1 4ef9ff62 2005-01-14 devnull .TH INSTALL 1
3 4ef9ff62 2005-01-14 devnull install \- notes about Plan 9 from User Space installation
4 4ef9ff62 2005-01-14 devnull .SH SYNOPSIS
6 4ef9ff62 2005-01-14 devnull cd \*9; ./INSTALL
12 4ef9ff62 2005-01-14 devnull .SH DESCRIPTION
13 4ef9ff62 2005-01-14 devnull To obtain the Plan 9 tree, use CVS
15 4ef9ff62 2005-01-14 devnull .IR cvs (1))
16 4ef9ff62 2005-01-14 devnull or download a tar file from
17 4ef9ff62 2005-01-14 devnull .HR http://swtch.com/plan9port "" .
19 af79ebc2 2005-12-30 devnull The tree can be unpacked anywhere, but the
20 af79ebc2 2005-12-30 devnull usual place is
21 af79ebc2 2005-12-30 devnull .BR /usr/local/plan9 .
22 4ef9ff62 2005-01-14 devnull In the root of the tree, run
23 4ef9ff62 2005-01-14 devnull .BR ./INSTALL .
24 af79ebc2 2005-12-30 devnull This script builds the Plan 9 build program
25 4ef9ff62 2005-01-14 devnull .IR mk (1)
26 af79ebc2 2005-12-30 devnull if necessary,
27 af79ebc2 2005-12-30 devnull cleans all previously built object files and libraries out of the tree,
28 4ef9ff62 2005-01-14 devnull rebuilds and installs everything, and then cleans up.
30 4ef9ff62 2005-01-14 devnull There are a few files in tree which have the root
31 4ef9ff62 2005-01-14 devnull hard-coded in them.
32 4ef9ff62 2005-01-14 devnull After the build,
33 4ef9ff62 2005-01-14 devnull .I INSTALL
34 4ef9ff62 2005-01-14 devnull edits these files to replace the string
35 4ef9ff62 2005-01-14 devnull .B /usr/local/plan9
36 4ef9ff62 2005-01-14 devnull with the name of the root of the current tree.
39 4ef9ff62 2005-01-14 devnull .I INSTALL
40 4ef9ff62 2005-01-14 devnull builds an HTML version of the manual and installs it in
41 4ef9ff62 2005-01-14 devnull .BR \*9/man .
43 af79ebc2 2005-12-30 devnull The installation can be thought of as two steps:
44 af79ebc2 2005-12-30 devnull build all the binaries, and then edit files as necessary
45 af79ebc2 2005-12-30 devnull to fix the references to the installation root.
46 af79ebc2 2005-12-30 devnull If necessary, these can be run separately.
47 af79ebc2 2005-12-30 devnull Given the
50 4ef9ff62 2005-01-14 devnull .I INSTALL
51 af79ebc2 2005-12-30 devnull performs only the first step.
52 af79ebc2 2005-12-30 devnull Given the
55 af79ebc2 2005-12-30 devnull .I INSTALL
56 af79ebc2 2005-12-30 devnull performs only the second step.
57 af79ebc2 2005-12-30 devnull The first step can be done with the tree in a temporary work directory,
58 af79ebc2 2005-12-30 devnull but the second step must be done once the tree is in its final location.
59 af79ebc2 2005-12-30 devnull These flags are only necessary when trying to conform to the
60 af79ebc2 2005-12-30 devnull expectations of certain package management systems.
62 af79ebc2 2005-12-30 devnull At the end of the installation,
63 7c604f0d 2005-01-23 devnull .I INSTALL
64 7c604f0d 2005-01-23 devnull prints suggested settings for the environment variables
65 7c604f0d 2005-01-23 devnull .B $PLAN9
67 7c604f0d 2005-01-23 devnull .BR $PATH .
69 7c604f0d 2005-01-23 devnull Plan 9 from User Space uses different threading implementations on Linux 2.6 and
70 3dc1ecc1 2005-01-14 devnull later kernels than on 2.4 and earlier;
71 3dc1ecc1 2005-01-14 devnull and on FreeBSD 5 and later kernels than on FreeBSD 4 and earlier.
72 b04c42e9 2005-01-17 devnull Running binaries from one class on another will not work.
74 b04c42e9 2005-01-17 devnull Some Linux 2.6 systems (e.g., Gentoo) do not use the new NPTL pthread library
75 b04c42e9 2005-01-17 devnull even though the kernel supports them. On these systems, plan9port must
76 b04c42e9 2005-01-17 devnull fall back on the threading code intended for Linux 2.4. To accomplish this,
77 b04c42e9 2005-01-17 devnull .I INSTALL
78 b04c42e9 2005-01-17 devnull checks whether the running system uses NPTL and sets
79 b04c42e9 2005-01-17 devnull .B SYSVERSION
81 b04c42e9 2005-01-17 devnull .B \*9/config
82 b04c42e9 2005-01-17 devnull accordingly.
84 d93fca6a 2005-02-11 devnull .B \*9/LOCAL.config
85 d93fca6a 2005-02-11 devnull is appended to
86 d93fca6a 2005-02-11 devnull .B config
87 d93fca6a 2005-02-11 devnull after this auto-detection and can be used to override the choices.
89 d93fca6a 2005-02-11 devnull .B LOCAL.config
90 d93fca6a 2005-02-11 devnull contains a line
91 16c1defa 2005-11-12 devnull .B WSYSTYPE=nowsys
92 d93fca6a 2005-02-11 devnull then the system is built without using X11.
94 af79ebc2 2005-12-30 devnull .I INSTALL
95 af79ebc2 2005-12-30 devnull can safely be repeated to rebuild the system from scratch.
97 17e1150a 2005-11-26 devnull Once the system is built for the first time,
98 17e1150a 2005-11-26 devnull it can be maintained and rebuilt using
99 17e1150a 2005-11-26 devnull .IR mk (1).
100 af79ebc2 2005-12-30 devnull To rebuild individual commands or libraries,
103 af79ebc2 2005-12-30 devnull .B install
106 af79ebc2 2005-12-30 devnull .B clean
107 af79ebc2 2005-12-30 devnull in the appropriate source directory
109 af79ebc2 2005-12-30 devnull .IR src (1)).
110 4ef9ff62 2005-01-14 devnull .SH FILES
112 4ef9ff62 2005-01-14 devnull .B \*9/lib/moveplan9.files
113 4ef9ff62 2005-01-14 devnull the list of files that need to have
114 4ef9ff62 2005-01-14 devnull .B /usr/local/plan9
115 4ef9ff62 2005-01-14 devnull edited out of them
117 4ef9ff62 2005-01-14 devnull .B \*9/lib/moveplan9.sh
118 4ef9ff62 2005-01-14 devnull the script that edits the files
120 4ef9ff62 2005-01-14 devnull .B \*9/src/mkmk.sh
121 4ef9ff62 2005-01-14 devnull the shell script used to build
122 4ef9ff62 2005-01-14 devnull .IR mk (1)
124 4ef9ff62 2005-01-14 devnull .B \*9/dist/manweb
125 4ef9ff62 2005-01-14 devnull the shell script that builds the HTML manual
127 4ef9ff62 2005-01-14 devnull .B \*9/man/index.html
128 4ef9ff62 2005-01-14 devnull the top-level page in the HTML version of the manual
130 7c604f0d 2005-01-23 devnull .B \*9/install.log
131 7c604f0d 2005-01-23 devnull logged output from the last run of
132 7c604f0d 2005-01-23 devnull .I INSTALL
134 af79ebc2 2005-12-30 devnull .B \*9/install.isum
135 af79ebc2 2005-12-30 devnull a summary of
136 af79ebc2 2005-12-30 devnull .B install.log
137 4ef9ff62 2005-01-14 devnull .SH SEE ALSO
138 4ef9ff62 2005-01-14 devnull .IR intro (1),
139 4ef9ff62 2005-01-14 devnull .IR cvs (1)
