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   <articleinfo>
   7     <title>xmlto</title>
   8     <author>
   9       <firstname>Kay</firstname>
  10       <surname>Sievers</surname>
  11       <email>kay.sievers@vrfy.org</email>
  12     </author>
  13     <copyright>
  14       <year>2006</year>
  15       <holder>Kay Sievers</holder>
  16     </copyright>
  17   </articleinfo>
  18
  19   <section>
  20     <title>vol_id</title>
  21     <refentry>
  22       <refentryinfo>
  23         <title>vol_id</title>
  24         <date>March 2006</date>
  25         <productname>volume_id</productname>
  26       </refentryinfo>
  27
  28       <refmeta>
  29         <refentrytitle>vol_id</refentrytitle>
  30         <manvolnum>8</manvolnum>
  31       </refmeta>
  32
  33       <refnamediv>
  34         <refname>vol_id</refname><refpurpose>probe filesystem type and read label and uuid</refpurpose>
  35       </refnamediv>
  36
  37       <refsynopsisdiv>
  38         <cmdsynopsis>
  39           <command>vol_id</command>
  40           <arg><option>--export</option></arg>
  41           <arg><option>-t</option></arg>
  42           <arg><option>-l</option></arg>
  43           <arg><option>-u</option></arg>
  44           <arg><replaceable>device</replaceable></arg>
  45         </cmdsynopsis>
  46       </refsynopsisdiv>
  47
  48       <refsect1><title>DESCRIPTION</title>
  49         <para><command>vol_id</command> is usually called from a udev rule, to
  50         provide udev with the filesystem type, the label and the uuid of a
  51         volume. <command>vol_id</command> supports all common filesystem formats
  52         and detects various raid setups to prevent the recognition of raid members
  53         as a volume with a filesystem.</para>
  54       </refsect1>
  55
  56       <refsect1><title>OPTIONS</title>
  57         <variablelist>
  58           <varlistentry>
  59             <term><option>--export</option></term>
  60             <listitem>
  61               <para>print all values in key/value format to import them into the
  62               environment.</para>
  63             </listitem>
  64           </varlistentry>
  65           <varlistentry>
  66             <term><option>-t</option></term>
  67             <listitem>
  68               <para>print the filesystem type</para>
  69             </listitem>
  70           </varlistentry>
  71           <varlistentry>
  72             <term><option>-l</option></term>
  73             <listitem>
  74               <para>print the label of a volume</para>
  75             </listitem>
  76           </varlistentry>
  77           <varlistentry>
  78             <term><option>-u</option></term>
  79             <listitem>
  80               <para>print the uuid of a volume</para>
  81             </listitem>
  82           </varlistentry>
  83         </variablelist>
  84       </refsect1>
  85
  86       <refsect1><title>ENVIRONMENT</title>
  87         <variablelist>
  88           <varlistentry>
  89             <term><option>UDEV_LOG</option></term>
  90             <listitem>
  91               <para>Set the syslog priority.</para>
  92             </listitem>
  93           </varlistentry>
  94         </variablelist>
  95       </refsect1>
  96
  97       <refsect1><title>EXIT STATUS</title>
  98         <para><command>vol_id</command> will only return successful if the
  99         value asked for is not empty. All trailing whitespace will be removed,
 100         spaces replaced by underscore and slashes ignored.</para>
 101      </refsect1>
 102
 103       <refsect1><title>AUTHOR</title>
 104         <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email></para>
 105       </refsect1>
 106
 107       <refsect1>
 108         <title>SEE ALSO</title>
 109         <para><citerefentry>
 110             <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
 111         </citerefentry></para>
 112       </refsect1>
 113     </refentry>
 114   </section>
 115 </article>