FGCOM/dahdi-tools
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

hyphen/minus fixes in man pages

Browse Source 
in groff '-' creates a hyphen and for a minus (path, option, or similar)
you need '\-'.

Signed-off-by: Tzafrir Cohen <tzafrir.cohen@xorcom.com>
This commit is contained in:
Tzafrir Cohen 2014-01-27 20:27:09 +02:00
parent 91768d360c
commit 98ecc272d1
5 changed files with 31 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/dahdi_cfg.8
View File

@ -4,7 +4,7 @@
dahdi_cfg \- configures DAHDI kernel modules from /etc/dahdi/system.conf dahdi_cfg \- configures DAHDI kernel modules from /etc/dahdi/system.conf
.SH SYNOPSIS .SH SYNOPSIS
.B dahdi_cfg [\-c \fICFG_FILE\fB] [\-S\fINUM\fB [-S\fICHANS\fB]] [\-s] [\-f] [\-t] [\-v [\-v ... ] ] .B dahdi_cfg [\-c \fICFG_FILE\fB] [\-S\fINUM\fB [\-S\fICHANS\fB]] [\-s] [\-f] [\-t] [\-v [\-v ... ] ]
.B dahdi_cfg \-h .B dahdi_cfg \-h

4
doc/dahdi_maint.8
View File

@ -43,11 +43,11 @@ Insert an error of a specific type
.SH EXAMPLES .SH EXAMPLES
Enable network line loopback on span 1: Enable network line loopback on span 1:
dahdi_maint -s 1 --loopback networkline dahdi_maint \-s 1 \-\-loopback networkline
Disable network line loopback on span 1: Disable network line loopback on span 1:
dahdi_maint -s 1 --loopback off dahdi_maint \-s 1 \-\-loopback off
.SH SEE ALSO .SH SEE ALSO

24
doc/dahdi_monitor.8
View File

@ -35,7 +35,7 @@ Normally there's a different option that you need that implies it.
.B \-o .B \-o
.RS .RS
Plays the output to OSS (/dev/dsp). Requires -m not to be used. Plays the output to OSS (/dev/dsp). Requires \-m not to be used.
.RE .RE
.B \-v .B \-v
@ -44,7 +44,7 @@ Display Visual audio levels. With two v-s, Verbose mode is enabled, that
shows the actual levels as numbers. Note that this requires a terminal shows the actual levels as numbers. Note that this requires a terminal
wider than 80 columns to be properly displayed. wider than 80 columns to be properly displayed.
Implies -m. Implies \-m.
.RE .RE
.B \-f \fIFILE .B \-f \fIFILE
@ -62,14 +62,14 @@ to a file.
.RS .RS
Record the content of the Rx channel to a file. Record the content of the Rx channel to a file.
Implies -m. Implies \-m.
.RE .RE
.B \-R \fIFILE .B \-R \fIFILE
.RS .RS
Record the content of the R channel before the echo canceler to a file. Record the content of the R channel before the echo canceler to a file.
Implies -m. Implies \-m.
.RE .RE
.B \-s \fIFILE .B \-s \fIFILE
@ -87,47 +87,47 @@ canceler to a file.
.RS .RS
Record the content of the Tx channel to a file. Record the content of the Tx channel to a file.
Implies -m. Implies \-m.
.RE .RE
.B \-T \fIFILE .B \-T \fIFILE
.RS .RS
Record the content of the Tx channel before the echo canceler to a file. Record the content of the Tx channel before the echo canceler to a file.
Implies -m. Implies \-m.
.RE .RE
.SH EXAMPLES .SH EXAMPLES
Visualize audio levels on DAHDI channel 2: Visualize audio levels on DAHDI channel 2:
dahdi_monitor 2 -v dahdi_monitor 2 \-v
Record channel 3 to a file: Record channel 3 to a file:
dahdi_monitor 3 -f output.raw dahdi_monitor 3 \-f output.raw
This will create a raw PCM file (signed-linear, 8kHz, mono, 16 bits per This will create a raw PCM file (signed-linear, 8kHz, mono, 16 bits per
sample). Both the Tx and Rx will be multiplexed in a single channel. sample). Both the Tx and Rx will be multiplexed in a single channel.
It can be converted to a WAV file using e.g.: It can be converted to a WAV file using e.g.:
sox -s -c1 -2 -r8000 output.raw output.wav sox \-s \-c1 \-2 \-r8000 output.raw output.wav
Record Tx and Rx of channel 5 to separate files. This time directly to Record Tx and Rx of channel 5 to separate files. This time directly to
WAV files: WAV files:
dahdi_monitor 5 -r output_rx.wav -t output_tx.wav dahdi_monitor 5 \-r output_rx.wav \-t output_tx.wav
Record channel 8 to a stereo file (Tx and Rx on its two channels): Record channel 8 to a stereo file (Tx and Rx on its two channels):
dahdi_monitor 8 -s output.raw dahdi_monitor 8 \-s output.raw
Converting it to a WAV file: Converting it to a WAV file:
sox -s -c2 -2 -r8000 output.raw output.wav sox \-s \-c2 \-2 \-r8000 output.raw output.wav

