dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 11:38:00 +00:00
Code Issues Releases Wiki Activity

Improve diction in documentation

Browse Source
This commit is contained in:
Sorin Ionescu 2012-06-02 17:17:12 -04:00
parent c28c5edd21
commit b2b90c22f8
12 changed files with 85 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/completion/README.md
View File

@ -1,8 +1,8 @@
Completion
==========
Loads and configures tab completion and provides additional completions from the
[zsh-completions][1] project.
Loads and configures tab completion and provides additional completions from
the [zsh-completions][1] project.
This module must be loaded **after** the *alias* module but **before** the
*utility* module.
@ -11,7 +11,7 @@ Contributors
------------
Completions should be submitted to the [zsh-completions][1] project according
to its rules and regulations. This module will be synched against it.
to its rules and regulations. This module will be synchronized against it.
Authors
-------

24
modules/directory/README.md
View File

@ -6,23 +6,23 @@ Sets directory options and defines directory aliases.
Options
-------
- `AUTO_CD` auto cd to a directory without typing `cd`.
- `AUTO_PUSHD` push the old directory onto the stack on `cd`.
- `PUSHD_IGNORE_DUPS` don't store duplicates in the stack.
- `PUSHD_SILENT` do not print the directory stack after `pushd` or `popd`.
- `PUSHD_TO_HOME` push to home directory when no argument is given.
- `CDABLE_VARS` change directory to a path stored in a variable.
- `AUTO_NAME_DIRS` auto add variable-stored paths to `~` list.
- `MULTIOS` write to multiple descriptors.
- `EXTENDED_GLOB` use extended globbing syntax.
- `CLOBBER` don't overwrite existing files with `>` and `>>`. Use `>!` and
- `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.
- `AUTO_NAME_DIRS` auto adds variable-stored paths to `~` list.
- `MULTIOS` writes to multiple descriptors.
- `EXTENDED_GLOB` uses extended globbing syntax.
- `CLOBBER` does not overwrite existing files with `>` and `>>`. Use `>!` and
`>>!` to bypass.
Aliases
-------
- `d` print the contents of the directory stack.
- `1 ... 9` change 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
-------

6
modules/directory/init.zsh
View File

@ -6,16 +6,16 @@
# Sorin Ionescu <sorin.ionescu@gmail.com>
#
setopt AUTO_CD # Auto cd to a directory without typing cd.
setopt AUTO_CD # Auto changes to a directory without typing cd.
setopt AUTO_PUSHD # Push the old directory onto the stack on cd.
setopt PUSHD_IGNORE_DUPS # Don't store duplicates in the stack.
setopt PUSHD_IGNORE_DUPS # Do not store duplicates in the stack.
setopt PUSHD_SILENT # Do not print the directory stack after pushd or popd.
setopt PUSHD_TO_HOME # Push to home directory when no argument is given.
setopt CDABLE_VARS # Change directory to a path stored in a variable.
setopt AUTO_NAME_DIRS # Auto add variable-stored paths to ~ list.
setopt MULTIOS # Write to multiple descriptors.
setopt EXTENDED_GLOB # Use extended globbing syntax.
unsetopt CLOBBER # Don't overwrite existing files with > and >>.
unsetopt CLOBBER # Do not overwrite existing files with > and >>.
# Use >! and >>! to bypass.
# Aliases

28
modules/dpkg/init.zsh
View File

@ -8,24 +8,24 @@
#
# Aliases
alias as="aptitude -F \"* %p -> %d \n(%v/%V)\" --no-gui --disable-columns search" # Search package.
alias ad="sudo apt-get update" # Update packages lists.
alias au="sudo apt-get update && sudo apt-get dselect-upgrade" # Upgrade packages.
alias ai="sudo apt-get install" # Install package.
alias ar="sudo apt-get remove --purge && sudo apt-get autoremove --purge" # Remove package.
alias ap="apt-cache policy" # Apt policy.
alias av="apt-cache show" # Show package info.
alias acs="apt-cache search" # Search package.
alias ac="sudo apt-get clean && sudo apt-get autoclean" # Clean apt cache.
alias afs='apt-file search --regexp' # Find file's packake.
alias as="aptitude -F \"* %p -> %d \n(%v/%V)\" --no-gui --disable-columns search" # Searches for a package.
alias ad="sudo apt-get update" # Updates packages lists.
alias au="sudo apt-get update && sudo apt-get dselect-upgrade" # Upgrades packages.
alias ai="sudo apt-get install" # Installs package.
alias ar="sudo apt-get remove --purge && sudo apt-get autoremove --purge" # Removes package.
alias ap="apt-cache policy" # Prints pinning levels.
alias av="apt-cache show" # Shows package info.
alias acs="apt-cache search" # Searches for a package.
alias ac="sudo apt-get clean && sudo apt-get autoclean" # Cleans cache.
alias afs='apt-file search --regexp' # Finds a file's packake.
# Install all .deb files in the current directory.
# WARNING: you will need to put the glob in single quotes if you use glob_subst.
# Installs all .deb files in the current directory.
# WARNING: You will need to put the glob in single quotes if you use GLOB_SUBST.
alias debi='su -c "dpkg -i ./*.deb"'
# Create a basic .deb package.
# Creates a basic .deb package.
alias debc='time dpkg-buildpackage -rfakeroot -us -uc'
# Remove ALL kernel images and headers EXCEPT the one in use.
# Removes ALL kernel images and headers EXCEPT the one in use.
alias kclean='su -c '\''aptitude remove -P ?and(~i~nlinux-(ima|hea) ?not(~n`uname -r`))'\'' root'

34
modules/history/README.md
View File

@ -6,31 +6,31 @@ Sets [history][1] options and defines history aliases.
VARIABLES
---------
- `HISTFILE` the file to save the history in when an interactive shell exits.
- `HISTSIZE` the maximum size of the history list.
- `SAVEHIST` the maximum number of history events to save in the history file.
- `HISTFILE` stores the path to the history file.
- `HISTSIZE` stores the maximum number of events to save in the internal history.
- `SAVEHIST` stores the maximum number of events to save in the history file.
Options
-------
- `BANG_HIST` treat the **!** character specially during expansion.
- `EXTENDED_HISTORY` write the history file in the *:start:elapsed;command* format.
- `INC_APPEND_HISTORY` write to the history file immediately, not when the shell exits.
- `SHARE_HISTORY` share history between all sessions.
- `HIST_EXPIRE_DUPS_FIRST` expire duplicate entries first when trimming history.
- `HIST_IGNORE_DUPS` do not record an entry that was just recorded again.
- `HIST_IGNORE_ALL_DUPS` delete old recorded entry if new entry is a duplicate.
- `HIST_FIND_NO_DUPS` do not display a line previously found.
- `HIST_IGNORE_SPACE` do not record an entry starting with a space.
- `HIST_SAVE_NO_DUPS` do not write duplicate entries in the history file.
- `HIST_REDUCE_BLANKS` remove superfluous blanks before recording entry.
- `HIST_VERIFY` do not execute immediately upon history expansion.
- `HIST_BEEP` beep when accessing non-existent history.
- `BANG_HIST` treats the **!** character specially during expansion.
- `EXTENDED_HISTORY` writes the history file in the *:start:elapsed;command* format.
- `INC_APPEND_HISTORY` writes to the history file immediately, not when the shell exits.
- `SHARE_HISTORY` shares history between all sessions.
- `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_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.
- `HIST_REDUCE_BLANKS` removes superfluous blanks before recording an event.
- `HIST_VERIFY` does not execute immediately upon history expansion.
- `HIST_BEEP` beeps when accessing non-existent history.
Aliases
-------
- `history-stat` list the ten most used commands
- `history-stat` lists the ten most used commands
Authors
-------

