xref: /freebsd-13.1/lib/libsysdecode/sysdecode.3 (revision 2e43efd0)
1d6fb4894SJohn Baldwin.\"
2d6fb4894SJohn Baldwin.\" Copyright (c) 2015 John Baldwin <[email protected]>
3d6fb4894SJohn Baldwin.\"
4d6fb4894SJohn Baldwin.\" Redistribution and use in source and binary forms, with or without
5d6fb4894SJohn Baldwin.\" modification, are permitted provided that the following conditions
6d6fb4894SJohn Baldwin.\" are met:
7d6fb4894SJohn Baldwin.\" 1. Redistributions of source code must retain the above copyright
8d6fb4894SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer.
9d6fb4894SJohn Baldwin.\" 2. Redistributions in binary form must reproduce the above copyright
10d6fb4894SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer in the
11d6fb4894SJohn Baldwin.\"    documentation and/or other materials provided with the distribution.
12d6fb4894SJohn Baldwin.\"
13d6fb4894SJohn Baldwin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14d6fb4894SJohn Baldwin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15d6fb4894SJohn Baldwin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16d6fb4894SJohn Baldwin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17d6fb4894SJohn Baldwin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18d6fb4894SJohn Baldwin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19d6fb4894SJohn Baldwin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20d6fb4894SJohn Baldwin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21d6fb4894SJohn Baldwin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22d6fb4894SJohn Baldwin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23d6fb4894SJohn Baldwin.\" SUCH DAMAGE.
24d6fb4894SJohn Baldwin.\"
25d6fb4894SJohn Baldwin.\" $FreeBSD$
26d6fb4894SJohn Baldwin.\"
27*9a16bd16SEd Maste.Dd April 26, 2018
28d6fb4894SJohn Baldwin.Dt SYSDECODE 3
29d6fb4894SJohn Baldwin.Os
30d6fb4894SJohn Baldwin.Sh NAME
31d6fb4894SJohn Baldwin.Nm sysdecode
32d6fb4894SJohn Baldwin.Nd system argument decoding library
33d6fb4894SJohn Baldwin.Sh LIBRARY
34d6fb4894SJohn Baldwin.Lb libsysdecode
359289f547SJohn Baldwin.Sh SYNOPSIS
369289f547SJohn Baldwin.In sys/types.h
379289f547SJohn Baldwin.In stdbool.h
389289f547SJohn Baldwin.In sysdecode.h
39d6fb4894SJohn Baldwin.Sh DESCRIPTION
40d6fb4894SJohn BaldwinThe
41d6fb4894SJohn Baldwin.Nm
42d6fb4894SJohn Baldwinlibrary includes several functions that provide descriptive names of
43d6fb4894SJohn Baldwinvalues associated with system calls.
44a5f14abfSJohn Baldwin.Ss Supported ABIs
45a5f14abfSJohn BaldwinSome functions in this library provide ABI-specific descriptions.
46a5f14abfSJohn BaldwinThe supported ABIs are named by the
47a5f14abfSJohn Baldwin.Vt enum sysdecode_abi
48a5f14abfSJohn Baldwinenumeration.
49a5f14abfSJohn Baldwin.Pp
505842bd68SJohn Baldwin.Bl -tag -width "Li SYSDECODE_ABI_CLOUDABI64" -compact
515842bd68SJohn Baldwin.It Li SYSDECODE_ABI_FREEBSD
52a5f14abfSJohn BaldwinNative FreeBSD binaries.
53a5f14abfSJohn BaldwinSupported on all platforms.
545842bd68SJohn Baldwin.It Li SYSDECODE_ABI_FREEBSD32
55a5f14abfSJohn Baldwin32-bit FreeBSD binaries.
56a5f14abfSJohn BaldwinSupported on amd64 and powerpc64.
575842bd68SJohn Baldwin.It Li SYSDECODE_ABI_LINUX
58a5f14abfSJohn BaldwinLinux binaries of the same platform.
59*9a16bd16SEd MasteSupported on amd64, i386, and arm64.
605842bd68SJohn Baldwin.It Li SYSDECODE_ABI_LINUX32
61a5f14abfSJohn Baldwin32-bit Linux binaries.
62a5f14abfSJohn BaldwinSupported on amd64.
6387f69beeSEd Schouten.It Li SYSDECODE_ABI_CLOUDABI32
6487f69beeSEd Schouten32-bit CloudABI binaries.
6587f69beeSEd SchoutenSupported on all platforms.
665842bd68SJohn Baldwin.It Li SYSDECODE_ABI_CLOUDABI64
67a5f14abfSJohn Baldwin64-bit CloudABI binaries.
6887f69beeSEd SchoutenSupported on all platforms.
695842bd68SJohn Baldwin.It Li SYSDECODE_ABI_UNKNOWN
70a5f14abfSJohn BaldwinA placeholder for use when the ABI is not known.
71a5f14abfSJohn Baldwin.El
72d6fb4894SJohn Baldwin.Sh SEE ALSO
73287b96ddSJohn Baldwin.Xr sysdecode_abi_to_freebsd_errno 3 ,
749289f547SJohn Baldwin.Xr sysdecode_cap_rights 3 ,
75a826eb5aSMichael Tuexen.Xr sysdecode_cmsg_type 3 ,
769289f547SJohn Baldwin.Xr sysdecode_enum 3 ,
779289f547SJohn Baldwin.Xr sysdecode_fcntl_arg 3 ,
78265e5898SJohn Baldwin.Xr sysdecode_ioctlname 3 ,
79ffb66079SJohn Baldwin.Xr sysdecode_kevent 3 ,
809289f547SJohn Baldwin.Xr sysdecode_mask 3 ,
819289f547SJohn Baldwin.Xr sysdecode_quotactl_cmd 3 ,
821e6455d8SMichael Tuexen.Xr sysdecode_sctp_sinfo_flags 3 ,
839289f547SJohn Baldwin.Xr sysdecode_sigcode 3 ,
842bdd2e7eSJohn Baldwin.Xr sysdecode_socket_protocol 3 ,
859289f547SJohn Baldwin.Xr sysdecode_sockopt_name 3 ,
86a5f14abfSJohn Baldwin.Xr sysdecode_syscallnames 3 ,
87d6fb4894SJohn Baldwin.Xr sysdecode_utrace 3
88d6fb4894SJohn Baldwin.Sh HISTORY
89d6fb4894SJohn BaldwinThe
90d6fb4894SJohn Baldwin.Nm
91d6fb4894SJohn Baldwinlibrary first appeared in
92d6fb4894SJohn Baldwin.Fx 11.0 .
93