diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 14:30:35 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 14:30:35 +0000 |
| commit | 378c18e5f024ac5a8aef4cb40d7c9aa9633d144c (patch) | |
| tree | 44dfb6ca500d32cabd450649b322a42e70a30683 /libblkid/docs/libblkid-docs.xml | |
| parent | Initial commit. (diff) | |
| download | util-linux-upstream.tar.xz util-linux-upstream.zip | |
Adding upstream version 2.38.1.upstream/2.38.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'libblkid/docs/libblkid-docs.xml')
| -rw-r--r-- | libblkid/docs/libblkid-docs.xml | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/libblkid/docs/libblkid-docs.xml b/libblkid/docs/libblkid-docs.xml new file mode 100644 index 0000000..0dc5270 --- /dev/null +++ b/libblkid/docs/libblkid-docs.xml @@ -0,0 +1,82 @@ +<?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-2022</year> + <holder>Karel Zak <kzak@redhat.com></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 library +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. + </para> + <para> +The low-level probing code, topology and partitions support was written +by Karel Zak. Currently, the library is maintained by Karel Zak. + </para> + <para> +The library is part of the util-linux package since version 2.15 and is +available from https://www.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"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + <index role="2.30"> + <title>Index of new symbols in 2.30</title> + <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include> + </index> + <index role="2.31"> + <title>Index of new symbols in 2.31</title> + <xi:include href="xml/api-index-2.31.xml"><xi:fallback /></xi:include> + </index> + <index role="2.35"> + <title>Index of new symbols in 2.36</title> + <xi:include href="xml/api-index-2.36.xml"><xi:fallback /></xi:include> + </index> +</book> |