[Fix #104] Add documentation for environment

modules/environment/README.md

@@ -0,0 +1,26 @@
+Environment
+===========
+
+Sets general shell options and defines environment variables.
+
+This module must be loaded first.
+
+Environment Variables
+---------------------
+
+Contributors
+------------
+
+This module **MUST NOT** rely on any command not built in Zsh.
+
+Non-interactive environment variables should be defined in *zshenv*.
+
+Authors
+-------
+
+*The authors of this module should be contacted via the [issue tracker][1].*
+
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues
+

modules/environment/init.zsh

@@ -30,12 +30,12 @@ fi
 
 # Termcap
 if zstyle -t ':omz:environment:termcap' color; then
-  export LESS_TERMCAP_mb=$'\E[01;31m'      # begin blinking
+  export LESS_TERMCAP_mb=$'\E[01;31m'      # Begins blinking.
-  export LESS_TERMCAP_md=$'\E[01;31m'      # begin bold
+  export LESS_TERMCAP_md=$'\E[01;31m'      # Begins bold.
-  export LESS_TERMCAP_me=$'\E[0m'          # end mode
+  export LESS_TERMCAP_me=$'\E[0m'          # Ends mode.
-  export LESS_TERMCAP_se=$'\E[0m'          # end standout-mode
+  export LESS_TERMCAP_se=$'\E[0m'          # Ends standout-mode.
-  export LESS_TERMCAP_so=$'\E[00;47;30m'   # begin standout-mode
+  export LESS_TERMCAP_so=$'\E[00;47;30m'   # Begins standout-mode.
-  export LESS_TERMCAP_ue=$'\E[0m'          # end underline
+  export LESS_TERMCAP_ue=$'\E[0m'          # Ends underline.
-  export LESS_TERMCAP_us=$'\E[01;32m'      # begin underline
+  export LESS_TERMCAP_us=$'\E[01;32m'      # Begins underline.
 fi
 

templates/zshenv

@@ -12,17 +12,20 @@ export OMZ="$HOME/.oh-my-zsh"
 typeset -gU cdpath fpath mailpath manpath path
 typeset -gUT INFOPATH infopath
 
+# Set the the list of directories that cd searches.
 cdpath=(
   $HOME
   $cdpath
 )
 
+# Set the list of directories that info searches for manuals.
 infopath=(
   /usr/local/share/info
   /usr/share/info
   $infopath
 )
 
+# Set the list of directories that man searches for manuals.
 manpath=(
   /usr/local/share/man
   /usr/share/man
@@ -34,6 +37,7 @@ for path_file in /etc/manpaths.d/*(.N); do
 done
 unset path_file
 
+# Set the list of directories that Zsh searches for programs.
 path=(
   /usr/local/{bin,sbin}
   /usr/{bin,sbin}
@@ -66,10 +70,12 @@ export LESSCHARSET="UTF-8"
 export LESSHISTFILE='-'
 export LESSEDIT='vim ?lm+%lm. %f'
 
+# Set the default Less options.
 # Mouse-wheel scrolling has been disabled by -X (disable screen clearing).
 # Remove -X and -F (exit if the content fits on one screen) to enable it.
 export LESS='-F -g -i -M -R -S -w -X -z-4'
 
+# Set the Less input preprocessor.
 if (( $+commands[lesspipe.sh] )); then
   export LESSOPEN='| /usr/bin/env lesspipe.sh %s 2>&-'
 fi