diff options
Diffstat (limited to 'gnome-users-guide/gnome-users-guide-1.4/C/applets')
38 files changed, 12481 insertions, 0 deletions
diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/anotherclock-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/anotherclock-ug.sgml new file mode 100644 index 0000000..2382e9c --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/anotherclock-ug.sgml @@ -0,0 +1,247 @@ + <sect2 id="anotherclock"> + <title>Another Clock</title> + <para> + <application>Another Clock</application> applet, shown in <xref + linkend="anotherclock-applet">, is a simple analog clock (similar + to that in the CDE, Common Desktop Environment, panel). To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Clocks</guisubmenu> + <guimenuitem>Another Clock</guimenuitem> + </menuchoice>. + </para> + + <figure id="anotherclock-applet"> + <title>Another Clock Applet</title> + <screenshot> + <screeninfo>Another Clock Applet</screeninfo> + <graphic format="png" fileref="figures/anotherclock-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="anotherclock-usage"> + <title>Usage</title> + <para> + You don't need to do anything special to this clock. It will just + sit on your panel and tell the time for you. + </para> + + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="anotherclock-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Another Clock + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="anotherclock-prefs"> + <title>Customization</title> + <para> + You can customize <application>Another Clock</application> by + right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="anotherclock-settings-fig">), which allows you to + change various settings. + </para> + + + <figure id="anotherclock-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/anotherclock-properties" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The properties are: + <itemizedlist> + + <listitem> + <para> + Clock color — This is currently greyed-out, but in the + future it will be possible to adjust the colour of the clockface. + </para> + </listitem> + + <listitem> + <para> + Hour needle color — Set this to the color you wish to + use for the hour needle (hand) of the clock. + </para> + </listitem> + + <listitem> + <para> + Minute needle color — Set this to the color you wish to + use for the minute needle (hand) of the clock. + </para> + </listitem> + + <listitem> + <para> + Second needle color — Set this to the color you wish to + use for the second needle (hand) of the clock. + </para> + </listitem> + + <listitem> + <para> + Show seconds needle — If this button is checked, the + second needle (hand) of the clock will be shown. + </para> + </listitem> + + </itemizedlist> + </para> + + <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> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="anotherclock-bugs"> + <title>Known Bugs and Limitations</title> + <orderedlist> +<!-- <listitem> Jacob says this should be fixed with GTK+-1.2.7. + <para> + You can't change the time through the clock properties. This + is not really a bug; it's because you must be root to alter + the time for the whole of the system, using the <command> + date</command> command. + </para> + </listitem>--> + <listitem> + <para> + If you adjust the system clock backwards using the <command> + date</command> command, the clock will stop working until the + system time reaches the time the clock displays. It will start + working normally then. + </para> + </listitem> + </orderedlist> + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="anotherclock-authors"> + <title>Authors</title> + <para> + <application>Another Clock</application> was written by + Iñigo Serna (<email>inigo@gazletan.bi.ehu.es</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 Telsa Gwynne (<email>telsa@linuxchix.org</email>) + and Eric Baudais (<email>baudais@okstate.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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <ulink type="help" url="gnome-help:gpl"> + <citetitle>GNU General Public License</citetitle></ulink> 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> + You may 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> + </sect3> + + --> + </sect2> + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/applet2ug b/gnome-users-guide/gnome-users-guide-1.4/C/applets/applet2ug new file mode 100755 index 0000000..c1c2be5 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/applet2ug @@ -0,0 +1,42 @@ +#!/usr/bin/perl -w +# +# THIS SCRIPT CHANGES THE SECTION LABELLING +# +# example input name: sound-monitor or sound-monitor.sgml +# example output name: sound-monitor.sgml.ug +# + +$_ = shift @ARGV; +s/.sgml//; +$basename=$_; +$infilename=$basename . ".sgml"; +$outfilename=$basename . "-ug.sgml"; + +print ("Reading: $infilename\n"); +open (IN,$infilename) || die "can't open file: $!"; +print ("Writing: $outfilename\n"); +open (OUT,">$outfilename") || die "can't open file for writing: $!"; + +while (<IN>) { + # Now comment out the license + s/<sect2 id="license">/<!-- + <sect2 id="license">/; + s/<\/sect1>/--> + <\/sect1>/; + + # Start by substituting sections (sect4->sect5, sect3->sect4, ...) + s/sect4/sect5/; + s/sect3/sect4/; + s/sect2/sect3/; + s/sect1/sect2/; + + # Now try to pluck out any id's which could be problematic + s/id="authors"/id="$basename-authors"/; + s/id="bugs"/id="$basename-bugs"/; + s/id="prefs"/id="$basename-prefs"/; + s/id="usage"/id="$basename-usage"/; + + print OUT $_; +} +close (IN) || die "can't close $infilename: $!"; +close (OUT) || die "can't close $outfilename: $!"; diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/asclock-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/asclock-ug.sgml new file mode 100644 index 0000000..f832445 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/asclock-ug.sgml @@ -0,0 +1,260 @@ + <sect2 id="asclock"> + <title>AfterStep Clock Applet</title> + + <para> + The <application>AfterStep Clock</application> applet, shown in <xref + linkend="asclock-applet-fig">, is an applet which + displays the time in both analogue (clockface) and digital format + along with the day of the week and the date. It is based on the look + of the NeXTStep clock. This document describes version 2.1.10 of + <application>AfterStep Clock</application>. + </para> + <para> + To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Clocks</guisubmenu> + <guimenuitem>AfterStep Clock</guimenuitem> + </menuchoice>. + </para> + + <figure id="asclock-applet-fig"> + <title>AfterStep Clock Applet</title> + <screenshot> + <screeninfo>AfterStep Clock Applet</screeninfo> + <graphic format="png" fileref="figures/asclock_applet" + srccredit="Aaron Weber"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="asclock-usage"> + <title>Usage</title> + <para> + You don't need to do anything special to this clock. It will just + sit on your panel and tell you the time and date. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="asclock-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>ASClock + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="asclock-prefs"> + <title>Customization</title> + <para> + You can customize <application>AfterStep Clock</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="asclock-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="asclock-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/asclock_settings" + srccredit="Aaron Weber"> + </graphic> + </screenshot> + </figure> + + <para> + Your properties in the <guilabel>General</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Display time in 12 hour format (AM/PM) — Clicking this + will display the time in a 12 hour format. The default state, + off, uses a 24-hour clock. + </para> + </listitem> + + <listitem> + <para> + Blinking elements in clock — When the + <application>AfterStep clock applet</application> starts + up, by default it displays a blinking colon between the hour and + minute display. Clicking this turns this blinking off. + </para> + </listitem> + + <listitem> + <para> + Clock theme — The <application>AS Clock</application> + applet can take on a number of different appearances. Select + the theme (appearance) from this list. + </para> + </listitem> + + </itemizedlist> + </para> + + + <para> + The <guilabel>Timezone</guilabel> tab is used to specify your + timezone. Select the continent and city your are in or closest + to. + </para> + + <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> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="asclock-bugs"> + <title>Known Bugs and Limitations</title> + <para> + You can't change the time through the clock properties. This + is not really a bug; it's because you must be root to alter + the time for the whole of the system, using the <command> + date</command> command. + </para> + <para> + If you adjust the system clock backwards using the <command> + date</command> command, the clock will stop working until the + system time reaches the time the clock displays. It will start + working normally then. + </para> + <para> + Switching between a lot of themes or a lot of timezones seems + to use up inordinate amounts of memory. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="asclock-authors"> + <title>Authors</title> + + + <para> + The <application>AfterStep Clock applet</application> was written + by Beat Christen (<email>spiff@longstreet.ch</email>) and + Patrick Rogan (<email>rogan@lycos.com</email>). + Please send all comments, suggestions, and bug + reports regarding the software 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 Telsa Gwynne + (<email>hobbit@aloss.ukuu.org.uk</email>) and Aaron Weber + (<email>aaron@helixcode.com</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/battery-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/battery-ug.sgml new file mode 100644 index 0000000..ea30472 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/battery-ug.sgml @@ -0,0 +1,540 @@ + <!-- ############### Battery Charge Monitor ############### --> + <sect2 id="Battery-Charge-Monitor"> + <title>Battery Charge Monitor Applet</title> + + <para> + <application>Battery Charge Monitor</application> applet, shown in <link + linkend="Battery-Charge-Monitor-fig1">Figure 1</link>, displays the + charge status of your portable computer battery. To learn how to + add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Monitors</guisubmenu> + <guimenuitem>Battery Charge Monitor</guimenuitem> + </menuchoice>. + </para> + + <note> + <para> + In order for <application>Battery Charge + Monitor</application> to function correctly, your computer must + have been configured to support <systemitem>Advanced Power + Management</systemitem>. + </para> + </note> + + <figure id="Battery-Charge-Monitor-fig1"> + <title>Battery Charge Monitor</title> + <screenshot> + <screeninfo>Battery Charge Monitor</screeninfo> + <graphic format="png" fileref="figures/battery-applet-ac-offline-25-20" + srccredit="James Cope"> + </graphic> + </screenshot> + </figure> + + <sect3 id="Battery-Charge-Monitor-usage"> + <title>Usage</title> + <para> + <application>Battery Charge Monitor</application> just sits in + your panel monitoring the status of your computer battery. By + <mousebutton>left</mousebutton>-clicking on the applet you can + toggle the view between Readout View and Graph View described in the + <link linkend="Battery-Charge-Monitor-Readout-sec">Readout View</link> + and <link linkend="Battery-Charge-Monitor-Graph-sec">Graph View</link> + sections respectively. + </para> + + <sect4 id="Battery-Charge-Monitor-Readout-sec"> + <title>Readout View</title> + <para> + Readout View, the default mode of view, displays the current + battery status in an iconic and textual format. In this mode + <application>Battery Charge Monitor</application> displays + the following information: + </para> + + <variablelist> + <varlistentry> + <term><emphasis>Battery Icon</emphasis></term> + <listitem> + <para> + The iconic representation of a battery on the left of the + applet, shows how fully charged your battery is + currently. The coloured area of the battery represents the + ammount of charge left in your battery, with the top of the + battery representing 100% charged. + </para> + + <para> + The colour of the battery changes when the charge drops below + the current <guilabel>Low Charge Threshold</guilabel> (see + <link linkend="Battery-Charge-Monitor-properties-general">Properties — + General</link>). The default colour of the battery is green in a normal state and + red when it drops below the <guilabel>Low Charge Threshold</guilabel>. + </para> + + <para> + When your computer is attached to the power supply, a + small lightning bolt appears on the battery representation to + indicate that the battery is attached to the power supply + and is in a charging state. An example of this is shown in + <link linkend="Battery-Charge-Monitor-fig2">Figure 2</link>. + You can also configure the battery to change colour when it is or isn't + connected to the power supply, see + <link linkend="Battery-Charge-Monitor-properties-readout"> + Properties — Readout</link> for further details on this feature. + </para> + + <figure id="Battery-Charge-Monitor-fig2"> + <title>Battery Charge Monitor with the power supply connected</title> + <screenshot> + <screeninfo>Battery Charge Monitor</screeninfo> + <graphic format="png" + fileref="figures/battery-applet-ac-online-25-20" + srccredit="James Cope"> + </graphic> + </screenshot> + </figure> + + </listitem> + </varlistentry> + + <varlistentry> + <term><emphasis>Percentage Remaining</emphasis></term> + <listitem> + <para> + The percentage readout on the top right of the applet + represents how fully charged your computer battery is currently. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><emphasis>Time Remaining</emphasis></term> + <listitem> + <para> + The time remaining readout on the bottom right of the applet + shows how much running time the battery has left. The time is + shown in hours and minutes. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect4> + + <sect4 id="Battery-Charge-Monitor-Graph-sec"> + <title>Graph View</title> + <para> + Graph View displays the percentage of charge remaining in your + battery as a moving graph. The horizontal axis represents time + and the vertical axis represents charge percentage with 100% + charged being the top of the graph. By default the graph is + green when your computer is connected to the power supply and + blue when it isn't. The graph also changes colour when the + charge drops below the <guilabel>Low Charge Threshold</guilabel> + (see <link linkend="Battery-Charge-Monitor-properties-general"> + Properties — General</link>) the default colour in this case is red. + </para> + + <figure> + <title>Battery Charge Monitor in Graph View</title> + <screenshot> + <screeninfo>Battery Charge Monitor in Graph View</screeninfo> + <graphic format="png" + fileref="figures/battery-applet-graph" + srccredit="James Cope"> + </graphic> + </screenshot> + </figure> + </sect4> + </sect3> + + <sect3 id="Battery-Charge-Monitor-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items, the right-click pop-up menu has + the following item: + <itemizedlist> + <listitem> + <para> + <guimenuitem>Properties...</guimenuitem> — This menu + item opens the <interface>Properties</interface> dialog (see + <link linkend="Battery-Charge-Monitor-properties">Properties</link>) + which allows you to customize the appearance and behavior of this applet. + </para> + </listitem> + </itemizedlist> + </para> + </sect3> + + <sect3 id="Battery-Charge-Monitor-properties"> + <title>Properties</title> + <para> + You can configure <application>Battery Charge + Monitor</application> applet by right-clicking on the applet and + choosing the <guimenuitem>Properties...</guimenuitem> menu + item. This will open the <interface>Properties</interface> + dialog, with four groups of configurable items arranged in the + following tabbed pages: + <link + linkend="Battery-Charge-Monitor-properties-general">General</link>, + <link + linkend="Battery-Charge-Monitor-properties-readout">Readout</link>, + <link + linkend="Battery-Charge-Monitor-properties-graph">Graph</link> and + <link linkend="Battery-Charge-Monitor-properties-messages">Battery + Charge Messages</link>. + </para> + + <sect4 id="Battery-Charge-Monitor-properties-general"> + <title>Properties — General</title> + + <figure id="Battery-Charge-Monitor-properties-fig1"> + <title>Properties Dialogue — General</title> + <screenshot> + <screeninfo>Properties Dialogue — General</screeninfo> + <graphic format="png" + fileref="figures/battery-applet-properties-general" + srccredit="James Cope"> + </graphic> + </screenshot> + </figure> + + <itemizedlist> + <listitem> + <para> + <guilabel>Follow Panel Size</guilabel> — instructs + <application>Battery Charge Monitor</application> to resize + when the panel changes size. It is checked on by default. In + order for <guilabel>Applet Height</guilabel> and + <guilabel>Applet Width</guilabel> settings to take affect, it + must be unchecked. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Applet Height & Applet Width</guilabel> — + these two spin buttons allow you to specify the dimensions + of <application>Battery Charge Monitor</application> exactly + in pixels. In order for these settings to take affect, + <guilabel>Follow Panel Size</guilabel> must be unchecked. The + default values are both set to 48. + </para> + + <note> + <para> + Setting these values very small (below 28 pixels) + results in the battery icon not being displayed due to lack + of space. + </para> + </note> + </listitem> + + <listitem> + <para> + <guilabel>Update Interval</guilabel> — specifies in + seconds how often <application>Battery Charge + Monitor</application> refreshes the battery charge + information it displays. The default setting is two seconds. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Low Charge Threshold</guilabel> — is a + percentage value of the battery charge that + <application>Battery Charge Monitor</application> uses to + optionally display a warning, it then considers the battery to + have little power remaining. For example this information is + used to decide when to change the colour of the battery icon in + Readout View. The default value is 25. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Applet Mode</guilabel> — the two + <guibutton>Readout</guibutton> and + <guibutton>Graph</guibutton> checkboxes are another way of + toggling between <link linkend="Battery-Charge-Monitor-Readout-sec"> + Readout View</link> and <link linkend="Battery-Charge-Monitor-Graph-sec"> + Graph View</link>. + </para> + </listitem> + </itemizedlist> + </sect4> + + <sect4 id="Battery-Charge-Monitor-properties-readout"> + <title>Properties — Readout</title> + + <para> + The settings on this tab only affect <application>Battery Charge + Monitor</application> when it is in <link linkend="Battery-Charge-Monitor-Readout-sec"> + Readout View</link>. + </para> + + <para> + All of the coloured rectangles on this tab can be + <mousebutton>left</mousebutton> clicked on to display the GNOME + colour wheel. This enables you to choose colours that you may + prefer more than the defaults. + </para> + + <figure id="Battery-Charge-Monitor-properties-fig2"> + <title>Properties Dialogue — Readout</title> + <screenshot> + <screeninfo>Properties Dialogue — Readout</screeninfo> + <graphic format="png" + fileref="figures/battery-applet-properties-readout" srccredit="James + Cope"></graphic> + </screenshot> + </figure> + + <itemizedlist> + <listitem> + <para> + <guilabel>AC-On Battery Color</guilabel> — specifies the + colour of the battery icon in Readout view when your computer + is connected to the AC power supply. The default colour is + green. + </para> + </listitem> + + <listitem> + <para> + <guilabel>AC-Off Battery Color</guilabel> — specifies + the colour of the battery icon in Readout View when your + computer is not connected to the AC power supply. The default + colour is green. + </para> + </listitem> + + + <listitem> + <para> + <guilabel>Low Battery Color</guilabel> — specifies the + colour of the battery icon in Readout View when the charge + percentage rate drops below the <guilabel>Low Charge + Threshold</guilabel> (see <link + linkend="Battery-Charge-Monitor-properties-general">Properties + — General</link>). The default colour is red. + </para> + </listitem> + </itemizedlist> + </sect4> + + <sect4 id="Battery-Charge-Monitor-properties-graph"> + <title>Properties — Graph</title> + + <para> + The settings on this tab only affect <application>Battery Charge + Monitor</application> when it is in <link linkend="Battery-Charge-Monitor-Graph-sec"> + Graph View</link>. + </para> + + <para> All of the coloured rectangles on this tab can be + <mousebutton>left</mousebutton> clicked on to display the GNOME + colour wheel. This enables you to choose colours that you may + prefer more than the defaults. + </para> + + <figure id="Battery-Charge-Monitor-properties-fig3"> + <title>Properties Dialogue — Graph</title> + <screenshot> + <screeninfo>Properties Dialogue — Graph</screeninfo> + <graphic format="png" + fileref="figures/battery-applet-properties-graph" srccredit="James + Cope"></graphic> + </screenshot> + </figure> + + + <itemizedlist> + <listitem> + <para> + <guilabel>AC-On Battery Color</guilabel> — + specifies the colour of the graph when your computer is + connected to the AC power supply. The default colour is + green. + </para> + </listitem> + + <listitem> + <para> + <guilabel>AC-Off Battery Color</guilabel> &mdash: specifies + the colour of the graph when your computer is not connected to + the AC power supply. The default colour is blue. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Graph Battery Low Color</guilabel> — specifies + the colour of the graph when the charge percentage rate drops + below the <guilabel>Low Charge Threshold</guilabel>. The + default colour is red. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Graph Tick Color</guilabel> — specifies the + colour of the graph division lines on the graph which mark the + 25%, 50% and 75% charge points. The default colour is dark + grey. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Graph Direction</guilabel> — + specifies which direction the graph moves over time. The + default direction is <guilabel>Right to Left</guilabel>. + </para> + </listitem> + </itemizedlist> + </sect4> + + <sect4 id="Battery-Charge-Monitor-properties-messages"> + <title>Properties — Battery Charge Messages</title> + + <figure id="Battery-Charge-Monitor-properties-fig4"> + <title>Properties Dialogue — Battery Charge + Messages</title> + <screenshot> + <screeninfo>Properties Dialogue — Battery Charge + Messages</screeninfo> + <graphic format="png" + fileref="figures/battery-applet-properties-messages" srccredit="James + Cope"></graphic> + </screenshot> + </figure> + + <itemizedlist> + <listitem> + <para> + <guilabel>Warn in the battery charge dips below</guilabel> + — specifies the charge percentage at which + <application>Battery Charge Monitor</application> shows a + warning dialogue box that the battery is at a low charge. This + warning is only displayed if <guilabel>Enable Low Battery + Warning</guilabel> is checked. The default setting is 5%. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Enable Low Battery Warning</guilabel> — + specifies if <application>Battery Charge Monitor</application> + should display a dialogue box warning that the battery charge + has dropped below the charge percentage specified in the + <guilabel>Warn if the battery charge dips below</guilabel> + setting. The default value is checked. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Enable Full-Charge Notification</guilabel> — + specifies if <application>Battery Charge + Monitor</application> should display a dialogue box when the + battery has reached its 100% charged rate. The default value + is unchecked. + </para> + </listitem> + </itemizedlist> + </sect4> +<!-- Not needed in for 1.x applets + <sect4> + <title>Further Information</title> + <para> + For more information on the <interface>Properties</interface> + dialog, including descriptions of the <guibutton>OK</guibutton>, + <guibutton>Apply</guibutton>, <guibutton>Close</guibutton>, and + <guibutton>Help</guibutton> buttons, see <xref + linkend="applet-properties-dialog">. + </para> + </sect4> +--> + </sect3> + + <sect3 id="Battery-Charge-Monitor-bugs"> + <title> Known Bugs and Limitations</title> + <para> + One oddity is if you start <application>Battery Charge + Monitor</application> on a computer that has no Advanced Power + Management support. This causes the <guilabel>Low Battery + Warning</guilabel> dialogue box to be displayed which may be + mis-leading. + </para> + </sect3> + + <sect3 id="Battery-Charge-Monitor-authors"> + <title>Authors</title> + <para> + This applet was writen by Nat Friedman + <email>nat@nat.org</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> + The documentation for this applet + which you are reading now was written by + James Cope <email>jcope@bcs.org.uk</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> + </sect3> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/cdplayer-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/cdplayer-ug.sgml new file mode 100644 index 0000000..d0a540e --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/cdplayer-ug.sgml @@ -0,0 +1,170 @@ + <sect2 id="cdplayerapplet"> + <title>CD Player Applet</title> + + <para> + <application>CD Player Applet</application>, shown in <xref + linkend="cdplayerapplet-fig">, allows you to play CD's from a + <interface>Panel</interface>. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Multimedia</guisubmenu> + <guimenuitem>CD Player</guimenuitem> + </menuchoice>. + </para> + + <figure id="cdplayerapplet-fig"> + <title>CD Player Applet</title> + <screenshot> + <screeninfo>CD Player Applet</screeninfo> + <graphic format="png" fileref="figures/cdplayer_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="cdplayer-usage"> + <title>Usage</title> + <para> + This applet is used to unobtrusively play and control CD's while you + get real work done or play + <application>FreeCell</application>. To use it, just press the + small buttons in the applet like you would on any CD player. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Run CD Player…</guimenuitem> — + starts the <application>GNOME CD Player</application>, which + has more features than the <application>CD Player + Applet</application> such as automatically downloading CD track + information from a CDDB server, volume control, and title/track + display. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>CD Player + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="cdplayer-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="cdplayer-authors"> + <title>Authors</title> + <para> + <application>CD Player Applet</application> was written by Tim Gerla + (<email>timg@means.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 Chris Lyttle + (<email>chris@wilddev.net</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/charpick-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/charpick-ug.sgml new file mode 100644 index 0000000..32f6a85 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/charpick-ug.sgml @@ -0,0 +1,342 @@ + <sect2 id="charpickapplet"> + <title>Character Picker Applet</title> + + <para> + <application>Character Picker</application> applet, shown in <xref + linkend="charpickapplet-fig">, allows you to easily write many + characters which are not available on standard keyboards such as + accented characters, certain mathemathical symbols and punctuation, + and some other special symbols. To add this applet to a + <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Character Picker</guimenuitem> + </menuchoice>. + </para> + + <figure id="charpickapplet-fig"> + <title>Character Picker Applet</title> + <screenshot> + <screeninfo>Character Picker Applet</screeninfo> + <graphic format="png" fileref="figures/charpick_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="charpickapplet-usage"> + <title>Usage</title> + <para> + First, bring the cursor focus to the <application>Character + Picker</application> applet by left-clicking on one of the + characters displayed in the applet. Specify the character group + by pressing the corresponding key on your keyboard. (For a + complete list of the character groups and corresponding keys, see + <xref linkend="charpickapplet-characters">.) For example, + to see the various accented versions of the "a" letter, press + "a". After you have found the correct letter or symbol, + left-click on it to copy the symbol into the buffer. The + character should appear as a depressed button. This is similar to + the common Copy command available in many programs. To paste the + symbol in any window, just click in the window with the middle + mouse button. Most applications which have Copy and Paste + features will also allow you to paste the symbol using its Paste + command. + </para> + + <note> + <title>ISO-8859-1 (Latin-1) character support</title> + <para> + Note that some applications do not support ISO-8859-1 + characters. These applications will not display some characters + from the <application>Character Picker</application> applet. + </para> + </note> + + <note> + <title>Cut and Paste in X</title> + <para> + The X Windows system allows you to copy and paste text by + highlighting it with the first mouse button to copy the text and + then pasting the text by pressing the middle mouse button. + Note that <application>Character Picker</application> uses the + same copy buffer as X uses. Thus, when you + select a character in the <application>Character + Picker</application> it replaces any previous text in the buffer + from highlighting text. Similarly, if you have selected a + character in <application>Character Picker</application> and then + highlight text, the highlighted text will replace the character + in the buffer and the character's button will no longer appear + depressed. + </para> + </note> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="charpickapplet-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Character Picker + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="charpickapplet-prefs"> + <title>Customization</title> + <para> + You can customize <application>Character Picker</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="charpickapplet-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="charpickapplet-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/charpick_applet_settings" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The properties in the <guilabel>Size</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + <guibutton>Follow panel size</guibutton> — If this + button is checked, the + <application>Character Picker</application> applet will + automatically set the appropriate number of columns and rows + of characters to fit in the <interface>Panel</interface>. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Minimum number of cells</guilabel>: (for autosize) + — This sets the + minimum number of character buttons (or "cells") which will be + shown. The actual number of character buttons may exceed this + number, depending upon the <interface>Panel</interface> size + and number chosen. Note that if this number is too small, + some characters may not be visible. (This variable does not + influence the cell layout if the <guibutton>Follow panel + size</guibutton> button is not selected.) + </para> + </listitem> + + <listitem> + <para> + <guilabel>Number of rows of buttons</guilabel>: — This + determines the number + of rows of character buttons (or "cells") that appear in the + applet. (This variable does not influence the cell layout if + the <guibutton>Follow panel size</guibutton> button is selected.) + </para> + </listitem> + + <listitem> + <para> + <guilabel>Number of columns of buttons</guilabel>: — + This determines the number + of columns of character buttons (or "cells") that appear in the + applet. (This variable does not influence the cell layout if + the <guibutton>Follow panel size</guibutton> button is selected.) + </para> + </listitem> + + <listitem> + <para> + <guilabel>Size of button</guilabel>: (pixels) — This is + the size (in pixels) + of each character button in the applet. + </para> + </listitem> + + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Default List</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + <guilabel>Default character list</guilabel> — This is + the list of characters + which will be shown in the applet when you press the space + bar. This is a convenient way to keep a list of your most + frequently used characters. Just enter your most frequently + used characters here. + </para> + </listitem> + + </itemizedlist> + </para> + + <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. Click + <guibutton>Apply</guibutton> to apply changes without closing. + <guibutton>Close</guibutton> closes + <interface>Properties</interface> without saving changes which + have not been applied. Applied changes cannot be cancelled. + </para> + </sect3> + + <!-- ============= Characters ================================== --> + <sect3 id="charpickapplet-characters"> + <title>Characters</title> + <para> + <application>Character Picker</application> applet has all + the characters from the + ISO-8859-1(Latin 1) character set which are not on standard US + keyboards. They are mapped onto the standard characters as shown in + <xref linkend="charpickapplet-characters-fig">. The bold + characters in the first column of each half and to the left of the + dotted lines are the characters you + must type in the <application>Character Picker</application> + applet to obtain + the corresponding characters shown to the right. + </para> + <figure id="charpickapplet-characters-fig"> + <title>Character Picker's Character Key</title> + <screenshot> + <screeninfo>Character Picker's Character Key</screeninfo> + <graphic format="png" fileref="figures/charpick_characters.png" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="charpickapplet-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="charpickapplet-authors"> + <title>Authors</title> + <para> + <application>Character Picker</application> was written by Alexandre Muñiz + (<email>munizao@xprt.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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/clock-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/clock-ug.sgml new file mode 100644 index 0000000..9968693 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/clock-ug.sgml @@ -0,0 +1,265 @@ + <sect2 id="clock"> + <title>Clock Applet</title> + + <para> + <application>Clock</application> applet, shown in <xref + linkend="clockapplet-fig">, is a simple applet which shows the + time (and optionally the date too) in any of several formats. To + add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Clocks</guisubmenu> + <guimenuitem>Clock</guimenuitem> + </menuchoice>. + </para> + + <figure id="clockapplet-fig"> + <title>Clock Applet</title> + <screenshot> + <screeninfo>Clock Applet</screeninfo> + <graphic format="png" fileref="figures/clock_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="clock-usage"> + <title>Usage</title> + <para> + <application>Clock</application> applet requires no user + input. You may optionally configure it, as described below. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="clock-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Clock + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="clock-prefs"> + <title>Customization</title> + <para> + You can customize <application>Clock</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="clock-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="clock-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/clock_settings" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The properties are: + <itemizedlist> + + <listitem> + <para> + Time Format — Select either <guilabel>12 hour</guilabel> + format for <quote>AM/PM</quote> formatted time, or + <guilabel>24 hour</guilabel> for a 24 hour clock. + </para> + </listitem> + + <listitem> + <para> + Show date in applet — Select this to show the date + inside the applet. + </para> + </listitem> + + <listitem> + <para> + Show date in tooltip — Select this to show the date in + the tooltip that pops up when the mouse is briefly left over + the applet. + </para> + </listitem> + + <listitem> + <para> + Use GMT — Select this to show the Greenwich Mean Time + instead of the local time. + </para> + </listitem> + + <listitem> + <para> + Unix time — Select this to show the time, in seconds, + that has elapsed since Jan 1, 1970. + </para> + </listitem> + + </itemizedlist> + </para> + + <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>Close</guibutton> button. + </para> + + <note> + <title>Setting the Time</title> + <para> + <application>Clock</application> applet only displays the time; + it does not allow you to set the time. In order to set the time + on a Unix or Linux system, you should use the + <command>date</command> command. For example, to set the time to + 11:43:01PM and the date to April 4, use <command>date --set="Apr + 4 23:43:01"</command>. Note that you must be logged in as root to + set the time. More information about the <command>date</command> command is + available from the <ulink type="man" url="man:date">date manual page</ulink>. + You may set your timezone using the <command>timeconfig</command> or + <command>tzselect</command> commands on some Linux + distributions. + </para> + </note> + + </sect3> + + + <!-- ============= 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 --> + <sect3 id="clock-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="clock-authors"> + <title>Authors</title> + <para> + <application>Clock</application> was written by Miguel de Icaza + (<email>miguel@kernel.org</email>), Federico Mena + (<email>quartic@gimp.org</email>), and Stuart Parmenter + (<email>pavlov@innerx.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://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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 + <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General + Public License</citetitle></ulink> for more details. + </para> + <para> + A copy of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> is included with the GNOME + documentation. You may also obtain a copy of the <ulink + type="help" url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/clockmail-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/clockmail-ug.sgml new file mode 100644 index 0000000..6c17602 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/clockmail-ug.sgml @@ -0,0 +1,343 @@ + <sect2 id="clockmail"> + <title>Clock and Mailcheck Applet</title> + + <para> + <application>Clock and Mailcheck</application> applet, shown in <xref + linkend="clockmailapplet-fig">, displays the current time and how + much mail is in your mailbox. It also notifies you when new mail + arrives by flashing. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Clocks</guisubmenu> + <guimenuitem>Clock and Mailcheck</guimenuitem> + </menuchoice>. + </para> + + <figure id="clockmailapplet-fig"> + <title>Clock and Mailcheck Applet</title> + <screenshot> + <screeninfo>Clock and Mailcheck Applet</screeninfo> + <graphic format="png" fileref="figures/clockmail_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + + <!-- ============= Usage ================================ --> + <sect3 id="clockmail-usage"> + <title>Usage</title> + <para> + View the time and number of messages in your inbox in the applet's + display. The envelope will flash when new email arrives. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="clockmail-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Clock and Mailcheck + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="clockmail-prefs"> + <title>Customization</title> + <para> + You can customize <application>Clock and Mailcheck</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="clockmail-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="clockmail-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/clockmail-prefs-general" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The <interface>Properties</interface> dialogue is divided in two + sections, one for general options and one for themes. + </para> + + <para> + The properties in the <guilabel>General</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Display time in 12 hours format (AM/PM) — Check this + button to show the time in 12-hour format. + </para> + </listitem> + + <listitem> + <para> + Display time relative to GMT (Greenwich Mean Time) — + This allows you to change the timezone + <application>Clock and Mailcheck</application> + uses. The time can be anything from twelve hours + ahead of GMT to twelve hours behind it. Remember also to select + the <guibutton>checkbox</guibutton>, to use the new + timezone. Note that you can only alter the + time by an integral number of hours. + </para> + </listitem> + + <listitem> + <para> + Mail file — Enter you email inbox file which should be + checked for new mail. Typically, this is + <filename>/var/spool/mail/yourusername</filename> + or something similar. You can only enter one file. + </para> + </listitem> + + <listitem> + <para> + When new mail is received, run... — It is possible to + execute commands when new mail arrives. + For example, it is very common for people to have a sound + file played as mail arrives. You can put the command to + run and the file to run it on in this space and ensure the + checkbox is checked for it to occur. + If you have more than one command, you can separate them + by a semi-colon. For example, + <itemizedlist> + <listitem> + <para> + <command>esdplay /full/path/to/file.wav</command> + </para> + </listitem> + <listitem> + <para> + <command>cd /path/to/directory ; esdplay file.wav</command> + </para> + </listitem> + </itemizedlist> + These two have the same effect. You will need the full path + for this, without using shortcuts such as <command>cd ~</command>. + </para> + </listitem> + + <listitem> + <para> + Always blink when new mail is waiting — If you select + this <guibutton>checkbox</guibutton>, then the + red envelope will blink until you read your unread email. Normally, + this is off, and the blinking lasts only a few seconds. + </para> + </listitem> + + <listitem> + <para> + Number of messages to consider mailbox full — Set the + number of messages you mailbox must have to be considered + <quote>full</quote>. Certain themes will show a special + symbol indicating the mailbox is full. + </para> + </listitem> + + <listitem> + <para> + When clicked, run... — When this is set, clicking + the left mouse button on the applet will run a program. The default is + to run the <application>Balsa</application> mail client. (If + <application>Balsa</application> is not installed, nothing + will happen.) Set this to be your favorite email program. + </para> + </listitem> + + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Theme</guilabel> tab allows you + to set the appearance of <application>Clock and + Mailcheck</application> applet. <application>Clock and + Mailcheck</application> applet comes with many themes which are + stored in <filename>$PREFIX/clockmail/</filename>. By + default, it does not use a theme. Note that not all of the themes + show both the time and the state of your mailbox. + </para> + + <figure id="clockmail-settings-theme-fig"> + <title>Properties dialog showing theme tab</title> + <screenshot> + <screeninfo>Properties dialog showing theme tab</screeninfo> + <graphic format="png" fileref="figures/clockmail-prefs-theme" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <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> + </sect3> + + <!-- ============= 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 --> + <sect3 id="clockmail-bugs"> + <title>Known Bugs and Limitations</title> + <orderedlist> + <listitem> + <para> + You can't change the time through the clock properties. This + is not really a bug; it's because you must be root to alter + the time for the whole of the system, using the <command> + date</command> command. + </para> + </listitem> + <listitem> + <para> + If you adjust the system clock backwards using the <command> + date</command> command, the clock will stop working until the + system time reaches the time the clock displays. It will start + working normally then. + </para> + </listitem> + <listitem> + <para> + The mailcounter theme gets the number of messages in your inbox + wrong. + </para> + </listitem> + <listitem> + <para> + Several themes do not reshape to the size of a vertical panel and + force the panel to be wider. + </para> + </listitem> + <listitem> + <para> + Doesn't handle multiple mailboxes. + </para> + </listitem> + </orderedlist> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="clockmail-authors"> + <title>Authors</title> + <para> + <application>ClockMail</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 Telsa Gywnne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/cpuload-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/cpuload-ug.sgml new file mode 100644 index 0000000..e4a973d --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/cpuload-ug.sgml @@ -0,0 +1,319 @@ +<!-- Permission is granted to make and distribute verbatim copies of --> +<!-- this manual provided the copyright notice and this permission --> +<!-- notice are preserved on all copies. --> +<!-- --> +<!-- Permission is granted to copy and distribute modified versions of --> +<!-- this manual under the conditions for verbatim copying, provided --> +<!-- that the entire resulting derived work is distributed under the --> +<!-- terms of a permission notice identical to this one. --> +<!-- --> +<!-- Permission is granted to copy and distribute translations of this --> +<!-- manual into another language, under the above conditions for --> +<!-- modified versions, except that this permission notice may be --> +<!-- stated in a translation approved by the Foundation. --> + + <sect2 id="cpuload-applet"> + <title>The CPU load applet</title> + + <para> + The <application>cpuload_applet</application> is a small monitor + applet which sits in your panel and tells you how much CPU is + being used. + </para> + + <sect3 id="cpuload-usage"> + <title>Usage</title> + <para> + You don't need to do anything to this applet. It will sit and + run in your panel. Various options to alter its display are + available. + </para> + + <figure id="cpuload-applet-fig"> + <title>CPU Load Applet</title> + <screenshot> + <screeninfo>CPU Load Applet</screeninfo> + <graphic format="png" fileref="figures/cpuload-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + <application>cpuload_applet</application> divides CPU use into + four sorts: + </para> + <variablelist> + <varlistentry> + <term>User</term> + <listitem> + <para> + This measures CPU use in "userland": ie, things not talking to + the kernel. The default colour for this is yellow. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>System</term> + <listitem> + <para> + This measures CPU use that involves the kernel: lots of talking + between memory and disc, for example. The default colour is pale + grey. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Nice</term> + <listitem> + <para> + This measures CPU use which is not "nice": running at a high priority. + The default colour is medium grey. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Idle</term> + <listitem> + <para> + Idle measures unused CPU capacity. The default colour is black. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="cpuload-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items, the right-click pop-up menu has + the following items: + </para> + + <variablelist> + <varlistentry> + <term>Default Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="cpuload-properties">described below</link> which allows + you to alter the default properties of this and related monitor + applets. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="cpuload-properties">described below</link> which + affects only the <application>cpuload_applet</application> + properties. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Run gtop...</term> + <listitem> + <para> + This option will run the <command>gtop</command> which + starts up the GNOME System Monitor. <application>gtop</application> + gives a much more detailed look at your system and what's happening + on it. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="cpuload-properties"> + <title>Properties</title> + + <figure id="cpuload-default-fig"> + <title>Default Properties Dialog</title> + <screenshot> + <screeninfo>CPU Load Applet Default Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/cpuload-applet-default" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Like several of the monitor applets, + <application>cpuload_applet</application> has two ways of setting + preferences. You can make changes that affect any of this group + (<application>cpuload_applet</application>, <application>memload_applet</application>, + <application>swapload_applet</application>, <application>netload_applet</application> + and <application>loadavg_applet</application>) in one large dialogue + box. This is useful if you run one or more of them. These are the + settings used by default. They are reached from the + <guimenuitem>Default Properties...</guimenuitem> menu item. + </para> + + <figure id="cpuload-greyed-fig"> + <title>Greyed Out Properties Dialog</title> + <screenshot> + <screeninfo>CPU Load Applet Greyed Out Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/cpuload-applet-greyed" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Or you can change just the properties for + <application>cpuload_applet</application>. This is useful for when + you only use <application>cpuload_applet</application> or want to + try new combinations out. It is reached from the + <guimenuitem>Properties</guimenuitem> menu item. + </para> + <note> + <para> + If you use the <guimenuitem>Properties...</guimenuitem> menu item + and edit the preferences for just this applet, you must uncheck + the <guibutton>Use default properties</guibutton> checkbox before + you can alter any settings. + </para> + </note> + + <figure id="cpuload-properties-fig"> + <title>CPU Load Properties Dialog</title> + <screenshot> + <screeninfo>CPU Load Applet Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/cpuload-applet-properties" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The changes you can make to the properties are three: + </para> + + <variablelist> + <varlistentry> + <term>Colours</term> + <listitem> + <para> + You can alter the colours used for the different forms of + CPU usage displayed by clicking on the colour boxes. This + invokes the GNOME colour wheel. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Speed</term> + <listitem> + <para> + You can alter the speed that the graph proceeds with this. + It is measured in milliseconds. The highest value is 1,000,000,000 + and the lowest is 1. The default is a more sensible 500. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Size</term> + <listitem> + <para> + You can alter the size of the applet with this. It is measured + in pixels. The default value is 40, and the range is from 1 pixel + to whatever you like. In a vertical panel, this refers to the + height. In a horizontal panel, it refers to the width. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="cpuload-bugs"> + <title> Known Bugs and Limitations</title> + <para> + Resizing and then altering the panel orientation can result in + intermittent problems, although they now fix themselves after a + short period. + </para> + </sect3> + + <sect3 id="cpuload-authors"> + <title>Authors</title> + <para> + This applet was writen by Martin Baulig (<email>martin@home-of-linux.org</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 Telsa Gywnne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.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> + + --> + + </sect3> + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/cpumemusage-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/cpumemusage-ug.sgml new file mode 100644 index 0000000..b2a9631 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/cpumemusage-ug.sgml @@ -0,0 +1,175 @@ +<!-- Permission is granted to make and distribute verbatim copies of --> +<!-- this manual provided the copyright notice and this permission --> +<!-- notice are preserved on all copies. --> +<!-- --> +<!-- Permission is granted to copy and distribute modified versions of --> +<!-- this manual under the conditions for verbatim copying, provided --> +<!-- that the entire resulting derived work is distributed under the --> +<!-- terms of a permission notice identical to this one. --> +<!-- --> +<!-- Permission is granted to copy and distribute translations of this --> +<!-- manual into another language, under the above conditions for --> +<!-- modified versions, except that this permission notice may be --> +<!-- stated in a translation approved by the Foundation. --> + +<sect2 id="cpumemusage-applet"> + <title>The CPU and memory usage applet</title> + + <para> + The <application>cpumemusage_applet</application> is a small monitor + applet which sits in your panel and tells you about your machine's + use of CPU, memory and swap. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Monitors</guisubmenu> + <guimenuitem>CPU/MEM usage</guimenuitem> + </menuchoice>. + </para> + + <sect3 id="cpumemusage-usage"> + <title>Usage</title> + <para> + You don't need to do anything to this applet. It will sit and + run in your panel. + </para> + <para> + The applet shows three bar charts, for CPU, memory and swap space. + If your panel is horizontal, the top bar is CPU, the middle is + memory, and the bottom is swap. If your panel is vertical, the left + bar is CPU, the middle is memory, and the right is swap. + </para> + + <figure id="cpumemusage-applet-fig"> + <title>CPU/MEM Applet</title> + <screenshot> + <screeninfo>CPU/MEM applet</screeninfo> + <graphic format="png" fileref="figures/cpumemusage-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <variablelist> + <varlistentry> + <term>CPU</term> + <listitem> + <para> + Three colours are used here. Yellow is used for CPU activity + which does not need the kernel. Grey is used for CPU activity + by programs talking to the kernel (typically, lots of I/O such + as moving things between memory and disk). Black is the background + and represents unused CPU. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Memory</term> + <listitem> + <para> + Four colours are used here. Yellow is used for shared memory + (memory more than one program is using). Grey is used for + buffer use (memory containing data not yet written to disk). + The greenish-yellow is used for other memory use. Green + represents unused memory. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Swap</term> + <listitem> + <para> + Two colours are used here. Red is used for swap space in use. + Green is for unused swap. Swap is a section of the hard-drive + where the kernel puts parts of programs which are not currently + being used so that it can retrieve them easily when it needs to. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> +<!-- When there are Right-Click Pop-Up Menu Items uncomment this section. + <sect3 id="cpumemusage-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + There are no extra menu items in the applet. + </para> + </sect3> +--> + <sect3 id="cpumemusage-bugs"> + <title> Known Bugs and Limitations</title> + <para> + There are no known bugs for this applet. + </para> + </sect3> + + <sect3 id="cpumemusage-authors"> + <title>Authors</title> + <para> + This applet was writen by Radek Doulik (<email>rodo@ucw.cz</email>). + Please report problems with it to the + <ulink type="http" url="http://bugs.gnome.org">GNOME bug + tracking system</ulink>. You can do this by following the + guidelines on that site or by using <application>bug-buddy</application> + from the command-line. For the package, put gnome-applets. + </para> + <para> + This guide was written by Telsa Gwynne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.edu</email>) and is almost entirely based on + the earlier documentation from the GNOME 1.0.53 User's Guide by David + Mason (<email>dcm@redhat.com</email>) and David Wheeler. Please + report problems with or suggestions for it to the GNOME Documentation + Project (<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> + </sect3> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> + + + + + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/desk-guide-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/desk-guide-ug.sgml new file mode 100644 index 0000000..f08278d --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/desk-guide-ug.sgml @@ -0,0 +1,603 @@ + + + + + <!-- ############### Desk Guide Applet ############### --> +<sect2 id="deskguide-applet"> + <title>Desk Guide Applet</title> + + <para> + <application>Desk Guide</application> applet, shown in <xref + linkend="deskguide-applet-fig">, is an applet that allows you to + visually navigate your virtual desktops. To add this applet to a + <interface>Panel</interface>, right-click on the panel and choose + <menuchoice> + <guimenu>Applets</guimenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Desk Guide</guimenuitem> + </menuchoice>. + </para> + + + <figure id="deskguide-applet-fig"> + <title>Desk Guide</title> + <screenshot> + <screeninfo>Desk Guide</screeninfo> + <graphic format="png" fileref="figures/deskguide-fig" srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> +<sect3 id="deskguide-applet-usage"> + <title>Usage</title> + + + <para><application>Desk Guide</application> applet helps you + navigate all of the virtual desktops available on your system. The + <application>X Window</application> system, working in + hand with a piece of software called a "window manager", allows + you to create more than one virtual desktop to organize your + work, with different applications running on each + desktop. Each desktop can also be subdivided by the window + manager into rows and columns of working space, called + "desk areas". <application>Desk + Guide</application> applet is a navigational tool to get around + the various desktops and desk areas, providing a miniature road + map in the GNOME panel showing all your virtual desktops (also + known as workspaces) and desk areas, and allowing you to switch + easily between them.</para> + + <para><application>Desk Guide</application> applet works + hand-in-hand with the window manager, the piece of software such + as Sawfish or Enlightenment that handles the look, feel and performance of + your windows. The window manager lays down borders, resizes windows, places + and moves them. The window manager is in charge of the various + desktops. <application>Desk Guide</application> applet handles the + navigation.</para> + + <para><application>Desk Guide</application> applet displays + miniature versions of all your available desktops, including + outlined boxes representing the applications running in each + desktop window. The desktop currently in use is + highlighted. Mouse-click on a representation of a desktop in + <application>Desk Guide</application> applet to switch to display + a different virtual desktop on your monitor.</para> + + <para>Click and hold with your middle mouse button on any window + image in <application>Desk Guide</application> applet to drag the + window around your virtual desktops.</para> + + <note> + <title>Note</title> + <para>Different window managers use different jargon to describe + virtual desktops and the subdivided workspaces within + them. <application>Enlightenment</application> divides your + working area into "desktops," and then subdivides those into + "screens." <application>Sawfish</application>, formerly known as + <application>Sawmill</application> divides your + working area into "workspaces" and then subdivides those into + columns and rows. <application>Desk Guide</application> applet + calls the workspaces "desktops" and the areas within them + "viewports". See your window manager's documentation for more + informaton on setting up and managing your virtual workspaces.</para> + </note> + + <para>Mouse-clicking on the arrow on the left side of + <application>Desk Guide</application> applet brings up the + <interface>Task List</interface> window, shown in <xref + linkend="deskguide-tasklist-applet-fig">.</para> + + <figure id="deskguide-tasklist-applet-fig"> + <title>Desk Guide Task List</title> + <screenshot> + <screeninfo>Desk Guide Task List</screeninfo> + <graphic format="png" fileref="figures/deskguide-tasklist-fig" srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + <para>The window lists the various applications running on your + computer. Left-clicking on any of the applications listed in the + <interface>Task List</interface> window shifts focus to that + application, i.e. this window rises to the foreground and all your + keyboard input will be sent to the application running in this window.</para> + + </sect3> + + <sect3 id="deskguide-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items (see <xref + linkend="deskguide-standard-right-click-items">), the right-click + pop-up menu has the following item: + <itemizedlist> + <listitem> + <para> + <guimenuitem>Properties...</guimenuitem> — This menu + item opens the <interface>Properties</interface> dialog (see + <xref linkend="deskguide-properties">) which allows you to + customize the appearance and behavior of this applet. + </para> + </listitem> + + + </itemizedlist> + </para> + </sect3> + + <sect3 id="deskguide-properties"> + <title>Properties</title> + <para> + You can configure <application>Desk Guide</application> applet by + right-clicking on the applet and choosing the + <guimenuitem>Properties...</guimenuitem> menu item. This will open the + <interface>Properties</interface> dialog, with four different + tabbed pages giving you access to various configuration options - + <link linkend="deskguide-properties-display">display</link>, + <link linkend="deskguide-properties-tasks">tasks</link> <link + linkend="deskguide-properties-geometry">geometry</link>, <link + linkend="deskguide-properties-advanced">advanced</link>.</para> + + + + <sect4 id="deskguide-properties-display"> + <title>Properties - Display</title> + <para>The first <interface>Properties </interface> window, shown + in <xref linkend="deskguide-properties-fig">, allows you to + control <application>Desk Guide</application> applet's display.</para> + + <figure id="deskguide-properties-fig"> + <title>Properties Dialog</title> + <screenshot> + <screeninfo>Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/deskguide-properties" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + <para>Options include: +<itemizedlist> + + <listitem> + <para><guilabel>Switch tasklist arrow</guilabel> + — switches the side of the applet on which the + arrow used to launch the tasklist window is displayed.</para> + </listitem> + + <listitem> + <para><guilabel>Only show current desktop in + pager</guilabel> — limits the applet display + to the desktop currently in use, including all its + viewports.</para> + </listitem> + + <listitem> + <para><guilabel>Raise area grid over tasks</guilabel> + — If you use multiple viewports (not only multiple + desktops) with your window manager, <application>Desk + Guide</application> draws a + viewport grid in the current desktop. It can either draw the + grid on top of the windows or below them.</para> + </listitem> + + + <listitem> + <para><guilabel>Show Desk-Guide tooltips</guilabel> — + Display tooltips related to various + <application>Desk Guide</application> applet components. The arrow + is the only widget that displays a tooltip.</para> + </listitem> + + <listitem> + <para><guilabel>Desk-Guide tooltip delay [ms]</guilabel> — + delay, in milliseconds, before the tooltip is displayed. You + may either type in a number or use the arrows to change the + number.</para> + </listitem> + + <listitem> + <para><guilabel>Show desktop name tooltips</guilabel> + — Some window managers, such as + <application>Enlightenment</application>, allow you to name + your desktops. The feature directs + <application>Deskguide</application> to show tooltips + displaying the desktop's name.</para> + </listitem> + + <listitem> + <para><guilabel>Desktop name tooltip delay [ms]</guilabel> + — delay, in milliseconds, before the tooltip is + displayed. You may either type in a number or use the arrows + to change the number.</para> + </listitem> + + </itemizedlist> +</para> + </sect4> + <sect4 id="deskguide-properties-tasks"> + <title>Properties - Tasks</title> + + + <figure id="deskguide-properties-tasks-fig"> + <title>Properties Dialog - Tasks</title> + <screenshot> + <screeninfo>Properties Dialog - Tasks</screeninfo> + <graphic format="png" fileref="figures/deskguide-properties-tasks-fig" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + <para>Options include:</para> + <itemizedlist> + <listitem> + <para><guilabel>Show hidden tasks (HIDDEN)</guilabel>, + <guilabel>Show shaded tasks (SHADED)</guilabel>, + <guilabel>Show tasks which hide from window list + (SKIP-WINLIST)</guilabel>, <guilabel>Show tasks which hide from taskbar + (SKIP-TASKBAR)</guilabel> — These four items allow + <application>Deskguide</application> to display applications + running with flags set that would normally hide them from an + application like this. For instance the + <application>panel</application> is flagged as + HIDDEN, HIDE_FROM_WINLIST and + HIDE_FROM_TASKBAR. Selecting these options will allow + <application>Deskguide</application> to show such + applications.</para> + </listitem> + + </itemizedlist> + + </sect4> + + <sect4 id="deskguide-properties-geometry"> + <title>Properties - Geometry</title> + <figure id="deskguide-properties-geometry-fig"> + <title>Properties Dialog - Geometry</title> + <screenshot> + <screeninfo>Properties Dialog - Geometry</screeninfo> + <graphic format="png" fileref="figures/deskguide-properties-geometry-fig" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + <para>Options include:</para> + <itemizedlist> + <listitem> + <para><guilabel>Desktop Height [pixels]</guilabel> — + sets the height of the desktop. By default this is greyed + out, and the panel size automatically sets the desktop + height. To activate it uncheck the <guilabel>Override desktop + height with panel size</guilabel> checkbox.</para> + </listitem> + + + <listitem> + <para><guilabel>Override desktop height with panel + size</guilabel> — forces <application>Desk + Guide</application> to automatically size itself to the + panel. Unchecking this allows you to manually set the height + using the <guilabel>Desktop Height</guilabel> setting above.</para> + </listitem> + + + <listitem> + <para><guilabel>Divide height by number of vertical + areas</guilabel> — divide the total applet + height by the number of rows of desktop areas visible.</para> + </listitem> + + + + <listitem> + <para><guilabel>Rows of desktops</guilabel> — set the + number of rows of desktop maps <application>Desk + Guide</application> creates in the panel to represent your + desktops. + <note> + <para>Your window manager, not <application>Desk Guide + Applet</application>, controls the number of desktops available on + your computer. This feature only controls the way + <application>Desk Guide</application> applet displays them.</para> + </note> + </para> + </listitem> + + + + <listitem> + <para><guilabel>Divide height by number of rows</guilabel> + — forces <application>Desk + Guide</application> to fit all the rows of desktops into the + height specified above (either one you have manually + specified or one set automatically to match the height of the + panel). Unchecking this, if you have more than one row, + allows <application>Desk Guide</application> to expand + vertically to two or more times normal height.</para> + </listitem> + + + + </itemizedlist> + + <para>The options for <interface>Vertical Layout</interface> are + mirror those for horizontal layout above, but effect the width + instead of height of the applet, and the number of columns it + occupies instead of the number of rows.</para> + </sect4> + + <sect4 id="deskguide-properties-advanced"> + <title>Properties - Advanced</title> + <figure id="deskguide-properties-advanced-fig"> + <title>Properties Dialog - Advanced</title> + <screenshot> + <screeninfo>Properties Dialog - Advanced</screeninfo> + <graphic format="png" fileref="figures/deskguide-properties-advanced-fig" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + <para>Advanced options allow you to control <application>Desk + Guide's</application> behavior with specific window managers, + along with other settings.</para> + + <itemizedlist> + + <listitem> + <para><guilabel>Draw desktops double-buffered + (recommended)</guilabel> — controls the method + <application>Desk Guide</application> draws desktops. Without + double-buffering, you may see flicker on slower + machines. With it, you may see slower performance on network + connections.</para> + </listitem> + + <listitem> + <para><guilabel>Window manager moves decoration window + instead</guilabel> — Check this if, when you move a + window with the middle mouse button, but the resulting window + position is off. If in doubt, check this if you use any of + the window managers mentioned + (<application>AfterStep</application>, + <application>Enlightenment</application>, + <application>FVWM</application>, + <application>IceWM</application>, or + <application>Sawmill</application>, now known as + <application>Sawfish</application>).</para> + </listitem> + + <listitem> + <para><guilabel>Window manager changes active area on all + desktops</guilabel> — If you have more than one + desktop, with multiple work areas within each desktop, this + option can be used to force the window manager to change the + active work area within all the desktops simultaneously if + you change your work area on one.</para> + </listitem> + + <listitem> + <para><guilabel>Window manager expects pager to modify + area+desktop</guilabel> — Currently has no effect.</para> + </listitem> + <listitem> + <para><guilabel>Popdown task view automatically</guilabel> — + Automatically pops down the task view window after you click on an + application in the task view list. If unchecked, you must click a + second time on the task view arrow to get the window to pop down.</para> + </listitem> + </itemizedlist> + </sect4> + +<sect4 id="moreInformation"> + <title>More Information</title> + <para>All <interface>Properties</interface> dialogs have the following + buttons at the bottom of the dialog: + <itemizedlist> + <listitem> + <para> + <guibutton>OK</guibutton> — + Pressing <guibutton>OK</guibutton> will activate any changes + in the properties you have made and close the + <interface>Properties</interface> dialog. + </para> + </listitem> + <listitem> + <para> + <guibutton>Apply</guibutton> — + Pressing <guibutton>Apply</guibutton> at any time will + make your changes active without closing the + <interface>Properties</interface> dialog. This is helpful if + you would like to test the effects of the changes you have + made but may want to continue changing the properties. + </para> + </listitem> + <listitem> + <para> + <guibutton>Close</guibutton> — + Pressing <guibutton>Close</guibutton> will close the + <interface>Properties</interface> dialog. Only changes in the + configuration which were previously applied with the + <guibutton>Apply</guibutton> button will persist. Other + changes will not be made active. + </para> + </listitem> + <listitem> + <para> + <guibutton>Help</guibutton> — + Pressing <guibutton>Help</guibutton> brings up the manual for + the application, opening it to the page describing the + <interface>Properties</interface> dialog. + + + + </para> +</listitem> +</itemizedlist> +</para> +</sect4> + + <sect4 id="deskguide-standard-right-click-items"> + <title>Standard Pop-Up Items</title> + <para> + All applets should have the following items in their right-click + <guimenu>pop-up menu</guimenu>: + <variablelist> + <varlistentry> + <term>Remove from panel</term> + <listitem> + <para> + The <guimenuitem>Remove from panel</guimenuitem> menu item + removes the applet from the <interface>Panel</interface>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Move</term> + <listitem> + <para> + After selecting <guimenuitem>Move</guimenuitem>, your mouse + pointer will change appearance (typically to a cross with + arrows in each direction). As you move your mouse, the applet + will move with it. When you have finished moving the applet, + click any mouse button and the applet will anchor in its + current position. Note that applets can be moved between two + <interface>Panels</interface> this way. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Panel</term> + <listitem> + <para> + The <guisubmenu>Panel</guisubmenu> submenu contains various + items and submenus for adding and removing + <interface>Panels</interface> and applets and for changing + the configuration. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>About</term> + <listitem> + <para> + The <guimenuitem>About...</guimenuitem> menu item brings up a + dialogue box containing various information about the applet, + typically including the applet's name, version, author, + copyright, license and description. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Help</term> + <listitem> + <para> + The <guimenuitem>Help</guimenuitem> menu item brings up the help + manual for the applet. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect4> + + + + </sect3> + + <sect3 id="deskguide-applet-bugs"> + <title> Known Bugs and Limitations</title> + <para>The <guilabel>Window manager expects pager to modify + area+desktop</guilabel> feature on the <interface>advanced + properties</interface> window currently has no effect. + + </para> + </sect3> + <!-- ============= Authors ================================ --> + + <sect3 id="deskguide-applet-authors"> + <title>Authors</title> + <para> + <application>Desk Guide</application> applet was written by Tim Janik + (<email>timj@gtk.org</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 John Fleck + (<email>jfleck@inkstain.net</email>). Please send all comments and + suggestions regarding this manual to the <ulink type="http" + url="http://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <sect3 id="deskguide-applet-license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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 + <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General + Public License</citetitle></ulink> for more details. + </para> + <para> + A copy of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> is included with the GNOME + documentation. You also may obtain a copy 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> + </sect3> + +--> + </sect2> + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/diskusage-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/diskusage-ug.sgml new file mode 100644 index 0000000..9f28db5 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/diskusage-ug.sgml @@ -0,0 +1,259 @@ + +<sect2 id="diskusage-applet"> + <title>Disk Usage Applet</title> + + <para> <application>Disk Usage Applet</application>, shown in <xref + linkend="diskusage-applet-fig1">, provides a panel monitor for the + amount of space in use and available on your disk drives. To add + this applet to the panel, right-click on the panel and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Monitors</guisubmenu> + <guimenuitem>Disk Usage</guimenuitem> + </menuchoice> + </para> + + + <figure id="diskusage-applet-fig1"> + <title>Disk Usage Applet</title> + <screenshot> + <screeninfo>Disk Usages Applet</screeninfo> + <graphic format="png" fileref="figures/diskusage-applet" srccredit="John + Fleck"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + + <sect3 id="diskusage-applet-usage"> + <title> Usage</title> + <para><application>Disk Usage Applet</application> provides + real-time monitoring of the available space on your disk + drives.</para> + <para>It provides three pieces of information. The colored pie + graphically represents how much space is used and how much is + available. <guilabel>MP:</guilabel> indicates the mount point of + the disk it is currently monitoring. <guilabel>av:</guilabel> + indicates the amount of space available on the selected drive, in + kilobytes. Clicking on the applet changes the drive being + monitored. Doing so repeatedly cycles through all available drives.</para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + <listitem> + <para> + <guimenuitem>File system</guimenuitem> — allows you + to change the file system <application>Disk Usage + Applet</application> monitors.</para> + </listitem> + <listitem> + <para> + <guimenuitem>Properties</guimenuitem>— opens the + <link linkend="diskusage-applet-prefs"> + <guilabel>Properties</guilabel> + </link> dialog + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Update</guimenuitem> — this can be used + to force the applet to update the filesystem list the applet + uses. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Disk Usage + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + + + </itemizedlist> + </para> + </sect3> + <!-- ============= Customization ============================= --> + <sect3 id="diskusage-applet-prefs"> + <title>Customization</title> + <para> + You can customize <application>Disk Usage Applet</application> by + right-clicking on it and choosing + <guimenuitem>Properties</guimenuitem>. This will launch the + <interface>Properties…</interface> dialog, which allows you to + change various settings. + </para> + <figure id="diskusage-applet-fig2"> + <title>Preferences dialog</title> + <screenshot> + <screeninfo>Preferences dialog</screeninfo> + <graphic format="png" fileref="figures/diskusage-applet-prefs" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + <para> + The properties are: + <itemizedlist> + + + <listitem> + <para> + <guilabel>Colors</guilabel> — To change the colors + displayed in the applet, click on the <guibutton>colored + buttons</guibutton> next to <guilabel>Used Diskspace</guilabel>, + <guilabel>Free Diskspace</guilabel>, + <guilabel>Textcolor</guilabel> and + <guilabel>Backgroundcolor</guilabel>. A color wheel dialog will + pop up offering you color options to make changes. When + finished, click on the <guibutton>OK</guibutton> button on the + color options window. + + </para> + </listitem> + + <listitem> + <para> + <guilabel>Size</guilabel> — <guilabel>Applet + Size</guilabel> and can be used to change the height (on a + horizontal panel) or width (on a vertical panel) of the applet.</para> + + <para>By checking the <guilabel>Automatically pick best applet + size</guilabel> check box, you can force <application>Disk Usage + Applet</application> to automatically choose the appropriate size + for your panel. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Fonts</guilabel> — Clicking on the bar in this + window opens a dialog box allowing you to change the font + displayed in the applet. + </para> + </listitem> + <listitem> + <para> + <guilabel>Update Frequency</guilabel> — changes + the amount of time, in seconds, between updates of + <application>Disk Usage Applet</application>. + </para> + </listitem> + + </itemizedlist> + </para> + + + <para> + </para> + + + + <para> After you have made all the choices you want, click on + <guibutton>OK</guibutton> to make the changes and close the + <interface>Properties</interface> dialog. To cancel the changes + and return to previous values, click on + <guibutton>Cancel</guibutton> button. + </para> + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="diskusage-authors"> + <title>Authors</title> + <para> + <application>Disk Usage Applet</application> was written by Dave Finton + <email>dfinton@d.umn.edu</email>, Bruno Widmann + <email>bwidmann@tks.fh-sbg.ac.at</email> and Martin Baulig + <email>martin@home-of-linux.org</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 John Fleck + (<email>jfleck@inkstain.net</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + +--> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/drivemount-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/drivemount-ug.sgml new file mode 100644 index 0000000..e1facf5 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/drivemount-ug.sgml @@ -0,0 +1,571 @@ + <sect2 id="drivemountapplet"> + <title>Drive Mount Applet</title> + + <para> + <application>Drive Mount Applet</application>, shown in <xref + linkend="drivemountapplet-fig">, allows you to quickly and easily + mount and unmount various types of drives and filesystems on your + computer. To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Drive Mount</guimenuitem> + </menuchoice>. + </para> + + <figure id="drivemountapplet-fig"> + <title>Drive Mount Applet</title> + <screenshot> + <screeninfo>Drive Mount Applet</screeninfo> + <graphic format="png" fileref="figures/drivemount_applet_floppy" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <note> + <title>Background Information for Beginners</title> + <para> + Many file systems on Linux and Unix systems must be manually + mounted and unmounted. After a file system is mounted, you can + read and write to it. When you are finished with a file system, + you should unmount it. It is important to unmount removable + drives, such as floppy disks and Zip disks, + before removing the media, because Linux and Unix systems do not + always write the changes made immediately. They typically buffer + the changes made to the disk in order to improve the speed of the + system. Partitions on fixed drives, such as your hard drive, are + typically mounted automatically when your computer boots and + unmounted when it shuts down. Removable media must be mounted and + unmounted by hand, such as by using the <application>Drive + Mount</application> applet. + </para> + <para> + The "root + filesystem" is the main filesystem on your computer starting with + "/" (root). Other filesystems are associated with directories inside + the root filesystem. These are called "mount points", which are + just empty directories. When a filesystem is mounted, its + contents appear inside this directory. As an example, most + systems create a mount point "/mnt/floppy" which is just an empty + directory if your floppy drive is not mounted. It contains + the contents of your floppy if the floppy drive is mounted. + </para> + </note> + + <!-- ============= Usage ================================ --> + <sect3 id="drivemount-usage"> + <title>Usage</title> + <para> + To mount or unmount a drive, simply click on the + <application>Drive Mount Applet</application> icon with the left + mouse button. For drives which can eject their media, such as + most CDROM's and JAZ drives, you can eject the drive by clicking on the + icon with the right mouse button and selecting + <guimenuitem>Eject</guimenuitem>. To browse the contents of the + drive with the <application>GNOME File Manager</application>, select + <guimenuitem>Browse…</guimenuitem>. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Browse…</guimenuitem> — shows + the contents of the drive using the <application>GNOME File + Manager</application>. + The drive must be mounted for this to work. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Eject</guimenuitem> — ejects the + storage medium for drives which can be ejected, such as + CDROM's and JAZ drives. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="drivemountapplet-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Drive Mount + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + + <para> + The mount point and mount status of a drive is shown in a tooltip + if the cursor is left over the applet for a short time, as shown + in <xref linkend="drivemountapplettooltips-fig">. + <figure id="drivemountapplettooltips-fig"> + <title>Drive Mount Applet showing tooltip</title> + <screenshot> + <screeninfo>Drive Mount Applet showing tooltip</screeninfo> + <graphic format="png" fileref="figures/drivemount_applet_tooltip" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + </para> + + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="drivemountapplet-prefs"> + <title>Customization</title> + <para> + You can customize <application>Drive Mount</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="drivemount-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="drivemount-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/drivemount_applet_settings" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The properties are: + <itemizedlist> + + <listitem> + <para> + <guilabel>Mount Point</guilabel> — This is the mount + point used when mounting the drive. This is + an empty directory which will hold the contents of the drive + whenever the drive is mounted. Mount points can occur + anywhere in your filesystem, but the convention is to put all + mount points for removable drives in the <filename + class="directory">/mnt</filename> + directory. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Update in seconds</guilabel> — This is the + interval in seconds at + which <application>Drive Mount</application> refreshes its + icon by checking the mount status. This is only + important if you sometimes mount or unmount a drive using a + command or application other than <application>Drive + Mount</application>. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Icon</guilabel> — This determines the icons + (one for unmounted and + one for mounted) displayed for the + drive. There are icon sets for most of the commonly used + drives (floppy, CDROM, Zip, hard disk, and JAZ). + They are shown in <xref + linkend="drivemountappletall-fig">. You may also select + <guimenuitem>Custom</guimenuitem>; this allows you to specify + your own icons. + </para> + <figure id="drivemountappletall-fig"> + <title>Icons for Mounted and Unmounted Drives of Various Types</title> + <screenshot> + <screeninfo>Icons for Mounted and Unmounted Drives of Various + Types</screeninfo> + <graphic format="png" fileref="figures/drivemount_applet_all" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + <para> + Notice that <xref linkend="drivemountappletall-fig"> + shows the icons for the unmounted and mounted states of (from + left to right) floppy, CDROM, Zip, JAZ, and hard disk drives. + </para> + </listitem> + + <listitem> + <para> + <guilabel>Custom icon for mounted</guilabel> — A custom + icon which is + displayed when the drive is mounted. This option is only + available if the <guimenu>Icon:</guimenu> selection is set to + "Custom". + </para> + </listitem> + + <listitem> + <para> + <guilabel>Custom icon for not mounted</guilabel> — A + custom icon which is + displayed when the drive is not mounted. This option is only + available if the <guimenu>Icon:</guimenu> selection is set to + "Custom". + </para> + </listitem> + + <listitem> + <para> + <guibutton>Scale size to panel</guibutton> — Selecting + this option scales + the size of the mounted and unmounted icons with the + <interface>Panel</interface>'s size. If this option is not + set, the icon sizes are fixed, independent of the size of + the <interface>Panel</interface>. Selecting this option + typically makes for a nicer appearance. For very small + <interface>Panel</interface> sizes, unselecting this option + may be useful, as it forces the applet to appear rotated and + larger, which makes it easier to see. + </para> + </listitem> + + <listitem> + <para> + <guibutton>Use automount friendly status test</guibutton> + — Select this option + if you use automount, otherwise leave it unselected. + </para> + <note> + <title>Information for Advanced Users</title> + <para> + The default command used by <application>Drive + Mount</application>to test whether a drive is mounted is + <command>stat</command> and would cause the drive to actually be + mounted if the user is using + <application>automount</application>. If this button is + selected, it uses <command>mount</command> instead, which + does not cause <application>automount</application> to mount + the drive. The reason this button is not selected by default + is that <command>mount</command> is more cpu intensive than + <command>stat</command>. + </para> + </note> + </listitem> + + </itemizedlist> + </para> + + <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. Click + <guibutton>Apply</guibutton> to apply changes without closing. + <guibutton>Close</guibutton> closes + <interface>Properties</interface> without saving changes which + have not been applied. Applied changes cannot be cancelled. + </para> + </sect3> + + <!-- ============= Configuring Your System ============== --> + <sect3 id="drivemountapplet-configuring"> + <title>Configuring Your System</title> + + <warning> + <title>For Advanced Users</title> + <para> + This section is intended for system administrators and advanced + users. + </para> + </warning> + + <para> + In order for <application>Drive Mount Applet</application> to work + properly, the system may need to be configured by the system + administrator, using root privileges. This section provides a + very basic introduction. + </para> + + <para> + Information describing the mount point and filesystem type of each + drive is kept in <filename>/etc/fstab</filename>. This can be + configured by hand or by using the + <application>linuxconf</application> application. For drives which + do not always have a single filesystem type (such as a floppy + drive which may have msdos or ext2 filesystems), you should use + "auto" for the filesystem type. Each device has a single line in + /etc/fstab of the following form: + <programlisting> + /dev/fd0 /mnt/floppy auto noauto,rw,user 0 0 + </programlisting> + This entry describes the first floppy device (/dev/fd0) as having + a mount point of <filename>/mnt/floppy</filename>, a variable + filesystem type which should be automatically detected, and the + following configurations: "noauto"— Do not automatically + mount the drive when the computer is booted, "rw"— The drive + is readable and writable, and "user"— Users have permission + to mount the drive. These, along with the last two fields which + we do not describe here, are discussed in detail in the fstab man + pages, available by typing <command>man fstab</command> or through + the <application>GNOME Help Browser</application>. + </para> + <para> + The <application>linuxconf</application> application provides a + graphical interface for controlling these filesystems. To start + <application>linuxconf</application>, just type + <command>linuxconf</command> in a shell window (you must log in as + root). Select + <menuchoice> + <guimenu>Config</guimenu> + <guisubmenu>filesystems</guisubmenu> + <guimenuitem>Access local drive</guimenuitem> + </menuchoice>. + To edit an entry, just select + it. <application>linuxconf</application> is meant to be easy + to use and has its own internal help system to guide you + through the process. You may also add new entries by selecting the + <guibutton>Add</guibutton> button. + </para> + </sect3> + + + <!-- ============ Troubleshooting & Error Messages ======= --> + <sect3 id="drivemountapplet-troubleshooting"> + <title>Troubleshooting and Understanding Error Messages</title> + <para> + If you do not have your system configured properly, you may + encounter certain error messages when trying to mount or access + certain drives. Here are some of the more common error messages + and their causes: + <itemizedlist> + <listitem> + <para> + <quote>mount: /dev/fd0 is not a valid block + device</quote>— The most common cause for this error is + that the drive (in this example, /dev/fd0, corresponding to the + floppy drive) is empty. + </para> + </listitem> + <listitem> + <para> + <quote>mount: only root can mount /dev/fda on + /mnt/floppy</quote>— You do not have permission to mount + this drive. Contact the system administrator, who can give you + permission. + </para> + <note> + <title>Note for System Administrators</title> + <para> + You can set a drive to be mountable and unmountable by users by + adding "users" to the mount options (fourth column) in + <filename>/etc/fstab</filename>. This may be done by hand or + by using <application>linuxconf</application>, using the + <guilabel>Local volume</guilabel> tab in + <menuchoice> + <guimenu>Config</guimenu> + <guisubmenu>Filesystems</guisubmenu> + <guimenuitem>Access local drive</guimenuitem> + </menuchoice>. After you select the correct drive from the list, + it will show you the <guilabel>Volume + specifications</guilabel>. Click on the + <guilabel>Options</guilabel> tab, and select the + <guibutton>User mountable</guibutton> button. + </para> + </note> + </listitem> + <listitem> + <para> + <quote>mount: wrong fs type, bad option, bad superblock on + /dev/cdrom, or too many mounted file systems</quote>— + This error can be caused by several problems. It is most + commonly caused by not having the right filesystem type, such as + trying to mount a music CDROM as if it held data, or trying to + mount an msdos formatted floppy as ext2. + </para> + </listitem> + <listitem> + <para> + <quote>mount /mnt/cdrom 2>&1 reported: mount: No medium + found</quote>— This error indicates the drive, in + this case the CDROM drive, is empty. + </para> + </listitem> + <listitem> + <para> + <quote>umount /mnt/cdrom 2>&1 reported: umount: /mnt/cdrom: + device is busy</quote>— This error indicates that the + drive cannot be unmounted because the drive is being used by + the computer. This often happens if you have the + <application>GNOME File Manager</application> open to a + directory on the drive or if you have a terminal window open + with the working directory on the drive. + </para> + </listitem> + <listitem> + <para> + <quote>umount: can't find /mnt/floppy in /etc/fstab or /etc/mtab + </quote>— + This indicates that the system has not been configured to mount + the mount point you are trying to use. In many cases, you may + have put the wrong mount point in the <guilabel>Mount + point</guilabel> entry in the <interface>Properties + Dialog</interface> (see <xref + linkend="drivemountapplet-prefs">). To find out which mount + point you should be using, contact your system administrator. + </para> + <note> + <title>Note for Advanced Users</title> + <para> + Each device (filesystem or drive) which can be mounted should + be listed in the <filename>/etc/fstab</filename> configuration + file. Reading this file will tell you which devices are + configured for your system. To add or modify entries, you can + edit this file by hand or by using the + <application>linuxconf</application> application. + </para> + </note> + </listitem> + <listitem> + <para> + <quote>mount: /dev/fd0 already mounted or /mnt/floppy busy + mount: according to mtab, /dev/fd0 is mounted on /mnt/floppy_ext2 + </quote>— + This error occurs if you have a single device (in this case + /dev/fd0) configured for multiple mount points and you try to + mount one mount point while another one is already mounted. + Having multiple mount points for a single device typically is + not necessary. + </para> + </listitem> + <listitem> + <para> + <quote>mount: the kernel does not recognize /dev/sda4 as a + block device(maybe 'insmod driver'?)</quote>— Contact + your system administrator. (This error + occurs if your kernel is not properly configured to + automatically mount the necessary kernel modules to read the + device.) + </para> + </listitem> + </itemizedlist> + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="drivemount-bugs"> + <title>Known Bugs and Limitations</title> + <para> + <guimenuitem>Eject</guimenuitem> does not always work. Trying to + eject with the drive mounted does not give a warning, explaining + why the drive does not eject. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="drivemount-authors"> + <title>Authors</title> + <para> + <application>Drive Mount Applet</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/fifteen-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/fifteen-ug.sgml new file mode 100644 index 0000000..a60364f --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/fifteen-ug.sgml @@ -0,0 +1,171 @@ + <sect2 id="fifteen"> + <title>Fifteen Applet</title> + + <para> + <application>Fifteen</application> applet, shown in <xref + linkend="fifteenapplet-fig">, is a version of the old game of + moving squares around a grid to put them into numerical order. To + add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Amusements</guisubmenu> + <guimenuitem>Fifteen</guimenuitem> + </menuchoice>. + </para> + + <figure id="fifteenapplet-fig"> + <title>Fifteen Applet</title> + <screenshot> + <screeninfo>Fifteen Applet</screeninfo> + <graphic format="png" fileref="figures/fifteen_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="fifteen-usage"> + <title>Usage</title> + <para> + The applet starts with the pieces in the correct order: this is + the order you will need to restore them to. To start a new game, + right-click on the applet and select <guimenuitem>Scramble + Pieces</guimenuitem>. Move the pieces by clicking on them with + the left mouse button until you have restored them all to their + original positions. When you have done this, you will see a + <guilabel>You win!</guilabel> dialog box. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Scramble pieces</guimenuitem> — + randomly rearranges the tile positions. Use this to start a + new game. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about + <application>Fifteen</application> applet, inluding the + applet's version and the author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="fifteen-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="fifteen-authors"> + <title>Authors</title> + <para> + <application>Fifteen</application> was written by Federico Mena + Quintero (<email>federico@nuclecu.unam.mx</email>). It is based on + the game described by Sam Lloyd in 1878. 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 Telsa Gwynne + (<email>hobbit@aloss.ukuu.org.uk</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/fish-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/fish-ug.sgml new file mode 100644 index 0000000..e387f6f --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/fish-ug.sgml @@ -0,0 +1,254 @@ + <sect2 id="fish"> + <title>Fish Applet</title> + + <para> + <application>Fish</application> applet, shown in <xref + linkend="fishapplet-fig">, displays a small + fish in your <interface>panel</interface> and does nothing useful + whatsoever beyond that. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Amusements</guisubmenu> + <guimenuitem>Fish</guimenuitem> + </menuchoice>. + </para> + + <figure id="fishapplet-fig"> + <title>Fish Applet</title> + <screenshot> + <screeninfo>Fish Applet</screeninfo> + <graphic format="png" fileref="figures/fish_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="fish-usage"> + <title>Usage</title> + <para> + Unlike most fishes, this fish requires little care and no fishbowl + cleaning. It swims happily about in its water. If you ask it, it + will tell you interesting thoughts. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="fish-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Fish + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="fish-prefs"> + <title>Customization</title> + <para> + You can customize <application>Fish</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="fish-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="fish-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/fish_settings" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The properties are: + <itemizedlist> + + <listitem> + <para> + Your GNOME Fish's Name — You can change your fish's + name here. The default name is Wanda. + </para> + </listitem> + + <listitem> + <para> + The Animation Filename — You can select a different set + of pictures here. By default, + the list of pictures is in <filename>$PREFIX/pixmaps/fish/</filename>, + which you can browse and choose from. You may also put a different + pathname in pointing to your own pictures. + </para> + </listitem> + + <listitem> + <para> + Frames In Animation — The number of frames in the + animation. The default is three, but the range is from 1 to 255. + </para> + </listitem> + + <listitem> + <para> + Pause per frame (s) — The period in seconds before + updating the picture. The default is one second, but the range + is from 0.10 to 10 seconds. + </para> + </listitem> + + <listitem> + <para> + Rotate on vertical panels — This checkbox is used for + vertical panels, and when checked, the + fish will appear swimming downwards on a vertical panel. If it is + not checked, it will appear the same way as on a horizontal panel, + which forces the vertical panel to widen to accomodate it. + </para> + </listitem> + + + </itemizedlist> + </para> + + <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> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="fish-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="fish-authors"> + <title>Authors</title> + <para> + <application>Fish</application> was written by George Lebl + (<email>jirka@5z.com</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 Telsa Gwynne + (<email>hobbit@aloss.ukuu.org.uk</email>). Please send all + comments and suggestions regarding this manual to the <ulink + type="http" url="http://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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 + <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General + Public License</citetitle></ulink> for more details. + </para> + <para> + A copy of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> is included with the GNOME + documentation. You also may obtain a copy of the <ulink + type="help" url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/geyes-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/geyes-ug.sgml new file mode 100644 index 0000000..0f0d14f --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/geyes-ug.sgml @@ -0,0 +1,203 @@ + <sect2 id="geyes"> + <title>gEyes Applet</title> + + <para> + <application>gEyes</application> applet, shown in <xref + linkend="geyesapplet-fig">, is a pair of eyes which follow your + mouse pointer around the screen. To add this applet to a + <interface>Panel</interface>, right-click on the + <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Amusements</guisubmenu> + <guimenuitem>gEyes</guimenuitem> + </menuchoice>. + </para> + + <figure id="geyesapplet-fig"> + <title>gEyes Applet</title> + <screenshot> + <screeninfo>gEyes Applet</screeninfo> + <graphic format="png" fileref="figures/geyes_applet" + srccredit="arjan"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="geyes-usage"> + <title>Usage</title> + <para> + Watch the eyes watch your mouse. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="geyes-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>gEyes + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="geyes-prefs"> + <title>Customization</title> + <para> + You can customize <application>gEyes</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="geyes-settings-fig">), which allows you to + change the theme. + </para> + + <figure id="geyes-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/geyes_settings" + srccredit="arjan"> + </graphic> + </screenshot> + </figure> + + <para> + This window shows a list of the currently installed + themes(appearances) for <application>gEyes</application>. Select + the theme you would like to use. + </para> + + <para> + After you have selected your new theme, click on + <guibutton>OK</guibutton> to apply the changes and close the + <interface>Properties</interface> dialog. + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="geyes-bugs"> + <title>Known Bugs and Limitations</title> + <para> + With the exception of Default-tiny, most of the themes + are too large for some <interface>Panel</interface> sizes and + force the <interface>Panel</interface> to resize. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="geyes-authors"> + <title>Authors</title> + <para> + <application>gEyes</application> was written by Dave Camp + (<email>campd@oit.edu</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 Telsa Gwynne + (<email>hobbit@aloss.ukuu.org.uk</email>) and Arjan Scherpenisse + (<email>acscherp@wins.uva.nl</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/gkb-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/gkb-ug.sgml new file mode 100644 index 0000000..777aebc --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/gkb-ug.sgml @@ -0,0 +1,523 @@ + <sect2 id="gkbapplet"> + <title>GNOME KeyBoard Applet</title> +<!-- reviewed by András--> + <para> + <application>GNOME KeyBoard Applet</application>, shown with its + default configuration in <xref linkend="gkbapplet-fig">, allows + you to easily and quickly change + the keyboard map to those used in various different countries. To + add this applet to a + <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>GKB KeyBoard Switcher</guimenuitem> + </menuchoice>. + </para> + + <figure id="gkbapplet-fig"> + <title>GNOME KeyBoard Applet</title> + <screenshot> + <screeninfo>GNOME KeyBoard Applet</screeninfo> + <graphic format="png" fileref="figures/gkb_applet" + srccredit="emese"> + </graphic> + </screenshot> + </figure> + + + <!-- ============= Usage ================================ --> + <sect3 id="gkbapplet-usage"> + <title>Usage</title> + <para> + Once configured, the <application>GNOME Keyboard</application> + applet allows you to switch the keyboard mapping between any number of + keyboard layout. Just left-click on the applet or press + <keycombo><keycap>Alt</keycap><keycap>Shift</keycap></keycombo> + to switch the keyboard + mapping. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="gkbapplet-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>GNOME KeyBoard + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="gkbapplet-prefs"> + <title>Customization</title> + <para> + You can customize <application>GNOME KeyBoard</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog (shown in <xref + linkend="gkbapplet-settings-fig">), which allows you to + add, modify, and remove keymaps, as well as to <link linkend="gkbapplet-options">configure + the applet's appearance</link>. + </para> + + <figure id="gkbapplet-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/gkb_applet_settings" + srccredit="emese"> + </graphic> + </screenshot> + </figure> + + <para>The <interface>Properties</interface> dialog box has two tabs: + <guilabel>Keymaps</guilabel> and <guilabel>Options</guilabel>. + On the <guilabel>Keymaps</guilabel> tab, you can Add, Edit, Delete + or change the order of keyboard layouts. On the + <guilabel>Options</guilabel> tab you can set the appearance of the + applet (flag, label or flag+label) and its size (Normal or Big), as + well as the key sequence to use to get GKB to switch between + keyboard layouts (see <xref linkend="bugs"> section.) + </para> + <sect4 id="gkb-prefs-add"> + <title>Setting keyboard layouts for you language</title> + <para> + Setting up keymaps can consist in one or more of the following steps: + <itemizedlist> + <listitem> + <para> + Adding a required keyboard layout — On the + <guilabel>Keymaps</guilabel> tab, click on the + <guibutton>Add</guibutton> button. The + <interface>tree</interface> shown in + <xref linkend="gkbapplet-add-keymap-fig"> allows you to choose + the keymap best suited for you, based on the language and the + country involved. + </para> + + <figure id="gkbapplet-add-keymap-fig"> + <title>Select Layout dialog</title> + <screenshot> + <screeninfo>Select layout dialog</screeninfo> + <graphic format="png" fileref="figures/gkb_add_list" + srccredit="emese"></graphic> + </screenshot> + </figure> + <para>To add a keymap, click on the <guibutton>+</guibutton> + sign preceeding the languge you want to set. A list of coutries + where the given language is used appears. Again, click on the + <guibutton>+</guibutton> preceeding the country chosen, and a + list of keymaps shows up. Select the keymap you would like to + use and click <guibutton>Add</guibutton>. Your keymap gets added to + the list on the <interface>GKB Properties</interface> window. You + may add another keymap or click + <guibutton>Close</guibutton> to close the + <interface>Select Layout</interface> dialog. + </para> + </listitem> + + <listitem> + <para> + Editing an existing keyboard layout — Selecting a keymap + and pressing the <guibutton>Edit</guibutton> brings up the + <interface>Edit keymap</interface> window (see + <xref linkend="gkbapplet-prefs-edit">). + </para> + + + <figure id="gkbapplet-prefs-edit"> + <title>Edit keymap dialog</title> + <screenshot> + <screeninfo>Edit keymap dialog</screeninfo> + <graphic format="png" fileref="figures/gkb_edit_keymap" + srccredit="emese"></graphic> + </screenshot> + </figure> + +<para> +On this dialog, you can modify different properties of the keymap. These +properties are: + +<itemizedlist> + +<listitem> +<para> +<guilabel>Name</guilabel>: The name of the keymap, as shown in the +<interface>GKB Properties</interface> window and in the hint appearing +when you move your mouse over the applet. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Label</guilabel>: This is the label that appears when you set +"Label" or "Flag+Label" modes. See <xref linkend="gkbapplet-options"> for more +details. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Language</guilabel>: This option will be used in Gnome 2.0. +It has no effect right now. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Country</guilabel>: This option will be used in Gnome 2.0. It +has no effect right now. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Flag</guilabel>: This is the place where you can set the flag +to be displayed with the given keyboard layout. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Architecture</guilabel>:This option will be used in Gnome 2.0. +It has no effect right now. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Type</guilabel>: This option will be used in Gnome 2.0. It has no +effect right now. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Code page</guilabel>: This option will be used in Gnome 2.0. It +has no effect right now. +</para> +</listitem> + +<listitem> +<para> +<guilabel>Command</guilabel>: This is the command which + <application>GNOME KeyBoard</application> will use to change + the keymap. The default is to use the + <command>gkb_xmmap <replaceable>xmodmap-file-extension</replaceable> +</command> command, where <replaceable>xmodmap-file-extension</replaceable> +should be replaced by the extension of the xmodmap file you want to use. +</para> +<tip> +<title>Finding keyboard layouts availble on your system</title> +<para>On a typical Linux system, xmodmap files can be found under the +directory <filename class="directory">/usr/share/xmodmap</filename>. +</para> +</tip> +<para> +To set the keymap to a US 101 key keyboard, for example, you would +use <command>gkb_xmmap us-101</command>. +</para> + <para> + If this doesn't work, you may also try setting the + keyboard using command <command>setxkbmap + <replaceable>LC</replaceable></command> where + <replaceable>LC</replaceable> is the two letter country + code of your locale. (for example, + <command>setxkbmap fr</command> to use a French + keyboard). Finally, if you have your own keyboard layout + (xmodmap) file, set the command to <command>xmodmap + <replaceable>xmodmap-filename</replaceable></command> (for + example, <command>xmodmap + ~/xrus/yawerty.koi8.xmm</command> to use keyboard layout + for Cyrillic letters in koi8 encoding). Please see + <xref linkend="gkbappplet-technical"> for more information. + </para> + +</listitem> +</itemizedlist> + + </para> + </listitem> + + <listitem> + <para> + Removing a keyboard layout that is no longer needed — + To remove a keyboard, select it (click on it in the + <interface>GKB Properties</interface> window) and click the + <guibutton>Delete</guibutton> button. + </para> + </listitem> + + <listitem> + <para> + Reordering keyboard layouts — The order in which the + keyboard layouts become active as you click on the applet or + press the hot key depends on the order they appear in the list in + the <interface>Properties</interface> window. The layout that is + displayed at the top of + the list will become the default layout when you close the + <interface>Properties</interface> window. To change the order in + the list, select the keymap to be moved, and click + <guibutton>Up</guibutton> or <guibutton>Down</guibutton> as + appropriate. + </para> + </listitem> + + </itemizedlist> + </para> + <para> + After you have made all the changes you want, click on + <guibutton>Apply</guibutton> to apply the changes or 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>Close</guibutton> + button. The <guibutton>Help</guibutton> button brings up this chapter + of the on-line help. + </para> + + </sect4> + + + <sect4 id="gkbapplet-options"> + <title>Miscellaneous options</title> + <para> + Different options allow you to customize the look of your applet. + As a new feature, you can select between three different display modes: + <itemizedlist> + + <listitem> + <para> + Flag mode — The flag associated to the keymap is + displayed on the <interface>Panel</interface>. + </para> + </listitem> + + <listitem> + <para> + Label mode — No flag is displayed, only the label + associated with the keymap. + </para> + </listitem> + + <listitem> + <para> + Flag and label mode — Both flag and label + associated with the keymap are displayed. + </para> + </listitem> + + </itemizedlist> + </para> + <para> + Many users have reported, that the applet takes too much room on + the panel. You can now set the applets size from the + <guilabel>Applet size</guilabel> pull down list. Set the size to + <guibutton>Normal</guibutton> if you want a smaller applet. + If you have plenty of space or like nice big flags on you panel, + set the option to <guibutton>Big</guibutton>. + </para> + <para> +An often formulated user wish was to implement the keymap switching using +hotkeys. The developers proudly announce, that keyboard initiated switching now works. The hotkey combination that allows to change keymaps is set to +<keycombo><keycap>Alt</keycap><keycap>Shift</keycap></keycombo> (<keycap>Alt</keycap> being the left <keycap>Alt</keycap> key). You can customize this hotkey sequence from the <interface>GKB Properties</interface> window's +<guilabel>Options</guilabel> tab. Click on the <guibutton>Grab hotkey</guibutton> button and press the keys you want to set. The key combination is displayed in the <interface>input box</interface> near the button (you may see something like: <keysym>Control-Shift_R</keysym>). Finally, click on <guibutton>Apply</guibutton> or <guibutton>OK</guibutton> to finalize the new settings. + </para> + </sect4> + + </sect3> + +<sect3 id="gkbappplet-technical"> + <title>Technical information</title> + <para> + Normally you do not need these details - but if something is not + working, or you are just curious, read on. + </para> + <para> + <application>GNOME Keyboard</application> switches the keyboard + map by issuing a command to X Window + System. X Window System has two mechanisms for setting keyboard + mapping: older one called "xmodmap" and a newer one, based on the + so-called "Xkb extension". If you have Xkb enabled, you should use + it and switch keyboard layouts by issuing a command + <command>setxkbmap <replaceable>LC</replaceable></command>. It + comes with a number of various keyboard layout files, usually in + directory <filename>/usr/X11R6/lib/X11/xkb/symbols</filename>. + </para> + <para> If you do not have Xkb extension enabled, or if it just + does not cover the language you need, you should use the older + <command>xmodmap</command> mechanism. In this case, you need to + have a file which describes keyboard layout in a special format + (see manual page for <command>xmodmap</command> for details), and + the command should be <command>xmodmap + <replaceable>filename</replaceable> </command>. <application>GNOME + Keyboard</application> includes a + number of keyboard layout files, which are installed in the + directory <filename>/usr/share/xmodmap</filename>; these files + have names like <filename>xmodmap.de</filename>. To use one of + these files, you can use the command <command>gkb_xmmap + <replaceable>LC</replaceable></command> + which is equivalent to <command>xmodmap + /usr/share/xmodmap/xmodmap.<replaceable>LC</replaceable></command>: + for example, + <command>gkb_xmmap hu</command> is the same as <command>xmodmap + /usr/share/xmodmap/xmodmap.hu</command>. + </para> + </sect3> + + + + + <!-- ============= 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 --> + <sect3 id="gkb-bugs"> + <title>Known Bugs and Limitations</title> + <para> + <itemizedlist> + <listitem> + <para> + Languages and countries showing up in the + <interface>Select layout</interface> dialog are not sorted in + alphabetical order. + </para> + </listitem> + <listitem> +<para> +The program has very few error handling routines implemented. If you try to feed it something unusual, it may crash. +</para> +</listitem> + <listitem> +<para> +If it does not crash, it returns the error: "The keymap switching + returned an error". If the <interface>Edit</interface> window is open + when this error appears and + you press the <guibutton>OK</guibutton> button on this window, it is + likely that nothing will happen. Try closing the + <interface>Edit</interface> window first and + then the error window. +</para> +</listitem> +</itemizedlist> + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="gkb-authors"> + <title>Authors</title> + <para> + <application>GNOME KeyBoard</application> was written by Szabolcs Ban + (<email>shooby@gnome.hu</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>). 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 originally written by Szabolcs (Shooby) Ban + (<email>shooby@gnome.hu</email>) and Dan Mueth + (<email>d-mueth@uchicago.edu</email>). It has been rewritten + (strongly based on the original) by Emese Kovacs + (<email>emese@gnome.hu</email>) to reflect changes from v1.2 to v1.4. + The <link linkend="gkbappplet-technical">Technical Information</link> + section has been added by + Alexander Kirillov (<email>kirillov@math.sunysb.edu</email>). + Please send all comments + and suggestions regarding this manual to the <ulink type="http" + url="http://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/gnotes-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/gnotes-ug.sgml new file mode 100644 index 0000000..1f5cc97 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/gnotes-ug.sgml @@ -0,0 +1,293 @@ + <!-- ############### GNOTES! ############### --> + +<sect2 id="gnotes"> + <title>GNOTES! Applet</title> + + <para> + <application>GNOTES!</application> applet, shown in <xref + linkend="gnotes-fig">, allows you to cover your + GNOME desktop with little, yellow, virtual sticky-notes. To + learn how to add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>GNotes!</guimenuitem> + </menuchoice>. + </para> + + + <figure id="gnotes-fig"> + <title>GNOTES!</title> + <screenshot> + <screeninfo>GNOTES!</screeninfo> + <graphic format="png" fileref="figures/gnotes-fig" srccredit="Michael Hall"> + </graphic> + </screenshot> + </figure> + + <sect3 id="gnotes-usage"> + <title>Usage</title> + <para> + This applet places a yellow sticky-note on your desktop. To use it, + left-click on the <guiicon>GNOTES!</guiicon> icon to make a new + note appear on your desktop. After creating a new note, you may + then left-click within the yellow area of the note to begin + adding text to it. + </para> + </sect3> + + <sect3 id="gnotes-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items, the right-click pop-up menu has + the following items: + <itemizedlist> + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — opens + the <link linkend="gnotes-properties"><interface> + Properties</interface></link> dialog which allows you to + customize the appearance and behavior of this applet. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>APPLET + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Raise Notes</guimenuitem> — causes all your + notes to appear above any overlapping windows. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Lower Notes</guimenuitem> — causes all your + notes to be hidden below any overlapping windows. + </para> + </listitem> + <listitem> + <para> + <guimenuitem>Hide Notes</guimenuitem> — causes all your + notes to become hidden from view. It does not destroy your notes. + </para> + </listitem> + <listitem> + <para> + <guimenuitem>Show Notes</guimenuitem> — brings your + notes back into view if you used the + <guimenuitem>Hide Notes</guimenuitem> menu command. + </para> + </listitem> + </itemizedlist> + </para> + </sect3> + <sect3 id="individual-note-right-click"> + <title>Right-Clicking on the Left Border of Individual Notes</title> + <para> + You may also right-click on the left border of each of the notes on your + desktop to change their individual properties. + + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Raise Note</guimenuitem> — This menu + item causes your note to appear above any overlapping windows. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Lower Note</guimenuitem> — This + menu item causes your note to be placed below any overlapping + windows. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Hide Note</guimenuitem> — This menu + item causes your note to become hidden from view. It does + not destroy your note. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Destroy Note</guimenuitem> — This menu + item permanently removes your note from the desktop. Unlike + <guimenuitem>Hide Notes</guimenuitem>, you may not recover + your note. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <sect3 id="gnotes-properties"> + <title>Properties</title> + <para> + You can configure <application>GNOTES!</application> applet by + right-clicking on the applet and choosing the + <guimenuitem>Properties...</guimenuitem> menu item. This will open the + <interface>Properties</interface> dialog, shown in + <link linkend="gnotes-properties-fig">Figure 2</link>. + </para> + + <figure id="gnotes-properties-fig"> + <title>Properties Dialog</title> + <screenshot> + <screeninfo>Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/gnotes-properties" srccredit="Michael Hall"> + </graphic> + </screenshot> + </figure> + + <para> + To change the default size at which your notes appear on the desktop, you + may either click on the <guibutton>up</guibutton> and + <guibutton>down</guibutton> arrows, or type values (in pixels) directly + into the fields next to the <guilabel>Default Height</guilabel> and + <guilabel>Default Width</guilabel> labels. + </para> + + <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> +<!-- Not needed for 1.x applets + <para> + For more information on the <interface>Properties</interface> + dialog, including descriptions of the <guibutton>OK</guibutton>, + <guibutton>Apply</guibutton>, <guibutton>Cancel</guibutton>, and + <guibutton>Help</guibutton> buttons, see <xref + linkend="applet-properties-dialog">. + </para> +--> + </sect3> + + <sect3 id="gnotes-bugs"> + <title> Known Bugs and Limitations</title> + <para> + Setting the <guilabel>Default Height</guilabel> or <guilabel>Default + Width</guilabel> may cause the <application>GNOTES</application> to crash. + </para> + + <para> + After first adding <application>GNOTES!</application> to your + <interface>Panel</interface>, clicking on the first note you create may + cause a second note to be created on your desktop. + </para> + + + </sect3> + + <sect3 id="gnotes-authors"> + <title>Authors</title> + <para> + This applet was writen by spoon + <email>spoon@ix.netcom.com</email> and dres + <email>dres@debian.org</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> + The documentation for this applet + which you are reading now was written by + Michael Hall <email>mphall@cstone.net</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> + + --> + + </sect3> + + <!-- + <sect3 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> + </sect3> + --> + </sect2> + + + + + + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/gweather-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/gweather-ug.sgml new file mode 100644 index 0000000..04967d9 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/gweather-ug.sgml @@ -0,0 +1,580 @@ + <sect2 id="gweather"> + <title>GNOME Weather Applet</title> + + <para> + <application>GNOME Weather</application> applet, shown in <xref + linkend="gweatherapplet-fig">, retrieves and displays various + weather information. To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>GNOME Weather</guimenuitem> + </menuchoice>. + </para> + + <figure id="gweatherapplet-fig"> + <title>GNOME Weather Applet</title> + <screenshot> + <screeninfo>GNOME Weather Applet</screeninfo> + <graphic format="png" fileref="figures/gweather_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="gweather-usage"> + <title>Usage</title> + <para> + <application>GNOME Weather</application> displays the current + temperature and weather conditions in numeric and iconified form + inside the applet. For further information, double-click on the + applet. This will open up the <interface>Weather Information + Window</interface>, shown in <xref + linkend="gweather-weather-fig">. This displays the current weather + information and either a one-day or five-day forecast. + </para> + + <figure id="gweather-weather-fig"> + <title>Weather Information Window</title> + <screenshot> + <screeninfo>Weather Information Window</screeninfo> + <graphic format="png" fileref="figures/gweather_weather" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Update</guimenuitem> — + refreshes the weather information and display. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="gweather-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>GNOME Weather + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="gweather-prefs"> + <title>Customization</title> + <para> + You can customize <application>GNOME Weather</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="gweather-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="gweather-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/gweather_settings" + srccredit="mueth"> + </graphic> + </screenshot> + </figure> + + <para> + The properties in the <guilabel>Basic</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Update Interval — This option determines how often + <application>GNOME Weather</application> will connect + to the server(s) and retrieve weather information. Current + conditions, forecast and radar map (if enabled) will be + downloaded + </para> + <note> + <title>Note About Server Updates</title> + <para> + Note that the <guilabel>Update Interval</guilabel> only + determines how often your computer downloads information from + the server(s). The update time shown in the + <interface>Current Conditions</interface> tab (viewed by + double-clicking on the applet) indicates when those + measurements were renewed on the server, rather than when + they were last retrieved. + </para> + </note> + <note> + <title>Disabling Automatic Updates and Using Manual Updates</title> + <para> + You can disable automatic updates by unchecking the + <guilabel>Update enabled</guilabel> box. On the other hand, you can + also force <application>GNOME Weather</application> to + perform an update by choosing the corresponding option in the + popup menu. These two options are very useful if you have an + intermitant internet connection, such as a laptop or modem + provides. + </para> + </note> + </listitem> + + <listitem> + <para> + Update enabled — Select this if you would like + <application>GNOME Weather</application> to automatically + download the latest weather information at the time interval + specified by <guilabel>Update</guilabel>. Deselect this if + you would only like weather updates to be done manually, by + right-clicking on the applet and selecting + <guimenuitem>Update</guimenuitem>. + </para> + </listitem> + + <listitem> + <para> + Use metric — By default <application>GNOME + Weather</application> uses the imperial system of + units. Select this box to use metric units. The units used are shown in + <xref linkend="tab-units">. + </para> + + <table id="tab-units"> + <title>Measurement Units</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Quantity</entry> + <entry>Metric</entry> + <entry>Imperial</entry> + </row> + </thead> + <tbody> + <row> + <entry>Temperature</entry> + <entry>deg Celsius</entry> + <entry>deg Farenheit</entry> + </row> + <row> + <entry>Windspeed</entry> + <entry>km/h</entry> + <entry>mph</entry> + </row> + <row> + <entry>Pressure</entry> + <entry>mmHg</entry> + <entry>inHg</entry> + </row> + <row> + <entry>Visibility</entry> + <entry>km</entry> + <entry>miles</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para> + Detailed Forecast — Select this if you would like + <application>GNOME Weather</application> to retrieve the + full five day forecast for your particular area. Note that + these forecasts may not be + available for some locations. + </para> + <para> + The forecast retrieved when this + button is not selected is a brief + forecast for the broader area containing the selected location + (usually the entire state) and typically is a 5-day forecast. + </para> + <note> + <title>Forecast Availability</title> + <para> + Note that the detailed forecasts downloaded from IWIN are + available only for US cities. + </para> + </note> + </listitem> + +<!-- + <listitem> + <para> + Enable radar maps — this allows you to retrieve radar + maps, if these are available. These may be retrieved from the + Web, as long as a valid URL pointing to the image (in + practically any format) is provided. Check the <quote>Enable + radar maps</quote> if you want to enable this option. If a + radar image URL is not provided in the + <filename>Locations</filename> file of the standard + distribution, you can always add one using the location editor + (see <xref linkend="location-editor">). + </para> + </listitem> +--> + + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Network</guilabel> tab should be + used if your computer is located behind a firewall. These + properties are: + <itemizedlist> + + <listitem> + <para> + Use proxy — Select this button if your computer is + behind a firewall and you must use an HTTP proxy to access the + Web. + </para> + </listitem> + + <listitem> + <para> + Proxy host — Enter your proxy host IP address here (if + you are using a HTTP proxy). + </para> + </listitem> + + <listitem> + <para> + Username — Enter your username here. + </para> + </listitem> + + <listitem> + <para> + Password — Enter your password here. (Note that this + password will be saved in a private configuration file but + will not be encrypted.) + </para> + </listitem> + + </itemizedlist> + </para> + + <para> + The <guilabel>Location</guilabel> tab allows you to specify the + geographic location that you would like <application>GNOME + Weather</application> applet to display the weather information + for. Click on any plus (+) symbol to expand the tree or any minus + (-) symbol to collapse a tree branch. Select the city or region + by clicking with the first mouse button. + </para> + + <para> + Locations are organized in a three-level hierarchy. The top + level contains broader geographical areas, the second contains + sub-regions of these areas and the last contains the particular + locations. This hierarchy is essentially based on the way + information is organized in the US NWS (National Weather + Service), and that is the reason that the US and Canada appear on + the topmost level. + </para> + + <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> + </sect3> + + <!-- ============= Further Information ==================== --> + <!-- 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 --> + <sect3 id="gweather-furtherinfo"> + <title>Further Information</title> + <para> + <application>GNOME Weather</application> has a homepage at <ulink + url="http://gweather.dhs.org/">http://gweather.dhs.org/</ulink>. + Here you can find the latest <ulink + url="http://gweather.dhs.org/Locations">Locations</ulink> file, + which is periodically updated with new cities, as sent in by + users. If your city is not included in the distribution, please + send an email to Spiros Papadimitriou + (<email>spapadim+@cs.cmu.edu</email>) with the necessary + information and it will be included in the next release. + </para> + + <para> + You may also want to visit the homepage if you are curious to see + <ulink url="http://gweather.dhs.org/news.html">what's new</ulink>. + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="gweather-bugs"> + <title>Known Bugs and Limitations</title> + <sect4 id="blocking-io"> + <title>Blocking Input/Output</title> + <para> + Even though <application>GNOME Weather</application> now uses + non-blocking I/O to retrieve data from the network, there are + still some steps that block execution. Most notably, + establishing a TCP connection to remote hosts is a blocking + operation. Because the NWS and IWIN web servers are often + heavily loaded, this step may take a significant amount of time. + While that happens, the application is unable to respond to CORBA + requests from the <interface>Panel</interface>. In its current + implementation, the <interface>Panel</interface> iterates through + all applications and sends frequent CORBA requests (eg. for + saving state). If an applet cannot respond for any reason, then + the <interface>Panel</interface> will block waiting for a + response. + </para> + + <para> + While the <interface>Panel</interface> is blocked, it will not + respond to any user (or application) requests. For instance, + <interface>Panel</interface> movement and + <interface>Panel</interface> menus (the ones that appear upon a + right click) will not work. However, other applets in the + <interface>Panel</interface> should work (unless they have made a + CORBA request to the <interface>Panel</interface>, eg. for + querying <interface>Panel</interface> size). As soon as the + blocking operation in <application>GNOME Weather</application> + completes, things should return to normal (and user interface + requests that were buffered will be executed). + </para> + + <para> + There is an experimental version of <application>GNOME + Weather</application> that uses a separate thread for HTTP + processing, which may be incorporated (temporarily) in the next + release. However, the final solution is + <application>gnome-vfs</application> which will be part of GNOME + 2.0 and will offer cross-platform support for fully asynchronous + I/O. + </para> + + </sect4> + </sect3> + + + <!-- ============= FAQ ================================== --> + <!-- 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 --> + + <sect3 id="gweather-faq"> + <title>Frequently Asked Questions</title> + + <para> + This is a list of frequently asked questions about + <application>GNOME Weather</application>. For further information + and updates, please visit the <ulink + url="http://gweather.dhs.org/">GNOME Weather homepage</ulink>. If + your question is still unresolved, you can email the author at + <email>spapadim+gweather@cs.cmu.edu</email>. + </para> + + <sect4 id="unnamed1"> + <title>Why does GNOME Weather freezes my Panel?</title> + <para> + This is due to the blocking nature of certain network operations + (see also <xref linkend="blocking-io">) and due to the way the + <interface>Panel</interface> currently works. + </para> + </sect4> + + <sect4 id="unnamed2"> + <title>Why does location list appears empty?</title> + + <para> + This is probably because the <filename>Locations</filename> file + was not installed in the proper place. This is usually because + <application>GNOME Weather</application> and GNOME were not + configured in the same way. The file containing the locations + must be installed in the <filename>gweather</filename> + subdirectory, under the gnome data directory. You can find out + the latter with the <userinput>gnome-config --datadir</userinput> + command. + </para> + + <para> + If you have compiled gnome-applets yourself, make sure that you + have used <userinput>configure --prefix=`gnome-config --prefix` + --sysconfdir=`gnome-config --sysconfdir`</userinput>. Binary + RPMs assume a that the prefix and sysconfdir are + <filename>/usr</filename> and <filename>/etc</filename>, + respectively. If you have compiled GNOME yourself with different + options, you need to download and compile gnome-applets yourself. + </para> + </sect4> + + <sect4 id="unnamed3"> + <title>Why does GNOME Weather display a question mark and dashes + for current conditions?</title> + + <para> + This will happen if <application>GNOME Weather</application> + cannot access the NWS server for any reason. This may be + because your network connection is down, or the NWS server is + down, or maybe the NWS server does not currently have any + information about your location. + </para> + </sect4> + + <sect4 id="unnamed4"> + <title>Why does GNOME Weather say that a forecast is not + available?</title> + + <para> + If you have enabled detailed forecasts, then it is possible that + one may not be available for your location. In this case, try + disabling detailed forecasts. + </para> + + <para> + Another possible reason is that the IWIN server is down and + <application>GNOME Weather</application> cannot retrieve forecast + information. The problem should go away as soon as the IWIN + server is up again. + </para> + </sect4> + +<!-- + <sect4> + <title>Why is the radar map not displayed?</title> + + <para> + The most common reason is that the webserver containing the radar + image is down. You may also want to use the location editor (see + <xref linkend="location-editor">) to make sure that the radar + image URL for your location is valid. + </para> + + <para> + Also, if the image is in an uncommon format, <application>GNOME + Weather</application> may not be able to display it. Images are + displayed using the GNOME libraries, which supports practically + all available formats, so this problem should be very + rare. </para> + </sect4> +--> + + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="gweather-authors"> + <title>Authors</title> + <para> + <application>GNOME Weather</application> was written by Spiros + Papadimitriou + (<email>spapadim+@cs.cmu.edu</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 Spiros Papadimitriou + (<email>spapadim+@cs.cmu.edu</email>) and 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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/jbc-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/jbc-ug.sgml new file mode 100644 index 0000000..6208e98 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/jbc-ug.sgml @@ -0,0 +1,240 @@ + <sect2 id="jbc"> + <title>Jon's Binary Clock Applet</title> + + <para> + <application>Jon's Binary Clock</application> applet, shown in <xref + linkend="jbcapplet-fig">, shows the time in an unusual form: binary + coded decimal. It has twenty-four LEDs which represent the hours, + minutes and seconds by illuminating the appropriate LED. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Clocks</guisubmenu> + <guimenuitem>JBC Binary Clock</guimenuitem> + </menuchoice>. + </para> + + <figure id="jbcapplet-fig"> + <title>Jon's Binary Clock Applet</title> + <screenshot> + <screeninfo>Jon's Binary Clock Applet</screeninfo> + <graphic format="png" fileref="figures/jbc_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="APPLET-usage"> + <title>Usage</title> + <para> + You don't need to do anything special to this clock. It just + sits there and flashes lights at you. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Jon's Binary Clock + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Deciphering the Lights =========================== --> + <sect3 id="jbc-deciphering"> + <title>Deciphering the Lights</title> + <para> + BCD stands for binary-coded decimal, a way of representing + normal denary (0,1,2,3,4,5,6,7,8,9) numbers as what programmers + call "a set of binary numbers in four bits, thus removing the + numbers A to F". If this doesn't make sense, just be aware + that this clock is an amusement for programmers, and serves + no really useful purpose. + </para> + <para> + It helps to read this clock upside-down! Start at the bottom and + read up to the top. + </para> + <para> + The right-hand pair of columns shows the two digits of the seconds: + the units on the right, the tens on the left. The centre pair of + columns shows the two digits of the minutes. The left hand pair of + columns shows the two digits of the hours. + </para> + <para> + You add up the values of the illuminated LEDs in each column. + You should get a number between zero to nine for each. That's + the time. + </para> + <orderedlist> + <listitem> + <para> + The bottom LED represents 1 when it is illuminated. + </para> + </listitem> + + <listitem> + <para> + The next LED represents 2 when it is illuminated. + </para> + </listitem> + + <listitem> + <para> + The next LED represents 4 when it is illuminated. + </para> + </listitem> + + <listitem> + <para> + The top LED represents 8 when it is illuminated. + </para> + </listitem> + </orderedlist> + + <para> + It is probably simplest to decipher the hours and minutes + first before trying to follow the seconds, which are always + changing. + </para> + + <para> + As an example, we can read the time in <xref + linkend="jbcapplet-fig">. Let's start with the hour. The first + column has only 1 LED on, in the second lowest position, so this + gives us <quote>2</quote> for the first digit of the hour. The + second column has no LEDs on, so we have a <quote>0</quote> for + the second digit of the hour. So the hour is <quote>20</quote>, + or 8PM for people who like AM/PM notation. Looking at the + minutes, we have <quote>0</quote> for the first digit, and + <quote>1</quote> for the second digit since only the bottom LED + is lit. This gives us "20:01" so far. Lastly, we have the + seconds. For the first digit, we have the lowest two LED's + lit. These have value 1 (for the lowest) and 2 (second lowest) + for a total of <quote>3</quote>. And the second column of the + seconds has the top LED lit, with a value of + <quote>8</quote>. Thus, the time is <quote>20:01:38</quote>, or + <quote>8:01:38PM</quote>. + </para> + + </sect3> + + <!-- ============= 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 --> + <sect3 id="jbc-bugs"> + <title>Known Bugs and Limitations</title> + <para> + If you add it to a vertical panel, it is a nice size. If you then + move it to a horizonal panel, it changes size in the horizontal + panel. If you move it back to a vertical panel, it doesn't change + size back, and forces the panel to widen itself. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="jbc-authors"> + <title>Authors</title> + <para> + <application>Jon's Binary Clock</application> was written by Jon + Anhold (<email>jon@snoopy.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 Telsa Gwynne + (<email>hobbit@aloss.ukuu.org.uk</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/life-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/life-ug.sgml new file mode 100644 index 0000000..12dcf6a --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/life-ug.sgml @@ -0,0 +1,217 @@ +<sect2 id="lifeapplet"> + <title>The Life Applet</title> + <para> + The GNOME panel <application>life</application> is an applet + which runs <quote>the game of life</quote> according to Conway's rules in a + small grid in your panel, with the organism and background colour + constantly changing. It is part of the gnome-applets package. + </para> + <para> + To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Amusements</guisubmenu> + <guimenuitem>Game of Life</guimenuitem> + </menuchoice>. + or you can issue this command at a command prompt: + <command>life_applet --activate-goad-server=life_applet & </command> + </para> + + <figure id="life-applet-fig"> + <title>Life Applet</title> + <screenshot> + <screeninfo>Life Applet</screeninfo> + <graphic format="png" fileref="figures/life-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <sect3 id="lifeapplet-usage"> + <title>Usage</title> + <para> + Once it is present, you don't need to do anything to the life + applet. It will run happily on its own. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Randomize</guimenuitem> — + randomizes the game. This will stop it from + getting boring and repeating the same patterns. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about the <application>Game of Life + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + <sect3 id="lifeapplet-rules"> + <title>Rules</title> + <para> + The Game of Life as described by Conway in 1970 has the following + rules: + </para> + <itemizedlist> + <listitem> + <para> + Start with a grid (usually a plain square) of squares. Fill + a proportion of them with cells, randomly placed. This is generation + zero. + </para> + </listitem> + <listitem> + <para> + Any cell with two or three neighbours survives to the next + generation. + </para> + </listitem> + <listitem> + <para> + On any square with no cell and three neighbours, a new cell is + born. On any other square, no new cells are born. + </para> + </listitem> + <listitem> + <para> + Repeat generations. + </para> + </listitem> + </itemizedlist> + + <para> + The game will eventually end in one of a number of ways: + </para> + + <itemizedlist> + <listitem> + <para> + The death of all cells (theoretical, but uncommon in the life + applet). + </para> + </listitem> + <listitem> + <para> + A fixed equilibrium with all remaining cells surviving but + creating no new cells. + </para> + </listitem> + <listitem> + <para> + A dynamic equilibrium where the game cycles continually through + a particular sequence of patterns. + </para> + </listitem> + </itemizedlist> + + <para> + For interest value, the current grid in the life applet is 78 by 78 + and the proportion of squares filled with cells is 50%. + </para> + </sect3> + + <sect3 id="lifeapplet-bugs"> + <title>Known Bugs and Limitations</title> + <para> + None known. + </para> + </sect3> + + <sect3 id="life-authors"> + <title>Authors</title> + <para> + The <application>Life Applet</application> was written by George Lebl + (<email>jirka@5z.com</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 Telsa Gwynne (<email>telsa@linuxchix.org</email>) + and Eric Baudais (<email>baudais@okstate.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> + + --> + + </sect3> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/loadavg-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/loadavg-ug.sgml new file mode 100644 index 0000000..96450a7 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/loadavg-ug.sgml @@ -0,0 +1,305 @@ +<!-- Permission is granted to make and distribute verbatim copies of --> +<!-- this manual provided the copyright notice and this permission --> +<!-- notice are preserved on all copies. --> +<!-- --> +<!-- Permission is granted to copy and distribute modified versions of --> +<!-- this manual under the conditions for verbatim copying, provided --> +<!-- that the entire resulting derived work is distributed under the --> +<!-- terms of a permission notice identical to this one. --> +<!-- --> +<!-- Permission is granted to copy and distribute translations of this --> +<!-- manual into another language, under the above conditions for --> +<!-- modified versions, except that this permission notice may be --> +<!-- stated in a translation approved by the Foundation. --> + + <sect2 id="loadavg-applet"> + <title>The load average applet</title> + + <para> + The <application>loadavg_applet</application> is a small monitor + applet which sits in your panel and tells you the current load + average. + </para> + + <para> + The load average of a machine is a rather arbitrary number which + represents how "busy" your machine is. It is calculated as an + average of (very roughly) how many processes there are which are + either running or are waiting for a wake-up call from the kernel. + It is very useful for comparing over time with different load + averages on your machine, but it is not very useful to compare + it with other machines. Normally, it is represented as a fraction. + + <figure id="loadavg-applet-fig"> + <title>Load Average Applet</title> + <screenshot> + <screeninfo>Load Average Applet</screeninfo> + <graphic format="png" fileref="figures/loadavg-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + </para> + + <sect3 id="loadavg-usage"> + <title>Usage</title> + <para> + You don't need to do anything to this applet. It will sit and + run in your panel. Various options to alter its display are + available. + </para> + </sect3> + + <sect3 id="loadavg-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items, + the right-click pop-up menu has the following items: + </para> + + <variablelist> + <varlistentry> + <term>Default Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="loadavg-properties">described below</link> which allows + you to alter the default properties of this and related monitor + applets. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="loadavg-properties">described below</link> which + affects only the <application>loadavg_applet</application> + properties. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Run gtop...</term> + <listitem> + <para> + This option will run the <command>gtop</command> which + starts up the GNOME System Monitor. <application>gtop</application> + gives a much more detailed look at your system and what's happening + on it. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="loadavg-properties"> + <title>Properties</title> + + <figure id="loadavg-default-fig"> + <title>Default Properties Dialog</title> + <screenshot> + <screeninfo>Load Average Applet Default Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/loadavg-applet-default" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Like several of the monitor applets, + <application>loadavg_applet</application> has two ways of setting + preferences. You can make changes that affect any of this group of + applets, + (<application>cpuload_applet</application>, <application>memload_applet</application>, + <application>swapload_applet</application>, <application>netload_applet</application> + and <application>loadavg_applet</application>) in one large dialogue + box. This is useful if you run one or more of them. These are the + settings used by default. They are reached from the + <guimenuitem>Default Properties...</guimenuitem> menu item. + </para> + + <figure id="loadavg-greyed-fig"> + <title>Greyed Out Properties Dialog</title> + <screenshot> + <screeninfo>Load Average Applet Greyed Out Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/loadavg-applet-greyed" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Or you can change just the properties for + <application>loadavg_applet</application>. This is useful for when + you only use <application>loadavg_applet</application> or want to + try new combinations out. It is reached from the + <guimenuitem>Properties</guimenuitem> menu item. + </para> + <note> + <para> + If you use the <guimenuitem>Properties...</guimenuitem> menu item + and edit the preferences for just this applet, you must uncheck + the <guibutton>Use default properties</guibutton> checkbox before + you can alter any settings. + </para> + </note> + + <figure id="loadavg-properties-fig"> + <title>Load Average Properties Dialog</title> + <screenshot> + <screeninfo>Load Average Applet Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/loadavg-applet-properties" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The changes you can make to the properties are four: + </para> + + <variablelist> + <varlistentry> + <term>Colours</term> + <listitem> + <para> + You can alter the colours used for the applet's display + clicking on the colour boxes. This invokes the GNOME colour wheel. + The titles are a little misleading. "Used" is the current load + average, and "free" is the background colour. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Speed</term> + <listitem> + <para> + You can alter the speed that the graph proceeds with this. + It is measured in milliseconds. The default is 500. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Size</term> + <listitem> + <para> + You can alter the size of the applet with this. It is measured + in pixels. The default value is 40, and the range is from 1 pixel + to whatever you like. In a vertical panel, this refers to the + height. In a horizontal panel, it refers to the width. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Maximum</term> + <listitem> + <para> + This is the maximum number in the Y axis (the possible + maximum load average which the applet will show). The default + is 10. + </para> + <note> + <para> + This option is only available from the <guimenuitem>Default + Properties menu option</guimenuitem>. It does not appear on + the dialogue box which is started by the + <guimenuitem>Properties menu option</guimenuitem>. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="loadavg-bugs"> + <title> Known Bugs and Limitations</title> + <para> + Resizing and then altering the panel orientation can still cause + intermittent problems, although they now fix themselves after a + short period. + </para> + </sect3> + + <sect3 id="loadavg-authors"> + <title>Authors</title> + <para> + This applet was writen by Martin Baulig (<email>martin@home-of-linux.org</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 Telsa Gwynne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.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> + + --> + + </sect3> + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml new file mode 100644 index 0000000..bd9f554 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mailcheck-ug.sgml @@ -0,0 +1,345 @@ + <sect2 id="applets-core-mailcheck"> + <title>The Mail Check Applet</title> + + <para> + The <application>mailcheck applet</application> is an applet which + sits in your panel and tells you when you have new email. To add + this applet to the panel, right-click on the panel and choose + <menuchoice> + <guimenu>Add applet</guimenu> + <guisubmenu>Network</guisubmenu> + <guimenuitem>Mailcheck</guimenuitem> + </menuchoice> + </para> + + <figure id="mailcheck-applets-core-fig"> + <title>Mail Check Applet</title> + <screenshot> + <screeninfo>Mail Check Applet</screeninfo> + <graphic format="png" fileref="figures/mailcheck-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <sect3 id="mailcheck-usage"> + <title> Usage</title> + <para> + You don't need to do anything in particular to run this applet. + Providing it is looking in the right place for your email, it + will run itself quite happily. The following options, however, + are available: + </para> + + <itemizedlist> + <listitem> + <para> + Clicking <mousebutton>mouse button 1</mousebutton> does nothing + unless you have told it to start a program when you do this. You + do this with the properties box described <link + linkend="mailcheck-prefs">below</link>. + </para> + </listitem> + <listitem> + <para> + Holding down <mousebutton>mouse button 2</mousebutton> allows + you to drag the applet around the panel (and between panels). + option. + </para> + </listitem> + <listitem> + <para> + Clicking <mousebutton>mouse button 3</mousebutton> brings up + the typical <guimenu>applet menu</guimenu> which includes an + About box and a <link linkend="mailcheck-prefs">properties</link> + </para> + </listitem> + </itemizedlist> + </sect3> + + <sect3 id="mailcheck-prefs"> + <title>Preferences</title> + <para> + The mailcheck <interface>properties dialogue box</interface> is + divided into two sections, one for what the mail check applet + does, and one for where it checks for email. + </para> + + <figure id="mailcheck-settings-mailcheck-fig"> + <title>Properties dialog — Mail check tab</title> + <screenshot> + <screeninfo>Properties dialog - Mail check tab</screeninfo> + <graphic format="png" fileref="figures/mailcheck-properties-mailcheck" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <variablelist> + <varlistentry> + <term>Mail check options</term> + <listitem> + <para> + The mail check options have six sections: + </para> + + <variablelist> + <varlistentry> + <term>Execute...before each update</term> + <listitem> + <para> + Sometimes you may want to run something such as + <application>fetchmail</application> before the applet + checks for new mail. To do this, check the checkbox and + fill in the program name in the space here. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Execute...when new mail arrives</term> + <listitem> + <para> + Sometimes you may want other programs to run when new mail + arrives. It is common to tell the machine to play a noise + at you, for example. Checking this checkbox and filling in + the command (such as <command>mpg123 + <replaceable>sillynoise.mpg</replaceable></command> or + <command>esdplay + <replaceable>sillynoise.wav</replaceable></command>) will + let this happen. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Execute...when clicked</term> + <listitem> + <para> + By putting a program name (generally a mail-reader such as + <application>balsa</application> or <application>spruce</application> + here and clicking on the checkbox, you can set things up so that + when you click <mousebutton>button 1</mousebutton> on the + applet, that program will be automatically run. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Check for mail every...</term> + <listitem> + <para> + You can adjust the range for checking whether mail has arrived + between 1440 minutes (once a day) to never. Setting it to never + is silly and will confuse it. The default value is every two + minutes. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Play a sound when new mail arrives</term> + <listitem> + <para> + The sound played if you check this <guibutton>checkbox</guibutton> + is an alarm bell. It is contained in + <filename>$prefix/sound/events/mailcheck.soundlist</filename>; + if you want to change it to a different sound, alter that and + put the sound in <filename>$prefix/sounds/</filename>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Select animation</term> + <listitem> + <para> + By clicking on the <guilabel>box with the animation name</guilabel>, + you can get a list of different pictures which have different + animations when new email arrives. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + </variablelist> + + <figure id="mailcheck-settings-mailbox-fig"> + <title>Properties dialog — Mailbox tab</title> + <screenshot> + <screeninfo>Properties dialog - Mailbox tab</screeninfo> + <graphic format="png" fileref="figures/mailcheck-properties-mailbox" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <variablelist> + <varlistentry> + <term>Mailbox options</term> + <listitem> + <para> + The mailbox options have four sections, some of which will be + greyed-out. + </para> + + <para> + By clicking on the <guilabel>box with the mailbox location</guilabel>, + you can tell the mailcheck applet where to look for your incoming + email. + </para> + <itemizedlist> + <listitem> + <para> + When local mailspool or local maildir are selected as the location + for the mailbox, then you can fill in the details on which file + or directory the applet should check for new email. You can only + put one filename here. The section about mail servers will be + greyed out. + </para> + </listitem> + <listitem> + <para> + When remote POP3 or remote IMAP are selected as the location for + the mailbox, then you can fill in the details on the mail server, + username and password. If the you don't supply the password, the + applet will ask for it when it first tries to check for mail. + The section about local filenames will be greyed out. + </para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="mailcheck-bugs"> + <title> Known bugs and limitations</title> + <itemizedlist> + <listitem> + <para> + Setting something to be executed before each update can hang the + applet and the panel. + </para> + </listitem> + <listitem> + <para> + Sometimes the animation stops happening after prolonged use. + </para> + </listitem> + <listitem> + <para> + If you use a mail filter such as <application>procmail</application>, + which sorts email into different folders, the applet won't check them + all for new email. It will only look at one file. + </para> + </listitem> + </itemizedlist> + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="mailcheck-authors"> + <title>Authors</title> + <para> + <application>Mail Check</application> was written by + Miguel de Icaza (<email>miguel@gnu.org</email>), + Jacob Berkman (<email>jberkman@andrew.cmu.edu</email>), + Jaka Mocnik (<email>jaka.mocnik@kiss.uni-lj.si</email>) and + Lennart Poettering (<email>poettering@gmx.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 Telsa Gwynne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.edu</email>). Please send all comments + and suggestions regarding this manual to the <ulink type="http" + url="http://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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 + <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General + Public License</citetitle></ulink> for more details. + </para> + <para> + A copy of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> is included with the GNOME documentation. You + also may obtain a + copy of the <ulink type="help" url="gnome-help:gpl"><citetitle>GNU + General Public License</citetitle></ulink> 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> + </sect3> + + --> + </sect2> + + + + + + + + + + + + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/memload-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/memload-ug.sgml new file mode 100644 index 0000000..2a3bb0a --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/memload-ug.sgml @@ -0,0 +1,329 @@ +<!-- Permission is granted to make and distribute verbatim copies of --> +<!-- this manual provided the copyright notice and this permission --> +<!-- notice are preserved on all copies. --> +<!-- --> +<!-- Permission is granted to copy and distribute modified versions of --> +<!-- this manual under the conditions for verbatim copying, provided --> +<!-- that the entire resulting derived work is distributed under the --> +<!-- terms of a permission notice identical to this one. --> +<!-- --> +<!-- Permission is granted to copy and distribute translations of this --> +<!-- manual into another language, under the above conditions for --> +<!-- modified versions, except that this permission notice may be --> +<!-- stated in a translation approved by the Foundation. --> + + <sect2 id="memload-applet"> + <title>The memory load applet</title> + + <para> + The <application>memload_applet</application> is a small monitor + applet which sits in your panel and tells you how much memory is + being used. + </para> + + <sect3 id="memload-usage"> + <title>Usage</title> + <para> + You don't need to do anything to this applet. It will sit and + run in your panel. Various options to alter its display are + available. + </para> + + <figure id="memload-applet-fig"> + <title>MEM Load Applet</title> + <screenshot> + <screeninfo>MEM Load Applet</screeninfo> + <graphic format="png" fileref="figures/memload-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The applet shows four different uses of memory: + </para> + <variablelist> + <varlistentry> + <term>Free</term> + <listitem> + <para> + Free memory is memory which is not being used by any program. + The default colour is green. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Buffers</term> + <listitem> + <para> + Buffers hold data which has not yet been written to the disk. + They also hold data which has been recently read from the disk, + keeping it around in case it is needed again. The default colour + is grey. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Shared memory</term> + <listitem> + <para> + Shared memory is memory which more than one program is using. + This is a very common thing to do on UNIX systems. Many GNOME + programs use a lot of shared memory, which cuts down on the + total memory used. The default colour is yellow. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Other</term> + <listitem> + <para> + Memory being used in other ways is shown in this category. The + default colour is a greenish-yellow. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="memload-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items, the right-click pop-up menu + has the following items: + </para> + + <variablelist> + <varlistentry> + <term>Default Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="memload-properties">described below</link> which allows + you to alter the default properties of this and related monitor + applets. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="memload-properties">described below</link> which + affects only the <application>memload_applet</application> + properties. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Run gtop...</term> + <listitem> + <para> + This option will run the <command>gtop</command> which + starts up the GNOME System Monitor. <application>gtop</application> + gives a much more detailed look at your system and what's happening + on it. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="memload-properties"> + <title>Properties</title> + + <figure id="memload-default-fig"> + <title>Default Properties Dialog</title> + <screenshot> + <screeninfo>MEM Load Applet Default Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/memload-applet-default" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Like several of the monitor applets, + <application>memload_applet</application> has two ways of setting + preferences. You can make changes that affect any of this group of + applets + (<application>cpuload_applet</application>, <application>memload_applet</application>, + <application>swapload_applet</application>, <application>netload_applet</application> + and <application>loadavg_applet</application>) in one large dialogue + box. This is useful if you run one or more of them. These are the + settings used by default. They are reached from the + <guimenuitem>Default Properties...</guimenuitem> menu item. + </para> + + <figure id="memload-greyed-fig"> + <title>Greyed Out Properties Dialog</title> + <screenshot> + <screeninfo>MEM Load Applet Greyed Out Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/memload-applet-greyed" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Or you can change just the properties for + <application>memload_applet</application>. This is useful for when + you only use <application>memload_applet</application> or want to + try new combinations out. It is reached from the + <guimenuitem>Properties</guimenuitem> menu item. + </para> + <note> + <para> + If you use the <guimenuitem>Properties...</guimenuitem> menu item + and edit the preferences for just this applet, you must uncheck + the <guibutton>Use default properties</guibutton> checkbox before + you can alter any settings. + </para> + </note> + + <figure id="memload-properties-fig"> + <title>MEM Load Properties Dialog</title> + <screenshot> + <screeninfo>MEM Load Applet Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/memload-applet-properties" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The changes you can make to the properties are three: + </para> + + <variablelist> + <varlistentry> + <term>Colours</term> + <listitem> + <para> + You can alter the colours used for the different categories of memory + the applet displays by clicking on the colour boxes. This + invokes the GNOME colour wheel. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Speed</term> + <listitem> + <para> + You can alter the speed that the graph proceeds with this. + It is measured in milliseconds. The default value is 500. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Size</term> + <listitem> + <para> + You can alter the size of the applet with this. It is measured + in pixels. The default value is 40, and the range is from 1 pixel + to whatever you like. In a vertical panel, this refers to the + height. In a horizontal panel, it refers to the width. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="memload-bugs"> + <title> Known Bugs and Limitations</title> + <para> + Resizing and then altering the panel orientation can still cause + intermittent problems, although they now fix themselves after a + short period. + </para> + </sect3> + + <sect3 id="memload-authors"> + <title>Authors</title> + <para> + This applet was writen by Martin Baulig (<email>martin@home-of-linux.org</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 Telsa Gywnne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.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> + + --> + + </sect3> + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> + + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml new file mode 100644 index 0000000..65cdcff --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mini-commander-ug.sgml @@ -0,0 +1,402 @@ + <sect2 id="mini-commander"> + <title>Mini-Commander Applet</title> + + <para> + <application>Mini-Commander</application> applet, shown in <xref + linkend="mini-commander-applet-fig">, adds a command line to your + <interface>Panel</interface>. It features command completion, + command history, changeable macros and an optional built-in clock. + Because of the changeable macros you can use it for many different + tasks. You can simply start a program (or a short macro) or view a + web page or search for a man/info page + etc. <application>Mini-Commander</application> can be detached from + your <interface>Panel</interface> using an optional handler on the + side, which is especially usefull for people who use vertical + panels. + </para> + <para> + To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Mini-Commander</guimenuitem> + </menuchoice>. + </para> + + <figure id="mini-commander-applet-fig"> + <title>Mini-Commander Applet</title> + <screenshot> + <screeninfo>Mini-Commander Applet</screeninfo> + <graphic format="png" fileref="figures/mini-commander_applet" + srccredit="Martin Baulig"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="APPLET-usage"> + <title>Usage</title> + + <para> + To start a program or run a command, simply enter the program or + command and press return. Or, to browse for an application or command + in your filesystem, click on the small <guiicon>circle</guiicon> + in the lower corner. + </para> + <para> + <application>Mini-Commander</application> has command + completion (similar to many other user shells). Thus, you often + have not to enter the full name but only the first few characters + followed by the <keycap>tab</keycap> + key. <application>Mini-Commander</application> will try to + complete the program name in the same way most UNIX shells do. + </para> + <para> + <application>Mini-Commander</application> also has command + history, which allows you to recall previous commands by pressing + the <keycap>arrow-up</keycap> or <keycap>arrow-down</keycap> + key. This works like the command history in most UNIX shells. Note + that commands are not stored in the history if it is already + present in the history in order to avoid duplication. You may + also access the history list by pressing the small <guibutton>down + arrow icon</guibutton> in the applet and selecting a command from + the history list. + </para> + <para> + <application>Mini-Commander</application> has the ability to use + macros. It has some predefined macros. For example if + you enter + <command>term:<replaceable>command</replaceable></command> then + <command><replaceable>command</replaceable></command> is executed + in a terminal window. Or if you enter an URL then your web browser is + used to view it. Additionally you can define your own macros or + change the predefined ones. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="mini-commander-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Mini-commander + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="mini-commander-prefs"> + <title>Customization</title> + <para> + You can customize <application>Mini-Commander</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="mini-commander-settings-fig-1">), which allows you to + change various settings. + </para> + + <figure id="mini-commander-settings-fig-1"> + <title>Properties dialog: General Tab</title> + <screenshot> + <screeninfo>Properties dialog: General Tab</screeninfo> + <graphic format="png" fileref="figures/mini-commander_settings_general" + srccredit="Martin Baulig"> + </graphic> + </screenshot> + </figure> + + <para> + The properties in the <guilabel>General</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Show time — If this button is checked, the time will be + shown in the lower corner of the applet. + </para> + </listitem> + + <listitem> + <para> + Show date — If this button is checked, the date will be + shown in the lower corner of the applet. + </para> + </listitem> + + <listitem> + <para> + Show handle — If this button is checked, a handle will + be attached to the edge of the applet, allowing you to detach + the applet from the <interface>Panel</interface>. You may + re-attach the applet on the <interface>Panel</interface> by + dragging it back into place. + </para> + </listitem> + + <listitem> + <para> + Show frame — If this button is checked, a thin black + frame will be drawn around the applet. + </para> + </listitem> + + <listitem> + <para> + Enable history based auto completion — If this button is + selected, <application>Mini-Commander</application> will + automatically complete commands using the history list. + </para> + </listitem> + + <listitem> + <para> + Applet width — Enter the desired applet width here. + </para> + </listitem> + + <listitem> + <para> + Applet height — Enter the desired applet height here. + </para> + </listitem> + + <listitem> + <para> + Command line height — (This feature is disabled.) + </para> + </listitem> + + <listitem> + <para> + Command line foreground — Select the foreground color, + used for the text you enter. + </para> + </listitem> + + <listitem> + <para> + Command line background — Selecting the background + color, used for the background behind the text in the entry. + </para> + </listitem> + + </itemizedlist> + </para> + +<!-- + <figure id="mini-commander-settings-fig-2"> + <title>Properties dialog: Macros Tab</title> + <screenshot> + <screeninfo>Properties dialog: Macros Tab</screeninfo> + <graphic format="png" fileref="figures/mini-commander_settings_macros" + srccredit="Martin Baulig"> + </graphic> + </screenshot> + </figure> +--> + + <para> + The <guilabel>Macros</guilabel> tab consists of a list of up to + 99 macros, each of which is a regular expression + (<guilabel>Regex</guilabel>) and a macro + (<guilabel>Macro</guilabel>). Enter the regular expression for + <application>Mini-Commander</application> to match in the left + column, and the corresponding macro which should be executed in + the right column. The default setting has many useful macros + already defined, which may be helpful in learning to write your + own macros. + </para> + + <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>Close</guibutton> button. + </para> + </sect3> + + + <!-- ============= Freq. Asked Questions ==================== --> + <sect3 id="faq"> + <title>Frequently Asked Questions</title> + + <para> + Here are listed some frequently asked questions and the answers to + them. + </para> + + <qandaset> + <qandaentry> + <question> + <para> + Why am I not able to give + <application>Mini-Commander</application> keyboard focus? + </para> + </question> + <answer> + <para> + This is a confusing problem which seems to have several reasons + and which occurs only under certain conditions. + </para> + + <para> + If you cannot give <application>Mini-Commander</application> + applet keyboard focus at all then this could be a problem with + you window manager. If this is true for you it would helpful + if you write me a short mail and tell me what window manager + you are using (name and version). + </para> + + <para> + Sometimes it happens that you can give keyboard focus to + <application>Mini-Commander</application> applet only for the + first time. After this it is impossible + to focus it again. Currently the reason for this bug is + unknown. + </para> + + </answer> + </qandaentry> + + </qandaset> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="mini-commander-bugs"> + <title>Known Bugs and Limitations</title> + <para> + In some instances, it is impossible to give + <application>Mini-Commander</application> focus after the first + time. + </para> + </sect3> + + + <!-- ============= Further Information ==================== --> + <sect3 id="furtherinfo"> + <title>Further Information</title> + <para> + For more information on <application>Mini-Commander</application> + applet, check out its web page at <ulink + url="http://www.maruhn.com/mini-commander/"> + http://www.maruhn.com/mini-commander/</ulink>. + </para> + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="mini-commander-authors"> + <title>Authors</title> + <para> + <application>Mini-Commander</application> was written by Oliver Maruhn + (<email>oliver@maruhn.com</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 Oliver Maruhn + (<email>oliver@maruhn.com</email>). Minor modifications and + updates were made 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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/mixer-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mixer-ug.sgml new file mode 100644 index 0000000..f630387 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/mixer-ug.sgml @@ -0,0 +1,193 @@ + <sect2 id="mixerapplet"> + <title>Mixer Applet</title> + + <para> + <application>Mixer</application> applet, shown in <xref + linkend="mixerapplet-fig">, provides a simple and + convenient interface for controlling the sound volume and launching + the <application>Audio Mixer</application>. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Multimedia</guisubmenu> + <guimenuitem>Mixer</guimenuitem> + </menuchoice>. + </para> + + <figure id="mixerapplet-fig"> + <title>Mixer Applet</title> + <screenshot> + <screeninfo>Mixer Applet</screeninfo> + <graphic format="png" fileref="figures/mixer_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="mixerapplet-usage"> + <title>Usage</title> + <para> + To adjust the volume, slide the volume bar up (louder) or down + (quieter). To mute (or un-mute) the volume, press the speaker + icon at the bottom of the applet. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Run Audio Mixer…</guimenuitem> — starts + the <application>Gmix Audio Mixer</application> + application. The contents of this audio mixer will vary, + depending upon the capabilities of your sound card. + However, it typically allows you to control the volume + level of the different sound input devices, such as the CD + player, microphone, and line. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Mixer</application> + applet, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + + <note> + <title>Note About Sound in GNOME</title> + <para> + For sound to work in GNOME, you must have sound enabled in the + <application>Control Center</application>. To configure sound, + click on the <guibutton>Main Menu</guibutton> button (the foot + icon) and select + <menuchoice> + <guimenu>Programs</guimenu> + <guisubmenu>Setting</guisubmenu> + <guisubmenu>Multimedia</guisubmenu> + <guimenuitem>Sound</guimenuitem> + </menuchoice>. Make sure both sound options are enabled in the + <guilabel>General</guilabel> tab. Feel free to configure and + test things in the <guilabel>Sound Events</guilabel> section. + Note that you may have to exit GNOME and restart for sound to + work properly after enabling it in the <application>Control + Center</application> for the first time. + </para> + </note> + + </sect3> + + + <!-- ============= 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 --> + <sect3 id="mixerapplet-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="mixerapplet-authors"> + <title>Authors</title> + <para> + <application>Mixer</application> applet was written by Michael Fulbright + (<email>msf@redhat.com</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/modemlights-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/modemlights-ug.sgml new file mode 100644 index 0000000..462d71b --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/modemlights-ug.sgml @@ -0,0 +1,317 @@ +<sect2 id="modemlights"> + <title>Modem Lights Applet</title> + + <para> <application>Modem Lights Applet</application>, shown in <xref + linkend="modemlights-fig1">, monitors your modem while it is + working. To add this applet to a <interface>Panel</interface>, + right-click on the panel + and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Network</guisubmenu> + <guimenuitem>Modem Lights</guimenuitem> + </menuchoice> + </para> + + + <figure id="modemlights-fig1"> + <title>Modem Lights Applet</title> + <screenshot> + <screeninfo>Modem Lights Applet</screeninfo> + <graphic format="png" fileref="figures/modemlights" srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + + + <sect3 id="modemlights-usage"> + <title>Usage</title> + <para>This applet can be used to tell if your modem is working, + and to track its behavior and performance. It can also be + configured to call a separate script or program to have your modem + connect and disconnect when you click on the <guibutton>button + with the single green light</guibutton>. + </para> + <para>Right-clicking on the applet brings up a menu containing the + following items: +<itemizedlist> + <listitem> + <para> + <guimenuitem>Properties</guimenuitem>— brings up + <link linkend="modemlights-prefs"> + <guilabel>Properties</guilabel> + </link> dialog + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — brings up this + document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About</guimenuitem> — shows basic + information about the <application>Modem Lights + Applet</application>, including the applet's version and + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + <!-- ============= Customization ============================= --> + <sect3 id="modemlights-prefs"> + <title>Customization</title> + <para> + You can customize <application>Modem Lights Applet</application> by + right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Modem Lights Settings</interface> dialog (shown in <xref + linkend="modemlights-fig2">, which allows you to + change various settings. + </para> + <figure id="modemlights-fig2"> + <title>Preferences dialog</title> + <screenshot> + <screeninfo>Preferences dialog</screeninfo> + <graphic format="png" fileref="figures/modemlights-prefs" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + <para> + The properties are: + <itemizedlist> + + <listitem> + <para><guilabel>Show connect time and + throughput</guilabel> &mdash have <application>Modem + Lights Applet's</application> graphic display expand to include + two small text boxes showing the current data transfer rate (top) + and connect time (bottom).</para> + + <para><guilabel>Connect command:</guilabel> and + <guilabel>Disconnect command: </guilabel> — To use + <application>Modem Lights Applet</application> to initiate a + connection, place the name of the startup command in the + <guilabel>Connect command</guilabel> text box, and the disconnect + command in the box beneath it labeled <guilabel>Disconnect + command</guilabel>. When you click on the single button on the + applet, it will connect or disconnect your modem.</para> +</listitem> + <listitem> + <para><guilabel>Confirm connection</guilabel> — + Display a dialog box confirming your connection.</para> + </listitem> + + <listitem> + <para> + <guilabel>Updates per second</guilabel> — Set the update + rate of <application>Modem Lights + Applet's</application> display.</para> + </listitem> + <listitem> + <para><guilabel>Show connect time and + throughput</guilabel> — add two text windows to the + applet showing the time you have been connected at the data + transfer rate. This is a good way to monitor your modem's + performance.</para> + </listitem> + </itemizedlist> + + </para> + + <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> + + <figure id="modemlights-fig3"> + <title>Advanced preferences dialog</title> + <screenshot> + <screeninfo>Advanced preferences dialog</screeninfo> + <graphic format="png" fileref="figures/modemlights-advpref" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + <para><application>Modem Lights Applet's</application> + <interface>Advanced preferences window</interface> allows you to + control advanced features of the applet.</para> + + <para> + The properties are: + <itemizedlist> + + <listitem> + <para><guilabel>Modem lock file:</guilabel> — + specifies the file created by the computer when the modem is + working, allowing other programs to know it is in + operation. <filename>/var/lock/LCK..modem</filename>, the default + setting, is the most common, if your computer uses a symbolic link + from <filename>/dev/modem</filename> to the actual modem + device. Check with your system administrator to see if a different + device name and therefore lock file is in use. <application>Modem + Lights Applet</application> needs this information to find and + monitor your modem.</para> + </listitem> + + <listitem> + <para><guilabel>Verify owner of lock file</guilabel> + — verify that the lockfile really belongs to the + currently running PPP daemon and is not left over from an + older one. This is checked by default and shouldn't be changed.</para> + + + + </listitem> + + <listitem> + <para><guilabel>Device</guilabel> — Device, typically + <filename>ppp0</filename> on a Linux machine, is the name of the + network interface being used by the modem. If + <filename>ppp0</filename> is not correct for your machine, check + your system documentation for the correct designation.</para> + + <para>Other possible network interface names commonly used include + <filename>ippp0</filename> for Linux ISDN; + <filename>isp0</filename> for NetBSD ISDN and + <filename>ipdptp0</filename> for Solaris PPP.</para> + + + + </listitem> +<listitem> + <para><guilabel>Use ISDN</guilabel> — If you use + an ISDN modem, check the <guilabel>Use ISDN</guilabel> + checkbox. <application>Modem Lights Applet</application> will then + ignore all the settings above related to standard modems.</para> + </listitem> + </itemizedlist> + </para> + + <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> + + + + + + + <para> After you made all the choices you want, click on + <guibutton>OK</guibutton> to make the changes and close the + <interface>Properties</interface> dialog. To cancel the changes + and return to previous values, click on + <guibutton>Cancel</guibutton> button. + </para> + </sect3> + + <sect3 id="modemlights-bugs"> + <title> Known bugs and limitations</title> + <para> + The <guilabel>Verify lock file</guilabel> check box on the + advanced preferences window should always be left true. It is + likely to be removed from future versions of <application>Modem + Lights Applet.</application> + </para> + </sect3> + + + + <!-- ============= Authors ================================ --> + + <sect3 id="modemlights-authors"> + <title>Authors</title> + <para> + <application>Modem Lights Applet</application> was written by + John Ellis (<email>johne@bellatlantic.net</email>) and Martin + Baulig (<email>martin@home-of-linux.org</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 John Fleck + (<email>jfleck@inkstain.net</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + +--> + </sect2> + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/netload-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/netload-ug.sgml new file mode 100644 index 0000000..2d806f2 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/netload-ug.sgml @@ -0,0 +1,333 @@ +<!-- Permission is granted to make and distribute verbatim copies of --> +<!-- this manual provided the copyright notice and this permission --> +<!-- notice are preserved on all copies. --> +<!-- --> +<!-- Permission is granted to copy and distribute modified versions of --> +<!-- this manual under the conditions for verbatim copying, provided --> +<!-- that the entire resulting derived work is distributed under the --> +<!-- terms of a permission notice identical to this one. --> +<!-- --> +<!-- Permission is granted to copy and distribute translations of this --> +<!-- manual into another language, under the above conditions for --> +<!-- modified versions, except that this permission notice may be --> +<!-- stated in a translation approved by the Foundation. --> + + <sect2 id="netload-applet"> + <title>The net load applet</title> + + <para> + The <application>netload_applet</application> is a small monitor + applet which sits in your panel and tells you about the load on +different network interfaces. + </para> + + + <sect3 id="netload-usage"> + <title>Usage</title> + <para> + You don't need to do anything to this applet. It will sit and + run in your panel. Various options to alter its display are + available. + </para> + + <figure id="netload-applet-fig"> + <title>Net Load Applet</title> + <screenshot> + <screeninfo>Net Load Applet</screeninfo> + <graphic format="png" fileref="figures/netload-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + It displays details for four different types of network interfaces: + </para> + <variablelist> + <varlistentry> + <term>SLIP</term> + <listitem> + <para> + SLIP is the serial line IP protocol. It is not commonly used + any more, being largely replaced by PPP, but it is one way of + connecting a computer to other machines which was popular for + modems. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>PPP</term> + <listitem> + <para> + PPP is the Point to Point Protocol, for connecting one computer + to another. It has largely replaced SLIP. It is effective and + flexible but not as fast as ethernet. This is probably the most + common way people connect from home to the internet. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>ETH</term> + <listitem> + <para> + Ethernet is another method for connecting machines together. + It requires an ethernet card in the computer and a piece of + ethernet cable connecting it to the other machine to talk to. + It's a lot faster than PPP. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Other</term> + <listitem> + <para> + Other forms of networking are available, such as ways to + talk over infra-red beams (IRDA), ways to talk over amateur + radio (AX25), and token-ring networks. Anything the applet + finds which is not SLIP, PPP or ethernet is monitored under + 'other'. + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + If you have two interfaces of the same type running (for example, + two ethernet interfaces talking to different machines), what is + displayed is the sum total of the two. The applet will not divide + it into two sections. + </para> + </sect3> + + <sect3 id="netload-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items, the right-click pop-up + menu has the following items: + </para> + + <variablelist> + <varlistentry> + <term>Default Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="netload-properties">described below</link> which allows + you to alter the default properties of this and related monitor + applets. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="netload-properties">described below</link> which + affects only the <application>netload_applet</application> + properties. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Run gtop...</term> + <listitem> + <para> + This option will run the <command>gtop</command> which + starts up the GNOME System Monitor. <application>gtop</application> + gives a much more detailed look at your system and what's happening + on it. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="netload-properties"> + <title>Properties</title> + + <figure id="netload-default-fig"> + <title>Default Properties Dialog</title> + <screenshot> + <screeninfo>Net Load Applet Default Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/netload-applet-default" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Like several of the monitor applets, + <application>netload_applet</application> has two ways of setting + preferences. You can make changes that affect all of this applet group + (<application>cpuload_applet</application>, <application>memload_applet</application>, + <application>swapload_applet</application>, <application>netload_applet</application> + and <application>loadavg_applet</application>) in one large dialogue + box. This is useful if you run one or more of them. These are the + settings used by default. They are reached from the + <guimenuitem>Default Properties...</guimenuitem> menu item. + </para> + + <figure id="netload-greyed-fig"> + <title>Greyed Out Properties Dialog</title> + <screenshot> + <screeninfo>Net Load Applet Greyed Out Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/netload-applet-greyed" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Or you can change just the properties for + <application>netload_applet</application>. This is useful for when + you only use <application>netload_applet</application> or want to + try new combinations out. It is reached from the + <guimenuitem>Properties</guimenuitem> menu item. + </para> + <note> + <para> + If you use the <guimenuitem>Properties...</guimenuitem> menu item + and edit the preferences for just this applet, you must uncheck + the <guibutton>Use default properties</guibutton> checkbox before + you can alter any settings. + </para> + </note> + + <figure id="netload-properties-fig"> + <title>Net Load Properties Dialog</title> + <screenshot> + <screeninfo>Net Load Applet Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/netload-applet-properties" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The changes you can make to the properties are three: + </para> + + <variablelist> + <varlistentry> + <term>Colours</term> + <listitem> + <para> + You can alter the colours used for the different network interfaces + by clicking on the colour boxes. This invokes the GNOME colour wheel. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Speed</term> + <listitem> + <para> + You can alter the speed that the graph proceeds with this. + It is measured in milliseconds. The default is 500. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Size</term> + <listitem> + <para> + You can alter the size of the applet with this. It is measured + in pixels. The default value is 40, and the range is from 1 pixel + to whatever you like. In a vertical panel, this refers to the + height. In a horizontal panel, it refers to the width. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="netload-bugs"> + <title> Known Bugs and Limitations</title> + <para> + Resizing and then altering the panel orientation can still cause + intermittent problems, although they now fix themselves after a + short period. + </para> + </sect3> + + <sect3 id="netload-authors"> + <title>Authors</title> + <para> + This applet was writen by Martin Baulig (<email>martin@home-of-linux.org</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 Telsa Gywnne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.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> + + --> + + </sect3> + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + --> + </sect2> diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml new file mode 100644 index 0000000..1f84c4c --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/odometer-ug.sgml @@ -0,0 +1,308 @@ +<sect2 id="odometer"> + <title>Odometer Applet</title> + + <para> + The GNOME panel <application>Odometer</application> applet, shown in <xref + linkend="odometer-applet-fig"> is an applet which tracks and measures the + movements of your mouse pointer across the desktop. It is part of the + gnome-applets package. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Amusements</guisubmenu> + <guimenuitem>Odometer</guimenuitem> + </menuchoice>. + </para> + + <figure id="odometer-applet-fig"> + <title>Odometer Applet</title> + <screenshot> + <screeninfo>Odometer Applet</screeninfo> + <graphic format="png" fileref="figures/odometer_applet" + srccredit="acscherp"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="odometer-usage"> + <title>Usage</title> + <para> + Once it is present, you don't need to do anything to the odometer. + It just sits quietly in your panel and keeps track of all your mouse movements. + In addition, moving the mouse pointer over the odometer produces + a <guilabel>tooltip</guilabel> telling you whether the distance + is expressed in metric units (centimeters, meters, kilometers) + of in feet (inches, feet, miles). + The upper value indicates your total trip distance, + and the lower value is the partial trip distance, that + can be resetted at will. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Reset</guimenuitem> — + This resets the odometer applet to zero again. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="odometer-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>odometer + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="odometer-prefs"> + <title>Customization</title> + <para> + You can customize <application>odometer</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="odometer-settings-fig">), which allows you to + change various settings. + </para> + + <para> + The <interface>properties dialog box</interface> (which calls + itself "Odometer setting" rather than properties) is divided into + two sections, one for general options, and one for themes. + + <variablelist> + <varlistentry> + <term>General</term> + <listitem> + + <figure id="odometer-settings-fig"> + <title>Properties dialog (general preferences tab)</title> + <screenshot> + <screeninfo>General preferences tab</screeninfo> + <graphic format="png" fileref="figures/odometer_settings" + srccredit="accscherp"> + </graphic> + </screenshot> + </figure> + + <para> + The <guilabel>general preferences tab</guilabel>, shown in <xref + linkend="odometer-settings-fig">, has four options: + </para> + <variablelist> + <varlistentry> + <term>Use metric</term> + <listitem> + <para> + If the <guibutton>use metric checkbox</guibutton> is checked, + mouse pointer distance travelled is shown in meters + (centimeters, meters, and kilometers) . If it + is not checked, the distance travelled is shown in feet + (inches, feet and miles). By + moving the pointer over the odometer you can produce a + <guilabel>tooltip</guilabel> which shows you whether it is + currently displaying meters or feet. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>auto_reset</term> + <listitem> + <para> + If the <guibutton>auto_reset checkbox</guibutton> is checked, + the odometer numbers return to zero each time it's + started or each time the session is started. This allows + you to display your daily mouse trip distance if you + used to restart you gnome session every morning. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>enabled</term> + <listitem> + <para> + If the <guibutton>enabled checkbox</guibutton> is checked, then + the odometer will keep counting how far you have moved your + pointer. If not, it will return the numbers to zero until you + re-enable it. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>digits number</term> + <listitem> + <para> + The <guibutton>digits number field</guibutton> determines how + many digits the odometer will display. The default is four, and + the range is from 1 to 10. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term>Theme</term> + <listitem> + + <figure id="odometer-themes-fig"> + <title>Properties dialog (theme preferences tab)</title> + <screenshot> + <screeninfo>Theme preferences tab</screeninfo> + <graphic format="png" fileref="figures/odometer_themes" + srccredit="accscherp"> + </graphic> + </screenshot> + </figure> + + <para> + The <guilabel>theme preferences tab</guilabel>, shown in <xref + linkend="odometer-themes-fig">, has a variety of + themes you can choose from. They are found by default in + <filename>$PREFIX/odometer/</filename>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <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>Close</guibutton> button. + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="odometer-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="odometer-authors"> + <title>Authors</title> + <para> + The <application>odometer applet</application> was written by + Fabrice Bellet (<email>Fabrice.Bellet@creatis.insa-lyon.fr</email>), + and based on the <application>Mouspedometa</application> for KDE by + Armen Nakashian, which in turn was based on the + Motif-based <application>Xodometer</application> by Mark H. Granoff. + 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 Arjan Scherpenisse + (<email>acscherp@wins.uva.nl</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + +--> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/printer-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/printer-ug.sgml new file mode 100644 index 0000000..f012b27 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/printer-ug.sgml @@ -0,0 +1,249 @@ + <!-- ############### printer applet ############### --> + <sect2 id="printer"> + <title>Printer Applet</title> + + <para> + + <application>Printer</application> applet, shown in <xref linkend="printer-fig">, + allows you to print files by dragging them onto the + applet from the <interface> desktop</interface> or <interface>file + manager</interface>. To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Printer Applet</guimenuitem> + </menuchoice>. + + </para> + + + <figure id="printer-fig"> + <title>Printer Applet</title> + <screenshot> + <screeninfo>Printer Applet</screeninfo> + <graphic format="png" fileref="figures/printer-fig" srccredit="Michael Hall"> + </graphic> + </screenshot> + </figure> + + <sect3 id="printer-usage"> + <title>Usage</title> + + <para> + To print a file from your <interface>desktop</interface> or <interface>file + manager</interface>, drag the file onto the <application>printer</application> applet. + + </para> + </sect3> + + <sect3 id="printer-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + <listitem> + <para> + <guimenuitem>Properties...</guimenuitem> — This menu + item opens the <interface>Properties</interface> dialog (see + <xref linkend="printer-properties">) which allows you to + customize the appearance and behavior of this applet. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about the <application>Printer + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + <sect3 id="printer-properties"> + <title>Properties</title> + <para> + You can configure <application>printer</application> applet by + right-clicking on the applet and choosing the + <guimenuitem>Properties...</guimenuitem> menu item. This will open the + <interface>Properties</interface> dialog, shown in <xref + linkend="printer-properties-fig">. + </para> + + <figure id="printer-properties-fig"> + <title>Properties Dialog</title> + <screenshot> + <screeninfo>Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/printer-properties" srccredit="Michael Hall"> + </graphic> + </screenshot> + </figure> + + <para> + + To change the label displayed at the bottom of the + <application>printer</application> applet, ("Print" in <xref + linkend="printer-fig">) type a new name in the <guilabel>Printer + name</guilabel> field. This setting is useful if you have more than one + printer available for use and wish to add a + <application>printer</application> applet to the + <interface>Panel</interface> for each printer. The <guilabel>Printer + name</guilabel> does not determine which printer your file will be printed + to, it exists as an easy means to to distinguish between printers should you + have more than one <application>printer</application> applet installed on + your <interface>Panel</interface>. + + + </para> + + <para> + To change the command the <application>printer</application> applet uses to + print your files, you may enter a new command in the <guilabel>Print + command</guilabel> field. By default, the <application>printer + </application> applet uses the command <command>lpr</command>, which is + common to many systems. Your system may use a different command. If you're + unsure, check your system's documentation. + </para> + <note> + <title>Note for advanced users</title> + <para> + If you have more than one printer, you may designate which printer to send + files to by changing the <guilabel>Print command</guilabel> setting. For + instance, if your system uses the command <command>lpr</command> to print + files and you need to print your file on the printer named "ljet5", you + would change the <guilabel>Print command</guilabel> setting to <command>lpr + -Pljet5</command>. + </para> + </note> + + <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>Close</guibutton> button. + </para> + </sect3> + + <sect3 id="printer-bugs"> + <title> Known Bugs and Limitations</title> + <para> + There are no known bugs in the + <application>printer</application> applet. + </para> + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="printer-authors"> + <title>Authors</title> + <para> + <application>Printer Applet</application> was written by + Miguel de Icaza (<email>miguel@kernel.org</email>) + and Federico Mena (<email>quartic@gimp.org</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>. You also can 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 Michael Hall + (<email>mphall@cstone.net</email>). Please send all comments and + suggestions regarding this manual to the <ulink type="http" + url="http://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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 + <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General + Public License</citetitle></ulink> for more details. + </para> + <para> + A copy of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> is included as an appendix to the + <citetitle>GNOME Users Guide</citetitle>. You may also obtain a + copy of the <ulink type="help" url="gnome-help:gpl"><citetitle>GNU + General Public License</citetitle></ulink> 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> + </sect3> + + --> + </sect2> + + + + + + + + + + + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/quicklaunch-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/quicklaunch-ug.sgml new file mode 100644 index 0000000..0535306 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/quicklaunch-ug.sgml @@ -0,0 +1,181 @@ + <sect2 id="quicklaunch"> + <title>QuickLaunch Applet</title> + + <para> + <application>QuickLaunch</application> is an applet + which holds application launchers. It shrinks the launcher icons + to their smallest size to save room on your panel. The example + <application>QuickLaunch Applet</application> shown in <xref + linkend="quicklaunchapplet-fig"> contains eight GNOME + application launchers in a standard-sized <interface>Panel</interface>. + To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>QuickLaunch</guimenuitem> + </menuchoice>. + </para> + + <figure id="quicklaunchapplet-fig"> + <title>QuickLaunch Applet</title> + <screenshot> + <screeninfo>QuickLaunch Applet</screeninfo> + <graphic format="png" fileref="figures/quicklaunch_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="quicklaunchapplet-usage"> + <title>Usage</title> + <para> + To add a launcher to the <application>QuickLaunch</application> + applet, just drag it from its current position (either on a + <interface>Panel</interface> or in the <guimenu>Main + Menu</guimenu>) onto the <application>QuickLaunch</application> + applet using the left mouse button. + To remove a launcher from the + <application>QuickLaunch</application> applet, just right-click on + the launcher and select <guilabel>Delete launcher</guilabel>. To + configure the properties of a launcher which is in your + <application>QuickLaunch</application> applet, right-click on the + launcher and select <guilabel>Launcher + Properties…</guilabel>. + </para> + <para> + The vertical bar at the left edge of the applet is used for + easily moving the applet in your <interface>Panel</interface>. + Grab the applet by depressing the left or center mouse button and + then move the applet, releasing the mouse button when finished. + This vertical bar is also used to access the applet menu items by + right-clicking on this bar. + </para> + + <para> + Right-clicking on the vertical bar on the left side of the applet + brings up a menu containing the following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>APPLET + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="quicklaunch-bugs"> + <title>Known Bugs and Limitations</title> + <para> + It is not possible to re-arrange launchers inside the + <application>QuickLaunch</application> applet. It is also not + possible to have multiple <application>QuickLaunch</application> + applets with different contents. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="quicklaunch-authors"> + <title>Authors</title> + <para> + <application>QuickLaunch</application> applet was written by Fabio + Gomes de Souza (<email>fabiofb@altavista.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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/screenshooter-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/screenshooter-ug.sgml new file mode 100644 index 0000000..6e4a63d --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/screenshooter-ug.sgml @@ -0,0 +1,714 @@ + <sect2 id="screenshooter-applet"> + <title>ScreenShooter Applet</title> + + <para> + <application>Screen-Shooter</application> is a handy little + screengrabber which is simple to use. It sits in your panel + and you can click on it to take a screenshot of either the + whole desktop or just a single window. + </para> + + <para> + To add the applet to your <interface>panel</interface>, you can + right-click on an empty part of the <interface>panel</interface> + and follow the sequence + <menuchoice> + <guimenu>Applets</guimenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>ScreenShooter</guimenuitem> + </menuchoice>. + </para> + + <sect3 id="screenshooter-usage"> + <title>Usage</title> + <itemizedlist> + <listitem> + <para> + To take a picture of the entire <interface>desktop</interface>, + left-click on the <guibutton>image of a monitor</guibutton>. This + button is the lower of the two on a normally-sized horizontal + <interface>panel</interface> and the right-hand button on a + narrow horizontal <interface>panel</interface> or a vertical + <interface>panel</interface>. + </para> + </listitem> + <listitem> + <para> + To take a picture of just one <interface>window</interface>, + left-click on the <guibutton>image of a window</guibutton>. + This button is the top one on a normally-sized horizontal + <interface>panel</interface> and the left-hand one on a narrow + horizontal <interface>panel</interface> or a vertical + <interface>panel</interface>. The button will stay pressed in + and the cursor will change to a cross. Move the cursor to the + window you want a picture of, and click in that window to select + it. + </para> + </listitem> + </itemizedlist> + + <para> + Right-clicking on the applet brings up a <guimenu>menu</guimenu> + containing the usual options for an applet, including a + <guimenuitem>Properties</guimenuitem> option + <link linkend="screenshooter-prefs">described below</link>. + </para> + </sect3> + + <sect3 id="screenshooter-prefs"> + <title>Settings</title> + <para> + <application>Screen-Shooter</application> can be configured to do + a number of different things. To configure + <application>Screen-Shooter</application>, click on the applet + with mouse button 3 (usually, right mouse button) and select + <guimenuitem>Properties</guimenuitem> from the + <guimenu>popup</guimenu> menu. The + <interface>Preferences</interface> dialogue has seven sections + described below. Five of these are visible initially: two more + sections are available from a toggle in the first section. + </para> + </sect3> + + <sect3 id="screenshooter-preferences-0"> + <title>General Preferences</title> + + <variablelist> + <varlistentry> + <term> + <guilabel>Capture WM decorations when grabbing a window</guilabel> + </term> + <listitem> + <para> + The <guibutton>capture decorations</guibutton> checkbox controls + whether or not the <interface>titlebar</interface> and edges of a + <interface>window</interface> are included. It is only relevant + when <application>Screen-Shooter</application> is taking a + picture of a single <interface>window</interface> rather than of + the whole screen or of a rectangle you have selected. The default is + for this to be checked and for the <interface>titlebar</interface> + and window borders to be included in the shot. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Give audio feedback using the keyboard bell + </guilabel></term> + <listitem> + <para> + The <guibutton>audio feedback</guibutton> checkbox controls + whether or not <application>Screen-Shooter</application> will + beep when it actually takes the shot. The default is to beep. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Display spurious options</guilabel></term> + <listitem> + <para> + The <guibutton>spurious options</guibutton> checkbox controls whether + some of <application>Screen-Shooter</application>'s more esoteric + options are available. The default is off (i.e., they are not + available). Checking this option makes two sections called + <link linkend="screenshooter-preferences-5">Spurious 1</link> and + <link linkend="screenshooter-preferences-6">Spurious 2</link> visible + in the preferences dialogue. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Delay before taking shot</guilabel></term> + <listitem> + <para> + When taking shots of the <interface>desktop</interface>, you can + set a delay between clicking on the + <application>Screen-Shooter</application> and the shot being taken. + The delay can be up to one minute. This can be very useful when you + want to focus on a particular <interface>window</interface> or if + you want to bring up a <interface>menu</interface>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Compression quality</guilabel></term> + <listitem> + <para> + Compression quality does not refer to how tightly a file is + compressed, but to how well it retains detail after + compression. The higher the compression quality, the better + the quality of the image, but the larger the size of the resulting + file. It is relevant when you are saving something as a JPEG, + a MIFF or a PNG file. The default compression quality is 75%. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Create monochrome image</guilabel></term> + <listitem> + <para> + A fairly self-explanatory option: if this is selected, + the resulting image will be in monochrome. This is off by default. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Invert colours in image</guilabel></term> + <listitem> + <para> + Another self-explanatory option: if this is selected, the colours + of the image are reversed so that white becomes black, pale purple + becomes greenish, and so on. Lovely -- but rarely useful! Off by + default. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="screenshooter-preferences-1"> + <title>Files, Apps</title> + + <variablelist> + <varlistentry> + <term><guilabel>Directory to save file in</guilabel></term> + <listitem> + <para> + The directory to save the shot in must exist already: + <application>Screen-Shooter</application> will not create + it for you. If you try to save it to somewhere that does + not exist, then no screenshot will be taken. The default + directory is <filename>~/</filename>: your home directory. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Filename for images</guilabel></term> + <listitem> + <para> + <application>Screen-Shooter</application> is designed to allow the + user maximum flexibility in naming each shot. The filename field + (as well as the directory field) is passed to a shell for normal + shell expansion before being used. This allows you to use the + output of programs, scripts or environment variables to name your + shots. The reason for this is to allow unique filenames. + By default, Screen-Shooter will create a name which is based on + the time and date it was taken: this of course should always be + unique. The default filename is + <filename>`date +%Y_%m_%d_%H%M%S`_shot.jpg</filename>. + As you can see, the filename includes the output of the date + command in order to generate a datestamp. + So it makes up a name based on the date, using the format the + percentage symbols and letters tell it. Then it adds the rest + of the name from outside the backticks to the date it has used. + Explanations of the cryptic percentage symbols can be found + in <command>man date</command>, but the arguments in the + default filename are: + </para> + <variablelist> + <varlistentry> + <term>%H</term> + <listitem><para>The hour of the day (from 00 to 23)</para></listitem> + </varlistentry> + <varlistentry> + <term>%M</term> + <listitem><para>The minute of the hour (from 00 to 59)</para></listitem> + </varlistentry> + <varlistentry> + <term>%S</term> + <listitem><para>The second of the minute (from 00 to 60)</para></listitem> + </varlistentry> + <varlistentry> + <term>%d</term> + <listitem><para>The day of the month (from 01 to 31)</para></listitem> + </varlistentry> + <varlistentry> + <term>%m</term> + <listitem><para>The month of the year (from 01 to 12)</para></listitem> + </varlistentry> + <varlistentry> + <term>%y</term> + <listitem><para>The final two digits of the year</para></listitem> + </varlistentry> + </variablelist> + + <para> + Other examples of filenames you might use are: + </para> + <itemizedlist> + <listitem> + <para><filename>screenshot-`date +%Y%m%d-%H%M%S`.jpg</filename></para> + </listitem> + <listitem> + <para><filename>pic-`date +%H%M%S`.png</filename></para> + </listitem> + <listitem> + <para><filename>myshot.jpg</filename></para> + </listitem> + <listitem> + <para><filename>`my_own_script_to_create_a_filename`.jpg</filename></para> + </listitem> + </itemizedlist> + + <para> + The filename suffix determines the filetype. Screen-Shooter + supports what can only be described as a ridiculous number of + different image formats. Try your luck. For a full list, type + <command>man convert</command>. You can even try .html to create a + client-side image map, and wild things like that. + </para> + + <para> + If your filename suffix is not something <application>Screen-Shooter + </application> recognises, or you omit one, it will save the shot as a + MIFF file. Use the <command>convert</command> utility to change the + format later. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>View screenshot after saving</term> + <listitem> + <para> + The <guilabel>view screenshot</guilabel> checkbox is unchecked by + default. After checking it, you will get a view of the shot once it + has been taken. You need to specify a viewer for this: the default + is <command>ee</command>, which launches the + <application>Electric Eyes</application> image viewing program. + </para> + </listitem> + </varlistentry> + + </variablelist> + </sect3> + + <sect3 id="screen-shooter-preferences-2"> + <title>Thumbnails</title> + + <variablelist> + <varlistentry> + <term><guilabel>Create thumbnail of image too</guilabel></term> + <listitem> + <para> + None of the other options on this page will have any effect + if <guibutton>create thumbnail</guibutton> is not checked. + By default, it is off. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Thumbnail size</guilabel></term> + <listitem> + <para> + This is the percentage of the original's size that the thumbnail + will be. The default is 25%. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Thumbnail compression</guilabel></term> + <listitem> + <para> + This is the quality of compression to use. As with the general + preferences, the better the quality of the compression, the more + detail will be preserved, and the bigger the thumbnail will be. + The default for a thumbnail is 50%. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Prefix to attach to filename</guilabel></term> + <listitem> + <para> + This is the prefix to attach to the thumbnail filename to distinguish + it from the full-sized shot. If you leave this blank, the + thumbnail will overwrite the full-sized shot and you will lose + the full-sized one. The default prefix is "thumb-". + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Use high-quality intermediate for + generating thumbnail</guilabel> + </term> + <listitem> + <para> + The <guibutton>high-quality intermediate</guibutton> checkbox is off + by default. It generates a MIFF image whilst making the thumbnail. A + 'lossy' file format refers to a file format where data and detail is + irretrievably lost, but which is typically much smaller than a + non-lossy format image of the same thing. The typical example of a + lossy file format is JPEG. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="screenshooter-preferences-3"> + <title>Post-Processing</title> + <note> + <para> + These options <emphasis>munch</emphasis> processing power compared + with the options in previous sections. They work by producing an + intermediate image of the screenshot, and then performing actions + upon it. Once any of these options are enabled, the shot will take + longer to complete, due to the extra processing involved. + </para> + </note> + + <variablelist> + <varlistentry> + <term><guilabel>Normalize image</guilabel></term> + <listitem> + <para> + The <guibutton>normalize image</guibutton> checkbox transforms the + image to span the full range of colour values. + Default is off. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Equalize image</guilabel></term> + <listitem> + <para> + The <guibutton>equalize image</guibutton> checkbox enables + histogram-based image equalization, which is a process which + compensates for low contrast in an image and brings out more + detail. Default is off. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Enhance image</guilabel></term> + <listitem> + <para> + The <guibutton>enhance image</guibutton> checkbox tells + <application>Screen-Shooter</application> to clean up + the image as best it can, and try to remove any noise. + Default is off. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Despeckle image</guilabel></term> + <listitem> + <para> + The <guibutton>despeckle image</guibutton> checkbox reduces + spotting by removing single pixels which are very different in + colour from their surroundings. The default is off. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Sharpen image by factor</guilabel></term> + <listitem> + <para> + Sharpening the image sharpens the image. The default is a factor + of zero, but it can be raised to 100%. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Rotate image clockwise</guilabel></term> + <listitem> + <para> + This is how many degrees clockwise to rotate the image. The + default is 0: unrotated. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Adjust gamma</guilabel></term> + <listitem> + <para> + The <guibutton>gamma</guibutton> checkbox enables you to adjust the + gamma. The gamma value is a value to do with the intensity + of the lightness of an image (and rather complicated). The + range <application>Screen-Shooter</application> provides is + from 0.8 to 2.3 with a default of 1.6. This is not a linear + (straight) scale so you will need to experiment. Lowering the + gamma produces a darker image. Raising it produces a lighter one. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="screenshooter-preferences-4"> + <title>Frills</title> + <variablelist> + <varlistentry> + <term><guilabel>Create frame around image</guilabel></term> + <listitem> + <para> + The <guibutton>create frame</guibutton> checkbox is off by default. + Checking it produces a frame around the shot taken. This frame is + always grey, but <link linkend="screenshooter-authors">Tom + Gilbert</link> notes, <quote>if anybody requests it, I'll add + options for setting its colour</quote>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Frame width</guilabel></term> + <listitem> + <para> + This determines the size of the frame in pixels. The range + is from one pixel to fifty. The default frame is six pixels. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Flip image vertically</guilabel></term> + <listitem> + <para> + This gives a vertical mirror image of the shot. It can be combined + with the following option. The default is unchecked. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Flip image horizontally</guilabel></term> + <listitem> + <para> + This gives a horizontal mirror image of the shot. It can be combined + with the preceding option. The default is unchecked. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Emboss image</guilabel></term> + <listitem> + <para> + Embossing an image produces an image drained of most colour and + drawn in relief. The default is unchecked. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Send image and thumbnail to...</guilabel></term> + <listitem> + <para> + By placing a script or program name in the box and checking the + <guibutton>send to</guibutton> checkbox, you can invoke that script + or program to be automatically run on the image and thumbnail. + This could be used to print the image out automatically, + to invoke a script to catalogue the files, or to add the + pictures to a website automatically. A sample script for the + latter is available with <application>Screen-Shooter</application>. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="screenshooter-preferences-5"> + <title>Spurious options: part 1</title> + <note> + <para> + Tom Gilbert says, <quote>These options are all just plain silly. But + they're fun. So I included them</quote>. They also munch processing + power in the same manner as the post-processing options above. + </para> + </note> + + <para> + To make use of any of the options listed in this section and the + next section, you need to have selected <guibutton>Display spurious + options</guibutton> in the <link + linkend="screenshooter-preferences-0">General Preferences</link> + section. They will not be available otherwise. + </para> + + + <variablelist> + <varlistentry> + <term><guilabel>Blur image</guilabel></term> + <listitem> + <para> + The <guibutton>blur image</guibutton> checkbox is off by default and + the blur factor is set to zero. By checking the checkbox and altering + the blur factor you can blur the image. Even at the highest + rating (100), a typical font on a typical terminal window is + still just about decipherable. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Create charcoal effect</guilabel></term> + <listitem> + <para> + The <guibutton>charcoal</guibutton> checkbox is off by default and + the charcoal factor is set to zero. Charcoaling produces a + monochrome image with a slight smudginess which increases + with the charcoal factor. It does not deal with highlighted + text very well, though. The maximum factor for this is 100. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Find edges</guilabel></term> + <listitem> + <para> + The <guibutton>find edges</guibutton> checkbox is off by default and + the factor is set to zero. Using it produces a monochrome image + where, rather than highlighting areas of different colours, it + highlights the edges and borders between areas of different + colour. Very interesting on maps and astronomical photos. The + maximum factor for this is 100. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Implode image</guilabel></term> + <listitem> + <para> + The <guibutton>implode image</guibutton> checkbox is off by default + and the factor is set to zero. Using it warps the resulting + screenshot as if a weight had been pressed into the centre of the + shot. The maximum factor for this is 100. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="screenshooter-preferences-6"> + <title>Spurious options: part 2</title> + + <variablelist> + <varlistentry> + <term><guilabel>Create painted effect</guilabel></term> + <listitem> + <para> + The <guibutton>painted effect</guibutton> checkbox is off by default + and the radius to paint around each pixel is set to zero. Checking + it with a radius of about 5 produces an effect like an Impressionist + painting. Checking it with a radius of about 50 will eat your + CPU cycles like mad for ten minutes on a reasonably powerful + machine. The maximum radius is 100, but you will need either + a large machine or a lot of patience for that. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Solarise image</guilabel></term> + <listitem> + <para> + The <guibutton>solarise</guibutton> checkbox is off by default and + the factor is set to zero. Solarising is an effect first noticed + in developing photographs from negatives. It results in a + negative image with different colouring from that of the + "inverted colours" option in the general preferences. A + solarise factor of 5 will produce startling results, but the + maximum factor is 100. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Spread image pixels</guilabel></term> + <listitem> + <para> + The <guibutton>spread image</guibutton> checkbox is off by default + and the factor is set to zero. The result of spreading the image + pixels by a radius of about 5 is similar to looking through + lightly frosted glass; for heavily-frosted glass, try 25. + The maximum is 100. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Swirl pixels</guilabel></term> + <listitem> + <para> + The <guibutton>swirl pixels</guibutton> checkbox is off by default + and the factor is set to zero. Swirling the pixels results in a + distorted image similar to an imploded image except that it + swirls around the central point rather than stretching to + it. A radius of 20 produces an effect like a fairground distorting + mirror, only not a mirror-image; 90 a much increased version + (although text is still legible); at 180 the entire image is + warped; and at the maximum of 360 a spiral effect is created. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="screenshooter-bugs"> + <title>Known bugs and limitations</title> + + <itemizedlist> + <listitem> + <para> + Often screenshots saved in PNG format show incorrectly in + <application>Netscape</application> or the <application>GNOME Help + Browser</application>. This is due to bugs in Netscape and + and GNOME image libraries, not to bugs in + <application>Screen-Shooter</application>. You can view such + screenshots in a different image-viewing program; or you can try + changing image compression level in the <link + linkend="screenshooter-preferences-0">Preferences dialogue box</link>, + which sometimes helps. + </para> + </listitem> + </itemizedlist> + </sect3> + + <sect3 id="screenshooter-authors"> + <title>Authors</title> + <para> + The <application>Screen-Shooter</application> applet was + written by Tom Gilbert + (<email>gilbertt@tomgilbert.freeserve.co.uk</email>). + Please report bugs in the Screen-Shooter applet to the + <ulink type="http" url="http://bugs.gnome.org">GNOME bug + tracking system</ulink>. You can do this by following the + guidelines on that site or by using + <application>bug-buddy</application> + from the command-line. For the package, put gnome-applets. + </para> + <para> + This manual was written by + Telsa Gwynne (<email>telsa@linuxchix.org</email>) and + Tom Gilbert (<email>gilbertt@tomgilbert.freeserve.co.uk</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> + </sect3> + --> + </sect2> diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/sound-monitor-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/sound-monitor-ug.sgml new file mode 100644 index 0000000..202a4b1 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/sound-monitor-ug.sgml @@ -0,0 +1,505 @@ + <sect2 id="soundmonitorapplet"> + <title>Sound Monitor Applet</title> + + <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) -- + GNOME component responsible for sound output. To add this applet to + a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Multimedia</guisubmenu> + <guimenuitem>Sound Monitor</guimenuitem> + </menuchoice>. + </para> + + <figure id="soundmonitorapplet-fig"> + <title>Sound Monitor Applet</title> + <screenshot> + <screeninfo>Sound Monitor Applet</screeninfo> + <graphic format="png" fileref="figures/soundmonitor_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Waht is ESD? ================================ --> + <sect3 id="soundmonitorapplet-esd"> + <title>Sound in GNOME</title> + <para> + GNOME uses a special program, called ESD (the Enlightened Sound + Daemon), as an intermediary between applications and sound + card. ESD allows mixing sound from several applications, so that + you can play a game and hear the sound effects while listening + to an aduio CD. To hear any sound from GNOME applications, ESD + must be running. Normally GNOME is configured so that ESD is + started every time you login; if for some reason this is not so, + click on the <guibutton>Main Menu</guibutton> button (the foot + icon) and select + <menuchoice> + <guimenu>Programs</guimenu> + <guisubmenu>Setting</guisubmenu> + <guisubmenu>Multimedia</guisubmenu> + <guimenuitem>Sound</guimenuitem> + </menuchoice> + and make sure that the option <guilabel>Enable sound server + startup</guilabel> is enabled, so that the next time you login, + ESD will be started. You can also start or stop ESD + using the <application>Sound Monitor</application> applet as + described below. + </para> + <para> + Non-GNOME applications usually are not aware of ESD and need + full control of the audio card --- they can not share audio card + with other applications. This means with such applications, you + can either have sound from GNOME or sound from non-GNOME + application, but not both. In many cases, this means that you + have to temporarily stop ESD to get sound from non-GNOME + applications (otherwise, you get error messages like + <command>Device /dev/dsp busy</command>). + </para> + </sect3> + + + <!-- ============= Usage ================================ --> + <sect3 id="soundmonitorapplet-usage"> + <title>Usage</title> + <para> + <application>Sound Monitor</application> always displays the + volume of sound being produced on your system graphically. + You may control sound by turning ESD on or off by right-clicking + on the applet and selecting <guimenuitem>Place Esound in + standby</guimenuitem> or <guimenuitem>Resume Esound</guimenuitem> + respectively, as described below. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Manager…</guimenuitem> — 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> — 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…</guimenuitem> — + opens the <link linkend="soundmonitorapplet-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Sound + Monitor</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="soundmonitorapplet-prefs"> + <title>Customization</title> + <para> + You can customize <application>Sound Monitor</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog (shown in <xref + linkend="soundmonitor-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="soundmonitor-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/soundmonitor_applet_settings" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The properties in the <guilabel>General</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Peak indicator — This controls the behavior of the peak + indicator (the bright line which tracks the peak volume), + either turning it off (<guilabel>off</guilabel>), having it + follow the peak as if it is floating on top + (<guilabel>active</guilabel>), or having it follow the peak + smoothing out short spikes and drops + (<guilabel>smooth</guilabel>). + </para> + </listitem> + + <listitem> + <para> + Peak indicator falloff speed — This controls the speed + the peak indicator falls back to zero volume (for active mode) + or moves toward the current volume (for smooth mode). + </para> + </listitem> + <listitem> + <para> + Scope (scale 1:X, where X=?) — This controls the + horizontal (time) axis scale for <application>Sound + Monitor</application> "scope-like" themes, i.e., themes that + show a graph of sound level, with time along the horizontal + axis. (Since + the default theme is not a scope, this control does not do + anything until you have modified the theme, as described + below.) A value of 1 corresponds to time scale of 44 100 + pixels/second; value of X gives 44 100/X pixels/second. (These + numbers appear because the standard for CD-quality audio + stipulates that there should be 44 100 sound samplings per second.) + </para> + </listitem> + + <listitem> + <para> + Connect points in scope — This determines whether the + sampled volume points are connected. (For scope themes only.) + </para> + </listitem> + + <listitem> + <para> + Screen refresh (frames per second) — This controls the + number of times the <application>Sound Monitor</application> + display is updated each second. + </para> + </listitem> + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Theme</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Theme file (directory) — This is the theme for you + <application>Sound Monitor</application>, which determines the + overall appearance of the applet. You can either select a + theme from the list <guilabel>Themes:</guilabel>, or else type + in the directory and name of another theme if available. Some + of the standard themes are shown in <xref + linkend="soundmonitorappletthemes-fig">. + + <figure id="soundmonitorappletthemes-fig"> + <title>Example Sound Monitor Themes</title> + <screenshot> + <screeninfo>Example Sound Monitor Themes</screeninfo> + <graphic format="png" fileref="figures/soundmonitor_applet_themes" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + </para> + + </listitem> + + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Advanced</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + ESD host to monitor — This option allows you to listen + to sound being played by ESD on another computer. To do so, + enter the network address (or IP address) of a computer to + monitor in the format <replaceable>host:port</replaceable>. + The host specified must be running ESD and have their esound + daemon "unlocked" to allow other machines to connect. Note + that the default port for ESD is 5001. Leave + this entry blank to monitor sound on the local machine. + </para> + </listitem> + + </itemizedlist> + </para> + + <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> + </sect3> + + + <!-- ============= Manager ================================== --> + <sect3 id="soundmonitorapplet-manager"> + <title>The Sound Monitor Manager</title> + <para> + To start the <interface>Sound Monitor Manager</interface>, + right-click on the applet and choose + <guimenuitem>Manager…</guimenuitem>. This will open the + <interface>Sound Monitor - Manager</interface> dialog (shown in <xref + linkend="soundmonitorappletmanager-fig">), which allows you to + view and modify various ESD settings. + </para> + <figure id="soundmonitorappletmanager-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Sound Monitor Manager dialog</screeninfo> + <graphic format="png" fileref="figures/soundmonitor_manager_server" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The <guilabel>Server</guilabel> tab displays the following information: + <itemizedlist> + + <listitem> + <para> + Server information — This is a brief description of the + esound server daemon's current status, including the sound + output rate to the sound card, the number of currently playing + sounds (connected streams), and the number of sound samples + cached in the server. + </para> + </listitem> + + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Streams</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Connected Streams — This displays a list of basic + information for the current sound streams playing through the + sound server. The user can adjust the volume and balance of a + stream by first selecting the stream's line, then adjusting + the volume and balance sliders. + </para> + </listitem> + + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Samples</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Cached Samples — This displays a list of basic + information for the current sounds cached in the sound + server. The user can adjust the volume and balance of a cached + sound by first selecting the sound's line, then adjusting the + volume and balance sliders. To toggle between displaying the + sound's length as bytes or time (format MM:SS.S) click on the + length or time column heading. + </para> + </listitem> + + </itemizedlist> + </para> + + <para> After you made all the choices you want, click on + <guibutton>OK</guibutton> to make 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> + + </sect3> + + <!-- ============= ESDPVD ================================== --> + <sect3 id="esdpvd"> + <title>The Esound Persistent Volume Daemon (ESDPVD)</title> + <para> + The <application>Sound Monitor</application> applet comes with a + companion program called the <application>Esound Persistent Volume + Daemon</application> + (ESDPVD), which can run in the background and remembers the volume + and balance of each stream that connects to the sound server. The + main purpose of <application>ESDPVD</application> is to be used in + conjunction with the <application>Sound Monitor</application> + applet's <interface>Manager</interface> dialog + to retain volume levels for individual streams that + connect to the ESD sound server. + </para> + <para> + As an example, suppose you are running the + <application>GTCD</application> CD Player and you + lower its volume using the <interface>Manager</interface> window. Normally + the volume setting will be lost when the program (in this case + <application>GTCD</application>) is exited and + restarted. However, if <application>esdpvd</application> is + running and you start <application>GTCD</application> again, the + volume will be restored to its previous (in this case, + lower) value from before. + </para> + <para> + If you configure GNOME to start <application>ESDPVD</application> + each time GNOME is started (using the + <interface>control-center</interface>'s <interface>Startup + Programs</interface> section), <application>ESDPVD</application> + will remember sound volume and balance customizations between + GNOME sessions. + </para> + <para> + <application>ESDPVD</application> also remembers volume and + balance adjustments to cached samples (often used for interface + sound events such as button clicks, menus, etc.). + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="sound-monitor-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet only shows the sound volume for sound produced by + GNOME applications (to be precise, sounds passing through ESD); it + will not show sound volume for applications that directly connect + to audio card. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="sound-monitor-authors"> + <title>Authors</title> + <para> + <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>. 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>) and John Ellis + (<email>johne@bellatlantic.net</email>). Please send all comments + and suggestions regarding this manual to the <ulink type="http" + url="http://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/swapload-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/swapload-ug.sgml new file mode 100644 index 0000000..3bfc3fe --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/swapload-ug.sgml @@ -0,0 +1,289 @@ +<!-- Permission is granted to make and distribute verbatim copies of --> +<!-- this manual provided the copyright notice and this permission --> +<!-- notice are preserved on all copies. --> +<!-- --> +<!-- Permission is granted to copy and distribute modified versions of --> +<!-- this manual under the conditions for verbatim copying, provided --> +<!-- that the entire resulting derived work is distributed under the --> +<!-- terms of a permission notice identical to this one. --> +<!-- --> +<!-- Permission is granted to copy and distribute translations of this --> +<!-- manual into another language, under the above conditions for --> +<!-- modified versions, except that this permission notice may be --> +<!-- stated in a translation approved by the Foundation. --> + + <sect2 id="swapload-applet"> + <title>The swap load applet</title> + + <para> + The <application>swapload_applet</application> is a small monitor + applet which sits in your panel and tells you how much swap space is + being used. + </para> + + <para> + The swap space is a part of the hard drive which is not + part of the filesystem. When the kernel decides a program in + memory is not being used a lot but might be required soon, + it takes parts of the program out of memory and puts those into the + swap space, where it can easily retrieve it. Moving data between + memory and swap can be slow, so if you are using a lot of your + swap space, you may find the machine's reaction slows. + </para> + + <sect3 id="swapload-usage"> + <title>Usage</title> + <para> + You don't need to do anything to this applet. It will sit and + run in your panel. Various options to alter its display are + available. + </para> + + <figure id="cpuload-applet-fig"> + <title>Swap Load Applet</title> + <screenshot> + <screeninfo>Swap Load Applet</screeninfo> + <graphic format="png" fileref="figures/swapload-applet" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + </sect3> + + <sect3 id="swapload-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items, the right-click pop-up menu has + the following items: + </para> + + <variablelist> + <varlistentry> + <term>Default Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="swapload-properties">described below</link> which allows + you to alter the default properties of this and related monitor + applets. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Properties...</term> + <listitem> + <para> + This opens the <guilabel>multiload_applet dialogue box</guilabel> + <link linkend="swapload-properties">described below</link> which + affects only the <application>swapload_applet</application> + properties. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Run gtop...</term> + <listitem> + <para> + This option will run the <command>gtop</command> which + starts up the GNOME System Monitor. <application>gtop</application> + gives a much more detailed look at your system and what's happening + on it. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="swapload-properties"> + <title>Properties</title> + + <figure id="cpuload-default-fig"> + <title>Default Properties Dialog</title> + <screenshot> + <screeninfo>Swap Load Applet Default Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/swapload-applet-default" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Like several of the monitor applets, + <application>swapload_applet</application> has two ways of setting + preferences. You can make changes that affect all of this group + (<application>cpuload_applet</application>, <application>memload_applet</application>, + <application>swapload_applet</application>, <application>netload_applet</application> + and <application>loadavg_applet</application>) in one large dialogue + box. This is useful if you run one or more of them. These are the + settings used by default. They are reached from the + <guimenuitem>Default Properties...</guimenuitem> menu item. + </para> + + <figure id="swapload-greyed-fig"> + <title>Greyed Out Properties Dialog</title> + <screenshot> + <screeninfo>Swap Load Applet Greyed Out Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/swapload-applet-greyed" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + Or you can change just the properties for + <application>swapload_applet</application>. This is useful for when + you only use <application>swapload_applet</application> or want to + try new combinations out. It is reached from the + <guimenuitem>Properties</guimenuitem> menu item. + </para> + <note> + <para> + If you use the <guimenuitem>Properties...</guimenuitem> menu item + and edit the preferences for just this applet, you must uncheck + the <guibutton>Use default properties</guibutton> checkbox before + you can alter any settings. + </para> + </note> + + <figure id="swapload-properties-fig"> + <title>Swap Load Properties Dialog</title> + <screenshot> + <screeninfo>Swap Load Applet Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/swapload-applet-properties" + srccredit="Eric Baudais"> + </graphic> + </screenshot> + </figure> + + <para> + The changes you can make to the properties are three: + </para> + + <variablelist> + <varlistentry> + <term>Colours</term> + <listitem> + <para> + You can alter the colours used for used and free swap space + that are displayed by clicking on the colour boxes. This + invokes the GNOME colour wheel. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Speed</term> + <listitem> + <para> + You can alter the speed that the graph proceeds with this. + It is measured in milliseconds, and the default is 500. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Size</term> + <listitem> + <para> + You can alter the size of the applet with this. It is measured + in pixels. The default value is 40, and the range is from 1 pixel + to whatever you like. In a vertical panel, this refers to the + height. In a horizontal panel, it refers to the width. + </para> + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 id="swapload-bugs"> + <title> Known Bugs and Limitations</title> + <para> + Resizing and then altering the panel orientation can still cause + intermittent problems, although they now fix themselves after a + short period. + </para> + </sect3> + + <sect3 id="swapload-authors"> + <title>Authors</title> + <para> + This applet was writen by Martin Baulig (<email>martin@home-of-linux.org</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 Telsa Gywnne + (<email>telsa@linuxchix.org</email>) and Eric Baudais + (<email>baudais@okstate.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> + + --> + + </sect3> + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> +--> + </sect2> + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/tasklist-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/tasklist-ug.sgml new file mode 100644 index 0000000..3c03d74 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/tasklist-ug.sgml @@ -0,0 +1,483 @@ + + <!-- ############### Tasklist ############### --> +<sect2 id="tasklist-applet"> + <title>Tasklist Applet</title> + + <para> + <application>Tasklist</application> applet, shown in <xref + linkend="tasklist-applet-fig">, displays a table showing windowed + applications running on your computer. Depending on the options + chosen, you can display either those on the desktop currently in + use, or on all virtual desktops. To add this applet to a + <interface>Panel</interface>, right-click on the panel and choose + <menuchoice> + <guimenu>Applets</guimenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Tasklist</guimenuitem> + </menuchoice>. + </para> + + + <figure id="tasklist-applet-fig"> + <title>Tasklist</title> + <screenshot> + <screeninfo>Tasklist</screeninfo> + <graphic format="png" fileref="figures/tasklist-fig" srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + <sect3 id="tasklist-applet-usage"> + <title>Usage</title> + <para><application>Tasklist</application> allows you to quickly + navigate the applications running on your computer, displaying + icons and application names for each application that meets the + criteria you've set in the <link + linkend="tasklist-applet-properties">properties window</link>. Clicking + on an icon or application name gives focus to that application, + bringing it to the foreground so it accepts your keyboard input.</para> + + <para>Right-clicking with the mouse on an application's icon or + text in the applet brings up the following menu:</para> + + <figure id="tasklist-rightclick-fig"> + <title>Tasklist Right-Click Options</title> + <screenshot> + <screeninfo>Tasklist Right-Click Options</screeninfo> + <graphic format="png" fileref="figures/tasklist-rightclick-fig" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + <para> + <itemizedlist> + <listitem> + <para><guilabel>Iconify</guilabel> — reduce the + selected application to a panel icon. When an application + already has been iconified, the menu item changes to + <guilabel>Restore</guilabel>. Clicking on it restores the + application to your desktop.</para> + </listitem> + + <listitem> + <para><guilabel>Shade</guilabel> — minimize the + application to a single window bar. When an application + has been Shaded, the menu item changes to + <guilabel>Unshade</guilabel>. Clicking on + <guilabel>Unshade</guilabel> restores the application to + full size.</para> + </listitem> + + <listitem> + <para><guilabel>Stick</guilabel> — make application + "sticky", which means it remains in your field of view when + you change virtual desktops, following you as you go. When + an application is sticky, the menu option + <guilabel>Unstick</guilabel> is displayed, allowing you to + leave an application behind as you continue your virtual + desktop travels.</para> + </listitem> + + <listitem> + <para><guilabel>Kill</guilabel> — kills the + application. The <link + linkend="tasklist-applet-properties">properties + dialog</link> allows you to + have <application>Tasklist</application> prompt you for + confirmation before causing an application's untimely death.</para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + <sect3 id="tasklist-task-grouping"> + <title>Task Grouping</title> + <para><application>Tasklist</application> can group icons together when + multiple instances of a program are running. A number in parentheses + appears to next to the application. Clicking on the icon brings up a menu + listing all of the running instances.</para> + <figure id="tasklist-applet-grouping-fig"> + <title>Task Grouping</title> + <!-- + <screenshot> + <screeninfo>Task Grouping</screeninfo> + <graphic format="png" fileref="figures/tasklist-grouping" + srccredit="John Fleck"> + </graphic> + </screenshot> + --> + </figure> + <para>Clicking on an item in the list brings that window to the foreground + and gives it focus.</para> + <para>By default, <application>Tasklist</application> groups four or more + applications. You can change this in the <link + linkend="tasklist-applet-properties">properties window</link>.</para> + </sect3> + + <sect3 id="tasklist-applet-right-click"> + <title>Right-Click Pop-Up Menu Items</title> + <para> + In addition to the standard menu items (see <xref + linkend="tasklist-standard-right-click-items">), the + right-click pop-up menu has + <guimenuitem>Properties...</guimenuitem> item — This menu + item opens the <interface>Properties</interface> dialog (see <xref + linkend="tasklist-applet-properties">) which allows you to + customize the appearance and behavior of this applet. + </para> + + </sect3> + + <sect3 id="tasklist-applet-properties"> + <title>Properties</title> + <para> + You can configure <application>Tasklist</application> applet by + right-clicking on the applet and choosing the + <guimenuitem>Properties...</guimenuitem> menu item. This will open the + <interface>Properties</interface> dialog, shown in <xref + linkend="tasklist-applet-properties-fig">. + </para> + <figure id="tasklist-applet-properties-fig"> + <title>Properties Dialog</title> + <screenshot> + <screeninfo>Properties Dialog</screeninfo> + <graphic format="png" fileref="figures/tasklist-properties" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + <para>The <interface>Properties dialog</interface> allows to you + control which tasks are displayed: +<itemizedlist> + + <listitem> + <para><guilabel>Show normal applications</guilabel> — + display, in the applet, all applications on the current + desktop that have not been minimized.</para> + </listitem> + <listitem> + <para><guilabel>Show iconified (minimized) applications + </guilabel> — show all applications on the current + desktop that have been minimized</para> + </listitem> + <listitem> + <para><guilabel>Show normal applications on all + desktops</guilabel> — show all full-sized, + non-minimized applications on all desktops. For this to + work, you must also have checked the <guilabel>Show normal + applications</guilabel> checkbox above.</para> + </listitem> + <listitem> + <para><guilabel>Show iconified (minimized) applications on + all desktops</guilabel> — show all applications that + have been minimized on all desktops. For this to work, you + must also have checked <guilabel>Show iconified (minimized) + applications</guilabel> above.</para> + </listitem> +</itemizedlist> +</para> + +<para> +<itemizedlist> + <listitem> + <para><guilabel>Show mini icons</guilabel> — Some + applications support a miniature icon. This option displays + it on the <application>Tasklist</application> panel.</para> + </listitem> + <listitem> + <para><guilabel>Confirm before killing windows</guilabel> + — have the applet prompt you before you're permitted + to <link linkend="tasklist-rightclick-fig">kill an + application</link>.</para> + </listitem> + <listitem> + <para><guilabel>Move iconified tasks to current workspace + when restoring</guilabel> — automatically switches + the desktop work area on your screen to the one containing + the application you click on in the + <application>Tasklist</application> panel.</para> + </listitem> + <listitem> + <para><guilabel>Enable task grouping</guilabel> — Turns on + <application>Tasklist's</application> <ulink + url="tasklist-task-grouping">grouping feature</ulink> and controls the number of instances of an application that must be running before they are grouped.</para> + </listitem> + + + </itemizedlist> + +</para> + <figure id="tasklist-applet-size-fig"> + <title>Properties Dialog - Size</title> + <screenshot> + <screeninfo>Properties Dialog - Size</screeninfo> + <graphic format="png" fileref="figures/tasklist-properties-size" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + <para>The <interface>size properties dialog</interface> controls + how much space <application>Tasklist</application> takes up on + your panel: +<itemizedlist> + <listitem> + <para><guilabel>Follow panel size</guilabel> + — have <application>Tasklist</application> size + determined automatically based on panel size. This overrides + other size options.</para> + </listitem> + <listitem> + <para><guilabel>Tasklist width (height)</guilabel> + — width (or height in vertical panel) of + <application>Tasklist</application> in pixels.</para> + </listitem> + <listitem> + <para><guilabel>Rows of tasks</guilabel> + — determines how many rows of task icons + <application>Tasklist</application> displays.</para> + </listitem> + <listitem> + <para><guilabel>Default task size</guilabel> + — set the default size for display of a task + item. (This only has effect if <guilabel>Tasklist width is + dynamic</guilabel> is checked below.)</para> + </listitem> + <listitem> + <para><guilabel>Tasklist width (height) is fixed + (dynamic)</guilabel> — Have the size of the tasklist + fixed or established by the applet dynamically. Setting it + to "fixed" means that the applet will always take the amount + of space set in "tasklist width", even if there are no + tasks. Setting it to <guilabel>dynamic</guilabel> means that + the applet will take as much space as needed to show all tasks (zero if + there are no tasks), but not more than the value set in + <guilabel>Tasklist width</guilabel>.</para> + </listitem> + <listitem> + <para><guilabel>Only use empty space</guilabel> — If width or + height is set to be dynamic, this option forces + <application>Tasklist</application> to use only the available space + on your screen, preventing it from pushing other applets out + of the way and off of your screen.</para> + </listitem> + </itemizedlist> + +</para> + + </sect3> + + +<sect3 id="basicPropertiesOptions"> + <title>Basic Properties Options</title> + <para>All <interface>Properties</interface> dialogs have the following + buttons at the bottom of the dialog: + <itemizedlist> + <listitem> + <para> + <guibutton>OK</guibutton> — + Pressing <guibutton>OK</guibutton> will activate any changes + in the properties you have made and close the + <interface>Properties</interface> dialog. + </para> + </listitem> + <listitem> + <para> + <guibutton>Apply</guibutton> — + Pressing <guibutton>Apply</guibutton> at any time will + make your changes active without closing the + <interface>Properties</interface> dialog. This is helpful if + you would like to test the effects of the changes you have + made but may want to continue changing the properties. + </para> + </listitem> + <listitem> + <para> + <guibutton>Close</guibutton> — + Pressing <guibutton>Close</guibutton> will close the + <interface>Properties</interface> dialog. Only changes in the + configuration which were previously applied with the + <guibutton>Apply</guibutton> button will persist. Other + changes will be discarded. + </para> + </listitem> + <listitem> + <para> + <guibutton>Help</guibutton> — + Pressing <guibutton>Help</guibutton> brings up the manual for + the application, opening it to the page describing the + <interface>Properties</interface> dialog. + + + + </para> +</listitem> +</itemizedlist> +</para> +</sect3> + + <sect3 id="tasklist-standard-right-click-items"> + <title>Standard Pop-Up Items</title> + <para> + All applets should have the following items in their right-click + <guimenu>pop-up menu</guimenu>: + <variablelist> + <varlistentry> + <term>Remove from panel</term> + <listitem> + <para> + The <guimenuitem>Remove from panel</guimenuitem> menu item + removes the applet from the <interface>Panel</interface>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Move</term> + <listitem> + <para> + After selecting <guimenuitem>Move</guimenuitem>, your mouse + pointer will change appearance (typically to a cross with + arrows in each direction). As you move your mouse, the applet + will move with it. When you have finished moving the applet, + click any mouse button and the applet will anchor in its + current position. Note that applets can be moved between two + <interface>Panels</interface> this way. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Panel</term> + <listitem> + <para> + The <guisubmenu>Panel</guisubmenu> submenu contains various + items and submenus for adding and removing + <interface>Panels</interface> and applets and for changing + the configuration. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>About</term> + <listitem> + <para> + The <guimenuitem>About...</guimenuitem> menu item brings up a + dialogue box containing various information about the applet, + typically including the applet's name, version, author, + copyright, license and description. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Help</term> + <listitem> + <para> + The <guimenuitem>Help</guimenuitem> menu item brings up the help + manual for the applet. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect3> + + + <sect3 id="tasklist-applet-bugs"> + <title> Known Bugs and Limitations</title> + <para> + There are no known bugs in the + <application>Tasklist</application> applet. + </para> + </sect3> + + <!-- ============= Authors ================================ --> + + <sect3 id="tasklist-authors"> + <title>Authors</title> + <para> + The <application>Tasklist</application> applet was written by Anders Carlsson + (<email>andersca@gnu.org</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 John Fleck + (<email>jfleck@inkstain.net</email>). Please send all comments and + suggestions regarding this manual to the <ulink type="http" + url="http://developer.gnome.org/projects/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://developer.gnome.org/projects/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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 id="license"> + <title>License</title> + <para> + This program is free software; you can redistribute it and/or + modify it under the terms of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> 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 + <ulink type="help" url="gnome-help:gpl"><citetitle>GNU General + Public License</citetitle></ulink> for more details. + </para> + <para> + A copy of the <ulink type="help" + url="gnome-help:gpl"><citetitle>GNU General Public + License</citetitle></ulink> is included with the GNOME documentation. You + may also obtain a + copy of the <ulink type="help" url="gnome-help:gpl"><citetitle>GNU + General Public License</citetitle></ulink> 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> + </sect3> +--> + </sect2> + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/tickastat-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/tickastat-ug.sgml new file mode 100644 index 0000000..4576897 --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/tickastat-ug.sgml @@ -0,0 +1,504 @@ + <sect2 id="tickastat"> + <title>Tick-a-Stat Applet</title> + + <para> + <application>Tick-a-Stat</application> applet, shown in <xref + linkend="tickastat-applet-fig">, watches various aspects of your + system and delivers information when certain events occur. For + example, it can watch the CPU load and warn you when the CPU is + being overloaded with concurrent processes. To add this + applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Tick-a-Stat</guimenuitem> + </menuchoice>. + </para> + + <figure id="tickastat-applet-fig"> + <title>Tick-a-Stat Applet</title> + <screenshot> + <screeninfo>Tick-a-Stat Applet</screeninfo> + <graphic format="png" fileref="figures/tickastat_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="tickastat-usage"> + <title>Usage</title> + <para> + After you have configured <application>Tick-a-Stat</application>, + it will run continuously and does not require any input. + General configuration of <application>Tick-a-Stat</application> is + explained in <xref linkend="tickastat-prefs">. There are several + modules which can be used. Their function and configuration is + described in <xref linkend="tickastat-modules">. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties…</guimenuitem> — + opens the <link linkend="tickastat-prefs"> + <guilabel>Properties</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Event Log…</guimenuitem> — + opens the <link linkend="tickastat-eventlog"> + <guilabel>Event Log</guilabel></link> dialog. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Tick-a-Stat + Applet</application>, including the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= Customization ============================= --> + <sect3 id="tickastat-prefs"> + <title>Customization</title> + <para> + You can customize <application>Tick-a-Stat</application> + applet by right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open the + <interface>Properties</interface> dialog(shown in <xref + linkend="tickastat-settings-fig">), which allows you to + change various settings. + </para> + + <figure id="tickastat-settings-fig"> + <title>Properties dialog</title> + <screenshot> + <screeninfo>Properties dialog</screeninfo> + <graphic format="png" fileref="figures/tickastat_settings" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The <guilabel>Modules</guilabel> tab lists the various modules + you can enable. Select a module from <guilabel>Module</guilabel> + list on the left to configure it in the pane on the right. Each + module and its configurable properties are described in <xref + linkend="tickastat-modules">. + </para> + + <para> + The properties in the <guilabel>General</guilabel> tab are: + <itemizedlist> + <listitem> + <para> + Enable logging of events — If this button is + checked, a log of each event detected by an enabled module + will be written to the file named in the <guilabel>Log + path</guilabel> entry. + </para> + </listitem> + + <listitem> + <para> + Log Path — This is name of the file which will be used + to store the event log. + </para> + </listitem> + </itemizedlist> + </para> + + <para> + The properties in the <guilabel>Display</guilabel> tab are: + <itemizedlist> + + <listitem> + <para> + Smooth scroll — Selecting this button causes old events + to slowly scroll upwards when new events occur, instead of + quickly moving up to make room. + </para> + </listitem> + + <listitem> + <para> + Smooth type — Selecting this button causes new text to + be slowly typed across the applet as if somebody is typing it, + instead of appearing very quickly. + </para> + </listitem> + + <listitem> + <para> + Delay when wrapping text — This is the time delay (in + tenths of a second) that it pauses when it wraps a message + around the right edge of the applet (ie. for a carriage return). + </para> + </listitem> + + <listitem> + <para> + Scroll speed between lines (Smooth scroll) — This is the + speed at which lines are scrolled upwards. + </para> + </listitem> + + <listitem> + <para> + Width — This is the width(in pixels) of the applet. + </para> + </listitem> + + <listitem> + <para> + Use all room on panel — Selecting this button expands + the applet along the <interface>Panel</interface> to fill all + space (up to any neighboring Panel objects if they exist.) + </para> + </listitem> + + <listitem> + <para> + Height — This is the height(in pixels) of the applet. + </para> + </listitem> + + <listitem> + <para> + Use panel size hint — Selecting this button causes the + applet to try to size itself to fit the + <interface>Panel</interface> height. + </para> + </listitem> + + </itemizedlist> + </para> + + + <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> + </sect3> + + <!-- ============= Modules ============================= --> + <sect3 id="tickastat-modules"> + <title>Modules</title> + <para> + <application>Tick-a-Stat</application> has several modules. + Each module watches a certain part of your system and responds + to different evens. Multiple modules can be run enabled at once. + The standard <application>Tick-a-Stat</application> modules are + described below. + </para> + + <sect4 id="tickastat-testmodule"> + <title>Test Module</title> + <para> + The Test module is a simple module that just prints + <quote>Testing line from test module :)</quote> in the applet + every few seconds. + </para> + </sect4> + + <sect4 id="tickastat-coredumpmodule"> + <title>Core Dump Catcher Module</title> + <para> + The Dump Monitor module monitors a certain path for core dumps. + If it finds one, it time stamps it and logs the backtrace. It also + displays a core dump logo and message in the main applet, as + shown in <xref linkend="tickastat-coredump-fig"> and optionally + will open a dialog displaying the backtrace. + </para> + <figure id="tickastat-coredump-fig"> + <title>Tick-a-Stat Showing a Core Dump</title> + <screenshot> + <screeninfo>Tick-a-Stat Showing a Core Dump</screeninfo> + <graphic format="png" fileref="figures/tickastat_coredump" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The Core Dump module settings are: + <itemizedlist> + + <listitem> + <para> + Enable this module — Selecting this button activates the + module. + </para> + </listitem> + + <listitem> + <para> + Show backtrace dialog on new core files — Selecting this + button will cause <application>Tick-a-Stat</application> to + open a dialog showing the backtrace each time a new core dump + is found. + </para> + </listitem> + + <listitem> + <para> + Path to monitor — Enter the name of the directory you + would like the Core Dump module to monitor for core dumps. + </para> + </listitem> + </itemizedlist> + </para> + </sect4> + + <sect4 id="tickastat-loadmonitormodule"> + <title>Load Average Monitor Module</title> + <para> + The Load Average Monitor module monitors the systems CPU usage + and warns you when the number of processes(programs) sharing the + CPU is too high. (This will cause poor performance of each + process and can be indicative of an errant program or daemon.) + When the CPU load is high it will display a warning, as shown in + <xref linkend="tickastat-loadmonitor-fig">. For even higher + loads, an alert is displayed. + </para> + <figure id="tickastat-loadmonitor-fig"> + <title>Tick-a-Stat Showing a Load Warning</title> + <screenshot> + <screeninfo>Tick-a-Stat Showing a Load Warning</screeninfo> + <graphic format="png" fileref="figures/tickastat_loadaverage" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <para> + The Load Average Monitor module settings are: + <itemizedlist> + + <listitem> + <para> + Enable this module — Selecting this button activates the + module. + </para> + </listitem> + + <listitem> + <para> + Check every (Seconds) — Set this to the interval (in + seconds) between checking the load. + </para> + </listitem> + + <listitem> + <para> + Show pop-up dialog for this event — Select this button + to have a pop-up dialog open each time a warning (or alert) + is issued. (This option occurs in both the Warning and Alert + sections.) + </para> + </listitem> + + <listitem> + <para> + Load average threshold — Set this to the load (the + average number of running programs which request use of the + CPU at any instant in time). (This option occurs in both the + Warning and Alert sections.) + </para> + </listitem> + + <listitem> + <para> + Text to display — Enter the message which should be + displayed when the load reaches the threshold level. + </para> + </listitem> + + </itemizedlist> + </para> + </sect4> + + <sect4 id="tickastat-filetailermodule"> + <title>File Tailer Module</title> + <para> + The File Tailer module shows any lines which are added to the + end of a given file. This is typically used to monitor the + output log files created by many programs. + </para> + + + <para> + The File Tailerr module settings are: + <itemizedlist> + + <listitem> + <para> + Enable this module — Selecting this button activates the + module. + </para> + </listitem> + + <listitem> + <para> + Path to tail — Set this to the name of the file you + wish to tail. (The term "tail" refers to watching the tail, + or end, of a file. In a shell, one can do this using the + <command>tail</command> command, typically with the "-f" + flag.) + </para> + </listitem> + + <listitem> + <para> + Show pop-up dialog for new line — Select this + to have a pop-up dialog showing the new line open each time a + new line is added to the file. + </para> + </listitem> + + </itemizedlist> + </para> + </sect4> + + </sect3> + + + <!-- ============= Event Log ============================== --> + <sect3 id="tickastat-eventlog"> + <title>The Event Log</title> + <para> + The event log is used to keep track of any events which register + in <application>Tick-a-Stat</application>. The file used for the + event log and whether event logging is enabled are specified in + the <guilabel>General</guilabel> tab of the <link + linkend="tickastat-prefs"> <guilabel>Properties</guilabel></link> + dialog. To view the event log, right click on the applet and + select <guimenuitem>Event log…</guimenuitem>. + </para> + + </sect3> + + + <!-- ============= 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 --> + <sect3 id="tickastatapplet-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="tickastat-authors"> + <title>Authors</title> + <para> + <application>Tick-a-Stat Applet</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/webcontrol-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/webcontrol-ug.sgml new file mode 100644 index 0000000..ce11a1c --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/webcontrol-ug.sgml @@ -0,0 +1,240 @@ + + + +<sect2 id="webcontrol"> + <title>WebControl Applet</title> + + <para> <application>WebControl Applet</application>, shown in <xref + linkend="webcontrol-applet-fig1">, allows you to launch your + <application>Netscape</application> browser with the URL you + indicate in the URL text box. To add this applet + to a <interface>Panel</interface>, right-click on the panel and choose + + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Network</guisubmenu> + <guimenuitem>WebControl</guimenuitem> + </menuchoice> + </para> + + + <figure id="webcontrol-applet-fig1"> + <title>WebControl Applet</title> + <screenshot> + <screeninfo>WebControl Applet</screeninfo> + <graphic format="png" fileref="figures/webcontrol-applet" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + + <sect3 id="webcontrol-applet-usage"> + <title> Usage</title> + <para> To use this applet, type the URL of the document you wish + to view in the text box. For an Internet URL, you must type in + <command>http://</command> followed by the web address, for + example, <command>http://www.gnome.org</command>. For a local + file, simply type the file's name. + </para> + + <para>If you would like to launch a new browser window instead of + using the currently active one, check the <guilabel>Launch new + window</guilabel> check box.</para> + + <para> Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Properties</guimenuitem>— opens the + <link linkend="webcontrol-applet-prefs"> + <guilabel>Properties</guilabel> + </link> dialog + </para> + </listitem> + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — displays this + document. + </para> + </listitem> + <listitem> + <para> + <guimenuitem>About</guimenuitem> — shows basic + information about <application>WebControl + Applet</application>, including the applet's version and author's name. + </para> + </listitem> + + + + + </itemizedlist> + </para> + </sect3> + + <sect3 id="webcontrol-applet-prefs"> + <title>Customization</title> + <para> + You can customize <application>WebControl Applet</application> by + right-clicking on it and choosing + <guimenuitem>Properties…</guimenuitem>. This will open + the <interface>Properties</interface> dialog (shown in <xref + linkend="webcontrol-applet-fig2">), which allows you to + change various settings. + </para> + <figure id="webcontrol-applet-fig2"> + <title>WebControl Properties Dialog</title> + <screenshot> + <screeninfo>Preferences dialog</screeninfo> + <graphic format="png" fileref="figures/webcontrol-applet-prefs" + srccredit="John Fleck"> + </graphic> + </screenshot> + </figure> + + <para> + The properties are: + <itemizedlist> + + <listitem> + <para><guilabel>Display URL label</guilabel> — + display the text <guilabel>Url:</guilabel> to the left of the + text entry window in the applet.</para> + </listitem> + + + <listitem> + <para> + <guilabel>Display "launch new window" option</guilabel> + — display check box on the applet window allowing you to + decide whether your document will be displayed in a new browser + window or the currently open.</para> + </listitem> + </itemizedlist> + </para> + + <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> + </sect3> + + <sect3 id="webcontro-applet-bugs"> + <title>Known bugs and limitations</title> + <para> + <application>WebControl Applet</application> only starts + <application>Netscape</application>. If you don't have + <application>Netscape</application>, it won't work. If you have + a different browser set as your URL handler, <application>Web + Control Applet</application> will still start <application>Netscape</application>. + </para> + <para><application>WebControl Applet</application> does not + resize to match the size of the panel if the panel is smaller than + <application>WebControl Applet's</application> normal height and width. This + effects both small horizontal panels and all vertical panels.</para> + </sect3> + + + + <!-- ============= Authors ================================ --> + + <sect3 id="webcontrol-authors"> + <title>Authors</title> + <para> + <application>WebControl Applet</application> was written by Garrett Smith + <email>gsmith@serv.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 John Fleck + (<email>jfleck@inkstain.net</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + + + + + + + + + + + + diff --git a/gnome-users-guide/gnome-users-guide-1.4/C/applets/whereami-ug.sgml b/gnome-users-guide/gnome-users-guide-1.4/C/applets/whereami-ug.sgml new file mode 100644 index 0000000..1a84e6a --- /dev/null +++ b/gnome-users-guide/gnome-users-guide-1.4/C/applets/whereami-ug.sgml @@ -0,0 +1,167 @@ + <sect2 id="whereami"> + <title>Where Am I? Applet</title> + + <para> + The <application>Where Am I?</application> applet, shown in <xref + linkend="whereamiapplet-fig">, shows the position + of your mouse pointer on the screen, reporting the coordinates as + <parameter>x</parameter> and <parameter>y</parameter>, where + <parameter>x</parameter> is horizontal and <parameter>y</parameter> + is vertical. The dimensions of an area on the screen can be determined + by dragging the cursor after the <application>Where Am I?</application> + applet has been activated.</para> + <para>To add this applet to a <interface>Panel</interface>, + right-click on the <interface>Panel</interface> and choose + <menuchoice> + <guimenu>Panel</guimenu> + <guisubmenu>Add to panel</guisubmenu> + <guisubmenu>Applet</guisubmenu> + <guisubmenu>Utility</guisubmenu> + <guimenuitem>Where Am I?</guimenuitem> + </menuchoice>. + </para> + + <figure id="whereamiapplet-fig"> + <title>Where Am I? Applet</title> + <screenshot> + <screeninfo>Where Am I? Applet</screeninfo> + <graphic format="png" fileref="figures/whereami_applet" + srccredit="muet"> + </graphic> + </screenshot> + </figure> + + <!-- ============= Usage ================================ --> + <sect3 id="whereami-usage"> + <title>Usage</title> + <para> + You don't need to do anything special to use this applet. It will + report the position of your cursor as you move your mouse about. + Clicking on the <application>Where Am I?</application> will "grab" + the cursor, causing it to change to a cross-hairs shape. Once the + cursor has been grabbed, you can can drag the cursor to measure + the dimensions of an area on the screen. A second click will + ungrab the cursor, and restore normal operation. + </para> + + <para> + Right-clicking on the applet brings up a menu containing the + following items: + <itemizedlist> + + <listitem> + <para> + <guimenuitem>Help</guimenuitem> — + displays this document. + </para> + </listitem> + + <listitem> + <para> + <guimenuitem>About…</guimenuitem> — + shows basic information about <application>Where Am I? + Applet</application>, inluding the applet's version and the + author's name. + </para> + </listitem> + + </itemizedlist> + </para> + </sect3> + + + <!-- ============= 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 --> + <sect3 id="whereami-bugs"> + <title>Known Bugs and Limitations</title> + <para> + This applet has no known bugs. + </para> + </sect3> + + + <!-- ============= Authors ================================ --> + + <sect3 id="whereami-authors"> + <title>Authors</title> + <para> + <application>Where Am I?</application> was written by John Kodis + (<email>kodis@jagunet.com</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 Telsa Gwynne + (<email>hobbit@aloss.ukuu.org.uk</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> + + --> + + </sect3> + + + <!-- ============= Application License ============================= --> + + <!-- + <sect3 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> + </sect3> + + --> + </sect2> + + + + |