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