openafs/doc/man-pages/pod1/pts_source.pod.in
Andrew Deason f69bf0b194 doc: pts manpage fixes
- 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>
2013-11-03 20:36:16 -08:00

79 lines
1.9 KiB
Plaintext

=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<-localauth>] [B<-force>] [B<-auth>] [B<-encrypt>] [B<-help>]
S<<< [B<-config> <I<config directory>>] >>>
B<pts so> S<<< [B<-f>] <I<file name>> >>> S<<< [B<-c>] <I<cell name>> >>>
[B<-n>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
=for html
</div>
=head1 DESCRIPTION
The B<pts source> runs commands from a file as if they were typed in B<pts
interactive> mode. The command can be run from the command line or
interactively.
=head1 CAUTIONS
Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts source> 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.
=head1 OPTIONS
B<pts source> takes the following options:
=over 4
=item B<-file> <I<file name>>
Specifies the file name to read commands from. The commands in the given file
are run as if they were typed in pts interactive mode.
=include fragments/pts-common.pod
=back
=head1 OUTPUT
This command shows the output of each command 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 BSD License as written in the
doc/LICENSE file. This man page was written by Jason Edgecombe for
OpenAFS.