diff options
author | emellor@leeni.uk.xensource.com <emellor@leeni.uk.xensource.com> | 2005-10-30 17:20:09 +0100 |
---|---|---|
committer | emellor@leeni.uk.xensource.com <emellor@leeni.uk.xensource.com> | 2005-10-30 17:20:09 +0100 |
commit | 94608ed8f30caf1ccd26df5f223f7806121f7f8e (patch) | |
tree | b5a8fa643d35aa0d4ff8522846a3d99dcd84c427 /docs/man/xmdomain.cfg.pod.5 | |
parent | 6bcc179281bd6cc548b147b213c3c8d2d77cc36e (diff) | |
download | xen-94608ed8f30caf1ccd26df5f223f7806121f7f8e.tar.gz xen-94608ed8f30caf1ccd26df5f223f7806121f7f8e.tar.bz2 xen-94608ed8f30caf1ccd26df5f223f7806121f7f8e.zip |
--- 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
Diffstat (limited to 'docs/man/xmdomain.cfg.pod.5')
-rw-r--r-- | docs/man/xmdomain.cfg.pod.5 | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/docs/man/xmdomain.cfg.pod.5 b/docs/man/xmdomain.cfg.pod.5 new file mode 100644 index 0000000000..b1c661ee87 --- /dev/null +++ b/docs/man/xmdomain.cfg.pod.5 @@ -0,0 +1,87 @@ +=head1 NAME + +xmdomain.cfg - xm domain create config file format + +=head1 SYNOPSIS + + /etc/xen/myxendomain + /etc/xen/myxendomain2 + /etc/xen/auto/myxenautostarted + +=head1 DESCRIPTION + +The xm(1) program uses python executable config files to define +domains to create from scratch. Each of these config files needs to +contain a number of required options, and may specify many more. + +Domain configuration files live in /etc/xen by default, though the +full path to the config file must be specified in the I<xm create> +command, so they can exist anywhere in the filesystem. + +/etc/xen/auto is a special case however, as domain config files in +that directory will be started automatically at system boot if the +xendomain init script is enabled. + +=head1 OPTIONS + +The following lists the most commonly used options for a domain config +file. + +=over 4 + +=item I<kernel> + +The kernel image used in the domain. + +=item I<ramdisk> + +The initial ramdisk to be used in the domain. Default xen domU +kernels do not usually need a ramdisk. + +=item I<memory> + +The amount of memory, in megabytes to allocate to the domain when it +starts. Allocating insufficient memory for a domain may produce +extremely bizarre behavior. + +=item I<name> + +A unique name for the domain. You can not create 2 domains with the +same name. + +=item I<root> + +Root stanza for the domain (required for Linux domains). + +=item I<disk> + +An array of disk stanzas + +=back + +A bare minimal config file example might be as follows: + + kernel = "/boot/vmlinuz-2.6-xenU" + memory = 128 + name = "MyLinux" + root = "/dev/hda1 ro" + +=head1 ADDITIONAL OPTIONS + +=over 4 + +=item I<builder> + +=back + +=head1 SEE ALSO + +B<xm>(1) + +=head1 AUTHOR + + Sean Dague <sean at dague dot net> + +=head1 BUGS + +Not all options are currently documented |