From 37f9df9b0568f9834452c949336783bf34e02ab9 Mon Sep 17 00:00:00 2001 From: David Zeuthen Date: Thu, 8 May 2008 22:29:38 -0400 Subject: initial commit --- doc/Makefile.am | 81 ++++++ doc/TODO | 34 +++ doc/dbus/Makefile.am | 15 ++ doc/dbus/dbus-introspect-docs.dtd | 32 +++ doc/dbus/spec-to-docbook.xsl | 543 ++++++++++++++++++++++++++++++++++++++ doc/devkit-power-docs.xml | 94 +++++++ doc/man/DeviceKit-power.xml | 64 +++++ doc/man/Makefile.am | 24 ++ doc/man/devkit-power-daemon.xml | 84 ++++++ doc/man/devkit-power.xml | 99 +++++++ doc/version.xml | 1 + 11 files changed, 1071 insertions(+) create mode 100644 doc/Makefile.am create mode 100644 doc/TODO create mode 100644 doc/dbus/Makefile.am create mode 100644 doc/dbus/dbus-introspect-docs.dtd create mode 100644 doc/dbus/spec-to-docbook.xsl create mode 100644 doc/devkit-power-docs.xml create mode 100644 doc/man/DeviceKit-power.xml create mode 100644 doc/man/Makefile.am create mode 100644 doc/man/devkit-power-daemon.xml create mode 100644 doc/man/devkit-power.xml create mode 100644 doc/version.xml (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..9953167 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,81 @@ + +SUBDIRS = man dbus + +NULL = + +AUTOMAKE_OPTIONS = 1.7 + +# The name of the module. +DOC_MODULE=devkit-power + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=devkit-power-docs.xml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS=--ignore-headers=config.h + +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR=../policy + +# Used for dependencies +HFILE_GLOB= +#$(top_srcdir)/policy/*.h +CFILE_GLOB= +#$(top_srcdir)/policy/*.c + +# Headers to ignore +IGNORE_HFILES= \ + $(NULL) + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = \ + $(DBUS_GLIB_CFLAGS) \ + $(GLIB_CFLAGS) \ + -I$(top_srcdir)/policy \ + -I$(top_builddir)/policy \ + $(NULL) + +GTKDOC_LIBS = \ + $(DBUS_GLIB_LIBS) \ + $(NULL) + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +MKTMPL_OPTIONS= + +# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) +content_files = \ + version.xml \ + man/devkit-power.xml \ + man/devkit-power-daemon.xml \ + man/DeviceKit-power.xml \ + dbus/org.freedesktop.DeviceKit.Power.ref.xml \ + dbus/org.freedesktop.DeviceKit.Power.Source.ref.xml \ + $(NULL) + +# Images to copy into HTML directory +HTML_IMAGES = \ + $(NULL) + +# Extra options to supply to gtkdoc-fixref +FIXXREF_OPTIONS= + +MAINTAINERCLEANFILES = \ + *~ \ + Makefile.in \ + devkit-power.types \ + devkit-power-*.txt \ + $(NULL) + +if ENABLE_GTK_DOC +include $(top_srcdir)/gtk-doc.make +else +EXTRA_DIST = +endif + +# Version information for marking the documentation +EXTRA_DIST += version.xml.in + diff --git a/doc/TODO b/doc/TODO new file mode 100644 index 0000000..3eb289a --- /dev/null +++ b/doc/TODO @@ -0,0 +1,34 @@ + +------------------------------------------------------------------------ +- Current dependencies +------------------------------------------------------------------------ + + - DeviceKit from git + - http://gitweb.freedesktop.org/?p=users/david/DeviceKit.git + - http://people.freedesktop.org/~david/DK/F9/src/DeviceKit-002-0.git20080506.fc9.src.rpm + + - D-Bus GLib 0.74 with some patches + - necessary changes are already committed upstream + - See Fedora 9 / Rawhide package for the patches needed + + - PolicyKit >= 0.8 + + - D-Bus >= 1.1.20 + +------------------------------------------------------------------------ +- TODO List (TODO: this section is incomplete) +------------------------------------------------------------------------ + +Before (next) release: + + - General project management tasks + - review licenses, NEWS, TODO, HACKING etc. file + +------------------------------------------------------------------------ +- Current features (TODO: this section is incomplete) +------------------------------------------------------------------------ + +------------------------------------------------------------------------ +- Future features (TODO: this section is incomplete) +------------------------------------------------------------------------ + diff --git a/doc/dbus/Makefile.am b/doc/dbus/Makefile.am new file mode 100644 index 0000000..d2685f4 --- /dev/null +++ b/doc/dbus/Makefile.am @@ -0,0 +1,15 @@ + +all : org.freedesktop.DeviceKit.Power.ref.xml org.freedesktop.DeviceKit.Power.Source.ref.xml + +org.freedesktop.DeviceKit.Power.ref.xml : $(top_srcdir)/src/org.freedesktop.DeviceKit.Power.xml $(top_srcdir)/doc/dbus/spec-to-docbook.xsl + echo """" > $@ + $(XSLTPROC) $(top_srcdir)/doc/dbus/spec-to-docbook.xsl $< | tail -n +2 >> $@ + +org.freedesktop.DeviceKit.Power.Source.ref.xml : $(top_srcdir)/src/org.freedesktop.DeviceKit.Power.Source.xml $(top_srcdir)/doc/dbus/spec-to-docbook.xsl + echo """" > $@ + $(XSLTPROC) $(top_srcdir)/doc/dbus/spec-to-docbook.xsl $< | tail -n +2 >> $@ + +EXTRA_DIST = spec-to-docbook.xsl dbus-introspect-docs.dtd + +clean-local : + rm -f *~ *.ref.xml diff --git a/doc/dbus/dbus-introspect-docs.dtd b/doc/dbus/dbus-introspect-docs.dtd new file mode 100644 index 0000000..ca918fb --- /dev/null +++ b/doc/dbus/dbus-introspect-docs.dtd @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/dbus/spec-to-docbook.xsl b/doc/dbus/spec-to-docbook.xsl new file mode 100644 index 0000000..1864414 --- /dev/null +++ b/doc/dbus/spec-to-docbook.xsl @@ -0,0 +1,543 @@ + + + + + + + + + + + + + + + + + + + + + + interface + + + + Methods + + + + + + + + + + + Signals + + + + + + + + + + + Implemented Interfaces + + Objects implementing also implements + org.freedesktop.DBus.Introspectable, + org.freedesktop.DBus.Properties + + + + + + + Properties + + + + + + + + + + + Description + + + + + + + Details + + + + + + + + + Signal Details + + + + + + + + + + + Property Details + + + + + + + + + + + + + + + + +: + + + + + + + + + + + + + + + + + + + + + + <anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>:<xsl:value-of select="@name"/></xsl:attribute></anchor>The "<xsl:value-of select="@name"/>" property + +'' + + + + + + + + + + + + + +: + + + + + + + + + + + + + + + + + + + + + <anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>::<xsl:value-of select="@name"/></xsl:attribute></anchor>The <xsl:value-of select="@name"/> signal + + () + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Since + + + + + + + + /> + + + + + + + is deprecated since version and should not be used in newly-written code. Use + + + + + : + + + :: + + + . + + + + + + + + + + + + + + + +instead. + + + + + + + + + + + + + + + + + +See also: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +: + + + + + + + + + + + + Errors + + + + : + + + + + + + + + + + + Permissions + + + + + + + + + + + + + + + + + + <anchor role="function"><xsl:attribute name="id"><xsl:value-of select="$basename"/>.<xsl:value-of select="@name"/></xsl:attribute></anchor><xsl:value-of select="@name"/> () + + () + + + + + + + + + + + + + + + + +:'' + + + + + + + + + + + + +::() + + + + + + + + + + + + +.() + + + + + +'' +, + + + + + +'' +, + + + + + + +'' + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/devkit-power-docs.xml b/doc/devkit-power-docs.xml new file mode 100644 index 0000000..6af1211 --- /dev/null +++ b/doc/devkit-power-docs.xml @@ -0,0 +1,94 @@ + + +]> + + + DeviceKit-power Reference Manual + Version &version; + + + David + Zeuthen + +
+ david@fubar.dk +
+ + + + + + 2008 + The DeviceKit-power Authors + + + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free + Documentation License, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: + +
+ The Free Software Foundation, Inc., + 59 Temple Place - Suite 330, + Boston, MA 02111-1307, + USA +
+ + + + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any GNOME documentation, and those trademarks + are made aware to the members of the GNOME Documentation + Project, the names have been printed in caps or initial caps. + + + + + + D-Bus API Reference + + + This part documents the D-Bus interface used to access the + DeviceKit-power daemon. + + + + + + + + Manual Pages + + + This part contains the manual pages distributed with DeviceKit-power. + + + + + + + + + Index + + + + + + License + +FIXME: MISSING XINCLUDE CONTENT + + + 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 @@ + + + DeviceKit-power + March 2008 + DeviceKit-power + + + + DeviceKit-power + 7 + + + + + DeviceKit-power + System-wide Power Management + + + DESCRIPTION + + DeviceKit-power provides an interface to enumerate power sources + on the system and control system-wide power management. Any + application can access + the org.freedesktop.DeviceKit.Power service + on the system message bus. Some operations (such as suspending + the system) is restricted using PolicyKit. + + + + AUTHOR + + Written by David Zeuthen david@fubar.dk with + a lot of help from many others. + + + + + BUGS + + Please send bug reports to either the distribution or the + hal mailing list, + see . + to subscribe. + + + + + SEE ALSO + + + DeviceKit7 + , + + PolicyKit8 + , + + devkit-power-daemon8 + , + + devkit-power1 + + + + 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 @@ + + + devkit-power-daemon + April 2008 + devkit-power-daemon + + + + devkit-power-daemon + 8 + + + + + devkit-power-daemon + DeviceKit-power Daemon + + + + + devkit-power-daemon + + + + + + DESCRIPTION + + devkit-power-daemon provides + the org.freedesktop.DeviceKit.Power service on the + system message bus. Users or administrators should never need to + start this daemon as it will be automatically started by + dbus-daemon1 + whenever an application calls into the org.freedesktop.DeviceKit.Power + service. + + + + + OPTIONS + + + + + + Show help options. + + + + + + + AUTHOR + + Written by David Zeuthen david@fubar.dk with + a lot of help from many others. + + + + + BUGS + + Please send bug reports to either the distribution or the + hal mailing list, + see + on how to subscribe. + + + + + SEE ALSO + + + DeviceKit-power7 + , + + devkit-power1 + , + + dbus-daemon1 + , + + + 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 @@ + + + devkit-power + April 2008 + devkit-power + + + + devkit-power + 1 + + + + + devkit-power + DeviceKit-power command line tool + + + + + devkit-power + + + + + + + + + DESCRIPTION + + devkit-power is a + simple command line client for the + DeviceKit-power7 + daemon. TODO: not fully documented. + + + + + OPTIONS + + + + + + Connect to the DeviceKit-power daemon and print a line + every time a power source is added, removed or changed. + + + + + + + + Like but prints the full + details of the power source whenever an event happens. + + + + + + + + Show help options. + + + + + + + AUTHOR + + Written by David Zeuthen david@fubar.dk with + a lot of help from many others. + + + + + BUGS + + Please send bug reports to either the distribution or the + hal mailing list, + see + on how to subscribe. + + + + + SEE ALSO + + + devkit-power-daemon8 + , + + DeviceKit-power7 + , + + + diff --git a/doc/version.xml b/doc/version.xml new file mode 100644 index 0000000..5325a8d --- /dev/null +++ b/doc/version.xml @@ -0,0 +1 @@ +001 -- cgit v1.2.1