summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMikhail Zabaluev <mikhail.zabaluev@nokia.com>2011-02-02 18:32:22 +0200
committerMikhail Zabaluev <mikhail.zabaluev@nokia.com>2011-02-02 18:35:48 +0200
commit26eae76d331cfa19edfc35dabf258a353904bd2a (patch)
tree5e19ef0a54080821b2f66aac984a829ae104333a
parent38c94348c26a1673d89f935ce36d6fa682af4277 (diff)
Brushed up the README
Removed obsolete information referring to libjingle. Updated information on building. More help on environment variables.
-rw-r--r--README51
1 files changed, 14 insertions, 37 deletions
diff --git a/README b/README
index bb818fe..a399ffd 100644
--- a/README
+++ b/README
@@ -7,52 +7,29 @@ Building
telepathy-sofiasip requires GNU make.
-When building from the devel tree (you need automake-1.8 or up):
+When building from the devel tree (you need automake-1.9 or up):
-sh> gtkdocize # (optional)
-sh> autoreconf -i
+sh> ./autogen.sh --no-configure
And then continue with the normal:
sh> ./configure
sh> make
-If using gtkdoc, a second 'make' is needed as the 1st will fail due
-to a bug in gtkdoc.
-
Running
-------
-Set the "SOFIASIP_PERSIST" environment variable to prevent the connection
+Set the "TPSIP_PERSIST" environment variable to prevent the connection
manager from exiting after all connections have been disconnected. This
option is only available if telepathy-sofiasip was configured with
-the "--enable-debug" option.
-
-Comments on IETF ICE compliance
-------------------------------
-
-Telepathy frameworks streamed media support was first implemented for
-Jabber/Jingle ICE-RTP profile. Using the same interface for SIP based
-media session setup creates some challenges (most urgent first):
-
-Spec issues
-~~~~~~~~~~~
-
-- some differences in terms: IETF-ICE has component (candidate-id) and transport
- identifiers (tid) and a session-level password (ice-pwd), which are similar but
- not equivalent to Telepathy transport properties 'user' and 'pass'
-- the candidate-id values should be random with length of at least
- four characters
-- libjingle does not support multiple components (like one for RTP and one
- for RTCP) per candidate
-
-Implementation issues
-~~~~~~~~~~~~~~~~~~~~~
-
-- open: to talk with non-ICE compliant SIP endpoints, libjingle has to
- support bypassing connectivity checks for the default candidate - can
- this be done?
-- currently libjingle does not emit NativeCandidatePrepared, making it
- more difficult to decide when to send all local candidates (whether to
- wait until one of each type of candidates is generated, or some fixed
- time interval?)
+the "--enable-debug" option, which is on by default.
+
+Other useful environment variables:
+* TPSIP_DEBUG -- enables debug tracing via g_log.
+ The value "all" enables all categories; for detailed categories look into
+ the file 'src/debug.c'.
+* TPORT_LOG -- setting to 1 enables logging of SIP protocol messages.
+
+See also Sofia-SIP documentation for environment variables to enable tracing
+in various modules of the Sofia-SIP library:
+http://sofia-sip.sourceforge.net/refdocs/pages.html