xref: /freebsd/lib/libsysdecode/sysdecode_cap_rights.3 (revision 869199d9922c7dee92c1c24f95b90f1d1319433e)
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 sys/types.h
37.In stdbool.h
38.In stdio.h
39.In sysdecode.h
40.Ft void
41.Fn sysdecode_cap_rights "FILE *fp" "cap_rights_t *rightsp"
42.Sh DESCRIPTION
43The
44.Fn sysdecode_cap_rights
45function outputs a comma-separated list of capability rights at
46.Fa rightsp
47to the stream
48.Fa fp .
49.Pp
50Note that some capability rights are supersets of others; for example,
51.Dv CAP_PREAD
52is the union of
53.Dv CAP_READ
54and
55.Dv CAP_SEEK .
56.Fn sysdecode_cap_rights
57emits a minimal list of rights whose union is equal to
58.Fa *rightsp .
59For example, if both
60.Dv CAP_READ
61and
62.Dv CAP_SEEK
63are set in
64.Fa *rightsp ,
65then
66.Fn sysdecode_cap_rights
67will include only
68.Dv CAP_PREAD
69in the output list.
70.Sh SEE ALSO
71.Xr sysdecode 3
72