Browse code

core: relocated man pages from root folder to doc/man/

Daniel-Constantin Mierla authored on 06/12/2016 13:44:42
Showing 1 changed files
1 1
deleted file mode 100644
... ...
@@ -1,200 +0,0 @@
1
-.\"
2
-.TH kamailio 8 06.12.2016 kamailio "Kamailio SIP Server"
3
-.\" Process with
4
-.\" groff -man -Tascii kamailio.8
5
-.\"
6
-.SH NAME
7
-kamailio \- very fast and configurable SIP server
8
-.SH SYNOPSIS
9
-.B kamailio
10
-[
11
-.B \-hcrRvdDEVTI
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 kamailio
48
-is a very fast and configurable SIP (RFC3261) server.
49
-
50
-.SH OPTIONS
51
-.TP 12
52
-.B \-h
53
-Displays a short usage description, including all available options.
54
-.TP
55
-.BI \-c
56
-Checks the config file and displays the aliases and listen interface list.
57
-.TP
58
-.BI \-r
59
-Uses dns to check if it is necessary to add a "received=" field to a via.
60
-.TP
61
-.BI \-R
62
-Same as
63
-.B \-r
64
-but uses reverse dns.
65
-.TP
66
-.BI \-K
67
-Turns on via host checking when forwarding replies.
68
-.TP
69
-.BI \-d
70
-Turns on debugging, multiple
71
-.B \-d
72
-increase the debug level.
73
-.TP
74
-.BI \-D
75
-Control how daemonize is done:
76
-.br
77
-.B \-D
78
-- do not fork (almost) anyway (run in foreground, doesn't fork into daemon mode);
79
-.br
80
-.B \-DD
81
-- do not daemonize creator (main process is not daemonized);
82
-.br
83
-.B \-DDD
84
-- daemonize (default)
85
-.TP
86
-.BI \-E
87
-Sends all the log messages to stderr.
88
-.TP
89
-.BI \-T
90
-Disables TCP support.
91
-.TP
92
-.BI \-V
93
-Displays the version number.
94
-.TP
95
-.BI \-I
96
-Displays details of internal constants and attributes.
97
-.TP
98
-.BI \-f " config\-file"
99
-Reads the configuration from
100
-.B " config\-file"
101
-(default
102
-.I  /etc/kamailio/kamailio.cfg
103
-).
104
-.TP
105
-.BI \-l " address"
106
-Listens on the specified address/interface. Multiple
107
-.B \-l
108
-mean listening on multiple addresses. The address format is
109
-[proto:]address[:port], where proto = udp|tcp and
110
-address = host|ip_address|interface_name. Example: -l localhost,
111
--l udp:127.0.0.1:5080, -l eth0:5062.
112
-The default behaviour is to listen on all the ipv4 interfaces.
113
-.TP
114
-.BI \-n " processes\-no"
115
-Specifies the number of children processes forked per interface (default 8).
116
-.TP
117
-.BI \-N " tcp processes\-no"
118
-Specifies the number of children processes forked to handle tcp incoming connections (by default is equal to
119
-.BI \-n
120
-).
121
-.TP
122
-.BI \-b " max_rcv_buf_size"
123
-Maximum receive buffer size which will not be exceeded by the auto-probing procedure even if the OS allows.
124
-.TP
125
-.BI \-m " shared_mem_size"
126
-Size of the shared memory which will be allocated (in Megabytes).
127
-.TP
128
-.BI \-M " private_mem_size"
129
-Size of the private memory which will be allocated per process (in Megabytes).
130
-.TP
131
-.BI \-w " working\-dir"
132
-Specifies the working directory. In the very improbable event that
133
-.B kamailio
134
-will crash, the core file will be generated here.
135
-.TP
136
-.BI \-t " chroot\-dir"
137
-Forces
138
-.B kamailio
139
-to chroot after reading the config file.
140
-.TP
141
-.BI \-u " uid"
142
-Changes the user id under which
143
-.B kamailio
144
-runs.
145
-.TP
146
-.BI \-g " gid"
147
-Changes the group id under which
148
-.B kamailio
149
-runs.
150
-.TP
151
-.BI \-P " pid\-file"
152
-Creates a file containing the pid of the main
153
-.B kamailio
154
-process.
155
-.TP
156
-.BI \-G " pgid\-file"
157
-Creates a file containing the pgid of the main
158
-.B kamailio
159
-process.
160
-.TP
161
-.BI \-L " modules\-dir"
162
-Specifies the directory where to look for
163
-.B kamailio
164
-modules (default: /usr/lib/kamailio/modules or /usr/lib64/kamailio/modules)
165
-.TP
166
-.BI \-a " auto\-aliases\-mode"
167
-Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
168
-.TP
169
-.BI \-A " pre\-processor\-define"
170
-Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A X='"Y"')
171
-
172
-.SH FILES
173
-.PD 0
174
-.B /usr/sbin/kamailio
175
-.br
176
-.B /etc/kamailio/kamailio.cfg
177
-.br
178
-.B /usr/lib/kamailio/modules/*
179
-.PD
180
-.SH AUTHORS
181
-
182
-see
183
-.B /usr/share/doc/kamailio/AUTHORS
184
-
185
-.SH SEE ALSO
186
-.BR kamailio.cfg(5)
187
-.PP
188
-Full documentation on kamailio, including configuration guidelines, FAQs and
189
-licensing conditions, is available at
190
-.I http://kamailio.org.
191
-.PP
192
-For reporting  bugs see
193
-.I
194
-https://github.com/kamailio/kamailio/issues.
195
-.PP
196
-Mailing lists:
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
Browse code

core: man pages updated to use kamailio name

Daniel-Constantin Mierla authored on 06/12/2016 13:42:58
Showing 1 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
Browse code

manpage: sip-router.8 fix hyphen-used-as-minus-sign

Victor Seva authored on 19/05/2015 19:12:31
Showing 1 changed files
... ...
@@ -71,19 +71,19 @@ Turns on via host checking when forwarding replies.
71 71
 .TP
72 72
 .BI \-d
73 73
 Turns on debugging, multiple
74
-.B -d
74
+.B \-d
75 75
 increase the debug level.
76 76
 .TP
77 77
 .BI \-D
78 78
 Control how daemonize is done:
79 79
 .br
80
-.B -D
80
+.B \-D
81 81
 - do not fork (almost) anyway (run in foreground, doesn't fork into daemon mode);
82 82
 .br
83
-.B -DD
83
+.B \-DD
84 84
 - do not daemonize creator (main process is not daemonized);
85 85
 .br
86
-.B -DDD
86
+.B \-DDD
87 87
 - daemonize (default)
88 88
 .TP
89 89
 .BI \-E
Browse code

core: update content for -D option in man page

Daniel-Constantin Mierla authored on 25/08/2014 14:56:16
Showing 1 changed files
... ...
@@ -75,7 +75,16 @@ Turns on debugging, multiple
75 75
 increase the debug level.
76 76
 .TP
77 77
 .BI \-D
78
-Runs sip-router in the foreground (it doesn't fork into daemon mode).
78
+Control how daemonize is done:
79
+.br
80
+.B -D
81
+- do not fork (almost) anyway (run in foreground, doesn't fork into daemon mode);
82
+.br
83
+.B -DD
84
+- do not daemonize creator (main process is not daemonized);
85
+.br
86
+.B -DDD
87
+- daemonize (default)
79 88
 .TP
80 89
 .BI \-E
81 90
 Sends all the log messages to stderr.
Browse code

core: command line option -v replaced with -K

- -v was exposing to misusage for -V (version), now is aliased to it

Daniel-Constantin Mierla authored on 05/01/2013 23:00:40
Showing 1 changed files
... ...
@@ -66,7 +66,7 @@ Same as
66 66
 .B \-r
67 67
 but uses reverse dns.
68 68
 .TP
69
-.BI \-v
69
+.BI \-K
70 70
 Turns on via host checking when forwarding replies.
71 71
 .TP
72 72
 .BI \-d
Browse code

man page: updated with the new -I command line option

Daniel-Constantin Mierla authored on 27/10/2011 14:11:14
Showing 1 changed files
... ...
@@ -8,7 +8,7 @@ sip-router \- very fast and configurable sip proxy
8 8
 .SH SYNOPSIS
9 9
 .B sip-router
10 10
 [
11
-.B \-hcrRvdDEVT
11
+.B \-hcrRvdDEVTI
12 12
 ] [
13 13
 .BI \-f " config\-file"
14 14
 ] [
... ...
@@ -86,6 +86,9 @@ Disables TCP support.
86 86
 .BI \-V
87 87
 Displays the version number.
88 88
 .TP
89
+.BI \-I
90
+Displays details of internal constants and attributes.
91
+.TP
89 92
 .BI \-f " config\-file"
90 93
 Reads the configuration from 
91 94
 .B " config\-file" 
Browse code

core: updated man page

Daniel-Constantin Mierla authored on 30/05/2011 21:03:42
Showing 1 changed files
... ...
@@ -22,6 +22,8 @@ sip-router \- very fast and configurable sip proxy
22 22
 ] [
23 23
 .BI \-m " shared_mem_size"
24 24
 ] [
25
+.BI \-M " private_mem_size"
26
+] [
25 27
 .BI \-w " working\-dir"
26 28
 ] [
27 29
 .BI \-t " chroot\-dir"
... ...
@@ -32,7 +34,13 @@ sip-router \- very fast and configurable sip proxy
32 34
 ] [
33 35
 .BI \-P " pid\-file"
34 36
 ] [
35
-.BI \-L " modules-dir"
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"
36 44
 ]
37 45
 
38 46
 .SH DESCRIPTION
... ...
@@ -108,6 +116,9 @@ Maximum receive buffer size which will not be exceeded by the auto-probing proce
108 116
 .BI \-m " shared_mem_size"
109 117
 Size of the shared memory which will be allocated (in Megabytes).
110 118
 .TP
119
+.BI \-M " private_mem_size"
120
+Size of the private memory which will be allocated per process (in Megabytes).
121
+.TP
111 122
 .BI \-w " working\-dir" 
112 123
 Specifies the working directory. In the very improbable event that 
113 124
 .B sip-router 
... ...
@@ -133,10 +144,21 @@ Creates a file containing the pid of the main
133 144
 .B sip-router
134 145
 process.
135 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
136 152
 .BI \-L " modules\-dir"
137 153
 Specifies the directory where to look for
138 154
 .B sip-router
139 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"')
140 162
 
141 163
 .SH FILES
142 164
 .PD 0
Browse code

* Core: Renamed ser.8 to sip-router.8

* Renamed ser.8 to sip-router.8.
* Small edits in sip-router.8.

Juha Heinanen authored on 24/06/2009 18:25:58
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,169 @@
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