20
modules/history/init.zsh
View File

@ -6,21 +6,21 @@
# Sorin Ionescu <sorin.ionescu@gmail.com>
#
HISTFILE="$HOME/.zhistory"
HISTSIZE=10000
SAVEHIST=10000
HISTFILE="$HOME/.zhistory" # The path to the history file.
HISTSIZE=10000 # The maximum number of events to save in the internal history.
SAVEHIST=10000 # The maximum number of events to save in the history file.
setopt BANG_HIST # Treat the '!' character specially during expansion.
setopt EXTENDED_HISTORY # Write the history file in the ':start:elapsed;command' format.
setopt INC_APPEND_HISTORY # Write to the history file immediately, not when the shell exits.
setopt SHARE_HISTORY # Share history between all sessions.
setopt HIST_EXPIRE_DUPS_FIRST # Expire duplicate entries first when trimming history.
setopt HIST_IGNORE_DUPS # Do not record an entry that was just recorded again.
setopt HIST_IGNORE_ALL_DUPS # Delete old recorded entry if new entry is a duplicate.
setopt HIST_FIND_NO_DUPS # Do not display a line previously found.
setopt HIST_IGNORE_SPACE # Do not record an entry starting with a space.
setopt HIST_SAVE_NO_DUPS # Do not write duplicate entries in the history file.
setopt HIST_REDUCE_BLANKS # Remove superfluous blanks before recording entry.
setopt HIST_EXPIRE_DUPS_FIRST # Expire a duplicate event first when trimming history.
setopt HIST_IGNORE_DUPS # Do not record an event that was just recorded again.
setopt HIST_IGNORE_ALL_DUPS # Delete an old recorded event if a new event is a duplicate.
setopt HIST_FIND_NO_DUPS # Do not display a previously found event.
setopt HIST_IGNORE_SPACE # Do not record an event starting with a space.
setopt HIST_SAVE_NO_DUPS # Do not write a duplicate event to the history file.
setopt HIST_REDUCE_BLANKS # Remove superfluous blanks before recording an event.
setopt HIST_VERIFY # Do not execute immediately upon history expansion.
setopt HIST_BEEP # Beep when accessing non-existent history.

