diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/hwdb.xml | 87 | ||||
| -rw-r--r-- | man/systemd-hwdb.xml | 94 | ||||
| -rw-r--r-- | man/udev.xml | 37 | ||||
| -rw-r--r-- | man/udevadm.xml | 53 |
4 files changed, 181 insertions, 90 deletions
diff --git a/man/hwdb.xml b/man/hwdb.xml new file mode 100644 index 0000000000..9f2aff3261 --- /dev/null +++ b/man/hwdb.xml @@ -0,0 +1,87 @@ +<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<refentry id="hwdb"> + <refentryinfo> + <title>hwdb</title> + <productname>systemd</productname> + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Kay</firstname> + <surname>Sievers</surname> + <email>kay@vrfy.org</email> + </author> + <author> + <contrib>Developer</contrib> + <firstname>Tom</firstname> + <surname>Gundersen</surname> + <email>teg@jklm.no</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>hwdb</refentrytitle> + <manvolnum>7</manvolnum> + </refmeta> + + <refnamediv> + <refname>hwdb</refname> + <refpurpose>Hardware Database</refpurpose> + </refnamediv> + + <refsect1><title>Description</title> + <para>The hardware database is a key-value store for associating modalias-like keys to + udev-properties-like values. It is used primarily by udev to add the relevant properties + to matching devices, but it can also be queried directly.</para> + </refsect1> + + <refsect1><title>Hardware Database Files</title> + <para>The hwdb files are read from the files located in the + system hwdb directory <filename>/usr/lib/udev/hwdb.d</filename>, + the volatile runtime directory <filename>/run/udev/hwdb.d</filename> + and the local administration directory <filename>/etc/udev/hwdb.d</filename>. + All hwdb files are collectively sorted and processed in lexical order, + regardless of the directories in which they live. However, files with + identical filenames replace each other. Files in <filename>/etc</filename> + have the highest priority, files in <filename>/run</filename> take precedence + over files with the same name in <filename>/usr/lib</filename>. This can be + used to override a system-supplied hwdb file with a local file if needed; + a symlink in <filename>/etc</filename> with the same name as a hwdb file in + <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>, + disables the hwdb file entirely. hwdb files must have the extension + <filename>.hwdb</filename>; other extensions are ignored.</para> + + <para>The hwdb file contains data records consisting of matches and + associated key-value pairs. Every record in the hwdb starts with one or + more match string, specifying a shell glob to compare the database + lookup string against. Multiple match lines are specified in additional + consecutive lines. Every match line is compared indivdually, they are + combined by OR. Every match line must start at the first character of + the line.</para> + + <para>The match lines are followed by one or more key-value pair lines, which + are recognized by a leading space character. The key name and value are separated + by <literal>=</literal>. An empty line signifies the end + of a record. Lines beginning with <literal>#</literal> are ignored.</para> + + <para>The content of all hwdb files is read by + <citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum></citerefentry> + and compiled to a binary database located at <filename>/etc/udev/hwdb.bin</filename>, + or alternatively <filename>/usr/lib/udev/hwdb.bin</filename> if you want ship the compiled + database in an immutable image. + During runtime only the binary database is used.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry> + <refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/systemd-hwdb.xml b/man/systemd-hwdb.xml new file mode 100644 index 0000000000..09f4d551a9 --- /dev/null +++ b/man/systemd-hwdb.xml @@ -0,0 +1,94 @@ +<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<refentry id="systemd-hwdb"> + <refentryinfo> + <title>systemd-hwdb</title> + <productname>systemd</productname> + <authorgroup> + <author> + <contrib>Developer</contrib> + <firstname>Kay</firstname> + <surname>Sievers</surname> + <email>kay@vrfy.org</email> + </author> + <author> + <contrib>Developer</contrib> + <firstname>Tom</firstname> + <surname>Gundersen</surname> + <email>teg@jklm.no</email> + </author> + </authorgroup> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-hwdb</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-hwdb</refname><refpurpose>hardware database management tool</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>systemd-hwdb <optional>options</optional> update</command> + </cmdsynopsis> + <cmdsynopsis> + <command>systemd-hwdb <optional>options</optional> query <replaceable>modalias</replaceable></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1><title>Description</title> + <para><command>systemd-hwdb</command> expects a command and command + specific arguments. It manages the binary hardware database.</para> + </refsect1> + + <refsect1><title>Options</title> + <variablelist> + <varlistentry> + <term><option>-h</option></term> + <term><option>--help</option></term> + <listitem> + <para>Print help text.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--usr</option></term> + <listitem> + <para>Generate in /usr/lib/udev instead of /etc/udev.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-r</option></term> + <term><option>--root=<replaceable>PATH</replaceable></option></term> + <listitem> + <para>Alternative root path in the filesystem.</para> + </listitem> + </varlistentry> + </variablelist> + + <refsect2><title>systemd-hwdb + <arg choice="opt"><replaceable>options</replaceable></arg> + update</title> + <para>Update the binary database.</para> + </refsect2> + + <refsect2><title>systemd-hwdb + <arg choice="opt"><replaceable>options</replaceable></arg> + query + <arg><replaceable>MODALIAS</replaceable></arg> + </title> + <para>Query database and print result.</para> + </refsect2> + </refsect1> + + <refsect1> + <title>See Also</title> + <para><citerefentry> + <refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum> + </citerefentry></para> + </refsect1> +</refentry> diff --git a/man/udev.xml b/man/udev.xml index 1113a66a2a..34b2e12f78 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -735,43 +735,6 @@ </variablelist> </refsect1> - <refsect1><title>Hardware Database Files</title> - <para>The hwdb files are read from the files located in the - system hwdb directory <filename>/usr/lib/udev/hwdb.d</filename>, - the volatile runtime directory <filename>/run/udev/hwdb.d</filename> - and the local administration directory <filename>/etc/udev/hwdb.d</filename>. - All hwdb files are collectively sorted and processed in lexical order, - regardless of the directories in which they live. However, files with - identical filenames replace each other. Files in <filename>/etc</filename> - have the highest priority, files in <filename>/run</filename> take precedence - over files with the same name in <filename>/usr/lib</filename>. This can be - used to override a system-supplied hwdb file with a local file if needed; - a symlink in <filename>/etc</filename> with the same name as a hwdb file in - <filename>/usr/lib</filename>, pointing to <filename>/dev/null</filename>, - disables the hwdb file entirely. hwdb files must have the extension - <filename>.hwdb</filename>; other extensions are ignored.</para> - - <para>The hwdb file contains data records consisting of matches and - associated key-value pairs. Every record in the hwdb starts with one or - more match string, specifying a shell glob to compare the database - lookup string against. Multiple match lines are specified in additional - consecutive lines. Every match line is compared indivdually, they are - combined by OR. Every match line must start at the first character of - the line.</para> - - <para>The match lines are followed by one or more key-value pair lines, which - are recognized by a leading space character. The key name and value are separated - by <literal>=</literal>. An empty line signifies the end - of a record. Lines beginning with <literal>#</literal> are ignored.</para> - - <para>The content of all hwdb files is read by - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> - and compiled to a binary database located at <filename>/etc/udev/hwdb.bin</filename>, - or alternatively <filename>/usr/lib/udev/hwdb.bin</filename> if you want ship the compiled - database in an immutable image. - During runtime only the binary database is used.</para> - </refsect1> - <refsect1> <title>See Also</title> <para> diff --git a/man/udevadm.xml b/man/udevadm.xml index 38c1935fa8..4aa89646db 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -49,9 +49,6 @@ <command>udevadm monitor <optional>options</optional></command> </cmdsynopsis> <cmdsynopsis> - <command>udevadm hwdb <optional>options</optional></command> - </cmdsynopsis> - <cmdsynopsis> <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command> </cmdsynopsis> <cmdsynopsis> @@ -512,56 +509,6 @@ </variablelist> </refsect2> - <refsect2><title>udevadm hwdb - <arg choice="opt"><replaceable>options</replaceable></arg> - </title> - <para>Maintain the hardware database index in <filename>/etc/udev/hwdb.bin</filename>.</para> - <variablelist> - <varlistentry> - <term><option>-u</option></term> - <term><option>--update</option></term> - <listitem> - <para>Compile the hardware database information located in /usr/lib/udev/hwdb.d/, - /etc/udev/hwdb.d/ and store it in <filename>/etc/udev/hwdb.bin</filename>. This should be done after - any update to the source files; it will not be called automatically. The running - udev daemon will detect a new database on its own and does not need to be - notified about it.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><option>--usr</option></term> - <listitem> - <para>Put the compiled database into <filename>/usr/lib/udev/hwdb.bin</filename> instead. - Use this if you want to ship a pre-compiled database in immutable system images, or - don't use <filename>/etc/udev/hwdb.d</filename> and want to avoid large binary files in - <filename>/etc</filename>.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><option>-t</option></term> - <term><option>--test=<replaceable>string</replaceable></option></term> - <listitem> - <para>Query the database with a modalias string, and print the - retrieved properties.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><option>-r</option></term> - <term><option>--root=<replaceable>string</replaceable></option></term> - <listitem> - <para>Alternative root path in the file system for reading and writing files.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><option>-h</option></term> - <term><option>--help</option></term> - <listitem> - <para>Print help text.</para> - </listitem> - </varlistentry> - </variablelist> - </refsect2> - <refsect2><title>udevadm test <arg choice="opt"><replaceable>options</replaceable></arg> <arg><replaceable>devpath</replaceable></arg> |