1<?xml version='1.0'?> <!--*-nxml-*-->
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-or-later -->
5
6<refentry id="oomctl" conditional='ENABLE_OOMD'
7  xmlns:xi="http://www.w3.org/2001/XInclude">
8
9  <refentryinfo>
10    <title>oomctl</title>
11    <productname>systemd</productname>
12  </refentryinfo>
13
14  <refmeta>
15    <refentrytitle>oomctl</refentrytitle>
16    <manvolnum>1</manvolnum>
17  </refmeta>
18
19  <refnamediv>
20    <refname>oomctl</refname>
21    <refpurpose>Analyze the state stored in <command>systemd-oomd</command></refpurpose>
22  </refnamediv>
23
24  <refsynopsisdiv>
25    <cmdsynopsis>
26      <command>oomctl</command>
27      <arg choice="opt" rep="repeat">OPTIONS</arg>
28      <arg choice="req">COMMAND</arg>
29    </cmdsynopsis>
30  </refsynopsisdiv>
31
32  <refsect1>
33    <title>Description</title>
34
35    <para><command>oomctl</command> may be used to get information about the various contexts read in by
36    the <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> userspace
37    out-of-memory (OOM) killer,
38    <citerefentry><refentrytitle>systemd-oomd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
39
40  </refsect1>
41
42  <refsect1>
43    <title>Commands</title>
44
45    <para>The following commands are understood:</para>
46
47    <variablelist>
48      <varlistentry>
49        <term><command>dump</command></term>
50
51        <listitem><para>Show the current state of the cgroup(s) and system context(s) stored by
52        <command>systemd-oomd</command>.</para></listitem>
53      </varlistentry>
54
55    </variablelist>
56
57  </refsect1>
58
59  <refsect1>
60    <title>Options</title>
61
62    <para>The following options are understood:</para>
63
64    <variablelist>
65      <xi:include href="standard-options.xml" xpointer="help" />
66      <xi:include href="standard-options.xml" xpointer="version" />
67      <xi:include href="standard-options.xml" xpointer="no-pager" />
68    </variablelist>
69  </refsect1>
70
71  <refsect1>
72    <title>Exit status</title>
73
74    <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
75  </refsect1>
76
77  <refsect1>
78    <title>See Also</title>
79    <para>
80      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
81      <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
82      <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
83    </para>
84  </refsect1>
85
86</refentry>
87