Blame


1 f305dffb 2003-10-13 devnull This is a port of some Plan 9 libraries and programs to Unix.
2 f305dffb 2003-10-13 devnull
3 f305dffb 2003-10-13 devnull Some parts expect that the tree is installed in /usr/local/plan9.
4 f305dffb 2003-10-13 devnull Most are position independent. The few hard-coded references
5 f305dffb 2003-10-13 devnull (there's one in sam) should really be fixed.
6 f305dffb 2003-10-13 devnull
7 f305dffb 2003-10-13 devnull * Obtaining the source
8 f305dffb 2003-10-13 devnull
9 771ff2bc 2003-10-13 devnull Tarballs will be posted nightly (but only when there are updates!) at
10 f305dffb 2003-10-13 devnull
11 f305dffb 2003-10-13 devnull http://pdos.lcs.mit.edu/~rsc/software/plan9
12 f305dffb 2003-10-13 devnull
13 f305dffb 2003-10-13 devnull /usr/local/plan9 is the suggested location to keep the software.
14 f305dffb 2003-10-13 devnull All the paths in the tarball begin with plan9/, so it's okay to unpack it
15 f305dffb 2003-10-13 devnull directly in /usr/local.
16 f305dffb 2003-10-13 devnull
17 f305dffb 2003-10-13 devnull You can use CVS to obtain the very latest version and stay up-to-date.
18 f305dffb 2003-10-13 devnull See below.
19 f305dffb 2003-10-13 devnull
20 f305dffb 2003-10-13 devnull * Building
21 f305dffb 2003-10-13 devnull
22 21a17ff3 2003-11-25 devnull To build, cd into src and run make; mk install. This will place binaries
23 21a17ff3 2003-11-25 devnull in "bin". At time of writing, the commands are sam, samterm, rc, and mk.
24 f305dffb 2003-10-13 devnull There are a few shell scripts already included in bin -- B, Bwait,
25 f305dffb 2003-10-13 devnull and samsave.
26 f305dffb 2003-10-13 devnull
27 21a17ff3 2003-11-25 devnull The "make" builds mk. Mk builds the rest.
28 f305dffb 2003-10-13 devnull
29 f305dffb 2003-10-13 devnull * Helping out
30 f305dffb 2003-10-13 devnull
31 f305dffb 2003-10-13 devnull If you'd like to help out, great!
32 f305dffb 2003-10-13 devnull
33 f305dffb 2003-10-13 devnull The TODO file contains our (somewhat long) to do list.
34 f305dffb 2003-10-13 devnull
35 f305dffb 2003-10-13 devnull If you port this code to other architectures, please share your changes
36 f305dffb 2003-10-13 devnull so others can benefit. See PORTING for some notes.
37 f305dffb 2003-10-13 devnull
38 f305dffb 2003-10-13 devnull Please use diff -u or CVS (see below) to prepare patches.
39 f305dffb 2003-10-13 devnull
40 f305dffb 2003-10-13 devnull * CVS
41 f305dffb 2003-10-13 devnull
42 f305dffb 2003-10-13 devnull You can use CVS to keep your local copy up-to-date as we make
43 f305dffb 2003-10-13 devnull changes and fix bugs. The idioms explained here are pretty much
44 f305dffb 2003-10-13 devnull all you need to know about CVS.
45 f305dffb 2003-10-13 devnull
46 f305dffb 2003-10-13 devnull To check out from the anonymous CVS repository, use
47 f305dffb 2003-10-13 devnull
48 f305dffb 2003-10-13 devnull cd /usr/local
49 f305dffb 2003-10-13 devnull >$HOME/.cvspass
50 f305dffb 2003-10-13 devnull cvs -d :pserver:anoncvs@cvs.pdos.lcs.mit.edu:/cvs login
51 f305dffb 2003-10-13 devnull cvs -d :pserver:anoncvs@cvs.pdos.lcs.mit.edu:/cvs checkout plan9
52 f305dffb 2003-10-13 devnull
53 f305dffb 2003-10-13 devnull When prompted for a password, just hit enter.
54 f305dffb 2003-10-13 devnull
55 f305dffb 2003-10-13 devnull From then on, when you want to update, you can do
56 f305dffb 2003-10-13 devnull
57 f305dffb 2003-10-13 devnull cd /usr/local/plan9
58 f305dffb 2003-10-13 devnull cvs update -dAP
59 f305dffb 2003-10-13 devnull
60 f305dffb 2003-10-13 devnull If there are conflicts between changes you have made locally
61 f305dffb 2003-10-13 devnull and changes on the server, cvs will warn about them and leave
62 f305dffb 2003-10-13 devnull them clearly marked in the updated files.
63 f305dffb 2003-10-13 devnull
64 f305dffb 2003-10-13 devnull If you change something and want to submit the change (please do!),
65 f305dffb 2003-10-13 devnull you can run
66 f305dffb 2003-10-13 devnull
67 f305dffb 2003-10-13 devnull cd /usr/local/plan9
68 f305dffb 2003-10-13 devnull cvs diff -u
69 f305dffb 2003-10-13 devnull
70 f305dffb 2003-10-13 devnull to generate the diff in a format that will be easy to apply.
71 f305dffb 2003-10-13 devnull (You can also use this to see what you've changed.)
72 f305dffb 2003-10-13 devnull
73 f305dffb 2003-10-13 devnull Running the cvs commands in /usr/local/plan9 makes them
74 f305dffb 2003-10-13 devnull apply to the whole tree. Running them in a subdirectory applies
75 f305dffb 2003-10-13 devnull only to the code rooted there in the code.
76 f305dffb 2003-10-13 devnull
77 f305dffb 2003-10-13 devnull There's not much magical about /usr/local/plan9. If you
78 f305dffb 2003-10-13 devnull check out the tree in some other directory, it should work
79 f305dffb 2003-10-13 devnull just as well.
80 f305dffb 2003-10-13 devnull
81 f305dffb 2003-10-13 devnull Thanks.
82 f305dffb 2003-10-13 devnull
83 f305dffb 2003-10-13 devnull Russ Cox <rsc@swtch.com>