← Back to branch summary

~ubuntu-branches/ubuntu/vivid/xfce4-session/vivid-proposed

« back to all changes in this revision

Viewing changes to doc/manual/xfce4-session.xml

  • Committer: Package Import Robot
  • Author(s): Lionel Le Folgoc
  • Date: 2012-05-18 20:21:52 UTC
  • mfrom: (4.1.7 experimental)
  • Revision ID: package-import@ubuntu.com-20120518202152-7bm9pla0j3ccfsnk
Tags: 4.10.0-1ubuntu1
* Merge from Debian experimental, remaining Ubuntu changes:
  - debian/control: build-depends on libgnome-keyring-dev to enable GNOME
    Keyring services support.
  - debian/rules: pass --enable-libgnome-keyring to dh_auto_configure.
  - debian/patches:
    + xubuntu_ignore-gdm-lang.patch: do not set $LANG to $GDM_LANG, there's
      already an xsession script to do that, and $GDM_LANG might not contain
      a valid locale code.

* debian/patches:
  - xubuntu_set-xdg-current-desktop.patch: added. Taken from xfce4-utils,
    export XDG_CURRENT_DESKTOP=XFCE, can be useful with alacarte and
    gnome-menus. lp #927172

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manual/xfce4-session.xml
1
 
<?xml version='1.0'?>
2
 
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
  <!ENTITY date "July 2005">
5
 
  <!ENTITY version "@PACKAGE_VERSION@">
6
 
  <!ENTITY app "@PACKAGE_NAME@">
7
 
]>
8
 
 
9
 
<article id="index" lang="en">
10
 
 
11
 
<!-- Header -->
12
 
<articleinfo>
13
 
 
14
 
  <title>Xfce 4 Session Manager</title>
15
 
 
16
 
  <copyright>
17
 
    <year>2003</year>
18
 
    <year>2004</year>
19
 
    <year>2005</year>
20
 
    <holder>Benedikt Meurer</holder>
21
 
  </copyright>
22
 
 
23
 
<!-- translators: uncomment this:
24
 
 
25
 
  <copyright>
26
 
   <year>2002</year> <holder>ME-THE-TRANSLATOR (Latin
27
 
   translation)</holder>
28
 
  </copyright>
29
 
 
30
 
 -->
31
 
 
32
 
  <legalnotice id="legalnotice">
33
 
    <para>
34
 
      Permission is granted to copy, distribute and/or modify this document
35
 
      under the terms of the GNU Free Documentation License, Version 1.1 or
36
 
      any later version published by the Free Software Foundation; with no
37
 
      Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
38
 
      Texts. The complete license text is available from the <ulink
39
 
      type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>.
40
 
    </para>
41
 
  </legalnotice>
42
 
 
43
 
  <authorgroup>
44
 
    <author>
45
 
      <firstname>Benedikt</firstname>
46
 
      <surname>Meurer</surname>
47
 
      <affiliation>
48
 
        <jobtitle>Software developer</jobtitle>
49
 
        <orgname>os-cillation</orgname>
50
 
        <orgdiv>System development</orgdiv>
51
 
        <address><email>benny@xfce.org</email></address>
52
 
      </affiliation>
53
 
    </author>
54
 
  </authorgroup>
55
 
 
56
 
  <releaseinfo>
57
 
    This manual describes the &app; package, version &version;.
58
 
  </releaseinfo>
59
 
 
60
 
  <pubdate>&date;</pubdate>
61
 
 
62
 
</articleinfo>
63
 
 
64
 
<sect1 id="xfsm-intro">
65
 
  <title>Introduction</title>
66
 
 
67
 
  <para><application>&app;</application> is a session manager for Xfce 4. Its task is to save the state of
68
 
  your desktop (opened applications and their location) and restore it during a next
69
 
  startup. You can create several different sessions and choose one of them on
70
 
  startup.
71
 
  </para>
72
 
 
73
 
  <para><application>&app;</application> provides session management for both X11R6 and
74
 
  legacy X11R5 protocols. If you don't need legacy session management
75
 
  support, you can disable it at compile time, giving
76
 
  --disable-legacy-sm to ./configure. Do <emphasis>NOT EVER</emphasis> run <application>smproxy</application> in
77
 
  session that is managed by <application>&app;</application>, or weird things will happen.
78
 
  The included legacy session management does everything that <application>smproxy</application>
79
 
  would do, and besides that, it also supports multiscreen display.</para>
80
 
 
81
 
</sect1>
82
 
 
83
 
<sect1 id="xfce4-session-settings">
84
 
  <title>Session Manager settings</title>
