summary refs log tree commit diff stats
path: root/gmitohtml.1
blob: 8ebf271e2a69ba021fc15789543a905d658333bd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
.Dd November 6, 2020
.Dt GMITOHTML 1
.Sh NAME
.Nm gmitohtml
.Nd convert gemtext to HTML
.Sh SYNOPSIS
.Nm gmitohtml
.Op Fl h
.Op Fl i Ar input
.Op Fl o Ar output
.Sh DESCRIPTION
.Nm gmitohtml
reads gemtext from stdin and converts it to HTML written to stdout.
.Pp
Options are as follows:
.Bl -tag -width Ds
.It Fl o
Print usage help message.
.It Fl i
Specify input file instead of stdin.
.It Fl o
Specify output file instead of stdout.
.El
.Sh EXAMPLES
Read from stdin, output to stdout:
.Bd -literal -offset indent
$ gmitohtml < index.gmi > index.html
.Ed
.Pp
Use alternative input/output:
.Bd -literal -offset indent
$ gmitohtml -i index.gmi -o index.html
.Ed
.Pp
Use only alternative input then redirect stdout output:
.Bd -literal -offset indent
$ gmitohtml -i index.gmi > output.html
.Ed
.Sh CAVEATS
This tool processes input and output in one chunk, meaning that streaming from and into pipes is not an option.
.Sh AUTHOR
.An Ali Fardan Aq Mt raiz@stellarbound.space