doc: document the `architecture` setting

[thirdparty/systemd.git] / man / systemd-hwdb.xml

<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  SPDX-License-Identifier: LGPL-2.1+
-->

<refentry id="systemd-hwdb" conditional="ENABLE_HWDB"
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>systemd-hwdb</title>
    <productname>systemd</productname>
  </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>--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>Alternate root path in the filesystem.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option></term>
        <term><option>--strict</option></term>
        <listitem>
          <para>When updating, return non-zero exit value on any parsing error.</para>
        </listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="help" />
    </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>