mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
110 lines
4.3 KiB
XML
110 lines
4.3 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<refentry id="backup_help8">
|
|
<refmeta>
|
|
<refentrytitle>backup help</refentrytitle>
|
|
<manvolnum>8</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>backup help</refname>
|
|
<refpurpose>Displays help for backup commands</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Synopsis</title>
|
|
<para><emphasis role="bold">backup help</emphasis> [<emphasis role="bold">-topic</emphasis> <<emphasis>help string</emphasis>>+] [<emphasis role="bold">-help</emphasis>]</para>
|
|
|
|
<para><emphasis role="bold">backup h</emphasis> [<emphasis role="bold">-t</emphasis> <<emphasis>help string</emphasis>>+] [<emphasis role="bold">-h</emphasis>]</para>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>The <emphasis role="bold">backup help</emphasis> command displays the complete online help entry (short
|
|
description and syntax statement) for each operation code specified by the
|
|
<emphasis role="bold">-topic</emphasis> argument. If the <emphasis role="bold">-topic</emphasis> argument is omitted, the output
|
|
includes the first line (name and short description) of the online help
|
|
entry for every <emphasis role="bold">backup</emphasis> command.</para>
|
|
|
|
<para>To list every backup command whose name or short description includes a
|
|
specified keyword, use the <emphasis role="bold">backup apropos</emphasis> command.</para>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Options</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><emphasis role="bold">-topic</emphasis> <<emphasis>help string</emphasis>>+</term>
|
|
<listitem>
|
|
<para>Indicates each command for which to display the complete online help
|
|
entry. Omit the <emphasis role="bold">backup</emphasis> part of the command name, providing only the
|
|
operation code (for example, specify <emphasis role="bold">dump</emphasis>, not <emphasis role="bold">backup dump</emphasis>). If this
|
|
argument is omitted, the output briefly describes every <emphasis role="bold">backup</emphasis> command.</para>
|
|
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><emphasis role="bold">-help</emphasis></term>
|
|
<listitem>
|
|
<para>Prints the online help for this command. All other valid options are
|
|
ignored.</para>
|
|
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Output</title>
|
|
<para>The online help entry for each backup command consists of the following
|
|
two or three lines:</para>
|
|
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>The first line names the command and briefly describes its function.</para>
|
|
|
|
</listitem>
|
|
<listitem>
|
|
<para>The second line lists aliases for the command, if any.</para>
|
|
|
|
</listitem>
|
|
<listitem>
|
|
<para>The final line, which begins with the string <computeroutput>Usage</computeroutput>, lists the command's
|
|
options in the prescribed order. Online help entries use the same symbols
|
|
(for example, brackets) as the reference pages in this document.</para>
|
|
|
|
</listitem>
|
|
</itemizedlist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Examples</title>
|
|
<para>The following example displays the online help entry for the <emphasis role="bold">backup
|
|
dump</emphasis> command:</para>
|
|
|
|
<programlisting>
|
|
% backup help dump
|
|
backup dump: start dump
|
|
Usage: backup dump -volumeset &lt;volume set name&gt; -dump &lt;dump level name&gt;
|
|
[-portoffset &lt;TC port offset&gt;] [-at &lt;Date/time to start dump&gt;+]
|
|
[-append] [-n] [-file &lt;load file&gt;] [-help]
|
|
|
|
</programlisting>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Privilege Required</title>
|
|
<para>None</para>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para><link linkend="backup8">backup(8)</link>,
|
|
<link linkend="backup_apropos8">backup_apropos(8)</link></para>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Copyright</title>
|
|
<para>IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.</para>
|
|
|
|
<para>This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
|
|
|
|
</refsect1>
|
|
</refentry>
|