man pages: hyphen to minus

  
Groff considers '-' a hyphen. If we want a minus (or a dash) we need to use
'\-'.

Merged revisions 8529 via svnmerge from 
http://svn.digium.com/svn/dahdi/tools/trunk


git-svn-id: http://svn.asterisk.org/svn/dahdi/tools/branches/2.3@8534 a0bf4364-ded3-4de4-8d8a-66a801d63aff

10 files changed, 79 insertions, 79 deletions

diff --git a/doc/dahdi_cfg.8 b/doc/dahdi_cfg.8
index 34bd70d..7a1fe88 100644
--- a/doc/dahdi_cfg.8
+++ b/doc/dahdi_cfg.8
@@ -4,9 +4,9 @@
 dahdi_cfg \- configures DAHDI kernel modules from /etc/dahdi/system.conf
 .SH SYNOPSIS
 
-.B dahdi_cfg [-c \fICFG_FILE\fB] [-s] [-f] [-t] [-v [-v ... ] ]
+.B dahdi_cfg [\-c \fICFG_FILE\fB] [\-s] [\-f] [\-t] [\-v [\-v ... ] ]
 
-.B dahdi_cfg -h
+.B dahdi_cfg \-h
 
 .SH DESCRIPTION
 .B dahdi_cfg 
@@ -20,33 +20,33 @@ the DAHDI init script.
 
 .SH OPTIONS
 
-.B -c \fICFG_FILE
+.B \-c \fICFG_FILE
 .RS
 Use an alternative configuration file instead of
 .I /etc/dahdi/system.conf
 .RE
 
-.B -s
+.B \-s
 .RS
 Only shutdown spans.
 .RE
 
-.B -f
+.B \-f
 .RS
 Always configure every channel, even if it appears not to have changed.
 .RE
 
-.B -t
+.B \-t
 .RS
 Test mode. Don't do anything, just report what you wanted to do.
 .RE
 
-.B -v
+.B \-v
 .RS
 Be more verbose. Add extra v-s for extra verbosity.
 .RE
 
-.B -h
+.B \-h
 .RS
 Display a brief help message.
 .RE
diff --git a/doc/dahdi_diag.8 b/doc/dahdi_diag.8
index 59fd6c5..0f01a09 100644
--- a/doc/dahdi_diag.8
+++ b/doc/dahdi_diag.8
@@ -22,13 +22,13 @@ May be any DAHDI channel (even if it is open).
 .SH EXAMPLE
 
   # /tmp/dahdi_diag 5
-  # dmesg | tail -n 15
+  # dmesg | tail \-n 15
   Dump of DAHDI Channel 5 (XPP_BRI_TE/00/01/1,5,2):
 
   flags: 501 hex, writechunk: c5190948, readchunk: c5190954
   rxgain: ccad2e80, txgain: ccad2e80, gainalloc: 0
   span: c48a900c, sig: 80 hex, sigcap: 80 hex
-  inreadbuf: -1, outreadbuf: 0, inwritebuf: 0, outwritebuf: -1
+  inreadbuf: \-1, outreadbuf: 0, inwritebuf: 0, outwritebuf: \-1
   blocksize: 160, numbufs: 4, txbufpolicy: 0, txbufpolicy: 0
   txdisable: 0, rxdisable: 0, iomask: 0
   curzone: c78e7000, tonezone: 0, curtone: 00000000, tonep: 0
@@ -49,4 +49,4 @@ the terms of the GNU General Public License, Version 2 any
 later version published by the Free Software Foundation. 
  
 On Debian systems, the complete text of the GNU General Public 
-License can be found in /usr/share/common-licenses/GPL. 
+License can be found in /usr/share/common\-licenses/GPL. 
diff --git a/doc/dahdi_monitor.8 b/doc/dahdi_monitor.8
index ce9e464..17adc64 100644
--- a/doc/dahdi_monitor.8
+++ b/doc/dahdi_monitor.8
@@ -4,7 +4,7 @@
 dahdi_monitor \- checks the rx/tx levels of DAHDI channels
 .SH SYNOPSIS
 
-.B dahdi_monitor \fIchannel number\fB [-v] [-f \fIFILE\fB]
+.B dahdi_monitor \fIchannel number\fB [\-v] [\-f \fIFILE\fB]
 
 .SH DESCRIPTION
 
@@ -17,12 +17,12 @@ balance
 The first (mandatory) parameter is the number of the channel
 to monitor.
 
-.B -v
+.B \-v
 .RS
 Display visual audio levels.
 .RE
 
-.B -f \fIFILE
+.B \-f \fIFILE
 .RS
 Write output to FILE
 .RE
