Document -B and -W flags and regenerate manpage from sgml

git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.6.2@280739 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 129 insertions, 101 deletions

diff --git a/doc/asterisk.8 b/doc/asterisk.8
index 959fc7795..046969ff7 100644
--- a/doc/asterisk.8
+++ b/doc/asterisk.8
@@ -1,35 +1,50 @@
-.\" 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" "17 December 2009" "asterisk 1.6.2" ""
-
+'\" -*- coding: us-ascii -*-
+.if \n(.g .ds T< \\FC
+.if \n(.g .ds T> \\F[\n[.fam]]
+.de URL
+\\$2 \(la\\$1\(ra\\$3
+..
+.if \n(.g .mso www.tmac
+.TH &#10;&#9;&#9;asterisk&#10;&#9; 8 2010-08-03 "asterisk 1.6" ""
 .SH NAME
-asterisk \- All-purpose telephony server.
+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
+'nh
+.fi
+.ad l
+\fBasterisk\fR \kx
+.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
+'in \n(.iu+\nxu
+[\fB-BcdfFghiImnpqRtTvVW\fR] [\fB-C \fR\fIfile\fR] [\fB-e \fR\fImemory\fR] [\fB-G \fR\fIgroup\fR] [\fB-L \fR\fIloadaverage\fR] [\fB-M \fR\fIvalue\fR] [\fB-U \fR\fIuser\fR] [\fB-s \fR\fIsocket-file\fR] [\fB-x \fR\fIcommand\fR]
+'in \n(.iu-\nxu
+.ad b
+'hy
+'nh
+.fi
+.ad l
+\fBasterisk -r\fR \kx
+.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
+'in \n(.iu+\nxu
+[\fB-v\fR] [\fB-x \fR\fIcommand\fR]
+'in \n(.iu-\nxu
+.ad b
+'hy
+.SH DESCRIPTION
 \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
+H.323, Unistim) 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.
+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
+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
@@ -39,146 +54,160 @@ 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
+.SH OPTIONS
+.TP 
+-B
+Force the background of the terminal to be black, in order for
+terminal colors to show up properly.
+.TP 
+-C \fIfile\fR
+Use \*(T<\fIfile\fR\*(T> as master configuration file
 instead of the default, /etc/asterisk/asterisk.conf
-.TP
-\fB-c\fR
+.TP 
+-c
 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
+.TP 
+-d
 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
+even if it is running in the background. This may affect the size
+of your log files, if the debug level is specified in logger.conf.
+.TP 
+-e \fImemory\fR
+Limit the generation of new channels when the amount of free memory has decreased to under \fImemory\fR megabytes.
+.TP 
+-f
+Do not fork or detach from controlling terminal. Overrides any preceding specification of \fB-F\fR on the command line.
+.TP 
+-F
+Always fork and detach from controlling terminal. Overrides any preceding specification of \fB-f\fR on the command line.
+.TP 
+-g
 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
+.TP 
+-G \fIgroup\fR
 Run as group \fIgroup\fR instead of the
-calling group.  \fBNOTE:\fR this requires substantial work
+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
+.TP 
+-h
 Provide brief summary of command line arguments and terminate.
-.TP
-\fB-i\fR
-Prompt user to initialize any encrypted private keys for IAX2
+.TP 
+-i
+Prompt user to intialize 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
+.TP 
+-I
+Enable internal timing if DAHDI timing 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 DAHDI timer instead.
+.TP 
+-L \fIloadaverage\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
+.TP 
+-m
+Temporarily mutes output to the console and logs. To return to normal,
+use \fBlogger mute\fR.
+.TP 
+-M \fIvalue\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
+.TP 
+-n
 Disable ANSI colors even on terminals capable of displaying them.
-.TP
-\fB-p\fR
+.TP 
+-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.
-.TP
-\fB-q\fR
+
+Note: \fBastcanary\fR will run concurrently with
+\fBasterisk\fR. If \fBastcanary\fR stops
+running or is killed, \fBasterisk\fR will slow down to
+normal process priority, to avoid locking up the machine.
+.TP 
+-q
 Reduce default console output when running in conjunction with
 console mode (\fB-c\fR).
-.TP
-\fB-r\fR
+.TP 
+-r
 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
+.TP 
+-R
+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 DAHDI 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 DAHDI timer instead.
-.TP
-\fB-t\fR
+.TP 
+-s \fIsocket file name\fR
+In combination with \fB-r\fR, connect directly to a specified
+Asterisk server socket.
+.TP 
+-t
 When recording files, write them first into a temporary holding directory, 
 then move them into the final location when done.
-.TP
-\fB-T\fR
+.TP 
+-T
 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
+.TP 
+-U \fIuser\fR
 Run as user \fIuser\fR instead of the
-calling user.  \fBNOTE:\fR this requires substantial work
+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
+.TP 
+-v
+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\&.
+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
+.TP 
+-V
 Display version information and exit immediately.
-.TP
-\fB-W\fR
-Change the terminal colors to compensate for a light background,
-rather than a dark background, as is the default.
-.TP
-\fB-x \fIcommand\fB\fR
+.TP 
+-W
+Display colored terminal text as if the background were white
+or otherwise light in color. Normally, terminal text is displayed
+as if the background were black or otherwise dark in color.
+.TP 
+-x \fIcommand\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
+then terminating when the command execution completes. Implies
 \fB-r\fR when \fB-R\fR is not explicitly
 supplied.
-.SH "EXAMPLES"
-.PP
+.SH EXAMPLES
 \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 BUGS
+Bug reports and feature requests may be filed at https://issues.asterisk.org
 .SH "SEE ALSO"
-.PP
 *CLI> \fBhelp\fR - Help on Asterisk CLI
 .PP
 *CLI> \fBcore show applications\fR - Show loaded dialplan applications
@@ -194,8 +223,7 @@ http://www.asteriskdocs.org - The Asterisk Documentation Project
 http://www.voip-info.org/wiki-Asterisk - The Asterisk Wiki
 .PP
 http://www.digium.com/ - Asterisk sponsor and hardware supplier
-.SH "AUTHOR"
-.PP
+.SH AUTHOR
 Mark Spencer <markster@digium.com>
 .PP
-Countless other contributors, see CREDITS with distribution for more information
+Countless other contributors, see CREDITS with distribution for more information.