← Back to branch summary

~ubuntu-branches/ubuntu/lucid/loop-aes-utils/lucid-security

« back to all changes in this revision

Viewing changes to libs/blkid/bin/blkid.8

  • Committer: Bazaar Package Importer
  • Author(s): Max Vozeler
  • Date: 2009-07-06 02:08:18 UTC
  • mfrom: (1.3.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090706020818-11pxao7bhgjenfv9
Tags: 2.15.1~rc1-2
http://bugs.debian.org/535676
Disable ncurses (--without-ncurses), not used in
mount/. Fixes FTBFS (closes: #535676).

Show diffs side-by-side

added added

removed removed

Lines of Context:
libs/blkid/bin/blkid.8
 
1
.\" Copyright 2000 Andreas Dilger (adilger@turbolinux.com)
 
2
.\"
 
3
.\" This man page was created for blkid from e2fsprogs-1.25.
 
4
.\"
 
5
.\" This file may be copied under the terms of the GNU Public License.
 
6
.\"
 
7
.\" Based on uuidgen, Mon Sep 17 10:42:12 2000, Andreas Dilger
 
8
.TH BLKID 8 "February 2009" "Linux" "MAINTENANCE COMMANDS"
 
9
.SH NAME
 
10
blkid \- command\-line utility to locate/print block device attributes
 
11
.SH SYNOPSIS
 
12
.B blkid
 
13
.RB \-L
 
14
.IR label " | "
 
15
.RB \-U
 
16
.IR uuid
 
17
 
 
18
.B blkid
 
19
.RB [ \-ghlv ]
 
20
.RB [ \-c
 
21
.IR file ]
 
22
.RB [ \-w
 
23
.IR file ]
 
24
.RB [ \-o
 
25
.IR format ]
 
26
.in +6
 
27
.RB [ \-s
 
28
.IR tag ]
 
29
.RB [ \-t
 
30
.IR NAME=value ]
 
31
.I device
 
32
[\fIdevice\fR ...]
 
33
.in -6
 
34
 
 
35
.B blkid
 
36
.RB -p
 
37
.RB [ \-O
 
38
.IR offset ]
 
39
.RB [ \-S
 
40
.IR size ]
 
41
.RB [ \-o
 
42
.IR format ]
 
43
.RB [ \-u
 
44
.IR list ]
 
45
.I device
 
46
[\fIdevice\fR ...]
 
47
 
 
48
.SH DESCRIPTION
 
49
The
 
50
.B blkid
 
51
program is the command-line interface to working with
 
52
.BR libblkid (3)
 
53
library.  It can determine the type of content (e.g. filesystem, swap)
 
54
a block device holds, and also attributes (tokens, NAME=value pairs)
 
55
from the content metadata (e.g. LABEL or UUID fields).
 
56
.PP
 
57
.B blkid
 
58
has two main forms of operation: either searching for a device with a
 
59
specific NAME=value pair, or displaying NAME=value pairs for one or
 
60
more devices.
 
61
.SH OPTIONS
 
62
.TP
 
63
.BI \-c " cachefile"
 
64
Read from
 
65
.I cachefile
 
66
instead of reading from the default cache file
 
67
.IR /etc/blkid.tab .
 
68
If you want to start with a clean cache (i.e. don't report devices previously
 
69
scanned but not necessarily available at this time), specify
 
70
.IR /dev/null .
 
71
.TP
 
72
.B \-g
 
73
Perform a garbage collection pass on the blkid cache to remove
 
74
devices which no longer exist.
 
75
.TP
 
76
.B \-h
 
77
Display a usage message and exit.
 
78
.TP
 
79
.B \-l
 
80
Look up one device that matches the search parameter specified using
 
81
the
 
82
.B \-t
 
83
option.  If there are multiple devices that match the specified search
 
84
parameter, then the device with the highest priority is returned, and/or
 
85
the first device found at a given priority.  Device types in order of
 
86
decreasing priority are Device Mapper, EVMS, LVM, MD, and finally regular
 
87
block devices.  If this option is not specified,
 
88
.B blkid
 
89
will print all of the devices that match the search parameter.
 
90
.TP
 
91
.B \-L " label "
 
92
Look up one device that uses the label (same as: -l -o device -t
 
93
LABEL=<label>).  This look up method is able to reliable use /dev/disk/by-label
 
94
udev symlinks (depends on setting in /etc/blkid.conf). Avoid to use the
 
95
symlinks directly. It is not reliable to use the symlinks without verification.
 
96
The \fB-L\fR option is portable and works on systems with and without udev.
 
97
.TP
 
98
.B \-u " list "
 
99
Restrict probing functions to defined (comma separated) list of "usage" types.
 
100
Supported usage types are: filesystem, raid, crypto and other. The list can be
 
101
prefixed with "no" to specify the usage types which should be ignored. For example:
 
102
.sp
 
103
  blkid -p -u filesystem,other /dev/sda1
 
104
.sp
 
105
probes for all filesystems and others (e.g. swap) formats, and
 
106
.sp
 
107
  blkid -p -u noraid /dev/sda1
 
108
.sp
 
109
probes for all supported formats exclude RAIDs. This option is useful with
 
110
\fB-p\fR only.
 
111
.TP
 
112
.B \-U " uuid "
 
113
Look up one device that uses the uuid. For more details see the \fB-L\fR option.
 
114
.TP
 
115
.BI \-o " format"
 
116
Display
 
117
.BR blkid 's
 
118
output using the specified format.  The
 
119
.I format
 
120
parameter may be:
 
121
.RS
 
122
.TP
 
123
.B full
 
124
print all tags (the default)
 
125
.TP
 
126
.B value
 
127
print the value of the tags
 
128
.TP
 
129
.B list
 
130
print the devices in a user-friendly format
 
131
.TP
 
132
.B device
 
133
print the device name only
 
134
.TP
 
135
.B udev
 
136
vol_id compatible mode; usable in udev rules
 
137
.RE
 
138
.TP
 
139
.BI \-O " bytes"
 
140
Probe at the given offset (only useful with \fB-p\fR).
 
141
.TP
 
142
.BI \-p
 
143
Switch to low-level probing mode (bypass cache)"
 
144
.TP
 
145
.BI \-s " tag"
 
146
For each (specified) device, show only the tags that match
 
147
.IR tag .
 
148
It is possible to specify multiple
 
149
.B \-s
 
150
options.  If no tag is specified, then all tokens are shown for all
 
151
(specified) devices.
 
152
In order to just refresh the cache without showing any tokens, use
 
153
.B "-s none"
 
154
with no other options.
 
155
.TP
 
156
.BI \-S " bytes"
 
157
Overwrite device/file size (only useful with \fB-p\fR).
 
158
.TP
 
159
.BI \-t " NAME" = "value"
 
160
Search for block devices with tokens named
 
161
.I NAME
 
162
that have the value
 
163
.IR value ,
 
164
and display any devices which are found.
 
165
Common values for
 
166
.I NAME
 
167
include
 
168
.BR TYPE ,
 
169
.BR LABEL ,
 
170
and
 
171
.BR UUID .
 
172
If there are no devices specified on the command line, all block devices
 
173
will be searched; otherwise only the specified devices are searched.
 
174
.TP
 
175
.B \-v
 
176
Display version number and exit.
 
177
.TP
 
178
.BI \-w " writecachefile"
 
179
Write the device cache to
 
180
.I writecachefile
 
181
instead of writing it to the default cache file
 
182
.IR /etc/blkid.tab .
 
183
If you don't want to save the cache to the default file, specify
 
184
.IR /dev/null.
 
185
If not specified it will be the same file as that given by the
 
186
.B \-c
 
187
option.
 
188
.TP
 
189
.I device
 
190
Display tokens from only the specified device.  It is possible to
 
191
give multiple
 
192
.I device
 
193
options on the command line.  If none is given, all devices which
 
194
appear in
 
195
.I /proc/partitions
 
196
are shown, if they are recognized.
 
197
.SH "RETURN CODE"
 
198
If the specified token was found, or if any tags were shown from (specified)
 
199
devices, 0 is returned.  If the specified token was not found, or no
 
200
(specified) devices could be identified, an exit code of 2 is returned.
 
201
For usage or other errors, an exit code of 4 is returned.
 
202
.SH AUTHOR
 
203
.B blkid
 
204
was written by Andreas Dilger for libblkid and improved by Theodore Ts'o
 
205
and Karel Zak.
 
206
.SH AVAILABILITY
 
207
The blkid command is part of the util-linux-ng package and is available from
 
208
ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.
 
209
.SH "SEE ALSO"
 
210
.BR libblkid (3)
 
211
.BR findfs (8)