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 \-hlv
  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 libuuid (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 \-h
  64 Display a usage message and exit.
  65 .TP
  66 .B \-l
  67 Look up the device that matches the search parameter specified using
  68 the
  69 .B \-t
  70 option, assuming that there is only one matching the search parameter.
  71 For a system with a large number of disks, this will be more
  72 efficient by avoiding the need to revalidate devices unless absolutely
  73 necessary.  If this option is not specified,
  74 .B blkid
  75 will use a less efficient approach, which allows
  76 .B blkid
  77 to print all of the devices that match the search parameter.
  78 .IP
  79 This option is best used for tag searches such as
  80 .I LABEL=data_vol
  81 or
  82 .IR UUID=e280469a-d06f-4c0b-b068-44f3b576029e .
  83 If you want
  84 .B blkid
  85 to print all of the ext3 filesystems using a search parameter
  86 such as
  87 .IR TYPE=ext3 ,
  88 then this option should
  89 .I not
  90 be used.
  91 .TP
  92 .B \-o
  93 Display
  94 .BR blkid 's
  95 output using the specified format.  The
  96 .I format
  97 parameter may be
  98 .IR full ,
  99 (the default),
 100 .IR  value ,
 101 (only print the value of any tags printed by
 102 .BR blkid)
 103 or
 104 .I device
 105 (only print the device name).
 106 .TP
 107 .B \-s
 108 Show only the tags for each (specified) device that match
 109 .IR tag .
 110 It is possible to specify multiple
 111 .B \-s
 112 options.  If no tag is specified, then all tokens are shown for all
 113 (specified) devices.
 114 In order to just refresh the cache without showing any tokens use
 115 .B "-s none"
 116 with no other options.
 117 .TP
 118 .B \-t
 119 Search for block devices with tokens named
 120 .I NAME
 121 that have the value
 122 .IR value ,
 123 and display any devices which are found.
 124 Common values for
 125 .I NAME
 126 include
 127 .BR TYPE ,
 128 .BR LABEL ,
 129 and
 130 .BR UUID .
 131 If there are no devices specified on the command line, all block devices
 132 will be searched; otherwise, only search the devices specified by the user.
 133 .TP
 134 .B \-v
 135 Display version number and exit.
 136 .TP
 137 .B \-w
 138 .I <writecachefile>
 139 Write the device cache to
 140 .I writecachefile
 141 instead of writing it to the default cache file
 142 .IR /etc/blkid.tab .
 143 If you don't want to save the cache to the default file, specify
 144 .IR /dev/null.
 145 If not specified it will be the same file as that given by the
 146 .B \-c
 147 option.
 148 .TP
 149 .I <device>
 150 Display tokens from only the specified device.  It is possible to
 151 give multiple
 152 .I <device>
 153 options on the command line.  If none is given, all devices which
 154 appear in
 155 .I /proc/partitions
 156 are shown, if they are recognized.
 157 .SH "RETURN CODE"
 158 If the specified token was found, or if any tags were shown from (specified)
 159 devices 0 is returned.  If the specified token was not found, or no
 160 (specified) devices could be identified, an exit code of 2 is returned.
 161 For usage or other errors, an exit code of 4 is returned.
 162 .SH AUTHOR
 163 .B blkid
 164 was written by Andreas Dilger for libblkid.
 165 .SH AVAILABILITY
 166 .B blkid
 167 is part the e2fsprogs package since version 1.26 and is available from
 168 http://e2fsprogs.sourceforge.net.
 169 .SH "SEE ALSO"
 170 .BR libblkid (3)