libvirt/docs/examples/examples.xml

<examples>
  <example filename='info1.c'>
    <synopsis>Extract informations about Xen domain 0</synopsis>
    <purpose>Demonstrate the basic use of the library to connect to the hypervisor and extract domain informations.</purpose>
    <usage>info1</usage>
    <test>info1</test>
    <author>Daniel Veillard</author>
    <copy>see Copyright for the status of this software. </copy>
    <section>Informations</section>
    <includes>
    </includes>
    <uses>
      <function line='43' file='libvirt' name='virDomainGetInfo'/>
      <function line='53' file='libvirt' name='virDomainFree'/>
      <function line='36' file='libvirt' name='virDomainLookupByID'/>
      <function line='55' file='libvirt' name='virConnectClose'/>
      <struct line='25' file='libvirt' name='virDomainInfo'/>
      <function line='29' file='libvirt' name='virConnectOpenReadOnly'/>
    </uses>
  </example>
  <example filename='suspend.c'>
    <synopsis>Suspend a domain and then resume its execution</synopsis>
    <purpose>Demonstrate the basic use of the library to suspend and resume a domain. If no id is given on the command line this script will suspend and resume the first domain found which is not Domain 0.</purpose>
    <usage>suspend [id]</usage>
    <test>suspend</test>
    <author>Daniel Veillard</author>
    <copy>see Copyright for the status of this software. </copy>
    <section>Scheduling</section>
    <includes>
    </includes>
    <uses>
      <function line='30' file='libvirt' name='virDomainGetInfo'/>
      <function line='110' file='libvirt' name='virConnectListDomains'/>
      <function line='92' file='libvirt' name='virDomainFree'/>
      <function line='72' file='libvirt' name='virDomainResume'/>
      <function line='49' file='libvirt' name='virDomainLookupByID'/>
      <function line='131' file='libvirt' name='virConnectClose'/>
      <struct line='27' file='libvirt' name='virDomainInfo'/>
      <function line='61' file='libvirt' name='virDomainSuspend'/>
      <function line='99' file='libvirt' name='virConnectOpenReadOnly'/>
    </uses>
  </example>
  <symbols>
    <symbol name='virConnectClose'>
      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virConnectListDomains'>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virConnectOpenReadOnly'>
      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virDomainFree'>
      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virDomainGetInfo'>
      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virDomainInfo'>
      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virDomainLookupByID'>
      <ref filename='info1.c'/>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virDomainResume'>
      <ref filename='suspend.c'/>
    </symbol>
    <symbol name='virDomainSuspend'>
      <ref filename='suspend.c'/>
    </symbol>
  </symbols>
  <sections>
    <section name='Informations'>
      <example filename='info1.c'/>
    </section>
    <section name='Scheduling'>
      <example filename='suspend.c'/>
    </section>
  </sections>
</examples>