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>]
  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 =include fragments/pts-common.pod
  49
  50 =back
  51
  52 =head1 OUTPUT
  53
  54 The output is the same as if each individual command were run from the
  55 command line.
  56
  57 =head1 EXAMPLES
  58
  59 Here is an example of a B<pts interactive> session:
  60
  61    % pts interactive
  62    pts> examine admin
  63    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
  64      membership: 2, flags: S----, group quota: 20.
  65    pts> help
  66    pts: Commands are:
  67    adduser         add a user to a group
  68    apropos         search by help text
  69    chown           change ownership of a group
  70    creategroup     create a new group
  71    createuser      create a new user
  72    delete          delete a user or group from database
  73    examine         examine an entry
  74    help            get help on commands
  75    interactive     enter interactive mode
  76    listentries     list users/groups in the protection database
  77    listmax         list max id
  78    listowned       list groups owned by an entry or zero id gets orphaned groups
  79    membership      list membership of a user or group
  80    quit            exit program
  81    removeuser      remove a user from a group
  82    rename          rename user or group
  83    setfields       set fields for an entry
  84    setmax          set max id
  85    sleep           pause for a bit
  86    source          read commands from file
  87    pts> quit
  88    %
  89
  90 =head1 PRIVILEGE REQUIRED
  91
  92 The same privilege is required to run the command in interactive mode as
  93 is required to run the command by itself on the command line. Some
  94 commands such as B<pts createuser> require that the user belong to the
  95 system:administrators group, while others do not.
  96
  97 =head1 SEE ALSO
  98
  99 L<pts(1)>,
 100 L<pts_quit(1)>,
 101 L<pts_sleep(1)>,
 102 L<pts_source(1)>,
 103 L<ptserver(8)>
 104
 105 =head1 COPYRIGHT
 106
 107 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
 108
 109 This documentation is covered by the BSD License as written in the
 110 doc/LICENSE file. This man page was written by Jason Edgecombe for
 111 OpenAFS.