]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/org.freedesktop.machine1.xml
man: add more details for IMPORT, PROGRAM and RUN keys
[thirdparty/systemd.git] / man / org.freedesktop.machine1.xml
index 3a2a4500b6705fc4e348355970861cec8fadcaa9..a54fa040b264263185789221447878dd7126065f 100644 (file)
 
     <para>The service exposes the following interfaces on the Manager object on the bus:</para>
 
-    <programlisting>
-$ gdbus introspect --system \
-        --dest org.freedesktop.machine1 \
-        --object-path /org/freedesktop/machine1
-
+    <programlisting executable="systemd-machined" node="/org/freedesktop/machine1" interface="org.freedesktop.machine1.Manager">
 node /org/freedesktop/machine1 {
   interface org.freedesktop.machine1.Manager {
     methods:
@@ -171,7 +167,115 @@ node /org/freedesktop/machine1 {
   interface org.freedesktop.DBus.Introspectable { ... };
   interface org.freedesktop.DBus.Properties { ... };
 };
-</programlisting>
+    </programlisting>
+
+    <!--method UnregisterMachine is not documented!-->
+
+    <!--method OpenMachineRootDirectory is not documented!-->
+
+    <!--method GetMachineUIDShift is not documented!-->
+
+    <!--method GetImageHostname is not documented!-->
+
+    <!--method GetImageMachineID is not documented!-->
+
+    <!--method GetImageMachineInfo is not documented!-->
+
+    <!--method GetImageOSRelease is not documented!-->
+
+    <!--method CleanPool is not documented!-->
+
+    <!--Autogenerated cross-references for systemd.directives, do not edit-->
+
+    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.machine1.Manager"/>
+
+    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.machine1.Manager"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetImage()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetMachineByPID()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="ListMachines()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="ListImages()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CreateMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CreateMachineWithNetwork()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="RegisterMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="RegisterMachineWithNetwork()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="UnregisterMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="TerminateMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="KillMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetMachineAddresses()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetMachineOSRelease()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenMachinePTY()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenMachineLogin()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenMachineShell()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="BindMountMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CopyFromMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CopyToMachine()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenMachineRootDirectory()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetMachineUIDShift()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="RemoveImage()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="RenameImage()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CloneImage()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="MarkImageReadOnly()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetImageHostname()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetImageMachineID()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetImageMachineInfo()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetImageOSRelease()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="SetPoolLimit()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="SetImageLimit()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CleanPool()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="MapFromMachineUser()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="MapToMachineUser()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="MapFromMachineGroup()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="MapToMachineGroup()"/>
+
+    <variablelist class="dbus-signal" generated="True" extra-ref="MachineNew"/>
+
+    <variablelist class="dbus-signal" generated="True" extra-ref="MachineRemoved"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="PoolPath"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="PoolUsage"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="PoolLimit"/>
+
+    <!--End of Autogenerated section-->
 
     <refsect2>
       <title>Methods</title>
@@ -264,7 +368,8 @@ node /org/freedesktop/machine1 {
 
       <para><function>OpenMachinePTY()</function> allocates a pseudo TTY in the container and returns a file
       descriptor and its path. This is equivalent to transitioning into the container and invoking
-      <citerefentry><refentrytitle>posix_openpt</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
+      <citerefentry project='man-pages'><refentrytitle>posix_openpt</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
+      </para>
 
       <para><function>OpenMachineLogin()</function> allocates a pseudo TTY in the container and ensures that
       a getty login prompt of the container is running on the other end. It returns the file descriptor of
@@ -327,11 +432,7 @@ node /org/freedesktop/machine1 {
   <refsect1>
     <title>Machine Objects</title>
 
-    <programlisting>
-$ gdbus introspect --system \
-        --dest org.freedesktop.machine1 \
-        --object-path /org/freedesktop/machine1/machine/rawhide
-
+    <programlisting executable="systemd-machined" node="/org/freedesktop/machine1/machine/rawhide" interface="org.freedesktop.machine1.Machine">
 node /org/freedesktop/machine1/machine/rawhide {
   interface org.freedesktop.machine1.Machine {
     methods:
@@ -390,6 +491,76 @@ node /org/freedesktop/machine1/machine/rawhide {
 };
     </programlisting>
 
+    <!--method GetUIDShift is not documented!-->
+
+    <!--method OpenPTY is not documented!-->
+
+    <!--method OpenLogin is not documented!-->
+
+    <!--method OpenShell is not documented!-->
+
+    <!--method BindMount is not documented!-->
+
+    <!--method CopyFrom is not documented!-->
+
+    <!--method CopyTo is not documented!-->
+
+    <!--method OpenRootDirectory is not documented!-->
+
+    <!--Autogenerated cross-references for systemd.directives, do not edit-->
+
+    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.machine1.Machine"/>
+
+    <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.machine1.Machine"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="Terminate()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="Kill()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetAddresses()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetOSRelease()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="GetUIDShift()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenPTY()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenLogin()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenShell()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="BindMount()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CopyFrom()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="CopyTo()"/>
+
+    <variablelist class="dbus-method" generated="True" extra-ref="OpenRootDirectory()"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="Name"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="Id"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="Timestamp"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="TimestampMonotonic"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="Service"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="Unit"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="Leader"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="Class"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="RootDirectory"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="NetworkInterfaces"/>
+
+    <variablelist class="dbus-property" generated="True" extra-ref="State"/>
+
+    <!--End of Autogenerated section-->
+
     <refsect2>
       <title>Methods</title>
 
@@ -439,6 +610,30 @@ node /org/freedesktop/machine1/machine/rawhide {
     </refsect2>
   </refsect1>
 
+  <refsect1>
+    <title>Examples</title>
+
+    <example>
+      <title>Introspect <interfacename>org.freedesktop.machine1.Manager</interfacename> on the bus</title>
+
+      <programlisting>
+$ gdbus introspect --system \
+  --dest org.freedesktop.machine1 \
+  --object-path /org/freedesktop/machine1
+      </programlisting>
+    </example>
+
+    <example>
+      <title>Introspect <interfacename>org.freedesktop.machine1.Machine</interfacename> on the bus</title>
+
+      <programlisting>
+$ gdbus introspect --system \
+  --dest org.freedesktop.machine1 \
+  --object-path /org/freedesktop/machine1/machine/rawhide
+      </programlisting>
+    </example>
+  </refsect1>
+
   <refsect1>
     <title>Versioning</title>