2 .\" Copyright (c) 1999 Dag-Erling Coïdan Smørgrav
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer
10 .\" in this position and unchanged.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\" derived from this software without specific prior written permission.
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 .Dd September 13, 2020
45 command lists open Internet or
49 The following options are available:
60 Display the congestion control module, if applicable.
61 This is currently only implemented for TCP.
63 Show connected sockets.
65 Show only sockets belonging to the specified jail ID or name.
67 Only show Internet sockets if the local and foreign addresses are not
68 in the loopback network prefix
70 or do not contain the IPv6 loopback address
73 Show listening sockets.
75 Only show Internet sockets if the local or foreign port number
76 is on the specified list.
79 argument is a comma-separated list of port numbers and ranges
80 specified as first and last port separated by a dash.
82 Only show sockets of the specified
86 argument is a comma-separated list of protocol names,
87 as they are defined in
90 Quiet mode, do not print the header line.
92 Display the protocol stack, if applicable.
93 This is currently only implemented for TCP.
95 Display the protocol state, if applicable.
96 This is currently only implemented for SCTP and TCP.
98 Display the remote UDP encapsulation port number, if applicable.
99 This is currently only implemented for SCTP.
108 Use wider field size for displaying addresses.
117 will list sockets in all three domains.
125 will list both listening and connected sockets.
127 The information listed for each
129 .Bl -tag -width "FOREIGN ADDRESS"
131 The user who owns the socket.
133 The command which holds the socket.
135 The process ID of the command which holds the socket.
137 The file descriptor number of the socket.
139 The transport protocol associated with the socket for Internet
140 sockets, or the type of socket
141 .Pq stream, datagram, or seqpacket
146 For Internet sockets, this is the address the local end of the socket
148 .Xr getsockname 2 ) .
151 sockets, it is the socket's filename.
154 sockets, it is a right arrow followed by the endpoint's filename, or
156 if the endpoint could not be determined.
157 .It Li FOREIGN ADDRESS
158 (Internet sockets only)
159 The address the foreign end of the socket is bound to (see
160 .Xr getpeername 2 ) .
162 The remote UDP encapsulation port number if
164 is specified (only for SCTP).
168 is specified (only for SCTP).
170 The connection state if
172 is specified (only for SCTP or TCP).
174 The protocol stack if
176 is specified (only for TCP).
178 The congestion control if
180 is specified (only for TCP).
183 If a socket is associated with more than one file descriptor,
184 it is shown multiple times.
185 If a socket is not associated with any file descriptor,
186 the first four columns have no meaning.
188 Show information for IPv4 sockets listening on port 22 using protocol
190 .Bd -literal -offset indent
191 $ sockstat -4 -l -P tcp -p 22
194 Show information for sockets using either TCP or UDP, if neither, the local nor
195 the foreign addresses are in the loopback network:
196 .Bd -literal -offset indent
197 $ sockstat -L -P tcp,udp
200 Show TCP IPv6 sockets which are listening and connected (default):
201 .Bd -literal -offset indent
219 command and this manual page were written by
220 .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .