source: Main/trunk/Manpage/tewi.conf.5.tmpl@ 37

Last change on this file since 37 was 37, checked in by Nishi, on Sep 16, 2024 at 10:57:39 PM

add manpage

File size: 2.2 KB
Line 
1.Dd 2024 Sep 16th
2.Dt TEWI 8
3.Os
4.Sh NAME
5.Nm tewi ,
6.Nm tewi.conf
7.Nd Tewi HTTPd
8.Sh DESCRIPTION
9.Nm
10is a simple public domain HTTP daemon written in C.
11.Sh CONFIGURATION
12.Ss "General settings"
13.Bl -tag -width 20 -compact
14.It Pa "Listen"
15Specifies the port(s) to be listened on.
16.It Pa "DocumentRoot"
17Specifies the document root.
18.It Pa "LoadModule"
19Loads the module.
20.It Pa "MIMEType"
21Specifies the MIME type for files.
22\fBall\fR can be used instead of the extension if you want to make all extensions appear as same MIME.
23Later rules will override the MIME.
24
25Example:
26
27.Vb 1
28\& MIMEType all application/octet-stream
29
30\& MIMEType .html text/html
31.Ve
32
33.It Pa "BeginVirtualHost"
34Begins the virtual host section.
35.It Pa "EndVirtualHost"
36Ends the virtual host section.
37.El
38.Ss "TLS/SSL settings"
39.Bl -tag -width 20 -compact
40.It Pa "ListenSSL"
41Specifies the port(s) to be listened on, but with TLS/SSL.
42.It Pa "SSLKey"
43Specifies the TLS/SSL private key.
44This works in the virtual host section too, and can be used to switch key depending on the virtual host.
45.It Pa "SSLCertificate"
46Specifies the TLS/SSL certificate.
47This works in the virtual host section too, and can be used to switch certificate depending on the virtual host.
48.El
49.Ss "Access settings"
50.Bl -tag -width 20 -compact
51Default access is "Deny all".
52
53.It Pa "BeginDirectory"
54Begins the directory section.
55.It Pa "EndDirectory"
56Ends the directory section.
57.It Pa "Allow"
58Allows the connection. Only works with \fBall\fR for now.
59Will not work outside of the directory section.
60.It Pa "Deny"
61Denies the connection. Only works with \fBall\fR for now.
62Will not work outside of the directory section.
63.El
64.Ss "Directory settings"
65.Bl -tag -width 20 -compact
66.It Pa "DirectoryIndex"
67Specifies the directory index.
68.It Pa "Readme"
69Specifies the README file for directory listing.
70.It Pa "Icon"
71Sets the icon for the MIME type.
72\fBall\fR can be used instead of the MIME if you want to make all MIMEs appear as same icon.
73Later rules will override the icon.
74
75Example:
76
77.Vb 1
78\& Icon all /icons/unknown.png
79
80\& Icon text/* /icons/text.png
81.Ve
82.El
83.Sh FILES
84.Bl -tag -width @PREFIX@/etc/tewi.conf -compact
85.It Pa @PREFIX@/etc/tewi.conf
86Default path for the config
87.El
88.Sh AUTHORS
89.An Nishi Aq Mt nishi@nishi.boats
Note: See TracBrowser for help on using the repository browser.