1OPENPBX(8) OPENPBX(8)
2
6 openpbx - All-purpose telephony server.
7
9 openpbx [ -tThfdvVqpRgcin ] [ -C file ] [ -U user ] [ -G group ] [ -x
10 command ] [ -M value ]
11 openpbx -r [ -v ] [ -x command ]
14
17 openpbx is a full-featured telephony server which provides Private
18 Branch eXchange (PBX), Interactive Voice Response (IVR), Automated Call
19 Distribution (ACD), Voice over IP (VoIP) gatewaying, Conferencing, and
20 a plethora of other telephony applications to a broad range of tele‐
21 phony devices including packet voice (SIP, IAX, MGCP, Skinny, H.323)
22 devices (both endpoints and proxies), as well as traditional TDM hard‐
23 ware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
24 ISDN BRI, T38, and many more.
25 OpenPBX reads most of its configuration files from configuration files
27 located in /opt/openpbx.org/etc. Virtually all aspects of the opera‐
28 tion of openpbx's configuration files can be found in the sample con‐
29 figuration files. The format for those files is generally beyond the
30 scope of this man page.
31 When running with -c, -r or -R options, OpenPBX supplies a powerful
33 command line, including command completion, which may be used to moni‐
34 tors its status, perform a variety of administrative actions and even
35 explore the applications that are currently loaded into the system.
36
38 -C file
39 Use file as master configuration file instead of the default,
40 ex: /opt/openpbx.org/etc/openpbx.conf
41 -c Provide a control console on the calling terminal. Specifying
43 this option implies -f and will cause openpbx to no longer fork
44 or detach from the controlling terminal.
45 -d Enable extra debugging statements.
47 -f Do not fork or detach from controlling terminal.
49 -g Remove resource limit on core size, thus forcing OpenPBX to dump
51 core in the unlikely event of a segmentation fault or abort sig‐
52 nal. NOTE: in some cases this may be incompatible with the -U
53 or -G flags.
54 -G group
56 Run as group group instead of the calling group. NOTE: this
57 requires substantial work to be sure that OpenPBX's environment
58 has permission to write the files required for its operation,
59 including logs, its comm socket, the openpbx database, etc.
60 -h Provide brief summary of command line arguments and terminate.
62 -i Prompt user to intialize any encrypted private keys during
64 startup.
65 -L loadaverage
67 Limits the maximum load average before rejecting new calls.
68 This can be useful to prevent a system from being brought down
69 by terminating too many simultaneous calls.
70 -M value
72 Limits the maximum number of calls to the specified value. This
73 can be useful to prevent a system from being brought down by
74 terminating too many simultaneous calls.
75 -n Disable ANSI colors even on terminals capable of displaying
77 them.
78 -p If supported by the operating system (and executing as root),
80 attempt to run with realtime priority for increased performance
81 and responsiveness within the OpenPBX process, at the expense of
82 other programs running on the same machine.
83 -q Reduce default console output when running in conjunction with
85 console mode (-c).
86 -r Instead of running a new OpenPBX process, attempt to connect to
88 a running OpenPBX process and provide a console interface for
89 controlling it.
90 -R Much like -r. Instead of running a new OpenPBX process, attempt
92 to connect to a running OpenPBX process and provide a console
93 interface for controlling it. Additionally, if connection to the
94 OpenPBX process is lost, attempt to reconnect for as long as 30
95 seconds.
96 -t When recording files, write them first into a temporary holding
98 directory, then move them into the final location when done.
99 -T Add timestamp to all non-command related output going to the
101 console when running with verbose and/or logging to the console.
102 -U user
104 Run as user user instead of the calling user. NOTE: this
105 requires substantial work to be sure that OpenPBX's environment
106 has permission to write the files required for its operation,
107 including logs, its comm socket, the openpbx database, etc.
108 -v Increase the level of verboseness on the console. The more
110 times -v is specified, the more verbose the output is. Specify‐
111 ing this option implies -f and will cause openpbx to no longer
112 fork or detach from the controlling terminal. This option may
113 also be used in conjunction with -r and -R
114 -V Display version information and exit immediately.
116 -x command
118 Connect to a running OpenPBX process and execute a command on a
119 command line, passing any output through to standard out and
120 then terminating when the command execution completes. Implies
121 -r when -R is not explicitly supplied.
122
124 openpbx - Begin OpenPBX as a daemon
125 openpbx -vvvgc - Run on controlling terminal
127 openpbx -rx "show channels" - Display channels on running server
129
131 Bug reports and feature requests may be filed at
132 http://trac.openpbx.org
133
135 *CLI> help - Help on OpenPBX CLI
136 *CLI> show applications - Show loaded applications
138 http://www.openpbx.org - The OpenPBX Home Page
140 http://wiki.openpbx.org - The OpenPBX.org Wiki
142
144 OpenPBX Community www.openpbx.org
145 Countless number of contributers, see CREDITS with distribution for
147 more information
148openpbx 1.2-RC3 12 October 2006 OPENPBX(8)