Blame


1 bdbc55d3 2005-11-28 devnull
2 bdbc55d3 2005-11-28 devnull INSTALL(1) INSTALL(1)
3 bdbc55d3 2005-11-28 devnull
4 bdbc55d3 2005-11-28 devnull NAME
5 bdbc55d3 2005-11-28 devnull install - notes about Plan 9 from User Space installation
6 bdbc55d3 2005-11-28 devnull
7 bdbc55d3 2005-11-28 devnull SYNOPSIS
8 bdbc55d3 2005-11-28 devnull cd /usr/local/plan9; ./INSTALL
9 bdbc55d3 2005-11-28 devnull
10 bdbc55d3 2005-11-28 devnull DESCRIPTION
11 bdbc55d3 2005-11-28 devnull To obtain the Plan 9 tree, use CVS (see cvs(1)) or download
12 bdbc55d3 2005-11-28 devnull a tar file from http://swtch.com/plan9port.
13 bdbc55d3 2005-11-28 devnull
14 bdbc55d3 2005-11-28 devnull In the root of the tree, run ./INSTALL. This script first
15 bdbc55d3 2005-11-28 devnull uses make(1) to build the Plan 9 build program mk(1) if nec-
16 bdbc55d3 2005-11-28 devnull essary. It cleans all previously built object files and
17 bdbc55d3 2005-11-28 devnull libraries out of the tree, rebuilds and installs everything,
18 bdbc55d3 2005-11-28 devnull and then cleans up.
19 bdbc55d3 2005-11-28 devnull
20 bdbc55d3 2005-11-28 devnull There are a few files in tree which have the root hard-coded
21 bdbc55d3 2005-11-28 devnull in them. After the build, INSTALL edits these files to
22 bdbc55d3 2005-11-28 devnull replace the string /usr/local/plan9 with the name of the
23 bdbc55d3 2005-11-28 devnull root of the current tree.
24 bdbc55d3 2005-11-28 devnull
25 bdbc55d3 2005-11-28 devnull Finally, INSTALL builds an HTML version of the manual and
26 bdbc55d3 2005-11-28 devnull installs it in /usr/local/plan9/man.
27 bdbc55d3 2005-11-28 devnull
28 bdbc55d3 2005-11-28 devnull INSTALL can safely be repeated to rebuild the system from
29 bdbc55d3 2005-11-28 devnull scratch.
30 bdbc55d3 2005-11-28 devnull
31 bdbc55d3 2005-11-28 devnull At the end of the build, INSTALL prints suggested settings
32 bdbc55d3 2005-11-28 devnull for the environment variables $PLAN9 and $PATH. After set-
33 bdbc55d3 2005-11-28 devnull ting those, the script $PLAN9/dist/isum will print a short
34 bdbc55d3 2005-11-28 devnull summary of the installation output, omitting the usual com-
35 bdbc55d3 2005-11-28 devnull mand chatter but preserving compiler warnings and errors.
36 bdbc55d3 2005-11-28 devnull
37 bdbc55d3 2005-11-28 devnull Plan 9 from User Space uses different threading implementa-
38 bdbc55d3 2005-11-28 devnull tions on Linux 2.6 and later kernels than on 2.4 and ear-
39 bdbc55d3 2005-11-28 devnull lier; and on FreeBSD 5 and later kernels than on FreeBSD 4
40 bdbc55d3 2005-11-28 devnull and earlier. Running binaries from one class on another
41 bdbc55d3 2005-11-28 devnull will not work.
42 bdbc55d3 2005-11-28 devnull
43 bdbc55d3 2005-11-28 devnull Some Linux 2.6 systems (e.g., Gentoo) do not use the new
44 bdbc55d3 2005-11-28 devnull NPTL pthread library even though the kernel supports them.
45 bdbc55d3 2005-11-28 devnull On these systems, plan9port must fall back on the threading
46 bdbc55d3 2005-11-28 devnull code intended for Linux 2.4. To accomplish this, INSTALL
47 bdbc55d3 2005-11-28 devnull checks whether the running system uses NPTL and sets
48 bdbc55d3 2005-11-28 devnull SYSVERSION in /usr/local/plan9/config accordingly. The file
49 bdbc55d3 2005-11-28 devnull /usr/local/plan9/LOCAL.config is appended to config after
50 bdbc55d3 2005-11-28 devnull this auto-detection and can be used to override the choices.
51 bdbc55d3 2005-11-28 devnull If LOCAL.config contains a line WSYSTYPE=nowsys then the
52 bdbc55d3 2005-11-28 devnull system is built without using X11.
53 bdbc55d3 2005-11-28 devnull
54 bdbc55d3 2005-11-28 devnull Page 1 Plan 9 (printed 11/28/05)
55 bdbc55d3 2005-11-28 devnull
56 bdbc55d3 2005-11-28 devnull INSTALL(1) INSTALL(1)
57 bdbc55d3 2005-11-28 devnull
58 bdbc55d3 2005-11-28 devnull Once the system is built for the first time, it can be main-
59 bdbc55d3 2005-11-28 devnull tained and rebuilt using mk(1).
60 bdbc55d3 2005-11-28 devnull
61 bdbc55d3 2005-11-28 devnull FILES
62 bdbc55d3 2005-11-28 devnull /usr/local/plan9/lib/moveplan9.files
63 bdbc55d3 2005-11-28 devnull the list of files that need to have /usr/local/plan9
64 bdbc55d3 2005-11-28 devnull edited out of them
65 bdbc55d3 2005-11-28 devnull
66 bdbc55d3 2005-11-28 devnull /usr/local/plan9/lib/moveplan9.sh
67 bdbc55d3 2005-11-28 devnull the script that edits the files
68 bdbc55d3 2005-11-28 devnull
69 bdbc55d3 2005-11-28 devnull /usr/local/plan9/src/mkmk.sh
70 bdbc55d3 2005-11-28 devnull the shell script used to build mk(1)
71 bdbc55d3 2005-11-28 devnull
72 bdbc55d3 2005-11-28 devnull /usr/local/plan9/dist/manweb
73 bdbc55d3 2005-11-28 devnull the shell script that builds the HTML manual
74 bdbc55d3 2005-11-28 devnull
75 bdbc55d3 2005-11-28 devnull /usr/local/plan9/man/index.html
76 bdbc55d3 2005-11-28 devnull the top-level page in the HTML version of the manual
77 bdbc55d3 2005-11-28 devnull
78 bdbc55d3 2005-11-28 devnull /usr/local/plan9/install.log
79 bdbc55d3 2005-11-28 devnull logged output from the last run of INSTALL
80 bdbc55d3 2005-11-28 devnull
81 bdbc55d3 2005-11-28 devnull SEE ALSO
82 bdbc55d3 2005-11-28 devnull intro(1), cvs(1)
83 bdbc55d3 2005-11-28 devnull
84 bdbc55d3 2005-11-28 devnull Page 2 Plan 9 (printed 11/28/05)
85 bdbc55d3 2005-11-28 devnull