chiark / gitweb /
volume_id: add volume_id_get_* functions
[elogind.git] / extras / volume_id / vol_id.8
1 .\"     Title: vol_id
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
4 .\"      Date: March 2006
5 .\"    Manual: vol_id
6 .\"    Source: volume_id
7 .\"
8 .TH "VOL_ID" "8" "March 2006" "volume_id" "vol_id"
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 vol_id \- probe filesystem type and read label and uuid
15 .SH "SYNOPSIS"
16 .HP 7
17 \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]
18 .SH "DESCRIPTION"
19 .PP
20 \fBvol_id\fR
21 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.
22 .SH "OPTIONS"
23 .PP
24 \fB\-\-export\fR
25 .RS 4
26 Print all values in key/value format to import them into the environment.
27 .RE
28 .PP
29 \fB\-\-type\fR
30 .RS 4
31 Print the filesystem type.
32 .RE
33 .PP
34 \fB\-\-label\fR
35 .RS 4
36 Print the safe version of volume label suitable for use as filename.
37 .RE
38 .PP
39 \fB\-\-label\-raw\fR
40 .RS 4
41 Print the raw volume label.
42 .RE
43 .PP
44 \fB\-\-uuid\fR
45 .RS 4
46 Print the uuid of a volume.
47 .RE
48 .PP
49 \fB\-\-skip\-raid\fR
50 .RS 4
51 Skip detection of raid metadata.
52 .RE
53 .PP
54 \fB\-\-probe\-all\fR
55 .RS 4
56 Probe for all types and print all matches.
57 .RE
58 .PP
59 \fB\-\-help\fR
60 .RS 4
61 Print usage.
62 .RE
63 .SH "ENVIRONMENT"
64 .PP
65 \fBUDEV_LOG\fR
66 .RS 4
67 Set the syslog priority.
68 .RE
69 .SH "EXIT STATUS"
70 .PP
71 \fBvol_id\fR
72 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.
73 .SH "AUTHOR"
74 .PP
75 Written by Kay Sievers
76 <kay.sievers@vrfy.org>
77 .SH "SEE ALSO"
78 .PP
79 \fBudev\fR(7)