~ubuntu-branches/ubuntu/trusty/util-linux/trusty-proposed

« back to all changes in this revision

Viewing changes to shlibs/blkid/docs/libblkid-docs.xml

  • Committer: Package Import Robot
  • Author(s): LaMont Jones
  • Date: 2011-11-03 15:38:23 UTC
  • mto: (4.5.5 sid) (1.6.4)
  • mto: This revision was merged to the branch mainline in revision 85.
  • Revision ID: package-import@ubuntu.com-20111103153823-10sx16jprzxlhkqf
ImportĀ upstreamĀ versionĀ 2.20.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
4
 
[
5
 
  <!ENTITY version SYSTEM "version.xml">
6
 
]>
7
 
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
8
 
  <bookinfo>
9
 
    <title>libblkid Reference Manual</title>
10
 
    <releaseinfo>for libblkid version &version;</releaseinfo>
11
 
    <copyright>
12
 
      <year>2009</year>
13
 
      <holder>Karel Zak &lt;kzak@redhat.com&gt;</holder>
14
 
    </copyright>
15
 
  </bookinfo>
16
 
 
17
 
  <part id="gtk">
18
 
    <title>libblkid Overview</title>
19
 
    <partintro>
20
 
    <para>
21
 
The libblkid library is used to identify block devices (disks) as to their
22
 
content (e.g.  filesystem type, partitions) as well as extracting additional
23
 
information such as filesystem labels/volume names, partitions, unique
24
 
identifiers/serial numbers, etc.  A common use is to allow use of LABEL= and
25
 
UUID= tags instead of hard-coding specific block device names into
26
 
configuration files.
27
 
    </para>
28
 
    <para>
29
 
The libblkid librray
30
 
was written by Andreas Dilger for the ext2 filesystem utilties, with input
31
 
from Ted Ts'o.  The library was subsequently heavily modified by Ted Ts'o.
32
 
    </para>
33
 
    <para>
34
 
The low-level probing code, topology and partitions support was written
35
 
by Karel Zak. Currently, the library is mainatned by Karel Zak.
36
 
    </para>
37
 
    <para>
38
 
The library is part of the util-linux package since version 2.15 and is
39
 
available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
40
 
    </para>
41
 
  </partintro>
42
 
  <xi:include href="xml/libblkid-config.xml"/>
43
 
 </part>
44
 
 
45
 
  <part>
46
 
    <title>High-level</title>
47
 
    <xi:include href="xml/evaluate.xml"/>
48
 
    <xi:include href="xml/cache.xml"/>
49
 
    <xi:include href="xml/search.xml"/>
50
 
  </part>
51
 
  <part>
52
 
    <title>Low-level</title>
53
 
    <xi:include href="xml/lowprobe.xml"/>
54
 
    <xi:include href="xml/lowprobe-tags.xml"/>
55
 
    <xi:include href="xml/superblocks.xml"/>
56
 
    <xi:include href="xml/partitions.xml"/>
57
 
    <xi:include href="xml/topology.xml"/>
58
 
  </part>
59
 
  <part>
60
 
    <title>Common utils</title>
61
 
    <xi:include href="xml/encode.xml"/>
62
 
    <xi:include href="xml/misc.xml"/>
63
 
  </part>
64
 
 
65
 
  <index id="api-index-full">
66
 
    <title>API Index</title>
67
 
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
68
 
  </index>
69
 
</book>