bat-extras/doc/batman.md

# bat-extras: batman

Read system manual pages (`man`) using `bat` as the manual page formatter.

Gone are the days of losing your place while reading through monotone manual pages. With `bat` and `batman`, you can read `man ifconfig` with beautiful 24-bit color and syntax higlighting.


## Usage

    batman [SECTION] [ENTRY]


## Environment

| Variable   | Description                                                  |
| ---------- | ------------------------------------------------------------ |
| `MANPAGER` | Changes the pager used for `batman`. This is treated like `BAT_PAGER`, but only affects this command. |


## Installation

This script is a part of the `bat-extras` suite of scripts. You can find install instructions [here](../README.md#installation).


## Acknowledgements

Thanks to [@sharkdp](https://github.com/sharkdp) and [@LunarLambda](https://github.com/LunarLambda) for debugging how to make this work properly in [certain environments](https://github.com/sharkdp/bat/issues/652).


## Issues?

If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!
Contributions are always welcome.
Added script for using bat with man 2019-09-08 00:19:12 +02:00			`# bat-extras: batman`

Update documentation to be more clear and descriptive 2020-04-06 20:42:45 +02:00			Read system manual pages (`man`) using `bat` as the manual page formatter.

			Gone are the days of losing your place while reading through monotone manual pages. With `bat` and `batman`, you can read `man ifconfig` with beautiful 24-bit color and syntax higlighting.
Added script for using bat with man 2019-09-08 00:19:12 +02:00


doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			`## Usage`
Added script for using bat with man 2019-09-08 00:19:12 +02:00
docs: Convert usage section into code block to work around mdroff 2020-10-04 20:51:02 +02:00			`batman [SECTION] [ENTRY]`
Added script for using bat with man 2019-09-08 00:19:12 +02:00


doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			`## Environment`
batman: Add support for MANPAGER environment variable 2020-02-16 00:10:18 +01:00
			`\| Variable \| Description \|`
			`\| ---------- \| ------------------------------------------------------------ \|`
			\| `MANPAGER` \| Changes the pager used for `batman`. This is treated like `BAT_PAGER`, but only affects this command. \|




Update documentation to add install instructions for each script 2019-09-18 23:15:45 +02:00			`## Installation`

			This script is a part of the `bat-extras` suite of scripts. You can find install instructions [here](../README.md#installation).



Added script for using bat with man 2019-09-08 00:19:12 +02:00			`## Acknowledgements`

			`Thanks to [@sharkdp](https://github.com/sharkdp) and [@LunarLambda](https://github.com/LunarLambda) for debugging how to make this work properly in [certain environments](https://github.com/sharkdp/bat/issues/652).`



			`## Issues?`

			`If you find an issue or have a feature suggestion, make a pull request or issue through GitHub!`
doc: Clean up command documentation 2020-05-16 05:53:59 +02:00			`Contributions are always welcome.`