initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf076.htm
diff --git a/doc/html/AdminReference/auarf076.htm b/doc/html/AdminReference/auarf076.htm
new file mode 100644 (file)
index 0000000..bbd9168
--- /dev/null
@@ -0,0 +1,109 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
+<HTML><HEAD>
+<TITLE>Administration Reference</TITLE>
+<!-- Begin Header Records  ========================================== -->
+<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
+<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
+<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
+<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
+<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
+</HEAD><BODY>
+<!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
+<BODY bgcolor="ffffff"> 
+<!-- End Header Records  ============================================ -->
+<A NAME="Top_Of_Page"></A>
+<H1>Administration Reference</H1>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf075.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf077.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<P>
+<H2><A NAME="HDRBK_INTERACTIVE" HREF="auarf002.htm#ToC_90">backup interactive</A></H2>
+<A NAME="IDX4327"></A>
+<A NAME="IDX4328"></A>
+<A NAME="IDX4329"></A>
+<A NAME="IDX4330"></A>
+<A NAME="IDX4331"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Enters interactive mode
+<P><STRONG>Synopsis</STRONG>
+<P>
+<PRE><B>backup</B> [<B>interactive</B>]  [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
+  
+<B>backup</B> [<B>i</B>]  [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell name</VAR>>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>backup interactive</B> initiates an interactive session for
+issuing <B>backup</B> commands. As indicated in the syntax
+statement, the operation code (<B>interactive</B>) is optional.
+<P>Several features of interactive mode distinguish it from regular
+mode:
+<UL>
+<P><LI>In interactive mode, the <TT>backup></TT> prompt replaces the system
+(shell) prompt. The operator enters only a command's operation
+code (omitting the command suite name, <B>backup</B>).
+<P><LI>If the <B>-localauth</B> flag or the <B>-cell</B> argument is
+included on the <B>backup (interactive)</B> 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
+<B>help</B> subcommand or <B>-help</B> flag on an individual command
+issued at the <TT>backup></TT> prompt.
+<P><LI>The <B>(backup) jobs</B> and <B>(backup) kill</B> commands are
+available only in interactive mode. It is not possible to track and
+terminate backup operations as cleanly in non-interactive mode.
+<P><LI>It is not necessary to enclose strings that include metacharacters in
+double quotes or other delimiters.
+<P><LI>The <B>backup</B> 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.
+</UL>
+<P>To exit an interactive session, issue the <B>(backup) quit</B>
+command.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B>-localauth
+</B><DD>Constructs a server ticket using a key from the local
+<B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
+interpreter presents it to the Backup Server, Volume Server and VL Server
+during mutual authentication. Do not combine this flag with the
+<B>-cell</B> argument. For more details, see the introductory
+<B>backup</B> reference page.
+<P><DT><B>-cell
+</B><DD>Names the cell in which to run the command. Do not combine this
+argument with the <B>-localauth</B> flag. For more details, see the
+introductory <B>backup</B> reference page.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Examples</STRONG>
+<P>The following example shows how the <B>-localauth</B> flag and
+<B>-cell</B> argument do not appear when the <B>help dump</B>
+subcommand is issued in interactive mode.
+<PRE>   % <B>backup</B>
+   backup> <B>help dump</B>
+   dump: start dump 
+   Usage: dump [-volumeset &lt;volume&nbsp;set&nbsp;name>] [-dump &lt;dump level name>] 
+   [-portoffset &lt;TC port offset>] [-at &lt;Date/time to start dump>+]
+   [-append ] [-n ] [-file &lt;load file>] [-help ] 
+   
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>None. However, <B>backup</B> commands that require privilege in
+regular mode still require it in interactive mode.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
+<P><A HREF="auarf077.htm#HDRBK_JOBS">backup jobs</A>
+<P><A HREF="auarf078.htm#HDRBK_KILL">backup kill</A>
+<P><A HREF="auarf083.htm#HDRBK_QUIT">backup quit</A>
+<P><A HREF="auarf126.htm#HDRBUTC">butc</A>
+<P>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf075.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf077.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<!-- Begin Footer Records  ========================================== -->
+<P><HR><B> 
+<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
+</B> 
+<!-- End Footer Records  ============================================ -->
+<A NAME="Bot_Of_Page"></A>
+</BODY></HTML>