From ca3f3152bb4260ddde6a7f27f035387d5040d6c2 Mon Sep 17 00:00:00 2001 From: s3lph Date: Mon, 23 Nov 2020 01:17:56 +0000 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7796672..2b685d8 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,17 @@ This is **work in progress** and probably quite horrible. ## What? +This is a [lexer][lexer] for [Pygments][pygments] that can lex the output of [BIND 9's `dig` command][dig] to provide colorful syntax highlighting for `dig`: + ![Screenshot of colorful dig output][screenshot] ## Why? -`dig` output can be hard to read, especially with `+trace`. +`dig` output can be hard to read, especially with `+trace`. Having some colors in the output helps a lot when reading large dig responses. ## How to use? -Put something like this in your .bashrc, .zshrc, or whatever: +Put something like this in your shell's config, e.g. `.bashrc`, `.zshrc`, or whatever your shell uses: ```bash function dig() { @@ -20,6 +22,11 @@ function dig() { } ``` -Then rehash your shell config. +Then rehash your shell config or start a new session. Now calling `dig` will call this function instead, passing the arguments to the original `dig` command, e.g. in `/usr/bin/dig`, and pipe the output through `pygmentize`. -[screenshot]: https://gitlab.com/s3lph/pygments-dig-lexer/-/raw/master/screenshot.png \ No newline at end of file +If necessary, you can still call the original dig by its full path, e.g. `/usr/bin/dig` instead of just `dig`. + +[screenshot]: https://gitlab.com/s3lph/pygments-dig-lexer/-/raw/master/screenshot.png +[lexer]: https://en.wikipedia.org/wiki/Lexical_analysis +[pygments]: https://pygments.org/ +[dig]: https://en.wikipedia.org/wiki/Dig_(command) \ No newline at end of file