Browse Source

doc: update options at manpage

* put them in order too
Victor Seva 4 years ago
parent
commit
377bb3bdfd
1 changed files with 140 additions and 68 deletions
  1. 140 68
      doc/man/kamailio.8

+ 140 - 68
doc/man/kamailio.8

@@ -1,5 +1,5 @@
 .\"
-.TH kamailio 8 06.12.2016 kamailio "Kamailio SIP Server"
+.TH kamailio 8 03.02.2021 kamailio "Kamailio SIP Server"
 .\" Process with
 .\" groff -man -Tascii kamailio.8
 .\"
@@ -8,39 +8,39 @@ kamailio \- a very fast and configurable SIP server
 .SH SYNOPSIS
 .B kamailio
 [
-.B \-hcrRvdDEVTI
+.B \-hfcmMdVIhEeblLnvKrRDTNWwtugPGSQOaAxXY
 ] [
-.BI \-f " config\-file"
+.BI \-a " auto\-aliases\-mode"
 ] [
-.BI \-l " address"
+.BI \-A " pre\-processor\-define"
 ] [
-.BI \-n " processes\-no"
+.BI \-b " max_rcv_buf_size"
 ] [
-.BI \-N " tcp processes\-no"
+.BI \-f " config\-file"
 ] [
-.BI \-b " max_rcv_buf_size"
+.BI \-g " gid"
 ] [
-.BI \-m " shared_mem_size"
+.BI \-G " pgid\-file"
 ] [
-.BI \-M " private_mem_size"
+.BI \-l " address"
 ] [
-.BI \-w " working\-dir"
+.BI \-L " modules\-dir"
 ] [
-.BI \-t " chroot\-dir"
+.BI \-M " private_mem_size"
 ] [
-.BI \-u " uid"
+.BI \-m " shared_mem_size"
 ] [
-.BI \-g " gid"
+.BI \-n " processes\-no"
 ] [
-.BI \-P " pid\-file"
+.BI \-N " tcp processes\-no"
 ] [
-.BI \-G " pgid\-file"
+.BI \-P " pid\-file"
 ] [
-.BI \-L " modules\-dir"
+.BI \-t " chroot\-dir"
 ] [
-.BI \-a " auto\-aliases\-mode"
+.BI \-u " uid"
 ] [
-.BI \-A " pre\-processor\-define"
+.BI \-w " working\-dir"
 ]
 
 .SH DESCRIPTION
@@ -49,28 +49,35 @@ is a very fast and configurable SIP (RFC3261) server.
 
 .SH OPTIONS
 .TP 12
-.B \-h
-Displays a short usage description, including all available options.
+.B
 .TP
-.BI \-c
-Checks the config file and displays the aliases and listen interface list.
+.BI \-a " auto\-aliases\-mode"
+Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
 .TP
-.BI \-r
-Uses dns to check if it is necessary to add a "received=" field to a via.
+.BI \-\-alias\fR=\fIval
+Add an alias, the value has to be '[proto:]hostname[:port]'
+(like for 'alias' global parameter)
 .TP
-.BI \-R
-Same as
-.B \-r
-but uses reverse dns.
+.BI \-A " pre\-processor\-define"
+Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A X='"Y"')
 .TP
-.BI \-K
-Turns on via host checking when forwarding replies.
+.BI \-b " max_rcv_buf_size"
+Maximum receive buffer size which will not be exceeded by the auto-probing procedure even if the OS allows.
+.TP
+.BI \-c
+Checks the config file and displays the aliases and listen interface list.
+.TP
+.BI \-\-cfg\-print
+Print configuration file evaluating includes and ifdefs
 .TP
 .BI \-d
 Turns on debugging, multiple
 .B \-d
 increase the debug level.
 .TP
+.BI \-\-debug\fR=\fIval
+Debugging level value
+.TP
 .BI \-D
 Control how daemonize is done:
 .br
@@ -83,18 +90,12 @@ Control how daemonize is done:
 .B \-DDD
 - daemonize (default)
 .TP
+.BI \-e
+Log messages printed in terminal colors (requires -E)
+.TP
 .BI \-E
 Sends all the log messages to stderr.
 .TP
-.BI \-T
-Disables TCP support.
-.TP
-.BI \-V
-Displays the version number.
-.TP
-.BI \-I
-Displays details of internal constants and attributes.
-.TP
 .BI \-f " config\-file"
 Reads the configuration from
 .B " config\-file"
@@ -102,6 +103,25 @@ Reads the configuration from
 .I  /etc/kamailio/kamailio.cfg
 ).
 .TP
+.BI \-g " gid"
+Changes the group id under which
+.B kamailio
+runs.
+.TP
+.BI \-G " pgid\-file"
+Creates a file containing the pgid of the main
+.B kamailio
+process.
+.TP
+.B \-h \-\-help
+Displays a short usage description, including all available options.
+.TP
+.BI \-I
+Displays details of internal constants and attributes.
+.TP
+.BI \-K
+Turns on via host checking when forwarding replies.
+.TP
 .BI \-l " address"
 Listens on the specified address/interface. Multiple
 .B \-l
