diff options
Diffstat (limited to 'doc/fxotune.8')
| -rw-r--r-- | doc/fxotune.8 | 72 |
1 files changed, 36 insertions, 36 deletions
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. |