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