xref: /freebsd/lib/libsysdecode/sysdecode_cap_rights.3 (revision 19fae0f66023a97a9b464b3beeeabb2081f575b3)
1.\"
2.\" Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd April 11, 2022
28.Dt sysdecode_cap_rights 3
29.Os
30.Sh NAME
31.Nm sysdecode_cap_rights
32.Nd output list of capability rights
33.Sh LIBRARY
34.Lb libsysdecode
35.Sh SYNOPSIS
36.In sysdecode.h
37.Ft void
38.Fn sysdecode_cap_rights "FILE *fp" "cap_rights_t *rightsp"
39.Sh DESCRIPTION
40The
41.Fn sysdecode_cap_rights
42function outputs a comma-separated list of capability rights at
43.Fa rightsp
44to the stream
45.Fa fp .
46.Pp
47Note that some capability rights are supersets of others; for example,
48.Dv CAP_PREAD
49is the union of
50.Dv CAP_READ
51and
52.Dv CAP_SEEK .
53.Fn sysdecode_cap_rights
54emits a minimal list of rights whose union is equal to
55.Fa *rightsp .
56For example, if both
57.Dv CAP_READ
58and
59.Dv CAP_SEEK
60are set in
61.Fa *rightsp ,
62then
63.Fn sysdecode_cap_rights
64will include only
65.Dv CAP_PREAD
66in the output list.
67.Sh SEE ALSO
68.Xr sysdecode 3
69