chiark / gitweb /
libvolume_id: recognize swap partitions with a tuxonice hibernate image
[elogind.git] / extras / volume_id / vol_id.8
index 6ffe7ce..daa583b 100644 (file)
@@ -1,41 +1,79 @@
-.TH VOL_ID 8 "November 2005" "" "Linux Administrator's Manual"
-.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
+.\"     Title: vol_id
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\"      Date: March 2006
+.\"    Manual: vol_id
+.\"    Source: volume_id
+.\"
+.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"
+.HP 7
+\fBvol_id\fR [\fB\-\-export\fR] [\fB\-\-type\fR] [\fB\-\-label\fR] [\fB\-\-label\-raw\fR] [\fB\-\-uuid\fR] [\fB\-\-skip\-raid\fR] [\fB\-\-probe\-all\fR] [\fB\-\-help\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:
-.TP
-.BI --export
-print all values in key/value format to import them into the environment.
-.TP
-.BI -l
-print the label of the partition
-.TP
-.BI -t
-print the type of the partition
-.TP
-.BI -u
-print the uuid of the partition
-.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 (8)
-.SH AUTHORS
-Developed by Kay Sievers <kay.sievers@vrfy.org>.
-
+.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\. 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\.
+.SH "OPTIONS"
+.PP
+\fB\-\-export\fR
+.RS 4
+Print all values in key/value format to import them into the environment\.
+.RE
+.PP
+\fB\-\-type\fR
+.RS 4
+Print the filesystem type\.
+.RE
+.PP
+\fB\-\-label\fR
+.RS 4
+Print the safe version of volume label suitable for use as filename\.
+.RE
+.PP
+\fB\-\-label\-raw\fR
+.RS 4
+Print the raw volume label\.
+.RE
+.PP
+\fB\-\-uuid\fR
+.RS 4
+Print the uuid of a volume\.
+.RE
+.PP
+\fB\-\-skip\-raid\fR
+.RS 4
+Skip detection of raid metadata\.
+.RE
+.PP
+\fB\-\-probe\-all\fR
+.RS 4
+Probe for all types and print all matches\.
+.RE
+.PP
+\fB\-\-help\fR
+.RS 4
+Print usage\.
+.RE
+.SH "ENVIRONMENT"
+.PP
+\fBUDEV_LOG\fR
+.RS 4
+Set the syslog priority\.
+.RE
+.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)