man/direnv.1.md: add FILES section (fix direnv#758) (direnv#759)

bigbabyjesusdagawd · Feb 12, 2021 · 7d24434 · 7d24434
1 parent 3355e47
commit 7d24434
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 8 deletions.
diff --git a/man/direnv.1 b/man/direnv.1
@@ -1,3 +1,4 @@
+.nh
 .TH DIRENV 1 "2019" direnv "User Manuals"
 .SH NAME
 .PP
@@ -87,7 +88,7 @@ eval "$(direnv hook zsh)"
 
 .SS FISH
 .PP
-Add the following line at the end of the \fB\fC\~/.config/fish/config.fish\fR file:
+Add the following line at the end of the \fB\fC$XDG\_CONFIG\_HOME/fish/config.fish\fR file:
 
 .PP
 .RS
@@ -177,24 +178,37 @@ things.
 Exporting variables by hand is a bit repetitive so direnv provides a set of
 utility functions that are made available in the context of the \fB\fC\&.envrc\fR file.
 Check the direnv\-stdlib(1) man page for more details. You can also define your
-own extensions inside \fB\fC\~/.config/direnv/direnvrc\fR or
-\fB\fC\~/.config/direnv/lib/*.sh\fR files.
+own extensions inside \fB\fC$XDG\_CONFIG\_HOME/direnv/direnvrc\fR or
+\fB\fC$XDG\_CONFIG\_HOME/direnv/lib/*.sh\fR files.
 
 .PP
 Hopefully this is enough to get you started.
 
+.SH FILES
+.TP
+$XDG\_CONFIG\_HOME/direnv/direnvrc
+\fB\fCdirenv\fR configuration
+
+.TP
+$XDG\_CONFIG\_HOME/direnv/lib/*.sh
+Third\-party extensions to direnv\-stdlib.
+
+.TP
+$XDG\_DATA\_HOME/direnv/allow
+Records which \fB\fC\&.envrc\fR files have been \fB\fCdirenv allow\fRed.
+
 .SH CONTRIBUTE
 .PP
 Bug reports, contributions and forks are welcome.
 
 .PP
 All bugs or other forms of discussion happen on
-
+http://github.com/direnv/direnv/issues
 \[la]http://github.com/direnv/direnv/issues\[ra]
 
 .PP
 There is also a wiki available where you can share your usage patterns or
-other tips and tricks 
+other tips and tricks https://github.com/direnv/direnv/wiki
 \[la]https://github.com/direnv/direnv/wiki\[ra]
 
 .PP

diff --git a/man/direnv.1.md b/man/direnv.1.md
@@ -77,7 +77,7 @@ eval "$(direnv hook zsh)"
 
 ### FISH
 
-Add the following line at the end of the `~/.config/fish/config.fish` file:
+Add the following line at the end of the `$XDG_CONFIG_HOME/fish/config.fish` file:
 
 ```fish
 direnv hook fish | source
@@ -138,11 +138,23 @@ things.
 Exporting variables by hand is a bit repetitive so direnv provides a set of
 utility functions that are made available in the context of the `.envrc` file.
 Check the direnv-stdlib(1) man page for more details. You can also define your
-own extensions inside `~/.config/direnv/direnvrc` or
-`~/.config/direnv/lib/*.sh` files.
+own extensions inside `$XDG_CONFIG_HOME/direnv/direnvrc` or
+`$XDG_CONFIG_HOME/direnv/lib/*.sh` files.
 
 Hopefully this is enough to get you started.
 
+FILES
+-----
+
+$XDG_CONFIG_HOME/direnv/direnvrc
+: `direnv` configuration
+
+$XDG_CONFIG_HOME/direnv/lib/*.sh
+: Third-party extensions to direnv-stdlib.
+
+$XDG_DATA_HOME/direnv/allow
+: Records which `.envrc` files have been `direnv allow`ed.
+
 CONTRIBUTE
 ----------