DEVEL15-man-page-pts-pullup-20070817
[openafs.git] / 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<-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 =head1 CAUTIONS
24
25 Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts interactive> command
26 was only available on Unix or Linux and when OpenAFS was compiled with the
27 supergroups option (disabled by default).  As of OpenAFS 1.4.5 and 1.5.23,
28 it is always available.
29
30 Running bulk B<pts> commands may degrade the performance of the Protection
31 Server while they are run and server resources may not be released
32 immediately after commands are run. The B<pts sleep> command can be used
33 in interactive mode or with B<pts source> to give the Protection Server a
34 change to catch up.
35
36 =head1 OPTIONS
37
38 B<pts interactive> only takes the standard B<pts> options.
39
40 =over 4
41
42 =item B<-cell> <I<cell name>>
43
44 Names the cell in which to run the command. For more details, see
45 L<pts(1)>.
46
47 =item B<-force>
48
49 Enables the command to continue executing as far as possible when errors
50 or other problems occur, rather than halting execution at the first error.
51 This is useful for bulk operations where you would like to continue even
52 if one of many operations fails.
53
54 =item B<-noauth>
55
56 Assigns the unprivileged identity anonymous to the issuer. For more
57 details, see L<pts(1)>.
58
59 =back
60
61 =head1 OUTPUT
62
63 The output is the same as if each individual command were run from the
64 command line.
65
66 =head1 EXAMPLES
67
68 Here is an example of a B<pts interactive> session:
69
70    % pts interactive
71    pts> examine admin
72    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
73      membership: 2, flags: S----, group quota: 20.
74    pts> help
75    pts: Commands are:
76    adduser         add a user to a group
77    apropos         search by help text
78    chown           change ownership of a group
79    creategroup     create a new group
80    createuser      create a new user
81    delete          delete a user or group from database
82    examine         examine an entry
83    help            get help on commands
84    interactive     enter interactive mode
85    listentries     list users/groups in the protection database
86    listmax         list max id
87    listowned       list groups owned by an entry or zero id gets orphaned groups
88    membership      list membership of a user or group
89    quit            exit program
90    removeuser      remove a user from a group
91    rename          rename user or group
92    setfields       set fields for an entry
93    setmax          set max id
94    sleep           pause for a bit
95    source          read commands from file
96    pts> quit
97    %
98
99 =head1 PRIVILEGE REQUIRED
100
101 The same privilege is required to run the command in interactive mode as
102 is required to run the command by itself on the command line. Some
103 commands such as B<pts createuser> require that the user belong to the
104 system:administrators group, while others do not.
105
106 =head1 SEE ALSO
107
108 L<pts(1)>,
109 L<pts_quit(1)>,
110 L<pts_sleep(1)>,
111 L<pts_source(1)>,
112 L<ptserver(8)>
113
114 =head1 COPYRIGHT
115
116 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
117
118 This documentation is covered by the IBM Public License Version 1.0. This
119 man page was written by Jason Edgecombe for OpenAFS.