contrib/zsh_completion.in

   1 #compdef pacman pacman.static=pacman pacman-key makepkg
   2
   3 # copy this file to /usr/share/zsh/site-functions/_pacman
   4
   5 typeset -A opt_args
   6
   7 # options for passing to _arguments: main pacman commands
   8 _pacman_opts_commands=(
   9         '-Q[Query the package database]'
  10         '-R[Remove a package from the system]'
  11         '-S[Synchronize packages]'
  12         '-U[Upgrade a package]'
  13         '-V[Display version and exit]'
  14         '-h[Display usage]'
  15 )
  16
  17 # options for passing to _arguments: options common to all commands
  18 _pacman_opts_common=(
  19         '-b[Alternate database location]:database_location:_files -/'
  20         '-h[Display syntax for the given operation]'
  21         '-r[Set alternate installation root]:installation root:_files -/'
  22         '-v[Be more verbose]'
  23         '--cachedir[Alternate package cache location]:cache_location:_files -/'
  24         '--config[An alternate configuration file]:config file:_files'
  25         '--logfile[An alternate log file]:config file:_files'
  26         '--noconfirm[Do not ask for confirmation]'
  27         '--noprogressbar[Do not show a progress bar when downloading files]'
  28         '--noscriptlet[Do not execute the install scriptlet if one exists]'
  29         '--print[Only print the targets instead of performing the operation]'
  30 )
  31
  32 # options for passing to _arguments: options for --upgrade commands
  33 _pacman_opts_pkgfile=(
  34         '-d[Skip dependency checks]'
  35         '--dbonly[Only remove database entry, do not remove files]'
  36         '--force[Overwrite conflicting files]'
  37         '--needed[Do not reinstall up to date packages]'
  38         '--recursive[Reinstall all dependencies of target packages]'
  39         '*:package file:_files -g "*.pkg.tar*(.)"'
  40 )
  41
  42 # options for passing to _arguments: subactions for --query command
  43 _pacman_opts_query_actions=(
  44         '-g[View all members of a package group]:*:package groups:->query_group'
  45         '-o[Query the package that owns a file]:file:_files'
  46         '-p[Package file to query]:*:package file:->query_file'
  47         '-s[Search package names and descriptions]:*:search text:->query_search'
  48 )
  49
  50 # options for passing to _arguments: options for --query and subcommands
  51 _pacman_opts_query_modifiers=(
  52         '-c[List package changelog]'
  53         '-d[List packages installed as dependencies]'
  54         '-e[List packages explicitly installed]'
  55         '-i[View package information]'
  56         '-ii[View package information including backup files]'
  57         '-k[Check package files]'
  58         '-l[List package contents]'
  59         '-m[List installed packages not found in sync db(s)]'
  60         '-t[List packages not required by any package]'
  61         '-u[List packages that can be upgraded]'
  62 )
  63
  64 # options for passing to _arguments: options for --remove command
  65 _pacman_opts_remove=(
  66         '-c[Remove all dependent packages]'
  67         '-d[Skip dependency checks]'
  68         '-n[Remove protected configuration files]'
  69         '-s[Remove dependencies not required by other packages]'
  70         '--dbonly[Only remove database entry, do not remove files]'
  71         '*:installed package:_pacman_completions_installed_packages'
  72 )
  73
  74 # options for passing to _arguments: options for --sync command
  75 _pacman_opts_sync_actions=(
  76         '*-c[Remove old packages from cache]:*:clean:->sync_clean'
  77         '*-cc[Remove all packages from cache]:*:clean:->sync_clean'
  78         '-g[View all members of a package group]:*:package groups:->sync_group'
  79         '-s[Search package names and descriptions]:*:search text:->sync_search'
  80         '--dbonly[Only remove database entry, do not remove files]'
  81         '--needed[Do not reinstall up to date packages]'
  82         '--recursive[Reinstall all dependencies of target packages]'
  83 )
  84
  85 # options for passing to _arguments: options for --sync command
  86 _pacman_opts_sync_modifiers=(
  87         '-d[Skip dependency checks]'
  88         '-i[View package information]'
  89         '-l[List all packages in a repository]'
  90         '-p[Print download URIs for each package to be installed]'
  91         '-u[Upgrade all out-of-date packages]'
  92         '-w[Download packages only]'
  93         '-y[Download fresh package databases]'
  94         '*--ignore[Ignore a package upgrade]:package:
  95                 _pacman_completions_all_packages'
  96         '*--ignoregroup[Ignore a group upgrade]:package group:
  97                 _pacman_completions_all_groups'
  98         '--asdeps[Install packages as non-explicitly installed]'
  99         '--asexplicit[Install packages as explicitly installed]'
 100         '--force[Overwrite conflicting files]'
 101 )
 102
 103 # handles --help subcommand
 104 _pacman_action_help() {
 105         _arguments -s : \
 106                 "$_pacman_opts_commands[@]"
 107 }
 108
 109 # handles cases where no subcommand has yet been given
 110 _pacman_action_none() {
 111         _arguments -s : \
 112                 "$_pacman_opts_commands[@]"
 113 }
 114
 115 # handles --query subcommand
 116 _pacman_action_query() {
 117         local context state line
 118         typeset -A opt_args
 119
 120 #       _arguments -s : \
 121 #               "$_pacman_opts_common[@]" \
 122 #               "$_pacman_opts_query_actions[@]" \
 123 #               "$_pacman_opts_query_modifiers[@]"
 124
 125         case $state in
 126                 query_file)
 127                         _arguments -s : \
 128                                 "$_pacman_opts_common[@]" \
 129                                 "$_pacman_opts_query_modifiers[@]" \
 130                                 '*:package file:_files -g "*.pkg.tar*"'
 131                                 ;;
 132                 query_group)
 133                         _arguments -s : \
 134                                 "$_pacman_opts_common[@]" \
 135                                 "$_pacman_opts_query_modifiers[@]" \
 136                                 '*:groups:_pacman_completions_installed_groups'
 137                                 ;;
 138                 query_owner)
 139                         _arguments -s : \
 140                                 "$_pacman_opts_common[@]" \
 141                                 "$_pacman_opts_query_modifiers[@]" \
 142                                 '*:file:_files'
 143                                 ;;
 144                 query_search)
 145                         _arguments -s : \
 146                                 "$_pacman_opts_common[@]" \
 147                                 "$_pacman_opts_query_modifiers[@]" \
 148                                 '*:search text: '
 149                                 ;;
 150                 *)
 151                         _arguments -s : \
 152                                 "$_pacman_opts_common[@]" \
 153                                 "$_pacman_opts_query_actions[@]" \
 154                                 "$_pacman_opts_query_modifiers[@]" \
 155                                 '*:package:_pacman_completions_installed_packages'
 156                                 ;;
 157         esac
 158 }
 159
 160 # handles --remove subcommand
 161 _pacman_action_remove() {
 162         _arguments -s : \
 163                 "$_pacman_opts_common[@]" \
 164                 "$_pacman_opts_remove[@]"
 165 }
 166
 167 # handles --sync subcommand
 168 _pacman_action_sync() {
 169         local context state line
 170         typeset -A opt_args
 171
 172 #       _arguments -s : \
 173 #               "$_pacman_opts_common[@]" \
 174 #               "$_pacman_opts_sync_actions[@]" #\
 175 #               #"$_pacman_opts_sync_modifiers[@]"
 176
 177         case $state in
 178                 sync_clean)
 179                         _arguments -s : \
 180                                 "$_pacman_opts_common[@]" \
 181                                 "$_pacman_opts_sync_modifiers[@]" \
 182                                 '*-c[Remove old packages from cache]' \
 183                                 ;;
 184                 sync_group)
 185                         _arguments -s : \
 186                                 "$_pacman_opts_common[@]" \
 187                                 "$_pacman_opts_sync_modifiers[@]" \
 188                                 '*:package group:_pacman_completions_all_groups'
 189                                 ;;
 190                 sync_search)
 191                         _arguments -s : \
 192                                 "$_pacman_opts_common[@]" \
 193                                 "$_pacman_opts_sync_modifiers[@]" \
 194                                 '*:search text: '
 195                                 ;;
 196                 *)
 197                         _arguments -s : \
 198                                 "$_pacman_opts_common[@]" \
 199                                 "$_pacman_opts_sync_modifiers[@]" \
 200                                 '*:package:_pacman_completions_all_packages'
 201                                 ;;
 202                 esac
 203 }
 204
 205 # handles --upgrade subcommand
 206 _pacman_action_upgrade() {
 207         _arguments -s : \
 208                 "$_pacman_opts_common[@]" \
 209                 "$_pacman_opts_pkgfile[@]"
 210 }
 211
 212 # handles --version subcommand
 213 _pacman_action_version() {
 214         # no further arguments
 215         return 0
 216 }
 217
 218 # provides completions for package groups
 219 _pacman_completions_all_groups() {
 220         local -a cmd groups
 221         _pacman_get_command
 222         groups=( $(_call_program groups $cmd[@] -Sg) )
 223         typeset -U groups
 224         compadd "$@" -a groups
 225 }
 226
 227 # provides completions for packages available from repositories
 228 # these can be specified as either 'package' or 'repository/package'
 229 _pacman_completions_all_packages() {
 230         local -a cmd packages repositories packages_long
 231         _pacman_get_command
 232
 233         if compset -P1 '*/*'; then
 234                 packages=( $(_call_program packages $cmd[@] -Sql ${words[CURRENT]%/*}) )
 235                 typeset -U packages
 236                 _wanted repo_packages expl "repository/package" compadd ${(@)packages}
 237         else
 238                 packages=( $(_call_program packages $cmd[@] -Sql) )
 239                 typeset -U packages
 240                 _wanted packages expl "packages" compadd - "${(@)packages}"
 241
 242                 repositories=(${(o)${${${(M)${(f)"$(<@sysconfdir@/pacman.conf)"}:#\[*}/\[/}/\]/}:#options})
 243                 typeset -U repositories
 244                 _wanted repo_packages expl "repository/package" compadd -S "/" $repositories
 245         fi
 246 }
 247
 248 # provides completions for package groups
 249 _pacman_completions_installed_groups() {
 250         local -a cmd groups
 251         _pacman_get_command
 252         groups=(${(o)${(f)"$(_call_program groups $cmd[@] -Qg)"}% *})
 253         typeset -U groups
 254         compadd "$@" -a groups
 255 }
 256
 257 # provides completions for installed packages
 258 _pacman_completions_installed_packages() {
 259         local -a cmd packages packages_long
 260         packages_long=(@localstatedir@/lib/pacman/local/*(/))
 261         packages=( ${${packages_long#@localstatedir@/lib/pacman/local/}%-*-*} )
 262         compadd "$@" -a packages
 263 }
 264
 265 # provides completions for repository names
 266 _pacman_completions_repositories() {
 267         local -a cmd repositories
 268         repositories=(${(o)${${${(M)${(f)"$(<@sysconfdir@/pacman.conf)"}:#\[*}/\[/}/\]/}:#options})
 269         # Uniq the array
 270         typeset -U repositories
 271         compadd "$@" -a repositories
 272 }
 273
 274 # builds command for invoking pacman in a _call_program command - extracts
 275 # relevant options already specified (config file, etc)
 276 # $cmd must be declared by calling function
 277 _pacman_get_command() {
 278         # this is mostly nicked from _perforce
 279         cmd=( "pacman" "2>/dev/null")
 280         integer i
 281         for (( i = 2; i < CURRENT - 1; i++ )); do
 282                 if [[ ${words[i]} = "--config" || ${words[i]} = "--root" ]]; then
 283                         cmd+=( ${words[i,i+1]} )
 284                 fi
 285         done
 286 }
 287
 288 # main dispatcher
 289 _pacman_zsh_comp() {
 290         case $words[2] in
 291                 -Q*g*) # ipkg groups
 292                         _arguments -s : \
 293                                 "$_pacman_opts_common[@]" \
 294                                 "$_pacman_opts_query_modifiers[@]" \
 295                                 '*:groups:_pacman_completions_installed_groups'
 296                                 ;;
 297                 -Q*o*) # file
 298                         _arguments -s : \
 299                                 "$_pacman_opts_common[@]" \
 300                                 "$_pacman_opts_query_modifiers[@]" \
 301                                 '*:package file:_files'
 302                                 ;;
 303                 -Q*p*) # file *.pkg.tar*
 304                         _arguments -s : \
 305                                 "$_pacman_opts_common[@]" \
 306                                 "$_pacman_opts_query_modifiers[@]" \
 307                                 '*:package file:_files -g "*.pkg.tar*"'
 308                                 ;;
 309                 -Q*)  _pacman_action_query    ;;
 310                 -R*)  _pacman_action_remove   ;;
 311                 -S*c*) # no completion
 312                         return 0
 313                         ;;
 314                 -S*l*) # repos
 315                         _arguments -s : \
 316                                 "$_pacman_opts_common[@]" \
 317                                 "$_pacman_opts_sync_modifiers[@]" \
 318                                 '*:package repo:_pacman_completions_repositories' \
 319                                 ;;
 320                 -S*g*) # pkg groups
 321                         _arguments -s : \
 322                                 "$_pacman_opts_common[@]" \
 323                                 "$_pacman_opts_sync_modifiers[@]" \
 324                                 '*:package group:_pacman_completions_all_groups'
 325                                 ;;
 326                 -S*)  _pacman_action_sync     ;;
 327                 -U*)  _pacman_action_upgrade  ;;
 328                 -V*)  _pacman_action_version  ;;
 329                 -h*)  _pacman_action_help     ;;
 330                 -  )  _pacman_action_none     ;;
 331                 *  )  return 1                ;;
 332         esac
 333 }
 334
 335 _key_shortopts=(
 336     '-h[show help]' \
 337     '-a[Add the specified keys (empty for stdin)]: :_files'
 338     '-d[Remove the Specified keyids]:*: :_keys'
 339     '-e[Export the specified or all keyids]:*: :_keys'
 340     '-f[List fingreprint for specidied or all keyids]:*: :_keys'
 341     '-l[List the specified or all keys]:*: :_keys'
 342     '-r[Fetch the specified keyids]:*: :_keys'
 343     '-u[Update the trustdb of pacman]'
 344     '-v[Verify the file specified by the signature]: :_files -g "*.sig"'
 345     '-V[Show program version]'
 346     )
 347
 348 _key_longopts=(
 349     '--help[show help]'
 350     '--add[Add the specified keys (empty for stdin)]: :_files'
 351     '--delete[Remove the Specified keyids]:*: :_keys'
 352     '--export[Export the specified or all keyids]:*: :_keys'
 353     '--finger[List fingreprint for specidied or all keyids]:*: :_keys'
 354     '--list-keys[List the specified or all keys]:*: :_keys'
 355     '--recv-keys[Fetch the specified keyids]:*: :_keys'
 356     '--updatedb[Update the trustdb of pacman]'
 357     '--verify[Verify the file specified by the signature]: :_files -g "*.sig"'
 358     '--version[Show program version]'
 359     '--edit-key[Present a menu for key management task on keyids]:*: :_keys'
 360     '--import[Imports pubring.gpg from dir(s)]: :_files -g "*.gpg"'
 361     '--import-tb[Imports ownertrust values from trustdb.gpg in dir(s)]: :_files -g "*.gpg"'
 362     '--init[Ensure the keyring is properly initialized]'
 363     '--list-sigs[List keys and their signatures]:*: :_keys'
 364     '--lsign-key[Locally sign the specified keyid]:*: :_keys'
 365     '--populate[Reload the default keys from the (given) keyrings in '/usr/share/pacman/keyrings']: :_path_files -W /usr/share/pacman/keyrings'
 366     '--refresh-keys[Update specified or all keys from a keyserver]:*: :_keys'
 367     )
 368
 369 _pacman_key_options=(
 370   '--config[Use an alternate config file (instead of /etc/pacman.con)]: :_files'
 371   '--gpgdir[Set an alternate directory for GnuPG (instead of /etc/pacman.d/gnupg)]: :_files -/'
 372   '--keyserver[Specify a keyserver to use if necessary]'
 373   )
 374
 375 _pacman_key() {
 376   case $words[CURRENT] in
 377     --*)
 378       _arguments -s : \
 379         "$_pacman_key_options[@]" \
 380         "$_key_longopts[@]"
 381       ;;
 382     -*)
 383       _arguments -s : \
 384         "$_pacman_key_options[@]" \
 385         "$_key_shortopts[@]" \
 386         "$_key_longopts[@]"
 387       ;;
 388     *)
 389       i=$#;
 390       while [[ $words[$i] != -* ]] && [[ $words[$i] != "pacman-key" ]];do
 391         i=$(($i-1))
 392       done
 393       case $i in
 394         --*)
 395         _arguments -s : \
 396           "$_pacman_key_options[@]" \
 397           "$_key_longopts[@]"
 398         ;;
 399       -*)
 400         _arguments -s : \
 401           "$_pacman_key_options[@]" \
 402           "$_key_shortopts[@]" \
 403           "$_key_longopts[@]"
 404         ;;
 405       *) return 1;;
 406     esac
 407     ;;
 408   esac
 409 }
 410
 411 _keys() {
 412   local keylist keys
 413   keylist=$(pacman-key --list-keys 2>/dev/null | awk '
 414       $1 == "pub" {
 415         # key id
 416         split($2, a, "/"); print a[2]
 417       }
 418       $1 == "uid" {
 419         # email
 420         if (match($NF, /<[^>]+>/))
 421           print substr($NF, RSTART + 1, RLENGTH - 2)
 422       #this adds support for names as well if that is ever added
 423         }
 424       $1 == "uid" {
 425       for (i=2;i<NF;i++) {printf "%s%s",sep, $i;sep=" "}; printf "\n"
 426       }' |sed -e 's/(.*)//g' -e 's/^\ //g' -e 's/\ *$//g' |uniq
 427         )
 428         keys=(${(s:/:)${keylist//$'\n'/\/}})
 429   _describe -t modules 'keys in keyring' keys && return 0
 430 }
 431
 432 _makepkg_shortopts=(
 433     '*-s[Install missing dependencies with pacman]'
 434     '*-i[Install package after successful build]'
 435     '*-A[Ignore incomplete arch field in PKGBUILD]'
 436     '*-c[Clean up work files after build]'
 437     '*-d[Skip all dependency checks]'
 438     '*-e[Do not extract source files (use existing src/ dir)]'
 439     '*-f[Overwrite existing package]'
 440     '*-g[Generate integrity checks for source files]'
 441     '*-h[Show help message and exit]'
 442     '*-L[Log package build process]'
 443     '*-m[Disable colorized output messages]'
 444     '*-o[Download and extract files only]'
 445     '-p[Use an alternate build script (instead of 'PKGBUILD')]: :_files'
 446     '*-r[Remove installed dependencies after a successful build]'
 447     '*-R[Repackage contents of the package without rebuilding]'
 448     '*-S[Generate a source-only tarball without downloading sources]'
 449     )
 450
 451 _makepkg_action_none(){
 452   _arguments \
 453                 "$_makepkg_shortopts[@]"\
 454     "$_makepkg_longopts[@]"
 455 }
 456 _makepkg_longopts=(
 457   '--ignorearch[Ignore incomplete arch field in PKGBUILD]'
 458   '--clean[Clean up work files after build]'
 459   '--nodeps[Skip all dependency checks]'
 460   '--noextract[Do not extract source files (use existing src/ dir)]'
 461   '--force[Overwrite existing package]'
 462   '--geninteg[Generate integrity checks for source files]'
 463   '--help[Show help message and exit]'
 464   '--install[Install package after successful build]'
 465   '--log[Log package build process]'
 466   '--nocolor[Disable colorized output messages]'
 467   '--nobuild[Download and extract files only]'
 468   '--rmdeps[Remove installed dependencies after a successful build]'
 469   '--repackage[Repackage contents of the package without rebuilding]'
 470   '--syncdeps[Install missing dependencies with pacman]'
 471   '--source[Generate a source-only tarball without downloading sources]'
 472   '--allsource[Generate a source-only tarball including downloaded source]'
 473   '--asroot[Allow makepkg to run as root user]'
 474   '--check[Run check() function in the PKGBUILD]'
 475   '--config[Use an alternate config file instead of '/etc/makepkg.conf']: :_files'
 476   '--holdver[Prevent automatic version bumping for development PKGBUILDs]'
 477   '--key[Specify key to use for gpg signing instead of the default]: :_keys'
 478   '--nocheck[Do not run the check() function in the PKGBUILD]'
 479   '--nosign[Do not create a signature for the package]'
 480   '--pkg[Only build listed packages from a split package]'
 481   '--sign[Sign the resulting package with gpg]'
 482   '--skipchecksums[Do not verify checksums of the source files]'
 483   '--skipinteg[do not perform any verification checks on source files]'
 484   '--skippgpcheck[Do not verify source files with PGP signatures]'
 485   '--noconfirm[do not ask for confirmation when resolving dependencies]'
 486   '--asdeps[Install packages as non-explicitly installed]'
 487   '--noprogressbar[Do not show a progress bar when downloading files]'
 488   )
 489 _makepkg(){
 490     case $words[CURRENT] in
 491       -*)
 492         _arguments -s -w : \
 493           "$_makepkg_shortopts[@]" \
 494           "$_makepkg_longopts[@]"
 495         ;;
 496       --* )
 497         _arguments -s \
 498           "$_makepkg_longopts[@]"
 499         ;;
 500       - )_makepkg_action_none ;;
 501       * )
 502         i=$#
 503         while [[ $words[i] != -* ]] && [[ $words[$i] != "makepkg" ]];do
 504           i=$((i-1));
 505         done
 506         case $words[$i] in
 507           -*)
 508             _arguments -s -w : \
 509               "$_makepkg_shortopts[@]" \
 510               "$_makepkg_longopts[@]"
 511             ;;
 512           --* )
 513             _arguments -s \
 514               "$_makepkg_longopts[@]"
 515             ;;
 516           - )_makepkg_action_none ;;
 517           * ) return 1 ;;
 518         esac
 519       ;;
 520     esac
 521 }
 522 _pacman_comp() {
 523   case "$service" in
 524     makepkg)
 525       _makepkg "$@";;
 526     pacman-key)
 527       _pacman_key "$@";;
 528     pacman)
 529       _pacman_zsh_comp "$@";;
 530     *)
 531       _message "Error";;
 532   esac
 533 }
 534
 535 _pacman_comp "$@"