Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / pts_sleep.pod.in
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<-localauth>] [B<-force>]
12 [B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
13
14 B<pts sl> S<<< [B<-d>] <I<# of seconds>> >>> S<<< [B<-c>] <I<cell name>> >>>
15 [B<-n>] [B<-l>] [B<-f>] [B<-h>]
16 [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
17
18 =for html
19 </div>
20
21 =head1 DESCRIPTION
22
23 The B<pts sleep> pauses for a specified number of seconds. The command can
24 be run from the command line or interactively, although from the command
25 line it's essentially equivalent to the B<sleep> command. It is intended
26 for use in interactive mode to pause for a few seconds between batch
27 commands to allow the Protection Server to catch up.
28
29 =head1 CAUTIONS
30
31 Prior to OpenAFS 1.4.5 and OpenAFS 1.5.23, the B<pts sleep> command was
32 only available on Unix or Linux and when OpenAFS was compiled with the
33 supergroups option (disabled by default). As of OpenAFS 1.4.5 and 1.5.23,
34 it is always available.
35
36 =head1 OPTIONS
37
38 Although they have no effect, B<pts sleep> takes the following standard
39 B<pts> options:
40
41 =over 4
42
43 =item B<-delay> <I<# of seconds>>
44
45 Specifies the amount of time to sleep, in seconds.
46
47 =include fragments/pts-common.pod
48
49 =back
50
51 =head1 OUTPUT
52
53 This command produces no output.
54
55 =head1 EXAMPLES
56
57 Here is an example of a B<pts interactive> session:
58
59 % pts interactive
60 pts> sleep 5
61 pts> quit
62 %
63
64 =head1 SEE ALSO
65
66 L<pts(1)>,
67 L<pts_interactive(1)>
68
69 =head1 COPYRIGHT
70
71 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
72
73 This documentation is covered by the BSD License as written in the
74 doc/LICENSE file. This man page was written by Jason Edgecombe for
75 OpenAFS.