diff --git a/doc/dahdi_scan.8 b/doc/dahdi_scan.8
index aef6f0a..d7a9e16 100644
--- a/doc/dahdi_scan.8
+++ b/doc/dahdi_scan.8
@@ -36,10 +36,10 @@ Information about a certain analog span:
   active=yes
   alarms=OK
   description=Xorcom XPD #00/10: FXS
-  name=XBUS-00/XPD-10
+  name=XBUS\-00/XPD\-10
   manufacturer=Xorcom Inc.
   devicetype=Astribank: Unit 1 Subunit 0: FXS
-  location=usb-0000:00:03.3-4
+  location=usb\-0000:00:03.3\-4
   basechan=125
   totchans=8
   irq=0
@@ -66,16 +66,16 @@ And an example of a digital span:
   basechan=1
   totchans=24
   irq=193
-  type=digital-T1
+  type=digital\-T1
   syncsrc=0
-  lbo=0 db (CSU)/0-133 feet (DSX-1)
+  lbo=0 db (CSU)/0\-133 feet (DSX\-1)
   coding_opts=B8ZS,AMI
   framing_opts=ESF,D4
   coding=B8ZS
   framing=ESF
 
-The "type" field may contain: "analog", "digital-T1", "digital-E1",
-"digital-J1" or "digital-BRI".
+The "type" field may contain: "analog", "digital\-T1", "digital\-E1",
+"digital\-J1" or "digital\-BRI".
 
 .SH FILES
 Requires read access to /dev/dahdi/ctl .
@@ -98,4 +98,4 @@ the terms of the GNU General Public License, Version 2 any
 later version published by the Free Software Foundation. 
  
 On Debian systems, the complete text of the GNU General Public 
