blob: 97e8f3f21fe1e07bb8141ba178903b3796590992 (
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 January 12, 2021
.Dt HTAGML 1
.Os
.
.Sh NAME
.Nm htagml
.Nd format tagged file as HTML
.
.Sh SYNOPSIS
.Nm
.Op Fl ip | x
.Op Fl f Ar tagsfile
.Ar file
.
.Sh DESCRIPTION
The
.Nm
utility formats a file tagged with
.Xr ctags 1
as HTML.
Tags are output as fragment hyperlinks
with the class
.Qq tag .
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl f Ar tagsfile
Read the tag descriptions from a file called
.Ar tagsfile .
The default behavior is
to read them from a file called
.Pa tags .
.It Fl i
Assume
.Ar file
has been pre-formatted
on standard input,
such as by a syntax highlighter.
Only tag hyperlinks are added.
.It Fl p
Wrap the output in a
.Sy pre
element.
.It Fl x
Instead produce an index of tags
ordered by their occurrence in
.Ar file .
The index is formatted as a
.Sy ul
element with the class
.Qq index .
.El
.
.Sh FILES
.Bl -tag -width Ds
.It Pa tags
default input tags file
.El
.
.Sh EXAMPLES
.Bd -literal -offset indent
ctags htagml.c && htagml htagml.c
hilex -f html htagml.c | htagml -i htagml.c
.Ed
.
.Sh SEE ALSO
.Xr ctags 1 ,
.Xr hilex 1
|