direct-io.hg

changeset 7563:d49fd494963e

--- 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
author emellor@leeni.uk.xensource.com
date Sun Oct 30 17:20:09 2005 +0100 (2005-10-30)
parents c774efa2aca8
children 127d856ce124
files docs/Makefile docs/man/xm.pod.1 docs/man/xmdomain.cfg.pod.5
line diff
     1.1 --- a/docs/Makefile	Sun Oct 30 17:19:35 2005 +0100
     1.2 +++ b/docs/Makefile	Sun Oct 30 17:20:09 2005 +0100
     1.3 @@ -1,5 +1,6 @@
     1.4  #!/usr/bin/make -f
     1.5  
     1.6 +VERSION		= xen-unstable
     1.7  INSTALL		= install
     1.8  INSTALL_DIR	= $(INSTALL) -d -m0755
     1.9  
    1.10 @@ -9,9 +10,15 @@ LATEX		:= latex
    1.11  FIG2DEV		:= fig2dev
    1.12  LATEX2HTML	:= latex2html
    1.13  DOXYGEN		:= doxygen
    1.14 +POD2MAN		:= pod2man
    1.15  
    1.16  pkgdocdir	:= /usr/share/doc/xen
    1.17 +mandir		:= /usr/share/man
    1.18  
    1.19 +DOC_MAN5SRC	:= $(wildcard man/*.pod.5)
    1.20 +DOC_MAN1SRC	:= $(wildcard man/*.pod.1)
    1.21 +DOC_MAN1	:= $(patsubst man/%.pod.1,man1/%.1,$(DOC_MAN1SRC))
    1.22 +DOC_MAN5	:= $(patsubst man/%.pod.5,man5/%.5,$(DOC_MAN5SRC))
    1.23  DOC_TEX		:= src/user.tex src/interface.tex
    1.24  DOC_PS		:= $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
    1.25  DOC_PDF		:= $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
    1.26 @@ -22,7 +29,7 @@ GFX = $(patsubst %.fig, %.eps, $(wildcar
    1.27  .PHONY:	all build dev-docs python-dev-docs ps pdf html clean install
    1.28  
    1.29  all: build
    1.30 -build: ps pdf html
    1.31 +build: ps pdf html man-pages
    1.32  	rm -f *.aux *.dvi *.bbl *.blg *.glo *.idx *.ilg *.log *.ind *.toc
    1.33  
    1.34  dev-docs: python-dev-docs
    1.35 @@ -43,17 +50,36 @@ python-dev-docs:
    1.36  	$(MAKE) -C api/tools/python/latex ; else                   \
    1.37          echo "Doxygen not installed; skipping python-dev-docs."; fi
    1.38  
    1.39 +man-pages:
    1.40 +	@if which $(POD2MAN) 1>/dev/null 2>/dev/null; then \
    1.41 +	$(MAKE) $(DOC_MAN1) $(DOC_MAN5); fi
    1.42 +
    1.43 +man1/%.1: man/%.pod.1 Makefile
    1.44 +	$(INSTALL_DIR) $(@D)
    1.45 +	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man1.//'| \
    1.46 +		sed 's/.1//'` -s 1 -c "Xen" $< $@
    1.47 +
    1.48 +man5/%.5: man/%.pod.5 Makefile
    1.49 +	$(INSTALL_DIR) $(@D)
    1.50 +	$(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man5.//'| \
    1.51 +		sed 's/.5//'` -s 5 -c "Xen" $< $@
    1.52 +
    1.53  clean:
    1.54  	rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~ 
    1.55  	rm -rf *.ilg *.log *.ind *.toc *.bak core
    1.56  	rm -rf $(GFX) ps pdf html
    1.57  	rm -rf api
    1.58 +	rm -rf man5
    1.59 +	rm -rf man1
    1.60  
    1.61  install: all
    1.62  	rm -rf $(DESTDIR)$(pkgdocdir)
    1.63  	$(INSTALL_DIR) $(DESTDIR)$(pkgdocdir)
    1.64  	cp -dR ps $(DESTDIR)$(pkgdocdir)
    1.65  	cp -dR pdf $(DESTDIR)$(pkgdocdir)
    1.66 +	$(INSTALL_DIR) $(DESTDIR)$(mandir)
    1.67 +	cp -dR man1 $(DESTDIR)$(mandir)
    1.68 +	cp -dR man5 $(DESTDIR)$(mandir)
    1.69  	[ ! -d html ] || cp -dR html $(DESTDIR)$(pkgdocdir)
    1.70  
    1.71  pdf/%.pdf: ps/%.ps
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/docs/man/xm.pod.1	Sun Oct 30 17:20:09 2005 +0100
     2.3 @@ -0,0 +1,254 @@
     2.4 +=head1 NAME
     2.5 +
     2.6 +xm - Xen management user interface
     2.7 +
     2.8 +=head1 SYNOPSIS
     2.9 +
    2.10 +xm <subcommand> [args]
    2.11 +
    2.12 +=head1 DESCRIPTION
    2.13 +
    2.14 +The B<xm> program is the main interface for managing Xen guest domains. The program can be used to create, pause, and shutdown domains. It can also be used to list current domains, enable or pin VCPUs, and attach or detach virtual block devices. The B<xm> program relies upon B<xend>. The daemon must be running in order for the program to work.
    2.15 +
    2.16 +Domain name <DomName> can be substituted in the subcommands for Domain id <DomId>.
    2.17 +
    2.18 +=head1 DOMAIN SUBCOMMANDS
    2.19 +
    2.20 +=over 4
    2.21 +
    2.22 +=item I<console> <DomId>
    2.23 +
    2.24 +Attach to domain DomId's console.
    2.25 +
    2.26 +=item I<create> <CfgFile>
    2.27 +
    2.28 +Create a domain based on B<xmdomain.cfg> configuration file.
    2.29 +
    2.30 +=item I<destroy> <DomId>
    2.31 +
    2.32 +Terminate domain DomId immediately.
    2.33 +
    2.34 +=item I<domid> <DomName>
    2.35 +
    2.36 +Converts a domain name to a domain id.
    2.37 +
    2.38 +=item I<domname> <DomId>
    2.39 +
    2.40 +Converts a domain id to a domain name.
    2.41 +
    2.42 +=item I<help> [--long]
    2.43 +
    2.44 +Displays command's help message. The long option prints out the complete set of B<xm> subcommands.
    2.45 +
    2.46 +=item I<list> [DomId, ...]
    2.47 +
    2.48 +List information about domains.
    2.49 +
    2.50 +=item I<mem-max> <DomId> <Mem>
    2.51 +
    2.52 +Set domain maximum memory limit to Mem. Mem is in Megabytes. This is the upper memory mark for how much memory a domain can have.
    2.53 +
    2.54 +=item I<mem-set> <DomId> <Mem>
    2.55 +
    2.56 +Set domain's memory, in Megabytes. Mem must be less than or equal to the maximum memory for the domain.
    2.57 +
    2.58 +=item I<migrate> <DomId> <Host> [Options]
    2.59 +
    2.60 +Migrate a domain to another Host machine. B<Xend> must be running on other host machine and there must be sufficient resources as well.
    2.61 +
    2.62 +=over 4
    2.63 +
    2.64 +Additional Options:
    2.65 +
    2.66 +    -l, --live                    Use live migration.
    2.67 +    -r, --resource <Mbit value>   Set resource level.
    2.68 +
    2.69 +=back
    2.70 +
    2.71 +=item I<pause> <DomId>
    2.72 +
    2.73 +Pause a domain's execution.
    2.74 +
    2.75 +=item I<reboot> [Options] <DomId>
    2.76 +
    2.77 +Reboot a domain.
    2.78 +
    2.79 +=over 4
    2.80 +
    2.81 +Additional Options:
    2.82 +
    2.83 +    -a, --all        reboot all domains.
    2.84 +    -w, --wait       Wait for shutdown to complete.
    2.85 +
    2.86 +=back
    2.87 +
    2.88 +=item I<restore> <File>
    2.89 +
    2.90 +Create a domain from saved state File.
    2.91 +
    2.92 +=item I<save> <DomId> <File>
    2.93 +
    2.94 +Save domain state to File. Saves domain configuration to File as well.
    2.95 +
    2.96 +=item I<shutdown> [Options] <DomId>
    2.97 +
    2.98 +Shutdown a domain.
    2.99 +
   2.100 +=over 4
   2.101 +
   2.102 +Additional Options:
   2.103 +
   2.104 +    -a, --all        Shutdown all domains.
   2.105 +    -H, --halt       Shutdown domain without reboot.
   2.106 +    -R, --reboot     Shutdown and reboot domain.
   2.107 +    -w, --wait       Wait for shutdown to complete.
   2.108 +
   2.109 +=back
   2.110 +
   2.111 +=item I<sysrq> <DomId> <letter>
   2.112 +
   2.113 +Send a sysrq to a domain.
   2.114 +
   2.115 +=item I<unpause> <DomId>
   2.116 +
   2.117 +Unpause a paused domain.
   2.118 +
   2.119 +=item I<set-vcpus> <DomId> <VCPUs>
   2.120 +
   2.121 +Enable a specific number of VCPUs for a domain. Subcommand only enables or disables already configured VCPUs for domain.
   2.122 +
   2.123 +=item I<vpcu-list> [DomID]
   2.124 +
   2.125 +Lists VCPU information for a specific domain or all domains if DomID not given.
   2.126 +
   2.127 +=item I<vcpu-pin> <DomId> <VCPU> <CPUs>
   2.128 +
   2.129 +Sets VCPU to only run on specific CPUs.
   2.130 +
   2.131 +=back
   2.132 +
   2.133 +=head1 XEN HOST SUBCOMMANDS
   2.134 +
   2.135 +=over 4
   2.136 +
   2.137 +=item I<dmesg> [OPTION]
   2.138 +
   2.139 +Read or clear Xen's message buffer. The buffer contains Xen boot, warning, and error messages.
   2.140 +
   2.141 +=over 4
   2.142 +
   2.143 +Additional Option:
   2.144 +
   2.145 +    -c, --clear        Clears Xen's message buffer.
   2.146 +
   2.147 +=back
   2.148 +
   2.149 +=item I<info>
   2.150 +
   2.151 +Get information about Xen host.
   2.152 +
   2.153 +=item I<log>
   2.154 +
   2.155 +Print B<xend> log.
   2.156 +
   2.157 +=item I<top>
   2.158 +
   2.159 +Monitor system and domains in real-time.
   2.160 +
   2.161 +=back
   2.162 +
   2.163 +=head1 SCHEDULER SUBCOMMANDS
   2.164 +
   2.165 +=over 4
   2.166 +
   2.167 +=item I<sched-bvt> <Parameters>
   2.168 +
   2.169 +Set Borrowed Virtual Time (BVT) scheduler parameters. There are five parameters, which are given in order below.
   2.170 +
   2.171 +=over 4
   2.172 +
   2.173 +Parameters:
   2.174 +
   2.175 +    mcuadv - Minimum Charging Unit (MCU) advance.
   2.176 +    warpback - Warp back time allowed.
   2.177 +    warpvalue - Warp value.
   2.178 +    warpl - Warp maximum limit.
   2.179 +    warpu - Unwarped minimum limit.
   2.180 +
   2.181 +=back 
   2.182 +
   2.183 +=item I<sched-bvt-ctxallow> <Allow>
   2.184 +
   2.185 +Sets the BVT scheduler's context switch allowance. Allow is the minimum time slice allowed to run before being pre-empted.
   2.186 +
   2.187 +=item I<sched-sedf> <Parameters>
   2.188 +
   2.189 +Set simple sEDF scheduler parameters. Use the following parametersin order.
   2.190 +
   2.191 +=over 4
   2.192 +
   2.193 +Parameters:
   2.194 +
   2.195 +    period - in nanoseconds
   2.196 +    slice - in nanoseconds
   2.197 +    latency-hint - scaled period if domain is doing heavy I/O
   2.198 +    extratime - flag for allowing domain to run in extra time.
   2.199 +    weight - another way of setting cpu slice.
   2.200 +
   2.201 +=back
   2.202 +
   2.203 +=back
   2.204 +
   2.205 +=head1 VIRTUAL DEVICE COMMANDS
   2.206 +
   2.207 +=over 4
   2.208 +
   2.209 +=item I<block-attach <DomId> <BackDev> <FrontDev> <Mode> [BackDomId]
   2.210 +
   2.211 +Create a new virtual block device.
   2.212 +
   2.213 +=item I<block-detach> <DomId> <DevId>
   2.214 +
   2.215 +Destroy a domain's virtual block device. DevId may either be a device ID or the device name as mounted in the guest.
   2.216 +
   2.217 +=item I<block-list> <DomId>
   2.218 +
   2.219 +List virtual block devices for a domain.
   2.220 +
   2.221 +=item I<network-limit> <DomId> <Vif> <Credit> <Period>
   2.222 +
   2.223 +Limit the transmission rate of a virtual network interface.
   2.224 +
   2.225 +=item I<network-list> <DomId>
   2.226 +
   2.227 +List virtual network interfaces for a domain.
   2.228 +
   2.229 +=back
   2.230 +
   2.231 +=head1 VNET COMMANDS
   2.232 +
   2.233 +=over 4
   2.234 +
   2.235 +=item I<vnet-list> [-l|--long]
   2.236 +
   2.237 +List vnets.
   2.238 +
   2.239 +=item I<vnet-create> <config>
   2.240 +
   2.241 +Create a vnet from a config file.
   2.242 +
   2.243 +=item I<vnet-delete> <vnetid>
   2.244 +
   2.245 +Delete a vnet.
   2.246 +
   2.247 +=back
   2.248 +
   2.249 +=head1 SEE ALSO
   2.250 +
   2.251 +B<xmdomain.cfg>(5)
   2.252 +
   2.253 +=head1 AUTHOR
   2.254 +
   2.255 +  Daniel Stekloff <dsteklof at us dot ibm dot com>
   2.256 +
   2.257 +=head1 BUGS
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/docs/man/xmdomain.cfg.pod.5	Sun Oct 30 17:20:09 2005 +0100
     3.3 @@ -0,0 +1,87 @@
     3.4 +=head1 NAME
     3.5 +
     3.6 +xmdomain.cfg - xm domain create config file format
     3.7 +
     3.8 +=head1 SYNOPSIS
     3.9 +
    3.10 + /etc/xen/myxendomain
    3.11 + /etc/xen/myxendomain2
    3.12 + /etc/xen/auto/myxenautostarted
    3.13 +
    3.14 +=head1 DESCRIPTION
    3.15 +
    3.16 +The xm(1) program uses python executable config files to define
    3.17 +domains to create from scratch.  Each of these config files needs to
    3.18 +contain a number of required options, and may specify many more.
    3.19 +
    3.20 +Domain configuration files live in /etc/xen by default, though the
    3.21 +full path to the config file must be specified in the I<xm create>
    3.22 +command, so they can exist anywhere in the filesystem.
    3.23 +
    3.24 +/etc/xen/auto is a special case however, as domain config files in
    3.25 +that directory will be started automatically at system boot if the
    3.26 +xendomain init script is enabled.
    3.27 +
    3.28 +=head1 OPTIONS
    3.29 +
    3.30 +The following lists the most commonly used options for a domain config
    3.31 +file.  
    3.32 +
    3.33 +=over 4
    3.34 +
    3.35 +=item I<kernel>
    3.36 +
    3.37 +The kernel image used in the domain.
    3.38 +
    3.39 +=item I<ramdisk>
    3.40 +
    3.41 +The initial ramdisk to be used in the domain.  Default xen domU
    3.42 +kernels do not usually need a ramdisk.
    3.43 +
    3.44 +=item I<memory>
    3.45 +
    3.46 +The amount of memory, in megabytes to allocate to the domain when it
    3.47 +starts.  Allocating insufficient memory for a domain may produce
    3.48 +extremely bizarre behavior.
    3.49 +
    3.50 +=item I<name>
    3.51 +
    3.52 +A unique name for the domain.  You can not create 2 domains with the
    3.53 +same name.
    3.54 +
    3.55 +=item I<root>
    3.56 +
    3.57 +Root stanza for the domain (required for Linux domains).
    3.58 +
    3.59 +=item I<disk>
    3.60 +
    3.61 +An array of disk stanzas 
    3.62 +
    3.63 +=back
    3.64 +
    3.65 +A bare minimal config file example might be as follows:
    3.66 +
    3.67 +    kernel = "/boot/vmlinuz-2.6-xenU"
    3.68 +    memory = 128
    3.69 +    name = "MyLinux"      
    3.70 +    root = "/dev/hda1 ro"
    3.71 +
    3.72 +=head1 ADDITIONAL OPTIONS
    3.73 +
    3.74 +=over 4
    3.75 +
    3.76 +=item I<builder>
    3.77 +
    3.78 +=back
    3.79 +
    3.80 +=head1 SEE ALSO
    3.81 +
    3.82 +B<xm>(1)
    3.83 +
    3.84 +=head1 AUTHOR
    3.85 +
    3.86 +  Sean Dague <sean at dague dot net>
    3.87 +
    3.88 +=head1 BUGS
    3.89 +
    3.90 +Not all options are currently documented