improved the configuration section
[ikiwiki.git] / docs / newhandbook / X / index.mdwn
1 # The X Window System 
2 ***Updated for X.Org's X11 server by Ken Tom and Marc Fonvieille. Updated for DragonFly by Victor Balada Diaz. Updated for 2014 pkgng by Warren Postma***
3
4 [[!toc  levels=3]]
5
6
7 ## Synopsis 
8
9
10 This chapter will cover the installation and some configuration of the usual way of giving your Dragonfly BSD system an X-Windows style Graphical User Interface (GUI) and a modern Desktop Environment.  In Unix systems, the graphical drawing system is provided by the combination of an X11R6 compliant X-Windows Server, such as the X.org server, and other software such as Window Managers and Desktop Environments.  This multi-layered approach may be surprising to people coming from systems like the Mac or like Windows where these components are not so flexible, or provided by so many separately installed and configured pieces. 
11
12 For more information on the video hardware support in X.org, check the [X.org](http://www.x.org/) web site. If you have problems configuring your X server, just search the web. There are lots of tutorials and guides on how to set up your X properly, if the information in this page is not enough for your situation.
13
14 Before reading this chapter, you should know how to install additional third-party software. Read the  `dports` section of the documentation, for DragonFly 3.4 and later.
15
16
17
18
19
20 ## Understanding X 
21
22 ### What is X.Org
23
24 X.Org is the most popular free implementation of the X11 specification.  The X11 specification is an open standard, and there are other implementations, some commercial, and some free.
25
26 ### The Window Manager and the Desktop Environment
27
28 An X Server is a very low level piece of software.  It does not provide any way to move windows around or resize them. It does not provide a title bar on the top of your windows, or a dock, or any menus.
29
30 These things are the job, in the oldest style of X environment, of your window manager, or in more recent times, of a Desktop Environment.
31
32 Installing X.org by itself does not give you any window manager or any desktop environment. You will have to choose one and install it yourself. Until you select one, your system will not be usable.
33
34 There are dozens of window managers and desktop environments available for X. The most retro ones you might chose include `fvwm` and `twm` which have that retro 1980s workstation look and feel.  There are also window managers included inside modern desktop environments like XFCE, KDE and Gnome.  
35
36 If you are brand new and don't know what to do, select the XFCE4 desktop and follow those instructions.
37 Every desktop environment and window manager also has a different configuration mechanism. Read your chosen environment's documentation to learn more.   Some are configured by text files alone, and some (like KDE and Gnome) have sophisticated graphical configuration utilities and "control panels".
38
39 Note that XFCE4 and Gnome and KDE do not require you to install any window manager as they include one automatically.
40
41
42 ## Installing X
43
44 **X.org**  is currently available in the DragonFly dports collection.
45
46 To install:
47
48     # pkg install xorg-7.7
49
50 By the time you read this, it might be a newer version of xorg than 7.7, you can also try this general command:
51
52     # pkg install xorg
53
54
55
56 ## Configuring X
57
58
59 You may need to add the following like to `/etc/rc.conf`:
60
61    # hald_enabled="YES" 
62
63 As of version 7.3, Xorg can often work without any configuration file by simply typing at prompt:
64
65     
66
67     % startx
68
69 If this does not work, or if the default configuration is not acceptable, then X11 must be configured manually.  For example, if X11 does not detect your mouse then you will not get a mouse pointer, you will get a desktop (either a color or a dotted-pattern) but moving your mouse will not result in you seeing a mouse pointer move around.  Also, you might get a garbled display, or no display at all. If any of these happen to you, you need to do some manual configuration of X.org, which means a configuration text file.
70
71
72 Configuration of X11 is a multi-step process. The first step is to build an initial configuration file. As the super user, simply run:
73    
74
75     # Xorg -configure
76
77
78 This will generate an X11 configuration skeleton file in the `/root` directory called `xorg.conf.new` (whether you [su(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=su&section=1) or do a direct login affects the inherited supervisor `$HOME` directory variable). The X11 program will attempt to probe the graphics hardware on the system and write a configuration file to load the proper drivers for the detected hardware on the target system.
79
80
81
82 The next step is to test the existing configuration to verify that  **X.org**  can work with the graphics hardware on the target system. To perform this task, type:
83
84    
85
86     # Xorg -config xorg.conf.new
87
88
89 If a black and grey grid and an X mouse cursor appear, the configuration was successful. To exit the test, just press  **Ctrl** + **Alt** + **Backspace**  simultaneously.
90
91
92
93 **Note:** If the mouse does not work, you will need to first configure it before proceeding. This can usually be achieved by just using `/dev/sysmouse` as the input device in the config file and enabling `moused`:
94
95         # rcenable moused
96
97
98
99 Tune the `xorg.conf.new` configuration file to taste and move it to where [Xorg(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xorg&section=1) can find it. This is typically `/etc/X11/xorg.conf` or `/usr/pkg/xorg/lib/X11/xorg.conf`.
100
101     
102
103 The X11 configuration process is now complete. You can start  **X.org**  with [startx(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=startx&section=1). The X11 server may also be started with the use of [xdm(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xdm&section=1).
104
105
106
107
108 ## The X Display Manager 
109
110  ***Contributed by Seth Kingsley.***
111
112
113
114 ### Overview 
115
116
117
118  The X Display Manager ( **XDM** ) is an optional part of the X Window System that is used for login session management. This is useful for several types of situations, including minimal "X Terminals", desktops, and large network display servers. Since the X Window System is network and protocol independent, there are a wide variety of possible configurations for running X clients and servers on different machines connected by a network.  **XDM**  provides a graphical interface for choosing which display server to connect to, and entering authorization information such as a login and password combination.
119
120
121
122  Think of  **XDM**  as providing the same functionality to the user as the [getty(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=getty&section=8) utility (see [ Section 17.3.2](term.html#TERM-CONFIG) for details). That is, it performs system logins to the display being connected to and then runs a session manager on behalf of the user (usually an X window manager).  **XDM**  then waits for this program to exit, signaling that the user is done and should be logged out of the display. At this point,  **XDM**  can display the login and display chooser screens for the next user to login.
123
124
125
126 ### Using XDM 
127
128
129
130  The  **XDM**  daemon program is located in `/usr/pkg/bin/xdm`. This program can be run at any time as `root` and it will start managing the X display on the local machine. If  **XDM**  is to be run every time the machine boots up, a convenient way to do this is by adding an entry to `/etc/ttys`. For more information about the format and usage of this file, see [ Section 17.3.2.1](term.html#TERM-ETCTTYS). There is a line in the default `/etc/ttys` file for running the  **XDM**  daemon on a virtual terminal:
131
132
133
134      
135
136     ttyv8   "/usr/pkg/bin/xdm -nodaemon"  xterm   off secure
137
138
139
140
141
142  By default this entry is disabled; in order to enable it change field 5 from `off` to `on` and restart [init(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=init&section=8) using the directions in [ Section 17.3.2.2](term.html#TERM-HUP). The first field, the name of the terminal this program will manage, is `ttyv8`. This means that  **XDM**  will start running on the 9th virtual terminal.
143
144
145
146 ### Configuring XDM 
147
148
149
150  The  **XDM**  configuration directory is located in `/var/lib/xdm`. The sample configuration files are in `/usr/pkg/share/examples/xdm/`, in this directory there are several files used to change the behavior and appearance of  **XDM** . Typically these files will be found:
151
152
153 [[!table  data="""
154 <tablestyle="width:100%">  **File**  |  **Description**
155 <tablestyle="width:100%"> `Xaccess` | Client authorization ruleset.
156 `Xresources` | Default X resource values.
157 `Xservers` | List of remote and local displays to manage.
158 `Xsession` | Default session script for logins.
159 `Xsetup_`* | Script to launch applications before the login interface.
160 `xdm-config` | Global configuration for all displays running on this machine.
161 `xdm-errors` | Errors generated by the server program.
162 `xdm-pid` | The process ID of the currently running XDM. |
163
164 """]]
165
166
167  Also in this directory are a few scripts and programs used to set up the desktop when  **XDM**  is running. The purpose of each of these files will be briefly described. The exact syntax and usage of all of these files is described in [xdm(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xdm&section=1).
168
169
170
171  The default configuration is a simple rectangular login window with the hostname of the machine displayed at the top in a large font and "Login:" and "Password:" prompts below. This is a good starting point for changing the look and feel of  **XDM**  screens.
172
173
174
175 #### Xaccess 
176
177
178
179  The protocol for connecting to  **XDM**  controlled displays is called the X Display Manager Connection Protocol (XDMCP). This file is a ruleset for controlling XDMCP connections from remote machines. It is ignored unless the `xdm-config` is changed to listen for remote connections. By default, it does not allow any clients to connect.
180
181
182
183 #### Xresources 
184
185
186
187  This is an application-defaults file for the display chooser and the login screens. This is where the appearance of the login program can be modified. The format is identical to the app-defaults file described in the X11 documentation.
188
189
190
191 #### Xservers 
192
193
194
195  This is a list of the remote displays the chooser should provide as choices.
196
197
198
199 #### Xsession 
200
201
202
203  This is the default session script for  **XDM**  to run after a user has logged in. Normally each user will have a customized session script in `~/.xsession` that overrides this script.
204
205
206
207 #### Xsetup_* 
208
209
210
211  These will be run automatically before displaying the chooser or login interfaces. There is a script for each display being used, named `Xsetup_` followed by the local display number (for instance `Xsetup_0`). Typically these scripts will run one or two programs in the background such as `xconsole`.
212
213
214
215 #### xdm-config 
216
217
218
219  This contains settings in the form of app-defaults that are applicable to every display that this installation manages.
220
221
222
223 #### xdm-errors 
224
225
226
227  This contains the output of the X servers that  **XDM**  is trying to run. If a display that  **XDM**  is trying to start hangs for some reason, this is a good place to look for error messages. These messages are also written to the user's `~/.xsession-errors` file on a per-session basis.
228
229
230
231 ### Running a Network Display Server 
232
233
234
235  In order for other clients to connect to the display server, edit the access control rules, and enable the connection listener. By default these are set to conservative values. To make  **XDM**  listen for connections, first comment out a line in the `xdm-config` file:
236
237
238
239      
240
241     ! SECURITY: do not listen for XDMCP or Chooser requests
242
243     ! Comment out this line if you want to manage X terminals with xdm
244
245     DisplayManager.requestPort:     0
246
247
248
249
250
251  and then restart  **XDM** . Remember that comments in app-defaults files begin with a "!" character, not the usual "#". More strict access controls may be desired. Look at the example entries in `Xaccess`, and refer to the [xdm(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=xdm&section=1) manual page for further information.
252
253
254
255 ### Replacements for XDM 
256
257
258
259  Several replacements for the default  **XDM**  program exist. One of them,  **kdm**  (bundled with  **KDE** ) is described later in this chapter. The  **kdm**  display manager offers many visual improvements and cosmetic frills, as well as the functionality to allow users to choose their window manager of choice at login time.
260
261
262 ----
263
264
265
266 ## Desktop Environments 
267
268  ***Contributed by Valentino Vaschetto. ***
269
270  This section describes the different desktop environments available for X on FreeBSD. A ***desktop environment*** can mean anything ranging from a simple window manager to a complete suite of desktop applications, such as  **KDE**  or  **GNOME** .
271
272
273
274 ### GNOME 
275
276
277
278 #### About GNOME 
279
280
281
282    **GNOME**  is a user-friendly desktop environment that enables users to easily use and configure their computers.  **GNOME**  includes a panel (for starting applications and displaying status), a desktop (where data and applications can be placed), a set of standard desktop tools and applications, and a set of conventions that make it easy for applications to cooperate and be consistent with each other. Users of other operating systems or environments should feel right at home using the powerful graphics-driven environment that  **GNOME**  provides.
283
284
285
286 #### Installing GNOME 
287
288
289
290    **GNOME**  can be easily installed from a package or from the pkgsrc framework:
291
292
293
294   To install the  **GNOME**  package from the network, simply type:
295
296     # pkg install gnome-desktop
297
298
299
300
301   To build  **GNOME**  from source, if you have the pkgsrc tree on your system:      
302
303     # cd /usr/pkgsrc/meta-pkgs/gnome
304
305     # bmake install clean
306
307
308
309   Once  **GNOME**  is installed, the X server must be told to start  **GNOME**  instead of a default window manager.
310
311
312
313   The easiest way to start  **GNOME**  is with  **GDM** , the GNOME Display Manager.  **GDM** , which is installed as a part of the  **GNOME**  desktop (but is disabled by default), can be enabled by adding `gdm_enable="YES"` to `/etc/rc.conf`. Once you have rebooted,  **GNOME**  will start automatically once you log in -- no further configuration is necessary.
314
315
316
317 **GNOME**  may also be started from the command-line by properly configuring a file named `.xinitrc`. If a custom `.xinitrc` is already in place, simply replace the line that starts the current window manager with one that starts  **/usr/pkg/bin/gnome-session**  instead. If nothing special has been done to the configuration file, then it is enough simply to type:
318
319
320
321       
322
323     % echo "/usr/pkg/bin/gnome-session" > ~/.xinitrc
324
325
326
327
328
329   Next, type `startx`, and the  **GNOME**  desktop environment will be started.
330
331
332 **Note:** If an older display manager, like  **XDM** , is being used, this will not work. Instead, create an executable `.xsession` file with the same command in it. To do this, edit the file and replace the existing window manager command with  **/usr/pkg/bin/gnome-session** :
333
334
335
336         
337
338     % echo "#!/bin/sh" > ~/.xsession
339
340     % echo "/usr/pkg/bin/gnome-session" >> ~/.xsession
341
342     % chmod +x ~/.xsession
343
344
345
346
347
348   Yet another option is to configure the display manager to allow choosing the window manager at login time; the section on [ KDE details](x11-wm.html#X11-WM-KDE-DETAILS) explains how to do this for  **kdm** , the display manager of  **KDE** .
349
350
351
352 #### Anti-aliased Fonts with GNOME 
353
354
355
356   X11 supports anti-aliasing via its ***RENDER*** extension. GTK+ 2.0 and greater (the toolkit used by  **GNOME** ) can make use of this functionality. Configuring anti-aliasing is described in [ Section 5.5.3](x-fonts.html#ANTIALIAS).
357   
358   So, with up-to-date software, anti-aliasing is possible within the  **GNOME**  desktop. Just go to  **Applications->Desktop Preferences->Font** , and select either Best shapes, Best contrast, or Subpixel smoothing (LCDs). For a GTK+ application that is not part of the  **GNOME**  desktop, set the environment variable `GDK_USE_XFT` to `1` before launching the program.
359
360
361
362 ### KDE 
363
364
365
366 #### About KDE 
367
368
369
370   **KDE**  is an easy to use contemporary desktop environment. Some of the things that  **KDE**  brings to the user are:
371
372 * A beautiful contemporary desktop
373
374 * A desktop exhibiting complete network transparency
375
376 * An integrated help system allowing for convenient, consistent access to help on the use of the  **KDE**  desktop and its applications
377
378 * Consistent look and feel of all  **KDE**  applications
379
380 * Standardized menu and toolbars, keybindings, color-schemes, etc.
381
382 * Internationalization:  **KDE**  is available in more than 40 languages
383
384 * Centralized consisted dialog driven desktop configuration
385
386 * A great number of useful  **KDE**  applications
387
388   **KDE**  comes with a web browser called  **Konqueror** , which represents a solid competitor to other existing web browsers on UNIX® systems. More information on  **KDE**  can be found on the [KDE website](http://www.kde.org/).
389
390
391
392 #### Installing KDE 
393
394
395  Just as with  **GNOME**  or any other desktop environment, the easiest way to install  **KDE**  is through the pkgsrc framework or from a package:
396
397
398
399  To install the  **KDE**  4.10 package from the network, simply type:
400
401    # pkg install kde-4.10
402
403
404  To build  **KDE**  from source, using the pkgsrc framework:
405
406     # cd /usr/pkgsrc/meta-pkgs/kde3
407
408     # bmake install clean
409
410
411
412
413
414  After  **KDE**  has been installed, the X server must be told to launch this application instead of the default window manager. This is accomplished by editing the `.xinitrc` file:
415
416
417     % echo "exec startkde" > ~/.xinitrc
418
419
420  Now, whenever the X Window System is invoked with `startx`,  **KDE**  will be the desktop.
421
422  If a display manager such as  **XDM**  is being used, the configuration is slightly different. Edit the `.xsession` file instead. Instructions for  **kdm**  are described later in this chapter.
423
424
425
426 #### More Details on KDE 
427
428
429
430  Now that  **KDE**  is installed on the system, most things can be discovered through the help pages, or just by pointing and clicking at various menus. Windows® or Mac® users will feel quite at home.
431
432  The best reference for  **KDE**  is the on-line documentation.  **KDE**  comes with its own web browser,  **Konqueror** , dozens of useful applications, and extensive documentation. The remainder of this section discusses the technical items that are difficult to learn by random exploration.
433
434
435
436 #### The KDE Display Manager 
437
438
439
440  An administrator of a multi-user system may wish to have a graphical login screen to welcome users. [ XDM](x-xdm.html) can be used, as described earlier. However,  **KDE**  includes an alternative,  **kdm** , which is designed to look more attractive and include more login-time options. In particular, users can easily choose (via a menu) which desktop environment ( **KDE** ,  **GNOME** , or something else) to run after logging on.
441
442
443
444  To enable  **kdm** , the `ttyv8` entry in `/etc/ttys` has to be adapted. The line should look as follows:
445   
446
447     ttyv8 "/usr/pkg/bin/kdm -nodaemon" xterm on secure
448
449
450     
451 ### XFce 
452
453
454
455 #### About XFce 
456
457
458   **XFce**  is a desktop environment based on the GTK+ toolkit used by  **GNOME** , but is much more lightweight and meant for those who want a simple, efficient desktop which is nevertheless easy to use and configure. Visually, it looks very much like  **CDE** , found on commercial UNIX systems. Some of  **XFce** 's features are:
459
460 * A simple, easy-to-handle desktop
461
462 * Fully configurable via mouse, with drag and drop, etc
463
464 * Main panel similar to  **CDE** , with menus, applets and applications launchers
465
466 * Integrated window manager, file manager, sound manager,  **GNOME**  compliance module, and other things
467
468 * Themeable (since it uses GTK+)
469
470 * Fast, light and efficient: ideal for older/slower machines or machines with memory limitations
471
472
473 More information on  **XFce**  can be found on the [XFce website](http://www.xfce.org/).
474
475
476
477 #### Installing XFce 
478
479
480
481  A binary package for  **XFce**  exists. To install, simply type:
482
483     # pkg install xfce4 xfce4-session 
484
485
486  Alternatively, to build from source, use the pkgsrc framework:
487
488    
489
490     # cd /usr/pkgsrc/meta-pkgs/xfce4
491
492     # bmake install clean
493
494
495
496
497  Now, tell the X server to launch  **XFce**  the next time X is started. Simply type this:
498
499     % echo "/usr/pkg/bin/startxfce4" > ~/.xinitrc
500
501
502
503  The next time X is started,  **XFce**  will be the desktop. As before, if a display manager like  **XDM**  is being used, create an `.xsession`, as described in the section on [ GNOME](x11-wm.html#X11-WM-GNOME), but with the `/usr/pkg/bin/startxfce4` command; or, configure the display manager to allow choosing a desktop at login time, as explained in the section on [ kdm](x11-wm.html#X11-WM-KDE-KDM).
504
505
506
507 <!-- XXX: FreeBSD's handbook has a nice user-oriented section about X applications here. maybe we should have one, too -->
508
509 ----