Add CVS information
[infodrom/cgilib] / readme
1 Using this Library
2 ------------------
3
4 To use this library you need to include the cgi.h include file with
5 the following expression into your C programs:
6
7    #include <cgi.h>
8
9 Additionally you'll have to add the library libcgi.a to the linker,
10 either by modifying LDFLAGS in your Makefile or by adding `-lcgi' to
11 the appropriate commandline.
12
13
14 Test Suite
15 ----------
16
17 This library comes with a test suite both to demonstrate its features
18 and to help you understand how it works.  The respective program is
19 called cgitest.c.  You can use it as reference implementation for this
20 CGI library.  It can also be used to debug the library by increasing
21 its debug level.  Therefore it should be included as source in your
22 distribution.
23
24 If you want to test your forms you can use the following action.
25
26    <form action="/cgi-bin/cgitest/listall" method="post">
27
28 The /listall target will display all environment variables, all CGI
29 variables, all HTTP Cookies and refer to all files that were
30 transmitted.  This way you can test your own implementations quite
31 easy.
32
33
34 Further Documentation
35 ---------------------
36
37 This section will refer to a number of URLs that document how this
38 library and used protocols work
39
40   The CGI Library
41
42     http://www.infodrom.org/projects/cgilib/
43
44   HTTP Return Codes
45
46     http://www.w3.org/Protocols/HTTP/HTRESP.html
47
48   HTTP Headers
49
50     http://www.w3.org/Protocols/HTTP/Object_Headers.html
51
52
53 Development
54 -----------
55
56 Development of this library takes place in a public CVS repository.
57 This offers a way to do versioning and provide a history for all files
58 and changes.  At any time it is possible to restore an older version,
59 partially or in total.  Additionally, lean patches can be applied and
60 reverted.
61
62 Log in:
63
64 cvs -d :pserver:anonymous@cvs.infodrom.org:/var/cvs/infodrom login
65
66 [Hit return]
67
68 Check out CVS HEAD:
69
70 cvs -d :pserver:anonymous@cvs.infodrom.org:/var/cvs/infodrom co cgilib
71
72
73 Mailing Lists
74 -------------
75
76 A mailing list dedicated to discussions about this library has been
77 created.  It is meant as a forum for users and developers of the
78 lightweight CGI library and applications that make use of it.
79
80 The lists address is <infodrom-cgilib@lists.infodrom.org>. 
81
82 To subscribe to this list,
83
84  . send a mail to infodrom-cgilib-request@@lists.infodrom.org with the
85    word "subscribe" as subject, or
86
87  . send a mail to majordomo@@lists.infodrom.org with the body of
88    "subscribe infodrom-cgilib".
89
90 The list is publicly archived at
91 <http://lists.infodrom.org/infodrom-cgilib/>.
92
93 A second mailing list exists as infodrom-cgilib-cvs on the same host.
94 Only CVS messages and differences are distributed there.  Whenever new
95 code is added to the CGI library, »cvs« generates a mail from these
96 changes which will be sent to this particular list.  Discussions
97 continue to take place on the first list.
98
99
100 Feedback
101 --------
102
103 If you have additions, questions or improvements please don't hesitate
104 to contact either the mailing list or me personally.
105
106 Infodrom Oldenburg
107 Martin Schulze
108 joey@infodrom.org