emo/procps
1
0
Fork 0
Code Issues Pull Requests Packages Releases Activity

docs: free great modernization manual page fixes

Browse Source 
Mention long options, and new options, in manual page.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
This commit is contained in:
Sami Kerola 2011-04-18 19:30:21 +02:00 committed by Jan Görig
parent d13fbc34a7
commit 11049a7c98
1 changed files with 46 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
free.1
View File

@ -1,58 +1,77 @@
.\" -*-Nroff-*-
.\" This page Copyright (C) 1993 Matt Welsh, mdw@sunsite.unc.edu.
.\" Long options where added at April 15th, 2011.
.\" Freely distributable under the terms of the GPL
.TH FREE 1 "5 Oct 2009 " "Cohesive Systems" "Linux User's Manual"
.TH FREE 1 "15 Apr 2011 " "Cohesive Systems" "Linux User's Manual"
.SH NAME
free \- Display amount of free and used memory in the system
.SH SYNOPSIS
.B free
.RB [ \-b | \-k | \-m | \-g ]
.RB [ \-c
.IR count ]
.RB [ \-l ]
.RB [ \-o ]
.RB [ \-t ]
.RB [ \-s
.IR delay ]
.RB [ \-V ]
.RB [ options ]
.SH DESCRIPTION
\fBfree\fP displays the total amount of free and used physical and swap
memory in the system, as well as the buffers used by the kernel.
The shared memory column should be ignored; it is obsolete.
.SS OPTIONS
.TP
\fB\-b\fR
\fB\-b, \-\-bytes\fR
Display the amount of memory in bytes.
.TP
\fB\-c\fR \fIcount\fR
Display the result \fIcount\fR times. Requires the \fB\-s\fR option.
.TP
\fB\-g\fR
Display the amount of memory in gigabytes.
.TP
\fB\-k\fR
\fB\-k, \-\-kilo\fR
Display the amount of memory in kilobytes. This is the default.
.TP
\fB\-l\fR
Show detailed low and high memory statistics.
.TP
\fB\-m\fR
\fB\-m, \-\-mega\fR
Display the amount of memory in megabytes.
.TP
\fB\-o\fR
\fB\-g, \-\-giga\fR
Display the amount of memory in gigabytes.
.TP
\fB\-\-tera
Display the amount of memory in terabytes.
.TP
\fB\-h, \-\-human\fP
Show all output fields automatically scaled to shortest three
digit unit and display the units of print out. Following units
are used.
.nf
B = bytes
K = kilos
M = megas
G = gigas
T = teras
.fi
If unit is missing, and you have petabyte of RAM or swap, the
number is in terabytes and columns might not be aligned with
header.
.TP
\fB\-c, \-\-count\fR \fICOUNT\fR
Display the result \fIcount\fR times. Requires the \fB\-s\fR option.
.TP
\fB\-l, \-\-lohi\fR
Show detailed low and high memory statistics.
.TP
\fB\-o, \-\-old\fR
Display the output in old format, the only difference being this option
will disable the display of the "buffer adjusted" line.
.TP
\fB\-s\fR
\fB\-s, \-\-seconds\fR \fISECONDS\fR
Continuously display the result \fIdelay\fP seconds apart. You
may actually specify any floating point number for \fIdelay\fP,
.BR usleep (3)
is used for microsecond resolution delay times.
.TP
\fB\-t\fR
\fB\-\-si\fP
Use power of 1000 not 1024.
.TP
\fB\-t, \-\-total\fR
Display a line showing the column totals.
.TP
\fB\-V\fR
\fB\-\-help\fP
Print help.
.TP
\fB\-V, \-\-version\fR
Display version information.
.SH FILES
.nf
@ -61,7 +80,7 @@ Display version information.
.SH AUTHORS
Written by Brian Edmonds.
Send bug reports to <albert@users.sf.net>
Send bug reports to <procps@freelists.org>
.SH "SEE ALSO"
.BR ps "(1), " slabtop "(1), " top "(1), " vmstat (8).
.\"{{{}}}