misc/blkid.8.in

   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 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   9 .SH NAME
  10 blkid \- command\-line utility to locate/print block device attributes
  11 .SH SYNOPSIS
  12 .B blkid
  13 [
  14 .B \-ghlv
  15 ]
  16 [
  17 [
  18 .B \-c
  19 .I cachefile
  20 ]
  21 .B \-w
  22 .I writecachefile
  23 ]
  24 [
  25 .B \-o
  26 .I format
  27 ]
  28 [
  29 .B \-s
  30 .I tag
  31 ]
  32 [
  33 .B \-t
  34 .IR NAME = value
  35 ]
  36 [
  37 .I device ...
  38 ]
  39 .SH DESCRIPTION
  40 The
  41 .B blkid
  42 program is the command-line interface to working with
  43 .BR libblkid (3)
  44 library.  It can determine the type of content (e.g. filesystem, swap)
  45 a block device holds, and also attributes (tokens, NAME=value pairs)
  46 from the content metadata (e.g. LABEL or UUID fields).
  47 .PP
  48 .B blkid
  49 has two main forms of operation: either searching for a device with a
  50 specific NAME=value pair, or displaying NAME=value pairs for one or
  51 more devices.
  52 .SH OPTIONS
  53 .TP
  54 .B \-c
  55 Read from
  56 .I cachefile
  57 instead of reading from the default cache file
  58 .IR /etc/blkid.tab .
  59 If you want to start with a clean cache (i.e. don't report devices previously
  60 scanned but not necessarily available at this time), specify
  61 .IR /dev/null.
  62 .TP
  63 .B \-g
  64 Perform a garbage collection pass on the blkid cache.
  65 .TP
  66 .B \-h
  67 Display a usage message and exit.
  68 .TP
  69 .B \-l
  70 Look up one device that matches the search parameter specified using
  71 the
  72 .B \-t
  73 option.  If there are multiple devices that match the specified search
  74 parameter, then the device with the highest priority is returned, and/or
  75 the first device found at a given priority.  Device types in order of
  76 decreasing priority are Device Mapper, EVMS, LVM, MD, and finally regular
  77 block devices.  If this option is not specified,
  78 .B blkid
  79 will print all of the devices that match the search parameter.
  80 .TP
  81 .B \-o
  82 Display
  83 .BR blkid 's
  84 output using the specified format.  The
  85 .I format
  86 parameter may be
  87 .IR full ,
  88 (the default),
  89 .IR  value ,
  90 (only print the value of any tags printed by
  91 .BR blkid)
  92 or
  93 .I device
  94 (only print the device name).
  95 .TP
  96 .B \-s
  97 Show only the tags for each (specified) device that match
  98 .IR tag .
  99 It is possible to specify multiple
 100 .B \-s
 101 options.  If no tag is specified, then all tokens are shown for all
 102 (specified) devices.
 103 In order to just refresh the cache without showing any tokens use
 104 .B "-s none"
 105 with no other options.
 106 .TP
 107 .B \-t
 108 Search for block devices with tokens named
 109 .I NAME
 110 that have the value
 111 .IR value ,
 112 and display any devices which are found.
 113 Common values for
 114 .I NAME
 115 include
 116 .BR TYPE ,
 117 .BR LABEL ,
 118 and
 119 .BR UUID .
 120 If there are no devices specified on the command line, all block devices
 121 will be searched; otherwise, only search the devices specified by the user.
 122 .TP
 123 .B \-v
 124 Display version number and exit.
 125 .TP
 126 .B \-w
 127 .I <writecachefile>
 128 Write the device cache to
 129 .I writecachefile
 130 instead of writing it to the default cache file
 131 .IR /etc/blkid.tab .
 132 If you don't want to save the cache to the default file, specify
 133 .IR /dev/null.
 134 If not specified it will be the same file as that given by the
 135 .B \-c
 136 option.
 137 .TP
 138 .I <device>
 139 Display tokens from only the specified device.  It is possible to
 140 give multiple
 141 .I <device>
 142 options on the command line.  If none is given, all devices which
 143 appear in
 144 .I /proc/partitions
 145 are shown, if they are recognized.
 146 .SH "RETURN CODE"
 147 If the specified token was found, or if any tags were shown from (specified)
 148 devices 0 is returned.  If the specified token was not found, or no
 149 (specified) devices could be identified, an exit code of 2 is returned.
 150 For usage or other errors, an exit code of 4 is returned.
 151 .SH AUTHOR
 152 .B blkid
 153 was written by Andreas Dilger for libblkid.
 154 .SH AVAILABILITY
 155 .B blkid
 156 is part the e2fsprogs package since version 1.26 and is available from
 157 http://e2fsprogs.sourceforge.net.
 158 .SH "SEE ALSO"
 159 .BR libblkid (3)