8158 Want named threads API
9857 proc manpages should have LIBRARY section

          --- old/usr/src/man/man3proc/Pcreate_agent.3proc
          +++ new/usr/src/man/man3proc/Pcreate_agent.3proc

   1    1  .\"
   2    2  .\" This file and its contents are supplied under the terms of the
   3    3  .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4    4  .\" You may only use this file in accordance with the terms of version
   5    5  .\" 1.0 of the CDDL.
   6    6  .\"
   7    7  .\" A full copy of the text of the CDDL should have accompanied this
   8    8  .\" source.  A copy of the CDDL is also available via the Internet at
   9    9  .\" http://www.illumos.org/license/CDDL.

  10   10  .\"
  11   11  .\"
  12   12  .\" Copyright 2015 Joyent, Inc.
  13   13  .\"
  14   14  .Dd May 11, 2016
  15   15  .Dt PCREATE_AGENT 3PROC
  16   16  .Os
  17   17  .Sh NAME
  18   18  .Nm Pcreate_agent
  19   19  .Nd create the agent LWP
  20      -.Sh SYNOPSIS
       20 +.Sh LIBRARY
  21   21  .Lb libproc
       22 +.Sh SYNOPSIS
  22   23  .In libproc.h
  23   24  .Ft int
  24   25  .Fo Pcreate_agent
  25   26  .Fa "struct ps_prochandle *P"
  26   27  .Fc
  27   28  .Sh DESCRIPTION
  28   29  The
  29   30  .Fn Pcreate_agent
  30   31  function creates the agent LWP in the process represented by the handle
  31   32  .Fa P .

  32   33  The agent LWP is used as a means to force system calls to be invoked on
  33   34  the controlled process.
  34   35  For more information on the agent LWP, see
  35   36  .Xr proc 4 .
  36   37  .Pp
  37   38  The agent LWP cannot be created for process handles corresponding to
  38   39  core files, zombie processes, processes that have yet to run, and ELF
  39   40  objects.
  40   41  .Pp
  41   42  The
  42   43  .Fn Pcreate_agent
  43   44  function is reentrant.
  44   45  It may be entered recursively.
  45   46  The act of creating the agent LWP will cause the process to be stopped.
  46   47  For every call to the
  47   48  .Fn Pcreate_agent
  48   49  function, a corresponding call to
  49   50  .Xr Pdestroy_agent 3PROC
  50   51  is required.
  51   52  .Sh RETURN VALUES
  52   53  Upon successful completion, the
  53   54  .Fn Pcreate_agent
  54   55  function returns
  55   56  .Sy 0
  56   57  and creates the agent LWP.
  57   58  Otherwise,
  58   59  .Sy -1
  59   60  is returned,
  60   61  .Sy errno
  61   62  is set to indicate the error, and the agent LWP is not created.
  62   63  .Sh ERRORS
  63   64  The
  64   65  .Fn Pcreate_agent
  65   66  function will fail if:
  66   67  .Bl -tag -width Er
  67   68  .It Er ENOENT
  68   69  The process referred to by
  69   70  .Fa P
  70   71  is a core file, zombie, ELF object, or has not begun execution.
  71   72  .El
  72   73  .Pp
  73   74  Note, it is possible for other error numbers to be returned.
  74   75  If they are, they represent unanticipated failure.
  75   76  .Sh INTERFACE STABILITY
  76   77  .Sy Uncommitted
  77   78  .Sh MT-LEVEL
  78   79  See
  79   80  .Sy LOCKING
  80   81  in
  81   82  .Xr libproc 3LIB .
  82   83  .Sh SEE ALSO
  83   84  .Xr libproc 3LIB ,
  84   85  .Xr Pdestroy_agent 3PROC ,
  85   86  .Xr proc 4

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX