Commit Graph
34 Commits
Author SHA1 Message Date
Ian Jackson e68ffca28b docs: Say in xm(1) that xm is obsolete
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
2011-12-08 16:55:00 +00:00
Keir Fraser 2a738c3fe1 tools: vnet: Remove
Build has been broken since at least 18969:d6889b3b6423 (early
2009) and it has been unhooked from the top level build since forever
AFAICT. The last actual development (as opposed to tree wide
cleanups and build fixes) appears to have been 11594:6d7bba6443ef in
2006. The functionality of vnet has apparently been superceded by
VLANs, ebtables, Ethernet-over-IP etc all of which are well integrated
with upstream kernels and distros.

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Signed-off-by: Keir Fraser <keir@xen.org>
2011-03-25 21:59:20 +00:00
Keir Fraser 6102cace93 Remove unmaintained Access Control Module (ACM) from hypervisor.
Signed-off-by: Keir Fraser <keir@xen.org>
2011-03-25 21:47:57 +00:00
Keir Fraser 9d1f137d16 Fix xm man page statement about asynchonous operation
The man page for xm command states that many commands acts
asynchronously which is not true. According to my experience most
commands does act synchronously with several exceptions, like create,
shutdown, mem-set and vcpu-set commands so this fixes the paragraph
available in this xm man page.

Signed-off-by: Michal Novotny <minovotn@redhat.com>
2010-06-02 10:49:35 +01:00
Keir Fraser 2450e3575f docs: Add detach console note to xm man page
I've been asked too many times about a hint in xm man page on how to
'detach' from a guest console - aka Ctrl+]

Signed-off-by: Jim Fehlig <jfehlig@novell.com>
2009-02-04 11:57:47 +00:00
Keir Fraser d2e81c31f8 xm docs: Added new,delete,dump-core,resume,suspend,uptime and fixed others
Signed-off-by: Bill Rieske <brieske@novell.com>
2008-09-24 10:17:18 +01:00
Keir Fraser 2c7a4f62dc Clarify 'xm mem-set' and 'xm vcpu-set' requirements in documentation.
From: Richard W.M. Jones <rjones@redhat.com>
Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
2008-01-18 13:43:26 +00:00
Keir Fraser 653ceb13b7 Minor correction in xm man page for 'xm create'.
From: Richard W.M. Jones <rjones@redhat.com>
Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
2008-01-17 15:21:35 +00:00
Keir Fraser 0ea4d2fb34 Implement legacy XML-RPC interface for ACM commands.
This patch implements a (non Xen-API) legacy XML-RPC interface for the
ACM commands and funnels the calls into code introduced by the Xen-API
support for ACM security management. Since some of the functionality
has changed, also the xm applications have changed. In particular the
following old commands have been removed along with some tools the
have become obsolete now:

- loadpolicy    (included in: setpolicy)
- makepolicy    (included in: setpolicy)
- cfgbootpolicy (included in: setpolicy)

and the following commands been introduced:

- setpolicy
- getpolicy
- resetpolicy

All tools have been adapted to work in Xen-API and legacy XML-RPC
mode. Both modes support the same functionality.

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2007-12-05 09:44:20 +00:00
Keir Fraser 07f557cb63 Replace sysctl.physinfo.sockets_per_node with more directly useful
sysctl.physinfo.nr_cpus. This also avoids miscalculation of
sockets_per_node by Xen where the number of CPUs in the system is
clipped.
From: Elizabeth Kon <eak@us.ibm.com>
Signed-off-by: Keir Fraser <keir@xensource.com>
2007-10-19 18:00:10 +01:00
kfraser@localhost.localdomain 3eb4247336 [MAN] Explanation of recent extensions to xm security subcommands
Signed-off-by: Stefan Berger <stefanb@usa.ibm.com>
2007-07-19 17:18:20 +01:00
kfraser@localhost.localdomain 49562f1285 docs: update xm man page
- Fixed description of "Mem" column in "xm list" output.
- Added a bit of text for the credit scheduler.
- Described the --force option to block-detach.
- Made formatting and spelling more consistent.
- etc...

Signed-off-by:  Charles Coffing <ccoffing@novell.com>
2007-07-06 14:45:02 +01:00
kfraser@localhost.localdomain e101034b6c Remove non-ASCII chars in man page.
Signed-off-by: Charles Coffing <ccoffing@novell.com>
2007-04-26 09:52:34 +01:00
kfraser@localhost.localdomain dce5dbf051 Simple fix to the man page for xm block-attach.
It currently says to use "ro" or "rw" for the mode, when it seems,
empirically, to take "r" or "w" for the mode, respectively.  Update
the man page to reflect that.