@@ -111,6 +131,27 @@ address = host|ip_address|interface_name. Example: -l localhost,
 -l udp:127.0.0.1:5080, -l eth0:5062.
 The default behaviour is to listen on all the ipv4 interfaces.
 .TP
+.BI \-\-loadmodule\fR=\fIname
+load the module specified by name
+.TP
+.BI \-\-log\-engine\fR=\fIname
+log engine name and data
+.TP
+.BI \-L " modules\-dir"
+Specifies the directory where to look for
+.B kamailio
+modules (default: /usr/lib/kamailio/modules or /usr/lib64/kamailio/modules)
+.TP
+.BI \-m " shared_mem_size"
+Size of the shared memory which will be allocated (in Megabytes).
+.TP
+.BI \-\-modparam\fR=\fImodname:paramname:type:value
+set the module parameter type has to be 's' for string value and 'i' for int value,
+example: --modparam=corex:alias_subdomains:s:" NAME ".org
+.TP
+.BI \-M " private_mem_size"
+Size of the private memory which will be allocated per process (in Megabytes).
+.TP
 .BI \-n " processes\-no"
 Specifies the number of children processes forked per interface (default 8).
 .TP
@@ -119,56 +160,87 @@ Specifies the number of children processes forked to handle tcp incoming connect
 .BI \-n
 ).
 .TP
-.BI \-b " max_rcv_buf_size"
-Maximum receive buffer size which will not be exceeded by the auto-probing procedure even if the OS allows.
+.BI \-\-no\-atexit
+Skip atexit callbacks execution from external libraries
+which may access destroyed shm memory causing crash on shutdown.
 .TP
-.BI \-m " shared_mem_size"
-Size of the shared memory which will be allocated (in Megabytes).
+.BI \-P " pid\-file"
+Creates a file containing the pid of the main
+.B kamailio
+process.
 .TP
-.BI \-M " private_mem_size"
-Size of the private memory which will be allocated per process (in Megabytes).
+.BI \-O " optimization\-level"
+Script optimization level (debugging option).
 .TP
-.BI \-w " working\-dir"
-Specifies the working directory. In the very improbable event that
+.BI \-P " pid\-file"
+Creates a file containing the pid of the main
 .B kamailio
-will crash, the core file will be generated here.
+process.
+.TP
+.BI \-Q
+Number of sctp child processes (default: equal to
+.BI \-n
+).
+.TP
+.BI \-r
+Uses dns to check if it is necessary to add a "received=" field to a via.
+.TP
+.BI \-R
+Same as
+.B \-r
+but uses reverse dns (to use both:
+.BI \-rR
+).
+.TP
+.BI \-\-server\-id\fR=\fInum
+Set the value for server_id
+.TP
+.BI \-\-subst\fR=\fIexp
+Set a subst preprocessor directive
+.TP
+.BI \-\-substdef\fR=\fIexp
+Set a substdef preprocessor directive
+.TP
+.BI \-\-substdefs\fR=\fIexp
+Set a substdefs preprocessor directive.
+.TP
+.BI \-S
+Disables SCTP support.
 .TP
 .BI \-t " chroot\-dir"
 Forces
 .B kamailio
 to chroot after reading the config file.
 .TP
+.BI \-T
+Disables TCP support.
+.TP
 .BI \-u " uid"
 Changes the user id under which
 .B kamailio
 runs.
 .TP
-.BI \-g " gid"
-Changes the group id under which
-.B kamailio
-runs.
+.BI "\-v \-V \-\-version"
+Displays the version number.
 .TP
-.BI \-P " pid\-file"
-Creates a file containing the pid of the main
-.B kamailio
-process.
+.BI \-x " name"
+Specify internal manager for shared memory (shm) can be: fm, qm or tlsf
 .TP
-.BI \-G " pgid\-file"
-Creates a file containing the pgid of the main
-.B kamailio
-process.
+.BI \-X " name"
+Specify internal manager for private memory (pkg) if omitted, the one for shm is used
 .TP
-.BI \-L " modules\-dir"
-Specifies the directory where to look for
+ .BI \-Y " dir"
+ Runtime dir path
+.TP
+.BI \-w " working\-dir"
+Specifies the working directory. In the very improbable event that
 .B kamailio
-modules (default: /usr/lib/kamailio/modules or /usr/lib64/kamailio/modules)
+will crash, the core file will be generated here.
 .TP
-.BI \-a " auto\-aliases\-mode"
-Enable auto-aliases with 'yes' or 'on', disable with 'no' or 'off
+.BI \-W " type"
+poll method (depending on support in OS, it can be: poll,
+epoll_lt, epoll_et, sigio_rt, select, kqueue, /dev/poll).
 .TP
-.BI \-A " pre\-processor\-define"
-Add config pre-processor define (e.g., -A WITH_AUTH, -A N=1, -A X='"Y"')
-
 .SH FILES
 .PD 0
 .B /usr/sbin/kamailio