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