chiark / gitweb /
volume_id: old md metadata has only 32 bit for the uuid
[elogind.git] / extras / volume_id / vol_id.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <article>
6   <section>
7     <title>vol_id</title>
8     <refentry>
9       <refentryinfo>
10         <title>vol_id</title>
11         <date>March 2006</date>
12         <productname>volume_id</productname>
13       </refentryinfo>
14
15       <refmeta>
16         <refentrytitle>vol_id</refentrytitle>
17         <manvolnum>8</manvolnum>
18         <refmiscinfo class="version"></refmiscinfo>
19       </refmeta>
20
21       <refnamediv>
22         <refname>vol_id</refname><refpurpose>probe filesystem type and read label and uuid</refpurpose>
23       </refnamediv>
24
25       <refsynopsisdiv>
26         <cmdsynopsis>
27           <command>vol_id</command>
28           <arg><option>--export</option></arg>
29           <arg><option>-t</option></arg>
30           <arg><option>-l</option></arg>
31           <arg><option>-u</option></arg>
32           <arg><replaceable>device</replaceable></arg>
33         </cmdsynopsis>
34       </refsynopsisdiv>
35
36       <refsect1><title>DESCRIPTION</title>
37         <para><command>vol_id</command> is usually called from a udev rule, to
38         provide udev with the filesystem type, the label and the uuid of a
39         volume. <command>vol_id</command> supports all common filesystem formats
40         and detects various raid setups to prevent the recognition of raid members
41         as a volume with a filesystem.</para>
42       </refsect1>
43
44       <refsect1><title>OPTIONS</title>
45         <variablelist>
46           <varlistentry>
47             <term><option>--export</option></term>
48             <listitem>
49               <para>print all values in key/value format to import them into the
50               environment.</para>
51             </listitem>
52           </varlistentry>
53           <varlistentry>
54             <term><option>-t</option></term>
55             <listitem>
56               <para>print the filesystem type</para>
57             </listitem>
58           </varlistentry>
59           <varlistentry>
60             <term><option>-l</option></term>
61             <listitem>
62               <para>
63                 print the safe version of volume label suitable for
64                 use as filename. Use <option>-L</option> to print literal label
65               </para>
66             </listitem>
67           </varlistentry>
68           <varlistentry>
69             <term><option>-u</option></term>
70             <listitem>
71               <para>print the uuid of a volume</para>
72             </listitem>
73           </varlistentry>
74           <varlistentry>
75             <term><option>-L</option></term>
76             <listitem>
77               <para>
78                 print raw volume label
79               </para>
80             </listitem>
81           </varlistentry>
82         </variablelist>
83       </refsect1>
84
85       <refsect1><title>ENVIRONMENT</title>
86         <variablelist>
87           <varlistentry>
88             <term><option>UDEV_LOG</option></term>
89             <listitem>
90               <para>Set the syslog priority.</para>
91             </listitem>
92           </varlistentry>
93         </variablelist>
94       </refsect1>
95
96       <refsect1><title>EXIT STATUS</title>
97         <para><command>vol_id</command> will only return successful if the
98         value asked for is not empty. All trailing whitespace will be removed,
99         spaces replaced by underscore and slashes ignored.</para>
100      </refsect1>
101
102       <refsect1><title>AUTHOR</title>
103         <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email></para>
104       </refsect1>
105
106       <refsect1>
107         <title>SEE ALSO</title>
108         <para><citerefentry>
109             <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
110         </citerefentry></para>
111       </refsect1>
112     </refentry>
113   </section>
114 </article>