update TODO

[elogind.git] / extras / volume_id / README

diff --git a/extras/volume_id/README b/extras/volume_id/README
index 969f301a4cc53ffa1a9ee0a6cf2baa6a5adc4d74..9459c880f8ba10f57a754f46022194749b8a482c 100644 (file)
--- a/extras/volume_id/README
+++ b/extras/volume_id/README
@@ -1,22 +1,31 @@
-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:
+vol_id will only return with a non-zero exit code if the string asked for,
+is not empty. All trailing whitespace will be removed, spaces replaced by
+underscore and slashes ignored.
+Unmangled values are available in the --export mode as hex-encoded strings
+in *_ENC= keys.

 
 

-  --export prints all values
-  -h       prints help text
-  -l       prints the label of the volume
-  -u       prints the uuid of the volume
+  $ extras/volume_id/vol_id --export /dev/sda6
+  ID_FS_USAGE=filesystem
+  ID_FS_TYPE=ext3
+  ID_FS_VERSION=1.0
+  ID_FS_UUID=3e999973-00c9-4917-9442-b7633bd95b9e
+  ID_FS_UUID_ENC=3e999973-00c9-4917-9442-b7633bd95b9e
+  ID_FS_LABEL=devel
+  ID_FS_LABEL_ENC=devel

 
 

-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.
+  $ extras/volume_id/vol_id --label /dev/sda6
+  devel

 
 

-fstype                 probe  label  uuid  fsversion
-----------------------------------------------------
+  $ extras/volume_id/vol_id --type /dev/sda6
+  ext3
+
+
+fstype                 probe  label  uuid  version
+--------------------------------------------------
+linux swap             *      *      *     *
+btrfs                  *      *      *     -

 ext                    *      *      *     *
 reiserfs jr/3.5/3.6/4  *      *      *     *
 fat (12, 16, 32)       *      *      *     *
 ext                    *      *      *     *
 reiserfs jr/3.5/3.6/4  *      *      *     *
 fat (12, 16, 32)       *      *      *     *


@@ -25,46 +34,33 @@ jfs                    *      *      *     -
 xfs                    *      *      *     -
 hfs (plus, wrapped)    *      *      *     -
 udf                    *      *      -     -
 xfs                    *      *      *     -
 hfs (plus, wrapped)    *      *      *     -
 udf                    *      *      -     -

-iso9660                *      *      n/a   -
+iso9660                *      *      -     -

 ufs                    *      -      -     -
 ufs                    *      -      -     -

-linux swap             *      *      *     *
-LVM 1                  *      -      -     -
-LVM 2                  *      -      -     *
-linux raid             *      -      *     *

 cramfs                 *      *      -     -
 sysv                   *      *      -     *
 luks                   *      -      *     -
 cramfs                 *      *      -     -
 sysv                   *      *      -     *
 luks                   *      -      *     -

-hpfs                   *      -      -     -
-romfs                  *
-squashfs               *
-minix                  *
-highpoint              *
-isw_raid               *
-lsi_raid               *
-nvidia_raid            *
-promise_raid           *
-silicon_raid           *
-via_raid               *
-
+hpfs                   *      *      -     -
+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.
-
-To give it a try, you may call it on the commandline:
-  $ extras/volume_id/vol_id --export /dev/sda6
-  ID_FS_USAGE=filesystem
-  ID_FS_TYPE=ext3
-  ID_FS_VERSION=1.0
-  ID_FS_UUID=3e999973-00c9-4917-9442-b7633bd95b9e
-  ID_FS_LABEL=devel
-  ID_FS_LABEL_SAFE=devel
-
-  $ extras/volume_id/vol_id -l /dev/sda6
-  devel
-
-  $ extras/volume_id/vol_id -t /dev/sda6
-  ext3
-
-
-Any comment/questions/concerns to me:
-  Kay Sievers <kay.sievers@vrfy.org>
+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                *      -      -     -