sip-router.8
6e7474e4
 .\" $Id$
5623ef89
 .TH sip-router 8 15.07.2002 sip-router "SIP Router" 
6e7474e4
 .\" Process with
5d1a75a6
 .\" groff -man -Tascii sip-router.8
6e7474e4
 .\"
 .SH NAME
5d1a75a6
 sip-router \- very fast and configurable sip proxy
6e7474e4
 .SH SYNOPSIS
5d1a75a6
 .B sip-router
6e7474e4
 [
3c45a468
 .B \-hcrRvdDEVTI
6e7474e4
 ] [
 .BI \-f " config\-file"
 ] [
 .BI \-l " address"
 ] [
 .BI \-n " processes\-no"
 ] [
5dcfb23d
 .BI \-N " tcp processes\-no"
 ] [
6e7474e4
 .BI \-b " max_rcv_buf_size"
 ] [
 .BI \-m " shared_mem_size"
 ] [
48e1227c
 .BI \-M " private_mem_size"
 ] [
6e7474e4
 .BI \-w " working\-dir"
 ] [
 .BI \-t " chroot\-dir"
 ] [
 .BI \-u " uid"
 ] [
 .BI \-g " gid"
 ] [
 .BI \-P " pid\-file"
049069b8
 ] [
48e1227c
 .BI \-G " pgid\-file"
 ] [
 .BI \-L " modules\-dir"
 ] [
 .BI \-a " auto\-aliases\-mode"
 ] [
 .BI \-A " pre\-processor\-define"
6e7474e4
 ]
 
 .SH DESCRIPTION
5d1a75a6
 .B sip-router 
6e7474e4
 or
5623ef89
 .BR SIP
6e7474e4
 .BR Router 
 is a very fast and configurable SIP proxy. 
 
 .SH OPTIONS
 .TP 12
 .B \-h
 Displays a short usage description, including all available options.
 .TP
 .BI \-c
dda578ba
 Checks the config file and displays the aliases and listen interface list.
6e7474e4
 .TP
 .BI \-r
 Uses dns to check if it is necessary to add a "received=" field to a via.
 .TP
 .BI \-R
 Same as 
 .B \-r
 but uses reverse dns.
 .TP
70d6cae2
 .BI \-K
6e7474e4
 Turns on via host checking when forwarding replies.
 .TP
 .BI \-d
 Turns on debugging, multiple
 .B -d
 increase the debug level.
 .TP
 .BI \-D
ee9ea2f5
 Control how daemonize is done:
 .br
 .B -D
 - do not fork (almost) anyway (run in foreground, doesn't fork into daemon mode);
 .br
 .B -DD
 - do not daemonize creator (main process is not daemonized);
 .br
 .B -DDD
 - daemonize (default)
6e7474e4
 .TP
 .BI \-E
 Sends all the log messages to stderr.
 .TP
5dcfb23d
 .BI \-T
 Disables TCP support.
 .TP
6e7474e4
 .BI \-V
 Displays the version number.
 .TP
3c45a468
 .BI \-I
 Displays details of internal constants and attributes.
 .TP
6e7474e4
 .BI \-f " config\-file"
 Reads the configuration from 
 .B " config\-file" 
 (default
5d1a75a6
 .I  /etc/sip-router/sip-router.cfg
6e7474e4
 ).
 .TP
 .BI \-l " address"
245b8b93
 Listens on the specified address/interface. Multiple 
6e7474e4
 .B \-l
245b8b93
 mean listening on multiple addresses. The address format is 
 [proto:]address[:port], where proto = udp|tcp and
 address = host|ip_address|interface_name. Example: -l localhost, 
 -l udp:127.0.0.1:5080, -l eth0:5062.
 The default behaviour is to listen on all the ipv4 interfaces.
6e7474e4
 .TP
 .BI \-n " processes\-no"
 Specifies the number of children processes forked per interface (default 8).
 .TP
5dcfb23d
 .BI \-N " tcp processes\-no"
 Specifies the number of children processes forked to handle tcp incoming connections (by default is equal to
 .BI \-n
 ).
 .TP
6e7474e4
 .BI \-b " max_rcv_buf_size"
 Maximum receive buffer size which will not be exceeded by the auto-probing procedure even if the OS allows.
 .TP
 .BI \-m " shared_mem_size"
 Size of the shared memory which will be allocated (in Megabytes).
 .TP
48e1227c
 .BI \-M " private_mem_size"
 Size of the private memory which will be allocated per process (in Megabytes).
 .TP
6e7474e4
 .BI \-w " working\-dir" 
 Specifies the working directory. In the very improbable event that 
5d1a75a6
 .B sip-router 
6e7474e4
 will crash, the core file will be generated here.
 .TP
 .BI \-t " chroot\-dir"
 Forces 
5d1a75a6
 .B sip-router 
6e7474e4
 to chroot after reading the config file.
 .TP
 .BI \-u " uid"
 Changes the user id under which 
5d1a75a6
 .B sip-router
6e7474e4
 runs.
 .TP
 .BI \-g " gid"
 Changes the group id under which 
5d1a75a6
 .B sip-router
6e7474e4
 runs.
 .TP
 .BI \-P " pid\-file"
049069b8
 Creates a file containing the pid of the main
5d1a75a6
 .B sip-router
6e7474e4
 process.
049069b8
 .TP
48e1227c
 .BI \-G " pgid\-file"
 Creates a file containing the pgid of the main
 .B sip-router
 process.
 .TP
049069b8
 .BI \-L " modules\-dir"
 Specifies the directory where to look for
5d1a75a6
 .B sip-router
 modules (default: /usr/lib/sip-router/modules)
48e1227c
 .TP
 .BI \-a " auto\-aliases\-mode"
 Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
 .TP
 .BI \-A " pre\-processor\-define"
 Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A X='"Y"')
6e7474e4
 
 .SH FILES
 .PD 0
5d1a75a6
 .B /usr/sbin/sip-router
6e7474e4
 .br
5d1a75a6
 .B /etc/sip-router/sip-router.cfg
6e7474e4
 .br
5d1a75a6
 .B /usr/lib/sip-router/modules/*
6e7474e4
 .PD
 .SH AUTHORS
c3e5dd3e
 
 see 
5d1a75a6
 .B /usr/share/doc/sip-router/AUTHORS
6e7474e4
 
 .SH SEE ALSO
5d1a75a6
 .BR sip-router.cfg(5)
6e7474e4
 .PP
5d1a75a6
 Full documentation on sip-router, including configuration guidelines, FAQs and
e58f2128
 licensing conditions, is available at
5d1a75a6
 .I http://sip-router.org.
6e7474e4
 .PP 
d48f0d9b
 For reporting  bugs see
 .I
5d1a75a6
 http://sip-router.org/tracker/.
d48f0d9b
 .PP
 Mailing lists:
 .nf 
5d1a75a6
 sr-users@lists.sip-router.org - sip-router user community
d48f0d9b
 .nf 
5d1a75a6
 sr-dev@lists.sip-router.org - sip-router development, new features and unstable version