Xen 4.3 Man Pages
From Xen
Jump to navigationJump to search
|
This section contains link to Xen manual pages that are generated from the Xen codebase. They reflect the state of 4.3-testing. We do not yet have versions for specific Xen releases, but will have them in future |
|
To Do:
4.3-testing has not been created yet at the time this document was written, thus most URL's will probably break. Also, new documents will not yet have been added. Also, add missing documents. |
Xen Man Pages
| Man page | Description | Console |
|---|---|---|
| xl(1) | Xen management tool, based on LibXenlight | XL |
| xm(1) | Xen management user interface (deprecated, also see Xen 4.1 Upgrade Notes) | XM |
| xend-config.sxp(5) | Xen daemon configuration file (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 (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. |
| 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 |
| 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 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. | Security Virtual Trusted Platform Module (research note) |
| Qemu Upstream: How to use it | QEMU | Pointer to a wiki page documenting how to build XXen 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 |
| Xen Hypervisor Command Line Options | ??? | List of hypervisor command line options | |
| EFI | ??? | Configuring Xen to work with EFI. | |
| 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 Error Handling | Developers | Explanation of the various types of error (BUG, ASSERT etc) that the hypervisor, and guest can call. | Developers |
| Xen 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 paging | Developers | Allow the sum of memory allocated to guests > physical memory available, by paging out. | Developers |
| Xen Crash Debugger | Developers | Using gdb to analyse why Xen has crashed. | Developers |
Also See
- Category:ManPage
- [1] : 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!
