mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-02-10 08:35:23 +00:00
general: Reformat documentation with better formatting and wording
General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
This commit is contained in:
parent
8edc5e9323
commit
d80e393f78
@ -1,42 +1,41 @@
|
||||
Contributing
|
||||
------------
|
||||
# Contributing
|
||||
|
||||
This project would not exist without all of its users and [contributors][1].
|
||||
|
||||
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.
|
||||
|
||||
### Issue Reporting
|
||||
## Issue Reporting
|
||||
|
||||
- Check that the issue has not already been reported.
|
||||
- Check that the issue has not already been fixed in the latest code.
|
||||
- Open an issue with a clear title and description in grammatically correct,
|
||||
complete sentences.
|
||||
- Check that the issue has not already been reported.
|
||||
- Check that the issue has not already been fixed in the latest code.
|
||||
- Open an issue with a clear title and description in grammatically correct,
|
||||
complete sentences.
|
||||
|
||||
### Pull Request
|
||||
## Pull Request
|
||||
|
||||
- Read [how to properly contribute to open source projects on GitHub][2].
|
||||
- Use a topic branch to easily amend a pull request later, if necessary.
|
||||
- Write [good commit messages][3].
|
||||
- Squash commits on the topic branch before opening a pull request.
|
||||
- Use the same coding style and spacing.
|
||||
- Open a [pull request][4] that relates to but one subject with a clear
|
||||
title and description in grammatically correct, complete sentences.
|
||||
- Read [how to properly contribute to open source projects on GitHub][2].
|
||||
- Use a topic branch to easily amend a pull request later, if necessary.
|
||||
- Write [good commit messages][3].
|
||||
- Squash commits on the topic branch before opening a pull request.
|
||||
- Use the same coding style and spacing.
|
||||
- Open a [pull request][4] that relates to but one subject with a clear title
|
||||
and description in grammatically correct, complete sentences.
|
||||
|
||||
#### Code Style
|
||||
### Code Style
|
||||
|
||||
This project follows the [Google Shell Style Guide][5] when possible. However,
|
||||
there are a number of additional things to keep in mind.
|
||||
|
||||
- Local variables should be used whenever possible.
|
||||
- Prefer `zstyle` over environment variables for configuration.
|
||||
- Prefer (( ... )) over [[ ... ]] for arithmetic expression.
|
||||
- Use the function keyword to define functions.
|
||||
- The 80 character hard limit can be waived for readability.
|
||||
- Local variables should be used whenever possible.
|
||||
- Prefer `zstyle` over environment variables for configuration.
|
||||
- Prefer (( ... )) over [[ ... ]] for arithmetic expression.
|
||||
- Use the function keyword to define functions.
|
||||
- The 80 character hard limit can be waived for readability.
|
||||
|
||||
#### Using an Alternative zprezto Directory
|
||||
### Using an Alternative *zprezto* Directory
|
||||
|
||||
To work on zprezto without messing with your current configuration:
|
||||
To work on Prezto without affecting your current configuration:
|
||||
|
||||
```sh
|
||||
mkdir devel-zprezto
|
||||
@ -52,24 +51,24 @@ done
|
||||
|
||||
Then to start zsh in this development environment you will run:
|
||||
|
||||
```sh
|
||||
```console
|
||||
ZDOTDIR=/path/to/devel-zprezto zsh
|
||||
```
|
||||
|
||||
#### Modules
|
||||
### Modules
|
||||
|
||||
- A *README.md* must be present.
|
||||
- Large functions must be placed in a *functions* directory.
|
||||
- Functions that take arguments must have completion.
|
||||
- A *README.md* must be present.
|
||||
- Large functions must be placed in a *functions* directory.
|
||||
- Functions that take arguments must have completion.
|
||||
|
||||
#### Themes
|
||||
### Themes
|
||||
|
||||
- A screenshots section must be present in the file header.
|
||||
- The pull request description must have [embedded screenshots][6].
|
||||
- A screenshots section must be present in the file header.
|
||||
- The pull request description must have [embedded screenshots][6].
|
||||
|
||||
[1]: https://github.com/sorin-ionescu/prezto/contributors
|
||||
[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
|
||||
[2]: https://gun.io/blog/how-to-github-fork-branch-and-pull-request
|
||||
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
||||
[4]: https://help.github.com/articles/using-pull-requests
|
||||
[5]: https://google.github.io/styleguide/shell.xml
|
||||
[6]: http://daringfireball.net/projects/markdown/syntax#img
|
||||
[6]: https://github.github.com/gfm/#images
|
||||
|
154
README.md
154
README.md
@ -1,66 +1,64 @@
|
||||
Prezto — Instantly Awesome Zsh
|
||||
==============================
|
||||
# Prezto — Instantly Awesome Zsh
|
||||
|
||||
Prezto is the configuration framework for [Zsh][1]; it enriches the command line
|
||||
interface environment with sane defaults, aliases, functions, auto completion,
|
||||
and prompt themes.
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
Prezto will work with any recent release of Zsh, but the minimum required
|
||||
version is 4.3.11.
|
||||
version is **4.3.11**.
|
||||
|
||||
1. Launch Zsh:
|
||||
01. Launch Zsh:
|
||||
|
||||
```console
|
||||
zsh
|
||||
```
|
||||
```console
|
||||
zsh
|
||||
```
|
||||
|
||||
2. Clone the repository:
|
||||
02. Clone the repository:
|
||||
|
||||
```console
|
||||
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
|
||||
```
|
||||
```console
|
||||
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
|
||||
```
|
||||
|
||||
3. Create a new Zsh configuration by copying the Zsh configuration files
|
||||
provided:
|
||||
03. Create a new Zsh configuration by copying the Zsh configuration files
|
||||
provided:
|
||||
|
||||
```sh
|
||||
setopt EXTENDED_GLOB
|
||||
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
|
||||
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
|
||||
done
|
||||
```
|
||||
```console
|
||||
setopt EXTENDED_GLOB
|
||||
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
|
||||
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
|
||||
done
|
||||
```
|
||||
|
||||
Note: If you already have any of the given configuration files, `ln` will
|
||||
cause error. In simple cases you can load prezto by adding the line
|
||||
`source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to the bottom of your
|
||||
`.zshrc` and keep the rest of your Zsh configuration intact. For more
|
||||
complicated setups, it is recommended that you back up your original
|
||||
configs and replace them with the provided prezto runcoms.
|
||||
**Note:** If you already have any of the given configuration files, `ln` in
|
||||
the above operation will cause an error. In simple cases, you can load
|
||||
Prezto by adding the line `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to
|
||||
the bottom of your *${ZDOTDIR:-$HOME}/.zshrc* and keep the rest of your Zsh
|
||||
configuration intact. For more complicated setups, we recommend that you
|
||||
back up your original configs and replace them with the provided Prezto
|
||||
*runcoms*.
|
||||
|
||||
4. Set Zsh as your default shell:
|
||||
04. Set Zsh as your default shell:
|
||||
|
||||
```console
|
||||
chsh -s /bin/zsh
|
||||
```
|
||||
```console
|
||||
chsh -s /bin/zsh
|
||||
```
|
||||
|
||||
5. Open a new Zsh terminal window or tab.
|
||||
05. Open a new Zsh terminal window or tab.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
If you are not able to find certain commands after switching to *Prezto*,
|
||||
modify the `PATH` variable in *~/.zprofile* then open a new Zsh terminal
|
||||
window or tab.
|
||||
If you are not able to find certain commands after switching to Prezto, modify
|
||||
the `PATH` variable in *${ZDOTDIR:-$HOME}/.zprofile* then open a new Zsh
|
||||
terminal window or tab.
|
||||
|
||||
Updating
|
||||
--------
|
||||
## Updating
|
||||
|
||||
Run `zprezto-update` to automatically check if there is an update to zprezto.
|
||||
If there are no file conflicts, zprezto and its submodules will be
|
||||
automatically updated. If there are conflicts you will be instructed to go into
|
||||
the `$ZPREZTODIR` directory and resolve them yourself.
|
||||
Run `zprezto-update` to automatically check if there is an update to Prezto.
|
||||
If there are no file conflicts, Prezto and its submodules will be automatically
|
||||
updated. If there are conflicts you will be instructed to go into the
|
||||
`$ZPREZTODIR` directory and resolve them yourself.
|
||||
|
||||
To pull the latest changes and update submodules manually:
|
||||
|
||||
@ -70,67 +68,63 @@ git pull
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
Usage
|
||||
-----
|
||||
## Usage
|
||||
|
||||
Prezto has many features disabled by default. Read the source code and
|
||||
accompanying README files to learn of what is available.
|
||||
Prezto has many features disabled by default. Read the source code and the
|
||||
accompanying README files to learn about what is available.
|
||||
|
||||
### Modules
|
||||
|
||||
1. Browse */modules* to see what is available.
|
||||
2. Load the modules you need in *~/.zpreztorc* then open a new Zsh terminal
|
||||
window or tab.
|
||||
01. Browse */modules* to see what is available.
|
||||
02. Load the modules you need in *${ZDOTDIR:-$HOME}/.zpreztorc* then open a new
|
||||
Zsh terminal window or tab.
|
||||
|
||||
### Themes
|
||||
|
||||
1. For a list of themes, type `prompt -l`.
|
||||
2. To preview a theme, type `prompt -p name`.
|
||||
3. Load the theme you like in *~/.zpreztorc* then open a new Zsh terminal
|
||||
window or tab.
|
||||
01. For a list of themes, type `prompt -l`.
|
||||
02. To preview a theme, type `prompt -p name`.
|
||||
03. Load the theme you like in *${ZDOTDIR:-$HOME}/.zpreztorc* then open a new
|
||||
Zsh terminal window or tab.
|
||||
|
||||
![sorin theme][2]
|
||||
Note that the 'git' module may be required for special symbols to appear,
|
||||
such as those on the right of the above image. Add `'git'` to the `pmodule`
|
||||
list (under `zstyle ':prezto:load' pmodule \` in your *~/.zpreztorc*) to
|
||||
enable this module.
|
||||
![sorin theme][2]
|
||||
Note that the *git* module may be required for special symbols to appear,
|
||||
such as those on the right of the above image. Add `'git'` to the `pmodule`
|
||||
list (under `zstyle ':prezto:load' pmodule \` in your
|
||||
*${ZDOTDIR:-$HOME}/.zpreztorc*) to enable this module.
|
||||
|
||||
### External Modules
|
||||
|
||||
1. By default modules will be loaded from */modules* and */contrib*.
|
||||
2. Additional module directories can be added to the
|
||||
`:prezto:load:pmodule-dirs` setting in *~/.zpreztorc*.
|
||||
01. By default modules will be loaded from */modules* and */contrib*.
|
||||
02. Additional module directories can be added to the
|
||||
`:prezto:load:pmodule-dirs` setting in *${ZDOTDIR:-$HOME}/.zpreztorc*.
|
||||
|
||||
Note that module names need to be unique or they will cause an error when
|
||||
loading.
|
||||
Note that module names need to be unique or they will cause an error when
|
||||
loading.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
|
||||
```
|
||||
```console
|
||||
zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
|
||||
```
|
||||
|
||||
Customization
|
||||
-------------
|
||||
## Customization
|
||||
|
||||
The project is managed via [Git][3]. It is highly recommended that you fork this
|
||||
project; so, that you can commit your changes and push them to [GitHub][4] to
|
||||
not lose them. If you do not know how to use Git, follow this [tutorial][5] and
|
||||
bookmark this [reference][6].
|
||||
The project is managed via [Git][3]. We highly recommend that you fork this
|
||||
project so that you can commit your changes and push them to your fork on
|
||||
[GitHub][4] to preserve them. If you do not know how to use Git, follow this
|
||||
[tutorial][5] and bookmark this [reference][6].
|
||||
|
||||
Resources
|
||||
---------
|
||||
## Resources
|
||||
|
||||
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
|
||||
|
||||
License
|
||||
-------
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License.
|
||||
|
||||
[1]: http://www.zsh.org
|
||||
[2]: http://i.imgur.com/nrGV6pg.png "sorin theme"
|
||||
[3]: http://git-scm.com
|
||||
[1]: https://www.zsh.org
|
||||
[2]: https://i.imgur.com/nrGV6pg.png "sorin theme"
|
||||
[3]: https://git-scm.com
|
||||
[4]: https://github.com
|
||||
[5]: http://gitimmersion.com
|
||||
[5]: https://gitimmersion.com
|
||||
[6]: https://git.github.io/git-reference/
|
||||
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
|
||||
[8]: http://grml.org/zsh/zsh-lovers.html
|
||||
[8]: https://grml.org/zsh/zsh-lovers.html
|
||||
|
@ -1,206 +1,166 @@
|
||||
Modules
|
||||
=======
|
||||
# Modules
|
||||
|
||||
Load modules in *zpreztorc*. The order matters.
|
||||
Load modules in *~/.zpreztorc*. The order matters.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:load' pmodule 'environment' 'terminal'
|
||||
```
|
||||
|
||||
Archive
|
||||
-------
|
||||
## Archive
|
||||
|
||||
Provides functions to list and extract archives.
|
||||
|
||||
Autosuggestions
|
||||
---------------
|
||||
## Autosuggestions
|
||||
|
||||
Integrates zsh-autosuggestions into Prezto.
|
||||
|
||||
Command-Not-Found
|
||||
-----------------
|
||||
## Command-Not-Found
|
||||
|
||||
Loads the command-not-found tool on macOS or Debian-based distributions.
|
||||
|
||||
Completion
|
||||
----------
|
||||
## Completion
|
||||
|
||||
Loads and configures tab completion and provides additional completions from
|
||||
the zsh-completions project.
|
||||
Loads and configures <kbd>TAB</kbd> completion and provides additional
|
||||
completions from the zsh-completions project.
|
||||
|
||||
Directory
|
||||
---------
|
||||
## Directory
|
||||
|
||||
Sets directory options and defines directory aliases.
|
||||
|
||||
DNF
|
||||
---
|
||||
## DNF
|
||||
|
||||
Defines dnf aliases.
|
||||
Defines *dnf* aliases.
|
||||
|
||||
Dpkg
|
||||
----
|
||||
## Dpkg
|
||||
|
||||
Defines dpkg aliases and functions.
|
||||
Defines *dpkg* aliases and functions.
|
||||
|
||||
Editor
|
||||
------
|
||||
## Editor
|
||||
|
||||
Sets key bindings.
|
||||
|
||||
Emacs
|
||||
-----
|
||||
## Emacs
|
||||
|
||||
Enables Emacs dependency management.
|
||||
|
||||
Environment
|
||||
-----------
|
||||
## Environment
|
||||
|
||||
Sets general shell options and defines environment variables.
|
||||
|
||||
Fasd
|
||||
----
|
||||
## Fasd
|
||||
|
||||
Maintains a frequently used file and directory list for fast access.
|
||||
|
||||
Git
|
||||
---
|
||||
## Git
|
||||
|
||||
Enhances the Git distributed version control system by providing aliases,
|
||||
functions and by exposing repository status information to prompts.
|
||||
|
||||
GNU Utility
|
||||
-----------
|
||||
## GNU Utility
|
||||
|
||||
Provides for the interactive use of GNU utilities on non-GNU systems.
|
||||
|
||||
GPG
|
||||
---
|
||||
## GPG
|
||||
|
||||
Provides for an easier use of GPG by setting up gpg-agent.
|
||||
|
||||
Haskell
|
||||
-------
|
||||
## Haskell
|
||||
|
||||
Enables local Haskell package installation.
|
||||
|
||||
Helper
|
||||
------
|
||||
## Helper
|
||||
|
||||
Provides helper functions for developing modules.
|
||||
|
||||
History
|
||||
-------
|
||||
## History
|
||||
|
||||
Sets history options and defines history aliases.
|
||||
|
||||
History Substring Search
|
||||
------------------------
|
||||
## History Substring Search
|
||||
|
||||
Integrates zsh-history-substring-search into Prezto.
|
||||
|
||||
Homebrew
|
||||
--------
|
||||
## Homebrew
|
||||
|
||||
Defines Homebrew aliases.
|
||||
|
||||
MacPorts
|
||||
--------
|
||||
## MacPorts
|
||||
|
||||
Defines MacPorts aliases and adds MacPorts directories to path variables.
|
||||
|
||||
Node.js
|
||||
-------
|
||||
## Node.js
|
||||
|
||||
Provides utility functions for Node.js and loads npm completion.
|
||||
|
||||
OCaml
|
||||
-----
|
||||
## OCaml
|
||||
|
||||
Initializes OCaml package management.
|
||||
|
||||
OSX
|
||||
---
|
||||
## OSX
|
||||
|
||||
Defines macOS aliases and functions.
|
||||
|
||||
Pacman
|
||||
------
|
||||
## Pacman
|
||||
|
||||
Provides aliases and functions for the Pacman package manager and frontends.
|
||||
|
||||
Perl
|
||||
----
|
||||
## Perl
|
||||
|
||||
Enables local Perl module installation on macOS and defines alises.
|
||||
|
||||
Prompt
|
||||
------
|
||||
## Prompt
|
||||
|
||||
Loads prompt themes.
|
||||
|
||||
Python
|
||||
------
|
||||
## Python
|
||||
|
||||
Enables local Python and local Python package installation.
|
||||
|
||||
Ruby on Rails
|
||||
-------------
|
||||
## Ruby on Rails
|
||||
|
||||
Defines Ruby on Rails aliases.
|
||||
|
||||
Rsync
|
||||
-----
|
||||
## Rsync
|
||||
|
||||
Defines rsync aliases.
|
||||
|
||||
Ruby
|
||||
----
|
||||
## Ruby
|
||||
|
||||
Configures Ruby local gem installation, loads version managers, and defines
|
||||
aliases.
|
||||
|
||||
GNU Screen
|
||||
----------
|
||||
## GNU Screen
|
||||
|
||||
Defines GNU Screen aliases and provides for auto launching it at start-up.
|
||||
|
||||
Spectrum
|
||||
--------
|
||||
## Spectrum
|
||||
|
||||
Provides for easier use of 256 colors and effects.
|
||||
|
||||
SSH
|
||||
---
|
||||
## SSH
|
||||
|
||||
Provides for an easier use of SSH by setting up ssh-agent.
|
||||
|
||||
Syntax Highlighting
|
||||
-------------------
|
||||
## Syntax Highlighting
|
||||
|
||||
Integrates zsh-syntax-highlighting into Prezto.
|
||||
|
||||
Terminal
|
||||
--------
|
||||
## Terminal
|
||||
|
||||
Sets terminal window and tab titles.
|
||||
|
||||
Tmux
|
||||
----
|
||||
## Tmux
|
||||
|
||||
Defines tmux aliases and provides for auto launching it at start-up.
|
||||
|
||||
Utility
|
||||
-------
|
||||
## Utility
|
||||
|
||||
Defines general aliases and functions.
|
||||
|
||||
Wake-on-LAN
|
||||
-----------
|
||||
## Wake-on-LAN
|
||||
|
||||
This module provides a wrapper around the wakeonlan tool.
|
||||
|
||||
Yum
|
||||
---
|
||||
## Yum
|
||||
|
||||
Defines yum aliases.
|
||||
|
@ -1,52 +1,47 @@
|
||||
Archive
|
||||
=======
|
||||
# Archive
|
||||
|
||||
Provides functions to create, list, and extract archives.
|
||||
|
||||
Functions
|
||||
---------
|
||||
## Functions
|
||||
|
||||
- `archive` creates an archive based on the provided archive name.
|
||||
- `lsarchive` lists the contents of one or more archives.
|
||||
- `unarchive` extracts the contents of one or more archives.
|
||||
- `archive` creates an archive based on the provided archive name.
|
||||
- `lsarchive` lists the contents of one or more archives.
|
||||
- `unarchive` extracts the contents of one or more archives.
|
||||
|
||||
Supported Formats
|
||||
-----------------
|
||||
## Supported Formats
|
||||
|
||||
The following archive formats are supported when the required utilities are
|
||||
installed:
|
||||
|
||||
- *.tar.gz*, *.tgz* require `tar` (optionally `pigz`).
|
||||
- *.tar.bz2*, *.tbz* require `tar` (optionally `pbzip2`).
|
||||
- *.tar.xz*, *.txz* require `tar` with *xz* support.
|
||||
- *.tar.zma*, *.tlz* require `tar` with *lzma* support.
|
||||
- *.tar* requires `tar`.
|
||||
- *.gz* requires `gunzip`.
|
||||
- *.bz2* requires `bunzip2`.
|
||||
- *.xz* requires `unxz`.
|
||||
- *.lzma* requires `unlzma`.
|
||||
- *.Z* requires `uncompress`.
|
||||
- *.zip*, *.jar* requires `unzip`.
|
||||
- *.rar* requires `rar` (needed for `archive` support), `unrar` or `lsar` and `unar`.
|
||||
- *.7z* requires `7za`.
|
||||
- *.deb* requires `ar`, `tar`.
|
||||
- *.tar.gz*, *.tgz* require `tar` (optionally `pigz`).
|
||||
- *.tar.bz2*, *.tbz* require `tar` (optionally `pbzip2`).
|
||||
- *.tar.xz*, *.txz* require `tar` with *xz* support.
|
||||
- *.tar.zma*, *.tlz* require `tar` with *lzma* support.
|
||||
- *.tar* requires `tar`.
|
||||
- *.gz* requires `gunzip`.
|
||||
- *.bz2* requires `bunzip2`.
|
||||
- *.xz* requires `unxz`.
|
||||
- *.lzma* requires `unlzma`.
|
||||
- *.Z* requires `uncompress`.
|
||||
- *.zip*, *.jar* requires `unzip`.
|
||||
- *.rar* requires `rar` (needed for `archive` support), `unrar` or `lsar` and `unar`.
|
||||
- *.7z* requires `7za`.
|
||||
- *.deb* requires `ar`, `tar`.
|
||||
|
||||
Additionally, if `pigz` and/or `pbzip2` are installed, `archive` will use them
|
||||
over their traditional counterparts, `gzip` and `bzip2` respectively, to take
|
||||
full advantage of all available CPU cores for compression.
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
## Alternatives
|
||||
|
||||
Specifically on macOS, [The Unarchiver][1] provides a similar command line tool
|
||||
which doesn't depend on a number of other programs being installed.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][1].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Matt Hamilton](https://github.com/Eriner)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Matt Hamilton](https://github.com/Eriner)
|
||||
|
||||
[1]: https://theunarchiver.com/command-line
|
||||
|
@ -1,5 +1,4 @@
|
||||
Autosuggestions
|
||||
===============
|
||||
# Autosuggestions
|
||||
|
||||
Integrates [zsh-autosuggestions][1] into Prezto, which implements the
|
||||
[Fish shell][2]'s autosuggestions feature, where the user can type in any part
|
||||
@ -13,15 +12,13 @@ If this module is used in conjunction with the *history-substring-search*
|
||||
module, this module must be loaded **after** the *history-substring-search*
|
||||
module.
|
||||
|
||||
Contributors
|
||||
------------
|
||||
## Contributors
|
||||
|
||||
New features and bug fixes should be submitted to the [zsh-autosuggestions][1]
|
||||
project according to its rules and regulations. This module will be synchronized
|
||||
against it.
|
||||
|
||||
Settings
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Highlighting
|
||||
|
||||
@ -29,33 +26,31 @@ If colors are enabled, *autosuggestions* will automatically highlight
|
||||
positive results.
|
||||
|
||||
To enable highlighting for this module only, add the following line to
|
||||
*zpreztorc*:
|
||||
*~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:autosuggestions' color 'yes'
|
||||
```
|
||||
|
||||
To set the query found color, add the following line to *zpreztorc*:
|
||||
To set the query found color, add the following line to *~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:autosuggestions:color' found ''
|
||||
```
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
## Troubleshooting
|
||||
|
||||
### Autosuggestions from previous sessions don't show up
|
||||
|
||||
For autosuggestions from previous shell sessions to work, please make sure you
|
||||
also have the `history` module enabled.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][3].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/tarruda/zsh-autosuggestions
|
||||
[2]: http://fishshell.com
|
||||
[2]: https://fishshell.com
|
||||
[3]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
@ -1,9 +1,8 @@
|
||||
Command-Not-Found
|
||||
=================
|
||||
# Command-Not-Found
|
||||
|
||||
When you try to use a command that is not available locally, searches
|
||||
the package manager for a package offering that command and suggests
|
||||
the proper install command.
|
||||
When you try to use a command that is not available locally, searches the
|
||||
package manager for a package offering that command and suggests the proper
|
||||
install command.
|
||||
|
||||
Debian and Arch Linux based distributions use the [`command-not-found`][1] tool.
|
||||
|
||||
@ -11,14 +10,12 @@ macOS uses Homebrew's [`command-not-found` clone][2]. Note that unless you have
|
||||
a recent version of Homebrew installed, you might also need to tap the
|
||||
`command-not-found` Homebrew repository [following the instructions][3].
|
||||
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][4].*
|
||||
|
||||
- [Joseph Booker](https://github.com/sargas)
|
||||
- [Indrajit Raychaudhuri](https://github.com/indrajitr)
|
||||
- [Joseph Booker](https://github.com/sargas)
|
||||
- [Indrajit Raychaudhuri](https://github.com/indrajitr)
|
||||
|
||||
[1]: https://code.launchpad.net/command-not-found
|
||||
[2]: https://github.com/Homebrew/homebrew-command-not-found
|
||||
|
@ -1,31 +1,29 @@
|
||||
Completion
|
||||
==========
|
||||
# Completion
|
||||
|
||||
Loads and configures tab completion and provides additional completions from
|
||||
the [zsh-completions][1] project.
|
||||
Loads and configures <kbd>TAB</kbd> completion and provides additional
|
||||
completions from the [zsh-completions][1] project.
|
||||
|
||||
This module must be loaded **after** the *utility* module.
|
||||
|
||||
Options
|
||||
-------
|
||||
## 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.
|
||||
- `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 <kbd>TAB</kbd> 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
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Ignore */etc/hosts* Entries
|
||||
|
||||
To ignore certain entries from static */etc/hosts* for host completion, add the
|
||||
following lines in *zpreztorc* with the IP addresses of the hosts as they
|
||||
following lines in *~/.zpreztorc* with the IP addresses of the hosts as they
|
||||
appear in */etc/hosts*. Both IP address and the corresponding hostname will be
|
||||
ignored during host completion. However, some of the entries ignored from
|
||||
*/etc/hosts* still might appear during completion because of their presence in
|
||||
@ -36,18 +34,16 @@ zstyle ':prezto:module:completion:*:hosts' etc-host-ignores \
|
||||
'0.0.0.0' '127.0.0.1'
|
||||
```
|
||||
|
||||
Contributors
|
||||
------------
|
||||
## Contributors
|
||||
|
||||
Completions should be submitted to the [zsh-completions][1] project according
|
||||
to its rules and regulations. This module will be synchronized against it.
|
||||
Completions should be submitted to the [zsh-completions][1] project according to
|
||||
its rules and regulations. This module will be synchronized against it.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][2].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/zsh-users/zsh-completions
|
||||
[2]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
@ -1,34 +1,30 @@
|
||||
Directory
|
||||
=========
|
||||
# Directory
|
||||
|
||||
Sets directory options and defines directory aliases.
|
||||
|
||||
Options
|
||||
-------
|
||||
## Options
|
||||
|
||||
- `AUTO_CD` auto changes to a directory without typing `cd`.
|
||||
- `AUTO_PUSHD` pushes the old directory onto the stack on `cd`.
|
||||
- `PUSHD_IGNORE_DUPS` does not store duplicates in the stack.
|
||||
- `PUSHD_SILENT` does not print the directory stack after `pushd` or `popd`.
|
||||
- `PUSHD_TO_HOME` pushes to the home directory when no argument is given.
|
||||
- `CDABLE_VARS` changes directory to a path stored in a variable.
|
||||
- `MULTIOS` writes to multiple descriptors.
|
||||
- `EXTENDED_GLOB` uses extended globbing syntax.
|
||||
- `CLOBBER` does not overwrite existing files with `>` and `>>`. Use `>!` and
|
||||
`>>!` to bypass.
|
||||
- `AUTO_CD` auto changes to a directory without typing `cd`.
|
||||
- `AUTO_PUSHD` pushes the old directory onto the stack on `cd`.
|
||||
- `PUSHD_IGNORE_DUPS` does not store duplicates in the stack.
|
||||
- `PUSHD_SILENT` does not print the directory stack after `pushd` or `popd`.
|
||||
- `PUSHD_TO_HOME` pushes to the home directory when no argument is given.
|
||||
- `CDABLE_VARS` changes directory to a path stored in a variable.
|
||||
- `MULTIOS` writes to multiple descriptors.
|
||||
- `EXTENDED_GLOB` uses extended globbing syntax.
|
||||
- `CLOBBER` does not overwrite existing files with `>` and `>>`. Use `>!` and
|
||||
`>>!` to bypass.
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
- `d` prints the contents of the directory stack.
|
||||
- `1 ... 9` changes the directory to the **n** previous one.
|
||||
- `d` prints the contents of the directory stack.
|
||||
- `1 ... 9` changes the directory to the **n** previous one.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][1].*
|
||||
|
||||
- [James Cox](https://github.com/imajes)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [James Cox](https://github.com/imajes)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
@ -1,29 +1,25 @@
|
||||
DNF
|
||||
===
|
||||
# DNF
|
||||
|
||||
Defines [dnf][1] aliases.
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
- `dnfc` removes package(s) and leaves.
|
||||
- `dnfi` installs package(s).
|
||||
- `dnfh` displays history.
|
||||
- `dnfl` lists packages.
|
||||
- `dnfL` lists installed packages.
|
||||
- `dnfq` displays package information.
|
||||
- `dnfr` removes package(s).
|
||||
- `dnfs` searches for a package.
|
||||
- `dnfu` updates packages.
|
||||
- `dnfU` upgrades packages.
|
||||
- `dnfc` removes package(s) and leaves.
|
||||
- `dnfi` installs package(s).
|
||||
- `dnfh` displays history.
|
||||
- `dnfl` lists packages.
|
||||
- `dnfL` lists installed packages.
|
||||
- `dnfq` displays package information.
|
||||
- `dnfr` removes package(s).
|
||||
- `dnfs` searches for a package.
|
||||
- `dnfu` updates packages.
|
||||
- `dnfU` upgrades packages.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][2].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://fedoraproject.org/wiki/Features/DNF
|
||||
[2]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
# ZSH Docker Aliases
|
||||
# Docker
|
||||
|
||||
Defines [Docker][1] aliases and functions.
|
||||
|
||||
@ -21,14 +21,15 @@ Defines [Docker][1] aliases and functions.
|
||||
- `dkli` Log in to a Docker registry
|
||||
- `dklo` Log out from a Docker registry
|
||||
- `dkls` is alias for `dkps`
|
||||
- `dkp` Pause all processes within one or more containers<Paste>
|
||||
- `dkp` Pause all processes within one or more containers
|
||||
- `dkP` Unpause all processes within one or more containers
|
||||
- `dkpl` Pull an image or a repository from a registry
|
||||
- `dkph` Push an image or a repository to a registry
|
||||
- `dkps` List containers
|
||||
- `dkpsa` List all containers (default lists just running)
|
||||
- `dkr` Run a command in a new container
|
||||
- `dkR` Run an interactive command in a new container and automatically remove the container when it exits
|
||||
- `dkR` Run an interactive command in a new container and automatically remove
|
||||
the container when it exits
|
||||
- `dkRe` like `dkR` and set entry point to `/bin/bash`
|
||||
- `dkrm` Remove one or more containers
|
||||
- `dkrmi` Remove one or more images
|
||||
@ -39,13 +40,14 @@ Defines [Docker][1] aliases and functions.
|
||||
- `dks` Start one or more stopped containers
|
||||
- `dkS` Restart a container
|
||||
- `dkss` Display a live stream of container(s) resource usage statistics
|
||||
- `dksv` Save one or more images to a tar archive (streamed to STDOUT by default)
|
||||
- `dksv` Save one or more images to a tar archive (streamed to STDOUT by
|
||||
default)
|
||||
- `dkt` Tag an image into a repository
|
||||
- `dktop` Display the running processes of a container
|
||||
- `dkup` Update configuration of one or more containers
|
||||
- `dkV` Manage Docker volumes
|
||||
- `dkv` Show the Docker version information
|
||||
- `dkw` Block until a container stops, then print its exit code<Paste>
|
||||
- `dkw` Block until a container stops, then print its exit code
|
||||
- `dkx` Stop a running container
|
||||
|
||||
#### container (C)
|
||||
@ -65,7 +67,8 @@ Defines [Docker][1] aliases and functions.
|
||||
- `dkCS` Restart one or more containers
|
||||
- `dkCrm` Remove one or more containers
|
||||
- `dkCr` Run a command in a new container
|
||||
- `dkCR` Run an interactive command in a new container and automatically remove the container when it exits
|
||||
- `dkCR` Run an interactive command in a new container and automatically remove
|
||||
the container when it exits
|
||||
- `dkCRe` like `dkCR` and set entry point to `/bin/bash`
|
||||
- `dkCs` Start one or more stopped containers
|
||||
- `dkCss` Display a live stream of container(s) resource usage statistics
|
||||
@ -87,7 +90,8 @@ Defines [Docker][1] aliases and functions.
|
||||
- `dkIpl` Pull an image or a repository from a registry
|
||||
- `dkIph` Push an image or a repository to a registry
|
||||
- `dkIrm` Remove one or more images
|
||||
- `dkIsv` Save one or more images to a tar archive (streamed to STDOUT by default)
|
||||
- `dkIsv` Save one or more images to a tar archive (streamed to STDOUT by
|
||||
default)
|
||||
- `dkIt` Tag an image into a repository
|
||||
|
||||
#### volume (V)
|
||||
|
@ -1,10 +1,8 @@
|
||||
Dpkg
|
||||
====
|
||||
# Dpkg
|
||||
|
||||
Defines [dpkg][1] aliases and functions.
|
||||
Defines [*dpkg*][1] aliases and functions.
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
- `debc` cleans the cache.
|
||||
- `debf` displays a file's package.
|
||||
@ -20,22 +18,20 @@ Aliases
|
||||
- `deb-kclean` removes all kernel images and headers, except for the ones in
|
||||
use.
|
||||
|
||||
Functions
|
||||
---------
|
||||
## Functions
|
||||
|
||||
- `deb-clone` generates a script that can be used to duplicate a dpkg-based
|
||||
- `deb-clone` generates a script that can be used to duplicate a `dpkg`-based
|
||||
system.
|
||||
- `deb-history` displays dpkg history.
|
||||
- `deb-kbuild` makes a dpkg Linux kernel package.
|
||||
- `deb-history` displays `dpkg` history.
|
||||
- `deb-kbuild` makes a `dpkg` Linux kernel package.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][2].*
|
||||
|
||||
- [Daniel Bolton](https://github.com/dbb)
|
||||
- [Benjamin Boudreau](https://github.com/dreur)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Daniel Bolton](https://github.com/dbb)
|
||||
- [Benjamin Boudreau](https://github.com/dreur)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: http://wiki.debian.org/Teams/Dpkg
|
||||
[1]: https://wiki.debian.org/Teams/Dpkg
|
||||
[2]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
@ -1,25 +1,21 @@
|
||||
Editor
|
||||
======
|
||||
# Editor
|
||||
|
||||
Sets editor specific key bindings options and variables.
|
||||
|
||||
Options
|
||||
-------
|
||||
## Options
|
||||
|
||||
- `BEEP` beep on error in line editor.
|
||||
- `BEEP` beep on error in line editor.
|
||||
|
||||
Variables
|
||||
---------
|
||||
## Variables
|
||||
|
||||
- `WORDCHARS` treat a given set of characters as part of a word.
|
||||
- `WORDCHARS` treat a given set of characters as part of a word.
|
||||
|
||||
Settings
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Key bindings
|
||||
|
||||
To enable key bindings, add the following to *zpreztorc*, and replace 'bindings'
|
||||
with 'emacs' or 'vi'.
|
||||
To enable key bindings, add the following to *~/.zpreztorc*, and replace
|
||||
'bindings' with 'emacs' or 'vi'.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:editor' key-bindings 'bindings'
|
||||
@ -28,7 +24,7 @@ zstyle ':prezto:module:editor' key-bindings 'bindings'
|
||||
### Dot Expansion
|
||||
|
||||
To enable the auto conversion of .... to ../.., add the following to
|
||||
*zpreztorc*.
|
||||
*~/.zpreztorc*.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:editor' dot-expansion 'yes'
|
||||
@ -37,14 +33,13 @@ zstyle ':prezto:module:editor' dot-expansion 'yes'
|
||||
### PS Context
|
||||
|
||||
To enable the prompt context to be set, add the following to your
|
||||
*zpreztorc*.
|
||||
*~/.zpreztorc*.
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:editor' ps-context 'yes'
|
||||
```
|
||||
|
||||
Theming
|
||||
-------
|
||||
## Theming
|
||||
|
||||
To indicate when the editor is in the primary keymap (emacs or viins), add
|
||||
the following to your `theme_prompt_setup` function.
|
||||
@ -84,8 +79,7 @@ zstyle ':prezto:module:editor:info:completing' format '...'
|
||||
Then add `$editor_info[context]`, where context is *keymap*, *insert*, or
|
||||
*overwrite*, to `$PROMPT` or `$RPROMPT`.
|
||||
|
||||
Convenience Functions
|
||||
---------------------
|
||||
## Convenience Functions
|
||||
|
||||
### bindkey-all
|
||||
|
||||
@ -99,11 +93,10 @@ It will also pass through arguments so you can use bindkey-all to set bindings
|
||||
for all keymaps at once. If provided arguments it will *not* print out the
|
||||
names of each of the keymaps, and just run the command for each keymap.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][1].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
@ -1,10 +1,8 @@
|
||||
Emacs
|
||||
=====
|
||||
# Emacs
|
||||
|
||||
Enables Emacs dependency management.
|
||||
|
||||
Dependency management
|
||||
---------------------
|
||||
## Dependency management
|
||||
|
||||
[Carton][1] installs and manages Emacs packages for Emacs package development
|
||||
and Emacs configuration.
|
||||
@ -12,22 +10,20 @@ and Emacs configuration.
|
||||
This module prepends the Carton directory to the path variable to enable the
|
||||
execution of `carton`.
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
### Carton
|
||||
|
||||
- `cai` installs dependencies.
|
||||
- `cau` updates dependencies.
|
||||
- `caI` initializes the current directory for dependency management.
|
||||
- `cae` executes a command which correct dependencies.
|
||||
- `cai` installs dependencies.
|
||||
- `cau` updates dependencies.
|
||||
- `caI` initializes the current directory for dependency management.
|
||||
- `cae` executes a command which correct dependencies.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][2].*
|
||||
|
||||
- [Sebastian Wiesner](https://github.com/lunaryorn)
|
||||
- [Sebastian Wiesner](https://github.com/lunaryorn)
|
||||
|
||||
[1]: https://github.com/rejeep/carton
|
||||
[2]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
@ -1,56 +1,51 @@
|
||||
Environment
|
||||
===========
|
||||
# Environment
|
||||
|
||||
Sets general shell options and defines environment variables.
|
||||
|
||||
This module must be loaded first.
|
||||
|
||||
Contributors
|
||||
------------
|
||||
## Contributors
|
||||
|
||||
This module **MUST NOT** rely on any command not built in Zsh.
|
||||
|
||||
Non-interactive environment variables should be defined in [`zshenv`][1].
|
||||
|
||||
Options
|
||||
-------
|
||||
## 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.
|
||||
- `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.
|
||||
- `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
|
||||
---------
|
||||
## 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.
|
||||
- `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
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][2].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/sorin-ionescu/prezto/blob/master/runcoms/zshenv
|
||||
[2]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
@ -1,5 +1,4 @@
|
||||
Fasd
|
||||
====
|
||||
# Fasd
|
||||
|
||||
[Fasd][1] is a command-line productivity booster, inspired by tools like
|
||||
[autojump][2], [z][3] and [v][4], it offers quick access to files and
|
||||
@ -12,30 +11,27 @@ module.
|
||||
The Prezto Fasd configuration differs from the default. The default aliases have
|
||||
been disabled.
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
`fasd` is bundled with prezto as a git submodule. Alternatively, you can manually install `fasd`.
|
||||
If a manual install is found, it will be used instead of the bundled version.
|
||||
`fasd` is bundled with prezto as a git submodule. Alternatively, you can
|
||||
manually install `fasd`. If a manual installation is found, it will be used
|
||||
instead of the bundled version.
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
- `j` changes the current working directory interactively.
|
||||
- `j` changes the current working directory interactively.
|
||||
|
||||
Completion
|
||||
----------
|
||||
## Completion
|
||||
|
||||
Type `,`, `f,`, `d,` in front of a comma-separated query or type `,,`, `,,f`,
|
||||
`,,d` at the end of a comma-separated query then hit <kbd>tab</kbd>.
|
||||
`,,d` at the end of a comma-separated query then hit <kbd>TAB</kbd>.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][5].*
|
||||
|
||||
- [Wei Dai](https://github.com/clvv)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Wei Dai](https://github.com/clvv)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/clvv/fasd
|
||||
[2]: https://github.com/joelthelion/autojump
|
||||
|
@ -1,13 +1,11 @@
|
||||
Git
|
||||
===
|
||||
# Git
|
||||
|
||||
Enhances the [Git][1] distributed version control system by providing aliases,
|
||||
functions and by exposing repository status information to prompts.
|
||||
|
||||
Git **1.7.2** is the [minimum required version][7].
|
||||
|
||||
Settings
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Log
|
||||
|
||||
@ -30,8 +28,7 @@ zstyle ':prezto:module:git:status:ignore' submodules 'all'
|
||||
|
||||
This setting affects all aliases and functions that call `git-status`.
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
Aliases are enabled by default. You can disable them with:
|
||||
|
||||
@ -41,288 +38,290 @@ zstyle ':prezto:module:git:alias' skip 'yes'
|
||||
|
||||
### Git
|
||||
|
||||
- `g` is short for `git`.
|
||||
- `g` is short for `git`.
|
||||
|
||||
### Branch
|
||||
### Branch (b)
|
||||
|
||||
- `gb` lists, creates, renames, and deletes branches.
|
||||
- `gbc` creates a new branch.
|
||||
- `gbl` lists branches and their commits. (also `gbv`)
|
||||
- `gbL` lists all local and remote branches and their commits.
|
||||
- `gbr` renames a branch. (also `gbm`)
|
||||
- `gbR` renames a branch even if the new branch name already exists. (also
|
||||
`gbM`)
|
||||
- `gbs` lists branches and their commits with ancestry graphs.
|
||||
- `gbS` lists local and remote branches and their commits with ancestry
|
||||
graphs.
|
||||
- `gbV` lists branches with more verbose information about their commits.
|
||||
- `gbx` deletes a branch. (also `gbd`)
|
||||
- `gbX` deletes a branch irrespective of its merged status. (also `gbD`)
|
||||
- `gb` lists, creates, renames, and deletes branches.
|
||||
- `gbc` creates a new branch.
|
||||
- `gbl` lists branches and their commits. (also `gbv`)
|
||||
- `gbL` lists all local and remote branches and their commits.
|
||||
- `gbr` renames a branch. (also `gbm`)
|
||||
- `gbR` renames a branch even if the new branch name already exists. (also
|
||||
`gbM`)
|
||||
- `gbs` lists branches and their commits with ancestry graphs.
|
||||
- `gbS` lists local and remote branches and their commits with ancestry graphs.
|
||||
- `gbV` lists branches with more verbose information about their commits.
|
||||
- `gbx` deletes a branch. (also `gbd`)
|
||||
- `gbX` deletes a branch irrespective of its merged status. (also `gbD`)
|
||||
|
||||
### Commit (c)
|
||||
|
||||
### Commit
|
||||
- `gc` records changes to the repository.
|
||||
- `gca` stages all modified and deleted files.
|
||||
- `gcm` records changes to the repository with the given message.
|
||||
- `gcS` records changes to the repository. (Signed)
|
||||
- `gcSa` stages all modified and deleted files. (Signed)
|
||||
- `gcSm` records changes to the repository with the given message. (Signed)
|
||||
- `gcam` stages all modified and deleted files, and records changes to the
|
||||
repository with the given message.
|
||||
- `gco` checks out a branch or paths to work tree.
|
||||
- `gcO` checks out hunks from the index or the tree interactively.
|
||||
- `gcf` amends the tip of the current branch using the same log message as
|
||||
*HEAD*.
|
||||
- `gcSf` amends the tip of the current branch using the same log message as
|
||||
*HEAD*. (Signed)
|
||||
- `gcF` amends the tip of the current branch.
|
||||
- `gcSF` amends the tip of the current branch. (Signed)
|
||||
- `gcp` applies changes introduced by existing commits.
|
||||
- `gcP` applies changes introduced by existing commits without committing.
|
||||
- `gcr` reverts existing commits by reverting patches and recording new commits.
|
||||
- `gcR` removes the *HEAD* commit.
|
||||
- `gcs` displays various types of objects.
|
||||
- `gcsS` displays commits with GPG signature.
|
||||
- `gcl` lists lost commits.
|
||||
- `gcy` displays commits yet to be applied to upstream in the short format.
|
||||
- `gcY` displays commits yet to be applied to upstream.
|
||||
|
||||
- `gc` records changes to the repository.
|
||||
- `gca` stages all modified and deleted files.
|
||||
- `gcm` records changes to the repository with the given message.
|
||||
- `gcS` records changes to the repository. (Signed)
|
||||
- `gcSa` stages all modified and deleted files. (Signed)
|
||||
- `gcSm` records changes to the repository with the given message. (Signed)
|
||||
- `gcam` stages all modified and deleted files, and records changes to the repository with the given message.
|
||||
- `gco` checks out a branch or paths to work tree.
|
||||
- `gcO` checks out hunks from the index or the tree interactively.
|
||||
- `gcf` amends the tip of the current branch using the same log message as *HEAD*.
|
||||
- `gcSf` amends the tip of the current branch using the same log message as *HEAD*. (Signed)
|
||||
- `gcF` amends the tip of the current branch.
|
||||
- `gcSF` amends the tip of the current branch. (Signed)
|
||||
- `gcp` applies changes introduced by existing commits.
|
||||
- `gcP` applies changes introduced by existing commits without committing.
|
||||
- `gcr` reverts existing commits by reverting patches and recording new
|
||||
commits.
|
||||
- `gcR` removes the *HEAD* commit.
|
||||
- `gcs` displays various types of objects.
|
||||
- `gcsS` displays commits with GPG signature.
|
||||
- `gcl` lists lost commits.
|
||||
- `gcy` displays commits yet to be applied to upstream in the short format.
|
||||
- `gcY` displays commits yet to be applied to upstream.
|
||||
### Conflict (C)
|
||||
|
||||
### Conflict
|
||||
- `gCl` lists unmerged files.
|
||||
- `gCa` adds unmerged file contents to the index.
|
||||
- `gCe` executes merge-tool on all unmerged file.
|
||||
- `gCo` checks out our changes for unmerged paths.
|
||||
- `gCO` checks out our changes for all unmerged paths.
|
||||
- `gCt` checks out their changes for unmerged paths.
|
||||
- `gCT` checks out their changes for all unmerged paths.
|
||||
|
||||
- `gCl` lists unmerged files.
|
||||
- `gCa` adds unmerged file contents to the index.
|
||||
- `gCe` executes merge-tool on all unmerged file.
|
||||
- `gCo` checks out our changes for unmerged paths.
|
||||
- `gCO` checks out our changes for all unmerged paths.
|
||||
- `gCt` checks out their changes for unmerged paths.
|
||||
- `gCT` checks out their changes for all unmerged paths.
|
||||
### Data (d)
|
||||
|
||||
### Data
|
||||
- `gd` displays information about files in the index and the work tree.
|
||||
- `gdc` lists cached files.
|
||||
- `gdx` lists deleted files.
|
||||
- `gdm` lists modified files.
|
||||
- `gdu` lists untracked files.
|
||||
- `gdk` lists killed files.
|
||||
- `gdi` lists ignored files.
|
||||
|
||||
- `gd` displays information about files in the index and the work tree.
|
||||
- `gdc` lists cached files.
|
||||
- `gdx` lists deleted files.
|
||||
- `gdm` lists modified files.
|
||||
- `gdu` lists untracked files.
|
||||
- `gdk` lists killed files.
|
||||
- `gdi` lists ignored files.
|
||||
### Fetch (f)
|
||||
|
||||
### Fetch
|
||||
- `gf` downloads objects and references from another repository.
|
||||
- `gfa` downloads objects and references from all remote repositories.
|
||||
- `gfc` clones a repository into a new directory.
|
||||
- `gfcr` clones a repository into a new directory including all submodules.
|
||||
- `gfm` fetches from and merges with another repository or local branch.
|
||||
- `gfr` fetches from and rebases on another repository or local branch.
|
||||
|
||||
- `gf` downloads objects and references from another repository.
|
||||
- `gfa` downloads objects and references from all remote repositories.
|
||||
- `gfc` clones a repository into a new directory.
|
||||
- `gfcr` clones a repository into a new directory including all submodules.
|
||||
- `gfm` fetches from and merges with another repository or local branch.
|
||||
- `gfr` fetches from and rebases on another repository or local branch.
|
||||
### Flow (F)
|
||||
|
||||
### Flow
|
||||
- `gFi` is short for `git flow init`
|
||||
|
||||
- `gFi` is short for `git flow init`
|
||||
#### Feature (Ff)
|
||||
|
||||
#### Feature
|
||||
- `gFf` is short for `git flow feature`
|
||||
- `gFfl` is short for `git flow feature list`
|
||||
- `gFfs` is short for `git flow feature start`
|
||||
- `gFff` is short for `git flow feature finish`
|
||||
- `gFfp` is short for `git flow feature publish`
|
||||
- `gFft` is short for `git flow feature track`
|
||||
- `gFfd` is short for `git flow feature diff`
|
||||
- `gFfr` is short for `git flow feature rebase`
|
||||
- `gFfc` is short for `git flow feature checkout`
|
||||
- `gFfm` is short for `git flow feature pull`
|
||||
- `gFfx` is short for `git flow feature delete`
|
||||
|
||||
- `gFf` is short for `git flow feature`
|
||||
- `gFfl` is short for `git flow feature list`
|
||||
- `gFfs` is short for `git flow feature start`
|
||||
- `gFff` is short for `git flow feature finish`
|
||||
- `gFfp` is short for `git flow feature publish`
|
||||
- `gFft` is short for `git flow feature track`
|
||||
- `gFfd` is short for `git flow feature diff`
|
||||
- `gFfr` is short for `git flow feature rebase`
|
||||
- `gFfc` is short for `git flow feature checkout`
|
||||
- `gFfm` is short for `git flow feature pull`
|
||||
- `gFfx` is short for `git flow feature delete`
|
||||
#### Bugfix (Fb)
|
||||
|
||||
#### Bugfix
|
||||
- `gFb` is short for `git flow bugfix`
|
||||
- `gFbl` is short for `git flow bugfix list`
|
||||
- `gFbs` is short for `git flow bugfix start`
|
||||
- `gFbf` is short for `git flow bugfix finish`
|
||||
- `gFbp` is short for `git flow bugfix publish`
|
||||
- `gFbt` is short for `git flow bugfix track`
|
||||
- `gFbd` is short for `git flow bugfix diff`
|
||||
- `gFbr` is short for `git flow bugfix rebase`
|
||||
- `gFbc` is short for `git flow bugfix checkout`
|
||||
- `gFbm` is short for `git flow bugfix pull`
|
||||
- `gFbx` is short for `git flow bugfix delete`
|
||||
|
||||
- `gFb` is short for `git flow bugfix`
|
||||
- `gFbl` is short for `git flow bugfix list`
|
||||
- `gFbs` is short for `git flow bugfix start`
|
||||
- `gFbf` is short for `git flow bugfix finish`
|
||||
- `gFbp` is short for `git flow bugfix publish`
|
||||
- `gFbt` is short for `git flow bugfix track`
|
||||
- `gFbd` is short for `git flow bugfix diff`
|
||||
- `gFbr` is short for `git flow bugfix rebase`
|
||||
- `gFbc` is short for `git flow bugfix checkout`
|
||||
- `gFbm` is short for `git flow bugfix pull`
|
||||
- `gFbx` is short for `git flow bugfix delete`
|
||||
#### Release (Fl)
|
||||
|
||||
#### Release
|
||||
- `gFl` is short for `git flow release`
|
||||
- `gFll` is short for `git flow release list`
|
||||
- `gFls` is short for `git flow release start`
|
||||
- `gFlf` is short for `git flow release finish`
|
||||
- `gFlp` is short for `git flow release publish`
|
||||
- `gFlt` is short for `git flow release track`
|
||||
- `gFld` is short for `git flow release diff`
|
||||
- `gFlr` is short for `git flow release rebase`
|
||||
- `gFlc` is short for `git flow release checkout`
|
||||
- `gFlm` is short for `git flow release pull`
|
||||
- `gFlx` is short for `git flow release delete`
|
||||
|
||||
- `gFl` is short for `git flow release`
|
||||
- `gFll` is short for `git flow release list`
|
||||
- `gFls` is short for `git flow release start`
|
||||
- `gFlf` is short for `git flow release finish`
|
||||
- `gFlp` is short for `git flow release publish`
|
||||
- `gFlt` is short for `git flow release track`
|
||||
- `gFld` is short for `git flow release diff`
|
||||
- `gFlr` is short for `git flow release rebase`
|
||||
- `gFlc` is short for `git flow release checkout`
|
||||
- `gFlm` is short for `git flow release pull`
|
||||
- `gFlx` is short for `git flow release delete`
|
||||
#### Hotfix (Fh)
|
||||
|
||||
#### Hotfix
|
||||
- `gFh` is short for `git flow hotfix`
|
||||
- `gFhl` is short for `git flow hotfix list`
|
||||
- `gFhs` is short for `git flow hotfix start`
|
||||
- `gFhf` is short for `git flow hotfix finish`
|
||||
- `gFhp` is short for `git flow hotfix publish`
|
||||
- `gFht` is short for `git flow hotfix track`
|
||||
- `gFhd` is short for `git flow hotfix diff`
|
||||
- `gFhr` is short for `git flow hotfix rebase`
|
||||
- `gFhc` is short for `git flow hotfix checkout`
|
||||
- `gFhm` is short for `git flow hotfix pull`
|
||||
- `gFhx` is short for `git flow hotfix delete`
|
||||
|
||||
- `gFh` is short for `git flow hotfix`
|
||||
- `gFhl` is short for `git flow hotfix list`
|
||||
- `gFhs` is short for `git flow hotfix start`
|
||||
- `gFhf` is short for `git flow hotfix finish`
|
||||
- `gFhp` is short for `git flow hotfix publish`
|
||||
- `gFht` is short for `git flow hotfix track`
|
||||
- `gFhd` is short for `git flow hotfix diff`
|
||||
- `gFhr` is short for `git flow hotfix rebase`
|
||||
- `gFhc` is short for `git flow hotfix checkout`
|
||||
- `gFhm` is short for `git flow hotfix pull`
|
||||
- `gFhx` is short for `git flow hotfix delete`
|
||||
#### Support (Fs)
|
||||
|
||||
#### Support
|
||||
- `gFs` is short for `git flow support`
|
||||
- `gFsl` is short for `git flow support list`
|
||||
- `gFss` is short for `git flow support start`
|
||||
- `gFsf` is short for `git flow support finish`
|
||||
- `gFsp` is short for `git flow support publish`
|
||||
- `gFst` is short for `git flow support track`
|
||||
- `gFsd` is short for `git flow support diff`
|
||||
- `gFsr` is short for `git flow support rebase`
|
||||
- `gFsc` is short for `git flow support checkout`
|
||||
- `gFsm` is short for `git flow support pull`
|
||||
- `gFsx` is short for `git flow support delete`
|
||||
|
||||
- `gFs` is short for `git flow support`
|
||||
- `gFsl` is short for `git flow support list`
|
||||
- `gFss` is short for `git flow support start`
|
||||
- `gFsf` is short for `git flow support finish`
|
||||
- `gFsp` is short for `git flow support publish`
|
||||
- `gFst` is short for `git flow support track`
|
||||
- `gFsd` is short for `git flow support diff`
|
||||
- `gFsr` is short for `git flow support rebase`
|
||||
- `gFsc` is short for `git flow support checkout`
|
||||
- `gFsm` is short for `git flow support pull`
|
||||
- `gFsx` is short for `git flow support delete`
|
||||
### Grep (g)
|
||||
|
||||
### Grep
|
||||
- `gg` displays lines matching a pattern.
|
||||
- `ggi` displays lines matching a pattern ignoring case.
|
||||
- `ggl` lists files matching a pattern.
|
||||
- `ggL` lists files that are not matching a pattern.
|
||||
- `ggv` displays lines not matching a pattern.
|
||||
- `ggw` displays lines matching a pattern at word boundary.
|
||||
|
||||
- `gg` displays lines matching a pattern.
|
||||
- `ggi` displays lines matching a pattern ignoring case.
|
||||
- `ggl` lists files matching a pattern.
|
||||
- `ggL` lists files that are not matching a pattern.
|
||||
- `ggv` displays lines not matching a pattern.
|
||||
- `ggw` displays lines matching a pattern at word boundary.
|
||||
### Index (i)
|
||||
|
||||
### Index
|
||||
- `gia` adds file contents to the index.
|
||||
- `giA` adds file contents to the index interactively.
|
||||
- `giu` adds file contents to the index (updates only known files).
|
||||
- `gid` displays changes between the index and a named commit (diff).
|
||||
- `giD` displays changes between the index and a named commit (word diff).
|
||||
- `gii` temporarily ignore differences in a given file.
|
||||
- `giI` unignore differences in a given file.
|
||||
- `gir` resets the current HEAD to the specified state.
|
||||
- `giR` resets the current index interactively.
|
||||
- `gix` removes files/directories from the index (recursively).
|
||||
- `giX` removes files/directories from the index (recursively and forced).
|
||||
|
||||
- `gia` adds file contents to the index.
|
||||
- `giA` adds file contents to the index interactively.
|
||||
- `giu` adds file contents to the index (updates only known files).
|
||||
- `gid` displays changes between the index and a named commit (diff).
|
||||
- `giD` displays changes between the index and a named commit (word diff).
|
||||
- `gii` temporarily ignore differences in a given file.
|
||||