man/org.freedesktop.oom1.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" >
   4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   5
   6 <refentry id="org.freedesktop.oom1" conditional='ENABLE_OOMD'
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8   <refentryinfo>
   9     <title>org.freedesktop.oom1</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>org.freedesktop.oom1</refentrytitle>
  15     <manvolnum>5</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>org.freedesktop.oom1</refname>
  20     <refpurpose>The D-Bus interface of systemd-oomd</refpurpose>
  21   </refnamediv>
  22
  23   <refsect1>
  24     <title>Introduction</title>
  25
  26     <para>
  27     <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  28     is a system service which implements a userspace out-of-memory (OOM) killer. This page describes the
  29     D-Bus interface.</para>
  30   </refsect1>
  31
  32   <refsect1>
  33     <title>The Manager Object</title>
  34
  35     <para>The service exposes the following interfaces on the Manager object on the bus:</para>
  36
  37     <programlisting executable="systemd-oomd" node="/org/freedesktop/oom1" interface="org.freedesktop.oom1.Manager">
  38 node /org/freedesktop/oom1 {
  39   interface org.freedesktop.oom1.Manager {
  40     methods:
  41       DumpByFileDescriptor(out h fd);
  42   };
  43   interface org.freedesktop.DBus.Peer { ... };
  44   interface org.freedesktop.DBus.Introspectable { ... };
  45   interface org.freedesktop.DBus.Properties { ... };
  46 };
  47     </programlisting>
  48
  49     <!--method DumpByFileDescriptor is not documented!-->
  50
  51     <!--Autogenerated cross-references for systemd.directives, do not edit-->
  52
  53     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.oom1.Manager"/>
  54
  55     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.oom1.Manager"/>
  56
  57     <variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/>
  58
  59     <!--End of Autogenerated section-->
  60
  61     <refsect2>
  62       <title>Methods</title>
  63
  64       <para>...</para>
  65     </refsect2>
  66   </refsect1>
  67
  68   <refsect1>
  69     <title>Versioning</title>
  70
  71     <para>These D-Bus interfaces follow <ulink url="http://0pointer.de/blog/projects/versioning-dbus.html">
  72     the usual interface versioning guidelines</ulink>.</para>
  73   </refsect1>
  74 </refentry>