~ubuntu-branches/debian/stretch/alpine/stretch

« back to all changes in this revision

Viewing changes to web/src/cgi.tcl-1.10/INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Asheesh Laroia
  • Date: 2007-02-17 13:17:42 UTC
  • Revision ID: james.westby@ubuntu.com-20070217131742-99x5c6cpg1pbkdhw
Tags: upstream-0.82+dfsg
ImportĀ upstreamĀ versionĀ 0.82+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
This file is INSTALL.  It contains installation instructions for cgi.tcl.
 
2
 
 
3
If you do not have Tcl, get it (the README explains how) and install
 
4
it.  The rest of these instructions assume that you have Tcl
 
5
installed.
 
6
 
 
7
--------------------
 
8
Installation
 
9
--------------------
 
10
 
 
11
By default, the Tcl source directory is assumed to be in the same
 
12
directory as the cgi.tcl source directory.  For example, in this
 
13
listing, cgi.tcl and Tcl are both stored in /usr/local/src:
 
14
 
 
15
        /usr/local/src/tcl7.5           (actual version may be different)
 
16
        /usr/local/src/cgi.tcl-1.0      (actual version may be different)
 
17
 
 
18
If Tcl is stored elsewhere, the easiest way to deal with this is to
 
19
create a symbolic link to its real directory.  For example, from the
 
20
cgi.tcl directory, type:
 
21
 
 
22
        ln -s /some/where/else/src/tcl7.5 ..
 
23
 
 
24
Run "./configure".  This will generate a Makefile (from a prototype
 
25
called "Makefile.in") appropriate to your system.  Make sure you run
 
26
configure with the same arguments as when you ran Tcl's configure
 
27
script.  (If you don't, package loading won't work.)
 
28
 
 
29
Most people will not need to make any changes to the generated
 
30
Makefile and can go on to the next step.  If you want though, you can
 
31
edit the Makefile and change any definitions as appropriate for your
 
32
site.  All the definitions you are likely to want to change are
 
33
clearly identified and described at the beginning of the file.
 
34
 
 
35
Run "make".
 
36
 
 
37
It is useful (although not necessary) for cgi.tcl to understand how to
 
38
send mail.  By default, cgi.tcl tries to use /usr/lib/sendmail,
 
39
otherwise it falls back to carrying out the raw SMTP dialogue itself.
 
40
Any mailer can be substituted by modifying cgi.tcl appropriately.  It
 
41
is easy to do.  Edit cgi.tcl and look at the cgi_mail_end procedure.
 
42
It should be obvious what to do at that point.  The ability to send
 
43
mail isn't required for basic use of cgi.tcl, but it is especially
 
44
useful for in-the-field debugging so I encourage you to enable it.
 
45
 
 
46
You can now "source cgi.tcl" if you want to try things out by hand
 
47
before installing (or if you want to use the package without
 
48
installing it).  Example:
 
49
 
 
50
        $ tclsh7.6 (or whatever your Tcl interpreter is called)
 
51
        % source cgi.tcl
 
52
        % h4 "Don Libes"
 
53
        <h4>Don Libes</h4>
 
54
        %
 
55
 
 
56
Once you're done playing, go ahead and install it.  To install everything:
 
57
 
 
58
        make install
 
59
 
 
60
You're done!  Now you can use cgi.tcl.
 
61
 
 
62
--------------------
 
63
Examples
 
64
--------------------
 
65
 
 
66
The example directory has some examples.  See the README in there.
 
67
 
 
68
--------------------
 
69
Test Suite
 
70
--------------------
 
71
 
 
72
There is no test suite.
 
73
 
 
74
--------------------
 
75
Uninstalling
 
76
--------------------
 
77
 
 
78
"make uninstall" removes all the files that "make install" creates
 
79
(excluding those in the current directory).
 
80
 
 
81
--------------------
 
82
Cleaning Up
 
83
--------------------
 
84
 
 
85
Several "clean" targets are available to reduce space consumption of
 
86
the cgi.tcl source.  The two most useful are as follows:
 
87
 
 
88
"make clean" deletes all files from the current directory that were
 
89
created by "make"
 
90
 
 
91
"make distclean" is like "make clean", but it also deletes files
 
92
created by "configure"
 
93
 
 
94
Other targets can be found in the Makefile.  They follow the GNU
 
95
Makefile conventions.
 
96