aboutsummaryrefslogtreecommitdiffstats
path: root/docs/man/xm.pod.1
Commit message (Collapse)AuthorAgeFilesLines
* docs: Fix minor error in xm man pageGeorge Dunlap2013-07-171-1/+1
| | | | | | | | | xm block-attach takes "r" as read-only, not "ro". This is a backport candidate for 4.3, and probably others. Signed-off-by: George Dunlap <george.dunlap@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com>
* docs: Make note for the scheduler "cap" option warning about power ↵George Dunlap2013-06-121-0/+13
| | | | | | | | | management effects Suggested-by: Massimo Canonico <mex@di.unipmn.it> Signed-off-by: George Dunlap <george.dunlap@eu.citrix.com> Reviewed-by: Dario Faggioli <dario.faggioli@citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com>
* xend: Remove old vtpm support from xmMatthew Fioravante2012-11-191-11/+0
| | | | | | Signed-off-by: Matthew Fioravante <matthew.fioravante@jhuapl.edu> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Campbell <ian.campbell@citrix.com>
* docs: various typosTim Deegan2012-06-281-2/+2
| | | | | | Signed-off-by: Tim Deegan <tim@xen.org> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* docs: Say in xm(1) that xm is obsoleteIan Jackson2011-12-081-5/+9
| | | | | Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com>
* tools: vnet: RemoveKeir Fraser2011-03-251-23/+0
| | | | | | | | | | | | | 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>
* Remove unmaintained Access Control Module (ACM) from hypervisor.Keir Fraser2011-03-251-378/+0
| | | | Signed-off-by: Keir Fraser <keir@xen.org>
* Fix xm man page statement about asynchonous operationKeir Fraser2010-06-021-6/+4
| | | | | | | | | | 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>
* docs: Add detach console note to xm man pageKeir Fraser2009-02-041-0/+2
| | | | | | | 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>
* xm docs: Added new,delete,dump-core,resume,suspend,uptime and fixed othersKeir Fraser2008-09-241-38/+268
| | | | Signed-off-by: Bill Rieske <brieske@novell.com>
* Clarify 'xm mem-set' and 'xm vcpu-set' requirements in documentation.Keir Fraser2008-01-181-3/+10
| | | | | From: Richard W.M. Jones <rjones@redhat.com> Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
* Minor correction in xm man page for 'xm create'.Keir Fraser2008-01-171-1/+1
| | | | | From: Richard W.M. Jones <rjones@redhat.com> Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
* Implement legacy XML-RPC interface for ACM commands.Keir Fraser2007-12-051-37/+24
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* Replace sysctl.physinfo.sockets_per_node with more directly usefulKeir Fraser2007-10-191-1/+0
| | | | | | | | 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>
* [MAN] Explanation of recent extensions to xm security subcommandskfraser@localhost.localdomain2007-07-191-44/+95
| | | | Signed-off-by: Stefan Berger <stefanb@usa.ibm.com>
* docs: update xm man pagekfraser@localhost.localdomain2007-07-061-127/+162
| | | | | | | | | | - 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>
* Remove non-ASCII chars in man page.kfraser@localhost.localdomain2007-04-261-9/+9
| | | | Signed-off-by: Charles Coffing <ccoffing@novell.com>
* Simple fix to the man page for xm block-attach.kfraser@localhost.localdomain2007-03-101-1/+1
| | | | | | | | 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>
* Add scheduler name to 'xm info' output.kfraser@localhost.localdomain2007-01-171-1/+2
| | | | Signed-off-by: Masaki Kanno <kanno.masaki@jp.fujitsu.com>
* Use the name of the title of the system to boot into (instead of thekfraser@localhost.localdomain2006-10-201-2/+2
| | | | | | | | 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>
* Adds support for the keyword 'all' to the vcpu-pin operation.Emmanuel Ackaouy2006-09-261-1/+3
| | | | | | 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>
* This patch intends for updating "man xm" about xm info description.Ewan Mellor2006-09-051-3/+4
| | | | | | | | For example item:system is removed from xm info. Signed-off-by: shaocyou <shaocyou@jp.fujitsu.com>
* Remove all traces of the obsolete BVT scheduler.kfraser@localhost.localdomain2006-08-231-55/+0
| | | | Signed-off-by: Keir Fraser <keir@xensource.com>
* This patch adds new xm subcommands to support working with resourceemellor@leeni.uk.xensource.com2006-06-281-8/+85
| | | | | | | | | | | | | | | | | | | 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>
* Fix spelling errors in man pages.kaf24@firebug.cl.cam.ac.uk2006-05-151-9/+9
| | | | | Signed-off-by: Charles Coffing <ccoffing@novell.com>
* This patch updates the documentation and extends the 'xm' man page with smh22@firebug.cl.cam.ac.uk2006-04-241-1/+270
| | | | | | | | | 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>
* Changed deprecated "set-vcpus" to "vcpu-set" in the xm man page.kaf24@firebug.cl.cam.ac.uk2006-04-011-3/+3
| | | | | | Signed-off-by: Charles Coffing <ccoffing@novell.com>
* Attached patch updates the xm man page for the listing ofemellor@leeni.uk.xensource.com2006-02-171-4/+11
| | | | | | | block/network/vtpm devices. Signed-off-by: Stefan Berger <stefanb@us.ibm.com>
* Minor documentation fixmaf46@burn.cl.cam.ac.uk2006-01-171-1/+1
|
* added block device content, including finding a few more bugs in xensean@dague.net2005-11-181-4/+54
|
* This patch explains network-* options in xm.1, including the bits that areemellor@leeni.uk.xensource.com2005-11-171-5/+48
| | | | | | | currently not really working. Signed off by: Sean Dague <sean@dague.net>
* The following patch removes every (hopefully) reference to network-limit.emellor@leeni.uk.xensource.com2005-11-161-4/+0
| | | | | | | | | | 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>
* This patch is largely stylistic, and gets rid of StuddlyCaps formatting inemellor@leeni.uk.xensource.com2005-11-151-89/+107
| | | | | | | | | 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>
* This patch adds more content around the scheduler portions of the xm.1 manemellor@leeni.uk.xensource.com2005-11-151-20/+103
| | | | | | | | 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>
* This patch is another in the continued effort to flesh out the man pages, itemellor@leeni.uk.xensource.com2005-11-151-26/+140
| | | | | | | | 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>
* Further changes to xm.1 man page.emellor@leeni.uk.xensource.com2005-11-121-20/+138
| | | | | Signed-off-by: Sean Dague <sean@dague.net>
* The following patch is work in progress to add more meat to the xm.1 manemellor@leeni.uk.xensource.com2005-11-121-11/+123
| | | | | | | page. Expect more content to trickle in over time. Signed-off-by: Sean Dague <sean@dague.net>
* --- xen-unstable.hg.copy/docs/Makefile 2005-10-28 18:36:33.000000000 -0700emellor@leeni.uk.xensource.com2005-10-301-0/+254
+++ 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