diff options
| author | Christian Duerr <contact@christianduerr.com> | 2023-06-12 02:23:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-12 00:23:41 +0000 |
| commit | bd4906722a1a026b01f06c94c33b13ff63a7e044 (patch) | |
| tree | a2713a7b0a5fa23ec8b9055d7ed06f1cede62447 /README.md | |
| parent | ea2c39e65d21728e0f04b0eafcec7153e4447cd5 (diff) | |
| download | alacritty-bd4906722a1a026b01f06c94c33b13ff63a7e044.tar.gz alacritty-bd4906722a1a026b01f06c94c33b13ff63a7e044.zip | |
Switch to TOML configuration format
This switches Alacritty's default configuration format from yaml to
toml. While yaml is still supported, it is done by converting it to toml
and should be removed entirely in the future.
All existing features were persisted based on my testing. Behavior
should not change much, though `--option` might have slightly different
behavior since the entire line is not interpreted as one line of toml.
A new `alacritty migrate` subcommand has been added which allows
automatic migration from yaml to toml. This also could be used as a
facility to automatically fix configuration file changes in the future.
Closes #6592.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 10 insertions, 7 deletions
@@ -52,22 +52,25 @@ For everyone else, the detailed instructions to install Alacritty can be found ## Configuration -You can find the default configuration file with documentation for all available -fields on the [GitHub releases page](https://github.com/alacritty/alacritty/releases) for each release. +You can find the documentation for Alacritty's configuration in `man 5 +alacritty`, or by looking at [the scdoc file] if you do not have the manpages +installed. + +[the scdoc file]: ./extra/man/alacritty.5.scd Alacritty doesn't create the config file for you, but it looks for one in the following locations: -1. `$XDG_CONFIG_HOME/alacritty/alacritty.yml` -2. `$XDG_CONFIG_HOME/alacritty.yml` -3. `$HOME/.config/alacritty/alacritty.yml` -4. `$HOME/.alacritty.yml` +1. `$XDG_CONFIG_HOME/alacritty/alacritty.toml` +2. `$XDG_CONFIG_HOME/alacritty.toml` +3. `$HOME/.config/alacritty/alacritty.toml` +4. `$HOME/.alacritty.toml` ### Windows On Windows, the config file should be located at: -`%APPDATA%\alacritty\alacritty.yml` +`%APPDATA%\alacritty\alacritty.toml` ## Contributing |