README.md · bat · git.iko.soy

319Instead 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).

320

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

322`bat` will pass the following command line

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

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

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

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

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

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

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

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

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

332

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

334

335## Configuration file

336

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

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

339```

340bat --config-file

341```

342

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

344non-default location of the configuration file:

345```bash

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

347```

348

349### Format

350

351The 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.

352

353Example configuration file:

354```bash

355# Set the theme to "TwoDark"

356--theme="TwoDark"

357

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

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

360

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

362--italic-text=always

363

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

365# versions of "less")

366--pager="less -FR"

367

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

369--map-syntax h:cpp

370

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

372--map-syntax .ignore:.gitignore

373```

374

375## Using `bat` on Windows

376

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

378

379### Paging

380

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

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

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

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

385

386### Colors

387

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

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

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

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

392

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

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

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

396

397### Cygwin

398

399`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)`

400

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

402

403```shell

404bat() {

405 local index

406 local args=("$@")

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

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

409 -*) continue;;

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

411 esac