man/systemd-hwdb.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7
   8   This file is part of systemd.
   9
  10   Copyright 2014 Tom Gundersen
  11 -->
  12
  13 <refentry id="systemd-hwdb" conditional="ENABLE_HWDB"
  14           xmlns:xi="http://www.w3.org/2001/XInclude">
  15
  16   <refentryinfo>
  17     <title>systemd-hwdb</title>
  18     <productname>systemd</productname>
  19     <authorgroup>
  20       <author>
  21         <contrib>Developer</contrib>
  22         <firstname>Kay</firstname>
  23         <surname>Sievers</surname>
  24         <email>kay@vrfy.org</email>
  25       </author>
  26       <author>
  27         <contrib>Developer</contrib>
  28         <firstname>Tom</firstname>
  29         <surname>Gundersen</surname>
  30         <email>teg@jklm.no</email>
  31       </author>
  32     </authorgroup>
  33   </refentryinfo>
  34
  35   <refmeta>
  36     <refentrytitle>systemd-hwdb</refentrytitle>
  37     <manvolnum>8</manvolnum>
  38   </refmeta>
  39
  40   <refnamediv>
  41     <refname>systemd-hwdb</refname><refpurpose>hardware database management tool</refpurpose>
  42   </refnamediv>
  43
  44   <refsynopsisdiv>
  45     <cmdsynopsis>
  46       <command>systemd-hwdb <optional>options</optional> update</command>
  47     </cmdsynopsis>
  48     <cmdsynopsis>
  49       <command>systemd-hwdb <optional>options</optional> query <replaceable>modalias</replaceable></command>
  50     </cmdsynopsis>
  51   </refsynopsisdiv>
  52
  53   <refsect1><title>Description</title>
  54     <para><command>systemd-hwdb</command> expects a command and command
  55     specific arguments.  It manages the binary hardware database.</para>
  56   </refsect1>
  57
  58   <refsect1><title>Options</title>
  59     <variablelist>
  60       <varlistentry>
  61         <term><option>--usr</option></term>
  62         <listitem>
  63           <para>Generate in /usr/lib/udev instead of /etc/udev.</para>
  64         </listitem>
  65       </varlistentry>
  66       <varlistentry>
  67         <term><option>-r</option></term>
  68         <term><option>--root=<replaceable>PATH</replaceable></option></term>
  69         <listitem>
  70           <para>Alternate root path in the filesystem.</para>
  71         </listitem>
  72       </varlistentry>
  73       <varlistentry>
  74         <term><option>-s</option></term>
  75         <term><option>--strict</option></term>
  76         <listitem>
  77           <para>When updating, return non-zero exit value on any parsing error.</para>
  78         </listitem>
  79       </varlistentry>
  80
  81       <xi:include href="standard-options.xml" xpointer="help" />
  82     </variablelist>
  83
  84     <refsect2><title>systemd-hwdb
  85       <arg choice="opt"><replaceable>options</replaceable></arg>
  86       update</title>
  87       <para>Update the binary database.</para>
  88     </refsect2>
  89
  90     <refsect2><title>systemd-hwdb
  91       <arg choice="opt"><replaceable>options</replaceable></arg>
  92       query
  93       <arg><replaceable>MODALIAS</replaceable></arg>
  94     </title>
  95       <para>Query database and print result.</para>
  96     </refsect2>
  97   </refsect1>
  98
  99   <refsect1>
 100     <title>See Also</title>
 101     <para><citerefentry>
 102         <refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum>
 103     </citerefentry></para>
 104   </refsect1>
 105 </refentry>