Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / pts_source.pod.in
CommitLineData
805e021f
CE
1=head1 NAME
2
3pts_source - Read pts commands from a file
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<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>>] >>>
13
14B<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>>] >>>
16
17=for html
18</div>
19
20=head1 DESCRIPTION
21
22The B<pts source> runs commands from a file as if they were typed in B<pts
23interactive> mode. The command can be run from the command line or
24interactively.
25
26=head1 CAUTIONS
27
28Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts source> command was
29only available on Unix or Linux and when OpenAFS was compiled with the
30supergroups option (disabled by default). As of OpenAFS 1.4.5 and 1.5.23,
31it is always available.
32
33=head1 OPTIONS
34
35B<pts source> takes the following options:
36
37=over 4
38
39=item B<-file> <I<file name>>
40
41Specifies the file name to read commands from. The commands in the given file
42are run as if they were typed in pts interactive mode.
43
44=include fragments/pts-common.pod
45
46=back
47
48=head1 OUTPUT
49
50This command shows the output of each command in the file as if it were
51run normally.
52
53=head1 EXAMPLES
54
55Here is an example of using B<pts source> in a B<pts interactive> session:
56
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 %
64
65=head1 SEE ALSO
66
67L<pts(1)>,
68L<pts_interactive(1)>,
69L<pts_quit(1)>,
70L<pts_sleep(1)>
71
72=head1 COPYRIGHT
73
74Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
75
76This documentation is covered by the BSD License as written in the
77doc/LICENSE file. This man page was written by Jason Edgecombe for
78OpenAFS.