Re: [RFR] templates://nas/{nas.templates}

[Justin B Rye <jbr@edlug.org.uk>]

Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

>  _Description: Should nasd release /dev/dsp?
> - The NAS server will by default open the audio device configured on your
> + The NAS server will by default open the audio device configured on the
>   system at startup, and then keep it open until it is stopped. This will
> 
> "unpersonnalize" the system

Or even:
   By default, the NAS server will open the configured audio device
   at startup, [...]

> - nasd can be configured to release the audio device when it is not actively
> - using it. There will almost always be a slight delay between the
> - application using nas finishing and the audio device becoming available
> - for other uses; this is due to the latency inherent in the design of nas
> - and so cannot really be changed.
> + The daemon can be configured to release the audio device when it is
> + not actively using it, however with some delay after the
> + application completes and the audio is available.
> 
> Reword to shorten down so that the template has a chance to fit on one
> screen.

That "however" isn't great... how about:
    The daemon can be configured to release the audio device when it is
    not actively using it, but some delay is likely between an application
    completing and the device becoming available again.

> - An alternative to this is to use the "audiooss" program (in the package of
> - the same name) to wrap any programs that use /dev/dsp directly - it will
> - intercept most uses of /dev/dsp and make the equivalent nas calls instead.
> - .
> - Should nasd release the audio device? (It is recommended to select this
> - option unless you have special requirements.)
> + An alternative is using the "audiooss" package to wrap any programs
> + that use /dev/dsp directly to use the equivalent NAS calls.
> 
> Reword to shorten down so that the template has a chance to fit on one
> screen.

Make it:
    that use /dev/dsp directly, so they use equivalent NAS calls instead.

>  Template: nas/mixer         
[...]
> - The nas server will by default change the mixer settings at startup as
> + The NAS server may change the mixer settings at startup as
>   follows:         

"May" in what sense?  It's a boolean defaulting to no, so it would
be clearer as something like:
    If you choose this option, the NAS server will change the mixer settings
    at startup as follows:


Then the control file looks good, with only one query:
> Package: nas
[...]
> This package contains the NAS daemon (au), needed for local output from NAS.

In what sense is the NAS daemon called "au"?  /etc/init.d/nas calls
/usr/bin/nasd; there's a "man au", but it's a symlink to "man nas".


Oh, wait, here's an appropriately last-minute addition:
> source, including Postscript copies of papers describing its design.
                    PostScript
-- 
JBR
Ankh kak! (Ancient Egyptian blessing)

--- ../nas.old/debian/nas.templates	2007-08-30 22:19:10.000000000 +0100
+++ debian/nas.templates	2007-09-03 18:12:50.000000000 +0100
@@ -2,31 +2,23 @@
 Type: boolean
 Default: true
 _Description: Should nasd release /dev/dsp?
- The NAS server will by default open the audio device configured on your
- system at startup, and then keep it open until it is stopped. This will
- stop any audio clients that are not NAS aware from using the audio device.
+ By default, the NAS server will open the configured audio device
+ at startup, and then keep it open until it is stopped. This will
+ stop any audio clients that are not NAS-aware from using the audio device.
  .
- nasd can be configured to release the audio device when it is not actively
- using it. There will almost always be a slight delay between the
- application using nas finishing and the audio device becoming available
- for other uses; this is due to the latency inherent in the design of nas
- and so cannot really be changed.
+ The daemon can be configured to release the audio device when it is
+ not actively using it, but some delay is likely between an application
+ completing and the device becoming available again.
  .
- An alternative to this is to use the "audiooss" program (in the package of
- the same name) to wrap any programs that use /dev/dsp directly - it will
- intercept most uses of /dev/dsp and make the equivalent nas calls instead.
- .
- Should nasd release the audio device? (It is recommended to select this
- option unless you have special requirements.)
+ An alternative is using the "audiooss" package to wrap any programs
+ that use /dev/dsp directly, so they use equivalent NAS calls instead.
 
 Template: nas/mixer
 Type: boolean
 Default: false
 _Description: Should nasd change mixer settings at startup?