85
 
 
86
 
  <sect2 id="xfsm-general-settings">
87
 
        <title>General preferences</title>
88
 
 
89
 
    <figure id="xfsm-general-fig">
90
 
      <title><application>&app;</application> general preferences</title>
91
 
      <screenshot>
92
 
        <mediaobject>
93
 
          <imageobject>
94
 
            <imagedata fileref="images/xfsm-general.png" format="PNG" />
95
 
          </imageobject>
96
 
 
97
 
          <textobject>
98
 
            <phrase>Shows the General tab of the <application>&app;</application> settings dialog.</phrase>
99
 
          </textobject>
100
 
        </mediaobject>
101
 
      </screenshot>
102
 
    </figure>
103
 
 
104
 
        <variablelist>
105
 
      <varlistentry>
106
 
        <term>Display chooser on login</term>
107
 
        <listitem>
108
 
            <para>If set, the session manager will ask you to choose a session every
109
 
            time you log in to Xfce.</para>
110
 
        </listitem>
111
 
      </varlistentry>
112
 
 
113
 
      <varlistentry>
114
 
        <term>Automatically save session on logout</term>
115
 
        <listitem>
116
 
          <para>This option instructs the session manager to save the current
117
 
          session automatically when you log out. If you don't select this option
118
 
          you'll be prompted whether you want to save the current session on
119
 
          each logout.</para>
120
 
        </listitem>
121
 
      </varlistentry>
122
 
 
123
 
      <varlistentry>
124
 
        <term>Prompt on logout</term>
125
 
        <listitem>
126
 
          <para>This option disables the logout confirmation dialog. Whether
127
 
          the session will be saved or not depends on whether you enabled the
128
 
          automatic saving of sessions on logout or not.</para>
129
 
        </listitem>
130
 
      </varlistentry>
131
 
    </variablelist>
132
 
        </sect2>
133
 
 
134
 
        <sect2 id="xfsm-advanced-settings">
135
 
          <title>Advanced preferences</title>
136
 
 
137
 
    <figure id="xfsm-advanced-fig">
138
 
      <title><application>&app;</application> advanced preferences</title>
139
 
      <screenshot>
140
 
        <mediaobject>
141
 
          <imageobject>
142
 
            <imagedata fileref="images/xfsm-advanced.png" format="PNG" />
143
 
          </imageobject>
144
 
 
145
 
          <textobject>
146
 
            <phrase>Shows Advanced tab of the <application>&app;</application> settings dialog.</phrase>
147
 
          </textobject>
148
 
        </mediaobject>
149
 
      </screenshot>
150
 
    </figure>
151
 
 
152
 
    <variablelist>
153
 
      <varlistentry>
154
 
        <term>Launch Gnome services on startup</term>
155
 
        <listitem>
156
 
          <para>Enable this option if you need the GNOME keyring daemon to be run
157
 
          on startup. This option also instructs <application>&app;</application> to bring up the GNOME assistive
158
 
          technologies at startup (if enabled in the GNOME control center). See the
159
 
           GNOME documentation for more information on this topic.</para>
160
 
        </listitem>
161
 
                  </varlistentry>
162
 
 
163
 
      <varlistentry>
164
 
        <term>Launch KDE services on startup</term>
165
 
        <listitem>
166
 
          <para>Enable this option if you plan to run KDE applications as part of
167
 
          your Xfce Desktop session. This will notably increase the startup time,
168
 
          but on the other hand, KDE applications will startup faster. Some KDE
169
 
          applications may not work at all if you don't enable this option.</para>
170
 
        </listitem>
171
 
                </varlistentry>
172
 
 
173
 
      <varlistentry>
174
 
        <term>Manage remote applications</term>
175
 
        <listitem>
176
 
          <para>Allow the session manager to manage applications running on
177
 
          remote hosts. Since this option may constitute a security risk, by listening to
178
 
          a TCP port on your system, do not enable it unless you know what you are
179
 
          doing.</para>
180
 
          <para>System administrators may want to disable this option globally using the
181
 
          session managers <ulink url="#xfsm-kiosk-mode" type="html">KIOSK
182
 
          capabilities</ulink>.</para>
183
 
        </listitem>
184
 
      </varlistentry>
185
 
    </variablelist>
186
 
 
187
 
        </sect2>
188
 
</sect1>
189
 
 
190
 
<sect1 id="xfsm-customize">
191
 
        <title>Customizing the Session Manager</title>
192
 
 
193
 
        <para>You can customize the splash-screen that <application>&app;</application> will use when you log in to
194
 
        Xfce 4. There is a dedicated dialog available from the <emphasis>Xfce 4
