Blob


1 .\" Copyright (c) 2022, 2023 Omar Polo <op@omarpolo.com>
2 .\"
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
6 .\"
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .Dd July 3, 2024
15 .Dt GEMEXP 1
16 .Os
17 .Sh NAME
18 .Nm gemexp
19 .Nd export a directory over Gemini
20 .Sh SYNOPSIS
21 .Nm
22 .Bk -words
23 .Op Fl hRVv
24 .Op Fl d Ar certs-dir
25 .Op Fl H Ar hostname
26 .Op Fl p Ar port
27 .Op Ar directory
28 .Ek
29 .Sh DESCRIPTION
30 .Nm
31 exports the given
32 .Ar directory
33 over the Gemini protocol.
34 It's intended to be used interactively mostly for testing purposes,
35 for a full-fledged daemon look for
36 .Xr gmid 8 .
37 .Pp
38 The arguments are as follows:
39 .Bl -tag -width Ds
40 .It Fl d Ar certs-path
41 Directory where certificates are stored.
42 By default is
43 .Pa $XDG_DATA_HOME/gemexp ,
44 i.e.\&
45 .Pa ~/.local/share/gemexp .
46 .It Fl H Ar hostname
47 The
48 .Ar hostname
49 to use,
50 .Ar localhost
51 by default.
52 Certificates for the given
53 .Ar hostname
54 are searched inside the
55 .Ar certs-dir
56 specified with the
57 .Fl d
58 option.
59 The certificate files are named
60 .Ar hostname Ns .pem
61 and
62 .Ar hostname Ns .key
63 and are implicitly generated if not found.
64 .It Fl h , Fl -help
65 Print the usage and exit.
66 .It Fl p Ar port
67 The port to bind to, 1965 by default.
68 .It Fl R
69 Generate an RSA key instead of an EC one.
70 .It Fl V , Fl -version
71 Print the version and exit.
72 .It Fl v
73 Verbose mode.
74 .It Ar directory
75 The root directory to serve, or the current working directory if not
76 specified.
77 .El
78 .Sh SEE ALSO
79 .Xr gg 1 ,
80 .Xr gmid 8
81 .Sh ACKNOWLEDGEMENTS
82 .Nm
83 uses the
84 .Dq Flexible and Economical
85 UTF-8 decoder written by
86 .An Bjoern Hoehrmann .
87 .Sh AUTHORS
88 .An -nosplit
89 The
90 .Nm
91 program was written by
92 .An Omar Polo Aq Mt op@omarpolo.com .