Re: [RFR] templates://unixcw/{cwcp.templates,cw.templates}
Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.
I'm on reduced bandwidth right now, so no patch yet.
> Template: cw/suid_bit
> Type: boolean
> Default: false
> +_Description: Run cw with root privileges?
> + The cw program can produce sounds using console buzzer, but this feature
^the
> + is available only if cw is run by the root user.
> + .
> + This can be achieved by setting the "setuid" bit to
> + execute it with root privileges or by running the program
> + with sudo. Both are not recommended.
Setting setuid is slightly awkward... but more importantly this
phrasing (including the Description) makes it rather unclear that
the boolean here is only asking about setuid, not sudo.
> + .
> + Alternatively, you can use soundcard output instead of console buzzer output and
> eliminate this problem completely.
How about:
_Description: Make cw setuid root?
If run with elevated privileges (which is not recommended), cw can
produce sounds using the console buzzer.
.
Please choose whether this should be achieved by giving the
executable the "setuid" attribute.
.
Alternatives include running the program with sudo or eliminating
this issue completely by using output via a soundcard instead of the
buzzer.
> Package: libcw3
[...]
> Recommends: cw | cwcp | xcwcp
> -Description: Shared library for Morse programs
> - Shared library files for cw, cwcp and xcwcp programs.
> +Description: Morse programs - shared library
Given that all the programs are Morse code tutors, I'd suggest
mentioning that in the shared part of the description.
> + This package provides shared library files for cw, cwcp and xcwcp programs.
> The library handles Morse code signals and generates sound
> on console buzzer or sound card through OSS or ALSA.
Could we split this into a "unixcw boilerplate" paragraph and a
"libcw specifics" paragraph? And maybe throw in a why-the-name hint?
On the other hand the names of the other packages are already
present in the Recommends: line.
Description: Morse code tutor - shared library
The unixcw project provides support for learning to use Morse code
over Continuous Wave radio.
.
This package provides shared library files to handle Morse code
signals and to generate sound on the console buzzer or a sound card
through OSS or ALSA.
Package: libcw3-dev
Description: Morse code tutor - development files
The unixcw project provides support for learning to use Morse code
over Continuous Wave radio.
.
This package provides the static library, headers, and manual page for
development of programs that handle (i.e. send and receive) Morse code.
Package: cw
Description: Morse code tutor - command line user interface
The unixcw project provides support for learning to use Morse code
over Continuous Wave radio.
.
This package provides two executables:
* cw - a simple command line application that converts key-presses
to Morse code that can be heard through the console buzzer or a
sound card;
* cwgen - a program that generates groups of random characters for
Morse code practice, which can be piped to the cw program.
.
It also includes example files (with the extension "cw") containing
commands which can be used to change properties such as the speed,
tone, and spacing of characters.
I wouldn't normally think of referring to the noises as
"characters", but then again I'm not a radio ham. (And I nearly
said ".cw", but I suppose the dot isn't part of the extension.)
Package: cwcp
Description: Morse code tutor - text user interface
The unixcw project provides support for learning to use Morse code
over Continuous Wave radio.
.
This package provides an interactive Morse code tutor with a
full-screen text-based (ncurses) user interface. It offers menu
selection of sending modes, and keyboard control of character
sounding options such as the sending speed and pitch.
Package: xcwcp
Description: Morse code tutor - graphical user interface
The unixcw project provides support for learning to use Morse code
over Continuous Wave radio.
.
This package provides an interactive Morse code tutor with a Qt4
user interface. It allows choosing from a number of options for
practice, including sending random characters, random words, and
characters from the keyboard. It will also receive Morse code sent
using the keyboard or mouse as a Morse keyer, and display the
characters it sees.
If it's a Qt4 GUI (!= QT), and the package name is distinguished by
a prefixed X, then the fact it uses the X Window System can probably
be taken for granted.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
Reply to: