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