Browse Source

doc: More copyediting and formatting for consistency

master
Indrajit Raychaudhuri 6 years ago
parent
commit
1ca11ef045
  1. 6
      modules/archive/README.md
  2. 5
      modules/autosuggestions/README.md
  3. 5
      modules/command-not-found/README.md
  4. 14
      modules/environment/README.md
  5. 8
      modules/python/README.md
  6. 7
      modules/utility/README.md

6
modules/archive/README.md

@ -31,9 +31,9 @@ installed:
- *.7z* requires `7za`. - *.7z* requires `7za`.
- *.deb* requires `ar`, `tar`. - *.deb* requires `ar`, `tar`.
Additionally, if `pigz` and/or `pbzip2` are installed, `archive` will use them over Additionally, if `pigz` and/or `pbzip2` are installed, `archive` will use them
their traditional counterparts, `gzip` and `bzip2` respectively, to take full advantage over their traditional counterparts, `gzip` and `bzip2` respectively, to take
of all available CPU cores for compression. full advantage of all available CPU cores for compression.
Alternatives Alternatives
------------ ------------

5
modules/autosuggestions/README.md

@ -1,8 +1,3 @@
Autosuggestions
---------------
Integrates zsh-autosuggestions into Prezto.
Autosuggestions Autosuggestions
=============== ===============

5
modules/command-not-found/README.md

@ -5,9 +5,10 @@ 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 package manager for a package offering that command and suggests
the proper install command. the proper install command.
Debian-based and Arch Linux-based distributions use the [`command-not-found`][1] tool. Debian and Arch Linux based distributions use the [`command-not-found`][1] tool.
macOS uses Homebrew's [`command-not-found` clone][2]. Note that you also need to [follow the instructions to tap the `command-not-found` homebrew repository][3]. macOS uses Homebrew's [`command-not-found` clone][2]. Note that you also need to
[follow the instructions][3] to tap the `command-not-found` homebrew repository.
Authors Authors

14
modules/environment/README.md

@ -5,6 +5,13 @@ Sets general shell options and defines environment variables.
This module must be loaded first. This module must be loaded first.
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
------- -------
@ -38,13 +45,6 @@ Variables
- `LESS_TERMCAP_ue` ends underline. - `LESS_TERMCAP_ue` ends underline.
- `LESS_TERMCAP_us` begins underline. - `LESS_TERMCAP_us` begins underline.
Contributors
------------
This module **MUST NOT** rely on any command not built in Zsh.
Non-interactive environment variables should be defined in [`zshenv`][1].
Authors Authors
------- -------

8
modules/python/README.md

@ -6,7 +6,9 @@ Enables local Python and local Python package installation.
Settings Settings
-------- --------
This module supports virtual environments from conda and virtualenvwrapper. By default, only virtualenvwrapper is enabled. To disable virtualenvwrapper, add the following to *zpreztorc*. This module supports virtual environments from conda and virtualenvwrapper. By
default, only virtualenvwrapper is enabled. To disable virtualenvwrapper, add
the following to *zpreztorc*.
```sh ```sh
zstyle ':prezto:module:python' skip-virtualenvwrapper-init 'on' zstyle ':prezto:module:python' skip-virtualenvwrapper-init 'on'
@ -52,8 +54,8 @@ 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 `virtualenv` creates isolated Python environments and `virtualenvwrapper`
convenient shell functions to create, switch, and manage them. provides convenient shell functions to create, switch, and manage them.
### Usage ### Usage

7
modules/utility/README.md

@ -8,8 +8,8 @@ Settings
### Highlighting ### Highlighting
If you have enabled color globally in *zpreztorc*, you may disable it for certain If you have enabled color globally in *zpreztorc*, you may disable it for
commands. certain commands.
To disable `ls` color, add the following line to *zpreztorc*; when coloring is To disable `ls` color, add the following line to *zpreztorc*; when coloring is
disabled, type indicators (\*, /, =>, @, =, |, %) will be appended to entries. disabled, type indicators (\*, /, =>, @, =, |, %) will be appended to entries.
@ -109,7 +109,8 @@ Aliases
### Resource Usage ### Resource Usage
- `df` displays free disk space using human readable units (aliases to `pydf`, if installed). - `df` displays free disk space using human readable units (aliases to `pydf`,
if installed).
- `du` displays disk usage using human readable units. - `du` displays disk usage using human readable units.
- `top` displays information about processes. - `top` displays information about processes.
- `topc` displays information about processes sorted by CPU usage. - `topc` displays information about processes sorted by CPU usage.

Loading…
Cancel
Save