[OpenAFS-Doc] new man pages: pts_interactive, pts_sleep, and
pts_quit
Jason Edgecombe
jason@rampaginggeek.com
Sat, 11 Aug 2007 15:56:33 -0400
This is a multi-part message in MIME format.
--------------000908050303020607050703
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
ok,
I'm sorry for all of the different versions of the pts_* man pages I've
been bombarding the list with, but here is what I believe to be my final
versions of the pts pages. There are no pts pages left in the
man-pages/README file.
I've attached the latest versions of the pts source, pts sleep, pts
interactive, and pts quit man pages along with a diff against the CVS
head that shows my changes to existing files.
I fixed some pod syntax errors in existing files (most of which were mine).
The pts stuff should be safe to commit now. I'm done with it.
Sincerely,
Jason
Jason Edgecombe wrote:
> I fixed the name section of pts_quit. New file is attached.
>
> Thanks to andrew deason for pointing that out.
>
>
> Jason
>
> Jason Edgecombe wrote:
>> Hi guys,
>>
>> These are the latest versions of the pts_interactive, pts_sleep, and
>> pts_quit man pages. they should probably go in man-pages/pod1. Please
>> disregard earlier versions. I've included a patch for
>> man-pages/README against CVS head.
>>
>> I had added some commas in the "SEE ALSO" section to the newer versions.
>>
>> Only one more and all pts commands will be documented!
>>
>> Sincerely,
>> Jason
--------------000908050303020607050703
Content-Type: text/plain; x-mac-type="0"; x-mac-creator="0";
name="diff.txt"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="diff.txt"
? doc/man-pages/readpod
? doc/man-pages/testpod
? doc/man-pages/pod1/pts_interactive.pod
? doc/man-pages/pod1/pts_quit.pod
? doc/man-pages/pod1/pts_sleep.pod
? doc/man-pages/pod1/pts_source.pod
Index: doc/man-pages/README
===================================================================
RCS file: /cvs/openafs/doc/man-pages/README,v
retrieving revision 1.14
diff -u -r1.14 README
--- doc/man-pages/README 5 Aug 2007 21:58:35 -0000 1.14
+++ doc/man-pages/README 11 Aug 2007 19:35:31 -0000
@@ -201,10 +201,6 @@
fs rxstatproc
fs setcbaddr
kseal
- pts interactive
- pts quit
- pts sleep
- pts source
read_tape
restorevol
rmtsysd
Index: doc/man-pages/pod1/fs_getcrypt.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/fs_getcrypt.pod,v
retrieving revision 1.3
diff -u -r1.3 fs_getcrypt.pod
--- doc/man-pages/pod1/fs_getcrypt.pod 5 Aug 2007 21:38:10 -0000 1.3
+++ doc/man-pages/pod1/fs_getcrypt.pod 11 Aug 2007 19:35:31 -0000
@@ -58,8 +58,6 @@
% fs getcrypt
-=back
-
=head1 PRIVILEGE REQUIRED
No special priviledges are required for this command.
Index: doc/man-pages/pod1/fs_listaliases.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/fs_listaliases.pod,v
retrieving revision 1.2
diff -u -r1.2 fs_listaliases.pod
--- doc/man-pages/pod1/fs_listaliases.pod 5 Aug 2007 21:38:10 -0000 1.2
+++ doc/man-pages/pod1/fs_listaliases.pod 11 Aug 2007 19:35:31 -0000
@@ -43,8 +43,6 @@
% fs listaliases
-=back
-
=head1 PRIVILEGE REQUIRED
No special priviledges are required for this command.
Index: doc/man-pages/pod1/pts.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/pts.pod,v
retrieving revision 1.2
diff -u -r1.2 pts.pod
--- doc/man-pages/pod1/pts.pod 9 Dec 2005 13:26:31 -0000 1.2
+++ doc/man-pages/pod1/pts.pod 11 Aug 2007 19:35:31 -0000
@@ -52,6 +52,15 @@
=item *
+Commands to run commands interactively: B<pts interactive>, B<pts
+sleep>, and B<pts quit>
+
+=item *
+
+A command to read bulk commands form a file: B<pts source>
+
+=item *
+
Commands to obtain help: B<pts apropos> and B<pts help>.
=back
@@ -136,14 +145,18 @@
L<pts_delete(1)>,
L<pts_examine(1)>,
L<pts_help(1)>,
+L<pts_interactive(1)>,
L<pts_listentries(1)>,
L<pts_listmax(1)>,
L<pts_listowned(1)>,
L<pts_membership(1)>,
+L<pts_quit(1)>,
L<pts_removeuser(1)>,
L<pts_rename(1)>,
L<pts_setfields(1)>,
-L<pts_setmax(1)>
+L<pts_setmax(1)>,
+L<pts_sleep(1)>,
+L<pts_source(1)>
=head1 COPYRIGHT
Index: doc/man-pages/pod1/vos_backupsys.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/vos_backupsys.pod,v
retrieving revision 1.5
diff -u -r1.5 vos_backupsys.pod
--- doc/man-pages/pod1/vos_backupsys.pod 1 Mar 2006 05:02:30 -0000 1.5
+++ doc/man-pages/pod1/vos_backupsys.pod 11 Aug 2007 19:35:32 -0000
@@ -109,7 +109,7 @@
-prefix '^.*aix'
-=back 4
+=back
To display a list of the volumes to be cloned, without actually cloning
them, include the B<-dryrun> flag. To display a statement that summarizes
Index: doc/man-pages/pod1/vos_size.pod
===================================================================
RCS file: /cvs/openafs/doc/man-pages/pod1/vos_size.pod,v
retrieving revision 1.1
diff -u -r1.1 vos_size.pod
--- doc/man-pages/pod1/vos_size.pod 5 Aug 2007 21:58:35 -0000 1.1
+++ doc/man-pages/pod1/vos_size.pod 11 Aug 2007 19:35:32 -0000
@@ -125,8 +125,6 @@
Volume: user.thoron
dump_size: 21095
-=back
-
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
--------------000908050303020607050703
Content-Type: text/plain; x-mac-type="0"; x-mac-creator="0";
name="pts_quit.pod"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="pts_quit.pod"
=head1 NAME
pts quit - Exit from B<pts interactive> mode
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<pts quit> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-force>]
B<pts q> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-force>]
=for html
</div>
=head1 DESCRIPTION
The B<pts quit> command exits from pts interactive mode. The command
can be run from the command line or interactively. Running B<pts quit>
on the command line isn't very useful because it doesn't do anything
from the command line.
=head1 CAUTIONS
The B<pts quit> command is only available if OpenAFS was compiled
with the supergroups option, which is disabled by default.
This command is only available on Windows in OpenAFS version 1.5.23
and later when compiled with the SUPERGROUPS option.
=head1 OPTIONS
Even though they have no appreciable effect, B<pts quit> takes
the following options:
=over 4
=item B<-cell> <I<cell name>>
Specifies an alternate cell to talk to.
=item B<-force>
Continue the operation even if there are errors. This is useful for
bulk operations where you would like to continue even if one of the
many operations fails.
=item B<-noauth>
Perform the action as the unauthenticated user instead of using the
current users credentials.
=back
=head1 OUTPUT
This command has no output.
=head1 EXAMPLES
Here is an example of a B<pts interactive> session:
% pts interactive
pts> quit
%
=head1 SEE ALSO
L<pts(1)>,
L<pts_interactive(1)>,
L<pts_sleep(1)>,
L<pts_source(1)>
=head1 COPYRIGHT
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
This documentation is covered by the IBM Public License Version 1.0. This
man page was written by Jason Edgecombe for OpenAFS.
--------------000908050303020607050703
Content-Type: text/plain; x-mac-type="0"; x-mac-creator="0";
name="pts_interactive.pod"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="pts_interactive.pod"
=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<-force>]
B<pts in> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-force>]
=for html
</div>
=head1 DESCRIPTION
The B<pts interactive> command allows the user to enter an interactive
mode which is useful for running bulk commands like creating new users
or groups.
=head1 CAUTIONS
The B<pts_interactive> command is only available if OpenAFS was
compiled with the supergroups option, which is disabled by default.
This command is only available on Windows in OpenAFS version 1.5.23
and later when compiled with the SUPERGROUPS option.
Running bulk B<pts> commands may degrade the performance of the pts
server while they are run. In addition, server resource may not be
released immediately after commands are run. Because of this, the
L<pts sleep(1)> command can be used in interactive mode or with
L<pts source(1)> to give the B<ptserver> a change to catch up.
=head1 OPTIONS
B<pts interactive> only takes the standard B<pts> options.
=over 4
=item B<-cell> <I<cell name>>
Specifies an alternate cell to talk to.
=item B<-noauth>
Perform the action as the unauthenticated user instead of using the
current users credentials.
=item B<-force>
Continue the operation even if there are errors. This is useful for
bulk operations where you would like to continue even if one of the
many operations fails.
=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 AFS administrator
privileges, while others do not.
=head1 SEE ALSO
L<pts(1)>,
L<pts_quit(1)>,
L<pts_sleep(1)>,
L<pts_source(1)>
=head1 COPYRIGHT
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
This documentation is covered by the IBM Public License Version 1.0. This
man page was written by Jason Edgecombe for OpenAFS.
--------------000908050303020607050703
Content-Type: text/plain; x-mac-type="0"; x-mac-creator="0";
name="pts_source.pod"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="pts_source.pod"
=head1 NAME
pts source - Read pts commands from a file
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<pts source> S<<< [B<-file>] <I<file name>> >>> S<<< [B<-cell>] <I<cell name>> >>>
[B<-noauth>] [B<-force>]
B<pts so> S<<< [B<-file>] <I<file name>> >>> S<<< [B<-cell>] <I<cell name>> >>>
[B<-noauth>] [B<-force>]
=for html
</div>
=head1 DESCRIPTION
The B<pts source> runs commands from a file as if they were typed in
pts interactive mode. The command can be run from the command line or
interactively.
=head1 CAUTIONS
The B<pts source> command is only available if OpenAFS was compiled
with the supergroups option, which is disabled by default.
This command is only available on Windows in OpenAFS version 1.5.23
and later when compiled with the SUPERGROUPS option.
=head1 OPTIONS
B<pts source> takes the following options:
=over 4
=item B<-cell> <I<cell name>>
Specifies an alternate cell to talk to.
=item B<-file> <I<file name>>
Specifies the filename from which to read commands.
=item B<-force>
Continue the operation even if there are errors. This is useful for
bulk operations where you would like to continue even if one of the
many operations fails.
=item B<-noauth>
Perform the action as the unauthenticated user instead of using the
current users credentials.
=back
=head1 OUTPUT
This command shows the output of each comand in the file as if it were
run normally.
=head1 EXAMPLES
Here is an example of using B<pts source> in a B<pts interactive> session:
% echo examine admin > /tmp/commands.txt
% pts interactive
pts> source /tmp/commands.txt
Name: admin, id: 1, owner: system:administrators, creator: anonymous,
membership: 2, flags: S----, group quota: 20.
pts> quit
%
=head1 SEE ALSO
L<pts(1)>,
L<pts_interactive(1)>,
L<pts_quit(1)>,
L<pts_sleep(1)>
=head1 COPYRIGHT
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
This documentation is covered by the IBM Public License Version 1.0. This
man page was written by Jason Edgecombe for OpenAFS.
--------------000908050303020607050703
Content-Type: text/plain; x-mac-type="0"; x-mac-creator="0";
name="pts_sleep.pod"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="pts_sleep.pod"
=head1 NAME
pts sleep - Pauses for a few seconds
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<pts sleep> S<<< [B<-delay>] <I<# of seconds>> >>>
S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-force>]
B<pts sl> S<<< [B<-delay>] <I<# of seconds>> >>>
S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-force>]
=for html
</div>
=head1 DESCRIPTION
The B<pts sleep> pauses for a specified number of seconds. The command
can be run from the command line or interactively. Running B<pts
sleep> on the command line isn't very useful. It's primarily for use
in interactive mode where you can use it to pause for a few seconds
between batch commands.
=head1 CAUTIONS
The B<pts sleep> command is only available if OpenAFS was compiled
with the SUPERGROUPS option, which is disabled by default.
This command is only available on Windows in OpenAFS version 1.5.23
and later when compiled with the SUPERGROUPS option.
Running bulk B<pts> commands may degrade the performance of the pts
server while they are run. In addition, server resource may not be
released immediately after commands are run. Because of this, the
B<pts sleep> command can be used in interactive mode to give the
B<ptserver> a change to catch up.
=head1 OPTIONS
B<pts sleep> takes the following options:
=over 4
=item B<-cell> <I<cell name>>
Specifies an alternate cell to talk to.
=item B<-delay> <I<# of seconds>>
Specifies the number of seconds to pause.
=item B<-force>
Continue the operation even if there are errors. This is useful for
bulk operations where you would like to continue even if one of the
many operations fails.
=item B<-noauth>
Perform the action as the unauthenticated user instead of using the
current users credentials.
=back
=head1 OUTPUT
This command has no output.
=head1 EXAMPLES
Here is an example of a B<pts interactive> session:
% pts interactive
pts> sleep 5
pts> quit
%
=head1 SEE ALSO
L<pts(1)>,
L<pts_interactive(1)>,
L<pts_quit(1)>,
L<pts_source(1)>
=head1 COPYRIGHT
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
This documentation is covered by the IBM Public License Version 1.0. This
man page was written by Jason Edgecombe for OpenAFS.
--------------000908050303020607050703--