summaryrefslogtreecommitdiff
path: root/sound-monitor
diff options
context:
space:
mode:
authorDan Mueth <d-mueth@uchicago.edu>2000-04-12 02:35:46 +0000
committerDan Mueth <dmueth@src.gnome.org>2000-04-12 02:35:46 +0000
commite08e9c2189e3ced7d55f295b36b0cf64e5bedd4f (patch)
treec7ffe084eca1b582382837fad25c07654a74df59 /sound-monitor
parent1c94770c9ba7220a19e9d8b8b9689af724eb75b6 (diff)
Updated gkb, charpick, mixer, and sound-monitor docs, mostly moving them
2000-04-11 Dan Mueth <d-mueth@uchicago.edu> * Updated gkb, charpick, mixer, and sound-monitor docs, mostly moving them to the newer template. Several other small fixes.
Diffstat (limited to 'sound-monitor')
-rw-r--r--sound-monitor/ChangeLog4
-rw-r--r--sound-monitor/docs/C/sound-monitor-applet.sgml90
-rw-r--r--sound-monitor/docs/C/sound-monitor.sgml233
-rw-r--r--sound-monitor/docs/C/sound-monitor_applet.sgml90
4 files changed, 263 insertions, 154 deletions
diff --git a/sound-monitor/ChangeLog b/sound-monitor/ChangeLog
index 4816bba0f..efc2ca7a6 100644
--- a/sound-monitor/ChangeLog
+++ b/sound-monitor/ChangeLog
@@ -1,3 +1,7 @@
+2000-04-11 Dan Mueth <d-mueth@uchicago.edu>
+
+ * docs/C/*sgml: Updated to new templates.
+
2000-03-31 Jacob Berkman <jacob@helixcode.com>
* main.c (create_new_app):
diff --git a/sound-monitor/docs/C/sound-monitor-applet.sgml b/sound-monitor/docs/C/sound-monitor-applet.sgml
index 2f7254314..80c62e26e 100644
--- a/sound-monitor/docs/C/sound-monitor-applet.sgml
+++ b/sound-monitor/docs/C/sound-monitor-applet.sgml
@@ -1,48 +1,56 @@
<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN"[
- <!entity soundmonitor.sgml SYSTEM "sound-monitor.sgml">
+ <!entity soundmonitor.sgml SYSTEM "sound-monitor.sgml">
+
]>
-<article id="index">
-
- <artheader>
- <title>Sound Monitor Applet</title>
- <authorgroup>
- <author>
- <firstname>Dan</firstname>
- <surname>Mueth</surname>
- </author>
- </authorgroup>
- <copyright>
- <year>2000</year>
- <holder>Dan Mueth</holder>
- </copyright>
-
- <legalnotice>
- <para>
- Permission is granted to copy, distribute and/or modify this
- document under the terms of the GNU Free Documentation License,
- Version 1.1 or any later version published by the Free Software
- Foundation; with no Invariant Sections, with no Front-Cover
- Texts, and with no Back-Cover Texts. A copy of the license is
- available from the GNU Foundation and can be viewed <ulink
- url="http://www.gnu.org/copyleft/fdl.html"
- type="http">online</ulink>.
- </para>
-
- <para> UNIX is a trademark of X/Open Group.</para> <para> Linux
- is a trademark of Linus Torvalds.</para> <para> X Window System
- is a trademark of X Consortium, Inc.</para> <para> Windows is a
- trademark of Microsoft Corp.</para>
- </legalnotice>
-
- <releaseinfo>
- This is version 0.9 of the Sound Monitor manual.
- </releaseinfo>
- </artheader>
-
- &soundmonitor.sgml;
-</article>
+<article id="index"> <!-- please do not change the id -->
+
+ <!-- ============= Document Header ============================= -->
+ <artheader>
+ <title>Sound Monitor Applet</title>
+ <copyright>
+ <year>2000</year>
+ <holder>Dan Mueth</holder>
+ </copyright>
+
+ <!-- translators: uncomment this:
+
+ <copyright>
+ <year>2000</year>
+ <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+ </copyright>
+
+ -->
+
+ <!-- do not put authorname in the header except in copyright - use
+ section "authors" below -->
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the <citetitle>GNU Free Documentation
+ License</citetitle>, Version 1.1 or any later version published
+ by the Free Software Foundation with no Invariant Sections, no
+ Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy
+ of the <citetitle>GNU Free Documentation License</citetitle> from
+ the Free Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to:
+ Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ Boston, MA 02111-1307, USA.
+ </para>
+
+ </legalnotice>
+
+ <releaseinfo>
+ This is version 1.0 of the Sound Monitor applet manual.
+ </releaseinfo>
+ </artheader>
+
+ <!-- ============= Document Body ============================= -->
+
+ &soundmonitor.sgml;
+
+</article>
diff --git a/sound-monitor/docs/C/sound-monitor.sgml b/sound-monitor/docs/C/sound-monitor.sgml
index d3d3fd5a2..df075a27a 100644
--- a/sound-monitor/docs/C/sound-monitor.sgml
+++ b/sound-monitor/docs/C/sound-monitor.sgml
@@ -1,8 +1,8 @@
<sect1 id="soundmonitorapplet">
- <title>Sound Monitor Applet</title>
+ <title>Sound Monitor Applet</title>
- <para>
- <application>Sound Monitor Applet</application>, shown in its
+ <para>
+ <application>Sound Monitor</application> applet, shown in its
default theme(appearance) in <xref
linkend="soundmonitorapplet-fig">, is a sound volume display and an
interface for controlling ESD (the Enlightened Sound Daemon). If
@@ -18,7 +18,7 @@
<guimenuitem>Sound Monitor</guimenuitem>
</menuchoice>.
</para>
-
+
<figure id="soundmonitorapplet-fig">
<title>Sound Monitor Applet</title>
<screenshot>
@@ -29,6 +29,7 @@
</screenshot>
</figure>
+ <!-- ============= Usage ================================ -->
<sect2 id="soundmonitorapplet-usage">
<title>Usage</title>
<para>
@@ -39,57 +40,65 @@
standby</guimenuitem> or <guimenuitem>Resume Esound</guimenuitem>
respectively, as described below.
</para>
- <para>
- If you right-click on the applet, it brings up a
- menu, containing the following commands:
- <itemizedlist>
-
- <listitem>
- <para>
- <guimenuitem>About&hellip;</guimenuitem> &mdash; shows info about
- the <application>Sound Monitor</application>, inluding the
- version and the author's name and email address.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <guimenuitem>Help&hellip;</guimenuitem> &mdash; brings up this
- document.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <guimenuitem>Properties&hellip;</guimenuitem>&mdash; brings up
- the <link linkend="soundmonitorapplet-prefs">
- <interface>Properties</interface></link> dialog.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <guimenuitem>Manager&hellip;</guimenuitem> &mdash; brings
- up the <link linkend="soundmonitorapplet-manager">
- <interface>Sound Monitor Manager</interface></link> dialog,
- which allows you to view and control current ESD settings.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <guimenuitem>Place Esound in
- standby</guimenuitem>/<guimenuitem>Resume
- Esound</guimenuitem> &mdash; These menu items allow you to
- temporarily place ESD in standby and then resume ESD.
- This is useful if you have a sound application which is
- unable to work with ESD, but needs direct access to the
- sound device.
- </para>
- </listitem>
-
- </itemizedlist>
- </para>
+
+ <para>
+ Right-clicking on the applet brings up a menu containing the
+ following items:
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guimenuitem>Manager&hellip;</guimenuitem> &mdash; brings
+ up the <link linkend="soundmonitorapplet-manager">
+ <interface>Sound Monitor Manager</interface></link> dialog,
+ which allows you to view and control current ESD settings.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenuitem>Place Esound in
+ standby</guimenuitem>/<guimenuitem>Resume
+ Esound</guimenuitem>/<guimenuitem>Start
+ Esound</guimenuitem> &mdash; At any time, you will only
+ have one of these three items, depending on whether ESD is
+ running and what its status is. The first two menu items
+ allow you to
+ temporarily place ESD in standby and then resume ESD.
+ This is useful if you have a sound application which is
+ unable to work with ESD, but needs direct access to the
+ sound device. The third allows you to start
+ <application>Esound</application> if it is not started.
+ </para>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ <guimenuitem>Properties&hellip;</guimenuitem> &mdash;
+ opens the <link linkend="soundmonitorapplet-prefs">
+ <guilabel>Properties</guilabel></link> dialog.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenuitem>Help</guimenuitem> &mdash;
+ displays this document.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenuitem>About&hellip;</guimenuitem> &mdash;
+ shows basic information about <application>Sound
+ Monitor</application>, inluding the applet's version and the
+ author's name.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
<note>
<title>Note About Sound in GNOME</title>
@@ -111,19 +120,23 @@
Center</application> for the first time.
</para>
</note>
+
</sect2>
+
+ <!-- ============= Customization ============================= -->
<sect2 id="soundmonitorapplet-prefs">
<title>Customization</title>
<para>
- You can customize <application>Sound Monitor</application> by
- right-clicking on it and choosing
+ You can customize <application>Sound Monitor</application>
+ applet by right-clicking on it and choosing
<guimenuitem>Properties&hellip;</guimenuitem>. This will open the
<interface>Properties</interface> dialog(shown in <xref
- linkend="soundmonitorappletsettings-fig">), which allows you to
+ linkend="soundmonitor-settings-fig">), which allows you to
change various settings.
</para>
- <figure id="soundmonitorappletsettings-fig">
+
+ <figure id="soundmonitor-settings-fig">
<title>Properties dialog</title>
<screenshot>
<screeninfo>Properties dialog</screeninfo>
@@ -226,15 +239,17 @@
</itemizedlist>
</para>
- <para> After you made all the choices you want, click on
- <guibutton>OK</guibutton> to make the changes and close the
+ <para>
+ After you have made all the changes you want, click on
+ <guibutton>OK</guibutton> to apply the changes and close the
<interface>Properties</interface> dialog. To cancel the changes
and return to previous values, click the
<guibutton>Cancel</guibutton> button.
</para>
-
</sect2>
+
+ <!-- ============= Manager ================================== -->
<sect2 id="soundmonitorapplet-manager">
<title>The Sound Monitor Manager</title>
<para>
@@ -304,24 +319,98 @@
</sect2>
- <sect2 id="soundmonitorapplet-bugs">
- <title>Known bugs and limitations</title>
+ <!-- ============= Bugs ================================== -->
+ <!-- This section should describe known bugs and limitations of
+ the program if there are any - please be frank and list all
+ problems you know of -->
+ <sect2 id="bugs">
+ <title>Known Bugs and Limitations</title>
<para>
- There are no known bugs.
+ This applet has no known bugs.
</para>
</sect2>
- <sect2 id="soundmonitorapplet-authors">
+
+ <!-- ============= Authors ================================ -->
+
+ <sect2 id="authors">
<title>Authors</title>
<para>
- This applet was writen by John Ellis
- <email>johne@bellatlantic.net</email>. To submit suggestions and
- bug reports, use <ulink type="http"
- url="http://bugs.gnome.org">The GNOME Bug Tracking System</ulink>
- or the <application>bug-buddy</application> utility in the
- <interface>Main Menu</interface>.
+ <application>Sound Monitor</application> was written by John Ellis
+ (<email>johne@bellatlantic.net</email>). Please send all comments,
+ suggestions, and bug
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ bug tracking database</ulink>. (Instructions for submitting bug
+ reports can be found <ulink
+ url="http://bugs.gnome.org/Reporting.html" type="http">
+ on-line</ulink>. If you are using
+ GNOME 1.1 or later, you can also use <application>Bug Report
+ Tool</application> (<command>bug-buddy</command>), available in the
+ <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
+ Menu</guimenu>, for submitting bug reports.
+ </para>
+
+ <para>
+ This manual was written by Dan Mueth
+ (<email>d-mueth@uchicago.edu</email>). Please send all comments and
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://www.gnome.org/gdp">GNOME Documentation Project</ulink>
+ by sending an email to <email>docs@gnome.org</email>. You can also
+ submit comments online by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
+ Table</ulink>.
+ </para>
+
+ <!-- For translations: uncomment this:
+
+ <para>
+ Latin translation was done by ME
+ (<email>MYNAME@MYADDRESS</email>). Please send all comments and
+ suggestions regarding this translation to SOMEWHERE.
+ </para>
+
+ -->
+
+ </sect2>
+
+
+ <!-- ============= Application License ============================= -->
+
+ <sect2 id="license">
+ <title>License</title>
+ <para>
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the <citetitle>GNU General Public
+ License</citetitle> as published by the Free Software Foundation;
+ either version 2 of the License, or (at your option) any later
+ version.
+ </para>
+ <para>
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ <citetitle>GNU General Public License</citetitle> for more details.
+ </para>
+ <para>
+ A copy of the <citetitle>GNU General Public License</citetitle> is
+ included as an appendix to the <citetitle>GNOME Users
+ Guide</citetitle>. You may also obtain a copy of the
+ <citetitle>GNU General Public License</citetitle> from the Free
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
+ <address>
+ Free Software Foundation, Inc.
+ <street>59 Temple Place</street> - Suite 330
+ <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
+ <country>USA</country>
+ </address>
</para>
</sect2>
</sect1>
+
+
+
+
+
diff --git a/sound-monitor/docs/C/sound-monitor_applet.sgml b/sound-monitor/docs/C/sound-monitor_applet.sgml
index 2f7254314..80c62e26e 100644
--- a/sound-monitor/docs/C/sound-monitor_applet.sgml
+++ b/sound-monitor/docs/C/sound-monitor_applet.sgml
@@ -1,48 +1,56 @@
<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN"[
- <!entity soundmonitor.sgml SYSTEM "sound-monitor.sgml">
+ <!entity soundmonitor.sgml SYSTEM "sound-monitor.sgml">
+
]>
-<article id="index">
-
- <artheader>
- <title>Sound Monitor Applet</title>
- <authorgroup>
- <author>
- <firstname>Dan</firstname>
- <surname>Mueth</surname>
- </author>
- </authorgroup>
- <copyright>
- <year>2000</year>
- <holder>Dan Mueth</holder>
- </copyright>
-
- <legalnotice>
- <para>
- Permission is granted to copy, distribute and/or modify this
- document under the terms of the GNU Free Documentation License,
- Version 1.1 or any later version published by the Free Software
- Foundation; with no Invariant Sections, with no Front-Cover
- Texts, and with no Back-Cover Texts. A copy of the license is
- available from the GNU Foundation and can be viewed <ulink
- url="http://www.gnu.org/copyleft/fdl.html"
- type="http">online</ulink>.
- </para>
-
- <para> UNIX is a trademark of X/Open Group.</para> <para> Linux
- is a trademark of Linus Torvalds.</para> <para> X Window System
- is a trademark of X Consortium, Inc.</para> <para> Windows is a
- trademark of Microsoft Corp.</para>
- </legalnotice>
-
- <releaseinfo>
- This is version 0.9 of the Sound Monitor manual.
- </releaseinfo>
- </artheader>
-
- &soundmonitor.sgml;
-</article>
+<article id="index"> <!-- please do not change the id -->
+
+ <!-- ============= Document Header ============================= -->
+ <artheader>
+ <title>Sound Monitor Applet</title>
+ <copyright>
+ <year>2000</year>
+ <holder>Dan Mueth</holder>
+ </copyright>
+
+ <!-- translators: uncomment this:
+
+ <copyright>
+ <year>2000</year>
+ <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+ </copyright>
+
+ -->
+
+ <!-- do not put authorname in the header except in copyright - use
+ section "authors" below -->
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the <citetitle>GNU Free Documentation
+ License</citetitle>, Version 1.1 or any later version published
+ by the Free Software Foundation with no Invariant Sections, no
+ Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy
+ of the <citetitle>GNU Free Documentation License</citetitle> from
+ the Free Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to:
+ Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ Boston, MA 02111-1307, USA.
+ </para>
+
+ </legalnotice>
+
+ <releaseinfo>
+ This is version 1.0 of the Sound Monitor applet manual.
+ </releaseinfo>
+ </artheader>
+
+ <!-- ============= Document Body ============================= -->
+
+ &soundmonitor.sgml;
+
+</article>