Signed-off-by: Chris Lalancette <clalance@redhat.com>
2007-03-10 16:59:57 +00:00
kfraser@localhost.localdomain edf5361fb2 Add scheduler name to 'xm info' output.
Signed-off-by: Masaki Kanno <kanno.masaki@jp.fujitsu.com>
2007-01-17 14:54:06 +00:00
kfraser@localhost.localdomain a75c9af600 Use the name of the title of the system to boot into (instead of the
kernel version) to determine where to make the entry into the grub
configuration file.

Signed-off-by: Reiner Sailer <sailer@us.ibm.com>
Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2006-10-20 09:32:16 +01:00
Emmanuel Ackaouy 7ccdaed2ed Adds support for the keyword 'all' to the vcpu-pin operation.
Using 'all' in place of a specific vcpu will apply the cpumask
to all vcpus in the domain.
Signed-off-by: Ryan Harper <ryanh@us.ibm.com>
2006-09-26 12:17:51 +01:00
Ewan Mellor 9ad71b6de8 This patch intends for updating "man xm" about xm info description.
For example item:system is removed from xm info.

Signed-off-by: shaocyou <shaocyou@jp.fujitsu.com>
2006-09-05 16:48:21 +01:00
kfraser@localhost.localdomain db51cd09d3 Remove all traces of the obsolete BVT scheduler.
Signed-off-by: Keir Fraser <keir@xensource.com>
2006-08-23 17:14:38 +01:00
emellor@leeni.uk.xensource.com bc6220c199 This patch adds new xm subcommands to support working with resource
labels.  The new subcommands are 'xm resources', 'xm rmlabel', 'xm
getlabel' and 'xm dry-run'.  In addition, the 'xm addlabel' subcommand
now uses an updated syntax to support labeling both domains and
resources.  See the xm man page for details on each subcommand.

Beyond the new subcommands, this patch allows users to immediately see
when security checks will fail by pushing some basic security checking
into the beginning of 'xm create' and 'xm block-attach'.  ACM security
attributes for block devices are added to XenStore in order to support
the final security enforcement, which will be performed in the kernel
and included in a separate patch.

Signed-off-by: Bryan D. Payne <bdpayne@us.ibm.com>
Signed-off-by: Reiner Sailer <sailer@us.ibm.com>
2006-06-28 16:05:27 +01:00
kaf24@firebug.cl.cam.ac.uk c60d2bbfac Fix spelling errors in man pages.
Signed-off-by: Charles Coffing <ccoffing@novell.com>
2006-05-15 07:51:07 +01:00
smh22@firebug.cl.cam.ac.uk 655ead6573 This patch updates the documentation and extends the 'xm' man page with
the integrated access control management commands. The man page is a 
good place to start exploring these commands.

Signed-off by: Reiner Sailer <sailer@us.ibm.com>
2006-04-24 10:59:57 +01:00
kaf24@firebug.cl.cam.ac.uk 840ac8df5a Changed deprecated "set-vcpus" to "vcpu-set" in the xm man page.
Signed-off-by:  Charles Coffing <ccoffing@novell.com>
2006-04-01 10:50:58 +01:00
emellor@leeni.uk.xensource.com dd3606b160 Attached patch updates the xm man page for the listing of
block/network/vtpm devices.

Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
2006-02-17 23:00:05 +01:00
maf46@burn.cl.cam.ac.uk 232f69bfdd Minor documentation fix 2006-01-17 16:06:03 +01:00
sean@dague.net 829e31bad5 added block device content, including finding a few more bugs in xen 2005-11-18 12:58:16 +01:00
emellor@leeni.uk.xensource.com 8add0c9fed This patch explains network-* options in xm.1, including the bits that are
currently not really working.

