initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf076.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <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> 
17 <P>
18 <H2><A NAME="HDRBK_INTERACTIVE" HREF="auarf002.htm#ToC_90">backup interactive</A></H2>
19 <A NAME="IDX4327"></A>
20 <A NAME="IDX4328"></A>
21 <A NAME="IDX4329"></A>
22 <A NAME="IDX4330"></A>
23 <A NAME="IDX4331"></A>
24 <P><STRONG>Purpose</STRONG>
25 <P>Enters interactive mode
26 <P><STRONG>Synopsis</STRONG>
27 <P>
28 <PRE><B>backup</B> [<B>interactive</B>]  [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
29   
30 <B>backup</B> [<B>i</B>]  [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell name</VAR>>]  [<B>-h</B>]
31 </PRE>
32 <P><STRONG>Description</STRONG>
33 <P>The <B>backup interactive</B> initiates an interactive session for
34 issuing <B>backup</B> commands. As indicated in the syntax
35 statement, the operation code (<B>interactive</B>) is optional.
36 <P>Several features of interactive mode distinguish it from regular
37 mode:
38 <UL>
39 <P><LI>In interactive mode, the <TT>backup></TT> prompt replaces the system
40 (shell) prompt. The operator enters only a command's operation
41 code (omitting the command suite name, <B>backup</B>).
42 <P><LI>If the <B>-localauth</B> flag or the <B>-cell</B> argument is
43 included on the <B>backup (interactive)</B> command, the settings apply to
44 all commands issued during that interactive session. The issuer does
45 not need to type them on every command. Another consequence is that the
46 flag and argument do not appear in the syntax statement generated by the
47 <B>help</B> subcommand or <B>-help</B> flag on an individual command
48 issued at the <TT>backup></TT> prompt.
49 <P><LI>The <B>(backup) jobs</B> and <B>(backup) kill</B> commands are
50 available only in interactive mode. It is not possible to track and
51 terminate backup operations as cleanly in non-interactive mode.
52 <P><LI>It is not necessary to enclose strings that include metacharacters in
53 double quotes or other delimiters.
54 <P><LI>The <B>backup</B> command interpreter establishes a connection to the
55 Backup Server, Volume Server and Volume Location (VL) Server processes as it
56 enters interactive mode, and uses the same connection for all commands during
57 the session. Execution time can therefore be faster than in
58 non-interactive mode, in which the command interpreter must establish a new
59 connection for each command.
60 </UL>
61 <P>To exit an interactive session, issue the <B>(backup) quit</B>
62 command.
63 <P><STRONG>Options</STRONG>
64 <DL>
65 <P><DT><B>-localauth
66 </B><DD>Constructs a server ticket using a key from the local
67 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
68 interpreter presents it to the Backup Server, Volume Server and VL Server
69 during mutual authentication. Do not combine this flag with the
70 <B>-cell</B> argument. For more details, see the introductory
71 <B>backup</B> reference page.
72 <P><DT><B>-cell
73 </B><DD>Names the cell in which to run the command. Do not combine this
74 argument with the <B>-localauth</B> flag. For more details, see the
75 introductory <B>backup</B> reference page.
76 <P><DT><B>-help
77 </B><DD>Prints the online help for this command. All other valid options
78 are ignored.
79 </DL>
80 <P><STRONG>Examples</STRONG>
81 <P>The following example shows how the <B>-localauth</B> flag and
82 <B>-cell</B> argument do not appear when the <B>help dump</B>
83 subcommand is issued in interactive mode.
84 <PRE>   % <B>backup</B>
85    backup> <B>help dump</B>
86    dump: start dump 
87    Usage: dump [-volumeset &lt;volume&nbsp;set&nbsp;name>] [-dump &lt;dump level name>] 
88    [-portoffset &lt;TC port offset>] [-at &lt;Date/time to start dump>+]
89    [-append ] [-n ] [-file &lt;load file>] [-help ] 
90    
91 </PRE>
92 <P><STRONG>Privilege Required</STRONG>
93 <P>None. However, <B>backup</B> commands that require privilege in
94 regular mode still require it in interactive mode.
95 <P><STRONG>Related Information</STRONG>
96 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
97 <P><A HREF="auarf077.htm#HDRBK_JOBS">backup jobs</A>
98 <P><A HREF="auarf078.htm#HDRBK_KILL">backup kill</A>
99 <P><A HREF="auarf083.htm#HDRBK_QUIT">backup quit</A>
100 <P><A HREF="auarf126.htm#HDRBUTC">butc</A>
101 <P>
102 <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> 
103 <!-- Begin Footer Records  ========================================== -->
104 <P><HR><B> 
105 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
106 </B> 
107 <!-- End Footer Records  ============================================ -->
108 <A NAME="Bot_Of_Page"></A>
109 </BODY></HTML>