- The nas server will by default change the mixer settings at startup as
- follows:
- .
-  * set PCM volume to 50%
-  * change the record input device to LINE
+ If you choose this option, the NAS server will change the mixer settings
+ at startup as follows:
  .
- Do you want it to do this? (Most people are expected to disable this option)
+  - set PCM volume to 50%;
+  - change the record input device to LINE.
--- ../nas.old/debian/control	2007-08-30 22:19:10.000000000 +0100
+++ debian/control	2007-09-03 18:49:40.000000000 +0100
@@ -13,14 +13,15 @@
 Replaces: nas-lib
 Conflicts: nas-lib
 Suggests: nas
-Description: The Network Audio System (NAS). (shared libraries)
- The Network Audio System was developed by NCD for playing, recording, and
- manipulating audio data over a network.  Like the X Window System, it uses
- the client/server model to separate applications from the specific drivers
- that control audio input and output devices.
+Description: Network Audio System - shared libraries
+ The Network Audio System (NAS) was developed by NCD for playing,
+ recording, and manipulating audio data over a network. Like the X
+ Window System, it uses the client/server model to separate
+ applications from the specific drivers that control audio input and
+ output devices.
  .
- This package contains the nas library (libaudio), needed for both remote
- and local output. 
+ This package contains the NAS library (libaudio), needed for both remote
+ and local output.
 Section: libs
 
 Package: nas
@@ -28,13 +29,14 @@
 Architecture: any
 Depends: libaudio2, ${shlibs:Depends}, debconf | debconf-2.0
 Suggests: audiooss
-Description: The Network Audio System (NAS). (local server)
- The Network Audio System was developed by NCD for playing, recording, and
- manipulating audio data over a network.  Like the X Window System, it uses
- the client/server model to separate applications from the specific drivers
- that control audio input and output devices.
+Description: Network Audio System - local server
+ The Network Audio System (NAS) was developed by NCD for playing,
+ recording, and manipulating audio data over a network. Like the X
+ Window System, it uses the client/server model to separate
+ applications from the specific drivers that control audio input and
+ output devices.
  .
- This package contains the nas daemon (au), needed for local output from nas.
+ This package contains the NAS daemon (au), needed for local output from NAS.
 Section: sound
 
 Package: libaudio-dev
@@ -44,39 +46,42 @@
 Provides: nas-dev
 Replaces: nas-dev
 Conflicts: nas-dev
-Description: The Network Audio System (NAS). (development files)
- The Network Audio System was developed by NCD for playing, recording, and
- manipulating audio data over a network.  Like the X Window System, it uses
- the client/server model to separate applications from the specific drivers
- that control audio input and output devices.
+Description: Network Audio System - development files
+ The Network Audio System (NAS) was developed by NCD for playing,
+ recording, and manipulating audio data over a network. Like the X
+ Window System, it uses the client/server model to separate
+ applications from the specific drivers that control audio input and
+ output devices.
  .
  This package contains the header files and static library (libaudio.a), 
- needed for development of programs using nas. 
+ needed for development of programs using NAS.
 Section: libdevel
 
 Package: nas-bin
 Priority: extra
 Architecture: any
 Depends: libaudio2, perl5, ${shlibs:Depends}
-Description: The Network Audio System (NAS). (client binaries)
- The Network Audio System was developed by NCD for playing, recording, and
- manipulating audio data over a network.  Like the X Window System, it uses
- the client/server model to separate applications from the specific drivers
- that control audio input and output devices.
+Description: Network Audio System - client binaries
+ The Network Audio System (NAS) was developed by NCD for playing,
+ recording, and manipulating audio data over a network. Like the X
+ Window System, it uses the client/server model to separate
+ applications from the specific drivers that control audio input and
+ output devices.
  .
- This package contains the example applications / utilities that are
- provided with nas. 
+ This package contains the example applications and utilities that are
+ provided with NAS.
 Section: sound
 
 Package: nas-doc
 Priority: extra
 Architecture: all
