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 one device that matches the search parameter specified using
  68 the
  69 .B \-t
  70 option.  If there are multiple devices that match the specified search
  71 parameter, then the device with the highest priority is returned, and/or
  72 the first device found at a given priority.  Device types in order of
  73 decreasing priority are Device Mapper, EVMS, LVM, MD, and finally regular
  74 block devices.  If this option is not specified,
  75 .B blkid
  76 will print all of the devices that match the search parameter.
  77 .TP
  78 .B \-o
  79 Display
  80 .BR blkid 's
  81 output using the specified format.  The
  82 .I format
  83 parameter may be
  84 .IR full ,
  85 (the default),
  86 .IR  value ,
  87 (only print the value of any tags printed by
  88 .BR blkid)
  89 or
  90 .I device
  91 (only print the device name).
  92 .TP
  93 .B \-s
  94 Show only the tags for each (specified) device that match
  95 .IR tag .
  96 It is possible to specify multiple
  97 .B \-s
  98 options.  If no tag is specified, then all tokens are shown for all
  99 (specified) devices.
 100 In order to just refresh the cache without showing any tokens use
 101 .B "-s none"
 102 with no other options.
 103 .TP
 104 .B \-t
 105 Search for block devices with tokens named
 106 .I NAME
 107 that have the value
 108 .IR value ,
 109 and display any devices which are found.
 110 Common values for
 111 .I NAME
 112 include
 113 .BR TYPE ,
 114 .BR LABEL ,
 115 and
 116 .BR UUID .
 117 If there are no devices specified on the command line, all block devices
 118 will be searched; otherwise, only search the devices specified by the user.
 119 .TP
 120 .B \-v
 121 Display version number and exit.
 122 .TP
 123 .B \-w
 124 .I <writecachefile>
 125 Write the device cache to
 126 .I writecachefile
 127 instead of writing it to the default cache file
 128 .IR /etc/blkid.tab .
 129 If you don't want to save the cache to the default file, specify
 130 .IR /dev/null.
 131 If not specified it will be the same file as that given by the
 132 .B \-c
 133 option.
 134 .TP
 135 .I <device>
 136 Display tokens from only the specified device.  It is possible to
 137 give multiple
 138 .I <device>
 139 options on the command line.  If none is given, all devices which
 140 appear in
 141 .I /proc/partitions
 142 are shown, if they are recognized.
 143 .SH "RETURN CODE"
 144 If the specified token was found, or if any tags were shown from (specified)
 145 devices 0 is returned.  If the specified token was not found, or no
 146 (specified) devices could be identified, an exit code of 2 is returned.
 147 For usage or other errors, an exit code of 4 is returned.
 148 .SH AUTHOR
 149 .B blkid
 150 was written by Andreas Dilger for libblkid.
 151 .SH AVAILABILITY
 152 .B blkid
 153 is part the e2fsprogs package since version 1.26 and is available from
 154 http://e2fsprogs.sourceforge.net.
 155 .SH "SEE ALSO"
 156 .BR libblkid (3)