diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/on_ac_power.sgml | 85 | ||||
| -rw-r--r-- | man/pm-pmu.sgml | 102 |
2 files changed, 187 insertions, 0 deletions
diff --git a/man/on_ac_power.sgml b/man/on_ac_power.sgml new file mode 100644 index 0000000..a490398 --- /dev/null +++ b/man/on_ac_power.sgml @@ -0,0 +1,85 @@ +<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ + <!ENTITY date "<date>05 June, 2006</date>"> + <!ENTITY package "on_ac_power"> + <!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>test whether the computer is running on line power</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 system is using line power + and 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 is on line power.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>1 (false)</option> + </term> + <listitem> + <para>System is not on line power.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <option>255 (false)</option> + </term> + <listitem> + <para>Power status could not be determined.</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> 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> |