8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3proc / proc_fltset2str.3proc
blob96c40eeab21a25671f6e502071106c686e58c1f6
1 .\"
2 .\" This file and its contents are supplied under the terms of the
3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 .\" You may only use this file in accordance with the terms of version
5 .\" 1.0 of the CDDL.
6 .\"
7 .\" A full copy of the text of the CDDL should have accompanied this
8 .\" source.  A copy of the CDDL is also available via the Internet at
9 .\" http://www.illumos.org/license/CDDL.
10 .\"
11 .\"
12 .\" Copyright 2015 Joyent, Inc.
13 .\"
14 .Dd May 11, 2016
15 .Dt PROC_FLTSET2STR 3PROC
16 .Os
17 .Sh NAME
18 .Nm proc_fltset2str ,
19 .Nm proc_sigset2str ,
20 .Nm proc_sysset2str
21 .Nd convert a fault, signal, or system call set to a string
22 .Sh SYNOPSIS
23 .Lb libproc
24 .In libproc.h
25 .Ft "char *"
26 .Fo proc_fltset2str
27 .Fa "const fltset_t *set"
28 .Fa "const char *delim"
29 .Fa "int members"
30 .Fa "char *buf"
31 .Fa "size_t buflen"
32 .Fc
33 .Ft "char *"
34 .Fo proc_sigset2str
35 .Fa "const sigset_t *set"
36 .Fa "const char *delim"
37 .Fa "int members"
38 .Fa "char *buf"
39 .Fa "size_t buflen"
40 .Fc
41 .Ft "char *"
42 .Fo proc_sysset2str
43 .Fa "const sysset_t *set"
44 .Fa "const char *delim"
45 .Fa "int members"
46 .Fa "char *buf"
47 .Fa "size_t buflen"
48 .Fc
49 .Sh DESCRIPTION
50 The
51 .Fn proc_fltset2str ,
52 .Fn proc_sigset2str ,
53 and
54 .Fn proc_sysset2str
55 functions respectively convert the fault, signal, and system call sets in
56 .Fa fltset ,
57 .Fa sigset ,
58 and
59 .Fa sysset
60 to a human-readable name and place the corresponding string in
61 .Fa buf .
62 .Pp
63 Up to
64 .Fa buflen
65 characters will be placed in
66 .Fa buf ,
67 including the null terminator.
69 .Fa buf
70 is not large enough to hold the entire string, then an error
71 will be returned.
72 .Pp
73 The
74 .Fa members
75 argument controls which members of the set are written out.
77 .Fa members
79 .Sy 1 ,
80 then the sets member are placed in
81 .Fa buf .
83 .Fa members
85 .Sy 0 ,
86 then the members which are not in the set are placed in
87 .Fa buf .
88 .Pp
89 The string
90 .Fa delim
91 will be placed in-between every member of the set.
92 It will not come after the last entry in the set.
93 .Sh RETURN VALUES
94 Upon successful completion, the
95 .Fn proc_fltset2str ,
96 .Fn proc_sigset2str ,
97 and
98 .Fn proc_sysset2str
99 functions return
100 .Fa buf .
101 Otherwise,
102 .Dv NULL
103 is returned.
104 .Sh INTERFACE STABILITY
105 .Sy Uncommitted
106 .Sh MT-LEVEL
107 .Sy MT-Safe
108 .Sh SEE ALSO
109 .Xr libproc 3LIB ,
110 .Xr proc_fltname 3PROC ,
111 .Xr proc_signame 3PROC ,
112 .Xr proc_str2flt 3PROC ,
113 .Xr proc_str2fltset 3PROC ,
114 .Xr proc_str2sig 3PROC ,
115 .Xr proc_str2sigset 3PROC ,
116 .Xr proc_str2sys 3PROC ,
117 .Xr proc_str2sysset 3PROC ,
118 .Xr proc_sysname 3PROC ,
119 .Xr proc 4