chiark / gitweb /
update TODO
[elogind.git] / extras / volume_id / README
index 9d881a1..9459c88 100644 (file)
@@ -1,49 +1,66 @@
+vol_id - probe filesystem and read label and uuid
 
-udev_volume_id - partition, filesystem, disklabel reader
+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.
 
-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 specified by the environment variable
-DEVPATH and searches for a filesystem superblock to read the label. The
-following commandline switches are supported to specify what udev_volume_id
-should print to stdout:
+  $ 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
 
-       no option prints all values
-  -h   prints help text
-  -l   prints the label of the partition
-  -u   prints the uuid of the partition
-  -d   read disk instead of partition
+  $ extras/volume_id/vol_id --label /dev/sda6
+  devel
 
-If -d is specified udev_volume_id tries to read the label from the main
-block device where the partition belongs to. For now this is only useful
-for s390 dasd labels.
+  $ extras/volume_id/vol_id --type /dev/sda6
+  ext3
 
-udev_volume_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.
 
-The following rule will create a symlink named with the label string:
-  KERNEL="[hs]d*", PROGRAM="/sbin/udev_volume_id -l", SYMLINK="%c"
+fstype                 probe  label  uuid  version
+--------------------------------------------------
+linux swap             *      *      *     *
+btrfs                  *      *      *     -
+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              *      *      *     -
+oracleasm              *      *      -     -
 
-If no label is found udev_volume_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]# DEVPATH=/block/hda/hda3 extras/volume_id/udev_volume_id
-  T:ext3
-  L:Music Store
-  N:Music_Store
-  U:d2da42b5-bbd9-44eb-a72c-cc4542fcb71e
-
-  [root@pim udev.kay]# DEVPATH=/block/hda/hda3 extras/volume_id/udev_volume_id -l
-  Music_Store
-
-  [root@pim udev.kay]# DEVPATH=/block/hda/hda1 extras/volume_id/udev_volume_id -t
-  swap
-
-
-Please send any comment/questions/concerns to me or:
-       linux-hotplug-devel@lists.sourceforge.net
-
-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                *      -      -     -