summary refs log tree commit diff
path: root/bin/man1/hi.1
blob: c00874dd3fb28f2b68c1a2f26ff9eca9e754064f (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
.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 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,
.Ar lang
may be inferred from its name.
.El
.
.Pp
The following languages are supported:
.Cm c ,
.Cm make ,
.Cm mdoc .
.
.Pp
The output formats are as follows:
.Bl -tag -width "html-document"
.It Cm ansi
ANSI terminal escape codes.
.It Cm irc
IRC formatting codes.
.It Cm html
HTML
.Sy <pre>
fragment with
.Sy <span>
classes.
.It Cm html-document
HTML document with
.Sy <style> .
.El