1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-23 01:17:59 +00:00
prezto/modules/environment/README.md
Indrajit Raychaudhuri 1ff9421f7b general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.

Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.

While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
2021-05-21 12:31:02 -05:00

1.5 KiB

Environment

Sets general shell options and defines environment variables.

This module must be loaded first.

Contributors

This module MUST NOT rely on any command that is not built in Zsh.

Non-interactive environment variables should be defined in ${ZDOTDIR:-$HOME}/.zshenv.

Options

General

  • COMBINING_CHARS combine zero-length punctuation characters (accents) with the base character.
  • INTERACTIVE_COMMENTS enable comments in interactive shell.
  • RC_QUOTES allow 'Henry''s Garage' instead of 'Henry'''s Garage'.
  • MAIL_WARNING don't print a warning message if a mail file has been accessed.

Jobs

  • LONG_LIST_JOBS list jobs in the long format by default.
  • AUTO_RESUME attempt to resume existing job before creating a new process.
  • NOTIFY report status of background jobs immediately.
  • BG_NICE don't run all background jobs at a lower priority.
  • HUP don't kill jobs on shell exit.
  • CHECK_JOBS don't report on jobs when shell exit.

Variables

Termcap

  • LESS_TERMCAP_mb begins blinking.
  • LESS_TERMCAP_md begins bold.
  • LESS_TERMCAP_me ends mode.
  • LESS_TERMCAP_se ends standout-mode.
  • LESS_TERMCAP_so begins standout-mode.
  • LESS_TERMCAP_ue ends underline.
  • LESS_TERMCAP_us begins underline.

Authors

The authors of this module should be contacted via the issue tracker.