man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / backup_interactive.pod
1 =head1 NAME
2
3 backup interactive - Enters interactive mode
4
5 =head1 SYNOPSIS
6
7 B<backup> [B<interactive>] [B<-localauth>] [B<-cell> <I<cell name>>]
8     [B<-help>]
9
10 B<backup> [B<i>] [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
11
12 =head1 DESCRIPTION
13
14 The B<backup interactive> initiates an interactive session for issuing
15 B<backup> commands. As indicated in the syntax statement, the operation
16 code (B<interactive>) is optional.
17
18 Several features of interactive mode distinguish it from regular mode:
19
20 =over 4
21
22 =item *
23
24 In interactive mode, the C<backup>> prompt replaces the system (shell)
25 prompt. The operator enters only a command's operation code (omitting the
26 command suite name, B<backup>).
27
28 =item *
29
30 If the B<-localauth> flag or the B<-cell> argument is included on the
31 B<backup interactive> command, the settings apply to all commands issued
32 during that interactive session. The issuer does not need to type them on
33 every command. Another consequence is that the flag and argument do not
34 appear in the syntax statement generated by the B<help> subcommand or
35 B<-help> flag on an individual command issued at the C<backup>> prompt.
36
37 =item *
38
39 The B<backup jobs> and B<backup kill> commands are available only in
40 interactive mode. It is not possible to track and terminate backup
41 operations as cleanly in non-interactive mode.
42
43 =item *
44
45 It is not necessary to enclose strings that include metacharacters in
46 double quotes or other delimiters.
47
48 =item *
49
50 The backup command interpreter establishes a connection to the Backup
51 Server, Volume Server and Volume Location (VL) Server processes as it
52 enters interactive mode, and uses the same connection for all commands
53 during the session. Execution time can therefore be faster than in
54 non-interactive mode, in which the command interpreter must establish a
55 new connection for each command.
56
57 =back
58
59 To exit an interactive session, issue the B<backup quit> command.
60
61 =head1 OPTIONS
62
63 =over 4
64
65 =item B<-localauth>
66
67 Constructs a server ticket using a key from the local
68 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
69 it to the Backup Server, Volume Server and VL Server during mutual
70 authentication. Do not combine this flag with the B<-cell> argument. For
71 more details, see L<backup(8)>.
72
73 =item B<-cell> <I<cell name>>
74
75 Names the cell in which to run the command. Do not combine this argument
76 with the B<-localauth> flag. For more details, see L<backup(8)>.
77
78 =item B<-help>
79
80 Prints the online help for this command. All other valid options are
81 ignored.
82
83 =back
84
85 =head1 EXAMPLES
86
87 The following example shows how the B<-localauth> flag and B<-cell>
88 argument do not appear when the B<help dump> subcommand is issued in
89 interactive mode.
90
91    % backup
92    backup> help dump
93    dump: start dump 
94    Usage: dump [-volumeset <volume set name>] [-dump <dump level name>] 
95    [-portoffset <TC port offset>] [-at <Date/time to start dump>+]
96    [-append ] [-n ] [-file <load file>] [-help ] 
97
98 =head1 PRIVILEGE REQUIRED
99
100 None. However, B<backup> commands that require privilege in regular mode
101 still require it in interactive mode.
102
103 =head1 SEE ALSO
104
105 L<backup(8)>,
106 L<backup_jobs(8)>,
107 L<backup_kill(8)>,
108 L<backup_quit(8)>,
109 L<butc(8)>
110
111 =head1 COPYRIGHT
112
113 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
114
115 This documentation is covered by the IBM Public License Version 1.0.  It was
116 converted from HTML to POD by software written by Chas Williams and Russ
117 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.