doc/xml/AdminReference/sect8/backup_help.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="backup_help8">
   3   <refmeta>
   4     <refentrytitle>backup help</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>backup help</refname>
   9     <refpurpose>Displays help for backup commands</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">backup help</emphasis> [<emphasis role="bold">-topic</emphasis> &lt;<emphasis>help string</emphasis>&gt;+] [<emphasis role="bold">-help</emphasis>]</para>
  14
  15     <para><emphasis role="bold">backup h</emphasis> [<emphasis role="bold">-t</emphasis> &lt;<emphasis>help string</emphasis>&gt;+] [<emphasis role="bold">-h</emphasis>]</para>
  16
  17   </refsect1>
  18   <refsect1>
  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>
  25
  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>
  28
  29   </refsect1>
  30   <refsect1>
  31     <title>Options</title>
  32     <variablelist>
  33       <varlistentry>
  34         <term><emphasis role="bold">-topic</emphasis> &lt;<emphasis>help string</emphasis>&gt;+</term>
  35         <listitem>
  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>
  40
  41         </listitem>
  42       </varlistentry>
  43       <varlistentry>
  44         <term><emphasis role="bold">-help</emphasis></term>
  45         <listitem>
  46           <para>Prints the online help for this command. All other valid options are
  47           ignored.</para>
  48
  49         </listitem>
  50       </varlistentry>
  51     </variablelist>
  52   </refsect1>
  53   <refsect1>
  54     <title>Output</title>
  55     <para>The online help entry for each backup command consists of the following
  56     two or three lines:</para>
  57
  58     <itemizedlist>
  59       <listitem>
  60         <para>The first line names the command and briefly describes its function.</para>
  61
  62       </listitem>
  63       <listitem>
  64         <para>The second line lists aliases for the command, if any.</para>
  65
  66       </listitem>
  67       <listitem>
  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>
  71
  72       </listitem>
  73     </itemizedlist>
  74   </refsect1>
  75   <refsect1>
  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>
  79
  80 <programlisting>
  81    % backup help dump
  82    backup dump: start dump
  83    Usage: backup dump -volumeset &amp;lt;volume set name&amp;gt; -dump &amp;lt;dump level name&amp;gt;
  84    [-portoffset &amp;lt;TC port offset&amp;gt;]  [-at &amp;lt;Date/time to start dump&amp;gt;+]
  85    [-append]  [-n]  [-file &amp;lt;load file&amp;gt;]  [-help]
  86
  87 </programlisting>
  88     </refsect1>
  89     <refsect1>
  90       <title>Privilege Required</title>
  91       <para>None</para>
  92
  93     </refsect1>
  94     <refsect1>
  95       <title>See Also</title>
  96       <para><link linkend="backup8">backup(8)</link>,
  97       <link linkend="backup_apropos8">backup_apropos(8)</link></para>
  98
  99     </refsect1>
 100     <refsect1>
 101       <title>Copyright</title>
 102       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 103
 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>
 107
 108     </refsect1>
 109   </refentry>