vol_id: add --offset option

[elogind.git] / extras / volume_id / README

diff --git a/extras/volume_id/README b/extras/volume_id/README
index d570615e10ad58d74e8a80b667606e15c6c4e456..217be3114c8e8a55340925237ffcc476dae64e38 100644 (file)
--- a/extras/volume_id/README
+++ b/extras/volume_id/README
@@ -1,43 +1,78 @@
-
-udev_volume_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
 
 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.
-udev_volume_id opens the blockdevice node specified at the commandline.
-The following commandline switches are supported to specify what udev_volume_id
-should print to stdout:
-
-       no option prints all values
-  -h   prints help text
-  -l   prints the label of the partition
-  -u   prints the uuid of the partition
+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

 
 

-udev_volume_id will only return successful if the string asked for, is not
+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.
 
 empty. All trailing whitespace will be removed, spaces replaced by underscore
 and slashes ignored.
 

-The following rule will create a symlink named with the label string:
-  KERNEL="[hs]d*", PROGRAM="/sbin/udev_volume_id -l %N", SYMLINK="%c"
+fstype                 probe  label  uuid  version
+--------------------------------------------------
+linux swap             *      *      *     *
+ext                    *      *      *     *
+reiserfs jr/3.5/3.6/4  *      *      *     *
+fat (12, 16, 32)       *      *      *     *
+ntfs                   *      *      *     *
+jfs                    *      *      *     -
+xfs                    *      *      *     -
+hfs (plus, wrapped)    *      *      *     -
+udf                    *      *      -     -
+iso9660                *      *      -     -
+ufs                    *      -      -     -
+cramfs                 *      *      -     -
+sysv                   *      *      -     *
+luks                   *      -      *     -
+hpfs                   *      -      -     -
+romfs                  *      *      -     -
+squashfs               *      -      -     -
+minix                  *      -      -     *
+ocfs (1, 2)            *      *      *     *
+vxfs                   *      -      -     *
+nss (netware)          *             *     *
+gfs, gfs2              *      -      -     -

 
 

-If no label is found udev_volume_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:
 
 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

 
 

-  [root@pim udev.kay]# extras/volume_id/udev_volume_id /dev/hda3
-  T:ext3
-  L:Music Store
-  N:Music_Store
-  U:d2da42b5-bbd9-44eb-a72c-cc4542fcb71e
-
-  [root@pim udev.kay]# extras/volume_id/udev_volume_id -l /dev/hda3
-  Music_Store
-
-  [root@pim udev.kay]# extras/volume_id/udev_volume_id -t /dev/hda3
-  swap
+  $ extras/volume_id/vol_id --label /dev/sda6
+  devel

 
 

+  $ extras/volume_id/vol_id --type /dev/sda6
+  ext3

 
 

-Please send any comment/questions/concerns to me or:
-       linux-hotplug-devel@lists.sourceforge.net

 
 

-Kay Sievers <kay.sievers@vrfy.org>
+Any comment/questions/concerns to me:
+  Kay Sievers <kay.sievers@vrfy.org>