fwupd/docs/man/fwupdmgr.sgml

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY date        "<date>26 February,2015</date>">
  <!ENTITY package     "fwupdmgr">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      <email>richard@hughsie.com</email>;
    </address>
    <author>
      <firstname>Richard</firstname>
      <surname>Hughes</surname>
    </author>
    <copyright>
      <year>2015</year>
      <holder>Richard Hughes</holder>
    </copyright>
    &date;
  </refentryinfo>
  <refmeta>
    <refentrytitle>fwupdmgr</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>&package;</refname>
    <refpurpose>fwupd client tool</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&package;</command>
      <arg><option>options</option></arg>
      <arg>COMMAND</arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      This manual page documents briefly the <command>&package;</command> command.
    </para>
    <para>
      <command>&package;</command> allows an administrator to update firmware.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <para>
      This program follows the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.
    </para>
    <variablelist>
      <varlistentry>
        <term>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--verbose</option>
        </term>
        <listitem>
          <para>Show extra debugging information.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--allow-reinstall</option>
        </term>
        <listitem>
          <para>Allow re-installing existing firmware versions.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--allow-older</option>
        </term>
        <listitem>
          <para>Allow downgrading firmware versions.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--offline</option>
        </term>
        <listitem>
          <para>Schedule installation for next reboot when possible.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--force</option>
        </term>
        <listitem>
          <para>Override plugin warning.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>COMMANDS</title>
    <para>
      This program takes commands with a variable number of arguments.
    </para>
    <variablelist>
      <varlistentry>
        <term>
          <option>get-details</option>
        </term>
        <listitem>
          <para>Gets details about a firmware file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>get-devices</option>
        </term>
        <listitem>
          <para>Get the list of hardware that supports firmware updates.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>get-updates</option>
        </term>
        <listitem>
          <para>Gets the list of updates for connected hardware.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>update</option>
        </term>
        <listitem>
          <para>Updates all firmware to latest versions available.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>install</option>
        </term>
        <listitem>
          <para>Install a firmware file on this hardware.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>install-prepared</option>
        </term>
        <listitem>
          <para>Install prepared updates now.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>clear-results</option>
        </term>
        <listitem>
          <para>Clears the results from the last update.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>dump-rom</option>
        </term>
        <listitem>
          <para>Dump the ROM checksum.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>monitor</option>
        </term>
        <listitem>
          <para>Monitor the daemon for events.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>unlock</option>
        </term>
        <listitem>
          <para>Unlocks the devicefor firmware access.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>verify</option>
        </term>
        <listitem>
          <para>Gets the cryptographic hash of the dumped firmware.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>verify-update</option>
        </term>
        <listitem>
          <para>Update the stored metadata with current ROM contents.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>refresh</option>
        </term>
        <listitem>
          <para>Refresh metadata from remote server.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>get-results</option>
        </term>
        <listitem>
          <para>Gets the results from the last update.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>This manual page was written by Richard Hughes <email>richard@hughsie.com</email>.
    </para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->