diff options
| author | David Sterba <dsterba@suse.cz> | 2014-05-19 17:49:35 +0200 |
|---|---|---|
| committer | David Sterba <dsterba@suse.cz> | 2014-05-19 17:54:10 +0200 |
| commit | a4197dfe24a1964f43734af126188c100885d88e (patch) | |
| tree | 2777013a0acac0b7196684afb4faf7725b28886d /Documentation/btrfs-property.txt | |
| parent | aaeae23458aa76a68f5e1b1fb8bf551b04f57f2e (diff) | |
btrfs-progs: doc: make all commands and subcommands bold
Italic format is used for parameters and values. also this makes the
text visually separated,
Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation/btrfs-property.txt')
| -rw-r--r-- | Documentation/btrfs-property.txt | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Documentation/btrfs-property.txt b/Documentation/btrfs-property.txt index 82466f9e..4b0f49e0 100644 --- a/Documentation/btrfs-property.txt +++ b/Documentation/btrfs-property.txt @@ -7,20 +7,20 @@ btrfs-property - get/set/list properties for given btrfs object. SYNOPSIS -------- -'btrfs property' <subcommand> <args> +*btrfs property* <subcommand> <args> DESCRIPTION ----------- -'btrfs property' is used to get/set/list property, like lable or compression +*btrfs property* is used to get/set/list property, like lable or compression state, for given btrfs object. -'btrfs property' provides an unified and user-friendly method to tune different +*btrfs property* provides an unified and user-friendly method to tune different btrfs properties instead of using the traditional method like `chattr`(1) or `lsattr`(1). SUBCOMMAND ---------- -'get' [-t <type>] <object> [<name>]:: +*get* [-t <type>] <object> [<name>]:: Gets a property from a btrfs object. + If no name is specified, all properties for the given object are @@ -37,26 +37,26 @@ Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]'. The <object> can be path of btrfs device, btrfs mount point, or any directories/files inside btrfs. -'set' [-t <type>] <object> <name> <value>:: +*set* [-t <type>] <object> <name> <value>:: Sets a property on a btrfs object. + -See description of 'get' subcommand for a description of objects and object +See description of *get* subcommand for a description of objects and object types. -'list' [-t <type>] <object>:: +*list* [-t <type>] <object>:: Lists available properties with their descriptions for the given object. + -Please see the help of 'btrfs property get' for a description of +Please see the help of *btrfs property get* for a description of objects and object types. EXIT STATUS ----------- -'btrfs property' returns a zero exist status if it succeeds. Non zero is +*btrfs property* 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 |