summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/macports/README.md
diff options
context:
space:
mode:
authornavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
committernavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
commit02f14a9cb152561a5e44062aac79f3b700403b40 (patch)
tree2db8ebda3b7f6f8777783aeb5c60018e6e1359d8 /home/.oh-my-zsh/plugins/macports/README.md
parentcbbdeb2f6b40a102a829f0c47cff052937231f00 (diff)
omz
Diffstat (limited to 'home/.oh-my-zsh/plugins/macports/README.md')
-rw-r--r--home/.oh-my-zsh/plugins/macports/README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/macports/README.md b/home/.oh-my-zsh/plugins/macports/README.md
new file mode 100644
index 0000000..ffe3f97
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/macports/README.md
@@ -0,0 +1,47 @@
+# 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 |
+| pli | `port livecheck installed` | Check for updates for installed ports |
+| plm | `port-livecheck-maintainer` | Check for updates of ports maintained by the specified users |
+| 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 |
+
+## Commands
+
+### port-livecheck-maintainer
+
+```text
+Usage:
+ port-livecheck-maintainer
+ port-livecheck-maintainer (maintainer)+
+ port-livecheck-maintainer -h|--help
+
+Check
+
+Options:
+ maintainer maintainer id
+ -h print this help message and exit
+```
+
+Checks whether updates are available for ports whose maintainer is the current
+user, or any of a specified list of maintainer expressions. The current user
+maintainer id is retrieved as follows:
+
+* The value of the `MACPORTS_MAINTAINER` variable, if set and not null.
+* The value of the `USER` variable.