Add to git.
[rws.git] / rwsd.1
1 .TH rwsd 1 "October 22, 2002" "GNU" "Programmer's Manual"
2
3 .SH NAME
4 rwsd \- a small, fast web server
5
6 .SH SYNOPSIS
7 .B rwsd
8 [\fI\-p port\fR] [\fI\-C configpath\fR]
9 [\fI\-d\fR] [\fI\-f\fR] [\fI\-a address\fR]
10
11 .SH DESCRIPTION
12 \fBrwsd\fR is a small, fast web server, written in C, but with a
13 very comprehensible and straightforward design. It uses a lightweight
14 threading library called \fBpthrlib\fR (so it runs as a single process)
15 and a set of basic data types for C called \fBc2lib\fR.
16
17 .SH "COMMAND LINE OPTIONS"
18 .TP
19 \fB\-p port\fR
20 listen on the given port (default is to listen on port 80)
21 .TP
22 \fB\-C configpath\fR
23 find configuration files under path (default is \fB/etc/rws/\fR)
24 .TP
25 \fB\-d\fR
26 do not send stderr to the \fBerror_log\fR file (used when debugging)
27 .TP
28 \fB\-f\fR
29 do not fork into the background (used when debugging)
30 .TP
31 \fB\-a address\fR
32 bind only to the given interface (default is to bind to all interfaces)
33
34 .SH CONFIGURATION
35 The server is configured through files in the \fB/etc/rws/\fR
36 directory. The main configuration file is \fB/etc/rws/rws.conf\fR
37 and virtual hosts are configured using files in
38 \fB/etc/rws/hosts/\fR\fIhostname\fR, for each virtual host
39 \fIhostname\fR.
40
41
42
43
44
45
46 .SH "RUNNING THE SERVER"
47 To start the server running, log in as root and do:
48 .PP
49 .B /usr/sbin/rwsd
50 .PP
51 To stop the server running, do:
52 .PP
53 .B killall rwsd
54 .PP
55 A SysV start up script is also installed by default, if you prefer
56 to use that method for starting and stopping the service. Do:
57 .PP
58 .B /etc/init.d/rws.rc start
59 .PP
60 or:
61 .PP
62 .B /etc/init.d/rws.rc stop
63 .PP
64 \fBrws\fR cannot run from \fBinetd\fR.
65
66 .SH "HTML FILES"
67
68 .SH "DIRECTORIES"
69
70 .SH "CGI SCRIPTS"
71
72 .SH "SHARED OBJECT SCRIPTS"
73
74
75 .SH FILES
76 \fB/etc/rws/rws.conf\fR
77 .PP
78 \fB/etc/rws/hosts/default\fR
79 .PP
80 \fB/etc/rws/hosts/\fR\fIhostname\fR
81
82 .SH "SEE ALSO"
83 \fBnew_pool\fP(3),
84 \fBnew_pseudothread\fP(3).
85 .PP
86 \fBhttp://www.annexia.org/freeware/rws/\fP
87
88 .SH AUTHOR
89 The primary author is Richard W.M. Jones <\fBrich@annexia.org\fR>.
90
91 .SH COPYRIGHT
92 Copyright \(co 2000-2002 Richard W.M. Jones <\fBrich@annexia.org\fR>.
93
94 .SH LICENSE
95 This software is licensed under the terms of the GNU Library General Public
96 License (GNU LGPL). Please see the file \fBCOPYING.LIB\fR which
97 accompanies the source distribution.