specter/gmi-web
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

man page final draft?

Browse source
This commit is contained in:
Talon Poole 2021-02-19 17:58:49 +00:00
parent 1baa403227
commit 609d77d515
1 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
gmi-web.1.scd
View file

@ -1,4 +1,4 @@
gmi-web(1) "1.0.0-rc.3" gmi-web(1)
# NAME # NAME
@ -8,7 +8,7 @@ gmi-web - A bridge between Gemini and HTML
*gmi-web* _OPTIONS_ < _FILE_ *gmi-web* _OPTIONS_ < _FILE_
*gmi-web* _OPTIONS_ _FILES_ *gmi-web* _OPTIONS_ _FILES.._
# DESCRIPTION # DESCRIPTION
@ -18,7 +18,7 @@ fashion!
# OPTIONS # OPTIONS
*--body* *--body*
Generate just the HTML for the lines of the Gemini document. Generate just the HTML blocks for the lines of the Gemini document.
*--html* _LANG_ *--html* _LANG_
Generate a full HTML5 document with the provided _LANG_. *--dir* can be used Generate a full HTML5 document with the provided _LANG_. *--dir* can be used
@ -26,12 +26,12 @@ fashion!
Use *--author* _NAME_ to set the author <meta> tag on every file. Use *--author* _NAME_ to set the author <meta> tag on every file.
Use *--descriptions* _LIMIT_ to apply the first non-empty text line of each Use *--descriptions* [_LIMIT_] to apply the first non-empty text line of each
file as the description <meta> tag. _LIMIT_ will be used to truncate the text file as the description <meta> tag. _LIMIT_ may be used to truncate the text
with an ellipsis at that number of characters. with an ellipsis at that number of characters.
*--css* [_MODE_|_FILE_] *--css* _MODE_|_FILE_
By default this will be set to *full* enabling a handful of customizable *--html* will default _MODE_ to *full* enabling a handful of font and color
variables. See *--help* for the complete list. variables. See *--help* for the complete list.
``` ```
@ -40,20 +40,18 @@ gmi-web --html en \\
--background "#9EEBCF" < doc.gmi --background "#9EEBCF" < doc.gmi
``` ```
Choosing *core* will use just what is needed to fix vertical layout issues *--body* will default _MODE_ to *core* and use just what is needed to fix
with CSS 2.1's Normal Flow and inline elements. Choosing *none* will not CSS Normal Flow quirks.
include any style information.
Pointing to a CSS _FILE_ will use those styles. This works with *--body* or
*--inline*.
*--inline* will insert the declarations as "style" properties on their *--inline* will insert the declarations as "style" properties on their
respective tags. This is the sole behavior when using *--body* and can be respective blocks. This is the only behavior when using *--body*.
turned off by using --css *none*. When using --css *full* this feature is
unavailable.
Pointing to a .css _FILE_ will use those styles and works with *--body* or Choosing *none* will not include any style information.
*--inline*. You may want to use *--schemes* to include the <meta> tag for
the light and dark schemes.
*[--image|--audio|--video]* _EXTENSIONS_ *--image|--audio|--video* _EXTENSIONS_
Include media extensions inline. You can provide multiple extensions per flag Include media extensions inline. You can provide multiple extensions per flag
or multiple flags per extension. or multiple flags per extension.