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