195
 
  Settings Manager</emphasis>.</para>
196
 
 
197
 
        <sect2 id="xfsm-engines">
198
 
                <title>Splash screen settings</title>
199
 
 
200
 
    <figure id="splash-screen-settings-fig">
201
 
      <title>Splash screen settings dialog</title>
202
 
      <screenshot>
203
 
        <mediaobject>
204
 
          <imageobject>
205
 
            <imagedata fileref="images/xfsm-splash.png" format="PNG" />
206
 
          </imageobject>
207
 
 
208
 
          <textobject>
209
 
            <phrase>Shows the <application>&app;</application> splash screen settings dialog.</phrase>
210
 
          </textobject>
211
 
        </mediaobject>
212
 
      </screenshot>
213
 
    </figure>
214
 
 
215
 
    <para>On the left, the dialog shows a list of all installed engines.
216
 
    Select an engine, and you will see, if available, a preview and
217
 
    information about it. You can click on the <guibutton>Test</guibutton>
218
 
    button to see a demonstration of the selected splash screen
219
 
    engine.</para>
220
 
 
221
 
    <para><application>&app;</application> provides three Splash themes engines by default. Their
222
 
    respective configuration options - if any - are available from the
223
 
    <guibutton>Configure</guibutton> button.</para>
224
 
        </sect2>
225
 
 
226
 
        <sect2 id="xfsm-shutdown">
227
 
                <title>Shutdown/reboot options</title>
228
 
 
229
 
    <para><application>&app;</application> supports shutting down your computer when you log out
230
 
    of your desktop session. To be able to shutdown the computer, you
231
 
    have to be listed in the systems <filename>sudoers</filename> file,
232
 
    in particular, you must be allowed to execute the command
233
 
    <filename>${libdir}/xfce4/session/xfsm-shutdown-helper</filename>
234
 
    (<filename>/usr/sbin/xfsm-shutdown-helper</filename> on Debian GNU/Linux)
235
 
    as user root (where <filename>${libdir}</filename> is the <filename
236
 
    role="directory">lib</filename> sub directory in the prefix you
237
 
    installed <application>&app;</application>, for example
238
 
    <filename role="directory">/usr/local/lib/xfce4/session</filename>).</para>
239
 
 
240
 
    <para>For example, lets say, you installed <application>&app;</application> into <filename
241
 
    role="directory">/usr/local</filename>, your hostname is <emphasis>myhost</emphasis>
242
 
    and your user account is named <emphasis>myuser</emphasis>, then you
243
 
    would have to add the following line to your <filename>sudoers</filename>
244
 
    file (remember to use <application>visudo</application> to edit
245
 
    that file):</para>
246
 
 
247
 
<programlisting>
248
 
myuser myhost=/usr/local/lib/xfce4/session/xfsm-shutdown-helper
249
 
</programlisting>
250
 
        </sect2>
251
 
 
252
 
</sect1>
253
 
 
254
 
<sect1 id="xfsm-advanced">
255
 
  <title>Advanced</title>
256
 
 
257
 
  <sect2 id="files-and-env-vars">
258
 
    <title>Files and Environment Variables</title>
259
 
 
260
 
    <para>Xfce now uses the Basedir Specification as defined on <ulink
261
 
    url="http://freedesktop.org/" type="http">Freedesktop.org</ulink> to
262
 
    locate its data and configuration files. This means that file locations
263
 
    will be specified as a path relative to the directories described in
264
 
    the specification.</para>
265
 
 
266
 
    <variablelist>
267
 
      <varlistentry>
268
 
        <term>${XDG_CONFIG_HOME}</term>
269
 
        <listitem>
270
 
          <para>The first base directory to look for configuration
271
 
          files. By default this is set to <filename
272
 
          role="directory">~/.config/</filename>.</para>
273
 
        </listitem>
274
 
      </varlistentry>
275
 
 
276
 
      <varlistentry>
277
 
        <term>${XDG_CONFIG_DIRS}</term>
278
 
        <listitem>
279
 
          <para>A list of system directories that contain configuration
280
 
          data. By default the panel will look in <filename
281
 
          role="directory">${sysconfdir}/xdg/</filename> and
282
 
          <filename role="directory">/etc/xdg/</filename>. The value of
283
 
          ${sysconfdir} depends on how the program was build and will often be
284
 
          <filename role="directory">/etc/</filename> for binary
285
 
          packages.</para>
286
 
        </listitem>
287
 
      </varlistentry>
288
 
 
289
 
      <varlistentry>
290
 
        <term>${XDG_CACHE_HOME}</term>
