Version 44 (Adrian Georgescu, 03/12/2009 10:04 pm) → Version 45/212 (Adrian Georgescu, 03/13/2009 11:58 am)

= Installation guide =

[[TOC(WikiStart, Sip*, depth=3)]]

== Supported platforms ==

Currently i386, amd64 and ppc architectures have been tested and are fully supported on the following operating systems:

* Linux
* MacOSX
* FreeBSD

Porting to other operating systems (like Windows, Symbian and iPhone) should be possible as long as Python environment and [ PJSIP] are supported by
that platform. The MSRP library is not yet fully working on ARM processors.

== Debian package ==

For people running Debian 5.0 or Ubuntu 8.10 there is a debian package ready for use available from the public repository provided by AG Projects. To install the debian package add these lines in /etc/apt/sources.list

# AG Projects software
deb unstable main
deb-src unstable main

Install the AG Projects debian software signing key:

apt-key add agp-debian-gpg.key

After that, run:

apt-get update
apt-get install sipclient

== Development version ==

The source code is managed using [ darcs] version control tool. The darcs repository can be fetched with:

darcs get

To obtain the incremental changes after the initial get, go to the sipsimpleclient directory and run:

cd python-sipsimple
darcs pull

== Building instructions ==

Building instructions for the corresponding platforms are available at:

* [source:docs/INSTALL.linux INSTALL.linux]
* [source:docs/INSTALL.osx INSTALL.osx]
* [source:docs/INSTALL.freebsd INSTALL.freebsd]

The build process can be fine-tuned for various options (like for using a specific version of underlying pjsip library):

adigeo@ag-imac3:python build_ext --help
Common commands: (see '--help-commands' for more) build will build the package underneath 'build/' install will install the package

Global options:
--verbose (-v) run verbosely (default)
--quiet (-q) run quietly (turns verbosity off)
--dry-run (-n) don't actually do anything
--help (-h) show detailed help message

Options for 'PJSIP_build_ext' command:
--build-lib (-b) directory for compiled extension modules
--build-temp (-t) directory for temporary files (build by-products)
--inplace (-i) ignore build-lib and put compiled extensions into
the source directory alongside your pure Python
--include-dirs (-I) list of directories to search for header files
(separated by ':')
--define (-D) C preprocessor macros to define
--undef (-U) C preprocessor macros to undefine
--libraries (-l) external C libraries to link with
--library-dirs (-L) directories to search for external C libraries
(separated by ':')
--rpath (-R) directories to search for shared C libraries at
--link-objects (-O) extra explicit link objects to include in the link
--debug (-g) compile/link with debugging information
--force (-f) forcibly build everything (ignore file timestamps)
--compiler (-c) specify the compiler type
--swig-cpp make SWIG create C++ files (default is C)
--swig-opts list of SWIG command line options
--swig path to the SWIG executable
--pyrex-cplus generate C++ source files
--pyrex-create-listing write errors to a listing file
--pyrex-include-dirs path to the Cython include files (separated by ':')
--pyrex-c-in-temp put generated C files in temp directory
--pyrex-gen-pxi generate .pxi file for public declarations
--pjsip-svn-repo PJSIP SVN repository to checkout from
--pjsip-svn-revision PJSIP SVN revision to fetch
--pjsip-clean-compile Clean PJSIP tree before compilation
--help-compiler list available compilers

usage: [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
or: --help [cmd1 cmd2 ...]
or: --help-commands
or: cmd --help


== Upgrade instructions ==

* [browser:docs/Upgrade.txt Upgrade guide]

== How to un-install ==

* [browser:docs/UnINSTALL.txt Uninstall guide]