mirror of
https://github.com/systemd/systemd-stable.git
synced 2024-12-24 21:34:08 +03:00
volume_id: generate man page from xml source
This commit is contained in:
Kay Sievers
parent
f05da2ae00
commit
cee5700cde
@ -7,7 +7,7 @@
|
|||||||
|
|
||||||
PROG = vol_id
|
PROG = vol_id
|
||||||
GEN_HEADERS =
|
GEN_HEADERS =
|
||||||
MAN_PAGES =
|
MAN_PAGES = vol_id.8
|
||||||
|
|
||||||
prefix =
|
prefix =
|
||||||
etcdir = ${prefix}/etc
|
etcdir = ${prefix}/etc
|
||||||
|
|||||||
@ -1,41 +1,48 @@
|
|||||||
.TH VOL_ID 8 "November 2005" "" "Linux Administrator's Manual"
|
.\" ** You probably do not want to edit this file directly **
|
||||||
.SH NAME
|
.\" 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
|
vol_id \- probe filesystem type and read label and uuid
|
||||||
.SH SYNOPSIS
|
.SH "SYNOPSIS"
|
||||||
.BI vol_id
|
.HP 7
|
||||||
[\fI--export\fP|\fI-t\fP|\fI-l\fP|\fI-u\fP] \fIblockdevice\fP
|
\fBvol_id\fR [\fB\-\-export\fR] [\fB\-t\fR] [\fB\-l\fR] [\fB\-u\fR] [\fIdevice\fR]
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
.B vol_id
|
.PP
|
||||||
is normally called from a udev rule, to provide udev with the
|
\fBvol_id\fR
|
||||||
label and uuid of a filesystem. vol_id supports all common
|
is usually called from a udev rule, to provide udev with the filesystem type, the label and the uuid of a volume.
|
||||||
filesystem formats and detects various raid setups to prevent
|
\fBvol_id\fR
|
||||||
the recognition of raid members as a filesystem.
|
supports all common filesystem formats and detects various raid setups to prevent the recognition of raid members as a volume with a filesystem.
|
||||||
.SH USAGE
|
.SH "OPTIONS"
|
||||||
.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:
|
|
||||||
.TP
|
.TP
|
||||||
.BI --export
|
\fB\-\-export\fR
|
||||||
print all values in key/value format to import them into the environment.
|
print all values in key/value format to import them into the environment.
|
||||||
.TP
|
.TP
|
||||||
.BI -l
|
\fB\-t\fR
|
||||||
print the label of the volume
|
print the filesystem type
|
||||||
.TP
|
.TP
|
||||||
.BI -t
|
\fB\-l\fR
|
||||||
print the type of the volume
|
print the label of a volume
|
||||||
.TP
|
.TP
|
||||||
.BI -u
|
\fB\-u\fR
|
||||||
print the uuid of the volume
|
print the uuid of a volume
|
||||||
.RE
|
.SH "ENVIRONMENT"
|
||||||
.SH EXIT STATUS
|
.TP
|
||||||
.B vol_id
|
\fBUDEV_LOG\fR
|
||||||
will only return successful if the string asked for is not empty.
|
Set the syslog priority.
|
||||||
All trailing whitespace will be removed, spaces replaced by underscore
|
.SH "EXIT STATUS"
|
||||||
and slashes ignored.
|
.PP
|
||||||
.SH SEE ALSO
|
\fBvol_id\fR
|
||||||
.BR udev (7)
|
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 AUTHORS
|
.SH "AUTHOR"
|
||||||
Developed by Kay Sievers <kay.sievers@vrfy.org>.
|
.PP
|
||||||
|
Written by Kay Sievers
|
||||||
|
<kay.sievers@vrfy.org>
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
.PP
|
||||||
|
\fBudev\fR(7)
|
||||||
|
|||||||
115
extras/volume_id/vol_id.xml
Normal file
115
extras/volume_id/vol_id.xml
Normal file
@ -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>
|
||||||
Loading…
Reference in New Issue
Block a user