xref: /netbsd-src/usr.bin/kdump/ioctlprint.1 (revision 232ae7152646a450ea4b49bb4da79e8b87e80b87)
1*232ae715Swiz.\" $NetBSD: ioctlprint.1,v 1.5 2020/04/03 06:12:48 wiz Exp $
2bf449249Skamil.\"
3bf449249Skamil.\" Copyright (c) 2020 The NetBSD Foundation, Inc.
4bf449249Skamil.\" All rights reserved.
5bf449249Skamil.\"
6bf449249Skamil.\" This code is derived from software contributed to The NetBSD Foundation
7bf449249Skamil.\" by Kamil Rytarowski.
8bf449249Skamil.\"
9bf449249Skamil.\" Redistribution and use in source and binary forms, with or without
10bf449249Skamil.\" modification, are permitted provided that the following conditions
11bf449249Skamil.\" are met:
12bf449249Skamil.\" 1. Redistributions of source code must retain the above copyright
13bf449249Skamil.\"    notice, this list of conditions and the following disclaimer.
14bf449249Skamil.\" 2. Redistributions in binary form must reproduce the above copyright
15bf449249Skamil.\"    notice, this list of conditions and the following disclaimer in the
16bf449249Skamil.\"    documentation and/or other materials provided with the distribution.
17bf449249Skamil.\"
18bf449249Skamil.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19bf449249Skamil.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20bf449249Skamil.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21bf449249Skamil.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22bf449249Skamil.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23bf449249Skamil.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24bf449249Skamil.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25bf449249Skamil.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26bf449249Skamil.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27bf449249Skamil.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28bf449249Skamil.\" POSSIBILITY OF SUCH DAMAGE.
29bf449249Skamil.\"
30bf449249Skamil.Dd April 2, 2020
31bf449249Skamil.Dt IOCTLPRINT 1
32bf449249Skamil.Os
33bf449249Skamil.Sh NAME
34bf449249Skamil.Nm ioctlprint
35bf449249Skamil.Nd display descriptive ioctl value
36bf449249Skamil.Sh SYNOPSIS
37bf449249Skamil.Nm
38e30be371Schristos.Op Fl l
39bf449249Skamil.Op Fl e Ar emulation
40bf449249Skamil.Op Fl f Ar format
41bf449249Skamil.Op Ar arg ...
42bf449249Skamil.Sh DESCRIPTION
43bf449249SkamilThe
44bf449249Skamil.Nm
458ec0a7f9Swizutility displays information about the file ioctl operation pointed
468ec0a7f9Swizto by one or more
47bf449249Skamil.Ar arg
48bf449249Skamilarguments.
49e30be371SchristosThe argument can either be an
50*232ae715Swiz.Xr ioctl 2
51*232ae715Swizsymbolic name or the ioctl value.
52bf449249Skamil.Pp
53bf449249SkamilThe options are as follows:
54*232ae715Swiz.Bl -tag -width 12n
55bf449249Skamil.It Fl e Ar emulation
56bf449249SkamilIf an emulation of a process is unknown,
57bf449249Skamilinterpret system call maps assuming the named emulation instead of
58bf449249Skamildefault "netbsd".
59bf449249Skamil.It Fl f Ar format
60bf449249SkamilThe argument is a
61bf449249Skamil.Xr printf 3
62bf449249Skamilstyle format string that allows customization of
638ec0a7f9Swiz.Nm ioctlprint Ap s
64bf449249Skamiloutput.
65bf449249Skamil.Pp
66bf449249SkamilThe following conversion characters can be used:
67*232ae715Swiz.Bl -tag -width 9n
68e30be371Schristos.It \&%E
69e30be371SchristosSymbolic decoded ioctl string.
70bf449249Skamil.It \&%e
71e30be371SchristosDecoded ioctl string with hex values.
72bf449249Skamil.It \&%n
73bf449249SkamilDescriptive ioctl operation name.
74bf449249Skamil.It \&%x
75bf449249SkamilHexadecimal ioctl number.
76bf449249Skamil.It \&%o
77bf449249SkamilOctal ioctl number.
78bf449249Skamil.It \&%d or \&%i
79bf449249SkamilDecimal ioctl number.
80bf449249Skamil.El
81bf449249Skamil.Pp
82bf449249SkamilThe default format is:
83bf449249Skamil.Bd -literal -offset indent
84bf449249Skamil"%n %e %x\\n"
85bf449249Skamil.Ed
86e30be371Schristos.It Fl l
87*232ae715SwizList all known
88e30be371Schristos.Xr ioctl 2
89*232ae715Swizrequests.
90bf449249Skamil.El
91bf449249Skamil.Sh SEE ALSO
928ec0a7f9Swiz.Xr kdump 1 ,
93bf449249Skamil.Xr ktrace 1
94bf449249Skamil.Sh HISTORY
95bf449249SkamilThe
96bf449249Skamil.Nm
97bf449249Skamilcommand first appeared in
98bf449249Skamil.Nx 10 .
99bf449249Skamil.Sh AUTHORS
100bf449249Skamil.An Kamil Rytarowski Aq Mt kamil@NetBSD.org
101