udevadm: add --version --help options to man page, hide them as commands

[elogind.git] / extras / volume_id / README

diff --git a/extras/volume_id/README b/extras/volume_id/README
index 969f301a4cc53ffa1a9ee0a6cf2baa6a5adc4d74..0c5e37f9691c2fb00ec124b8e5b18a6e80e8cafc 100644 (file)
--- a/extras/volume_id/README
+++ b/extras/volume_id/README
@@ -1,22 +1,25 @@
-vol_id - volume, filesystem, disklabel reader
+vol_id - probe filesystem and read label and uuid
 
 This program is normally called from a udev rule, to provide udev with the
-name, uuid or the filesystem type of a volume to name a device node.
-vol_id opens the blockdevice node specified at the commandline.
-The following commandline switches are supported to specify what vol_id
-should print:
-
-  --export prints all values
-  -h       prints help text
-  -l       prints the label of the volume
-  -u       prints the uuid of the volume
+filesystem type of a volume and the label and uuid to name a device node.
+vol_id opens the blockdevice node specified at the commandline. The following
+commandline switches are supported to specify what vol_id should print:
+  --export        export key/value pairs
+  --type          filesystem type
+  --label         filesystem label
+  --label-raw     raw label
+  --uuid          filesystem uuid
+  --skip-raid     don't probe for raid
+  --probe-all     find possibly conflicting signatures
+  --help
 
 vol_id will only return successful if the string asked for, is not
 empty. All trailing whitespace will be removed, spaces replaced by underscore
 and slashes ignored.
 
-fstype                 probe  label  uuid  fsversion
-----------------------------------------------------
+fstype                 probe  label  uuid  version
+--------------------------------------------------
+linux swap             *      *      *     *
 ext                    *      *      *     *
 reiserfs jr/3.5/3.6/4  *      *      *     *
 fat (12, 16, 32)       *      *      *     *
@@ -25,30 +28,36 @@ jfs                    *      *      *     -
 xfs                    *      *      *     -
 hfs (plus, wrapped)    *      *      *     -
 udf                    *      *      -     -
-iso9660                *      *      n/a   -
+iso9660                *      *      -     -
 ufs                    *      -      -     -
-linux swap             *      *      *     *
-LVM 1                  *      -      -     -
-LVM 2                  *      -      -     *
-linux raid             *      -      *     *
 cramfs                 *      *      -     -
 sysv                   *      *      -     *
 luks                   *      -      *     -
 hpfs                   *      -      -     -
-romfs                  *
-squashfs               *
-minix                  *
-highpoint              *
-isw_raid               *
-lsi_raid               *
-nvidia_raid            *
-promise_raid           *
-silicon_raid           *
-via_raid               *
-
+romfs                  *      *      -     -
+squashfs               *      -      -     -
+minix                  *      -      -     *
+ocfs (1, 2)            *      *      *     *
+vxfs                   *      -      -     *
+nss (netware)          *             *     *
+gfs, gfs2              *      *      -     -
+oracleasm              *      *      -     -
 
-If no label is found vol_id exits with nonzero and the rule will be
-ignored.
+Raid members are detected to prevent the probing for a filesystem
+-----------------------------------------------------------------
+linux raid (md)        *      *      *     *
+LVM 1                  *      -      -     -
+LVM 2                  *      -      -     *
+ddf                    *      -      *     *
+highpoint              *      -      -     -
+isw_raid               *      -      -     -
+lsi_raid               *      -      -     -
+nvidia_raid            *      -      -     -
+promise_raid           *      -      -     -
+silicon_raid           *      -      -     -
+via_raid               *      -      -     -
+jmicron                *      -      -     -
+adaptec                *      -      -     -
 
 To give it a try, you may call it on the commandline:
   $ extras/volume_id/vol_id --export /dev/sda6
@@ -59,10 +68,10 @@ To give it a try, you may call it on the commandline:
   ID_FS_LABEL=devel
   ID_FS_LABEL_SAFE=devel
 
-  $ extras/volume_id/vol_id -l /dev/sda6
+  $ extras/volume_id/vol_id --label /dev/sda6
   devel
 
-  $ extras/volume_id/vol_id -t /dev/sda6
+  $ extras/volume_id/vol_id --type /dev/sda6
   ext3