Signed off by: Sean Dague <sean@dague.net>
2005-11-17 12:01:13 +01:00
emellor@leeni.uk.xensource.com cb248d6b16 The following patch removes every (hopefully) reference to network-limit.
Upon further investigation it sets Device parameters that don't exist any
longer, thus causing exceptions.  As it looks like this is completely
obsolete, and no one is actively working on it, we should just rip it out to
end the confusion.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-16 11:31:57 +01:00
emellor@leeni.uk.xensource.com 0e9ceb580a This patch is largely stylistic, and gets rid of StuddlyCaps formatting in
all the param variables, make consistant use of bold and italics in the the
man pages to make it easier to read, and adds a few minor content additions.
It makes actually reading the man page a lot easier.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:36:42 +01:00
emellor@leeni.uk.xensource.com 92c71aea0d This patch adds more content around the scheduler portions of the xm.1 man
page.  Most of this content came from the xensource wiki or the sedf doc in
the Xen tree.  It still needs more work, but it is a good first start.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:27:48 +01:00
emellor@leeni.uk.xensource.com c7509dd6cc This patch is another in the continued effort to flesh out the man pages, it
adds pretty reasonable text to most of the code xen domain and host commands
(device and scheduler will come in the future).

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-15 15:26:37 +01:00
emellor@leeni.uk.xensource.com aeedebd423 Further changes to xm.1 man page.
Signed-off-by: Sean Dague <sean@dague.net>
2005-11-12 18:52:16 +01:00
emellor@leeni.uk.xensource.com 23b53644ac The following patch is work in progress to add more meat to the xm.1 man
page.  Expect more content to trickle in over time.

Signed-off-by: Sean Dague <sean@dague.net>
2005-11-12 18:32:19 +01:00
emellor@leeni.uk.xensource.com 94608ed8f3 --- xen-unstable.hg.copy/docs/Makefile 2005-10-28 18:36:33.000000000 -0700
+++ xen-unstable.hg/docs/Makefile	2005-10-28 14:58:18.000000000 -0700
@@ -1,5 +1,6 @@
 #!/usr/bin/make -f

+VERSION		= xen-unstable
 INSTALL		= install
 INSTALL_DIR	= $(INSTALL) -d -m0755

@@ -9,9 +10,15 @@
 FIG2DEV		:= fig2dev
 LATEX2HTML	:= latex2html
 DOXYGEN		:= doxygen
+POD2MAN		:= pod2man

 pkgdocdir	:= /usr/share/doc/xen
+mandir		:= /usr/share/man

+DOC_MAN5SRC	:= $(wildcard man/*.pod.5)
+DOC_MAN1SRC	:= $(wildcard man/*.pod.1)
+DOC_MAN1	:= $(patsubst man/%.pod.1,man1/%.1,$(DOC_MAN1SRC))
+DOC_MAN5	:= $(patsubst man/%.pod.5,man5/%.5,$(DOC_MAN5SRC))
 DOC_TEX		:= src/user.tex src/interface.tex
 DOC_PS		:= $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
 DOC_PDF		:= $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
@@ -22,7 +29,7 @@
 .PHONY:	all build dev-docs python-dev-docs ps pdf html clean install

 all: build
-build: ps pdf html
+build: ps pdf html man-pages
 	rm -f *.aux *.dvi *.bbl *.blg *.glo *.idx *.ilg *.log *.ind *.toc

 dev-docs: python-dev-docs
@@ -43,17 +50,36 @@
 	$(MAKE) -C api/tools/python/latex ; else                   \
         echo "Doxygen not installed; skipping python-dev-docs."; fi

+man-pages:
+	@if which $(POD2MAN) 1>/dev/null 2>/dev/null; then \
+	$(MAKE) $(DOC_MAN1) $(DOC_MAN5); fi
+
+man1/%.1: man/%.pod.1 Makefile
+	$(INSTALL_DIR) $(@D)
+	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man1.//'| \
+		sed 's/.1//'` -s 1 -c "Xen" $< $@
+
+man5/%.5: man/%.pod.5 Makefile
+	$(INSTALL_DIR) $(@D)
+	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man5.//'| \
+		sed 's/.5//'` -s 5 -c "Xen" $< $@
+
 clean:
 	rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~
 	rm -rf *.ilg *.log *.ind *.toc *.bak core
 	rm -rf $(GFX) ps pdf html
 	rm -rf api
+	rm -rf man5
+	rm -rf man1

 install: all
 	rm -rf $(DESTDIR)$(pkgdocdir)
 	$(INSTALL_DIR) $(DESTDIR)$(pkgdocdir)
 	cp -dR ps $(DESTDIR)$(pkgdocdir)
 	cp -dR pdf $(DESTDIR)$(pkgdocdir)
+	$(INSTALL_DIR) $(DESTDIR)$(mandir)
+	cp -dR man1 $(DESTDIR)$(mandir)
+	cp -dR man5 $(DESTDIR)$(mandir)
 	[ ! -d html ] || cp -dR html $(DESTDIR)$(pkgdocdir)

 pdf/%.pdf: ps/%.ps
2005-10-30 17:20:09 +01:00