1 a7e678bf 2021-08-08 xhr .\"
 2 a7e678bf 2021-08-08 xhr .\" Copyright (c) 2021 Matthias Schmidt
 3 a7e678bf 2021-08-08 xhr .\"
 4 a7e678bf 2021-08-08 xhr .\" Permission to use, copy, modify, and distribute this software for any
 5 a7e678bf 2021-08-08 xhr .\" purpose with or without fee is hereby granted, provided that the above
 6 a7e678bf 2021-08-08 xhr .\" copyright notice and this permission notice appear in all copies.
 7 a7e678bf 2021-08-08 xhr .\"
 8 a7e678bf 2021-08-08 xhr .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 9 a7e678bf 2021-08-08 xhr .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 a7e678bf 2021-08-08 xhr .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 a7e678bf 2021-08-08 xhr .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 a7e678bf 2021-08-08 xhr .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 a7e678bf 2021-08-08 xhr .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 a7e678bf 2021-08-08 xhr .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 a7e678bf 2021-08-08 xhr .\"
16 a7e678bf 2021-08-08 xhr .\"
17 5423f862 2021-08-12 xhr .Dd August 12, 2021
18 a7e678bf 2021-08-08 xhr .Dt TWIND 8
19 a7e678bf 2021-08-08 xhr .Os
20 a7e678bf 2021-08-08 xhr .Sh NAME
21 a7e678bf 2021-08-08 xhr .Nm twind
22 a7e678bf 2021-08-08 xhr .Nd Simple gemini server
23 a7e678bf 2021-08-08 xhr .Sh SYNOPSIS
24 a7e678bf 2021-08-08 xhr .Nm twind
25 b67b4591 2021-08-12 xhr .Op Fl dfV
26 004fd51a 2021-08-12 xhr .Op Fl p Ar port
27 a7e678bf 2021-08-08 xhr .Sh DESCRIPTION
28 a7e678bf 2021-08-08 xhr .Nm
29 66231e9e 2021-08-12 xhr is a simple daemon serving static files over the gemini protocol.
30 66231e9e 2021-08-12 xhr It is intended to have as few knobs as possible and has no support for
31 66231e9e 2021-08-12 xhr a configuration file.
32 66231e9e 2021-08-12 xhr .Pp
33 a7e678bf 2021-08-08 xhr The options are as follows:
34 a7e678bf 2021-08-08 xhr .Bl -tag -width Ds
35 a7e678bf 2021-08-08 xhr .It Fl d
36 a7e678bf 2021-08-08 xhr Enable debug log messages.
37 a7e678bf 2021-08-08 xhr Most useful together with
38 a7e678bf 2021-08-08 xhr .Fl f .
39 a7e678bf 2021-08-08 xhr .It Fl f
40 a7e678bf 2021-08-08 xhr Do not daemonize.
41 a7e678bf 2021-08-08 xhr If this option is specified,
42 a7e678bf 2021-08-08 xhr .Nm
43 a7e678bf 2021-08-08 xhr will run in the foreground and log to
44 a7e678bf 2021-08-08 xhr .Em stderr .
45 004fd51a 2021-08-12 xhr .It Fl p Ar port
46 004fd51a 2021-08-12 xhr Listen on Port
47 004fd51a 2021-08-12 xhr .Ar port
48 004fd51a 2021-08-12 xhr instead of the default 1965.
49 b67b4591 2021-08-12 xhr .It Fl V
50 b67b4591 2021-08-12 xhr Display the version and exit.
51 a7e678bf 2021-08-08 xhr .El
52 5423f862 2021-08-12 xhr .Pp
53 5423f862 2021-08-12 xhr .Nm
54 507357d8 2021-08-12 xhr listens on the any address (:: and 0.0.0.0) for both IPv4 and IPv6.
55 507357d8 2021-08-12 xhr .Pp
56 507357d8 2021-08-12 xhr .Nm
57 5423f862 2021-08-12 xhr has support for virtual hosts by default.
58 5423f862 2021-08-12 xhr To serve files for a specific host you have to place them in a sub directory
59 5423f862 2021-08-12 xhr named after the domain under
60 5423f862 2021-08-12 xhr .Pa /var/twind .
61 a7e678bf 2021-08-08 xhr .Sh FILES
62 66231e9e 2021-08-12 xhr The following path cannot be changed, i.e. you have to name your
63 66231e9e 2021-08-12 xhr TLS certificate and key file exactly as shown.
64 66231e9e 2021-08-12 xhr .Pp
65 a7e678bf 2021-08-08 xhr .Bl -tag -width Ds -compact
66 a7e678bf 2021-08-08 xhr .It Pa /etc/twind/twind.cert.pem
67 a7e678bf 2021-08-08 xhr TLS certificate for
68 a7e678bf 2021-08-08 xhr .Nm
69 a7e678bf 2021-08-08 xhr .It Pa /etc/twind/twind.key.pem
70 a7e678bf 2021-08-08 xhr Private key for the certificate mentioned above.
71 1805feb0 2021-08-10 xhr .It Pa /var/twind/
72 a7e678bf 2021-08-08 xhr Default location for the gemini (gmi) files.
73 a7e678bf 2021-08-08 xhr Contains one sub directory for each virtual host.
74 1805feb0 2021-08-10 xhr .It Pa /var/twind/example.com/
75 66231e9e 2021-08-12 xhr Subdirectory containing gemini files for the
76 66231e9e 2021-08-12 xhr .Em example.com
77 66231e9e 2021-08-12 xhr host.
78 a7e678bf 2021-08-08 xhr .El
79 a7e678bf 2021-08-08 xhr .Sh EXIT STATUS
80 a7e678bf 2021-08-08 xhr .Nm
81 be0cc427 2021-08-08 xhr normally exists with 0 or with -1 if an error occurred.
82 a7e678bf 2021-08-08 xhr .Sh AUTHORS
83 a7e678bf 2021-08-08 xhr .Nm
84 a7e678bf 2021-08-08 xhr was written by
85 e0186a20 2021-08-08 xhr .An Matthias Schmidt Aq Mt xhr@giessen.ccc.de .