summaryrefslogtreecommitdiffstats
path: root/libblkid/docs/libblkid-docs.xml
diff options
context:
space:
mode:
Diffstat (limited to 'libblkid/docs/libblkid-docs.xml')
-rw-r--r--libblkid/docs/libblkid-docs.xml70
1 files changed, 70 insertions, 0 deletions
diff --git a/libblkid/docs/libblkid-docs.xml b/libblkid/docs/libblkid-docs.xml
new file mode 100644
index 000000000..1f412c105
--- /dev/null
+++ b/libblkid/docs/libblkid-docs.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>libblkid Reference Manual</title>
+ <releaseinfo>for libblkid version &version;</releaseinfo>
+ <copyright>
+ <year>2009-2013</year>
+ <holder>Karel Zak &lt;kzak@redhat.com&gt;</holder>
+ </copyright>
+ </bookinfo>
+
+ <part id="gtk">
+ <title>libblkid Overview</title>
+ <partintro>
+ <para>
+The libblkid library is used to identify block devices (disks) as to their
+content (e.g. filesystem type, partitions) as well as extracting additional
+information such as filesystem labels/volume names, partitions, unique
+identifiers/serial numbers, etc. A common use is to allow use of LABEL= and
+UUID= tags instead of hard-coding specific block device names into
+configuration files.
+ </para>
+ <para>
+The libblkid librray
+was written by Andreas Dilger for the ext2 filesystem utilties, with input
+from Ted Ts'o. The library was subsequently heavily modified by Ted Ts'o.
+ </para>
+ <para>
+The low-level probing code, topology and partitions support was written
+by Karel Zak. Currently, the library is mainatned by Karel Zak.
+ </para>
+ <para>
+The library is part of the util-linux package since version 2.15 and is
+available from ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+ </para>
+ </partintro>
+ <xi:include href="xml/libblkid-config.xml"/>
+ </part>
+
+ <part>
+ <title>High-level</title>
+ <xi:include href="xml/evaluate.xml"/>
+ <xi:include href="xml/cache.xml"/>
+ <xi:include href="xml/search.xml"/>
+ </part>
+ <part>
+ <title>Low-level</title>
+ <xi:include href="xml/init.xml"/>
+ <xi:include href="xml/lowprobe.xml"/>
+ <xi:include href="xml/lowprobe-tags.xml"/>
+ <xi:include href="xml/superblocks.xml"/>
+ <xi:include href="xml/partitions.xml"/>
+ <xi:include href="xml/topology.xml"/>
+ </part>
+ <part>
+ <title>Common utils</title>
+ <xi:include href="xml/encode.xml"/>
+ <xi:include href="xml/misc.xml"/>
+ </part>
+
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+</book>