22
modules/osx/README.md
View File

@ -6,23 +6,25 @@ Defines [Mac OS X][1] aliases and functions.
Aliases
-------
- `cdf` change the current working director to the current _Finder_ directory.
- `pushdf` push the current working directory onto the directory queue and
- `ql` quick look at files.
- `rm-osx-cruft` delete .DS\_Store, \_\_MACOSX cruft.
- `cdf` changes the current working director to the current _Finder_
directory.
- `pushdf` pushes the current working directory onto the directory queue and
- `ql` quick looks at files.
- `rm-osx-cruft` deletes .DS\_Store, \_\_MACOSX cruft.
Functions
---------
- `manb` open _man_ pages in [_Bwana.app_][2].
- `manp` open _man_ pages in _Preview.app_.
- `pfd` print current _Finder_ directory.
- `pfs` print current _Finder_ selection.
- `tab` create a new tab (works in both _Terminal_ and [_iTerm_][3]).
- `trash` move files and folders to _Trash_.
- `manb` opens _man_ pages in [_Bwana.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]).
- `trash` moves files and folders to _Trash_.
Authors
-------
*The authors of this module should be contacted via the [issue tracker][4].*
- [Sorin Ionescu](https://github.com/sorin-ionescu)

5
modules/python/README.md
View File

@ -9,8 +9,9 @@ Local Package Installation
Since version 2.6, Python supports per user package installation, as defined in
[PEP 370][1].
This module prepends per user site directories to the relevant path variables to
enable the execution of user installed scripts and the reading of documentation.
This module prepends per user site directories to the relevant path variables
to enable the execution of user installed scripts and the reading of
documentation.
### Usage

8
modules/screen/README.md
View File

@ -6,16 +6,16 @@ Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.
Aliases
-------
- `sl` list sessions/socket directory.
- `sn` start a new session.
- `sr` attach to a session if one exists or start a new one.
- `sl` lists sessions/socket directory.
- `sn` starts a new session.
- `sr` attaches to a session if one exists or start a new one.
Settings
--------
### Auto-start
Start a Screen session automatically when Zsh is launched.
Starts a GNU Screen session automatically when Zsh is launched.
To enable this feature, add the following line to *zshrc*:

6
modules/tmux/README.md
View File

@ -6,15 +6,15 @@ Defines [tmux][1] aliases and provides for auto launching it at start-up.
Aliases
-------
- `ta` attach or switch to a tmux session.
- `tl` list sessions managed by the tmux server.
- `ta` attaches or switches to a tmux session.
- `tl` lists sessions managed by the tmux server.
Settings
--------
### Auto-start
Start a tmux session automatically when Zsh is launched.
Starts a tmux session automatically when Zsh is launched.
To enable this feature, add the following line to *zshrc*:

4
modules/utility/README.md
View File

@ -1,7 +1,7 @@
Utility
=======
Defines additional utilities functions.
Defines additional utility functions.
Aliases
-------
@ -16,7 +16,7 @@ Functions
- `cdls` changes to a directory and lists its contents.
- `pushdls` pushes an entry onto the directory stack and lists its contents.
- `popdls` pops an entry off the directory stack and lists its contents.
- `slit` prints columns 1 2 3 ... n.
- `slit` prints columns 1, 2, 3 ... n.
- `find-exec` finds files and executes a command on them.
Authors

4
modules/z/README.md
View File

@ -7,8 +7,8 @@ information see [z][1].
Aliases
-------
- `z` cd to most frecent dir matching.
- `j` same as `z` for [autojump][2] converts.
- `z` changes the directory to most *frecent* match.
- `j` is the same as `z` for [autojump][2] converts.
Authors
-------