← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/programs/Xserver/hw/xfree86/doc/Install

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/programs/Xserver/hw/xfree86/doc/Install
 
1
                 Installation Details for XFree86[tm] 4.3.0
 
2
 
 
3
                          The XFree86 Project, Inc
 
4
 
 
5
                              24 February 2003
 
6
 
 
7
                                  Abstract
 
8
 
 
9
     How to install XFree86.
 
10
 
 
11
1.  Introduction
 
12
 
 
13
This document contains information about installing the XFree86 binaries as
 
14
provided by The XFree86 Project.
 
15
 
 
16
The XFree86 binaries that we provide for UNIX-like OS's (Linux, the BSDs,
 
17
Solaris, etc) are packaged in a platform-independent gzipped tar format (aka
 
18
"tarballs" identified by the .tgz suffix).  Along with the binaries we pro-
 
19
vide a customized version of the GNU tar utility called "extract" and an
 
20
installation script.  We recommend that these be used to install the bina-
 
21
ries.  (The source for this customized version of GNU tar can be found in the
 
22
XFree86 CVS repository's "utils" module, and from our ftp site
 
23
<URL:ftp://ftp.xfree86.org/pub/XFree86/misc/utils-1.1.0.tgz>.)
 
24
 
 
25
2.  Downloading the XFree86 4.3.0 binaries
 
26
 
 
27
We provide XFree86 4.3.0 binaries for a range of operating systems at our ftp
 
28
site <URL:ftp://ftp.xfree86.org/pub/XFree86/4.3.0/binaries/> and our web site
 
29
<URL:http://ftp.xfree86.org/pub/XFree86/4.3.0/binaries/>.  Often during
 
30
releases our site is heavily loaded.  Instead of downloading directly from us
 
31
we recommend that instead you use one of our mirror sites.
 
32
 
 
33
Our binaries are organized by sub-directories which correspond to each of the
 
34
OS/platforms for which we provide binaries.  First go to the sub-directory
 
35
that represents your OS platform. In some cases (e.g., Linux) there may be a
 
36
number of choices depending on the architecture or libc version your platform
 
37
uses.  In all case we recommend that you first download the Xinstall.sh
 
38
script, and run it as in the following example to find out which binary dis-
 
39
tribution you should download.
 
40
 
 
41
     sh Xinstall.sh -check
 
42
 
 
43
The output of this utility tells you which is the correct set of binaries for
 
44
you to download.  If you are careful with this step you will save yourself a
 
45
lot time and trouble from NOT downloading an incompatible distribution.
 
46
 
 
47
NOTES:
 
48
 
 
49
   o The Xinstall.sh script must be downloaded in binary mode, otherwise it
 
50
     won't run correctly.  If you get lots of "command not found" messages
 
51
     when you try to run it, then it is most likely because the script wasn't
 
52
     downloaded in binary mode.  Some web browsers won't do this for files of
 
53
     that name, so we also have a copy of it called "Xinstall.bin", and most
 
54
     browsers should download that correctly.  When downloading it under this
 
55
     name, select "save as" on your browser, and save the file under the name
 
56
     "Xinstall.sh".
 
57
 
 
58
   o The Xinstall.sh script requires some system commands and utilities to
 
59
     function correctly.  While most systems will have these, some Linux
 
60
     installations may not.  If you find that the script is failing because
 
61
     of some missing system command, you will need to install it before you
 
62
     can continue.  If you don't know how to do this, then we recommend that
 
63
     you obtain this version of XFree86 from your Operating System distribu-
 
64
     tor.
 
65
 
 
66
   o Always use the version of the Xinstall.sh script that's provided with
 
67
     the release you're installing.  Older versions of the script may not
 
68
     install newer releases correctly.
 
69
 
 
70
   o If the binary distribution reported by the Xinstall.sh script isn't pre-
 
71
     sent on our site, then there are two possibilities.  The first is that
 
72
     it hasn't been prepared and uploaded yet.  This is likely if you are
 
73
     looking soon after the release date.  The second possibility is that we
 
74
     won't have it available at all for this release.  This is likely if it's
 
75
     still not there about two weeks after the release date.  Check here
 
76
     <URL:http://www.xfree86.org/4.3.0/UPDATES.html> for information about
 
77
     updates to our binary distributions, and here
 
78
     <URL:http://www.xfree86.org/4.3.0/ERRATA.html> for errata related to
 
79
     this release.
 
80
 
 
81
Once you're run the Xinstall.sh script and found which binary distribution is
 
82
suitable for your system, download the necessary files.  The twelve (12)
 
83
mandatory files for all installations are listed below.  If you have not
 
84
downloaded all of the files, the installer script will complain.
 
85
 
 
86
          1.   Xinstall.sh    The installer script
 
87
          2.   extract        The utility for extracting tarballs
 
88
          3.   Xbin.tgz       X clients/utilities and run-time libraries
 
89
          4.   Xlib.tgz       Some data files required at run-time
 
90
          5.   Xman.tgz       Manual pages
 
91
          6.   Xdoc.tgz       XFree86 documentation
 
92
          7.   Xfnts.tgz      Base set of fonts
 
93
          8.   Xfenc.tgz      Base set of font encoding data
 
94
          9.   Xetc.tgz       Run-time configuration files
 
95
          10.  Xvar.tgz       Run-time data
 
96
          11.  Xxserv.tgz     XFree86 X server
 
97
          12.  Xmod.tgz       XFree86 X server modules
 
98
 
 
99
NOTES:
 
100
 
 
101
   o Some web browsers have a problem downloading the extract utility cor-
 
102
     rectly.  If you encounter this problem, download the version called
 
103
     extract.exe instead.  This should fix the problem.  (This is not a
 
104
     DOS/Windows executable.)
 
105
 
 
106
   o A few distributions don't have or require the Xvar.tgz tarball.  If it
 
107
     is present in the binaries sub-directory for your platform, then it is
 
108
     required.
 
109
 
 
110
   o The Darwin/Mac OS X distribution doesn't have or require the Xmod.tgz
 
111
     tarball.
 
112
 
 
113
   o Some distributions may have additional mandatory tarballs.  While rare,
 
114
     the installer script will tell you if any are missing.
 
115
 
 
116
The following eleven (11) tarballs are optional.  You should download the
 
117
ones you want to install.
 
118
 
 
119
          1.   Xfsrv.tgz      Font server
 
120
          2.   Xnest.tgz      Nested X server
 
121
          3.   Xprog.tgz      X header files, config files and compile-time libs
 
122
          4.   Xprt.tgz       X Print server
 
123
          5.   Xvfb.tgz       Virtual framebuffer X server
 
124
          6.   Xf100.tgz      100dpi fonts
 
125
          7.   Xfcyr.tgz      Cyrillic fonts
 
126
          8.   Xfscl.tgz      Scalable fonts (Speedo, Type1 and TrueType)
 
127
          9.   Xhtml.tgz      HTML version of the documentation
 
128
          10.  Xps.tgz        PostScript version of the documentation
 
129
          11.  Xjdoc.tgz      Documentation in Japanese
 
130
 
 
131
NOTES:
 
132
 
 
133
   o Some distributions may have some additional optional tarballs.
 
134
 
 
135
If you miss some and want to install them later, go to the Manual Installa-
 
136
tion (section 4., page 1) section.
 
137
 
 
138
3.  Installing XFree86 4.3.0 using the Xinstall.sh script
 
139
 
 
140
We strongly recommend that our XFree86 4.3.0 binaries be installed using the
 
141
Xinstall.sh script that we provide.  There are a lot of steps in the manual
 
142
installation process, and those steps can vary according to the platform and
 
143
hardware setup.  There is a description of the manual installation process
 
144
for the most common cases below (section 4., page 1).
 
145
 
 
146
You must login as the super user (root) to run the installer script.  Place
 
147
all of the downloaded files into a single directory (choose a temporary loca-
 
148
tion with enough space).  Use the cd command to change to that directory and
 
149
then run the installer script as follows:
 
150
 
 
151
     sh Xinstall.sh
 
152
 
 
153
Answer the prompts as they come up.  If you are missing something that is
 
154
required, the installer may tell you to install it before trying again.  If
 
155
the problem is that you did not download all of mandatory files aforemen-
 
156
tioned, then the installer will tell you which ones are missing and ask you
 
157
to download them before proceeding.
 
158
 
 
159
3.1  Questions the installer may ask
 
160
 
 
161
The installer asks some questions that may not have obvious answers.  The
 
162
information here should help you answer them.  In most cases, apart from the
 
163
first question, the default answers should be OK.
 
164
 
 
165
If you run the installer from within an X session (the installer checks if
 
166
$DISPLAY is set), you will be warned that doing so is not a good idea.
 
167
Unless you have a good reason for knowing that this won't be a problem, you
 
168
should exit your X session, including stopping xdm or equivalent if it is
 
169
running, before continuing.  If you ignore this warning and run into prob-
 
170
lems, well, you were warned!
 
171
 
 
172
If you have an existing X installation, you will be warned that proceeding
 
173
with this installation will overwrite it.  Only those things that are part of
 
174
our standard distribution will be overwritten.  Other X applications that you
 
175
may have installed will not be removed.  Some configuration files may be
 
176
overwritten though, but the installer should prompt you before doing so.  As
 
177
the opening greeting says, it is strongly recommended that you backup any
 
178
existing installation before proceeding.  If you want your old applications
 
179
to still be there after you've installed, don't do the "backup" by simply
 
180
renaming your old /usr/X11R6 directory.  It is better to make a copy of it,
 
181
and then install over the top of the original one.  If you run into problems
 
182
and want to revert to the old installation, you can then delete the overwrit-
 
183
ten one and copy the saved version back.
 
184
 
 
185
During the first part of the installation over an existing version, the
 
186
script may remove some old files or directories that would get in the way of
 
187
the new installation.  It will list which files/directories have been
 
188
removed.  If none are listed, then none were removed.
 
189
 
 
190
The next step when installing over an existing version is to check for exist-
 
191
ing configuration files.  As of XFree86 version 3.9.18, the run-time configu-
 
192
ration files are installed by default under /etc/X11 instead of under
 
193
/usr/X11R6/lib/X11.  The installer will move the existing ones for you and
 
194
create the necessary symbolic links.  If you don't want to have these config-
 
195
uration files under /etc/X11, then you should answer "no" when asked about
 
196
it.  Answering "no" here also means that the new configuration files will be
 
197
installed in the old /usr/X11R6/lib/X11 location.
 
198
 
 
199
Note: for the rare systems that don't have symbolic links, this question will
 
200
not be asked.  The default answer is "yes" because that is best for most sit-
 
201
uations.  It is our new default.  It makes it easier to share the /usr/X11R6
 
202
directory between multiple hosts, and allows it to be mounted read-only.  If
 
203
you don't need these features, then you can safely answer "no" if you don't
 
204
want them moved.
 
205
 
 
206
When installing over an existing version, you will be prompted before each
 
207
set of configuration files is installed.  If you haven't made any Customisa-
 
208
tions to your existing configuration files, then you can safely answer "yes"
 
209
for each of these.  If you have made customisations, you can try answering
 
210
"no".  If you run into problems later, you may need to manually merge your
 
211
customisations into the the new version of the configuration files.  The con-
 
212
figuration files can all be found in the Xetc.tgz tarball.  See the section
 
213
below (section 4., page 1) about manual installation for information about
 
214
extracting them separately.
 
215
 
 
216
After the configuration files have been dealt with, the other mandatory com-
 
217
ponents of the binary distribution will be installed.  This should proceed
 
218
without any user intervention.
 
219
 
 
220
If you downloaded any of the optional components, the installer will ask you
 
221
about each one before it is installed.  The default answer is "yes".  If
 
222
there are any that you've since decided that you don't want to install,
 
223
answer "no" when prompted.
 
224
 
 
225
After that is done, the main part of the installation is complete.  The next
 
226
steps are to tidy up some aspects of the installation.  The first of these is
 
227
to run "ldconfig" on systems that require it, so that the newly installed
 
228
shared libraries are accessible.  Then the fonts.dir files in some directo-
 
229
ries are updated so that the fonts can be accessed correctly.  Next, the
 
230
installer checks to see if your system has a termcap file or terminfo files.
 
231
If it finds the former, it tells you how you may update the entries in that
 
232
file.  If it finds the latter, it asks you if you want it to update them for
 
233
you.
 
234
 
 
235
You may be asked if you want to create links for the GL libraries and header
 
236
files.  The OpenGL standard on some platforms (Linux in particular) says that
 
237
these should be installed in the standard system locations (/usr/lib and
 
238
/usr/include), so the installer offers to create the appropriate links.  If
 
239
you're running Linux, you should probably answer yes.  For other platforms it
 
240
is your choice.  If you already have another version of libGL in /usr/lib,
 
241
answering "yes" will remove it and replace it with a link to the version we
 
242
supply.  The installer will show you a listing of any existing versions
 
243
before asking if they should be replaced.
 
244
 
 
245
Finally, the installer asks you if you want a link created for the rstart
 
246
utility.  On most modern systems the link isn't essential, so the default
 
247
answer is "no".  Answer "yes" if you know that you need it.  If you find
 
248
later that you need it, you can create it easily by running:
 
249
 
 
250
     rm -f /usr/bin/rstartd
 
251
     ln -s /usr/X11R6/bin/rstartd /usr/bin/rstartd
 
252
 
 
253
3.2  After the installation is complete
 
254
 
 
255
The next step is to configure the X server.  That is covered in detail in an
 
256
as-yet unwritten document :-(.  In the meantime, there are three ways to cre-
 
257
ate a basic X server configuration file for XFree86 4.3.0.  One is to run the
 
258
xf86config utility.  Another is to run the xf86cfg utility.  The third option
 
259
is to use the new -configure X server option:
 
260
 
 
261
     XFree86 -configure
 
262
 
 
263
Note that if you are running Darwin/Mac OS X, there is no step 3 :-).  You
 
264
should skip this step, as configuration is not required or possible.  The X
 
265
server configuration file is not used on Darwin/Mac OS X.
 
266
 
 
267
The X server config file (XF86Config) format has changed compared to 3.3.x.
 
268
Also, its default location is now /etc/X11.  Finally, there is now only one X
 
269
server for driving video hardware, and it is called "XFree86".  Once you're
 
270
satisfied with the operation of the new X server, you can safely remove the
 
271
old XF86_* and/or XF98_* X server binaries from /usr/X11R6/bin.
 
272
 
 
273
After the X server configuration is done, it may be advisable to reboot,
 
274
especially if you run xdm (or equivalent) or the font server (xfs).
 
275
 
 
276
4.  Installing XFree86 4.3.0 manually
 
277
 
 
278
This section contains information about manually installing the XFree86 4.3.0
 
279
binary distributions.  You should only use this method if you know what
 
280
you're doing.  The information here covers some common cases, but not every
 
281
possible case.  It also may not be complete or up to date.  Use at your own
 
282
risk.
 
283
 
 
284
Put all of the downloaded files into a single directory (choose some tempo-
 
285
rary location with enough space).  Become the super user (root).  All of the
 
286
following commands should be run as root, and they should be run from the
 
287
directory that has all of the downloaded files.  The "extract" utility should
 
288
be used to unpack the tarballs.  This is a customised version of GNU tar that
 
289
has the gzip code built-in, and which has a different usage when run under
 
290
the name "extract".  One important thing that extract does that most versions
 
291
of tar do not do by default is that it unlinks existing files before writing
 
292
new ones.  This is important when installing over an existing version of X.
 
293
If you choose to use some other utility to extract the tarballs, you're on
 
294
your own.
 
295
 
 
296
4.1  A new installation
 
297
 
 
298
The simplest case is when there is no existing X installation.  The installa-
 
299
tion procedure for this case is as follows:
 
300
 
 
301
     chmod +x extract
 
302
     mkdir /usr/X11R6
 
303
     mkdir /etc/X11
 
304
     ./extract -C /usr/X11R6 X[a-df-uw-z]*.tgz
 
305
     ./extract -C /usr/X11R6 Xvfb.tgz    # If you are installing Xvfb
 
306
     ./extract -C /etc/X11 Xetc.tgz
 
307
     ./extract -C /var Xvar.tgz
 
308
     ln -s /etc/X11/app-defaults /usr/X11R6/lib/X11
 
309
     ln -s /etc/X11/fs /usr/X11R6/lib/X11
 
310
     ln -s /etc/X11/lbxproxy /usr/X11R6/lib/X11
 
311
     ln -s /etc/X11/proxymngr /usr/X11R6/lib/X11
 
312
     ln -s /etc/X11/rstart /usr/X11R6/lib/X11
 
313
     ln -s /etc/X11/twm /usr/X11R6/lib/X11
 
314
     ln -s /etc/X11/xdm /usr/X11R6/lib/X11
 
315
     ln -s /etc/X11/xinit /usr/X11R6/lib/X11
 
316
     ln -s /etc/X11/xsm /usr/X11R6/lib/X11
 
317
     ln -s /etc/X11/xserver /usr/X11R6/lib/X11
 
318
     chmod ug-w /usr/X11R6/lib           # Make sure the permissions are OK
 
319
     /sbin/ldconfig /usr/X11R6/lib       # For Linux
 
320
     /sbin/ldconfig -m /usr/X11R6/lib    # For FreeBSD, NetBSD, OpenBSD
 
321
     /usr/X11R6/bin/mkfontdir /usr/X11R6/lib/X11/fonts/misc
 
322
 
 
323
4.2  Installing over an old installation
 
324
 
 
325
If you have an existing installation of X, you should make a backup copy of
 
326
it before installing the new version over the top of it.
 
327
 
 
328
Before doing anything else, make sure the extract command is executable, and
 
329
also link it to the name "gnu-tar" so that it can be used as a regular tar
 
330
command:
 
331
 
 
332
     chmod +x extract
 
333
     rm -f gnu-tar
 
334
     ln extract gnu-tar
 
335
 
 
336
The first part of the procedure is to move the old run-time config files from
 
337
/usr/X11R6/lib/X11 to /etc/X11.  Create /etc/X11 if it doesn't already exist.
 
338
For each of the following sub-directories (app-defaults, fs, lbxproxy, prox-
 
339
ymngr, rstart, twm, xdm, xinit, xsm, xserver) that you want to move, check
 
340
that there is a sub-directory of this name in /usr/X11R6/lib/X11.  Create a
 
341
sub-directory of the same name under /etc/X11, then copy the files over by
 
342
running:
 
343
 
 
344
     ./gnu-tar -C /usr/X11R6/lib/X11/subdir -c -f - . | \
 
345
       ./gnu-tar -C /etc/X11/subdir -v -x -p -U -f -
 
346
 
 
347
For each subdirectory that is moved, remove the one under /usr/X11R6/lib/X11
 
348
and create a symbolic link to the new location:
 
349
 
 
350
     rm -fr /usr/X11R6/lib/X11/subdir
 
351
     ln -s /etc/X11/subdir /usr/X11R6/lib/X11
 
352
 
 
353
For those subdirectories that didn't already exist under /usr/X11R6/lib/X11,
 
354
create one under /etc/X11 and create the symbolic link to it:
 
355
 
 
356
     mkdir /etc/X11/subdir
 
357
     ln -s /etc/X11/subdir /usr/X11R6/lib/X11
 
358
 
 
359
Once that is done, extract the config files from the Xetc.tgz tarball into a
 
360
temporary directory:
 
361
 
 
362
     mkdir tmpdir
 
363
     ./extract -C tmpdir Xetc.tgz
 
364
 
 
365
and then copy each sub-directory over to the installed location:
 
366
 
 
367
     ./gnu-tar -C tmpdir/subdir -c -f - . | \
 
368
       ./gnu-tar -C /usr/X11R6/lib/X11/subdir -v -x -p -U -f -
 
369
 
 
370
If you have customised any config files in your old installation, you may
 
371
want to omit those sub-directories, or copy selected files over by hand.
 
372
 
 
373
Once that's done, the main part of the installation can be done:
 
374
 
 
375
     ./extract -C /usr/X11R6 `pwd`/X[a-df-uw-z]*.tgz
 
376
     ./extract -C /usr/X11R6 Xvfb.tgz    # If you are installing Xvfb
 
377
     ./extract -C /var Xvar.tgz
 
378
     chmod ug-w /usr/X11R6/lib           # Make sure the permissions are OK
 
379
     /sbin/ldconfig /usr/X11R6/lib       # For Linux
 
380
     /sbin/ldconfig -m /usr/X11R6/lib    # For FreeBSD, NetBSD, OpenBSD
 
381
     /usr/X11R6/bin/mkfontdir /usr/X11R6/lib/X11/fonts/misc
 
382
 
 
383
     Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/Install.sgml,v 1.17 2003/02/24 17:09:16 dawes Exp $
 
384
 
 
385
 
 
386
$XFree86: xc/programs/Xserver/hw/xfree86/doc/Install,v 1.21 2003/02/25 05:29:10 dawes Exp $