procps/man/hugetop.1
G. Branden Robinson 39aab8c464 man/: Align TH calls with style recommendations
* Stop quoting macro arguments that don't contain spaces.
* Stop defining content for the center header.
* Migrate procio(3) and top(1) to use ISO 8601 date format, like most of
  the other man pages in this project.
* Add the day of the month to procps(3)'s and top(1)'s revision dates.
* Replace procio(3)'s inside footer, "Linux Manpage", with "procps-ng".
* Migrate procps(3), procps_misc(3), procps_pids(3) to use "procps-ng"
  instead of "libproc2" as their inside footers, like all the other man
  pages in this project.

groff_man_style(7):

   Macro reference preliminaries
...
     If a macro accepts multiple arguments, those containing space
     characters must be double‐quoted to be interpreted correctly.
...
   Document structure macros
...
     .TH identifier section [footer‐middle [footer‐inside [header‐middle]]]
...
            identifier and section are positioned at the left and right
            in the header; the latter is set after the former, in
            parentheses and without space.  footer‐middle is centered in
            the footer.  By default, footer‐inside is positioned at the
            bottom left.  Use of the double‐sided layout option -rD1
            places footer‐inside at the bottom left on recto
            (odd‐numbered) pages, and the bottom right on verso
            (even‐numbered) pages.  By default, the outside footer is
            the page number.  Use of the continuous‐rendering option
            -rcR=1 replaces it with identifier and section, as in the
            header.  header‐middle is centered in the header.  If
            section is an integer between 1 and 9 (inclusive), there is
            no need to specify header‐middle; an.tmac supplies text for
            it.
...
            By convention, footer‐middle is the date of the most recent
            modification to the man page source document, and footer‐
            inside is the name and version or release of the project
            providing it.
2024-11-04 10:31:06 +00:00

69 lines
1.6 KiB
Groff

.\"
.\" Copyright (c) 2024 zhenwei pi <pizhenwei@bytedance.com>
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\"
.TH HUGETOP 1 2024-01-18 procps-ng
.SH NAME
hugetop \- report huge page information
.SH SYNOPSIS
.B hugetop
.RI [ option " .\|.\|.]"
.SH DESCRIPTION
The
.B hugetop
command reports the huge page information of system and processes. It displays
a summary of the system huge page status. For each process that has at
least one huge page, the number of private and shared pages, along with
the process PID and command name are displayed.
.SH OPTIONS
.TP
\fB\-d\fR, \fB\-\-delay\fR=\fIN\fR
Refresh the display every
.I n
in seconds. By default,
.B hugetop
refreshes the display every three seconds. To exit the program, hit
.BR q .
This cannot be combined with the \fB-o\fR option.
.TP
\fB\-n\fR, \fB\-\-numa\fR
Display per NUMA node huge page information.
.TP
\fB\-o\fR, \fB\-\-once\fR
Display the output once and then exit.
.TP
\fB\-H\fR, \fB\-\-human\fR
Display human-readable output.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help text and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.
.SH "EXIT STATUS"
.PP
.RS
.PD 0
.TP
.B 0
Success.
.TP
.B Others
Errno.
.PD
.SH AUTHOR
zhenwei pi <pizhenwei@bytedance.com>
.SH "SEE ALSO"
.BR pmap (1)
.SH STANDARDS
No standards apply.
.SH "REPORTING BUGS"
Please send bug reports to
.MT procps@freelists.org
.ME .