'\" t
.\"     Title: lsbtr
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.18
.\"      Date: 2023-03-25
.\"    Manual: Btrbk Manual
.\"    Source: Btrbk 0.32.6
.\"  Language: English
.\"
.TH "LSBTR" "1" "2023-03-25" "Btrbk 0.32.6" "Btrbk Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
lsbtr \- list btrfs subvolumes
.SH "SYNOPSIS"
.sp
.nf
lsbtr [\-h|\-\-help] [\-\-version]
      [\-l|\-\-long] [\-u|\-\-uuid] [\-1|\-\-single\-column] [\-\-raw]
      [\-\-format <output\-format>]
      [\-v|\-\-verbose]
      [\-c|\-\-config <file>]
      [\-\-override <config_option>=<value>]
      [[\-\-] <path>|<url>...]
.fi
.br
.SH "DESCRIPTION"
.sp
List btrfs subvolumes and their mount points visible by the file
system below \fI<path>\fP.
.sp
\fBlsbtr\fP is part of \fBbtrbk\fP (basically a shortcut for "btrbk ls"), and
takes some global configuration options from btrbk.conf(5) if present.
.sp
\fBlsbtr\fP requires \fIroot privileges\fP to run correctly. Alternatively,
consider using "btrfs\-progs\-sudo" or "btrfs\-progs\-btrbk" backends,
both of which allows you to run lsbtr as a regular user. Refer to
configuration option \fIbackend\fP in btrbk.conf(5) for more details.
.SH "OPTIONS"
.sp
\-h, \-\-help
.RS 4
Prints the synopsis and a list of the commands.
.RE
.sp
\-\-version
.RS 4
Prints the btrbk version.
.RE
.sp
\-l, \-\-long
.RS 4
Print output in long table format (additionally print subvolume
path).
.RE
.sp
\-u, \-\-uuid
.RS 4
Print UUID table (parent/received relations).
.RE
.sp
\-1, \-\-single\-column
.RS 4
Print path column only (delimited by newline).
.RE
.sp
\-\-raw
.RS 4
Print space\-separated key="value" pairs (machine readable).
.RE
.sp
\-\-format table|long|raw|col:[h:]<columns>
.RS 4
Print output in specified format. If set to "raw", prints
space\-separated key="value" pairs (machine readable).
.sp
If set to "col:", prints only the <columns> specified (comma\-separated
list). Header lines are ommitted if the "h:" modifier is present.
Columns prefixed with "\-" are collapsed if empty. Columns postfixed
with ":RALIGN" are right\-aligned.
.RE
.sp
\-v, \-\-verbose
.RS 4
Increase the level of verbosity.
.RE
.sp
\-c, \-\-config <file>
.RS 4
Read the configuration from <file>.
.RE
.sp
\-\-override <config_option>=<value>
.RS 4
Override a configuration option <config_option> with <value>.
.RE
.SH "FILES"
.sp
\f(CR/etc/btrbk.conf\fP, \f(CR/etc/btrbk/btrbk.conf\fP
.RS 4
Default configuration file. The file format and configuration
options are described in \fBbtrbk.conf\fP(5).
.RE
.SH "EXIT STATUS"
.sp
\fBlsbtr\fP returns the following error codes:
.sp
0
.RS 4
No problems occurred.
.RE
.sp
1
.RS 4
Generic error code.
.RE
.sp
2
.RS 4
Parse error: when parsing command\-line options or configuration
file.
.RE
.sp
255
.RS 4
Script error.
.RE
.SH "AVAILABILITY"
.sp
Please refer to the btrbk project page \fB\c
.URL "https://digint.ch/btrbk/" "" "\fP"
for further details.
.SH "SEE ALSO"
.sp
\fBbtrbk\fP(1),
\fBbtrbk.conf\fP(5),
\fBbtrfs\fP(8)
.SH "AUTHOR"
.sp
Axel Burri \c
.MTO "axel\(attty0.ch" "" ""