diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-10-15 15:08:31 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-10-15 15:08:31 +0200 |
commit | 699a810b3f4c34a489d818c15d001156ec470e3c (patch) | |
tree | 821e9353b12c8dea3c6778a9dd3b12e130f6bacc /man/org.freedesktop.oom1.xml | |
parent | oomd: add names to dbus parameters and implement --bus-introspection (diff) | |
download | systemd-699a810b3f4c34a489d818c15d001156ec470e3c.tar.xz systemd-699a810b3f4c34a489d818c15d001156ec470e3c.zip |
man: add org.freedesktop.oom1(5) stub
Diffstat (limited to 'man/org.freedesktop.oom1.xml')
-rw-r--r-- | man/org.freedesktop.oom1.xml | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/man/org.freedesktop.oom1.xml b/man/org.freedesktop.oom1.xml new file mode 100644 index 0000000000..289a7b6e89 --- /dev/null +++ b/man/org.freedesktop.oom1.xml @@ -0,0 +1,74 @@ +<?xml version='1.0'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > +<!-- SPDX-License-Identifier: LGPL-2.1+ --> + +<refentry id="org.freedesktop.oom1" conditional='ENABLE_OOMD' + xmlns:xi="http://www.w3.org/2001/XInclude"> + <refentryinfo> + <title>org.freedesktop.oom1</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>org.freedesktop.oom1</refentrytitle> + <manvolnum>5</manvolnum> + </refmeta> + + <refnamediv> + <refname>org.freedesktop.oom1</refname> + <refpurpose>The D-Bus interface of systemd-oomd</refpurpose> + </refnamediv> + + <refsect1> + <title>Introduction</title> + + <para> + <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + is a system service which implements a userspace out-of-memory (OOM) killer. This page describes the + D-Bus interface.</para> + </refsect1> + + <refsect1> + <title>The Manager Object</title> + + <para>The service exposes the following interfaces on the Manager object on the bus:</para> + + <programlisting executable="systemd-oomd" node="/org/freedesktop/oom1" interface="org.freedesktop.oom1.Manager"> +node /org/freedesktop/oom1 { + interface org.freedesktop.oom1.Manager { + methods: + DumpByFileDescriptor(out h fd); + }; + interface org.freedesktop.DBus.Peer { ... }; + interface org.freedesktop.DBus.Introspectable { ... }; + interface org.freedesktop.DBus.Properties { ... }; +}; + </programlisting> + + <!--method DumpByFileDescriptor is not documented!--> + + <!--Autogenerated cross-references for systemd.directives, do not edit--> + + <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.oom1.Manager"/> + + <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.oom1.Manager"/> + + <variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/> + + <!--End of Autogenerated section--> + + <refsect2> + <title>Methods</title> + + <para>...</para> + </refsect2> + </refsect1> + + <refsect1> + <title>Versioning</title> + + <para>These D-Bus interfaces follow <ulink url="http://0pointer.de/blog/projects/versioning-dbus.html"> + the usual interface versioning guidelines</ulink>.</para> + </refsect1> +</refentry> |