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
7 4ef9ff62 2005-01-14 devnull .SH DESCRIPTION
8 4ef9ff62 2005-01-14 devnull To obtain the Plan 9 tree, use CVS
10 4ef9ff62 2005-01-14 devnull .IR cvs (1))
11 4ef9ff62 2005-01-14 devnull or download a tar file from
12 4ef9ff62 2005-01-14 devnull .HR http://swtch.com/plan9port "" .
14 4ef9ff62 2005-01-14 devnull In the root of the tree, run
15 4ef9ff62 2005-01-14 devnull .BR ./INSTALL .
16 4ef9ff62 2005-01-14 devnull This script first uses
17 4ef9ff62 2005-01-14 devnull .IR make (1)
18 4ef9ff62 2005-01-14 devnull to build the Plan 9 build program
19 4ef9ff62 2005-01-14 devnull .IR mk (1)
20 4ef9ff62 2005-01-14 devnull if necessary.
21 4ef9ff62 2005-01-14 devnull It cleans all previously built object files and libraries out of the tree,
22 4ef9ff62 2005-01-14 devnull rebuilds and installs everything, and then cleans up.
24 4ef9ff62 2005-01-14 devnull There are a few files in tree which have the root
25 4ef9ff62 2005-01-14 devnull hard-coded in them.
26 4ef9ff62 2005-01-14 devnull After the build,
27 4ef9ff62 2005-01-14 devnull .I INSTALL
28 4ef9ff62 2005-01-14 devnull edits these files to replace the string
29 4ef9ff62 2005-01-14 devnull .B /usr/local/plan9
30 4ef9ff62 2005-01-14 devnull with the name of the root of the current tree.
33 4ef9ff62 2005-01-14 devnull .I INSTALL
34 4ef9ff62 2005-01-14 devnull builds an HTML version of the manual and installs it in
35 4ef9ff62 2005-01-14 devnull .BR \*9/man .
37 4ef9ff62 2005-01-14 devnull .I INSTALL
38 4ef9ff62 2005-01-14 devnull can safely be repeated to rebuild the system from scratch.
40 7c604f0d 2005-01-23 devnull At the end of the build,
41 7c604f0d 2005-01-23 devnull .I INSTALL
42 7c604f0d 2005-01-23 devnull prints suggested settings for the environment variables
43 7c604f0d 2005-01-23 devnull .B $PLAN9
45 7c604f0d 2005-01-23 devnull .BR $PATH .
46 7c604f0d 2005-01-23 devnull After setting those, the script
47 7c604f0d 2005-01-23 devnull .B $PLAN9/dist/isum
48 7c604f0d 2005-01-23 devnull will print a short summary of the installation output,
49 7c604f0d 2005-01-23 devnull omitting the usual command chatter but preserving
50 7c604f0d 2005-01-23 devnull compiler warnings and errors.
52 7c604f0d 2005-01-23 devnull Plan 9 from User Space uses different threading implementations on Linux 2.6 and
53 3dc1ecc1 2005-01-14 devnull later kernels than on 2.4 and earlier;
54 3dc1ecc1 2005-01-14 devnull and on FreeBSD 5 and later kernels than on FreeBSD 4 and earlier.
55 b04c42e9 2005-01-17 devnull Running binaries from one class on another will not work.
57 b04c42e9 2005-01-17 devnull Some Linux 2.6 systems (e.g., Gentoo) do not use the new NPTL pthread library
58 b04c42e9 2005-01-17 devnull even though the kernel supports them. On these systems, plan9port must
59 b04c42e9 2005-01-17 devnull fall back on the threading code intended for Linux 2.4. To accomplish this,
60 b04c42e9 2005-01-17 devnull .I INSTALL
61 b04c42e9 2005-01-17 devnull checks whether the running system uses NPTL and sets
62 b04c42e9 2005-01-17 devnull .B SYSVERSION
64 b04c42e9 2005-01-17 devnull .B \*9/config
65 b04c42e9 2005-01-17 devnull accordingly.
67 d93fca6a 2005-02-11 devnull .B \*9/LOCAL.config
68 d93fca6a 2005-02-11 devnull is appended to
69 d93fca6a 2005-02-11 devnull .B config
70 d93fca6a 2005-02-11 devnull after this auto-detection and can be used to override the choices.
72 d93fca6a 2005-02-11 devnull .B LOCAL.config
73 d93fca6a 2005-02-11 devnull contains a line
74 d93fca6a 2005-02-11 devnull .B WSYS=nowsys
75 d93fca6a 2005-02-11 devnull then the system is built without using X11.
76 4ef9ff62 2005-01-14 devnull .SH FILES
78 4ef9ff62 2005-01-14 devnull .B \*9/lib/moveplan9.files
79 4ef9ff62 2005-01-14 devnull the list of files that need to have
80 4ef9ff62 2005-01-14 devnull .B /usr/local/plan9
81 4ef9ff62 2005-01-14 devnull edited out of them
83 4ef9ff62 2005-01-14 devnull .B \*9/lib/moveplan9.sh
84 4ef9ff62 2005-01-14 devnull the script that edits the files
86 4ef9ff62 2005-01-14 devnull .B \*9/src/mkmk.sh
87 4ef9ff62 2005-01-14 devnull the shell script used to build
88 4ef9ff62 2005-01-14 devnull .IR mk (1)
90 4ef9ff62 2005-01-14 devnull .B \*9/dist/manweb
91 4ef9ff62 2005-01-14 devnull the shell script that builds the HTML manual
93 4ef9ff62 2005-01-14 devnull .B \*9/man/index.html
94 4ef9ff62 2005-01-14 devnull the top-level page in the HTML version of the manual
96 7c604f0d 2005-01-23 devnull .B \*9/install.log
97 7c604f0d 2005-01-23 devnull logged output from the last run of
98 7c604f0d 2005-01-23 devnull .I INSTALL
99 4ef9ff62 2005-01-14 devnull .SH SEE ALSO
100 4ef9ff62 2005-01-14 devnull .IR intro (1),
101 4ef9ff62 2005-01-14 devnull .IR cvs (1)