From dd8b4f152607d0d40b47f58a1dcaa6c85d98f816 Mon Sep 17 00:00:00 2001 From: markster Date: Sun, 18 Jul 2004 17:58:05 +0000 Subject: Add Asterisk manpage git-svn-id: http://svn.digium.com/svn/asterisk/trunk@3471 f38db490-d61c-443f-a65b-d21fe96a405b --- asterisk.sgml | 295 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 295 insertions(+) create mode 100755 asterisk.sgml (limited to 'asterisk.sgml') diff --git a/asterisk.sgml b/asterisk.sgml new file mode 100755 index 000000000..fb569d533 --- /dev/null +++ b/asterisk.sgml @@ -0,0 +1,295 @@ + + + + 2004-07-18 + + + + asterisk + + 8 + asterisk 1.0 + + + + asterisk + + + All-purpose telephony server. + + + + + asterisk + +file +user +group +command + + + + asterisk -r + +command + + + + + 2004-07-01 + + DESCRIPTION + + asterisk 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, IAX, 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. + + + Asterisk reads most of its configuration files from configuration files + located in /etc/asterisk. 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. + + + When running with -c, -r or -R + 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. + + + + OPTIONS + + + -C file + + + Use file as master configuration file + instead of the default, /etc/asterisk/asterisk.conf + + + + + -c + + + Provide a control console on the calling terminal. + Specifying this option implies -f and will cause + asterisk to no longer fork or detach from the controlling terminal. + + + + + -d + + + Enable extra debugging statements. + + + + + -f + + + Do not fork or detach from controlling terminal. + + + + + -g + + + Remove resource limit on core size, thus forcing Asterisk to dump + core in the unlikely event of a segmentation fault or abort signal. + NOTE: in some cases this may be incompatible + with the -U or -G flags. + + + + + -G group + + + Run as group group instead of the + calling group. NOTE: 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. + + + + + -h + + + Provide brief summary of command line arguments and terminate. + + + + + -i + + + Prompt user to intialize any encrypted private keys during startup. + + + + + -n + + + Disable ANSI colors even on terminals capable of displaying them. + + + + + -p + + + 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. + + + + + -q + + + Reduce default console output when running in conjunction with + console mode (-c). + + + + + -r + + + Instead of running a new Asterisk process, attempt to connect + to a running Asterisk process and provide a console interface + for controlling it. + + + + + -R + + + Much like -r. 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. + + + + + -U user + + + Run as user user instead of the + calling user. NOTE: 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. + + + + + -v + + + Increase the level of verboseness on the console. The more times + -v is specified, the more verbose the output is. + Specifying this option implies -f and will cause + asterisk to no longer fork or detach from the controlling terminal. + This option may also be used in conjunction with -r + and -R + + + + + -V + + + Display version information and exit immediately. + + + + + -x command + + + 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 + -r when -R is not explicitly + supplied. + + + + + + + EXAMPLES + + asterisk - Begin Asterisk as a daemon + + + asterisk -vvvgc - Run on controlling terminal + + + asterisk -rx "show channels" - Display channels on running server + + + + BUGS + + Bug reports and feature requests may be filed at http://bugs.digium.com + + + + SEE ALSO + + *CLI> help - Help on Asterisk CLI + + + *CLI> show applications - Show loaded applications + + + http://www.asterisk.org - The Asterisk Home Page + + + http://www.asteriskdocs.org - The Asterisk Documentation Project + + + http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki + + + http://www.digium.com/ - Asterisk sponsor and hardware supplier + + + http://www.markocam.com/ - Asterisk author's web cam + + + + AUTHOR + + + Mark Spencer <markster@digium.com> + + + + + Countless other contributers, see CREDITS with distribution for more information + + + + -- cgit v1.2.3