Browse Source

Improve diction in documentation

master
Sorin Ionescu 13 years ago
parent
commit
b2b90c22f8
  1. 6
      modules/completion/README.md
  2. 24
      modules/directory/README.md
  3. 6
      modules/directory/init.zsh
  4. 28
      modules/dpkg/init.zsh
  5. 34
      modules/history/README.md
  6. 20
      modules/history/init.zsh
  7. 22
      modules/osx/README.md
  8. 5
      modules/python/README.md
  9. 8
      modules/screen/README.md
  10. 6
      modules/tmux/README.md
  11. 4
      modules/utility/README.md
  12. 4
      modules/z/README.md

6
modules/completion/README.md

@ -1,8 +1,8 @@
Completion Completion
========== ==========
Loads and configures tab completion and provides additional completions from the Loads and configures tab completion and provides additional completions from
[zsh-completions][1] project. the [zsh-completions][1] project.
This module must be loaded **after** the *alias* module but **before** the This module must be loaded **after** the *alias* module but **before** the
*utility* module. *utility* module.
@ -11,7 +11,7 @@ Contributors
------------ ------------
Completions should be submitted to the [zsh-completions][1] project according 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 Authors
------- -------

24
modules/directory/README.md

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

6
modules/directory/init.zsh

@ -6,16 +6,16 @@
# Sorin Ionescu <sorin.ionescu@gmail.com> # 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 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_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 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 CDABLE_VARS # Change directory to a path stored in a variable.
setopt AUTO_NAME_DIRS # Auto add variable-stored paths to ~ list. setopt AUTO_NAME_DIRS # Auto add variable-stored paths to ~ list.
setopt MULTIOS # Write to multiple descriptors. setopt MULTIOS # Write to multiple descriptors.
setopt EXTENDED_GLOB # Use extended globbing syntax. 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. # Use >! and >>! to bypass.
# Aliases # Aliases

28
modules/dpkg/init.zsh

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

34
modules/history/README.md

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

20
modules/history/init.zsh

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

22
modules/osx/README.md

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

5
modules/python/README.md

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

8
modules/screen/README.md

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

6
modules/tmux/README.md

@ -6,15 +6,15 @@ Defines [tmux][1] aliases and provides for auto launching it at start-up.
Aliases Aliases
------- -------
- `ta` attach or switch to a tmux session. - `ta` attaches or switches to a tmux session.
- `tl` list sessions managed by the tmux server. - `tl` lists sessions managed by the tmux server.
Settings Settings
-------- --------
### Auto-start ### 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*: To enable this feature, add the following line to *zshrc*:

4
modules/utility/README.md

@ -1,7 +1,7 @@
Utility Utility
======= =======
Defines additional utilities functions. Defines additional utility functions.
Aliases Aliases
------- -------
@ -16,7 +16,7 @@ Functions
- `cdls` changes to a directory and lists its contents. - `cdls` changes to a directory and lists its contents.
- `pushdls` pushes an entry onto the directory stack 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. - `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. - `find-exec` finds files and executes a command on them.
Authors Authors

4
modules/z/README.md

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

Loading…
Cancel
Save