Xen Project 4.5 Man Pages: Difference between revisions
From Xen
				
				
				Jump to navigationJump to search
				
				| Lars.kurth (talk | contribs)  (Created page with "{{TODO|Clone existing pages and update URLs; check for new documents or invalid ones - such ass all info related to xm and delete}}  Category:Xen 4.5") | Lars.kurth (talk | contribs)  No edit summary | ||
| Line 1: | Line 1: | ||
| {{TODO| | |||
| {{TODO|Clone existing pages and update URLs; check for new documents or invalid ones - such ass all info related to xm and delete}} | |||
| * Clone existing pages {{Tick}} | |||
| * and update URLs {{Tick}} - but note that the links do '''not yet exist''' | |||
| * remove XL related docs {{Tick}} | |||
| * check for new documents {{NotDone}} | |||
| * check for other old documents {{NotDone}} | |||
| }} | |||
| {{ManualLayout| | |||
| __TOC__ | |||
| }} | |||
| = Xen Project Configuration = | |||
| {| class="zebra sortable fullwidth" | |||
| |- | |||
| !style="min-width: 200px; max-width: 300px;"| Page  | |||
| ! Description | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/xen-command-line.html Xen Project CLI] | |||
| | Command line options for Xen Project software to be used in /boot/grub/grub.conf | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/efi.html EFI] | |||
| | Configuring Xen Project software to work with EFI. | |||
| |} | |||
| = Xen Project Man Pages = | |||
| {| class="zebra sortable fullwidth" | |||
| |- | |||
| !style="min-width: 200px; max-width: 300px;"| Man page | |||
| ! Description | |||
| !style="min-width: 100px; max-width: 100px;"| Console | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/man/xl.1.html xl(1)] | |||
| | Xen Project management tool, based on LibXenlight | |||
| | XL | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/man/xl.cfg.5.html 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 | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/man/xl.conf.5.html xl.conf(5)] | |||
| | XL Global/Host Configuration: allows configuration of hostwide xl toolstack options | |||
| | XL | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/man/xlcpupool.cfg.5.html 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_command|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  = | |||
| {| class="zebra fullwidth" | |||
| |- | |||
| !style="min-width: 300px; max-width: 400px;"| Document | |||
| ! Description | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/xl-disk-configuration.txt xl.cfg(5), '''disk''' configuration] | |||
| | This document specifies the xl config file format disk configuration option.  | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/xl-network-configuration.html xl.cfg(5), '''network''' configuration] | |||
| | This document specifies the xl config file format vif configuration option.  | |||
| |-  | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/tscmode.txt 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. | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/xl-numa-placement.html 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 = | |||
| {| class="zebra sortable fullwidth" | |||
| |- | |||
| !style="min-width: 200px; max-width: 300px;"| Document(s) | |||
| !style="min-width: 100px; max-width: 100px;"| Category | |||
| !style="min-width: 200px;"| Description | |||
| !style="min-width: 100px; max-width: 200px;"| Also See | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/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. | |||
| | [[Distros]] | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/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/4.5-testing/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/4.5-testing/misc/vtpm.txt 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. | |||
| | {{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/4.5-testing/misc/qemu-upstream_howto_use_it.html Qemu Upstream: How to use it] | |||
| | QEMU | |||
| | Pointer to a wiki page documenting how to build Xen Project software with the QEMU unstable tree. | |||
| | | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/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/4.5-testing/misc/xl-numa-placement.html XL placement] | |||
| | Performance | |||
| | NUMA Node placement. | |||
| | {{Category|Performance}} {{Category|NUMA}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/vtd.txt VT-d HOWTO] | |||
| | PCI Passthrough | |||
| | How to use Intel's VT-d extensions. | |||
| | {{Category|VGA}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/pvh-readme.txt PVH Information] | |||
| | Virtualization Mode | |||
| | Using the new PVH virtualization mode. | |||
| | {{Category|Performance}}<hr>[http://blog.xenproject.org/index.php/2012/10/23/the-paravirtualization-spectrum-part-1-the-ends-of-the-spectrum/ Blog post] | |||
| |- | |||
| | '''More documentation''': | |||
| | | |||
| | See [http://xenbits.xen.org/docs/4.5-testing/ Generated documents] | |||
| | | |||
| |} | |||
| = Developer Topics = | |||
| {| class="zebra sortable fullwidth" | |||
| |- | |||
| !style="min-width: 200px; max-width: 300px;"| Document(s) | |||
| !style="min-width: 100px; max-width: 100px;"| Category | |||
| ! Description | |||
| !style="min-width: 100px; max-width: 200px;"| Also See | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/kexec_and_kdump.txt 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. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/dump-core-format.txt Xen Project Core Dump Format] | |||
| | Developers | |||
| | Format of the output of the x{m,l} core-dump command | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/vbd-interface.txt Xen Project Guest Disk (VBD) interface] | |||
| | Developers | |||
| | The interface exposed to DomUs for communicating with block devices. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/xenstore.txt Xenstore Protocol Definition] | |||
| | Developers | |||
| | Definition of standard behaviour, when using Xenstore. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/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/4.5-testing/misc/xen-error-handling.txt Xen Project 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/4.5-testing/misc/hvm-emulated-unplug.html 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.  | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/xenpaging.txt Xen Project paging] | |||
| | Developers | |||
| | Allow the sum of memory allocated to guests > physical memory available, by paging out. | |||
| | {{Category|Developers}} | |||
| |- | |||
| | [http://xenbits.xen.org/docs/4.5-testing/misc/crashdb.txt Xen Project Crash Debugger] | |||
| | Developers | |||
| | Using gdb to analyse why Xen Hypervisor has crashed. | |||
| | {{Category|Developers}} | |||
| |} | |||
| = Also See = | |||
| * [[:Category:ManPage]] | |||
| * [http://xenbits.xen.org/docs/4.5-testing] : All generated pages | |||
| <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> | |||
| [[Category:Xen]] | |||
| [[Category:ManPage]] | |||
| [[Category:Manual]] | |||
| [[Category:Beginners]] | |||
| [[Category:Users]] | |||
| [[Category:Developers]] | |||
| [[Category:Xen 4.5]] | [[Category:Xen 4.5]] | ||
Revision as of 18:15, 19 December 2014
|  | 
 
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 | 
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 | 
| 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 the Xen Project Hypervisor 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 | 
| PVH Information | Virtualization Mode | Using the new PVH virtualization mode. | Performance Blog post | 
| More documentation: | See Generated documents | 
Developer Topics
| Document(s) | Category | Description | Also See | 
|---|---|---|---|
| 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. | Developers | 
| Xen Project Core Dump Format | Developers | Format of the output of the x{m,l} core-dump command | Developers | 
| Xen Project 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 Xen Hypervisor 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!


