update docs

This commit is contained in:
Fabian Kurz 2011-01-25 20:25:49 +00:00
parent db89baca8f
commit 628ca7b1a9
4 changed files with 16 additions and 8 deletions

View File

@ -31,7 +31,7 @@ uninstall:
rm -f $(DESTDIR)/share/man/man1/ebook2cw.1 rm -f $(DESTDIR)/share/man/man1/ebook2cw.1
clean: clean:
rm -f ebook2cw *~ *.mp3 rm -f ebook2cw *~ *.mp3 *.ogg *.cgi
dist: dist:
sed 's/v[0-9].[0-9].[0-9]/v$(VERSION)/g' README > README2 sed 's/v[0-9].[0-9].[0-9]/v$(VERSION)/g' README > README2

11
README
View File

@ -1,4 +1,4 @@
ebook2cw v0.7.1 - convert ebooks to morse mp3s - Fabian Kurz, DJ1YFK ebook2cw v0.8.0 - convert ebooks to morse mp3s - Fabian Kurz, DJ1YFK
--------------------------------------------------------------------- ---------------------------------------------------------------------
Website: http://fkurz.net/ham/ebook2cw.html Website: http://fkurz.net/ham/ebook2cw.html
@ -27,4 +27,11 @@ make install
CGI CGI
--- ---
ebook2cw can also be compiled as a CGI, with "make cgi". ebook2cw can also be compiled as a CGI, with "make cgi". The executable can
then be used on a webserver and called in the format
http://example.com/cgi-bin/cw.cgi?s=25&e=25&f=600&t=%20hello%20world
which returns a MP3 file with "hello world" at the given speed etc. The order
of the GET parameters must be used as shown above. Real-world examples of
ebook2cw as a CGI can be found at http://lcwo.net/.

View File

@ -1,4 +1,4 @@
.TH ebook2cw 1 "MARCH 2008" Linux "User Manuals" .TH ebook2cw 1 "JANUARY 2011" Linux "User Manuals"
.SH NAME .SH NAME
ebook2cw \- convert ebooks to morse mp3s ebook2cw \- convert ebooks to morse mp3s
.SH SYNOPSIS .SH SYNOPSIS
@ -99,9 +99,10 @@ center frequencies: 800Hz
CW prosigns can be generated by enclosing arbitrary letters in angle brackets CW prosigns can be generated by enclosing arbitrary letters in angle brackets
(e.g. <AR>, <SK>, ...). (e.g. <AR>, <SK>, ...).
The tone frequency (f), speed (w), effective speed (e) and waveform (T) can be The tone frequency (f), speed (w), effective speed (e), extra word space (W),
changed arbitrarily within the text by inserting commands, starting with a pipe waveform (T) and SNR (N) can be changed arbitrarily within the text by
symbol, followed by the parameter to change and the value. inserting commands, starting with a pipe symbol, followed by the parameter to
change and the value.
Example: |f400 changes the tone frequency to 400Hz, |w60 changes the speed to Example: |f400 changes the tone frequency to 400Hz, |w60 changes the speed to
60wpm, |T3 changes the waveform to squarewave. 60wpm, |T3 changes the waveform to squarewave.

View File

@ -1,5 +1,5 @@
@echo off @echo off
echo ebook2cw - Batch file for Windows. echo ebook2cw - Batch file for Windows (obsolete; replaced by ebook2cwgui)
echo - echo -
echo Usage: You will be promted for a filename and (at your option) echo Usage: You will be promted for a filename and (at your option)
echo additional parameters for ebook2cw (such as wpm, tone freq etc). echo additional parameters for ebook2cw (such as wpm, tone freq etc).