summary refs log tree commit diff
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-07-14 13:32:48 -0400
committerJune McEnroe <june@causal.agency>2019-07-14 13:32:48 -0400
commitdc2665af8edb63055ee775285f0b2b790614b40e (patch)
tree8f2672c4624946d1f79a83ef3221b6f2a8fce2f1
parentFix OSC PT handling (diff)
downloadsrc-dc2665af8edb63055ee775285f0b2b790614b40e.tar.gz
src-dc2665af8edb63055ee775285f0b2b790614b40e.zip
Add more info to shotty man page
Diffstat (limited to '')
-rw-r--r--bin/man1/shotty.128
1 files changed, 26 insertions, 2 deletions
diff --git a/bin/man1/shotty.1 b/bin/man1/shotty.1
index 025ff293..349e603e 100644
--- a/bin/man1/shotty.1
+++ b/bin/man1/shotty.1
@@ -23,8 +23,28 @@ or standard input
 and produces HTML
 .Sy <pre>
 on standard output.
-Terminal output can be captured with
+.
+.Pp
+Terminal output
+can be captured with
 .Xr ptee 1 .
+.Nm
+targets compatibility with
+.Ev TERM Ns = Ns Cm xterm
+and
+.Ev TERM Ns = Ns Cm xterm-256color
+as used by
+.Xr ncurses 3 .
+.
+.Pp
+HTML output uses the classes
+.Sy bg Ns Va n
+and
+.Sy fg Ns Va n ,
+and inline styles for
+bold, italic and underline.
+CSS for colors can be generated with
+.Xr scheme 1 .
 .
 .Pp
 The arguments are as follows:
@@ -61,5 +81,9 @@ Set the terminal width.
 The default value is 80.
 .El
 .
+.Sh EXAMPLES
+.Dl ptee htop | shotty -s > htop.html
+.
 .Sh SEE ALSO
-.Xr ptee 1
+.Xr ptee 1 ,
+.Xr scheme 1
over-highlight'> 2019-02-28Add Station ElevenJune McEnroe 2019-02-27Use getsubopt(3) to parse -o options in hiJune McEnroe 2019-02-27Add type and ulimit shell keywordsJune McEnroe 2019-02-27Fix make target pattern whitespace in hiJune McEnroe 2019-02-27Delete extraneous <pre> in html.shJune McEnroe 2019-02-24Use setopt in upJune McEnroe 2019-02-24Add setoptJune McEnroe 2019-02-20Match make targets as TagJune McEnroe 2019-02-20Use $PWD in html.sh to pass absolute path to manJune McEnroe 2019-02-20Factor out html.sh and produce html for all sourcesJune McEnroe Except for gfx-cocoa because I don't have an Objective-C highlighter. Also hypothetically the .h rule could match up headers with .3 manual pages if I cared to write them. 2019-02-20Add Dirk Gently's Holistic Detective AgencyJune McEnroe 2019-02-20Move /opt/pkg after /usr in PATHJune McEnroe Installing mandoc from pkgsrc also installs a man executable which is horribly broken. Keep using the system man. 2019-02-20Set man_hard_wrap in nvimJune McEnroe Vendoring man.vim until <https://github.com/neovim/neovim/pull/9633> is merged and appears in a release. 2019-02-18Use hi -o anchor in upJune McEnroe 2019-02-18Don't match nested parentheses in Tag for CJune McEnroe Fixes mistaken highlight of: pngWrite(file, (uint8_t []) { 0, 0, 0 }, 3); 2019-02-18Match whitespace between * [] {}June McEnroe 2019-02-18Fix function-like #define regexJune McEnroe A define like #define FOO (1) is not function-like. 2019-02-18Match Tag in RustJune McEnroe 2019-02-18Match sh functions as TagJune McEnroe 2019-02-18Match Sh and Ss as Tag in mdocJune McEnroe 2019-02-18Match statics and typedefs as TagJune McEnroe 2019-02-18Clean up htmlHeaderJune McEnroe 2019-02-18Remove hi line numberingJune McEnroe Tags are much better for referring to specific parts of a file and line numbering is better done by a post-processing tool such as cat -n or producing a two-column HTML <table>. 2019-02-18Add Tag class to hiJune McEnroe 2019-02-17Generate HTML with hi -n -f html -o anchorJune McEnroe Running hi twice to insert stuff between the head and the content is a bit of a hack but oh well. 2019-02-17Add hi -f html -o anchor for line number linksJune McEnroe 2019-02-17Simplify temp trap in upJune McEnroe 2019-02-17Add line numbers to hiJune McEnroe Renames previous -n option to -m to stay consistent with cat -n. Prefixing lines with line numbers affects where the first tab indent ends up relative to the text above it. Not sure if it's worth fixing somehow. 2019-02-17Always split spans after newlinesJune McEnroe Simplifies ANSI and IRC output code, and prepares for line numbered output. 2019-02-15Color format specifiers light cyan in vimJune McEnroe 2019-02-15Highlight Interp as yellowJune McEnroe 2019-02-15Highlight strings in sh command substitutionsJune McEnroe 2019-02-15Add nmap gpJune McEnroe 2019-02-14Avoid newline when copying URL to pasteboardJune McEnroe 2019-02-13Add forgotten "sixth" book of H2G2June McEnroe