Add to git.
[monolith.git] / README
1 Monolith (C) Copyright 2000-2002 Richard W.M. Jones <rich@annexia.org>
2
3 Monolith is distributed under the terms of the GNU Library GPL. See
4 the accompanying file COPYING.LIB for details.
5
6 Please see doc/index.html for full documentation and a tutorial.
7
8 Installing Monolith
9 -------------------
10
11 You first need to install the following components, in the order
12 listed below:
13
14 0. cdoc    from http://www.annexia.org/freeware/c2lib/ (optional)
15 1. c2lib   from http://www.annexia.org/freeware/c2lib/
16 2. pthrlib from http://www.annexia.org/freeware/pthrlib/
17 3. rws     from http://www.annexia.org/freeware/rws/
18
19 Make sure you have the latest versions of these packages. Older
20 versions may not work correctly.
21
22 Build it:
23
24         ./configure --sysconfdir=/etc
25         make+
26         make+ test
27
28 Install it (as root):
29
30         make+ install
31
32 You will now need to configure rws. The configuration files for rws
33 are normally located in the /etc/rws/ directory.
34
35 For the /etc/rws/rws.conf file, just use the example one supplied with
36 rws. You can modify it if you want, but I didn't.
37
38 Now create a /etc/rws/hosts/localhost file which should contain:
39
40         alias /
41                 # Path to the document root. NOTE you will
42                 # definitely want to change this!
43                 path:           /var/www
44                 show:           1
45                 list:           1
46         end alias
47
48         alias /so-bin/
49                 path:           /usr/local/share/rws/so-bin
50                 exec so:        1
51         end alias
52
53         alias /ml-styles/
54                 path:           /usr/local/share/rws/ml-styles
55                 show:           1
56         end alias
57
58         alias /ml-icons/
59                 path:           /usr/local/share/rws/ml-icons
60                 show:           1
61         end alias
62
63 These are the default locations for the files if you installed
64 Monolith with --prefix=/usr/local, but you may need to change these if
65 you installed with another prefix.
66
67 Create symbolic links as necessary to your localhost file:
68
69         cd /etc/rws/hosts
70         ln -s localhost:8080 localhost
71         ln -s www.example.com localhost
72
73 etc.
74
75 Now, start up rws (as root, of course):
76
77         /usr/local/sbin/rwsd -C /etc/rws -p 8080
78
79 Fire up a browser and point it at
80
81         http://localhost:8080/so-bin/01_label_and_button.so
82
83 Errors will be displayed in the error log (/tmp/error_log,
84 /var/log/httpd/error_log or /var/log/rws/error_log).
85
86 If the button doesn't appear as a white square surrounded by a black
87 rectangle, then the stylesheet is not being found. Make sure you set
88 up the /ml-styles/ alias correctly.
89
90 Monolith installs other example programs. Look in the examples/
91 directory for a full list.