doc/man-pages/pod1/pts_interactive.pod.in

   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>] [B<-help>]
  12     [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
  13
  14
  15 B<pts in> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-f>] [B<-h>]
  16     [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
  17
  18 =for html
  19 </div>
  20
  21 =head1 DESCRIPTION
  22
  23 The B<pts interactive> command allows the user to enter an interactive
  24 mode, useful for running bulk commands like creating new users or groups.
  25
  26 B<pts interactive> uses the authentication state supplied on its command
  27 line to run all bulk commands. However, if a bulk command is supplied
  28 with authentication options such as B<-cell>, B<-localauth>, B<-auth>
  29 or B<-noauth> then it, and all subsequent bulk commands, will be run with
  30 those options.
  31
  32 =head1 CAUTIONS
  33
  34 Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts interactive> command
  35 was only available on Unix or Linux and when OpenAFS was compiled with the
  36 supergroups option (disabled by default).  As of OpenAFS 1.4.5 and 1.5.23,
  37 it is always available.
  38
  39 Running bulk B<pts> commands may degrade the performance of the Protection
  40 Server while they are run and server resources may not be released
  41 immediately after commands are run. The B<pts sleep> command can be used
  42 in interactive mode or with B<pts source> to give the Protection Server a
  43 change to catch up.
  44
  45 =head1 OPTIONS
  46
  47 B<pts interactive> only takes the standard B<pts> options.
  48
  49 =over 4
  50
  51 =include fragments/pts-common.pod
  52
  53 =back
  54
  55 =head1 OUTPUT
  56
  57 The output is the same as if each individual command were run from the
  58 command line.
  59
  60 =head1 EXAMPLES
  61
  62 Here is an example of a B<pts interactive> session:
  63
  64    % pts interactive
  65    pts> examine admin
  66    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
  67      membership: 2, flags: S----, group quota: 20.
  68    pts> help
  69    pts: Commands are:
  70    adduser         add a user to a group
  71    apropos         search by help text
  72    chown           change ownership of a group
  73    creategroup     create a new group
  74    createuser      create a new user
  75    delete          delete a user or group from database
  76    examine         examine an entry
  77    help            get help on commands
  78    interactive     enter interactive mode
  79    listentries     list users/groups in the protection database
  80    listmax         list max id
  81    listowned       list groups owned by an entry or zero id gets orphaned groups
  82    membership      list membership of a user or group
  83    quit            exit program
  84    removeuser      remove a user from a group
  85    rename          rename user or group
  86    setfields       set fields for an entry
  87    setmax          set max id
  88    sleep           pause for a bit
  89    source          read commands from file
  90    pts> quit
  91    %
  92
  93 =head1 PRIVILEGE REQUIRED
  94
  95 The same privilege is required to run the command in interactive mode as
  96 is required to run the command by itself on the command line. Some
  97 commands such as B<pts createuser> require that the user belong to the
  98 system:administrators group, while others do not.
  99
 100 =head1 SEE ALSO
 101
 102 L<pts(1)>,
 103 L<pts_quit(1)>,
 104 L<pts_sleep(1)>,
 105 L<pts_source(1)>,
 106 L<ptserver(8)>
 107
 108 =head1 COPYRIGHT
 109
 110 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
 111
 112 This documentation is covered by the BSD License as written in the
 113 doc/LICENSE file. This man page was written by Jason Edgecombe for
 114 OpenAFS.