Browse Source

general: Miscellaneous documentation updates

- Add missing documentation for options and environment variables
- Rearrange definition and documentation of 'Options', 'Variables'
  and 'Aliases' in a consistent order
master
Indrajit Raychaudhuri 6 years ago
parent
commit
3fc54bf88a
  1. 13
      modules/completion/README.md
  2. 2
      modules/completion/init.zsh
  3. 12
      modules/editor/README.md
  4. 34
      modules/environment/README.md
  5. 14
      modules/history/README.md
  6. 16
      modules/history/init.zsh
  7. 6
      modules/homebrew/README.md
  8. 2
      modules/homebrew/init.zsh
  9. 3
      modules/rsync/init.zsh
  10. 2
      runcoms/README.md

13
modules/completion/README.md

@ -6,6 +6,19 @@ the [zsh-completions][1] project. @@ -6,6 +6,19 @@ the [zsh-completions][1] project.
This module must be loaded **after** the *utility* module.
Options
-------
- `COMPLETE_IN_WORD` complete from both ends of a word.
- `ALWAYS_TO_END` move cursor to the end of a completed word.
- `PATH_DIRS` perform path search even on command names with slashes.
- `AUTO_MENU` show completion menu on a successive tab press.
- `AUTO_LIST` automatically list choices on ambiguous completion.
- `AUTO_PARAM_SLASH` if completed parameter is a directory, add a trailing slash.
- `EXTENDED_GLOB` needed for file modification glob modifiers with compinit.
- `MENU_COMPLETE` do not autoselect the first completion entry.
- `FLOW_CONTROL` disable start/stop characters in shell editor.
Settings
--------

2
modules/completion/init.zsh

@ -99,7 +99,7 @@ zstyle ':completion:*:history-words' remove-all-dups yes @@ -99,7 +99,7 @@ zstyle ':completion:*:history-words' remove-all-dups yes
zstyle ':completion:*:history-words' list false
zstyle ':completion:*:history-words' menu yes
# Environmental Variables
# Environment Variables
zstyle ':completion::*:(-command-|export):*' fake-parameters ${${${_comps[(I)-value-*]#*,}%%,*}:#-*-}
# Populate hostname completion. But allow ignoring custom entries from static

12
modules/editor/README.md

@ -1,7 +1,17 @@ @@ -1,7 +1,17 @@
Editor
======
Sets key bindings.
Sets editor specific key bindings options and variables.
Options
-------
- `BEEP` beep on error in line editor.
Variables
---------
- `WORDCHARS` treat a given set of characters as part of a word.
Settings
--------

34
modules/environment/README.md

@ -5,8 +5,38 @@ Sets general shell options and defines environment variables. @@ -5,8 +5,38 @@ Sets general shell options and defines environment variables.
This module must be loaded first.
Environment Variables
---------------------
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.
Contributors
------------

14
modules/history/README.md

@ -3,13 +3,6 @@ History @@ -3,13 +3,6 @@ History
Sets [history][1] options and defines history aliases.
Variables
---------
- `HISTFILE` stores the path to the history file.
- `HISTSIZE` stores the maximum number of events to save in the internal history.
- `SAVEHIST` stores the maximum number of events to save in the history file.
Options
-------
@ -26,6 +19,13 @@ Options @@ -26,6 +19,13 @@ Options
- `HIST_VERIFY` does not execute immediately upon history expansion.
- `HIST_BEEP` beeps when accessing non-existent history.
Variables
---------
- `HISTFILE` stores the path to the history file.
- `HISTSIZE` stores the maximum number of events to save in the internal history.
- `SAVEHIST` stores the maximum number of events to save in the history file.
Aliases
-------

16
modules/history/init.zsh

@ -6,14 +6,6 @@ @@ -6,14 +6,6 @@
# Sorin Ionescu <sorin.ionescu@gmail.com>
#
#
# Variables
#
HISTFILE="${ZDOTDIR:-$HOME}/.zhistory" # The path to the history file.
HISTSIZE=10000 # The maximum number of events to save in the internal history.
SAVEHIST=10000 # The maximum number of events to save in the history file.
#
# Options
#
@ -31,6 +23,14 @@ setopt HIST_SAVE_NO_DUPS # Do not write a duplicate event to the history @@ -31,6 +23,14 @@ setopt HIST_SAVE_NO_DUPS # Do not write a duplicate event to the history
setopt HIST_VERIFY # Do not execute immediately upon history expansion.
setopt HIST_BEEP # Beep when accessing non-existent history.
#
# Variables
#
HISTFILE="${ZDOTDIR:-$HOME}/.zhistory" # The path to the history file.
HISTSIZE=10000 # The maximum number of events to save in the internal history.
SAVEHIST=10000 # The maximum number of events to save in the history file.
#
# Aliases
#

6
modules/homebrew/README.md

@ -1,10 +1,10 @@ @@ -1,10 +1,10 @@
Homebrew
========
Defines Homebrew specific shell environment variables and aliases.
Defines Homebrew specific environment variables and aliases.
Environment Variables
---------------------
Variables
---------
Execute the following to list the environment variables loaded in the shell:

2
modules/homebrew/init.zsh

@ -11,7 +11,7 @@ if [[ "$OSTYPE" != (darwin|linux)* ]]; then @@ -11,7 +11,7 @@ if [[ "$OSTYPE" != (darwin|linux)* ]]; then
fi
#
# Environmental Variables
# Variables
#
# Load standard Homebrew shellenv into the shell session.

3
modules/rsync/init.zsh

@ -14,7 +14,8 @@ fi @@ -14,7 +14,8 @@ fi
# Aliases
#
_rsync_cmd='rsync --verbose --progress --human-readable --compress --archive --hard-links --one-file-system'
_rsync_cmd='rsync --verbose --progress --human-readable --compress --archive \
--hard-links --one-file-system'
if grep -q 'xattrs' <(rsync --help 2>&1); then
_rsync_cmd="${_rsync_cmd} --acls --xattrs"

2
runcoms/README.md

@ -10,7 +10,7 @@ in */etc* by default. @@ -10,7 +10,7 @@ in */etc* by default.
User-local configuration files have the same name as their global counterparts
but are prefixed with a dot (hidden). Zsh looks for these files in the path
stored in the `$ZDOTDIR` environmental variable. However, if said variable is
stored in the `$ZDOTDIR` environment variable. However, if said variable is
not defined, Zsh will use the user's home directory.
File Descriptions

Loading…
Cancel
Save