btrfs-progs/Documentation/man-index.rst

.. BTRFS manual pages index

Manual pages
============

.. toctree::
   :maxdepth: 1

   btrfs
   btrfs-man5
   btrfs-balance
   btrfs-check
   btrfs-convert
   btrfs-device
   btrfs-filesystem
   btrfs-find-root
   btrfs-image
   btrfs-inspect-internal
   btrfs-map-logical
   btrfs-property
   btrfs-qgroup
   btrfs-quota
   btrfs-receive
   btrfs-replace
   btrfs-rescue
   btrfs-restore
   btrfs-scrub
   btrfs-select-super
   btrfs-send
   btrfs-subvolume
   btrfstune
   fsck.btrfs
   mkfs.btrfs
btrfs-progs: docs: add sample RSTified manual page The asciidoc format needs to be tweaked but otherwise is basically the same. Changes: - bold text is - italics is * * - NOTE is directive .. note - definition list is simple indented block after the term - section NAME in the manual page is generated from date in conf.py:man_pages - new page has to be added to the index To do: - references to other manual pages, will be RST native linking once all the pages are converted The output is in Documentation/_build/man and the format is visually not much different from what is generated by asciidoc. Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 21:06:50 +00:00			`.. BTRFS manual pages index`

			`Manual pages`
			`============`

			`.. toctree::`
			`:maxdepth: 1`

btrfs-progs: docs: convert btrfs(8) to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs`
btrfs-progs: docs: convert btrfs(5) to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-man5`
btrfs-progs: docs: convert btrfs-balance to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-balance`
btrfs-progs: docs: convert btrfs-check to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-check`
btrfs-progs: docs: convert btrfs-convert to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-convert`
btrfs-progs: docs: convert btrfs-device to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-device`
btrfs-progs: docs: convert btrfs-filesystem to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-filesystem`
btrfs-progs: docs: convert btrfs-find-root to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-find-root`
btrfs-progs: docs: convert btrfs-image to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-image`
btrfs-progs: docs: convert btrfs-inspect-internal to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-inspect-internal`
btrfs-progs: docs: convert btrfs-map-logical to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-map-logical`
btrfs-progs: docs: convert btrfs-property to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-property`
btrfs-progs: docs: convert btrfs-qgroup to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-qgroup`
btrfs-progs: docs: convert btrfs-quota to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-quota`
btrfs-progs: docs: convert btrfs-receive to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-receive`
btrfs-progs: docs: convert btrfs-replace to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-replace`
btrfs-progs: docs: convert btrfs-rescue to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-rescue`
btrfs-progs: docs: convert btrfs-restore to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-restore`
btrfs-progs: docs: convert btrfs-scrub to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-scrub`
btrfs-progs: docs: add sample RSTified manual page The asciidoc format needs to be tweaked but otherwise is basically the same. Changes: - bold text is - italics is * * - NOTE is directive .. note - definition list is simple indented block after the term - section NAME in the manual page is generated from date in conf.py:man_pages - new page has to be added to the index To do: - references to other manual pages, will be RST native linking once all the pages are converted The output is in Documentation/_build/man and the format is visually not much different from what is generated by asciidoc. Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 21:06:50 +00:00			`btrfs-select-super`
btrfs-progs: docs: convert btrfs-send to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-send`
btrfs-progs: docs: convert btrfs-subvolume to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfs-subvolume`
btrfs-progs: docs: convert btrfstune to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`btrfstune`
btrfs-progs: docs: convert fsck.btrfs to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`fsck.btrfs`
btrfs-progs: docs: convert mkfs.btrfs to rst Signed-off-by: David Sterba <dsterba@suse.com> 2021-10-26 22:45:24 +00:00			`mkfs.btrfs`