1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
.\" $Id: openser.8,v 1.2 2006/06/08 12:10:56 miconda Exp $
.\" Process with
.\" groff -man -Tascii openser.8
.\"
.TH "OpenSER" "8" "08.06.2006" "OpenSER" "VoIP SIP Server"
.SH "NAME"
openser \- flexible and roboust SIP (RFC3261, RFC3263) server for Voice over IP (VoIP)
.SH "SYNOPSIS"
.B openser
[
.B \-hcCrRvdDEVT
] [
.BI \-f " config\-file"
] [
.BI \-l " address"
] [
.BI \-n " processes\-no"
] [
.BI \-N " tcp processes\-no"
] [
.BI \-b " max_rcv_buf_size"
] [
.BI \-m " shared_mem_size"
] [
.BI \-w " working\-dir"
] [
.BI \-W " method"
] [
.BI \-t " chroot\-dir"
] [
.BI \-u " uid"
] [
.BI \-g " gid"
] [
.BI \-P " pid\-file"
] [
.BI \-i " fifo\-path"
] [
.BI \-x " socket\-path"
]
.SH "DESCRIPTION"
.B OpenSER
.BR
is a SIP\-based VoIP server running on most Unix\-like operating systems. It supports UDP, TCP and TLS transport layers. Among its features:
.IP *
SIP Proxy Server, SIP Registrar Server, SIP Redirect Server, SIP Location Server, SIP Application Server
.IP *
Call Processing Language (RFC3880)
.IP *
ENUM support
.IP *
server side NAT traversal
.IP *
LCR \- least cost routing
.IP *
load balancing
.IP *
AAA with database (MySQL, Postgres, Unixodbc) or RADIUS backend
.IP *
audio, video, instant messaging and pressence
.SH "OPTIONS"
.TP 12
.B \-h
Displays a short usage description, including all available options.
.TP
.BI \-c
Checks the config file and displays the aliases and listen interface list.
.TP
.BI \-C
Similar to \-c but in addition checks the flags of exported functions from included route blocks.
.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.
.TP
.BI \-v
Turns on via host checking when forwarding replies.
.TP
.BI \-d
Turns on debugging, multiple
.B \-d
increase the debug level.
.TP
.BI \-D
Runs openser in the foreground (it doesn't fork into daemon mode).
.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 \-f " config\-file"
Reads the configuration from
.B " config\-file"
(default
.I /etc/openser/openser.cfg
).
.TP
.BI \-l " address"
Listens on the specified address/interface. Multiple
.B \-l
mean listening on multiple addresses. The address format is
[proto:]address[:port], where proto = udp|tcp and
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 \-n " processes\-no"
Specifies the number of children processes forked per interface (default 8).
.TP
.BI \-N " tcp processes\-no"
Specifies the number of children processes forked to handle tcp incoming connections (by default is equal to
.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.
.TP
.BI \-m " shared_mem_size"
Size of the shared memory which will be allocated (in Megabytes).
.TP
.BI \-w " working\-dir"
Specifies the working directory. In the very improbable event that
.B openser
will crash, the core file will be generated here.
.TP
.BI \-W " method"
Specify poll method.
.TP
.BI \-t " chroot\-dir"
Forces
.B openser
to chroot after reading the config file.
.TP
.BI \-u " uid"
Changes the user id under which
.B openser
runs.
.TP
.BI \-g " gid"
Changes the group id under which
.B openser
runs.
.TP
.BI \-P " pid\-file"
Creates a file containing the pid of the main
.B openser
process.
.TP
.BI \-i " fifo\-path"
Creates a fifo, usefull for monitoring
.B openser
status.
.TP
.BI \-x " socket\-path"
Creates a unix socket, usefull for monitoring
.B openser
status ( same as
.BI \-i " fifo\-path"
but using instead unix sockets).
.SH "FILES"
.PD 0
.B /usr/sbin/openser
.br
.B /etc/openser/openser.cfg
.br
.B /usr/lib/openser/modules/*
.PD
.SH "AUTHORS"
see
.B /usr/share/doc/openser/AUTHORS
.SH "SEE ALSO"
.BR openser.cfg(5)
.PP
Full documentation on openser is available at
.I http://www.openser.org/.
.PP
Project tracker and CVS
.I
http://sourceforge.net/projects/openser/.
.PP
Mailing lists:
.nf
users@openser.org \- openser user community
.nf
devel@openser.org \- openser development, new features and unstable version
|