aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAarni Koskela <akx@iki.fi>2024-05-03 20:44:17 +0300
committerGitHub <noreply@github.com>2024-05-03 21:44:17 +0400
commit26ed8e1b9dfe2e4c5d23dc80043554197113d83f (patch)
tree1df458d99d0aee54d542fd9ec8c685e34feca970
parented3fac8a033acf10293712339185920849d45a0a (diff)
downloadalacritty-26ed8e1b9dfe2e4c5d23dc80043554197113d83f.tar.gz
alacritty-26ed8e1b9dfe2e4c5d23dc80043554197113d83f.zip
Add config file locations into alacritty(5)
-rw-r--r--README.md6
-rw-r--r--extra/man/alacritty.5.scd14
2 files changed, 16 insertions, 4 deletions
diff --git a/README.md b/README.md
index af678ff8..d00520b4 100644
--- a/README.md
+++ b/README.md
@@ -69,11 +69,9 @@ following locations:
3. `$HOME/.config/alacritty/alacritty.toml`
4. `$HOME/.alacritty.toml`
-### Windows
+On Windows, the config file will be looked for in:
-On Windows, the config file should be located at:
-
-`%APPDATA%\alacritty\alacritty.toml`
+* `%APPDATA%\alacritty\alacritty.toml`
## Contributing
diff --git a/extra/man/alacritty.5.scd b/extra/man/alacritty.5.scd
index 81637f3e..a26b3d96 100644
--- a/extra/man/alacritty.5.scd
+++ b/extra/man/alacritty.5.scd
@@ -9,6 +9,20 @@ Alacritty - TOML configuration file format.
Alacritty's configuration file uses the TOML format. The format's specification
can be found at _https://toml.io/en/v1.0.0_.
+# LOCATION
+
+Alacritty doesn't create the config file for you, but it looks for one in the
+following locations on UNIX systems:
+
+. `$XDG_CONFIG_HOME/alacritty/alacritty.toml`
+. `$XDG_CONFIG_HOME/alacritty.toml`
+. `$HOME/.config/alacritty/alacritty.toml`
+. `$HOME/.alacritty.toml`
+
+On Windows, the config file will be looked for in:
+
+. `%APPDATA%\alacritty\alacritty.toml`
+
# GENERAL
This section documents the root level of the configuration file.