Xen Man Pages
From Xen
Jump to navigationJump to search
 |
This document contains links to Xen Project manual pages that are generated from the Xen Project codebase. They reflect the state of xen-unstable.hg, except for the xm commands which refer to 4.4 -- the last version to support this toolset. Versions for specific Xen Project software releases, are available from Category:ManPage.
Xen Project Software Configuration
| Page | Description |
|---|---|
| Xen Project CLI | Command line options for Xen 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 |
|---|---|---|
| Xen Project CLI (1) | Command line options for Xen Project software to be used in /boot/grub/grub.conf | N/A |
| xl(1) | Xen Project management tool, based on LibXenlight | XL |
| xm(1) | Xen Project management user interface (deprecated, removed in 4.5; also see Xen 4.1+ Upgrade Notes) | XM |
| xend-config.sxp(5) | Xen Project daemon configuration file (deprecated, removed in 4.5; 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 (deprecated, removed in 4.5; also see Xen 4.1+ Upgrade Notes) | XM |
| 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 |
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 Project 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. |
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 |
| Distro directory layouts | Distros | Overview of the differences in directory layout between RHEL, Debian and Suse. | Distros |
| How to do PCI Passthrough with VT-d | PCI Passthrough | VGA 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 Xen Project software and Linux on a machine. | Security Virtual Trusted Platform Module (research note) |
| 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 SsEDF scheduler for weighted CPU sharing. | Performance |
| XL placement | Performance | NUMA Node placement. | Performance NUMA |
| VT-d HOWTO | PCI Passthrough | How to use Intel's VT-d extensions. | VGA |
| XSM/FLASK Configuration | Security | Configuring Xen to use the XSM/FLASK mandatory access control framework | Security XSM-FLASK |
| More documentation: | See Generated documents |
Developer Topics
| Document(s) | Category | Description | Also See |
|---|---|---|---|
| Kexec, and kdump for Xen | Developers | Guide to using kexec to switch to a new kernel; and kdump for catching a dump image, with Xen. | Developers |
| Xen Core Dump Format | Developers | Format of the output of the x{m,l} core-dump command | Developers |
| Xen Guest Disk (VBD) interface | Developers | The interface exposed to DomUs for communicating with block devices. | Developers |
| Xenstore Protocol Definition | Developers | Definition of standard behaviour, when using Xenstore. | Developers |
| A rough introduction to using grant tables | Developers | Explanation of the data structures, and hypercalls required to share memory between domains. | Developers |
| Xen Project Error Handling | Developers | Explanation of the various types of error (BUG, ASSERT etc) that the hypervisor, and guest can call. | Developers |
| 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. | Developers |
| Xen Project paging | Developers | Allow the sum of memory allocated to guests > physical memory available, by paging out. | Developers |
| Xen Project Crash Debugger | Developers | Using gdb to analyse why the hypervisor has crashed. | Developers |
Also See
- Category:ManPage
- 4.4-testing : All generated pages
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!
