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 \-s
  26 .I tag
  27 ]
  28 [
  29 .B \-t
  30 .IR NAME = value
  31 ]
  32 [
  33 .I device ...
  34 ]
  35 .SH DESCRIPTION
  36 The
  37 .B blkid
  38 program is the command-line interface to working with
  39 .BR libuuid (3)
  40 library.  It can determine the type of content (e.g. filesystem, swap)
  41 a block device holds, and also attributes (tokens, NAME=value pairs)
  42 from the content metadata (e.g. LABEL or UUID fields).
  43 .PP
  44 .B blkid
  45 has two main forms of operation: either searching for a device with a
  46 specific NAME=value pair, or displaying NAME=value pairs for one or
  47 more devices.
  48 .SH OPTIONS
  49 .TP
  50 .B \-c
  51 Read from
  52 .I cachefile
  53 instead of reading from the default cache file
  54 .IR /etc/blkid.tab .
  55 If you want to start with a clean cache (i.e. don't report devices previously
  56 scanned but not necessarily available at this time), specify
  57 .IR /dev/null.
  58 .TP
  59 .B \-h
  60 Display a usage message and exit.
  61 .TP
  62 .B \-p
  63 Probe all available devices.  This is the default when displaying
  64 tokens.  When searching for a token normally the cache file is
  65 used to locate the device and only that device is probed (to ensure
  66 cache coherency) and all devices are probed only if the token cannot
  67 be found in the cache.
  68 .TP
  69 .B \-s
  70 Show only the tags for each (specified) device that match
  71 .IR tag .
  72 It is possible to specify multiple
  73 .B \-s
  74 options.  If no tag is specified, then all tokens are shown for all
  75 (specified) devices.
  76 In order to just refresh the cache without showing any tokens use
  77 .B "-s none"
  78 with no other options.
  79 .TP
  80 .B \-t
  81 Search the blkid cache (plus any devices specifed on the command line)
  82 for all visible block devices with tokens named
  83 .I NAME
  84 that have the value
  85 .IR value ,
  86 and print the name of any devices that are found.
  87 Common values for
  88 .I NAME
  89 include
  90 .BR TYPE ,
  91 .BR LABEL ,
  92 and
  93 .BR UUID .
  94 .TP
  95 .B \-v
  96 Display version number and exit.
  97 .TP
  98 .B \-w
  99 .I <writecachefile>
 100 Write the device cache to
 101 .I writecachefile
 102 instead of writing it to the default cache file
 103 .IR /etc/blkid.tab .
 104 If you don't want to save the cache to the default file, specify
 105 .IR /dev/null.
 106 If not specified it will be the same file as that given by the
 107 .B -c
 108 option.
 109 .TP
 110 .I <device>
 111 Display tokens from only the specified device.  It is possible to
 112 give multiple
 113 .I <device>
 114 options on the command line.  If none is given, all devices which
 115 appear in
 116 .I /proc/partitions
 117 are shown, if they are recognized.
 118 .SH "RETURN CODE"
 119 If the specified token was found, or if any tags were shown from (specified)
 120 devices 0 is returned.  If the specified token was not found, or no
 121 (specified) devices could be identified, an exit code of 2 is returned.
 122 For usage or other errors, an exit code of 4 is returned.
 123 .SH AUTHOR
 124 .B blkid
 125 was written by Andreas Dilger for libblkid.
 126 .SH AVAILABILITY
 127 .B blkid
 128 is part the e2fsprogs package since version 1.26 and is available from
 129 http://e2fsprogs.sourceforge.net.
 130 .SH "SEE ALSO"
 131 .BR libblkid (3)