usr.bin/sockstat/sockstat.1

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