Xen Project 4.10 Man Pages: Difference between revisions

From Xen
Jump to navigationJump to search
(Created page with "{{TODOLeft|When 4.10-testing is created, replace all references of '''docs/unstable''' with '''docs/4.10-testing''', except for the one in '''Also See'''}} <hr> <br> {{InfoLef...")
 
(Undo revision 18721 by Lars.kurth (talk))
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TODOLeft|When 4.10-testing is created, replace all references of '''docs/unstable''' with '''docs/4.10-testing''', except for the one in '''Also See'''}}
<hr>
<br>
{{InfoLeft|Note that the pages below may miss some new documents. If you do not find what you are looking for: please check [http://xenbits.xen.org/docs/unstable]!}}
{{ManualLayout|
__TOC__
}}


= Xen Project Configuration =
= Xen Project Configuration =
Line 13: Line 6:
! Description
! Description
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html Xen Project CLI]
| [http://xenbits.xen.org/docs/4.10-testing/misc/xen-command-line.html Xen Project CLI]
| Command line options for Xen Project software to be used in /boot/grub/grub.conf
| Command line options for Xen Project software to be used in /boot/grub/grub.conf
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/efi.html EFI]
| [http://xenbits.xen.org/docs/4.10-testing/misc/efi.html EFI]
| Configuring Xen Project software to work with EFI.
| Configuring Xen Project software to work with EFI.
|}
|}
Line 27: Line 20:
!style="min-width: 100px; max-width: 100px;"| Console
!style="min-width: 100px; max-width: 100px;"| Console
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xl.1.html xl(1)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xl.1.html xl(1)]
| Xen Project management tool, based on LibXenlight
| Xen Project management tool, based on LibXenlight
| XL
| XL
... ...
... ...
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html xl.cfg(5)]
| [http://xenbits.xen.org/docs/4.10-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 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
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xl.conf.5.html xl.conf(5)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xl.conf.5.html xl.conf(5)]
| XL Global/Host Configuration: allows configuration of hostwide xl toolstack options
| XL Global/Host Configuration: allows configuration of hostwide xl toolstack options
| XL
| XL
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xlcpupool.cfg.5.html xlcpupool.cfg(5)]
| [http://xenbits.xen.org/docs/4.10-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 Cpupool Configuration File Syntax: to create a Cpupool with xl requires the provision of a cpupool config file.
| XL
| XL
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xentop.1.html xentop(1)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xentop.1.html xentop(1)]
| xentop displays information about the Xen Project system and domains, in a continually-updating manner.
| xentop displays information about the Xen Project system and domains, in a continually-updating manner.
| XENTOP
| XENTOP
Line 52: Line 45:
| XENPM
| XENPM
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xenstore.1.html xenstore(1)]
| [http://xenbits.xen.org/docs/4.10-testing/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 holds configuration and status information for a xen based system. This command allows you to query and interact with xenstore.
| XENSTORE
| XENSTORE
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xenstore-chmod.1.html xenstore-chmod(1)]
| [http://xenbits.xen.org/docs/4.10-testing/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 holds configuration and status information for a xen based system. This command allows you to change permissions of data in xenstore.
| XENSTORE
| XENSTORE
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xenstore-ls.1.html xenstore-ls(1)]
| [http://xenbits.xen.org/docs/4.10-testing/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
| Xenstore holds configuration and status information for a xen based system. This command allows you to list information held in xenstore
| XENSTORE
| XENSTORE
Line 72: Line 65:
! Description
! Description
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xl-disk-configuration.5.html xl-disk-configuration(5))]
| [http://xenbits.xen.org/docs/4.10-testing/man/xl-disk-configuration.5.html xl-disk-configuration(5))]
| This document specifies the xl config file format disk configuration option.
| This document specifies the xl config file format disk configuration option.
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xl-network-configuration.5.html xl-network-configuration(5)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xl-network-configuration.5.html xl-network-configuration(5)]
| 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/man/xl-numa-placement.7.html xl-numa-placement(7)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xl-numa-placement.7.html xl-numa-placement(7)]
| This document describes the automatic placement options for NUMA hardware in XL.
| This document describes the automatic placement options for NUMA hardware in XL.
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xen-tscmode.7.html xen-tscmode(7) '''tsc_mode''' configuration]
| [http://xenbits.xen.org/docs/4.10-testing/man/xen-tscmode.7.html xen-tscmode(7) '''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.
| 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.
|}
|}
Line 92: Line 85:
! Description
! Description
|-<li>
|-<li>
| [http://xenbits.xen.org/docs/unstable/man/xen-vbd-interface.7.html xen-vbd-interface(7)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xen-vbd-interface.7.html xen-vbd-interface(7)]
| This document specifies the config file syntax with examples for Virtual Block Devices (VBDs)
| This document specifies the config file syntax with examples for Virtual Block Devices (VBDs)
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xen-pv-channel.7.html xen-pv-channel(7)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xen-pv-channel.7.html xen-pv-channel(7)]
| A PV channel is a low-bandwidth private byte stream similar to a serial link. This document explains how to use channels.
| A PV channel is a low-bandwidth private byte stream similar to a serial link. This document explains how to use channels.
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xen-pci-device-reservations.7.html xen-pci-device-reservations(7)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xen-pci-device-reservations.7.html xen-pci-device-reservations(7)]
| This document describes the usage and allocation of PCI vendor IDs
| This document describes the usage and allocation of PCI vendor IDs
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xen-vtpm.7.html xen-vtpm(7)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xen-vtpm.7.html xen-vtpm(7)]
| Man page showing how to use vTPM in Xen
| Man page showing how to use vTPM in Xen
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xen-vtpmmgr.7.html xen-vtpmmgr(7)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xen-vtpmmgr.7.html xen-vtpmmgr(7)]
| Man page showing how to use the vTPM Manager in Xen
| Man page showing how to use the vTPM Manager in Xen
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xentrace.8.html xentrace(8))]
| [http://xenbits.xen.org/docs/4.10-testing/man/xentrace.8.html xentrace(8))]
| xentrace - capture Xen trace buffer data
| xentrace - capture Xen trace buffer data
|-
|-
| [http://xenbits.xen.org/docs/unstable/man/xentrace_format.1.html xentrace_format(1)]
| [http://xenbits.xen.org/docs/4.10-testing/man/xentrace_format.1.html xentrace_format(1)]
| xentrace_format - pretty-print Xen trace data
| xentrace_format - pretty-print Xen trace data
|}
|}
Line 122: Line 115:
!style="min-width: 100px; max-width: 200px;"| Also See
!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/4.10-testing/misc/distro_mapping.txt Environment Variables for different Linux distros]
| 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]]
| [[Distros]]
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/vtd.txt How to do PCI Passthrough with VT-d]
| [http://xenbits.xen.org/docs/4.10-testing/misc/vtd.txt How to do PCI Passthrough with VT-d]
| PCI Passthrough
| PCI Passthrough
|
|
| {{Category|VGA}}<hr> [[Xen_PCI_Passthrough|Xen PCI Passthrough Overview]], [[VTdHowTo|VT-d HowTo]]
| {{Category|VGA}}<hr> [[Xen_PCI_Passthrough|Xen PCI Passthrough Overview]], [[VTdHowTo|VT-d HowTo]]
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/vtpm-platforms.txt Virtual TPM Example Configurations]
| [http://xenbits.xen.org/docs/4.10-testing/misc/vtpm-platforms.txt Virtual TPM Example Configurations]
| Security
| Security
| This document describes examples which use virtual TPMs to provide security properties for guests.
| This document describes examples which use virtual TPMs to provide security properties for guests.
| {{Category|Security}}
| {{Category|Security}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/xsm-flask.txt XSM/FLASK Configuration]
| [http://xenbits.xen.org/docs/4.10-testing/misc/xsm-flask.txt XSM/FLASK Configuration]
| Security
| 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]].
| 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}}
| {{Category|Security}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/vtd.txt VT-d HOWTO]
| [http://xenbits.xen.org/docs/4.10-testing/misc/vtd.txt VT-d HOWTO]
| PCI Passthrough
| PCI Passthrough
| How to use Intel's VT-d extensions.
| How to use Intel's VT-d extensions.
| {{Category|VGA}}
| {{Category|VGA}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/x86-xenpv-bootloader.html x86 PV Bootloader]
| [http://xenbits.xen.org/docs/4.10-testing/misc/x86-xenpv-bootloader.html x86 PV Bootloader]
| Configuration
| 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.
| 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.
Line 162: Line 155:
!style="min-width: 100px; max-width: 200px;"| Also See
!style="min-width: 100px; max-width: 200px;"| Also See
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/livepatch.html Live Patching Design]
| [http://xenbits.xen.org/docs/4.10-testing/misc/livepatch.html Live Patching Design]
| Developers
| Developers
| Live Patching is a mechanism is required to binarily patch the running hypervisor with new opcodes that have come about due to primarily security updates. This document describes the design of the API that would allow us to upload to the hypervisor binary patches.
| Live Patching is a mechanism is required to binarily patch the running hypervisor with new opcodes that have come about due to primarily security updates. This document describes the design of the API that would allow us to upload to the hypervisor binary patches.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/kexec_and_kdump.txt Kexec, and kdump for Xen Project]
| [http://xenbits.xen.org/docs/4.10-testing/misc/kexec_and_kdump.txt Kexec, and kdump for Xen Project]
| Developers
| Developers
| Guide to using kexec to switch to a new kernel; and kdump for catching a dump image, with Xen Project.
| Guide to using kexec to switch to a new kernel; and kdump for catching a dump image, with Xen Project.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/dump-core-format.txt Xen Project Core Dump Format]
| [http://xenbits.xen.org/docs/4.10-testing/misc/dump-core-format.txt Xen Project Core Dump Format]
| Developers
| Developers
| Format of the output of the x{m,l} core-dump command
| Format of the output of the x{m,l} core-dump command
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/xenstore.txt XenStore Protocol Definition]
| [http://xenbits.xen.org/docs/4.10-testing/misc/xenstore.txt XenStore Protocol Definition]
| Developers
| Developers
| Definition of standard behaviour, when using Xenstore.
| Definition of standard behaviour, when using Xenstore.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/xenstore-paths.html XenStore Paths]
| [http://xenbits.xen.org/docs/4.10-testing/misc/xenstore-paths.html XenStore Paths]
| Developers
| Developers
| This document attempts to defines all the paths which are in common use by either guests, front-/back-end drivers, toolstacks etc.
| This document attempts to defines all the paths which are in common use by either guests, front-/back-end drivers, toolstacks etc.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/xenstore-ring.txt XenStore Ring]
| [http://xenbits.xen.org/docs/4.10-testing/misc/xenstore-ring.txt XenStore Ring]
| Developers
| 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.
| 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}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/grant-tables.txt A rough introduction to using grant tables]
| [http://xenbits.xen.org/docs/4.10-testing/misc/grant-tables.txt A rough introduction to using grant tables]
| Developers
| 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.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/xen-error-handling.txt Xen Project Error Handling]
| [http://xenbits.xen.org/docs/4.10-testing/misc/xen-error-handling.txt Xen Project Error Handling]
| Developers
| 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.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/hvm-emulated-unplug.html Xen Project HVM emulated device unplug protocol]
| [http://xenbits.xen.org/docs/4.10-testing/misc/hvm-emulated-unplug.html Xen Project HVM emulated device unplug protocol]
| Developers
| 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.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/xenpaging.txt Xen Project paging]
| [http://xenbits.xen.org/docs/4.10-testing/misc/xenpaging.txt Xen Project paging]
| Developers
| 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.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/crashdb.txt Xen Project Crash Debugger]
| [http://xenbits.xen.org/docs/4.10-testing/misc/crashdb.txt Xen Project Crash Debugger]
| Developers
| Developers
| Using gdb to analyse why Xen Hypervisor has crashed.
| Using gdb to analyse why Xen Hypervisor has crashed.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/grant-tables.txt Grant Tables]
| [http://xenbits.xen.org/docs/4.10-testing/misc/grant-tables.txt Grant Tables]
| Developers
| Developers
| Introduction to grant tables
| Introduction to grant tables
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/console.txt PV Console Architecture Overview]
| [http://xenbits.xen.org/docs/4.10-testing/misc/console.txt PV Console Architecture Overview]
| Developers
| 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.
| 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}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/amd-ucode-container.txt AMD Microcode Container File format]
| [http://xenbits.xen.org/docs/4.10-testing/misc/amd-ucode-container.txt AMD Microcode Container File format]
| Developers
| Developers
|
|
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/coverage.html Coverage support for Xen]
| [http://xenbits.xen.org/docs/4.10-testing/misc/coverage.html Coverage support for Xen]
| Developers
| 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.
| 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}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/printk-formats.txt Xen custom %p format options]
| [http://xenbits.xen.org/docs/4.10-testing/misc/printk-formats.txt Xen custom %p format options]
| Developers
| Developers
| Specification of custom %p format options in Xen.
| Specification of custom %p format options in Xen.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/pvh.html PVH Architecture and Specification]
| [http://xenbits.xen.org/docs/4.10-testing/misc/pvh.html PVH Architecture and Specification]
| Developers
| Developers
| This document gives an overview of the PVH implementation
| This document gives an overview of the PVH implementation
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/hypercall/index.html Hypercall ABI documentation]
| [http://xenbits.xen.org/docs/4.10-testing/hypercall/index.html Hypercall ABI documentation]
| Developers
| Developers
| Hypercall ABI documentation for x86 and ARM
| Hypercall ABI documentation for x86 and ARM
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/pv-drivers-lifecycle.html pv-drivers-lifecycle]
| [http://xenbits.xen.org/docs/4.10-testing/misc/pv-drivers-lifecycle.html pv-drivers-lifecycle]
| Developers
| Developers
| Getting new PV drivers accepted in Xen, upstream code bases, and ABI stable in the quickest and most efficient way possible.
| Getting new PV drivers accepted in Xen, upstream code bases, and ABI stable in the quickest and most efficient way possible.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/9pfs.html 9pfs]
| [http://xenbits.xen.org/docs/4.10-testing/misc/9pfs.html 9pfs]
| Developers
| Developers
| 9pfs is a network filesystem protocol developed for Plan 9. 9pfs is very simple and describes a series of commands and responses. It is completely independent from the communication channels, in fact many clients and servers support multiple channels, usually called "transports". For example the Linux client supports tcp and unix sockets, fds, virtio and rdma.
| 9pfs is a network filesystem protocol developed for Plan 9. 9pfs is very simple and describes a series of commands and responses. It is completely independent from the communication channels, in fact many clients and servers support multiple channels, usually called "transports". For example the Linux client supports tcp and unix sockets, fds, virtio and rdma.
| {{Category|Developers}}
| {{Category|Developers}}
|-
|-
| [http://xenbits.xen.org/docs/unstable/misc/pvcalls.html pvcalls]
| [http://xenbits.xen.org/docs/4.10-testing/misc/pvcalls.html pvcalls]
| Developers
| Developers
| PV Calls is a paravirtualized protocol that allows the implementation of a set of POSIX functions in a different domain. The PV Calls frontend sends POSIX function calls to the backend, which implements them and returns a value to the frontend and acts on the function call.
| PV Calls is a paravirtualized protocol that allows the implementation of a set of POSIX functions in a different domain. The PV Calls frontend sends POSIX function calls to the backend, which implements them and returns a value to the frontend and acts on the function call.

Latest revision as of 16:11, 14 May 2018

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-disk-configuration(5)) This document specifies the xl config file format disk configuration option.
xl-network-configuration(5) This document specifies the xl config file format vif configuration option.
xl-numa-placement(7) This document describes the automatic placement options for NUMA hardware in XL.
xen-tscmode(7) 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.

Other Man pages

Document Description
xen-vbd-interface(7) This document specifies the config file syntax with examples for Virtual Block Devices (VBDs)
xen-pv-channel(7) A PV channel is a low-bandwidth private byte stream similar to a serial link. This document explains how to use channels.
xen-pci-device-reservations(7) This document describes the usage and allocation of PCI vendor IDs
xen-vtpm(7) Man page showing how to use vTPM in Xen
xen-vtpmmgr(7) Man page showing how to use the vTPM Manager in Xen
xentrace(8)) xentrace - capture Xen trace buffer data
xentrace_format(1) xentrace_format - pretty-print Xen trace data

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 Example Configurations Security This document describes examples which use virtual TPMs to provide security properties for guests. 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
VT-d HOWTO PCI Passthrough How to use Intel's VT-d extensions. VGA
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
Live Patching Design Developers Live Patching is a mechanism is required to binarily patch the running hypervisor with new opcodes that have come about due to primarily security updates. This document describes the design of the API that would allow us to upload to the hypervisor binary patches. Developers
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
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
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
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
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
pv-drivers-lifecycle Developers Getting new PV drivers accepted in Xen, upstream code bases, and ABI stable in the quickest and most efficient way possible. Developers
9pfs Developers 9pfs is a network filesystem protocol developed for Plan 9. 9pfs is very simple and describes a series of commands and responses. It is completely independent from the communication channels, in fact many clients and servers support multiple channels, usually called "transports". For example the Linux client supports tcp and unix sockets, fds, virtio and rdma. Developers
pvcalls Developers PV Calls is a paravirtualized protocol that allows the implementation of a set of POSIX functions in a different domain. The PV Calls frontend sends POSIX function calls to the backend, which implements them and returns a value to the frontend and acts on the function call. Developers

Also See

Retrieved from "https://wiki.xenproject.org/index.php?title=Xen_Project_4.10_Man_Pages&oldid=18723"