doc/man-pages/pod1/pts_interactive.pod

   1 =head1 NAME
   2
   3 pts_interactive - Enters interactive mode
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<pts interactive> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>]
  11     [B<-auth>] [B<-localauth>] [B<-force>]
  12
  13 B<pts in> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-f>]
  14
  15 =for html
  16 </div>
  17
  18 =head1 DESCRIPTION
  19
  20 The B<pts interactive> command allows the user to enter an interactive
  21 mode, useful for running bulk commands like creating new users or groups.
  22
  23 B<pts interactive> uses the authentication state supplied on its command
  24 line to run all bulk commands. However, if a bulk command is supplied
  25 with authentication options such as B<-cell>, B<-localauth>, B<-auth>
  26 or B<-noauth> then it, and all subsequent bulk commands, will be run with
  27 those options.
  28
  29 =head1 CAUTIONS
  30
  31 Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts interactive> command
  32 was only available on Unix or Linux and when OpenAFS was compiled with the
  33 supergroups option (disabled by default).  As of OpenAFS 1.4.5 and 1.5.23,
  34 it is always available.
  35
  36 Running bulk B<pts> commands may degrade the performance of the Protection
  37 Server while they are run and server resources may not be released
  38 immediately after commands are run. The B<pts sleep> command can be used
  39 in interactive mode or with B<pts source> to give the Protection Server a
  40 change to catch up.
  41
  42 =head1 OPTIONS
  43
  44 B<pts interactive> only takes the standard B<pts> options.
  45
  46 =over 4
  47
  48 =item B<-cell> <I<cell name>>
  49
  50 Names the cell in which to run the command. For more details, see
  51 L<pts(1)>.
  52
  53 =item B<-force>
  54
  55 Enables the command to continue executing as far as possible when errors
  56 or other problems occur, rather than halting execution at the first error.
  57 This is useful for bulk operations where you would like to continue even
  58 if one of many operations fails.
  59
  60 =item B<-noauth>
  61
  62 Assigns the unprivileged identity anonymous to the issuer. For more
  63 details, see L<pts(1)>.
  64
  65 =item B<-localauth>
  66
  67 Constructs a server ticket using a key from the local
  68 F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
  69 B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
  70
  71 =back
  72
  73 =head1 OUTPUT
  74
  75 The output is the same as if each individual command were run from the
  76 command line.
  77
  78 =head1 EXAMPLES
  79
  80 Here is an example of a B<pts interactive> session:
  81
  82    % pts interactive
  83    pts> examine admin
  84    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
  85      membership: 2, flags: S----, group quota: 20.
  86    pts> help
  87    pts: Commands are:
  88    adduser         add a user to a group
  89    apropos         search by help text
  90    chown           change ownership of a group
  91    creategroup     create a new group
  92    createuser      create a new user
  93    delete          delete a user or group from database
  94    examine         examine an entry
  95    help            get help on commands
  96    interactive     enter interactive mode
  97    listentries     list users/groups in the protection database
  98    listmax         list max id
  99    listowned       list groups owned by an entry or zero id gets orphaned groups
 100    membership      list membership of a user or group
 101    quit            exit program
 102    removeuser      remove a user from a group
 103    rename          rename user or group
 104    setfields       set fields for an entry
 105    setmax          set max id
 106    sleep           pause for a bit
 107    source          read commands from file
 108    pts> quit
 109    %
 110
 111 =head1 PRIVILEGE REQUIRED
 112
 113 The same privilege is required to run the command in interactive mode as
 114 is required to run the command by itself on the command line. Some
 115 commands such as B<pts createuser> require that the user belong to the
 116 system:administrators group, while others do not.
 117
 118 =head1 SEE ALSO
 119
 120 L<pts(1)>,
 121 L<pts_quit(1)>,
 122 L<pts_sleep(1)>,
 123 L<pts_source(1)>,
 124 L<ptserver(8)>
 125
 126 =head1 COPYRIGHT
 127
 128 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
 129
 130 This documentation is covered by the BSD License as written in the
 131 doc/LICENSE file. This man page was written by Jason Edgecombe for
 132 OpenAFS.