aslakhellesoy-bcat 0.6.0.1

data/man/a2h.1

@@ -0,0 +1,55 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "A2H" "1" "June 2010" "Ryan Tomayko" "Bcat 0.5.0"
+.
+.SH "NAME"
+\fBa2h\fR \- convert ANSI/VT100 escape sequences to HTML
+.
+.SH "SYNOPSIS"
+\fBa2h\fR [\-] [\fIfile\fR\.\.\.]
+.
+.SH "DESCRIPTION"
+The \fBa2h\fR utility reads from standard input, or one or more \fIfile\fRs, and converts ANSI/VT100 escape sequences to inline HTML\.
+.
+.SH "ESCAPE SEQUENCES"
+The following escape sequences are supported:
+.
+.TP
+\fB<ESC>[0m\fR
+Resets all attributes / closes all HTML tags\.
+.
+.TP
+\fB<ESC>[1m\fR=\fB<b>\fR
+Bold\.
+.
+.TP
+\fB<ESC>[4m\fR=\fB<u>\fR
+Underscore\.
+.
+.TP
+\fB<ESC>[5m\fR=\fB<blink>\fR
+Blink\. Really\.
+.
+.TP
+\fB<ESC>[8m\fR=\fB<span style=\'display:none\'>\fR
+Hidden\.
+.
+.TP
+\fB<ESC>[30\-37m\fR=\fB<span style=\'color:\fR\fIcolor\fR\fB>\fR
+Foreground color\.
+.
+.TP
+\fB<ESC>[40\-47m\fR=\fB<span style=\'background\-color:\fR\fIcolor\fR\fB>\fR
+Background color\.
+.
+.TP
+\fB<ESC>[90\-97m\fR=\fB<span style=\'color:\fR\fIcolor\fR\fB>\fR
+Light foreground colors\.
+.
+.TP
+\fB<ESC>[100\-107m\fR=\fB<span style=\'background\-color:\fR\fIcolor\fR\fB>\fR
+Light background color\.
+.
+.SH "SEE ALSO"
+ansi2html\.sh \fIhttp://github\.com/pixelb/scripts/blob/master/scripts/ansi2html\.sh\fR, HTML::FromANSI \fIhttp://cpansearch\.perl\.org/src/NUFFIN/HTML\-FromANSI\-2\.03/lib/HTML/FromANSI\.pm\fR

data/man/a2h.1.ronn

@@ -0,0 +1,39 @@
+a2h(1) -- convert ANSI/VT100 escape sequences to HTML
+=====================================================
+
+## SYNOPSIS
+
+`a2h` [-] [<file>...]
+
+## DESCRIPTION
+
+The `a2h` utility reads from standard input, or one or more <file>s, and
+converts ANSI/VT100 escape sequences to inline HTML.
+
+## ESCAPE SEQUENCES
+
+The following escape sequences are supported:
+
+  * `<ESC>[0m`:
+    Resets all attributes / closes all HTML tags.
+  * `<ESC>[1m`=`<b>`:
+    Bold.
+  * `<ESC>[4m`=`<u>`:
+    Underscore.
+  * `<ESC>[5m`=`<blink>`:
+    Blink. Really.
+  * `<ESC>[8m`=`<span style='display:none'>`:
+    Hidden.
+  * `<ESC>[30-37m`=`<span style='color:`<color>`>`:
+    Foreground color.
+  * `<ESC>[40-47m`=`<span style='background-color:`<color>`>`:
+    Background color.
+  * `<ESC>[90-97m`=`<span style='color:`<color>`>`:
+    Light foreground colors.
+  * `<ESC>[100-107m`=`<span style='background-color:`<color>`>`:
+    Light background color.
+
+## SEE ALSO
+
+[ansi2html.sh](http://github.com/pixelb/scripts/blob/master/scripts/ansi2html.sh),
+[HTML::FromANSI](http://cpansearch.perl.org/src/NUFFIN/HTML-FromANSI-2.03/lib/HTML/FromANSI.pm)

data/man/bcat.1

@@ -0,0 +1,226 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "BCAT" "1" "July 2010" "Ryan Tomayko" "Bcat 0.5.0"
+.
+.SH "NAME"
+\fBbcat\fR \- browser cat
+.
+.SH "SYNOPSIS"
+\fBbcat\fR [\-htad] [\fIfile\fR\.\.\.]
+.
+.br
+\fBbtee\fR [\-htad] [\fIfile\fR\.\.\.]
+.
+.SH "DESCRIPTION"
+The \fBbcat\fR utility reads from standard input, or one or more \fIfile\fRs, and pipes output into a web browser\. \fIfile\fR may be \'\-\', in which case standard input is concatenated at that position\.
+.
+.P
+When invoked as \fBbtee\fR, all input is written immediately to standard output in addition to being piped into the browser\.
+.
+.SH "OPTIONS"
+\fBbcat\fR opens a simple, undecorated page with the system default web browser and immediately begins streaming input\. The following options control the browser display:
+.
+.TP
+\fB\-b\fR, \fB\-\-browser\fR=default|firefox|safari|chrome|opera|\fIother\fR
+The name of the browser application\. Defaults to the value of the \fBBCAT_BROWSER\fR environment variable, or the system default browser when no \fBBCAT_BROWSER\fR is defined\.
+.
+.TP
+\fB\-T\fR, \fB\-\-title\fR=\fItext\fR
+Use \fItext\fR as the page \fB<title>\fR\. By default, the path to the current working directory is used as the title\.
+.
+.TP
+\fB\-a\fR, \fB\-\-ansi\fR
+Turns on VT100/ANSI escape sequence conversion\. This causes all input to be piped through a2h(1), replacing ANSI escape sequences with HTML for things like bold, underline, and colors\. On by default when the input is text; use the \fB\-a\fR option to turn it on when the input is HTML\.
+.
+.P
+By default, \fBbcat\fR attempts to detect whether input is HTML or plain text using a simple heuristic, but you can force input to be treated as one or the other with these options:
+.
+.TP
+\fB\-t\fR, \fB\-\-text\fR
+The input is non\-HTML encoded text\. All bare \fB<\fR and \fB&\fR characters are entity encoded, end\-of\-line characters are converted to \fB<br>\fR, and the entire output is wrapped in a \fB<pre>\fR\.
+.
+.TP
+\fB\-h\fR, \fB\-\-html\fR
+The input is already HTML encoded\. Under this mode, bcat passes input through to the browser mostly unmodified\. The input may be a full HTML document, or it may be an HTML fragment\. \fBbcat\fR outputs \fB<html>\fR, \fB<head>\fR, and \fB<body>\fR elements even if they are not included in the input\.
+.
+.P
+Miscellaneous options:
+.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Turn on verbose debug logging to standard error\. Include this output when reporting defects if applicable\.
+.
+.SH "ENVIRONMENT"
+.
+.TP
+\fBBCAT_BROWSER\fR=default|firefox|safari|chrome|opera|\fIother\fR
+The name of the browser to use by default\. \fBbcat\fR maps this to an actual browser command based on the current platform\. The special value "default" maps to the system default browser\.
+.
+.TP
+\fBBCAT_COMMAND\fR=\fIcommand\fR
+The entire browser command line (to be executed by \fB/bin/sh\fR)\. This overrides the \fBBCAT_BROWSER\fR environment variable and makes the \fB\-\-browser\fR (\fB\-b\fR) option a no\-op\. This should only be necessary when running a browser unknown to bcat or in order to pass special arguments\.
+.
+.SH "EXAMPLES"
+.
+.SS "Basic Shell Examples"
+With build tools:
+.
+.IP "" 4
+.
+.nf
+
+make test |bcat
+rake test |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+As a clipboard viewer:
+.
+.IP "" 4
+.
+.nf
+
+pbpaste  |bcat  # mac
+xclip \-o |bcat  # X11
+.
+.fi
+.
+.IP "" 0
+.
+.P
+For previewing HTML:
+.
+.IP "" 4
+.
+.nf
+
+markdown README\.md |bcat
+redcloth README\.textile |bcat
+erb \-T \- template\.erb |bcat
+mustache < template\.mustache |bcat
+pygmentize \-Ofull,style=colorful \-f html main\.c |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+As a simple man pager:
+.
+.IP "" 4
+.
+.nf
+
+export MANPAGER=\'col \-b |bcat\'
+man grep
+.
+.fi
+.
+.IP "" 0
+.
+.P
+With git, selectively:
+.
+.IP "" 4
+.
+.nf
+
+git log \-p \-\-color |bcat
+git diff \-\-color HEAD@{5d} HEAD |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+With git, as the default PAGER:
+.
+.IP "" 4
+.
+.nf
+
+export GIT_PAGER=bcat
+
+git log \-p
+git diff HEAD@{5d} HEAD
+.
+.fi
+.
+.IP "" 0
+.
+.P
+As a log viewer:
+.
+.IP "" 4
+.
+.nf
+
+tail \-n 1000 \-f /var/log/messages |bcat
+tail \-f $RAILS_ROOT/log/development\.log |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Or, a remote log viewer:
+.
+.IP "" 4
+.
+.nf
+
+ssh example\.org \'tail \-n 1000 \-f /var/log/syslog\' |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Vim and vi Examples"
+Preview current buffer as HTML:
+.
+.IP "" 4
+.
+.nf
+
+:!markdown % |bcat
+:!ronn \-5 \-\-pipe % |bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create keymappings:
+.
+.IP "" 4
+.
+.nf
+
+map ,pm :!markdown % \e|bcat
+map ,pp :!pygmentize \-Ofull,style=colorful \-f html % \e|bcat
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Use with \fBmakeprg\fR:
+.
+.IP "" 4
+.
+.nf
+
+set makeprg=make\e \e\e\e|bcat
+set makeprg=markdown\e %\e \e\e\e|bcat
+set makeprg=testrb\e %\e \e\e\e|bcat
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+cat(1), tee(1), open(1)

data/man/bcat.1.ronn

@@ -0,0 +1,159 @@
+bcat(1) -- browser cat
+======================
+
+## SYNOPSIS
+
+`bcat` [-htapd] [<file>...]<br>
+`bcat` [-htapd] -c <command>...<br>
+`btee` [-htad] [<file>...]
+
+## DESCRIPTION
+
+The `bcat` utility reads from standard input, or one or more <file>s, and pipes
+output into a web browser. <file> may be '-', in which case standard input is
+concatenated at that position.
+
+When invoked as `btee`, all input is written immediately to standard output in
+addition to being piped into the browser.
+
+## OPTIONS
+
+`bcat` opens a simple, undecorated page with the system default web browser and
+immediately begins streaming input. The following options control the browser
+display:
+
+  * `-b`, `--browser`=default|firefox|safari|chrome|opera|<other>:
+    The name of the browser application. Defaults to the value of the
+    `BCAT_BROWSER` environment variable, or the system default browser when
+    no `BCAT_BROWSER` is defined.
+
+  * `-T`, `--title`=<text>:
+    Use <text> as the page `<title>`. By default, the path to the current working
+    directory is used as the title.
+
+  * `-a`, `--ansi`:
+    Turns on VT100/ANSI escape sequence conversion. This causes all input to be
+    piped through a2h(1), replacing ANSI escape sequences with HTML for things
+    like bold, underline, and colors. On by default when the input is text; use
+    the `-a` option to turn it on when the input is HTML.
+
+By default, `bcat` attempts to detect whether input is HTML or plain text using
+a simple heuristic, but you can force input to be treated as one or the other
+with these options:
+
+  * `-t`, `--text`:
+    The input is non-HTML encoded text. All bare `<` and `&` characters are
+    entity encoded, end-of-line characters are converted to `<br>`, and the
+    entire output is wrapped in a `<pre>`.
+
+  * `-h`, `--html`:
+    The input is already HTML encoded. Under this mode, `bcat` passes input
+    through to the browser mostly unmodified. The input may be a full HTML
+    document, or it may be an HTML fragment. `bcat` outputs `<html>`, `<head>`,
+    and `<body>` elements even if they are not included in the input.
+
+Miscellaneous options:
+
+  * `-c`, `--command`:
+    Interpret the remaining options as a command to be run whose output should
+    be piped into the web browser.
+
+  * `-p`, `--persist`:
+    Have `bcat` serve requests until it is interrupted. Reloading the page
+    in the browser will cause `bcat` to re-read the files (or re-run the command
+    if used with the `--command` option). Standard input can only be read once
+    and will produce no content on subsequent requests.
+
+  * `-d`, `--debug`:
+    Turn on verbose debug logging to standard error. Include this output when
+    reporting defects if applicable.
+
+## ENVIRONMENT
+
+  * `BCAT_BROWSER`=default|firefox|safari|chrome|opera|<other>:
+    The name of the browser to use by default. `bcat` maps this to an
+    actual browser command based on the current platform. The special
+    value "default" maps to the system default browser.
+
+  * `BCAT_COMMAND`=<command>:
+    The entire browser command line (to be executed by `/bin/sh`). This
+    overrides the `BCAT_BROWSER` environment variable and makes the `--browser`
+    (`-b`) option a no-op. This should only be necessary when running a
+    browser unknown to bcat or in order to pass special arguments.
+
+## EXAMPLES
+
+### Basic Shell Examples
+
+With build tools:
+
+    make test |bcat
+    rake test |bcat
+
+As a clipboard viewer:
+
+    pbpaste  |bcat  # mac
+    xclip -o |bcat  # X11
+
+For previewing HTML:
+
+    markdown README.md |bcat
+    redcloth README.textile |bcat
+    erb -T - template.erb |bcat
+    mustache < template.mustache |bcat
+    pygmentize -Ofull,style=colorful -f html main.c |bcat
+
+Regenerate the content each time the page is reloaded:
+
+    bcat -pc markdown README.md
+
+As a simple man pager:
+
+    export MANPAGER='col -b |bcat'
+    man grep
+
+With git, selectively:
+
+    git log -p --color |bcat
+    git diff --color HEAD@{5d} HEAD |bcat
+
+With git, as the default PAGER:
+
+    export GIT_PAGER=bcat
+
+    git log -p
+    git diff HEAD@{5d} HEAD
+
+As a log viewer:
+
+    tail -n 1000 -f /var/log/messages |bcat
+    tail -f $RAILS_ROOT/log/development.log |bcat
+
+Or, a remote log viewer:
+
+    ssh example.org 'tail -n 1000 -f /var/log/syslog' |bcat
+
+### Vim and vi Examples
+
+Preview current buffer as HTML:
+
+    :!markdown % |bcat
+    :!ronn -5 --pipe % |bcat
+
+Create keymappings:
+
+    map ,pm :!markdown % \|bcat
+    map ,pp :!pygmentize -Ofull,style=colorful -f html % \|bcat
+
+Use with `makeprg`:
+
+    set makeprg=make\ \\\|bcat
+    set makeprg=markdown\ %\ \\\|bcat
+    set makeprg=testrb\ %\ \\\|bcat
+
+(Note that you may need to escape the `%` character with quotes if there's
+spaces in the pathname. For example: `!markdown '%' |bcat`.)
+
+## SEE ALSO
+
+cat(1), tee(1), open(1)