hyphen/minus fixes in man pages
[dahdi/tools.git] / doc / dahdi_monitor.8
1 .TH "DAHDI_MONITOR" "8" "9 Sep 2011" "" ""
2
3 .SH NAME
4 dahdi_monitor \- checks the Rx/Tx levels of a DAHDI channels
5 .SH SYNOPSIS
6
7 .B dahdi_monitor \fInum\fB [\-v[v]]
8 .B dahdi_monitor \fInum\fB [\-o] [<\-f|\-F> \fIFILE\fB]
9 .B dahdi_monitor \fInum\fB [[<\-r|\-R> \fIFILE\fB]] [[<\-t|\-T> \fIFILE\fB]]
10
11 .SH DESCRIPTION
12
13 dahdi_monitor monitors a Dahdi channel. It can record the output to a
14 file, play it to the speaker, or visualize the audio levels on the
15 terminal.
16
17 Recorded audio files are by default raw signed linear PCM. If the file
18 name ends with ".wav", the recorded file will be a WAV file.
19
20 The visual display shows the current audio level at both the Rx
21 (audio Received by Asterisk) and
22 Tx (audio Transmitted by Asterisk) 
23
24 To exit the program, press Ctrl-C.
25
26 .SH OPTIONS
27 The first (mandatory) parameter is the number of the channel
28 to monitor.
29
30 .B \-m
31 .RS
32 Multiple channels. Don't multiplex both Rx and Tx in a single channel.
33 Normally there's a different option that you need that implies it.
34 .RE
35
36 .B \-o
37 .RS
38 Plays the output to OSS (/dev/dsp). Requires \-m not to be used.
39 .RE
40
41 .B \-v
42 .RS
43 Display Visual audio levels. With two v-s, Verbose mode is enabled, that
44 shows the actual levels as numbers. Note that this requires a terminal
45 wider than 80 columns to be properly displayed.
46
47 Implies \-m.
48 .RE
49
50 .B \-f \fIFILE
51 .RS
52 Record the content of the channel (Tx + Rx) to a file.
53 .RE
54
55 .B \-F \fIFILE
56 .RS
57 Record the content of the channel (Tx + Rx) before the echo canceler
58 to a file.
59 .RE
60
61 .B \-r \fIFILE
62 .RS
63 Record the content of the Rx channel to a file.
64
65 Implies \-m.
66 .RE
67
68 .B \-R \fIFILE
69 .RS
70 Record the content of the R channel before the echo canceler to a file.
71
72 Implies \-m.
73 .RE
74
75 .B \-s \fIFILE
76 .RS
77 Record the content of the Tx and Rx of the channel to a file.
78 .RE
79
80 .B \-S \fIFILE
81 .RS
82 Records a stereo of both Tx and Rx of the channel before the echo
83 canceler to a file.
84 .RE
85
86 .B \-t \fIFILE
87 .RS
88 Record the content of the Tx channel to a file.
89
90 Implies \-m.
91 .RE
92
93 .B \-T \fIFILE
94 .RS
95 Record the content of the Tx channel before the echo canceler to a file.
96
97 Implies \-m.
98 .RE
99
100 .SH EXAMPLES
101
102 Visualize audio levels on DAHDI channel 2:
103
104   dahdi_monitor 2 \-v
105
106
107 Record channel 3 to a file:
108
109   dahdi_monitor 3 \-f output.raw
110
111 This will create a raw PCM file (signed-linear, 8kHz, mono, 16 bits per
112 sample). Both the Tx and Rx will be multiplexed in a single channel.
113 It can be converted to a WAV file using e.g.:
114
115   sox \-s \-c1 \-2 \-r8000 output.raw output.wav
116
117
118 Record Tx and Rx of channel 5 to separate files. This time directly to
119 WAV files:
120
121   dahdi_monitor 5 \-r output_rx.wav \-t output_tx.wav
122
123
124 Record channel 8 to a stereo file (Tx and Rx on its two channels):
125
126   dahdi_monitor 8 \-s output.raw
127
128 Converting it to a WAV file:
129
130   sox \-s \-c2 \-2 \-r8000 output.raw output.wav
131
132
133
134 .SH SEE ALSO
135 .PP
136 dahdi_tool(8), dahdi_cfg(8).
137
138 .SH AUTHOR
139 .PP
140 This manual page was written by Santiago Ruano Rinc\['o]n 
141 <santiago@unicauca.edu.co> for
142 the Debian system (but may be used by others).  Permission is
143 granted to copy, distribute and/or modify this document under
144 the terms of the GNU General Public License, Version 2 any 
145 later version published by the Free Software Foundation.