xref: /freebsd/usr.bin/sockstat/sockstat.1 (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1.\"-
2.\" Copyright (c) 1999 Dag-Erling Coïdan Smørgrav
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
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.
16.\"
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.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd July 14, 2015
31.Dt SOCKSTAT 1
32.Os
33.Sh NAME
34.Nm sockstat
35.Nd list open sockets
36.Sh SYNOPSIS
37.Nm
38.Op Fl 46cLlsu
39.Op Fl j Ar jid
40.Op Fl p Ar ports
41.Op Fl P Ar protocols
42.Sh DESCRIPTION
43The
44.Nm
45command lists open Internet or
46.Ux
47domain sockets.
48.Pp
49The following options are available:
50.Bl -tag -width Fl
51.It Fl 4
52Show
53.Dv AF_INET
54(IPv4) sockets.
55.It Fl 6
56Show
57.Dv AF_INET6
58(IPv6) sockets.
59.It Fl c
60Show connected sockets.
61.It Fl j Ar jid
62Show only sockets belonging to the specified jail ID.
63.It Fl L
64Only show Internet sockets if the local and foreign addresses are not
65in the loopback network prefix
66.Li 127.0.0.0/8 ,
67or do not contain the IPv6 loopback address
68.Li ::1 .
69.It Fl l
70Show listening sockets.
71.It Fl p Ar ports
72Only show Internet sockets if the local or foreign port number
73is on the specified list.
74The
75.Ar ports
76argument is a comma-separated list of port numbers and ranges
77specified as first and last port separated by a dash.
78.It Fl P Ar protocols
79Only show sockets of the specified
80.Ar protocols .
81The
82.Ar protocols
83argument is a comma-separated list of protocol names,
84as they are defined in
85.Xr protocols 5 .
86.It Fl s
87Display the protocol state, if applicable.
88This is currently only implemented for TCP.
89.It Fl u
90Show
91.Dv AF_LOCAL
92.Pq Ux
93sockets.
94.El
95.Pp
96If neither
97.Fl 4 , 6
98or
99.Fl u
100is specified,
101.Nm
102will list sockets in all three domains.
103.Pp
104If neither
105.Fl c
106or
107.Fl l
108is specified,
109.Nm
110will list both listening and connected sockets.
111.Pp
112The information listed for each
113socket is:
114.Bl -tag -width "FOREIGN ADDRESS"
115.It Li USER
116The user who owns the socket.
117.It Li COMMAND
118The command which holds the socket.
119.It Li PID
120The process ID of the command which holds the socket.
121.It Li FD
122The file descriptor number of the socket.
123.It Li PROTO
124The transport protocol associated with the socket for Internet
125sockets, or the type of socket
126.Pq stream, datagram, or seqpacket
127for
128.Ux
129sockets.
130.It Li LOCAL ADDRESS
131For Internet sockets, this is the address the local end of the socket
132is bound to (see
133.Xr getsockname 2 ) .
134For bound
135.Ux
136sockets, it is the socket's filename.
137For other
138.Ux
139sockets, it is a right arrow followed by the endpoint's filename, or
140.Dq Li ??
141if the endpoint could not be determined.
142.It Li FOREIGN ADDRESS
143(Internet sockets only)
144The address the foreign end of the socket is bound to (see
145.Xr getpeername 2 ) .
146.El
147.Pp
148If a socket is associated with more than one file descriptor,
149it is shown multiple times.
150If a socket is not associated with any file descriptor,
151the first four columns have no meaning.
152.Sh SEE ALSO
153.Xr fstat 1 ,
154.Xr netstat 1 ,
155.Xr procstat 1 ,
156.Xr inet 4 ,
157.Xr inet6 4 ,
158.Xr protocols 5
159.Sh HISTORY
160The
161.Nm
162command appeared in
163.Fx 3.1 .
164.Sh AUTHORS
165The
166.Nm
167command and this manual page were written by
168.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
169