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