Blame


1 bdbc55d3 2005-11-28 devnull
2 93a25a0f 2021-04-09 rsc INSTALL(1) INSTALL(1)
3 bdbc55d3 2005-11-28 devnull
4 bdbc55d3 2005-11-28 devnull NAME
5 93a25a0f 2021-04-09 rsc install - notes about Plan 9 from User Space installation
6 bdbc55d3 2005-11-28 devnull
7 93a25a0f 2021-04-09 rsc SYNOPSIS
8 93a25a0f 2021-04-09 rsc cd /usr/local/plan9; ./INSTALL [ -b | -c ] [ -r path ]
9 93a25a0f 2021-04-09 rsc
10 bdbc55d3 2005-11-28 devnull DESCRIPTION
11 93a25a0f 2021-04-09 rsc To obtain the Plan 9 tree, use Git (see git(1)) or download
12 93a25a0f 2021-04-09 rsc a tar file from https://9fans.github.io/plan9port.
13 bdbc55d3 2005-11-28 devnull
14 93a25a0f 2021-04-09 rsc The tree can be unpacked anywhere, but the usual place is
15 93a25a0f 2021-04-09 rsc /usr/local/plan9. In the root of the tree, run ./INSTALL.
16 93a25a0f 2021-04-09 rsc This script builds the Plan 9 build program mk(1) if neces-
17 93a25a0f 2021-04-09 rsc sary, cleans all previously built object files and libraries
18 93a25a0f 2021-04-09 rsc out of the tree, rebuilds and installs everything, and then
19 93a25a0f 2021-04-09 rsc cleans up.
20 bdbc55d3 2005-11-28 devnull
21 93a25a0f 2021-04-09 rsc There are a few files in tree which have the root hard-coded
22 93a25a0f 2021-04-09 rsc in them. After the build, INSTALL edits these files to
23 93a25a0f 2021-04-09 rsc replace the string /usr/local/plan9 with the name of the
24 93a25a0f 2021-04-09 rsc root of the current tree.
25 bdbc55d3 2005-11-28 devnull
26 93a25a0f 2021-04-09 rsc Finally, INSTALL builds an HTML version of the manual and
27 93a25a0f 2021-04-09 rsc installs it in /usr/local/plan9/man.
28 bdbc55d3 2005-11-28 devnull
29 93a25a0f 2021-04-09 rsc The installation can be thought of as two steps: build all
30 93a25a0f 2021-04-09 rsc the binaries, and then edit files as necessary to fix the
31 93a25a0f 2021-04-09 rsc references to the installation root. If necessary, these
32 93a25a0f 2021-04-09 rsc can be run separately. Given the -b flag, INSTALL performs
33 93a25a0f 2021-04-09 rsc only the first step. Given the -c flag, INSTALL performs
34 93a25a0f 2021-04-09 rsc only the second step. The first step can be done with the
35 93a25a0f 2021-04-09 rsc tree in a temporary work directory, but the second step must
36 93a25a0f 2021-04-09 rsc be done once the tree is in its final location. If you want
37 93a25a0f 2021-04-09 rsc to build the project in one location and then install into
38 93a25a0f 2021-04-09 rsc another location, use -r path to specify the final location
39 93a25a0f 2021-04-09 rsc of Plan9 tree. These flags are only necessary when trying
40 93a25a0f 2021-04-09 rsc to conform to the expectations of certain package management
41 93a25a0f 2021-04-09 rsc systems.
42 bdbc55d3 2005-11-28 devnull
43 93a25a0f 2021-04-09 rsc At the end of the installation, INSTALL prints suggested
44 93a25a0f 2021-04-09 rsc settings for the environment variables $PLAN9 and $PATH.
45 bdbc55d3 2005-11-28 devnull
46 93a25a0f 2021-04-09 rsc INSTALL writes various autodetected settings to
47 93a25a0f 2021-04-09 rsc /usr/local/plan9/config. The file
48 93a25a0f 2021-04-09 rsc /usr/local/plan9/LOCAL.config is appended to config after
49 93a25a0f 2021-04-09 rsc this auto-detection and can be used to override the choices.
50 93a25a0f 2021-04-09 rsc If LOCAL.config contains a line WSYSTYPE=nowsys then the
51 93a25a0f 2021-04-09 rsc system is built without using X11. LOCAL.config may also
52 93a25a0f 2021-04-09 rsc list settings for CC9 (the host C compiler) and CC9FLAGS
53 93a25a0f 2021-04-09 rsc (any additional flags to pass to the compiler). Values more
54 bdbc55d3 2005-11-28 devnull
55 93a25a0f 2021-04-09 rsc Page 1 Plan 9 (printed 4/9/21)
56 bdbc55d3 2005-11-28 devnull
57 93a25a0f 2021-04-09 rsc INSTALL(1) INSTALL(1)
58 8c24e687 2009-04-30 rsc
59 93a25a0f 2021-04-09 rsc complex than single words should be quoted with single
60 93a25a0f 2021-04-09 rsc quotes.
61 bdbc55d3 2005-11-28 devnull
62 93a25a0f 2021-04-09 rsc On most Linux systems, the X11 header packages need to be
63 93a25a0f 2021-04-09 rsc installed to build using X11. On Debian. the required pack-
64 93a25a0f 2021-04-09 rsc ages are libfontconfig1-dev, libx11-dev, libxext-dev, and
65 93a25a0f 2021-04-09 rsc libxt-dev. On Ubuntu, it suffices to install xorg-dev.
66 bdbc55d3 2005-11-28 devnull
67 93a25a0f 2021-04-09 rsc INSTALL can safely be repeated to rebuild the system from
68 93a25a0f 2021-04-09 rsc scratch.
69 bdbc55d3 2005-11-28 devnull
70 93a25a0f 2021-04-09 rsc Once the system is built for the first time, it can be main-
71 93a25a0f 2021-04-09 rsc tained and rebuilt using mk(1). To rebuild individual com-
72 93a25a0f 2021-04-09 rsc mands or libraries, run mk install and mk clean in the
73 93a25a0f 2021-04-09 rsc appropriate source directory (see src(1)).
74 bdbc55d3 2005-11-28 devnull
75 93a25a0f 2021-04-09 rsc FILES
76 93a25a0f 2021-04-09 rsc /usr/local/plan9/lib/moveplan9.files
77 93a25a0f 2021-04-09 rsc the list of files that need to have /usr/local/plan9
78 93a25a0f 2021-04-09 rsc edited out of them
79 bdbc55d3 2005-11-28 devnull
80 93a25a0f 2021-04-09 rsc /usr/local/plan9/lib/moveplan9.sh
81 93a25a0f 2021-04-09 rsc the script that edits the files
82 bdbc55d3 2005-11-28 devnull
83 93a25a0f 2021-04-09 rsc /usr/local/plan9/src/mkmk.sh
84 93a25a0f 2021-04-09 rsc the shell script used to build mk(1)
85 bdbc55d3 2005-11-28 devnull
86 93a25a0f 2021-04-09 rsc /usr/local/plan9/dist/manweb
87 93a25a0f 2021-04-09 rsc the shell script that builds the HTML manual
88 bdbc55d3 2005-11-28 devnull
89 93a25a0f 2021-04-09 rsc /usr/local/plan9/man/index.html
90 93a25a0f 2021-04-09 rsc the top-level page in the HTML version of the manual
91 2e8a63f0 2005-12-30 devnull
92 93a25a0f 2021-04-09 rsc /usr/local/plan9/install.log
93 93a25a0f 2021-04-09 rsc logged output from the last run of INSTALL
94 709ba3c4 2014-12-02 rsc
95 93a25a0f 2021-04-09 rsc /usr/local/plan9/install.sum
96 93a25a0f 2021-04-09 rsc a summary of install.log
97 709ba3c4 2014-12-02 rsc
98 bdbc55d3 2005-11-28 devnull SEE ALSO
99 93a25a0f 2021-04-09 rsc intro(1), git(1)
100 bdbc55d3 2005-11-28 devnull
101 93a25a0f 2021-04-09 rsc Page 2 Plan 9 (printed 4/9/21)
102 709ba3c4 2014-12-02 rsc