HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

man/oomctl.xml

2,713 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: 02289f674189dfe55599402256461d8aa9ee5df2

Lines 1–89 of 89

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
<refentry id="oomctl" conditional='ENABLE_OOMD'
  xmlns:xi="http://www.w3.org/2001/XInclude">
 
  <refentryinfo>
    <title>oomctl</title>
    <productname>systemd</productname>
  </refentryinfo>
 
  <refmeta>
    <refentrytitle>oomctl</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
 
  <refnamediv>
    <refname>oomctl</refname>
    <refpurpose>Analyze the state stored in <command>systemd-oomd</command></refpurpose>
  </refnamediv>
 
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>oomctl</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="req">COMMAND</arg>
    </cmdsynopsis>
  </refsynopsisdiv>
 
  <refsect1>
    <title>Description</title>
 
    <para><command>oomctl</command> may be used to get information about the various contexts read in by
    the <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> userspace
    out-of-memory (OOM) killer,
    <citerefentry><refentrytitle>systemd-oomd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 
  </refsect1>
 
  <refsect1>
    <title>Commands</title>
 
    <para>The following commands are understood:</para>
 
    <variablelist>
      <varlistentry>
        <term><command>dump</command></term>
 
        <listitem><para>Show the current state of the cgroups and system contexts stored by
        <command>systemd-oomd</command>.</para>
 
        <xi:include href="version-info.xml" xpointer="v247"/></listitem>
      </varlistentry>
 
    </variablelist>
 
  </refsect1>
 
  <refsect1>
    <title>Options</title>
 
    <para>The following options are understood:</para>
 
    <variablelist>
      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
      <xi:include href="standard-options.xml" xpointer="no-pager" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>Exit status</title>
 
    <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
    <para><simplelist type="inline">
      <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
    </simplelist></para>
  </refsect1>
 
</refentry>