summary refs log tree commit diff
path: root/bin/man1/hi.1
blob: ad3957f172aeddf1beac3bde44454ca321d0c998 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
.Dd February 7, 2019
.Dt HI 1
.Os
.
.Sh NAME
.Nm hi
.Nd syntax highlighter
.
.Sh SYNOPSIS
.Nm
.Op Fl f Ar format
.Op Fl l Ar lang
.Op Fl n Ar name
.Op Ar file
.Nm
.Fl c
.
.Sh DESCRIPTION
.Nm
highlights the contents of a
.Ar file
or standard input
and formats it
on standard output.
A maximum of 32K
is read from standard input.
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl c
Compile all regular expressions and exit.
.It Fl f Ar format
Set the output format.
The default
.Ar format
is
.Cm ansi .
.It Fl l Ar lang
Set the input language.
If a
.Ar file
is provided,
the input language
may be inferred from its name.
.It Fl n Ar name
Override the name used
to infer the input language.
.El
.
.Pp
The output formats are as follows:
.Bl -tag -offset indent -width "html-document"
.It Cm ansi
ANSI terminal escape codes.
.It Cm irc
IRC formatting codes.
.It Cm html
HTML fragment.
.It Cm html-document
HTML document.
.El
.
.Pp
The languages are as follows:
.Bl -tag -offset indent -width "make"
.It Cm c
The C11 language.
.It Cm make
The portable subset of
.Xr make 1 .
Variable substitution supports
one level of nesting with the same delimiter.
.It Cm mdoc
The
.Xr mdoc 7
language.
.El