libblkid/libblkid.3.adoc

   1 //po4a: entry man manual
   2 ////
   3 Copyright 2001 Andreas Dilger (adilger@turbolinux.com)
   4 This man page was created for libblkid.so.1.0 from e2fsprogs-1.24.
   5 This file may be copied under the terms of the GNU Lesser General Public License.
   6 Created  Wed Sep 14 12:02:12 2001, Andreas Dilger
   7 ////
   8 = libblkid(3)
   9 :doctype: manpage
  10 :man manual: Programmer's Manual
  11 :man source: util-linux {release-version}
  12 :page-layout: base
  13 :lib: libblkid
  14 :firstversion: 2.15
  15
  16 == NAME
  17
  18 libblkid - block device identification library
  19
  20 == SYNOPSIS
  21
  22 *#include <blkid.h>*
  23
  24 *cc* _file.c_ *-lblkid*
  25
  26 == DESCRIPTION
  27
  28 The *libblkid* library is used to identify block devices (disks) as to their content (e.g., filesystem type) as well as extracting additional information such as filesystem labels/volume names, unique identifiers/serial numbers. A common use is to allow use of *LABEL=* and *UUID=* tags instead of hard-coding specific block device names into configuration files.
  29
  30 The low-level part of the library also allows the extraction of information about partitions and block device topology.
  31
  32 The high-level part of the library keeps information about block devices in a cache file and is verified to still be valid before being returned to the user (if the user has read permission on the raw block device, otherwise not). The cache file also allows unprivileged users (normally anyone other than root, or those not in the "disk" group) to locate devices by label/id. The standard location of the cache file can be overridden by the environment variable *BLKID_FILE*.
  33
  34 In situations where one is getting information about a single known device, it does not impact performance whether the cache is used or not (unless you are not able to read the block device directly).
  35
  36 The high-level part of the library supports two methods to evaluate *LABEL/UUID*. It reads information directly from a block device or read information from /dev/disk/by-* udev symlinks. The udev is preferred method by default.
  37
  38 If you are dealing with multiple devices, use of the cache is highly recommended (even if empty) as devices will be scanned at most one time and the on-disk cache will be updated if possible.
  39
  40 In some cases (modular kernels), block devices are not even visible until after they are accessed the first time, so it is critical that there is some way to locate these devices without enumerating only visible devices, so the use of the cache file is *required* in this situation.
  41
  42 == CONFIGURATION FILE
  43
  44 The standard location of the _/etc/blkid.conf_ config file can be overridden by the environment variable *BLKID_CONF*. For more details about the config file see *blkid*(8) man page.
  45
  46 == AUTHORS
  47
  48 *libblkid* was written by Andreas Dilger for the ext2 filesystem utilities, with input from Ted Ts'o. The library was subsequently heavily modified by Ted Ts'o.
  49
  50 The low-level probing code was rewritten by Karel Zak.
  51
  52 == COPYING
  53
  54 *libblkid* is available under the terms of the GNU Library General Public License (LGPL), version 2 (or at your discretion any later version).
  55
  56 == SEE ALSO
  57
  58 *blkid*(8),
  59 *findfs*(8)
  60
  61 include::man-common/bugreports.adoc[]
  62
  63 include::man-common/footer-lib.adoc[]
  64
  65 ifdef::translation[]
  66 include::man-common/translation.adoc[]
  67 endif::[]