general: Update documentation better qualifying runcom paths
Zsh and Prezto files don't always reside in `~/`. Instead, they have
a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them
unambiguous in the documentation. Likewise, for `$GNUPGHOME`.
Further, add instruction for optionally setting up Prezto in
`$XDG_CONFIG_HOME`.
While at this, also add clarification on relative ordering of some of
the modules, apply more formatting tweaks and doc improvements.
master
Indrajit Raychaudhuri4 years agocommitted byIndrajit Raychaudhuri
03. Create a new Zsh configuration by copying/linking the Zsh configuration
files provided:
```console
setopt EXTENDED_GLOB
@ -34,10 +58,10 @@ version is **4.3.11**.
@@ -34,10 +58,10 @@ version is **4.3.11**.
**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
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*.
[_`runcoms`_][10].
04. Set Zsh as your default shell:
@ -50,7 +74,7 @@ version is **4.3.11**.
@@ -50,7 +74,7 @@ version is **4.3.11**.
### Troubleshooting
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
the `PATH` variable in _`${ZDOTDIR:-$HOME}/.zprofile`_ then open a new Zsh
terminal window or tab.
## Updating
@ -76,33 +100,33 @@ accompanying README files to learn about what is available.
@@ -76,33 +100,33 @@ accompanying README files to learn about what is available.
### Modules
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.
01. Browse [_`modules`_][9] to see what is available.
02. Load the modules you need in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and then open
a new Zsh terminal window or tab.
### Themes
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.
03. Load the theme you like in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ and 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
*${ZDOTDIR:-$HOME}/.zpreztorc*) to enable this module.
Note that the [_`git`_][11] 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
01. By default modules will be loaded from */modules* and */contrib*.
01. By default modules will be loaded from [_`/modules`_][9] and _`/contrib`_.
02. Additional module directories can be added to the
`:prezto:load:pmodule-dirs` setting in *${ZDOTDIR:-$HOME}/.zpreztorc*.
`:prezto:load:pmodule-dirs` setting in _`${ZDOTDIR:-$HOME}/.zpreztorc`_.
Note that module names need to be unique or they will cause an error when
- _.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
@ -34,14 +38,16 @@ full advantage of all available CPU cores for compression.
@@ -34,14 +38,16 @@ full advantage of all available CPU cores for compression.
## Alternatives
Specifically on macOS, [The Unarchiver][1] provides a similar command line tool
Specifically on macOS, [The Unarchiver][2] provides a similar command line tool
which doesn't depend on a number of other programs being installed.
## Authors
*The authors of this module should be contacted via the [issue tracker][1].*
_The authors of this module should be contacted via the [issue tracker][3]._
@ -5,13 +5,16 @@ Integrates [zsh-autosuggestions][1] into Prezto, which implements the
@@ -5,13 +5,16 @@ Integrates [zsh-autosuggestions][1] into Prezto, which implements the
of a previously entered command and Zsh suggests commands as you type based on
history and completions.
If this module is used in conjunction with the *syntax-highlighting* module,
this module must be loaded **after** the *syntax-highlighting* module.
If this module is used in conjunction with the [_`syntax-highlighting`_][3]
module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
If this module is used in conjunction with the *history-substring-search*
module, this module must be loaded **after** the *history-substring-search*
If this module is used in conjunction with the [_`history-substring-search`_][4]
module, this module must be loaded _after_ the _`history-substring-search`_
module.
To elaborate, the relative order of loading the modules would be
_`autosuggestions`_, _`syntax-highlighting`_ and _`history-substring-search`_.
## Contributors
New features and bug fixes should be submitted to the [zsh-autosuggestions][1]
@ -22,17 +25,18 @@ against it.
@@ -22,17 +25,18 @@ against it.
### Highlighting
If colors are enabled, *autosuggestions* will automatically highlight
If colors are enabled, _autosuggestions_ will automatically highlight
positive results.
To enable highlighting for this module only, add the following line to
*~/.zpreztorc*:
_`${ZDOTDIR:-$HOME}/.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
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:autosuggestions:color' found ''
@ -47,10 +51,12 @@ also have the `history` module enabled.
@@ -47,10 +51,12 @@ also have the `history` module enabled.
## Authors
*The authors of this module should be contacted via the [issue tracker][3].*
_The authors of this module should be contacted via the [issue tracker][5]._
@ -12,7 +12,7 @@ a recent version of Homebrew installed, you might also need to tap the
@@ -12,7 +12,7 @@ a recent version of Homebrew installed, you might also need to tap the
## Authors
*The authors of this module should be contacted via the [issue tracker][4].*
_The authors of this module should be contacted via the [issue tracker][4]._
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.
This module must be loaded late _after_ the _`utility`_ module and all other
modules that provide completion definitions.
## Options
@ -14,20 +15,20 @@ This module must be loaded **after** the *utility* module.
@@ -14,20 +15,20 @@ This module must be loaded **after** the *utility* module.
- `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*.
- `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
### Ignore */etc/hosts* Entries
### 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
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
*ssh* configuration or history).
To ignore certain entries from static _`/etc/hosts`_ for host completion, add
the following lines in _`${ZDOTDIR:-$HOME}/.zpreztorc`_ with the IP addresses of
the hosts as they appear in _`/etc/hosts`_. Both IP address and the associated
hostname(s) 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 _ssh_ configuration or history).
@ -41,7 +42,7 @@ its rules and regulations. This module will be synchronized against it.
@@ -41,7 +42,7 @@ its rules and regulations. This module will be synchronized against it.
## Authors
*The authors of this module should be contacted via the [issue tracker][2].*
_The authors of this module should be contacted via the [issue tracker][2]._
To enable the prompt context to be set, add the following to your
*~/.zpreztorc*.
To enable the prompt context to be set, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:editor' ps-context 'yes'
@ -76,26 +76,26 @@ To indicate when the editor is completing, add the following to your
@@ -76,26 +76,26 @@ To indicate when the editor is completing, add the following to your
zstyle ':prezto:module:editor:info:completing' format '...'
```
Then add `$editor_info[context]`, where context is *keymap*, *insert*, or
*overwrite*, to `$PROMPT` or `$RPROMPT`.
Then add `$editor_info[context]`, where context is _keymap_, _insert_, or
_overwrite_, to `$PROMPT` or `$RPROMPT`.
## Convenience Functions
### bindkey-all
Provides a function `bindkey-all` which can be useful for checking how all of the
keys are bound. Normal `bindkey` command will only list the keys bound for one
keymap, which is not as useful if you want to grep through the output. The
keymap's names go to stderr so when you grep through bindkey-all's output you
Provides a function `bindkey-all` which can be useful for checking how all of
the keys are bound. Normal `bindkey` command will only list the keys bound for
one keymap, which is not as useful if you want to grep through the output. The
keymap's names go to stderr so when you grep through `bindkey-all`'s output you
will still see the headings and can tell which keymap each binding goes to.
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
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
*The authors of this module should be contacted via the [issue tracker][1].*
_The authors of this module should be contacted via the [issue tracker][1]._
@ -6,9 +6,10 @@ This module must be loaded first.
@@ -6,9 +6,10 @@ This module must be loaded first.
## Contributors
This module **MUST NOT** rely on any command not built in Zsh.
This module **MUST NOT** rely on any command that is not built in Zsh.
Non-interactive environment variables should be defined in [`zshenv`][1].
Non-interactive environment variables should be defined in
[_`${ZDOTDIR:-$HOME}/.zshenv`_][1].
## Options
@ -43,9 +44,9 @@ Non-interactive environment variables should be defined in [`zshenv`][1].
@@ -43,9 +44,9 @@ Non-interactive environment variables should be defined in [`zshenv`][1].
## Authors
*The authors of this module should be contacted via the [issue tracker][2].*
_The authors of this module should be contacted via the [issue tracker][2]._
directories by keeping track of files and directories that were previously
accessed.
For completion to work, this module must be loaded **after** the *completion*
module.
For shell completion to work, this module must be loaded _after_ the
[_`completion`_][5] module.
The Prezto Fasd configuration differs from the default. The default aliases have
been disabled.
@ -28,7 +28,7 @@ Type `,`, `f,`, `d,` in front of a comma-separated query or type `,,`, `,,f`,
@@ -28,7 +28,7 @@ Type `,`, `f,`, `d,` in front of a comma-separated query or type `,,`, `,,f`,
## Authors
*The authors of this module should be contacted via the [issue tracker][5].*
_The authors of this module should be contacted via the [issue tracker][6]._
@ -37,4 +37,5 @@ Type `,`, `f,`, `d,` in front of a comma-separated query or type `,,`, `,,f`,
@@ -37,4 +37,5 @@ Type `,`, `f,`, `d,` in front of a comma-separated query or type `,,`, `,,f`,
- `gm` shadows the [GraphicsMagick image processor][11].
- `gpt` shadows the [GUID partition table maintenance utility][4].
- `gs` shadows the [Ghostscript interpreter and previewer][5].
@ -335,7 +343,7 @@ You can temporarily bypass an alias by prefixing it with a backward slash:
@@ -335,7 +343,7 @@ You can temporarily bypass an alias by prefixing it with a backward slash:
- `git-commit-lost` lists lost commits.
- `git-dir` displays the path to the Git directory.
- `git-hub-browse` opens the [GitHub][3] repository in the default browser.
@ -8,7 +8,7 @@ Provides for an easier use of [GPG][1] by setting up [gpg-agent][2].
@@ -8,7 +8,7 @@ Provides for an easier use of [GPG][1] by setting up [gpg-agent][2].
To enable OpenSSH Agent protocol emulation, and make `gpg-agent` a drop-in
replacement for `ssh-agent`, add the following line to
*`~/.gnupg/gpg-agent.conf`*:
_`$GNUPGHOME/gpg-agent.conf`_ or _`$$HOME/.gnupg/gpg-agent.conf`_:
```conf
enable-ssh-support
@ -19,7 +19,7 @@ module for additional processing.
@@ -19,7 +19,7 @@ module for additional processing.
## Authors
*The authors of this module should be contacted via the [issue tracker][3].*
_The authors of this module should be contacted via the [issue tracker][3]._
@ -17,7 +17,7 @@ Install packages into per user directories with `cabal install --user`.
@@ -17,7 +17,7 @@ Install packages into per user directories with `cabal install --user`.
## Authors
*The authors of this module should be contacted via the [issue tracker][2].*
_The authors of this module should be contacted via the [issue tracker][2]._
@ -5,8 +5,8 @@ Integrates [`zsh-history-substring-search`][1] into Prezto, which implements the
@@ -5,8 +5,8 @@ Integrates [`zsh-history-substring-search`][1] into Prezto, which implements the
a previously entered command and press up and down to cycle through matching
commands.
If this module is used in conjunction with the *syntax-highlighting* module,
this module must be loaded **after** the *syntax-highlighting* module.
If this module is used in conjunction with the [_`syntax-highlighting`_][3]
module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
## Contributors
@ -19,7 +19,7 @@ regulations. This module will be synchronized against it.
@@ -19,7 +19,7 @@ regulations. This module will be synchronized against it.
### Case Sensitivity
To enable case-sensitivity for this module only, add the following line to
Sets [history][1] options and defines history aliases.
**Note:** Default path of `HISTFILE` has changed from *`${ZDOTDIR:-$HOME}/.zhistory`*
to *`${ZDOTDIR:-$HOME}/.zsh_history`*. The file will be automatically renamed if
possible (when the new one doesn't exist). Otherwise, if you want to preserve
previous history, you will need to move them from *`${ZDOTDIR:-$HOME}/.zhistory`*
to *`${ZDOTDIR:-$HOME}/.zsh_history`*.
**Note:** Default path of `HISTFILE` has changed from
_`${ZDOTDIR:-$HOME}/.zhistory`_ to _`${ZDOTDIR:-$HOME}/.zsh_history`_. The file
will be automatically renamed if possible (when the new one doesn't exist).
Otherwise, if you want to preserve previous history, you will need to move them
from _`${ZDOTDIR:-$HOME}/.zhistory`_ to _`${ZDOTDIR:-$HOME}/.zsh_history`_.
Alternately, you can set `HISTFILE` manually to *`${ZDOTDIR:-$HOME}/.zhistory`*.
Alternately, you can set `HISTFILE` manually to _`${ZDOTDIR:-$HOME}/.zhistory`_.
## Options
- `BANG_HIST` treats the **!** character specially during expansion.
- `EXTENDED_HISTORY` writes the history file in the *:start:elapsed;command* format.
- `EXTENDED_HISTORY` writes the history file in the _:start:elapsed;command_
format.
- `SHARE_HISTORY` shares history between all sessions. Note that
`SHARE_HISTORY`, `INC_APPEND_HISTORY`, and `INC_APPEND_HISTORY_TIME` are
mutually exclusive.
- `HIST_EXPIRE_DUPS_FIRST` expires a duplicate event first when trimming history.
- `HIST_IGNORE_DUPS` does not record an event that was just recorded again.
- `HIST_IGNORE_ALL_DUPS` deletes an old recorded event if a new event is a duplicate.
- `HIST_IGNORE_ALL_DUPS` deletes an old recorded event if a new event is a
duplicate.
- `HIST_FIND_NO_DUPS` does not display a previously found event.
- `HIST_IGNORE_SPACE` does not record an event starting with a space.
- `HIST_SAVE_NO_DUPS` does not write a duplicate event to the history file.
@ -38,7 +40,7 @@ Alternately, you can set `HISTFILE` manually to *`${ZDOTDIR:-$HOME}/.zhistory`*.
@@ -38,7 +40,7 @@ Alternately, you can set `HISTFILE` manually to *`${ZDOTDIR:-$HOME}/.zhistory`*.
## Authors
*The authors of this module should be contacted via the [issue tracker][2].*
_The authors of this module should be contacted via the [issue tracker][2]._
Provides utility functions for [Node.js][1], loads the Node Version Manager, and
enables [*npm*][2] completion.
enables [_npm_][2] completion.
## nvm
[*nvm*][5] allows for managing multiple, isolated Node.js installations in the
[_nvm_][5] allows for managing multiple, isolated Node.js installations in the
home directory.
This will be loaded automatically if nvm is installed in `$NVM_DIR`,
*~/.nvm*, or nvm is installed with homebrew.
_`~/.nvm`_, or nvm is installed with Homebrew.
## nodenv
[*nodenv*][6] does one thing well - it is concerned solely with switching
[_nodenv_][6] does one thing well - it is concerned solely with switching
Node versions. It is simple and predictable, Just Works, and is rock solid in
production. nodenv is forked from the popular [*rbenv*][7].
production. nodenv is forked from the popular [_rbenv_][7].
This will be loaded automatically if nodenv is installed in `$NODENV_ROOT`,
*~/.nodenv*, or `nodenv` is on the path.
_`~/.nodenv`_, or `nodenv` is on the path.
## Functions
@ -42,7 +42,7 @@ Then add `$node_info[version]` to either `$PROMPT` or `$RPROMPT` and call
@@ -42,7 +42,7 @@ Then add `$node_info[version]` to either `$PROMPT` or `$RPROMPT` and call
## Authors
*The authors of this module should be contacted via the [issue tracker][4].*
_The authors of this module should be contacted via the [issue tracker][4]._
@ -15,7 +15,7 @@ Install packages to your local package directory with `opam install`.
@@ -15,7 +15,7 @@ Install packages to your local package directory with `opam install`.
## Authors
*The authors of this module should be contacted via the [issue tracker][3].*
_The authors of this module should be contacted via the [issue tracker][3]._
@ -15,11 +15,12 @@ supported by Archlinux. It is currently recommended to manually build AUR
@@ -15,11 +15,12 @@ supported by Archlinux. It is currently recommended to manually build AUR
packages using the [provided instructions][3]. The [aurutils][4] project has a
set of small utilities to make this easier.
To enable a Pacman frontend, add the following line to *~/.zpreztorc*,
substituting *pacman_frontend* with the name of the frontend:
To enable a different Pacman frontend, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_, and replace `'<frontend>'` with the name
@ -6,11 +6,11 @@ Enables local [Perl][1] module installation on macOS and defines aliases.
@@ -6,11 +6,11 @@ Enables local [Perl][1] module installation on macOS and defines aliases.
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
macOS in *`~/Library/Perl/5.12`* by altering the environment.
macOS in _`~/Library/Perl/5.12`_ by altering the environment.
### Usage
For Perl versions older than 5.14, install *`local::lib`*.
For Perl versions older than 5.14, install _`local::lib`_.
@ -33,10 +33,10 @@ management of multiple, isolated Perl installations in the home directory.
@@ -33,10 +33,10 @@ management of multiple, isolated Perl installations in the home directory.
## plenv
Yet another alternative is [*plenv*][3]. This is inspired from *rbenv* and
Yet another alternative is [_plenv_][3]. This is inspired from _rbenv_ and
enables switching between multiple binary installations.
The subcommands of *plenv* is similar with *rbenv*.
The subcommands of _plenv_ is similar with _rbenv_.
## Aliases
@ -96,7 +96,7 @@ Then add `$perl_info[version]` to `$PROMPT` or `$RPROMPT` and call
@@ -96,7 +96,7 @@ Then add `$perl_info[version]` to `$PROMPT` or `$RPROMPT` and call
## Authors
*The authors of this module should be contacted via the [issue tracker][4].*
_The authors of this module should be contacted via the [issue tracker][4]._
@ -18,7 +18,7 @@ WARNING: Prezto does not support 'powerlevel9k' anymore as it has
@@ -18,7 +18,7 @@ WARNING: Prezto does not support 'powerlevel9k' anymore as it has
been deprecated and is not supported by its author.
Consider migrating to 'powerlevel10k' instead by setting:
@ -5,14 +5,16 @@ Enables local Python and local Python package installation.
@@ -5,14 +5,16 @@ Enables local Python and local Python package installation.
## Settings
This module supports virtual environments from conda and
[*virtualenvwrapper*][2]. By default, only *virtualenvwrapper* is enabled. To
disable *virtualenvwrapper*, add the following to *~/.zpreztorc*.
[_virtualenvwrapper_][2]. By default, only _virtualenvwrapper_ is enabled. To
Conda support is enabled by adding the following to *~/.zpreztorc*.
Conda support can be enabled by adding the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:python' conda-init 'on'
@ -22,18 +24,18 @@ Caution: using conda and virtualenvwrapper at the same time may cause conflicts.
@@ -22,18 +24,18 @@ Caution: using conda and virtualenvwrapper at the same time may cause conflicts.
## Local Python Installation
[*pyenv*][4] builds and installs multiple Python versions locally in the home
[_pyenv_][4] builds and installs multiple Python versions locally in the home
directory.
This module prepends the *pyenv* directory to the path variable to enable the
This module prepends the _pyenv_ directory to the path variable to enable the
execution of `pyenv`.
### Usage
Install Python versions with `pyenv install` into *~/.pyenv/versions*.
Install Python versions with `pyenv install` into _`~/.pyenv/versions`_.
This will be loaded automatically if pyenv is installed to `$PYENV_ROOT`,
*~/.pyenv*, or if the `pyenv` command is on the path.
_`~/.pyenv`_, or if the `pyenv` command is on the path.
## Local Package Installation
@ -50,7 +52,7 @@ Install packages into the per user site directory with `pip install --user`.
@@ -50,7 +52,7 @@ Install packages into the per user site directory with `pip install --user`.
## virtualenvwrapper
[*virtualenvwrapper*][2] is a frontend to the popular [*virtualenv*][3] utility.
[_virtualenvwrapper_][2] is a frontend to the popular [_virtualenv_][3] utility.
`virtualenv` creates isolated Python environments and `virtualenvwrapper`
provides convenient shell functions to create, switch, and manage them.
@ -59,14 +61,15 @@ provides convenient shell functions to create, switch, and manage them.
@@ -59,14 +61,15 @@ provides convenient shell functions to create, switch, and manage them.
Install `virtualenvwrapper`.
Virtual environments are stored in *~/.virtualenvs*.
Virtual environments are stored in _`~/.virtualenvs`_.
There are configuration variables that have to be set to enable certain features.
If you wish to use these features, export the variables in [`zshenv`][6].
There are configuration variables that have to be set to enable certain
features. If you wish to use these features, export the variables in
[_`${ZDOTDIR:-$HOME}/.zshenv`_][6].
The variable `$PROJECT_HOME` tells `virtualenvwrapper` where to place project
working directories. It must be set and the directory created before `mkproject`
is used. Replace *Developer* with your projects directory.
is used. Replace _Developer_ with your projects directory.
@ -94,7 +94,7 @@ Then add `$ruby_info[version]` to `$PROMPT` or `$RPROMPT` and call
@@ -94,7 +94,7 @@ Then add `$ruby_info[version]` to `$PROMPT` or `$RPROMPT` and call
## Authors
*The authors of this module should be contacted via the [issue tracker][6].*
_The authors of this module should be contacted via the [issue tracker][6]._
@ -9,14 +9,14 @@ Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.
@@ -9,14 +9,14 @@ Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.
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*:
line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:screen:auto-start' local 'yes'
```
To enable this feature when launching Zsh in a SSH connection, add the following
@ -79,7 +79,7 @@ Use `$BG[none]`, `$FG[none]`, or `$FX[none]` to turn off formatting.
@@ -79,7 +79,7 @@ Use `$BG[none]`, `$FG[none]`, or `$FX[none]` to turn off formatting.
## Authors
*The authors of this module should be contacted via the [issue tracker][2].*
_The authors of this module should be contacted via the [issue tracker][2]._
To format terminal window and tab titles, add the following to *~/.zpreztorc*:
To format terminal window and tab titles, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:terminal:window-title' format '%n@%m: %s'
@ -44,7 +45,7 @@ For a list of sequences, see [Expansion of Prompt Sequences][1].
@@ -44,7 +45,7 @@ For a list of sequences, see [Expansion of Prompt Sequences][1].
## Authors
*The authors of this module should be contacted via the [issue tracker][2].*
_The authors of this module should be contacted via the [issue tracker][2]._
Defines [*tmux*][1] aliases and provides for auto launching it at start-up.
Defines [_tmux_][1] aliases and provides for auto launching it at start-up.
## Settings
@ -9,14 +9,14 @@ Defines [*tmux*][1] aliases and provides for auto launching it at start-up.
@@ -9,14 +9,14 @@ Defines [*tmux*][1] aliases and provides for auto launching it at start-up.
Starts a tmux session automatically when Zsh is launched.
To enable this feature when launching Zsh in a local terminal, add the following
line to *~/.zpreztorc*:
line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
```sh
zstyle ':prezto:module:tmux:auto-start' local 'yes'
```
To enable this feature when launching Zsh in a SSH connection, add the following
@ -61,7 +61,7 @@ Read [iTerm2 and tmux Integration][7] for more information.
@@ -61,7 +61,7 @@ Read [iTerm2 and tmux Integration][7] for more information.
On macOS, launching tmux can cause the error **launch_msg(...): Socket is not
connected** to be displayed, which can be fixed by installing
[reattach-to-user-namespace][3], available in [Homebrew][4], and adding the
@ -4,13 +4,13 @@ This module provides a wrapper around the [wakeonlan][1] tool.
@@ -4,13 +4,13 @@ This module provides a wrapper around the [wakeonlan][1] tool.
## Usage
To use this wrapper, create the *`~/.wakeonlan`* directory, and place in it one
To use this wrapper, create the _`~/.wakeonlan`_ 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.
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
`*~/.wakeonlan/leto`* with the following contents:
_`~/.wakeonlan/leto`_ with the following contents:
```conf
00:11:22:33:44:55:66 192.168.0.255
@ -27,7 +27,7 @@ For more information on the configuration file format, read the
@@ -27,7 +27,7 @@ For more information on the configuration file format, read the
## Authors
*The authors of this module should be contacted via [issue tracker][3].*
_The authors of this module should be contacted via [issue tracker][3]._
@ -14,19 +14,19 @@ not defined, Zsh will use the user's home directory.
@@ -14,19 +14,19 @@ not defined, Zsh will use the user's home directory.
## File Descriptions
The configuration files are read in the following order:
01. */etc/zshenv*
02. *~/.zshenv*
03. */etc/zprofile*
04. *~/.zprofile*
05. */etc/zshrc*
06. *~/.zshrc*
07. *~/.zpreztorc*
08. */etc/zlogin*
09. *~/.zlogin*
10. *~/.zlogout*
11. */etc/zlogout*
The [configuration files][1] are read in the following order:
01. *`/etc/zshenv`*
02. *`${ZDOTDIR:-$HOME}/.zshenv`*
03. *`/etc/zprofile`*
04. *`${ZDOTDIR:-$HOME}/.zprofile`*
05. *`/etc/zshrc`*
06. *`${ZDOTDIR:-$HOME}/.zshrc`*
07. *`${ZDOTDIR:-$HOME}/.zpreztorc`*
08. *`/etc/zlogin`*
09. *`${ZDOTDIR:-$HOME}/.zlogin`*
10. *`${ZDOTDIR:-$HOME}/.zlogout`*
11. *`/etc/zlogout`*
### zshenv
@ -36,7 +36,7 @@ small as possible and should only define environment variables.
@@ -36,7 +36,7 @@ small as possible and should only define environment variables.
### zprofile
This file is similar to *zlogin*, but it is sourced before *zshrc*. It was added
for [KornShell][1] fans. See the description of *zlogin* below for what it may
for [KornShell][2] fans. See the description of *zlogin* below for what it may
contain.
*zprofile* and *zlogin* are not meant to be used together but can be done so.
@ -54,7 +54,7 @@ This file configures Prezto.
@@ -54,7 +54,7 @@ This file configures Prezto.
This file is sourced by login shells after *zshrc*. Thus, it should contain
commands that need to execute at login. It is usually used for messages such as
[*fortune*][2], [*msgs*][3], or for the creation of files.
[*fortune*][3], [*msgs*][4], or for the creation of files.
This is not the file to define aliases, functions, shell options, and key
bindings. It should not change the shell environment.
@ -66,11 +66,12 @@ displaying messages and for deletion of files.
@@ -66,11 +66,12 @@ displaying messages and for deletion of files.
## Authors
*The authors of these files should be contacted via the [issue tracker][4].*
*The authors of these files should be contacted via the [issue tracker][5].*
Indrajit Raychaudhuri
4 years ago
committed by