man-page-updates-20070817
[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<-force>
44
45 Enables the command to continue executing as far as possible when errors
46 or other problems occur, rather than halting execution at the first error.
47 This is useful for bulk operations where you would like to continue even
48 if one of many operations fails.
49
50 =item B<-noauth>
51
52 Assigns the unprivileged identity anonymous to the issuer. For more
53 details, see L<pts(1)>.
54
55 =back
56
57 =head1 OUTPUT
58
59 This command shows the output of each comand in the file as if it were
60 run normally.
61
62 =head1 EXAMPLES
63
64 Here is an example of using B<pts source> in a B<pts interactive> session:
65
66    % echo examine admin > /tmp/commands.txt 
67    % pts interactive
68    pts> source /tmp/commands.txt
69    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
70      membership: 2, flags: S----, group quota: 20.
71    pts> quit
72    %
73
74 =head1 SEE ALSO
75
76 L<pts(1)>,
77 L<pts_interactive(1)>,
78 L<pts_quit(1)>,
79 L<pts_sleep(1)>
80
81 =head1 COPYRIGHT
82
83 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
84
85 This documentation is covered by the IBM Public License Version 1.0. This
86 man page was written by Jason Edgecombe for OpenAFS.