blob: b6d7d4f0d07adda6cb34a6e82e2ba6ba11eed33e [file] [log] [blame]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001From 28c29dece6c434e7d3d01e805555ba7ddf6fba65 Mon Sep 17 00:00:00 2001
2From: "Lu, Han" <han.lu@intel.com>
3Date: Wed, 3 Feb 2016 14:20:33 +0800
4Subject: [PATCH] alsabat: rename to avoid naming conflict
5
6alsa-utils as well as bareos-bat (as well a some Bacula packages)
7all contain a program called /usr/bin/bat, which causes conflicts on
8various distributions ("basic audio tester" vs "bareos administration
9tool"("bacula administration tool")).
10Rename to avoid conflict.
11
12Signed-off-by: Lu, Han <han.lu@intel.com>
13Signed-off-by: Takashi Iwai <tiwai@suse.de>
14
15Upstream-Status: Accepted [expected in version 1.1.1]
16
17Signed-off-by: Tanu Kaskinen <tanuk@iki.fi>
18---
19 bat/Makefile.am | 10 +++++-----
20 bat/{bat.1 => alsabat.1} | 43 ++++++++++++++++++++++---------------------
21 bat/bat.c | 2 +-
22 3 files changed, 28 insertions(+), 27 deletions(-)
23 rename bat/{bat.1 => alsabat.1} (72%)
24
25diff --git a/bat/Makefile.am b/bat/Makefile.am
26index 842ae6b..985f00c 100644
27--- a/bat/Makefile.am
28+++ b/bat/Makefile.am
29@@ -1,9 +1,9 @@
30-bin_PROGRAMS = bat
31-man_MANS = bat.1
32+bin_PROGRAMS = alsabat
33+man_MANS = alsabat.1
34
35-EXTRA_DIST = bat.1
36+EXTRA_DIST = alsabat.1
37
38-bat_SOURCES = \
39+alsabat_SOURCES = \
40 bat.c \
41 common.c \
42 analyze.c \
43@@ -21,4 +21,4 @@ noinst_HEADERS = \
44 AM_CPPFLAGS = \
45 -Wall -I$(top_srcdir)/include
46
47-bat_LDADD = @FFTW_LIB@
48+alsabat_LDADD = @FFTW_LIB@
49diff --git a/bat/bat.1 b/bat/alsabat.1
50similarity index 72%
51rename from bat/bat.1
52rename to bat/alsabat.1
53index e00fc27..8d0b9c0 100644
54--- a/bat/bat.1
55+++ b/bat/alsabat.1
56@@ -1,23 +1,23 @@
57-.TH BAT 1 "20th October 2015"
58+.TH ALSABAT 1 "20th October 2015"
59 .SH NAME
60-bat \- command\-line sound tester for ALSA sound card driver
61+alsabat \- command\-line sound tester for ALSA sound card driver
62
63 .SH SYNOPSIS
64-\fBbat\fP [\fIflags\fP]
65+\fBalsabat\fP [\fIflags\fP]
66
67 .SH DESCRIPTION
68-\fBBAT(Basic Audio Tester)\fP is a simple command\-line utility intended
69-to help automate audio driver and sound server testing with little human
70-interaction. BAT can be used to test audio quality, stress test features
71-and test audio before and after PM state changes.
72+\fBALSABAT(ALSA Basic Audio Tester)\fP is a simple command\-line utility
73+intended to help automate audio driver and sound server testing with little
74+human interaction. ALSABAT can be used to test audio quality, stress test
75+features and test audio before and after PM state changes.
76
77-BAT's design is relatively simple. BAT plays an audio stream and captures
78-the same stream in either a digital or analog loop back. It then compares
79-the captured stream using a FFT to the original to determine if the test
80-case passes or fails.
81+ALSABAT's design is relatively simple. ALSABAT plays an audio stream and
82+captures the same stream in either a digital or analog loop back. It then
83+compares the captured stream using a FFT to the original to determine if
84+the test case passes or fails.
85
86-BAT can either run wholly on the target machine being tested (standalone
87-mode) or can run as a client/server mode where by bat client runs on the
88+ALSABAT can either run wholly on the target machine being tested (standalone
89+mode) or can run as a client/server mode where by alsabat client runs on the
90 target and runs as a server on a separate tester machine. The client/server
91 mode still requires some manual interaction for synchronization, but this
92 is actively being developed for future releases.
93@@ -93,8 +93,8 @@ Frequencies with amplitude larger than threshold will be recognized as a
94 peak, and the frequency with largest peak value will be recognized as a
95 detected frequency.
96 .br
97-BAT then compares the detected frequency to target frequency, to decide
98-if the detecting passes or fails.
99+ALSABAT then compares the detected frequency to target frequency, to
100+decide if the detecting passes or fails.
101 .br
102 The default value is 3.0.
103 .TP
104@@ -117,18 +117,19 @@ Target WAV file to save capture test content.
105 .TP
106 \fI\-\-local\fP
107 Internal loopback mode.
108-Playback, capture and analysis internal to BAT only. This is intended for
109-developers to test new BAT features as no audio is routed outside of BAT.
110+Playback, capture and analysis internal to ALSABAT only. This is intended
111+for developers to test new ALSABAT features as no audio is routed outside
112+of ALSABAT.
113
114 .SH EXAMPLES
115
116 .TP
117-\fBbat \-P plughw:0,0 \-C plughw:0,0 \-c 2 \-f S32_LE \-F 250\fR
118+\fBalsabat \-P plughw:0,0 \-C plughw:0,0 \-c 2 \-f S32_LE \-F 250\fR
119 Generate and play a sine wave of 250 Hertz with 2 channel and S32_LE format,
120 and then capture and analyze.
121
122 .TP
123-\fBbat \-P plughw:0,0 \-C plughw:0,0 \-\-file 500Hz.wav\fR
124+\fBalsabat \-P plughw:0,0 \-C plughw:0,0 \-\-file 500Hz.wav\fR
125 Play the RIFF WAV file "500Hz.wav" which contains 500 Hertz waveform LPCM
126 data, and then capture and analyze.
127
128@@ -152,7 +153,7 @@ Currently only support RIFF WAV format with PCM data. Please report any bugs to
129 the alsa-devel mailing list.
130
131 .SH AUTHOR
132-\fBbat\fP is by Liam Girdwood <liam.r.girdwood@linux.intel.com>, Bernard Gautier
133-<bernard.gautier@intel.com> and Han Lu <han.lu@intel.com>.
134+\fBalsabat\fP is by Liam Girdwood <liam.r.girdwood@linux.intel.com>, Bernard
135+Gautier <bernard.gautier@intel.com> and Han Lu <han.lu@intel.com>.
136 This document is by Liam Girdwood <liam.r.girdwood@linux.intel.com> and Han Lu
137 <han.lu@intel.com>.
138diff --git a/bat/bat.c b/bat/bat.c
139index 086b9fa..ddb60b7 100644
140--- a/bat/bat.c
141+++ b/bat/bat.c
142@@ -272,7 +272,7 @@ static void test_capture(struct bat *bat)
143 static void usage(struct bat *bat)
144 {
145 fprintf(bat->log,
146-_("Usage: bat [-options]...\n"
147+_("Usage: alsabat [-options]...\n"
148 "\n"
149 " -h, --help this help\n"
150 " -D pcm device for both playback and capture\n"
151--
1522.7.0
153