summaryrefslogtreecommitdiff
path: root/plugins/macports/README.md
diff options
context:
space:
mode:
authorSebastian Müller <sbmueller@users.noreply.github.com>2018-10-03 18:08:50 +0200
committerMarc Cornellà <marc.cornella@live.com>2018-10-03 18:08:50 +0200
commit544dfdd6da2ff3edc04bfd903fdb943960d743aa (patch)
treeff9a84d66fd720f4959d3135b46cc21d02a8558b /plugins/macports/README.md
parent2e0a5cbefd97f4e40baa2b7b351e2d44d260a59e (diff)
downloadzsh-544dfdd6da2ff3edc04bfd903fdb943960d743aa.tar.gz
zsh-544dfdd6da2ff3edc04bfd903fdb943960d743aa.tar.bz2
zsh-544dfdd6da2ff3edc04bfd903fdb943960d743aa.zip
macports: add README (#7204)
Diffstat (limited to 'plugins/macports/README.md')
-rw-r--r--plugins/macports/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/plugins/macports/README.md b/plugins/macports/README.md
new file mode 100644
index 000000000..ded823f3f
--- /dev/null
+++ b/plugins/macports/README.md
@@ -0,0 +1,21 @@
+# Macports plugin
+
+This plugin adds completion for the package manager [Macports](https://macports.com/),
+as well as some aliases for common Macports commands.
+
+To use it, add `macports` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... macports)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-------|------------------------------------|--------------------------------------------------------------|
+| pc | `sudo port clean --all installed` | Clean up intermediate installation files for installed ports |
+| pi | `sudo port install` | Install package given as argument |
+| psu | `sudo port selfupdate` | Update ports tree with MacPorts repository |
+| puni | `sudo port uninstall inactive` | Uninstall inactive ports |
+| puo | `sudo port upgrade outdated` | Upgrade ports with newer versions available |
+| pup | `psu && puo` | Update ports tree, then upgrade ports to newest versions |