-License can be found in /usr/share/common-licenses/GPL. 
+License can be found in /usr/share/common\-licenses/GPL. 
diff --git a/doc/dahdi_test.8 b/doc/dahdi_test.8
index 21cda80..90b1e0b 100644
--- a/doc/dahdi_test.8
+++ b/doc/dahdi_test.8
@@ -3,7 +3,7 @@
 dahdi_test \(em Test if the DAHDI timer provides timely response
 .SH "SYNOPSIS" 
 .B dahdi_test 
-.I [ -v ]
+.I [ \-v ]
 
 .SH DESCRIPTION 
 .B dahdi_test
@@ -20,12 +20,12 @@ Values of 100% and 99.99% Are normally considered a definite
 Values of 99.98% and 99.97% are probably OK as well.
 
 .SH OPTIONS
-.B -v
+.B \-v
 .RS
 Be more verbose: print one line per test.
 .RE
 
-.B -c 
+.B \-c 
 .I count
 .RS
 Run for 
diff --git a/doc/fxotune.8 b/doc/fxotune.8
index 65fcb61..efa94c3 100644
--- a/doc/fxotune.8
+++ b/doc/fxotune.8
@@ -2,33 +2,33 @@
 .SH NAME
 fxotune \- automatically tune DAHDI FXO channels
 .SH SYNOPSIS
-.B fxotune -i 
+.B fxotune \-i 
 .I [options]
-- detect mode
+\- detect mode
 
-.B fxotune -d
+.B fxotune \-d
 .I [ options ]
-- dump mode
+\- dump mode
 
-.B fxotune -s
-- Startup mode
+.B fxotune \-s
+\- Startup mode
 .SH
 .SH DESCRIPTION
 .B fxotune 
 is a script that fine-tune parameters of the FXO modules of the 
 card. It has three modes of operation:
 
-.I Detect mode (-i):
+.I Detect mode (\-i):
 it detects and tunes all the available FXO channels.
 It writes settings to a configuration file (/etc/fxotune.conf)
-from which it can be loaded (e.g: at startup) using -s .
+from which it can be loaded (e.g: at startup) using \-s .
 
-.I Dump mode (-d):
+.I Dump mode (\-d):
 Runs detection on a single DAHDI channel, and just dumps waveforms to
 .B fxotune_dump.vals
 is generated in the current directory.
 
-.I Startup mode (-s):
+.I Startup mode (\-s):
 fxotune just reads the settings from fxotune.conf into the FXO modules.
 
 You are advised to run fxotune on all FXO ports you have that support 
@@ -48,12 +48,12 @@ tuning before the PSTN gives up and gives a busy tone. So after a while
 it hangs up and starts a new cycle.
 
 .B fxotune
-has two operation modes: tune (-i) and set (-s). In the tune mode it 
+has two operation modes: tune (\-i) and set (\-s). In the tune mode it 
 generates /etc/fxotune.conf, and in the set mode it merely applies the 
 parameters from fxotune.conf to device's ports.
 
 .SH OPTIONS
-The following options below except -v (verbose) affect only the
+The following options below except \-v (verbose) affect only the
 detection process and hence apply only to the 
 .I detect
 and 
@@ -64,27 +64,27 @@ In addition, to maintain compatibility with older versions of fxotune,
 if in detect or dump mode there is a parameter with option before it, it
 is considered to be the 
 .I dialstring
-parameter (-n).
+parameter (\-n).
 
-.B -b
+.B \-b
 .I startdev
 .RS
 Start tuning from dahdi channel num. \fI startdev\fR: skip all previous
 channels. By default starting from channel 1.
 
-In dump mode (-d) this is the single channel that will be tested.
+In dump mode (\-d) this is the single channel that will be tested.
 .RE
 
-.B -e
+.B \-e
 .I stopdev
 .RS
 Tune only up to dahdi channel num. \fI stopdev\fR: skip all previous
 channels. By default stopping at channel 252.
 
-In dump mode (-d) this parameter is ignored.
+In dump mode (\-d) this parameter is ignored.
 .RE
 
-.B -l
+.B \-l
 .I delay-to-silence
 .RS
 Time in seconds to wait after dialing the dial-string to get a clear line.
@@ -92,7 +92,7 @@ The default is 0.
 before 
 .RE
 
-.B -m
+.B \-m
 .I silence-good-for
 .RS
 Time in seconds which states how long the PSTN will wait after we dialed
@@ -102,7 +102,7 @@ connecting an analog phone to the line and dialing.
 The default is 18 (18 seconds). 
 .RE
 
-.B -n
+.B \-n
 .I dial-string
 .RS
 Digits to dial to the PSTN in order to get it stop its dialtone and
@@ -113,45 +113,45 @@ cases. Again, this can be tested by connecting a phone to the PSTN line
 and dialing the dial-string.
 .RE
 
-.B -t
+.B \-t
 .I detect-type
 .RS
 This option allows using the older detection method used by fxotune of
 Zaptel 1.2. use 
-.B -t 1
+.B \-t 1
 for that older method. whereas
-.B -t 2
+.B \-t 2
 (the default) uses the current method.
 
-This option only applies to detect mode (-i).
+This option only applies to detect mode (\-i).
 .RE
 
-.B -v[vvvv]
+.B \-v[vvvv]
 .RS
 Sets debugging on. The more v-s, the higher debug level. 
 
-Note that: -vv -v  will actually set debug level to 1 instead of 3.
+Note that: \-vv \-v  will actually set debug level to 1 instead of 3.
 .RE
 
-.B -w
+.B \-w
 .I wave-form
 .RS
-The default: -1, for multitone waveform. Alternatively: a frequency of a
+The default: \-1, for multitone waveform. Alternatively: a frequency of a
 single tone.
 
-This option only applies to dump mode (-d).
+This option only applies to dump mode (\-d).
 .RE
 
 
 .SH EXAMPLES
 .RS
-fxotune -i 9
+fxotune \-i 9
 .RE
 if you need to dial 9 for an external line. If you always get a line, you
 can simply use any digit.
 .RE
 
-.B -s
+.B \-s
 .RS
 Load settings from the last test. Used at startup.
 .RE
@@ -161,12 +161,12 @@ Load settings from the last test. Used at startup.
 .RS
 The configuration file generated by fxotune in detect mode and from which
 configuration is loaded when 
-.B -s
+.B \-s
 is used.
 
 .SH NOTES
 Running fxotune takes approximately a minute per port. If you wish to only 
-run fxotune for several ports, you can use the options -b and -e to set a 
+run fxotune for several ports, you can use the options \-b and \-e to set a 
 specific range of ports. Another useful trick is to actually keep asterisk 
 running, and only "destroy" the dahdi channels you wish to tune (dahdi 
 destroy channel NNN): other channels will be used by Asterisk, and hence 
@@ -179,10 +179,10 @@ so if you stop it half-way, you may get a half-configured system. If you
 have already tuned your FXO channels and wish to test-run fxotune again, 
 you are advised to backup /etc/fxotune.conf .
 
-The default for -m is 18 seconds. This asusmes that you get a clear line 
+The default for \-m is 18 seconds. This asusmes that you get a clear line 
 for at least 18 seconds. It is advised that you test that timeout earlier
 by connecting a phone to the FXO line, dialing 4 (or whatever dial string 
-you put with -n) and see how much time of silence you have.
+you put with \-n) and see how much time of silence you have.
 
 If you connect your device to a PSTN provider that is not in the US, there
 is a similar operation you should apply before even getting to fxotune:
@@ -204,4 +204,4 @@ the terms of the GNU General Public License, Version 2 any
 later version published by the Free Software Foundation. 
 
 On Debian systems, the complete text of the GNU General Public 
