This commit was generated by cvs2svn to track changes on a CVS vendor
[unix-history] / usr.sbin / swapinfo / swapinfo.1
CommitLineData
4d554349
NW
1.\"
2.\" swapinfo
3.\"
4.Dd February 23, 1993
5.Dt SWAPINFO 1
6.Sh NAME
7.Nm swapinfo
8.Nd display free swap space
9.Sh SYNOPSIS
10.Nm swapinfo
11.Op Fl k
12.Sh DESCRIPTION
13.Nm Swapinfo
14displays statistics about the amount of free swap space on all of the
15swap areas compiled into the kernel.
16.Pp
17The following options are available:
18.Bl -tag -width Ds
19.It Fl k
20By default, all sizes are reported in 512-byte block counts.
21The
22.Fl k
23option causes the numbers to be reported in kilobyte counts.
24.El
25.Sh STATISTICS
26Statistics are reported for all swap partitions configured into the kernel.
27The first column is the device name of the partition. The next column is
28the total space available in the partition. The
29.Ar Used
30column indicates the total blocks used so far; the
31.Ar Available
32column indicates how much space is remaining on each partition.
33The
34.Ar Capacity
35reports the percentage of space used.
36.Pp
37If more than one partition is configured into the system, totals for all
38of the statistics will be reported in the final line of the report.
39.Sh "BUGS AND CAVEATS"
40The information reported by
41.Nm swapinfo
42is stored in the kernel in a linked list. Since we are merely reading
43this list out of kernel memory, it is entirely possible that the list could
44change as we try to read it. Suspicious and unrepeatable values are probably
45incorrect.
46.Pp
47Statistics are reported for all swap partitions compiled into the kernel,
48regardless of whether those partitions are being used.
49.Sh AUTHOR
50.RS
51Kevin Lahey
52.br
53kml@rokkaku.atl.ga.us