diff options
| author | Jeffrey Chandler <36927673+jeff-chandler@users.noreply.github.com> | 2018-10-12 15:48:08 -0400 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-12 21:48:08 +0200 |
| commit | b2f51a1a0a6dd2cb2baeb3e1131b5d41ee03a66d (patch) | |
| tree | 624553c5ae793701cd2a29708e570c9b2de74319 /plugins/command-not-found | |
| parent | 6fecbf6ad5fc6e78dcfd89227cf8b12305b1f8bc (diff) | |
| download | zsh-b2f51a1a0a6dd2cb2baeb3e1131b5d41ee03a66d.tar.gz zsh-b2f51a1a0a6dd2cb2baeb3e1131b5d41ee03a66d.tar.bz2 zsh-b2f51a1a0a6dd2cb2baeb3e1131b5d41ee03a66d.zip | |
command-not-found: add README (#7272)
Diffstat (limited to 'plugins/command-not-found')
| -rw-r--r-- | plugins/command-not-found/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/plugins/command-not-found/README.md b/plugins/command-not-found/README.md new file mode 100644 index 000000000..df62d1f07 --- /dev/null +++ b/plugins/command-not-found/README.md @@ -0,0 +1,31 @@ +# command-not-found plugin + +This plugin uses the command-not-found package for zsh to provide suggested packages to be installed if a command cannot be found. + +To use it, add `command-not-found` to the plugins array of your zshrc file: + +```zsh +plugins=(... command-not-found) +``` + +An example of how this plugin works in Ubuntu: +``` +$ mutt +The program 'mutt' can be found in the following packages: + * mutt + * mutt-kz + * mutt-patched +Try: sudo apt install <selected package> +``` + +### Supported platforms + +It works out of the box with the command-not-found packages for: + +- [Ubuntu](https://www.porcheron.info/command-not-found-for-zsh/) +- [Debian](https://packages.debian.org/search?keywords=command-not-found) +- [Arch Linux](https://wiki.archlinux.org/index.php/Pkgfile#Command_not_found) +- [macOS (Homebrew)](https://github.com/Homebrew/homebrew-command-not-found) +- [Fedora](https://fedoraproject.org/wiki/Features/PackageKitCommandNotFound) + +You can add support for other platforms by submitting a Pull Request. |