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