Xen project Mailing List

[Xen-changelog] [xen master] docs: Move xentop.1 to docs/man/xentop.pod.1

Date: Tue, 01 Sep 2015 10:56:35 +0000

Delivery-date: Tue, 01 Sep 2015 10:56:40 +0000

List-id: "Change log for Mercurial $receive only$" <xen-changelog.lists.xen.org>

commit 570de9c38419e0287479a819a80d691a0913e5e2 Author: Andrew Cooper <andrew.cooper3@xxxxxxxxxx> AuthorDate: Wed Aug 26 09:15:20 2015 +0000 Commit: Ian Jackson <Ian.Jackson@xxxxxxxxxxxxx> CommitDate: Thu Aug 27 19:14:20 2015 +0100 docs: Move xentop.1 to docs/man/xentop.pod.1 And transform to POD to match our other manpages. The content is identical, although the layout differs slightly with certain indentation. In addition, adjust the MAN{1,5}SRC-y `find` runes to be more general. Signed-off-by: Andrew Cooper <andrew.cooper3@xxxxxxxxxx> Acked-by: Wei Liu <wei.liu2@xxxxxxxxxx> --- docs/Makefile | 6 +-- docs/man/xentop.pod.1 | 111 +++++++++++++++++++++++++++++++++++++++++ tools/xenstat/xentop/Makefile | 4 +- tools/xenstat/xentop/xentop.1 | 103 -------------------------------------- 4 files changed, 114 insertions(+), 110 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 272292c..ef3340c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -7,10 +7,8 @@ VERSION := $(shell $(MAKE) -C $(XEN_ROOT)/xen --no-print-directory xenversion) DOC_ARCHES := arm x86_32 x86_64 # Documentation sources to build -MAN1SRC-y += $(sort $(shell find man -name 'xl*.pod.1' -print)) -MAN1SRC-y += $(sort $(shell find man -name 'xenstore*.pod.1' -print)) - -MAN5SRC-y := $(sort $(shell find man -name 'xl*.pod.5' -print)) +MAN1SRC-y := $(sort $(shell find man/ -name '*.pod.1' -print)) +MAN5SRC-y := $(sort $(shell find man/ -name '*.pod.5' -print)) MARKDOWNSRC-y := $(sort $(shell find misc -name '*.markdown' -print)) diff --git a/docs/man/xentop.pod.1 b/docs/man/xentop.pod.1 new file mode 100644 index 0000000..1d0eb50 --- /dev/null +++ b/docs/man/xentop.pod.1 @@ -0,0 +1,111 @@ +=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@xxxxxxxxxxxxx>. + +=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. diff --git a/tools/xenstat/xentop/Makefile b/tools/xenstat/xentop/Makefile index e67c9ab..1cc393f 100644 --- a/tools/xenstat/xentop/Makefile +++ b/tools/xenstat/xentop/Makefile @@ -30,11 +30,9 @@ LDFLAGS += $(APPEND_LDFLAGS) all: xentop .PHONY: install -install: xentop xentop.1 +install: xentop $(INSTALL_DIR) $(DESTDIR)$(sbindir) $(INSTALL_PROG) xentop $(DESTDIR)$(sbindir)/xentop - $(INSTALL_DIR) $(DESTDIR)$(MAN1DIR) - $(INSTALL_DATA) xentop.1 $(DESTDIR)$(MAN1DIR)/xentop.1 endif diff --git a/tools/xenstat/xentop/xentop.1 b/tools/xenstat/xentop/xentop.1 deleted file mode 100644 index 82c000e..0000000 --- a/tools/xenstat/xentop/xentop.1 +++ /dev/null @@ -1,103 +0,0 @@ -.\" Copyright (C) International Business Machines Corp., 2005 -.\" Author: Josh Triplett <josh@xxxxxxxxxx> -.\" -.\" 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; under version 2 of the License. -.\" -.\" This program is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with this program; If not, see <http://www.gnu.org/licenses/>. -.TH xentop 1 "August 2005" -.SH NAME -\fBxentop\fR \- displays real-time information about a Xen system and domains - -.SH SYNOPSIS -.B xentop -[\fB\-h\fR] -[\fB\-V\fR] -[\fB\-d\fRSECONDS] -[\fB\-n\fR] -[\fB\-r\fR] -[\fB\-v\fR] -[\fB\-f\fR] -[\fB\-b\fR] -[\fB\-i\fRITERATIONS] - -.SH DESCRIPTION -\fBxentop\fR 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 \fBxentop\fR. - -.SH OPTIONS -.TP -\fB\-h\fR, \fB\-\-help\fR -display help and exit -.TP -\fB\-V\fR, \fB\-\-version\fR -output version information and exit -.TP -\fB\-d\fR, \fB\-\-delay\fR=\fISECONDS\fR -seconds between updates (default 3) -.TP -\fB\-n\fR, \fB\-\-networks\fR -output network information -.TP -\fB\-x\fR, \fB\-\-vbds\fR -output vbd block device data -.TP -\fB\-r\fR, \fB\-\-repeat\-header\fR -repeat table header before each domain -.TP -\fB\-v\fR, \fB\-\-vcpus\fR -output VCPU data -.TP -\fB\-f\fR, \fB\-\-full\-name\fR -output the full domain name (not truncated) -.TP -\fB\-b\fR, \fB\-\-batch\fR -output data in batch mode (to stdout) -.TP -\fB\-i\fR, \fB\-\-iterations\fR=\fIITERATIONS\fR -maximum number of iterations xentop should produce before ending - - -.SH "INTERACTIVE COMMANDS" -All interactive commands are case-insensitive. -.TP -.B D -set delay between updates -.TP -.B N -toggle display of network information -.TP -.B Q, Esc -quit -.TP -.B R -toggle table header before each domain -.TP -.B S -cycle sort order -.TP -.B V -toggle display of VCPU information -.TP -.B Arrows -scroll domain display - -.SH AUTHORS -Written by Judy Fischbach, David Hendricks, and Josh Triplett - -.SH "REPORTING BUGS" -Report bugs to <xen-devel@xxxxxxxxxxxxx>. - -.SH COPYRIGHT -Copyright \(co 2005 International Business Machines Corp -.br -This is free software; see the source for copying conditions. There is NO -warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -- generated by git-patchbot for /home/xen/git/xen.git#master _______________________________________________ Xen-changelog mailing list Xen-changelog@xxxxxxxxxxxxx http://lists.xensource.com/xen-changelog

©2013 Xen Project, A Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation.
Xen Project is a trademark of The Linux Foundation.