Fix various documentation issues (bugs #5464-5467)
[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" "18 October 2005" "asterisk 1.2" ""
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, IAX2, 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 At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
29 file and locates the rest of the configuration files from the configuration
30 in that file. The -C option specifies an alternate main configuration file.
31 Virtually all aspects of the operation of asterisk's configuration files
32 can be found in the sample configuration files.  The format for those files
33 is generally beyond the scope of this man page.
34 .PP
35 When running with \fB-c\fR, \fB-r\fR or \fB-R\fR
36 options, Asterisk supplies a powerful command line, including command
37 completion, which may be used to monitors its status, perform a variety
38 of administrative actions and even explore the applications that are
39 currently loaded into the system.
40 .PP
41 Asterisk is a trademark of Digium, Inc.
42 .SH "OPTIONS"
43 .TP
44 \fB-C \fIfile\fB\fR
45 Use \fIfile\fR as master configuration file
46 instead of the default, /etc/asterisk/asterisk.conf
47 .TP
48 \fB-c\fR
49 Provide a control console on the calling terminal.
50 Specifying this option implies \fB-f\fR and will cause
51 asterisk to no longer fork or detach from the controlling terminal.
52 .TP
53 \fB-d\fR
54 Enable extra debugging statements.
55
56 Note: This always sets the debug level in the asterisk process,
57 even if it is running in the background. This will affect the size
58 of your log files.
59 .TP
60 \fB-f\fR
61 Do not fork or detach from controlling terminal.
62 .TP
63 \fB-g\fR
64 Remove resource limit on core size, thus forcing Asterisk to dump
65 core in the unlikely event of a segmentation fault or abort signal.
66 \fBNOTE:\fR in some cases this may be incompatible
67 with the \fB-U\fR or \fB-G\fR flags.
68 .TP
69 \fB-G \fIgroup\fB\fR
70 Run as group \fIgroup\fR instead of the
71 calling group.  \fBNOTE:\fR this requires substantial work
72 to be sure that Asterisk's environment has permission to write
73 the files required for its operation, including logs, its comm
74 socket, the asterisk database, etc.
75 .TP
76 \fB-h\fR
77 Provide brief summary of command line arguments and terminate.
78 .TP
79 \fB-i\fR
80 Prompt user to intialize any encrypted private keys for IAX2
81 secure authentication during startup.
82 .TP
83 \fB-M \fIvalue\fB\fR
84 Limits the maximum number of calls to the specified value.  This can
85 be useful to prevent a system from being brought down by terminating
86 too many simultaneous calls.
87 .TP
88 \fB-n\fR
89 Disable ANSI colors even on terminals capable of displaying them.
90 .TP
91 \fB-p\fR
92 If supported by the operating system (and executing as root),
93 attempt to run with realtime priority for increased performance and
94 responsiveness within the Asterisk process, at the expense of other
95 programs running on the same machine.
96 .TP
97 \fB-q\fR
98 Reduce default console output when running in conjunction with
99 console mode (\fB-c\fR).
100 .TP
101 \fB-r\fR
102 Instead of running a new Asterisk process, attempt to connect
103 to a running Asterisk process and provide a console interface
104 for controlling it.
105 .TP
106 \fB-R\fR
107 Much like \fB-r\fR\&.  Instead of running a new Asterisk process, attempt to connect
108 to a running Asterisk process and provide a console interface
109 for controlling it. Additionally, if connection to the Asterisk 
110 process is lost, attempt to reconnect for as long as 30 seconds.
111 .TP
112 \fB-t\fR
113 When recording files, write them first into a temporary holding directory, 
114 then move them into the final location when done.
115 .TP
116 \fB-T\fR
117 Add timestamp to all non-command related output going to the console
118 when running with verbose and/or logging to the console.
119 .TP
120 \fB-U \fIuser\fB\fR
121 Run as user \fIuser\fR instead of the
122 calling user.  \fBNOTE:\fR this requires substantial work
123 to be sure that Asterisk's environment has permission to write
124 the files required for its operation, including logs, its comm
125 socket, the asterisk database, etc.
126 .TP
127 \fB-v\fR
128 Increase the level of verboseness on the console.  The more times
129 \fB-v\fR is specified, the more verbose the output is.
130 Specifying this option implies \fB-f\fR and will cause
131 asterisk to no longer fork or detach from the controlling terminal.
132 This option may also be used in conjunction with \fB-r\fR
133 and \fB-R\fR\&.
134
135 Note: This always sets the verbose level in the asterisk process,
136 even if it is running in the background. This will affect the size
137 of your log files.
138 .TP
139 \fB-V\fR
140 Display version information and exit immediately.
141 .TP
142 \fB-x \fIcommand\fB\fR
143 Connect to a running Asterisk process and execute a command on
144 a command line, passing any output through to standard out and
145 then terminating when the command execution completes.  Implies
146 \fB-r\fR when \fB-R\fR is not explicitly
147 supplied.
148 .SH "EXAMPLES"
149 .PP
150 \fBasterisk\fR - Begin Asterisk as a daemon
151 .PP
152 \fBasterisk -vvvgc\fR - Run on controlling terminal
153 .PP
154 \fBasterisk -rx "show channels"\fR - Display channels on running server
155 .SH "BUGS"
156 .PP
157 Bug reports and feature requests may be filed at http://bugs.digium.com
158 .SH "SEE ALSO"
159 .PP
160 *CLI> \fBhelp\fR - Help on Asterisk CLI
161 .PP
162 *CLI> \fBshow applications\fR - Show loaded dialplan applications
163 .PP
164 *CLI> \fBshow functions\fR - Show loaded dialplan functions
165 .PP
166 http://www.asterisk.org - The Asterisk Home Page
167 .PP
168 http://www.asteriskdocs.org - The Asterisk Documentation Project
169 .PP
170 http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
171 .PP
172 http://www.digium.com/ - Asterisk sponsor and hardware supplier
173 .PP
174 http://www.markocam.com/ - Asterisk author's web cam
175 .SH "AUTHOR"
176 .PP
177 Mark Spencer <markster@digium.com>
178 .PP
179 Countless other contributers, see CREDITS with distribution for more information