1LSBTR(1)                         Btrbk Manual                         LSBTR(1)
2
3
4

NAME

6       lsbtr - list btrfs subvolumes
7

SYNOPSIS

9       lsbtr [-h|--help] [--version]
10             [-l|--long] [-u|--uuid] [-1|--single-column] [--raw]
11             [--format <output-format>]
12             [-v|--verbose]
13             [-c|--config <file>]
14             [--override <config_option>=<value>]
15             [[--] <path>|<url>...]
16

DESCRIPTION

18       List btrfs subvolumes and their mount points visible by the file system
19       below <path>.
20
21       lsbtr is part of btrbk (basically a shortcut for "btrbk ls"), and takes
22       some global configuration options from btrbk.conf(5) if present.
23
24       lsbtr requires root privileges to run correctly. Alternatively,
25       consider using "btrfs-progs-sudo" or "btrfs-progs-btrbk" backends, both
26       of which allows you to run lsbtr as a regular user. Refer to
27       configuration option backend in btrbk.conf(5) for more details.
28

OPTIONS

30       -h, --help
31           Prints the synopsis and a list of the commands.
32
33       --version
34           Prints the btrbk version.
35
36       -l, --long
37           Print output in long table format (additionally print subvolume
38           path).
39
40       -u, --uuid
41           Print UUID table (parent/received relations).
42
43       -1, --single-column
44           Print path column only (delimited by newline).
45
46       --raw
47           Print space-separated key="value" pairs (machine readable).
48
49       --format table|long|raw|col:[h:]<columns>
50           Print output in specified format. If set to "raw", prints
51           space-separated key="value" pairs (machine readable).
52
53           If set to "col:", prints only the <columns> specified
54           (comma-separated list). Header lines are ommitted if the "h:"
55           modifier is present. Columns prefixed with "-" are collapsed if
56           empty. Columns postfixed with ":RALIGN" are right-aligned.
57
58       -v, --verbose
59           Increase the level of verbosity.
60
61       -c, --config <file>
62           Read the configuration from <file>.
63
64       --override <config_option>=<value>
65           Override a configuration option <config_option> with <value>.
66

FILES

68       /etc/btrbk.conf, /etc/btrbk/btrbk.conf
69           Default configuration file. The file format and configuration
70           options are described in btrbk.conf(5).
71

EXIT STATUS

73       lsbtr returns the following error codes:
74
75       0
76           No problems occurred.
77
78       1
79           Generic error code.
80
81       2
82           Parse error: when parsing command-line options or configuration
83           file.
84
85       255
86           Script error.
87

AVAILABILITY

89       Please refer to the btrbk project page https://digint.ch/btrbk/ for
90       further details.
91

SEE ALSO

93       btrbk(1), btrbk.conf(5), btrfs(8)
94

AUTHOR

96       Axel Burri axel@tty0.ch
97
98
99
100Btrbk 0.32.6                      2023-03-25                          LSBTR(1)
Impressum