man-page-license-change-20071225
[openafs.git] / doc / man-pages / pod1 / pts_source.pod
1 =head1 NAME
2
3 pts_source - Read pts commands from a file
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts source> S<<< [B<-file>] <I<file name>> >>> S<<< [B<-cell>] <I<cell name>> >>>
11    [B<-noauth>] [B<-force>]
12
13 B<pts so> S<<< [B<-f>] <I<file name>> >>> S<<< [B<-c>] <I<cell name>> >>>
14    [B<-n>] [B<-f>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<pts source> runs commands from a file as if they were typed in B<pts
22 interactive> mode. The command can be run from the command line or
23 interactively.
24
25 =head1 CAUTIONS
26
27 Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts source> command was
28 only available on Unix or Linux and when OpenAFS was compiled with the
29 supergroups option (disabled by default).  As of OpenAFS 1.4.5 and 1.5.23,
30 it is always available.
31
32 =head1 OPTIONS
33
34 B<pts source> takes the following options:
35
36 =over 4
37
38 =item B<-cell> <I<cell name>>
39
40 Names the cell in which to run the command. For more details, see
41 L<pts(1)>.
42
43 =item B<-file> <I<file name>>
44
45 Specifies the filename from which to read commands.
46
47 =item B<-force>
48
49 Enables the command to continue executing as far as possible when errors
50 or other problems occur, rather than halting execution at the first error.
51 This is useful for bulk operations where you would like to continue even
52 if one of many operations fails.
53
54 =item B<-noauth>
55
56 Assigns the unprivileged identity anonymous to the issuer. For more
57 details, see L<pts(1)>.
58
59 =back
60
61 =head1 OUTPUT
62
63 This command shows the output of each comand in the file as if it were
64 run normally.
65
66 =head1 EXAMPLES
67
68 Here is an example of using B<pts source> in a B<pts interactive> session:
69
70    % echo examine admin > /tmp/commands.txt 
71    % pts interactive
72    pts> source /tmp/commands.txt
73    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
74      membership: 2, flags: S----, group quota: 20.
75    pts> quit
76    %
77
78 =head1 SEE ALSO
79
80 L<pts(1)>,
81 L<pts_interactive(1)>,
82 L<pts_quit(1)>,
83 L<pts_sleep(1)>
84
85 =head1 COPYRIGHT
86
87 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
88
89 This documentation is covered by the BSD License as written in the
90 doc/LICENSE file. This man page was written by Jason Edgecombe for
91 OpenAFS.