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