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