[hcoop/debian/openafs.git] / doc / man-pages / pod8 / backup_interactive.pod

=head1 NAME

backup_interactive - Enters interactive mode

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<backup> [B<interactive>] [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>>
    [B<-help>]

B<backup> [B<i>] [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]

=for html
</div>

=head1 DESCRIPTION

The B<backup interactive> initiates an interactive session for issuing
B<backup> commands. As indicated in the syntax statement, the operation
code (B<interactive>) is optional.

Several features of interactive mode distinguish it from regular mode:

=over 4

=item *

In interactive mode, the C<backup>> prompt replaces the system (shell)
prompt. The operator enters only a command's operation code (omitting the
command suite name, B<backup>).

=item *

If the B<-localauth> flag or the B<-cell> argument is included on the
B<backup interactive> 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> subcommand or
B<-help> flag on an individual command issued at the C<backup>> prompt.

=item *

The B<backup jobs> and B<backup kill> commands are available only in
interactive mode. It is not possible to track and terminate backup
operations as cleanly in non-interactive mode.

=item *

It is not necessary to enclose strings that include metacharacters in
double quotes or other delimiters.

=item *

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.

=back

To exit an interactive session, issue the B<backup quit> command.

=head1 OPTIONS

=over 4

=item B<-localauth>

Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<backup> 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> argument. For
more details, see L<backup(8)>.

=item B<-cell> <I<cell name>>

Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<backup(8)>.

=item B<-help>

Prints the online help for this command. All other valid options are
ignored.

=back

=head1 EXAMPLES

The following example shows how the B<-localauth> flag and B<-cell>
argument do not appear when the B<help dump> subcommand is issued in
interactive mode.

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

=head1 PRIVILEGE REQUIRED

None. However, B<backup> commands that require privilege in regular mode
still require it in interactive mode.

=head1 SEE ALSO

L<backup(8)>,
L<backup_jobs(8)>,
L<backup_kill(8)>,
L<backup_quit(8)>,
L<butc(8)>

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

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