xref: /freebsd/usr.bin/sockstat/sockstat.1 (revision 83f60cb20252feabf9c47c4f7599f8c144b9159d)
158278509SDag-Erling Smørgrav.\"-
2fb2ad9d3SUlrich Spörlein.\" Copyright (c) 1999 Dag-Erling Coïdan Smørgrav
358278509SDag-Erling Smørgrav.\" All rights reserved.
458278509SDag-Erling Smørgrav.\"
558278509SDag-Erling Smørgrav.\" Redistribution and use in source and binary forms, with or without
658278509SDag-Erling Smørgrav.\" modification, are permitted provided that the following conditions
758278509SDag-Erling Smørgrav.\" are met:
858278509SDag-Erling Smørgrav.\" 1. Redistributions of source code must retain the above copyright
958278509SDag-Erling Smørgrav.\"    notice, this list of conditions and the following disclaimer
1058278509SDag-Erling Smørgrav.\"    in this position and unchanged.
1158278509SDag-Erling Smørgrav.\" 2. Redistributions in binary form must reproduce the above copyright
1258278509SDag-Erling Smørgrav.\"    notice, this list of conditions and the following disclaimer in the
1358278509SDag-Erling Smørgrav.\"    documentation and/or other materials provided with the distribution.
1458278509SDag-Erling Smørgrav.\" 3. The name of the author may not be used to endorse or promote products
1558278509SDag-Erling Smørgrav.\"    derived from this software without specific prior written permission.
1658278509SDag-Erling Smørgrav.\"
1758278509SDag-Erling Smørgrav.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1858278509SDag-Erling Smørgrav.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1958278509SDag-Erling Smørgrav.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
2058278509SDag-Erling Smørgrav.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
2158278509SDag-Erling Smørgrav.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
2258278509SDag-Erling Smørgrav.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2358278509SDag-Erling Smørgrav.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2458278509SDag-Erling Smørgrav.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2558278509SDag-Erling Smørgrav.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
2658278509SDag-Erling Smørgrav.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2758278509SDag-Erling Smørgrav.\"
28c3aac50fSPeter Wemm.\" $FreeBSD$
2958278509SDag-Erling Smørgrav.\"
30e5cccc35SMichael Tuexen.Dd September 12, 2017
315ff829fdSSheldon Hearn.Dt SOCKSTAT 1
3262500372SRuslan Ermilov.Os
3358278509SDag-Erling Smørgrav.Sh NAME
3458278509SDag-Erling Smørgrav.Nm sockstat
35ac1070c6SDag-Erling Smørgrav.Nd list open sockets
3658278509SDag-Erling Smørgrav.Sh SYNOPSIS
3758278509SDag-Erling Smørgrav.Nm
38*83f60cb2SMichael Tuexen.Op Fl 46cLlSsUuvw
3900feaafdSAndrew Thompson.Op Fl j Ar jid
4003f28475SDag-Erling Smørgrav.Op Fl p Ar ports
411f3d67aaSGiorgos Keramidas.Op Fl P Ar protocols
4258278509SDag-Erling Smørgrav.Sh DESCRIPTION
4358278509SDag-Erling SmørgravThe
4458278509SDag-Erling Smørgrav.Nm
453ce0d6e8SRuslan Ermilovcommand lists open Internet or
463ce0d6e8SRuslan Ermilov.Ux
473ce0d6e8SRuslan Ermilovdomain sockets.
48ac1070c6SDag-Erling Smørgrav.Pp
49ac1070c6SDag-Erling SmørgravThe following options are available:
50ac1070c6SDag-Erling Smørgrav.Bl -tag -width Fl
51ac1070c6SDag-Erling Smørgrav.It Fl 4
523ce0d6e8SRuslan ErmilovShow
533ce0d6e8SRuslan Ermilov.Dv AF_INET
543ce0d6e8SRuslan Ermilov(IPv4) sockets.
55ac1070c6SDag-Erling Smørgrav.It Fl 6
563ce0d6e8SRuslan ErmilovShow
573ce0d6e8SRuslan Ermilov.Dv AF_INET6
583ce0d6e8SRuslan Ermilov(IPv6) sockets.
59a0581bbcSDag-Erling Smørgrav.It Fl c
60a0581bbcSDag-Erling SmørgravShow connected sockets.
6100feaafdSAndrew Thompson.It Fl j Ar jid
6200feaafdSAndrew ThompsonShow only sockets belonging to the specified jail ID.
639b6ca892SBruce M Simpson.It Fl L
64f03482d4SMichael TuexenOnly show Internet sockets if the local and foreign addresses are not
659b6ca892SBruce M Simpsonin the loopback network prefix
669b6ca892SBruce M Simpson.Li 127.0.0.0/8 ,
679b6ca892SBruce M Simpsonor do not contain the IPv6 loopback address
689b6ca892SBruce M Simpson.Li ::1 .
69a0581bbcSDag-Erling Smørgrav.It Fl l
70a0581bbcSDag-Erling SmørgravShow listening sockets.
7103f28475SDag-Erling Smørgrav.It Fl p Ar ports
7225044bbcSMichael TuexenOnly show Internet sockets if the local or foreign port number
7303f28475SDag-Erling Smørgravis on the specified list.
7403f28475SDag-Erling SmørgravThe
7503f28475SDag-Erling Smørgrav.Ar ports
7603f28475SDag-Erling Smørgravargument is a comma-separated list of port numbers and ranges
7703f28475SDag-Erling Smørgravspecified as first and last port separated by a dash.
781f3d67aaSGiorgos Keramidas.It Fl P Ar protocols
791f3d67aaSGiorgos KeramidasOnly show sockets of the specified
801f3d67aaSGiorgos Keramidas.Ar protocols .
811f3d67aaSGiorgos KeramidasThe
821f3d67aaSGiorgos Keramidas.Ar protocols
831f3d67aaSGiorgos Keramidasargument is a comma-separated list of protocol names,
841f3d67aaSGiorgos Keramidasas they are defined in
851f3d67aaSGiorgos Keramidas.Xr protocols 5 .
86e5cccc35SMichael Tuexen.It Fl S
87e5cccc35SMichael TuexenDisplay the protocol stack, if applicable.
88e5cccc35SMichael TuexenThis is currently only implemented for TCP.
897a5642b3SDag-Erling Smørgrav.It Fl s
907a5642b3SDag-Erling SmørgravDisplay the protocol state, if applicable.
916414db1bSMichael TuexenThis is currently only implemented for SCTP and TCP.
9249b836f2SMichael Tuexen.It Fl U
9349b836f2SMichael TuexenDisplay the remote UDP encapsulation port number, if applicable.
9449b836f2SMichael TuexenThis is currently only implemented for SCTP.
95ac1070c6SDag-Erling Smørgrav.It Fl u
963ce0d6e8SRuslan ErmilovShow
973ce0d6e8SRuslan Ermilov.Dv AF_LOCAL
983ce0d6e8SRuslan Ermilov.Pq Ux
993ce0d6e8SRuslan Ermilovsockets.
100*83f60cb2SMichael Tuexen.It Fl v
101*83f60cb2SMichael TuexenVerbose mode.
102*83f60cb2SMichael Tuexen.It Fl w
103*83f60cb2SMichael TuexenUse wider field size for displaying addresses.
104ac1070c6SDag-Erling Smørgrav.El
105ac1070c6SDag-Erling Smørgrav.Pp
106a0581bbcSDag-Erling SmørgravIf neither
1073ce0d6e8SRuslan Ermilov.Fl 4 , 6
108a0581bbcSDag-Erling Smørgravor
109a0581bbcSDag-Erling Smørgrav.Fl u
110a0581bbcSDag-Erling Smørgravis specified,
111ac1070c6SDag-Erling Smørgrav.Nm
112a0581bbcSDag-Erling Smørgravwill list sockets in all three domains.
113a0581bbcSDag-Erling Smørgrav.Pp
114a0581bbcSDag-Erling SmørgravIf neither
115a0581bbcSDag-Erling Smørgrav.Fl c
116a0581bbcSDag-Erling Smørgravor
117a0581bbcSDag-Erling Smørgrav.Fl l
118a0581bbcSDag-Erling Smørgravis specified,
119a0581bbcSDag-Erling Smørgrav.Nm
120a0581bbcSDag-Erling Smørgravwill list both listening and connected sockets.
121ac1070c6SDag-Erling Smørgrav.Pp
12287faa07bSSheldon HearnThe information listed for each
12358278509SDag-Erling Smørgravsocket is:
12414802b60SDag-Erling Smørgrav.Bl -tag -width "FOREIGN ADDRESS"
12558278509SDag-Erling Smørgrav.It Li USER
12658278509SDag-Erling SmørgravThe user who owns the socket.
12758278509SDag-Erling Smørgrav.It Li COMMAND
12858278509SDag-Erling SmørgravThe command which holds the socket.
12958278509SDag-Erling Smørgrav.It Li PID
13058278509SDag-Erling SmørgravThe process ID of the command which holds the socket.
13158278509SDag-Erling Smørgrav.It Li FD
13258278509SDag-Erling SmørgravThe file descriptor number of the socket.
13358278509SDag-Erling Smørgrav.It Li PROTO
134ac1070c6SDag-Erling SmørgravThe transport protocol associated with the socket for Internet
135b8e20e2dSHiroki Satosockets, or the type of socket
136b8e20e2dSHiroki Sato.Pq stream, datagram, or seqpacket
137b8e20e2dSHiroki Satofor
1383ce0d6e8SRuslan Ermilov.Ux
1393ce0d6e8SRuslan Ermilovsockets.
14058278509SDag-Erling Smørgrav.It Li LOCAL ADDRESS
141ca007d91SDag-Erling SmørgravFor Internet sockets, this is the address the local end of the socket
142ca007d91SDag-Erling Smørgravis bound to (see
14358278509SDag-Erling Smørgrav.Xr getsockname 2 ) .
144ca007d91SDag-Erling SmørgravFor bound
145ca007d91SDag-Erling Smørgrav.Ux
146ca007d91SDag-Erling Smørgravsockets, it is the socket's filename.
147ca007d91SDag-Erling SmørgravFor other
148ca007d91SDag-Erling Smørgrav.Ux
149ca007d91SDag-Erling Smørgravsockets, it is a right arrow followed by the endpoint's filename, or
150ca007d91SDag-Erling Smørgrav.Dq Li ??
151ca007d91SDag-Erling Smørgravif the endpoint could not be determined.
15258278509SDag-Erling Smørgrav.It Li FOREIGN ADDRESS
153ac1070c6SDag-Erling Smørgrav(Internet sockets only)
15458278509SDag-Erling SmørgravThe address the foreign end of the socket is bound to (see
15558278509SDag-Erling Smørgrav.Xr getpeername 2 ) .
15649b836f2SMichael Tuexen.It Li ENCAPS
15749b836f2SMichael TuexenThe remote UDP encapsulation port number if
15849b836f2SMichael Tuexen.Fl U
15949b836f2SMichael Tuexenis specified (only for SCTP).
160e389705eSMichael Tuexen.It Li PATH STATE
161e389705eSMichael TuexenThe path state if
162e389705eSMichael Tuexen.Fl s
163e389705eSMichael Tuexenis specified (only for SCTP).
164e389705eSMichael Tuexen.It Li CONN STATE
165e389705eSMichael TuexenThe connection state if
166e5cccc35SMichael Tuexen.Fl s
167e5cccc35SMichael Tuexenis specified (only for SCTP or TCP).
168e5cccc35SMichael Tuexen.It Li STACK
169e5cccc35SMichael TuexenThe protocol stack if
170e5cccc35SMichael Tuexen.Fl S
171e5cccc35SMichael Tuexenis specified (only for TCP).
17258278509SDag-Erling Smørgrav.El
17397c6143cSPeter Pentchev.Pp
17461149f8dSJilles TjoelkerIf a socket is associated with more than one file descriptor,
17561149f8dSJilles Tjoelkerit is shown multiple times.
17661149f8dSJilles TjoelkerIf a socket is not associated with any file descriptor,
17761149f8dSJilles Tjoelkerthe first four columns have no meaning.
17858278509SDag-Erling Smørgrav.Sh SEE ALSO
17958278509SDag-Erling Smørgrav.Xr fstat 1 ,
18014802b60SDag-Erling Smørgrav.Xr netstat 1 ,
181e5002279SEdward Tomasz Napierala.Xr procstat 1 ,
182482ca427SYoshinobu Inoue.Xr inet 4 ,
1831f3d67aaSGiorgos Keramidas.Xr inet6 4 ,
1841f3d67aaSGiorgos Keramidas.Xr protocols 5
18558278509SDag-Erling Smørgrav.Sh HISTORY
18658278509SDag-Erling SmørgravThe
18758278509SDag-Erling Smørgrav.Nm
18858278509SDag-Erling Smørgravcommand appeared in
18958278509SDag-Erling Smørgrav.Fx 3.1 .
19058278509SDag-Erling Smørgrav.Sh AUTHORS
19158278509SDag-Erling SmørgravThe
19258278509SDag-Erling Smørgrav.Nm
19358278509SDag-Erling Smørgravcommand and this manual page were written by
1942b7af31cSBaptiste Daroussin.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
195