diff options
author | Jan Safranek <jsafrane@redhat.com> | 2013-08-19 15:17:11 +0200 |
---|---|---|
committer | Jan Safranek <jsafrane@redhat.com> | 2013-08-19 16:10:45 +0200 |
commit | bb3534a39e98a2106ae4cbbb0e0d513857d6475a (patch) | |
tree | 42f3801d2472d7a2a5c790a988478ffe1ed2d828 /commands/storage/doc | |
parent | d43ae7f4bc6a16b41e7c6666aebe77bab8c824df (diff) | |
download | openlmi-scripts-bb3534a39e98a2106ae4cbbb0e0d513857d6475a.tar.gz openlmi-scripts-bb3534a39e98a2106ae4cbbb0e0d513857d6475a.tar.xz openlmi-scripts-bb3534a39e98a2106ae4cbbb0e0d513857d6475a.zip |
Regenerate documentation.
Diffstat (limited to 'commands/storage/doc')
-rw-r--r-- | commands/storage/doc/cmdline.rst | 386 | ||||
-rw-r--r-- | commands/storage/doc/conf.py | 2 |
2 files changed, 251 insertions, 137 deletions
diff --git a/commands/storage/doc/cmdline.rst b/commands/storage/doc/cmdline.rst index 1ab4742..67001f4 100644 --- a/commands/storage/doc/cmdline.rst +++ b/commands/storage/doc/cmdline.rst @@ -3,219 +3,333 @@ LMI command line reference These commands allow listing and manipulation with block devices. - device ------ Basic device information. -Usage: - device list [<devices>]... - device show [<devices>]... - device depends [ --deep ] [<devices>]... - device provides [ --deep ] [<devices>]... - device tree [<device>] -Commands: - list List short information about given device. If no devices - are given, all devices are listed. +**Usage:** + + **lmi** **device** **list** [ \ *<device>*\ ...] + + **lmi** **device** **show** [ \ *<device>*\ ...] + + **lmi** **device** **depends** [ \ **--deep**\ ] [ \ *<device>*\ ...] + + **lmi** **device** **provides** [ \ **--deep**\ ] [ \ *<device>*\ ...] + + **lmi** **device** **tree** [ \ *<device>*\ ] + + + +**Commands:** + + + **list** + List short information about given device. If no devices + are given, all devices are listed. + - show Show detailed information about given devices. If no devices - are provided, all of them are displayed. + **show** + Show detailed information about given devices. If no devices + are provided, all of them are displayed. - provides Show devices, which are created from given devices - (= show children of the devices). - For example, if disk is provided, all partitions on it are - returned. If 'deep' is used, all RAIDs, Volume Groups and - Logical Volumes indirectly allocated from it are returned too. + **provides** + Show devices, which are created from given devices + (= show children of the devices). - depends Show devices, which are required by given devices to operate - correctly (= show parents of the devices). + For example, if disk is provided, all partitions on it are + returned. If 'deep' is used, all RAIDs, Volume Groups and + Logical Volumes indirectly allocated from it are returned too. - For example, if a Logical Volume is provided, its Volume Group - is returned. If 'deep' is used, also all Physical Volumes and - disk are returned. - tree Show tree of devices, similar to lsblk. - (Note that the output is really crude and needs to be worked - on). + **depends** + Show devices, which are required by given devices to operate + correctly (= show parents of the devices). - If no device is provided, all devices are shown, starting - with physical disks. + For example, if a Logical Volume is provided, its Volume Group + is returned. If 'deep' is used, also all Physical Volumes and + disk are returned. - If a device is provided, tree starts with the device - and all dependent devices are shown. + + **tree** + Show tree of devices, similar to lsblk. + (Note that the output is really crude and needs to be worked + on). + + If no device is provided, all devices are shown, starting + with physical disks. + + If a device is provided, tree starts with the device + and all dependent devices are shown. partition-table --------------- Partition management. -Usage: - lmi partition-table list [<devices>]... - lmi partition-table create [ --gpt | --msdos ] <devices>... - lmi partition-table show [<devices>]... -Commands: - list List partition tables on given device. - If no devices are provided, all partition tables are listed. +**Usage:** + + **lmi** **partition-table** **list** [ \ *<device>*\ ...] + + **lmi** **partition-table** **create** [ \ **--gpt**\ | \ **--msdos**\ ] \ *<device>*\ ... + + **lmi** **partition-table** **show** [ \ *<device>*\ ...] + + + +**Commands:** + + + **list** + List partition tables on given device. + If no devices are provided, all partition tables are listed. - create Create a partition table on given devices. The devices must be - empty, i.e. must not have any partitions on them. GPT partition - table is created by default. - show Show detailed information about partition table on given - devices. If no devices are provided, all of them are displayed. + **create** + Create a partition table on given devices. The devices must be + empty, i.e. must not have any partitions on them. GPT partition + table is created by default. + **show** + Show detailed information about partition table on given + devices. If no devices are provided, all of them are displayed. + partition --------- Partition management. -Usage: - lmi partition list [<devices>]... - lmi partition create [ --logical | --extended ] <device> [<size>] - lmi partition delete <partitions>... - lmi partition show [<partitions>]... -Commands: - list List available partitions on given devices. - If no devices are provided, all partitions are listed. +**Usage:** + + **lmi** **partition** **list** [ \ *<device>*\ ...] + + **lmi** **partition** **create** [ \ **--logical**\ | \ **--extended**\ ] \ *<device>*\ [\ *<size>*\ ] + + **lmi** **partition** **delete** \ *<partition>*\ ... + + **lmi** **partition** **show** [ \ *<partition>*\ ...] + + + +**Commands:** + + + **list** + List available partitions on given devices. + If no devices are provided, all partitions are listed. + + + **create** + Create a partition on given device. - create Create a partition on given device. + If no size is given, the resulting partition will occupy the + largest available space on disk. - If no size is given, the resulting partition will occupy the - largest available space on disk. + The command automatically creates extended and logical + partitions using these rules: - The command automatically creates extended and logical - partitions using these rules: + * If no partition type (logical or extended) is provided and + MS-DOS partition is requested and there is extended partition + already on the device, a logical partition is created. - * If no partition type (logical or extended) is provided and - MS-DOS partition is requested and there is extended partition - already on the device, a logical partition is created. + * If there is no extended partition on the device and there are + at most two primary partitions on the device, primary + partition is created. - * If there is no extended partition on the device and there are - at most two primary partitions on the device, primary partition - is created. + * If there is no extended partition and three primary partitions + already exist, new extended partition with all remaining space + is created and a logical partition with requested size is + created. - * If there is no extended partition and three primary partitions - already exist, new extended partition with all remaining space - is created and a logical partition with requested size is - created. - delete Delete given partitions. + **delete** + Delete given partitions. - show Show detailed information about given partitions. If no - partitions are provided, all of them are displayed. -Options: - size Size of the partition in sectors. - --logical Override the automatic behavior and request logical partition. - --extended Override the automatic behavior and request extended partition. + **show** + Show detailed information about given partitions. If no + partitions are provided, all of them are displayed. +**Options:** + + + **size** + Size of the partition in sectors. + + **--logical** + Override the automatic behavior and request logical partition. + + **--extended** + Override the automatic behavior and request extended partition. raid ---- MD RAID management. -Usage: - lmi raid list - lmi raid create [ --name=<name> ] <level> <devices>... - lmi raid delete <devices>... - lmi raid show [<devices>]... -Commands: - list List all MD RAID devices on the system. +**Usage:** + + **lmi** **raid** list + + **lmi** **raid** **create** [ \ **--name**\ =\ *<name>*\ ] \ *<level>*\ \ *<device>*\ ... + + **lmi** **raid** **delete** \ *<device>*\ ... + + **lmi** **raid** **show** [ \ *<device>*\ ...] + + + +**Commands:** - create Create MD RAID array with given RAID level from list of devices. - delete Delete given MD RAID devices. + **list** + List all MD RAID devices on the system. - show Show detailed information about given MD RAID devices. If no - devices are provided, all MD RAID devices are displayed. + **create** + Create MD RAID array with given RAID level from list of devices. + + + **delete** + Delete given MD RAID devices. + + + **show** + Show detailed information about given MD RAID devices. If no + devices are provided, all MD RAID devices are displayed. vg -- Volume Group management. -Usage: - lmi vg list - lmi vg create [ --extent-size=<size> ] <name> <devices>... - lmi vg delete <vgs>... - lmi vg show [<vgs>]... -Commands: - list List all volume groups on the system. +**Usage:** + + **lmi** **vg** list + + **lmi** **vg** **create** [ \ **--extent-size**\ =\ *<size>*\ ] \ *<name>*\ \ *<device>*\ ... + + **lmi** **vg** **delete** \ *<vg>*\ ... + + **lmi** **vg** **show** [ \ *<vg>*\ ...] + + + +**Commands:** + - create Create Volume Group with given name from list of devices. + **list** + List all volume groups on the system. - delete Delete given Volume Groups. - show Show detailed information about given Volume Groups. If no - Volume Groups are provided, all of them are displayed. + **create** + Create Volume Group with given name from list of devices. + **delete** + Delete given Volume Groups. + + + **show** + Show detailed information about given Volume Groups. If no + Volume Groups are provided, all of them are displayed. + lv ---- +-- Logical Volume management. -Usage: - lmi lv list [<vgs>]... - lmi lv create <vg> <name> <size> - lmi lv delete <lvs>... - lmi lv show [<lvs>]... -Commands: - list List available logical volumes on given volume groups. - If no volume groups are provided, all logical volumes are - listed. +**Usage:** + + **lmi** **lv** **list** [ \ *<vg>*\ ...] + + **lmi** **lv** **create** \ *<vg>*\ \ *<name>*\ \ *<size>*\ + + **lmi** **lv** **delete** \ *<lv>*\ ... + + **lmi** **lv** **show** [ \ *<lv>*\ ...] + + + +**Commands:** - create Create a logical volume on given volume group. - Size can be specified as number of extents using 'e' suffix, - e.g. '100e' is 100 extents. + **list** + List available logical volumes on given volume groups. + If no volume groups are provided, all logical volumes are + listed. - delete Delete given logical volume. - show Show detailed information about given Logical Volumes. If no - Logical Volumes are provided, all of them are displayed. + **create** + Create a logical volume on given volume group. + Size can be specified as number of extents using 'e' suffix, + e.g. '100e' is 100 extents. + + + **delete** + Delete given logical volume. + + + **show** + Show detailed information about given Logical Volumes. If no + Logical Volumes are provided, all of them are displayed. fs -- Filesystem and other data format management. -Usage: - lmi fs list [--all] [<devices>]... - lmi fs create [ --label=<label> ] <type> [<devices>]... - lmi fs delete <devices>... - lmi fs list-supported - -Commands: - list List filesystems and and other data formats (RAID metadata, ...) - on given devices. - If no devices are provided, all filesystems are listed. - If --all option is set, all filesystem, including system ones - like tmpfs, cgroups, procfs, sysfs etc are listed. - - create Format device(s) with given filesystem. - If more devices are given, the filesystem will span - over these devices (currently supported only by btrfs). - - For list of available filesystem types, see output of - %(cmd)s list-supported. - - delete Delete given filesystem or data format (like partition table, - RAID metadata, LUKS, physical volume metadata etc) - on given devices. - - list-supported - List supported filesystems, which can be used as - %(cmd)s create <type> option. + +**Usage:** + + **lmi** **fs** **list** [\ **--all**\ ] [ \ *<device>*\ ...] + + **lmi** **fs** **create** [ \ **--label**\ =\ *<label>*\ ] \ *<type>*\ \ *<device>*\ ... + + **lmi** **fs** **delete** \ *<device>*\ ... + + **lmi** **fs** list-supported + + + +**Commands:** + + + **list** + List filesystems and and other data formats (RAID metadata, ...) + on given devices. + If no devices are provided, all filesystems are listed. + If --all option is set, all filesystem, including system ones + like tmpfs, cgroups, procfs, sysfs etc are listed. + + + **create** + Format device(s) with given filesystem. + If more devices are given, the filesystem will span + over these devices (currently supported only by btrfs). + + For list of available filesystem types, see output of + lmi fs list-supported. + + + **delete** + Delete given filesystem or data format (like partition table, + RAID metadata, LUKS, physical volume metadata etc) + on given devices. + + + **list-supported** + + List supported filesystems, which can be used as + lmi fs create <type> option. + diff --git a/commands/storage/doc/conf.py b/commands/storage/doc/conf.py index e273622..8b9ee8c 100644 --- a/commands/storage/doc/conf.py +++ b/commands/storage/doc/conf.py @@ -128,7 +128,7 @@ html_static_path = ['_static'] # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +html_use_smartypants = False # Custom sidebar templates, maps document names to template names. #html_sidebars = {} |