summaryrefslogtreecommitdiffstats
path: root/gnome-users-guide/gnome-users-guide-1.4/C/applets/modemlights-ug.sgml
blob: 462d71b0cd2a6358cf37450400f193de7fb09106 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
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>&mdash; brings up
	    <link linkend="modemlights-prefs">
                <guilabel>Properties</guilabel>
            </link> dialog
	    </para>
	</listitem>

        <listitem>
	  <para>
	    <guimenuitem>Help</guimenuitem> &mdash; brings up this
            document. 
	    </para>
	</listitem>
	
	<listitem>
	  <para>
	    <guimenuitem>About</guimenuitem> &mdash; 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&hellip;</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> &mdash;  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> &mdash;
        Display a dialog box confirming your connection.</para>
      </listitem>

      <listitem>
       <para>
        <guilabel>Updates per second</guilabel> &mdash; Set the update
        rate of <application>Modem Lights
        Applet's</application> display.</para>
      </listitem>
 <listitem>
	    <para><guilabel>Show connect time and
        throughput</guilabel> &mdash; 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> &mdash;
    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>
        &mdash;  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> &mdash; 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> &mdash; 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>