Browse code

core: man pages updated to use kamailio name

Daniel-Constantin Mierla authored on 06/12/2016 13:42:58
Showing 2 changed files
... ...
@@ -1,12 +1,12 @@
1
-.\" $Id$
2
-.TH sip-router 8 15.07.2002 sip-router "SIP Router" 
1
+.\"
2
+.TH kamailio 8 06.12.2016 kamailio "Kamailio SIP Server"
3 3
 .\" Process with
4
-.\" groff -man -Tascii sip-router.8
4
+.\" groff -man -Tascii kamailio.8
5 5
 .\"
6 6
 .SH NAME
7
-sip-router \- very fast and configurable sip proxy
7
+kamailio \- very fast and configurable SIP server
8 8
 .SH SYNOPSIS
9
-.B sip-router
9
+.B kamailio
10 10
 [
11 11
 .B \-hcrRvdDEVTI
12 12
 ] [
... ...
@@ -44,11 +44,8 @@ sip-router \- very fast and configurable sip proxy
44 44
 ]
45 45
 
46 46
 .SH DESCRIPTION
47
-.B sip-router 
48
-or
49
-.BR SIP
50
-.BR Router 
51
-is a very fast and configurable SIP proxy. 
47
+.B kamailio
48
+is a very fast and configurable SIP (RFC3261) server.
52 49
 
53 50
 .SH OPTIONS
54 51
 .TP 12
... ...
@@ -62,7 +59,7 @@ Checks the config file and displays the aliases and listen interface list.
62 59
 Uses dns to check if it is necessary to add a "received=" field to a via.
63 60
 .TP
64 61
 .BI \-R
65
-Same as 
62
+Same as
66 63
 .B \-r
67 64
 but uses reverse dns.
68 65
 .TP
... ...
@@ -99,18 +96,18 @@ Displays the version number.
99 96
 Displays details of internal constants and attributes.
100 97
 .TP
101 98
 .BI \-f " config\-file"
102
-Reads the configuration from 
103
-.B " config\-file" 
99
+Reads the configuration from
100
+.B " config\-file"
104 101
 (default
105
-.I  /etc/sip-router/sip-router.cfg
102
+.I  /etc/kamailio/kamailio.cfg
106 103
 ).
107 104
 .TP
108 105
 .BI \-l " address"
109
-Listens on the specified address/interface. Multiple 
106
+Listens on the specified address/interface. Multiple
110 107
 .B \-l
111
-mean listening on multiple addresses. The address format is 
108
+mean listening on multiple addresses. The address format is
112 109
 [proto:]address[:port], where proto = udp|tcp and
113
-address = host|ip_address|interface_name. Example: -l localhost, 
110
+address = host|ip_address|interface_name. Example: -l localhost,
114 111
 -l udp:127.0.0.1:5080, -l eth0:5062.
115 112
 The default behaviour is to listen on all the ipv4 interfaces.
116 113
 .TP
... ...
@@ -131,40 +128,40 @@ Size of the shared memory which will be allocated (in Megabytes).
131 128
 .BI \-M " private_mem_size"
132 129
 Size of the private memory which will be allocated per process (in Megabytes).
133 130
 .TP
134
-.BI \-w " working\-dir" 
135
-Specifies the working directory. In the very improbable event that 
136
-.B sip-router 
131
+.BI \-w " working\-dir"
132
+Specifies the working directory. In the very improbable event that
133
+.B kamailio
137 134
 will crash, the core file will be generated here.
138 135
 .TP
139 136
 .BI \-t " chroot\-dir"
140
-Forces 
141
-.B sip-router 
137
+Forces
138
+.B kamailio
142 139
 to chroot after reading the config file.
143 140
 .TP
144 141
 .BI \-u " uid"
145
-Changes the user id under which 
146
-.B sip-router
142
+Changes the user id under which
143
+.B kamailio
147 144
 runs.
148 145
 .TP
149 146
 .BI \-g " gid"
150
-Changes the group id under which 
151
-.B sip-router
147
+Changes the group id under which
148
+.B kamailio
152 149
 runs.
153 150
 .TP
154 151
 .BI \-P " pid\-file"
155 152
 Creates a file containing the pid of the main
156
-.B sip-router
153
+.B kamailio
157 154
 process.
158 155
 .TP
159 156
 .BI \-G " pgid\-file"
160 157
 Creates a file containing the pgid of the main
161
-.B sip-router
158
+.B kamailio
162 159
 process.
163 160
 .TP
164 161
 .BI \-L " modules\-dir"
165 162
 Specifies the directory where to look for
166
-.B sip-router
167
-modules (default: /usr/lib/sip-router/modules)
163
+.B kamailio
164
+modules (default: /usr/lib/kamailio/modules or /usr/lib64/kamailio/modules)
168 165
 .TP
