Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod1 / pts_source.pod.in
blob24da00dd75f805e99a2a89301d29e76ee41fb9a9
1 =head1 NAME
3 pts_source - Read pts commands from a file
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<pts source> S<<< [B<-file>] <I<file name>> >>> S<<< [B<-cell>] <I<cell name>> >>>
11    [B<-noauth>] [B<-localauth>] [B<-force>] [B<-auth>] [B<-encrypt>] [B<-help>]
12    S<<< [B<-config> <I<config directory>>] >>>
14 B<pts so> S<<< [B<-f>] <I<file name>> >>> S<<< [B<-c>] <I<cell name>> >>>
15    [B<-n>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
17 =for html
18 </div>
20 =head1 DESCRIPTION
22 The B<pts source> runs commands from a file as if they were typed in B<pts
23 interactive> mode. The command can be run from the command line or
24 interactively.
26 =head1 CAUTIONS
28 Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts source> command was
29 only available on Unix or Linux and when OpenAFS was compiled with the
30 supergroups option (disabled by default).  As of OpenAFS 1.4.5 and 1.5.23,
31 it is always available.
33 =head1 OPTIONS
35 B<pts source> takes the following options:
37 =over 4
39 =item B<-file> <I<file name>>
41 Specifies the file name to read commands from. The commands in the given file
42 are run as if they were typed in pts interactive mode.
44 =include fragments/pts-common.pod
46 =back
48 =head1 OUTPUT
50 This command shows the output of each command in the file as if it were
51 run normally.
53 =head1 EXAMPLES
55 Here is an example of using B<pts source> in a B<pts interactive> session:
57    % echo examine admin > /tmp/commands.txt 
58    % pts interactive
59    pts> source /tmp/commands.txt
60    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
61      membership: 2, flags: S----, group quota: 20.
62    pts> quit
63    %
65 =head1 SEE ALSO
67 L<pts(1)>,
68 L<pts_interactive(1)>,
69 L<pts_quit(1)>,
70 L<pts_sleep(1)>
72 =head1 COPYRIGHT
74 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
76 This documentation is covered by the BSD License as written in the
77 doc/LICENSE file. This man page was written by Jason Edgecombe for
78 OpenAFS.