diff options
Diffstat (limited to 'Documentation/btrfs.txt')
| -rw-r--r-- | Documentation/btrfs.txt | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/Documentation/btrfs.txt b/Documentation/btrfs.txt index c9bed702..d0b3f35a 100644 --- a/Documentation/btrfs.txt +++ b/Documentation/btrfs.txt @@ -7,92 +7,92 @@ btrfs - control a btrfs filesystem SYNOPSIS -------- -'btrfs' <command> [<args>] +*btrfs* <command> [<args>] DESCRIPTION ----------- -'btrfs' is used to control the filesystem and the files and directories stored. +*btrfs* is used to control the filesystem and the files and directories stored. It is the tool to create or destroy a snapshot or a subvolume for the filesystem, to defrag a file or a directory, flush the data to the disk, to resize the filesystem, to scan the device. It is possible to abbreviate the commands unless the commands are ambiguous. -For example: it is possible to run 'btrfs sub snaps' instead of -'btrfs subvolume snapshot'. -But 'btrfs file s' is not allowed, because 'file s' may be interpreted -both as 'filesystem show' and as 'filesystem sync'. +For example: it is possible to run *btrfs sub snaps* instead of +*btrfs subvolume snapshot*. +But *btrfs file s* is not allowed, because *file s* may be interpreted +both as *filesystem show* and as *filesystem sync*. If a command is terminated by '--help', the detailed help is showed. If the passed command matches more commands, detailed help of all the matched commands is showed. For example -'btrfs dev --help' shows the help of all 'device*' commands. +*btrfs dev --help* shows the help of all *device** commands. COMMANDS -------- -'subvolume':: +*subvolume*:: Create/delete/list/manage btrfs subvolume. + See `btrfs-subvolume`(8) for details. -'filesystem':: +*filesystem*:: Manage a btrfs filesystem, including label setting/sync and so on. + See `btrfs-filesystem`(8) for details. -'[filesystem] balance':: +*[filesystem] balance*:: Balance btrfs filesystem chunks across single or several devices. + See `btrfs-balance`(8) for details. -'device':: +*device*:: Manage devices managed by btrfs, including add/delete/scan and so on. + See `btrfs-device`(8) for details. -'scrub':: +*scrub*:: Scrub a btrfs filesystem. + See `btrfs-scrub`(8) for details. -'check':: +*check*:: Do off-line check on a btrfs filesystem. + See `btrfs-check`(8) for details. -'rescue':: +*rescue*:: Try to rescue damaged btrfs filesystem. + See `btrfs-rescue`(8) for details. -'restore':: +*restore*:: Manage a btrfs filesystem, including label setting/sync and so on. + See `btrfs-restore`(8) for details. -'inspect-internal':: +*inspect-internal*:: Debug tools for developers/hackers. + See `btrfs-inspect-internal`(8) for details. -'send':: +*send*:: Send subvolume data to stdout/file for backup and etc. + See `btrfs-send`(8) for details. -'receive':: +*receive*:: Receive subvolume data from stdin/file for restore and etc. + See `btrfs-receive`(8) for details. -'quota':: +*quota*:: Manage quota on btrfs filesystem like enabling/rescan and etc. + See `btrfs-quota`(8) and `btrfs-qgroup`(8) for details. -'qgroup':: +*qgroup*:: Manage quota group(qgroup) for btrfs filesystem. + See `btrfs-qgroup`(8) for details. -'replace':: +*replace*:: Replace btrfs devices. + See `btrfs-replace`(8) for details. EXIT STATUS ----------- -'btrfs' returns a zero exist status if it succeeds. Non zero is returned in +*btrfs* 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 |