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>--type</option></arg>
  30           <arg><option>--label</option></arg>
  31           <arg><option>--label-raw</option></arg>
  32           <arg><option>--uuid</option></arg>
  33           <arg><option>--skip-raid</option></arg>
  34           <arg><option>--probe-all</option></arg>
  35           <arg><option>--offset=<replaceable>bytes</replaceable></option></arg>
  36           <arg><option>--debug</option></arg>
  37           <arg><option>--help</option></arg>
  38           <arg><replaceable>device</replaceable></arg>
  39         </cmdsynopsis>
  40       </refsynopsisdiv>
  41
  42       <refsect1><title>DESCRIPTION</title>
  43         <para><command>vol_id</command> is usually called from a udev rule, to
  44         provide udev with the filesystem type, the label and the uuid of a
  45         volume. It supports most of the common filesystem formats and detects
  46         various raid setups to prevent the recognition of raid members
  47         as a volume with a filesystem.</para>
  48       </refsect1>
  49
  50       <refsect1><title>OPTIONS</title>
  51         <variablelist>
  52           <varlistentry>
  53             <term><option>--export</option></term>
  54             <listitem>
  55               <para>Print all values in key/value format to import them into the
  56               environment.</para>
  57             </listitem>
  58           </varlistentry>
  59           <varlistentry>
  60             <term><option>--type</option></term>
  61             <listitem>
  62               <para>Print the filesystem type.</para>
  63             </listitem>
  64           </varlistentry>
  65           <varlistentry>
  66             <term><option>--label</option></term>
  67             <listitem>
  68               <para>
  69                 Print the safe version of volume label suitable for
  70                 use as filename.
  71               </para>
  72             </listitem>
  73           </varlistentry>
  74           <varlistentry>
  75             <term><option>--label-raw</option></term>
  76             <listitem>
  77               <para>
  78                 Print the raw volume label.
  79               </para>
  80             </listitem>
  81           </varlistentry>
  82           <varlistentry>
  83             <term><option>--uuid</option></term>
  84             <listitem>
  85               <para>Print the uuid of a volume.</para>
  86             </listitem>
  87           </varlistentry>
  88           <varlistentry>
  89             <term><option>--skip-raid</option></term>
  90             <listitem>
  91               <para>Skip detection of raid metadata.</para>
  92             </listitem>
  93           </varlistentry>
  94           <varlistentry>
  95             <term><option>--probe-all</option></term>
  96             <listitem>
  97               <para>Probe for all types and print all matches.</para>
  98             </listitem>
  99           </varlistentry>
 100           <varlistentry>
 101             <term><option>--offset=<replaceable>bytes</replaceable></option></term>
 102             <listitem>
 103               <para>Probing at the given offset, instead of the start of the volume.
 104               The offset value is specified in bytes.</para>
 105             </listitem>
 106           </varlistentry>
 107           <varlistentry>
 108             <term><option>--debug</option></term>
 109             <listitem>
 110               <para>Print debug messages to stderr.</para>
 111             </listitem>
 112           </varlistentry>
 113           <varlistentry>
 114             <term><option>--help</option></term>
 115             <listitem>
 116               <para>Print usage.</para>
 117             </listitem>
 118           </varlistentry>
 119         </variablelist>
 120       </refsect1>
 121
 122       <refsect1><title>ENVIRONMENT</title>
 123         <variablelist>
 124           <varlistentry>
 125             <term><option>UDEV_LOG</option></term>
 126             <listitem>
 127               <para>Set the syslog priority.</para>
 128             </listitem>
 129           </varlistentry>
 130         </variablelist>
 131       </refsect1>
 132
 133       <refsect1><title>EXIT STATUS</title>
 134         <para><command>vol_id</command> will only return successful if the
 135         value asked for is not empty. All trailing whitespace will be removed,
 136         spaces replaced by underscore and slashes ignored.</para>
 137      </refsect1>
 138
 139       <refsect1><title>AUTHOR</title>
 140         <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email></para>
 141       </refsect1>
 142
 143       <refsect1>
 144         <title>SEE ALSO</title>
 145         <para><citerefentry>
 146             <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
 147         </citerefentry></para>
 148       </refsect1>
 149     </refentry>
 150   </section>
 151 </article>