Browse code

doc: update manpage for atexit option

Victor Seva authored on 03/02/2021 12:33:32
Showing 1 changed files
... ...
@@ -58,6 +58,12 @@ Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
58 58
 Add an alias, the value has to be '[proto:]hostname[:port]'
59 59
 (like for 'alias' global parameter)
60 60
 .TP
61
+.BI \-\-atexit\fR=\fIval
62
+Control atexit callbacks execution from external libraries
63
+which may access destroyed shm memory causing crash on shutdown.
64
+Can be y[es] or 1 to enable atexit callbacks, n[o] or 0 to disable,
65
+default is yes.
66
+.TP
61 67
 .BI \-A " pre\-processor\-define"
62 68
 Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A X='"Y"')
63 69
 .TP
... ...
@@ -160,10 +166,6 @@ Specifies the number of children processes forked to handle tcp incoming connect
160 166
 .BI \-n
161 167
 ).
162 168
 .TP
163
-.BI \-\-no\-atexit
164
-Skip atexit callbacks execution from external libraries
165
-which may access destroyed shm memory causing crash on shutdown.
166
-.TP
167 169
 .BI \-P " pid\-file"
168 170
 Creates a file containing the pid of the main
169 171
 .B kamailio
Browse code

doc: update options at manpage

* put them in order too

Victor Seva authored on 03/02/2021 08:41:12
Showing 1 changed files
... ...
@@ -1,5 +1,5 @@
1 1
 .\"
2
-.TH kamailio 8 06.12.2016 kamailio "Kamailio SIP Server"
2
+.TH kamailio 8 03.02.2021 kamailio "Kamailio SIP Server"
3 3
 .\" Process with
4 4
 .\" groff -man -Tascii kamailio.8
5 5
 .\"
... ...
@@ -8,39 +8,39 @@ kamailio \- a very fast and configurable SIP server
8 8
 .SH SYNOPSIS
9 9
 .B kamailio
10 10
 [
11
-.B \-hcrRvdDEVTI
11
+.B \-hfcmMdVIhEeblLnvKrRDTNWwtugPGSQOaAxXY
12 12
 ] [
13
-.BI \-f " config\-file"
13
+.BI \-a " auto\-aliases\-mode"
14 14
 ] [
15
-.BI \-l " address"
15
+.BI \-A " pre\-processor\-define"
16 16
 ] [
17
-.BI \-n " processes\-no"
17
+.BI \-b " max_rcv_buf_size"
18 18
 ] [
19
-.BI \-N " tcp processes\-no"
19
+.BI \-f " config\-file"
20 20
 ] [
21
-.BI \-b " max_rcv_buf_size"
21
+.BI \-g " gid"
22 22
 ] [
23
-.BI \-m " shared_mem_size"
23
+.BI \-G " pgid\-file"
24 24
 ] [
25
-.BI \-M " private_mem_size"
25
+.BI \-l " address"
26 26
 ] [
27
-.BI \-w " working\-dir"
27
+.BI \-L " modules\-dir"
28 28
 ] [
29
-.BI \-t " chroot\-dir"
29
+.BI \-M " private_mem_size"
30 30
 ] [
31
-.BI \-u " uid"
31
+.BI \-m " shared_mem_size"
32 32
 ] [
33
-.BI \-g " gid"
33
+.BI \-n " processes\-no"
34 34
 ] [
35
-.BI \-P " pid\-file"
35
+.BI \-N " tcp processes\-no"
36 36
 ] [
37
-.BI \-G " pgid\-file"
37
+.BI \-P " pid\-file"
38 38
 ] [
39
-.BI \-L " modules\-dir"
39
+.BI \-t " chroot\-dir"
40 40
 ] [
41
-.BI \-a " auto\-aliases\-mode"
41
+.BI \-u " uid"
42 42
 ] [
43
-.BI \-A " pre\-processor\-define"
43
+.BI \-w " working\-dir"
44 44
 ]
45 45
 
46 46
 .SH DESCRIPTION
... ...
@@ -49,28 +49,35 @@ is a very fast and configurable SIP (RFC3261) server.
49 49
 
50 50
 .SH OPTIONS
51 51
 .TP 12
52
-.B \-h
53
-Displays a short usage description, including all available options.
52
+.B
54 53
 .TP
55
-.BI \-c
56
-Checks the config file and displays the aliases and listen interface list.
54
+.BI \-a " auto\-aliases\-mode"
55
+Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
57 56
 .TP
58
-.BI \-r
59
-Uses dns to check if it is necessary to add a "received=" field to a via.
57
+.BI \-\-alias\fR=\fIval
58
+Add an alias, the value has to be '[proto:]hostname[:port]'
59
+(like for 'alias' global parameter)
60 60
 .TP
