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