doc: quote list items in POD
[openafs.git] / doc / man-pages / pod1 / pts_source.pod.in
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<-localauth>] [B<-force>]
12
13 B<pts so> S<<< [B<-f>] <I<file name>> >>> S<<< [B<-c>] <I<cell name>> >>>
14    [B<-n>] [B<-l>] [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 =include fragments/pts-common.pod
39
40 =back
41
42 =head1 OUTPUT
43
44 This command shows the output of each command in the file as if it were
45 run normally.
46
47 =head1 EXAMPLES
48
49 Here is an example of using B<pts source> in a B<pts interactive> session:
50
51    % echo examine admin > /tmp/commands.txt 
52    % pts interactive
53    pts> source /tmp/commands.txt
54    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
55      membership: 2, flags: S----, group quota: 20.
56    pts> quit
57    %
58
59 =head1 SEE ALSO
60
61 L<pts(1)>,
62 L<pts_interactive(1)>,
63 L<pts_quit(1)>,
64 L<pts_sleep(1)>
65
66 =head1 COPYRIGHT
67
68 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
69
70 This documentation is covered by the BSD License as written in the
71 doc/LICENSE file. This man page was written by Jason Edgecombe for
72 OpenAFS.