diff options
Diffstat (limited to '')
-rw-r--r-- | bin/man1/htagml.1 | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/bin/man1/htagml.1 b/bin/man1/htagml.1 new file mode 100644 index 00000000..97e8f3f2 --- /dev/null +++ b/bin/man1/htagml.1 @@ -0,0 +1,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 |