169 166
 .BI \-a " auto\-aliases\-mode"
170 167
 Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
... ...
@@ -174,30 +171,30 @@ Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A X='"Y"')
174 171
 
175 172
 .SH FILES
176 173
 .PD 0
177
-.B /usr/sbin/sip-router
174
+.B /usr/sbin/kamailio
178 175
 .br
179
-.B /etc/sip-router/sip-router.cfg
176
+.B /etc/kamailio/kamailio.cfg
180 177
 .br
181
-.B /usr/lib/sip-router/modules/*
178
+.B /usr/lib/kamailio/modules/*
182 179
 .PD
183 180
 .SH AUTHORS
184 181
 
185
-see 
186
-.B /usr/share/doc/sip-router/AUTHORS
182
+see
183
+.B /usr/share/doc/kamailio/AUTHORS
187 184
 
188 185
 .SH SEE ALSO
189
-.BR sip-router.cfg(5)
186
+.BR kamailio.cfg(5)
190 187
 .PP
191
-Full documentation on sip-router, including configuration guidelines, FAQs and
188
+Full documentation on kamailio, including configuration guidelines, FAQs and
192 189
 licensing conditions, is available at
193
-.I http://sip-router.org.
194
-.PP 
190
+.I http://kamailio.org.
191
+.PP
195 192
 For reporting  bugs see
196 193
 .I
197
-http://sip-router.org/tracker/.
194
+https://github.com/kamailio/kamailio/issues.
198 195
 .PP
199 196
 Mailing lists:
200
-.nf 
201
-sr-users@lists.sip-router.org - sip-router user community
202
-.nf 
203
-sr-dev@lists.sip-router.org - sip-router development, new features and unstable version
197
+.nf
198
+sr-users@lists.sip-router.org - kamailio user community
199
+.nf
200
+sr-dev@lists.sip-router.org - kamailio development, new features and unstable version
... ...
@@ -1,16 +1,16 @@
1
-.\" $Id$
2
-.TH sip-router.cfg 5 15.07.2002 sip-router "SIP Router" 
1
+.\"
2
+.TH kamailio.cfg 5 06.12.2016 kamailio "Kamailio SIP Server"
3 3
 .\" Process with
4
-.\" groff -man -Tascii sip-router.cfg.5 
4
+.\" groff -man -Tascii kamailio.cfg.5
5 5
 .\"
6 6
 .SH NAME
7
-sip-router.cfg \- sip-router configuration file
7
+kamailio.cfg \- kamailio configuration file
8 8
 .SH SYNOPSIS
9
-.I /etc/sip-router/sip-router.cfg
9
+.I /etc/kamailio/kamailio.cfg
10 10
 .SH DESCRIPTION
11
-.B sip-router
11
+.B kamailio
12 12
 reads the configuration data from
13
-.I /etc/sip-router/sip-router.cfg
13
+.I /etc/kamailio/kamailio.cfg
14 14
 (or the file specified with
15 15
 .B \-f
16 16
 on the command line).
... ...
@@ -21,29 +21,29 @@ or enclosed in
21 21
 are interpreted as comments.
22 22
 .PP
23 23
 This manual page is incomplete. For further information please see documentation on page
24
-.I  http://sip-router.org/wiki.
24
+.I  http://kamailio.org/wiki.
25 25
 
26 26
 .SH FILES
27
-.I /etc/sip-router/sip-router.cfg
27
+.I /etc/kamailio/kamailio.cfg
28 28
 
29 29
 .SH AUTHORS
30 30
 
31
-see 
32
-.B /usr/share/doc/sip-router/AUTHORS
31
+see
32
+.B /usr/share/doc/kamailio/AUTHORS
33 33
 
34 34
 .SH SEE ALSO
35
-.BR sip-router(8)
35
+.BR kamailio(8)
36 36
 .PP
37
-Full documentation on sip-router, including configuration guidelines, FAQs and
37
+Full documentation on kamailio, including configuration guidelines, FAQs and
38 38
 licensing conditions, is available at
39
-.I http://sip-router.org.
39
+.I http://kamailio.org.
40 40
 .PP
41 41
 For reporting  bugs see
42 42
 .I
43
-http://sip-router.org/tracker/
43
+https://github.com/kamailio/kamailio/issues
44 44
 .PP
45 45
 Mailing lists:
46
-.nf 
47
-sr-users@lists.sip-router.org - SIP Router user community
48
-.nf 
49
-sr-dev@lists.sip-router.org - SIP Router development, new features and unstable version
46
+.nf
47
+sr-users@lists.sip-router.org - Kamailio user community
48
+.nf
49
+sr-dev@lists.sip-router.org - Kamailio development, new features and unstable version