diff options
| -rw-r--r-- | extras/volume_id/Makefile | 2 | ||||
| -rw-r--r-- | extras/volume_id/vol_id.8 | 75 | ||||
| -rw-r--r-- | extras/volume_id/vol_id.xml | 115 |
3 files changed, 157 insertions, 35 deletions
diff --git a/extras/volume_id/Makefile b/extras/volume_id/Makefile index f8d54a2309..0b22fb9c2d 100644 --- a/extras/volume_id/Makefile +++ b/extras/volume_id/Makefile @@ -7,7 +7,7 @@ PROG = vol_id GEN_HEADERS = -MAN_PAGES = +MAN_PAGES = vol_id.8 prefix = etcdir = ${prefix}/etc diff --git a/extras/volume_id/vol_id.8 b/extras/volume_id/vol_id.8 index d84ca8311a..9f5a9c5d8e 100644 --- a/extras/volume_id/vol_id.8 +++ b/extras/volume_id/vol_id.8 @@ -1,41 +1,48 @@ -.TH VOL_ID 8 "November 2005" "" "Linux Administrator's Manual" -.SH NAME +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "VOL_ID" "8" "March 2006" "volume_id" "vol_id" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" vol_id \- probe filesystem type and read label and uuid -.SH SYNOPSIS -.BI vol_id -[\fI--export\fP|\fI-t\fP|\fI-l\fP|\fI-u\fP] \fIblockdevice\fP +.SH "SYNOPSIS" +.HP 7 +\fBvol_id\fR [\fB\-\-export\fR] [\fB\-t\fR] [\fB\-l\fR] [\fB\-u\fR] [\fIdevice\fR] .SH "DESCRIPTION" -.B vol_id -is normally called from a udev rule, to provide udev with the -label and uuid of a filesystem. vol_id supports all common -filesystem formats and detects various raid setups to prevent -the recognition of raid members as a filesystem. -.SH USAGE -.B vol_id -opens the device node specified at the commandline. -.SH OPTIONS -The following commandline switches are supported to specify what vol_id -should print: +.PP +\fBvol_id\fR +is usually called from a udev rule, to provide udev with the filesystem type, the label and the uuid of a volume. +\fBvol_id\fR +supports all common filesystem formats and detects various raid setups to prevent the recognition of raid members as a volume with a filesystem. +.SH "OPTIONS" .TP -.BI --export +\fB\-\-export\fR print all values in key/value format to import them into the environment. .TP -.BI -l -print the label of the volume +\fB\-t\fR +print the filesystem type .TP -.BI -t -print the type of the volume +\fB\-l\fR +print the label of a volume .TP -.BI -u -print the uuid of the volume -.RE -.SH EXIT STATUS -.B vol_id -will only return successful if the string asked for is not empty. -All trailing whitespace will be removed, spaces replaced by underscore -and slashes ignored. -.SH SEE ALSO -.BR udev (7) -.SH AUTHORS -Developed by Kay Sievers <kay.sievers@vrfy.org>. - +\fB\-u\fR +print the uuid of a volume +.SH "ENVIRONMENT" +.TP +\fBUDEV_LOG\fR +Set the syslog priority. +.SH "EXIT STATUS" +.PP +\fBvol_id\fR +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. +.SH "AUTHOR" +.PP +Written by Kay Sievers +<kay.sievers@vrfy.org> +.SH "SEE ALSO" +.PP +\fBudev\fR(7) diff --git a/extras/volume_id/vol_id.xml b/extras/volume_id/vol_id.xml new file mode 100644 index 0000000000..0d4130e33f --- /dev/null +++ b/extras/volume_id/vol_id.xml @@ -0,0 +1,115 @@ +<?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> + <articleinfo> + <title>xmlto</title> + <author> + <firstname>Kay</firstname> + <surname>Sievers</surname> + <email>kay.sievers@vrfy.org</email> + </author> + <copyright> + <year>2006</year> + <holder>Kay Sievers</holder> + </copyright> + </articleinfo> + + <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> + </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>-t</option></arg> + <arg><option>-l</option></arg> + <arg><option>-u</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. <command>vol_id</command> supports all 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>-t</option></term> + <listitem> + <para>print the filesystem type</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-l</option></term> + <listitem> + <para>print the label of a volume</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-u</option></term> + <listitem> + <para>print the uuid of a volume</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> |