openafs/doc/xml/AdminReference/sect8/backup_interactive.xml

<?xml version="1.0" encoding="UTF-8"?>
<refentry id="backup_interactive8">
  <refmeta>
    <refentrytitle>backup interactive</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>backup interactive</refname>
    <refpurpose>Enters interactive mode</refpurpose>
  </refnamediv>
  <refsect1>
    <title>Synopsis</title>
    <para><emphasis role="bold">backup</emphasis> [<emphasis role="bold">interactive</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
        [<emphasis role="bold">-help</emphasis>]</para>

    <para><emphasis role="bold">backup</emphasis> [<emphasis role="bold">i</emphasis>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-h</emphasis>]</para>

  </refsect1>
  <refsect1>
    <title>Description</title>
    <para>The <emphasis role="bold">backup interactive</emphasis> initiates an interactive session for issuing
    <emphasis role="bold">backup</emphasis> commands. As indicated in the syntax statement, the operation
    code (<emphasis role="bold">interactive</emphasis>) is optional.</para>

    <para>Several features of interactive mode distinguish it from regular mode:</para>

    <itemizedlist>
      <listitem>
        <para>In interactive mode, the <computeroutput>backup</computeroutput>&gt; prompt replaces the system (shell)
        prompt. The operator enters only a command's operation code (omitting the
        command suite name, <emphasis role="bold">backup</emphasis>).</para>

      </listitem>
      <listitem>
        <para>If the <emphasis role="bold">-localauth</emphasis> flag or the <emphasis role="bold">-cell</emphasis> argument is included on the
        <emphasis role="bold">backup interactive</emphasis> command, the settings apply to all commands issued
        during that interactive session. The issuer does not need to type them on
        every command. Another consequence is that the flag and argument do not
        appear in the syntax statement generated by the <emphasis role="bold">help</emphasis> subcommand or
        <emphasis role="bold">-help</emphasis> flag on an individual command issued at the <computeroutput>backup</computeroutput>&gt; prompt.</para>

      </listitem>
      <listitem>
        <para>The <emphasis role="bold">backup jobs</emphasis> and <emphasis role="bold">backup kill</emphasis> commands are available only in
        interactive mode. It is not possible to track and terminate backup
        operations as cleanly in non-interactive mode.</para>

      </listitem>
      <listitem>
        <para>It is not necessary to enclose strings that include metacharacters in
        double quotes or other delimiters.</para>

      </listitem>
      <listitem>
        <para>The backup command interpreter establishes a connection to the Backup
        Server, Volume Server and Volume Location (VL) Server processes as it
        enters interactive mode, and uses the same connection for all commands
        during the session. Execution time can therefore be faster than in
        non-interactive mode, in which the command interpreter must establish a
        new connection for each command.</para>

      </listitem>
    </itemizedlist>
    <para>To exit an interactive session, issue the <emphasis role="bold">backup quit</emphasis> command.</para>

  </refsect1>
  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><emphasis role="bold">-localauth</emphasis></term>
        <listitem>
          <para>Constructs a server ticket using a key from the local
          <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">backup</emphasis> command interpreter presents
          it to the Backup Server, Volume Server and VL Server during mutual
          authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument. For
          more details, see <link linkend="backup8">backup(8)</link>.</para>

        </listitem>
      </varlistentry>
      <varlistentry>
        <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
        <listitem>
          <para>Names the cell in which to run the command. Do not combine this argument
          with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="backup8">backup(8)</link>.</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>Examples</title>
    <para>The following example shows how the <emphasis role="bold">-localauth</emphasis> flag and <emphasis role="bold">-cell</emphasis>
    argument do not appear when the <emphasis role="bold">help dump</emphasis> subcommand is issued in
    interactive mode.</para>

<programlisting>
   % backup
   backup&amp;gt; help dump
   dump: start dump
   Usage: dump [-volumeset &amp;lt;volume set name&amp;gt;] [-dump &amp;lt;dump level name&amp;gt;]
   [-portoffset &amp;lt;TC port offset&amp;gt;] [-at &amp;lt;Date/time to start dump&amp;gt;+]
   [-append ] [-n ] [-file &amp;lt;load file&amp;gt;] [-help ]

</programlisting>
    </refsect1>
    <refsect1>
      <title>Privilege Required</title>
      <para>None. However, <emphasis role="bold">backup</emphasis> commands that require privilege in regular mode
      still require it in interactive mode.</para>

    </refsect1>
    <refsect1>
      <title>See Also</title>
      <para><link linkend="backup8">backup(8)</link>,
      <link linkend="backup_jobs8">backup_jobs(8)</link>,
      <link linkend="backup_kill8">backup_kill(8)</link>,
      <link linkend="backup_quit8">backup_quit(8)</link>,
      <link linkend="butc8">butc(8)</link></para>

    </refsect1>
    <refsect1>
      <title>Copyright</title>
      <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; 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>