path: root/man
Commit message (Collapse)AuthorAge
* btrfs-progs: update man page for btrfs filesystem labelGuangyu Sun2013-08-09
| | | | | | | | | | btrfs filesystem label can work on a mounted filesystem, also on a multi-devices filesystem. And the restriction of label name is changed, too. The man page should be updated accordingly. Signed-off-by: Guangyu Sun <> Signed-off-by: David Sterba <> Signed-off-by: Chris Mason <>
* btrfs-progs: mkfs: add -O option to specify fs featuresDavid Sterba2013-08-09
| | | | | | | | Extend mkfs options to specify optional or potentially backwards incompatible features. Signed-off-by: David Sterba <> Signed-off-by: Chris Mason <>
* btrfs-progs: update manpage to add filesystem show command in synopsisEryu Guan2013-08-09
| | | | | | | | filesystem show was missing in SYNOPSIS section. Signed-off-by: Eryu Guan <> Signed-off-by: David Sterba <> Signed-off-by: Chris Mason <>
* Btrfs-image: add the ability to santize file names when making an imageJosef Bacik2013-06-19
| | | | | | | | | | | | | | | | | | | We've had a few users who wouldn't (or couldn't) provide us btrfs-images because we maintain the file names when making an image. So introduce a sanitize option. There are two uses, one that is fast and the other that is dog slow. The fast way just generates garbage that's equal in length to the original name. The slow way will try and find a crc32c collision for the file name that is also the same length. Finding a crc32c collision for the file name "btrfs-progs" on my box without CPU crc32c support takes a little more than 3 minutes, and a little less than 2 minutes for my box that has CPU crc32c support, so it's a lengthy and CPU intensive process. The idea is that we use -s for most cases, and then only use -ss when we need the file system tree to be somewhat sane. I could probably do a better job about finding collisions, but I'll have to revist that later. Thanks, Signed-off-by: Josef Bacik <> Signed-off-by: Chris Mason <>
* Btrfs-progs: add function to map subvol ID to pathStefan Behrens2013-04-23
| | | | | | | | | | | | | | | | Several tools like btrfs-send and btrfs-receive need to map a subvolume ID to a filesystem path. The so far existing methods in btrfs-list.c cause a horrible effort when performing this operation (and the effort is dependent on the number of existing subvolumes with quadratic effort). This commit adds a function that is able to map a subvolume ID to a filesystem path with an effort that is independent of the number of existing subvolumes. In addition to this function, a command line frontend is added as well: btrfs inspect-internal subvolid-resolve <subvolid> <path> Signed-off-by: Stefan Behrens <>
* Btrfs-progs: add an option to btrfs-image to walk the treesJosef Bacik2013-04-23
| | | | | | | | | | | | When working with a user with a broken file system I noticed I wasn't able to read some of the blocks properly from the restored image. This is because his extent tree was corrupt and was missing references to some of the blocks, which means they weren't copied into the image when he generated it. So add a -w option which will walk all of the trees manually and copy them into the image. This way we can run fsck against a complete file system image and fix any bugs in fsck. Thanks, Signed-off-by: Josef Bacik <>
* btrfs-progs: revert skinny extents changes from mkfsDavid Sterba2013-04-23
| | | | | | | We are going to unify enabling filesystem features via option -O. For now, use btrfstune to enable the features. Signed-off-by: David Sterba <>
* Btrfs-progs: add skinny metadata support to progs V3Josef Bacik2013-04-23
| | | | | | | | | This fixes up the progs to properly deal with skinny metadata. This adds the -x option to mkfs and btrfstune for enabling the skinny metadata option. This also makes changes to fsck so it can properly deal with the skinny metadata entries. Thanks, Signed-off-by: Josef Bacik <>
* btrfs-progs: add missing qgroup synopsis in btrfsZhi Yong Wu2013-04-09
| | | | Signed-off-by: Zhi Yong Wu <>
* btrfs-progs: fix one bracket issue in mkfs.btrfs manpageZhi Yong Wu2013-04-09
| | | | | | | | In "[ \fB\-f\fP\fI ]", the "\fI" will result in the front half "["of "[ -f ]" doesn't the back half "]"; When you issue the command "man mkfs.btrfs", you will see the difference. Signed-off-by: Zhi Yong Wu <>
* Btrfs-progs: make btrfs-image restore with a valid chunk tree V2Josef Bacik2013-04-09
| | | | | | | | | | | | | | | | | | | | Previously btrfs-image would set a METADUMP flag and would make one big system chunk to cover the entire file system in the super in order to get around the unpleasant business of having to adjust the chunk tree. This meant that you could use the progs stuff on a restored file system, which is great for testing btrfsck and other such things. But we want to be able to run the tree log replay on a file system that is not able to run the tree log replay. So in order to do this we need to fixup the super's chunk array and the chunk tree itself. This is pretty easy since we restore using the logical offsets of the metadata, so we just have to set the chunk items to have 1 stripe and have the stripes point at the primary device and then use the logical offset of the chunk as the physical offset. With this patch I can restore a file system image that had a tree log and mount the file system and have the log be replayed successfully. This patch also gives you the -o option in case you want the old restore way, in the case where we want to make sure the system chunks as they were given to us are correct. Thanks, Signed-off-by: Josef Bacik <>
* Btrfs-progs: make scrub IO priority configurableStefan Behrens2013-03-19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The btrfs tool is changed in order to support command line parameters to configure the IO priority of the scrub tasks. Also the default is changed. The default IO priority for scrub is the idle class now. The behavior is the same as when one would type 'ionice ... btrfs scrub start ...' or 'ionice ... btrfs scrub resume ...' (without this patch applied). The only reason for adding this to the btrfs tool is that it was not documented and not obvious that it worked like this, that all internal scrub tasks inherited the IO priority values of the btrfs tool that is starting or resuming the scrub operation. Note that after applying the patch it is no longer possible to set the IO priority using ionice since the btrfs tool always configures the priority in order to run in the idle class by default. Some basic performance measurements have been done with the goal to measure which IO priority for scrub gives the best overall disk data throughput. The kernel was configured to use the CFQ IO scheduler with default configuration and without support for throttling. The summary is, that the more the disk head movements are avoided, the faster the overall disk transfer capacity is, which is not really a big surprise. Therefore it makes sense that the best data throughput was measured setting the scrub IO priority and the scrub readahead IO priority to the idle class priority. Running with idle class IO priority means that scrub and scrub readahead IO is paused while other tasks access the disk. Doing the tasks one after the other instead of concurrently avoids many disk head movements. The overall data throughput of rotating disks is improved this way. However, if it is desired to have the scrub task done within a reasonable time, and if at the same time the filesystem is heavily loaded, the idle IO priority should be avoided. Otherwise the scrub operation will never take place and thus never terminate. The best effort IO priority class with the subclass 7 (the lowest one in the best effort class) is recommended in the case of always heavily loaded hard disks. If the filesystem is not loaded all the time and leaves some idle slots for scrub, the idle class IO priority is recommended. The idle class now is the default if the scrub operation is started with the btrfs-progs tools. Note that the patch that sets the scrub readahead IO priority to the idle class is a seperate patch, this needs to be done in the kernel. Signed-off-by: Stefan Behrens <>
* Removing btrfsctl, btrfs-vol, btrfs-showGoffredo Baroncelli2013-03-19
| | | | | | | | | | | | | | With the commit 002d021c (committed October 2011) btrfsctl, btrfs-vol, btrfs-show were declared deprecated. The last patches related to these commands are dated December 2010. These tools are replaced by the "btrfs" tool in all the functionality. This commit removes all the related code. Signed-off-by: Goffredo Baroncelli <> Signed-off-by: David Sterba <>
* btrfs-progs: mkfs: add missing raid5/6 descriptionMatias Bjørling2013-03-15
| | | | Signed-off-by: Matias Bjørling <>
* btrfs-progs: document force option in mkfs usage(); add long optEric Sandeen2013-03-14
| | | | | | | | | | I missed updating the mkfs.btrfs usage() when I added the option to force fs overwrite. Update that, and while we're at it add a long option, since all other commands have long counterparts. Signed-off-by: Eric Sandeen <>
* btrfs-progs: require mkfs -f force option to overwrite filesystem or ↵Eric Sandeen2013-02-19
| | | | | | | | | | | | | | | | | | | | | | | | partition table The core of this is shamelessly stolen from xfsprogs. Use blkid to detect an existing filesystem or partition table on any of the target devices. If something is found, require the '-f' option to overwrite it, hopefully avoiding disaster due to mistyped devicenames, etc. # mkfs.btrfs /dev/sda1 WARNING! - Btrfs v0.20-rc1-59-gd00279c-dirty IS EXPERIMENTAL WARNING! - see before using /dev/sda1 appears to contain an existing filesystem (xfs). Use the -f option to force overwrite. # This does introduce a requirement on libblkid. Signed-off-by: Eric Sandeen <>
* btrfs-progs: update man pages of subvol listDavid Sterba2013-02-01
| | | | | | | | | - 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 <>
* Btrfs-progs: add show subcommand to subvol cliAnand Jain2013-02-01
| | | | | | | | This adds show sub-command to the btrfs subvol cli to display detailed inforamtion of the given subvol or snapshot. Signed-off-by: Anand Jain <>
* Btrfs-progs: add '-o' option into subvolume list commandLukas Czerner2013-02-01
| | | | | | | | This commit introduces new option '-o' to list only subvolumes under the specified path. This does not change subvolume list behaviour. It has been default in the past and it is even with this commit. Signed-off-by: Lukas Czerner <>
* Btrfs-progs: move path modification to filtersLukas Czerner2013-02-01
| | | | | | | | | | | | Commit 8e8e019e910f20947fea7eff5da40753639d8870 introduces -a option which will list all subvolumes with distinguishing between relative and absolute by prepending absolute patch with "<FS_TREE>". This commit moves the path modification to a filter code rather than doing so in path construction in resolve_root(). This gives us more flexibility in formatting path output. Signed-off-by: Lukas Czerner <>
* Update the man page with the new prefixes.Goffredo Baroncelli2013-02-01
| | | | Signed-off-by: Goffredo Baroncelli <>
* Btrfs-progs: man btrfs: subcommands must be grouped togetherAnand Jain2013-01-31
| | | | Signed-off-by: Anand Jain <>
* Btrfs-progs: add support for device replace procedureStefan Behrens2013-01-31
| | | | | | | | | | | This is the user mode part of the device replace patch series. The command group "btrfs replace" is added with three commands: - btrfs replace start srcdev|srcdevid targetdev [-Bfr] mount_point - btrfs replace status mount_point [-1] - btrfs replace cancel mount_point Signed-off-by: Stefan Behrens <>
* Btrfs-progs: add command to get/reset device stats via ioctlStefan Behrens2013-01-31
| | | | | | | | "btrfs device stats" is used to retrieve and print the device stats. "btrfs device stats -z" is used to atomically retrieve, reset and print the stats. Signed-off-by: Stefan Behrens <>
* btrfs-progs pretty/quiet buildEric Sandeen2013-01-26
| | | | | | | | | | | | | | | | | | A quieter build makes warnings more obvious. This could probably be improved, but just to see if people like this or if they hate it. :) make V=1 overrides it and gets you the full glory again. [CC] ctree.o [CC] disk-io.o [CC] radix-tree.o [CC] extent-tree.o ... Signed-off-by: Eric Sandeen <>
* Btrfs-progs: detect if the disk we are formatting is a ssdJosef Bacik2013-01-23
| | | | | | | | | | | | | | Patch rebased because of changes in mkfs.c but otherwise the same as created by Josef Bacik SSD's do not gain anything by having metadata DUP turned on. The underlying file system that is a part of all SSD's could easily map duplicate metadat blocks into the same erase block which effectively eliminates the benefit of duplicating the metadata on disk. So detect if we are formatting a single SSD drive and if we are do not use DUP. Thanks, Signed-off-by: Josef Bacik <> Signed-off-by: Gene Czarcinski <>
* btrfs-progs: fix build, manpage compression commandChristian Hesse2013-01-23
| | | | | | | | | | | | | | | man pages for btrfs-progs are compressed by gzip by default. In Makefile the variable GZIP is use, this evaluates to 'gzip gzip' on my system. From man gzip: > The environment variable GZIP can hold a set of default options for gzip. > These options are interpreted first and can be overwritten by explicit > command line parameters. So using any other variable name fixes this. Patch is attached. Signed-off-by: Christian Hesse <> Signed-off-by: Gene Czarcinski <>
* btrfs-progs: remove '-h' from btrfs man pageSimon Xu2013-01-17
| | | | | | Remove '-h' from btrfs man page as it's not supported by the btrfs utility. Signed-off-by: Simon Xu <>
* btrfs-progs: remove "device show" from btrfs man pageSimon Xu2013-01-17
| | | | | | | Remove "device show" from btrfs man page as it's not supported by the btrfs utility. Signed-off-by: Simon Xu <>
* Btrfs-progs: add options to change bufsize in logical to inode translationLiu Bo2012-10-04
| | | | | | | | | Add an option 's' to set bufsize in logical to inode transition, then we are able to read all the refs to the logical address. Meanwhile, set a max value 64k for the bufsize. Signed-off-by: Liu Bo <> Signed-off-by: Chris Mason <>
* Btrfs-progs: btrfs subvolume delete could delete subvolumesAnand Jain2012-10-04
| | | | | | | | | With this user will be able to provide more than one subvolume to delete. eg: btrfs subvolume delete <subvol1> <subvol2> Signed-off-by: Anand Jain <> Signed-off-by: Chris Mason <>
* Btrfs-progs: correct the mkfs.btrfs man pageAnand Jain2012-10-04
| | | | | Signed-off-by: Anand Jain <> Signed-off-by: Chris Mason <>
* Btrfs-Progs: update '-s' option without a argument.Wang Shilong2012-10-04
| | | | | | | Since '--sort' options was given ,and we can list snapshots in generation order by --sort=+/-gen to replace '-s [0|1]' totally. Signed-off-by: Wang Shilong <>
* Btrfs-progs: introduces '-a' option into subvolume list commandWang Shilong2012-10-04
| | | | | | | | | | | | | | | We list the subvolumes under current directory according to the input subvolume. However, if we still want to list all the subvolumes in the tree, we can use '-a' option to help us. There may be two kinds of path: absolute path , relative path . The absolute path is beginning with "<FS_TREE>" The relative path is under current path that you input. Signed-off-by: Wang Shilong <>
* Btrfs-progs: introduce '-t' option into subvolume list commandMiao Xie2012-10-04
| | | | | | | | This patch introduces '-t' option into subvolume list command. By this option, we can output the result as a table. Signed-off-by: Wang Shilong <> Signed-off-by: Miao Xie <>
* Btrfs-progs: introduce -g -c --sort options into btrfs subvol list commandwangshilong2012-10-04
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch introduces '-g' '-c' '--sort' options The option '-g' can help you filter the subvolumes by the generation, you may use it just like: btrfs subvol list -g +/-value <path> '+' means the generation of the subvolumes should >= the value you specified. '-' means the generation should <= the value If you don't input either '+' nor '-', this command will list the subvolumes that their generation equals to the value. However if you want to find gengeration between value1 and value2 you may use the above like: btrfs sub list -g -value1 -g +value2 <path> The option '-c' can help you filter the subvolumes by the ogeneration, you may use it just like: btrfs subvol list -c +/-value <path> The usage is the same to '-g' You might want to list subvolumes in order of some items, such as root id, gen and so on, you can use '--sort'. Now you can sort the subvolumes by root id, gen, ogen and path. For example: If you want to list subvolumes in order of rootid, you can use the option like that: btrfs sub list --sort=+/-rooid <path> Here, '+' means the result is sorted by ascending order. '-' is by descending order. If you don't specify either '+' nor '-', the result is sorted by default - ascending order. If you want to combine sort items, you do it like that: btrfs sub list --sort=-rootid,+path,ogen,gen <path> Signed-off-by: Wang Shilong <> Signed-off-by: Miao Xie <>
* Btrfs-progs: update the manpage entries for the btrfs subvolume listZhou Bo2012-10-04
| | | | | | | This patch adds the introduction of the new option '-r' into the man page of 'btrfs subvolume list' command. Signed-off-by: Zhou Bo <>
* btrfs-progs: mkfs: rename nodiscard option to KDavid Sterba2012-10-02
| | | | | | | The original patch named the option -T, mkfs.xfs uses -K let's keep it same. Signed-off-by: David Sterba <>
* btrfs-progs: mkfs: add option to skip trimDavid Sterba2012-07-06
| | | | Signed-off-by: Chris Mason <>
* Btrfs-progs: Fix manual of btrfs commandAkira Fujita2012-07-03
| | | | | | | | | Usage of balancing btrfs is "btrfs filesystem balance", not "btrfs device balance". And remove unneeded usage of "btrfs filesystem defrag". Also fix some typos and over 80 columns. Signed-off-by: Akira Fujita <>
* btrfs-progs: document --rootdir mkfs switchPhillip Susi2012-07-03
| | | | Signed-off-by: Phillip Susi <>
* btrfs-progs: removed extraneous whitespace from mkfs man pagePhillip Susi2012-07-03
| | | | | | | There were extra spaces around some of the arguments in the man page for mkfs. Signed-off-by: Phillip Susi <>
* btrfs-progs: Update resize documentationShawn Bohrer2012-07-03
| | | | | | | | | | | The btrfs filesystem resize command defaults to only resizing the filesystem for devid 1, and must have a devid passed in to resize the filesystem for the other devices in the filesystem. Additionally the documentation lacked information on how to actually resize the underlying partition so this provides a little more detail. Signed-off-by: Shawn Bohrer <>
* man: fix btrfs man page formattingHubert Kario2012-07-03
| | | | Signed-off-by: Hubert Kario <>
* Btrfs-progs: added resolve commands to man pageJan Schmidt2011-11-02
| | | | | | | Added "inspect-internal inode-resolve" and "inspect-internal logical-resolve" to the btrfs(8) man page. Signed-off-by: Jan Schmidt <>
* Scan the devices listed in /proc/partitionsGoffredo Baroncelli2011-10-25
| | | | | | | | | | | During the commands: - btrfs filesystem show - btrfs device scan the devices "scanned" are extracted from /proc/partitions. This should avoid to scan devices not suitable for a btrfs filesystem like cdrom and floppy or to scan not existant devices. The old behavior (scan all the block devices under /dev) may be forced passing the "--all-devices" switch.
* Btrfs-progs: add "btrfs subvolume get-default" subcommandZhong, Xin2011-10-25
| | | | | | | | | | | | | | Add subcommand to get the default subvolume of btrfs filesystem V2->V3: * add man page * based on integration-20110705 Reviewed-by: Andreas Philipp <> Reviewed-by: Goffredo Baroncelli <> Reported-by: Yang, Yi <> Signed-off-by: Zhong, Xin <>
* btrfs-progs: scrub added to manpageJan Schmidt2011-10-25
| | | | | Signed-off-by: Jan Schmidt <> Signed-off-by: Hugo Mills <>
* update manpage entries for btrfs subvolume listAndreas Philipp2011-10-25
| | | | | | | | Update the manpage entries for the btrfs subvolume list command to reflect the newly created additional option '-p'. Signed-off-by: Andreas Philipp <> Signed-off-by: Hugo Mills <>
* Updated manpage for btrfs subvolume snapshot.Andreas Philipp2011-10-25
| | | | | Signed-off-by: Andreas Philipp <> Signed-off-by: Hugo Mills <>