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   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="systemd-hwdb" conditional="ENABLE_HWDB"
  27           xmlns:xi="http://www.w3.org/2001/XInclude">
  28
  29   <refentryinfo>
  30     <title>systemd-hwdb</title>
  31     <productname>systemd</productname>
  32     <authorgroup>
  33       <author>
  34         <contrib>Developer</contrib>
  35         <firstname>Kay</firstname>
  36         <surname>Sievers</surname>
  37         <email>kay@vrfy.org</email>
  38       </author>
  39       <author>
  40         <contrib>Developer</contrib>
  41         <firstname>Tom</firstname>
  42         <surname>Gundersen</surname>
  43         <email>teg@jklm.no</email>
  44       </author>
  45     </authorgroup>
  46   </refentryinfo>
  47
  48   <refmeta>
  49     <refentrytitle>systemd-hwdb</refentrytitle>
  50     <manvolnum>8</manvolnum>
  51   </refmeta>
  52
  53   <refnamediv>
  54     <refname>systemd-hwdb</refname><refpurpose>hardware database management tool</refpurpose>
  55   </refnamediv>
  56
  57   <refsynopsisdiv>
  58     <cmdsynopsis>
  59       <command>systemd-hwdb <optional>options</optional> update</command>
  60     </cmdsynopsis>
  61     <cmdsynopsis>
  62       <command>systemd-hwdb <optional>options</optional> query <replaceable>modalias</replaceable></command>
  63     </cmdsynopsis>
  64   </refsynopsisdiv>
  65
  66   <refsect1><title>Description</title>
  67     <para><command>systemd-hwdb</command> expects a command and command
  68     specific arguments.  It manages the binary hardware database.</para>
  69   </refsect1>
  70
  71   <refsect1><title>Options</title>
  72     <variablelist>
  73       <varlistentry>
  74         <term><option>--usr</option></term>
  75         <listitem>
  76           <para>Generate in /usr/lib/udev instead of /etc/udev.</para>
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term><option>-r</option></term>
  81         <term><option>--root=<replaceable>PATH</replaceable></option></term>
  82         <listitem>
  83           <para>Alternate root path in the filesystem.</para>
  84         </listitem>
  85       </varlistentry>
  86
  87       <xi:include href="standard-options.xml" xpointer="help" />
  88     </variablelist>
  89
  90     <refsect2><title>systemd-hwdb
  91       <arg choice="opt"><replaceable>options</replaceable></arg>
  92       update</title>
  93       <para>Update the binary database.</para>
  94     </refsect2>
  95
  96     <refsect2><title>systemd-hwdb
  97       <arg choice="opt"><replaceable>options</replaceable></arg>
  98       query
  99       <arg><replaceable>MODALIAS</replaceable></arg>
 100     </title>
 101       <para>Query database and print result.</para>
 102     </refsect2>
 103   </refsect1>
 104
 105   <refsect1>
 106     <title>See Also</title>
 107     <para><citerefentry>
 108         <refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum>
 109     </citerefentry></para>
 110   </refsect1>
 111 </refentry>