summaryrefslogtreecommitdiff
path: root/man/pm-pmu.sgml
diff options
context:
space:
mode:
authorRichard Hughes <richard@hughsie.com>2006-06-05 20:49:48 +0000
committerRichard Hughes <richard@hughsie.com>2006-06-05 20:49:48 +0000
commitf120e807617807d4a04fbdb186d9a89677317a13 (patch)
tree1af51b7d94ed64831afb03ef07c6499b7752e1f7 /man/pm-pmu.sgml
parente32beb674d911c0c0bf8195bde9e29e0fbb1141d (diff)
2006-06-05 Richard Hughes <richard@hughsie.com>
* man/on_ac_power.sgml: * man/pm-pmu.sgml: Don't use hardcoded .1 files, instead generate them using sgml files.
Diffstat (limited to 'man/pm-pmu.sgml')
-rw-r--r--man/pm-pmu.sgml102
1 files changed, 102 insertions, 0 deletions
diff --git a/man/pm-pmu.sgml b/man/pm-pmu.sgml
new file mode 100644
index 0000000..c0a7e55
--- /dev/null
+++ b/man/pm-pmu.sgml
@@ -0,0 +1,102 @@
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+ <!ENTITY date "<date>05 June, 2006</date>">
+ <!ENTITY package "pm-pmu">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+ <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
+]>
+
+<refentry>
+ <refentryinfo>
+ <address>
+ <email>richard@hughsie.com</email>;
+ </address>
+ <author>
+ <firstname>Richard</firstname>
+ <surname>Hughes</surname>
+ </author>
+ <copyright>
+ <year>2006</year>
+ <holder>Richard Hughes</holder>
+ </copyright>
+ &date;
+ </refentryinfo>
+ <refmeta>
+ <refentrytitle>&package;</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+ <refnamediv>
+ <refname>&package;</refname>
+ <refpurpose>suspend the computer on machines using a Macintosh-style PMU</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&package;</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>DESCRIPTION</title>
+ <para>This manual page documents briefly the
+ <command>&package;</command> command.</para>
+ <para><command>&package;</command> is a command line program to test whether the computer is running on line power</para>
+ </refsect1>
+ <refsect1>
+ <title>EXIT CODES</title>
+ <para>
+ The command succeeds (status 0) if the machine uses a Macintosh-style
+ PMU, and suspended successfully. The command fails (status other than
+ 0) otherwise.
+ It is designed to be easy to use in shell scripts.
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>0 (true)</option>
+ </term>
+ <listitem>
+ <para>System was suspended using PMU.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>1 (false)</option>
+ </term>
+ <listitem>
+ <para>System could not be suspended using PMU.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+ <para>This program follows the usual &gnu; command line syntax,
+ with long options starting with two dashes (`-'). A summary of
+ options is included below. </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>--suspend</option>
+ </term>
+ <listitem>
+ <para>Suspend the computer.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>--help</option>
+ </term>
+ <listitem>
+ <para>Show help message.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
+ <title>SEE ALSO</title>
+ <para>pm-suspend (1).</para>
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+ <para>This manual page was written by Richard Hughes <email>richard@hughsie.com</email>.
+ </para>
+ </refsect1>
+</refentry>