man/oomctl.xml

   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 cgroups and system contexts stored by
  52         <command>systemd-oomd</command>.</para>
  53
  54         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
  55       </varlistentry>
  56
  57     </variablelist>
  58
  59   </refsect1>
  60
  61   <refsect1>
  62     <title>Options</title>
  63
  64     <para>The following options are understood:</para>
  65
  66     <variablelist>
  67       <xi:include href="standard-options.xml" xpointer="help" />
  68       <xi:include href="standard-options.xml" xpointer="version" />
  69       <xi:include href="standard-options.xml" xpointer="no-pager" />
  70     </variablelist>
  71   </refsect1>
  72
  73   <refsect1>
  74     <title>Exit status</title>
  75
  76     <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
  77   </refsect1>
  78
  79   <refsect1>
  80     <title>See Also</title>
  81     <para><simplelist type="inline">
  82       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
  83       <member><citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
  84       <member><citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
  85     </simplelist></para>
  86   </refsect1>
  87
  88 </refentry>