2d967d66e618ad6d95978ba5ede33fa5f24fe489

Author
Zach Whitten <zwhitten+github@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

ubuntu: update plugin README (#7199)

Diff

This diff is truncated to protect this page.

 1diff --git a/plugins/ubuntu/README.md b/plugins/ubuntu/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..caa6a90b4b2247544495816f42dde91c68320c0b
 4--- /dev/null
 5+++ b/plugins/ubuntu/README.md
 6@@ -0,0 +1,52 @@
 7+# Ubuntu plugin
 8+
 9+This plugin adds completions and aliases for [Ubuntu](https://www.ubuntu.com/).
10+
11+To use it, add `ubuntu` to the plugins array in your zshrc file: 
12+
13+```zsh
14+plugins=(... ubuntu)
15+```
16+
17+## Aliases
18+
19+Commands that use `$APT` will use apt if installed or defer to apt-get otherwise. 
20+
21+| Alias   | Command                                                                | Description                                                                                       |
22+|---------|------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
23+| acs     | `apt-cache search`                                                     | Search the apt-cache with the specified criteria                                                  |
24+| acp     | `apt-cache policy`                                                     | Display the package source priorities                                                             | 
25+| afs     | `apt-file search --regexp`                                             | Perform a regular expression apt-file search                                                      |
26+| afu     | `sudo apt-file update`                                                 | Generates or updates the apt-file package database                                                | 
27+| ag      | `sudo $APT`                                                            | Run apt-get with sudo                                                                             | 
28+| aga     | `sudo $APT autoclean`                                                  | Clears out the local reposityory of retrieved package files that can no longer be downloaded      | 
29+| agb     | `sudo $APT build-dep <source_pkg>`                                     | Installs/Removes packages to satisfy the dependencies of a specified build pkg                    | 
30+| agc     | `sudo $APT clean`                                                      | Clears out the local repository of retrieved package files leaving everything from the lock files | 
31+| agd     | `sudo $APT dselect-upgrade`                                            | Follows dselect choices for package installation                                                  | 
32+| agi     | `sudo $APT install <pkg>`                                              | Install the specified package                                                                     | 
33+| agli    | `apt list --installed`                                                 | List the installed packages                                                                       | 
34+| aglu    | `sudo apt-get -u upgrade --assume-no`                                  | Run an apt-get upgrade assuming no to all prompts                                                 | 
35+| agp     | `sudo $APT purge <pkg>`                                                | Remove a package including any configuration files                                                | 
36+| agr     | `sudo $APT remove <pkg>`                                               | Remove a package                                                                                  | 
37+| ags     | `$APT source <pkg>`                                                    | Fetch the source for the specified package                                                        | 
38+| agu     | `sudo $APT update`                                                     | Update package list                                                                               | 
39+| agud    | `sudo $APT update && sudo $APT dist-upgrade`                           | Update packages list and perform a distribution upgrade                                           | 
40+| agug    | `sudo $APT upgrade`                                                    | Upgrade available packages                                                                        | 
41+| agar    | `sudo $APT autoremove`                                                 | Remove automatically installed packages no longer needed                                          | 
42+| aguu    | `sudo $APT update && sudo $APT upgrade`                                | Update packages list and upgrade available packages                                               | 
43+| allpkgs | `dpkg --get-selections \| grep -v deinstall`                           | Print all installed packages                                                                      | 
44+| kclean  | `sudo aptitude remove -P ?and(~i~nlinux-(ima\|hea) ?not(~n$(uname -r)))`  |Remove ALL kernel images and headers EXCEPT the one in use                                         |
45+| mydeb   | `time dpkg-buildpackage -rfakeroot -us -uc`                            | Create a basic .deb package                                                                       |
46+| ppap    | `sudo ppa-purge <ppa>`                                                 | Remove the specified PPA                                                                          | 
47+
48+
49+## Functions
50+
51+| Function          | Usage                                 |Description                                                               |
52+|-------------------|---------------------------------------|--------------------------------------------------------------------------|
53+| aar               | `aar ppa:xxxxxx/xxxxxx [packagename]` | apt-add-repository with automatic install/upgrade of the desired package |
54+| apt-history       | `apt-history <action>`                | Prints the Apt history of the specified action                           |
55+| apt-list-packages | `apt-list-packages`                   | List packages by size                                                    |
56+| kerndeb           | `kerndeb`                             | Kernel-package building shortcut                                         | 
57+
58+
59diff --git a/plugins/ubuntu/readme.md b/plugins/ubuntu/readme.md
60deleted file mode 100644
61index 99d62a6f7edce1339b8f530be0acfa89718df165..0000000000000000000000000000000000000000
62--- a/plugins/ubuntu/readme.md
63+++ /dev/null
64@@ -1,21 +0,0 @@