61
-.BI \-R
62
-Same as
63
-.B \-r
64
-but uses reverse dns.
61
+.BI \-A " pre\-processor\-define"
62
+Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A X='"Y"')
65 63
 .TP
66
-.BI \-K
67
-Turns on via host checking when forwarding replies.
64
+.BI \-b " max_rcv_buf_size"
65
+Maximum receive buffer size which will not be exceeded by the auto-probing procedure even if the OS allows.
66
+.TP
67
+.BI \-c
68
+Checks the config file and displays the aliases and listen interface list.
69
+.TP
70
+.BI \-\-cfg\-print
71
+Print configuration file evaluating includes and ifdefs
68 72
 .TP
69 73
 .BI \-d
70 74
 Turns on debugging, multiple
71 75
 .B \-d
72 76
 increase the debug level.
73 77
 .TP
78
+.BI \-\-debug\fR=\fIval
79
+Debugging level value
80
+.TP
74 81
 .BI \-D
75 82
 Control how daemonize is done:
76 83
 .br
... ...
@@ -83,18 +90,12 @@ Control how daemonize is done:
83 90
 .B \-DDD
84 91
 - daemonize (default)
85 92
 .TP
93
+.BI \-e
94
+Log messages printed in terminal colors (requires -E)
95
+.TP
86 96
 .BI \-E
87 97
 Sends all the log messages to stderr.
88 98
 .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 99
 .BI \-f " config\-file"
99 100
 Reads the configuration from
100 101
 .B " config\-file"
... ...
@@ -102,6 +103,25 @@ Reads the configuration from
102 103
 .I  /etc/kamailio/kamailio.cfg
103 104
 ).
104 105
 .TP
106
+.BI \-g " gid"
107
+Changes the group id under which
108
+.B kamailio
109
+runs.
110
+.TP
111
+.BI \-G " pgid\-file"
112
+Creates a file containing the pgid of the main
113
+.B kamailio
114
+process.
115
+.TP
116
+.B \-h \-\-help
117
+Displays a short usage description, including all available options.
118
+.TP
119
+.BI \-I
120
+Displays details of internal constants and attributes.
121
+.TP
122
+.BI \-K
123
+Turns on via host checking when forwarding replies.
124
+.TP
105 125
 .BI \-l " address"
106 126
 Listens on the specified address/interface. Multiple
107 127
 .B \-l
... ...
@@ -111,6 +131,27 @@ address = host|ip_address|interface_name. Example: -l localhost,
111 131
 -l udp:127.0.0.1:5080, -l eth0:5062.
112 132
 The default behaviour is to listen on all the ipv4 interfaces.
113 133
 .TP
134
+.BI \-\-loadmodule\fR=\fIname
135
+load the module specified by name
136
+.TP
137
+.BI \-\-log\-engine\fR=\fIname
138
+log engine name and data
139
+.TP
140
+.BI \-L " modules\-dir"
141
+Specifies the directory where to look for
142
+.B kamailio
143
+modules (default: /usr/lib/kamailio/modules or /usr/lib64/kamailio/modules)
144
+.TP
145
+.BI \-m " shared_mem_size"
146
+Size of the shared memory which will be allocated (in Megabytes).
147
+.TP
148
+.BI \-\-modparam\fR=\fImodname:paramname:type:value
149
+set the module parameter type has to be 's' for string value and 'i' for int value,
150
+example: --modparam=corex:alias_subdomains:s:" NAME ".org
151
+.TP
152
+.BI \-M " private_mem_size"
153
+Size of the private memory which will be allocated per process (in Megabytes).
154
+.TP
114 155
 .BI \-n " processes\-no"
115 156
 Specifies the number of children processes forked per interface (default 8).
116 157
 .TP
... ...
@@ -119,56 +160,87 @@ Specifies the number of children processes forked to handle tcp incoming connect
119 160
 .BI \-n
120 161
 ).
121 162
 .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.
163
+.BI \-\-no\-atexit
164
+Skip atexit callbacks execution from external libraries
165
+which may access destroyed shm memory causing crash on shutdown.
124 166
 .TP
125
-.BI \-m " shared_mem_size"
126
-Size of the shared memory which will be allocated (in Megabytes).
167
+.BI \-P " pid\-file"
168
+Creates a file containing the pid of the main
169
+.B kamailio
170
+process.
127 171
 .TP
128
-.BI \-M " private_mem_size"
129
-Size of the private memory which will be allocated per process (in Megabytes).
172
+.BI \-O " optimization\-level"
173
+Script optimization level (debugging option).
130 174
 .TP
131
-.BI \-w " working\-dir"
132
-Specifies the working directory. In the very improbable event that
175
+.BI \-P " pid\-file"
176
+Creates a file containing the pid of the main
133 177
 .B kamailio
