usr.sbin/pstat/pstat.8

   1 .\" Copyright (c) 1980, 1991, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)pstat.8     8.5 (Berkeley) 5/13/94
  29 .\" $FreeBSD: src/usr.sbin/pstat/pstat.8,v 1.19.2.10 2002/07/12 09:12:49 des Exp $
  30 .\"
  31 .Dd December 10, 2014
  32 .Dt PSTAT 8
  33 .Os
  34 .Sh NAME
  35 .Nm pstat ,
  36 .Nm swapinfo
  37 .Nd display system data structures
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl Tfhknst
  41 .Op Fl M Ar core
  42 .Op Fl N Ar system
  43 .Pp
  44 .Nm swapinfo
  45 .Op Fl ghkm
  46 .Op Fl M Ar core
  47 .Op Fl N Ar system
  48 .Sh DESCRIPTION
  49 .Nm Pstat
  50 displays open file entry, swap space utilization,
  51 terminal state, and vnode data structures.
  52 .Pp
  53 If invoked as
  54 .Nm swapinfo
  55 the
  56 .Fl s
  57 option is implied, and only the
  58 .Fl h , k , m , g , M
  59 and
  60 .Fl N
  61 options are legal.
  62 .Pp
  63 The following options are available:
  64 .Bl -tag -width indent
  65 .It Fl n
  66 Print devices out by major/minor instead of name.
  67 .It Fl h
  68 Print sizes with human-readable scaling.  BLOCKSIZE is ignored.
  69 .It Fl k
  70 Print sizes in kilobytes, regardless of the setting of the
  71 .Ev BLOCKSIZE
  72 environment variable.
  73 .It Fl m
  74 Print sizes in megabytes, regardless of the setting of the
  75 .Ev BLOCKSIZE
  76 environment variable.
  77 .It Fl g
  78 Print sizes in gigabytes, regardless of the setting of the
  79 .Ev BLOCKSIZE
  80 environment variable.
  81 .It Fl T
  82 Print the number of used and free slots in several system tables.
  83 This is useful for checking to see how large system tables have become
  84 if the system is under heavy load.
  85 .It Fl f
  86 Print the open file table with these headings:
  87 .Bl -tag -width indent
  88 .It LOC
  89 The core location of this table entry.
  90 .It TYPE
  91 The type of object the file table entry points to.
  92 .It FLG
  93 Miscellaneous state variables encoded thus:
  94 .Pp
  95 .Bl -tag -width indent -compact
  96 .It R
  97 open for reading
  98 .It W
  99 open for writing
 100 .It A
 101 open for appending
 102 .It S
 103 shared lock present
 104 .It X
 105 exclusive lock present
 106 .It I
 107 signal pgrp when data ready
 108 .El
 109 .It CNT
 110 Number of processes that know this open file.
 111 .It MSG
 112 Number of messages outstanding for this file.
 113 .It DATA
 114 The location of the vnode table entry or socket structure for this file.
 115 .It OFFSET
 116 The file offset (see
 117 .Xr lseek 2 ) .
 118 .El
 119 .It Fl s
 120 Print information about swap space usage on all the
 121 swap areas compiled into the kernel.
 122 The first column is the device name of the partition.  The next column is
 123 the total space available in the partition.  The
 124 .Ar Used
 125 column indicates the total blocks used so far;  the
 126 .Ar Available
 127 column indicates how much space is remaining on each partition.
 128 The
 129 .Ar Capacity
 130 reports the percentage of space used.
 131 .Pp
 132 If more than one partition is configured into the system, totals for all
 133 of the statistics will be reported in the final line of the report.
 134 .Pp
 135 If you supply the option again, as in
 136 .Fl ss ,
 137 the system will display a breakdown of the swap bitmap/radix-tree.
 138 .It Fl t
 139 Print table for terminals
 140 with these headings:
 141 .Bl -tag -width indent
 142 .It RAW
 143 Number of characters in raw input queue.
 144 .It CAN
 145 Number of characters in canonicalized input queue.
 146 .It OUT
 147 Number of characters in output queue.
 148 .It MODE
 149 See
 150 .Xr tty 4 .
 151 .It ADDR
 152 Physical device address.
 153 .It DEL
 154 Number of delimiters (newlines) in canonicalized input queue.
 155 .It COL
 156 Calculated column position of terminal.
 157 .It STATE
 158 Miscellaneous state variables encoded thus:
 159 .Pp
 160 .Bl -tag -width indent -compact
 161 .It T
 162 delay timeout in progress
 163 .It W
 164 waiting for open to complete
 165 .It O
 166 open
 167 .It F
 168 outq has been flushed during DMA
 169 .It C
 170 carrier is on
 171 .It c
 172 connection open
 173 .It B
 174 busy doing output
 175 .It A
 176 process is waiting for space in output queue
 177 .It a
 178 process is waiting for output to complete
 179 .It X
 180 open for exclusive use
 181 .It S
 182 output stopped (ixon flow control)
 183 .It m
 184 output stopped (carrier flow control)
 185 .It o
 186 output stopped (CTS flow control)
 187 .It d
 188 output stopped (DSR flow control)
 189 .It K
 190 input stopped
 191 .It Y
 192 send
 193 .Dv SIGIO
 194 for input events
 195 .It D
 196 state for lowercase
 197 .Ql \e
 198 work
 199 .It E
 200 within a
 201 .Ql \e.../
 202 for PRTRUB
 203 .It L
 204 next character is literal
 205 .It P
 206 retyping suspended input (PENDIN)
 207 .It N
 208 counting tab width, ignore FLUSHO
 209 .It l
 210 block mode input routine in use
 211 .It s
 212 i/o being snooped
 213 .It Z
 214 connection lost
 215 .El
 216 .It SESS
 217 Kernel address of the session structure.
 218 .It PGID
 219 Process group for which this is controlling terminal.
 220 .It DISC
 221 Line discipline;
 222 .Ql term
 223 for
 224 TTYDISC
 225 or
 226 .Ql ntty
 227 for
 228 NTTYDISC
 229 or
 230 .Ql tab
 231 for
 232 TABLDISC
 233 or
 234 .Ql slip
 235 for
 236 SLIPDISC
 237 or
 238 .Ql ppp
 239 for
 240 PPPDISC.
 241 .El
 242 .It Fl M
 243 Extract values associated with the name list from the specified core
 244 instead of the default
 245 .Pa /dev/kmem .
 246 .It Fl N
 247 Extract the name list from the specified system instead of the default
 248 .Pa /boot/kernel .
 249 .El
 250 .Sh FILES
 251 .Bl -tag -width /dev/memxxx -compact
 252 .It Pa /boot/kernel
 253 namelist
 254 .It Pa /dev/mem
 255 default source of tables
 256 .El
 257 .Sh SEE ALSO
 258 .Xr fstat 1 ,
 259 .Xr ps 1 ,
 260 .Xr systat 1 ,
 261 .Xr stat 2 ,
 262 .Xr fs 5 ,
 263 .Xr iostat 8 ,
 264 .Xr vmstat 8
 265 .Rs
 266 .%T UNIX Implementation
 267 .%A K. Thompson
 268 .Re
 269 .Sh HISTORY
 270 The
 271 .Nm
 272 command appeared in
 273 .Bx 4.0 .
 274 .Sh BUGS
 275 Does not understand
 276 .Tn NFS
 277 swap servers.