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