134
-will crash, the core file will be generated here.
178
+process.
179
+.TP
180
+.BI \-Q
181
+Number of sctp child processes (default: equal to
182
+.BI \-n
183
+).
184
+.TP
185
+.BI \-r
186
+Uses dns to check if it is necessary to add a "received=" field to a via.
187
+.TP
188
+.BI \-R
189
+Same as
190
+.B \-r
191
+but uses reverse dns (to use both:
192
+.BI \-rR
193
+).
194
+.TP
195
+.BI \-\-server\-id\fR=\fInum
196
+Set the value for server_id
197
+.TP
198
+.BI \-\-subst\fR=\fIexp
199
+Set a subst preprocessor directive
200
+.TP
201
+.BI \-\-substdef\fR=\fIexp
202
+Set a substdef preprocessor directive
203
+.TP
204
+.BI \-\-substdefs\fR=\fIexp
205
+Set a substdefs preprocessor directive.
206
+.TP
207
+.BI \-S
208
+Disables SCTP support.
135 209
 .TP
136 210
 .BI \-t " chroot\-dir"
137 211
 Forces
138 212
 .B kamailio
139 213
 to chroot after reading the config file.
140 214
 .TP
215
+.BI \-T
216
+Disables TCP support.
217
+.TP
141 218
 .BI \-u " uid"
142 219
 Changes the user id under which
143 220
 .B kamailio
144 221
 runs.
145 222
 .TP
146
-.BI \-g " gid"
147
-Changes the group id under which
148
-.B kamailio
149
-runs.
223
+.BI "\-v \-V \-\-version"
224
+Displays the version number.
150 225
 .TP
151
-.BI \-P " pid\-file"
152
-Creates a file containing the pid of the main
153
-.B kamailio
154
-process.
226
+.BI \-x " name"
227
+Specify internal manager for shared memory (shm) can be: fm, qm or tlsf
155 228
 .TP
156
-.BI \-G " pgid\-file"
157
-Creates a file containing the pgid of the main
158
-.B kamailio
159
-process.
229
+.BI \-X " name"
230
+Specify internal manager for private memory (pkg) if omitted, the one for shm is used
160 231
 .TP
161
-.BI \-L " modules\-dir"
162
-Specifies the directory where to look for
232
+ .BI \-Y " dir"
233
+ Runtime dir path
234
+.TP
235
+.BI \-w " working\-dir"
236
+Specifies the working directory. In the very improbable event that
163 237
 .B kamailio
164
-modules (default: /usr/lib/kamailio/modules or /usr/lib64/kamailio/modules)
238
+will crash, the core file will be generated here.
165 239
 .TP
166
-.BI \-a " auto\-aliases\-mode"
167
-Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
240
+.BI \-W " type"
241
+poll method (depending on support in OS, it can be: poll,
242
+epoll_lt, epoll_et, sigio_rt, select, kqueue, /dev/poll).
168 243
 .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 244
 .SH FILES
173 245
 .PD 0
174 246
 .B /usr/sbin/kamailio
Browse code

update mailing list URL

Victor Seva authored on 23/08/2018 14:59:11
Showing 1 changed files
... ...
@@ -195,6 +195,6 @@ https://github.com/kamailio/kamailio/issues.
195 195
 .PP
196 196
 Mailing lists:
197 197
 .nf
198
-sr-users@lists.sip-router.org - kamailio user community
198
+sr-users@lists.kamailio.org - kamailio user community
199 199
 .nf
200
-sr-dev@lists.sip-router.org - kamailio development, new features and unstable version
200
+sr-dev@lists.kamailio.org - kamailio development, new features and unstable version
Browse code

manpage Add proper web address to the project (include https)

Olle E. Johansson authored on 07/02/2017 14:20:15
Showing 1 changed files
... ...
@@ -4,7 +4,7 @@
4 4
 .\" groff -man -Tascii kamailio.8
5 5
 .\"
6 6
 .SH NAME
7
-kamailio \- very fast and configurable SIP server
7
+kamailio \- a very fast and configurable SIP server
8 8
 .SH SYNOPSIS
9 9
 .B kamailio
10 10
 [
... ...
@@ -187,7 +187,7 @@ see
187 187
 .PP
188 188
 Full documentation on kamailio, including configuration guidelines, FAQs and
189 189
 licensing conditions, is available at
190
-.I http://kamailio.org.
190
+.I https://www.kamailio.org/
191 191
 .PP
192 192
 For reporting  bugs see
193 193
 .I
Browse code

doc/man: renamed man files to use kamailio name

Daniel-Constantin Mierla authored on 06/12/2016 13:45:50
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,200 @@
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