systemd/extras/volume_id/vol_id.xml

<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article>
  <section>
    <title>vol_id</title>
    <refentry>
      <refentryinfo>
        <title>vol_id</title>
        <date>March 2006</date>
        <productname>volume_id</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>vol_id</refentrytitle>
        <manvolnum>8</manvolnum>
        <refmiscinfo class="version"></refmiscinfo>
      </refmeta>

      <refnamediv>
        <refname>vol_id</refname><refpurpose>probe filesystem type and read label and uuid</refpurpose>
      </refnamediv>

      <refsynopsisdiv>
        <cmdsynopsis>
          <command>vol_id</command>
          <arg><option>--export</option></arg>
          <arg><option>--type</option></arg>
          <arg><option>--label</option></arg>
          <arg><option>--label-raw</option></arg>
          <arg><option>--uuid</option></arg>
          <arg><option>--skip-raid</option></arg>
          <arg><option>--probe-all</option></arg>
          <arg><option>--offset=<replaceable>bytes</replaceable></option></arg>
          <arg><option>--debug</option></arg>
          <arg><option>--help</option></arg>
          <arg><replaceable>device</replaceable></arg>
        </cmdsynopsis>
      </refsynopsisdiv>

      <refsect1><title>DESCRIPTION</title>
        <para><command>vol_id</command> is usually called from a udev rule, to
        provide udev with the filesystem type, the label and the uuid of a
        volume. It supports most of the common filesystem formats and detects
        various raid setups to prevent the recognition of raid members
        as a volume with a filesystem.</para>
      </refsect1>

      <refsect1><title>OPTIONS</title>
        <variablelist>
          <varlistentry>
            <term><option>--export</option></term>
            <listitem>
              <para>Print all values in key/value format to import them into the
              environment.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--type</option></term>
            <listitem>
              <para>Print the filesystem type.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--label</option></term>
            <listitem>
              <para>
                Print the safe version of volume label suitable for
                use as filename.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--label-raw</option></term>
            <listitem>
              <para>
                Print the raw volume label.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--uuid</option></term>
            <listitem>
              <para>Print the uuid of a volume.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--skip-raid</option></term>
            <listitem>
              <para>Skip detection of raid metadata.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--probe-all</option></term>
            <listitem>
              <para>Probe for all types and print all matches.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--offset=<replaceable>bytes</replaceable></option></term>
            <listitem>
              <para>Probing at the given offset, instead of the start of the volume.
              The offset value is specified in bytes.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--debug</option></term>
            <listitem>
              <para>Print debug messages to stderr.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--help</option></term>
            <listitem>
              <para>Print usage.</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </refsect1>

      <refsect1><title>ENVIRONMENT</title>
        <variablelist>
          <varlistentry>
            <term><option>UDEV_LOG</option></term>
            <listitem>
              <para>Set the syslog priority.</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </refsect1>

      <refsect1><title>EXIT STATUS</title>
        <para><command>vol_id</command> will only return successful if the
        value asked for is not empty. All trailing whitespace will be removed,
        spaces replaced by underscore and slashes ignored.</para>
     </refsect1>

      <refsect1><title>AUTHOR</title>
        <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email></para>
      </refsect1>

      <refsect1>
        <title>SEE ALSO</title>
        <para><citerefentry>
            <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
        </citerefentry></para>
      </refsect1>
    </refentry>
  </section>
</article>