chiark / gitweb /
volume_id: update README
[elogind.git] / extras / volume_id / README
1 vol_id - probe filesystem and read label and uuid
2
3 This program is normally called from a udev rule, to provide udev with the
4 filesystem type of a volume and the label and uuid to name a device node.
5 vol_id opens the blockdevice node specified at the commandline. The following
6 commandline switches are supported to specify what vol_id should print:
7
8   --export prints all values
9   -h       prints help text
10   -l       prints the label of the volume
11   -u       prints the uuid of the volume
12
13 vol_id will only return successful if the string asked for, is not
14 empty. All trailing whitespace will be removed, spaces replaced by underscore
15 and slashes ignored.
16
17 fstype                 probe  label  uuid  fsversion
18 ----------------------------------------------------
19 linux swap             *      *      *     *
20 ext                    *      *      *     *
21 reiserfs jr/3.5/3.6/4  *      *      *     *
22 fat (12, 16, 32)       *      *      *     *
23 ntfs                   *      *      *     *
24 jfs                    *      *      *     -
25 xfs                    *      *      *     -
26 hfs (plus, wrapped)    *      *      *     -
27 udf                    *      *      -     -
28 iso9660                *      *      -     -
29 ufs                    *      -      -     -
30 cramfs                 *      *      -     -
31 sysv                   *      *      -     *
32 luks                   *      -      *     -
33 hpfs                   *      -      -     -
34 romfs                  *      *      -     -
35 squashfs               *      -      -     -
36 minix                  *      -      -     *
37 ocfs (1, 2)            *      *      *     *
38 vxfs                   *      -      -     *
39
40 Raid members are detected to prevent the probing for a filesystem
41 -----------------------------------------------------------------
42 linux raid             *      -      *     *
43 LVM 1                  *      -      -     -
44 LVM 2                  *      -      -     *
45 highpoint              *      -      -     -
46 isw_raid               *      -      -     -
47 lsi_raid               *      -      -     -
48 nvidia_raid            *      -      -     -
49 promise_raid           *      -      -     -
50 silicon_raid           *      -      -     -
51 via_raid               *      -      -     -
52
53
54 If no label is found vol_id exits with nonzero and the rule will be
55 ignored.
56
57 To give it a try, you may call it on the commandline:
58   $ extras/volume_id/vol_id --export /dev/sda6
59   ID_FS_USAGE=filesystem
60   ID_FS_TYPE=ext3
61   ID_FS_VERSION=1.0
62   ID_FS_UUID=3e999973-00c9-4917-9442-b7633bd95b9e
63   ID_FS_LABEL=devel
64   ID_FS_LABEL_SAFE=devel
65
66   $ extras/volume_id/vol_id -l /dev/sda6
67   devel
68
69   $ extras/volume_id/vol_id -t /dev/sda6
70   ext3
71
72
73 Any comment/questions/concerns to me:
74   Kay Sievers <kay.sievers@vrfy.org>