Xen 4.3 Man Pages: Difference between revisions

From Xen
Jump to navigationJump to search
No edit summary
Line 123: Line 123:
|-
|-
! Document(s)
! Document(s)
! Category
! Description
! Description
! Also See
! Also See
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/vtd.txt How to do PCI Passthrough with VT-d]
| [http://xenbits.xen.org/docs/4.3-testing/misc/vtd.txt How to do PCI Passthrough with VT-d]
| PCI Passthrough
|
|
| [[Xen_PCI_Passthrough|Xen PCI Passthrough Overview]], [[VTdHowTo|VT-d HowTo]]
| [[Xen_PCI_Passthrough|Xen PCI Passthrough Overview]], [[VTdHowTo|VT-d HowTo]]
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/vtpm.txt Virtual TPM support]
| [http://xenbits.xen.org/docs/4.3-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.
| 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.
| [http://domino.research.ibm.com/comm/research_projects.nsf/pages/ssd_vtpm.index.html Virtual Trusted Platform Module (research note)]
| [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.3-testing/misc/grant-tables.txt A rough introduction to using grant tables]
| [http://xenbits.xen.org/docs/4.3-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.
| Explanation of the data structures, and hypercalls required to share memory between domains.
|
|
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/xen-error-handling.txt Xen Error Handling]
| [http://xenbits.xen.org/docs/4.3-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.
| Explanation of the various types of error (BUG, ASSERT etc) that the hypervisor, and guest can call.
|
|
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/hvm-emulated-unplug.html Xen HVM emulated device unplug protocol]
| [http://xenbits.xen.org/docs/4.3-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.
| Definition of the protocol used to disconnect emulated deivces, get log messages from drivers, and prevent Dom0 from loading specific drivers.
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/xenpaging.txt Xen paging]
| [http://xenbits.xen.org/docs/4.3-testing/misc/xenpaging.txt Xen paging]
| Developers
| Allow the sum of memory allocated to guests > physical memory available, by paging out.
| Allow the sum of memory allocated to guests > physical memory available, by paging out.
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/crashdb.txt Xen Crash Debugger]
| [http://xenbits.xen.org/docs/4.3-testing/misc/crashdb.txt Xen Crash Debugger]
| Developers
| Using gdb to analyse why Xen has crashed.
| Using gdb to analyse why Xen has crashed.
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/qemu-upstream_howto_use_it.html Qemu Upstream: How to use it]
| [http://xenbits.xen.org/docs/4.3-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.
| Pointer to a wiki page documenting how to build XXen with the QEMU unstable tree.
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/sedf_scheduler_mini-HOWTO.txt sEDF scheduler how to]
| [http://xenbits.xen.org/docs/4.3-testing/misc/sedf_scheduler_mini-HOWTO.txt sEDF scheduler how to]
| Scheduler / Performance
| Using the SsEDF scheduler for weighted CPU sharing.
| Using the SsEDF scheduler for weighted CPU sharing.
|-
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/xl-numa-placement.html XL placement]
| [http://xenbits.xen.org/docs/4.3-testing/misc/xl-numa-placement.html XL placement]
| Performance
| NUMA Node placement.
| NUMA Node placement.
|-
| [http://xenbits.xen.org/docs/4.3-testing/misc/xsm-flask.txt XSM-Flask]
| Security
|-
|-
| '''More documentation''':
| '''More documentation''':
|
| See [http://xenbits.xen.org/docs/4.3-testing/ Generated documents]
| See [http://xenbits.xen.org/docs/4.3-testing/ Generated documents]
|}
|}

Revision as of 11:54, 24 June 2013

Icon Info.png 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


Icon todo.png 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.


Wiki Man Pages

See Category:ManPage

All Generated Man Pages

See [1]

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 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.

Other documents

Document Description
Environment Variables for different Linux 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.
Distro directory layouts Overview of the differences in directory layout between RHEL, Debian and Suse.
Kexec, and kdump for Xen Guide to using kexec to switch to a new kernel; and kdump for catching a dump image, with Xen.
VT-d HOWTO How to use Intel's VT-d extensions.
XSM/FLASK Configuration Configuring Xen to use the XSM/FLASK mandatory access control framework
Xen Core Dump Format Format of the output of the x{m,l} core-dump command
Xeb Hypervisor Command Line Options List of hypervisor command line options
Xen Guest Disk (VBD) interface The interface exposed to DomUs for communicating with block devices.
Xenstore Protocol Definition Definition of standard behaviour, when using Xenstore.
EFI Configuring Xen to work with EFI.

Advanced topics

Document(s) Category Description Also See
How to do PCI Passthrough with VT-d PCI Passthrough 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. Virtual Trusted Platform Module (research note)
A rough introduction to using grant tables Developers Explanation of the data structures, and hypercalls required to share memory between domains.
Xen Error Handling Developers Explanation of the various types of error (BUG, ASSERT etc) that the hypervisor, and guest can call.
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.
Xen paging Developers Allow the sum of memory allocated to guests > physical memory available, by paging out.
Xen Crash Debugger Developers Using gdb to analyse why Xen has crashed.
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.
XL placement Performance NUMA Node placement.
XSM-Flask Security
More documentation: See Generated documents
Retrieved from "https://wiki.xenproject.org/index.php?title=Xen_4.3_Man_Pages&oldid=9111"