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<-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 =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 =item B<-localauth>
  60
  61 Constructs a server ticket using a key from the local
  62 F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
  63 B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
  64
  65 =back
  66
  67 =head1 OUTPUT
  68
  69 This command shows the output of each command in the file as if it were
  70 run normally.
  71
  72 =head1 EXAMPLES
  73
  74 Here is an example of using B<pts source> in a B<pts interactive> session:
  75
  76    % echo examine admin > /tmp/commands.txt
  77    % pts interactive
  78    pts> source /tmp/commands.txt
  79    Name: admin, id: 1, owner: system:administrators, creator: anonymous,
  80      membership: 2, flags: S----, group quota: 20.
  81    pts> quit
  82    %
  83
  84 =head1 SEE ALSO
  85
  86 L<pts(1)>,
  87 L<pts_interactive(1)>,
  88 L<pts_quit(1)>,
  89 L<pts_sleep(1)>
  90
  91 =head1 COPYRIGHT
  92
  93 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
  94
  95 This documentation is covered by the BSD License as written in the
  96 doc/LICENSE file. This man page was written by Jason Edgecombe for
  97 OpenAFS.