opensips-clone / opensips.8

.\" $Id: opensips.8 4395 2008-06-16 15:49:24Z henningw $
.\" Process with
.\" groff -man -Tascii opensips.8
.\" 
.TH "OpenSIPS" "8" "08.06.2006" "OpenSIPS" "VoIP SIP Server"
.SH "NAME"
opensips \- flexible and roboust SIP (RFC3261, RFC3263) server for Voice over IP (VoIP)

.SH "SYNOPSIS"
.B opensips
[
.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 OpenSIPS 
.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 opensips 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/opensips/opensips.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 opensips 
will crash, the core file will be generated here.
.TP 
.BI \-W " method"
Specify poll method.
.TP 
.BI \-t " chroot\-dir"
Forces 
.B opensips 
to chroot after reading the config file.
.TP 
.BI \-u " uid"
Changes the user id under which 
.B opensips
runs.
.TP 
.BI \-g " gid"
Changes the group id under which 
.B opensips 
runs.
.TP 
.BI \-P " pid\-file"
Creates a file containing the pid of the main 
.B opensips 
process.
.TP 
.BI \-i " fifo\-path"
Creates a fifo, usefull for monitoring
.B opensips
status.
.TP 
.BI \-x " socket\-path"
Creates a unix socket, usefull for monitoring
.B opensips
status ( same as
.BI \-i " fifo\-path" 
but using instead unix sockets).


.SH "FILES"
.PD 0
.B /usr/sbin/opensips
.br 
.B /etc/opensips/opensips.cfg
.br 
.B /usr/lib/opensips/modules/*
.PD
.SH "AUTHORS"
see 
.B /usr/share/doc/opensips/AUTHORS

.SH "SEE ALSO"
.BR opensips.cfg(5)
.PP 
Full documentation on opensips is available at
.I http://www.opensips.org/.
.PP 
Project tracker and SVN
.I 
http://sourceforge.net/projects/opensips/.
.PP 
Mailing lists:
.nf 
users@lists.opensips.org \- opensips user community
.nf 
devel@lists.opensips.org \- opensips development, new features and unstable version
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.