mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
f69bf0b194
- Mention the -help, -auth, -encrypt, and -config options for all pts commands in their synopsis - Add the -auth option to the pts.pod page - Reference the -auth, -encrypt, and -config options from all subcommand pts pages - pts_removeuser: Replace -name with -user - pts_sleep: Add missing -delay - pts_source: Add missing -file Change-Id: I4f0889d661c46f6bdd2a9604d8423d809a632d2d Reviewed-on: http://gerrit.openafs.org/10387 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
115 lines
3.4 KiB
Plaintext
115 lines
3.4 KiB
Plaintext
=head1 NAME
|
|
|
|
pts_interactive - Enters interactive mode
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<pts interactive> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>]
|
|
[B<-auth>] [B<-localauth>] [B<-force>] [B<-help>]
|
|
[B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
|
|
|
|
|
|
B<pts in> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-f>] [B<-h>]
|
|
[B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<pts interactive> command allows the user to enter an interactive
|
|
mode, useful for running bulk commands like creating new users or groups.
|
|
|
|
B<pts interactive> uses the authentication state supplied on its command
|
|
line to run all bulk commands. However, if a bulk command is supplied
|
|
with authentication options such as B<-cell>, B<-localauth>, B<-auth>
|
|
or B<-noauth> then it, and all subsequent bulk commands, will be run with
|
|
those options.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts interactive> command
|
|
was only available on Unix or Linux and when OpenAFS was compiled with the
|
|
supergroups option (disabled by default). As of OpenAFS 1.4.5 and 1.5.23,
|
|
it is always available.
|
|
|
|
Running bulk B<pts> commands may degrade the performance of the Protection
|
|
Server while they are run and server resources may not be released
|
|
immediately after commands are run. The B<pts sleep> command can be used
|
|
in interactive mode or with B<pts source> to give the Protection Server a
|
|
change to catch up.
|
|
|
|
=head1 OPTIONS
|
|
|
|
B<pts interactive> only takes the standard B<pts> options.
|
|
|
|
=over 4
|
|
|
|
=include fragments/pts-common.pod
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
The output is the same as if each individual command were run from the
|
|
command line.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Here is an example of a B<pts interactive> session:
|
|
|
|
% pts interactive
|
|
pts> examine admin
|
|
Name: admin, id: 1, owner: system:administrators, creator: anonymous,
|
|
membership: 2, flags: S----, group quota: 20.
|
|
pts> help
|
|
pts: Commands are:
|
|
adduser add a user to a group
|
|
apropos search by help text
|
|
chown change ownership of a group
|
|
creategroup create a new group
|
|
createuser create a new user
|
|
delete delete a user or group from database
|
|
examine examine an entry
|
|
help get help on commands
|
|
interactive enter interactive mode
|
|
listentries list users/groups in the protection database
|
|
listmax list max id
|
|
listowned list groups owned by an entry or zero id gets orphaned groups
|
|
membership list membership of a user or group
|
|
quit exit program
|
|
removeuser remove a user from a group
|
|
rename rename user or group
|
|
setfields set fields for an entry
|
|
setmax set max id
|
|
sleep pause for a bit
|
|
source read commands from file
|
|
pts> quit
|
|
%
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The same privilege is required to run the command in interactive mode as
|
|
is required to run the command by itself on the command line. Some
|
|
commands such as B<pts createuser> require that the user belong to the
|
|
system:administrators group, while others do not.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<pts(1)>,
|
|
L<pts_quit(1)>,
|
|
L<pts_sleep(1)>,
|
|
L<pts_source(1)>,
|
|
L<ptserver(8)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
|
|
|
|
This documentation is covered by the BSD License as written in the
|
|
doc/LICENSE file. This man page was written by Jason Edgecombe for
|
|
OpenAFS.
|