2021-01-29 06:33:54 +00:00
|
|
|
.\" Generated by scdoc 1.10.1
|
|
|
|
|
.\" Complete documentation for this program is not available as a GNU info page
|
|
|
|
|
.ie \n(.g .ds Aq \(aq
|
|
|
|
|
.el .ds Aq '
|
|
|
|
|
.nh
|
|
|
|
|
.ad l
|
|
|
|
|
.\" Begin generated content:
|
2021-01-29 19:55:24 +00:00
|
|
|
.TH "gmi-web" "1" "2021-01-29" "1.0.0"
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
|
|
|
|
.SH NAME
|
|
|
|
|
.P
|
2021-01-29 19:55:24 +00:00
|
|
|
gmi-web - A bridge between Gemini and HTML.
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.P
|
2021-01-29 23:27:39 +00:00
|
|
|
\fBgmi-web\fR [--lang] <\fIOPTIONS\fR> [\fIFILES\fR]
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.P
|
2021-01-29 19:55:24 +00:00
|
|
|
Convert Gemtext to semantic HTML styled in a readable, predictable
|
2021-01-29 06:33:54 +00:00
|
|
|
and mobile-friendly fashion!
|
|
|
|
|
.P
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.P
|
2021-01-29 23:27:39 +00:00
|
|
|
\fB--lang\fR
|
|
|
|
|
.RS 4
|
|
|
|
|
Required for <meta languge="">
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
2021-01-29 22:32:30 +00:00
|
|
|
\fBCSS Variables\fR
|
2021-01-29 06:33:54 +00:00
|
|
|
.RS 4
|
2021-01-29 22:32:30 +00:00
|
|
|
Any variable documented in \fBgmi.css\fR(5) can be set via \fIOPTIONS\fR of the same
|
|
|
|
|
name.
|
2021-01-29 19:55:24 +00:00
|
|
|
.P
|
2021-01-29 23:27:39 +00:00
|
|
|
\fBgmi-web\fR --lang "en" --foreground "#FFFFF" --background "#00000" $(find . -name *.gmi)
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
|
|
|
|
.RE
|
2021-01-29 23:59:12 +00:00
|
|
|
\fB--config\fR [\fIJSON\fR]
|
|
|
|
|
.RS 4
|
|
|
|
|
All the options documented here and by \fB--help\fR may be captured in a .json
|
|
|
|
|
file and passed to \fB--config\fR.
|
|
|
|
|
.P
|
|
|
|
|
.RE
|
2021-01-29 22:32:30 +00:00
|
|
|
\fB--images\fR \fB--audio\fR \fB--video\fR
|
2021-01-29 06:33:54 +00:00
|
|
|
.RS 4
|
2021-01-29 22:32:30 +00:00
|
|
|
Include the respective media inline.
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
|
|
|
|
.RE
|
2021-01-29 19:55:24 +00:00
|
|
|
\fB--no-css\fR
|
2021-01-29 06:33:54 +00:00
|
|
|
.RS 4
|
2021-01-29 23:59:12 +00:00
|
|
|
Use only the bare minimum <style>
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
|
|
|
|
.RE
|
2021-01-29 22:32:30 +00:00
|
|
|
.SH EXAMPLES
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
2021-01-29 22:49:09 +00:00
|
|
|
Render .html for all the .gmi files in the current directory
|
2021-01-29 19:55:24 +00:00
|
|
|
.P
|
2021-01-29 22:32:30 +00:00
|
|
|
.nf
|
|
|
|
|
.RS 4
|
2021-01-29 23:27:39 +00:00
|
|
|
gmi-web --lang en $(find \&. -name *\&.gmi)
|
2021-01-29 22:32:30 +00:00
|
|
|
.fi
|
2021-01-29 06:33:54 +00:00
|
|
|
.RE
|
2021-01-29 22:32:30 +00:00
|
|
|
.P
|
2021-01-29 23:59:12 +00:00
|
|
|
To use \fB--config\fR you will need a .json file with the flags you want to be
|
|
|
|
|
included.
|
|
|
|
|
.P
|
|
|
|
|
.nf
|
|
|
|
|
.RS 4
|
|
|
|
|
{
|
|
|
|
|
"language": "en",
|
|
|
|
|
"foreground": "#137752",
|
|
|
|
|
"background": "#F4F4F4"
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.RE
|
|
|
|
|
.P
|
|
|
|
|
Then give the path to \fBgmi-web\fR --config.
|
|
|
|
|
.P
|
|
|
|
|
.nf
|
|
|
|
|
.RS 4
|
|
|
|
|
gmi-web --config /path/to/my\&.json $(find \&. -name *\&.gmi)
|
|
|
|
|
.fi
|
|
|
|
|
.RE
|
|
|
|
|
.P
|
|
|
|
|
.P
|
2021-01-29 19:55:24 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.P
|
|
|
|
|
\fBgmi.css\fR(5)
|
2021-01-29 06:33:54 +00:00
|
|
|
.P
|
|
|
|
|
.SH AUTHORS
|
|
|
|
|
.P
|
|
|
|
|
Maintained by Talon Poole <code@talon.computer>. Up-to-date sources can be
|
|
|
|
|
found at https://codeberg.org/talon/gmi-web
|
|
|
|
|
.P
|
|
|
|
|
.SH COPYRIGHT
|
|
|
|
|
This is free and unencumbered software released into the public domain.
|
|
|
|
|
.P
|
|
|
|
|
Anyone is free to copy, modify, publish, use, compile, sell, or
|
|
|
|
|
distribute this software, either in source code form or as a compiled
|
|
|
|
|
binary, for any purpose, commercial or non-commercial, and by any
|
|
|
|
|
means.
|
|
|
|
|
.P
|
|
|
|
|
In jurisdictions that recognize copyright laws, the author or authors
|
|
|
|
|
of this software dedicate any and all copyright interest in the
|
|
|
|
|
software to the public domain. We make this dedication for the benefit
|
|
|
|
|
of the public at large and to the detriment of our heirs and
|
|
|
|
|
successors. We intend this dedication to be an overt act of
|
|
|
|
|
relinquishment in perpetuity of all present and future rights to this
|
|
|
|
|
software under copyright law.
|
|
|
|
|
.P
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
|
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
|
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
|
|
|
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
|
|
|
|
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|
|
|
|
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
|
|
|
OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
|
.P
|
|
|
|
|
For more information, please refer to <http://unlicense.org/>
|
