Xen Project 4.7 Man Pages

= Xen Project Configuration =
Page 	Description
Xen Project CLI	Command line options for Xen Project software to be used in /boot/grub/grub.conf
EFI 	Configuring Xen Project software to work with EFI.
= Xen Project Man Pages =
Man page 	Description 	Console
xl(1) 	Xen Project management tool, based on LibXenlight 	XL
xl.cfg(5) 	XL Domain Configuration File Syntax: to create a VM (a domain in Xen Project 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
xentop(1) 	xentop displays information about the Xen Project 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
xenstore(1) 	Xenstore holds configuration and status information for a xen based system. This command allows you to query and interact with xenstore. 	XENSTORE
xenstore-chmod(1)	Xenstore holds configuration and status information for a xen based system. This command allows you to change permissions of data in xenstore. 	XENSTORE
xenstore-ls(1) 	Xenstore holds configuration and status information for a xen based system. This command allows you to list information held in xenstore 	XENSTORE
= Supporting Documents for XL =
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 Project 4.*, a new config option called tsc_mode may be specified for each domain. This document is targeted for Xen Project users and administrators that may need to select a non-default tsc_mode.
xl-numa.cfg(5), Guest Automatic NUMA placement in LIBXL and XL	This document describes the automatic placement options for NUMA hardware in XL.
= Advanced Topics =
Document(s) 	Category 	Description 	Also See
Environment Variables for different Linux distros	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. 	Distros
How to do PCI Passthrough with VT-d 	PCI Passthrough 	 	Xen PCI Passthrough Overview, VT-d HowTo
Virtual TPM support 	Security 	This document gives a short introduction to the virtual TPM support in Xen Project 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 the Xen Project Hypervisor and Linux on a machine.	Virtual Trusted Platform Module (research note)
Virtual TPM Example Configurations 	Security 	This document describes examples which use virtual TPMs to provide security properties for guests. 	
Virtual TPM Manager CLI 	Security 	This document describes the operation and command line interface of vtpmmgr-stubdom. 	
XSM/FLASK Configuration 	Security 	Flask is the Xen Project's equivalent of SELinux. A more thorough user guide can be found at Xen Security Modules : XSM-FLASK. 	
Qemu Upstream: How to use it 	QEMU 	Pointer to a wiki page documenting how to build Xen Project software with the QEMU unstable tree. 	
sEDF scheduler how to 	Scheduler / Performance	Using the sEDF scheduler for weighted CPU sharing. 	
VT-d HOWTO 	PCI Passthrough 	How to use Intel's VT-d extensions. 	
PVH Information 	Virtualization Mode 	Using the new PVH virtualization mode. 	
x86 PV Bootloader 	Configuration 	The purpose of this document is to define the paths within the guest filesystem where a stage 1 bootloader should look for the in-guest PV bootloader to load and the protocol/format expected from the to-be-chainloaded bootloader. 	
= Developer Topics =
Document(s) 	Category 	Description 	Also See
Live Patching Design 	Developers	Live Patching is a mechanism is required to binarily patch the running hypervisor with new opcodes that have come about due to primarily security updates. This document describes the design of the API that would allow us to upload to the hypervisor binary patches.	
Kexec, and kdump for Xen Project 	Developers	Guide to using kexec to switch to a new kernel; and kdump for catching a dump image, with Xen Project. 	
Xen Project Core Dump Format 	Developers	Format of the output of the x{m,l} core-dump command 	
Xen Project Guest Disk (VBD) interface 	Developers	The interface exposed to DomUs for communicating with block devices. 	
XenStore Protocol Definition 	Developers	Definition of standard behaviour, when using Xenstore. 	
XenStore Paths 	Developers	This document attempts to defines all the paths which are in common use by either guests, front-/back-end drivers, toolstacks etc. 	
XenStore Ring 	Developers	This document describes the xenstore ring datastructure and its usage. The xenstore ring is a datastructure stored within a single 4KiB page shared between the xenstore server and the guest. 	
A rough introduction to using grant tables 	Developers	Explanation of the data structures, and hypercalls required to share memory between domains. 	
Xen Project Error Handling 	Developers	Explanation of the various types of error (BUG, ASSERT etc) that the hypervisor, and guest can call. 	
Xen Project HVM emulated device unplug protocol	Developers	Definition of the protocol used to disconnect emulated deivces, get log messages from drivers, and prevent Dom0 from loading specific drivers. 	
Xen Project paging 	Developers	Allow the sum of memory allocated to guests > physical memory available, by paging out. 	
Xen Project Crash Debugger 	Developers	Using gdb to analyse why Xen Hypervisor has crashed. 	
Grant Tables 	Developers	Introduction to grant tables 	
Error Handling 	Developers	Outlines coding conventions around error handling 	
PV Console Architecture Overview 	Developers	Xen traditionally provided a single PV console to PV guests. Today we have support fort multiple PV consoles and backends. This document provides an architecture overview of PV Consoles and explains how different components interact with each other. 	
AMD Microcode Container File format 	Developers	 	
Xen PV Channels 	Developers	Introduction, Usage and Design Limitations of PV channels in Xen 	
Coverage support for Xen 	Developers	Coverage support allow you to get code coverage information when Xen executes (in other words you can see how many times a line is executed). This tutorial shows how to enable and use code coverage support for Xen. 	
PCI Device ID Reservation 	Developers	This document shows ranges reserved for PCI Device ID Reservation and explains how to reserve new IDs. 	
Xen custom %p format options 	Developers	Specification of custom %p format options in Xen. 	
PVH Architecture and Specification 	Developers	This document gives an overview of the PVH implementation 	
Hypercall ABI documentation 	Developers	Hypercall ABI documentation for x86 and ARM 	
= Also See =
* :Category:ManPage
* : All generated pages. Note that not all pages may be listed above!
Category:Xen
Category:ManPage
Category:Manual
Category:Beginners
Category:Users
Category:Developers
Category:Xen 4.7