{ "content": [ { "type": "text", "text": "# BTRFS (man)\n\n## NAME\n\nbtrfs - a toolbox to manage btrfs filesystems\n\n## SYNOPSIS\n\nbtrfs [global] [...] []\n\n## DESCRIPTION\n\nThe btrfs utility is a toolbox for managing btrfs filesystems. There are command groups to\nwork with subvolumes, devices, for whole filesystem or other specific actions. See section\nCOMMANDS.\n\n## TLDR\n\n> A filesystem based on the copy-on-write (COW) principle for Linux.\n\n- Create subvolume:\n `sudo btrfs {{su|subvolume}} {{c|create}} {{path/to/subvolume}}`\n- List subvolumes:\n `sudo btrfs {{su|subvolume}} {{l|list}} {{path/to/mount_point}}`\n- Show space usage information:\n `sudo btrfs {{f|filesystem}} df {{path/to/mount_point}}`\n- Enable quota:\n `sudo btrfs {{qu|quota}} {{e|enable}} {{path/to/subvolume}}`\n- Show quota:\n `sudo btrfs {{qg|qgroup}} {{s|show}} {{path/to/subvolume}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **COMMAND SYNTAX** (3 subsections)\n- **COMMANDS** (8 subsections)\n- **STANDALONE TOOLS** (4 subsections)\n- **EXIT STATUS**\n- **AVAILABILITY**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "BTRFS", "section": "", "mode": "man", "summary": "btrfs - a toolbox to manage btrfs filesystems", "synopsis": "btrfs [global] [...] []", "tldr_summary": "A filesystem based on the copy-on-write (COW) principle for Linux.", "tldr_examples": [ { "description": "Create subvolume", "command": "sudo btrfs {{su|subvolume}} {{c|create}} {{path/to/subvolume}}" }, { "description": "List subvolumes", "command": "sudo btrfs {{su|subvolume}} {{l|list}} {{path/to/mount_point}}" }, { "description": "Show space usage information", "command": "sudo btrfs {{f|filesystem}} df {{path/to/mount_point}}" }, { "description": "Enable quota", "command": "sudo btrfs {{qu|quota}} {{e|enable}} {{path/to/subvolume}}" }, { "description": "Show quota", "command": "sudo btrfs {{qg|qgroup}} {{s|show}} {{path/to/subvolume}}" } ], "tldr_source": "official", "flags": [ { "flag": "", "long": "--version", "arg": null, "description": "print version string" } ], "examples": [], "see_also": [ { "name": "btrfs", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/btrfs/5/json" }, { "name": "btrfs-balance", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-balance/8/json" }, { "name": "btrfs-check", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-check/8/json" }, { "name": "btrfs-convert", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-convert/8/json" }, { "name": "btrfs-device", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-device/8/json" }, { "name": "btrfs-filesystem", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-filesystem/8/json" }, { "name": "btrfs-inspect-internal", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-inspect-internal/8/json" }, { "name": "btrfs-property", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-property/8/json" }, { "name": "btrfs-qgroup", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-qgroup/8/json" }, { "name": "btrfs-quota", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-quota/8/json" }, { "name": "btrfs-receive", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-receive/8/json" }, { "name": "btrfs-replace", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-replace/8/json" }, { "name": "btrfs-rescue", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-rescue/8/json" }, { "name": "btrfs-restore", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-restore/8/json" }, { "name": "btrfs-scrub", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-scrub/8/json" }, { "name": "btrfs-send", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-send/8/json" }, { "name": "btrfs-subvolume", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfs-subvolume/8/json" }, { "name": "btrfstune", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/btrfstune/8/json" }, { "name": "mkfs.btrfs", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/mkfs.btrfs/8/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 10, "subsections": [] }, { "name": "COMMAND SYNTAX", "lines": 23, "subsections": [ { "name": "-v|--verbose", "lines": 2 }, { "name": "-q|--quiet", "lines": 9 }, { "name": "--version", "lines": 2, "long": "--version" } ] }, { "name": "COMMANDS", "lines": 1, "subsections": [ { "name": "balance", "lines": 8 }, { "name": "filesystem", "lines": 3 }, { "name": "inspect-internal", "lines": 2 }, { "name": "property", "lines": 7 }, { "name": "receive", "lines": 3 }, { "name": "replace", "lines": 4 }, { "name": "restore", "lines": 7 }, { "name": "subvolume", "lines": 2 } ] }, { "name": "STANDALONE TOOLS", "lines": 6, "subsections": [ { "name": "btrfs-convert", "lines": 2 }, { "name": "btrfstune", "lines": 2 }, { "name": "btrfs-select-super", "lines": 2 }, { "name": "btrfs-find-root", "lines": 7 } ] }, { "name": "EXIT STATUS", "lines": 2, "subsections": [] }, { "name": "AVAILABILITY", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 7, "subsections": [] } ], "sections": { "NAME": { "content": "btrfs - a toolbox to manage btrfs filesystems\n", "subsections": [] }, "SYNOPSIS": { "content": "btrfs [global] [...] []\n", "subsections": [] }, "DESCRIPTION": { "content": "The btrfs utility is a toolbox for managing btrfs filesystems. There are command groups to\nwork with subvolumes, devices, for whole filesystem or other specific actions. See section\nCOMMANDS.\n\nThere are also standalone tools for some tasks like btrfs-convert(8) or btrfstune(8) that\nwere separate historically and/or haven't been merged to the main utility. See section\nSTANDALONE TOOLS for more details.\n\nFor other topics (mount options, etc) please refer to the separate manual page btrfs(5).\n", "subsections": [] }, "COMMAND SYNTAX": { "content": "Any command name can be shortened so long as the shortened form is unambiguous, however, it\nis recommended to use full command names in scripts. All command groups have their manual\npage named btrfs-.\n\nFor example: it is possible to run btrfs sub snaps instead of btrfs subvolume snapshot. But\nbtrfs file s is not allowed, because file s may be interpreted both as filesystem show and as\nfilesystem sync.\n\nIf the command name is ambiguous, the list of conflicting options is printed.\n\nSizes, both upon input and output, can be expressed in either SI or IEC-I units (see\nnumfmt(1)) with the suffix B appended. All numbers will be formatted according to the rules\nof the C locale (ignoring the shell locale, see locale(7)).\n\nFor an overview of a given command use btrfs command --help or btrfs [command...] --help\n--full to print all available options.\n\nThere are global options that are passed between btrfs and the group name and affect behav‐\niour not specific to the command, e.g. verbosity or the type of the output.\n\n--format \nif supported by the command, print subcommand output in that format (text, json)\n", "subsections": [ { "name": "-v|--verbose", "content": "increase verbosity of the subcommand\n" }, { "name": "-q|--quiet", "content": "print only errors\n\n--log \nset log level (default, info, verbose, debug, quiet)\n\nThe remaining options are relevant only for the main tool:\n\n--help print condensed help for all subcommands\n" }, { "name": "--version", "content": "print version string\n", "long": "--version" } ] }, "COMMANDS": { "content": "", "subsections": [ { "name": "balance", "content": "Balance btrfs filesystem chunks across single or several devices. See\nbtrfs-balance(8) for details.\n\ncheck Do off-line check on a btrfs filesystem. See btrfs-check(8) for details.\n\ndevice Manage devices managed by btrfs, including add/delete/scan and so on. See\nbtrfs-device(8) for details.\n" }, { "name": "filesystem", "content": "Manage a btrfs filesystem, including label setting/sync and so on. See\nbtrfs-filesystem(8) for details.\n" }, { "name": "inspect-internal", "content": "Debug tools for developers/hackers. See btrfs-inspect-internal(8) for details.\n" }, { "name": "property", "content": "Get/set a property from/to a btrfs object. See btrfs-property(8) for details.\n\nqgroup Manage quota group(qgroup) for btrfs filesystem. See btrfs-qgroup(8) for details.\n\nquota Manage quota on btrfs filesystem like enabling/rescan and etc. See btrfs-quota(8) and\nbtrfs-qgroup(8) for details.\n" }, { "name": "receive", "content": "Receive subvolume data from stdin/file for restore and etc. See btrfs-receive(8) for\ndetails.\n" }, { "name": "replace", "content": "Replace btrfs devices. See btrfs-replace(8) for details.\n\nrescue Try to rescue damaged btrfs filesystem. See btrfs-rescue(8) for details.\n" }, { "name": "restore", "content": "Try to restore files from a damaged btrfs filesystem. See btrfs-restore(8) for de‐\ntails.\n\nscrub Scrub a btrfs filesystem. See btrfs-scrub(8) for details.\n\nsend Send subvolume data to stdout/file for backup and etc. See btrfs-send(8) for details.\n" }, { "name": "subvolume", "content": "Create/delete/list/manage btrfs subvolume. See btrfs-subvolume(8) for details.\n" } ] }, "STANDALONE TOOLS": { "content": "New functionality could be provided using a standalone tool. If the functionality proves to\nbe useful, then the standalone tool is declared obsolete and its functionality is copied to\nthe main tool. Obsolete tools are removed after a long (years) depreciation period.\n\nTools that are still in active use without an equivalent in btrfs:\n", "subsections": [ { "name": "btrfs-convert", "content": "in-place conversion from ext2/3/4 filesystems to btrfs\n" }, { "name": "btrfstune", "content": "tweak some filesystem properties on a unmounted filesystem\n" }, { "name": "btrfs-select-super", "content": "rescue tool to overwrite primary superblock from a spare copy\n" }, { "name": "btrfs-find-root", "content": "rescue helper to find tree roots in a filesystem\n\nFor space-constrained environments, it's possible to build a single binary with functionality\nof several standalone tools. This is following the concept of busybox where the file name se‐\nlects the functionality. This works for symlinks or hardlinks. The full list can be obtained\nby btrfs help --box.\n" } ] }, "EXIT STATUS": { "content": "btrfs returns a zero exit status if it succeeds. Non zero is returned in case of failure.\n", "subsections": [] }, "AVAILABILITY": { "content": "btrfs is part of btrfs-progs. Please refer to the documentation at\nhttps://btrfs.readthedocs.io.\n", "subsections": [] }, "SEE ALSO": { "content": "btrfs(5), btrfs-balance(8), btrfs-check(8), btrfs-convert(8), btrfs-device(8),\nbtrfs-filesystem(8), btrfs-inspect-internal(8), btrfs-property(8), btrfs-qgroup(8),\nbtrfs-quota(8), btrfs-receive(8), btrfs-replace(8), btrfs-rescue(8), btrfs-restore(8),\nbtrfs-scrub(8), btrfs-send(8), btrfs-subvolume(8), btrfstune(8), mkfs.btrfs(8)\n\n\n6.6.3 Mar 31, 2024 BTRFS(8)", "subsections": [] } } } }