From d7d85f517a47220cc80f28775b189ec87b0573b8 Mon Sep 17 00:00:00 2001 From: Sorin Ionescu Date: Tue, 25 Sep 2012 00:42:03 -0400 Subject: [PATCH] [Fix #289] Describe all modules in a README --- modules/README.md | 170 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 modules/README.md diff --git a/modules/README.md b/modules/README.md new file mode 100644 index 0000000..9e048d2 --- /dev/null +++ b/modules/README.md @@ -0,0 +1,170 @@ +Modules +======= + +Load modules in *zpreztorc*. The order matters. + + zstyle ':prezto:load' pmodule 'environment' 'terminal' + +Archive +------- + +Provides functions to extract and list popular archive formats. + +Command-Not-Found +----------------- + +Loads the command-not-found tool on Debian-based distributions. + +Completion +---------- + +Loads and configures tab completion and provides additional completions from +the zsh-completions project. + +Directory +--------- + +Sets directory options and defines directory aliases. + +Dpkg +---- + +Defines dpkg aliases and functions. + +Environment +----------- + +Sets general shell options and defines environment variables. + +GNU Utility +----------- + +Provides for the interactive use of GNU utilities on non-GNU systems. + +GPG-Agent +--------- + +Provides for an easier use of gpg-agent. + +Haskell +------- + +Enables local Haskell package installation. + +Helper +------ + +Provides helper functions for developing modules. + +History Substring Search +------------------------ + +Integrates zsh-history-substring-search into Prezto. + +History +------- + +Sets history options and defines history aliases. + +Macports +-------- + +Defines MacPorts aliases and adds MacPorts directories to path variables. + +Node.js +------- + +Provides utility functions for Node.js and loads npm completion. + +OSX +--- + +Defines Mac OS X aliases and functions. + +Pacman +------ + +Provides aliases and functions for the Pacman package manager and frontends. + +Perl +---- + +Enables local Perl module installation on Mac OS X and defines alises. + +Prompt +------ + +Loads prompt themes. + +Python +------ + +Enables local Python and local Python package installation. + +Ruby on Rails +------------- + +Defines Ruby on Rails aliases. + +Rsync +----- + +Defines rsync aliases. + +Ruby +---- + +Configures Ruby local gem installation, loads version managers, and defines +aliases. + +GNU Screen +---------- + +Defines GNU Screen aliases and provides for auto launching it at start-up. + +Spectrum +-------- + +Provides for easier use of 256 colors and effects. + +SSH-Agent +--------- + +Provides for an easier use of ssh-agent. + +Syntax Highlighting +------------------- + +Integrates zsh-syntax-highlighting into Prezto. + +Terminal +-------- + +Sets terminal window and tab titles. + +Tmux +---- + +Defines tmux aliases and provides for auto launching it at start-up. + +Utility +------- + +Defines general aliases and functions. + +Wake-on-LAN +----------- + +This module provides a wrapper around the wakeonlan tool. + +Yum +--- + +Defines yum aliases. + +Z +- + +Integrates z into Prezto, which maintains a frequently used directory list for +fast directory changes. +