14
doc/dahdi_span_assignments.8
View File

@ -28,7 +28,7 @@ at all).
.B dahdi_span_assignments .B dahdi_span_assignments
is used to assign those spans or to help creating the configuration is used to assign those spans or to help creating the configuration
file used in their assignment: file used in their assignment:
.B /etc/dahdi/assigned-spans.conf . .B /etc/dahdi/assigned\-spans.conf .
.SH SUB-COMMANDS .SH SUB-COMMANDS
@ -46,14 +46,14 @@ Parameters are paths (in SysFS) to DAHDI devices with unassigned
spans. spans.
The command will assign spans with DAHDI according to The command will assign spans with DAHDI according to
configuration in \fBassigned-spans.conf\fR. configuration in \fBassigned\-spans.conf\fR.
If no line matches the span, or if the assignment for it fails (it is If no line matches the span, or if the assignment for it fails (it is
not available) it will remain unassigned. not available) it will remain unassigned.
If any of the span settings fails (the span number or range of channels If any of the span settings fails (the span number or range of channels
is already in use), the program will print a message, but continue is already in use), the program will print a message, but continue
applying the others. In such a case you should fix assigned-spans.conf applying the others. In such a case you should fix assigned\-spans.conf
and re-run \fBadd\fR (or run \fBauto\fR to give those channels the and re-run \fBadd\fR (or run \fBauto\fR to give those channels the
first available range and regenerate the file with 'dahdi_genconf first available range and regenerate the file with 'dahdi_genconf
assignedspans'). assignedspans').
@ -161,7 +161,7 @@ The value in this field is matched (when the commands \fBadd\fR and
See above for their descriptions. The value may include shell wildcards: See above for their descriptions. The value may include shell wildcards:
*, ? and [], which are used in the match. The values to be matched are *, ? and [], which are used in the match. The values to be matched are
first cleaned up: '!' is replaced with '/' and any character beyond first cleaned up: '!' is replaced with '/' and any character beyond
"a-zA-Z0-9/:.-" is removed. "a\-zA\-Z0\-9/:.\-" is removed.
.SS Span Specification .SS Span Specification
@ -197,13 +197,13 @@ space must be available.
.B DAHDICONFDIR .B DAHDICONFDIR
.RS .RS
The directory in which assigned-spans.conf resides. /etc/dahdi if not The directory in which assigned\-spans.conf resides. /etc/dahdi if not
overridden from the environment. overridden from the environment.
.RE .RE
.B DAHDISASSIGNEDSPANSCONF .B DAHDISASSIGNEDSPANSCONF
.RS .RS
The path to assigned-spans.conf resides. /etc/dahdi/assigned-spans.conf if The path to assigned-spans.conf resides. /etc/dahdi/assigned\-spans.conf if
not overridden from the environment. not overridden from the environment.
.RE .RE
@ -216,7 +216,7 @@ environment.
.SH FILES .SH FILES
.B /etc/dahdi/assigned-spans.conf .B /etc/dahdi/assigned\-spans.conf
.RS .RS
The default location for the configuration file. The default location for the configuration file.
.RE .RE

18
doc/dahdi_span_types.8
View File

@ -24,18 +24,18 @@ The device is marked as a path in the SysFS tree.
.SH OPTIONS .SH OPTIONS
.B -h|--help .B \-h|\-\-help
.RS .RS
Output usage message and exit Output usage message and exit
.RE .RE
.B -n|--dry-run .B \-n|\-\-dry\-run
.RS .RS
During \fB"set"\fR operation, only show what would be done, without actually During \fB"set"\fR operation, only show what would be done, without actually
changing anything. changing anything.
.RE .RE
.B -v|--verbose .B \-v|\-\-verbose
.RS .RS
During \fB"set"\fR operation, show the actions that are being performed. During \fB"set"\fR operation, show the actions that are being performed.
.RE .RE
@ -53,7 +53,7 @@ to override the "wildcard".
.SH SUB-COMMANDS .SH SUB-COMMANDS
.B set .B set
.RS .RS
Reads settings from \fBspan-types.conf\fR and applies them to the Reads settings from \fBspan\-types.conf\fR and applies them to the
device(s) specified in the command line (or all devices, if none device(s) specified in the command line (or all devices, if none
specified). specified).
.RE .RE
@ -67,7 +67,7 @@ dahdi_span_types (E1/T1/J1 spans).
.B dumpconfig .B dumpconfig
.RS .RS
List types for the spans in a format fit to be used in List types for the spans in a format fit to be used in
\fBspan-types.conf\fR. Use this to generate a configuration file after \fBspan\-types.conf\fR. Use this to generate a configuration file after
you have (perhaps manually) set all existing spans. you have (perhaps manually) set all existing spans.
.B dahdi_genconf spantypes .B dahdi_genconf spantypes
@ -76,7 +76,7 @@ uses this command internally.
.SH CONFIGURATION .SH CONFIGURATION
.SS General structure .SS General structure
.B span-types.conf .B span\-types.conf
is a file with lines specifying line modes of spans. is a file with lines specifying line modes of spans.
Empty lines or lines beginning with '#' are ignored. Empty lines or lines beginning with '#' are ignored.
@ -106,7 +106,7 @@ used) to the following values:
See above for their descriptions. The value may include shell wildcards: See above for their descriptions. The value may include shell wildcards:
*, ? and [], which are used in the match. The values to be matched are *, ? and [], which are used in the match. The values to be matched are
first cleaned up: '!' is replaced with '/' and any character not in first cleaned up: '!' is replaced with '/' and any character not in
"a-zA-Z0-9/:.-" is replaced by "_". "a\-zA\-Z0\-9/:.\-" is replaced by "_".
Note that while span\-types.conf allows an arbitrarily-complex Note that while span\-types.conf allows an arbitrarily-complex
combination of E1, J1 and T1 ports, it would normally have just a single combination of E1, J1 and T1 ports, it would normally have just a single
@ -154,13 +154,13 @@ usb:X1234567 [34]:E1 # Except spans 3,4 on the device which will be E1
.B DAHDICONFDIR .B DAHDICONFDIR
.RS .RS
The directory in which span-types.conf resides. /etc/dahdi if not The directory in which span\-types.conf resides. /etc/dahdi if not
overridden from the environment. overridden from the environment.
.RE .RE
.B DAHDISPANTYPESCONF .B DAHDISPANTYPESCONF
.RS .RS
The path to span-types.conf resides. /etc/dahdi/span\-types.conf if The path to span\-types.conf resides. /etc/dahdi/span\-types.conf if
not overridden from the environment. not overridden from the environment.
.RE .RE