diff options
| author | Anita Zhang <the.anitazha@gmail.com> | 2020-09-09 10:04:36 +0200 |
|---|---|---|
| committer | Anita Zhang <the.anitazha@gmail.com> | 2020-10-09 11:40:19 +0200 |
| commit | cf3e57884e8a61548684df44dab3f44b5a7f1748 (patch) | |
| tree | 8f33ad552ae05b242b64a9c9233fd3801ac21575 /man/oomctl.xml | |
| parent | core: add systemd-oomd implicit dependencies (diff) | |
| download | systemd-cf3e57884e8a61548684df44dab3f44b5a7f1748.tar.xz systemd-cf3e57884e8a61548684df44dab3f44b5a7f1748.zip | |
man: document systemd-oomd and related items
Diffstat (limited to 'man/oomctl.xml')
| -rw-r--r-- | man/oomctl.xml | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/man/oomctl.xml b/man/oomctl.xml new file mode 100644 index 0000000000..10633b92fc --- /dev/null +++ b/man/oomctl.xml @@ -0,0 +1,86 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!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="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 cgroup(s) and system context(s) stored by + <command>systemd-oomd</command>.</para></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> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> |