Automatically create new buddy upon reception of a presence stanza of
[asterisk/asterisk.git] / doc / 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" "25 October 2005" "asterisk 1.2" ""
7
8 .SH NAME
9 asterisk \- All-purpose telephony server.
10 .SH SYNOPSIS
11
12 \fBasterisk\fR [ \fB-tThfdvVqpRgciIn\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 ] [ \fB-s \fIsocket\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 initialize any encrypted private keys for IAX2
81 secure authentication during startup.
82 .TP
83 \fB-L \fIloadaverage\fB\fR
84 Limits the maximum load average before rejecting new calls.  This can
85 be useful to prevent a system from being brought down by terminating
86 too many simultaneous calls.
87 .TP
88 \fB-m\fR
89 Disable log and verbose output to remote (-r) consoles.
90 .TP
91 \fB-M \fIvalue\fB\fR
92 Limits the maximum number of calls to the specified value.  This can
93 be useful to prevent a system from being brought down by terminating
94 too many simultaneous calls.
95 .TP
96 \fB-n\fR
97 Disable ANSI colors even on terminals capable of displaying them.
98 .TP
99 \fB-p\fR
100 If supported by the operating system (and executing as root),
101 attempt to run with realtime priority for increased performance and
102 responsiveness within the Asterisk process, at the expense of other
103 programs running on the same machine.
104 .TP
105 \fB-q\fR
106 Reduce default console output when running in conjunction with
107 console mode (\fB-c\fR).
108 .TP
109 \fB-r\fR
110 Instead of running a new Asterisk process, attempt to connect
111 to a running Asterisk process and provide a console interface
112 for controlling it.
113 .TP
114 \fB-R\fR
115 Much like \fB-r\fR\&.  Instead of running a new Asterisk process, attempt to connect
116 to a running Asterisk process and provide a console interface
117 for controlling it. Additionally, if connection to the Asterisk 
118 process is lost, attempt to reconnect for as long as 30 seconds.
119 .TP
120 \fB-s \fIsocket\fB\fR
121 Allows to specify the socket file to be used to connect to the
122 Asterisk console. Used in conjunction with \fB-r\fR or \fB-R\fR.
123 .TP
124 \fB-I\fR
125 Enable internal timing if Zaptel timer is available
126 The default behaviour is that outbound packets are phase locked
127 to inbound packets. Enabling this switch causes them to be
128 locked to the internal Zaptel timer instead.
129 .TP
130 \fB-t\fR
131 When recording files, write them first into a temporary holding directory, 
132 then move them into the final location when done.
133 .TP
134 \fB-T\fR
135 Add timestamp to all non-command related output going to the console
136 when running with verbose and/or logging to the console.
137 .TP
138 \fB-U \fIuser\fB\fR
139 Run as user \fIuser\fR instead of the
140 calling user.  \fBNOTE:\fR this requires substantial work
141 to be sure that Asterisk's environment has permission to write
142 the files required for its operation, including logs, its comm
143 socket, the asterisk database, etc.
144 .TP
145 \fB-v\fR
146 Increase the level of verboseness on the console.  The more times
147 \fB-v\fR is specified, the more verbose the output is.
148 Specifying this option implies \fB-f\fR and will cause
149 asterisk to no longer fork or detach from the controlling terminal.
150 This option may also be used in conjunction with \fB-r\fR
151 and \fB-R\fR\&.
152
153 Note: This always sets the verbose level in the asterisk process,
154 even if it is running in the background. This will affect the size
155 of your log files.
156 .TP
157 \fB-V\fR
158 Display version information and exit immediately.
159 .TP
160 \fB-x \fIcommand\fB\fR
161 Connect to a running Asterisk process and execute a command on
162 a command line, passing any output through to standard out and
163 then terminating when the command execution completes.  Implies
164 \fB-r\fR when \fB-R\fR is not explicitly
165 supplied.
166 .SH "EXAMPLES"
167 .PP
168 \fBasterisk\fR - Begin Asterisk as a daemon
169 .PP
170 \fBasterisk -vvvgc\fR - Run on controlling terminal
171 .PP
172 \fBasterisk -rx "core show channels"\fR - Display channels on running server
173 .SH "BUGS"
174 .PP
175 Bug reports and feature requests may be filed at http://bugs.digium.com
176 .SH "SEE ALSO"
177 .PP
178 *CLI> \fBhelp\fR - Help on Asterisk CLI
179 .PP
180 *CLI> \fBcore show applications\fR - Show loaded dialplan applications
181 .PP
182 *CLI> \fBcore show functions\fR - Show loaded dialplan functions
183 .PP
184 *CLI> \fBdialplan show\fR - Show current dialplan
185 .PP
186 http://www.asterisk.org - The Asterisk Home Page
187 .PP
188 http://www.asteriskdocs.org - The Asterisk Documentation Project
189 .PP
190 http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
191 .PP
192 http://www.digium.com/ - Asterisk sponsor and hardware supplier
193 .PP
194 http://www.markocam.com/ - Asterisk author's web cam
195 .SH "AUTHOR"
196 .PP
197 Mark Spencer <markster@digium.com>
198 .PP
199 Countless other contributors, see CREDITS with distribution for more information