handle peer matching for subscriptions by name instead of IP address (issue #5103)
[asterisk/asterisk.git] / asterisk.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry>
3 <refentryinfo>
4         <date>2004-07-18</date>
5 </refentryinfo>
6 <refmeta>
7         <refentrytitle>
8                 <application>asterisk</application>
9         </refentrytitle>
10         <manvolnum>8</manvolnum>
11         <refmiscinfo>asterisk 1.0</refmiscinfo>
12 </refmeta>
13 <refnamediv>
14         <refname>
15                 <application>asterisk</application>
16         </refname>
17         <refpurpose>
18         All-purpose telephony server.
19         </refpurpose>
20 </refnamediv>
21 <refsynopsisdiv>
22         <cmdsynopsis>
23         <command>asterisk</command>
24 <arg><option>-tThfdvVqpRgcin</option></arg>
25 <arg><option>-C </option><replaceable class="parameter">file</replaceable></arg>
26 <arg><option>-U </option><replaceable class="parameter">user</replaceable></arg>
27 <arg><option>-G </option><replaceable class="parameter">group</replaceable></arg>
28 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
29 <arg><option>-M </option><replaceable class="parameter">value</replaceable></arg>
30         </cmdsynopsis>
31         <cmdsynopsis>
32
33         <command>asterisk -r</command>
34         <arg><option>-v</option></arg>
35 <arg><option>-x </option><replaceable class="parameter">command</replaceable></arg>
36         </cmdsynopsis>
37 </refsynopsisdiv>
38 <refsect1>
39         <refsect1info>
40                 <date>2004-07-01</date>
41         </refsect1info>
42         <title>DESCRIPTION</title>
43         <para>
44         <command>asterisk</command> is a full-featured telephony server which
45         provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
46         Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, 
47         Conferencing, and a plethora of other telephony applications to a broad
48         range of telephony devices including packet voice (SIP, IAX, MGCP, Skinny,
49         H.323) devices (both endpoints and proxies), as well as traditional TDM
50         hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
51         ISDN BRI, and many more.
52         </para>
53         <para>
54         Asterisk reads most of its configuration files from configuration files
55         located in /etc/asterisk.  Virtually all aspects of the operation of
56         asterisk's configuration files can be found in the sample configuration
57         files.  The format for those files is generally beyond the scope of this
58         man page.
59         </para>
60         <para>
61         When running with <command>-c</command>, <command>-r</command> or <command>-R</command>
62         options, Asterisk supplies a powerful command line, including command
63         completion, which may be used to monitors its status, perform a variety
64         of administrative actions and even explore the applications that are
65         currently loaded into the system.
66         </para>
67 </refsect1>
68 <refsect1>
69         <title>OPTIONS</title>
70         <variablelist>
71         <varlistentry>
72                 <term>-C <replaceable class="parameter">file</replaceable></term>
73                 <listitem>
74                         <para>
75                         Use <filename>file</filename> as master configuration file
76                         instead of the default, /etc/asterisk/asterisk.conf
77                         </para>
78                 </listitem>
79         </varlistentry>
80         <varlistentry>
81                 <term>-c</term>
82                 <listitem>
83                         <para>
84                         Provide a control console on the calling terminal.
85                         Specifying this option implies <command>-f</command> and will cause
86                         asterisk to no longer fork or detach from the controlling terminal.
87                         </para>
88                 </listitem>
89         </varlistentry>
90         <varlistentry>
91                 <term>-d</term>
92                 <listitem>
93                         <para>
94                         Enable extra debugging statements.
95                         </para>
96                 </listitem>
97         </varlistentry>
98         <varlistentry>
99                 <term>-f</term>
100                 <listitem>
101                         <para>
102                         Do not fork or detach from controlling terminal.
103                         </para>
104                 </listitem>
105         </varlistentry>
106         <varlistentry>
107                 <term>-g</term>
108                 <listitem>
109                         <para>
110                         Remove resource limit on core size, thus forcing Asterisk to dump
111                         core in the unlikely event of a segmentation fault or abort signal.
112                         <command>NOTE:</command> in some cases this may be incompatible
113                         with the <command>-U</command> or <command>-G</command> flags.
114                         </para>
115                 </listitem>
116         </varlistentry>
117         <varlistentry>
118                 <term>-G <replaceable class="parameter">group</replaceable></term>
119                 <listitem>
120                         <para>
121                         Run as group <replaceable>group</replaceable> instead of the
122                         calling group.  <command>NOTE:</command> 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                         </para>
127                 </listitem>
128         </varlistentry>
129         <varlistentry>
130                 <term>-h</term>
131                 <listitem>
132                         <para>
133                         Provide brief summary of command line arguments and terminate.
134                         </para>
135                 </listitem>
136         </varlistentry>
137         <varlistentry>
138                 <term>-i</term>
139                 <listitem>
140                         <para>
141                         Prompt user to intialize any encrypted private keys during startup.
142                         </para>
143                 </listitem>
144         </varlistentry>
145         <varlistentry>
146                 <term>-M <replaceable class="parameter">value</replaceable></term>
147                 <listitem>
148                         <para>
149                         Limits the maximum number of calls to the specified value.  This can
150                         be useful to prevent a system from being brought down by terminating
151                         too many simultaneous calls.
152                         </para>
153                 </listitem>
154         </varlistentry>
155         <varlistentry>
156                 <term>-n</term>
157                 <listitem>
158                         <para>
159                         Disable ANSI colors even on terminals capable of displaying them.
160                         </para>
161                 </listitem>
162         </varlistentry>
163         <varlistentry>
164                 <term>-p</term>
165                 <listitem>
166                         <para>
167                         If supported by the operating system (and executing as root),
168                         attempt to run with realtime priority for increased performance and
169                         responsiveness within the Asterisk process, at the expense of other
170                         programs running on the same machine.
171                         </para>
172                 </listitem>
173         </varlistentry>
174         <varlistentry>
175                 <term>-q</term>
176                 <listitem>
177                         <para>
178                         Reduce default console output when running in conjunction with
179                         console mode (<command>-c</command>).
180                         </para>
181                 </listitem>
182         </varlistentry>
183         <varlistentry>
184                 <term>-r</term>
185                 <listitem>
186                         <para>
187                         Instead of running a new Asterisk process, attempt to connect
188                         to a running Asterisk process and provide a console interface
189                         for controlling it.
190                         </para>
191                 </listitem>
192         </varlistentry>
193         <varlistentry>
194                 <term>-R</term>
195                 <listitem>
196                         <para>
197                         Much like <command>-r</command>.  Instead of running a new Asterisk process, attempt to connect
198                         to a running Asterisk process and provide a console interface
199                         for controlling it. Additionally, if connection to the Asterisk 
200                         process is lost, attempt to reconnect for as long as 30 seconds.
201                         </para>
202                 </listitem>
203         </varlistentry>
204         <varlistentry>
205                 <term>-t</term>
206                 <listitem>
207                         <para>
208                         When recording files, write them first into a temporary holding directory, 
209                         then move them into the final location when done.
210                         </para>
211                 </listitem>
212         </varlistentry>
213         <varlistentry>
214                 <term>-T</term>
215                 <listitem>
216                         <para>
217                         Add timestamp to all non-command related output going to the console
218                         when running with verbose and/or logging to the console.
219                         </para>
220                 </listitem>
221         </varlistentry>
222         <varlistentry>
223                 <term>-U <replaceable class="parameter">user</replaceable></term>
224                 <listitem>
225                         <para>
226                         Run as user <replaceable>user</replaceable> instead of the
227                         calling user.  <command>NOTE:</command> this requires substantial work
228                         to be sure that Asterisk's environment has permission to write
229                         the files required for its operation, including logs, its comm
230                         socket, the asterisk database, etc.
231                         </para>
232                 </listitem>
233         </varlistentry>
234         <varlistentry>
235                 <term>-v</term>
236                 <listitem>
237                         <para>
238                         Increase the level of verboseness on the console.  The more times
239                         <command>-v</command> is specified, the more verbose the output is.
240                         Specifying this option implies <command>-f</command> and will cause
241                         asterisk to no longer fork or detach from the controlling terminal.
242                         This option may also be used in conjunction with <command>-r</command>
243                         and <command>-R</command>
244                         </para>
245                 </listitem>
246         </varlistentry>
247         <varlistentry>
248                 <term>-V</term>
249                 <listitem>
250                         <para>
251                         Display version information and exit immediately.
252                         </para>
253                 </listitem>
254         </varlistentry>
255         <varlistentry>
256                 <term>-x <replaceable class="parameter">command</replaceable></term>
257                 <listitem>
258                         <para>
259                         Connect to a running Asterisk process and execute a command on
260                         a command line, passing any output through to standard out and
261                         then terminating when the command execution completes.  Implies
262                         <command>-r</command> when <command>-R</command> is not explicitly
263                         supplied.
264                         </para>
265                 </listitem>
266         </varlistentry>
267         </variablelist>
268 </refsect1>
269 <refsect1>
270         <title>EXAMPLES</title>
271         <para>
272         <command>asterisk</command> - Begin Asterisk as a daemon
273         </para>
274         <para>
275         <command>asterisk -vvvgc</command> - Run on controlling terminal
276         </para>
277         <para>
278         <command>asterisk -rx "show channels"</command> - Display channels on running server
279         </para>
280 </refsect1>
281 <refsect1>
282         <title>BUGS</title>
283         <para>
284         Bug reports and feature requests may be filed at http://bugs.digium.com
285         </para>
286 </refsect1>
287 <refsect1>
288         <title>SEE ALSO</title>
289         <para>
290         *CLI&gt; <command>help</command> - Help on Asterisk CLI
291         </para>
292         <para>
293         *CLI&gt; <command>show applications</command> - Show loaded applications
294         </para>
295         <para>
296         http://www.asterisk.org - The Asterisk Home Page
297         </para>
298         <para>
299         http://www.asteriskdocs.org - The Asterisk Documentation Project
300         </para>
301         <para>
302         http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
303         </para>
304         <para>
305         http://www.digium.com/ - Asterisk sponsor and hardware supplier
306         </para>
307         <para>
308         http://www.markocam.com/ - Asterisk author's web cam
309         </para>
310 </refsect1>
311 <refsect1>
312         <title>AUTHOR</title>
313         <para>
314         <author>
315                 <firstname>Mark Spencer &lt;markster@digium.com&gt;</firstname> 
316         </author>
317         </para>
318         <para>
319         <author>
320                 <firstname>Countless other contributers, see CREDITS with distribution for more information</firstname> 
321         </author>
322         </para>
323 </refsect1>
324 </refentry>