README.md · bat · git.iko.soy

323Instead of using environment variables, you can also use `bat`s [configuration file](https://github.com/sharkdp/bat#configuration-file) to configure the pager (`--pager` option).

324

325**Note**: By default, if the pager is set to `less` (any no command-line options are specified),

326`bat` will pass the following command line

327options to the pager: `-R`/`--RAW-CONTROL-CHARS`, `-F`/`--quit-if-one-screen` and `-X`/`--no-init`.

328The first (`-R`) is needed to interpret ANSI colors correctly. The second option (`-F`) instructs

329less to exit immediately if the output size is smaller than the vertical size of the terminal.

330This is convenient for small files because you do not have to press `q` to quit the pager. The

331third option (`-X`) is needed to fix a bug with the `--quit-if-one-screen` feature in old versions

332of `less`. Unfortunately, it also breaks mouse-wheel support in `less`. If you want to enable

333mouse-wheel scrolling, you can either pass just `-R` (as in the example above, this will disable

334the quit-if-one-screen feature), or you can use a recent version of `less` and pass `-RF` which

335will hopefully enable both quit-if-one-screen and mouse-wheel scrolling.

336

337If scrolling still doesn't work for you, you can try to pass the `-S` option in addition.

338

339## Configuration file

340

341`bat` can also be customized with a configuration file. The location of the file is dependent

342on your operating system. To get the default path for your system, call

343```

344bat --config-file

345```

346

347Alternatively, you can use the `BAT_CONFIG_PATH` environment variable to point `bat` to a

348non-default location of the configuration file:

349```bash

350export BAT_CONFIG_PATH="/path/to/bat.conf"

351```

352

353### Format

354

355The configuration file is a simple list of command line arguments. Use `bat --help` to see a full list of possible options and values. In addition, you can add comments by prepending a line with the `#` character.

356

357Example configuration file:

358```bash

359# Set the theme to "TwoDark"

360--theme="TwoDark"

361

362# Show line numbers, Git modifications and file header (but no grid)

363--style="numbers,changes,header"

364

365# Use italic text on the terminal (not supported on all terminals)

366--italic-text=always

367

368# Add mouse scrolling support in less (does not work with older

369# versions of "less")

370--pager="less -FR"

371

372# Use C++ syntax (instead of C) for .h header files

373--map-syntax h:cpp

374

375# Use "gitignore" highlighting for ".ignore" files

376--map-syntax .ignore:.gitignore

377```

378

379## Using `bat` on Windows

380

381`bat` mostly works out-of-the-box on Windows, but a few features may need extra configuration.

382

383### Paging

384

385Windows only includes a very limited pager in the form of `more`. You can download a Windows binary

386for `less` [from its homepage](http://www.greenwoodsoftware.com/less/download.html) or [through

387Chocolatey](https://chocolatey.org/packages/Less). To use it, place the binary in a directory in

388your `PATH` or [define an environment variable](#using-a-different-pager).

389

390### Colours

391

392Windows 10 natively supports colours in both `conhost.exe` (Command Prompt) and PowerShell since

393[v1511](https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1511_(November_Update)), as

394well as in newer versions of bash. On earlier versions of Windows, you can use

395[Cmder](http://cmder.net/), which includes [ConEmu](https://conemu.github.io/).

396

397**Note:** The Git and MSYS versions of `less` do not correctly interpret colours on Windows. If you

398don’t have any other pagers installed, you can disable paging entirely by passing `--paging=never`

399or by setting `BAT_PAGER` to an empty string.

400

401### Cygwin

402

403`bat` on Windows does not natively support Cygwin's unix-style paths (`/cygdrive/*`). When passed an absolute cygwin path as an argument, `bat` will encounter the following error: `The system cannot find the path specified. (os error 3)`

404

405This can be solved by creating a wrapper or adding the following function to your `.bash_profile` file:

406

407```shell

408bat() {

409 local index

410 local args=("$@")

411 for index in $(seq 0 ${#args[@]}) ; do

412 case "${args[index]}" in

413 -*) continue;;

414 *) [ -e "${args[index]}" ] && args[index]="$(cygpath --windows "${args[index]}")";;

415 esac