-Description: The Network Audio System (NAS). (extra documentation)
- The Network Audio System was developed by NCD for playing, recording, and
- manipulating audio data over a network.  Like the X Window System, it uses
- the client/server model to separate applications from the specific drivers
- that control audio input and output devices.
+Description: Network Audio System - extra documentation
+ The Network Audio System (NAS) was developed by NCD for playing,
+ recording, and manipulating audio data over a network. Like the X
+ Window System, it uses the client/server model to separate
+ applications from the specific drivers that control audio input and
+ output devices.
  .
- This package contains the extra documentation provided with the nas
- source, including Postscript copies of papers describing its design.
+ This package contains the extra documentation provided with the NAS
+ source, including PostScript copies of papers describing its design.
 Section: doc

Template: nas/relinquish
Type: boolean
Default: true
_Description: Should nasd release /dev/dsp?
 By default, the NAS server will open the configured audio device
 at startup, and then keep it open until it is stopped. This will
 stop any audio clients that are not NAS-aware from using the audio device.
 .
 The daemon can be configured to release the audio device when it is
 not actively using it, but some delay is likely between an application
 completing and the device becoming available again.
 .
 An alternative is using the "audiooss" package to wrap any programs
 that use /dev/dsp directly, so they use equivalent NAS calls instead.

Template: nas/mixer
Type: boolean
Default: false
_Description: Should nasd change mixer settings at startup?
 If you choose this option, the NAS server will change the mixer settings
 at startup as follows:
 .
  - set PCM volume to 50%;
  - change the record input device to LINE.

Source: nas
Section: sound
Priority: optional
Maintainer: Steve McIntyre <93sam@debian.org>
Build-Depends: libxp-dev, libxau-dev, libsm-dev, libice-dev, libx11-dev, libxt-dev, libxaw7-dev, xutils, bison, flex, file, po-debconf
Standards-Version: 3.7.2.0

Package: libaudio2
Priority: optional
Architecture: any
Depends: ${shlibs:Depends}
Provides: nas-lib
Replaces: nas-lib
Conflicts: nas-lib
Suggests: nas
Description: Network Audio System - shared libraries
 The Network Audio System (NAS) was developed by NCD for playing,
 recording, and manipulating audio data over a network. Like the X
 Window System, it uses the client/server model to separate
 applications from the specific drivers that control audio input and
 output devices.
 .
 This package contains the NAS library (libaudio), needed for both remote
 and local output.
Section: libs

Package: nas
Priority: optional
Architecture: any
Depends: libaudio2, ${shlibs:Depends}, debconf | debconf-2.0
Suggests: audiooss
Description: Network Audio System - local server
 The Network Audio System (NAS) was developed by NCD for playing,
 recording, and manipulating audio data over a network. Like the X
 Window System, it uses the client/server model to separate
 applications from the specific drivers that control audio input and
 output devices.
 .
 This package contains the NAS daemon (au), needed for local output from NAS.
Section: sound

Package: libaudio-dev
Priority: optional
Architecture: any
Depends: libaudio2, ${shlibs:Depends}
Provides: nas-dev
Replaces: nas-dev
Conflicts: nas-dev
Description: Network Audio System - development files
 The Network Audio System (NAS) was developed by NCD for playing,
 recording, and manipulating audio data over a network. Like the X
 Window System, it uses the client/server model to separate
 applications from the specific drivers that control audio input and
 output devices.
 .
 This package contains the header files and static library (libaudio.a), 
 needed for development of programs using NAS.
Section: libdevel

Package: nas-bin
Priority: extra
Architecture: any
Depends: libaudio2, perl5, ${shlibs:Depends}
Description: Network Audio System - client binaries
 The Network Audio System (NAS) was developed by NCD for playing,
 recording, and manipulating audio data over a network. Like the X
 Window System, it uses the client/server model to separate
 applications from the specific drivers that control audio input and
 output devices.
 .
 This package contains the example applications and utilities that are
 provided with NAS.
Section: sound

Package: nas-doc
Priority: extra
Architecture: all
Description: Network Audio System - extra documentation
 The Network Audio System (NAS) was developed by NCD for playing,
 recording, and manipulating audio data over a network. Like the X
 Window System, it uses the client/server model to separate
 applications from the specific drivers that control audio input and
 output devices.
 .
 This package contains the extra documentation provided with the NAS
 source, including PostScript copies of papers describing its design.
Section: doc