zsh-completions/README.md

77 lines
3.9 KiB
Markdown
Raw Normal View History

2017-10-19 18:13:28 +00:00
zsh-completions ![GitHub release](https://img.shields.io/github/release/zsh-users/zsh-completions.svg) ![GitHub contributors](https://img.shields.io/github/contributors/zsh-users/zsh-completions.svg) [![IRC](https://img.shields.io/badge/IRC-%23zsh--completions-yellow.svg)](irc://irc.freenode.net/#zsh-completions) [![Gitter](https://badges.gitter.im/zsh-users/zsh-completions.svg)](https://gitter.im/zsh-users/zsh-completions?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2016-11-26 17:16:54 +00:00
=============
2011-07-20 12:38:50 +00:00
**Additional completion definitions for [Zsh](http://www.zsh.org).**
2016-11-26 17:16:54 +00:00
*This projects aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts may be contributed to the Zsh project when stable enough.*
2011-07-20 12:38:50 +00:00
2016-11-26 17:16:54 +00:00
## Status
2013-02-27 02:13:49 +00:00
See [issues](https://github.com/zsh-users/zsh-completions/issues) for details on each completion definition.
2011-07-20 12:38:50 +00:00
2016-11-26 17:16:54 +00:00
## Usage
### Using packages
| System | Package |
| ------------- | ------------- |
2017-02-28 20:06:15 +00:00
| Debian / Ubuntu | [zsh-completions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-completions&package=zsh-completions) |
| Fedora / CentOS / RHEL / Scientific Linux | [zsh-completions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-completions&package=zsh-completions) |
| OpenSUSE / SLE | [zsh-completions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-completions&package=zsh-completions) |
2016-11-26 17:16:54 +00:00
| Arch Linux | [zsh-completions](https://www.archlinux.org/packages/zsh-completions), [zsh-completions-git](https://aur.archlinux.org/packages/zsh-completions-git) |
| Gentoo | [app-shells/zsh-completions](http://packages.gentoo.org/package/app-shells/zsh-completions) |
2016-12-20 04:21:06 +00:00
| NixOS | [zsh-completions](https://github.com/NixOS/nixpkgs/blob/master/pkgs/shells/zsh-completions/default.nix) |
2017-10-19 18:06:06 +00:00
| Void Linux | [zsh-completions](https://github.com/voidlinux/void-packages/tree/master/srcpkgs/zsh-completions) |
2018-06-03 00:15:04 +00:00
| Mac OS | [homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/zsh-completions.rb), [MacPorts](https://github.com/macports/macports-ports/blob/master/sysutils/zsh-completions/Portfile) |
2016-11-26 17:16:54 +00:00
### Using zsh frameworks
#### [antigen](https://github.com/zsh-users/antigen)
Add `antigen bundle zsh-users/zsh-completions` to your `~/.zshrc`.
2016-11-26 17:16:54 +00:00
#### [oh-my-zsh](http://github.com/robbyrussell/oh-my-zsh)
2016-11-26 17:16:54 +00:00
* Clone the repository inside your oh-my-zsh repo:
2016-11-26 17:16:54 +00:00
git clone https://github.com/zsh-users/zsh-completions ~/.oh-my-zsh/custom/plugins/zsh-completions
2014-10-06 00:20:00 +00:00
2016-11-26 17:16:54 +00:00
* Enable it in your `.zshrc` by adding it to your plugin list and reloading the completion:
2014-10-06 00:20:00 +00:00
2016-11-26 17:16:54 +00:00
plugins=(… zsh-completions)
autoload -U compinit && compinit
2016-11-26 17:16:54 +00:00
### Manual installation
2011-07-31 18:04:09 +00:00
* Clone the repository:
2011-07-21 22:35:27 +00:00
2011-07-31 18:04:09 +00:00
git clone git://github.com/zsh-users/zsh-completions.git
* Include the directory in your `$fpath`, for example by adding in `~/.zshrc`:
2011-07-31 18:04:09 +00:00
2012-08-01 11:30:37 +00:00
fpath=(path/to/zsh-completions/src $fpath)
2011-07-31 18:04:09 +00:00
* You may have to force rebuild `zcompdump`:
rm -f ~/.zcompdump; compinit
2011-07-31 18:04:09 +00:00
2016-11-26 17:16:54 +00:00
### Contributing
2011-07-31 18:04:09 +00:00
Contributions are welcome, just make sure you follow the guidelines:
2016-02-04 22:02:26 +00:00
* Completions are not accepted when already available in zsh.
2014-07-16 20:14:17 +00:00
* Completions are not accepted when already available in their original project.
2014-07-16 19:35:49 +00:00
* Please do not just copy/paste someone else completion, ask before.
* Completions only partially implemented are not accepted.
* Please add a header containing authors, status and origin of the script and license header if you do not wish to use the Zsh license (example [here](src/_ack)).
2011-07-31 18:04:09 +00:00
* Please try to follow [Zsh completion style guide](https://github.com/zsh-users/zsh/blob/master/Etc/completion-style-guide).
2016-02-04 22:02:26 +00:00
* Please send one separate pull request per file.
2011-07-31 18:04:09 +00:00
* Send a pull request or ask for committer access.
2011-07-20 12:38:50 +00:00
2016-11-26 17:16:54 +00:00
## License
Completions use the Zsh license, unless explicitely mentionned in the file header.
See [LICENSE](https://github.com/zsh-users/zsh-completions/blob/master/LICENSE) for more information.