diff options
| -rw-r--r-- | docs/Makefile.am | 8 | ||||
| -rw-r--r-- | docs/telepathy-ring.8.in | 54 |
2 files changed, 39 insertions, 23 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 5a9c8ad..20b603c 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1 +1,9 @@ EXTRA_DIST = design.txt DTMF-playback + +# Man page +man_MANS = telepathy-sofiasip.8 +CLEANFILES = $(man_MANS) +EXTRA_DIST += telepathy-sofiasip.8.in + +%.8: %.8.in Makefile + sed -e 's,[@]libexecdir[@],@libexecdir@,' < $< > $@ diff --git a/docs/telepathy-ring.8.in b/docs/telepathy-ring.8.in index 2095bfb..0068253 100644 --- a/docs/telepathy-ring.8.in +++ b/docs/telepathy-ring.8.in @@ -1,42 +1,50 @@ -.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. +.TH TELEPATHY-RING "4" "February 2011" "Telepathy" "D-Bus services" +\" This man page is based on page written by Simon McVittie for +\" telepathy-sofiasip. \" Copyright © 2007-2010 Collabora Ltd. <http://www.collabora.co.uk/> -\" It may be distributed under the same terms as telepathy-sofiasip itself. +\" Copyright © 2011 Nokia Corporation. <http://www.nokia.com/> +\" It may be distributed under the same terms as telepathy-ring itself. .SH NAME -telepathy-sofiasip \- Telepathy connection manager for SIP +telepathy-ring \- Telepathy connection manager for GSM .SH SYNOPSIS -\fB@libexecdir@/telepathy\-sofiasip\fR +\fB@libexecdir@/telepathy\-ring\fR .SH DESCRIPTION -\fBtelepathy\-sofiasip\fR implements the Telepathy D-Bus specification for -the Session Initiation Protocol, allowing Telepathy clients like + +\fBtelepathy\-ring\fR implements the Telepathy D-Bus specification for +the GSM and UMTS, allowing Telepathy clients like .BR empathy (1) -to connect to Voice over IP providers that implement SIP. +to place mobile calls and send or receive SMSs. It uses +.BR ofonod (8) +for interfacing with modems. + .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. +\fBtelepathy\-ring\fR 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 +\fBRING_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. +\fBMODEM_DEBUG\fR=\fItype\fR +May be set to "all" for full debug output from oFono interface, or +various undocumented options (which may change from release to release) +to filter the output. + .TP -\fBTPSIP_PERSIST\fR -May be set to any value to avoid telepathy-sofiasip's usual automatic exit +\fBRING_PERSIST\fR +May be set to any value to avoid telepathy-ring'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 mission-control-5 (1) .BR empathy (1) +.BR ofonod (8) |