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 [
  15 .B \-h
  16 ]
  17 [
  18 [
  19 .B \-c
  20 .I cachefile
  21 ]
  22 .B \-s
  23 .I savecachefile
  24 ]
  25 [
  26 .B \-p
  27 ]
  28 [
  29 .B \-t
  30 .I token
  31 ]...
  32 [
  33 .B \-v
  34 ]
  35 [
  36 .I device ...
  37 ]
  38 .SH DESCRIPTION
  39 The
  40 .B blkid
  41 program is the command-line interface to working with
  42 .BR libuuid (3)
  43 library.  It can determine the type of content (e.g. filesystem, swap)
  44 a block device holds, and also attributes (tokens, NAME=value pairs)
  45 from the content metadata (e.g. LABEL or UUID fields).
  46 .PP
  47 .B blkid
  48 has two main forms of operation: either searching for a device with a
  49 specific NAME=value pair, or displaying NAME=value pairs for one or
  50 more devices.
  51 .SH OPTIONS
  52 .TP
  53 .B \-c
  54 .I <cachefile>
  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 \-p
  67 Probe all available devices.  This is the default when displaying
  68 tokens.  When searching for a token normally the cache file is
  69 used to locate the device and only that device is probed (to ensure
  70 cache coherency) and all devices are probed only if the token cannot
  71 be found in the cache.
  72 .TP
  73 .B \-s
  74 .I tag
  75 .I tag
  76 is of the form
  77 .I NAME
  78 and the resulting token is shown for each (specified) device that has
  79 such a tag.  It is possible to specify multiple
  80 .I tag
  81 options.  If no tag is specified, then all tokens are shown for all
  82 (specified) devices.
  83 In order to just refresh the cache without showing any tokens use
  84 .B "-s none"
  85 with no other options.
  86 .TP
  87 .B \-t
  88 .I token
  89 .I token
  90 is of the form
  91 .IB NAME = value
  92 and that specific token is searched for in the cache or among all visible
  93 block devices and additionally any specified devices.  If that token is
  94 not found, no output is shown.  Common values for
  95 .I NAME
  96 include
  97 .BR TYPE ,
  98 .BR LABEL ,
  99 and
 100 .BR UUID .
 101 .TP
 102 .B \-v
 103 Display version number and exit.
 104 .SH RETURN VALUE
 105 The UUID of the form 1b4e28ba-2fa1-11d2-883f-b9a761bde3fb (in
 106 .BR printf (3)
 107 format "%08x-%04x-%04x-%04x-%012x") is output to the standard output.
 108 .TP
 109 .B \-w
 110 .I <writecachefile>
 111 Write the device cache to
 112 .I writecachefile
 113 instead of writing it to the default cache file
 114 .IR /etc/blkid.tab .
 115 If you don't want to save the cache to the default file, specify
 116 .IR /dev/null.
 117 If not specified it will be the same file as that given by the
 118 .B -c
 119 option.
 120 .TP
 121 .I <device>
 122 Display tokens from only the specified device.  It is possible to
 123 give multiple
 124 .I <device>
 125 options on the command line.  If none is given, all devices which
 126 appear in
 127 .I /proc/partitions
 128 are shown, if they are recognized.
 129 .SH "RETURN CODE"
 130 If the specified token was found, or if any tags were shown from (specified)
 131 devices 0 is returned.  If the specified token was not found, or no
 132 (specified) devices could be identified return 2.  For usage or other errors
 133 return 4.
 134 .SH AUTHOR
 135 .B blkid
 136 was written by Andreas Dilger for libblkid.
 137 .SH AVAILABILITY
 138 .B blkid
 139 is part the e2fsprogs package since version 1.26 and is available from
 140 http://e2fsprogs.sourceforge.net.
 141 .SH "SEE ALSO"
 142 .BR libblkid (3)