From: Luca Boccassi <bluca@debian.org>
Date: Wed, 1 Feb 2023 19:29:11 +0000 (+0000)
Subject: man: add page for systemd-ac-power
X-Git-Tag: v253-rc2~11
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8310229a04842d654a00c2d03a0f22d27904708e;p=thirdparty%2Fsystemd.git

man: add page for systemd-ac-power

It is now a supported executable, so add manpage.

Fixes https://github.com/systemd/systemd/issues/26289
---

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 75197736b0f..c5b457bd7f9 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -856,6 +856,7 @@ manpages = [
  ['shutdown', '8', [], ''],
  ['sysctl.d', '5', [], ''],
  ['systemctl', '1', [], ''],
+ ['systemd-ac-power', '1', [], ''],
  ['systemd-analyze', '1', [], 'ENABLE_ANALYZE'],
  ['systemd-ask-password-console.service',
   '8',
diff --git a/man/systemd-ac-power.xml b/man/systemd-ac-power.xml
new file mode 100644
index 00000000000..a4c9378cfd7
--- /dev/null
+++ b/man/systemd-ac-power.xml
@@ -0,0 +1,71 @@
+<?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-or-later -->
+
+<refentry id="systemd-ac-power" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+  <refentryinfo>
+    <title>systemd-ac-power</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>systemd-ac-power</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>systemd-ac-power</refname>
+    <refpurpose>Report whether we are connected to an external power source</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>systemd-ac-power</command>
+      <arg choice="opt" rep="repeat">OPTIONS</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><command>systemd-ac-power</command> may be used to check whether the system
+    is running on AC power or not. By default it will simply return success (if we
+    can detect that we are running on AC power) or failure, with no output.
+    This can be useful for example to debug <varname>ConditionACPower=</varname> (see
+    <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Options</title>
+
+    <para>The following options are understood:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><option>-v</option></term>
+        <term><option>--verbose</option></term>
+
+        <listitem><para>Show result as text instead of just returning success or failure.</para></listitem>
+      </varlistentry>
+
+      <xi:include href="standard-options.xml" xpointer="help" />
+      <xi:include href="standard-options.xml" xpointer="version" />
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Exit status</title>
+
+    <para>On success (running on AC power), 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>
+    </para>
+  </refsect1>
+
+</refentry>