summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPekka Pessi <Pekka.Pessi@nokia.com>2011-02-04 14:37:12 +0200
committerPekka Pessi <Pekka.Pessi@nokia.com>2011-02-04 17:07:25 +0200
commiteddce3598dbc53d1fc291729b3fcd18ce1a250fd (patch)
tree8dd534881f34ae6098ab78bdf15fffc67e40eddb
parent76ff040baea0010f2c0c30b864514c19d26400ca (diff)
docs/telepathy-ring.8.in: copied telepathy-sofiasip manual page
-rw-r--r--docs/telepathy-ring.8.in42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/telepathy-ring.8.in b/docs/telepathy-ring.8.in
new file mode 100644
index 0000000..2095bfb
--- /dev/null
+++ b/docs/telepathy-ring.8.in
@@ -0,0 +1,42 @@
+.TH TELEPATHY-SOFIASIP "8" "February 2010" "Telepathy" "D-Bus services"
+\" This man page was written by Simon McVittie for the Debian project,
+\" but may be used by others.
+\" Copyright © 2007-2010 Collabora Ltd. <http://www.collabora.co.uk/>
+\" It may be distributed under the same terms as telepathy-sofiasip itself.
+.SH NAME
+telepathy-sofiasip \- Telepathy connection manager for SIP
+.SH SYNOPSIS
+\fB@libexecdir@/telepathy\-sofiasip\fR
+.SH DESCRIPTION
+\fBtelepathy\-sofiasip\fR implements the Telepathy D-Bus specification for
+the Session Initiation Protocol, allowing Telepathy clients like
+.BR empathy (1)
+to connect to Voice over IP providers that implement SIP.
+.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
+\fBTPSIP_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.
+.TP
+\fBTPSIP_LOGFILE\fR=\fIfilename\fR
+May be set to the name of a file to overwrite with log messages. The filename
+may be prefixed with \fB+\fR to append messages to an existing file instead
+of overwriting it.
+.TP
+\fBTPSIP_PERSIST\fR
+May be set to any value to avoid telepathy-sofiasip's usual automatic exit
+when there have been no connections for a few seconds.
+.TP
+\fBTPORT_LOG\fR
+May be set to any value to print all parsed SIP messages at the transport
+layer (this functionality is provided by the underlying Sofia-SIP library,
+which also offers various more specialized debugging options).
+.SH SEE ALSO
+.IR http://telepathy.freedesktop.org/ ,
+.BR empathy (1)