fix some formatting and add some comments (issue #5403)
[asterisk/asterisk.git] / asterisk.8
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "ASTERISK" "8" "17 May 2005" "asterisk 1.0" ""
7
8 .SH NAME
9 asterisk \- All-purpose telephony server.
10 .SH SYNOPSIS
11
12 \fBasterisk\fR [ \fB-tThfdvVqpRgcin\fR ] [ \fB-C \fIfile\fB\fR ] [ \fB-U \fIuser\fB\fR ] [ \fB-G \fIgroup\fB\fR ] [ \fB-x \fIcommand\fB\fR ] [ \fB-M \fIvalue\fB\fR ]
13
14
15 \fBasterisk -r\fR [ \fB-v\fR ] [ \fB-x \fIcommand\fB\fR ]
16
17 .SH "DESCRIPTION"
18 .PP
19 \fBasterisk\fR is a full-featured telephony server which
20 provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
21 Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, 
22 Conferencing, and a plethora of other telephony applications to a broad
23 range of telephony devices including packet voice (SIP, IAX, MGCP, Skinny,
24 H.323) devices (both endpoints and proxies), as well as traditional TDM
25 hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
26 ISDN BRI, and many more.
27 .PP
28 Asterisk reads most of its configuration files from configuration files
29 located in /etc/asterisk.  Virtually all aspects of the operation of
30 asterisk's configuration files can be found in the sample configuration
31 files.  The format for those files is generally beyond the scope of this
32 man page.
33 .PP
34 When running with \fB-c\fR, \fB-r\fR or \fB-R\fR
35 options, Asterisk supplies a powerful command line, including command
36 completion, which may be used to monitors its status, perform a variety
37 of administrative actions and even explore the applications that are
38 currently loaded into the system.
39 .SH "OPTIONS"
40 .TP
41 \fB-C \fIfile\fB\fR
42 Use \fIfile\fR as master configuration file
43 instead of the default, /etc/asterisk/asterisk.conf
44 .TP
45 \fB-c\fR
46 Provide a control console on the calling terminal.
47 Specifying this option implies \fB-f\fR and will cause
48 asterisk to no longer fork or detach from the controlling terminal.
49 .TP
50 \fB-d\fR
51 Enable extra debugging statements.
52 .TP
53 \fB-f\fR
54 Do not fork or detach from controlling terminal.
55 .TP
56 \fB-g\fR
57 Remove resource limit on core size, thus forcing Asterisk to dump
58 core in the unlikely event of a segmentation fault or abort signal.
59 \fBNOTE:\fR in some cases this may be incompatible
60 with the \fB-U\fR or \fB-G\fR flags.
61 .TP
62 \fB-G \fIgroup\fB\fR
63 Run as group \fIgroup\fR instead of the
64 calling group.  \fBNOTE:\fR this requires substantial work
65 to be sure that Asterisk's environment has permission to write
66 the files required for its operation, including logs, its comm
67 socket, the asterisk database, etc.
68 .TP
69 \fB-h\fR
70 Provide brief summary of command line arguments and terminate.
71 .TP
72 \fB-i\fR
73 Prompt user to intialize any encrypted private keys during startup.
74 .TP
75 \fB-M \fIvalue\fB\fR
76 Limits the maximum number of calls to the specified value.  This can
77 be useful to prevent a system from being brought down by terminating
78 too many simultaneous calls.
79 .TP
80 \fB-n\fR
81 Disable ANSI colors even on terminals capable of displaying them.
82 .TP
83 \fB-p\fR
84 If supported by the operating system (and executing as root),
85 attempt to run with realtime priority for increased performance and
86 responsiveness within the Asterisk process, at the expense of other
87 programs running on the same machine.
88 .TP
89 \fB-q\fR
90 Reduce default console output when running in conjunction with
91 console mode (\fB-c\fR).
92 .TP
93 \fB-r\fR
94 Instead of running a new Asterisk process, attempt to connect
95 to a running Asterisk process and provide a console interface
96 for controlling it.
97 .TP
98 \fB-R\fR
99 Much like \fB-r\fR\&.  Instead of running a new Asterisk process, attempt to connect
100 to a running Asterisk process and provide a console interface
101 for controlling it. Additionally, if connection to the Asterisk 
102 process is lost, attempt to reconnect for as long as 30 seconds.
103 .TP
104 \fB-t\fR
105 When recording files, write them first into a temporary holding directory, 
106 then move them into the final location when done.
107 .TP
108 \fB-T\fR
109 Add timestamp to all non-command related output going to the console
110 when running with verbose and/or logging to the console.
111 .TP
112 \fB-U \fIuser\fB\fR
113 Run as user \fIuser\fR instead of the
114 calling user.  \fBNOTE:\fR this requires substantial work
115 to be sure that Asterisk's environment has permission to write
116 the files required for its operation, including logs, its comm
117 socket, the asterisk database, etc.
118 .TP
119 \fB-v\fR
120 Increase the level of verboseness on the console.  The more times
121 \fB-v\fR is specified, the more verbose the output is.
122 Specifying this option implies \fB-f\fR and will cause
123 asterisk to no longer fork or detach from the controlling terminal.
124 This option may also be used in conjunction with \fB-r\fR
125 and \fB-R\fR
126 .TP
127 \fB-V\fR
128 Display version information and exit immediately.
129 .TP
130 \fB-x \fIcommand\fB\fR
131 Connect to a running Asterisk process and execute a command on
132 a command line, passing any output through to standard out and
133 then terminating when the command execution completes.  Implies
134 \fB-r\fR when \fB-R\fR is not explicitly
135 supplied.
136 .SH "EXAMPLES"
137 .PP
138 \fBasterisk\fR - Begin Asterisk as a daemon
139 .PP
140 \fBasterisk -vvvgc\fR - Run on controlling terminal
141 .PP
142 \fBasterisk -rx "show channels"\fR - Display channels on running server
143 .SH "BUGS"
144 .PP
145 Bug reports and feature requests may be filed at http://bugs.digium.com
146 .SH "SEE ALSO"
147 .PP
148 *CLI> \fBhelp\fR - Help on Asterisk CLI
149 .PP
150 *CLI> \fBshow applications\fR - Show loaded applications
151 .PP
152 http://www.asterisk.org - The Asterisk Home Page
153 .PP
154 http://www.asteriskdocs.org - The Asterisk Documentation Project
155 .PP
156 http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
157 .PP
158 http://www.digium.com/ - Asterisk sponsor and hardware supplier
159 .PP
160 http://www.markocam.com/ - Asterisk author's web cam
161 .SH "AUTHOR"
162 .PP
163 Mark Spencer <markster@digium.com>
164 .PP
165 Countless other contributers, see CREDITS with distribution for more information