Files
xen/docs/man/xentop.1.pod
T
Andrew Cooper 8410fcb54a docs/man: Fix/simplify generation of manpages
The original intent of this patch was to rename xen-vbd-interface.markdown.7
to xen-vbd-interface.pandoc.7 to remove the final markdown file from the docs/
tree.

The DOC_MANx lists are broken.  They contain MANxSRC-y twice, the first half
with a partial %.pod substituation, and the second half with a partial
%.markdown substitution.  This is also the root cause behind the filtering
activity in the uninstall-man$(i)-pages rule.

Furthermore, the logic for generating the manpage targets is unnecesserily
repetative, owing to the layout of source files in the man/ directory.

Therefore, tackle the problem by renaming all of our manpage source files from
"$FORMAT.$SECTION" to "$SECTION.$FORMAT".  For the two xl.cfg.5 and xl.1 which
are preprocessed by autoconf to contain path information, this requires
updating configure.ac and .gitignore.  The markdown to pandoc conversion is
performed as well, as it is also a straight rename.

An ancillary benefit of this renaming is that text editors stand a chance of
being able to work out the correct mode to use.

As for the makefile:

1) Break the MAN_SECTIONS list out of the GENERATE_MANPAGE_RULES loop, as we
   are going to use it a second time.
2) Do away with the individaul MANxSRC-y variables.  Use a single list,
   derived from all *.pod and *.pandoc files, with their format suffixes
   removed.
3) Use a $(foreach ...) to generate the DOC_MANx lists, filling them with the
   correct content.
4) The DOC_HTML and DOC_TXT can now include all manpages with a single
   substitution, as they don't need to separate the manpages by
   section-numbered-directory.
5) Fix up the filenames in the manpage metarule to match the renaming.

No functional change.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
2019-01-02 17:50:36 +00:00

112 lines
1.8 KiB
INI

=head1 NAME
xentop - displays real-time information about a Xen system and domains
=head1 SYNOPSIS
B<xentop> [B<-h>] [B<-V>] [B<-d>SECONDS] [B<-n>] [B<-r>] [B<-v>] [B<-f>]
[B<-b>] [B<-i>ITERATIONS]
=head1 DESCRIPTION
B<xentop> displays information about the Xen system and domains, in a
continually-updating manner. Command-line options and interactive commands
can change the detail and format of the information displayed by B<xentop>.
=head1 OPTIONS
=over 4
=item B<-h>, B<--help>
display help and exit
=item B<-V>, B<--version>
output version information and exit
=item B<-d>, B<--delay>=I<SECONDS>
seconds between updates (default 3)
=item B<-n>, B<--networks>
output network information
=item B<-x>, B<--vbds>
output vbd block device data
=item B<-r>, B<--repeat-header>
repeat table header before each domain
=item B<-v>, B<--vcpus>
output VCPU data
=item B<-f>, B<--full-name>
output the full domain name (not truncated)
=item B<-b>, B<--batch>
output data in batch mode (to stdout)
=item B<-i>, B<--iterations>=I<ITERATIONS>
maximum number of iterations xentop should produce before ending
=back
=head1 INTERACTIVE COMMANDS
All interactive commands are case-insensitive.
=over 4
=item B<D>
set delay between updates
=item B<N>
toggle display of network information
=item B<Q>, B<Esc>
quit
=item B<R>
toggle table header before each domain
=item B<S>
cycle sort order
=item B<V>
toggle display of VCPU information
=item B<Arrows>
scroll domain display
=back
=head1 AUTHORS
Written by Judy Fischbach, David Hendricks, and Josh Triplett
=head1 REPORTING BUGS
Report bugs to <xen-devel@lists.xen.org>.
=head1 COPYRIGHT
Copyright 2005 International Business Machines Corp
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.