Xen Project 4.4 Man Pages: Difference between revisions
From Xen
Jump to navigationJump to search
Rcpavlicek (talk | contribs) mNo edit summary |
Rcpavlicek (talk | contribs) No edit summary |
||
| Line 18: | Line 18: | ||
= Xen Man Pages = |
= Xen 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.4-testing/man/xl.1.html xl(1)] |
|||
| Xen management tool, based on LibXenlight |
|||
| XL |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-testing/man/xm.1.html xm(1)] |
|||
| Xen management user interface (deprecated, also see [[MigrationGuideToXen4.1%2B#Toolstack_upgrade_notes|Xen 4.1 Upgrade Notes]]) |
|||
| XM |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-testing/man/xend-config.sxp.5.html xend-config.sxp(5)] |
|||
| Xen daemon configuration file (deprecated, also see [[MigrationGuideToXen4.1%2B#Toolstack_upgrade_notes|Xen 4.1 Upgrade Notes]]) |
|||
| XM |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-testing/man/xl.cfg.5.html 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 |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-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.4-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 |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-testing/man/xmdomain.cfg.5.html xmdomain.cfg(5)] |
|||
| XM domain config file format (deprecated, also see [[MigrationGuideToXen4.1%2B#Toolstack_upgrade_notes|Xen 4.1 Upgrade Notes]]) |
|||
| XM |
|||
|- |
|||
| [[xentop(1)]] |
|||
| xentop displays information about the Xen 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 & XM = |
|||
{| class="zebra fullwidth" |
|||
|- |
|||
!style="min-width: 300px; max-width: 400px;"| Document |
|||
! Description |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-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.4-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.4-testing/misc/tscmode.txt 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. |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-testing/misc/sedf_scheduler_mini-HOWTO.txt xm.cfg(5), '''sEDF scheduler'''] |
|||
| The sEDF scheduler provides weighted CPU sharing in an intuitive way and uses realtime-algorithms to ensure time guarantees. |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-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.4-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.4-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.4-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.4-testing/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/4.4-testing/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/4.4-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.4-testing/misc/xl-numa-placement.html XL placement] |
|||
| Performance |
|||
| NUMA Node placement. |
|||
| {{Category|Performance}} {{Category|NUMA}} |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-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.4-testing/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/4.4-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.4-testing/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. |
|||
| {{Category|Developers}} |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-testing/misc/dump-core-format.txt Xen Core Dump Format] |
|||
| Developers |
|||
| Format of the output of the x{m,l} core-dump command |
|||
| {{Category|Developers}} |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-testing/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/4.4-testing/misc/xenstore.txt Xenstore Protocol Definition] |
|||
| Developers |
|||
| Definition of standard behaviour, when using Xenstore. |
|||
| {{Category|Developers}} |
|||
|- |
|||
| [http://xenbits.xen.org/docs/4.4-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.4-testing/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/4.4-testing/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/4.4-testing/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/4.4-testing/misc/crashdb.txt Xen Crash Debugger] |
|||
| Developers |
|||
| Using gdb to analyse why Xen has crashed. |
|||
| {{Category|Developers}} |
|||
|} |
|||
= Also See = |
= Also See = |
||
* [[:Category:ManPage]] |
* [[:Category:ManPage]] |
||
* [http://xenbits.xen.org/docs/4.4-testing] : All generated pages |
* [http://xenbits.xen.org/docs/4.4-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> |
<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> |
||
Revision as of 19:08, 8 March 2014
 |
NOTE: THIS IS A STUB PENDING RELEASE
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 |
|---|---|---|
| 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 |
| 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!
