2 bdbc55d3 2005-11-28 devnull INSTALL(1) INSTALL(1)
5 bdbc55d3 2005-11-28 devnull install - notes about Plan 9 from User Space installation
8 2e8a63f0 2005-12-30 devnull cd /usr/local/plan9; ./INSTALL [ -b | -c ]
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.
14 2e8a63f0 2005-12-30 devnull The tree can be unpacked anywhere, but the usual place is
15 2e8a63f0 2005-12-30 devnull /usr/local/plan9. In the root of the tree, run ./INSTALL.
16 2e8a63f0 2005-12-30 devnull This script builds the Plan 9 build program mk(1) if neces-
17 2e8a63f0 2005-12-30 devnull sary, cleans all previously built object files and libraries
18 2e8a63f0 2005-12-30 devnull out of the tree, rebuilds and installs everything, and then
19 2e8a63f0 2005-12-30 devnull cleans up.
21 bdbc55d3 2005-11-28 devnull There are a few files in tree which have the root hard-coded
22 bdbc55d3 2005-11-28 devnull in them. After the build, INSTALL edits these files to
23 bdbc55d3 2005-11-28 devnull replace the string /usr/local/plan9 with the name of the
24 bdbc55d3 2005-11-28 devnull root of the current tree.
26 bdbc55d3 2005-11-28 devnull Finally, INSTALL builds an HTML version of the manual and
27 bdbc55d3 2005-11-28 devnull installs it in /usr/local/plan9/man.
29 2e8a63f0 2005-12-30 devnull The installation can be thought of as two steps: build all
30 2e8a63f0 2005-12-30 devnull the binaries, and then edit files as necessary to fix the
31 2e8a63f0 2005-12-30 devnull references to the installation root. If necessary, these
32 2e8a63f0 2005-12-30 devnull can be run separately. Given the -b flag, INSTALL performs
33 2e8a63f0 2005-12-30 devnull only the first step. Given the -c flag, INSTALL performs
34 2e8a63f0 2005-12-30 devnull only the second step. The first step can be done with the
35 2e8a63f0 2005-12-30 devnull tree in a temporary work directory, but the second step must
36 2e8a63f0 2005-12-30 devnull be done once the tree is in its final location. These flags
37 2e8a63f0 2005-12-30 devnull are only necessary when trying to conform to the expecta-
38 2e8a63f0 2005-12-30 devnull tions of certain package management systems.
40 2e8a63f0 2005-12-30 devnull At the end of the installation, INSTALL prints suggested
41 2e8a63f0 2005-12-30 devnull settings for the environment variables $PLAN9 and $PATH.
43 bdbc55d3 2005-11-28 devnull Plan 9 from User Space uses different threading implementa-
44 bdbc55d3 2005-11-28 devnull tions on Linux 2.6 and later kernels than on 2.4 and ear-
45 bdbc55d3 2005-11-28 devnull lier; and on FreeBSD 5 and later kernels than on FreeBSD 4
46 bdbc55d3 2005-11-28 devnull and earlier. Running binaries from one class on another
47 bdbc55d3 2005-11-28 devnull will not work.
49 bdbc55d3 2005-11-28 devnull Some Linux 2.6 systems (e.g., Gentoo) do not use the new
50 bdbc55d3 2005-11-28 devnull NPTL pthread library even though the kernel supports them.
51 bdbc55d3 2005-11-28 devnull On these systems, plan9port must fall back on the threading
52 bdbc55d3 2005-11-28 devnull code intended for Linux 2.4. To accomplish this, INSTALL
53 bdbc55d3 2005-11-28 devnull checks whether the running system uses NPTL and sets
55 2e8a63f0 2005-12-30 devnull Page 1 Plan 9 (printed 12/30/05)
57 2e8a63f0 2005-12-30 devnull INSTALL(1) INSTALL(1)
59 bdbc55d3 2005-11-28 devnull SYSVERSION in /usr/local/plan9/config accordingly. The file
60 bdbc55d3 2005-11-28 devnull /usr/local/plan9/LOCAL.config is appended to config after
61 bdbc55d3 2005-11-28 devnull this auto-detection and can be used to override the choices.
62 bdbc55d3 2005-11-28 devnull If LOCAL.config contains a line WSYSTYPE=nowsys then the
63 bdbc55d3 2005-11-28 devnull system is built without using X11.
65 2e8a63f0 2005-12-30 devnull INSTALL can safely be repeated to rebuild the system from
68 bdbc55d3 2005-11-28 devnull Once the system is built for the first time, it can be main-
69 2e8a63f0 2005-12-30 devnull tained and rebuilt using mk(1). To rebuild individual com-
70 2e8a63f0 2005-12-30 devnull mands or libraries, run mk install and mk clean in the
71 2e8a63f0 2005-12-30 devnull appropriate source directory (see src(1)).
74 bdbc55d3 2005-11-28 devnull /usr/local/plan9/lib/moveplan9.files
75 bdbc55d3 2005-11-28 devnull the list of files that need to have /usr/local/plan9
76 bdbc55d3 2005-11-28 devnull edited out of them
78 bdbc55d3 2005-11-28 devnull /usr/local/plan9/lib/moveplan9.sh
79 bdbc55d3 2005-11-28 devnull the script that edits the files
81 bdbc55d3 2005-11-28 devnull /usr/local/plan9/src/mkmk.sh
82 bdbc55d3 2005-11-28 devnull the shell script used to build mk(1)
84 bdbc55d3 2005-11-28 devnull /usr/local/plan9/dist/manweb
85 bdbc55d3 2005-11-28 devnull the shell script that builds the HTML manual
87 bdbc55d3 2005-11-28 devnull /usr/local/plan9/man/index.html
88 bdbc55d3 2005-11-28 devnull the top-level page in the HTML version of the manual
90 bdbc55d3 2005-11-28 devnull /usr/local/plan9/install.log
91 bdbc55d3 2005-11-28 devnull logged output from the last run of INSTALL
93 2e8a63f0 2005-12-30 devnull /usr/local/plan9/install.isum
94 2e8a63f0 2005-12-30 devnull a summary of install.log
97 bdbc55d3 2005-11-28 devnull intro(1), cvs(1)
99 2e8a63f0 2005-12-30 devnull Page 2 Plan 9 (printed 12/30/05)
