etc/zsh/zshrc

   1 # Filename:      /etc/zsh/zshrc
   2 # Purpose:       config file for zsh (z shell)
   3 # Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
   4 # Bug-Reports:   see http://grml.org/bugs/
   5 # License:       This file is licensed under the GPL v2.
   6 ################################################################################
   7 # This file is sourced only for interactive shells. It
   8 # should contain commands to set up aliases, functions,
   9 # options, key bindings, etc.
  10 #
  11 # Global Order: zshenv, zprofile, zshrc, zlogin
  12 ################################################################################
  13
  14 # zsh-refcard-tag documentation: {{{
  15 #   You may notice strange looking comments in this file.
  16 #   These are there for a purpose. grml's zsh-refcard can now be
  17 #   automatically generated from the contents of the actual configuration
  18 #   file. However, we need a little extra information on which comments
  19 #   and what lines of code to take into account (and for what purpose).
  20 #
  21 # Here is what they mean:
  22 #
  23 # List of tags (comment types) used:
  24 #   #a#     Next line contains an important alias, that should
  25 #           be included in the grml-zsh-refcard.
  26 #           (placement tag: @@INSERT-aliases@@)
  27 #   #f#     Next line contains the beginning of an important function.
  28 #           (placement tag: @@INSERT-functions@@)
  29 #   #v#     Next line contains an important variable.
  30 #           (placement tag: @@INSERT-variables@@)
  31 #   #k#     Next line contains an important keybinding.
  32 #           (placement tag: @@INSERT-keybindings@@)
  33 #   #d#     Hashed directories list generation:
  34 #               start   denotes the start of a list of 'hash -d'
  35 #                       definitions.
  36 #               end     denotes its end.
  37 #           (placement tag: @@INSERT-hasheddirs@@)
  38 #   #A#     Abbreviation expansion list generation:
  39 #               start   denotes the beginning of abbreviations.
  40 #               end     denotes their end.
  41 #           Lines within this section that end in '#d .*' provide
  42 #           extra documentation to be included in the refcard.
  43 #           (placement tag: @@INSERT-abbrev@@)
  44 #   #m#     This tag allows you to manually generate refcard entries
  45 #           for code lines that are hard/impossible to parse.
  46 #               Example:
  47 #                   #m# k ESC-h Call the run-help function
  48 #               That would add a refcard entry in the keybindings table
  49 #               for 'ESC-h' with the given comment.
  50 #           So the syntax is: #m# <section> <argument> <comment>
  51 #   #o#     This tag lets you insert entries to the 'other' hash.
  52 #           Generally, this should not be used. It is there for
  53 #           things that cannot be done easily in another way.
  54 #           (placement tag: @@INSERT-other-foobar@@)
  55 #
  56 #   All of these tags (except for m and o) take two arguments, the first
  57 #   within the tag, the other after the tag:
  58 #
  59 #   #<tag><section># <comment>
  60 #
  61 #   Where <section> is really just a number, which are defined by the
  62 #   @secmap array on top of 'genrefcard.pl'. The reason for numbers
  63 #   instead of names is, that for the reader, the tag should not differ
  64 #   much from a regular comment. For zsh, it is a regular comment indeed.
  65 #   The numbers have got the following meanings:
  66 #         0 -> "default"
  67 #         1 -> "system"
  68 #         2 -> "user"
  69 #         3 -> "debian"
  70 #         4 -> "search"
  71 #         5 -> "shortcuts"
  72 #         6 -> "services"
  73 #
  74 #   So, the following will add an entry to the 'functions' table in the
  75 #   'system' section, with a (hopefully) descriptive comment:
  76 #       #f1# Edit an alias via zle
  77 #       edalias() {
  78 #
  79 #   It will then show up in the @@INSERT-aliases-system@@ replacement tag
  80 #   that can be found in 'grml-zsh-refcard.tex.in'.
  81 #   If the section number is omitted, the 'default' section is assumed.
  82 #   Furthermore, in 'grml-zsh-refcard.tex.in' @@INSERT-aliases@@ is
  83 #   exactly the same as @@INSERT-aliases-default@@. If you want a list of
  84 #   *all* aliases, for example, use @@INSERT-aliases-all@@.
  85 #}}}
  86
  87 # zsh profiling {{{
  88 # just execute 'ZSH_PROFILE_RC=1 zsh' and run 'zprof' to get the details
  89 if [[ $ZSH_PROFILE_RC -gt 0 ]] ; then
  90     zmodload zsh/zprof
  91 fi
  92 # }}}
  93
  94 # load .zshrc.pre to give the user the chance to overwrite the defaults
  95 [[ -r ${HOME}/.zshrc.pre ]] && source ${HOME}/.zshrc.pre
  96
  97 # {{{ check for version/system
  98 # check for versions (compatibility reasons)
  99 is4(){
 100     [[ $ZSH_VERSION == <4->* ]] && return 0
 101     return 1
 102 }
 103
 104 is41(){
 105     [[ $ZSH_VERSION == 4.<1->* || $ZSH_VERSION == <5->* ]] && return 0
 106     return 1
 107 }
 108
 109 is42(){
 110     [[ $ZSH_VERSION == 4.<2->* || $ZSH_VERSION == <5->* ]] && return 0
 111     return 1
 112 }
 113
 114 is425(){
 115     [[ $ZSH_VERSION == 4.2.<5->* || $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
 116     return 1
 117 }
 118
 119 is43(){
 120     [[ $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
 121     return 1
 122 }
 123
 124 #f1# Checks whether or not you're running grml
 125 isgrml(){
 126     [[ -f /etc/grml_version ]] && return 0
 127     return 1
 128 }
 129
 130 #f1# Checks whether or not you're running a grml cd
 131 isgrmlcd(){
 132     [[ -f /etc/grml_cd ]] && return 0
 133     return 1
 134 }
 135
 136 if isgrml ; then
 137 #f1# Checks whether or not you're running grml-small
 138     isgrmlsmall() {
 139         [[ ${${${(f)"$(</etc/grml_version)"}%% *}##*-} == 'small' ]] && return 0 ; return 1
 140     }
 141 else
 142     isgrmlsmall() { return 1 }
 143 fi
 144
 145 isdarwin(){
 146     [[ $OSTYPE == darwin* ]] && return 0
 147     return 1
 148 }
 149
 150 #f1# are we running within an utf environment?
 151 isutfenv() {
 152     case "$LANG $CHARSET $LANGUAGE" in
 153         *utf*) return 0 ;;
 154         *UTF*) return 0 ;;
 155         *)     return 1 ;;
 156     esac
 157 }
 158
 159 # check for user, if not running as root set $SUDO to sudo
 160 (( EUID != 0 )) && SUDO='sudo' || SUDO=''
 161
 162 # change directory to home on first invocation of zsh
 163 # important for rungetty -> autologin
 164 # Thanks go to Bart Schaefer!
 165 isgrml && checkhome() {
 166     if [[ -z "$ALREADY_DID_CD_HOME" ]] ; then
 167         export ALREADY_DID_CD_HOME=$HOME
 168         cd
 169     fi
 170 }
 171
 172 # check for zsh v3.1.7+
 173
 174 if ! [[ ${ZSH_VERSION} == 3.1.<7->*      \
 175      || ${ZSH_VERSION} == 3.<2->.<->*    \
 176      || ${ZSH_VERSION} == <4->.<->*   ]] ; then
 177
 178     printf '-!-\n'
 179     printf '-!- In this configuration we try to make use of features, that only\n'
 180     printf '-!- require version 3.1.7 of the shell; That way this setup can be\n'
 181     printf '-!- used with a wide range of zsh versions, while using fairly\n'
 182     printf '-!- advanced features in all supported versions.\n'
 183     printf '-!-\n'
 184     printf '-!- However, you are running zsh version %s.\n' "$ZSH_VERSION"
 185     printf '-!-\n'
 186     printf '-!- While this *may* work, it might as well fail.\n'
 187     printf '-!- Please consider updating to at least version 3.1.7 of zsh.\n'
 188     printf '-!-\n'
 189     printf '-!- DO NOT EXPECT THIS TO WORK FLAWLESSLY!\n'
 190     printf '-!- If it does today, you'\''ve been lucky.\n'
 191     printf '-!-\n'
 192     printf '-!- Ye been warned!\n'
 193     printf '-!-\n'
 194
 195     function zstyle() { : }
 196 fi
 197
 198 # autoload wrapper - use this one instead of autoload directly
 199 # We need to define this function as early as this, because autoloading
 200 # 'is-at-least()' needs it.
 201 function zrcautoload() {
 202     setopt local_options extended_glob
 203     local fdir ffile
 204     local -i ffound
 205
 206     ffile=${1}
 207     (( found = 0 ))
 208     for fdir in ${fpath} ; do
 209         [[ -e ${fdir}/${ffile} ]] && (( ffound = 1 ))
 210     done
 211
 212     (( ffound == 0 )) && return 1
 213     if [[ $ZSH_VERSION == 3.1.<6-> || $ZSH_VERSION == <4->* ]] ; then
 214         autoload -U ${ffile} || return 1
 215     else
 216         autoload ${ffile} || return 1
 217     fi
 218     return 0
 219 }
 220
 221 # Load is-at-least() for more precise version checks
 222 # Note that this test will *always* fail, if the is-at-least
 223 # function could not be marked for autoloading.
 224 zrcautoload is-at-least || is-at-least() { return 1 }
 225
 226 # }}}
 227
 228 # setting some default values {{{
 229
 230 NOCOR=${NOCOR:-0}
 231 NOMENU=${NOMENU:-0}
 232 NOPRECMD=${NOPRECMD:-0}
 233 BATTERY=${BATTERY:-0}
 234 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
 235 GRML_ALWAYS_LOAD_ALL=${GRML_ALWAYS_LOAD_ALL:-0}
 236
 237 if isgrmlcd ; then
 238     GRML_WARN_SKEL=${GRML_WARN_SKEL:-0}
 239 else
 240     GRML_WARN_SKEL=${GRML_WARN_SKEL:-1}
 241 fi
 242
 243 if (( GRML_WARN_SKEL != 0 )) ; then
 244
 245 function grml_warn_skel_main() {
 246     printf '
 247 Dear user,
 248
 249 You updated grml'\''s zshrc which brings a major change.
 250 The configuration is kept only in one file, being the global zshrc.
 251 In the past, the configuration was split in two files, with the
 252 second file being the .zshrc file from /etc/skel.
 253
 254 If you have a .zshrc file in your home directory that originally
 255 came from the skel directory, please remove it. This is also the case
 256 if you followed earlier instructions from the grml-zsh-refcard or
 257 from <http://grml.org/console/> on non-grml systems.
 258
 259 Please see the current grml-zsh-refcard (available at
 260 <http://grml.org/zsh/>) for updated installation information. In short,
 261 you don'\''t want a .zshrc.global file. Install the global zshrc to
 262 ~/.zshrc and be done.
 263
 264 If you need changes to the configuration, use ~/.zshrc.pre and
 265 ~/.zshrc.local.
 266
 267 '
 268 }
 269
 270 function grml_warn_skel_remove() {
 271     printf 'To remove this warning execute '\''grml_do_not_warn_skel'\''.\n\n'
 272 }
 273
 274 function grml_do_not_warn_skel() {
 275     printf '# Do not warn about old skel dot-files anymore\n' >>! ~/.zshrc.pre
 276     printf 'GRML_WARN_SKEL=0\n' >>! ~/.zshrc.pre
 277 }
 278
 279 # let's try to guess how the user uses us.
 280 if is-at-least 4.3.7 ; then
 281     # funcsourcetrace requires at least version 4.3.7 of zsh.
 282     GRML_SRC_FILE="${${funcsourcetrace[1]}%:*}"
 283
 284     grml_warn_skel_main
 285     case ${GRML_SRC_FILE} in
 286         (${HOME}/.zshrc.global)
 287             grml_warn_skel_remove
 288             printf '\nIt looks like you copied the grml zshrc to '\''~/.zshrc.global'\''.\n'
 289             printf 'Nowadays you just copy the global zshrc to '\''~/.zshrc'\'' to use\n'
 290             printf 'it on a non-grml-system.\n'
 291             ;;
 292         (${HOME}/.zshrc)
 293             printf '\nIt looks like you copied the grml zshrc to '\''~/.zshrc'\''.\n'
 294             printf 'We'\''ll disable this warning automatically for later sessions.\n'
 295             grml_do_not_warn_skel
 296             ;;
 297         (*)
 298             grml_do_not_warn_skel
 299             ;;
 300     esac
 301 else
 302     grml_warn_skel_main
 303     grml_warn_skel_remove
 304 fi
 305
 306 unfunction grml_warn_skel_remove grml_warn_skel_main
 307
 308 fi # GRML_WARN_SKEL
 309
 310 # }}}
 311
 312 # utility functions {{{
 313 # this function checks if a command exists and returns either true
 314 # or false. This avoids using 'which' and 'whence', which will
 315 # avoid problems with aliases for which on certain weird systems. :-)
 316 check_com() {
 317     local -i comonly
 318
 319     if [[ ${1} == '-c' ]] ; then
 320         (( comonly = 1 ))
 321         shift
 322     else
 323         (( comonly = 0 ))
 324     fi
 325
 326     if (( ${#argv} != 1 )) ; then
 327         printf 'usage: check_com [-c] <command>\n' >&2
 328         return 1
 329     fi
 330
 331     if (( comonly > 0 )) ; then
 332         [[ -n ${commands[$1]}  ]] && return 0
 333         return 1
 334     fi
 335
 336     if   [[ -n ${commands[$1]}    ]] \
 337       || [[ -n ${functions[$1]}   ]] \
 338       || [[ -n ${aliases[$1]}     ]] \
 339       || [[ -n ${reswords[(r)$1]} ]] ; then
 340
 341         return 0
 342     fi
 343
 344     return 1
 345 }
 346
 347 # creates an alias and precedes the command with
 348 # sudo if $EUID is not zero.
 349 salias() {
 350     local only=0 ; local multi=0
 351     while [[ ${1} == -* ]] ; do
 352         case ${1} in
 353             (-o) only=1 ;;
 354             (-a) multi=1 ;;
 355             (--) shift ; break ;;
 356             (-h)
 357                 printf 'usage: salias [-h|-o|-a] <alias-expression>\n'
 358                 printf '  -h      shows this help text.\n'
 359                 printf '  -a      replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
 360                 printf '          be careful using this option.\n'
 361                 printf '  -o      only sets an alias if a preceding sudo would be needed.\n'
 362                 return 0
 363                 ;;
 364             (*) printf "unkown option: '%s'\n" "${1}" ; return 1 ;;
 365         esac
 366         shift
 367     done
 368
 369     if (( ${#argv} > 1 )) ; then
 370         printf 'Too many arguments %s\n' "${#argv}"
 371         return 1
 372     fi
 373
 374     key="${1%%\=*}" ;  val="${1#*\=}"
 375     if (( EUID == 0 )) && (( only == 0 )); then
 376         alias -- "${key}=${val}"
 377     elif (( EUID > 0 )) ; then
 378         (( multi > 0 )) && val="${val// ; / ; sudo }"
 379         alias -- "${key}=sudo ${val}"
 380     fi
 381
 382     return 0
 383 }
 384
 385 # a "print -l ${(u)foo}"-workaround for pre-4.2.0 shells
 386 # usage: uprint foo
 387 #   Where foo is the *name* of the parameter you want printed.
 388 #   Note that foo is no typo; $foo would be wrong here!
 389 if ! is42 ; then
 390     uprint () {
 391         local -a u
 392         local w
 393         local parameter=${1}
 394
 395         if [[ -z ${parameter} ]] ; then
 396             printf 'usage: uprint <parameter>\n'
 397             return 1
 398         fi
 399
 400         for w in ${(P)parameter} ; do
 401             [[ -z ${(M)u:#${w}} ]] && u=( ${u} ${w} )
 402         done
 403
 404         builtin print -l ${u}
 405     }
 406 fi
 407
 408 # Check if we can read given files and source those we can.
 409 xsource() {
 410     if (( ${#argv} < 1 )) ; then
 411         printf 'usage: xsource FILE(s)...\n' >&2
 412         return 1
 413     fi
 414
 415     while (( ${#argv} > 0 )) ; do
 416         [[ -r ${1} ]] && source ${1}
 417         shift
 418     done
 419     return 0
 420 }
 421
 422 # Check if we can read a given file and 'cat(1)' it.
 423 xcat() {
 424     if (( ${#argv} != 1 )) ; then
 425         printf 'usage: xcat FILE\n' >&2
 426         return 1
 427     fi
 428
 429     [[ -r ${1} ]] && cat ${1}
 430     return 0
 431 }
 432
 433 # Remove these functions again, they are of use only in these
 434 # setup files. This should be called at the end of .zshrc.
 435 xunfunction() {
 436     local -a funcs
 437     funcs=(salias xcat xsource xunfunction zrcautoload)
 438
 439     for func in $funcs ; do
 440         [[ -n ${functions[$func]} ]] \
 441             && unfunction $func
 442     done
 443     return 0
 444 }
 445
 446 # this allows us to stay in sync with grml's zshrc and put own
 447 # modifications in ~/.zshrc.local
 448 zrclocal() {
 449     xsource "${HOME}/.zshrc.local"
 450     return 0
 451 }
 452
 453 #}}}
 454
 455 # locale setup {{{
 456 xsource "/etc/default/locale"
 457
 458 export LANG=${LANG:-en_US.iso885915}
 459 for var in LC_ALL LC_MESSAGES ; do
 460     [[ -n ${(P)var} ]] && export $var
 461 done
 462
 463 xsource "/etc/sysconfig/keyboard"
 464
 465 TZ=$(xcat /etc/timezone)
 466 # }}}
 467
 468 # check for potentially old files in 'completion.d' {{{
 469 setopt extendedglob
 470 xof=(/etc/zsh/completion.d/*~/etc/zsh/completion.d/_*(N))
 471 if (( ${#xof} > 0 )) ; then
 472     printf '\n -!- INFORMATION\n\n'
 473     printf ' -!- %s file(s) not starting with an underscore (_) found in\n' ${#xof}
 474     printf ' -!- /etc/zsh/completion.d/.\n\n'
 475     printf ' -!- While this has been the case in old versions of grml-etc-core,\n'
 476     printf ' -!- recent versions of the grml-zsh-setup have all these files rewritten\n'
 477     printf ' -!- and renamed. Furthermore, the grml-zsh-setup will *only* add files\n'
 478     printf ' -!- named _* to that directory.\n\n'
 479     printf ' -!- If you added functions to completion.d yourself, please consider\n'
 480     printf ' -!- moving them to /etc/zsh/functions.d/. Files in that directory, not\n'
 481     printf ' -!- starting with an underscore are marked for automatic loading\n'
 482     printf ' -!- by default (so that is quite convenient).\n\n'
 483     printf ' -!- If there are files *not* starting with an underscore from an older\n'
 484     printf ' -!- grml-etc-core in completion.d, you may safely remove them.\n\n'
 485     printf ' -!- Delete the files for example via running:\n\n'
 486     printf "      rm ${xof}\n\n"
 487     printf ' -!- Note, that this message will *not* go away, unless you yourself\n'
 488     printf ' -!- resolve the situation manually.\n\n'
 489     BROKEN_COMPLETION_DIR=1
 490 fi
 491 unset xof
 492 # }}}
 493
 494 # {{{ set some variables
 495 if check_com -c vim ; then
 496 #v#
 497     export EDITOR=${EDITOR:-vim}
 498 else
 499     export EDITOR=${EDITOR:-vi}
 500 fi
 501
 502 #v#
 503 export PAGER=${PAGER:-less}
 504
 505 #v#
 506 export MAIL=${MAIL:-/var/mail/$USER}
 507
 508 # if we don't set $SHELL then aterm, rxvt,.. will use /bin/sh or /bin/bash :-/
 509 export SHELL='/bin/zsh'
 510
 511 # color setup for ls:
 512 check_com -c dircolors && eval $(dircolors -b)
 513 # color setup for ls on OS X:
 514 isdarwin && export CLICOLOR=1
 515
 516 # do MacPorts setup on darwin
 517 if isdarwin && [[ -d /opt/local ]]; then
 518     # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
 519     # zshenv.
 520     PATH="/opt/local/bin:/opt/local/sbin:$PATH"
 521     MANPATH="/opt/local/share/man:$MANPATH"
 522 fi
 523 # do Fink setup on darwin
 524 isdarwin && xsource /sw/bin/init.sh
 525
 526 # completion functions go to /etc/zsh/completion.d
 527 # function files may be put into /etc/zsh/functions.d, from where they
 528 # will be automatically autoloaded.
 529 if [[ -n "$BROKEN_COMPLETION_DIR" ]] ; then
 530     print 'Warning: not setting completion directories because broken files have been found.' >&2
 531 else
 532     [[ -d /etc/zsh/completion.d ]] && fpath=( $fpath /etc/zsh/completion.d )
 533     if [[ -d /etc/zsh/functions.d ]] ; then
 534         fdir='/etc/zsh/functions.d'
 535         fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
 536         for func in ${fdir}/**/[^_]*[^~](N.) ; do
 537             zrcautoload ${func:t}
 538         done
 539         unset fdir
 540     fi
 541 fi
 542
 543 # automatically remove duplicates from these arrays
 544 typeset -U path cdpath fpath manpath
 545 # }}}
 546
 547 # {{{ keybindings
 548 if [[ "$TERM" != emacs ]] ; then
 549     [[ -z "$terminfo[kdch1]" ]] || bindkey -M emacs "$terminfo[kdch1]" delete-char
 550     [[ -z "$terminfo[khome]" ]] || bindkey -M emacs "$terminfo[khome]" beginning-of-line
 551     [[ -z "$terminfo[kend]"  ]] || bindkey -M emacs "$terminfo[kend]"  end-of-line
 552     [[ -z "$terminfo[kdch1]" ]] || bindkey -M vicmd "$terminfo[kdch1]" vi-delete-char
 553     [[ -z "$terminfo[khome]" ]] || bindkey -M vicmd "$terminfo[khome]" vi-beginning-of-line
 554     [[ -z "$terminfo[kend]"  ]] || bindkey -M vicmd "$terminfo[kend]"  vi-end-of-line
 555     [[ -z "$terminfo[cuu1]"  ]] || bindkey -M viins "$terminfo[cuu1]"  vi-up-line-or-history
 556     [[ -z "$terminfo[cuf1]"  ]] || bindkey -M viins "$terminfo[cuf1]"  vi-forward-char
 557     [[ -z "$terminfo[kcuu1]" ]] || bindkey -M viins "$terminfo[kcuu1]" vi-up-line-or-history
 558     [[ -z "$terminfo[kcud1]" ]] || bindkey -M viins "$terminfo[kcud1]" vi-down-line-or-history
 559     [[ -z "$terminfo[kcuf1]" ]] || bindkey -M viins "$terminfo[kcuf1]" vi-forward-char
 560     [[ -z "$terminfo[kcub1]" ]] || bindkey -M viins "$terminfo[kcub1]" vi-backward-char
 561     # ncurses stuff:
 562     [[ "$terminfo[kcuu1]" == $'\eO'* ]] && bindkey -M viins "${terminfo[kcuu1]/O/[}" vi-up-line-or-history
 563     [[ "$terminfo[kcud1]" == $'\eO'* ]] && bindkey -M viins "${terminfo[kcud1]/O/[}" vi-down-line-or-history
 564     [[ "$terminfo[kcuf1]" == $'\eO'* ]] && bindkey -M viins "${terminfo[kcuf1]/O/[}" vi-forward-char
 565     [[ "$terminfo[kcub1]" == $'\eO'* ]] && bindkey -M viins "${terminfo[kcub1]/O/[}" vi-backward-char
 566     [[ "$terminfo[khome]" == $'\eO'* ]] && bindkey -M viins "${terminfo[khome]/O/[}" beginning-of-line
 567     [[ "$terminfo[kend]"  == $'\eO'* ]] && bindkey -M viins "${terminfo[kend]/O/[}"  end-of-line
 568     [[ "$terminfo[khome]" == $'\eO'* ]] && bindkey -M emacs "${terminfo[khome]/O/[}" beginning-of-line
 569     [[ "$terminfo[kend]"  == $'\eO'* ]] && bindkey -M emacs "${terminfo[kend]/O/[}"  end-of-line
 570 fi
 571
 572 ## keybindings (run 'bindkeys' for details, more details via man zshzle)
 573 # use emacs style per default:
 574 bindkey -e
 575 # use vi style:
 576 # bindkey -v
 577
 578 #if [[ "$TERM" == screen ]] ; then
 579 bindkey '\e[1~' beginning-of-line       # home
 580 bindkey '\e[4~' end-of-line             # end
 581 bindkey '\e[A'  up-line-or-search       # cursor up
 582 bindkey '\e[B'  down-line-or-search     # <ESC>-
 583
 584 bindkey '^xp'   history-beginning-search-backward
 585 bindkey '^xP'   history-beginning-search-forward
 586 # bindkey -s '^L' "|less\n"             # ctrl-L pipes to less
 587 # bindkey -s '^B' " &\n"                # ctrl-B runs it in the background
 588 # if terminal type is set to 'rxvt':
 589 bindkey '\e[7~' beginning-of-line       # home
 590 bindkey '\e[8~' end-of-line             # end
 591 #fi
 592
 593 # insert unicode character
 594 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
 595 # See for example http://unicode.org/charts/ for unicode characters code
 596 zrcautoload insert-unicode-char
 597 zle -N insert-unicode-char
 598 #k# Insert Unicode character
 599 bindkey '^Xi' insert-unicode-char
 600
 601 # just type 'cd ...' to get 'cd ../..'
 602 #  rationalise-dot() {
 603 #  if [[ $LBUFFER == *.. ]] ; then
 604 #    LBUFFER+=/..
 605 #  else
 606 #    LBUFFER+=.
 607 #  fi
 608 #  }
 609 #  zle -N rationalise-dot
 610 #  bindkey . rationalise-dot
 611
 612 #  bindkey '\eq' push-line-or-edit
 613
 614 ## toggle the ,. abbreviation feature on/off
 615 # NOABBREVIATION: default abbreviation-state
 616 #                 0 - enabled (default)
 617 #                 1 - disabled
 618 NOABBREVIATION=${NOABBREVIATION:-0}
 619
 620 grml_toggle_abbrev() {
 621     if (( ${NOABBREVIATION} > 0 )) ; then
 622         NOABBREVIATION=0
 623     else
 624         NOABBREVIATION=1
 625     fi
 626 }
 627
 628 zle -N grml_toggle_abbrev
 629 bindkey '^xA' grml_toggle_abbrev
 630
 631 # add a command line to the shells history without executing it
 632 commit-to-history() {
 633     print -s ${(z)BUFFER}
 634     zle send-break
 635 }
 636 zle -N commit-to-history
 637 bindkey "^x^h" commit-to-history
 638
 639 # }}}
 640
 641 # a generic accept-line wrapper {{{
 642
 643 # This widget can prevent unwanted autocorrections from command-name
 644 # to _command-name, rehash automatically on enter and call any number
 645 # of builtin and user-defined widgets in different contexts.
 646 #
 647 # For a broader description, see:
 648 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
 649 #
 650 # The code is imported from the file 'zsh/functions/accept-line' from
 651 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
 652 # distributed under the same terms as zsh itself.
 653
 654 # A newly added command will may not be found or will cause false
 655 # correction attempts, if you got auto-correction set. By setting the
 656 # following style, we force accept-line() to rehash, if it cannot
 657 # find the first word on the command line in the $command[] hash.
 658 zstyle ':acceptline:*' rehash true
 659
 660 function Accept-Line() {
 661     setopt localoptions noksharrays
 662     local -a subs
 663     local -xi aldone
 664     local sub
 665
 666     zstyle -a ":acceptline:${alcontext}" actions subs
 667
 668     (( ${#subs} < 1 )) && return 0
 669
 670     (( aldone = 0 ))
 671     for sub in ${subs} ; do
 672         [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
 673         zle ${sub}
 674
 675         (( aldone > 0 )) && break
 676     done
 677 }
 678
 679 function Accept-Line-getdefault() {
 680     local default_action
 681
 682     zstyle -s ":acceptline:${alcontext}" default_action default_action
 683     case ${default_action} in
 684         ((accept-line|))
 685             printf ".accept-line"
 686             ;;
 687         (*)
 688             printf ${default_action}
 689             ;;
 690     esac
 691 }
 692
 693 function accept-line() {
 694     setopt localoptions noksharrays
 695     local -a cmdline
 696     local -x alcontext
 697     local buf com fname format msg default_action
 698
 699     alcontext='default'
 700     buf="${BUFFER}"
 701     cmdline=(${(z)BUFFER})
 702     com="${cmdline[1]}"
 703     fname="_${com}"
 704
 705     zstyle -t ":acceptline:${alcontext}" rehash \
 706         && [[ -z ${commands[$com]} ]]           \
 707         && rehash
 708
 709     if    [[ -n ${reswords[(r)$com]} ]] \
 710        || [[ -n ${aliases[$com]}     ]] \
 711        || [[ -n ${functions[$com]}   ]] \
 712        || [[ -n ${builtins[$com]}    ]] \
 713        || [[ -n ${commands[$com]}    ]] ; then
 714
 715         # there is something sensible to execute, just do it.
 716         alcontext='normal'
 717         zle Accept-Line
 718
 719         default_action=$(Accept-Line-getdefault)
 720         zstyle -T ":acceptline:${alcontext}" call_default \
 721             && zle ${default_action}
 722         return
 723     fi
 724
 725     if    [[ -o correct              ]] \
 726        || [[ -o correctall           ]] \
 727        && [[ -n ${functions[$fname]} ]] ; then
 728
 729         # nothing there to execute but there is a function called
 730         # _command_name; a completion widget. Makes no sense to
 731         # call it on the commandline, but the correct{,all} options
 732         # will ask for it nevertheless, so warn the user.
 733         if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
 734             # Okay, we warned the user before, he called us again,
 735             # so have it his way.
 736             alcontext='force'
 737             zle Accept-Line
 738
 739             default_action=$(Accept-Line-getdefault)
 740             zstyle -T ":acceptline:${alcontext}" call_default \
 741                 && zle ${default_action}
 742             return
 743         fi
 744
 745         # prepare warning message for the user, configurable via zstyle.
 746         zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
 747
 748         if [[ -z ${msg} ]] ; then
 749             msg="%c will not execute and completion %f exists."
 750         fi
 751
 752         zformat -f msg "${msg}" "c:${com}" "f:${fname}"
 753
 754         zle -M -- "${msg}"
 755         return
 756     elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
 757         # If we are here, the commandline contains something that is not
 758         # executable, which is neither subject to _command_name correction
 759         # and is not empty. might be a variable assignment
 760         alcontext='misc'
 761         zle Accept-Line
 762
 763         default_action=$(Accept-Line-getdefault)
 764         zstyle -T ":acceptline:${alcontext}" call_default \
 765             && zle ${default_action}
 766         return
 767     fi
 768
 769     # If we got this far, the commandline only contains whitespace, or is empty.
 770     alcontext='empty'
 771     zle Accept-Line
 772
 773     default_action=$(Accept-Line-getdefault)
 774     zstyle -T ":acceptline:${alcontext}" call_default \
 775         && zle ${default_action}
 776 }
 777
 778 zle -N accept-line
 779 zle -N Accept-Line
 780
 781 # }}}
 782
 783 # power completion - abbreviation expansion {{{
 784 # power completion / abbreviation expansion / buffer expansion
 785 # see http://zshwiki.org/home/examples/zleiab for details
 786 # less risky than the global aliases but powerful as well
 787 # just type the abbreviation key and afterwards ',.' to expand it
 788 declare -A abk
 789 setopt extendedglob
 790 setopt interactivecomments
 791 abk=(
 792 #   key   # value                  (#d additional doc string)
 793 #A# start
 794     '...'  '../..'
 795     '....' '../../..'
 796     'BG'   '& exit'
 797     'C'    '| wc -l'
 798     'G'    '|& grep --color=auto '
 799     'H'    '| head'
 800     'Hl'   ' --help |& less -r'    #d (Display help in pager)
 801     'L'    '| less'
 802     'LL'   '|& less -r'
 803     'M'    '| most'
 804     'N'    '&>/dev/null'           #d (No Output)
 805     'R'    '| tr A-z N-za-m'       #d (ROT13)
 806     'SL'   '| sort | less'
 807     'S'    '| sort -u'
 808     'T'    '| tail'
 809     'V'    '|& vim -'
 810 #A# end
 811     'co'   './configure && make && sudo make install'
 812 )
 813
 814 globalias() {
 815     local MATCH
 816
 817     if (( NOABBREVIATION > 0 )) ; then
 818         LBUFFER="${LBUFFER},."
 819         return 0
 820     fi
 821
 822     matched_chars='[.-|_a-zA-Z0-9]#'
 823     LBUFFER=${LBUFFER%%(#m)[.-|_a-zA-Z0-9]#}
 824     LBUFFER+=${abk[$MATCH]:-$MATCH}
 825 }
 826
 827 zle -N globalias
 828 bindkey ",." globalias
 829 # }}}
 830
 831 # {{{ autoloading
 832 zrcautoload zmv    # who needs mmv or rename?
 833 zrcautoload history-search-end
 834
 835 # we don't want to quote/espace URLs on our own...
 836 # if autoload -U url-quote-magic ; then
 837 #    zle -N self-insert url-quote-magic
 838 #    zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
 839 # else
 840 #    print 'Notice: no url-quote-magic available :('
 841 # fi
 842 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
 843
 844 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
 845 alias run-help >&/dev/null && unalias run-help
 846 zrcautoload run-help # use via 'esc-h'
 847
 848 # completion system
 849 if zrcautoload compinit && compinit 2>/dev/null ; then
 850     compinit 2>/dev/null || print 'Notice: no compinit available :('
 851 else
 852     print 'Notice: no compinit available :('
 853     function zstyle { }
 854     function compdef { }
 855 fi
 856
 857 is4 && zrcautoload zed # use ZLE editor to edit a file or function
 858
 859 is4 && \
 860 for mod in complist deltochar mathfunc ; do
 861     zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
 862 done
 863
 864 # autoload zsh modules when they are referenced
 865 if is4 ; then
 866     tmpargs=(
 867         a   stat
 868         a   zpty
 869         ap  mapfile
 870     )
 871
 872     while (( ${#tmpargs} > 0 )) ; do
 873         zmodload -${tmpargs[1]} zsh/${tmpargs[2]} ${tmpargs[2]}
 874         shift 2 tmpargs
 875     done
 876     unset tmpargs
 877 fi
 878
 879 if is4 && zrcautoload insert-files && zle -N insert-files ; then
 880     #k# Insert files
 881     bindkey "^Xf" insert-files # C-x-f
 882 fi
 883
 884 bindkey ' '   magic-space    # also do history expansion on space
 885 #k# Trigger menu-complete
 886 bindkey '\ei' menu-complete  # menu completion via esc-i
 887
 888 # press esc-e for editing command line in $EDITOR or $VISUAL
 889 if is4 && zrcautoload edit-command-line && zle -N edit-command-line ; then
 890     #k# Edit the current line in \kbd{\$EDITOR}
 891     bindkey '\ee' edit-command-line
 892 fi
 893
 894 if is4 && [[ -n ${(k)modules[zsh/complist]} ]] ; then
 895     #k# menu selection: pick item but stay in the menu
 896     bindkey -M menuselect '\e^M' accept-and-menu-complete
 897
 898     # accept a completion and try to complete again by using menu
 899     # completion; very useful with completing directories
 900     # by using 'undo' one's got a simple file browser
 901     bindkey -M menuselect '^o' accept-and-infer-next-history
 902 fi
 903
 904 # press "ctrl-e d" to insert the actual date in the form yyyy-mm-dd
 905 _bkdate() { BUFFER="$BUFFER$(date '+%F')"; CURSOR=$#BUFFER; }
 906 zle -N _bkdate
 907
 908 #k# Insert a timestamp on the command line (yyyy-mm-dd)
 909 bindkey '^Ed' _bkdate
 910
 911 # press esc-m for inserting last typed word again (thanks to caphuso!)
 912 insert-last-typed-word() { zle insert-last-word -- 0 -1 };
 913 zle -N insert-last-typed-word;
 914
 915 #k# Insert last typed word
 916 bindkey "\em" insert-last-typed-word
 917
 918 #k# Shortcut for \kbd{fg<enter>}
 919 bindkey -s '^z' "fg\n"
 920
 921 # run command line as user root via sudo:
 922 sudo-command-line() {
 923     [[ -z $BUFFER ]] && zle up-history
 924     [[ $BUFFER != sudo\ * ]] && BUFFER="sudo $BUFFER"
 925 }
 926 zle -N sudo-command-line
 927
 928 #k# Put the current command line into a \kbd{sudo} call
 929 bindkey "^Os" sudo-command-line
 930
 931 ### jump behind the first word on the cmdline.
 932 ### useful to add options.
 933 function jump_after_first_word() {
 934     local words
 935     words=(${(z)BUFFER})
 936
 937     if (( ${#words} <= 1 )) ; then
 938         CURSOR=${#BUFFER}
 939     else
 940         CURSOR=${#${words[1]}}
 941     fi
 942 }
 943 zle -N jump_after_first_word
 944
 945 bindkey '^x1' jump_after_first_word
 946
 947 # }}}
 948
 949 # {{{ set some important options
 950 # Please update these tags, if you change the umask settings below.
 951 #o# r_umask     002
 952 #o# r_umaskstr  rwxrwxr-x
 953 #o# umask       022
 954 #o# umaskstr    rwxr-xr-x
 955 (( EUID != 0 )) && umask 002 || umask 022
 956
 957 # history:
 958 setopt append_history       # append history list to the history file (important for multiple parallel zsh sessions!)
 959 is4 && setopt SHARE_HISTORY # import new commands from the history file also in other zsh-session
 960 setopt extended_history     # save each command's beginning timestamp and the duration to the history file
 961 is4 && setopt histignorealldups # If  a  new  command  line being added to the history
 962                             # list duplicates an older one, the older command is removed from the list
 963 setopt histignorespace      # remove command lines from the history list when
 964                             # the first character on the line is a space
 965 setopt auto_cd              # if a command is issued that can't be executed as a normal command,
 966                             # and the command is the name of a directory, perform the cd command to that directory
 967 setopt extended_glob        # in order to use #, ~ and ^ for filename generation
 968                             # grep word *~(*.gz|*.bz|*.bz2|*.zip|*.Z) ->
 969                             # -> searches for word not in compressed files
 970                             # don't forget to quote '^', '~' and '#'!
 971 setopt longlistjobs         # display PID when suspending processes as well
 972 setopt notify               # report the status of backgrounds jobs immediately
 973 setopt hash_list_all        # Whenever a command completion is attempted, make sure \
 974                             # the entire command path is hashed first.
 975 setopt completeinword       # not just at the end
 976 setopt nohup                # and don't kill them, either
 977 setopt auto_pushd           # make cd push the old directory onto the directory stack.
 978 setopt nonomatch            # try to avoid the 'zsh: no matches found...'
 979 setopt nobeep               # avoid "beep"ing
 980 setopt pushd_ignore_dups    # don't push the same dir twice.
 981 setopt noglobdots           # * shouldn't match dotfiles. ever.
 982
 983 MAILCHECK=30       # mailchecks
 984 REPORTTIME=5       # report about cpu-/system-/user-time of command if running longer than 5 seconds
 985 watch=(notme root) # watch for everyone but me and root
 986
 987 # only slash should be considered as a word separator:
 988 slash-backward-kill-word() {
 989     local WORDCHARS="${WORDCHARS:s@/@}"
 990     # zle backward-word
 991     zle backward-kill-word
 992 }
 993 zle -N slash-backward-kill-word
 994
 995 #k# Kill everything in a word up to its last \kbd{/}
 996 bindkey '\ev' slash-backward-kill-word
 997
 998 # }}}
 999
1000 # {{{ history
1001
1002 ZSHDIR=$HOME/.zsh
1003
1004 #v#
1005 HISTFILE=$HOME/.zsh_history
1006 isgrmlcd && HISTSIZE=500  || HISTSIZE=5000
1007 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1008
1009 # }}}
1010
1011 # dirstack handling {{{
1012
1013 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1014 DIRSTACKFILE=${DIRSTACKFILE:-${HOME}/.zdirs}
1015
1016 if [[ -f ${DIRSTACKFILE} ]] && [[ ${#dirstack[*]} -eq 0 ]] ; then
1017     dirstack=( ${(f)"$(< $DIRSTACKFILE)"} )
1018     # "cd -" won't work after login by just setting $OLDPWD, so
1019     [[ -d $dirstack[0] ]] && cd $dirstack[0] && cd $OLDPWD
1020 fi
1021
1022 chpwd() {
1023     if is42 ; then
1024         builtin print -l ${(u)dirstack} >! ${DIRSTACKFILE}
1025     else
1026         uprint dirstack >! ${DIRSTACKFILE}
1027     fi
1028 }
1029
1030 # }}}
1031
1032 # {{{ display battery status on right side of prompt via running 'BATTERY=1 zsh'
1033 if [[ $BATTERY -gt 0 ]] ; then
1034     if ! check_com -c acpi ; then
1035         BATTERY=0
1036     fi
1037 fi
1038
1039 battery() {
1040 if [[ $BATTERY -gt 0 ]] ; then
1041     PERCENT="${${"$(acpi 2>/dev/null)"}/(#b)[[:space:]]#Battery <->: [^0-9]##, (<->)%*/${match[1]}}"
1042     if [[ -z "$PERCENT" ]] ; then
1043         PERCENT='acpi not present'
1044     else
1045         if [[ "$PERCENT" -lt 20 ]] ; then
1046             PERCENT="warning: ${PERCENT}%%"
1047         else
1048             PERCENT="${PERCENT}%%"
1049         fi
1050     fi
1051 fi
1052 }
1053 # }}}
1054
1055 # set colors for use in prompts {{{
1056 if zrcautoload colors && colors 2>/dev/null ; then
1057     BLUE="%{${fg[blue]}%}"
1058     RED="%{${fg_bold[red]}%}"
1059     GREEN="%{${fg[green]}%}"
1060     CYAN="%{${fg[cyan]}%}"
1061     MAGENTA="%{${fg[magenta]}%}"
1062     YELLOW="%{${fg[yellow]}%}"
1063     WHITE="%{${fg[white]}%}"
1064     NO_COLOUR="%{${reset_color}%}"
1065 else
1066     BLUE=$'%{\e[1;34m%}'
1067     RED=$'%{\e[1;31m%}'
1068     GREEN=$'%{\e[1;32m%}'
1069     CYAN=$'%{\e[1;36m%}'
1070     WHITE=$'%{\e[1;37m%}'
1071     MAGENTA=$'%{\e[1;35m%}'
1072     YELLOW=$'%{\e[1;33m%}'
1073     NO_COLOUR=$'%{\e[0m%}'
1074 fi
1075
1076 # }}}
1077
1078 # gather version control information for inclusion in a prompt {{{
1079
1080 if ! is41 ; then
1081     # Be quiet about version problems in grml's zshrc as the user cannot disable
1082     # loading vcs_info() as it is *in* the zshrc - as you can see. :-)
1083     # Just unset most probable variables and disable vcs_info altogether.
1084     local -i i
1085     for i in {0..9} ; do
1086         unset VCS_INFO_message_${i}_
1087     done
1088     zstyle ':vcs_info:*' enable false
1089 fi
1090
1091 # The following code is imported from the file 'zsh/functions/vcs_info'
1092 # from <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>,
1093 # which distributed under the same terms as zsh itself.
1094
1095 # we will be using two variables, so let the code know now.
1096 zstyle ':vcs_info:*' max-exports 2
1097
1098 # vcs_info() documentation:
1099 #{{{
1100 # REQUIREMENTS:
1101 #{{{
1102 #     This functionality requires zsh version >= 4.1.*.
1103 #}}}
1104 #
1105 # LOADING:
1106 #{{{
1107 # To load vcs_info(), copy this file to your $fpath[] and do:
1108 #   % autoload -Uz vcs_info && vcs_info
1109 #
1110 # To work, vcs_info() needs 'setopt prompt_subst' in your setup.
1111 #}}}
1112 #
1113 # QUICKSTART:
1114 #{{{
1115 # To get vcs_info() working quickly (including colors), you can do the
1116 # following (assuming, you loaded vcs_info() properly - see above):
1117 #
1118 # % RED=$'%{\e[31m%}'
1119 # % GR=$'%{\e[32m%}'
1120 # % MA=$'%{\e[35m%}'
1121 # % YE=$'%{\e[33m%}'
1122 # % NC=$'%{\e[0m%}'
1123 #
1124 # % zstyle ':vcs_info:*' actionformats \
1125 #       "${MA}(${NC}%s${MA})${YE}-${MA}[${GR}%b${YE}|${RED}%a${MA}]${NC} "
1126 #
1127 # % zstyle ':vcs_info:*' formats       \
1128 #       "${MA}(${NC}%s${MA})${Y}-${MA}[${GR}%b${MA}]${NC}%} "
1129 #
1130 # % zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "%b${RED}:${YE}%r"
1131 #
1132 # % precmd () { vcs_info }
1133 # % PS1='${MA}[${GR}%n${MA}] ${MA}(${RED}%!${MA}) ${YE}%3~ ${VCS_INFO_message_0_}${NC}%# '
1134 #
1135 # Obviously, the las two lines are there for demonstration: You need to
1136 # call vcs_info() from your precmd() function (see 'SPECIAL FUNCTIONS' in
1137 # 'man zshmisc'). Once that is done you need a *single* quoted
1138 # '${VCS_INFO_message_0_}' in your prompt.
1139 #
1140 # Now call the 'vcs_info_printsys' utility from the command line:
1141 #
1142 # % vcs_info_printsys
1143 # # list of supported version control backends:
1144 # # disabled systems are prefixed by a hash sign (#)
1145 # git
1146 # hg
1147 # bzr
1148 # darcs
1149 # svk
1150 # mtn
1151 # svn
1152 # cvs
1153 # cdv
1154 # tla
1155 # # flavours (cannot be used in the disable style; they
1156 # # are disabled with their master [git-svn -> git]):
1157 # git-p4
1158 # git-svn
1159 #
1160 # Ten version control backends as you can see. You may not want all
1161 # of these. Because there is no point in running the code to detect
1162 # systems you do not use. ever. So, there is a way to disable some
1163 # backends altogether:
1164 #
1165 # % zstyle ':vcs_info:*' disable bzr cdv darcs mtn svk tla
1166 #
1167 # If you rerun 'vcs_info_printsys' now, you will see the backends listed
1168 # in the 'disable' style marked as diabled by a hash sign. That means the
1169 # detection of these systems is skipped *completely*. No wasted time there.
1170 #
1171 # For more control, read the reference below.
1172 #}}}
1173 #
1174 # CONFIGURATION:
1175 #{{{
1176 # The vcs_info() feature can be configured via zstyle.
1177 #
1178 # First, the context in which we are working:
1179 #       :vcs_info:<vcs-string>:<user-context>
1180 #
1181 # ...where <vcs-string> is one of:
1182 #   - git, git-svn, git-p4, hg, darcs, bzr, cdv, mtn, svn, cvs, svk or tla.
1183 #
1184 # ...and <user-context> is a freely configurable string, assignable by the
1185 # user as the first argument to vcs_info() (see its description below).
1186 #
1187 # There is are three special values for <vcs-string>: The first is named
1188 # 'init', that is in effect as long as there was no decision what vcs
1189 # backend to use. The second is 'preinit; it is used *before* vcs_info()
1190 # is run, when initializing the data exporting variables. The third
1191 # special value is 'formats' and is used by the 'vcs_info_lastmsg' for
1192 # looking up its styles.
1193 #
1194 # There are two pre-defined values for <user-context>:
1195 #   default  - the one used if none is specified
1196 #   command  - used by vcs_info_lastmsg to lookup its styles.
1197 #
1198 # You may *not* use 'print_systems_' as a user-context string, because it
1199 # is used internally.
1200 #
1201 # You can of course use ':vcs_info:*' to match all VCSs in all
1202 # user-contexts at once.
1203 #
1204 # Another special context is 'formats', which is used by the
1205 # vcs_info_lastmsg() utility function (see below).
1206 #
1207 #
1208 # This is a description of all styles, that are looked up:
1209 #   formats             - A list of formats, used when actionformats is not
1210 #                         used (which is most of the time).
1211 #   actionformats       - A list of formats, used if a there is a special
1212 #                         action going on in your current repository;
1213 #                         (like an interactive rebase or a merge conflict)
1214 #   branchformat        - Some backends replace %b in the formats and
1215 #                         actionformats styles above, not only by a branch
1216 #                         name but also by a revision number. This style
1217 #                         let's you modify how that string should look like.
1218 #   nvcsformats         - These "formats" are exported, when we didn't detect
1219 #                         a version control system for the current directory.
1220 #                         This is useful, if you want vcs_info() to completely
1221 #                         take over the generation of your prompt.
1222 #                         You would do something like
1223 #                           PS1='${VCS_INFO_message_0_}'
1224 #                         to accomplish that.
1225 #   max-exports         - Defines the maximum number if VCS_INFO_message_*_
1226 #                         variables vcs_info() will export.
1227 #   enable              - Checked in the 'init' context. If set to false,
1228 #                         vcs_info() will do nothing.
1229 #   disable             - Provide a list of systems, you don't want
1230 #                         the vcs_info() to check for repositories
1231 #                         (checked in the 'init' context, too).
1232 #   disable-patterns    - A list of patterns that are checked against $PWD.
1233 #                         If the pattern matches, vcs_info will be disabled.
1234 #                         Say, ~/.zsh is a directory under version control,
1235 #                         in which you do not want vcs_info to be active, do:
1236 #                         zstyle ':vcs_info:*' disable-patterns "$HOME/.zsh+(|/*)"
1237 #   use-simple          - If there are two different ways of gathering
1238 #                         information, you can select the simpler one
1239 #                         by setting this style to true; the default
1240 #                         is to use the not-that-simple code, which is
1241 #                         potentially a lot slower but might be more
1242 #                         accurate in all possible cases.
1243 #   use-prompt-escapes  - determines if we assume that the assembled
1244 #                         string from vcs_info() includes prompt escapes.
1245 #                         (Used by vcs_info_lastmsg().
1246 #
1247 # The use-simple style is only available for the bzr backend.
1248 #
1249 # The default values for these in all contexts are:
1250 #   formats             " (%s)-[%b|%a]-"
1251 #   actionformats       " (%s)-[%b]-"
1252 #   branchformat        "%b:%r" (for bzr, svn and svk)
1253 #   nvcsformats         ""
1254 #   max-exports         2
1255 #   enable              true
1256 #   disable             (empty list)
1257 #   disable-patterns    (empty list)
1258 #   use-simple          false
1259 #   use-prompt-escapes  true
1260 #
1261 #
1262 # In normal formats and actionformats, the following replacements
1263 # are done:
1264 #   %s  - The vcs in use (git, hg, svn etc.)
1265 #   %b  - Information about the current branch.
1266 #   %a  - An identifier, that describes the action.
1267 #         Only makes sense in actionformats.
1268 #   %R  - base directory of the repository.
1269 #   %r  - repository name
1270 #         If %R is '/foo/bar/repoXY', %r is 'repoXY'.
1271 #   %S  - subdirectory within a repository. if $PWD is
1272 #         '/foo/bar/reposXY/beer/tasty', %S is 'beer/tasty'.
1273 #
1274 #
1275 # In branchformat these replacements are done:
1276 #   %b  - the branch name
1277 #   %r  - the current revision number
1278 #
1279 # Not all vcs backends have to support all replacements.
1280 # nvcsformat does not perform *any* replacements. It is just a string.
1281 #}}}
1282 #
1283 # ODDITIES:
1284 #{{{
1285 # If you want to use the %b (bold off) prompt expansion in 'formats', which
1286 # expands %b itself, use %%b. That will cause the vcs_info() expansion to
1287 # replace %%b with %b. So zsh's prompt expansion mechanism can handle it.
1288 # Similarly, to hand down %b from branchformat, use %%%%b. Sorry for this
1289 # inconvenience, but it cannot be easily avoided. Luckily we do not clash
1290 # with a lot of prompt expansions and this only needs to be done for those.
1291 # See 'man zshmisc' for details about EXPANSION OF PROMPT SEQUENCES.
1292 #}}}
1293 #
1294 # FUNCTION DESCRIPTIONS (public API):
1295 #{{{
1296 #   vcs_info()
1297 #       The main function, that runs all backends and assembles
1298 #       all data into ${VCS_INFO_message_*_}. This is the function
1299 #       you want to call from precmd() if you want to include
1300 #       up-to-date information in your prompt (see VARIABLE
1301 #       DESCRIPTION below).
1302 #
1303 #   vcs_info_printsys()
1304 #       Prints a list of all supported version control systems.
1305 #       Useful to find out possible contexts (and which of them are enabled)
1306 #       or values for the 'disable' style.
1307 #
1308 #   vcs_info_lastmsg()
1309 #       Outputs the last ${VCS_INFO_message_*_} value. Takes into account
1310 #       the value of the use-prompt-escapes style in ':vcs_info:formats'.
1311 #       It also only prints max-exports values.
1312 #
1313 # All functions named VCS_INFO_* are for internal use only.
1314 #}}}
1315 #
1316 # VARIABLE DESCRIPTION:
1317 #{{{
1318 #   ${VCS_INFO_message_N_}    (Note the trailing underscore)
1319 #       Where 'N' is an integer, eg: VCS_INFO_message_0_
1320 #       These variables are the storage for the informational message the
1321 #       last vcs_info() call has assembled. These are strongly connected
1322 #       to the formats, actionformats and nvcsformats styles described
1323 #       above. Those styles are lists. the first member of that list gets
1324 #       expanded into ${VCS_INFO_message_0_}, the second into
1325 #       ${VCS_INFO_message_1_} and the Nth into ${VCS_INFO_message_N-1_}.
1326 #       These parameters are exported into the environment.
1327 #       (See the max-exports style above.)
1328 #}}}
1329 #
1330 # EXAMPLES:
1331 #{{{
1332 #   Don't use vcs_info at all (even though it's in your prompt):
1333 #   % zstyle ':vcs_info:*' enable false
1334 #
1335 #   Disable the backends for bzr and svk:
1336 #   % zstyle ':vcs_info:*' disable bzr svk
1337 #
1338 #   Provide a special formats for git:
1339 #   % zstyle ':vcs_info:git:*' formats       ' GIT, BABY! [%b]'
1340 #   % zstyle ':vcs_info:git:*' actionformats ' GIT ACTION! [%b|%a]'
1341 #
1342 #   Use the quicker bzr backend (if you do, please report if it does
1343 #   the-right-thing[tm] - thanks):
1344 #   % zstyle ':vcs_info:bzr:*' use-simple true
1345 #
1346 #   Display the revision number in yellow for bzr and svn:
1347 #   % zstyle ':vcs_info:(svn|bzr):*' branchformat '%b%{'${fg[yellow]}'%}:%r'
1348 #
1349 # If you want colors, make sure you enclose the color codes in %{...%},
1350 # if you want to use the string provided by vcs_info() in prompts.
1351 #
1352 # Here is how to print the vcs infomation as a command:
1353 #   % alias vcsi='vcs_info command; vcs_info_lastmsg'
1354 #
1355 #   This way, you can even define different formats for output via
1356 #   vcs_info_lastmsg() in the ':vcs_info:command:*' namespace.
1357 #}}}
1358 #}}}
1359 # utilities
1360 VCS_INFO_adjust () { #{{{
1361     [[ -n ${vcs_comm[overwrite_name]} ]] && vcs=${vcs_comm[overwrite_name]}
1362     return 0
1363 }
1364 # }}}
1365 VCS_INFO_check_com () { #{{{
1366     (( ${+commands[$1]} )) && [[ -x ${commands[$1]} ]] && return 0
1367     return 1
1368 }
1369 # }}}
1370 VCS_INFO_formats () { # {{{
1371     setopt localoptions noksharrays
1372     local action=$1 branch=$2 base=$3
1373     local msg
1374     local -i i
1375
1376     if [[ -n ${action} ]] ; then
1377         zstyle -a ":vcs_info:${vcs}:${usercontext}" actionformats msgs
1378         (( ${#msgs} < 1 )) && msgs[1]=' (%s)-[%b|%a]-'
1379     else
1380         zstyle -a ":vcs_info:${vcs}:${usercontext}" formats msgs
1381         (( ${#msgs} < 1 )) && msgs[1]=' (%s)-[%b]-'
1382     fi
1383
1384     (( ${#msgs} > maxexports )) && msgs[$(( maxexports + 1 )),-1]=()
1385     for i in {1..${#msgs}} ; do
1386         zformat -f msg ${msgs[$i]}                      \
1387                         a:${action}                     \
1388                         b:${branch}                     \
1389                         r:${base:t}                     \
1390                         s:${vcs}                        \
1391                         R:${base}                       \
1392                         S:"$(VCS_INFO_reposub ${base})"
1393         msgs[$i]=${msg}
1394     done
1395     return 0
1396 }
1397 # }}}
1398 VCS_INFO_maxexports () { #{{{
1399     zstyle -s ":vcs_info:${vcs}:${usercontext}" "max-exports" maxexports || maxexports=2
1400     if [[ ${maxexports} != <-> ]] || (( maxexports < 1 )); then
1401         printf 'vcs_info(): expecting numeric arg >= 1 for max-exports (got %s).\n' ${maxexports}
1402         printf 'Defaulting to 2.\n'
1403         maxexports=2
1404     fi
1405 }
1406 # }}}
1407 VCS_INFO_nvcsformats () { #{{{
1408     setopt localoptions noksharrays
1409     local c v
1410
1411     if [[ $1 == 'preinit' ]] ; then
1412         c=default
1413         v=preinit
1414     fi
1415     zstyle -a ":vcs_info:${v:-$vcs}:${c:-$usercontext}" nvcsformats msgs
1416     (( ${#msgs} > maxexports )) && msgs[${maxexports},-1]=()
1417 }
1418 # }}}
1419 VCS_INFO_realpath () { #{{{
1420     # a portable 'readlink -f'
1421     # forcing a subshell, to ensure chpwd() is not removed
1422     # from the calling shell (if VCS_INFO_realpath() is called
1423     # manually).
1424     (
1425         (( ${+functions[chpwd]} )) && unfunction chpwd
1426         setopt chaselinks
1427         cd $1 2>/dev/null && pwd
1428     )
1429 }
1430 # }}}
1431 VCS_INFO_reposub () { #{{{
1432     setopt localoptions extendedglob
1433     local base=${1%%/##}
1434
1435     [[ ${PWD} == ${base}/* ]] || {
1436         printf '.'
1437         return 1
1438     }
1439     printf '%s' ${PWD#$base/}
1440     return 0
1441 }
1442 # }}}
1443 VCS_INFO_set () { #{{{
1444     setopt localoptions noksharrays
1445     local -i i j
1446
1447     if [[ $1 == '--clear' ]] ; then
1448         for i in {0..9} ; do
1449             unset VCS_INFO_message_${i}_
1450         done
1451     fi
1452     if [[ $1 == '--nvcs' ]] ; then
1453         [[ $2 == 'preinit' ]] && (( maxexports == 0 )) && (( maxexports = 1 ))
1454         for i in {0..$((maxexports - 1))} ; do
1455             typeset -gx VCS_INFO_message_${i}_=
1456         done
1457         VCS_INFO_nvcsformats $2
1458     fi
1459
1460     (( ${#msgs} - 1 < 0 )) && return 0
1461     for i in {0..$(( ${#msgs} - 1 ))} ; do
1462         (( j = i + 1 ))
1463         typeset -gx VCS_INFO_message_${i}_=${msgs[$j]}
1464     done
1465     return 0
1466 }
1467 # }}}
1468 # information gathering
1469 VCS_INFO_bzr_get_data () { # {{{
1470     setopt localoptions noksharrays
1471     local bzrbase bzrbr
1472     local -a bzrinfo
1473
1474     if zstyle -t ":vcs_info:${vcs}:${usercontext}" "use-simple" ; then
1475         bzrbase=${vcs_comm[basedir]}
1476         bzrinfo[2]=${bzrbase:t}
1477         if [[ -f ${bzrbase}/.bzr/branch/last-revision ]] ; then
1478             bzrinfo[1]=$(< ${bzrbase}/.bzr/branch/last-revision)
1479             bzrinfo[1]=${${bzrinfo[1]}%% *}
1480         fi
1481     else
1482         bzrbase=${${(M)${(f)"$( bzr info )"}:# ##branch\ root:*}/*: ##/}
1483         bzrinfo=( ${${${(M)${(f)"$( bzr version-info )"}:#(#s)(revno|branch-nick)*}/*: /}/*\//} )
1484         bzrbase="$(VCS_INFO_realpath ${bzrbase})"
1485     fi
1486
1487     zstyle -s ":vcs_info:${vcs}:${usercontext}" branchformat bzrbr || bzrbr="%b:%r"
1488     zformat -f bzrbr "${bzrbr}" "b:${bzrinfo[2]}" "r:${bzrinfo[1]}"
1489     VCS_INFO_formats '' "${bzrbr}" "${bzrbase}"
1490     return 0
1491 }
1492 # }}}
1493 VCS_INFO_cdv_get_data () { # {{{
1494     local cdvbase
1495
1496     cdvbase=${vcs_comm[basedir]}
1497     VCS_INFO_formats '' "${cdvbase:t}" "${cdvbase}"
1498     return 0
1499 }
1500 # }}}
1501 VCS_INFO_cvs_get_data () { # {{{
1502     local cvsbranch cvsbase basename
1503
1504     cvsbase="."
1505     while [[ -d "${cvsbase}/../CVS" ]]; do
1506         cvsbase="${cvsbase}/.."
1507     done
1508     cvsbase="$(VCS_INFO_realpath ${cvsbase})"
1509     cvsbranch=$(< ./CVS/Repository)
1510     basename=${cvsbase:t}
1511     cvsbranch=${cvsbranch##${basename}/}
1512     [[ -z ${cvsbranch} ]] && cvsbranch=${basename}
1513     VCS_INFO_formats '' "${cvsbranch}" "${cvsbase}"
1514     return 0
1515 }
1516 # }}}
1517 VCS_INFO_darcs_get_data () { # {{{
1518     local darcsbase
1519
1520     darcsbase=${vcs_comm[basedir]}
1521     VCS_INFO_formats '' "${darcsbase:t}" "${darcsbase}"
1522     return 0
1523 }
1524 # }}}
1525 VCS_INFO_git_getaction () { #{{{
1526     local gitaction='' gitdir=$1
1527     local tmp
1528
1529     for tmp in "${gitdir}/rebase-apply" \
1530                "${gitdir}/rebase"       \
1531                "${gitdir}/../.dotest" ; do
1532         if [[ -d ${tmp} ]] ; then
1533             if   [[ -f "${tmp}/rebasing" ]] ; then
1534                 gitaction="rebase"
1535             elif [[ -f "${tmp}/applying" ]] ; then
1536                 gitaction="am"
1537             else
1538                 gitaction="am/rebase"
1539             fi
1540             printf '%s' ${gitaction}
1541             return 0
1542         fi
1543     done
1544
1545     for tmp in "${gitdir}/rebase-merge/interactive" \
1546                "${gitdir}/.dotest-merge/interactive" ; do
1547         if [[ -f "${tmp}" ]] ; then
1548             printf '%s' "rebase-i"
1549             return 0
1550         fi
1551     done
1552
1553     for tmp in "${gitdir}/rebase-merge" \
1554                "${gitdir}/.dotest-merge" ; do
1555         if [[ -d "${tmp}" ]] ; then
1556             printf '%s' "rebase-m"
1557             return 0
1558         fi
1559     done
1560
1561     if [[ -f "${gitdir}/MERGE_HEAD" ]] ; then
1562         printf '%s' "merge"
1563         return 0
1564     fi
1565
1566     if [[ -f "${gitdir}/BISECT_LOG" ]] ; then
1567         printf '%s' "bisect"
1568         return 0
1569     fi
1570     return 1
1571 }
1572 # }}}
1573 VCS_INFO_git_getbranch () { #{{{
1574     local gitbranch gitdir=$1
1575     local gitsymref='git symbolic-ref HEAD'
1576
1577     if    [[ -d "${gitdir}/rebase-apply" ]] \
1578        || [[ -d "${gitdir}/rebase" ]]       \
1579        || [[ -d "${gitdir}/../.dotest" ]]   \
1580        || [[ -f "${gitdir}/MERGE_HEAD" ]] ; then
1581         gitbranch="$(${(z)gitsymref} 2> /dev/null)"
1582         [[ -z ${gitbranch} ]] && [[ -r ${gitdir}/rebase-apply/head-name ]] \
1583             && gitbranch="$(< ${gitdir}/rebase-apply/head-name)"
1584
1585     elif   [[ -f "${gitdir}/rebase-merge/interactive" ]] \
1586         || [[ -d "${gitdir}/rebase-merge" ]] ; then
1587         gitbranch="$(< ${gitdir}/rebase-merge/head-name)"
1588
1589     elif   [[ -f "${gitdir}/.dotest-merge/interactive" ]] \
1590         || [[ -d "${gitdir}/.dotest-merge" ]] ; then
1591         gitbranch="$(< ${gitdir}/.dotest-merge/head-name)"
1592
1593     else
1594         gitbranch="$(${(z)gitsymref} 2> /dev/null)"
1595
1596         if [[ $? -ne 0 ]] ; then
1597             gitbranch="$(git describe --exact-match HEAD 2>/dev/null)"
1598
1599             if [[ $? -ne 0 ]] ; then
1600                 gitbranch="${${"$(< $gitdir/HEAD)"}[1,7]}..."
1601             fi
1602         fi
1603     fi
1604
1605     printf '%s' "${gitbranch##refs/heads/}"
1606     return 0
1607 }
1608 # }}}
1609 VCS_INFO_git_get_data () { # {{{
1610     setopt localoptions extendedglob
1611     local gitdir gitbase gitbranch gitaction
1612
1613     gitdir=${vcs_comm[gitdir]}
1614     gitbranch="$(VCS_INFO_git_getbranch ${gitdir})"
1615
1616     if [[ -z ${gitdir} ]] || [[ -z ${gitbranch} ]] ; then
1617         return 1
1618     fi
1619
1620     VCS_INFO_adjust
1621     gitaction="$(VCS_INFO_git_getaction ${gitdir})"
1622     gitbase=${PWD%/${$( git rev-parse --show-prefix )%/##}}
1623     VCS_INFO_formats "${gitaction}" "${gitbranch}" "${gitbase}"
1624     return 0
1625 }
1626 # }}}
1627 VCS_INFO_hg_get_data () { # {{{
1628     local hgbranch hgbase
1629
1630     hgbase=${vcs_comm[basedir]}
1631     hgbranch=$(< ${hgbase}/.hg/branch)
1632     VCS_INFO_formats '' "${hgbranch}" "${hgbase}"
1633     return 0
1634 }
1635 # }}}
1636 VCS_INFO_mtn_get_data () { # {{{
1637     local mtnbranch mtnbase
1638
1639     mtnbase=${vcs_comm[basedir]}
1640     mtnbranch=${${(M)${(f)"$( mtn status )"}:#(#s)Current branch:*}/*: /}
1641     VCS_INFO_formats '' "${mtnbranch}" "${mtnbase}"
1642     return 0
1643 }
1644 # }}}
1645 VCS_INFO_svk_get_data () { # {{{
1646     local svkbranch svkbase
1647
1648     svkbase=${vcs_comm[basedir]}
1649     zstyle -s ":vcs_info:${vcs}:${usercontext}" branchformat svkbranch || svkbranch="%b:%r"
1650     zformat -f svkbranch "${svkbranch}" "b:${vcs_comm[branch]}" "r:${vcs_comm[revision]}"
1651     VCS_INFO_formats '' "${svkbranch}" "${svkbase}"
1652     return 0
1653 }
1654 # }}}
1655 VCS_INFO_svn_get_data () { # {{{
1656     setopt localoptions noksharrays
1657     local svnbase svnbranch
1658     local -a svninfo
1659
1660     svnbase="."
1661     while [[ -d "${svnbase}/../.svn" ]]; do
1662         svnbase="${svnbase}/.."
1663     done
1664     svnbase="$(VCS_INFO_realpath ${svnbase})"
1665     svninfo=( ${${${(M)${(f)"$( svn info )"}:#(#s)(URL|Revision)*}/*: /}/*\//} )
1666
1667     zstyle -s ":vcs_info:${vcs}:${usercontext}" branchformat svnbranch || svnbranch="%b:%r"
1668     zformat -f svnbranch "${svnbranch}" "b:${svninfo[1]}" "r:${svninfo[2]}"
1669     VCS_INFO_formats '' "${svnbranch}" "${svnbase}"
1670     return 0
1671 }
1672 # }}}
1673 VCS_INFO_tla_get_data () { # {{{
1674     local tlabase tlabranch
1675
1676     tlabase="$(VCS_INFO_realpath ${vcs_comm[basedir]})"
1677     # tree-id gives us something like 'foo@example.com/demo--1.0--patch-4', so:
1678     tlabranch=${${"$( tla tree-id )"}/*\//}
1679     VCS_INFO_formats '' "${tlabranch}" "${tlabase}"
1680     return 0
1681 }
1682 # }}}
1683 # detection
1684 VCS_INFO_detect_by_dir() { #{{{
1685     local dirname=$1
1686     local basedir="." realbasedir
1687
1688     realbasedir="$(VCS_INFO_realpath ${basedir})"
1689     while [[ ${realbasedir} != '/' ]]; do
1690         if [[ -n ${vcs_comm[detect_need_file]} ]] ; then
1691             [[ -d ${basedir}/${dirname} ]] && \
1692             [[ -f ${basedir}/${dirname}/${vcs_comm[detect_need_file]} ]] && \
1693                 break
1694         else
1695             [[ -d ${basedir}/${dirname} ]] && break
1696         fi
1697
1698         basedir=${basedir}/..
1699         realbasedir="$(VCS_INFO_realpath ${basedir})"
1700     done
1701
1702     [[ ${realbasedir} == "/" ]] && return 1
1703     vcs_comm[basedir]=${realbasedir}
1704     return 0
1705 }
1706 # }}}
1707 VCS_INFO_bzr_detect() { #{{{
1708     VCS_INFO_check_com bzr || return 1
1709     vcs_comm[detect_need_file]=branch/format
1710     VCS_INFO_detect_by_dir '.bzr'
1711     return $?
1712 }
1713 # }}}
1714 VCS_INFO_cdv_detect() { #{{{
1715     VCS_INFO_check_com cdv || return 1
1716     vcs_comm[detect_need_file]=format
1717     VCS_INFO_detect_by_dir '.cdv'
1718     return $?
1719 }
1720 # }}}
1721 VCS_INFO_cvs_detect() { #{{{
1722     VCS_INFO_check_com svn || return 1
1723     [[ -d "./CVS" ]] && [[ -r "./CVS/Repository" ]] && return 0
1724     return 1
1725 }
1726 # }}}
1727 VCS_INFO_darcs_detect() { #{{{
1728     VCS_INFO_check_com darcs || return 1
1729     vcs_comm[detect_need_file]=format
1730     VCS_INFO_detect_by_dir '_darcs'
1731     return $?
1732 }
1733 # }}}
1734 VCS_INFO_git_detect() { #{{{
1735     if VCS_INFO_check_com git && git rev-parse --is-inside-work-tree &> /dev/null ; then
1736         vcs_comm[gitdir]="$(git rev-parse --git-dir 2> /dev/null)" || return 1
1737         if   [[ -d ${vcs_comm[gitdir]}/svn ]]             ; then vcs_comm[overwrite_name]='git-svn'
1738         elif [[ -d ${vcs_comm[gitdir]}/refs/remotes/p4 ]] ; then vcs_comm[overwrite_name]='git-p4' ; fi
1739         return 0
1740     fi
1741     return 1
1742 }
1743 # }}}
1744 VCS_INFO_hg_detect() { #{{{
1745     VCS_INFO_check_com hg || return 1
1746     vcs_comm[detect_need_file]=branch
1747     VCS_INFO_detect_by_dir '.hg'
1748     return $?
1749 }
1750 # }}}
1751 VCS_INFO_mtn_detect() { #{{{
1752     VCS_INFO_check_com mtn || return 1
1753     vcs_comm[detect_need_file]=revision
1754     VCS_INFO_detect_by_dir '_MTN'
1755     return $?
1756 }
1757 # }}}
1758 VCS_INFO_svk_detect() { #{{{
1759     setopt localoptions noksharrays extendedglob
1760     local -a info
1761     local -i fhash
1762     fhash=0
1763
1764     VCS_INFO_check_com svk || return 1
1765     [[ -f ~/.svk/config ]] || return 1
1766
1767     # This detection function is a bit different from the others.
1768     # We need to read svk's config file to detect a svk repository
1769     # in the first place. Therefore, we'll just proceed and read
1770     # the other information, too. This is more then any of the
1771     # other detections do but this takes only one file open for
1772     # svk at most. VCS_INFO_svk_get_data() get simpler, too. :-)
1773     while IFS= read -r line ; do
1774         if [[ -n ${vcs_comm[basedir]} ]] ; then
1775             line=${line## ##}
1776             [[ ${line} == depotpath:* ]] && vcs_comm[branch]=${line##*/}
1777             [[ ${line} == revision:* ]] && vcs_comm[revision]=${line##*[[:space:]]##}
1778             [[ -n ${vcs_comm[branch]} ]] && [[ -n ${vcs_comm[revision]} ]] && break
1779             continue
1780         fi
1781         (( fhash > 0 )) && [[ ${line} == '  '[^[:space:]]*:* ]] && break
1782         [[ ${line} == '  hash:'* ]] && fhash=1 && continue
1783         (( fhash == 0 )) && continue
1784         [[ ${PWD}/ == ${${line## ##}%:*}/* ]] && vcs_comm[basedir]=${${line## ##}%:*}
1785     done < ~/.svk/config
1786
1787     [[ -n ${vcs_comm[basedir]} ]]  && \
1788     [[ -n ${vcs_comm[branch]} ]]   && \
1789     [[ -n ${vcs_comm[revision]} ]] && return 0
1790     return 1
1791 }
1792 # }}}
1793 VCS_INFO_svn_detect() { #{{{
1794     VCS_INFO_check_com svn || return 1
1795     [[ -d ".svn" ]] && return 0
1796     return 1
1797 }
1798 # }}}
1799 VCS_INFO_tla_detect() { #{{{
1800     VCS_INFO_check_com tla || return 1
1801     vcs_comm[basedir]="$(tla tree-root 2> /dev/null)" && return 0
1802     return 1
1803 }
1804 # }}}
1805 # public API
1806 vcs_info_printsys () { # {{{
1807     vcs_info print_systems_
1808 }
1809 # }}}
1810 vcs_info_lastmsg () { # {{{
1811     local -i i
1812
1813     VCS_INFO_maxexports
1814     for i in {0..$((maxexports - 1))} ; do
1815         printf '$VCS_INFO_message_%d_: "' $i
1816         if zstyle -T ':vcs_info:formats:command' use-prompt-escapes ; then
1817             print -nP ${(P)${:-VCS_INFO_message_${i}_}}
1818         else
1819             print -n ${(P)${:-VCS_INFO_message_${i}_}}
1820         fi
1821         printf '"\n'
1822     done
1823 }
1824 # }}}
1825 vcs_info () { # {{{
1826     local pat
1827     local -i found
1828     local -a VCSs disabled dps
1829     local -x vcs usercontext
1830     local -ix maxexports
1831     local -ax msgs
1832     local -Ax vcs_comm
1833
1834     vcs="init"
1835     VCSs=(git hg bzr darcs svk mtn svn cvs cdv tla)
1836     case $1 in
1837         (print_systems_)
1838             zstyle -a ":vcs_info:${vcs}:${usercontext}" "disable" disabled
1839             print -l '# list of supported version control backends:' \
1840                      '# disabled systems are prefixed by a hash sign (#)'
1841             for vcs in ${VCSs} ; do
1842                 [[ -n ${(M)disabled:#${vcs}} ]] && printf '#'
1843                 printf '%s\n' ${vcs}
1844             done
1845             print -l '# flavours (cannot be used in the disable style; they' \
1846                      '# are disabled with their master [git-svn -> git]):'   \
1847                      git-{p4,svn}
1848             return 0
1849             ;;
1850         ('')
1851             [[ -z ${usercontext} ]] && usercontext=default
1852             ;;
1853         (*) [[ -z ${usercontext} ]] && usercontext=$1
1854             ;;
1855     esac
1856
1857     zstyle -T ":vcs_info:${vcs}:${usercontext}" "enable" || {
1858         [[ -n ${VCS_INFO_message_0_} ]] && VCS_INFO_set --clear
1859         return 0
1860     }
1861     zstyle -a ":vcs_info:${vcs}:${usercontext}" "disable" disabled
1862
1863     zstyle -a ":vcs_info:${vcs}:${usercontext}" "disable-patterns" dps
1864     for pat in ${dps} ; do
1865         if [[ ${PWD} == ${~pat} ]] ; then
1866             [[ -n ${vcs_info_msg_0_} ]] && VCS_INFO_set --clear
1867             return 0
1868         fi
1869     done
1870
1871     VCS_INFO_maxexports
1872
1873     (( found = 0 ))
1874     for vcs in ${VCSs} ; do
1875         [[ -n ${(M)disabled:#${vcs}} ]] && continue
1876         vcs_comm=()
1877         VCS_INFO_${vcs}_detect && (( found = 1 )) && break
1878     done
1879
1880     (( found == 0 )) && {
1881         VCS_INFO_set --nvcs
1882         return 0
1883     }
1884
1885     VCS_INFO_${vcs}_get_data || {
1886         VCS_INFO_set --nvcs
1887         return 1
1888     }
1889
1890     VCS_INFO_set
1891     return 0
1892 }
1893
1894 VCS_INFO_set --nvcs preinit
1895 # }}}
1896
1897 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1898 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1899 # TODO: The included vcs_info() version still uses $VCS_INFO_message_N_.
1900 #       That needs to be the use of $VCS_INFO_message_N_ needs to be changed
1901 #       to $vcs_info_msg_N_ as soon as we use the included version.
1902 if [[ "$TERM" == dumb ]] ; then
1903     zstyle ':vcs_info:*' actionformats "(%s%)-[%b|%a] " "zsh: %r"
1904     zstyle ':vcs_info:*' formats       "(%s%)-[%b] "    "zsh: %r"
1905 else
1906     # these are the same, just with a lot of colours:
1907     zstyle ':vcs_info:*' actionformats "${MAGENTA}(${NO_COLOUR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOUR} " \
1908                                        "zsh: %r"
1909     zstyle ':vcs_info:*' formats       "${MAGENTA}(${NO_COLOUR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOUR}%} " \
1910                                        "zsh: %r"
1911     zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "%b${RED}:${YELLOW}%r"
1912 fi
1913
1914 # }}}
1915
1916 # {{{ set prompt
1917 if zrcautoload promptinit && promptinit 2>/dev/null ; then
1918     promptinit # people should be able to use their favourite prompt
1919 else
1920     print 'Notice: no promptinit available :('
1921 fi
1922
1923 setopt prompt_subst
1924
1925 # make sure to use right prompt only when not running a command
1926 is41 && setopt transient_rprompt
1927
1928 # TODO: revise all these NO* variables and especially their documentation
1929 #       in zsh-help() below.
1930 is4 && [[ $NOPRECMD -eq 0 ]] && precmd () {
1931     [[ $NOPRECMD -gt 0 ]] && return 0
1932     # update VCS information
1933     vcs_info
1934
1935     if [[ $TERM == screen* ]] ; then
1936         if [[ -n ${VCS_INFO_message_1_} ]] ; then
1937             print -nP "\ek${VCS_INFO_message_1_}\e\\"
1938         else
1939             print -nP "\ekzsh\e\\"
1940         fi
1941     fi
1942     # just use DONTSETRPROMPT=1 to be able to overwrite RPROMPT
1943     if [[ $DONTSETRPROMPT -eq 0 ]] ; then
1944         if [[ $BATTERY -gt 0 ]] ; then
1945             # update battery (dropped into $PERCENT) information
1946             battery
1947             RPROMPT="%(?..:() ${PERCENT}"
1948         else
1949             RPROMPT="%(?..:() "
1950         fi
1951     fi
1952     # adjust title of xterm
1953     # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
1954     [[ ${NOTITLE} -gt 0 ]] && return 0
1955     case $TERM in
1956         (xterm*|rxvt*)
1957             print -Pn "\e]0;%n@%m: %~\a"
1958             ;;
1959     esac
1960 }
1961
1962 # preexec() => a function running before every command
1963 is4 && [[ $NOPRECMD -eq 0 ]] && \
1964 preexec () {
1965     [[ $NOPRECMD -gt 0 ]] && return 0
1966 # set hostname if not running on host with name 'grml'
1967     if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
1968        NAME="@$HOSTNAME"
1969     fi
1970 # get the name of the program currently running and hostname of local machine
1971 # set screen window title if running in a screen
1972     if [[ "$TERM" == screen* ]] ; then
1973         # local CMD=${1[(wr)^(*=*|sudo|ssh|-*)]}       # don't use hostname
1974         local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME" # use hostname
1975         echo -ne "\ek$CMD\e\\"
1976     fi
1977 # adjust title of xterm
1978     [[ ${NOTITLE} -gt 0 ]] && return 0
1979     case $TERM in
1980         (xterm*|rxvt)
1981             print -Pn "\e]0;%n@%m: $1\a"
1982             ;;
1983     esac
1984 }
1985
1986 EXITCODE="%(?..%?%1v )"
1987 PS2='\`%_> '      # secondary prompt, printed when the shell needs more information to complete a command.
1988 PS3='?# '         # selection prompt used within a select loop.
1989 PS4='+%N:%i:%_> ' # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1990
1991 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1992 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1993     debian_chroot=$(cat /etc/debian_chroot)
1994 fi
1995
1996 # don't use colors on dumb terminals (like emacs):
1997 if [[ "$TERM" == dumb ]] ; then
1998     PROMPT="${EXITCODE}${debian_chroot:+($debian_chroot)}%n@%m %40<...<%B%~%b%<< "'${VCS_INFO_message_0_}'"%# "
1999 else
2000     # only if $GRMLPROMPT is set (e.g. via 'GRMLPROMPT=1 zsh') use the extended prompt
2001     # set variable identifying the chroot you work in (used in the prompt below)
2002     if [[ $GRMLPROMPT -gt 0 ]] ; then
2003         PROMPT="${RED}${EXITCODE}${CYAN}[%j running job(s)] ${GREEN}{history#%!} ${RED}%(3L.+.) ${BLUE}%* %D
2004 ${BLUE}%n${NO_COLOUR}@%m %40<...<%B%~%b%<< %# "
2005     else
2006         # This assembles the primary prompt string
2007         if (( EUID != 0 )); then
2008             PROMPT="${RED}${EXITCODE}${WHITE}${debian_chroot:+($debian_chroot)}${BLUE}%n${NO_COLOUR}@%m %40<...<%B%~%b%<< "'${VCS_INFO_message_0_}'"%# "
2009         else
2010             PROMPT="${BLUE}${EXITCODE}${WHITE}${debian_chroot:+($debian_chroot)}${RED}%n${NO_COLOUR}@%m %40<...<%B%~%b%<< "'${VCS_INFO_message_0_}'"%# "
2011         fi
2012     fi
2013 fi
2014
2015 # if we are inside a grml-chroot set a specific prompt theme
2016 if [[ -n "$GRML_CHROOT" ]] ; then
2017     PROMPT="%{$fg[red]%}(CHROOT) %{$fg_bold[red]%}%n%{$fg_no_bold[white]%}@%m %40<...<%B%~%b%<< %\# "
2018 fi
2019 # }}}
2020
2021 # {{{ 'hash' some often used directories
2022 #d# start
2023 hash -d deb=/var/cache/apt/archives
2024 hash -d doc=/usr/share/doc
2025 hash -d linux=/lib/modules/$(command uname -r)/build/
2026 hash -d log=/var/log
2027 hash -d slog=/var/log/syslog
2028 hash -d src=/usr/src
2029 hash -d templ=/usr/share/doc/grml-templates
2030 hash -d tt=/usr/share/doc/texttools-doc
2031 hash -d www=/var/www
2032 #d# end
2033 # }}}
2034
2035 # {{{ some aliases
2036 if check_com -c screen ; then
2037     if [[ $UID -eq 0 ]] ; then
2038         [[ -r /etc/grml/screenrc ]] && alias screen="${commands[screen]} -c /etc/grml/screenrc"
2039     elif [[ -r $HOME/.screenrc ]] ; then
2040         alias screen="${commands[screen]} -c $HOME/.screenrc"
2041     else
2042         [[ -r /etc/grml/screenrc_grml ]] && alias screen="${commands[screen]} -c /etc/grml/screenrc_grml"
2043     fi
2044 fi
2045
2046 # do we have GNU ls with color-support?
2047 if ls --help 2>/dev/null | grep -- --color= >/dev/null && [[ "$TERM" != dumb ]] ; then
2048     #a1# execute \kbd{@a@}:\quad ls with colors
2049     alias ls='ls -b -CF --color=auto'
2050     #a1# execute \kbd{@a@}:\quad list all files, with colors
2051     alias la='ls -la --color=auto'
2052     #a1# long colored list, without dotfiles (@a@)
2053     alias ll='ls -l --color=auto'
2054     #a1# long colored list, human readable sizes (@a@)
2055     alias lh='ls -hAl --color=auto'
2056     #a1# List files, append qualifier to filenames \\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2057     alias l='ls -lF --color=auto'
2058 else
2059     alias ls='ls -b -CF'
2060     alias la='ls -la'
2061     alias ll='ls -l'
2062     alias lh='ls -hAl'
2063     alias l='ls -lF'
2064 fi
2065
2066 alias mdstat='cat /proc/mdstat'
2067 alias ...='cd ../../'
2068
2069 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2070 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2071     alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2072 fi
2073
2074 alias cp='nocorrect cp'         # no spelling correction on cp
2075 alias mkdir='nocorrect mkdir'   # no spelling correction on mkdir
2076 alias mv='nocorrect mv'         # no spelling correction on mv
2077 alias rm='nocorrect rm'         # no spelling correction on rm
2078
2079 #a1# Execute \kbd{rmdir}
2080 alias rd='rmdir'
2081 #a1# Execute \kbd{rmdir}
2082 alias md='mkdir'
2083
2084 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2085 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2086 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2087
2088 # make sure it is not assigned yet
2089 [[ $(whence -w utf2iso &>/dev/null) == 'utf2iso: alias' ]] && unalias utf2iso
2090
2091 utf2iso() {
2092     if isutfenv ; then
2093         for ENV in $(env | command grep -i '.utf') ; do
2094             eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2095         done
2096     fi
2097 }
2098
2099 # make sure it is not assigned yet
2100 [[ $(whence -w iso2utf &>/dev/null) == 'iso2utf: alias' ]] && unalias iso2utf
2101 iso2utf() {
2102     if ! isutfenv ; then
2103         for ENV in $(env | command grep -i '\.iso') ; do
2104             eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2105         done
2106     fi
2107 }
2108
2109 # set up software synthesizer via speakup
2110 swspeak() {
2111     if [ -x /usr/sbin/swspeak-setup ] ; then
2112        setopt singlelinezle
2113        unsetopt prompt_cr
2114        export PS1="%m%# "
2115        /usr/sbin/swspeak-setup $@
2116      else # old version:
2117         aumix -w 90 -v 90 -p 90 -m 90
2118         if ! [[ -r /dev/softsynth ]] ; then
2119             flite -o play -t "Sorry, software synthesizer not available. Did you boot with swspeak bootoption?"
2120             return 1
2121         else
2122            setopt singlelinezle
2123            unsetopt prompt_cr
2124            export PS1="%m%# "
2125             nice -n -20 speechd-up
2126             sleep 2
2127             flite -o play -t "Finished setting up software synthesizer"
2128         fi
2129      fi
2130 }
2131
2132 # I like clean prompt, so provide simple way to get that
2133 check_com 0 || alias 0='return 0'
2134
2135 # for really lazy people like mika:
2136 check_com S &>/dev/null || alias S='screen'
2137 check_com s &>/dev/null || alias s='ssh'
2138
2139 # get top 10 shell commands:
2140 alias top10='print -l ? ${(o)history%% *} | uniq -c | sort -nr | head -n 10'
2141
2142 # truecrypt; use e.g. via 'truec /dev/ice /mnt/ice' or 'truec -i'
2143 if check_com -c truecrypt ; then
2144     if isutfenv ; then
2145         alias truec='truecrypt --mount-options "rw,sync,dirsync,users,uid=1000,gid=users,umask=077,utf8" '
2146     else
2147         alias truec='truecrypt --mount-options "rw,sync,dirsync,users,uid=1000,gid=users,umask=077" '
2148     fi
2149 fi
2150
2151 #f1# Hints for the use of zsh on grml
2152 zsh-help() {
2153     print "$bg[white]$fg[black]
2154 zsh-help - hints for use of zsh on grml
2155 =======================================$reset_color"
2156
2157     print '
2158 Main configuration of zsh happens in /etc/zsh/zshrc.
2159 That file is part of the package grml-etc-core, if you want to
2160 use them on a non-grml-system just get the tar.gz from
2161 http://deb.grml.org/ or (preferably) get it from the git repository:
2162
2163   http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2164
2165 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2166 The file is still there, but it is empty for backwards compatibility.
2167
2168 For your own changes use these two files:
2169     $HOME/.zshrc.pre
2170     $HOME/.zshrc.local
2171
2172 The former is sourced very early in our zshrc, the latter is sourced
2173 very lately.
2174
2175 System wide configuration without touching configuration files of grml
2176 can take place in /etc/zsh/zshrc.local.
2177
2178 Normally, the root user (EUID == 0) does not get the whole grml setup.
2179 If you want to force the whole setup for that user, too, set
2180 GRML_ALWAYS_LOAD_ALL=1 in .zshrc.pre in root'\''s home directory.
2181
2182 For information regarding zsh start at http://grml.org/zsh/
2183
2184 Take a look at grml'\''s zsh refcard:
2185 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2186
2187 Check out the main zsh refcard:
2188 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2189
2190 And of course visit the zsh-lovers:
2191 % man zsh-lovers
2192
2193 You can adjust some options through environment variables when
2194 invoking zsh without having to edit configuration files.
2195 Basically meant for bash users who are not used to the power of
2196 the zsh yet. :)
2197
2198   "NOCOR=1    zsh" => deactivate automatic correction
2199   "NOMENU=1   zsh" => do not use auto menu completion (note: use ctrl-d for completion instead!)
2200   "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2201   "NOTITLE=1  zsh" => disable setting the title of xterms without disabling
2202                       preexec() and precmd() completely
2203   "BATTERY=1  zsh" => activate battery status (via acpi) on right side of prompt
2204
2205 A value greater than 0 is enables a feature; a value equal to zero
2206 disables it. If you like one or the other of these settings, you can
2207 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2208 zshrc.'
2209
2210     print "
2211 $bg[white]$fg[black]
2212 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2213 Enjoy your grml system with the zsh!$reset_color"
2214 }
2215
2216 # debian stuff
2217 if [[ -r /etc/debian_version ]] ; then
2218     #a3# Execute \kbd{apt-cache search}
2219     alias acs='apt-cache search'
2220     #a3# Execute \kbd{apt-cache show}
2221     alias acsh='apt-cache show'
2222     #a3# Execute \kbd{apt-cache policy}
2223     alias acp='apt-cache policy'
2224     #a3# Execute \kbd{apt-get dist-upgrade}
2225     salias adg="apt-get dist-upgrade"
2226     #a3# Execute \kbd{apt-get install}
2227     salias agi="apt-get install"
2228     #a3# Execute \kbd{aptitude install}
2229     salias ati="aptitude install"
2230     #a3# Execute \kbd{apt-get upgrade}
2231     salias ag="apt-get upgrade"
2232     #a3# Execute \kbd{apt-get update}
2233     salias au="apt-get update"
2234     #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2235     salias -a up="aptitude update ; aptitude safe-upgrade"
2236     #a3# Execute \kbd{dpkg-buildpackage}
2237     alias dbp='dpkg-buildpackage'
2238     #a3# Execute \kbd{grep-excuses}
2239     alias ge='grep-excuses'
2240
2241     # debian upgrade
2242     #f3# Execute \kbd{apt-get update \&\& }\\&\quad \kbd{apt-get dist-upgrade}
2243     upgrade() {
2244         if [[ -z "$1" ]] ; then
2245             $SUDO apt-get update
2246             $SUDO apt-get -u upgrade
2247         else
2248             ssh $1 $SUDO apt-get update
2249             # ask before the upgrade
2250             local dummy
2251             ssh $1 $SUDO apt-get --no-act upgrade
2252             echo -n 'Process the upgrade?'
2253             read -q dummy
2254             if [[ $dummy == "y" ]] ; then
2255                 ssh $1 $SUDO apt-get -u upgrade --yes
2256             fi
2257         fi
2258     }
2259
2260     # get a root shell as normal user in live-cd mode:
2261     if isgrmlcd && [[ $UID -ne 0 ]] ; then
2262        alias su="sudo su"
2263      fi
2264
2265     #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
2266     alias llog="$PAGER /var/log/syslog"     # take a look at the syslog
2267     #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
2268     alias tlog="tail -f /var/log/syslog"    # follow the syslog
2269 fi
2270
2271 # sort installed Debian-packages by size
2272 if check_com -c grep-status ; then
2273     #a3# List installed Debian-packages sorted by size
2274     alias debs-by-size='grep-status -FStatus -sInstalled-Size,Package -n "install ok installed" | paste -sd "  \n" | sort -rn'
2275 fi
2276
2277 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2278 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord ; then
2279     if check_com -c wodim ; then
2280         alias cdrecord="echo 'cdrecord is not provided under its original name by Debian anymore.
2281 See #377109 in the BTS of Debian for more details.
2282
2283 Please use the wodim binary instead' ; return 1"
2284     fi
2285 fi
2286
2287 # get_tw_cli has been renamed into get_3ware
2288 if check_com -c get_3ware ; then
2289     get_tw_cli() {
2290         echo 'Warning: get_tw_cli has been renamed into get_3ware. Invoking get_3ware for you.'>&2
2291         get_3ware
2292     }
2293 fi
2294
2295 # I hate lacking backward compatibility, so provide an alternative therefore
2296 if ! check_com -c apache2-ssl-certificate ; then
2297
2298     apache2-ssl-certificate() {
2299
2300     print 'Debian does not ship apache2-ssl-certificate anymore (see #398520). :('
2301     print 'You might want to take a look at Debian the package ssl-cert as well.'
2302     print 'To generate a certificate for use with apache2 follow the instructions:'
2303
2304     echo '
2305
2306 export RANDFILE=/dev/random
2307 mkdir /etc/apache2/ssl/
2308 openssl req $@ -new -x509 -days 365 -nodes -out /etc/apache2/ssl/apache.pem -keyout /etc/apache2/ssl/apache.pem
2309 chmod 600 /etc/apache2/ssl/apache.pem
2310
2311 Run "grml-tips ssl-certificate" if you need further instructions.
2312 '
2313     }
2314 fi
2315 # }}}
2316
2317 # {{{ Use hard limits, except for a smaller stack and no core dumps
2318 unlimit
2319 is425 && limit stack 8192
2320 isgrmlcd && limit core 0 # important for a live-cd-system
2321 limit -s
2322 # }}}
2323
2324 # {{{ completion system
2325
2326 # called later (via is4 && grmlcomp)
2327 # note: use 'zstyle' for getting current settings
2328 #         press ^Xh (control-x h) for getting tags in context; ^X? (control-x ?) to run complete_debug with trace output
2329 grmlcomp() {
2330     # TODO: This could use some additional information
2331
2332     # allow one error for every three characters typed in approximate completer
2333     zstyle ':completion:*:approximate:'    max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
2334
2335     # don't complete backup files as executables
2336     zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
2337
2338     # start menu completion only if it could find no unambiguous initial string
2339     zstyle ':completion:*:correct:*'       insert-unambiguous true
2340     zstyle ':completion:*:corrections'     format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
2341     zstyle ':completion:*:correct:*'       original true
2342
2343     # activate color-completion
2344     zstyle ':completion:*:default'         list-colors ${(s.:.)LS_COLORS}
2345
2346     # format on completion
2347     zstyle ':completion:*:descriptions'    format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
2348
2349     # complete 'cd -<tab>' with menu
2350     zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
2351
2352     # insert all expansions for expand completer
2353     zstyle ':completion:*:expand:*'        tag-order all-expansions
2354     zstyle ':completion:*:history-words'   list false
2355
2356     # activate menu
2357     zstyle ':completion:*:history-words'   menu yes
2358
2359     # ignore duplicate entries
2360     zstyle ':completion:*:history-words'   remove-all-dups yes
2361     zstyle ':completion:*:history-words'   stop yes
2362
2363     # match uppercase from lowercase
2364     zstyle ':completion:*'                 matcher-list 'm:{a-z}={A-Z}'
2365
2366     # separate matches into groups
2367     zstyle ':completion:*:matches'         group 'yes'
2368     zstyle ':completion:*'                 group-name ''
2369
2370     if [[ "$NOMENU" -eq 0 ]] ; then
2371         # if there are more than 5 options allow selecting from a menu
2372         zstyle ':completion:*'               menu select=5
2373     else
2374         # don't use any menus at all
2375         setopt no_auto_menu
2376     fi
2377
2378     zstyle ':completion:*:messages'        format '%d'
2379     zstyle ':completion:*:options'         auto-description '%d'
2380
2381     # describe options in full
2382     zstyle ':completion:*:options'         description 'yes'
2383
2384     # on processes completion complete all user processes
2385     zstyle ':completion:*:processes'       command 'ps -au$USER'
2386
2387     # offer indexes before parameters in subscripts
2388     zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
2389
2390     # provide verbose completion information
2391     zstyle ':completion:*'                 verbose true
2392
2393     # recent (as of Dec 2007) zsh versions are able to provide descriptions
2394     # for commands (read: 1st word in the line) that it will list for the user
2395     # to choose from. The following disables that, because it's not exactly fast.
2396     zstyle ':completion:*:-command-:*:'    verbose false
2397
2398     # set format for warnings
2399     zstyle ':completion:*:warnings'        format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
2400
2401     # define files to ignore for zcompile
2402     zstyle ':completion:*:*:zcompile:*'    ignored-patterns '(*~|*.zwc)'
2403     zstyle ':completion:correct:'          prompt 'correct to: %e'
2404
2405     # Ignore completion functions for commands you don't have:
2406     zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
2407
2408     # Provide more processes in completion of programs like killall:
2409     zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
2410
2411     # complete manual by their section
2412     zstyle ':completion:*:manuals'    separate-sections true
2413     zstyle ':completion:*:manuals.*'  insert-sections   true
2414     zstyle ':completion:*:man:*'      menu yes select
2415
2416     # provide .. as a completion
2417     zstyle ':completion:*' special-dirs ..
2418
2419     # run rehash on completion so new installed program are found automatically:
2420     _force_rehash() {
2421         (( CURRENT == 1 )) && rehash
2422         return 1
2423     }
2424
2425     ## correction
2426     # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
2427     if [[ "$NOCOR" -gt 0 ]] ; then
2428         zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
2429         setopt nocorrect
2430     else
2431         # try to be smart about when to use what completer...
2432         setopt correct
2433         zstyle -e ':completion:*' completer '
2434             if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
2435                 _last_try="$HISTNO$BUFFER$CURSOR"
2436                 reply=(_complete _match _ignored _prefix _files)
2437             else
2438                 if [[ $words[1] == (rm|mv) ]] ; then
2439                     reply=(_complete _files)
2440                 else
2441                     reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
2442                 fi
2443             fi'
2444     fi
2445
2446     # command for process lists, the local web server details and host completion
2447     zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
2448
2449     # caching
2450     [[ -d $ZSHDIR/cache ]] && zstyle ':completion:*' use-cache yes && \
2451                             zstyle ':completion::complete:*' cache-path $ZSHDIR/cache/
2452
2453     # host completion /* add brackets as vim can't parse zsh's complex cmdlines 8-) {{{ */
2454     if is42 ; then
2455         [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
2456         [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
2457     else
2458         _ssh_hosts=()
2459         _etc_hosts=()
2460     fi
2461     hosts=(
2462         $(hostname)
2463         "$_ssh_hosts[@]"
2464         "$_etc_hosts[@]"
2465         grml.org
2466         localhost
2467     )
2468     zstyle ':completion:*:hosts' hosts $hosts
2469     # TODO: so, why is this here?
2470     #  zstyle '*' hosts $hosts
2471
2472     # use generic completion system for programs not yet defined; (_gnu_generic works
2473     # with commands that provide a --help option with "standard" gnu-like output.)
2474     for compcom in tail head feh cp mv df stow uname ipacsum fetchipac; do
2475         [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
2476     done; unset compcom
2477
2478     # see upgrade function in this file
2479     compdef _hosts upgrade
2480 }
2481 # }}}
2482
2483 # {{{ grmlstuff
2484 grmlstuff() {
2485 # people should use 'grml-x'!
2486     startx() {
2487         if [[ -e /etc/X11/xorg.conf ]] ; then
2488             [[ -x /usr/bin/startx ]] && /usr/bin/startx "$@" || /usr/X11R6/bin/startx "$@"
2489         else
2490             echo "Please use the script \"grml-x\" for starting the X Window System
2491 because there does not exist /etc/X11/xorg.conf yet.
2492 If you want to use startx anyway please call \"/usr/bin/startx\"."
2493             return -1
2494         fi
2495     }
2496
2497     xinit() {
2498         if [[ -e /etc/X11/xorg.conf ]] ; then
2499             [[ -x /usr/bin/xinit ]] && /usr/bin/xinit || /usr/X11R6/bin/xinit
2500         else
2501             echo "Please use the script \"grml-x\" for starting the X Window System.
2502 because there does not exist /etc/X11/xorg.conf yet.
2503 If you want to use xinit anyway please call \"/usr/bin/xinit\"."
2504             return -1
2505         fi
2506     }
2507
2508     if check_com -c 915resolution ; then
2509         alias 855resolution='echo -e "Please use 915resolution as resolution modify tool for Intel graphic chipset."; return -1'
2510     fi
2511
2512     #a1# Output version of running grml
2513     alias grml-version='cat /etc/grml_version'
2514
2515     if check_com -c rebuildfstab ; then
2516         #a1# Rebuild /etc/fstab
2517         alias grml-rebuildfstab='rebuildfstab -v -r -config'
2518     fi
2519
2520     if check_com -c grml-debootstrap ; then
2521         alias debian2hd='print "Installing debian to harddisk is possible via using grml-debootstrap." ; return 1'
2522     fi
2523 }
2524 # }}}
2525
2526 # {{{ now run the functions
2527 isgrml && checkhome
2528 is4    && isgrml    && grmlstuff
2529 is4    && grmlcomp
2530 # }}}
2531
2532 # {{{ keephack
2533 is4 && xsource "/etc/zsh/keephack"
2534 # }}}
2535
2536 # {{{ wonderful idea of using "e" glob qualifier by Peter Stephenson
2537 # You use it as follows:
2538 # $ NTREF=/reference/file
2539 # $ ls -l *(e:nt:)
2540 # This lists all the files in the current directory newer than the reference file.
2541 # You can also specify the reference file inline; note quotes:
2542 # $ ls -l *(e:'nt ~/.zshenv':)
2543 is4 && nt() {
2544     if [[ -n $1 ]] ; then
2545         local NTREF=${~1}
2546     fi
2547     [[ $REPLY -nt $NTREF ]]
2548 }
2549 # }}}
2550
2551 # shell functions {{{
2552
2553 #f1# Provide csh compatibility
2554 setenv()  { typeset -x "${1}${1:+=}${(@)argv[2,$#]}" }  # csh compatibility
2555
2556 #f1# Reload an autoloadable function
2557 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2558
2559 #f1# Reload zsh setup
2560 reload() {
2561     if [[ "$#*" -eq 0 ]] ; then
2562         [[ -r ~/.zshrc ]] && . ~/.zshrc
2563     else
2564         local fn
2565         for fn in "$@"; do
2566             unfunction $fn
2567             autoload -U $fn
2568         done
2569     fi
2570 }
2571 compdef _functions reload freload
2572
2573 #f1# List symlinks in detail (more detailed version of 'readlink -f' and 'whence -s')
2574 sll() {
2575     [[ -z "$1" ]] && printf 'Usage: %s <file(s)>\n' "$0" && return 1
2576     for i in "$@" ; do
2577         file=$i
2578         while [[ -h "$file" ]] ; do
2579             ls -l $file
2580             file=$(readlink "$file")
2581         done
2582     done
2583 }
2584
2585 # fast manual access
2586 if check_com qma ; then
2587     #f1# View the zsh manual
2588     manzsh()  { qma zshall "$1" }
2589     compdef _man qma
2590 else
2591     manzsh()  { /usr/bin/man zshall |  vim -c "se ft=man| se hlsearch" +/"$1" - ; }
2592 fi
2593
2594 if check_com -c $PAGER ; then
2595     #f1# View Debian's changelog of a given package
2596     dchange() {
2597         if [[ -r /usr/share/doc/${1}/changelog.Debian.gz ]] ; then
2598             $PAGER /usr/share/doc/${1}/changelog.Debian.gz
2599         elif [[ -r /usr/share/doc/${1}/changelog.gz ]] ; then
2600             $PAGER /usr/share/doc/${1}/changelog.gz
2601         else
2602             if check_com -c aptitude ; then
2603                 echo "No changelog for package $1 found, using aptitude to retrieve it."
2604                 if isgrml ; then
2605                     aptitude -t unstable changelog ${1}
2606                 else
2607                     aptitude changelog ${1}
2608                 fi
2609             else
2610                 echo "No changelog for package $1 found, sorry."
2611                 return 1
2612             fi
2613         fi
2614     }
2615     _dchange() { _files -W /usr/share/doc -/ }
2616     compdef _dchange dchange
2617
2618     #f1# View Debian's NEWS of a given package
2619     dnews() {
2620         if [[ -r /usr/share/doc/${1}/NEWS.Debian.gz ]] ; then
2621             $PAGER /usr/share/doc/${1}/NEWS.Debian.gz
2622         else
2623             if [[ -r /usr/share/doc/${1}/NEWS.gz ]] ; then
2624                 $PAGER /usr/share/doc/${1}/NEWS.gz
2625             else
2626                 echo "No NEWS file for package $1 found, sorry."
2627                 return 1
2628             fi
2629         fi
2630     }
2631     _dnews() { _files -W /usr/share/doc -/ }
2632     compdef _dnews dnews
2633
2634     #f1# View upstream's changelog of a given package
2635     uchange() {
2636         if [[ -r /usr/share/doc/${1}/changelog.gz ]] ; then
2637             $PAGER /usr/share/doc/${1}/changelog.gz
2638         else
2639             echo "No changelog for package $1 found, sorry."
2640             return 1
2641         fi
2642     }
2643     _uchange() { _files -W /usr/share/doc -/ }
2644     compdef _uchange uchange
2645 fi
2646
2647 # zsh profiling
2648 profile() {
2649     ZSH_PROFILE_RC=1 $SHELL "$@"
2650 }
2651
2652 #f1# Edit an alias via zle
2653 edalias() {
2654     [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2655 }
2656 compdef _aliases edalias
2657
2658 #f1# Edit a function via zle
2659 edfunc() {
2660     [[ -z "$1" ]] && { echo "Usage: edfun <function_to_edit>" ; return 1 } || zed -f "$1" ;
2661 }
2662 compdef _functions edfunc
2663
2664 # use it e.g. via 'Restart apache2'
2665 #m# f6 Start() \kbd{/etc/init.d/\em{process}}\quad\kbd{start}
2666 #m# f6 Restart() \kbd{/etc/init.d/\em{process}}\quad\kbd{restart}
2667 #m# f6 Stop() \kbd{/etc/init.d/\em{process}}\quad\kbd{stop}
2668 #m# f6 Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{reload}
2669 #m# f6 Force-Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{force-reload}
2670 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2671     __start_stop() {
2672         local action_="${1:l}"  # e.g Start/Stop/Restart
2673         local service_="$2"
2674         local param_="$3"
2675
2676         local service_target_="$(readlink /etc/init.d/$service_)"
2677         if [[ $service_target_ == "/usr/bin/sv" ]]; then
2678             # runit
2679             case "${action_}" in
2680                 start) if [[ ! -e /etc/service/$service_ ]]; then
2681                            $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2682                        else
2683                            $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2684                        fi ;;
2685                 # there is no reload in runits sysv emulation
2686                 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2687                 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2688             esac
2689         else
2690             # sysvinit
2691             $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2692         fi
2693     }
2694
2695     for i in Start Restart Stop Force-Reload Reload ; do
2696         eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
2697     done
2698 fi
2699
2700 #f1# Provides useful information on globbing
2701 H-Glob() {
2702     echo -e "
2703     /      directories
2704     .      plain files
2705     @      symbolic links
2706     =      sockets
2707     p      named pipes (FIFOs)
2708     *      executable plain files (0100)
2709     %      device files (character or block special)
2710     %b     block special files
2711     %c     character special files
2712     r      owner-readable files (0400)
2713     w      owner-writable files (0200)
2714     x      owner-executable files (0100)
2715     A      group-readable files (0040)
2716     I      group-writable files (0020)
2717     E      group-executable files (0010)
2718     R      world-readable files (0004)
2719     W      world-writable files (0002)
2720     X      world-executable files (0001)
2721     s      setuid files (04000)
2722     S      setgid files (02000)
2723     t      files with the sticky bit (01000)
2724
2725   print *(m-1)          # Files modified up to a day ago
2726   print *(a1)           # Files accessed a day ago
2727   print *(@)            # Just symlinks
2728   print *(Lk+50)        # Files bigger than 50 kilobytes
2729   print *(Lk-50)        # Files smaller than 50 kilobytes
2730   print **/*.c          # All *.c files recursively starting in \$PWD
2731   print **/*.c~file.c   # Same as above, but excluding 'file.c'
2732   print (foo|bar).*     # Files starting with 'foo' or 'bar'
2733   print *~*.*           # All Files that do not contain a dot
2734   chmod 644 *(.^x)      # make all plain non-executable files publically readable
2735   print -l *(.c|.h)     # Lists *.c and *.h
2736   print **/*(g:users:)  # Recursively match all files that are owned by group 'users'
2737   echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
2738 }
2739 alias help-zshglob=H-Glob
2740
2741 check_com -c qma && alias ?='qma zshall'
2742
2743 # grep for running process, like: 'any vim'
2744 any() {
2745     if [[ -z "$1" ]] ; then
2746         echo "any - grep for process(es) by keyword" >&2
2747         echo "Usage: any <keyword>" >&2 ; return 1
2748     else
2749         local STRING=$1
2750         local LENGTH=$(expr length $STRING)
2751         local FIRSCHAR=$(echo $(expr substr $STRING 1 1))
2752         local REST=$(echo $(expr substr $STRING 2 $LENGTH))
2753         ps xauwww| grep "[$FIRSCHAR]$REST"
2754     fi
2755 }
2756
2757 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
2758 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
2759 [[ -r /proc/1/maps ]] && \
2760 deswap() {
2761     print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
2762     cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/')  > /dev/null
2763     print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
2764 }
2765
2766 # print hex value of a number
2767 hex() {
2768     [[ -n "$1" ]] && printf "%x\n" $1 || { print 'Usage: hex <number-to-convert>' ; return 1 }
2769 }
2770
2771 # calculate (or eval at all ;-)) with perl => p[erl-]eval
2772 # hint: also take a look at zcalc -> 'autoload zcalc' -> 'man zshmodules | less -p MATHFUNC'
2773 peval() {
2774     [[ -n "$1" ]] && CALC="$*" || print "Usage: calc [expression]"
2775     perl -e "print eval($CALC),\"\n\";"
2776 }
2777 functions peval &>/dev/null && alias calc=peval
2778
2779 # brltty seems to have problems with utf8 environment and/or font Uni3-Terminus16 under
2780 # certain circumstances, so work around it, no matter which environment we have
2781 brltty() {
2782     if [[ -z "$DISPLAY" ]] ; then
2783         consolechars -f /usr/share/consolefonts/default8x16.psf.gz
2784         command brltty "$@"
2785     else
2786         command brltty "$@"
2787     fi
2788 }
2789
2790 # just press 'asdf' keys to toggle between dvorak and us keyboard layout
2791 aoeu() {
2792     echo -n 'Switching to us keyboard layout: '
2793     [[ -z "$DISPLAY" ]] && $SUDO loadkeys us &>/dev/null || setxkbmap us &>/dev/null
2794     echo 'Done'
2795 }
2796 asdf() {
2797     echo -n 'Switching to dvorak keyboard layout: '
2798     [[ -z "$DISPLAY" ]] && $SUDO loadkeys dvorak &>/dev/null || setxkbmap dvorak &>/dev/null
2799     echo 'Done'
2800 }
2801 # just press 'asdf' key to toggle from neon layout to us keyboard layout
2802 uiae() {
2803     echo -n 'Switching to us keyboard layout: '
2804     setxkbmap us && echo 'Done' || echo 'Failed'
2805 }
2806
2807 # set up an ipv6 tunnel
2808 ipv6-tunnel() {
2809     case $1 in
2810         start)
2811             if ifconfig sit1 2>/dev/null | grep -q 'inet6 addr: 2002:.*:1::1' ; then
2812                 print 'ipv6 tunnel already set up, nothing to be done.'
2813                 print 'execute: "ifconfig sit1 down ; ifconfig sit0 down" to remove ipv6-tunnel.' ; return 1
2814             else
2815                 [[ -n "$PUBLIC_IP" ]] || \
2816                     local PUBLIC_IP=$(ifconfig $(route -n | awk '/^0\.0\.0\.0/{print $8; exit}') | \
2817                                       awk '/inet addr:/ {print $2}' | tr -d 'addr:')
2818
2819                 [[ -n "$PUBLIC_IP" ]] || { print 'No $PUBLIC_IP set and could not determine default one.' ; return 1 }
2820                 local IPV6ADDR=$(printf "2002:%02x%02x:%02x%02x:1::1" $(print ${PUBLIC_IP//./ }))
2821                 print -n "Setting up ipv6 tunnel $IPV6ADDR via ${PUBLIC_IP}: "
2822                 ifconfig sit0 tunnel ::192.88.99.1 up
2823                 ifconfig sit1 add "$IPV6ADDR" && print done || print failed
2824             fi
2825             ;;
2826         status)
2827             if ifconfig sit1 2>/dev/null | grep -q 'inet6 addr: 2002:.*:1::1' ; then
2828                 print 'ipv6 tunnel available' ; return 0
2829             else
2830                 print 'ipv6 tunnel not available' ; return 1
2831             fi
2832             ;;
2833         stop)
2834             if ifconfig sit1 2>/dev/null | grep -q 'inet6 addr: 2002:.*:1::1' ; then
2835                 print -n 'Stopping ipv6 tunnel (sit0 + sit1): '
2836                 ifconfig sit1 down ; ifconfig sit0 down && print done || print failed
2837             else
2838                 print 'No ipv6 tunnel found, nothing to be done.' ; return 1
2839             fi
2840             ;;
2841         *)
2842             print "Usage: ipv6-tunnel [start|stop|status]">&2 ; return 1
2843             ;;
2844     esac
2845 }
2846
2847 # run dhclient for wireless device
2848 iwclient() {
2849     salias dhclient "$(wavemon -d | awk '/device/{print $2}')"
2850 }
2851
2852 # spawn a minimally set up ksh - useful if you want to umount /usr/.
2853 minimal-shell() {
2854     exec env -i ENV="/etc/minimal-shellrc" HOME="$HOME" TERM="$TERM" ksh
2855 }
2856
2857 # a wrapper for vim, that deals with title setting
2858 #   VIM_OPTIONS
2859 #       set this array to a set of options to vim you always want
2860 #       to have set when calling vim (in .zshrc.local), like:
2861 #           VIM_OPTIONS=( -p )
2862 #       This will cause vim to send every file given on the
2863 #       commandline to be send to it's own tab (needs vim7).
2864 vim() {
2865     VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
2866 }
2867
2868 # make a backup of a file
2869 bk() {
2870     cp -a "$1" "${1}_$(date --iso-8601=seconds)"
2871 }
2872
2873 #f1# grep for patterns in grml's zsh setup
2874 zg() {
2875 #{{{
2876     LANG=C perl -e '
2877
2878 sub usage {
2879     print "usage: zg -[anr] <pattern>\n";
2880     print " Search for patterns in grml'\''s zshrc.\n";
2881     print " zg takes no or exactly one option plus a non empty pattern.\n\n";
2882     print "   options:\n";
2883     print "     --  no options (use if your pattern starts in with a dash.\n";
2884     print "     -a  search for the pattern in all code regions\n";
2885     print "     -n  search for the pattern in non-root code only\n";
2886     print "     -r  search in code for everyone (also root) only\n\n";
2887     print "   The default is -a for non-root users and -r for root.\n\n";
2888     print " If you installed the zshrc to a non-default locations (ie *NOT*\n";
2889     print " in /etc/zsh/zshrc) do: export GRML_ZSHRC=\$HOME/.zshrc\n";
2890     print " ...in case you copied the file to that location.\n\n";
2891     exit 1;
2892 }
2893
2894 if ($ENV{GRML_ZSHRC} ne "") {
2895     $RC = $ENV{GRML_ZSHRC};
2896 } else {
2897     $RC = "/etc/zsh/zshrc";
2898 }
2899
2900 usage if ($#ARGV < 0 || $#ARGV > 1);
2901 if ($> == 0) { $mode = "allonly"; }
2902 else { $mode = "all"; }
2903
2904 $opt = $ARGV[0];
2905 if ($opt eq "--")     { shift; }
2906 elsif ($opt eq "-a")  { $mode = "all"; shift; }
2907 elsif ($opt eq "-n")  { $mode = "nonroot"; shift; }
2908 elsif ($opt eq "-r" ) { $mode = "allonly"; shift; }
2909 elsif ($opt =~ m/^-/ || $#ARGV > 0) { usage(); }
2910
2911 $pattern = $ARGV[0];
2912 usage() if ($pattern eq "");
2913
2914 open FH, "<$RC" or die "zg: Could not open $RC: $!\n";
2915 while ($line = <FH>) {
2916     chomp $line;
2917     if ($line =~ m/^#:grep:marker:for:mika:/) { $markerfound = 1; next; }
2918     next if ($mode eq "nonroot" && markerfound == 0);
2919     break if ($mode eq "allonly" && markerfound == 1);
2920     print $line, "\n" if ($line =~ /$pattern/);
2921 }
2922 close FH;
2923 exit 0;
2924
2925     ' -- "$@"
2926 #}}}
2927     return $?
2928 }
2929
2930 # }}}
2931
2932 # {{{ make sure our environment is clean regarding colors
2933 for color in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $color
2934 # }}}
2935
2936 # source another config file if present {{{
2937 xsource "/etc/zsh/zshrc.local"
2938 # }}}
2939
2940 # "persistent history" {{{
2941 # just write important commands you always need to ~/.important_commands
2942 if [[ -r ~/.important_commands ]] ; then
2943     fc -R ~/.important_commands
2944 fi
2945 # }}}
2946
2947 #:grep:marker:for:mika: :-)
2948 ### non-root (EUID != 0) code below
2949 ###
2950
2951 if (( GRML_ALWAYS_LOAD_ALL == 0 )) && (( $EUID == 0 )) ; then
2952     zrclocal
2953     return 0
2954 fi
2955
2956
2957 # variables {{{
2958
2959 # set terminal property (used e.g. by msgid-chooser)
2960 export COLORTERM="yes"
2961
2962 # set default browser
2963 if [[ -z "$BROWSER" ]] ; then
2964     if [[ -n "$DISPLAY" ]] ; then
2965         #v# If X11 is running
2966         check_com -c firefox && export BROWSER=firefox
2967     else
2968         #v# If no X11 is running
2969         check_com -c w3m && export BROWSER=w3m
2970     fi
2971 fi
2972
2973 #m# v QTDIR \kbd{/usr/share/qt[34]}\quad [for non-root only]
2974 [[ -d /usr/share/qt3 ]] && export QTDIR=/usr/share/qt3
2975 [[ -d /usr/share/qt4 ]] && export QTDIR=/usr/share/qt4
2976
2977 # support running 'jikes *.java && jamvm HelloWorld' OOTB:
2978 #v# [for non-root only]
2979 [[ -f /usr/share/classpath/glibj.zip ]] && export JIKESPATH=/usr/share/classpath/glibj.zip
2980 # }}}
2981
2982 # aliases {{{
2983
2984 # Xterm resizing-fu.
2985 # Based on http://svn.kitenet.net/trunk/home-full/.zshrc?rev=11710&view=log (by Joey Hess)
2986 alias hide='echo -en "\033]50;nil2\007"'
2987 alias tiny='echo -en "\033]50;-misc-fixed-medium-r-normal-*-*-80-*-*-c-*-iso8859-15\007"'
2988 alias small='echo -en "\033]50;6x10\007"'
2989 alias medium='echo -en "\033]50;-misc-fixed-medium-r-normal--13-120-75-75-c-80-iso8859-15\007"'
2990 alias default='echo -e "\033]50;-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-15\007"'
2991 alias large='echo -en "\033]50;-misc-fixed-medium-r-normal-*-*-150-*-*-c-*-iso8859-15\007"'
2992 alias huge='echo -en "\033]50;-misc-fixed-medium-r-normal-*-*-210-*-*-c-*-iso8859-15\007"'
2993 alias smartfont='echo -en "\033]50;-artwiz-smoothansi-*-*-*-*-*-*-*-*-*-*-*-*\007"'
2994 alias semifont='echo -en "\033]50;-misc-fixed-medium-r-semicondensed-*-*-120-*-*-*-*-iso8859-15\007"'
2995
2996 # general
2997 #a2# Execute \kbd{du -sch}
2998 alias da='du -sch'
2999 #a2# Execute \kbd{jobs -l}
3000 alias j='jobs -l'
3001
3002 # compile stuff
3003 #a2# Execute \kbd{./configure}
3004 alias CO="./configure"
3005 #a2# Execute \kbd{./configure --help}
3006 alias CH="./configure --help"
3007
3008 # http://conkeror.mozdev.org/
3009 # TODO: I think this should be removed, as conkeror is not a simple extension anymore
3010 #a2# Run a keyboard driven firefox
3011 alias conkeror='firefox -chrome chrome://conkeror/content'
3012
3013 # arch/tla stuff
3014 if check_com -c tla ; then
3015     #a2# Execute \kbd{tla what-changed --diffs | less}
3016     alias tdi='tla what-changed --diffs | less'
3017     #a2# Execute \kbd{tla-buildpackage}
3018     alias tbp='tla-buildpackage'
3019     #a2# Execute \kbd{tla archive-mirror}
3020     alias tmi='tla archive-mirror'
3021     #a2# Execute \kbd{tla commit}
3022     alias tco='tla commit'
3023     #a2# Execute \kbd{tla star-merge}
3024     alias tme='tla star-merge'
3025 fi
3026
3027 # listing stuff
3028 #a2# Execute \kbd{ls -lSrah}
3029 alias dir="ls -lSrah"
3030 #a2# Only show dot-directories
3031 alias lad='ls -d .*(/)'                # only show dot-directories
3032 #a2# Only show dot-files
3033 alias lsa='ls -a .*(.)'                # only show dot-files
3034 #a2# Only files with setgid/setuid/sticky flag
3035 alias lss='ls -l *(s,S,t)'             # only files with setgid/setuid/sticky flag
3036 #a2# Only show 1st ten symlinks
3037 alias lsl='ls -l *(@[1,10])'           # only symlinks
3038 #a2# Display only executables
3039 alias lsx='ls -l *(*[1,10])'           # only executables
3040 #a2# Display world-{readable,writable,executable} files
3041 alias lsw='ls -ld *(R,W,X.^ND/)'       # world-{readable,writable,executable} files
3042 #a2# Display the ten biggest files
3043 alias lsbig="ls -flh *(.OL[1,10])"     # display the biggest files
3044 #a2# Only show directories
3045 alias lsd='ls -d *(/)'                 # only show directories
3046 #a2# Only show empty directories
3047 alias lse='ls -d *(/^F)'               # only show empty directories
3048 #a2# Display the ten newest files
3049 alias lsnew="ls -rl *(D.om[1,10])"     # display the newest files
3050 #a2# Display the ten oldest files
3051 alias lsold="ls -rtlh *(D.om[1,10])"   # display the oldest files
3052 #a2# Display the ten smallest files
3053 alias lssmall="ls -Srl *(.oL[1,10])"   # display the smallest files
3054
3055 # chmod
3056 #a2# Execute \kbd{chmod 600}
3057 alias rw-='chmod 600'
3058 #a2# Execute \kbd{chmod 700}
3059 alias rwx='chmod 700'
3060 #m# a2 r-{}- Execute \kbd{chmod 644}
3061 alias r--='chmod 644'
3062 #a2# Execute \kbd{chmod 755}
3063 alias r-x='chmod 755'
3064
3065 # some useful aliases
3066 #a2# Execute \kbd{mkdir -o}
3067 alias md='mkdir -p'
3068
3069 check_com -c ipython && alias ips='ipython -p sh'
3070
3071 # console stuff
3072 #a2# Execute \kbd{mplayer -vo fbdev}
3073 alias cmplayer='mplayer -vo fbdev'
3074 #a2# Execute \kbd{mplayer -vo fbdev -fs -zoom}
3075 alias fbmplayer='mplayer -vo fbdev -fs -zoom'
3076 #a2# Execute \kbd{links2 -driver fb}
3077 alias fblinks='links2 -driver fb'
3078
3079 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3080 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3081 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3082
3083 # simple webserver
3084 check_com -c python && alias http="python -m SimpleHTTPServer"
3085
3086 # Use 'g' instead of 'git':
3087 check_com g || alias g='git'
3088
3089 # use colors when browsing man pages, but only if not using LESS_TERMCAP_* from /etc/zsh/zshenv:
3090 if [[ -z "$LESS_TERMCAP_md" ]] ; then
3091     [[ -d ~/.terminfo/ ]] && alias man='TERMINFO=~/.terminfo/ LESS=C TERM=mostlike PAGER=less man'
3092 fi
3093
3094 # check whether Debian's package management (dpkg) is running
3095 if check_com salias ; then
3096     #a2# Check whether a dpkg instance is currently running
3097     salias check_dpkg_running="dpkg_running"
3098 fi
3099
3100 # work around non utf8 capable software in utf environment via $LANG and luit
3101 if check_com isutfenv && check_com luit ; then
3102     if check_com -c mrxvt ; then
3103         isutfenv && [[ -n "$LANG" ]] && \
3104             alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3105     fi
3106
3107     if check_com -c aterm ; then
3108         isutfenv && [[ -n "$LANG" ]] && \
3109             alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3110     fi
3111
3112     if check_com -c centericq ; then
3113         isutfenv && [[ -n "$LANG" ]] && \
3114             alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3115     fi
3116 fi
3117 # }}}
3118
3119 # useful functions {{{
3120
3121 # searching
3122 #f4# Search for newspostings from authors
3123 agoogle() { ${=BROWSER} "http://groups.google.com/groups?as_uauthors=$*" ; }
3124 #f4# Search Debian Bug Tracking System
3125 debbug()  {
3126     setopt localoptions extendedglob
3127     if [[ $# -eq 1 ]]; then
3128         case "$1" in
3129             ([0-9]##)
3130             ${=BROWSER} "http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=$1"
3131             ;;
3132             (*@*)
3133             ${=BROWSER} "http://bugs.debian.org/cgi-bin/pkgreport.cgi?submitter=$1"
3134             ;;
3135             (*)
3136             ${=BROWSER} "http://bugs.debian.org/$*"
3137             ;;
3138         esac
3139     else
3140         print "$0 needs one argument"
3141         return 1
3142     fi
3143 }
3144 #f4# Search Debian Bug Tracking System in mbox format
3145 debbugm() { bts show --mbox $1 } # provide bugnummer as "$1"
3146 #f4# Search DMOZ
3147 dmoz()    { ${=BROWSER} http://search.dmoz.org/cgi-bin/search\?search=${1// /_} }
3148 #f4# Search German   Wiktionary
3149 dwicti()  { ${=BROWSER} http://de.wiktionary.org/wiki/${(C)1// /_} }
3150 #f4# Search English  Wiktionary
3151 ewicti()  { ${=BROWSER} http://en.wiktionary.org/wiki/${(C)1// /_} }
3152 #f4# Search Google Groups
3153 ggogle()  { ${=BROWSER} "http://groups.google.com/groups?q=$*" }
3154 #f4# Search Google
3155 google()  { ${=BROWSER} "http://www.google.com/search?&num=100&q=$*" }
3156 #f4# Search Google Groups for MsgID
3157 mggogle() { ${=BROWSER} "http://groups.google.com/groups?selm=$*" }
3158 #f4# Search Netcraft
3159 netcraft(){ ${=BROWSER} "http://toolbar.netcraft.com/site_report?url=$1" }
3160 #f4# Use German Wikipedia's full text search
3161 swiki()   { ${=BROWSER} http://de.wikipedia.org/wiki/Spezial:Search/${(C)1} }
3162 #f4# search \kbd{dict.leo.org}
3163 oleo()    { ${=BROWSER} "http://dict.leo.org/?search=$*" }
3164 #f4# Search German   Wikipedia
3165 wikide()  { ${=BROWSER} http://de.wikipedia.org/wiki/"${(C)*}" }
3166 #f4# Search English  Wikipedia
3167 wikien()  { ${=BROWSER} http://en.wikipedia.org/wiki/"${(C)*}" }
3168 #f4# Search official debs
3169 wodeb()   { ${=BROWSER} "http://packages.debian.org/search?keywords=$1&searchon=contents&suite=${2:=unstable}&section=all" }
3170
3171 #m# f4 gex() Exact search via Google
3172 check_com google && gex () { google "\"[ $1]\" $*" } # exact search at google
3173
3174 # misc
3175 #f5# Backup \kbd{file {\rm to} file\_timestamp}
3176 bk()      { cp -b ${1} ${1}_`date --iso-8601=m` }
3177 #f5# Copied diff
3178 cdiff()   { diff -crd "$*" | egrep -v "^Only in |^Binary files " }
3179 #f5# cd to directoy and list files
3180 cl()      { cd $1 && ls -a }        # cd && ls
3181 #f5# Cvs add
3182 cvsa()    { cvs add $* && cvs com -m 'initial checkin' $* }
3183 #f5# Cvs diff
3184 cvsd()    { cvs diff -N $* |& $PAGER }
3185 #f5# Cvs log
3186 cvsl()    { cvs log $* |& $PAGER }
3187 #f5# Cvs update
3188 cvsq()    { cvs -nq update }
3189 #f5# Rcs2log
3190 cvsr()    { rcs2log $* | $PAGER }
3191 #f5# Cvs status
3192 cvss()    { cvs status -v $* }
3193 #f5# Disassemble source files using gcc and as
3194 disassemble(){ gcc -pipe -S -o - -O -g $* | as -aldh -o /dev/null }
3195 #f5# Firefox remote control - open given URL
3196 fir()     { firefox -a firefox -remote "openURL($1)" }
3197 #f5# Create Directoy and \kbd{cd} to it
3198 mcd()     { mkdir -p "$@"; cd "$@" } # mkdir && cd
3199 #f5# Unified diff to timestamped outputfile
3200 mdiff()   { diff -udrP "$1" "$2" > diff.`date "+%Y-%m-%d"`."$1" }
3201 #f5# Memory overview
3202 memusage(){ ps aux | awk '{if (NR > 1) print $5; if (NR > 2) print "+"} END { print "p" }' | dc }
3203 #f5# Show contents of tar file
3204 shtar()   { gunzip -c $1 | tar -tf - -- | $PAGER }
3205 #f5# Show contents of tgz file
3206 shtgz()   { tar -ztf $1 | $PAGER }
3207 #f5# Show contents of zip file
3208 shzip()   { unzip -l $1 | $PAGER }
3209 #f5# Greps signature from file
3210 sig()     { agrep -d '^-- $' "$*" ~/.Signature }
3211 #f5# Unified diff
3212 udiff()   { diff -urd $* | egrep -v "^Only in |^Binary files " }
3213 #f5# (Mis)use \kbd{vim} as \kbd{less}
3214 viless()  { vim --cmd 'let no_plugin_maps = 1' -c "so \$VIMRUNTIME/macros/less.vim" "${@:--}" }
3215
3216 # download video from youtube
3217 ytdl() {
3218     if ! [[ -n "$2" ]] ; then
3219         print "Usage: ydtl http://youtube.com/watch?v=.... outputfile.flv">&2
3220         return 1
3221     else
3222         wget -O${2} "http://youtube.com/get_video?"${${${"$(wget -o/dev/null -O- "${1}" | grep -e watch_fullscreen)"}##*watch_fullscreen\?}%%\&fs=*}
3223     fi
3224 }
3225
3226 # Function Usage: uopen $URL/$file
3227 #f5# Download a file and display it locally
3228 uopen() {
3229     if ! [[ -n "$1" ]] ; then
3230         print "Usage: uopen \$URL/\$file">&2
3231         return 1
3232     else
3233         FILE=$1
3234         MIME=$(curl --head $FILE | grep Content-Type | cut -d ' ' -f 2 | cut -d\; -f 1)
3235         MIME=${MIME%$'\r'}
3236         curl $FILE | see ${MIME}:-
3237     fi
3238 }
3239
3240 # Function Usage: doc packagename
3241 #f5# \kbd{cd} to /usr/share/doc/\textit{package}
3242 doc() { cd /usr/share/doc/$1 && ls }
3243 _doc() { _files -W /usr/share/doc -/ }
3244 check_com compdef && compdef _doc doc
3245
3246 #f5# Make screenshot
3247 sshot() {
3248     [[ ! -d ~/shots  ]] && mkdir ~/shots
3249     #cd ~/shots ; sleep 5 ; import -window root -depth 8 -quality 80 `date "+%Y-%m-%d--%H:%M:%S"`.png
3250     cd ~/shots ; sleep 5; import -window root shot_`date --iso-8601=m`.jpg
3251 }
3252
3253 # list images only
3254 limg() {
3255     local -a images
3256     images=( *.{jpg,gif,png}(.N) )
3257
3258     if [[ $#images -eq 0 ]] ; then
3259         print "No image files found"
3260     else
3261         ls "$@" "$images[@]"
3262     fi
3263 }
3264
3265 #f5# Create PDF file from source code
3266 makereadable() {
3267     output=$1
3268     shift
3269     a2ps --medium A4dj -E -o $output $*
3270     ps2pdf $output
3271 }
3272
3273 # zsh with perl-regex - use it e.g. via:
3274 # regcheck '\s\d\.\d{3}\.\d{3} Euro' ' 1.000.000 Euro'
3275 #f5# Checks whether a regex matches or not.\\&\quad Example: \kbd{regcheck '.\{3\} EUR' '500 EUR'}
3276 regcheck() {
3277     zmodload -i zsh/pcre
3278     pcre_compile $1 && \
3279     pcre_match $2 && echo "regex matches" || echo "regex does not match"
3280 }
3281
3282 #f5# List files which have been modified within the last {\it n} days
3283 new() { print -l *(m-$1) }
3284
3285 #f5# Grep in history
3286 greph() { history 0 | grep $1 }
3287 # use colors when GNU grep with color-support
3288 #a2# Execute \kbd{grep -{}-color=auto}
3289 (grep --help 2>/dev/null |grep -- --color) >/dev/null && alias grep='grep --color=auto'
3290 #a2# Execute \kbd{grep -i -{}-color=auto}
3291 alias GREP='grep -i --color=auto'
3292
3293 # one blank line between each line
3294 if [[ -r ~/.terminfo/m/mostlike ]] ; then
3295     #f5# Watch manpages in a stretched style
3296     man2() { PAGER='dash -c "sed G | /usr/bin/less"' TERM=mostlike /usr/bin/man "$@" ; }
3297 fi
3298
3299 # d():Copyright 2005 Nikolai Weibull <nikolai@bitwi.se>
3300 # note: option AUTO_PUSHD has to be set
3301 #f5# Jump between directories
3302 d() {
3303     emulate -L zsh
3304     autoload -U colors
3305     local color=$fg_bold[blue]
3306     integer i=0
3307     dirs -p | while read dir; do
3308         local num="${$(printf "%-4d " $i)/ /.}"
3309         printf " %s  $color%s$reset_color\n" $num $dir
3310         (( i++ ))
3311     done
3312     integer dir=-1
3313     read -r 'dir?Jump to directory: ' || return
3314     (( dir == -1 )) && return
3315     if (( dir < 0 || dir >= i )); then
3316         echo d: no such directory stack entry: $dir
3317         return 1
3318     fi
3319     cd ~$dir
3320 }
3321
3322 # usage example: 'lcheck strcpy'
3323 #f5# Find out which libs define a symbol
3324 lcheck() {
3325     if [[ -n "$1" ]] ; then
3326         nm -go /usr/lib/lib*.a 2>/dev/null | grep ":[[:xdigit:]]\{8\} . .*$1"
3327     else
3328         echo "Usage: lcheck <function>" >&2
3329     fi
3330 }
3331
3332 #f5# Clean up directory - remove well known tempfiles
3333 purge() {
3334     FILES=(*~(N) .*~(N) \#*\#(N) *.o(N) a.out(N) *.core(N) *.cmo(N) *.cmi(N) .*.swp(N))
3335     NBFILES=${#FILES}
3336     if [[ $NBFILES > 0 ]] ; then
3337         print $FILES
3338         local ans
3339         echo -n "Remove these files? [y/n] "
3340         read -q ans
3341         if [[ $ans == "y" ]] ; then
3342             rm ${FILES}
3343             echo ">> $PWD purged, $NBFILES files removed"
3344         else
3345             echo "Ok. .. than not.."
3346         fi
3347     fi
3348 }
3349
3350 # Translate DE<=>EN
3351 # 'translate' looks up fot a word in a file with language-to-language
3352 # translations (field separator should be " : "). A typical wordlist looks
3353 # like at follows:
3354 #  | english-word : german-transmission
3355 # It's also only possible to translate english to german but not reciprocal.
3356 # Use the following oneliner to turn back the sort order:
3357 #  $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3358 #    /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3359 #f5# Translates a word
3360 trans() {
3361     case "$1" in
3362         -[dD]*)
3363             translate -l de-en $2
3364             ;;
3365         -[eE]*)
3366             translate -l en-de $2
3367             ;;
3368         *)
3369             echo "Usage: $0 { -D | -E }"
3370             echo "         -D == German to English"
3371             echo "         -E == English to German"
3372     esac
3373 }
3374
3375 #f5# List all occurrences of programm in current PATH
3376 plap() {
3377     if [[ $# = 0 ]] ; then
3378         echo "Usage:    $0 program"
3379         echo "Example:  $0 zsh"
3380         echo "Lists all occurrences of program in the current PATH."
3381     else
3382         ls -l ${^path}/*$1*(*N)
3383     fi
3384 }
3385
3386 # Found in the mailinglistarchive from Zsh (IIRC ~1996)
3387 #f5# Select items for specific command(s) from history
3388 selhist() {
3389     emulate -L zsh
3390     local TAB=$'\t';
3391     (( $# < 1 )) && {
3392         echo "Usage: $0 command"
3393         return 1
3394     };
3395     cmd=(${(f)"$(grep -w $1 $HISTFILE | sort | uniq | pr -tn)"})
3396     print -l $cmd | less -F
3397     echo -n "enter number of desired command [1 - $(( ${#cmd[@]} - 1 ))]: "
3398     local answer
3399     read answer
3400     print -z "${cmd[$answer]#*$TAB}"
3401 }
3402
3403 # Use vim to convert plaintext to HTML
3404 #f5# Transform files to html with highlighting
3405 2html() { vim -u NONE -n -c ':syntax on' -c ':so $VIMRUNTIME/syntax/2html.vim' -c ':wqa' $1 &>/dev/null }
3406
3407 # Usage: simple-extract <file>
3408 #f5# Smart archive extractor
3409 simple-extract () {
3410     if [[ -f $1 ]] ; then
3411         case $1 in
3412             *.tar.bz2)  bzip2 -v -d $1      ;;
3413             *.tar.gz)   tar -xvzf $1        ;;
3414             *.rar)      unrar $1            ;;
3415             *.deb)      ar -x $1            ;;
3416             *.bz2)      bzip2 -d $1         ;;
3417             *.lzh)      lha x $1            ;;
3418             *.gz)       gunzip -d $1        ;;
3419             *.tar)      tar -xvf $1         ;;
3420             *.tgz)      gunzip -d $1        ;;
3421             *.tbz2)     tar -jxvf $1        ;;
3422             *.zip)      unzip $1            ;;
3423             *.Z)        uncompress $1       ;;
3424             *)          echo "'$1' Error. Please go away" ;;
3425         esac
3426     else
3427         echo "'$1' is not a valid file"
3428     fi
3429 }
3430
3431 # Usage: smartcompress <file> (<type>)
3432 #f5# Smart archive creator
3433 smartcompress() {
3434     if [[ -n $2 ]] ; then
3435         case $2 in
3436             tgz | tar.gz)   tar -zcvf$1.$2 $1 ;;
3437             tbz2 | tar.bz2) tar -jcvf$1.$2 $1 ;;
3438             tar.Z)          tar -Zcvf$1.$2 $1 ;;
3439             tar)            tar -cvf$1.$2  $1 ;;
3440             gz | gzip)      gzip           $1 ;;
3441             bz2 | bzip2)    bzip2          $1 ;;
3442             *)
3443                 echo "Error: $2 is not a valid compression type"
3444                 ;;
3445         esac
3446     else
3447         smartcompress $1 tar.gz
3448     fi
3449 }
3450
3451 # Usage: show-archive <archive>
3452 #f5# List an archive's content
3453 show-archive() {
3454     if [[ -f $1 ]] ; then
3455         case $1 in
3456             *.tar.gz)      gunzip -c $1 | tar -tf - -- ;;
3457             *.tar)         tar -tf $1 ;;
3458             *.tgz)         tar -ztf $1 ;;
3459             *.zip)         unzip -l $1 ;;
3460             *.bz2)         bzless $1 ;;
3461             *.deb)         dpkg-deb --fsys-tarfile $1 | tar -tf - -- ;;
3462             *)             echo "'$1' Error. Please go away" ;;
3463         esac
3464     else
3465         echo "'$1' is not a valid archive"
3466     fi
3467 }
3468
3469 # It's shameless stolen from <http://www.vim.org/tips/tip.php?tip_id=167>
3470 #f5# Use \kbd{vim} as your manpage reader
3471 vman() { man $* | col -b | view -c 'set ft=man nomod nolist' - }
3472
3473 # function readme() { $PAGER -- (#ia3)readme* }
3474 #f5# View all README-like files in current directory in pager
3475 readme() {
3476     local files
3477     files=(./(#i)*(read*me|lue*m(in|)ut)*(ND))
3478     if (($#files)) ; then
3479         $PAGER $files
3480     else
3481         print 'No README files.'
3482     fi
3483 }
3484
3485 # function ansi-colors()
3486 #f5# Display ANSI colors
3487 ansi-colors() {
3488     typeset esc="\033[" line1 line2
3489     echo " _ _ _40 _ _ _41_ _ _ _42 _ _ 43_ _ _ 44_ _ _45 _ _ _ 46_ _ _ 47_ _ _ 49_ _"
3490     for fore in 30 31 32 33 34 35 36 37; do
3491         line1="$fore "
3492         line2="   "
3493         for back in 40 41 42 43 44 45 46 47 49; do
3494             line1="${line1}${esc}${back};${fore}m Normal ${esc}0m"
3495             line2="${line2}${esc}${back};${fore};1m Bold   ${esc}0m"
3496         done
3497         echo -e "$line1\n$line2"
3498     done
3499 }
3500
3501 # suidfind() { ls -latg $path | grep '^...s' }
3502 #f5# Find all files in \$PATH with setuid bit set
3503 suidfind() { ls -latg $path/*(sN) }
3504
3505 # See above but this is /better/ ... anywise ..
3506 findsuid() {
3507     print 'Output will be written to ~/suid_* ...'
3508     $SUDO find / -type f \( -perm -4000 -o -perm -2000 \) -ls > ~/suid_suidfiles.`date "+%Y-%m-%d"`.out 2>&1
3509     $SUDO find / -type d \( -perm -4000 -o -perm -2000 \) -ls > ~/suid_suiddirs.`date "+%Y-%m-%d"`.out 2>&1
3510     $SUDO find / -type f \( -perm -2 -o -perm -20 \) -ls > ~/suid_writefiles.`date "+%Y-%m-%d"`.out 2>&1
3511     $SUDO find / -type d \( -perm -2 -o -perm -20 \) -ls > ~/suid_writedirs.`date "+%Y-%m-%d"`.out 2>&1
3512     print 'Finished'
3513 }
3514
3515 #f5# Reload given functions
3516 refunc() {
3517     for func in $argv ; do
3518         unfunction $func
3519         autoload $func
3520     done
3521 }
3522
3523 # a small check to see which DIR is located on which server/partition.
3524 # stolen and modified from Sven's zshrc.forall
3525 #f5# Report diskusage of a directory
3526 dirspace() {
3527     if [[ -n "$1" ]] ; then
3528         for dir in $* ; do
3529             if [[ -d "$dir" ]] ; then
3530                 ( cd $dir; echo "-<$dir>"; du -shx .; echo);
3531             else
3532                 echo "warning: $dir does not exist" >&2
3533             fi
3534         done
3535     else
3536         for dir in $path; do
3537             if [[ -d "$dir" ]] ; then
3538                 ( cd $dir; echo "-<$dir>"; du -shx .; echo);
3539             else
3540                 echo "warning: $dir does not exist" >&2
3541             fi
3542         done
3543     fi
3544 }
3545
3546 # % slow_print `cat /etc/passwd`
3547 #f5# Slowly print out parameters
3548 slow_print() {
3549     for argument in "${@}" ; do
3550         for ((i = 1; i <= ${#1} ;i++)) ; do
3551             print -n "${argument[i]}"
3552             sleep 0.08
3553         done
3554         print -n " "
3555     done
3556     print ""
3557 }
3558
3559 #f5# Show some status info
3560 status() {
3561     print ""
3562     print "Date..: "$(date "+%Y-%m-%d %H:%M:%S")""
3563     print "Shell.: Zsh $ZSH_VERSION (PID = $$, $SHLVL nests)"
3564     print "Term..: $TTY ($TERM), ${BAUD:+$BAUD bauds, }$COLUMNS x $LINES cars"
3565     print "Login.: $LOGNAME (UID = $EUID) on $HOST"
3566     print "System: $(cat /etc/[A-Za-z]*[_-][rv]e[lr]*)"
3567     print "Uptime:$(uptime)"
3568     print ""
3569 }
3570
3571 # Rip an audio CD
3572 #f5# Rip an audio CD
3573 audiorip() {
3574     mkdir -p ~/ripps
3575     cd ~/ripps
3576     cdrdao read-cd --device $DEVICE --driver generic-mmc audiocd.toc
3577     cdrdao read-cddb --device $DEVICE --driver generic-mmc audiocd.toc
3578     echo " * Would you like to burn the cd now? (yes/no)"
3579     read input
3580     if [[ "$input" = "yes" ]] ; then
3581         echo " ! Burning Audio CD"
3582         audioburn
3583         echo " * done."
3584     else
3585         echo " ! Invalid response."
3586     fi
3587 }
3588
3589 # and burn it
3590 #f5# Burn an audio CD (in combination with audiorip)
3591 audioburn() {
3592     cd ~/ripps
3593     cdrdao write --device $DEVICE --driver generic-mmc audiocd.toc
3594     echo " * Should I remove the temporary files? (yes/no)"
3595     read input
3596     if [[ "$input" = "yes" ]] ; then
3597         echo " ! Removing Temporary Files."
3598         cd ~
3599         rm -rf ~/ripps
3600         echo " * done."
3601     else
3602         echo " ! Invalid response."
3603     fi
3604 }
3605
3606 #f5# Make an audio CD from all mp3 files
3607 mkaudiocd() {
3608     # TODO: do the renaming more zshish, possibly with zmv()
3609     cd ~/ripps
3610     for i in *.[Mm][Pp]3; do mv "$i" `echo $i | tr '[A-Z]' '[a-z]'`; done
3611     for i in *.mp3; do mv "$i" `echo $i | tr ' ' '_'`; done
3612     for i in *.mp3; do mpg123 -w `basename $i .mp3`.wav $i; done
3613     normalize -m *.wav
3614     for i in *.wav; do sox $i.wav -r 44100 $i.wav resample; done
3615 }
3616
3617 #f5# Create an ISO image. You are prompted for\\&\quad volume name, filename and directory
3618 mkiso() {
3619     echo " * Volume name "
3620     read volume
3621     echo " * ISO Name (ie. tmp.iso)"
3622     read iso
3623     echo " * Directory or File"
3624     read files
3625     mkisofs -o ~/$iso -A $volume -allow-multidot -J -R -iso-level 3 -V $volume -R $files
3626 }
3627
3628 #f5# Simple thumbnails generator
3629 genthumbs() {
3630     rm -rf thumb-* index.html
3631     echo "
3632 <html>
3633   <head>
3634     <title>Images</title>
3635   </head>
3636   <body>" > index.html
3637     for f in *.(gif|jpeg|jpg|png) ; do
3638         convert -size 100x200 "$f" -resize 100x200 thumb-"$f"
3639         echo "    <a href=\"$f\"><img src=\"thumb-$f\"></a>" >> index.html
3640     done
3641     echo "
3642   </body>
3643 </html>" >> index.html
3644 }
3645
3646 #f5# Set all ulimit parameters to \kbd{unlimited}
3647 allulimit() {
3648     ulimit -c unlimited
3649     ulimit -d unlimited
3650     ulimit -f unlimited
3651     ulimit -l unlimited
3652     ulimit -n unlimited
3653     ulimit -s unlimited
3654     ulimit -t unlimited
3655 }
3656
3657 # ogg2mp3 with bitrate of 192
3658 ogg2mp3_192() {
3659     oggdec -o - ${1} | lame -b 192 - ${1:r}.mp3
3660 }
3661
3662 #f5# RFC 2396 URL encoding in Z-Shell
3663 urlencode() {
3664     setopt localoptions extendedglob
3665     input=( ${(s::)1} )
3666     print ${(j::)input/(#b)([^A-Za-z0-9_.!~*\'\(\)-])/%${(l:2::0:)$(([##16]#match))}}
3667 }
3668
3669 #f5# Install x-lite (VoIP software)
3670 getxlite() {
3671     setopt local_options
3672     setopt errreturn
3673     [[ -d ~/tmp ]] || mkdir ~/tmp
3674     cd ~/tmp
3675
3676     echo "Downloading http://www.counterpath.com/download/X-Lite_Install.tar.gz and storing it in ~/tmp:"
3677     if wget http://www.counterpath.com/download/X-Lite_Install.tar.gz ; then
3678         unp X-Lite_Install.tar.gz && echo done || echo failed
3679     else
3680         echo "Error while downloading." ; return 1
3681     fi
3682
3683     if [[ -x xten-xlite/xtensoftphone ]] ; then
3684         echo "Execute xten-xlite/xtensoftphone to start xlite."
3685     fi
3686 }
3687
3688 #f5# Install skype
3689 getskype() {
3690     setopt local_options
3691     setopt errreturn
3692     echo "Downloading debian package of skype."
3693     echo "Notice: If you want to use a more recent skype version run 'getskypebeta'."
3694     wget http://www.skype.com/go/getskype-linux-deb
3695     $SUDO dpkg -i skype*.deb && echo "skype installed."
3696 }
3697
3698 #f5# Install beta-version of skype
3699 getskypebeta() {
3700     setopt local_options
3701     setopt errreturn
3702     echo "Downloading debian package of skype (beta version)."
3703     wget http://www.skype.com/go/getskype-linux-beta-deb
3704     $SUDO dpkg -i skype-beta*.deb && echo "skype installed."
3705 }
3706
3707 #f5# Install gizmo (VoIP software)
3708 getgizmo() {
3709     setopt local_options
3710     setopt errreturn
3711     echo "libgtk2.0-0, gconf2, libstdc++6, libasound2 and zlib1g have to be available. Installing."
3712     $SUDO apt-get update
3713     $SUDO apt-get install libgtk2.0-0 gconf2 libstdc++6 libasound2 zlib1g
3714     wget "$(lynx --dump http://gizmo5.com/pc/download/linux/ | awk '/libstdc\+\+6.*\.deb/ {print $2}')"
3715     $SUDO dpkg -i gizmo-project*.deb && echo "gizmo installed."
3716 }
3717
3718 #f5# Get and run AIR (Automated Image and Restore)
3719 getair() {
3720     setopt local_options
3721     setopt errreturn
3722     [[ -w . ]] || { echo 'Error: you do not have write permissions in this directory. Exiting.' ; return 1 }
3723     local VER='1.2.8'
3724     wget http://puzzle.dl.sourceforge.net/sourceforge/air-imager/air-$VER.tar.gz
3725     tar zxf air-$VER.tar.gz
3726     cd air-$VER
3727     INTERACTIVE=no $SUDO ./install-air-1.2.8
3728     [[ -x /usr/local/bin/air ]] && [[ -n "$DISPLAY" ]] && $SUDO air
3729 }
3730
3731 #f5# Get specific git commitdiff
3732 git-get-diff() {
3733     if [[ -z $GITTREE ]] ; then
3734         GITTREE='linux/kernel/git/torvalds/linux-2.6.git'
3735     fi
3736     if ! [[ -z $1 ]] ; then
3737         ${=BROWSER} "http://kernel.org/git/?p=$GITTREE;a=commitdiff;h=$1"
3738     else
3739         echo "Usage: git-get-diff <commit>"
3740     fi
3741 }
3742
3743 #f5# Get specific git commit
3744 git-get-commit() {
3745     if [[ -z $GITTREE ]] ; then
3746         GITTREE='linux/kernel/git/torvalds/linux-2.6.git'
3747     fi
3748     if ! [[ -z $1 ]] ; then
3749         ${=BROWSER} "http://kernel.org/git/?p=$GITTREE;a=commit;h=$1"
3750     else
3751         echo "Usage: git-get-commit <commit>"
3752     fi
3753 }
3754
3755 #f5# Get specific git diff
3756 git-get-plaindiff () {
3757     if [[ -z $GITTREE ]] ; then
3758        GITTREE='linux/kernel/git/torvalds/linux-2.6.git'
3759     fi
3760     if [[ -z $1 ]] ; then
3761        echo 'Usage: git-get-plaindiff '
3762     else
3763        echo -n "Downloading $1.diff ... "
3764        # avoid "generating ..." stuff from kernel.org server:
3765        wget --quiet "http://kernel.org/git/?p=$GITTREE;a=commitdiff_plain;h=$1" -O /dev/null
3766        wget --quiet "http://kernel.org/git/?p=$GITTREE;a=commitdiff_plain;h=$1" -O $1.diff \
3767             && echo done || echo failed
3768     fi
3769 }
3770
3771
3772 # http://strcat.de/blog/index.php?/archives/335-Software-sauber-deinstallieren...html
3773 #f5# Log 'make install' output
3774 mmake() {
3775     [[ ! -d ~/.errorlogs ]] && mkdir ~/.errorlogs
3776     make -n install > ~/.errorlogs/${PWD##*/}-makelog
3777 }
3778
3779 #f5# Indent source code
3780 smart-indent() {
3781     indent -npro -kr -i8 -ts8 -sob -l80 -ss -ncs $*
3782 }
3783
3784 # highlight important stuff in diff output, usage example: hg diff | hidiff
3785 #m# a2 hidiff \kbd{histring} oneliner for diffs
3786 check_com -c histring && \
3787     alias hidiff="histring -fE '^Comparing files .*|^diff .*' | histring -c yellow -fE '^\-.*' | histring -c green -fE '^\+.*'"
3788
3789 # rename pictures based on information found in exif headers
3790 #f5# Rename pictures based on information found in exif headers
3791 exirename() {
3792     if [[ $# -lt 1 ]] ; then
3793         echo 'Usage: jpgrename $FILES' >& 2
3794         return 1
3795     else
3796         echo -n 'Checking for jhead with version newer than 1.9: '
3797         jhead_version=`jhead -h | grep 'used by most Digital Cameras.  v.*' | awk '{print $6}' | tr -d v`
3798         if [[ $jhead_version > '1.9' ]]; then
3799             echo 'success - now running jhead.'
3800             jhead -n%Y-%m-%d_%Hh%M_%f $*
3801         else
3802             echo 'failed - exiting.'
3803         fi
3804     fi
3805 }
3806
3807 # open file in vim and jump to line
3808 # http://www.downgra.de/archives/2007/05/08/T19_21_11/
3809 j2v() {
3810     local -a params
3811     params=(${*//(#m):[0-9]*:/\\n+${MATCH//:/}}) # replace ':23:' to '\n+23'
3812     params=(${(s|\n|)${(j|\n|)params}}) # join array using '\n', then split on all '\n'
3813     vim ${params}
3814 }
3815
3816 # get_ic() - queries imap servers for capabilities; real simple. no imaps
3817 ic_get() {
3818     local port
3819     if [[ ! -z $1 ]] ; then
3820         port=${2:-143}
3821         print "querying imap server on $1:${port}...\n";
3822         print "a1 capability\na2 logout\n" | nc $1 ${port}
3823     else
3824         print "usage:\n  $0 <imap-server> [port]"
3825     fi
3826 }
3827
3828 # creates a Maildir/ with its {new,cur,tmp} subdirs
3829 mkmaildir() {
3830     local root subdir
3831     root=${MAILDIR_ROOT:-${HOME}/Mail}
3832     if [[ -z ${1} ]] ; then print "Usage:\n $0 <dirname>" ; return 1 ; fi
3833     subdir=${1}
3834     mkdir -p ${root}/${subdir}/{cur,new,tmp}
3835 }
3836
3837 #f5# Change the xterm title from within GNU-screen
3838 xtrename() {
3839     if [[ ${1} != "-f" ]] ; then
3840         if [[ -z ${DISPLAY} ]] ; then
3841             printf 'xtrename only makes sense in X11.\n'
3842             return 1
3843         fi
3844     else
3845         shift
3846     fi
3847     if [[ -z ${1} ]] ; then
3848         printf 'usage: xtrename [-f] "title for xterm"\n'
3849         printf '  renames the title of xterm from _within_ screen.\n'
3850         printf '  also works without screen.\n'
3851         printf '  will not work if DISPLAY is unset, use -f to override.\n'
3852         return 0
3853     fi
3854     print -n "\eP\e]0;${1}\C-G\e\\"
3855     return 0
3856 }
3857
3858 # hl() highlighted less
3859 # http://ft.bewatermyfriend.org/comp/data/zsh/zfunct.html
3860 if check_com -c highlight ; then
3861     function hl() {
3862         local theme lang
3863         theme=${HL_THEME:-""}
3864         case ${1} in
3865             (-l|--list)
3866                 ( printf 'available languages (syntax parameter):\n\n' ;
3867                     highlight --list-langs ; ) | less -SMr
3868                 ;;
3869             (-t|--themes)
3870                 ( printf 'available themes (style parameter):\n\n' ;
3871                     highlight --list-themes ; ) | less -SMr
3872                 ;;
3873             (-h|--help)
3874                 printf 'usage: hl <syntax[:theme]> <file>\n'
3875                 printf '    available options: --list (-l), --themes (-t), --help (-h)\n\n'
3876                 printf '  Example: hl c main.c\n'
3877                 ;;
3878             (*)
3879                 if [[ -z ${2} ]] || (( ${#argv} > 2 )) ; then
3880                     printf 'usage: hl <syntax[:theme]> <file>\n'
3881                     printf '    available options: --list (-l), --themes (-t), --help (-h)\n'
3882                     (( ${#argv} > 2 )) && printf '  Too many arguments.\n'
3883                     return 1
3884                 fi
3885                 lang=${1%:*}
3886                 [[ ${1} == *:* ]] && [[ -n ${1#*:} ]] && theme=${1#*:}
3887                 if [[ -n ${theme} ]] ; then
3888                     highlight --xterm256 --syntax ${lang} --style ${theme} ${2} | less -SMr
3889                 else
3890                     highlight --ansi --syntax ${lang} ${2} | less -SMr
3891                 fi
3892                 ;;
3893         esac
3894         return 0
3895     }
3896     # ... and a proper completion for hl()
3897     # needs 'highlight' as well, so it fits fine in here.
3898     function _hl_genarg()  {
3899         local expl
3900         if [[ -prefix 1 *: ]] ; then
3901             local themes
3902             themes=(${${${(f)"$(LC_ALL=C highlight --list-themes)"}/ #/}:#*(Installed|Use name)*})
3903             compset -P 1 '*:'
3904             _wanted -C list themes expl theme compadd ${themes}
3905         else
3906             local langs
3907             langs=(${${${(f)"$(LC_ALL=C highlight --list-langs)"}/ #/}:#*(Installed|Use name)*})
3908             _wanted -C list languages expl languages compadd -S ':' -q ${langs}
3909         fi
3910     }
3911     function _hl_complete() {
3912         _arguments -s '1: :_hl_genarg' '2:files:_path_files'
3913     }
3914     compdef _hl_complete hl
3915 fi
3916
3917 # Create small urls via http://tinyurl.com using wget(1).
3918 function zurl() {
3919     [[ -z ${1} ]] && { print "USAGE: zurl <URL>" ; return 1 }
3920
3921     local PN url tiny grabber search result preview
3922     PN=${0}
3923     url=${1}
3924 #   Check existence of given URL with the help of ping(1).
3925 #   N.B. ping(1) only works without an eventual given protocol.
3926     ping -c 1 ${${url#(ftp|http)://}%%/*} >& /dev/null || \
3927         read -q "?Given host ${${url#http://*/}%/*} is not reachable by pinging. Proceed anyway? [y|n] "
3928
3929     if (( $? == 0 )) ; then
3930 #           Prepend 'http://' to given URL where necessary for later output.
3931             [[ ${url} != http(s|)://* ]] && url='http://'${url}
3932             tiny='http://tinyurl.com/create.php?url='
3933             if check_com -c wget ; then
3934                 grabber='wget -O- -o/dev/null'
3935             else
3936                 print "wget is not available, but mandatory for ${PN}. Aborting."
3937             fi
3938 #           Looking for i.e.`copy('http://tinyurl.com/7efkze')' in TinyURL's HTML code.
3939             search='copy\(?http://tinyurl.com/[[:alnum:]]##*'
3940             result=${(M)${${${(f)"$(${=grabber} ${tiny}${url})"}[(fr)${search}*]}//[()\';]/}%%http:*}
3941 #           TinyURL provides the rather new feature preview for more confidence. <http://tinyurl.com/preview.php>
3942             preview='http://preview.'${result#http://}
3943
3944             printf '%s\n\n' "${PN} - Shrinking long URLs via webservice TinyURL <http://tinyurl.com>."
3945             printf '%s\t%s\n\n' 'Given URL:' ${url}
3946             printf '%s\t%s\n\t\t%s\n' 'TinyURL:' ${result} ${preview}
3947     else
3948         return 1
3949     fi
3950 }
3951
3952 #f2# Print a specific line of file(s).
3953 linenr () {
3954 # {{{
3955     if [ $# -lt 2 ] ; then
3956        print "Usage: linenr <number>[,<number>] <file>" ; return 1
3957     elif [ $# -eq 2 ] ; then
3958          local number=$1
3959          local file=$2
3960          command ed -s $file <<< "${number}n"
3961     else
3962          local number=$1
3963          shift
3964          for file in "$@" ; do
3965              if [ ! -d $file ] ; then
3966                 echo "${file}:"
3967                 command ed -s $file <<< "${number}n" 2> /dev/null
3968              else
3969                 continue
3970              fi
3971          done | less
3972     fi
3973 # }}}
3974 }
3975
3976 #f2# Find history events by search pattern and list them by date.
3977 whatwhen()  {
3978 # {{{
3979     local usage help ident format_l format_s first_char remain first last
3980     usage='USAGE: whatwhen [options] <searchstring> <search range>'
3981     help='Use' \`'whatwhen -h'\'' for further explanations.'
3982     ident=${(l,${#${:-Usage: }},, ,)}
3983     format_l="${ident}%s\t\t\t%s\n"
3984     format_s="${format_l//(\\t)##/\\t}"
3985     # Make the first char of the word to search for case
3986     # insensitive; e.g. [aA]
3987     first_char=[${(L)1[1]}${(U)1[1]}]
3988     remain=${1[2,-1]}
3989     # Default search range is `-100'.
3990     first=${2:-\-100}
3991     # Optional, just used for `<first> <last>' given.
3992     last=$3
3993     case $1 in
3994         ("")
3995             printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3996             printf '%s\n%s\n\n' ${usage} ${help} && return 1
3997         ;;
3998         (-h)
3999             printf '%s\n\n' ${usage}
4000             print 'OPTIONS:'
4001             printf $format_l '-h' 'show help text'
4002             print '\f'
4003             print 'SEARCH RANGE:'
4004             printf $format_l "'0'" 'the whole history,'
4005             printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
4006             printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
4007             printf '\n%s\n' 'EXAMPLES:'
4008             printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
4009             printf $format_l 'whatwhen zsh -250'
4010             printf $format_l 'whatwhen foo 1 99'
4011         ;;
4012         (\?)
4013             printf '%s\n%s\n\n' ${usage} ${help} && return 1
4014         ;;
4015         (*)
4016             # -l list results on stout rather than invoking $EDITOR.
4017             # -i Print dates as in YYYY-MM-DD.
4018             # -m Search for a - quoted - pattern within the history.
4019             fc -li -m "*${first_char}${remain}*" $first $last
4020         ;;
4021     esac
4022 # }}}
4023 }
4024
4025 # change fluxbox keys from 'Alt-#' to 'Alt-F#' and vice versa
4026 fluxkey-change() {
4027     [[ -n "$FLUXKEYS" ]] || local FLUXKEYS="$HOME/.fluxbox/keys"
4028     if ! [[ -r "$FLUXKEYS" ]] ; then
4029         echo "Sorry, \$FLUXKEYS file $FLUXKEYS could not be read - nothing to be done."
4030         return 1
4031     else
4032         if grep -q 'Mod1 F[0-9] :Workspace [0-9]' $FLUXKEYS ; then
4033             echo -n 'Switching to Alt-# mode in ~/.fluxbox/keys: '
4034             sed -i -e 's|^\(Mod[0-9]\+[: space :]\+\)F\([0-9]\+[: space :]\+:Workspace.*\)|\1\2|' $FLUXKEYS && echo done || echo failed
4035         elif grep -q 'Mod1 [0-9] :Workspace [0-9]' $FLUXKEYS ; then
4036             echo -n 'Switching to Alt-F# mode in ~/.fluxbox/keys: '
4037             sed -i -e 's|^\(Mod[0-9]\+[: space :]\+\)\([0-9]\+[: space :]\+:Workspace.*\)|\1F\2|' $FLUXKEYS && echo done || echo failed
4038         else
4039             echo 'Sorry, do not know what to do.'
4040             return 1
4041         fi
4042     fi
4043 }
4044
4045 # retrieve weather information on the console
4046 # Usage example: 'weather LOWG'
4047 weather() {
4048     [[ -n "$1" ]] || {
4049         print 'Usage: weather <station_id>' >&2
4050         print 'List of stations: http://en.wikipedia.org/wiki/List_of_airports_by_ICAO_code'>&2
4051         return 1
4052     }
4053
4054     local PLACE="${1:u}"
4055     local FILE="$HOME/.weather/$PLACE"
4056     local LOG="$HOME/.weather/log"
4057
4058     [[ -d $HOME/.weather ]] || {
4059         print -n "Creating $HOME/.weather: "
4060         mkdir $HOME/.weather
4061         print 'done'
4062     }
4063
4064     print "Retrieving information for ${PLACE}:"
4065     print
4066     wget -T 10 --no-verbose --output-file=$LOG --output-document=$FILE --timestamping http://weather.noaa.gov/pub/data/observations/metar/decoded/$PLACE.TXT
4067
4068     if [[ $? -eq 0 ]] ; then
4069         if [[ -n "$VERBOSE" ]] ; then
4070             cat $FILE
4071         else
4072             DATE=$(grep 'UTC' $FILE | sed 's#.* /##')
4073             TEMPERATURE=$(awk '/Temperature/ { print $4" degree Celcius / " $2" degree Fahrenheit" }' $FILE| tr -d '(')
4074             echo "date: $DATE"
4075             echo "temp:  $TEMPERATURE"
4076         fi
4077     else
4078         print "There was an error retrieving the weather information for $PLACE" >&2
4079         cat $LOG
4080         return 1
4081     fi
4082 }
4083 # }}}
4084
4085 # mercurial related stuff {{{
4086 if check_com -c hg ; then
4087     # gnu like diff for mercurial
4088     # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
4089     #f5# GNU like diff for mercurial
4090     hgdi() {
4091         for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
4092     }
4093
4094     # build debian package
4095     #a2# Alias for \kbd{hg-buildpackage}
4096     alias hbp='hg-buildpackage'
4097
4098     # execute commands on the versioned patch-queue from the current repos
4099     alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
4100
4101     # diffstat for specific version of a mercurial repository
4102     #   hgstat      => display diffstat between last revision and tip
4103     #   hgstat 1234 => display diffstat between revision 1234 and tip
4104     #f5# Diffstat for specific version of a mercurial repos
4105     hgstat() {
4106         [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
4107     }
4108
4109     #f5# Get current mercurial tip via hg itself
4110     gethgclone() {
4111         setopt local_options
4112         setopt errreturn
4113         if [[ -f mercurial-tree/.hg ]] ; then
4114             cd mercurial-tree
4115             echo "Running hg pull for retreiving latest version..."
4116             hg pull
4117             echo "Finished update. Building mercurial"
4118             make local
4119             echo "Setting \$PATH to $PWD:\$PATH..."
4120             export PATH="$PWD:$PATH"
4121         else
4122             echo "Downloading mercurial via hg"
4123             hg clone http://selenic.com/repo/hg mercurial-tree
4124             cd mercurial-tree
4125             echo "Building mercurial"
4126             make local
4127             echo "Setting \$PATH to $PWD:\$PATH..."
4128             export PATH="$PWD:$PATH"
4129             echo "make sure you set it permanent via ~/.zshrc if you plan to use it permanently."
4130             # echo "Setting \$PYTHONPATH to PYTHONPATH=\${HOME}/lib/python,"
4131             # export PYTHONPATH=${HOME}/lib/python
4132         fi
4133     }
4134
4135 fi # end of check whether we have the 'hg'-executable
4136
4137 # get current mercurial snapshot
4138 #f5# Get current mercurial snapshot
4139 gethgsnap() {
4140     setopt local_options
4141     setopt errreturn
4142     if [[ -f mercurial-snapshot.tar.gz ]] ; then
4143          echo "mercurial-snapshot.tar.gz exists already, skipping download."
4144     else
4145         echo "Downloading mercurial snapshot"
4146         wget http://www.selenic.com/mercurial/mercurial-snapshot.tar.gz
4147     fi
4148     echo "Unpacking mercurial-snapshot.tar.gz"
4149     tar zxf mercurial-snapshot.tar.gz
4150     cd mercurial-snapshot/
4151     echo "Installing required build-dependencies"
4152     $SUDO apt-get update
4153     $SUDO apt-get install python2.4-dev
4154     echo "Building mercurial"
4155     make local
4156     echo "Setting \$PATH to $PWD:\$PATH..."
4157     export PATH="$PWD:$PATH"
4158     echo "make sure you set it permanent via ~/.zshrc if you plan to use it permanently."
4159 }
4160 # }}}
4161
4162 # some useful commands often hard to remember - let's grep for them {{{
4163 # actually use our zg() function now. :)
4164
4165 # Work around ion/xterm resize bug.
4166 #if [[ "$SHLVL" -eq 1 ]]; then
4167 #       if check_com -c resize ; then
4168 #               eval `resize </dev/null`
4169 #       fi
4170 #fi
4171
4172 # enable jackd:
4173 #  /usr/bin/jackd -dalsa -dhw:0 -r48000 -p1024 -n2
4174 # now play audio file:
4175 #  alsaplayer -o jack foobar.mp3
4176
4177 # send files via netcat
4178 # on sending side:
4179 #  send() {j=$*; tar cpz ${j/%${!#}/}|nc -w 1 ${!#} 51330;}
4180 #  send dir* $HOST
4181 #  alias receive='nc -vlp 51330 | tar xzvp'
4182
4183 # debian stuff:
4184 # dh_make -e foo@localhost -f $1
4185 # dpkg-buildpackage -rfakeroot
4186 # lintian *.deb
4187 # dpkg-scanpackages ./ /dev/null | gzip > Packages.gz
4188 # dpkg-scansources . | gzip > Sources.gz
4189 # grep-dctrl --field Maintainer $* /var/lib/apt/lists/*
4190
4191 # other stuff:
4192 # convert -geometry 200x200 -interlace LINE -verbose
4193 # ldapsearch -x -b "OU=Bedienstete,O=tug" -h ldap.tugraz.at sn=$1
4194 # ps -ao user,pcpu,start,command
4195 # gpg --keyserver blackhole.pca.dfn.de --recv-keys
4196 # xterm -bg black -fg yellow -fn -misc-fixed-medium-r-normal--14-140-75-75-c-90-iso8859-15 -ah
4197 # nc -vz $1 1-1024   # portscan via netcat
4198 # wget --mirror --no-parent --convert-links
4199 # pal -d `date +%d`
4200 # autoload -U tetris; zle -N tetris; bindkey '...' ; echo "press ... for playing tennis"
4201 #
4202 # modify console cursor
4203 # see http://www.tldp.org/HOWTO/Framebuffer-HOWTO-5.html
4204 # print $'\e[?96;0;64c'
4205 # }}}
4206
4207 # grml-small cleanups {{{
4208
4209 # The following is used to remove zsh-config-items that do not work
4210 # in grml-small by default.
4211 # If you do not want these adjustments (for whatever reason), set
4212 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
4213 # sources if it is there).
4214
4215 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
4216
4217     unset abk[V]
4218     unalias    'V'      &> /dev/null
4219     unfunction vman     &> /dev/null
4220     unfunction vimpm    &> /dev/null
4221     unfunction vimhelp  &> /dev/null
4222     unfunction viless   &> /dev/null
4223     unfunction 2html    &> /dev/null
4224
4225     # manpages are not in grmlsmall
4226     unfunction manzsh   &> /dev/null
4227     unalias    man2     &> /dev/null
4228     unalias    man      &> /dev/null
4229     unfunction man2     &> /dev/null
4230
4231 fi
4232
4233 #}}}
4234
4235 zrclocal
4236
4237 ## genrefcard.pl settings {{{
4238
4239 ### doc strings for external functions from files
4240 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
4241
4242 ### example: split functions-search 8,16,24,32
4243 #@# split functions-search 8
4244
4245 ## }}}
4246
4247 ## END OF FILE #################################################################
4248 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4