xref: /freebsd/lib/libsysdecode/sysdecode.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\"
2.\" Copyright (c) 2015 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.Dd September 22, 2021
26.Dt SYSDECODE 3
27.Os
28.Sh NAME
29.Nm sysdecode
30.Nd system argument decoding library
31.Sh LIBRARY
32.Lb libsysdecode
33.Sh SYNOPSIS
34.In sysdecode.h
35.Sh DESCRIPTION
36The
37.Nm
38library includes several functions that provide descriptive names of
39values associated with system calls.
40.Ss Supported ABIs
41Some functions in this library provide ABI-specific descriptions.
42The supported ABIs are named by the
43.Vt enum sysdecode_abi
44enumeration.
45.Pp
46.Bl -tag -width "Li SYSDECODE_ABI_FREEBSD32" -compact
47.It Li SYSDECODE_ABI_FREEBSD
48Native FreeBSD binaries.
49Supported on all platforms.
50.It Li SYSDECODE_ABI_FREEBSD32
5132-bit FreeBSD binaries.
52Supported on aarch64, amd64 and powerpc64.
53.It Li SYSDECODE_ABI_LINUX
54Linux binaries of the same platform.
55Supported on amd64, i386, and aarch64.
56.It Li SYSDECODE_ABI_LINUX32
5732-bit Linux binaries.
58Supported on amd64.
59.It Li SYSDECODE_ABI_UNKNOWN
60A placeholder for use when the ABI is not known.
61.El
62.Sh SEE ALSO
63.Xr sysdecode_abi_to_freebsd_errno 3 ,
64.Xr sysdecode_cap_rights 3 ,
65.Xr sysdecode_cmsg_type 3 ,
66.Xr sysdecode_enum 3 ,
67.Xr sysdecode_fcntl_arg 3 ,
68.Xr sysdecode_ioctlname 3 ,
69.Xr sysdecode_kevent 3 ,
70.Xr sysdecode_mask 3 ,
71.Xr sysdecode_quotactl_cmd 3 ,
72.Xr sysdecode_sctp_sinfo_flags 3 ,
73.Xr sysdecode_sigcode 3 ,
74.Xr sysdecode_socket_protocol 3 ,
75.Xr sysdecode_sockopt_name 3 ,
76.Xr sysdecode_syscallnames 3 ,
77.Xr sysdecode_utrace 3
78.Sh HISTORY
79The
80.Nm
81library first appeared in
82.Fx 11.0 .
83