diff options
Diffstat (limited to 'Documentation/btrfs-subvolume.txt')
| -rw-r--r-- | Documentation/btrfs-subvolume.txt | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/Documentation/btrfs-subvolume.txt b/Documentation/btrfs-subvolume.txt index 6cc72803..3fd29282 100644 --- a/Documentation/btrfs-subvolume.txt +++ b/Documentation/btrfs-subvolume.txt @@ -7,11 +7,11 @@ btrfs-subvolume - control btrfs subvolume(s) SYNOPSIS -------- -'btrfs subvolume' <subcommand> [<args>] +*btrfs subvolume* <subcommand> [<args>] DESCRIPTION ----------- -'btrfs subvolume' is used to control the filesystem to create/delete/list/show +*btrfs subvolume* is used to control the filesystem to create/delete/list/show subvolumes and snapshots. SUBVOLUME AND SNAPSHOT @@ -43,7 +43,7 @@ from normal directories. SUBCOMMAND ----------- -'create' [-i <qgroupid>] [<dest>]<name>:: +*create* [-i <qgroupid>] [<dest>]<name>:: Create a subvolume <name> in <dest>. + If <dest> is not given, subvolume <name> will be created in the currently @@ -55,7 +55,7 @@ directory. Add the newly created subvolume to a qgroup. This option can be given multiple times. -'delete' [options] <subvolume> [<subvolume>...]:: +*delete* [options] <subvolume> [<subvolume>...]:: Delete the subvolume(s) from the filesystem. + If <subvolume> is not a subvolume, btrfs returns an error but continues if @@ -75,7 +75,7 @@ wait for transaction commit at the end of the operation -C|--commit-each:::: wait for transaction commit after delet each subvolume -'list' [options] [-G [\+|-]<value>] [-C [+|-]<value>] [--sort=rootid,gen,ogen,path] <path>:: +*list* [options] [-G [\+|-]<value>] [-C [+|-]<value>] [--sort=rootid,gen,ogen,path] <path>:: List the subvolumes present in the filesystem <path>. + For every subvolume the following information is shown by default. + @@ -125,7 +125,7 @@ you can add \'\+' or \'-' in front of each items, \'+' means ascending, for --sort you can combine some items together by \',', just like -sort=+ogen,-gen,path,rootid. -'snapshot' [-r] <source> <dest>|[<dest>/]<name>:: +*snapshot* [-r] <source> <dest>|[<dest>/]<name>:: Create a writable/readonly snapshot of the subvolume <source> with the name <name> in the <dest> directory. + @@ -133,32 +133,32 @@ If only <dest> is given, the subvolume will be named the basename of <source>. If <source> is not a subvolume, btrfs returns an error. If '-r' is given, the snapshot will be readonly. -'get-default' <path>:: +*get-default* <path>:: Get the default subvolume of the filesystem <path>. + -The output format is similar to 'subvolume list' command. +The output format is similar to *subvolume list* command. -'set-default' <id> <path>:: +*set-default* <id> <path>:: Set the subvolume of the filesystem <path> which is mounted as default. + -The subvolume is identified by <id>, which is returned by the 'subvolume list' +The subvolume is identified by <id>, which is returned by the *subvolume list* command. -'find-new' <subvolume> <last_gen>:: +*find-new* <subvolume> <last_gen>:: List the recently modified files in a subvolume, after <last_gen> ID. -'show' <path>:: +*show* <path>:: Show information of a given subvolume in the <path>. EXIT STATUS ----------- -'btrfs subvolume' returns a zero exist status if it succeeds. Non zero is +*btrfs subvolume* returns a zero exist status if it succeeds. Non zero is returned in case of failure. AVAILABILITY ------------ -'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +*btrfs* is part of btrfs-progs. Btrfs filesystem is currently under heavy development, and not suitable for any uses other than benchmarking and review. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for |