1 files changed, 199 insertions, 0 deletions
diff --git a/trunk/doc/asterisk.8 b/trunk/doc/asterisk.8
new file mode 100644
index 000000000..876721a93
--- /dev/null
+++ b/trunk/doc/asterisk.8
@@ -0,0 +1,199 @@
+.\" This manpage has been automatically generated by docbook2man 
+.\" from a DocBook document.  This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
+.\" Please send any bug reports, improvements, comments, patches, 
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "ASTERISK" "8" "25 October 2005" "asterisk 1.2" ""
+
+.SH NAME
+asterisk \- All-purpose telephony server.
+.SH SYNOPSIS
+
+\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 ]
+
+
+\fBasterisk -r\fR [ \fB-v\fR ] [ \fB-x \fIcommand\fB\fR ] [ \fB-s \fIsocket\fB\fR ]
+
+.SH "DESCRIPTION"
+.PP
+\fBasterisk\fR is a full-featured telephony server which
+provides Private Branch eXchange (PBX), Interactive Voice Response (IVR),
+Automated Call Distribution (ACD), Voice over IP (VoIP) gatewaying, 
+Conferencing, and a plethora of other telephony applications to a broad
+range of telephony devices including packet voice (SIP, IAX2, MGCP, Skinny,
+H.323) devices (both endpoints and proxies), as well as traditional TDM
+hardware including T1, E1, ISDN PRI, GR-303, RBS, Loopstart, Groundstart,
+ISDN BRI, and many more.
+.PP
+At start, Asterisk reads the /etc/asterisk/asterisk.conf main configuration
+file and locates the rest of the configuration files from the configuration
+in that file. The -C option specifies an alternate main configuration file.
+Virtually all aspects of the operation of asterisk's configuration files
+can be found in the sample configuration files.  The format for those files
+is generally beyond the scope of this man page.
+.PP
+When running with \fB-c\fR, \fB-r\fR or \fB-R\fR
+options, Asterisk supplies a powerful command line, including command
+completion, which may be used to monitors its status, perform a variety
+of administrative actions and even explore the applications that are
+currently loaded into the system.
+.PP
+Asterisk is a trademark of Digium, Inc.
+.SH "OPTIONS"
+.TP
+\fB-C \fIfile\fB\fR
+Use \fIfile\fR as master configuration file
+instead of the default, /etc/asterisk/asterisk.conf
+.TP
+\fB-c\fR
+Provide a control console on the calling terminal.
+Specifying this option implies \fB-f\fR and will cause
+asterisk to no longer fork or detach from the controlling terminal.
+.TP
+\fB-d\fR
+Enable extra debugging statements.
+
+Note: This always sets the debug level in the asterisk process,
+even if it is running in the background. This will affect the size
+of your log files.
+.TP
+\fB-f\fR
+Do not fork or detach from controlling terminal.
+.TP
+\fB-g\fR
+Remove resource limit on core size, thus forcing Asterisk to dump
+core in the unlikely event of a segmentation fault or abort signal.
+\fBNOTE:\fR in some cases this may be incompatible
+with the \fB-U\fR or \fB-G\fR flags.
+.TP
+\fB-G \fIgroup\fB\fR
+Run as group \fIgroup\fR instead of the
+calling group.  \fBNOTE:\fR this requires substantial work
+to be sure that Asterisk's environment has permission to write
+the files required for its operation, including logs, its comm
+socket, the asterisk database, etc.
+.TP
+\fB-h\fR
+Provide brief summary of command line arguments and terminate.
+.TP
+\fB-i\fR
+Prompt user to initialize any encrypted private keys for IAX2
+secure authentication during startup.
+.TP
+\fB-L \fIloadaverage\fB\fR
+Limits the maximum load average before rejecting new calls.  This can
+be useful to prevent a system from being brought down by terminating
+too many simultaneous calls.
+.TP
+\fB-m\fR
+Disable log and verbose output to remote (-r) consoles.
+.TP
+\fB-M \fIvalue\fB\fR
+Limits the maximum number of calls to the specified value.  This can
+be useful to prevent a system from being brought down by terminating
+too many simultaneous calls.
+.TP
+\fB-n\fR
+Disable ANSI colors even on terminals capable of displaying them.
+.TP
+\fB-p\fR
+If supported by the operating system (and executing as root),
+attempt to run with realtime priority for increased performance and
+responsiveness within the Asterisk process, at the expense of other
+programs running on the same machine.
+.TP
+\fB-q\fR
+Reduce default console output when running in conjunction with
+console mode (\fB-c\fR).
+.TP
+\fB-r\fR
+Instead of running a new Asterisk process, attempt to connect
+to a running Asterisk process and provide a console interface
+for controlling it.
+.TP
+\fB-R\fR
+Much like \fB-r\fR\&.  Instead of running a new Asterisk process, attempt to connect
+to a running Asterisk process and provide a console interface
+for controlling it. Additionally, if connection to the Asterisk 
+process is lost, attempt to reconnect for as long as 30 seconds.
+.TP
+\fB-s \fIsocket\fB\fR
+Allows to specify the socket file to be used to connect to the
+Asterisk console. Used in conjunction with \fB-r\fR or \fB-R\fR.
+.TP
+\fB-I\fR
+Enable internal timing if Zaptel timer is available
+The default behaviour is that outbound packets are phase locked
+to inbound packets. Enabling this switch causes them to be
+locked to the internal Zaptel timer instead.
+.TP
+\fB-t\fR
+When recording files, write them first into a temporary holding directory, 
+then move them into the final location when done.
+.TP
+\fB-T\fR
+Add timestamp to all non-command related output going to the console
+when running with verbose and/or logging to the console.
+.TP
+\fB-U \fIuser\fB\fR
+Run as user \fIuser\fR instead of the
+calling user.  \fBNOTE:\fR this requires substantial work
+to be sure that Asterisk's environment has permission to write
+the files required for its operation, including logs, its comm
+socket, the asterisk database, etc.
+.TP
+\fB-v\fR
+Increase the level of verboseness on the console.  The more times
+\fB-v\fR is specified, the more verbose the output is.
+Specifying this option implies \fB-f\fR and will cause
+asterisk to no longer fork or detach from the controlling terminal.
+This option may also be used in conjunction with \fB-r\fR
+and \fB-R\fR\&.
+
+Note: This always sets the verbose level in the asterisk process,
+even if it is running in the background. This will affect the size
+of your log files.
+.TP
+\fB-V\fR
+Display version information and exit immediately.
+.TP
+\fB-x \fIcommand\fB\fR
+Connect to a running Asterisk process and execute a command on
+a command line, passing any output through to standard out and
+then terminating when the command execution completes.  Implies
+\fB-r\fR when \fB-R\fR is not explicitly
+supplied.
+.SH "EXAMPLES"
+.PP
+\fBasterisk\fR - Begin Asterisk as a daemon
+.PP
+\fBasterisk -vvvgc\fR - Run on controlling terminal
+.PP
+\fBasterisk -rx "core show channels"\fR - Display channels on running server
+.SH "BUGS"
+.PP
+Bug reports and feature requests may be filed at http://bugs.digium.com
+.SH "SEE ALSO"
+.PP
+*CLI> \fBhelp\fR - Help on Asterisk CLI
+.PP
+*CLI> \fBcore show applications\fR - Show loaded dialplan applications
+.PP
+*CLI> \fBcore show functions\fR - Show loaded dialplan functions
+.PP
+*CLI> \fBdialplan show\fR - Show current dialplan
+.PP
+http://www.asterisk.org - The Asterisk Home Page
+.PP
+http://www.asteriskdocs.org - The Asterisk Documentation Project
+.PP
+http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
+.PP
+http://www.digium.com/ - Asterisk sponsor and hardware supplier
+.PP
+http://www.markocam.com/ - Asterisk author's web cam
+.SH "AUTHOR"
+.PP
+Mark Spencer <markster@digium.com>
+.PP
+Countless other contributors, see CREDITS with distribution for more information