man: clarify paths (#929)

direnv · Apr 14, 2022 · 110b04a · 110b04a
1 parent d08393b
commit 110b04a
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 12 deletions.
diff --git a/man/direnv.1 b/man/direnv.1
@@ -184,17 +184,26 @@ own extensions inside \fB\fC$XDG_CONFIG_HOME/direnv/direnvrc\fR or
 .PP
 Hopefully this is enough to get you started.
 
+.SH ENVIRONMENT
+.TP
+\fB\fCXDG_CONFIG_HOME\fR
+Defaults to \fB\fC$HOME/.config\fR\&.
+
 .SH FILES
 .TP
-$XDG_CONFIG_HOME/direnv/direnvrc
-\fB\fCdirenv\fR configuration
+\fB\fC$XDG_CONFIG_HOME/direnv/direnv.toml\fR
+Direnv configuration. See direnv.toml(1).
+
+.TP
+\fB\fC$XDG_CONFIG_HOME/direnv/direnvrc\fR
+Bash code loaded before every \fB\fC\&.envrc\fR\&. Good for personal extensions.
 
 .TP
-$XDG_CONFIG_HOME/direnv/lib/*.sh
-Third-party extensions to direnv-stdlib.
+\fB\fC$XDG_CONFIG_HOME/direnv/lib/*.sh\fR
+Bash code loaded before every \fB\fC\&.envrc\fR\&. Good for third-party extensions.
 
 .TP
-$XDG_DATA_HOME/direnv/allow
+\fB\fC$XDG_DATA_HOME/direnv/allow\fR
 Records which \fB\fC\&.envrc\fR files have been \fB\fCdirenv allow\fRed.
 
 .SH CONTRIBUTE

diff --git a/man/direnv.1.md b/man/direnv.1.md
@@ -143,16 +143,25 @@ own extensions inside `$XDG_CONFIG_HOME/direnv/direnvrc` or
 
 Hopefully this is enough to get you started.
 
+ENVIRONMENT
+-----------
+
+`XDG_CONFIG_HOME`
+: Defaults to `$HOME/.config`.
+
 FILES
 -----
 
-$XDG_CONFIG_HOME/direnv/direnvrc
-: `direnv` configuration
+`$XDG_CONFIG_HOME/direnv/direnv.toml`
+: Direnv configuration. See direnv.toml(1).
+
+`$XDG_CONFIG_HOME/direnv/direnvrc`
+: Bash code loaded before every `.envrc`. Good for personal extensions.
 
-$XDG_CONFIG_HOME/direnv/lib/*.sh
-: Third-party extensions to direnv-stdlib.
+`$XDG_CONFIG_HOME/direnv/lib/*.sh`
+: Bash code loaded before every `.envrc`. Good for third-party extensions.
 
-$XDG_DATA_HOME/direnv/allow
+`$XDG_DATA_HOME/direnv/allow`
 : Records which `.envrc` files have been `direnv allow`ed.
 
 CONTRIBUTE

diff --git a/man/direnv.toml.1 b/man/direnv.toml.1
@@ -7,7 +7,7 @@ direnv.toml - the direnv configuration file
 .SH DESCRIPTION
 .PP
 A configuration file in TOML
-\[la]https://github.com/toml-lang/toml\[ra] format to specify a variety of configuration options for direnv. Read from at CONFIGURATION_DIR/direnv.toml or $DIRENV_CONFIG/direnv.toml. For many users, CONFIGURATION_DIR will be located at $HOME/.config/direnv/direnv.toml.
+\[la]https://github.com/toml-lang/toml\[ra] format to specify a variety of configuration options for direnv. The file is read from \fB\fC$XDG_CONFIG_HOME/direnv/direnv.toml\fR\&.
 
 .PP
 .RS

diff --git a/man/direnv.toml.1.md b/man/direnv.toml.1.md
@@ -9,7 +9,7 @@ direnv.toml - the direnv configuration file
 DESCRIPTION
 -----------
 
-A configuration file in [TOML](https://github.com/toml-lang/toml) format to specify a variety of configuration options for direnv. Read from at CONFIGURATION_DIR/direnv.toml or $DIRENV_CONFIG/direnv.toml. For many users, CONFIGURATION_DIR will be located at $HOME/.config/direnv/direnv.toml.
+A configuration file in [TOML](https://github.com/toml-lang/toml) format to specify a variety of configuration options for direnv. The file is read from `$XDG_CONFIG_HOME/direnv/direnv.toml`.
 
 > For versions v2.21.0 and below use config.toml instead of direnv.toml