From 87bbbca9bd79cc531ff8b520f22f196c107c5686 Mon Sep 17 00:00:00 2001 From: Sorin Ionescu Date: Tue, 11 Sep 2012 10:47:06 -0400 Subject: [PATCH] Add man pages --- documentation/man/man1/prezto-archive.1 | 55 +++++ .../man/man1/prezto-command-not-found.1 | 17 ++ documentation/man/man1/prezto-completion.1 | 27 ++ documentation/man/man1/prezto-directory.1 | 49 ++++ documentation/man/man1/prezto-dpkg.1 | 63 +++++ documentation/man/man1/prezto-environment.1 | 22 ++ documentation/man/man1/prezto-gnu-utility.1 | 31 +++ documentation/man/man1/prezto-gpg-agent.1 | 20 ++ documentation/man/man1/prezto-haskell.1 | 27 ++ documentation/man/man1/prezto-helper.1 | 29 +++ .../man1/prezto-history-substring-search.1 | 55 +++++ documentation/man/man1/prezto-history.1 | 62 +++++ documentation/man/man1/prezto-macports.1 | 35 +++ documentation/man/man1/prezto-node.1 | 29 +++ documentation/man/man1/prezto-osx.1 | 48 ++++ documentation/man/man1/prezto-pacman.1 | 84 +++++++ documentation/man/man1/prezto-perl.1 | 74 ++++++ documentation/man/man1/prezto-prompt.1 | 108 ++++++++ documentation/man/man1/prezto-python.1 | 119 +++++++++ documentation/man/man1/prezto-rails.1 | 56 +++++ documentation/man/man1/prezto-rsync.1 | 34 +++ documentation/man/man1/prezto-ruby.1 | 97 ++++++++ documentation/man/man1/prezto-screen.1 | 37 +++ documentation/man/man1/prezto-spectrum.1 | 145 +++++++++++ documentation/man/man1/prezto-ssh-agent.1 | 53 ++++ .../man/man1/prezto-syntax-highlighting.1 | 53 ++++ documentation/man/man1/prezto-terminal.1 | 26 ++ documentation/man/man1/prezto-tmux.1 | 61 +++++ documentation/man/man1/prezto-utility.1 | 233 ++++++++++++++++++ documentation/man/man1/prezto-wakeonlan.1 | 43 ++++ documentation/man/man1/prezto-yum.1 | 40 +++ documentation/man/man1/prezto-z.1 | 23 ++ documentation/man/man1/prezto.1 | 199 +++++++++++++++ 33 files changed, 2054 insertions(+) create mode 100644 documentation/man/man1/prezto-archive.1 create mode 100644 documentation/man/man1/prezto-command-not-found.1 create mode 100644 documentation/man/man1/prezto-completion.1 create mode 100644 documentation/man/man1/prezto-directory.1 create mode 100644 documentation/man/man1/prezto-dpkg.1 create mode 100644 documentation/man/man1/prezto-environment.1 create mode 100644 documentation/man/man1/prezto-gnu-utility.1 create mode 100644 documentation/man/man1/prezto-gpg-agent.1 create mode 100644 documentation/man/man1/prezto-haskell.1 create mode 100644 documentation/man/man1/prezto-helper.1 create mode 100644 documentation/man/man1/prezto-history-substring-search.1 create mode 100644 documentation/man/man1/prezto-history.1 create mode 100644 documentation/man/man1/prezto-macports.1 create mode 100644 documentation/man/man1/prezto-node.1 create mode 100644 documentation/man/man1/prezto-osx.1 create mode 100644 documentation/man/man1/prezto-pacman.1 create mode 100644 documentation/man/man1/prezto-perl.1 create mode 100644 documentation/man/man1/prezto-prompt.1 create mode 100644 documentation/man/man1/prezto-python.1 create mode 100644 documentation/man/man1/prezto-rails.1 create mode 100644 documentation/man/man1/prezto-rsync.1 create mode 100644 documentation/man/man1/prezto-ruby.1 create mode 100644 documentation/man/man1/prezto-screen.1 create mode 100644 documentation/man/man1/prezto-spectrum.1 create mode 100644 documentation/man/man1/prezto-ssh-agent.1 create mode 100644 documentation/man/man1/prezto-syntax-highlighting.1 create mode 100644 documentation/man/man1/prezto-terminal.1 create mode 100644 documentation/man/man1/prezto-tmux.1 create mode 100644 documentation/man/man1/prezto-utility.1 create mode 100644 documentation/man/man1/prezto-wakeonlan.1 create mode 100644 documentation/man/man1/prezto-yum.1 create mode 100644 documentation/man/man1/prezto-z.1 create mode 100644 documentation/man/man1/prezto.1 diff --git a/documentation/man/man1/prezto-archive.1 b/documentation/man/man1/prezto-archive.1 new file mode 100644 index 00000000..54e628cc --- /dev/null +++ b/documentation/man/man1/prezto-archive.1 @@ -0,0 +1,55 @@ +.TH Archive +.PP +Provides functions to extract and list popular archive formats. +.SH Functions +.RS +.IP \(bu 2 +\fB\fCextract\fR extracts the contents of one or more archives. +.IP \(bu 2 +\fB\fCls-archive\fR lists the contents of one or more archives. +.RE +.SH Supported Formats +.PP +The following archive formats are supported when the required utilities are +installed: +.RS +.IP \(bu 2 +\fI.tar.gz\fP, \fI.tgz\fP require \fB\fCtar\fR. +.IP \(bu 2 +\fI.tar.bz2\fP, \fI.tbz\fP require \fB\fCtar\fR. +.IP \(bu 2 +\fI.tar.xz\fP, \fI.txz\fP require \fB\fCtar\fR with \fIxz\fP support. +.IP \(bu 2 +\fI.tar.zma\fP, \fI.tlz\fP require \fB\fCtar\fR with \fIlzma\fP support. +.IP \(bu 2 +\fI.tar\fP requires \fB\fCtar\fR. +.IP \(bu 2 +\fI.gz\fP requires \fB\fCgunzip\fR. +.IP \(bu 2 +\fI.bz2\fP requires \fB\fCbunzip2\fR. +.IP \(bu 2 +\fI.xz\fP requires \fB\fCunxz\fR. +.IP \(bu 2 +\fI.lzma\fP requires \fB\fCunlzma\fR. +.IP \(bu 2 +\fI.Z\fP requires \fB\fCuncompress\fR. +.IP \(bu 2 +\fI.zip\fP requires \fB\fCunzip\fR. +.IP \(bu 2 +\fI.rar\fP requires \fB\fCunrar\fR. +.IP \(bu 2 +\fI.7z\fP requires \fB\fC7za\fR. +.IP \(bu 2 +\fI.deb\fP requires \fB\fCar\fR, \fB\fCtar\fR. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-command-not-found.1 b/documentation/man/man1/prezto-command-not-found.1 new file mode 100644 index 00000000..67e49775 --- /dev/null +++ b/documentation/man/man1/prezto-command-not-found.1 @@ -0,0 +1,17 @@ +.TH Command\-Not\-Found +.PP +Loads the command\-not\-found +.UR https://code.launchpad.net/command-not-found +.UE +tool on Debian\-based distributions. +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Joseph Booker +.UR https://github.com/sargas +.UE +.RE diff --git a/documentation/man/man1/prezto-completion.1 b/documentation/man/man1/prezto-completion.1 new file mode 100644 index 00000000..de8c166c --- /dev/null +++ b/documentation/man/man1/prezto-completion.1 @@ -0,0 +1,27 @@ +.TH Completion +.PP +Loads and configures tab completion and provides additional completions from +the zsh\-completions +.UR https://github.com/zsh-users/zsh-completions +.UE +project. +.PP +This module must be loaded \fBafter\fP the \fIutility\fP module. +.SH Contributors +.PP +Completions should be submitted to the zsh\-completions +.UR https://github.com/zsh-users/zsh-completions +.UE +project according +to its rules and regulations. This module will be synchronized against it. +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-directory.1 b/documentation/man/man1/prezto-directory.1 new file mode 100644 index 00000000..adead51a --- /dev/null +++ b/documentation/man/man1/prezto-directory.1 @@ -0,0 +1,49 @@ +.TH Directory +.PP +Sets directory options and defines directory aliases. +.SH Options +.RS +.IP \(bu 2 +\fB\fCAUTO_CD\fR auto changes to a directory without typing \fB\fCcd\fR. +.IP \(bu 2 +\fB\fCAUTO_PUSHD\fR pushes the old directory onto the stack on \fB\fCcd\fR. +.IP \(bu 2 +\fB\fCPUSHD_IGNORE_DUPS\fR does not store duplicates in the stack. +.IP \(bu 2 +\fB\fCPUSHD_SILENT\fR does not print the directory stack after \fB\fCpushd\fR or \fB\fCpopd\fR. +.IP \(bu 2 +\fB\fCPUSHD_TO_HOME\fR pushes to the home directory when no argument is given. +.IP \(bu 2 +\fB\fCCDABLE_VARS\fR changes directory to a path stored in a variable. +.IP \(bu 2 +\fB\fCAUTO_NAME_DIRS\fR auto adds variable\-stored paths to \fB\fC~\fR list. +.IP \(bu 2 +\fB\fCMULTIOS\fR writes to multiple descriptors. +.IP \(bu 2 +\fB\fCEXTENDED_GLOB\fR uses extended globbing syntax. +.IP \(bu 2 +\fB\fCCLOBBER\fR does not overwrite existing files with \fB\fC>\fR and \fB\fC>>\fR. Use \fB\fC>!\fR and +\fB\fC>>!\fR to bypass. +.RE +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCd\fR prints the contents of the directory stack. +.IP \(bu 2 +\fB\fC1 ... 9\fR changes the directory to the \fBn\fP previous one. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +James Cox +.UR https://github.com/imajes +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-dpkg.1 b/documentation/man/man1/prezto-dpkg.1 new file mode 100644 index 00000000..bad0a2ae --- /dev/null +++ b/documentation/man/man1/prezto-dpkg.1 @@ -0,0 +1,63 @@ +.TH Dpkg +.PP +Defines dpkg +.UR http://wiki.debian.org/Teams/Dpkg +.UE +aliases and functions. +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCdebc\fR cleans the cache. +.IP \(bu 2 +\fB\fCdebf\fR displays a file's packake. +.IP \(bu 2 +\fB\fCdebi\fR installs packages from repositories. +.IP \(bu 2 +\fB\fCdebI\fR installs packages from files. +.IP \(bu 2 +\fB\fCdebq\fR displays package information. +.IP \(bu 2 +\fB\fCdebu\fR updates the packages lists. +.IP \(bu 2 +\fB\fCdebU\fR upgrades outdated packages. +.IP \(bu 2 +\fB\fCdebx\fR removes packages. +.IP \(bu 2 +\fB\fCdebX\fR removes packages, their configuration, and unneeded dependencies. +.IP \(bu 2 +\fB\fCdebs\fR searches for packages. +.IP \(bu 2 +\fB\fCdeb-build\fR creates a basic .deb package. +.IP \(bu 2 +\fB\fCdeb-kclean\fR removes all kernel images and headers, except for the ones in +use. +.RE +.SH Functions +.RS +.IP \(bu 2 +\fB\fCdeb-clone\fR generates a script that can be used to duplicate a dpkg\-based +system. +.IP \(bu 2 +\fB\fCdeb-history\fR displays dpkg history. +.IP \(bu 2 +\fB\fCdeb-kbuild\fR makes a dpkg Linux kernel package. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Daniel Bolton +.UR https://github.com/dbb +.UE +.IP \(bu 2 +Benjamin Boudreau +.UR https://github.com/dreur +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-environment.1 b/documentation/man/man1/prezto-environment.1 new file mode 100644 index 00000000..71a6786f --- /dev/null +++ b/documentation/man/man1/prezto-environment.1 @@ -0,0 +1,22 @@ +.TH Environment +.PP +Sets general shell options and defines environment variables. +.PP +This module must be loaded first. +.SH Environment Variables +.SH Contributors +.PP +This module \fBMUST NOT\fP rely on any command not built in Zsh. +.PP +Non\-interactive environment variables should be defined in \fIzshenv\fP. +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-gnu-utility.1 b/documentation/man/man1/prezto-gnu-utility.1 new file mode 100644 index 00000000..82caab4d --- /dev/null +++ b/documentation/man/man1/prezto-gnu-utility.1 @@ -0,0 +1,31 @@ +.TH GNU Utility +.PP +Provides for the interactive use of GNU utilities on non\-GNU systems. +.PP +Installing GNU utilities on non\-GNU systems in \fB\fC$PATH\fR without a prefix, i.e. +\fB\fCls\fR instead of \fB\fCgls\fR, is not recommended since scripts that target other +utilities will be broken. +.PP +However, for interactive use, prefixed commands can be wrapped in their +non\-prefixed counterparts. +.PP +This module must be loaded \fBbefore\fP the \fIutility\fP module. +.SH Settings +.SS Prefix +.PP +To use a different prefix, add the following to \fIzpreztorc\fP, and replace 'g' with +the desired prefix: +.nf +zstyle ':prezto:module:gnu-utility' prefix 'g' +.fi +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-gpg-agent.1 b/documentation/man/man1/prezto-gpg-agent.1 new file mode 100644 index 00000000..8142269c --- /dev/null +++ b/documentation/man/man1/prezto-gpg-agent.1 @@ -0,0 +1,20 @@ +.TH GPG\-Agent +.PP +Provides for an easier use of gpg\-agent +.UR http://linux.die.net/man/1/gpg-agent +.UE . +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Florian Walch +.UR https://github.com/fwalch +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-haskell.1 b/documentation/man/man1/prezto-haskell.1 new file mode 100644 index 00000000..5281cdaf --- /dev/null +++ b/documentation/man/man1/prezto-haskell.1 @@ -0,0 +1,27 @@ +.TH Haskell +.PP +Enables local Haskell package installation. +.SH Per\-user Package Installation +.PP +Cabal +.UR http://www.haskell.org/cabal/ +.UE , the Haskell package manager, can install packages into per user +directories. +.PP +This module prepends per user directories to the relevant path variables to +enable the execution of user installed executables and the reading of +documentation. +.SS Usage +.PP +Install packages into per user directories with \fB\fCcabal install --user\fR. +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sebastian Wiesner +.UR https://github.com/lunaryorn +.UE +.RE diff --git a/documentation/man/man1/prezto-helper.1 b/documentation/man/man1/prezto-helper.1 new file mode 100644 index 00000000..6a3f02fb --- /dev/null +++ b/documentation/man/man1/prezto-helper.1 @@ -0,0 +1,29 @@ +.TH Helper +.PP +Provides helper functions for developing modules. +.SH Functions +.RS +.IP \(bu 2 +\fB\fCadd-zsh-trap\fR adds a function name to a list to be called when a trap is +triggered. +.IP \(bu 2 +\fB\fCis-autoloadable\fR checks if a file can be autoloaded by trying to load it +in a subshell. +.IP \(bu 2 +\fB\fCis-callable\fR checks if a name is a command, function, or alias. +.IP \(bu 2 +\fB\fCis-true\fR checks a boolean variable for "true". +.IP \(bu 2 +\fB\fCcoalesce\fR prints the first non\-empty string in the arguments array. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-history-substring-search.1 b/documentation/man/man1/prezto-history-substring-search.1 new file mode 100644 index 00000000..571b8fd5 --- /dev/null +++ b/documentation/man/man1/prezto-history-substring-search.1 @@ -0,0 +1,55 @@ +.TH History Substring Search +.PP +Integrates zsh\-history\-substring\-search +.UR https://github.com/zsh-users/zsh-history-substring-search +.UE +into Prezto, which implements +the Fish shell +.UR http://fishshell.com +.UE 's history search feature, where the user can type in any +part of a previously entered command and press up and down to cycle through +matching commands. +.PP +If this module is used in conjuncture with the \fIsyntax\-highlighting\fP module, it +must be loaded \fBafter\fP it. +.SH Contributors +.PP +New features and bug fixes should be submitted to the +zsh\-history\-substring\-search +.UR https://github.com/zsh-users/zsh-history-substring-search +.UE +project according to its rules and +regulations. This module will be synchronized against it. +.SH Settings +.SS Case Sensitivity +.PP +To enable case\-sensitivity for this module only, add the following line to +\fIzpreztorc\fP: +.nf +zstyle ':prezto:module:history-substring-search' case-sensitive 'yes' +.fi +.SS Highlighting +.PP +If colors are enabled, \fIhistory\-substring\-search\fP will automatically highlight +positive results. +.PP +To enable highlighting for this module only, add the following line to +\fIzpreztorc\fP: +.nf +zstyle ':prezto:module:history-substring-search' color 'yes' +.fi +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Suraj N. Kurapati +.UR https://github.com/sunaku +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-history.1 b/documentation/man/man1/prezto-history.1 new file mode 100644 index 00000000..99e57d92 --- /dev/null +++ b/documentation/man/man1/prezto-history.1 @@ -0,0 +1,62 @@ +.TH History +.PP +Sets history +.UR http://zsh.sourceforge.net/Guide/zshguide02.html#l16 +.UE +options and defines history aliases. +.SH Variables +.RS +.IP \(bu 2 +\fB\fCHISTFILE\fR stores the path to the history file. +.IP \(bu 2 +\fB\fCHISTSIZE\fR stores the maximum number of events to save in the internal history. +.IP \(bu 2 +\fB\fCSAVEHIST\fR stores the maximum number of events to save in the history file. +.RE +.SH Options +.RS +.IP \(bu 2 +\fB\fCBANG_HIST\fR treats the \fB!\fP character specially during expansion. +.IP \(bu 2 +\fB\fCEXTENDED_HISTORY\fR writes the history file in the \fI:start:elapsed;command\fP format. +.IP \(bu 2 +\fB\fCINC_APPEND_HISTORY\fR writes to the history file immediately, not when the shell exits. +.IP \(bu 2 +\fB\fCSHARE_HISTORY\fR shares history between all sessions. +.IP \(bu 2 +\fB\fCHIST_EXPIRE_DUPS_FIRST\fR expires a duplicate event first when trimming history. +.IP \(bu 2 +\fB\fCHIST_IGNORE_DUPS\fR does not record an event that was just recorded again. +.IP \(bu 2 +\fB\fCHIST_IGNORE_ALL_DUPS\fR deletes an old recorded event if a new event is a duplicate. +.IP \(bu 2 +\fB\fCHIST_FIND_NO_DUPS\fR does not display a previously found event. +.IP \(bu 2 +\fB\fCHIST_IGNORE_SPACE\fR does not record an event starting with a space. +.IP \(bu 2 +\fB\fCHIST_SAVE_NO_DUPS\fR does not write a duplicate event to the history file. +.IP \(bu 2 +\fB\fCHIST_VERIFY\fR does not execute immediately upon history expansion. +.IP \(bu 2 +\fB\fCHIST_BEEP\fR beeps when accessing non\-existent history. +.RE +.SH Aliases +.RS +.IP \(bu 2 +\fB\fChistory-stat\fR lists the ten most used commands +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Robby Russell +.UR https://github.com/robbyrussell +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-macports.1 b/documentation/man/man1/prezto-macports.1 new file mode 100644 index 00000000..920fc890 --- /dev/null +++ b/documentation/man/man1/prezto-macports.1 @@ -0,0 +1,35 @@ +.TH Macports +.PP +Defines MacPorts aliases and adds MacPorts directories to path variables. +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCportc\fR cleans the files used to build ports. +.IP \(bu 2 +\fB\fCporti\fR installs a port. +.IP \(bu 2 +\fB\fCports\fR searches for a port. +.IP \(bu 2 +\fB\fCportu\fR upgrades a port. +.IP \(bu 2 +\fB\fCportU\fR upgrades MacPorts, the ports collection, and outdated ports. +.IP \(bu 2 +\fB\fCportx\fR uninstalls a port. +.IP \(bu 2 +\fB\fCportX\fR uninstalls inactive ports. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Matt Cable +.UR https://github.com/curiousstranger +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-node.1 b/documentation/man/man1/prezto-node.1 new file mode 100644 index 00000000..7aff09fb --- /dev/null +++ b/documentation/man/man1/prezto-node.1 @@ -0,0 +1,29 @@ +.TH Node.js +.PP +Provides utility functions for Node.js +.UR http://nodejs.org +.UE +and loads npm +.UR http://npmjs.org +.UE +completion. +.SH Functions +.RS +.IP \(bu 2 +\fB\fCnode-doc\fR opens the Node.js online API documentation +.UR http://nodejs.org/api +.UE +in the default +browser. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-osx.1 b/documentation/man/man1/prezto-osx.1 new file mode 100644 index 00000000..26852f51 --- /dev/null +++ b/documentation/man/man1/prezto-osx.1 @@ -0,0 +1,48 @@ +.TH OSX +.PP +Defines Mac OS X +.UR http://www.apple.com/macosx/ +.UE +aliases and functions. +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCcdf\fR changes the current working director to the current \fIFinder\fP +directory. +.IP \(bu 2 +\fB\fCpushdf\fR pushes the current working directory onto the directory queue and +.IP \(bu 2 +\fB\fCql\fR quick looks at files. +.IP \(bu 2 +\fB\fCrm-osx-cruft\fR deletes .DS_Store, __MACOSX cruft. +.RE +.SH Functions +.RS +.IP \(bu 2 +\fB\fCmanb\fR opens \fIman\fP pages in \fIBwana.app\fP +.UR http://bruji.com/bwana/ +.UE . +.IP \(bu 2 +\fB\fCmanp\fR opens \fIman\fP pages in \fIPreview.app\fP. +.IP \(bu 2 +\fB\fCpfd\fR prints the current \fIFinder\fP directory. +.IP \(bu 2 +\fB\fCpfs\fR prints the current \fIFinder\fP selection. +.IP \(bu 2 +\fB\fCtab\fR creates a new tab (works in both \fITerminal\fP and \fIiTerm\fP +.UR http://www.iterm2.com/ +.UE ). +.IP \(bu 2 +\fB\fCtrash\fR moves files and folders to \fITrash\fP. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-pacman.1 b/documentation/man/man1/prezto-pacman.1 new file mode 100644 index 00000000..bd48fe7e --- /dev/null +++ b/documentation/man/man1/prezto-pacman.1 @@ -0,0 +1,84 @@ +.TH Pacman +.PP +Provides aliases and functions for the Pacman +.UR http://www.archlinux.org/pacman/ +.UE +package manager and +frontends. +.SH Settings +.PP +To enable a Pacman frontend, for example, Yaourt +.UR http://archlinux.fr/yaourt-en +.UE , add the following line to +\fIzpreztorc\fP: +.nf +zstyle ':prezto:module:pacman' frontend 'yaourt' +.fi +.PP +If you have enabled color globally in \fIzpreztorc\fP, you may disable it for certain +commands. +.PP +To disable \fB\fCyaourt\fR highlighting, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:pacman:yaourt' color 'no' +.fi +.SH Aliases +.SS Pacman +.RS +.IP \(bu 2 +\fB\fCpac\fR is short for \fB\fCpacman\fR. +.IP \(bu 2 +\fB\fCpaci\fR installs packages from repositories. +.IP \(bu 2 +\fB\fCpacI\fR installs packages from files. +.IP \(bu 2 +\fB\fCpacx\fR removes packages and unneeded dependencies. +.IP \(bu 2 +\fB\fCpacX\fR removes packages, their configuration, and unneeded dependencies. +.IP \(bu 2 +\fB\fCpacq\fR displays information about a package from the repositories. +.IP \(bu 2 +\fB\fCpacQ\fR displays information about a package from the local database. +.IP \(bu 2 +\fB\fCpacs\fR searches for packages in the repositories. +.IP \(bu 2 +\fB\fCpacS\fR searches for packages in the local database. +.IP \(bu 2 +\fB\fCpacu\fR synchronizes the local package and Arch Build System (requires \fB\fCabs\fR) +databases against the repositories. +.IP \(bu 2 +\fB\fCpacU\fR synchronizes the local package database against the repositories then +upgrades outdated packages. +.IP \(bu 2 +\fB\fCpacman-list-orphans\fR lists orphan packages. +.IP \(bu 2 +\fB\fCpacman-remove-orphans\fR removes orphan packages. +.RE +.SS Frontends +.SS Yaourt +.RS +.IP \(bu 2 +\fB\fCpacc\fR manages \fI.pac\\fP* files. +.RE +.SH Functions +.RS +.IP \(bu 2 +\fB\fCpacman-list-explicit\fR lists explicitly installed pacman packages. +.IP \(bu 2 +\fB\fCpacman-list-disowned\fR lists pacman disowned files. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Benjamin Boudreau +.UR https://github.com/dreur +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-perl.1 b/documentation/man/man1/prezto-perl.1 new file mode 100644 index 00000000..97a6e97f --- /dev/null +++ b/documentation/man/man1/prezto-perl.1 @@ -0,0 +1,74 @@ +.TH Perl +.PP +Enables local Perl +.UR http://www.perl.org +.UE +module installation on Mac OS X and defines alises. +.SH Local Module Installation +.PP +Perl versions older than 5.14 do not support the local installation of Perl +modules natively. This module allows for local installation of Perl modules on +Mac OS X in \fI~/Library/Perl/5.12\fP by altering the environment. +.SS Usage +.PP +For Perl versions older than 5.14, install \fIlocal::lib\fP. +.nf +curl -L -C - -O http://search.cpan.org/CPAN/authors/id/A/AP/APEIRON/local-lib-1.008004.tar.gz +tar xvf local-lib-1.008004.tar.gz +cd local-lib-1.008004 +perl Makefile.PL --bootstrap=$HOME/Library/Perl/5.12 +make && make test && make install +.fi +.PP +Install \fIcpanminus\fP: +.nf +curl -L http://cpanmin.us | perl - --self-upgrade +.fi +.SH Perlbrew +.PP +An alternative to the above is to use Perlbrew +.UR http://perlbrew.pl +.UE , which allows for the +management of multiple, isolated Perl installations in the home directory. +.SH Aliases +.SS General +.RS +.IP \(bu 2 +\fB\fCpl\fR is short for \fB\fCperl\fR. +.IP \(bu 2 +\fB\fCpld\fR looks up Perl documentation (\fB\fCperldoc\fR). +.IP \(bu 2 +\fB\fCple\fR executes a one line program in a loop (\fB\fCperl -wlne\fR). +.RE +.SS Perlbrew +.RS +.IP \(bu 2 +\fB\fCplb\fR manages Perl environments. +.IP \(bu 2 +\fB\fCplba\fR lists available Perl versions. +.IP \(bu 2 +\fB\fCplbi\fR installs a Perl version. +.IP \(bu 2 +\fB\fCplbl\fR lists installed Perl versions. +.IP \(bu 2 +\fB\fCplbo\fR temporarily turns off Perlbrew. +.IP \(bu 2 +\fB\fCplbO\fR turns off Perlbrew. +.IP \(bu 2 +\fB\fCplbs\fR switches to a Perl version. +.IP \(bu 2 +\fB\fCplbu\fR uninstalls a Perl version. +.IP \(bu 2 +\fB\fCplbx\fR temporarily sets the Perl version to use. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-prompt.1 b/documentation/man/man1/prezto-prompt.1 new file mode 100644 index 00000000..b035d7aa --- /dev/null +++ b/documentation/man/man1/prezto-prompt.1 @@ -0,0 +1,108 @@ +.TH Prompt +.PP +Loads prompt themes +.UR http://zsh.sourceforge.net/Doc/Release/User-Contributions.html#Prompt-Themes +.UE . +.SH Settings +.PP +To select a prompt theme, add the following to \fIzpreztorc\fP, and replace \fBname\fP +with the name of the theme you wish to load. Setting it to \fBrandom\fP will load +a random theme. +.nf +zstyle ':prezto:module:prompt' theme 'name' +.fi +.SH Theming +.PP +A prompt theme is an autoloadable function file with a special name, +\fB\fCprompt_name_setup\fR, placed anywhere in \fB\fC$fpath\fR, but for the purpose of this +project, themes \fBshould\fP be placed in the \fImodules/prompt/functions\fP +directory. +.SS Theme Functions +.PP +There are three theme functions, a setup function, a help function, and +a preview function. The setup function \fBmust\fP always be defined. The help +function and the preview functions are optional. +.SS prompt_name_setup +.PP +This function is called by the \fB\fCprompt\fR function to install the theme. This +function may define other functions as necessary to maintain the prompt, +including a function that displays help or a function used to preview it. +.PP +\fBDo not call this function directly.\fP +.PP +The most basic example of this function can be seen bellow. +.nf +function prompt_name_setup { + PROMPT='%m%# ' + RPROMPT='' +} +.fi +.SS prompt_name_help +.PP +If the \fB\fCprompt_name_setup\fR function is customizable via parameters, a help +function \fBshould\fP be defined. The user will access it via \fB\fCprompt -h name\fR. +.PP +The most basic example of this function can be seen bellow. +.nf +function prompt_name_help { + cat <] [] +where the color is for the left-hand prompt. +EOH +} +.fi +.SS prompt_name_preview +.PP +If the \fB\fCprompt_name_setup\fR function is customizable via parameters, a preview +function \fBshould\fP be defined. The user will access it via \fB\fCprompt -p name\fR. +.PP +The most basic example of this function can be seen bellow. +.nf +function prompt_name_preview { + if (( $# > 0 )); then + prompt_preview_theme theme "$@" + else + prompt_preview_theme theme red green blue + print + prompt_preview_theme theme yellow magenta black + fi +} +.fi +.SS Hook Functions +.PP +There are many Zsh hook +.UR http://zsh.sourceforge.net/Doc/Release/Functions.html#Hook-Functions +.UE +functions, but mostly the \fIprecmd\fP hook will be +used. +.SS prompt_name_precmd +.PP +This hook is called before the prompt is displayed and is useful for getting +information to display in a prompt. +.PP +When calling functions to get information to display in a prompt, do not assume +that all the dependencies have been loaded. Always check for the availability of +a function before you calling it. +.PP +\fBDo not register hook functions. They will be registered by the \fB\fCprompt\fR function.\fP +.PP +The most basic example of this function can be seen bellow. +.nf +function prompt_name_precmd { + if (( $+functions[git-info] )); then + git-info + fi +} +.fi +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-python.1 b/documentation/man/man1/prezto-python.1 new file mode 100644 index 00000000..4cf5c07f --- /dev/null +++ b/documentation/man/man1/prezto-python.1 @@ -0,0 +1,119 @@ +.TH Python +.PP +Enables local Python and local Python package installation. +.SH Local Python Installation +.PP +pythonz +.UR http://saghul.github.com/pythonz/ +.UE +builds and installs multiple Python versions locally in the home +directory. +.PP +This module prepends the pythonz directory to the path variable to enable the +execution of \fB\fCpythonz\fR. +.SS Usage +.PP +Install Python versions with \fB\fCpythonz install\fR into \fI~/.pythonz/pythons\fP. +.SH Local Package Installation +.PP +Since version 2.6, Python supports per user package installation, as defined in +PEP 370 +.UR http://www.python.org/dev/peps/pep-0370/ +.UE . +.PP +This module prepends per user site directories to the relevant path variables +to enable the execution of user installed scripts and the reading of +documentation. +.SS Usage +.PP +Install packages into the per user site directory with \fB\fCeasy_install --user\fR or +\fB\fCpip install --user\fR. +.SH virtualenvwrapper +.PP +virtualenvwrapper +.UR http://www.doughellmann.com/projects/virtualenvwrapper/ +.UE +is a frontend to the popular virtualenv +.UR http://pypi.python.org/pypi/virtualenv +.UE +utility. +.PP +virtualenv creates isolated Python environments and virtualenvwrapper provides +convenient shell functions to create, switch, and manage them. +.SS Usage +.PP +Install virtualenvwrapper. +.PP +Virtual environments are stored in \fI~/.virtualenvs\fP. +.PP +There are configuration variables that have to be set to enable certain features. +If you wish to use these features, export the variables in \fI~/.zshenv\fP +.PP +The variable \fB\fC$PROJECT_HOME\fR tells virtualenvwrapper where to place project +working directories. It must be set and the directory created before \fB\fCmkproject\fR +is used. Replace \fIDeveloper\fP with your projects directory. +.nf +export PROJECT_HOME="$HOME/Developer" +.fi +.PP +The variable \fB\fC$VIRTUALENVWRAPPER_VIRTUALENV_ARGS\fR tells virtualenvwrapper what +arguments to pass to \fB\fCvirtualenv\fR. For example, set the value to +\fI\-\-no\-site\-packages\fP to ensure that all new environments are isolated from the +system site\-packages directory. +.nf +export VIRTUALENVWRAPPER_VIRTUALENV_ARGS='--no-site-packages' +.fi +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCpy\fR is short for \fB\fCpython\fR. +.RE +.SS Pythonz +.RS +.IP \(bu 2 +\fB\fCpyz\fR is short for \fB\fCpythonz\fR. +.IP \(bu 2 +\fB\fCpyzc\fR removes stale source folders and archives. +.IP \(bu 2 +\fB\fCpyzi\fR installs Python versions. +.IP \(bu 2 +\fB\fCpyzl\fR lists installed Python versions. +.IP \(bu 2 +\fB\fCpyzL\fR lists available Python versions. +.IP \(bu 2 +\fB\fCpyzu\fR updates itself to the latest version. +.IP \(bu 2 +\fB\fCpyzx\fR uninstalls Python versions. +.RE +.SH Functions +.RS +.IP \(bu 2 +\fB\fCpython-info\fR exposes information about the Python environment via the +\fB\fC$python_info\fR associative array. +.RE +.SH Theming +.PP +To display the name of the current virtual enviroment in a prompt, define the +following style in the \fB\fCprompt_theme_setup\fR function. +.nf +# %v - virtualenv name. +zstyle ':prezto:module:python' virtualenv 'virtualenv:%v' +.fi +.PP +Then add \fB\fC$python_info[virtualenv]\fR to \fB\fC$PROMPT\fR or \fB\fC$RPROMPT\fR and call +\fB\fCpython-info\fR in the \fB\fCprompt_theme_preexec\fR hook function. +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.IP \(bu 2 +Sebastian Wiesner +.UR https://github.com/lunaryorn +.UE +.RE diff --git a/documentation/man/man1/prezto-rails.1 b/documentation/man/man1/prezto-rails.1 new file mode 100644 index 00000000..e34e65eb --- /dev/null +++ b/documentation/man/man1/prezto-rails.1 @@ -0,0 +1,56 @@ +.TH Ruby on Rails +.PP +Defines Ruby on Rails +.UR http://rubyonrails.org +.UE +aliases. +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCror\fR is short for \fB\fCrails\fR. +.IP \(bu 2 +\fB\fCrorc\fR starts the Rails console. +.IP \(bu 2 +\fB\fCrordc\fR starts the Rails console connected to the database. +.IP \(bu 2 +\fB\fCrordm\fR migrates the database. +.IP \(bu 2 +\fB\fCrordM\fR migrates the database and recreates the test database. +.IP \(bu 2 +\fB\fCrordr\fR rolls the database schema back to the previous version. +.IP \(bu 2 +\fB\fCrorg\fR generates new code. +.IP \(bu 2 +\fB\fCrorl\fR displays the log. +.IP \(bu 2 +\fB\fCrorlc\fR truncates logs to zero bytes. +.IP \(bu 2 +\fB\fCrorp\fR installs a plugin. +.IP \(bu 2 +\fB\fCrorr\fR runs code in the application environment. +.IP \(bu 2 +\fB\fCrors\fR starts the Rails server. +.IP \(bu 2 +\fB\fCrorsd\fR starts the Rails server with the debugger. +.IP \(bu 2 +\fB\fCrorx\fR destroys newly generated code. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Robby Russell +.UR https://github.com/robbyrussell +.UE +.IP \(bu 2 +Jake Bell +.UR https://github.com/theunraveler +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-rsync.1 b/documentation/man/man1/prezto-rsync.1 new file mode 100644 index 00000000..7b502de2 --- /dev/null +++ b/documentation/man/man1/prezto-rsync.1 @@ -0,0 +1,34 @@ +.TH Rsync +.PP +Defines rsync +.UR http://rsync.samba.org +.UE +aliases. +.PP +Mac OS X users are encouraged to use Bombich's rsync +.UR http://www.bombich.com/rsync.html +.UE , which has HFS+ +enhancements. +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCrsync-copy\fR copies files and directories from \fIsource\fP to \fIdestination\fP. +.IP \(bu 2 +\fB\fCrsync-move\fR moves files and directories from \fIsource\fP to \fIdestination\fP. +.IP \(bu 2 +\fB\fCrsync-update\fR updates files and directories on \fIdestination\fP. +.IP \(bu 2 +\fB\fCrsync-synchronize\fR synchronizes files and directories between \fIsource\fP and +\fIdestination\fP. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-ruby.1 b/documentation/man/man1/prezto-ruby.1 new file mode 100644 index 00000000..e7fece9f --- /dev/null +++ b/documentation/man/man1/prezto-ruby.1 @@ -0,0 +1,97 @@ +.TH Ruby +.PP +Configures Ruby +.UR http://www.ruby-lang.org +.UE +local gem installation, loads version managers, and defines +aliases. +.SH Local Gem Installation +.PP +When a Ruby version manager is not detected, local gems are installed in +\fI~/Library/Ruby/Gems/1.8\fP on Mac OS X. +.SH RVM +.PP +An alternative to the above is to use The Ruby Version Manager (RVM) +.UR https://rvm.io +.UE , which +allows for managing multiple, isolated Ruby installations and gem sets in the +home directory. +.PP +Since RVM is loaded into the shell and is known to override shell commands, it +may conflict with shell scripts. +.SH rbenv +.PP +An alternative RVM is to use rbenv +.UR https://github.com/sstephenson/rbenv +.UE , which allows for switching between multiple, +isolated Ruby installations in the home directory. +.PP +While it is not as feature rich as RVM, it is not loaded into the shell and is +not known to cause conflicts with shell scripts. +.SH Bundler +.PP +Manage gems that are not meant to be used as commands, such as application +dependencies, with Bundler +.UR http://gembundler.com +.UE . +.SH Aliases +.SS General +.RS +.IP \(bu 2 +\fB\fCrb\fR is short for \fB\fCruby\fR. +.RE +.SS Bundler +.RS +.IP \(bu 2 +\fB\fCrbb\fR manages ruby dependencies (\fB\fCbundle\fR). +.IP \(bu 2 +\fB\fCrbbe\fR executes a script in the context of the current bundle. +.IP \(bu 2 +\fB\fCrbbi\fR installs the gems specified in the \fIGemfile\fP in \fIvendor/bundle\fP. +.IP \(bu 2 +\fB\fCrbbI\fR installs the following: +.RS +.IP \(bu 2 +gems specified in the \fIGemfile\fP in \fIvendor/bundle\fP. +.IP \(bu 2 +packages the gems into \fIvendor/cache\fP. +.IP \(bu 2 +appends bundler directories to \fI.gitignore\fP. +.RE +.IP \(bu 2 +\fB\fCrbbl\fR lists all gems in the current bundle. +.IP \(bu 2 +\fB\fCrbbo\fR opens an installed gem in the editor. +.IP \(bu 2 +\fB\fCrbbp\fR packages gem files into \fIvendor/cache\fP. +.IP \(bu 2 +\fB\fCrbbu\fR updates gems to their latest version. +.RE +.SH Functions +.RS +.IP \(bu 2 +\fB\fCruby-info\fR exposes information about the Ruby environment via the +\fB\fC$ruby_info\fR associative array. +.RE +.SH Theming +.PP +To display the name of the current Ruby version in a prompt, define the +following style in the \fB\fCprompt_theme_setup\fR function. +.nf +# %v - ruby version. +zstyle ':prezto:module:ruby' version 'version:%v' +.fi +.PP +Then add \fB\fC$ruby_info[version]\fR to \fB\fC$PROMPT\fR or \fB\fC$RPROMPT\fR and call +\fB\fCruby-info\fR in the \fB\fCprompt_theme_preexec\fR hook function. +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-screen.1 b/documentation/man/man1/prezto-screen.1 new file mode 100644 index 00000000..daaa5cb2 --- /dev/null +++ b/documentation/man/man1/prezto-screen.1 @@ -0,0 +1,37 @@ +.TH GNU Screen +.PP +Defines GNU Screen +.UR http://www.gnu.org/software/screen/ +.UE +aliases and provides for auto launching it at start\-up. +.SH Settings +.SS Auto\-Start +.PP +Starts a GNU Screen session automatically when Zsh is launched. +.PP +To enable this feature, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:screen' auto-start 'yes' +.fi +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCscr\fR is short for \fB\fCscreen\fR. +.IP \(bu 2 +\fB\fCscrl\fR lists sessions/socket directory. +.IP \(bu 2 +\fB\fCscrn\fR starts a new session. +.IP \(bu 2 +\fB\fCscrr\fR attaches to a session if one exists or start a new one. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-spectrum.1 b/documentation/man/man1/prezto-spectrum.1 new file mode 100644 index 00000000..c13a38fa --- /dev/null +++ b/documentation/man/man1/prezto-spectrum.1 @@ -0,0 +1,145 @@ +.TH Spectrum +.PP +Provides for easier use of 256 colors and effects. +.PP +To learn more about text formatting, read That 256 Color Thing +.UR http://lucentbeing.com/blog/that-256-color-thing/ +.UE . +.SH Variables +.RS +.IP \(bu 2 +\fB\fCBG\fR provides background colors. +.IP \(bu 2 +\fB\fCFG\fR provides foreground colors. +.IP \(bu 2 +\fB\fCFX\fR provides effects. +.RE +.SS Background and Foreground +.PP +Terminals support 8, 16, 88, and 256 colors. Check if a terminal supports 256 +colors with \fB\fCtput colors\fR before use. +.PP +The following colors are supported. +.RS +.IP \(bu 2 +0 to 255 +.IP \(bu 2 +black +.IP \(bu 2 +red +.IP \(bu 2 +green +.IP \(bu 2 +yellow +.IP \(bu 2 +blue +.IP \(bu 2 +magenta +.IP \(bu 2 +cyan +.IP \(bu 2 +white +.RE +.SS Effects +.PP +Though there are many effects, most terminals support at least bold formatting. +.PP +\fBNot all effects work on all terminals; use them sparingly.\fP +.TS +allbox; +cb cb +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +. +Enable Disable + none + normal +bold no\-bold +faint no\-faint +standout no\-standout +underline no\-underline +blink no\-blink +fast\-blink no\-fast\-blink +reverse no\-reverse +conceal no\-conceal +strikethrough no\-strikethrough +gothic no\-gothic +double\-underline no\-double\-underline +proportional no\-proportional +overline no\-overline + + no\-border +border\-rectangle no\-border\-rectangle +border\-circle no\-border\-circle + + no\-ideogram\-marking +underline\-or\-right no\-underline\-or\-right +double\-underline\-or\-right no\-double\-underline\-or\-right +overline\-or\-left no\-overline\-or\-left +double\-overline\-or\-left no\-double\-overline\-or\-left +stress no\-stress + + font\-default +font\-first no\-font\-first +font\-second no\-font\-second +font\-third no\-font\-third +font\-fourth no\-font\-fourth +font\-fifth no\-font\-fifth +font\-sixth no\-font\-sixth +font\-seventh no\-font\-seventh +font\-eigth no\-font\-eigth +font\-ninth no\-font\-ninth +.TE +.SS Plain Text +.PP +Use \fB\fC$BG[none]\fR, \fB\fC$FG[none]\fR, or \fB\fC$FX[none]\fR to turn off formatting. +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +P.C. Shyamshankar +.UR https://github.com/sykora +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-ssh-agent.1 b/documentation/man/man1/prezto-ssh-agent.1 new file mode 100644 index 00000000..38b5bd5a --- /dev/null +++ b/documentation/man/man1/prezto-ssh-agent.1 @@ -0,0 +1,53 @@ +.TH SSH\-Agent +.PP +Provides for an easier use of ssh\-agent +.UR http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-agent&sektion=1 +.UE . +.SH Settings +.SS Agent Forwarding +.PP +To enable ssh\-agent forwarding, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:ssh-agent' forwarding 'yes' +.fi +.SS Identities +.PP +To load multiple identities, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:ssh-agent' identities 'id_rsa' 'id_rsa2' 'id_github' +.fi +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Robby Russell +.UR https://github.com/robbyrussell +.UE +.IP \(bu 2 +Theodore Robert Campbell Jr +.UR https://github.com/trcjr +.UE +.IP \(bu 2 +Joseph M. Reagle Jr. +.UR https://github.com/reagle +.UE +.IP \(bu 2 +Florent Thoumie +.UR https://github.com/flz +.UE +.IP \(bu 2 +Jonas Pfenniger +.UR https://github.com/zimbatm +.UE +.IP \(bu 2 +Gareth Owen +.UR https://github.com/gwjo +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-syntax-highlighting.1 b/documentation/man/man1/prezto-syntax-highlighting.1 new file mode 100644 index 00000000..84c115ed --- /dev/null +++ b/documentation/man/man1/prezto-syntax-highlighting.1 @@ -0,0 +1,53 @@ +.TH Syntax Highlighting +.PP +Integrates zsh\-syntax\-highlighting +.UR https://github.com/zsh-users/zsh-syntax-highlighting +.UE +into Prezto. +.PP +This module should be loaded \fIsecond to last\fP, where last is the \fIprompt\fP +module, unless used in conjuncture with the \fIhistory\-substring\-search\fP module +where it must be loaded \fBbefore\fP it. +.SH Contributors +.PP +New features and bug fixes should be submitted to the +zsh\-syntax\-highlighting +.UR https://github.com/zsh-users/zsh-syntax-highlighting +.UE +project according to its rules and regulations. +This module will be synchronized against it. +.SH Settings +.SS Highlighting +.PP +To enable highlighting for this module only, add the following line to +\fIzpreztorc\fP: +.nf +zstyle ':prezto:module:syntax-highlighting' color 'yes' +.fi +.SS Highlighters +.PP +Syntax highlighting is accomplished by pluggable highlighters +.UR https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters +.UE . This module +enables the \fImain\fP, \fIbrackets\fP, and \fIcursor\fP highlighters by default. +.PP +To enable all highlighters, add the following to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:syntax-highlighting' highlighters \ + 'main' \ + 'brackets' \ + 'pattern' \ + 'cursor' \ + 'root' +.fi +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-terminal.1 b/documentation/man/man1/prezto-terminal.1 new file mode 100644 index 00000000..5b5cb37c --- /dev/null +++ b/documentation/man/man1/prezto-terminal.1 @@ -0,0 +1,26 @@ +.TH Terminal +.PP +Sets terminal window and tab titles. +.SH Settings +.SS Auto\-Title +.PP +To auto set the terminal window and tab titles with the current command or +directory, add the following to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:terminal' auto-title 'yes' +.fi +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +James Cox +.UR https://github.com/imajes +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-tmux.1 b/documentation/man/man1/prezto-tmux.1 new file mode 100644 index 00000000..c3a8156d --- /dev/null +++ b/documentation/man/man1/prezto-tmux.1 @@ -0,0 +1,61 @@ +.TH Tmux +.PP +Defines tmux +.UR http://tmux.sourceforge.net +.UE +aliases and provides for auto launching it at start\-up. +.SH Settings +.SS Auto\-Start +.PP +Starts a tmux session automatically when Zsh is launched. +.PP +To enable this feature, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:tmux' auto-start 'yes' +.fi +.PP +It will create a background session named \fI#Prezto\fP and attach every new shell +to it. +.PP +To avoid keeping open sessions, this module sets \fB\fCdestroy-unattached off\fR on +the background session and \fB\fCdestroy-unattached on\fR on every other session +(global setting). +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCtmuxa\fR attaches or switches to a tmux session. +.IP \(bu 2 +\fB\fCtmuxl\fR lists sessions managed by the tmux server. +.RE +.SH Caveats +.PP +On Mac OS X, launching tmux can cause the error \fBlaunch_msg(...): Socket is not +connected\fP to be displayed, which can be fixed by installing +reattach\-to\-user\-namespace +.UR ChrisJohnsen/tmux-MacOSX-pasteboard +.UE , available in Homebrew +.UR mxcl/homebrew +.UE , and adding the +following to \fItmux.conf\fP: +.PP + set\-option \-g default\-command "reattach\-to\-user\-namespace \-l $SHELL \-l" +.PP +Furthermore, tmux is known to cause \fBkernel panics\fP on Mac OS X. A discussion +about this and Prezto has already been opened +.UR http://git.io/jkPqHg +.UE . +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.IP \(bu 2 +Colin Hebert +.UR https://github.com/ColinHebert +.UE +.RE diff --git a/documentation/man/man1/prezto-utility.1 b/documentation/man/man1/prezto-utility.1 new file mode 100644 index 00000000..ac829d63 --- /dev/null +++ b/documentation/man/man1/prezto-utility.1 @@ -0,0 +1,233 @@ +.TH Utility +.PP +Defines general aliases and functions. +.SH Settings +.SS Highlighting +.PP +If you have enabled color globally in \fIzpreztorc\fP, you may disable it for certain +commands. +.PP +To disable \fB\fCls\fR color, add the following line to \fIzpreztorc\fP; when coloring is +disabled, type indicators (*, /, =>, @, =, |, %) will be appended to entries. +.nf +zstyle ':prezto:module:utility:ls' color 'no' +.fi +.PP +To disable \fB\fCdiff\fR highlighting, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:utility:diff' color 'no' +.fi +.PP +To disable \fB\fCwdiff\fR highlighting, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:utility:wdiff' color 'no' +.fi +.PP +To disable \fB\fCmake\fR highlighting, add the following line to \fIzpreztorc\fP: +.nf +zstyle ':prezto:module:utility:make' color 'no' +.fi +.SH Aliases +.SS Disabled Spelling Correction +.RS +.IP \(bu 2 +\fB\fCack\fR +.IP \(bu 2 +\fB\fCcd\fR +.IP \(bu 2 +\fB\fCcp\fR +.IP \(bu 2 +\fB\fCebuild\fR +.IP \(bu 2 +\fB\fCgcc\fR +.IP \(bu 2 +\fB\fCgist\fR +.IP \(bu 2 +\fB\fCgrep\fR +.IP \(bu 2 +\fB\fCheroku\fR +.IP \(bu 2 +\fB\fCln\fR +.IP \(bu 2 +\fB\fCman\fR +.IP \(bu 2 +\fB\fCmkdir\fR +.IP \(bu 2 +\fB\fCmv\fR +.IP \(bu 2 +\fB\fCmysql\fR +.IP \(bu 2 +\fB\fCrm\fR +.RE +.SS Disabled File Globbing +.RS +.IP \(bu 2 +\fB\fCfc\fR +.IP \(bu 2 +\fB\fCfind\fR +.IP \(bu 2 +\fB\fCftp\fR +.IP \(bu 2 +\fB\fChistory\fR +.IP \(bu 2 +\fB\fClocate\fR +.IP \(bu 2 +\fB\fCrake\fR +.IP \(bu 2 +\fB\fCrsync\fR +.IP \(bu 2 +\fB\fCscp\fR +.IP \(bu 2 +\fB\fCsftp\fR +.RE +.SS General +.RS +.IP \(bu 2 +\fB\fC_\fR executes a command as another user (\fB\fCsudo\fR). +.IP \(bu 2 +\fB\fCb\fR opens the default web browser. +.IP \(bu 2 +\fB\fCcp\fR copies files and directories interactively. +.IP \(bu 2 +\fB\fCe\fR opens the default editor. +.IP \(bu 2 +\fB\fCln\fR links files and directories interactively. +.IP \(bu 2 +\fB\fCmkdir\fR creates directories, including intermediary directories. +.IP \(bu 2 +\fB\fCmv\fR moves files and directories interactively. +.IP \(bu 2 +\fB\fCp\fR opens the default pager. +.IP \(bu 2 +\fB\fCpo\fR removes a directory from the stack and changes to it (\fB\fCpopd\fR). +.IP \(bu 2 +\fB\fCpu\fR changes the directory and pushes the old directory onto the stack +(\fB\fCpushd\fR). +.IP \(bu 2 +\fB\fCrm\fR removes files and directories interactively. +.IP \(bu 2 +\fB\fCtype\fR displays all the attribute values of a shell parameter. +.RE +.SS Files and Directories +.RS +.IP \(bu 2 +\fB\fCls\fR lists with directories grouped first (GNU only). +.IP \(bu 2 +\fB\fCl\fR lists in one column, hidden files. +.IP \(bu 2 +\fB\fCll\fR lists human readable sizes. +.IP \(bu 2 +\fB\fClr\fR lists human readable sizes, recursively. +.IP \(bu 2 +\fB\fCla\fR lists human readable sizes, hidden files. +.IP \(bu 2 +\fB\fClm\fR lists human readable sizes, hidden files through pager. +.IP \(bu 2 +\fB\fClx\fR lists sorted by extension (GNU only). +.IP \(bu 2 +\fB\fClk\fR lists sorted by size, largest last. +.IP \(bu 2 +\fB\fClt\fR lists sorted by date, most recent last. +.IP \(bu 2 +\fB\fClc\fR lists sorted by date, most recent last, shows change time. +.IP \(bu 2 +\fB\fClu\fR lists sorted by date, most recent last, shows access time. +.IP \(bu 2 +\fB\fCsl\fR lists directory contents (\fB\fCls\fR). +.RE +.SS Mac OS X Everywhere +.RS +.IP \(bu 2 +\fB\fCo\fR opens files and directories (\fB\fCopen\fR or \fB\fCxdg-open\fR). +.IP \(bu 2 +\fB\fCget\fR downloads files (\fB\fCcurl\fR or \fB\fCwget\fR). +.IP \(bu 2 +\fB\fCpbcopy\fR copies to the pasteboard (\fB\fCpbcopy\fR, \fB\fCxclip\fR or \fB\fCxsel\fR). +.IP \(bu 2 +\fB\fCpbpaste\fR pastes from the pasteboard (\fB\fCpbcopy\fR, \fB\fCxclip\fR or \fB\fCxsel\fR). +.IP \(bu 2 +\fB\fCpbc\fR copies to the pasteboard (\fB\fCpbcopy\fR). +.IP \(bu 2 +\fB\fCpbp\fR pastes from the pasteboard (\fB\fCpbpaste\fR). +.RE +.SS Resource Usage +.RS +.IP \(bu 2 +\fB\fCdf\fR displays free disk space using human readable units. +.IP \(bu 2 +\fB\fCdu\fR displays disk usage using human readable units. +.IP \(bu 2 +\fB\fCtop\fR displays information about processes (aliased to \fB\fChtop\fR, if installed). +.IP \(bu 2 +\fB\fCtopc\fR displays information about processes sorted by CPU usage (\fB\fChtop\fR not +installed). +.IP \(bu 2 +\fB\fCtopm\fR displays information about processes sorted by RAM usage (\fB\fChtop\fR not +installed). +.RE +.SS Miscellaneous +.RS +.IP \(bu 2 +\fB\fChttp-serve\fR serves a directory via HTTP. +.RE +.SH Functions +.SS General +.RS +.IP \(bu 2 +\fB\fCslit\fR prints columns \fI1, 2, 3 ... n\fP. +.RE +.SS Files and Directories +.RS +.IP \(bu 2 +\fB\fCcdls\fR changes to a directory and lists its contents. +.IP \(bu 2 +\fB\fCdut\fR displays the grand total disk usage using human readable units. +.IP \(bu 2 +\fB\fCfind-exec\fR finds files and executes a command on them. +.IP \(bu 2 +\fB\fCmkdcd\fR makes a directory and changes to it. +.IP \(bu 2 +\fB\fCpopdls\fR pops an entry off the directory stack and lists its contents. +.IP \(bu 2 +\fB\fCpushdls\fR pushes an entry onto the directory stack and lists its contents. +.RE +.SS Developer +.RS +.IP \(bu 2 +\fB\fCdiff\fR highlights diff output (requires \fB\fCcolordiff\fR or \fB\fCGit\fR). +.IP \(bu 2 +\fB\fCmake\fR highlights make output (requires \fB\fCcolormake\fR). +.IP \(bu 2 +\fB\fCwdiff\fR highlights wdiff output (requires \fB\fCwdiff\fRor \fB\fCGit\fR). +.RE +.SS Resource usage +.RS +.IP \(bu 2 +\fB\fCpsu\fR displays user owned processes status. +.RE +.SS Search and Replace +.RS +.IP \(bu 2 +\fB\fCprep\fR provides a grep\-like pattern search. +.IP \(bu 2 +\fB\fCpsub\fR provides a sed\-like pattern substitution. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Robby Russell +.UR https://github.com/robbyrussell +.UE +.IP \(bu 2 +Suraj N. Kurapati +.UR https://github.com/sunaku +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-wakeonlan.1 b/documentation/man/man1/prezto-wakeonlan.1 new file mode 100644 index 00000000..3556dc13 --- /dev/null +++ b/documentation/man/man1/prezto-wakeonlan.1 @@ -0,0 +1,43 @@ +.TH Wake\-on\-LAN +.PP +This module provides a wrapper around the wakeonlan +.UR http://gsd.di.uminho.pt/jpo/software/wakeonlan/ +.UE +tool. +.SH Usage +.PP +To use this wrapper, create the \fI~/.wakeonlan\fP directory, and place in it one +file for each device you would like to be able to wake. Give the file a name +that describes the device, such as its hostname. +.PP +Each file should contain a line with the MAC address of the target device and +the network broadcast address. For instance, there might be a file +\fI~/.wakeonlan/leto\fP with the following contents: +.nf +00:11:22:33:44:55:66 192.168.0.255 +.fi +.PP +To wake that device, use the following command: +.nf +wake leto +.fi +.PP +For more information on the configuration file format, read the +wakeonlan man page +.UR http://man.cx/wakeonlan +.UE . +.SH Authors +.PP +\fIThe authors of this module should be contacted via issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Paul Dann +.UR https://github.com/giddie +.UE +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-yum.1 b/documentation/man/man1/prezto-yum.1 new file mode 100644 index 00000000..e80d70ab --- /dev/null +++ b/documentation/man/man1/prezto-yum.1 @@ -0,0 +1,40 @@ +.TH Yum +.PP +Defines yum +.UR http://yum.baseurl.org +.UE +aliases. +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCyumc\fR removes package(s) and leaves. +.IP \(bu 2 +\fB\fCyumi\fR installs package(s). +.IP \(bu 2 +\fB\fCyumh\fR displays history. +.IP \(bu 2 +\fB\fCyuml\fR lists packages. +.IP \(bu 2 +\fB\fCyumL\fR lists installed packages. +.IP \(bu 2 +\fB\fCyumq\fR displays package information. +.IP \(bu 2 +\fB\fCyumr\fR removes package(s). +.IP \(bu 2 +\fB\fCyums\fR searches for a package. +.IP \(bu 2 +\fB\fCyumu\fR updates packages. +.IP \(bu 2 +\fB\fCyumU\fR upgrates packages. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto-z.1 b/documentation/man/man1/prezto-z.1 new file mode 100644 index 00000000..daedd829 --- /dev/null +++ b/documentation/man/man1/prezto-z.1 @@ -0,0 +1,23 @@ +.TH Z +.PP +Integrates z +.UR https://github.com/rupa/z +.UE +into Prezto, which maintains a frequently used directory +list for fast directory changes. +.SH Aliases +.RS +.IP \(bu 2 +\fB\fCj\fR changes the current working directory to the most \fIfrecent\fP match. +.RE +.SH Authors +.PP +\fIThe authors of this module should be contacted via the issue tracker +.UR https://github.com/sorin-ionescu/prezto/issues +.UE .\fP +.RS +.IP \(bu 2 +Sorin Ionescu +.UR https://github.com/sorin-ionescu +.UE +.RE diff --git a/documentation/man/man1/prezto.1 b/documentation/man/man1/prezto.1 new file mode 100644 index 00000000..56d50d7a --- /dev/null +++ b/documentation/man/man1/prezto.1 @@ -0,0 +1,199 @@ +.TH Prezto — Instantly Awesome Zsh +.PP +Prezto is the configuration framework for Zsh +.UR http://www.zsh.org +.UE ; it enriches the command line +interface environment with sane defaults, aliases, functions, auto completion, +and prompt themes. +.SH Installation +.PP +Prezto will work with any recent release of Zsh, but the minimum recommended +version is 4.3.10. +.nr step0 0 1 +.RS +.IP \n+[step0] +Launch Zsh: +.nf +zsh +.fi +.IP \n+[step0] +Clone the repository: +.nf +git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto" +.fi +.IP \n+[step0] +Create a new Zsh configuration by copying the Zsh configuration files + provided: +.nf +setopt EXTENDED_GLOB +for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do + ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}" +done +.fi +.IP \n+[step0] +Set Zsh as your default shell: +.nf +chsh -s /bin/zsh +.fi +.IP \n+[step0] +Open a new Zsh terminal window or tab. +.RE +.SS Mac OS X +.PP +If you have administrator privileges, you must fix an Apple\-introduced problem +in Mac OS X 10.5 Leopard by executing the following command, or BASH and Zsh +will have the wrong \fB\fCPATH\fR when executed non\-interactively. +.nf +sudo chmod ugo-x /usr/libexec/path_helper +.fi +.PP +\fB\fCpath_helper\fR is intended to make it easier for installers to add new paths to +the environment without having to edit shell configuration files by adding +a file with a path to the \fI/etc/paths.d\fP directory. +.PP +Unfortunately, \fB\fCpath_helper\fR always reads paths from \fI/etc/paths\fP set by Apple +then paths from \fI/etc/paths.d\fP set by third party installers, and lastly paths +from the \fB\fCPATH\fR environment variable set by the parent process, which +ultimately is set by the user with \fB\fCexport PATH=...\fR Thus, it reorders path +priorities, and user \fI/bin\fP directories meant to override system \fI/bin\fP +directories end up at the tail of the array. +.SS Troubleshooting +.PP +If you are not able to find certain commands after switching to \fIPrezto\fP, +modify the \fB\fCPATH\fR variable in \fI~/.zshenv\fP then open a new Zsh terminal +window or tab. +.SH Usage +.PP +Prezto has many features disabled by default. Read the source code and +accompanying README files to learn of what is available. +.SS Modules +.nr step1 0 1 +.RS +.IP \n+[step1] +Browse \fI/modules\fP to see what is available. +.IP \n+[step1] +Load the modules you need in \fI~/.zpreztorc\fP then open a new Zsh terminal + window or tab. +.RE +.SS Themes +.nr step2 0 1 +.RS +.IP \n+[step2] +For a list of themes, type \fB\fCprompt -l\fR. +.IP \n+[step2] +To preview a theme, type \fB\fCprompt -p name\fR. +.IP \n+[step2] +Load the theme you like in \fI~/.zpreztorc\fP then open a new Zsh terminal + window or tab. +.PP + [sorin theme]2 +.UR http://i.imgur.com/ij8Lv.png +.UE +.RE +.SH Customization +.PP +The project is managed via Git +.UR http://git-scm.com +.UE . It is highly recommend that you commit +your changes and push them to GitHub +.UR https://github.com +.UE +to not lose them. If you do not know +how to use Git, follow this tutorial +.UR http://gitimmersion.com +.UE +and bookmark this reference +.UR http://gitref.org +.UE . +.SH Resources +.PP +The Zsh Reference Card +.UR http://www.bash2zsh.com/zsh_refcard/refcard.pdf +.UE +and the zsh\-lovers +.UR http://grml.org/zsh/zsh-lovers.html +.UE +man page are indispensable. +.SH Contribute +.PP +This project would not exist without all of its users and contributors +.UR https://github.com/sorin-ionescu/prezto/contributors +.UE . +.PP +If you have ideas on how to make the configuration easier to maintain or +improve its performance, do not hesitate to fork and send pull requests. +.SS Issue Reporting +.RS +.IP \(bu 2 +Check that the issue has not already been reported. +.IP \(bu 2 +Check that the issue has not already been fixed in the latest code. +.IP \(bu 2 +Open an issue with a clear title and description in grammatically correct, + complete sentences. +.RE +.SS Pull Request +.RS +.IP \(bu 2 +Read how to properly contribute to open source projects on GitHub +.UR http://gun.io/blog/how-to-github-fork-branch-and-pull-request +.UE . +.IP \(bu 2 +Use a topic branch to easily amend a pull request later, if necessary. +.IP \(bu 2 +Write good commit messages +.UR http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +.UE . +.IP \(bu 2 +Squash commits on the topic branch before opening a pull request. +.IP \(bu 2 +Use the same coding style and spacing. +.IP \(bu 2 +Open a pull request +.UR https://help.github.com/articles/using-pull-requests +.UE +that relates to but one subject with a clear + title and description in grammatically correct, complete sentences. +.RE +.SS Modules +.RS +.IP \(bu 2 +A \fIREADME.md\fP must be present. +.IP \(bu 2 +Large functions must be placed in a \fIfunctions\fP directory. +.IP \(bu 2 +Functions that take arguments must have completion. +.RE +.SS Themes +.RS +.IP \(bu 2 +A screenshots section must be present in the file header. +.IP \(bu 2 +The pull request description must have embedded + screenshots +.UR http://daringfireball.net/projects/markdown/syntax#img +.UE . +.RE +.SH License +.PP +(The MIT License) +.PP +Copyright (c) 2009\-2012 Robby Russell, Sorin Ionescu, and contributors. +.PP +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: +.PP +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. +.PP +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.