DEVEL15-man-page-pts-pullup-20070817
[openafs.git] / doc / man-pages / pod1 / pts_sleep.pod
1 =head1 NAME
2
3 pts sleep - Pauses for a few seconds
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts sleep> S<<< [B<-delay>] <I<# of seconds>> >>>
11    S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-force>]
12
13 B<pts sl> S<<< [B<-d>] <I<# of seconds>> >>> 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 sleep> pauses for a specified number of seconds. The command can
22 be run from the command line or interactively, although from the command
23 line it's essentially equivalent to the B<sleep> command. It is intended
24 for use in interactive mode to pause for a few seconds between batch
25 commands to allow the Protection Server to catch up.
26
27 =head1 CAUTIONS
28
29 Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts sleep> command was
30 only available on Unix or Linux and when OpenAFS was compiled with the
31 supergroups option (disabled by default).  As of OpenAFS 1.4.5 and 1.5.23,
32 it is always available.
33
34 =head1 OPTIONS
35
36 Although they have no effect, B<pts quit> takes the following standard
37 B<pts> options:
38
39 =over 4
40
41 =item B<-cell> <I<cell name>>
42
43 Names the cell in which to run the command. For more details, see
44 L<pts(1)>.
45
46 =item B<-force>
47
48 Enables the command to continue executing as far as possible when errors
49 or other problems occur, rather than halting execution at the first error.
50
51 =item B<-noauth>
52
53 Assigns the unprivileged identity anonymous to the issuer. For more
54 details, see L<pts(1)>.
55
56 =back
57
58 =head1 OUTPUT
59
60 This command produces no output.
61
62 =head1 EXAMPLES
63
64 Here is an example of a B<pts interactive> session:
65
66    % pts interactive
67    pts> sleep 5
68    pts> quit
69    %
70
71 =head1 SEE ALSO
72
73 L<pts(1)>,
74 L<pts_interactive(1)>
75
76 =head1 COPYRIGHT
77
78 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
79
80 This documentation is covered by the IBM Public License Version 1.0. This
81 man page was written by Jason Edgecombe for OpenAFS.