README.md · bat · git.iko.soy

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

328

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

330`bat` will pass the following command line

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

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

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

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

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

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

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

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

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

340

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

342

343## Configuration file

344

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

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

347```

348bat --config-file

349```

350

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

352non-default location of the configuration file:

353```bash

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

355```

356

357### Format

358

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

360

361Example configuration file:

362```bash

363# Set the theme to "TwoDark"

364--theme="TwoDark"

365

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

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

368

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

370--italic-text=always

371

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

373# versions of "less")

374--pager="less -FR"

375

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

377--map-syntax h:cpp

378

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

380--map-syntax .ignore:.gitignore

381```

382

383## Using `bat` on Windows

384

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

386

387### Paging

388

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

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

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

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

393

394### Colors

395

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

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

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

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

400

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

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

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

404

405### Cygwin

406

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

408

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

410

411```shell

412bat() {

413 local index

414 local args=("$@")

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

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

417 -*) continue;;

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

419 esac