291
 
        <listitem>
292
 
          <para>Specifies the root for all user-specific cache data. If
293
 
          this environment variable is unset, it defaults to <filename
294
 
          role="directory">~/.cache</filename>.</para>
295
 
        </listitem>
296
 
      </varlistentry>
297
 
 
298
 
      <varlistentry>
299
 
        <term>${XDG_CONFIG_DIRS}/autostart/</term>
300
 
        <listitem>
301
 
          <para>This is the location where the list of applications that
302
 
          should be automatically run on login is stored. Each autostarted
303
 
          application is represented by a <filename>.desktop</filename>
304
 
          file (see the <ulink type="http"
305
 
          url="http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html">Desktop
306
 
          Entry Specification</ulink> for details).</para>
307
 
          <para>Prior to Xfce 4.3, the list of autostarted applications
308
 
          was stored in <filename role="directory">~/Desktop/Autostart</filename>,
309
 
          which contained scripts and symbolic links to applications. If
310
 
          you run <application>&app;</application> &version; or above for the first time, it will
311
 
          automatically migrate the autostart items from the old location
312
 
          to the standard location and place a <filename>LOCATION-CHANGED.txt</filename>
313
 
          file in the old directory, that describes the location change.</para>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
 
317
 
      <varlistentry>
318
 
        <term>${XDG_CONFIG_DIRS}/xfce4-session/xfce4-session.rc</term>
319
 
        <listitem>
320
 
          <para>This is the location of the configuration file that
321
 
          includes the various settings for <application>&app;</application>, which can be changed
322
 
          from the settings dialog.</para>
323
 
        </listitem>
324
 
      </varlistentry>
325
 
 
326
 
      <varlistentry>
327
 
        <term>${XDG_CONFIG_DIRS}/xfce4-session/xfce4-splash.rc</term>
328
 
        <listitem>
329
 
          <para>This is the location of the configuration file that
330
 
          includes the configuration for the splash screen, which
331
 
          can be changed from the settings dialog.</para>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
 
335
 
      <varlistentry>
336
 
        <term>${XDG_CACHE_HOME}/sessions/</term>
337
 
        <listitem>
338
 
          <para>The directory where <application>&app;</application> and <application>xfwm4</application>
339
 
          store the session data to.</para>
340
 
        </listitem>
341
 
      </varlistentry>
342
 
 
343
 
      <varlistentry>
344
 
        <term>${sysconfdir}/xdg/xfce4/kiosk/kioskrc</term>
345
 
        <listitem>
346
 
          <para>Kiosk mode configuration file. See <ulink url="#xfsm-kiosk-mode">next
347
 
          section</ulink> for an explanation.</para>
348
 
        </listitem>
349
 
      </varlistentry>
350
 
    </variablelist>
351
 
 
352
 
    <para>None of the configuration files, except the <filename>kioskrc</filename>,
353
 
    are designed to be edited by hand during a Xfce session; in fact, the changes will
354
 
    be overwritten if you edit them while the session manager or the settings managers
355
 
    are running.</para>
356
 
 
357
 
    <para>System administrators might want to customize the file
358
 
    <filename>${sysconfdir}/xdg/xfce4-session/xfce4-session.rc</filename> to change
359
 
    the default applications that are run on Xfce startup. For example, if you want to
360
 
    start the <application>xfce4-iconbox</application> instead of the
361
 
    <application>xftaskbar4</application>, you would change the <emphasis>[Failsafe
362
 
    Session]</emphasis> section like to something like this:</para>
363
 
 
364
 
<programlisting>
365
 
[Failsafe Session]
366
 
Count=4
367
 
Client0_Command=xfwm4
368
 
Client0_PerScreen=False
369
 
Client1_Command=xfce4-panel
370
 
Client1_PerScreen=True
371
 
Client2_Command=xfce4-iconbox
372
 
Client2_PerScreen=True
373
 
Client3_Command=xfdesktop
374
 
Client3_PerScreen=False
375
 
</programlisting>
376
 
  </sect2>
377
 
 
378
 
  <sect2 id="xfsm-kiosk-mode">
379
 
    <title>Kiosk Mode</title>
380
 
 
381
 
    <para>The session manager offers support for the Kiosk Mode, that helps to
382
 
    prevent users from making changes to their session settings. To use it you
383
 
    have to edit or create the file
384
 
    <filename>${sysconfdir}/xdg/xfce4/kiosk/kioskrc</filename>.</para>
385
 
 
386
 
    <para>The way to explain the format of this file is by using an example. The
