debian: fix alias completion, rename ag and clean up README (#7698)

* Use double quotes to cache value of $apt_pref and $apt_upgr
* Clean up and fix syntax of command checks
* Clean up README and document $apt_pref/$apt_upgr overriding mechanism
* Rename `ag` alias (apt upgrade) to `au`
* Clean up README and fix syntax

Fixes #3686 
Fixes #4660 
Closes #5906

Co-authored-by: Noah Vesely <fowlslegs@riseup.net>
This commit is contained in:
Marc Cornellà 2019-06-11 15:02:04 +02:00 committed by GitHub
parent 24cd8e8314
commit 7f98e1cb52
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 107 additions and 104 deletions

View file

@ -1,75 +1,85 @@
# debian # debian
This plugin provides debian related zsh aliases. This plugin provides Debian-related aliases and functions for zsh.
To use it add `debian` to the plugins array in your zshrc file. To use it add `debian` to the plugins array in your zshrc file.
```zsh ```zsh
plugins=(... debian) plugins=(... debian)
``` ```
## Settings
- `$apt_pref`: use apt or aptitude if installed, fallback is apt-get.
- `$apt_upgr`: use upgrade or safe-upgrade (for aptitude).
Set `$apt_pref` and `$apt_upgr` to whatever command you want (before sourcing Oh My Zsh) to override this behavior.
## Common Aliases ## Common Aliases
| Alias | Command | Description | | Alias | Command | Description |
| -------- | ------------------------------------------------------------------------------|--------------------------------------------------------------------------- | | ------ | ---------------------------------------------------------------------- | ---------------------------------------------------------- |
| `age` | apt-get | Command line tool for handling packages | | `age` | `apt-get` | Command line tool for handling packages |
| `api` | aptitude | Same functionality as `apt-get`, provides extra options while installation | | `api` | `aptitude` | Same functionality as `apt-get`, provides extra options |
| `acs` | apt-cache search | Command line tool for searching apt software package cache | | `acs` | `apt-cache search` | Command line tool for searching apt software package cache |
| `aps` | aptitude search | Searches installed packages using aptitude | | `aps` | `aptitude search` | Searches installed packages using aptitude |
| `as` | aptitude -F \"* %p -> %d \n(%v/%V)\" \ -no-gui --disable-columns search | - | | `as` | `aptitude -F '* %p -> %d \n(%v/%V)' --no-gui --disable-columns search` | Print searched packages using a custom format |
| `afs` | apt-file search --regexp | Search file in packages | | `afs` | `apt-file search --regexp` | Search file in packages |
| `asrc` | apt-get source | Fetch source packages through `apt-get` | | `asrc` | `apt-get source` | Fetch source packages through `apt-get` |
| `app` | apt-cache policy | Displays priority of package sources | | `app` | `apt-cache policy` | Displays priority of package sources |
## Superuser Operations Aliases ## Superuser Operations Aliases
| Alias | Command | Description | | Alias | Command | Description |
| -------- | -------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------- | | -------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `aac` | sudo $apt_pref autoclean | Clears out the local repository of retrieved package files | | `aac` | `sudo $apt_pref autoclean` | Clears out the local repository of retrieved package files |
| `abd` | sudo $apt_pref build-dep | Installs all dependencies for building packages | | `abd` | `sudo $apt_pref build-dep` | Installs all dependencies for building packages |
| `ac` | sudo $apt_pref clean | Clears out the local repository of retrieved package files except lock files | | `ac` | `sudo $apt_pref clean` | Clears out the local repository of retrieved package files except lock files |
| `ad` | sudo $apt_pref update | Updates the package lists for upgrades for packages | | `ad` | `sudo $apt_pref update` | Updates the package lists for upgrades for packages |
| `adg` | sudo $apt_pref update && sudo $apt_pref $apt_upgr | Update and upgrade packages | | `adg` | `sudo $apt_pref update && sudo $apt_pref $apt_upgr` | Update and upgrade packages |
| `adu` | sudo $apt_pref update && sudo $apt_pref dist-upgrade | Smart upgrade that handles dependencies | | `adu` | `sudo $apt_pref update && sudo $apt_pref dist-upgrade` | Smart upgrade that handles dependencies |
| `afu` | sudo apt-file update | Update the files in packages | | `afu` | `sudo apt-file update` | Update the files in packages |
| `au` | sudo $apt_pref $apt_upgr | - | | `au` | `sudo $apt_pref $apt_upgr` | Install package upgrades |
| `ai` | sudo $apt_pref install | Command-line tool to install package | | `ai` | `sudo $apt_pref install` | Command-line tool to install package |
| `ail` | sed -e 's/ */ /g' -e 's/ *//' &#124; cut -s -d ' ' -f 1 &#124; "' xargs sudo $apt_pref install | Install all packages given on the command line while using only the first word of each line | | `ail` | `sed -e 's/ */ /g' -e 's/ *//' \| cut -s -d ' ' -f 1 \| xargs sudo $apt_pref install` | Install all packages given on the command line while using only the first word of each line |
| `ap` | sudo $apt_pref purge | Removes packages along with configuration files | | `ap` | `sudo $apt_pref purge` | Removes packages along with configuration files |
| `ar` | sudo $apt_pref remove | Removes packages, keeps the configuration files | | `ar` | `sudo $apt_pref remove` | Removes packages, keeps the configuration files |
| `ads` | sudo apt-get dselect-upgrade | Installs packages from list and removes all not in the list | | `ads` | `sudo apt-get dselect-upgrade` | Installs packages from list and removes all not in the list |
| `dia` | sudo dpkg -i ./*.deb | Install all .deb files in the current directory | | `dia` | `sudo dpkg -i ./*.deb` | Install all .deb files in the current directory |
| `di` | sudo dpkg -i | Install all .deb files in the current directory | | `di` | `sudo dpkg -i` | Install all .deb files in the current directory |
| `kclean` | sudo aptitude remove -P ?and(~i~nlinux-(ima&#124;hea) ?not(~n`uname -r`)) | Remove ALL kernel images and headers EXCEPT the one in use | | `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 |
- `$apt_pref` - Use apt or aptitude if installed, fallback is apt-get.
- `$apt_upgr` - Use upgrade.
## Aliases - Commands using `su` ## Aliases - Commands using `su`
| Alias | Command | | Alias | Command |
| -------- | ------------------------------------------------------------------------------| | ----- | --------------------------------------------------------- |
| `aac` | su -ls \'$apt_pref autoclean\' root | | `aac` | `su -ls "$apt_pref autoclean" root` |
| `ac` | su -ls \'$apt_pref clean\' root | | `ac` | `su -ls "$apt_pref clean" root` |
| `ad` | su -lc \'$apt_pref update\' root | | `ad` | `su -lc "$apt_pref update" root` |
| `adg` | su -lc \'$apt_pref update && aptitude $apt_upgr\' root | | `adg` | `su -lc "$apt_pref update && aptitude $apt_upgr" root` |
| `adu` | su -lc \'$apt_pref update && aptitude dist-upgrade\' root | | `adu` | `su -lc "$apt_pref update && aptitude dist-upgrade" root` |
| `afu` | su -lc "apt-file update | | `afu` | `su -lc "apt-file update"` |
| `ag` | su -lc \'$apt_pref $apt_upgr\' root | | `au` | `su -lc "$apt_pref $apt_upgr" root` |
| `dia` | su -lc "dpkg -i ./*.deb" root | | `dia` | `su -lc "dpkg -i ./*.deb" root` |
## Miscellaneous Aliases ## Miscellaneous Aliases
| Alias | Command | Description | | Alias | Command | Description |
| -------- | -------------------------------------------------|---------------------------------------- | | --------- | ---------------------------------------------- | ------------------------------ |
| `allpkgs`| aptitude search -F "%p" --disable-columns ~i | Display all installed packages | | `allpkgs` | `aptitude search -F "%p" --disable-columns ~i` | Display all installed packages |
| `mydeb` | time dpkg-buildpackage -rfakeroot -us -uc | Create a basic .deb package | | `mydeb` | `time dpkg-buildpackage -rfakeroot -us -uc` | Create a basic .deb package |
## Functions ## Functions
| Fucntion | Description | | Function | Description |
|-----------------------|-------------------------------------------------------------------------------| | ------------------- | --------------------------------------------------------------- |
| `apt-copy` | Create a simple script that can be used to 'duplicate' a system | | `apt-copy` | Create a simple script that can be used to 'duplicate' a system |
| `apt-history` | Displays apt history for a command | | `apt-history` | Displays apt history for a command |
| `kerndeb` | Builds kernel packages | | `kerndeb` | Builds kernel packages |
| `apt-list-packages` | List packages by size | | `apt-list-packages` | List packages by size |
## Authors
- [@AlexBio](https://github.com/AlexBio)
- [@dbb](https://github.com/dbb)
- [@Mappleconfusers](https://github.com/Mappleconfusers)

View file

@ -1,25 +1,21 @@
# Authors:
# https://github.com/AlexBio
# https://github.com/dbb
# https://github.com/Mappleconfusers
#
# Debian-related zsh aliases and functions for zsh
# Use apt or aptitude if installed, fallback is apt-get # Use apt or aptitude if installed, fallback is apt-get
# You can just set apt_pref='apt-get' to override it. # You can just set apt_pref='apt-get' to override it.
if [[ -e $( which -p apt 2>&1 ) ]]; then
apt_pref='apt' if [[ -z $apt_pref || -z $apt_upgr ]]; then
apt_upgr='upgrade' if [[ -e $commands[apt] ]]; then
elif [[ -e $( which -p aptitude 2>&1 ) ]]; then apt_pref='apt'
apt_pref='aptitude' apt_upgr='upgrade'
apt_upgr='safe-upgrade' elif [[ -e $commands[aptitude] ]]; then
else apt_pref='aptitude'
apt_pref='apt-get' apt_upgr='safe-upgrade'
apt_upgr='upgrade' else
apt_pref='apt-get'
apt_upgr='upgrade'
fi
fi fi
# Use sudo by default if it's installed # Use sudo by default if it's installed
if [[ -e $( which -p sudo 2>&1 ) ]]; then if [[ -e $commands[sudo] ]]; then
use_sudo=1 use_sudo=1
fi fi
@ -32,8 +28,7 @@ alias api='aptitude'
# Some self-explanatory aliases # Some self-explanatory aliases
alias acs="apt-cache search" alias acs="apt-cache search"
alias aps='aptitude search' alias aps='aptitude search'
alias as="aptitude -F \"* %p -> %d \n(%v/%V)\" \ alias as="aptitude -F '* %p -> %d \n(%v/%V)' --no-gui --disable-columns search"
--no-gui --disable-columns search" # search package
# apt-file # apt-file
alias afs='apt-file search --regexp' alias afs='apt-file search --regexp'
@ -46,49 +41,48 @@ alias app='apt-cache policy'
# superuser operations ###################################################### # superuser operations ######################################################
if [[ $use_sudo -eq 1 ]]; then if [[ $use_sudo -eq 1 ]]; then
# commands using sudo ####### # commands using sudo #######
alias aac='sudo $apt_pref autoclean' alias aac="sudo $apt_pref autoclean"
alias abd='sudo $apt_pref build-dep' alias abd="sudo $apt_pref build-dep"
alias ac='sudo $apt_pref clean' alias ac="sudo $apt_pref clean"
alias ad='sudo $apt_pref update' alias ad="sudo $apt_pref update"
alias adg='sudo $apt_pref update && sudo $apt_pref $apt_upgr' alias adg="sudo $apt_pref update && sudo $apt_pref $apt_upgr"
alias adu='sudo $apt_pref update && sudo $apt_pref dist-upgrade' alias adu="sudo $apt_pref update && sudo $apt_pref dist-upgrade"
alias afu='sudo apt-file update' alias afu="sudo apt-file update"
alias au='sudo $apt_pref $apt_upgr' alias au="sudo $apt_pref $apt_upgr"
alias ai='sudo $apt_pref install' alias ai="sudo $apt_pref install"
# Install all packages given on the command line while using only the first word of each line: # Install all packages given on the command line while using only the first word of each line:
# acs ... | ail # acs ... | ail
alias ail="sed -e 's/ */ /g' -e 's/ *//' | cut -s -d ' ' -f 1 | "' xargs sudo $apt_pref install' alias ail="sed -e 's/ */ /g' -e 's/ *//' | cut -s -d ' ' -f 1 | xargs sudo $apt_pref install"
alias ap='sudo $apt_pref purge' alias ap="sudo $apt_pref purge"
alias ar='sudo $apt_pref remove' alias ar="sudo $apt_pref remove"
# apt-get only # apt-get only
alias ads='sudo apt-get dselect-upgrade' alias ads="sudo apt-get dselect-upgrade"
# Install all .deb files in the current directory. # Install all .deb files in the current directory.
# Warning: you will need to put the glob in single quotes if you use: # Warning: you will need to put the glob in single quotes if you use:
# glob_subst # glob_subst
alias dia='sudo dpkg -i ./*.deb' alias dia="sudo dpkg -i ./*.deb"
alias di='sudo dpkg -i' alias di="sudo dpkg -i"
# Remove ALL kernel images and headers EXCEPT the one in use # Remove ALL kernel images and headers EXCEPT the one in use
alias kclean='sudo aptitude remove -P ?and(~i~nlinux-(ima|hea) \ alias kclean='sudo aptitude remove -P ?and(~i~nlinux-(ima|hea) ?not(~n$(uname -r)))'
?not(~n`uname -r`))'
# commands using su ######### # commands using su #########
else else
alias aac='su -ls \'$apt_pref autoclean\' root' alias aac="su -ls '$apt_pref autoclean' root"
abd() { abd() {
cmd="su -lc '$apt_pref build-dep $@' root" cmd="su -lc '$apt_pref build-dep $@' root"
print "$cmd" print "$cmd"
eval "$cmd" eval "$cmd"
} }
alias ac='su -ls \'$apt_pref clean\' root' alias ac="su -ls '$apt_pref clean' root"
alias ad='su -lc \'$apt_pref update\' root' alias ad="su -lc '$apt_pref update' root"
alias adg='su -lc \'$apt_pref update && aptitude $apt_upgr\' root' alias adg="su -lc '$apt_pref update && aptitude $apt_upgr' root"
alias adu='su -lc \'$apt_pref update && aptitude dist-upgrade\' root' alias adu="su -lc '$apt_pref update && aptitude dist-upgrade' root"
alias afu='su -lc "apt-file update"' alias afu="su -lc '$apt-file update'"
alias ag='su -lc \'$apt_pref $apt_upgr\' root' alias au="su -lc '$apt_pref $apt_upgr' root"
ai() { ai() {
cmd="su -lc 'aptitude -P install $@' root" cmd="su -lc 'aptitude -P install $@' root"
print "$cmd" print "$cmd"
@ -111,8 +105,7 @@ else
alias di='su -lc "dpkg -i" root' alias di='su -lc "dpkg -i" root'
# Remove ALL kernel images and headers EXCEPT the one in use # Remove ALL kernel images and headers EXCEPT the one in use
alias kclean='su -lc '\''aptitude remove -P ?and(~i~nlinux-(ima|hea) \ alias kclean='su -lc "aptitude remove -P ?and(~i~nlinux-(ima|hea) ?not(~n$(uname -r)))" root'
?not(~n`uname -r`))'\'' root'
fi fi
# Completion ################################################################ # Completion ################################################################
@ -126,11 +119,11 @@ apt_pref_compdef() {
f="_apt_pref_${2}" f="_apt_pref_${2}"
eval "function ${f}() { eval "function ${f}() {
shift words; shift words;
service=\"\$apt_pref\"; service=\"\$apt_pref\";
words=(\"\$apt_pref\" '$2' \$words); words=(\"\$apt_pref\" '$2' \$words);
((CURRENT++)) ((CURRENT++))
test \"\${apt_pref}\" = 'aptitude' && _aptitude || _apt test \"\${apt_pref}\" = 'aptitude' && _aptitude || _apt
}" }"
compdef "$f" "$1" compdef "$f" "$1"
@ -141,7 +134,7 @@ apt_pref_compdef abd "build-dep"
apt_pref_compdef ac "clean" apt_pref_compdef ac "clean"
apt_pref_compdef ad "update" apt_pref_compdef ad "update"
apt_pref_compdef afu "update" apt_pref_compdef afu "update"
apt_pref_compdef ag "$apt_upgr" apt_pref_compdef au "$apt_upgr"
apt_pref_compdef ai "install" apt_pref_compdef ai "install"
apt_pref_compdef ail "install" apt_pref_compdef ail "install"
apt_pref_compdef ap "purge" apt_pref_compdef ap "purge"
@ -213,7 +206,7 @@ kerndeb () {
# temporarily unset MAKEFLAGS ( '-j3' will fail ) # temporarily unset MAKEFLAGS ( '-j3' will fail )
MAKEFLAGS=$( print - $MAKEFLAGS | perl -pe 's/-j\s*[\d]+//g' ) MAKEFLAGS=$( print - $MAKEFLAGS | perl -pe 's/-j\s*[\d]+//g' )
print '$MAKEFLAGS set to '"'$MAKEFLAGS'" print '$MAKEFLAGS set to '"'$MAKEFLAGS'"
appendage='-custom' # this shows up in $ (uname -r ) appendage='-custom' # this shows up in $(uname -r )
revision=$(date +"%Y%m%d") # this shows up in the .deb file name revision=$(date +"%Y%m%d") # this shows up in the .deb file name
make-kpkg clean make-kpkg clean