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