diff options
author | June McEnroe <june@causal.agency> | 2021-01-12 22:06:56 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2021-01-12 22:06:56 -0500 |
commit | c277129386f1acfe133da11f23a7d730ae48964d (patch) | |
tree | 29923c815344b8ac967f2856338c5649365c43ce /bin/man1 | |
parent | Consolidate hilex formatters into hilex.c (diff) | |
download | src-c277129386f1acfe133da11f23a7d730ae48964d.tar.gz src-c277129386f1acfe133da11f23a7d730ae48964d.zip |
Move hilex out of hilex directory
Diffstat (limited to 'bin/man1')
-rw-r--r-- | bin/man1/hilex.1 | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/bin/man1/hilex.1 b/bin/man1/hilex.1 new file mode 100644 index 00000000..858c8565 --- /dev/null +++ b/bin/man1/hilex.1 @@ -0,0 +1,177 @@ +.Dd January 12, 2021 +.Dt HILEX 1 +.Os +. +.Sh NAME +.Nm hilex +.Nd syntax highlighter +. +.Sh SYNOPSIS +.Nm +.Op Fl t +.Op Fl f Ar format +.Op Fl l Ar lexer +.Op Fl n Ar name +.Op Fl o Ar opts +.Op Ar file +. +.Sh DESCRIPTION +The +.Nm +utility +syntax highlights +the contents of +.Ar file +or standard input +and formats it on standard output. +. +.Pp +The arguments are as follows: +.Bl -tag -width "-f format" +.It Fl f Ar format +Set the output format. +See +.Sx Output Formats . +The default format is +.Cm ansi . +. +.It Fl l Ar lexer +Set the input lexer. +See +.Sx Input Lexers . +The default input lexer is inferred from +.Ar name . +. +.It Fl n Ar name +Set the name used to infer the input lexer. +The default is the final component of +.Ar file . +. +.It Fl o Ar opts +Set output format options. +.Ar opts +is a comma-separated list of options. +Options for each output format are documented in +.Sx Output Formats . +. +.It Fl t +Default to the +.Cm text +input lexer if one cannot be inferred. +.El +. +.Ss Output Formats +.Bl -tag -width Ds +.It Cm ansi +Output ANSI terminal control sequences. +. +.It Cm html +Output HTML +.Sy <span> +elements +within a +.Sy <pre> +element. +Each element has the classes +.Sy hilex +and one of the following: +.Sy Operator , +.Sy Number , +.Sy Keyword , +.Sy Identifier , +.Sy Macro , +.Sy Comment , +.Sy String , +.Sy StringEscape , +.Sy StringFormat , +.Sy Interpolation . +. +.Pp +The options are as follows: +.Bl -tag -width "title=..." +.It Cm style Ns = Ns Ar url +With +.Cm document , +output a +.Sy <link> +element for the external stylesheet +.Ar url . +If unset, +output default styles in a +.Sy <style> +element. +. +.It Cm document +Output an HTML document containing the +.Sy <pre> +element. +. +.It Cm inline +Output inline +.Sy style +attributes rather than classes. +. +.It Cm tab Ns = Ns Ar n +With +.Cm document +or +.Cm inline , +set the +.Sy tab-size +property to +.Ar n . +. +.It Cm title Ns = Ns Ar ... +With +.Cm document , +set the +.Sy <title> +element text. +The default title is the same as +.Ar name . +.El +. +.It Cm irc +Output IRC formatting codes. +The options are as follows: +.Bl -tag -width "monospace" +.It Cm monospace +Use the IRCCloud monospace formatting code. +.El +.El +. +.Ss Input Lexers +.Bl -tag -width Ds +.It Cm c +The C11 language, +with minimal support for +.Xr lex 1 , +.Xr yacc 1 +and Objective-C input. +Inferred for +.Pa *.[chlmy] +files. +. +.It Cm make +The portable subset of +.Xr make 1 . +Inferred for +.Pa *.mk +and +.Pa Makefile +files. +. +.It Cm mdoc +The +.Xr mdoc 7 +language. +Inferred for +.Pa *.[1-9] +files. +. +.It Cm text +Plain text. +Inferred for +.Pa *.txt +files. +.El |