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://').pull/1915/head
Indrajit Raychaudhuri
4 years ago
committed by
Indrajit Raychaudhuri
parent
8edc5e9323
commit
d80e393f78
@ -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,50 +1,44 @@
|
||||
OSX
|
||||
===
|
||||
# OSX
|
||||
|
||||
Defines [macOS][1] aliases and functions.
|
||||
|
||||
Settings
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Dash Keyword
|
||||
|
||||
To change the keyword used by `mand` to open man pages in [_Dash.app_][2] from
|
||||
its default value of 'manpages', add the following line in *zpreztorc* and
|
||||
replace the **keyword** with the one configured in [_Dash.app_][2].
|
||||
To change the keyword used by `mand` to open man pages in [*Dash.app*][2] from
|
||||
its default value of 'manpages', add the following line in *~/.zpreztorc* and
|
||||
replace the **keyword** with the one configured in [*Dash.app*][2].
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:osx:man' dash-keyword 'keyword'
|
||||
```
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
- `cdf` changes the current working director to the current _Finder_
|
||||
directory.
|
||||
- `cdf` changes the current working director to the current *Finder* directory.
|
||||
- `pushdf` pushes the current working directory onto the directory queue and
|
||||
changes the current working director to the current _Finder_ directory.
|
||||
changes the current working director to the current *Finder* directory.
|
||||
|
||||
Functions
|
||||
---------
|
||||
## Functions
|
||||
|
||||
- `mand` opens _man_ pages in [_Dash.app_][2].
|
||||
- `manp` opens _man_ pages in _Preview.app_.
|
||||
- `pfd` prints the current _Finder_ directory.
|
||||
- `pfs` prints the current _Finder_ selection.
|
||||
- `tab` creates a new tab (works in both _Terminal_ and [_iTerm_][3]).
|
||||
- `mand` opens _man_ pages in [*Dash.app*][2].
|
||||
- `manp` opens _man_ pages in *Preview.app*.
|
||||
- `pfd` prints the current *Finder* directory.
|
||||
- `pfs` prints the current *Finder* selection.
|
||||
- `tab` creates a new tab (works in both _Terminal_ and [*iTerm.app*][3]).
|
||||
- `ql` previews files in Quick Look.
|
||||
- `osx-rm-dir-metadata` deletes .DS\_Store, \_\_MACOSX cruft.
|
||||
- `osx-rm-dir-metadata` deletes *.DS_Store*, *__MACOSX* cruft.
|
||||
- `osx-ls-download-history` displays the macOS download history.
|
||||
- `osx-rm-download-history` deletes the macOS download history.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][4].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: http://www.apple.com/macosx/
|
||||
[2]: http://kapeli.com/dash
|
||||
[3]: http://www.iterm2.com/
|
||||
[1]: https://www.apple.com/macos/
|
||||
[2]: https://kapeli.com/dash
|
||||
[3]: https://www.iterm2.com/
|
||||
[4]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
||||
@ -1,44 +1,40 @@
|
||||
GNU Screen
|
||||
==========
|
||||
# GNU Screen
|
||||
|
||||
Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.
|
||||
|
||||
Settings
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Auto-Start
|
||||
|
||||
Starts a GNU Screen session automatically when Zsh is launched.
|
||||
|
||||
To enable this feature when launching Zsh in a local terminal, add the
|
||||
following line to *zpreztorc*:
|
||||
To enable this feature when launching Zsh in a local terminal, add the following
|
||||
line to *~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:screen:auto-start' local 'yes'
|
||||
```
|
||||
|
||||
To enable this feature when launching Zsh in a SSH connection, add the
|
||||
following line to *zpreztorc*:
|
||||
To enable this feature when launching Zsh in a SSH connection, add the following
|
||||
line to *~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:screen:auto-start' remote 'yes'
|
||||
```
|
||||
|
||||
Aliases
|
||||
-------
|
||||
## Aliases
|
||||
|
||||
- `scr` is short for `screen`.
|
||||
- `scrl` lists sessions/socket directory.
|
||||
- `scrn` starts a new session.
|
||||
- `scrr` attaches to a session if one exists or start a new one.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][2].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Georges Discry](https://github.com/gdiscry)
|
||||
|
||||
[1]: http://www.gnu.org/software/screen/
|
||||
[1]: https://www.gnu.org/software/screen/
|
||||
[2]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
||||
@ -1,26 +1,23 @@
|
||||
SSH
|
||||
===
|
||||
# SSH
|
||||
|
||||
Provides for an easier use of [SSH][1] by setting up [ssh-agent][2].
|
||||
Provides for an easier use of [SSH][1] by setting up [*ssh-agent*][2].
|
||||
|
||||
Settings
|
||||
--------
|
||||
## Settings
|
||||
|
||||
### Identities
|
||||
|
||||
To load multiple identities, add the following line to *zpreztorc*:
|
||||
To load multiple identities, add the following line to *~/.zpreztorc*:
|
||||
|
||||
```sh
|
||||
zstyle ':prezto:module:ssh:load' identities 'id_rsa' 'id_dsa' 'id_github'
|
||||
```
|
||||
|
||||
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]: http://www.openssh.com
|
||||
[2]: http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-agent&sektion=1
|
||||
[1]: https://www.openssh.com
|
||||
[2]: https://www.openbsd.org/cgi-bin/man.cgi?query=ssh-agent&sektion=1
|
||||
[3]: https://github.com/sorin-ionescu/prezto/issues
|
||||
|
||||
Loading…
Reference in new issue