-License can be found in /usr/share/common-licenses/GPL. 
+License can be found in /usr/share/common\-licenses/GPL. 
diff --git a/doc/patgen.8 b/doc/patgen.8
index 75d9670..3585cff 100644
--- a/doc/patgen.8
+++ b/doc/patgen.8
@@ -41,4 +41,4 @@ the terms of the GNU General Public License, Version 2 any
 later version published by the Free Software Foundation. 
  
 On Debian systems, the complete text of the GNU General Public 
-License can be found in /usr/share/common-licenses/GPL. 
+License can be found in /usr/share/common\-licenses/GPL. 
diff --git a/doc/pattest.8 b/doc/pattest.8
index ca90686..bce3f1c 100644
--- a/doc/pattest.8
+++ b/doc/pattest.8
@@ -46,4 +46,4 @@ the terms of the GNU General Public License, Version 2 any
 later version published by the Free Software Foundation. 
  
 On Debian systems, the complete text of the GNU General Public 
-License can be found in /usr/share/common-licenses/GPL. 
+License can be found in /usr/share/common\-licenses/GPL. 
diff --git a/xpp/astribank_is_starting.8 b/xpp/astribank_is_starting.8
index 55db6f6..5ad0be1 100644
--- a/xpp/astribank_is_starting.8
+++ b/xpp/astribank_is_starting.8
@@ -3,11 +3,11 @@
 .SH NAME
 astribank_is_starting \- Mark / check is a Xorcom Astribank (xpp) is starting
 .SH SYNOPSIS
-.B astribank_is_starting [-d] [-v] [-t \fItimeout\fB] <-a|-r|-w>
+.B astribank_is_starting [\-d] [\-v] [\-t \fItimeout\fB] <\-a|\-r|\-w>
 
-.B astribank_is_starting [-d] [-v]
+.B astribank_is_starting [\-d] [\-v]
 
-.B astribank_is_starting -h
+.B astribank_is_starting \-h
 
 .SH DESCRIPTION
 .B astribank_is_starting
@@ -17,44 +17,44 @@ be an Astribank device currently initializing, and to check for that mark.
 Technically the mark is a SysV semaphore.
 
 .SH OPTIONS
-.B -a
+.B \-a
 .RS
 .B Add.
 Set the mark. Should return 0 unless there's an error.
 .RE
 
-.B -r
+.B \-r
 .RS
 .B Remove.
 Reset the mark. Should return 0 unless there's an error.
 .RE
 
-.BI -t timeout
+.BI \-t timeout
 .RS
 .B Timeout.
-Set the timeout value for the \fB-w\fR option. Default is 60 seconds.
+Set the timeout value for the \fB\-w\fR option. Default is 60 seconds.
 .RE
 
-.B -w
+.B \-w
 .RS
 .B Wait.
 Wait for mark to be reset. Should return 0 unless there's an error.
 .RE
 
-Without -a or -r: return 0 if the mark has been set, or a non-zero value
+Without \-a or \-r: return 0 if the mark has been set, or a non-zero value
 otherwise.
 
-.B -d
+.B \-d
 .RS
 Print debug information to stderr.
 .RE
 
-.B -v
+.B \-v
 .RS
 Verbose execution.
 .RE
 
-.B -h
+.B \-h
 .RS
 Displays usage message.
 .RE
@@ -83,9 +83,9 @@ Q: Why do you use a semaphore?
 A: because, unlike the filesystem, it is writable at any given time.
 
 .SH BUGS
-Option ordering matter. The \fB-v\fR and \fB-d\fR options should preceed
-the actions (\fB-a\fR, \fB-r\fR and \fB-w\fR).
-The \fB-t\fItimeout\fR option should preceed the \fB-w\fR option.
+Option ordering matter. The \fB\-v\fR and \fB\-d\fR options should preceed
+the actions (\fB\-a\fR, \fB\-r\fR and \fB\-w\fR).
+The \fB\-t\fItimeout\fR option should preceed the \fB\-w\fR option.
 
 .SH SEE ALSO
 semctl(3)
@@ -97,4 +97,4 @@ the terms of the GNU General Public License, Version 2 any
 later version published by the Free Software Foundation.
 
 On Debian systems, the complete text of the GNU General Public
-License can be found in /usr/share/common-licenses/GPL.
+License can be found in /usr/share/common\-licenses/GPL.
diff --git a/xpp/dahdi_genconf b/xpp/dahdi_genconf
index b03c42b..49b9325 100755
--- a/xpp/dahdi_genconf
+++ b/xpp/dahdi_genconf
@@ -131,7 +131,7 @@ It uses two information sources:
 =item /etc/dahdi/genconf_parameters
 
 A configuration file that supplements the hardware information.
-Its location may be overriden via the C<GENCONF_PARAMETERS> environment
+Its location may be overridden via the C<GENCONF_PARAMETERS> environment
 variable.
 
 =back