Print this page
8158 Want named threads API
9857 proc manpages should have LIBRARY section
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man3proc/Pplatform.3proc
+++ new/usr/src/man/man3proc/Pplatform.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.
↓ open down ↓ |
9 lines elided |
↑ open up ↑ |
10 10 .\"
11 11 .\"
12 12 .\" Copyright 2015 Joyent, Inc.
13 13 .\"
14 14 .Dd May 11, 2016
15 15 .Dt PPLATFORM 3PROC
16 16 .Os
17 17 .Sh NAME
18 18 .Nm Pplatform
19 19 .Nd get platform string
20 -.Sh SYNOPSIS
20 +.Sh LIBRARY
21 21 .Lb libproc
22 +.Sh SYNOPSIS
22 23 .In libproc.h
23 24 .Ft "char *"
24 25 .Fo Pplatform
25 26 .Fa "struct ps_prochandle *P"
26 27 .Fa "char *buffer"
27 28 .Fa "size_t bufsize"
28 29 .Fc
29 30 .Sh DESCRIPTION
30 31 The
31 32 .Fn Pplatform
32 33 function determines the name of the platform for the process handle
33 34 .Fa P .
34 35 Up to
35 36 .Fa bufsize
36 37 characters, including the null terminator, will be copied into
37 38 .Fa buffer .
38 39 .Pp
39 40 The platform is the value reported by the
40 41 .Sy -s
41 42 option to
42 43 .Xr uname 1 .
43 44 For example, on x86 systems, the value will be
44 45 .Sy i86pc .
45 46 .Pp
46 47 Note, process handles that correspond to a file, created by
47 48 .Xr Pgrab_file 3PROC ,
48 49 will not report a platform and the
49 50 .Fn Pplatform
50 51 function will fail.
51 52 .Sh RETURN VALUES
52 53 Upon successful completion, the
53 54 .Fn Pplatform
54 55 function returns
55 56 .Fa buffer .
56 57 Otherwise,
57 58 .Dv NULL
58 59 is returned,
59 60 .Sy errno
60 61 is set, and
61 62 .Fa buffer
62 63 is not updated.
63 64 .Sh ERRORS
64 65 The
65 66 .Fn Pplatform
66 67 function will fail if:
67 68 .Bl -tag -width Er
68 69 .It Er ENODATA
69 70 .Fa P
70 71 refers to a core file and there is no
71 72 .Sy NT_PLATFORM
72 73 ELF note available.
73 74 .It Er EFAULT
74 75 .Fa P
75 76 refers to a live process and
76 77 .Fa buffer
77 78 is an invalid address.
78 79 .El
79 80 .Sh INTERFACE STABILITY
80 81 .Sy Uncommitted
81 82 .Sh MT-LEVEL
82 83 See
83 84 .Sy LOCKING
84 85 in
85 86 .Xr libproc 3LIB .
86 87 .Sh SEE ALSO
87 88 .Xr uname 1 ,
88 89 .Xr sysinfo 2 ,
89 90 .Xr libproc 3LIB ,
90 91 .Xr proc 4
↓ open down ↓ |
59 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX