Xen Man Pages: Difference between revisions
From Xen
				
				
				Jump to navigationJump to search
				
				| Lars.kurth (talk | contribs) | Lars.kurth (talk | contribs)  No edit summary | ||
| Line 1: | Line 1: | ||
| {{Info|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}} | {{Info|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]] | See [[:Category:ManPage]] | ||
| = All Generated Man Pages = | |||
| See [http://xenbits.xen.org/docs/unstable/ xenbits.xen.org/docs/unstable]  | See [http://xenbits.xen.org/docs/unstable/ xenbits.xen.org/docs/unstable]  | ||
| <b>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!</b> | <b>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!</b> | ||
| = Xen Configuration = | |||
| {| class="zebra sortable fullwidth" | {| class="zebra sortable fullwidth" | ||
| |- | |- | ||
| Line 22: | Line 22: | ||
| |} | |} | ||
| = Xen Man Pages = | |||
| {| class="zebra sortable fullwidth" | {| class="zebra sortable fullwidth" | ||
| Line 71: | Line 71: | ||
| |} | |} | ||
| = Supporting Documents for XL & XM = | |||
| {| class="zebra sortable fullwidth" | {| class="zebra sortable fullwidth" | ||
| Line 91: | Line 91: | ||
| |} | |} | ||
| = Advanced Topics = | |||
| {| class="zebra sortable fullwidth" | {| class="zebra sortable fullwidth" | ||
| |- | |- | ||
| !style="min-width: 200px; max-width: 300px;"| Document(s) | |||
| ! Document | |||
| !style="min-width: 100px; max-width: 100px;"| Category | |||
| ! Description | |||
| !style="min-width: 200px;"| Description | |||
| !style="min-width: 100px; max-width: 200px;"| Also See | |||
| |- | |- | ||
| | [http://xenbits.xen.org/docs/unstable/misc/distro_mapping.txt Environment Variables for different Linux distros] | | [http://xenbits.xen.org/docs/unstable/misc/distro_mapping.txt 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. | | 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]] | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/distro_mapping.txt Distro directory layouts] | |||
| | Distros | |||
| | Overview of the differences in directory layout between RHEL, Debian and Suse. | |||
| | [[Distros]] | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/vtd.txt How to do PCI Passthrough with VT-d] | |||
| | PCI Passthrough  | |||
| |  | |||
| | {{Category|VGA}}<hr> [[Xen_PCI_Passthrough|Xen PCI Passthrough Overview]], [[VTdHowTo|VT-d HowTo]] | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/vtpm.txt 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. | |||
| | {{Category|Security}}<hr>[http://domino.research.ibm.com/comm/research_projects.nsf/pages/ssd_vtpm.index.html Virtual Trusted Platform Module (research note)] | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/qemu-upstream_howto_use_it.html Qemu Upstream: How to use it] | |||
| | QEMU | |||
| | Pointer to a wiki page documenting how to build XXen with the QEMU unstable tree. | |||
| | | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/sedf_scheduler_mini-HOWTO.txt sEDF scheduler how to] | |||
| | Scheduler / Performance | |||
| | Using the SsEDF scheduler for weighted CPU sharing. | |||
| | {{Category|Performance}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/xl-numa-placement.html XL placement] | |||
| | Performance | |||
| | NUMA Node placement. | |||
| | {{Category|Performance}} {{Category|NUMA}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/vtd.txt VT-d HOWTO] | |||
| | PCI Passthrough | |||
| | How to use Intel's VT-d extensions. | |||
| | {{Category|VGA}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/xsm-flask.txt XSM/FLASK Configuration] | |||
| | Security | |||
| | Configuring Xen to use the XSM/FLASK mandatory access control framework | |||
| | {{Category|Security}}<hr>[[Xen Security Modules : XSM-FLASK|XSM-FLASK]] | |||
| |- | |||
| | '''More documentation''': | |||
| | | |||
| | See [http://xenbits.xen.org/docs/unstable/ Generated documents] | |||
| | | |||
| |} | |} | ||
| = Developer Topics = | |||
| {| class="zebra sortable fullwidth" | {| class="zebra sortable fullwidth" | ||
| |- | |- | ||
| ! Document(s) | !style="min-width: 200px; max-width: 300px;"| Document(s) | ||
| !style="min-width: 100px; max-width: 100px;"| Category | |||
| ! Description | ! Description | ||
| !style="min-width: 100px; max-width: 200px;"| Also See | |||
| ! Also See | |||
| |- | |- | ||
| | [http://xenbits.xen.org/docs/unstable/misc/ | | [http://xenbits.xen.org/docs/unstable/misc/kexec_and_kdump.txt 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. | |||
| | [[Xen_PCI_Passthrough|Xen PCI Passthrough Overview]], [[VTdHowTo|VT-d HowTo]] | |||
| | {{Category|Developers}} | |||
| |- | |- | ||
| | [http://xenbits.xen.org/docs/unstable/misc/ | | [http://xenbits.xen.org/docs/unstable/misc/dump-core-format.txt Xen Core Dump Format] | ||
| | Developers | |||
| | 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. | |||
| | Format of the output of the x{m,l} core-dump command | |||
| | [http://domino.research.ibm.com/comm/research_projects.nsf/pages/ssd_vtpm.index.html Virtual Trusted Platform Module (research note)] | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/vbd-interface.txt Xen Guest Disk (VBD) interface] | |||
| | Developers | |||
| | The interface exposed to DomUs for communicating with block devices. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/xenstore.txt Xenstore Protocol Definition] | |||
| | Developers | |||
| | Definition of standard behaviour, when using Xenstore. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/grant-tables.txt A rough introduction to using grant tables] | |||
| | Developers | |||
| | Explanation of the data structures, and hypercalls required to share memory between domains. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/xen-error-handling.txt Xen Error Handling] | |||
| | Developers | |||
| | Explanation of the various types of error (BUG, ASSERT etc) that the hypervisor, and guest can call. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/hvm-emulated-unplug.html 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.  | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/xenpaging.txt Xen paging] | |||
| | Developers | |||
| | Allow the sum of memory allocated to guests > physical memory available, by paging out. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/unstable/misc/crashdb.txt Xen Crash Debugger] | |||
| | Developers | |||
| | Using gdb to analyse why Xen has crashed. | |||
| | {{Category|Developers}} | |||
| |} | |} | ||
Revision as of 08:35, 18 October 2013
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. | 
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 | 
| 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 | 


