diff options
| author |   Daniel Veillard <veillard@redhat.com> | 2006-02-09 18:03:54 +0000 |
|---|---|---|
| committer | Daniel Veillard <veillard@redhat.com> | 2006-02-09 18:03:54 +0000 |
| commit | 5fe8d8b3ff4c21db02478c2778631927a2388270 (patch) | |
| tree | a1cc8f0979cb76628fafb12d733c875ab6b3f310 | |
| parent | * //* : renamed the project libvirt , this affects all makefiles, (diff) | |
| download | libvirt-LIBVIRT_0_0_3.tar.gz libvirt-LIBVIRT_0_0_3.tar.bz2 libvirt-LIBVIRT_0_0_3.zip | |
Fixing generation, Danielv0.0.3LIBVIRT_0_0_3
| -rwxr-xr-x | docs/apibuild.py | 4 | ||||
| -rw-r--r-- | docs/html/book1.html | 2 | ||||
| -rw-r--r-- | docs/html/index.html | 2 | ||||
| -rw-r--r-- | docs/libvirt-api.xml (renamed from docs/libvir-api.xml) | 116 | ||||
| -rw-r--r-- | docs/libvirt-refs.xml (renamed from docs/libvir-refs.xml) | 116 |
5 files changed, 120 insertions, 120 deletions
diff --git a/docs/apibuild.py b/docs/apibuild.py index ada57fbe5..15c01ce85 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -2073,11 +2073,11 @@ class docBuilder: def rebuild(): builder = None - if glob.glob("../src/libvir.c") != [] : + if glob.glob("../src/libvirt.c") != [] : print "Rebuilding API description for libvirt" builder = docBuilder("libvirt", ["../src", "../include"], []) - elif glob.glob("src/libvir.c") != [] : + elif glob.glob("src/libvirt.c") != [] : print "Rebuilding API description for libvir" builder = docBuilder("libvirt", ["src", "include"], []) diff --git a/docs/html/book1.html b/docs/html/book1.html index 99c0a9702..893b6f1e8 100644 --- a/docs/html/book1.html +++ b/docs/html/book1.html @@ -1,3 +1,3 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvir</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvir</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvir.html">libvir</a>: core interfaces for the libvir library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a style="font-weight:bold" href="../html/index.html">API Menu</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> +<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a style="font-weight:bold" href="../html/index.html">API Menu</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> diff --git a/docs/html/index.html b/docs/html/index.html index 99c0a9702..893b6f1e8 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -1,3 +1,3 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvir</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvir</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvir.html">libvir</a>: core interfaces for the libvir library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a style="font-weight:bold" href="../html/index.html">API Menu</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> +<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><link rel="stylesheet" type="text/css" href="../libvirt.css" /><link rel="SHORTCUT ICON" href="/32favicon.png" /><title>Reference Manual for libvirt</title></head><body><div id="container"><div id="intro"><div id="adjustments"></div><div id="pageHeader"></div><div id="content2"><h1 class="style1">Reference Manual for libvirt</h1><h2>Table of Contents</h2><ul><li><a href="libvirt-libvirt.html">libvirt</a>: core interfaces for the libvirt library</li></ul></div></div><div class="linkList2"><div class="llinks2"><h3 class="links2"><span>main menu</span></h3><ul><li><a href="../index.html">Home</a></li><li><a style="font-weight:bold" href="../html/index.html">API Menu</a></li><li><a href="../ChangeLog.html">Recent Changes</a></li></ul></div><div class="llinks2"><h3 class="links2"><span>related links</span></h3><ul><li><a href="https://www.redhat.com/archives/libvir-list/">Mail archive</a></li><li><a href="http://www.cl.cam.ac.uk/Research/SRG/netos/xen/index.html">Xen project</a></li><li><form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="12" value="Search..." /><input name="submit" type="submit" value="Go" /></form></li><li><a href="http://xmlsoft.org/"><img src="../Libxml2-Logo-90x34.gif" alt="Made with Libxml2 Logo" /></a></li></ul><p class="credits">Graphics and design by <a href="mail:dfong@redhat.com">Diana Fong</a></p></div></div><div id="bottom"><p class="p1"></p></div></div></body></html> diff --git a/docs/libvir-api.xml b/docs/libvirt-api.xml index 49dedf2ea..450487ac4 100644 --- a/docs/libvir-api.xml +++ b/docs/libvirt-api.xml @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<api name='libvir'> +<api name='libvirt'> <files> - <file name='libvir'> - <summary>core interfaces for the libvir library</summary> - <description>Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0 </description> + <file name='libvirt'> + <summary>core interfaces for the libvirt library</summary> + <description>Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 </description> <author>Daniel Veillard <veillard@redhat.com> </author> <exports symbol='LIBVIR_VERSION_NUMBER' type='macro'/> <exports symbol='VIR_DOMAIN_SHUTOFF' type='enum'/> @@ -64,33 +64,33 @@ </file> </files> <symbols> - <macro name='LIBVIR_VERSION_NUMBER' file='libvir'> + <macro name='LIBVIR_VERSION_NUMBER' file='libvirt'> <info>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</info> </macro> - <enum name='VIR_DEVICE_DEFAULT' file='libvir' value='0' type='virDeviceMode' info='Default mode'/> - <enum name='VIR_DEVICE_RO' file='libvir' value='1' type='virDeviceMode' info='Access read-only'/> - <enum name='VIR_DEVICE_RW' file='libvir' value='2' type='virDeviceMode' info='Access read-write'/> - <enum name='VIR_DEVICE_RW_FORCE' file='libvir' value='3' type='virDeviceMode' info=' Forced read-write even if already used'/> - <enum name='VIR_DOMAIN_BLOCKED' file='libvir' value='2' type='virDomainState' info='the domain is blocked on resource'/> - <enum name='VIR_DOMAIN_CRASHED' file='libvir' value='6' type='virDomainState' info=' the domain is crashed'/> - <enum name='VIR_DOMAIN_DESTROY' file='libvir' value='1' type='virDomainRestart' info='destroy the domain'/> - <enum name='VIR_DOMAIN_NONE' file='libvir' value='0' type='virDomainCreateFlags'/> - <enum name='VIR_DOMAIN_NOSTATE' file='libvir' value='0' type='virDomainState' info='no state'/> - <enum name='VIR_DOMAIN_PAUSED' file='libvir' value='3' type='virDomainState' info='the domain is paused by user'/> - <enum name='VIR_DOMAIN_PRESERVE' file='libvir' value='3' type='virDomainRestart' info='keep as is, need manual destroy, for debug'/> - <enum name='VIR_DOMAIN_RENAME_RESTART' file='libvir' value='4' type='virDomainRestart' info=' restart under an new unique name'/> - <enum name='VIR_DOMAIN_RESTART' file='libvir' value='2' type='virDomainRestart' info='restart the domain'/> - <enum name='VIR_DOMAIN_RUNNING' file='libvir' value='1' type='virDomainState' info='the domain is running'/> - <enum name='VIR_DOMAIN_SHUTDOWN' file='libvir' value='4' type='virDomainState' info='the domain is being shut down'/> - <enum name='VIR_DOMAIN_SHUTOFF' file='libvir' value='5' type='virDomainState' info='the domain is shut off'/> - <struct name='virConnect' file='libvir' type='struct _virConnect'/> - <typedef name='virConnectPtr' file='libvir' type='virConnect *'> + <enum name='VIR_DEVICE_DEFAULT' file='libvirt' value='0' type='virDeviceMode' info='Default mode'/> + <enum name='VIR_DEVICE_RO' file='libvirt' value='1' type='virDeviceMode' info='Access read-only'/> + <enum name='VIR_DEVICE_RW' file='libvirt' value='2' type='virDeviceMode' info='Access read-write'/> + <enum name='VIR_DEVICE_RW_FORCE' file='libvirt' value='3' type='virDeviceMode' info=' Forced read-write even if already used'/> + <enum name='VIR_DOMAIN_BLOCKED' file='libvirt' value='2' type='virDomainState' info='the domain is blocked on resource'/> + <enum name='VIR_DOMAIN_CRASHED' file='libvirt' value='6' type='virDomainState' info=' the domain is crashed'/> + <enum name='VIR_DOMAIN_DESTROY' file='libvirt' value='1' type='virDomainRestart' info='destroy the domain'/> + <enum name='VIR_DOMAIN_NONE' file='libvirt' value='0' type='virDomainCreateFlags'/> + <enum name='VIR_DOMAIN_NOSTATE' file='libvirt' value='0' type='virDomainState' info='no state'/> + <enum name='VIR_DOMAIN_PAUSED' file='libvirt' value='3' type='virDomainState' info='the domain is paused by user'/> + <enum name='VIR_DOMAIN_PRESERVE' file='libvirt' value='3' type='virDomainRestart' info='keep as is, need manual destroy, for debug'/> + <enum name='VIR_DOMAIN_RENAME_RESTART' file='libvirt' value='4' type='virDomainRestart' info=' restart under an new unique name'/> + <enum name='VIR_DOMAIN_RESTART' file='libvirt' value='2' type='virDomainRestart' info='restart the domain'/> + <enum name='VIR_DOMAIN_RUNNING' file='libvirt' value='1' type='virDomainState' info='the domain is running'/> + <enum name='VIR_DOMAIN_SHUTDOWN' file='libvirt' value='4' type='virDomainState' info='the domain is being shut down'/> + <enum name='VIR_DOMAIN_SHUTOFF' file='libvirt' value='5' type='virDomainState' info='the domain is shut off'/> + <struct name='virConnect' file='libvirt' type='struct _virConnect'/> + <typedef name='virConnectPtr' file='libvirt' type='virConnect *'> <info>a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Xen Hypervisor in the API.</info> </typedef> - <typedef name='virDeviceMode' file='libvir' type='enum'/> - <struct name='virDomain' file='libvir' type='struct _virDomain'/> - <typedef name='virDomainCreateFlags' file='libvir' type='enum'/> - <struct name='virDomainInfo' file='libvir' type='struct _virDomainInfo'> + <typedef name='virDeviceMode' file='libvirt' type='enum'/> + <struct name='virDomain' file='libvirt' type='struct _virDomain'/> + <typedef name='virDomainCreateFlags' file='libvirt' type='enum'/> + <struct name='virDomainInfo' file='libvirt' type='struct _virDomainInfo'> <field name='state' type='unsigned char' info=' the running state, one of virDomainFlags'/> <field name='maxMem' type='unsigned long' info=' the maximum memory in KBytes allowed'/> <field name='memory' type='unsigned long' info=' the memory in KBytes used by the domain'/> @@ -103,62 +103,62 @@ * - add padding to this structure for ABI long term protection *'/> </struct> - <typedef name='virDomainInfoPtr' file='libvir' type='virDomainInfo *'> + <typedef name='virDomainInfoPtr' file='libvirt' type='virDomainInfo *'> <info>a virDomainInfoPtr is a pointer to a virDomainInfo structure.</info> </typedef> - <struct name='virDomainKernel' file='libvir' type='struct _virDomainKernel'> + <struct name='virDomainKernel' file='libvirt' type='struct _virDomainKernel'> <field name='kernel' type='const char *' info=' filename pointing to the kernel image'/> <field name='ramdisk' type='const char *' info=' an optional init ramdisk'/> <field name='root' type='const char *' info=' an optional root block device'/> <field name='extra' type='const char *' info=' optional kernel command line parameters'/> </struct> - <typedef name='virDomainKernelPtr' file='libvir' type='virDomainKernel *'> + <typedef name='virDomainKernelPtr' file='libvirt' type='virDomainKernel *'> <info>a virDomainKernelPtr is a pointer to a virDomainKernel structure.</info> </typedef> - <typedef name='virDomainPtr' file='libvir' type='virDomain *'> + <typedef name='virDomainPtr' file='libvirt' type='virDomain *'> <info>a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API.</info> </typedef> - <typedef name='virDomainRestart' file='libvir' type='enum'/> - <typedef name='virDomainState' file='libvir' type='enum'/> - <function name='virConnectClose' file='libvir' module='libvir'> + <typedef name='virDomainRestart' file='libvirt' type='enum'/> + <typedef name='virDomainState' file='libvirt' type='enum'/> + <function name='virConnectClose' file='libvirt' module='libvirt'> <info>This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.</info> <return type='int' info='0 in case of success or -1 in case of error.'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> </function> - <function name='virConnectGetType' file='libvir' module='libvir'> + <function name='virConnectGetType' file='libvirt' module='libvirt'> <info>Get the name of the Hypervisor software used.</info> <return type='const char *' info='NULL in case of error, a static zero terminated string otherwise.'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> </function> - <function name='virConnectGetVersion' file='libvir' module='libvir'> + <function name='virConnectGetVersion' file='libvirt' module='libvirt'> <info>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with priviledged access to the hypervisor, not with a Read-Only connection.</info> <return type='int' info='-1 in case of error, 0 otherwise. if the version can't be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> <arg name='hvVer' type='unsigned long *' info='return value for the version of the running hypervisor (OUT)'/> </function> - <function name='virConnectListDomains' file='libvir' module='libvir'> + <function name='virConnectListDomains' file='libvirt' module='libvirt'> <info>Collect the list of active domains, and store their ID in @maxids</info> <return type='int' info='the number of domain found or -1 in case of error'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> <arg name='ids' type='int *' info='array to collect the list of IDs of active domains'/> <arg name='maxids' type='int' info='size of @ids'/> </function> - <function name='virConnectNumOfDomains' file='libvir' module='libvir'> + <function name='virConnectNumOfDomains' file='libvirt' module='libvirt'> <info>Provides the number of active domains.</info> <return type='int' info='the number of domain found or -1 in case of error'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> </function> - <function name='virConnectOpen' file='libvir' module='libvir'> + <function name='virConnectOpen' file='libvirt' module='libvirt'> <info>This function should be called first to get a connection to the Hypervisor and xen store</info> <return type='virConnectPtr' info='a pointer to the hypervisor connection or NULL in case of error'/> <arg name='name' type='const char *' info='optional argument currently unused, pass NULL'/> </function> - <function name='virConnectOpenReadOnly' file='libvir' module='libvir'> + <function name='virConnectOpenReadOnly' file='libvirt' module='libvirt'> <info>This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</info> <return type='virConnectPtr' info='a pointer to the hypervisor connection or NULL in case of error'/> <arg name='name' type='const char *' info='optional argument currently unused, pass NULL'/> </function> - <function name='virDomainCreateLinux' file='libvir' module='libvir'> + <function name='virDomainCreateLinux' file='libvirt' module='libvirt'> <info>Launch a new Linux guest domain, unimplemented yet, API to be defined. This would function requires priviledged access to the hypervisor.</info> <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> @@ -168,94 +168,94 @@ <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/> <arg name='flags' type='unsigned int' info='an optional set of virDomainFlags'/> </function> - <function name='virDomainDestroy' file='libvir' module='libvir'> + <function name='virDomainDestroy' file='libvirt' module='libvirt'> <info>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virDomainFree' file='libvir' module='libvir'> + <function name='virDomainFree' file='libvirt' module='libvirt'> <info>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virDomainGetID' file='libvir' module='libvir'> + <function name='virDomainGetID' file='libvirt' module='libvirt'> <info>Get the hypervisor ID number for the domain</info> <return type='unsigned int' info='the domain ID number or (unsigned int) -1 in case of error'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virDomainGetInfo' file='libvir' module='libvir'> + <function name='virDomainGetInfo' file='libvirt' module='libvirt'> <info>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the informations can be extracted.</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> <arg name='info' type='virDomainInfoPtr' info='pointer to a virDomainInfo structure allocated by the user'/> </function> - <function name='virDomainGetMaxMemory' file='libvir' module='libvir'> + <function name='virDomainGetMaxMemory' file='libvirt' module='libvirt'> <info>Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.</info> <return type='unsigned long' info='the memory size in kilobytes or 0 in case of error.'/> <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/> </function> - <function name='virDomainGetName' file='libvir' module='libvir'> + <function name='virDomainGetName' file='libvirt' module='libvirt'> <info>Get the public name for that domain</info> <return type='const char *' info='a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virDomainGetOSType' file='libvir' module='libvir'> + <function name='virDomainGetOSType' file='libvirt' module='libvirt'> <info>Get the type of domain operation system.</info> <return type='char *' info='the new string or NULL in case of error'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virDomainGetXMLDesc' file='libvir' module='xml'> + <function name='virDomainGetXMLDesc' file='libvirt' module='xml'> <info>Provide an XML description of the domain. NOTE: this API is subject to changes.</info> <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> <arg name='flags' type='int' info='and OR'ed set of extraction flags, not used yet'/> </function> - <function name='virDomainLookupByID' file='libvir' module='libvir'> + <function name='virDomainLookupByID' file='libvirt' module='libvirt'> <info>Try to find a domain based on the hypervisor ID number</info> <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> <arg name='id' type='int' info='the domain ID number'/> </function> - <function name='virDomainLookupByName' file='libvir' module='libvir'> + <function name='virDomainLookupByName' file='libvirt' module='libvirt'> <info>Try to lookup a domain on the given hypervisor based on its name.</info> <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> <arg name='name' type='const char *' info='name for the domain'/> </function> - <function name='virDomainRestore' file='libvir' module='libvir'> + <function name='virDomainRestore' file='libvirt' module='libvirt'> <info>This method will restore a domain saved to disk by virDomainSave().</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/> <arg name='from' type='const char *' info='path to the'/> </function> - <function name='virDomainResume' file='libvir' module='libvir'> + <function name='virDomainResume' file='libvirt' module='libvirt'> <info>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged access</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virDomainSave' file='libvir' module='libvir'> + <function name='virDomainSave' file='libvirt' module='libvirt'> <info>This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> <arg name='to' type='const char *' info='path for the output file'/> </function> - <function name='virDomainSetMaxMemory' file='libvir' module='libvir'> + <function name='virDomainSetMaxMemory' file='libvirt' module='libvirt'> <info>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires priviledged access to the hypervisor.</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/> <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/> </function> - <function name='virDomainShutdown' file='libvir' module='libvir'> + <function name='virDomainShutdown' file='libvirt' module='libvirt'> <info>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virDomainSuspend' file='libvir' module='libvir'> + <function name='virDomainSuspend' file='libvirt' module='libvirt'> <info>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires priviledged access.</info> <return type='int' info='0 in case of success and -1 in case of failure.'/> <arg name='domain' type='virDomainPtr' info='a domain object'/> </function> - <function name='virGetVersion' file='libvir' module='libvir'> + <function name='virGetVersion' file='libvirt' module='libvirt'> <info>Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not availble, an error code will be returned and @typeVer will be 0.</info> <return type='int' info='-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.'/> <arg name='libVer' type='unsigned long *' info='return value for the library version (OUT)'/> diff --git a/docs/libvir-refs.xml b/docs/libvirt-refs.xml index 110087e60..af83e808a 100644 --- a/docs/libvir-refs.xml +++ b/docs/libvirt-refs.xml @@ -1,62 +1,62 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<apirefs name='libvir'> +<apirefs name='libvirt'> <references> - <reference name='LIBVIR_VERSION_NUMBER' href='html/libvir-libvir.html#LIBVIR_VERSION_NUMBER'/> - <reference name='VIR_DEVICE_DEFAULT' href='html/libvir-libvir.html#VIR_DEVICE_DEFAULT'/> - <reference name='VIR_DEVICE_RO' href='html/libvir-libvir.html#VIR_DEVICE_RO'/> - <reference name='VIR_DEVICE_RW' href='html/libvir-libvir.html#VIR_DEVICE_RW'/> - <reference name='VIR_DEVICE_RW_FORCE' href='html/libvir-libvir.html#VIR_DEVICE_RW_FORCE'/> - <reference name='VIR_DOMAIN_BLOCKED' href='html/libvir-libvir.html#VIR_DOMAIN_BLOCKED'/> - <reference name='VIR_DOMAIN_CRASHED' href='html/libvir-libvir.html#VIR_DOMAIN_CRASHED'/> - <reference name='VIR_DOMAIN_DESTROY' href='html/libvir-libvir.html#VIR_DOMAIN_DESTROY'/> - <reference name='VIR_DOMAIN_NONE' href='html/libvir-libvir.html#VIR_DOMAIN_NONE'/> - <reference name='VIR_DOMAIN_NOSTATE' href='html/libvir-libvir.html#VIR_DOMAIN_NOSTATE'/> - <reference name='VIR_DOMAIN_PAUSED' href='html/libvir-libvir.html#VIR_DOMAIN_PAUSED'/> - <reference name='VIR_DOMAIN_PRESERVE' href='html/libvir-libvir.html#VIR_DOMAIN_PRESERVE'/> - <reference name='VIR_DOMAIN_RENAME_RESTART' href='html/libvir-libvir.html#VIR_DOMAIN_RENAME_RESTART'/> - <reference name='VIR_DOMAIN_RESTART' href='html/libvir-libvir.html#VIR_DOMAIN_RESTART'/> - <reference name='VIR_DOMAIN_RUNNING' href='html/libvir-libvir.html#VIR_DOMAIN_RUNNING'/> - <reference name='VIR_DOMAIN_SHUTDOWN' href='html/libvir-libvir.html#VIR_DOMAIN_SHUTDOWN'/> - <reference name='VIR_DOMAIN_SHUTOFF' href='html/libvir-libvir.html#VIR_DOMAIN_SHUTOFF'/> - <reference name='_virDomainInfo' href='html/libvir-libvir.html#_virDomainInfo'/> - <reference name='_virDomainKernel' href='html/libvir-libvir.html#_virDomainKernel'/> - <reference name='virConnect' href='html/libvir-libvir.html#virConnect'/> - <reference name='virConnectClose' href='html/libvir-libvir.html#virConnectClose'/> - <reference name='virConnectGetType' href='html/libvir-libvir.html#virConnectGetType'/> - <reference name='virConnectGetVersion' href='html/libvir-libvir.html#virConnectGetVersion'/> - <reference name='virConnectListDomains' href='html/libvir-libvir.html#virConnectListDomains'/> - <reference name='virConnectNumOfDomains' href='html/libvir-libvir.html#virConnectNumOfDomains'/> - <reference name='virConnectOpen' href='html/libvir-libvir.html#virConnectOpen'/> - <reference name='virConnectOpenReadOnly' href='html/libvir-libvir.html#virConnectOpenReadOnly'/> - <reference name='virConnectPtr' href='html/libvir-libvir.html#virConnectPtr'/> - <reference name='virDeviceMode' href='html/libvir-libvir.html#virDeviceMode'/> - <reference name='virDomain' href='html/libvir-libvir.html#virDomain'/> - <reference name='virDomainCreateFlags' href='html/libvir-libvir.html#virDomainCreateFlags'/> - <reference name='virDomainCreateLinux' href='html/libvir-libvir.html#virDomainCreateLinux'/> - <reference name='virDomainDestroy' href='html/libvir-libvir.html#virDomainDestroy'/> - <reference name='virDomainFree' href='html/libvir-libvir.html#virDomainFree'/> - <reference name='virDomainGetID' href='html/libvir-libvir.html#virDomainGetID'/> - <reference name='virDomainGetInfo' href='html/libvir-libvir.html#virDomainGetInfo'/> - <reference name='virDomainGetMaxMemory' href='html/libvir-libvir.html#virDomainGetMaxMemory'/> - <reference name='virDomainGetName' href='html/libvir-libvir.html#virDomainGetName'/> - <reference name='virDomainGetOSType' href='html/libvir-libvir.html#virDomainGetOSType'/> - <reference name='virDomainGetXMLDesc' href='html/libvir-libvir.html#virDomainGetXMLDesc'/> - <reference name='virDomainInfo' href='html/libvir-libvir.html#virDomainInfo'/> - <reference name='virDomainInfoPtr' href='html/libvir-libvir.html#virDomainInfoPtr'/> - <reference name='virDomainKernel' href='html/libvir-libvir.html#virDomainKernel'/> - <reference name='virDomainKernelPtr' href='html/libvir-libvir.html#virDomainKernelPtr'/> - <reference name='virDomainLookupByID' href='html/libvir-libvir.html#virDomainLookupByID'/> - <reference name='virDomainLookupByName' href='html/libvir-libvir.html#virDomainLookupByName'/> - <reference name='virDomainPtr' href='html/libvir-libvir.html#virDomainPtr'/> - <reference name='virDomainRestart' href='html/libvir-libvir.html#virDomainRestart'/> - <reference name='virDomainRestore' href='html/libvir-libvir.html#virDomainRestore'/> - <reference name='virDomainResume' href='html/libvir-libvir.html#virDomainResume'/> - <reference name='virDomainSave' href='html/libvir-libvir.html#virDomainSave'/> - <reference name='virDomainSetMaxMemory' href='html/libvir-libvir.html#virDomainSetMaxMemory'/> - <reference name='virDomainShutdown' href='html/libvir-libvir.html#virDomainShutdown'/> - <reference name='virDomainState' href='html/libvir-libvir.html#virDomainState'/> - <reference name='virDomainSuspend' href='html/libvir-libvir.html#virDomainSuspend'/> - <reference name='virGetVersion' href='html/libvir-libvir.html#virGetVersion'/> + <reference name='LIBVIR_VERSION_NUMBER' href='html/libvirt-libvirt.html#LIBVIR_VERSION_NUMBER'/> + <reference name='VIR_DEVICE_DEFAULT' href='html/libvirt-libvirt.html#VIR_DEVICE_DEFAULT'/> + <reference name='VIR_DEVICE_RO' href='html/libvirt-libvirt.html#VIR_DEVICE_RO'/> + <reference name='VIR_DEVICE_RW' href='html/libvirt-libvirt.html#VIR_DEVICE_RW'/> + <reference name='VIR_DEVICE_RW_FORCE' href='html/libvirt-libvirt.html#VIR_DEVICE_RW_FORCE'/> + <reference name='VIR_DOMAIN_BLOCKED' href='html/libvirt-libvirt.html#VIR_DOMAIN_BLOCKED'/> + <reference name='VIR_DOMAIN_CRASHED' href='html/libvirt-libvirt.html#VIR_DOMAIN_CRASHED'/> + <reference name='VIR_DOMAIN_DESTROY' href='html/libvirt-libvirt.html#VIR_DOMAIN_DESTROY'/> + <reference name='VIR_DOMAIN_NONE' href='html/libvirt-libvirt.html#VIR_DOMAIN_NONE'/> + <reference name='VIR_DOMAIN_NOSTATE' href='html/libvirt-libvirt.html#VIR_DOMAIN_NOSTATE'/> + <reference name='VIR_DOMAIN_PAUSED' href='html/libvirt-libvirt.html#VIR_DOMAIN_PAUSED'/> + <reference name='VIR_DOMAIN_PRESERVE' href='html/libvirt-libvirt.html#VIR_DOMAIN_PRESERVE'/> + <reference name='VIR_DOMAIN_RENAME_RESTART' href='html/libvirt-libvirt.html#VIR_DOMAIN_RENAME_RESTART'/> + <reference name='VIR_DOMAIN_RESTART' href='html/libvirt-libvirt.html#VIR_DOMAIN_RESTART'/> + <reference name='VIR_DOMAIN_RUNNING' href='html/libvirt-libvirt.html#VIR_DOMAIN_RUNNING'/> + <reference name='VIR_DOMAIN_SHUTDOWN' href='html/libvirt-libvirt.html#VIR_DOMAIN_SHUTDOWN'/> + <reference name='VIR_DOMAIN_SHUTOFF' href='html/libvirt-libvirt.html#VIR_DOMAIN_SHUTOFF'/> + <reference name='_virDomainInfo' href='html/libvirt-libvirt.html#_virDomainInfo'/> + <reference name='_virDomainKernel' href='html/libvirt-libvirt.html#_virDomainKernel'/> + <reference name='virConnect' href='html/libvirt-libvirt.html#virConnect'/> + <reference name='virConnectClose' href='html/libvirt-libvirt.html#virConnectClose'/> + <reference name='virConnectGetType' href='html/libvirt-libvirt.html#virConnectGetType'/> + <reference name='virConnectGetVersion' href='html/libvirt-libvirt.html#virConnectGetVersion'/> + <reference name='virConnectListDomains' href='html/libvirt-libvirt.html#virConnectListDomains'/> + <reference name='virConnectNumOfDomains' href='html/libvirt-libvirt.html#virConnectNumOfDomains'/> + <reference name='virConnectOpen' href='html/libvirt-libvirt.html#virConnectOpen'/> + <reference name='virConnectOpenReadOnly' href='html/libvirt-libvirt.html#virConnectOpenReadOnly'/> + <reference name='virConnectPtr' href='html/libvirt-libvirt.html#virConnectPtr'/> + <reference name='virDeviceMode' href='html/libvirt-libvirt.html#virDeviceMode'/> + <reference name='virDomain' href='html/libvirt-libvirt.html#virDomain'/> + <reference name='virDomainCreateFlags' href='html/libvirt-libvirt.html#virDomainCreateFlags'/> + <reference name='virDomainCreateLinux' href='html/libvirt-libvirt.html#virDomainCreateLinux'/> + <reference name='virDomainDestroy' href='html/libvirt-libvirt.html#virDomainDestroy'/> + <reference name='virDomainFree' href='html/libvirt-libvirt.html#virDomainFree'/> + <reference name='virDomainGetID' href='html/libvirt-libvirt.html#virDomainGetID'/> + <reference name='virDomainGetInfo' href='html/libvirt-libvirt.html#virDomainGetInfo'/> + <reference name='virDomainGetMaxMemory' href='html/libvirt-libvirt.html#virDomainGetMaxMemory'/> + <reference name='virDomainGetName' href='html/libvirt-libvirt.html#virDomainGetName'/> + <reference name='virDomainGetOSType' href='html/libvirt-libvirt.html#virDomainGetOSType'/> + <reference name='virDomainGetXMLDesc' href='html/libvirt-libvirt.html#virDomainGetXMLDesc'/> + <reference name='virDomainInfo' href='html/libvirt-libvirt.html#virDomainInfo'/> + <reference name='virDomainInfoPtr' href='html/libvirt-libvirt.html#virDomainInfoPtr'/> + <reference name='virDomainKernel' href='html/libvirt-libvirt.html#virDomainKernel'/> + <reference name='virDomainKernelPtr' href='html/libvirt-libvirt.html#virDomainKernelPtr'/> + <reference name='virDomainLookupByID' href='html/libvirt-libvirt.html#virDomainLookupByID'/> + <reference name='virDomainLookupByName' href='html/libvirt-libvirt.html#virDomainLookupByName'/> + <reference name='virDomainPtr' href='html/libvirt-libvirt.html#virDomainPtr'/> + <reference name='virDomainRestart' href='html/libvirt-libvirt.html#virDomainRestart'/> + <reference name='virDomainRestore' href='html/libvirt-libvirt.html#virDomainRestore'/> + <reference name='virDomainResume' href='html/libvirt-libvirt.html#virDomainResume'/> + <reference name='virDomainSave' href='html/libvirt-libvirt.html#virDomainSave'/> + <reference name='virDomainSetMaxMemory' href='html/libvirt-libvirt.html#virDomainSetMaxMemory'/> + <reference name='virDomainShutdown' href='html/libvirt-libvirt.html#virDomainShutdown'/> + <reference name='virDomainState' href='html/libvirt-libvirt.html#virDomainState'/> + <reference name='virDomainSuspend' href='html/libvirt-libvirt.html#virDomainSuspend'/> + <reference name='virGetVersion' href='html/libvirt-libvirt.html#virGetVersion'/> </references> <alpha> <letter name='L'> @@ -187,7 +187,7 @@ </type> </functions> <files> - <file name='libvir'> + <file name='libvirt'> <ref name='LIBVIR_VERSION_NUMBER'/> <ref name='VIR_DEVICE_DEFAULT'/> <ref name='VIR_DEVICE_RO'/> |