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

          --- old/usr/src/man/man3proc/Penv_iter.3proc
          +++ new/usr/src/man/man3proc/Penv_iter.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 March 2, 2017
  15   15  .Dt PENV_ITER 3PROC
  16   16  .Os
  17   17  .Sh NAME
  18   18  .Nm Penv_iter
  19   19  .Nd iterate process environment
  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 Penv_iter
  25   26  .Fa "struct ps_prochandle *P"
  26   27  .Fa "proc_env_f *func"
  27   28  .Fa "void *data"
  28   29  .Fc
  29   30  .Sh DESCRIPTION
  30   31  The
  31   32  .Fn Penv_iter

  32   33  function iterates over the environment of the process represented by
  33   34  .Fa P .
  34   35  For each environment variable,
  35   36  .Fa func
  36   37  is passed the caller argument
  37   38  .Fa data
  38   39  along with the address of the environment variable and the key-value pair.
  39   40  For the full signature of the
  40   41  .Ft proc_env_f
  41   42  callback, see
  42   43  .Xr libproc 3LIB .
  43   44  .Pp
  44   45  The callback's return value controls whether or not iteration proceeds.
  45   46  If
  46   47  .Fa func
  47   48  returns zero, then iteration continues.
  48   49  Otherwise, iteration is terminated and the value is returned.
  49   50  It is recommended that callback functions do not return
  50   51  .Sy -1
  51   52  so as to distinguish between the failure of the
  52   53  .Fn Penv_iter
  53   54  function and the callback function.
  54   55  .Sh RETURN VALUES
  55   56  Upon successful completion, the
  56   57  .Fn Penv_iter
  57   58  function returns
  58   59  .Sy 0 .
  59   60  Otherwise, if there was an internal error, for example due to a
  60   61  corrupted environment, then
  61   62  .Sy -1
  62   63  is returned.
  63   64  Otherwise, if the callback function
  64   65  .Fa func
  65   66  returns non-zero, then its return value will be returned instead.
  66   67  .Sh INTERFACE STABILITY
  67   68  .Sy Uncommitted
  68   69  .Sh MT-LEVEL
  69   70  See
  70   71  .Sy LOCKING
  71   72  in
  72   73  .Xr libproc 3LIB .
  73   74  .Sh SEE ALSO
  74   75  .Xr libproc 3LIB

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX