File: fast-user-switch-applet.xml

package info (click to toggle)
fast-user-switch-applet 2.22.0-1
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 4,452 kB
  • ctags: 441
  • sloc: sh: 9,155; ansic: 5,028; xml: 3,013; makefile: 152
file content (417 lines) | stat: -rw-r--r-- 21,662 bytes parent folder | download | duplicates (2)
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appversion "0.2.4">
  <!ENTITY app "<application>User Switcher</application>">
  <!ENTITY appname "User Switcher">
]>
<!--
      (Do not remove this comment block.)
  Maintained by the GNOME Documentation Project
  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 12, 2002
-->
<article id="index" lang="en">
  <articleinfo>
    <title>&appname; Applet</title>
    <copyright>
      <year>2005</year>
      <holder>Joseph Pingenot</holder>
    </copyright>
    <copyright>
      <year>2005</year>
      <holder>James M. Cape</holder>
    </copyright>

<!-- translators: uncomment this:

    <copyright>
      <year>2002</year>
      <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
    </copyright>

   -->

    <publisher>
      <publishername>GNOME Documentation Project </publishername>
    </publisher>

    &legal;
  <!-- This file  contains link to license for the documentation (GNU FDL), and
        other legal stuff such as "NO WARRANTY" statement. Please do not change 
        any of this. -->

    <authorgroup>
      <author>
        <firstname>Joseph</firstname>
        <surname>Pingenot</surname>
      </author>
      <author role="maintainer">
	<firstname>James</firstname>
	<surname>Cape</surname>
      </author>
    </authorgroup>

    <abstract role="description">
      <para>User manual for the &appname; applet.</para>
    </abstract>

    <revhistory>
      <revision>
	<revnumber>Version 0.1</revnumber>
	<date>May 2005</date>
	<authorinitials>JP</authorinitials>
	<revdescription>
	   <para role="author">Joseph Pingenot</para>
	   <para role="publisher">GNOME Documentation Project</para>
	   <para>Infrastrucutre (e.g. legal notice, boilerplate code) shamelessly copied from the GNOME Drive Mount Applet Manual. Thanks!</para>
	</revdescription>
      </revision>

      <revision>
	<revnumber>Version 0.2</revnumber>
	<date>July 2005</date>
	<authorinitials>JMC</authorinitials>
	<revdescription>
	   <para role="author">James M. Cape</para>
	   <para role="publisher">GNOME Documentation Project</para>
	   <para>Updates for interface changes.</para>
	</revdescription>
      </revision>
    </revhistory>
    
    <releaseinfo>This manual describes version &appversion; of the &appname; applet.</releaseinfo>
    <legalnotice>
      <title>Feedback</title>
      <para>To report a bug or make a suggestion regarding the &app; applet or
      this manual, follow the directions in the 
	<ulink url="ghelp:gnome-feedback" type="help">GNOME Feedback Page</ulink
>. 
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice>
  </articleinfo>

  <indexterm zone="index"> 
    <primary>Fast User Switching Applet</primary> 
  </indexterm> 
  

  <!-- =======================  Introduction  ======================= -->
  <sect1 id="fusa-intro">
    <title>Introduction</title>
    <figure id="fusa-intro-fig"> 
      <title>&appname; Applet</title> 
      <screenshot> 
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/fast_user_switch_applet-text.png" format="PNG"/>
          </imageobject>
          <textobject>
            <phrase>The &appname; applet as text.</phrase>
          </textobject>
        </mediaobject>
      </screenshot>
    </figure>
    <para>
      The &app; allows you to quickly change between user accounts without having to log out.
    </para>
    <para>
      After your system administrator has installed &app;, no further configuration is necessary for most users. You may add the applet to a panel and begin using it immediately.
    </para>
    <sect2 id="fusa-intro-adding">
      <title>Adding the &app; to a <application>Panel</application></title>
      <para>
	To add &app; to your <application>Panel</application>, simply right-click on the <application>Panel</application> to which you wish to add &app;, select <guimenuitem>Add to Panel...</guimenuitem>, and then select <guilabel>&appname;</guilabel> from the list of items presented to you, and click <guibutton>OK</guibutton>.
      </para>
      <para>
	The exact appearance of the &app; depends on the size and type of the panel in which it resides, but you should now be able to use the &app; by clicking on the word <guilabel>Users</guilabel>.
      </para>
    </sect2>
  </sect1>
  <sect1 id="fusa-usage">
    <title>Using the &app;</title>
    <para>
      Using the &app; is easy. You should see the word <guilabel>Users</guilabel> on your Panel. You use the Applet by clicking on that word, which does different things depending on the mouse button you are using.
    </para>
    <sect2 id="fusa-usage-left">
      <title>Left-Clicking on the Applet</title>
      <figure id="fusa-usage-left-fig"> 
        <title>The applet menu</title> 
        <screenshot> 
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/fast_user_switch_applet.png" format="PNG"/>
            </imageobject>
            <textobject>
              <phrase>The applet menu.</phrase>
            </textobject>
          </mediaobject>
        </screenshot>
      </figure>
      <para>
	When you left-click on the &app;, a menu will pop up. This menu contains a list of users to which you can switch, as well as the option to simply go to the login screen.
      </para>
      <para>
	To either log in as another user, or to resume another user's session, simply click on that user's name. If the user is already logged in, then you will switch to that user's session and you will have to unlock the screen. If the user hasn't logged in, then you will be sent to the login screen.  Simply enter the user's name and password as requested, just as you do to log in normally.
      </para>
      <para>
	When you switch to another user, your session will be locked. You will have to enter your password to finish resuming your session.
      </para>
    </sect2>
    <sect2 id="fusa-usage-middle">
      <title>Middle-Clicking on the Applet</title>
      <para>
	As with any other GNOME applet, you can use the middle mousebutton to easily move an applet around on the <application>Panel</application>. Simply move your mouse over the &app;, and then press and hold the middle mousebutton. While holding the middle mousebutton, move your mouse. You should also move the applet.  If the applet does not move, you will need to unlock the applet by releasing the middle mousebutton, and then using the right mousebutton to bring up applet options, as described in the next section.
      </para>
      <para>
        Once you are satisfied with the applet's location on the <application>Panel</application>, release the middle mousebutton, and you're done! You may optionally lock the applet to this location, as described in the next section.   Middle-clicking on the applet allows you to move it within the panel. See
        <ulink type="help" url="ghelp:user-guide?gospanel-32">Moving a panel object</ulink> for more information.
      </para>
    </sect2>
    <sect2 id="fusa-usage-right">
      <title>Right-Clicking on the Applet</title>
      <figure id="fusa-usage-right-fig"> 
        <title>The Context Menu</title> 
        <screenshot> 
          <mediaobject> 
            <imageobject>
              <imagedata fileref="figures/fast_user_switch_applet-context.png" format="PNG"/> 
            </imageobject>
            <textobject>
              <phrase>The context menu</phrase>
            </textobject> 
          </mediaobject> 
        </screenshot> 
      </figure>
      <para>
	When you right-click on the &app;, a menu will appear. This menu lists the following things which you can do:
      </para>
      <itemizedlist>
	<listitem id="fusa-usage-right-epi">
	  <simpara>
	    <guimenuitem>Edit Personal Information</guimenuitem>
	  </simpara>
	  <para>
	    This option is a shortcut into the GNOME control center's <application>About Me</application> configuration dialog, which allows you to change your name, password, photo, etc.
	  </para>
	</listitem>
	<listitem id="fusa-usage-right-eug">
	  <simpara>
	    <guimenuitem>Edit Users and Groups</guimenuitem>
	  </simpara>
	  <para>
	    This option is a shortcut into the GNOME system utilites' user management system.  In order to run the tool, you must have administrator privileges. When you are finished, click <guibutton>OK</guibutton>, and you can continue into the GNOME system utilities' user management system. Please refer to that manual for further information on managing users and groups. To exit the password request, click <guibutton>Cancel</guibutton>.
	  </para>
	</listitem>
	<listitem id="fusa-usage-right-sls">
	  <simpara>
	    <guimenuitem>Setup Login Screen</guimenuitem>
	  </simpara>
	  <para>
	    This item, like the <guimenuitem>Edit Users and Groups</guimenuitem> menu item, requires administrator privileges, and lets you modify the appearance of the login screen. See the <guimenuitem>Edit Users and Groups</guimenuitem> and the login screen settings information in the GNOME system utilities manual for more information.
	  </para>
	</listitem>
	<listitem id="fusa-usage-right-prefs">
	  <simpara>
	    <guimenuitem>Preferences</guimenuitem>
	  </simpara>
	  <para>
	    The <guimenuitem>Preferences</guimenuitem> menu item will open the preferences dialog, which can be used to configure the &app;. See <xref linkend="fusa-config"/> for more information.
	  </para>
	</listitem>
	<listitem id="fusa-usage-right-about">
	  <simpara>
	    <guimenuitem>About</guimenuitem>
	  </simpara>
	  <para>
	    The <guimenuitem>About</guimenuitem> menu item will bring up a new window which will tell you a little bit more about the &app;. Here you can find out what version of the &app; you have, who made it, and where its home website is located. Additionally, by selecting the <guibutton>Credits</guibutton> and <guibutton>License</guibutton> buttons, you can find out who helped create it, and under what license it is distributed. Click the <guibutton>Close</guibutton> button to close this window when you are done.
	  </para>
	</listitem>
	<listitem id="fusa-usage-right-rfp">
	  <simpara>
	    <guimenuitem>Remove from Panel</guimenuitem>
	  </simpara>
	  <para>
	    The <guimenuitem>Remove From Panel</guimenuitem> menu item allows you to remove an applet from the <application>Panel</application>. You can later add the applet back again as described in the introduction. However, when an applet is removed from the panel, its settings will be lost. You will not be asked if you are sure before the applet is removed.
	  </para>
	</listitem>
	<listitem id="fusa-usage-right-move">
	  <simpara>
	    <guimenuitem>Move</guimenuitem>
	  </simpara>
	  <para>
	    The <guimenuitem>Move</guimenuitem> menu item provides another common way to move applets on the <application>Panel</application>. When you select this option, the applet may be moved simply by moving your mouse. Your cursor will change to illustrate the fact that you are moving the applet. When you have the applet where you want it on the <application>Panel</application>, press any mousebutton to drop the applet into place. Your cursor will change back, reflecting the fact that you are no longer moving the applet.
	  </para>
	</listitem>
	<listitem id="fusa-usage-right-lock">
	  <simpara>
	    <guimenuitem>Lock To Panel</guimenuitem>
	  </simpara>
	  <para>
	    The <guimenuitem>Lock To Panel</guimenuitem> menu item lets you lock the applet into its position on the <application>Panel</application>. Once an applet is Locked, it cannot be moved accidentally. The <guimenuitem>Move</guimenuitem> menu item (discussed next) will be "greyed" and you will no longer be able to select it. To move the applet again, you must first unlock the applet by selecting the <guimenuitem>Lock To Panel</guimenuitem> menu item again. The <guimenuitem>Move</guimenuitem> menu item will once again be selectable.
	  </para>
	</listitem>
      </itemizedlist>
    </sect2>
  </sect1>

  <!-- ======================  Configuration  ======================= -->
  <sect1 id="fusa-config">
    <title>Configuring the &app;</title>
    <figure id="fusa-config-prefs-fig"> 
      <title>Preferences dialog</title>
      <screenshot> 
        <mediaobject> 
          <imageobject>
            <imagedata fileref="figures/fast_user_switch_applet-prefs.png" format="PNG"/> 
          </imageobject>
          <textobject> 
            <phrase>The Preferences dialog.</phrase>
          </textobject> 
        </mediaobject> 
      </screenshot> 
    </figure>
    <para>
      The "Preferences" menu item brings up window where you may change the &app;'s behavior and appearance. There are two major sections in it: "Appearance" and "Options".
    </para>
    <sect2 id="fusa-config-appearance">
      <title>Appearance</title>
      <para>
	The <guilabel>Appearance</guilabel> option group changes the way the &app; applet is displayed on the panel to match the selected option.
      </para>
      <para>
	The first option, which should appear as your name, will make the applet appear as your name on the Panel. That is, the word <guilabel>Users</guilabel> will be replaced by your username. In the example above, the user's name is "Tyler Durden". If the name which appears here is not your name, you may change it using the <guimenuitem>Edit Personal Information</guimenuitem> item in the context menu. 
      </para>
      <figure id="fusa-config-appearance-username-fig"> 
        <title>The applet in username mode</title> 
        <screenshot> 
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/fast_user_switch_applet-username.png" format="PNG"/>
            </imageobject>
            <textobject>
              <phrase>The &appname; applet as the current user name.</phrase>
            </textobject>
          </mediaobject>
        </screenshot>
      </figure>
      <para>
	The second option is the word <guilabel>Users</guilabel> and is what is in use if you don't change your Preferences. The word <guilabel>Users</guilabel> will appear on the <application>Panel</application> to represent the &app;.
      </para>
      <figure id="fusa-config-appearance-text-fig"> 
        <title>The applet in text mode</title> 
        <screenshot> 
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/fast_user_switch_applet-text.png" format="PNG"/>
            </imageobject>
            <textobject>
              <phrase>The &appname; applet as text.</phrase>
            </textobject>
          </mediaobject>
        </screenshot>
      </figure>
      <para>
	The third and final option is a picture (see the example above). If you select this option, this picture will appear on the Panel to represent the &app;.
      </para>
      <figure id="fusa-config-appearance-icon-fig"> 
        <title>The applet in icon mode</title> 
        <screenshot> 
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/fast_user_switch_applet-icon.png" format="PNG"/>
            </imageobject>
            <textobject>
              <phrase>The &appname; applet as icon.</phrase>
            </textobject>
          </mediaobject>
        </screenshot>
      </figure>
    </sect2>
    <sect2 id="fusa-config-options">
      <title>Options</title>
      <para>
	The <guilabel>Options</guilabel> preference section provides options which control the behavior (as opposed to the appearance) of the &app;.
      </para>
      <sect3 id="fusa-config-options-lock">
	<title>Lock the screen after switching users</title>
	<para>
	  This option determines whether the &app; will attempt to lock the screen after switching to another user or login screen. If this option is enabled, your password must be entered to regain access to your desktop. If this option is disabled, then anyone on your computer may access your desktop without any passwords by switching back to your desktop.
	</para>
	<para>
	  When disabled, this option will disable security when switching users, so unless you explicitly trust everyone with access to the computer, it's better to leave it enabled.
	</para>
      </sect3>
      <sect3 id="fusa-config-options-nested">
	<title>Create new logins in nested windows</title>
	<para>
	  When this option is active, you will not actually switch screens when you log in as another user with the &app;. Instead, each new login will appear inside a window on your current screen. For obvious reasons, the current screen will not be locked when creating a new logins inside windows.
	</para>
	<para>
	  This option exists primarily to aid development of various desktop technologies, so most people won't have cause to enable it.
	</para>
      </sect3>
    </sect2>
  </sect1>
  
  <!-- ===========================  Notes  =========================== -->
  <sect1 id="fusa-notes">
    <title>Notes for Nerds</title>
    <sect2 id="fusa-notes-problems">
      <title>Common Problems</title>
      <qandaset>
        <qandaentry>
          <question>
            <para>
              User "faces" are not appearing in other users' menus.
            </para>
          </question>
          <answer>
            <para>
              In order for user faces to be visible, they must be readable by all users. Currently, faces are stored in image format in the file called <filename>~/.face</filename>. As a result, the <filename>~/.face</filename> file must have permissions which allow other users to read it (typically, a permissions mask of <computeroutput>0644</computeroutput> or <computeroutput>-rw-r--r--</computeroutput> will suffice), and the users home directories must allow listing by others (at minimum, <computeroutput>0711</computeroutput>, or <computeroutput>drwx--x--x</computeroutput> will suffice).
            </para>
          </answer>
        </qandaentry>
        <qandaentry>
          <question>
            <para>
              The &app; does not appear in the <guilabel>Add to Panel</guilabel> dialog.
            </para>
          </question>
          <answer>
            <para>
              The &app; must be installed to the same prefix as the <application>Panel</application>. That is, if the <application>Panel</application> is at <command>/usr/bin/panel</command>, the applet should be installed to the /usr prefix. If the applet was installed properly (for example, via your distribution), then try logging out and back in to refresh the <guilabel>Add to Panel</guilabel> list.
            </para>
          </answer>
        </qandaentry>
      </qandaset>
    </sect2>
    <sect2 id="fusa-notes-hidden">
      <title>Hidden Options</title>
      <para>
        The &app; applet contains some useful hidden options for geeks, nerds, administrators, and other misfits. These options require modifying the configuration using special tools like the <application>Configuration Editor</application> or <command>gconftool-2</command>, but they can cause some unexpected or undesired behavior. These options affect every instance of the &app; for a particular user, and can be locked by administrators.
      </para>
      <sect3 id="fusa-notes-hidden-show-active-users-only">
        <title>Show Active Users Only</title>
        <para>
          This key, in <filename>/apps/fast-user-switch-applet/show_active_users_only</filename> determines whether to show only those users who are currently logged in (when enabled), or all legal users (when disabled).
        </para>
      </sect3>
      <sect3 id="fusa-notes-hidden-show-screen-item">
        <title>Show Login Screen Menuitem</title>
        <para>
          This key, in <filename>/apps/fast-user-switch-applet/show_screen_item</filename> determines whether to show the <guimenuitem>Login Screen</guimenuitem> menu item at the bottom of the left-click menu (see <xref linkend="fusa-usage-left" /> for more information on this menu). This item is used to create a new, empty login screen. If this option is set to <computeroutput>always</computeroutput>, the item will always be shown. If this option is set to <computeroutput>auto</computeroutput>, then the item will be shown if the applet is configured to not use nested logins (see <xref linkend="fusa-config-options-nested"/> for more information). If this option is set to <computeroutput>never</computeroutput>, then the item will never be shown. 
        </para>
      </sect3>
      <sect3 id="fusa-notes-hidden-show-window-item">
        <title>Show Login Window Menuitem</title>
        <para>
          This key, in <filename>/apps/fast-user-switch-applet/show_window_item</filename> determines whether to show the <guimenuitem>Login Window</guimenuitem> menu item at the bottom of the left-click menu (see <xref linkend="fusa-usage-left" /> for more information on this menu). This item is used to create a new empty login screen inside a window on the current screen. If this option is set to <computeroutput>always</computeroutput>, the item will always be shown. If this option is set to <computeroutput>auto</computeroutput>, then the item will be shown if the applet is configured to use nested logins (see <xref linkend="fusa-config-options-nested"/> for more information). If this option is set to <computeroutput>never</computeroutput>, then the item will never be shown.
        </para>
      </sect3>
    </sect2>
  </sect1>
</article>