Xen Man Pages: Difference between revisions

From Xen
Jump to navigationJump to search
No edit summary
(Updated such that it reflects unstable (main change: removed xm related docs))
 
(28 intermediate revisions by 5 users not shown)
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}}


{{ManualLayout|
== Man Pages ==
__TOC__
}}


= Xen Project Configuration =
{| class="wikitable"
{| class="zebra sortable fullwidth"
|-
|-
!style="min-width: 200px; max-width: 300px;"| Page
! Man page
! Description
! Description
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xl.1.html xl(1)]
| [http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html Xen Project CLI]
| Command line options for Xen Project software to be used in /boot/grub/grub.conf
| Xen management tool, based on LibXenlight
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xm.1.html xm(1)]
| [http://xenbits.xen.org/docs/unstable/misc/efi.html EFI]
| Configuring Xen Project software to work with EFI.
| Xen management user interface (to be deprecated, also see [[MigrationGuideToXen4.1%2B#Toolstack_upgrade_notes|Xen 4.1 Upgrade Notes]])
|}

= Xen Project Man Pages =
{| class="zebra sortable fullwidth"
|-
|-
!style="min-width: 200px; max-width: 300px;"| Man page
| [http://xenbits.xen.org/docs/unstable/man/xend-config.sxp.5.html xend-config.sxp(5)]
! Description
| Xen daemon configuration file
!style="min-width: 100px; max-width: 100px;"| Console
|-
| [http://xenbits.xen.org/docs/unstable/man/xl.1.html xl(1)]
| Xen Project management tool, based on LibXenlight
| XL
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html xl.cfg(5)]
| [http://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html xl.cfg(5)]
| XL Domain Configuration File Syntax
| 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/unstable/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/unstable/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
|-
| [http://xenbits.xen.org/docs/unstable/man/xenstore.1.html xenstore(1)]
| Xenstore holds configuration and status information for a xen based system. This command allows you to query and interact with xenstore.
| XENSTORE
|-
| [http://xenbits.xen.org/docs/unstable/man/xenstore-chmod.1.html xenstore-chmod(1)]
| Xenstore holds configuration and status information for a xen based system. This command allows you to change permissions of data in xenstore.
| XENSTORE
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xmdomain.cfg.5.html xmdomain.cfg(5)]
| [http://xenbits.xen.org/docs/unstable/man/xenstore-ls.1.html xenstore-ls(1)]
| Xenstore holds configuration and status information for a xen based system. This command allows you to list information held in xenstore
| XM domain config file format
| XENSTORE
|}
|}


== Supporting Documents for specific use-cases ==
= Supporting Documents for XL =


{| class="wikitable"
{| class="zebra fullwidth"
|-
|-
!style="min-width: 300px; max-width: 400px;"| Document
! Document
! Description
! Description
|-
|-
Line 36: Line 73:
| [http://xenbits.xen.org/docs/unstable/misc/xl-network-configuration.html xl.cfg(5), '''network''' configuration]
| [http://xenbits.xen.org/docs/unstable/misc/xl-network-configuration.html xl.cfg(5), '''network''' configuration]
| This document specifies the xl config file format vif configuration option.
| This document specifies the xl config file format vif configuration option.
|-
| [http://xenbits.xen.org/docs/unstable/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/unstable/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 ==
= Advanced Topics =
{| class="zebra sortable fullwidth"

{| class="wikitable"
|-
|-
! Document(s)
!style="min-width: 200px; max-width: 300px;"| Document(s)
!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]
| 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/unstable/misc/vtd.txt How to do PCI Passthrough with VT-d]
| [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]
| [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.
| 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/unstable/misc/vtpm-platforms.txt Virtual TPM Example Configurations]
| Security
| This document describes examples which use virtual TPMs to provide security properties for guests.
| {{Category|Security}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/vtpmmgr.txt Virtual TPM Manager CLI]
| Security
| This document describes the operation and command line interface of vtpmmgr-stubdom.
| {{Category|Security}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/xsm-flask.txt XSM/FLASK Configuration]
| Security
| Flask is the Xen Project's equivalent of SELinux. A more thorough user guide can be found at [[Xen_Security_Modules_:_XSM-FLASK|Xen Security Modules : XSM-FLASK]].
| {{Category|Security}}
|-
| [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 Xen Project software 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 sEDF scheduler for weighted CPU sharing.
| {{Category|Performance}}
|-
| [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/pvh-readme.txt PVH Information]
| Virtualization Mode
| Using the new [[Linux_PVH|PVH virtualization]] mode.
| {{Category|Performance}}
|-
| [http://xenbits.xen.org/docs/unstable/miscx86-xenpv-bootloader.html x86 PV Bootloader]
| Configuration
| The purpose of this document is to define the paths within the guest filesystem where a stage 1 bootloader should look for the in-guest PV bootloader to load and the protocol/format expected from the to-be-chainloaded bootloader.
|
|}
|}


= 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/unstable/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/unstable/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/unstable/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/unstable/misc/xenstore.txt XenStore Protocol Definition]
| Developers
| Definition of standard behaviour, when using Xenstore.
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/xenstore-paths.html XenStore Paths]
| Developers
| This document attempts to defines all the paths which are in common use by either guests, front-/back-end drivers, toolstacks etc.
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/xenstore-ring.txt XenStore Ring]
| Developers
| This document describes the xenstore ring datastructure and its usage. The xenstore ring is a datastructure stored within a single 4KiB page shared between the xenstore server and the guest.
| {{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 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/unstable/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/unstable/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/unstable/misc/crashdb.txt Xen Project Crash Debugger]
| Developers
| Using gdb to analyse why Xen Hypervisor has crashed.
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/grant-tables.txt Grant Tables]
| Developers
| Introduction to grant tables
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/error-handling.txt Error Handling]
| Developers
| Outlines coding conventions around error handling
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/console.txt PV Console Architecture Overview]
| Developers
| Xen traditionally provided a single PV console to PV guests. Today we have support fort multiple PV consoles and backends. This document provides an architecture overview of PV Consoles and explains how different components interact with each other.
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/amd-ucode-container.txt AMD Microcode Container File format]
| Developers
|
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/channel.txt Xen PV Channels]
| Developers
| Introduction, Usage and Design Limitations of PV channels in Xen
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/coverage.txt Coverage support for Xen]
| Developers
| Coverage support allow you to get code coverage information when Xen executes (in other words you can see how many times a line is executed). This tutorial shows how to enable and use code coverage support for Xen.
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/pci-device-reservations.txt PCI Device ID Reservation]
| Developers
| This document shows ranges reserved for PCI Device ID Reservation and explains how to reserve new IDs.
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/printk-formats.txt Xen custom %p format options]
| Developers
| Specification of custom %p format options in Xen.
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/misc/pvh.html PVH Architecture and Specification]
| Developers
| This document gives an overview of the PVH implementation
| {{Category|Developers}}
|-
| [http://xenbits.xen.org/docs/unstable/hypercall/index.html Hypercall ABI documentation]
| Developers
| Hypercall ABI documentation for x86 and ARM
| {{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:Beginners]]
[[Category:Users]]
[[Category:Users]]

Latest revision as of 15:38, 6 January 2015

Book Help Manual Search.png

 

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
xenstore(1) Xenstore holds configuration and status information for a xen based system. This command allows you to query and interact with xenstore. XENSTORE
xenstore-chmod(1) Xenstore holds configuration and status information for a xen based system. This command allows you to change permissions of data in xenstore. XENSTORE
xenstore-ls(1) Xenstore holds configuration and status information for a xen based system. This command allows you to list information held in xenstore XENSTORE

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
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)
Virtual TPM Example Configurations Security This document describes examples which use virtual TPMs to provide security properties for guests. Security
Virtual TPM Manager CLI Security This document describes the operation and command line interface of vtpmmgr-stubdom. Security
XSM/FLASK Configuration Security Flask is the Xen Project's equivalent of SELinux. A more thorough user guide can be found at Xen Security Modules : XSM-FLASK. Security
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 sEDF scheduler for weighted CPU sharing. Performance
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
x86 PV Bootloader Configuration The purpose of this document is to define the paths within the guest filesystem where a stage 1 bootloader should look for the in-guest PV bootloader to load and the protocol/format expected from the to-be-chainloaded bootloader.

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
XenStore Paths Developers This document attempts to defines all the paths which are in common use by either guests, front-/back-end drivers, toolstacks etc. Developers
XenStore Ring Developers This document describes the xenstore ring datastructure and its usage. The xenstore ring is a datastructure stored within a single 4KiB page shared between the xenstore server and the guest. 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
Grant Tables Developers Introduction to grant tables Developers
Error Handling Developers Outlines coding conventions around error handling Developers
PV Console Architecture Overview Developers Xen traditionally provided a single PV console to PV guests. Today we have support fort multiple PV consoles and backends. This document provides an architecture overview of PV Consoles and explains how different components interact with each other. Developers
AMD Microcode Container File format Developers Developers
Xen PV Channels Developers Introduction, Usage and Design Limitations of PV channels in Xen Developers
Coverage support for Xen Developers Coverage support allow you to get code coverage information when Xen executes (in other words you can see how many times a line is executed). This tutorial shows how to enable and use code coverage support for Xen. Developers
PCI Device ID Reservation Developers This document shows ranges reserved for PCI Device ID Reservation and explains how to reserve new IDs. Developers
Xen custom %p format options Developers Specification of custom %p format options in Xen. Developers
PVH Architecture and Specification Developers This document gives an overview of the PVH implementation Developers
Hypercall ABI documentation Developers Hypercall ABI documentation for x86 and ARM Developers

Also See


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!

Retrieved from "https://wiki.xenproject.org/index.php?title=Xen_Man_Pages&oldid=13548"