diff options
author | David Zeuthen <davidz@redhat.com> | 2008-05-08 22:29:38 -0400 |
---|---|---|
committer | David Zeuthen <davidz@redhat.com> | 2008-05-08 22:29:38 -0400 |
commit | 37f9df9b0568f9834452c949336783bf34e02ab9 (patch) | |
tree | 567a010da3aa10870c7f52f1c311a5e36bc9cc0f /doc/man |
initial commit
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/DeviceKit-power.xml | 64 | ||||
-rw-r--r-- | doc/man/Makefile.am | 24 | ||||
-rw-r--r-- | doc/man/devkit-power-daemon.xml | 84 | ||||
-rw-r--r-- | doc/man/devkit-power.xml | 99 |
4 files changed, 271 insertions, 0 deletions
diff --git a/doc/man/DeviceKit-power.xml b/doc/man/DeviceKit-power.xml new file mode 100644 index 0000000..8f5ab6d --- /dev/null +++ b/doc/man/DeviceKit-power.xml @@ -0,0 +1,64 @@ +<refentry id="DeviceKit-power.7"> + <refentryinfo> + <title>DeviceKit-power</title> + <date>March 2008</date> + <productname>DeviceKit-power</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>DeviceKit-power</refentrytitle> + <manvolnum>7</manvolnum> + <refmiscinfo class="version"></refmiscinfo> + </refmeta> + + <refnamediv> + <refname>DeviceKit-power</refname> + <refpurpose>System-wide Power Management</refpurpose> + </refnamediv> + + <refsect1><title>DESCRIPTION</title> + <para> + DeviceKit-power provides an interface to enumerate power sources + on the system and control system-wide power management. Any + application can access + the <emphasis>org.freedesktop.DeviceKit.Power</emphasis> service + on the system message bus. Some operations (such as suspending + the system) is restricted using PolicyKit. + </para> + </refsect1> + + <refsect1><title>AUTHOR</title> + <para> + Written by David Zeuthen <email>david@fubar.dk</email> with + a lot of help from many others. + </para> + </refsect1> + + <refsect1> + <title>BUGS</title> + <para> + Please send bug reports to either the distribution or the + hal mailing list, + see <ulink url="http://lists.freedesktop.org/mailman/listinfo/hal"/>. + to subscribe. + </para> + </refsect1> + + <refsect1> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>DeviceKit</refentrytitle><manvolnum>7</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>PolicyKit</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>devkit-power-daemon</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>devkit-power</refentrytitle><manvolnum>1</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry> diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 0000000..f49dde9 --- /dev/null +++ b/doc/man/Makefile.am @@ -0,0 +1,24 @@ + +NULL = + +if MAN_PAGES_ENABLED + +man_MANS = \ + devkit-power.1 \ + devkit-power-daemon.8 \ + DeviceKit-power.7 \ + $(NULL) + +%.1 %.7 %.8 : %.xml + $(XSLTPROC) -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $< + +endif # MAN_PAGES_ENABLED + +EXTRA_DIST= \ + devkit-power.xml \ + devkit-power-daemon.xml \ + DeviceKit-power.xml \ + $(NULL) + +clean-local: + rm -f *~ *.[178] diff --git a/doc/man/devkit-power-daemon.xml b/doc/man/devkit-power-daemon.xml new file mode 100644 index 0000000..e969586 --- /dev/null +++ b/doc/man/devkit-power-daemon.xml @@ -0,0 +1,84 @@ +<refentry id="devkit-power-daemon.8"> + <refentryinfo> + <title>devkit-power-daemon</title> + <date>April 2008</date> + <productname>devkit-power-daemon</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>devkit-power-daemon</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="version"></refmiscinfo> + </refmeta> + + <refnamediv> + <refname>devkit-power-daemon</refname> + <refpurpose>DeviceKit-power Daemon</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>devkit-power-daemon</command> + <arg><option>--help</option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + + <refsect1><title>DESCRIPTION</title> + <para> + <emphasis><refentrytitle>devkit-power-daemon</refentrytitle></emphasis> provides + the <emphasis>org.freedesktop.DeviceKit.Power</emphasis> service on the + system message bus. Users or administrators should never need to + start this daemon as it will be automatically started by + <citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry> + whenever an application calls into the <emphasis>org.freedesktop.DeviceKit.Power</emphasis> + service. + </para> + </refsect1> + + <refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Show help options. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1><title>AUTHOR</title> + <para> + Written by David Zeuthen <email>david@fubar.dk</email> with + a lot of help from many others. + </para> + </refsect1> + + <refsect1> + <title>BUGS</title> + <para> + Please send bug reports to either the distribution or the + hal mailing list, + see <ulink url="http://lists.freedesktop.org/mailman/listinfo/hal"/> + on how to subscribe. + </para> + </refsect1> + + <refsect1> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>DeviceKit-power</refentrytitle><manvolnum>7</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>devkit-power</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum> + </citerefentry>, + </para> + </refsect1> +</refentry> diff --git a/doc/man/devkit-power.xml b/doc/man/devkit-power.xml new file mode 100644 index 0000000..fd25a79 --- /dev/null +++ b/doc/man/devkit-power.xml @@ -0,0 +1,99 @@ +<refentry id="devkit-power.1"> + <refentryinfo> + <title>devkit-power</title> + <date>April 2008</date> + <productname>devkit-power</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>devkit-power</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="version"></refmiscinfo> + </refmeta> + + <refnamediv> + <refname>devkit-power</refname> + <refpurpose>DeviceKit-power command line tool</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>devkit-power</command> + <arg><option>--enumerate</option></arg> + <arg><option>--monitor</option></arg> + <arg><option>--monitor-detail</option></arg> + <arg><option>--help</option></arg> + </cmdsynopsis> + </refsynopsisdiv> + + + <refsect1><title>DESCRIPTION</title> + <para> + <emphasis><refentrytitle>devkit-power</refentrytitle></emphasis> is a + simple command line client for the + <citerefentry><refentrytitle>DeviceKit-power</refentrytitle><manvolnum>7</manvolnum></citerefentry> + daemon. TODO: not fully documented. + </para> + </refsect1> + + <refsect1> + <title>OPTIONS</title> + <variablelist> + <varlistentry> + <term><option>--monitor</option></term> + <listitem> + <para> + Connect to the DeviceKit-power daemon and print a line + every time a power source is added, removed or changed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--monitor-detail</option></term> + <listitem> + <para> + Like <option>--monitor</option> but prints the full + details of the power source whenever an event happens. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para> + Show help options. + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1><title>AUTHOR</title> + <para> + Written by David Zeuthen <email>david@fubar.dk</email> with + a lot of help from many others. + </para> + </refsect1> + + <refsect1> + <title>BUGS</title> + <para> + Please send bug reports to either the distribution or the + hal mailing list, + see <ulink url="http://lists.freedesktop.org/mailman/listinfo/hal"/> + on how to subscribe. + </para> + </refsect1> + + <refsect1> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>devkit-power-daemon</refentrytitle><manvolnum>8</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>DeviceKit-power</refentrytitle><manvolnum>7</manvolnum> + </citerefentry>, + </para> + </refsect1> +</refentry> |