.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BACKUP_INTERACTIVE 8"
.TH BACKUP_INTERACTIVE 8 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
backup_interactive \- Enters interactive mode
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBbackup\fR [\fBinteractive\fR] [\fB\-localauth\fR] [\fB\-cell\fR\ <\fIcell\ name\fR>]
    [\fB\-help\fR]
.PP
\&\fBbackup\fR [\fBi\fR] [\fB\-l\fR] [\fB\-c\fR\ <\fIcell\ name\fR>] [\fB\-h\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBbackup interactive\fR initiates an interactive session for issuing
\&\fBbackup\fR commands. As indicated in the syntax statement, the operation
code (\fBinteractive\fR) is optional.
.PP
Several features of interactive mode distinguish it from regular mode:
.IP \(bu 4
In interactive mode, the \f(CW\*(C`backup\*(C'\fR> prompt replaces the system (shell)
prompt. The operator enters only a command's operation code (omitting the
command suite name, \fBbackup\fR).
.IP \(bu 4
If the \fB\-localauth\fR flag or the \fB\-cell\fR argument is included on the
\&\fBbackup interactive\fR 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 \fBhelp\fR subcommand or
\&\fB\-help\fR flag on an individual command issued at the \f(CW\*(C`backup\*(C'\fR> prompt.
.IP \(bu 4
The \fBbackup jobs\fR and \fBbackup kill\fR commands are available only in
interactive mode. It is not possible to track and terminate backup
operations as cleanly in non-interactive mode.
.IP \(bu 4
It is not necessary to enclose strings that include metacharacters in
double quotes or other delimiters.
.IP \(bu 4
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.
.PP
To exit an interactive session, issue the \fBbackup quit\fR command.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-localauth\fR 4
.IX Item "-localauth"
Constructs a server ticket using a key from the local
\&\fI/etc/openafs/server/KeyFile\fR file. The \fBbackup\fR command interpreter presents
it to the Backup Server, Volume Server and VL Server during mutual
authentication. Do not combine this flag with the \fB\-cell\fR argument. For
more details, see \fBbackup\fR\|(8).
.IP "\fB\-cell\fR <\fIcell name\fR>" 4
.IX Item "-cell <cell name>"
Names the cell in which to run the command. Do not combine this argument
with the \fB\-localauth\fR flag. For more details, see \fBbackup\fR\|(8).
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH EXAMPLES
.IX Header "EXAMPLES"
The following example shows how the \fB\-localauth\fR flag and \fB\-cell\fR
argument do not appear when the \fBhelp dump\fR subcommand is issued in
interactive mode.
.PP
.Vb 6
\&   % 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 ]
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
None. However, \fBbackup\fR commands that require privilege in regular mode
still require it in interactive mode.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBbackup\fR\|(8),
\&\fBbackup_jobs\fR\|(8),
\&\fBbackup_kill\fR\|(8),
\&\fBbackup_quit\fR\|(8),
\&\fBbutc\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
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.