Xen Man Pages

This section contains link to Xen manual pages that are generated from the Xen codebase. They reflect the state of xen-unstable.hg. We do not yet have versions for specific Xen releases, but will have them in future

Wiki Man Pages

See Category:ManPage

All Generated Man Pages

See xenbits.xen.org/docs/unstable

Note that the pages below may miss some new documents. If you do not find what you are looking for: please check the link above!

Xen Configuration

Page	Description
Xen CLI	Command line options for Xen to be used in /boot/grub/grub.conf
EFI	Configuring Xen to work with EFI.

Xen Man Pages

Man page	Description	Console
Xen CLI (1)	Command line options for Xen to be used in /boot/grub/grub.conf	N/A
xl(1)	Xen management tool, based on LibXenlight	XL
xm(1)	Xen management user interface (to be deprecated, also see Xen 4.1 Upgrade Notes)	XM
xend-config.sxp(5)	Xen daemon configuration file (to be deprecated, also see Xen 4.1 Upgrade Notes)	XM
xl.cfg(5)	XL Domain Configuration File Syntax: to create a VM (a domain in Xen terminology, sometimes called a guest) with xl requires the provision of a domain config file.	XL
xl.conf(5)	XL Global/Host Configuration: allows configuration of hostwide xl toolstack options	XL
xlcpupool.cfg(5)	XL Cpupool Configuration File Syntax: to create a Cpupool with xl requires the provision of a cpupool config file.	XL
xmdomain.cfg(5)	XM domain config file format (to be deprecated, also see Xen 4.1 Upgrade Notes)	XM
xentop(1)	xentop displays information about the Xen system and domains, in a continually-updating manner.	XENTOP
xenpm(1)	Xenpm is a userspace tool that can list the power information of available processors and control the power policy according to users' preference.	XENPM

Supporting Documents for XL & XM

Document	Description
xl.cfg(5), disk configuration	This document specifies the xl config file format disk configuration option.
xl.cfg(5), network configuration	This document specifies the xl config file format vif configuration option.
xl.cfg(5), tsc_mode configuration	In Xen 4 a new config option called tsc_mode may be specified for each domain. This document is targeted for Xen users and administrators that may need to select a non-default tsc_mode.
xm.cfg(5), sEDF scheduler	The sEDF scheduler provides weighted CPU sharing in an intuitive way and uses realtime-algorithms to ensure time guarantees.

Other documents

Document	Description
Environment Variables for different Linux distros	With directory layout differences between Red Hat, Debian, Suse and other distros one needs to set the variables for CONFIG_LEAF_DIR, SUBSYS_DIR and INITD_DIR.

Advanced topics

Document(s)	Description	Also See
How to do PCI Passthrough with VT-d		Xen PCI Passthrough Overview, VT-d HowTo
Virtual TPM support	This document gives a short introduction to the virtual TPM support in XEN and goes as far as connecting a user domain to a virtual TPM instance and doing a short test to verify success. It is assumed that the user is fairly familiar with compiling and installing XEN and Linux on a machine.	Virtual Trusted Platform Module (research note)