summaryrefslogtreecommitdiff
path: root/man/pm-pmu.xml
blob: cdd89b9123e9c3c03a859b71abf1f8f8879c1c78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

  <!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>8</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 suspend a computer on machines using a Macintosh-style PMU</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>
      <citerefentry>
        <refentrytitle>pm-suspend</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>This manual page was written by Richard Hughes <email>richard@hughsie.com</email>.
    </para>
  </refsect1>
</refentry>