X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=extras%2Fvolume_id%2FREADME;h=be98df9b12c1390a2e2e557627210c2a51523e94;hp=974a5016d9e1f5cdafd781cf3c08eb722d325337;hb=f05da2ae00de9fedaabb59dbf9a18b63175c5d40;hpb=b0f57eb066cd897dab536ee37daab4239d136d4c

diff --git a/extras/volume_id/README b/extras/volume_id/README
index 974a5016d..be98df9b1 100644
--- a/extras/volume_id/README
+++ b/extras/volume_id/README
@@ -1,15 +1,14 @@
-vol_id - partition, 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 partition 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:
+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 prints all values
   -h       prints help text
-  -l       prints the label of the partition
-  -u       prints the uuid of the partition
+  -l       prints the label of the volume
+  -u       prints the uuid of the volume
 
 vol_id will only return successful if the string asked for, is not
 empty. All trailing whitespace will be removed, spaces replaced by underscore
@@ -17,6 +16,7 @@ and slashes ignored.
 
 fstype                 probe  label  uuid  fsversion
 ----------------------------------------------------
+linux swap             *      *      *     *
 ext                    *      *      *     *
 reiserfs jr/3.5/3.6/4  *      *      *     *
 fat (12, 16, 32)       *      *      *     *
@@ -25,48 +25,50 @@ jfs                    *      *      *     -
 xfs                    *      *      *     -
 hfs (plus, wrapped)    *      *      *     -
 udf                    *      *      -     -
-iso9660                *      *      n/a   -
+iso9660                *      *      -     -
 ufs                    *      -      -     -
-linux swap             *      *      *     *
-LVM 1                  *      -      -     -
-LVM 2                  *      -      -     *
-linux raid             *      -      *     *
 cramfs                 *      *      -     -
 sysv                   *      *      -     *
 luks                   *      -      *     -
 hpfs                   *      -      -     -
-romfs                  *
-minix                  *
-highpoint              *
-isw_raid               *
-lsi_raid               *
-nvidia_raid            *
-promise_raid           *
-silicon_raid           *
-via_raid               *
-mac partitons          *
-msdos partitions       *
+romfs                  *      *      -     -
+squashfs               *      -      -     -
+minix                  *      -      -     *
+ocfs (1, 2)            *      *      *     *
+vxfs                   *      -      -     *
 
+Raid members are detected to prevent the probing for a filesystem
+-----------------------------------------------------------------
+linux raid             *      -      *     *
+LVM 1                  *      -      -     -
+LVM 2                  *      -      -     *
+highpoint              *      -      -     -
+isw_raid               *      -      -     -
+lsi_raid               *      -      -     -
+nvidia_raid            *      -      -     -
+promise_raid           *      -      -     -
+silicon_raid           *      -      -     -
+via_raid               *      -      -     -
 
-The following rule will create a symlink named with the label string:
-  KERNEL=="[hs]d*", PROGRAM=="/sbin/vol_id -l %N", SYMLINK+="%c"
 
 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:
-  [root@pim udev.kay]# extras/volume_id/vol_id /dev/hda3
-  T:ext3
-  L:Music Store
-  N:Music_Store
-  U:d2da42b5-bbd9-44eb-a72c-cc4542fcb71e
+  $ 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
 
-  [root@pim udev.kay]# extras/volume_id/vol_id -l /dev/hda3
-  Music_Store
+  $ extras/volume_id/vol_id -l /dev/sda6
+  devel
 
-  [root@pim udev.kay]# extras/volume_id/vol_id -t /dev/hda3
-  swap
+  $ extras/volume_id/vol_id -t /dev/sda6
+  ext3
 
 
 Any comment/questions/concerns to me:
-Kay Sievers <kay.sievers@vrfy.org>
+  Kay Sievers <kay.sievers@vrfy.org>