Blame


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