summaryrefslogtreecommitdiffstats
path: root/share/man/man9/sleep.9
diff options
context:
space:
mode:
authorhmp <hmp@FreeBSD.org>2003-05-31 14:07:25 +0000
committerhmp <hmp@FreeBSD.org>2003-05-31 14:07:25 +0000
commit5d71788a056bfdb2b7446be7e42b64371485657f (patch)
tree699677a7aafb30afb978e6dbdfaeb7e00df0b977 /share/man/man9/sleep.9
parentf2f79e8c3fd78874b7ac71ce17f19bb9f33d3061 (diff)
downloadFreeBSD-src-5d71788a056bfdb2b7446be7e42b64371485657f.zip
FreeBSD-src-5d71788a056bfdb2b7446be7e42b64371485657f.tar.gz
Some mdoc(7) fixes:
Nuke incorrect usage of .Ar; replace it with .Vt, .Va or .Fa appropriately. The .Ar mdoc(7) specifier should only be used when displaying command line arguments. Approved by: des (mentor)
Diffstat (limited to 'share/man/man9/sleep.9')
-rw-r--r--share/man/man9/sleep.920
1 files changed, 10 insertions, 10 deletions
diff --git a/share/man/man9/sleep.9 b/share/man/man9/sleep.9
index 272642f..f3b5f6c 100644
--- a/share/man/man9/sleep.9
+++ b/share/man/man9/sleep.9
@@ -56,17 +56,17 @@ If a process must wait for an
external event, it is put on sleep by
.Fn tsleep .
The parameter
-.Ar ident
+.Fa ident
is an arbitrary address that uniquely identifies the event on which
the process is being asleep. All processes sleeping on a single
-.Ar ident
+.Fa ident
are woken up later by
.Fn wakeup ,
often called from inside an interrupt routine, to indicate that the
resource the process was blocking on is available now.
.Pp
The parameter
-.Ar wmesg
+.Fa wmesg
is a string describing the sleep condition for tools like
.Xr ps 1 .
Due to the limited space of those programs to display arbitrary strings,
@@ -89,12 +89,12 @@ Suspends the current process until a wakeup is
performed on the specified identifier.
The process will then be made
runnable with the specified
-.Ar priority .
+.Fa priority .
Sleeps at most
-.Ar timo
+.Fa timo
\&/ hz seconds (0 means no timeout).
If
-.Ar pri
+.Fa pri
includes the
.Dv PCATCH
flag, signals are checked before and after sleeping, else signals are
@@ -116,16 +116,16 @@ The
.Fn msleep
function is a variation on tsleep.
The parameter
-.Ar mtx
+.Fa mtx
is a mutex which will be released before sleeping and reacquired before
.Fn msleep
returns.
If
-.Ar pri
+.Fa pri
includes the
.Dv PDROP
flag, the
-.Ar mtx
+.Fa mtx
parameter will not be reacquired before returning.
The mutex is
used to ensure that a condition can be checked atomically, and
@@ -152,7 +152,7 @@ The
.Fn sleep
function used to be the traditional form.
It did not let you specify a timeout or a
-.Ar wmesg ,
+.Fa wmesg ,
hence it was discontinued.
.Sh AUTHORS
.An -nosplit
OpenPOWER on IntegriCloud