btrfs-progs: update man pages of subvol list

- rename to match code where applicable
- add missing options
- unify the help strings in short and detailed sections
- fix a few typos

Signed-off-by: David Sterba <dsterba@suse.cz>
This commit is contained in:
David Sterba 2013-02-01 17:37:29 +01:00
parent 58cc1ef8df
commit 641e688375

View File

@ -11,7 +11,7 @@ btrfs \- control a btrfs filesystem
.PP
\fBbtrfs\fP \fBsubvolume create\fP\fI [<dest>/]<name>\fP
.PP
\fBbtrfs\fP \fBsubvolume list\fP\fI [-aoprts] [-g [+|-]value] [-c [+|-]value] [--rootid=rootid,gen,ogen,path] <path>\fP
\fBbtrfs\fP \fBsubvolume list\fP\fI [-acgoprts] [-G [+|-]value] [-C [+|-]value] [--sort=rootid,gen,ogen,path] <path>\fP
.PP
\fBbtrfs\fP \fBsubvolume set-default\fP\fI <id> <path>\fP
.PP
@ -116,7 +116,7 @@ Create a subvolume in \fI<dest>\fR (or in the current directory if
\fI<dest>\fR is omitted).
.TP
\fBsubvolume list\fR\fI [-aoprts][-g [+|-]value] [-c [+|-]value] [--sort=gen,ogen,rootid,path] <path>\fR
\fBsubvolume list\fR\fI [-acgoprts] [-G [+|-]value] [-C [+|-]value] [--sort=rootid,gen,ogen,path] <path>\fR
.RS
List the subvolumes present in the filesystem \fI<path>\fR. For every
subvolume the following information is shown by default.
@ -125,7 +125,7 @@ where path is the relative path of the subvolume to the \fItop level\fR
subvolume.
The subvolume's ID may be used by the \fBsubvolume set-default\fR command, or
at mount time via the \fIsubvol=\fR option.
at mount time via the \fIsubvolid=\fR option.
If \fI-p\fR is given, then \fIparent <ID>\fR is added to the output between ID
and top level. The parent's ID may be used at mount time via the
\fIsubvolrootid=\fR option.
@ -135,24 +135,30 @@ and top level. The parent's ID may be used at mount time via the
\fB-a\fP print all the subvolumes in the filesystem and distinguish between
absolute and relative path with respect to the given <path>.
\fB-c\fP print the ogeneration of the subvolume, aliases: ogen or origin generation
\fB-g\fP print the generation of the subvolume
\fB-u\fP print the UUID of the subvolume
\fB-o\fP print only subvolumes bellow specified <path>.
\fB-r\fP only readonly subvolumes in the filesystem wille be listed.
\fB-r\fP only readonly subvolumes in the filesystem will be listed.
\fB-s\fP only snapshot subvolumes in the filesystem will be listed.
\fB-s\fP only snapshot subvolumes in the filesystem will be listed.
\fB-g [+|-]value\fP
\fB-G [+|-]value\fP
list subvolumes in the filesystem that its generation is
>=, <= or = value. '+' means >= value, '-' means <= value, If there is
neither '+' nor '-', it means = value.
\fB-c [+|-]value\fP
\fB-C [+|-]value\fP
list subvolumes in the filesystem that its ogeneration is
>=, <= or = value. The usage is the same to '-g' option.
\fB--sort=gen,ogen,path,rootid\fP
\fB--sort=rootid,gen,ogen,path\fP
list subvolumes in order by specified items.
you can add '+' or '-' in front of each items, '+' means ascending,'-'
you can add '+' or '-' in front of each items, '+' means ascending, '-'
means descending. The default is ascending.
for \fB--sort\fP you can combine some items together by ',', just like