svn commit: r339080 - head/usr.bin/top

[Mateusz Piotrowski]

Author: 0mp (ports committer)
Date: Tue Oct  2 08:13:54 2018
New Revision: 339080
URL: https://svnweb.freebsd.org/changeset/base/339080

Log:
  top(1): Rework DESCRIPTION OF MEMORY section.
  
  Due to markup issues, the DESCRIPTION OF MEMORY section is rather
  unreadable; rework it a bit, using subsections for different lines of the
  top output, and move it closer to description.
  
  While here, pet manlint ordering other sections as expected.
  
  Submitted by:	Yuri Pankov <yuripv at yuripv.net>
  Reviewed by:	eadler
  Approved by:	re (gjb), krion (mentor)
  Differential Revision:	https://reviews.freebsd.org/D17369

Modified:
  head/usr.bin/top/top.1

Modified: head/usr.bin/top/top.1
==============================================================================
--- head/usr.bin/top/top.1	Mon Oct  1 20:55:01 2018	(r339079)
+++ head/usr.bin/top/top.1	Tue Oct  2 08:13:54 2018	(r339080)
@@ -1,5 +1,5 @@
 .\" $FreeBSD$
-.Dd June 9, 2018
+.Dd October 2, 2018
 .Dt TOP 1
 .Os
 .Sh NAME
@@ -359,81 +359,87 @@ the state column will report the name of the event or 
 process is waiting.
 Lock names are prefixed with an asterisk \*(lq*\*(rq while sleep events
 are not.
-.Sh AUTHORS
-.An William LeFebvre, EECS Department, Northwestern University
-.Sh BUGS
-The command name for swapped processes should be tracked down, but this
-would make the program run slower.
-.Pp
-As with
-.Xr ps 1 ,
-things can change while
-.Nm
-is collecting information for an update.
-The picture it gives is only a
-close approximation to reality.
-.Sh ENVIRONMENT
-.Bl -tag -width TOP -compact
-.It Pa TOP
-Default set of arguments to
-.Nm .
-.El
-.Sh SEE ALSO
-.Xr kill 1 ,
-.Xr ps 1 ,
-.Xr stty 1 ,
-.Xr getrusage 2 ,
-.Xr humanize_number 3 ,
-.Xr mem 4 ,
-.Xr renice 8
 .Sh DESCRIPTION OF MEMORY
+.Bd -literal
 Mem: 61M Active, 86M Inact, 368K Laundry, 22G Wired, 102G Free
 ARC: 15G Total, 9303M MFU, 6155M MRU, 1464K Anon, 98M Header, 35M Other
      15G Compressed, 27G Uncompressed, 1.75:1 Ratio, 174M Overhead
 Swap: 4096M Total, 532M Free, 13% Inuse, 80K In, 104K Out
-.Sh Physical Memory Stats
-.Bl -tag -width indent
-.It Active:
+.Ed
+.Ss Physical Memory Stats
+.Bl -tag -width "Uncompressed" -compact
+.It Em Active
 number of bytes active
-.It Inact:
+.It Em Inact
 number of clean bytes inactive
-.It Laundry:
+.It Em Laundry
 number of dirty bytes queued for laundering
-.It Wired:
+.It Em Wired
 number of bytes wired down, including IO-level cached file data pages
-.It Buf:
+.It Em Buf
 number of bytes used for IO-level disk caching
-.It Free:
+.It Em Free
 number of bytes free
-.It ZFS ARC Stats
+.El
+.Ss ZFS ARC Stats
 These stats are only displayed when the ARC is in use.
-.It Total:
+.Pp
+.Bl -tag -width "Uncompressed" -compact
+.It Em Total
 number of wired bytes used for the ZFS ARC
-.It MRU:
+.It Em MRU
 number of ARC bytes holding most recently used data
-.It MFU:
+.It Em MFU
 number of ARC bytes holding most frequently used data
-.It Anon:
+.It Em Anon
 number of ARC bytes holding in flight data
-.It Header:
+.It Em Header
 number of ARC bytes holding headers
-.It Other:
+.It Em Other
 miscellaneous ARC bytes
-.It Compressed:
+.It Em Compressed
 bytes of memory used by ARC caches
-.It Uncompressed:
+.It Em Uncompressed
 bytes of data stored in ARC caches before compression
-.It Ratio:
+.It Em Ratio
 compression ratio of data cached in the ARC
-.It Swap Stats
-.It Total:
+.El
+.Ss Swap Stats
+.Bl -tag -width "Uncompressed" -compact
+.It Em Total
 total available swap usage
-.It Free:
+.It Em Free
 total free swap usage
-.It Inuse:
+.It Em Inuse
 swap usage
-.It In:
+.It Em \&In
 bytes paged in from swap devices (last interval)
-.It Out:
+.It Em Out
 bytes paged out to swap devices (last interval)
 .El
+.Sh ENVIRONMENT
+.Bl -tag -width "Uncompressed"
+.It Ev TOP
+Default set of arguments to
+.Nm .
+.El
+.Sh SEE ALSO
+.Xr kill 1 ,
+.Xr ps 1 ,
+.Xr stty 1 ,
+.Xr getrusage 2 ,
+.Xr humanize_number 3 ,
+.Xr mem 4 ,
+.Xr renice 8
+.Sh AUTHORS
+.An William LeFebvre, EECS Department, Northwestern University
+.Sh BUGS
+The command name for swapped processes should be tracked down, but this
+would make the program run slower.
+.Pp
+As with
+.Xr ps 1 ,
+things can change while
+.Nm
+is collecting information for an update.
+The picture it gives is only a close approximation to reality.