tm: safety checks for possible escaped neg. ACKs
[sip-router] / ser.8
1 .\" $Id$
2 .TH sip-router 8 15.07.2002 sip-router "Sip Express Router" 
3 .\" Process with
4 .\" groff -man -Tascii sip-router.8
5 .\"
6 .SH NAME
7 sip-router \- very fast and configurable sip proxy
8 .SH SYNOPSIS
9 .B sip-router
10 [
11 .B \-hcrRvdDEVT
12 ] [
13 .BI \-f " config\-file"
14 ] [
15 .BI \-l " address"
16 ] [
17 .BI \-n " processes\-no"
18 ] [
19 .BI \-N " tcp processes\-no"
20 ] [
21 .BI \-b " max_rcv_buf_size"
22 ] [
23 .BI \-m " shared_mem_size"
24 ] [
25 .BI \-w " working\-dir"
26 ] [
27 .BI \-t " chroot\-dir"
28 ] [
29 .BI \-u " uid"
30 ] [
31 .BI \-g " gid"
32 ] [
33 .BI \-P " pid\-file"
34 ] [
35 .BI \-L " modules-dir"
36 ]
37
38 .SH DESCRIPTION
39 .B sip-router 
40 or
41 .BR Sip
42 .BR Express 
43 .BR Router 
44 is a very fast and configurable SIP proxy. 
45
46 .SH OPTIONS
47 .TP 12
48 .B \-h
49 Displays a short usage description, including all available options.
50 .TP
51 .BI \-c
52 Checks the config file and displays the aliases and listen interface list.
53 .TP
54 .BI \-r
55 Uses dns to check if it is necessary to add a "received=" field to a via.
56 .TP
57 .BI \-R
58 Same as 
59 .B \-r
60 but uses reverse dns.
61 .TP
62 .BI \-v
63 Turns on via host checking when forwarding replies.
64 .TP
65 .BI \-d
66 Turns on debugging, multiple
67 .B -d
68 increase the debug level.
69 .TP
70 .BI \-D
71 Runs sip-router in the foreground (it doesn't fork into daemon mode).
72 .TP
73 .BI \-E
74 Sends all the log messages to stderr.
75 .TP
76 .BI \-T
77 Disables TCP support.
78 .TP
79 .BI \-V
80 Displays the version number.
81 .TP
82 .BI \-f " config\-file"
83 Reads the configuration from 
84 .B " config\-file" 
85 (default
86 .I  /etc/sip-router/sip-router.cfg
87 ).
88 .TP
89 .BI \-l " address"
90 Listens on the specified address/interface. Multiple 
91 .B \-l
92 mean listening on multiple addresses. The address format is 
93 [proto:]address[:port], where proto = udp|tcp and
94 address = host|ip_address|interface_name. Example: -l localhost, 
95 -l udp:127.0.0.1:5080, -l eth0:5062.
96 The default behaviour is to listen on all the ipv4 interfaces.
97 .TP
98 .BI \-n " processes\-no"
99 Specifies the number of children processes forked per interface (default 8).
100 .TP
101 .BI \-N " tcp processes\-no"
102 Specifies the number of children processes forked to handle tcp incoming connections (by default is equal to
103 .BI \-n
104 ).
105 .TP
106 .BI \-b " max_rcv_buf_size"
107 Maximum receive buffer size which will not be exceeded by the auto-probing procedure even if the OS allows.
108 .TP
109 .BI \-m " shared_mem_size"
110 Size of the shared memory which will be allocated (in Megabytes).
111 .TP
112 .BI \-w " working\-dir" 
113 Specifies the working directory. In the very improbable event that 
114 .B sip-router 
115 will crash, the core file will be generated here.
116 .TP
117 .BI \-t " chroot\-dir"
118 Forces 
119 .B sip-router 
120 to chroot after reading the config file.
121 .TP
122 .BI \-u " uid"
123 Changes the user id under which 
124 .B sip-router
125 runs.
126 .TP
127 .BI \-g " gid"
128 Changes the group id under which 
129 .B sip-router
130 runs.
131 .TP
132 .BI \-P " pid\-file"
133 Creates a file containing the pid of the main
134 .B sip-router
135 process.
136 .TP
137 .BI \-L " modules\-dir"
138 Specifies the directory where to look for
139 .B sip-router
140 modules (default: /usr/lib/sip-router/modules)
141
142 .SH FILES
143 .PD 0
144 .B /usr/sbin/sip-router
145 .br
146 .B /etc/sip-router/sip-router.cfg
147 .br
148 .B /usr/lib/sip-router/modules/*
149 .PD
150 .SH AUTHORS
151
152 see 
153 .B /usr/share/doc/sip-router/AUTHORS
154
155 .SH SEE ALSO
156 .BR sip-router.cfg(5)
157 .PP
158 Full documentation on sip-router, including configuration guidelines, FAQs and
159 licensing conditions, is available at
160 .I http://sip-router.org.
161 .PP 
162 For reporting  bugs see
163 .I
164 http://sip-router.org/tracker/.
165 .PP
166 Mailing lists:
167 .nf 
168 sr-users@lists.sip-router.org - sip-router user community
169 .nf 
170 sr-dev@lists.sip-router.org - sip-router development, new features and unstable version