GNOME Bugzilla – Bug 300138
Documentation should explain the Sound options
Last modified: 2005-04-20 00:33:12 UTC
Documentation bug Section: Section 7 in the Gnome help documentation Section 7 says nothing about sound. Correct version: Something to the likes of... 7.2 Login Sound Configuration By default, gdm requires a media application such as "sox" to be present to play login sounds. GDM defaults the location of this application to "/usr/bin/play", however you can reassign this value in the gdm.conf file. Other information:
The appropriate place to document GDM2 features is in the GDM help docs which are in gdm2 CVS under docs/C/gdm.xml. Please update this file to include better documentation about how to configure sound. You can see these docs online here: http://yippi.hypermall.com/gdm/gdm-documentation/t1.html Note that under the "Configuration" section, it already includes information about the SoundOnLogin and SoundOnLoginFile configuration parameters. This seems good enough to me. I guess we could add a subsection to the "Overview" section which highlights how Sound can be configured with GDM. If you wanted to improve the docs, then that would be appreciated.
Do you feel that this bug has been fixed by your patch to fix #300136, or does more work need to be done to the docs? If the docs are in good shape, please close this bug.
For me I would say that the Accessibility section of the help documents should mention Sound since the Sound configuration is setup under that section of the gdmsetup program. For instance when I was first monkeying around with gdmsetup I couldn't figure out why it wasn't playing a login ready sound because I was looking the the Gnome Help documentation system by hitting the "Help" button inside gdmsetup. I couldn't find it since I was looking under accessibility because that's where the sound is configured in gdmsetup. I was thinking a small blurb like the one I originally posted might work for just that type of occasion, but if you don't think it's needed that's fine. I don't know very much about how the documentation system works. All my sound patch did was make the necessary addition of the new config line options for the new sound options. Attached is my proposed patch to the documentation
Created attachment 45452 [details] [review] Adds Accessibility Sound Documentation
Fixed in CVS head.