1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="backup_help8">
4 <refentrytitle>backup help</refentrytitle>
5 <manvolnum>8</manvolnum>
8 <refname>backup help</refname>
9 <refpurpose>Displays help for backup commands</refpurpose>
12 <title>Synopsis</title>
13 <para><emphasis role="bold">backup help</emphasis> [<emphasis role="bold">-topic</emphasis> <<emphasis>help string</emphasis>>+] [<emphasis role="bold">-help</emphasis>]</para>
15 <para><emphasis role="bold">backup h</emphasis> [<emphasis role="bold">-t</emphasis> <<emphasis>help string</emphasis>>+] [<emphasis role="bold">-h</emphasis>]</para>
19 <title>Description</title>
20 <para>The <emphasis role="bold">backup help</emphasis> command displays the complete online help entry (short
21 description and syntax statement) for each operation code specified by the
22 <emphasis role="bold">-topic</emphasis> argument. If the <emphasis role="bold">-topic</emphasis> argument is omitted, the output
23 includes the first line (name and short description) of the online help
24 entry for every <emphasis role="bold">backup</emphasis> command.</para>
26 <para>To list every backup command whose name or short description includes a
27 specified keyword, use the <emphasis role="bold">backup apropos</emphasis> command.</para>
31 <title>Options</title>
34 <term><emphasis role="bold">-topic</emphasis> <<emphasis>help string</emphasis>>+</term>
36 <para>Indicates each command for which to display the complete online help
37 entry. Omit the <emphasis role="bold">backup</emphasis> part of the command name, providing only the
38 operation code (for example, specify <emphasis role="bold">dump</emphasis>, not <emphasis role="bold">backup dump</emphasis>). If this
39 argument is omitted, the output briefly describes every <emphasis role="bold">backup</emphasis> command.</para>
44 <term><emphasis role="bold">-help</emphasis></term>
46 <para>Prints the online help for this command. All other valid options are
55 <para>The online help entry for each backup command consists of the following
56 two or three lines:</para>
60 <para>The first line names the command and briefly describes its function.</para>
64 <para>The second line lists aliases for the command, if any.</para>
68 <para>The final line, which begins with the string <computeroutput>Usage</computeroutput>, lists the command's
69 options in the prescribed order. Online help entries use the same symbols
70 (for example, brackets) as the reference pages in this document.</para>
76 <title>Examples</title>
77 <para>The following example displays the online help entry for the <emphasis role="bold">backup
78 dump</emphasis> command:</para>
82 backup dump: start dump
83 Usage: backup dump -volumeset &lt;volume set name&gt; -dump &lt;dump level name&gt;
84 [-portoffset &lt;TC port offset&gt;] [-at &lt;Date/time to start dump&gt;+]
85 [-append] [-n] [-file &lt;load file&gt;] [-help]
90 <title>Privilege Required</title>
95 <title>See Also</title>
96 <para><link linkend="backup8">backup(8)</link>,
97 <link linkend="backup_apropos8">backup_apropos(8)</link></para>
101 <title>Copyright</title>
102 <para>IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.</para>
104 <para>This documentation is covered by the IBM Public License Version 1.0. It was
105 converted from HTML to POD by software written by Chas Williams and Russ
106 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>