summaryrefslogtreecommitdiff
path: root/usr/src/man/man3proc/Pstopstatus.3proc
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man3proc/Pstopstatus.3proc')
-rw-r--r--usr/src/man/man3proc/Pstopstatus.3proc39
1 files changed, 23 insertions, 16 deletions
diff --git a/usr/src/man/man3proc/Pstopstatus.3proc b/usr/src/man/man3proc/Pstopstatus.3proc
index 12eeb3366f..8ce88fb7a4 100644
--- a/usr/src/man/man3proc/Pstopstatus.3proc
+++ b/usr/src/man/man3proc/Pstopstatus.3proc
@@ -19,7 +19,7 @@
.Nm Pstopstatus ,
.Nm Pstop ,
.Nm Pwait ,
-.Nm Ldstop
+.Nm Ldstop ,
.Nm Lstop ,
.Nm Lwait
.Nd process and thread stop operations
@@ -62,9 +62,10 @@ The
function allows the caller to stop and optionally wait for the process
handle referred to by
.Fa P
-to be stopped. Stopping a process causes all of its threads to stop
-execution. Where in their execution the threads will halt is not
-defined. Threads may be resumed with
+to be stopped.
+Stopping a process causes all of its threads to stop execution.
+Where in their execution the threads will halt is not defined.
+Threads may be resumed with
.Xr Psetrun 3PROC
and
.Xr prun 1 .
@@ -76,8 +77,8 @@ argument should be one of the following symbols:
.It Dv PCSTOP
Stop the process; wait for completion before returning.
.It Dv PCDSTOP
-Stop the process; do not wait for completion before returning. That
-is, the stopping of the process is performed asynchronously in
+Stop the process; do not wait for completion before returning.
+That is, the stopping of the process is performed asynchronously in
relation to the caller.
.It Dv PCWSTOP
Do not direct the process to stop; simply wait for it to stop.
@@ -91,14 +92,17 @@ Both the
and
.Dv PCWSTOP
requests allow an upper bound on the amount of time to wait for the
-process to stop. The
+process to stop.
+The
.Fa msec
argument indicates the number of milliseconds to wait for the stop to
-complete. If the value of
+complete.
+If the value of
.Fa msec
is
.Sy 0 ,
-then it will wait forever. Callers should pass
+then it will wait forever.
+Callers should pass
.Sy 0
for
.Fa msec
@@ -108,15 +112,17 @@ or
.Dv PCNULL .
.Pp
When a non-zero timeout is specified, the process may or may not be
-stopped upon return. The return value does not reflect the current
-state of the process. For example, if the timeout expires during a
+stopped upon return.
+The return value does not reflect the current state of the process.
+For example, if the timeout expires during a
.Fa PCWSTOP
request, the return value will be
.Sy 0
regardless of the actual state of the process.
.Pp
-Only active processes may be stopped. Handles that refer to core
-files, zombie processes, or files cannot be used; unless the value of
+Only active processes may be stopped.
+Handles that refer to core files, zombie processes, or files cannot be used;
+unless the value of
.Fa request
is set to
.Dv PCNULL .
@@ -154,8 +160,8 @@ functions are equivalent to the
.Fn Pstop ,
and
.Fn Pwait
-functions, respectively. Except, rather than operating on a process,
-they operate on the thread handle
+functions, respectively.
+Except, rather than operating on a process, they operate on the thread handle
.Fa L .
A call to
.Fn Lstop
@@ -199,7 +205,8 @@ functions will fail if:
.It Er EAGAIN
Control over the handle
.Fa P
-was lost. Callers should call
+was lost.
+Callers should call
.Xr Preopen 3PROC .
For more information on losing control, see
.Sy PROGRAMMING NOTES