summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2007-11-05 11:09:56 +0000
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2007-11-05 11:09:56 +0000
commitef1c3bb636b52e397c5daab8ec5090e890bd0d8d (patch)
treea6d26abd87e4b350691426563576922ccbe56921 /docs
parentb3ece2d3560aae48cbe9b8a492a580893e5083d8 (diff)
Add telepathy-gabble.8 man page
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am12
-rw-r--r--docs/telepathy-gabble.8.in37
2 files changed, 48 insertions, 1 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 94da71917..c864f89f4 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,3 +1,13 @@
+man_MANS = telepathy-gabble.8
+
+EXTRA_DIST = $(man_MANS:.8=.8.in)
+CLEANFILES = $(man_MANS)
+
+%.8: %.8.in Makefile
+ sed -e 's,[@]libexecdir[@],@libexecdir@,' < $< > $@
+
+# ---- Proto-XEPs (not automatically generated, see README) ----
+
PROTO_XEP_XML = \
muc-bytestream.xml \
tubes.xml
@@ -18,4 +28,4 @@ xep.xsl:
@echo "Please get xep.xsl from xmpp.org svn - see README for details"
@exit 1
-EXTRA_DIST = $(PROTO_XEP_XML)
+EXTRA_DIST += $(PROTO_XEP_XML)
diff --git a/docs/telepathy-gabble.8.in b/docs/telepathy-gabble.8.in
new file mode 100644
index 000000000..6c6e95458
--- /dev/null
+++ b/docs/telepathy-gabble.8.in
@@ -0,0 +1,37 @@
+.TH TELEPATHY-GABBLE "8" "October 2007" "Telepathy" "D-Bus services"
+\" This man page was written by Simon McVittie for the Debian project,
+\" but may be used by others.
+\" Copyright © 2007 Collabora Ltd. <http://www.collabora.co.uk/>
+\" It may be distributed under the same terms as telepathy-gabble itself.
+.SH NAME
+telepathy-gabble \- Telepathy connection manager for XMPP (Jabber)
+.SH SYNOPSIS
+\fB@libexecdir@/telepathy\-gabble\fR
+.SH DESCRIPTION
+Gabble implements the Telepathy D-Bus specification for XMPP (Jabber),
+allowing Telepathy clients like
+.BR empathy (1)
+to connect to XMPP accounts, including Google Talk.
+.PP
+It is a D-Bus service which runs on the session bus, and should usually be
+started automatically by D-Bus activation. However, it might be useful to
+start it manually for debugging.
+.SH OPTIONS
+There are no command-line options.
+.SH ENVIRONMENT
+.TP
+\fBGABBLE_LOGFILE\fR=\fIfilename\fR
+If set, debug output will go to the given file rather than to stderr.
+.TP
+\fBGABBLE_DEBUG\fR=\fItype\fR
+May be set to "all" for full debug output, or various undocumented options
+(which may change from release to release) to filter the output.
+\fBLM_DEBUG\fR=\fItype\fR
+May be set to "all" for full debug output from the Loudmouth XMPP library used
+by Gabble, or various undocumented options (which may change from release to
+release) to filter the output. For general Gabble debugging, "net" is
+recommended.
+.SH SEE ALSO
+.IR http://telepathy.freedesktop.org/ ,
+.IR http://telepathy.freedesktop.org/wiki/CategoryGabble ,
+.BR empathy (1)