387
 
    xfce4-session section of your <filename>kioskrc</filename> might look like
388
 
    this:</para>
389
 
 
390
 
<programlisting>
391
 
[xfce4-session]
392
 
CustomizeSplash=ALL
393
 
CustomizeChooser=ALL
394
 
CustomizeLogout=ALL
395
 
CustomizeCompatibility=%wheel
396
 
Shutdown=%wheel
397
 
CustomizeSecurity=NONE
398
 
</programlisting>
399
 
 
400
 
    <para>This allows all users to change their splash, chooser and logout settings,
401
 
    but allows only users in the group <emphasis>wheel</emphasis> to customize the
402
 
    compatibility settings and shutdown the system. No one will be allowed to adjust
403
 
    the security settings.</para>
404
 
 
405
 
    <para>The session manager supports the following KIOSK capabilities:</para>
406
 
 
407
 
    <variablelist>
408
 
      <varlistentry>
409
 
        <term>CustomizeSplash</term>
410
 
        <listitem>
411
 
          <para>Whether or not the user is allowed to customize the splash screen.</para>
412
 
        </listitem>
413
 
      </varlistentry>
414
 
 
415
 
      <varlistentry>
416
 
        <term>CustomizeChooser</term>
417
 
        <listitem>
418
 
          <para>Whether or not the user is allowed to customize the session chooser settings.</para>
419
 
        </listitem>
420
 
      </varlistentry>
421
 
 
422
 
      <varlistentry>
423
 
        <term>CustomizeLogout</term>
424
 
        <listitem>
425
 
          <para>Whether or not the user is allowed to customize the logout settings.</para>
426
 
        </listitem>
427
 
      </varlistentry>
428
 
 
429
 
      <varlistentry>
430
 
        <term>CustomizeCompatibility</term>
431
 
        <listitem>
432
 
          <para>Whether or not the user is allowed to customize the compatibility
433
 
          settings (KDE/Gnome compat)</para>
434
 
        </listitem>
435
 
      </varlistentry>
436
 
 
437
 
      <varlistentry>
438
 
        <term>CustomizeSecurity</term>
439
 
        <listitem>
440
 
          <para>Whether or not the user is allowed to customize the security settings.
441
 
          This is one of the most <emphasis>IMPORTANT</emphasis> settings, since it
442
 
          prevents users (actually <filename>libICE</filename>) from binding to a TCP port.</para>
443
 
        </listitem>
444
 
      </varlistentry>
445
 
 
446
 
      <varlistentry>
447
 
        <term>Shutdown</term>
448
 
        <listitem>
449
 
          <para>Whether or not the user is allowed to shutdown (reboot or poweroff) the system.
450
 
          If a user lacks this capability the reboot and poweroff options in the shutdown
451
 
          dialog will be greyed out.</para>
452
 
        </listitem>
453
 
      </varlistentry>
454
 
    </variablelist>
455
 
  </sect2>
456
 
</sect1>
457
 
 
458
 
<sect1 id="xfsm-copyright">
459
 
  <title>About <application>&app;</application></title>
460
 
 
461
 
  <para><application>&app;</application> was written by Benedikt Meurer
462
 
  (<email>benny@xfce.org</email>).
463
 
    To find more information, please visit the
464
 
    <ulink url="http://www.xfce.org" type="http">Xfce web site</ulink>.
465
 
  </para>
466
 
 
467
 
  <para>To report a bug or make a suggestion regarding this application or
468
 
    this manual, use the bug tracking system at <ulink
469
 
      url="http://bugzilla.xfce.org/"
470
 
      type="http">http://bugzilla.xfce.org/</ulink>.
471
 
  </para>
472
 
 
473
 
  <para>If you have questions about the use or installation of this package,
474
 
    please ask on the <ulink
475
 
      url="http://lunar-linux.org/mailman/listinfo/xfce"
476
 
      type="http">xfce</ulink> mailing list. Development discussion takes
477
 
    place on the <ulink
478
 
      url="http://lunar-linux.org/mailman/listinfo/xfce4-dev"
479
 
      type="http">xfce4-dev</ulink> mailing list.
480
 
  </para>
481
 
 
482
 
  <para> This program is distributed under the terms of the
483
 
    GNU General Public License as published by the Free Software Foundation;
484
 
    either version 2 of the License, or (at your option) any later version.
485
 
  </para>
486
 
 
487
 
  <para>You should have received a copy of the GNU General Public License
488
 
    along with this program; if not, write to the Free Software
489
 
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
490
 
    USA.
491
 
  </para>
492
 
 
493
 
</sect1>
494
 
 
495
 
</article>
496