gmi-web/gmi-web.1

.\" 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:
.TH "gmi-web" "1" "2021-02-15" "1.0.2-rc.2"
.P
.SH NAME
.P
gmi-web - a bridge between Gemini and HTML
.P
.SH SYNOPSIS
.P
\fBgmi-web\fR \fIOPTIONS\fR < \fIFILE\fR
.P
\fBgmi-web\fR \fIOPTIONS\fR \fIFILES\fR
.P
.SH DESCRIPTION 
.P
Convert Gemtext to semantic HTML styled in a readable, predictable and 
mobile-friendly fashion!
.P
.SH OPTIONS
.P
\fB--body\fR
.RS 4
Generate just the HTML for the lines of the Gemini document.
.P
.RE
\fB--html\fR \fILANG\fR
.RS 4
Generate a full HTML5 document with the provided \fILANG\fR. \fB--dir\fR can be used
to adjust the document text direction from "ltr" to "rtl".
.P
Use \fB--descriptions\fR \fILIMIT\fR to apply the first non-empty text line of each
file as the description <meta> tag. \fILIMIT\fR will be used to truncate the text
with an ellipsis at that number of characters.
.P
Use \fB--author\fR \fINAME\fR to set the author <meta> tag on every file.
.P
.RE
\fB--css\fR [\fIMODE\fR|\fIFILE\fR]
.RS 4
By default this will be set to \fBfull\fR enabling a handful of customizable
variables. See \fB--help\fR for the complete list.
.P
.RE
.nf
.RS 4
gmi-web --html en \\ 
	--foreground "#555555" \\
	--background "#9EEBCF" < doc\&.gmi
.fi
.RE
.P
.RS 4
Choosing \fBcore\fR will use just what is needed to fix vertical layout issues 
with CSS 2.1's Normal Flow and inline elements. Pointing to a .css \fIFILE\fR 
will use those styles. 
.P
Choosing \fBnone\fR will not include any style information including when paired
with \fB--body\fR where it will not apply the core inline styles.
.P
.RE
\fB[--image|--audio|--video]\fR \fIEXTENSIONS\fR
.RS 4
Include media extensions inline. You can provide multiple extensions per flag
or multiple flags per extension.
.P
.RE
.nf
.RS 4
gmi-web --html en \\
	--image jpg \\
	--image png \\
	--audio mp3 ogg < doc\&.gmi
.fi
.RE
.P
\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 instead of as flags on the command-line.
.P
.RE
.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/>