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
15 4ef9ff62 2005-01-14 devnull .SH DESCRIPTION
16 08e79372 2014-11-17 rsc To obtain the Plan 9 tree, use Git
19 4ef9ff62 2005-01-14 devnull or download a tar file from
20 a3993885 2017-09-01 rsc .HR https://9fans.github.io/plan9port "" .
22 af79ebc2 2005-12-30 devnull The tree can be unpacked anywhere, but the
23 af79ebc2 2005-12-30 devnull usual place is
24 af79ebc2 2005-12-30 devnull .BR /usr/local/plan9 .
25 4ef9ff62 2005-01-14 devnull In the root of the tree, run
26 4ef9ff62 2005-01-14 devnull .BR ./INSTALL .
27 af79ebc2 2005-12-30 devnull This script builds the Plan 9 build program
28 4ef9ff62 2005-01-14 devnull .IR mk (1)
29 af79ebc2 2005-12-30 devnull if necessary,
30 af79ebc2 2005-12-30 devnull cleans all previously built object files and libraries out of the tree,
31 4ef9ff62 2005-01-14 devnull rebuilds and installs everything, and then cleans up.
33 4ef9ff62 2005-01-14 devnull There are a few files in tree which have the root
34 4ef9ff62 2005-01-14 devnull hard-coded in them.
35 4ef9ff62 2005-01-14 devnull After the build,
36 4ef9ff62 2005-01-14 devnull .I INSTALL
37 4ef9ff62 2005-01-14 devnull edits these files to replace the string
38 4ef9ff62 2005-01-14 devnull .B /usr/local/plan9
39 4ef9ff62 2005-01-14 devnull with the name of the root of the current tree.
42 4ef9ff62 2005-01-14 devnull .I INSTALL
43 4ef9ff62 2005-01-14 devnull builds an HTML version of the manual and installs it in
44 4ef9ff62 2005-01-14 devnull .BR \*9/man .
46 af79ebc2 2005-12-30 devnull The installation can be thought of as two steps:
47 af79ebc2 2005-12-30 devnull build all the binaries, and then edit files as necessary
48 af79ebc2 2005-12-30 devnull to fix the references to the installation root.
49 af79ebc2 2005-12-30 devnull If necessary, these can be run separately.
50 af79ebc2 2005-12-30 devnull Given the
53 4ef9ff62 2005-01-14 devnull .I INSTALL
54 af79ebc2 2005-12-30 devnull performs only the first step.
55 af79ebc2 2005-12-30 devnull Given the
58 af79ebc2 2005-12-30 devnull .I INSTALL
59 af79ebc2 2005-12-30 devnull performs only the second step.
60 af79ebc2 2005-12-30 devnull The first step can be done with the tree in a temporary work directory,
61 af79ebc2 2005-12-30 devnull but the second step must be done once the tree is in its final location.
62 89ec3cde 2011-06-02 rsc If you want to build the project in one location and then install into
63 89ec3cde 2011-06-02 rsc another location, use
66 89ec3cde 2011-06-02 rsc to specify the
68 89ec3cde 2011-06-02 rsc location of Plan9 tree.
69 af79ebc2 2005-12-30 devnull These flags are only necessary when trying to conform to the
70 af79ebc2 2005-12-30 devnull expectations of certain package management systems.
72 af79ebc2 2005-12-30 devnull At the end of the installation,
73 7c604f0d 2005-01-23 devnull .I INSTALL
74 7c604f0d 2005-01-23 devnull prints suggested settings for the environment variables
75 7c604f0d 2005-01-23 devnull .B $PLAN9
77 7c604f0d 2005-01-23 devnull .BR $PATH .
79 7c604f0d 2005-01-23 devnull Plan 9 from User Space uses different threading implementations on Linux 2.6 and
80 3dc1ecc1 2005-01-14 devnull later kernels than on 2.4 and earlier;
81 3dc1ecc1 2005-01-14 devnull and on FreeBSD 5 and later kernels than on FreeBSD 4 and earlier.
82 b04c42e9 2005-01-17 devnull Running binaries from one class on another will not work.
84 b04c42e9 2005-01-17 devnull Some Linux 2.6 systems (e.g., Gentoo) do not use the new NPTL pthread library
85 b04c42e9 2005-01-17 devnull even though the kernel supports them. On these systems, plan9port must
86 b04c42e9 2005-01-17 devnull fall back on the threading code intended for Linux 2.4. To accomplish this,
87 b04c42e9 2005-01-17 devnull .I INSTALL
88 b04c42e9 2005-01-17 devnull checks whether the running system uses NPTL and sets
89 b04c42e9 2005-01-17 devnull .B SYSVERSION
91 b04c42e9 2005-01-17 devnull .B \*9/config
92 b04c42e9 2005-01-17 devnull accordingly.
94 d93fca6a 2005-02-11 devnull .B \*9/LOCAL.config
95 d93fca6a 2005-02-11 devnull is appended to
96 d93fca6a 2005-02-11 devnull .B config
97 d93fca6a 2005-02-11 devnull after this auto-detection and can be used to override the choices.
99 d93fca6a 2005-02-11 devnull .B LOCAL.config
100 d93fca6a 2005-02-11 devnull contains a line
101 16c1defa 2005-11-12 devnull .B WSYSTYPE=nowsys
102 d93fca6a 2005-02-11 devnull then the system is built without using X11.
104 8c24e687 2009-04-30 rsc On most Linux systems, the X11 header packages need to be installed
105 8c24e687 2009-04-30 rsc to build using X11. On Debian. the required packages are
106 8c24e687 2009-04-30 rsc libx11-dev, libxext-dev, and libxt-dev.
107 8c24e687 2009-04-30 rsc On Ubuntu, it suffices to install xorg-dev.
109 af79ebc2 2005-12-30 devnull .I INSTALL
110 af79ebc2 2005-12-30 devnull can safely be repeated to rebuild the system from scratch.
112 17e1150a 2005-11-26 devnull Once the system is built for the first time,
113 17e1150a 2005-11-26 devnull it can be maintained and rebuilt using
114 17e1150a 2005-11-26 devnull .IR mk (1).
115 af79ebc2 2005-12-30 devnull To rebuild individual commands or libraries,
118 af79ebc2 2005-12-30 devnull .B install
121 af79ebc2 2005-12-30 devnull .B clean
122 af79ebc2 2005-12-30 devnull in the appropriate source directory
124 af79ebc2 2005-12-30 devnull .IR src (1)).
125 4ef9ff62 2005-01-14 devnull .SH FILES
127 4ef9ff62 2005-01-14 devnull .B \*9/lib/moveplan9.files
128 4ef9ff62 2005-01-14 devnull the list of files that need to have
129 4ef9ff62 2005-01-14 devnull .B /usr/local/plan9
130 4ef9ff62 2005-01-14 devnull edited out of them
132 4ef9ff62 2005-01-14 devnull .B \*9/lib/moveplan9.sh
133 4ef9ff62 2005-01-14 devnull the script that edits the files
135 4ef9ff62 2005-01-14 devnull .B \*9/src/mkmk.sh
136 4ef9ff62 2005-01-14 devnull the shell script used to build
137 4ef9ff62 2005-01-14 devnull .IR mk (1)
139 4ef9ff62 2005-01-14 devnull .B \*9/dist/manweb
140 4ef9ff62 2005-01-14 devnull the shell script that builds the HTML manual
142 4ef9ff62 2005-01-14 devnull .B \*9/man/index.html
143 4ef9ff62 2005-01-14 devnull the top-level page in the HTML version of the manual
145 7c604f0d 2005-01-23 devnull .B \*9/install.log
146 7c604f0d 2005-01-23 devnull logged output from the last run of
147 7c604f0d 2005-01-23 devnull .I INSTALL
149 1415e197 2009-04-30 rsc .B \*9/install.sum
150 af79ebc2 2005-12-30 devnull a summary of
151 af79ebc2 2005-12-30 devnull .B install.log
152 4ef9ff62 2005-01-14 devnull .SH SEE ALSO
153 4ef9ff62 2005-01-14 devnull .IR intro (1),
