diff --git a/README b/README index 179dce3..cdb66ad 100644 --- a/README +++ b/README @@ -58,6 +58,7 @@ NOTES Set $_Z_NO_PROMPT_COMMAND to handle PROMPT_COMMAND/precmd your- self. Set $_Z_EXCLUDE_DIRS to an array of directories to exclude. + Set $_Z_OWNER to allow usage when in 'sudo -s' mode. (These settings should go in .bashrc/.zshrc before the line added above.) Install the provided man page z.1 somewhere like @@ -120,9 +121,12 @@ ENVIRONMENT directories to exclude from tracking. $HOME is always excluded. Direc- tories must be full paths without trailing slashes. + The environment variable $_Z_OWNER can be set to your username, to + allow usage of z when your sudo enviroment keeps $HOME set. + FILES - Data is stored in $HOME/.z. This can be overridden by setting the - $_Z_DATA environment variable. When initialized, z will raise an error + Data is stored in $HOME/.z. This can be overridden by setting the + $_Z_DATA environment variable. When initialized, z will raise an error if this path is a directory, and not function correctly. A man page (z.1) is provided. diff --git a/z.1 b/z.1 index 97459de..b331b14 100644 --- a/z.1 +++ b/z.1 @@ -82,6 +82,9 @@ Set \fB$_Z_NO_PROMPT_COMMAND\fR to handle \fBPROMPT_COMMAND/precmd\fR yourself. Set \fB$_Z_EXCLUDE_DIRS\fR to an array of directories to exclude. .RE .RS +Set \fB$_Z_OWNER\fR to allow usage when in 'sudo -s' mode. +.RE +.RS (These settings should go in .bashrc/.zshrc before the line added above.) .RE .RS @@ -144,6 +147,9 @@ handle \fBPROMPT_COMMAND\fR or \fBprecmd\fR yourself. The environment variable \fB$_Z_EXCLUDE_DIRS\fR can be set to an array of directories to exclude from tracking. \fB$HOME\fR is always excluded. Directories must be full paths without trailing slashes. +.P +The environment variable \fB$_Z_OWNER\fR can be set to your username, to +allow usage of \fBz\fR when your sudo enviroment keeps \fB$HOME\fR set. .SH FILES Data is stored in \fB$HOME/.z\fR. This can be overridden by setting the