Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

man: clarify paths #929

Merged
merged 1 commit into from Apr 14, 2022
Merged

man: clarify paths #929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 14 additions & 5 deletions man/direnv.1
View file
Open in desktop
Expand Up @@ -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
Expand Down
19 changes: 14 additions & 5 deletions man/direnv.1.md
View file
Open in desktop
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/direnv.toml.1
View file
Open in desktop
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/direnv.toml.1.md
View file
Open in desktop
Expand Up @@ -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

Expand Down