summaryrefslogtreecommitdiffstats
path: root/idle-inhibit/README
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2012-12-07 16:42:54 +0100
committerOwen W. Taylor <otaylor@fishsoup.net>2013-02-12 12:03:46 -0500
commit806462d8f6c3a2c0fac3488e94763e46ecef896c (patch)
treee9b2ac840a97b50bed212132b894f04be74106fa /idle-inhibit/README
parent77da08959a92a9873794ca0242d0a3ffea33befc (diff)
downloadxdg-specs-806462d8f6c3a2c0fac3488e94763e46ecef896c.tar.xz
Add idle-inhibit D-Bus service spec
Diffstat (limited to 'idle-inhibit/README')
-rw-r--r--idle-inhibit/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/idle-inhibit/README b/idle-inhibit/README
new file mode 100644
index 0000000..72a9997
--- /dev/null
+++ b/idle-inhibit/README
@@ -0,0 +1,20 @@
+Generating the specification consists of separate steps:
+
+1. Use an xslt processor to create a DocBook XML document from the Telepathy
+ Introspection document using the provided stylesheet:
+
+$ xsltproc tools/spec-to-docbook.xsl \
+ org.freedesktop.Secrets.xml >reference.xml
+
+2. Convert specification.xml and reference.xml to a suitable output format
+ (specification.xml includes reference.xml), eg html:
+
+$ xmlto --skip-validation -o html -p params-html.xsl xhtml specification.xml
+
+If you choose a different directory for html generation, be sure to copy
+html/style.css to that location.
+
+Then open the resulting html/index.html in your favourite browser.
+
+
+Michael Leupold <lemma@confuego.org>