zshrc: added OpenBSD support for battery info
[grml-etc-core.git] / 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 # zsh profiling
106 # just execute 'ZSH_PROFILE_RC=1 zsh' and run 'zprof' to get the details
107 if [[ $ZSH_PROFILE_RC -gt 0 ]] ; then
108     zmodload zsh/zprof
109 fi
110
111 # load .zshrc.pre to give the user the chance to overwrite the defaults
112 [[ -r ${ZDOTDIR:-${HOME}}/.zshrc.pre ]] && source ${ZDOTDIR:-${HOME}}/.zshrc.pre
113
114 # check for version/system
115 # check for versions (compatibility reasons)
116 is4(){
117     [[ $ZSH_VERSION == <4->* ]] && return 0
118     return 1
119 }
120
121 is41(){
122     [[ $ZSH_VERSION == 4.<1->* || $ZSH_VERSION == <5->* ]] && return 0
123     return 1
124 }
125
126 is42(){
127     [[ $ZSH_VERSION == 4.<2->* || $ZSH_VERSION == <5->* ]] && return 0
128     return 1
129 }
130
131 is425(){
132     [[ $ZSH_VERSION == 4.2.<5->* || $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
133     return 1
134 }
135
136 is43(){
137     [[ $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
138     return 1
139 }
140
141 is433(){
142     [[ $ZSH_VERSION == 4.3.<3->* || $ZSH_VERSION == 4.<4->* \
143                                  || $ZSH_VERSION == <5->* ]] && return 0
144     return 1
145 }
146
147 is437(){
148     [[ $ZSH_VERSION == 4.3.<7->* || $ZSH_VERSION == 4.<4->* \
149                                  || $ZSH_VERSION == <5->* ]] && return 0
150     return 1
151 }
152
153 is439(){
154     [[ $ZSH_VERSION == 4.3.<9->* || $ZSH_VERSION == 4.<4->* \
155                                  || $ZSH_VERSION == <5->* ]] && return 0
156     return 1
157 }
158
159 #f1# Checks whether or not you're running grml
160 isgrml(){
161     [[ -f /etc/grml_version ]] && return 0
162     return 1
163 }
164
165 #f1# Checks whether or not you're running a grml cd
166 isgrmlcd(){
167     [[ -f /etc/grml_cd ]] && return 0
168     return 1
169 }
170
171 if isgrml ; then
172 #f1# Checks whether or not you're running grml-small
173     isgrmlsmall() {
174         if [[ ${${${(f)"$(</etc/grml_version)"}%% *}##*-} == 'small' ]]; then
175             return 0
176         fi
177         return 1
178     }
179 else
180     isgrmlsmall() { return 1 }
181 fi
182
183 GRML_OSTYPE=$(uname -s)
184
185 islinux(){
186     [[ $GRML_OSTYPE == "Linux" ]]
187 }
188
189 isdarwin(){
190     [[ $GRML_OSTYPE == "Darwin" ]]
191 }
192
193 isfreebsd(){
194     [[ $GRML_OSTYPE == "FreeBSD" ]]
195 }
196
197 isopenbsd(){
198     [[ $GRML_OSTYPE == "OpenBSD" ]]
199 }
200
201 #f1# are we running within an utf environment?
202 isutfenv() {
203     case "$LANG $CHARSET $LANGUAGE" in
204         *utf*) return 0 ;;
205         *UTF*) return 0 ;;
206         *)     return 1 ;;
207     esac
208 }
209
210 # check for user, if not running as root set $SUDO to sudo
211 (( EUID != 0 )) && SUDO='sudo' || SUDO=''
212
213 # change directory to home on first invocation of zsh
214 # important for rungetty -> autologin
215 # Thanks go to Bart Schaefer!
216 isgrml && checkhome() {
217     if [[ -z "$ALREADY_DID_CD_HOME" ]] ; then
218         export ALREADY_DID_CD_HOME=$HOME
219         cd
220     fi
221 }
222
223 # check for zsh v3.1.7+
224
225 if ! [[ ${ZSH_VERSION} == 3.1.<7->*      \
226      || ${ZSH_VERSION} == 3.<2->.<->*    \
227      || ${ZSH_VERSION} == <4->.<->*   ]] ; then
228
229     printf '-!-\n'
230     printf '-!- In this configuration we try to make use of features, that only\n'
231     printf '-!- require version 3.1.7 of the shell; That way this setup can be\n'
232     printf '-!- used with a wide range of zsh versions, while using fairly\n'
233     printf '-!- advanced features in all supported versions.\n'
234     printf '-!-\n'
235     printf '-!- However, you are running zsh version %s.\n' "$ZSH_VERSION"
236     printf '-!-\n'
237     printf '-!- While this *may* work, it might as well fail.\n'
238     printf '-!- Please consider updating to at least version 3.1.7 of zsh.\n'
239     printf '-!-\n'
240     printf '-!- DO NOT EXPECT THIS TO WORK FLAWLESSLY!\n'
241     printf '-!- If it does today, you'\''ve been lucky.\n'
242     printf '-!-\n'
243     printf '-!- Ye been warned!\n'
244     printf '-!-\n'
245
246     function zstyle() { : }
247 fi
248
249 # autoload wrapper - use this one instead of autoload directly
250 # We need to define this function as early as this, because autoloading
251 # 'is-at-least()' needs it.
252 function zrcautoload() {
253     emulate -L zsh
254     setopt extended_glob
255     local fdir ffile
256     local -i ffound
257
258     ffile=$1
259     (( ffound = 0 ))
260     for fdir in ${fpath} ; do
261         [[ -e ${fdir}/${ffile} ]] && (( ffound = 1 ))
262     done
263
264     (( ffound == 0 )) && return 1
265     if [[ $ZSH_VERSION == 3.1.<6-> || $ZSH_VERSION == <4->* ]] ; then
266         autoload -U ${ffile} || return 1
267     else
268         autoload ${ffile} || return 1
269     fi
270     return 0
271 }
272
273 # Load is-at-least() for more precise version checks Note that this test will
274 # *always* fail, if the is-at-least function could not be marked for
275 # autoloading.
276 zrcautoload is-at-least || is-at-least() { return 1 }
277
278 # set some important options (as early as possible)
279
280 # append history list to the history file; this is the default but we make sure
281 # because it's required for share_history.
282 setopt append_history
283
284 # import new commands from the history file also in other zsh-session
285 is4 && setopt share_history
286
287 # save each command's beginning timestamp and the duration to the history file
288 setopt extended_history
289
290 # If a new command line being added to the history list duplicates an older
291 # one, the older command is removed from the list
292 is4 && setopt histignorealldups
293
294 # remove command lines from the history list when the first character on the
295 # line is a space
296 setopt histignorespace
297
298 # if a command is issued that can't be executed as a normal command, and the
299 # command is the name of a directory, perform the cd command to that directory.
300 setopt auto_cd
301
302 # in order to use #, ~ and ^ for filename generation grep word
303 # *~(*.gz|*.bz|*.bz2|*.zip|*.Z) -> searches for word not in compressed files
304 # don't forget to quote '^', '~' and '#'!
305 setopt extended_glob
306
307 # display PID when suspending processes as well
308 setopt longlistjobs
309
310 # try to avoid the 'zsh: no matches found...'
311 setopt nonomatch
312
313 # report the status of backgrounds jobs immediately
314 setopt notify
315
316 # whenever a command completion is attempted, make sure the entire command path
317 # is hashed first.
318 setopt hash_list_all
319
320 # not just at the end
321 setopt completeinword
322
323 # Don't send SIGHUP to background processes when the shell exits.
324 setopt nohup
325
326 # make cd push the old directory onto the directory stack.
327 setopt auto_pushd
328
329 # avoid "beep"ing
330 setopt nobeep
331
332 # don't push the same dir twice.
333 setopt pushd_ignore_dups
334
335 # * shouldn't match dotfiles. ever.
336 setopt noglobdots
337
338 # use zsh style word splitting
339 setopt noshwordsplit
340
341 # don't error out when unset parameters are used
342 setopt unset
343
344 # setting some default values
345 NOCOR=${NOCOR:-0}
346 NOMENU=${NOMENU:-0}
347 NOPRECMD=${NOPRECMD:-0}
348 COMMAND_NOT_FOUND=${COMMAND_NOT_FOUND:-0}
349 GRML_ZSH_CNF_HANDLER=${GRML_ZSH_CNF_HANDLER:-/usr/share/command-not-found/command-not-found}
350 GRML_DISPLAY_BATTERY=${GRML_DISPLAY_BATTERY:-${BATTERY:-0}}
351 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
352 ZSH_NO_DEFAULT_LOCALE=${ZSH_NO_DEFAULT_LOCALE:-0}
353
354 typeset -ga ls_options
355 typeset -ga grep_options
356 if ls --color=auto / >/dev/null 2>&1; then
357     ls_options=( --color=auto )
358 elif ls -G / >/dev/null 2>&1; then
359     ls_options=( -G )
360 fi
361 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
362     grep_options=( --color=auto )
363 fi
364
365 # utility functions
366 # this function checks if a command exists and returns either true
367 # or false. This avoids using 'which' and 'whence', which will
368 # avoid problems with aliases for which on certain weird systems. :-)
369 # Usage: check_com [-c|-g] word
370 #   -c  only checks for external commands
371 #   -g  does the usual tests and also checks for global aliases
372 check_com() {
373     emulate -L zsh
374     local -i comonly gatoo
375
376     if [[ $1 == '-c' ]] ; then
377         (( comonly = 1 ))
378         shift
379     elif [[ $1 == '-g' ]] ; then
380         (( gatoo = 1 ))
381     else
382         (( comonly = 0 ))
383         (( gatoo = 0 ))
384     fi
385
386     if (( ${#argv} != 1 )) ; then
387         printf 'usage: check_com [-c] <command>\n' >&2
388         return 1
389     fi
390
391     if (( comonly > 0 )) ; then
392         [[ -n ${commands[$1]}  ]] && return 0
393         return 1
394     fi
395
396     if   [[ -n ${commands[$1]}    ]] \
397       || [[ -n ${functions[$1]}   ]] \
398       || [[ -n ${aliases[$1]}     ]] \
399       || [[ -n ${reswords[(r)$1]} ]] ; then
400
401         return 0
402     fi
403
404     if (( gatoo > 0 )) && [[ -n ${galiases[$1]} ]] ; then
405         return 0
406     fi
407
408     return 1
409 }
410
411 # creates an alias and precedes the command with
412 # sudo if $EUID is not zero.
413 salias() {
414     emulate -L zsh
415     local only=0 ; local multi=0
416     local key val
417     while [[ $1 == -* ]] ; do
418         case $1 in
419             (-o) only=1 ;;
420             (-a) multi=1 ;;
421             (--) shift ; break ;;
422             (-h)
423                 printf 'usage: salias [-h|-o|-a] <alias-expression>\n'
424                 printf '  -h      shows this help text.\n'
425                 printf '  -a      replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
426                 printf '          be careful using this option.\n'
427                 printf '  -o      only sets an alias if a preceding sudo would be needed.\n'
428                 return 0
429                 ;;
430             (*) printf "unkown option: '%s'\n" "$1" ; return 1 ;;
431         esac
432         shift
433     done
434
435     if (( ${#argv} > 1 )) ; then
436         printf 'Too many arguments %s\n' "${#argv}"
437         return 1
438     fi
439
440     key="${1%%\=*}" ;  val="${1#*\=}"
441     if (( EUID == 0 )) && (( only == 0 )); then
442         alias -- "${key}=${val}"
443     elif (( EUID > 0 )) ; then
444         (( multi > 0 )) && val="${val// ; / ; sudo }"
445         alias -- "${key}=sudo ${val}"
446     fi
447
448     return 0
449 }
450
451 # a "print -l ${(u)foo}"-workaround for pre-4.2.0 shells
452 # usage: uprint foo
453 #   Where foo is the *name* of the parameter you want printed.
454 #   Note that foo is no typo; $foo would be wrong here!
455 if ! is42 ; then
456     uprint () {
457         emulate -L zsh
458         local -a u
459         local w
460         local parameter=$1
461
462         if [[ -z ${parameter} ]] ; then
463             printf 'usage: uprint <parameter>\n'
464             return 1
465         fi
466
467         for w in ${(P)parameter} ; do
468             [[ -z ${(M)u:#$w} ]] && u=( $u $w )
469         done
470
471         builtin print -l $u
472     }
473 fi
474
475 # Check if we can read given files and source those we can.
476 xsource() {
477     if (( ${#argv} < 1 )) ; then
478         printf 'usage: xsource FILE(s)...\n' >&2
479         return 1
480     fi
481
482     while (( ${#argv} > 0 )) ; do
483         [[ -r "$1" ]] && source "$1"
484         shift
485     done
486     return 0
487 }
488
489 # Check if we can read a given file and 'cat(1)' it.
490 xcat() {
491     emulate -L zsh
492     if (( ${#argv} != 1 )) ; then
493         printf 'usage: xcat FILE\n' >&2
494         return 1
495     fi
496
497     [[ -r $1 ]] && cat $1
498     return 0
499 }
500
501 # Remove these functions again, they are of use only in these
502 # setup files. This should be called at the end of .zshrc.
503 xunfunction() {
504     emulate -L zsh
505     local -a funcs
506     funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
507     for func in $funcs ; do
508         [[ -n ${functions[$func]} ]] \
509             && unfunction $func
510     done
511     return 0
512 }
513
514 # this allows us to stay in sync with grml's zshrc and put own
515 # modifications in ~/.zshrc.local
516 zrclocal() {
517     xsource "/etc/zsh/zshrc.local"
518     xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
519     return 0
520 }
521
522 # locale setup
523 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
524     xsource "/etc/default/locale"
525 fi
526
527 for var in LANG LC_ALL LC_MESSAGES ; do
528     [[ -n ${(P)var} ]] && export $var
529 done
530
531 # set some variables
532 if check_com -c vim ; then
533 #v#
534     export EDITOR=${EDITOR:-vim}
535 else
536     export EDITOR=${EDITOR:-vi}
537 fi
538
539 #v#
540 export PAGER=${PAGER:-less}
541
542 #v#
543 export MAIL=${MAIL:-/var/mail/$USER}
544
545 # if we don't set $SHELL then aterm, rxvt,.. will use /bin/sh or /bin/bash :-/
546 if [[ -z "$SHELL" ]] ; then
547   SHELL="$(which zsh)"
548   if [[ -x "$SHELL" ]] ; then
549     export SHELL
550   fi
551 fi
552
553 # color setup for ls:
554 check_com -c dircolors && eval $(dircolors -b)
555 # color setup for ls on OS X / FreeBSD:
556 isdarwin && export CLICOLOR=1
557 isfreebsd && export CLICOLOR=1
558
559 # do MacPorts setup on darwin
560 if isdarwin && [[ -d /opt/local ]]; then
561     # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
562     # zshenv.
563     PATH="/opt/local/bin:/opt/local/sbin:$PATH"
564     MANPATH="/opt/local/share/man:$MANPATH"
565 fi
566 # do Fink setup on darwin
567 isdarwin && xsource /sw/bin/init.sh
568
569 # load our function and completion directories
570 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
571     fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
572     if [[ ${fdir} == '/usr/share/grml/zsh/functions' ]] ; then
573         for func in ${fdir}/**/[^_]*[^~](N.) ; do
574             zrcautoload ${func:t}
575         done
576     fi
577 done
578 unset fdir func
579
580 # support colors in less
581 export LESS_TERMCAP_mb=$'\E[01;31m'
582 export LESS_TERMCAP_md=$'\E[01;31m'
583 export LESS_TERMCAP_me=$'\E[0m'
584 export LESS_TERMCAP_se=$'\E[0m'
585 export LESS_TERMCAP_so=$'\E[01;44;33m'
586 export LESS_TERMCAP_ue=$'\E[0m'
587 export LESS_TERMCAP_us=$'\E[01;32m'
588
589 # mailchecks
590 MAILCHECK=30
591
592 # report about cpu-/system-/user-time of command if running longer than
593 # 5 seconds
594 REPORTTIME=5
595
596 # watch for everyone but me and root
597 watch=(notme root)
598
599 # automatically remove duplicates from these arrays
600 typeset -U path cdpath fpath manpath
601
602 # Load a few modules
603 is4 && \
604 for mod in parameter complist deltochar mathfunc ; do
605     zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
606 done
607
608 # autoload zsh modules when they are referenced
609 if is4 ; then
610     zmodload -a  zsh/stat    zstat
611     zmodload -a  zsh/zpty    zpty
612     zmodload -ap zsh/mapfile mapfile
613 fi
614
615 # completion system
616 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
617 if zrcautoload compinit ; then
618     compinit -d ${COMPDUMPFILE} || print 'Notice: no compinit available :('
619 else
620     print 'Notice: no compinit available :('
621     function compdef { }
622 fi
623
624 # completion system
625
626 # called later (via is4 && grmlcomp)
627 # note: use 'zstyle' for getting current settings
628 #         press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
629 grmlcomp() {
630     # TODO: This could use some additional information
631
632     # Make sure the completion system is initialised
633     (( ${+_comps} )) || return 1
634
635     # allow one error for every three characters typed in approximate completer
636     zstyle ':completion:*:approximate:'    max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
637
638     # don't complete backup files as executables
639     zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
640
641     # start menu completion only if it could find no unambiguous initial string
642     zstyle ':completion:*:correct:*'       insert-unambiguous true
643     zstyle ':completion:*:corrections'     format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
644     zstyle ':completion:*:correct:*'       original true
645
646     # activate color-completion
647     zstyle ':completion:*:default'         list-colors ${(s.:.)LS_COLORS}
648
649     # format on completion
650     zstyle ':completion:*:descriptions'    format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
651
652     # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
653     # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
654
655     # insert all expansions for expand completer
656     zstyle ':completion:*:expand:*'        tag-order all-expansions
657     zstyle ':completion:*:history-words'   list false
658
659     # activate menu
660     zstyle ':completion:*:history-words'   menu yes
661
662     # ignore duplicate entries
663     zstyle ':completion:*:history-words'   remove-all-dups yes
664     zstyle ':completion:*:history-words'   stop yes
665
666     # match uppercase from lowercase
667     zstyle ':completion:*'                 matcher-list 'm:{a-z}={A-Z}'
668
669     # separate matches into groups
670     zstyle ':completion:*:matches'         group 'yes'
671     zstyle ':completion:*'                 group-name ''
672
673     if [[ "$NOMENU" -eq 0 ]] ; then
674         # if there are more than 5 options allow selecting from a menu
675         zstyle ':completion:*'               menu select=5
676     else
677         # don't use any menus at all
678         setopt no_auto_menu
679     fi
680
681     zstyle ':completion:*:messages'        format '%d'
682     zstyle ':completion:*:options'         auto-description '%d'
683
684     # describe options in full
685     zstyle ':completion:*:options'         description 'yes'
686
687     # on processes completion complete all user processes
688     zstyle ':completion:*:processes'       command 'ps -au$USER'
689
690     # offer indexes before parameters in subscripts
691     zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
692
693     # provide verbose completion information
694     zstyle ':completion:*'                 verbose true
695
696     # recent (as of Dec 2007) zsh versions are able to provide descriptions
697     # for commands (read: 1st word in the line) that it will list for the user
698     # to choose from. The following disables that, because it's not exactly fast.
699     zstyle ':completion:*:-command-:*:'    verbose false
700
701     # set format for warnings
702     zstyle ':completion:*:warnings'        format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
703
704     # define files to ignore for zcompile
705     zstyle ':completion:*:*:zcompile:*'    ignored-patterns '(*~|*.zwc)'
706     zstyle ':completion:correct:'          prompt 'correct to: %e'
707
708     # Ignore completion functions for commands you don't have:
709     zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
710
711     # Provide more processes in completion of programs like killall:
712     zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
713
714     # complete manual by their section
715     zstyle ':completion:*:manuals'    separate-sections true
716     zstyle ':completion:*:manuals.*'  insert-sections   true
717     zstyle ':completion:*:man:*'      menu yes select
718
719     # Search path for sudo completion
720     zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
721                                                /usr/local/bin  \
722                                                /usr/sbin       \
723                                                /usr/bin        \
724                                                /sbin           \
725                                                /bin            \
726                                                /usr/X11R6/bin
727
728     # provide .. as a completion
729     zstyle ':completion:*' special-dirs ..
730
731     # run rehash on completion so new installed program are found automatically:
732     _force_rehash() {
733         (( CURRENT == 1 )) && rehash
734         return 1
735     }
736
737     ## correction
738     # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
739     if [[ "$NOCOR" -gt 0 ]] ; then
740         zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
741         setopt nocorrect
742     else
743         # try to be smart about when to use what completer...
744         setopt correct
745         zstyle -e ':completion:*' completer '
746             if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
747                 _last_try="$HISTNO$BUFFER$CURSOR"
748                 reply=(_complete _match _ignored _prefix _files)
749             else
750                 if [[ $words[1] == (rm|mv) ]] ; then
751                     reply=(_complete _files)
752                 else
753                     reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
754                 fi
755             fi'
756     fi
757
758     # command for process lists, the local web server details and host completion
759     zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
760
761     # caching
762     [[ -d $ZSHDIR/cache ]] && zstyle ':completion:*' use-cache yes && \
763                             zstyle ':completion::complete:*' cache-path $ZSHDIR/cache/
764
765     # host completion
766     if is42 ; then
767         [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
768         [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
769     else
770         _ssh_hosts=()
771         _etc_hosts=()
772     fi
773     hosts=(
774         $(hostname)
775         "$_ssh_hosts[@]"
776         "$_etc_hosts[@]"
777         localhost
778     )
779     zstyle ':completion:*:hosts' hosts $hosts
780     # TODO: so, why is this here?
781     #  zstyle '*' hosts $hosts
782
783     # use generic completion system for programs not yet defined; (_gnu_generic works
784     # with commands that provide a --help option with "standard" gnu-like output.)
785     for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
786                    pal stow tail uname ; do
787         [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
788     done; unset compcom
789
790     # see upgrade function in this file
791     compdef _hosts upgrade
792 }
793
794 # Keyboard setup: The following is based on the same code, we wrote for
795 # debian's setup. It ensures the terminal is in the right mode, when zle is
796 # active, so the values from $terminfo are valid. Therefore, this setup should
797 # work on all systems, that have support for `terminfo'. It also requires the
798 # zsh in use to have the `zsh/terminfo' module built.
799 #
800 # If you are customising your `zle-line-init()' or `zle-line-finish()'
801 # functions, make sure you call the following utility functions in there:
802 #
803 #     - zle-line-init():      zle-smkx
804 #     - zle-line-finish():    zle-rmkx
805
806 # Use emacs-like key bindings by default:
807 bindkey -e
808
809 # Custom widgets:
810
811 ## beginning-of-line OR beginning-of-buffer OR beginning of history
812 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
813 beginning-or-end-of-somewhere() {
814     local hno=$HISTNO
815     if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
816       ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
817         zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
818     else
819         zle .${WIDGET:s/somewhere/line-hist/} "$@"
820         if (( HISTNO != hno )); then
821             zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
822         fi
823     fi
824 }
825 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
826 zle -N end-of-somewhere beginning-or-end-of-somewhere
827
828 # add a command line to the shells history without executing it
829 commit-to-history() {
830     print -s ${(z)BUFFER}
831     zle send-break
832 }
833 zle -N commit-to-history
834
835 # only slash should be considered as a word separator:
836 slash-backward-kill-word() {
837     local WORDCHARS="${WORDCHARS:s@/@}"
838     # zle backward-word
839     zle backward-kill-word
840 }
841 zle -N slash-backward-kill-word
842
843 # a generic accept-line wrapper
844
845 # This widget can prevent unwanted autocorrections from command-name
846 # to _command-name, rehash automatically on enter and call any number
847 # of builtin and user-defined widgets in different contexts.
848 #
849 # For a broader description, see:
850 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
851 #
852 # The code is imported from the file 'zsh/functions/accept-line' from
853 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
854 # distributed under the same terms as zsh itself.
855
856 # A newly added command will may not be found or will cause false
857 # correction attempts, if you got auto-correction set. By setting the
858 # following style, we force accept-line() to rehash, if it cannot
859 # find the first word on the command line in the $command[] hash.
860 zstyle ':acceptline:*' rehash true
861
862 function Accept-Line() {
863     setopt localoptions noksharrays
864     local -a subs
865     local -xi aldone
866     local sub
867     local alcontext=${1:-$alcontext}
868
869     zstyle -a ":acceptline:${alcontext}" actions subs
870
871     (( ${#subs} < 1 )) && return 0
872
873     (( aldone = 0 ))
874     for sub in ${subs} ; do
875         [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
876         zle ${sub}
877
878         (( aldone > 0 )) && break
879     done
880 }
881
882 function Accept-Line-getdefault() {
883     emulate -L zsh
884     local default_action
885
886     zstyle -s ":acceptline:${alcontext}" default_action default_action
887     case ${default_action} in
888         ((accept-line|))
889             printf ".accept-line"
890             ;;
891         (*)
892             printf ${default_action}
893             ;;
894     esac
895 }
896
897 function Accept-Line-HandleContext() {
898     zle Accept-Line
899
900     default_action=$(Accept-Line-getdefault)
901     zstyle -T ":acceptline:${alcontext}" call_default \
902         && zle ${default_action}
903 }
904
905 function accept-line() {
906     setopt localoptions noksharrays
907     local -ax cmdline
908     local -x alcontext
909     local buf com fname format msg default_action
910
911     alcontext='default'
912     buf="${BUFFER}"
913     cmdline=(${(z)BUFFER})
914     com="${cmdline[1]}"
915     fname="_${com}"
916
917     Accept-Line 'preprocess'
918
919     zstyle -t ":acceptline:${alcontext}" rehash \
920         && [[ -z ${commands[$com]} ]]           \
921         && rehash
922
923     if    [[ -n ${com}               ]] \
924        && [[ -n ${reswords[(r)$com]} ]] \
925        || [[ -n ${aliases[$com]}     ]] \
926        || [[ -n ${functions[$com]}   ]] \
927        || [[ -n ${builtins[$com]}    ]] \
928        || [[ -n ${commands[$com]}    ]] ; then
929
930         # there is something sensible to execute, just do it.
931         alcontext='normal'
932         Accept-Line-HandleContext
933
934         return
935     fi
936
937     if    [[ -o correct              ]] \
938        || [[ -o correctall           ]] \
939        && [[ -n ${functions[$fname]} ]] ; then
940
941         # nothing there to execute but there is a function called
942         # _command_name; a completion widget. Makes no sense to
943         # call it on the commandline, but the correct{,all} options
944         # will ask for it nevertheless, so warn the user.
945         if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
946             # Okay, we warned the user before, he called us again,
947             # so have it his way.
948             alcontext='force'
949             Accept-Line-HandleContext
950
951             return
952         fi
953
954         if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
955             alcontext='normal'
956             Accept-Line-HandleContext
957         else
958             # prepare warning message for the user, configurable via zstyle.
959             zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
960
961             if [[ -z ${msg} ]] ; then
962                 msg="%c will not execute and completion %f exists."
963             fi
964
965             zformat -f msg "${msg}" "c:${com}" "f:${fname}"
966
967             zle -M -- "${msg}"
968         fi
969         return
970     elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
971         # If we are here, the commandline contains something that is not
972         # executable, which is neither subject to _command_name correction
973         # and is not empty. might be a variable assignment
974         alcontext='misc'
975         Accept-Line-HandleContext
976
977         return
978     fi
979
980     # If we got this far, the commandline only contains whitespace, or is empty.
981     alcontext='empty'
982     Accept-Line-HandleContext
983 }
984
985 zle -N accept-line
986 zle -N Accept-Line
987 zle -N Accept-Line-HandleContext
988
989 # power completion / abbreviation expansion / buffer expansion
990 # see http://zshwiki.org/home/examples/zleiab for details
991 # less risky than the global aliases but powerful as well
992 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
993 declare -A abk
994 setopt extendedglob
995 setopt interactivecomments
996 abk=(
997 #   key   # value                  (#d additional doc string)
998 #A# start
999     '...'  '../..'
1000     '....' '../../..'
1001     'BG'   '& exit'
1002     'C'    '| wc -l'
1003     'G'    '|& grep '${grep_options:+"${grep_options[*]}"}
1004     'H'    '| head'
1005     'Hl'   ' --help |& less -r'    #d (Display help in pager)
1006     'L'    '| less'
1007     'LL'   '|& less -r'
1008     'M'    '| most'
1009     'N'    '&>/dev/null'           #d (No Output)
1010     'R'    '| tr A-z N-za-m'       #d (ROT13)
1011     'SL'   '| sort | less'
1012     'S'    '| sort -u'
1013     'T'    '| tail'
1014     'V'    '|& vim -'
1015 #A# end
1016     'co'   './configure && make && sudo make install'
1017 )
1018
1019 zleiab() {
1020     emulate -L zsh
1021     setopt extendedglob
1022     local MATCH
1023
1024     LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1025     LBUFFER+=${abk[$MATCH]:-$MATCH}
1026 }
1027
1028 zle -N zleiab
1029
1030 help-show-abk()
1031 {
1032   zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1033 }
1034
1035 zle -N help-show-abk
1036
1037 # press "ctrl-e d" to insert the actual date in the form yyyy-mm-dd
1038 insert-datestamp() { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1039 zle -N insert-datestamp
1040
1041 # press esc-m for inserting last typed word again (thanks to caphuso!)
1042 insert-last-typed-word() { zle insert-last-word -- 0 -1 };
1043 zle -N insert-last-typed-word;
1044
1045 function grml-zsh-fg() {
1046   if (( ${#jobstates} )); then
1047     zle .push-input
1048     [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1049     BUFFER="${BUFFER}fg"
1050     zle .accept-line
1051   else
1052     zle -M 'No background jobs. Doing nothing.'
1053   fi
1054 }
1055 zle -N grml-zsh-fg
1056
1057 # run command line as user root via sudo:
1058 sudo-command-line() {
1059     [[ -z $BUFFER ]] && zle up-history
1060     if [[ $BUFFER != sudo\ * ]]; then
1061         BUFFER="sudo $BUFFER"
1062         CURSOR=$(( CURSOR+5 ))
1063     fi
1064 }
1065 zle -N sudo-command-line
1066
1067 ### jump behind the first word on the cmdline.
1068 ### useful to add options.
1069 function jump_after_first_word() {
1070     local words
1071     words=(${(z)BUFFER})
1072
1073     if (( ${#words} <= 1 )) ; then
1074         CURSOR=${#BUFFER}
1075     else
1076         CURSOR=${#${words[1]}}
1077     fi
1078 }
1079 zle -N jump_after_first_word
1080
1081 #f5# Create directory under cursor or the selected area
1082 inplaceMkDirs() {
1083     # Press ctrl-xM to create the directory under the cursor or the selected area.
1084     # To select an area press ctrl-@ or ctrl-space and use the cursor.
1085     # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1086     # directory does not exist yet -> press ctrl-XM and problem solved
1087     local PATHTOMKDIR
1088     if ((REGION_ACTIVE==1)); then
1089         local F=$MARK T=$CURSOR
1090         if [[ $F -gt $T ]]; then
1091             F=${CURSOR}
1092             T=${MARK}
1093         fi
1094         # get marked area from buffer and eliminate whitespace
1095         PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1096         PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1097     else
1098         local bufwords iword
1099         bufwords=(${(z)LBUFFER})
1100         iword=${#bufwords}
1101         bufwords=(${(z)BUFFER})
1102         PATHTOMKDIR="${(Q)bufwords[iword]}"
1103     fi
1104     [[ -z "${PATHTOMKDIR}" ]] && return 1
1105     PATHTOMKDIR=${~PATHTOMKDIR}
1106     if [[ -e "${PATHTOMKDIR}" ]]; then
1107         zle -M " path already exists, doing nothing"
1108     else
1109         zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1110         zle end-of-line
1111     fi
1112 }
1113
1114 zle -N inplaceMkDirs
1115
1116 #v1# set number of lines to display per page
1117 HELP_LINES_PER_PAGE=20
1118 #v1# set location of help-zle cache file
1119 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1120 # helper function for help-zle, actually generates the help text
1121 help_zle_parse_keybindings()
1122 {
1123     emulate -L zsh
1124     setopt extendedglob
1125     unsetopt ksharrays  #indexing starts at 1
1126
1127     #v1# choose files that help-zle will parse for keybindings
1128     ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1129
1130     if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1131         local load_cache=0
1132         for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1133         [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1134     fi
1135
1136     #fill with default keybindings, possibly to be overwriten in a file later
1137     #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1138     local -A help_zle_keybindings
1139     help_zle_keybindings['<Ctrl>@']="set MARK"
1140     help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1141     help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1142     help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1143     help_zle_keybindings['<Ctrl>_']="undo"
1144     help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1145     help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1146     help_zle_keybindings['<Ctrl>e']="goto end of line"
1147     help_zle_keybindings['<Ctrl>t']="transpose charaters"
1148     help_zle_keybindings['<Alt>t']="transpose words"
1149     help_zle_keybindings['<Alt>s']="spellcheck word"
1150     help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1151     help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1152     help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1153     help_zle_keybindings["<Alt>'"]="quote line"
1154     help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1155     help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1156     help_zle_keybindings['<Alt>u']="make next word Uppercase"
1157     help_zle_keybindings['<Alt>l']="make next word lowercase"
1158     help_zle_keybindings['<Ctrl>xd']="preview expansion under cursor"
1159     help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1160     help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1161     help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1162     help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1163     help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1164     help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1165     help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1166     help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1167
1168     #init global variables
1169     unset help_zle_lines help_zle_sln
1170     typeset -g -a help_zle_lines
1171     typeset -g help_zle_sln=1
1172
1173     local k v
1174     local lastkeybind_desc contents     #last description starting with #k# that we found
1175     local num_lines_elapsed=0            #number of lines between last description and keybinding
1176     #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1177     for f in $HELPZLE_KEYBINDING_FILES; do
1178         [[ -r "$f" ]] || continue   #not readable ? skip it
1179         contents="$(<$f)"
1180         for cline in "${(f)contents}"; do
1181             #zsh pattern: matches lines like: #k# ..............
1182             if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1183                 lastkeybind_desc="$match[*]"
1184                 num_lines_elapsed=0
1185             #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1186             #             ignores lines that are commentend out
1187             #             grabs first in '' or "" enclosed string with length between 1 and 6 characters
1188             elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*)  ]]; then
1189                 #description prevously found ? description not more than 2 lines away ? keybinding not empty ?
1190                 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1191                     #substitute keybinding string with something readable
1192                     k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1193                     #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1194                     #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1195                     help_zle_keybindings[${k}]=$lastkeybind_desc
1196                 fi
1197                 lastkeybind_desc=""
1198             else
1199               ((num_lines_elapsed++))
1200             fi
1201         done
1202     done
1203     unset contents
1204     #calculate length of keybinding column
1205     local kstrlen=0
1206     for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1207     #convert the assoc array into preformated lines, which we are able to sort
1208     for k v in ${(kv)help_zle_keybindings[@]}; do
1209         #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1210         help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1211     done
1212     #sort lines alphabetically
1213     help_zle_lines=("${(i)help_zle_lines[@]}")
1214     [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1215     echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1216     zcompile $HELP_ZLE_CACHE_FILE
1217 }
1218 typeset -g help_zle_sln
1219 typeset -g -a help_zle_lines
1220
1221 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1222 help-zle()
1223 {
1224     emulate -L zsh
1225     unsetopt ksharrays  #indexing starts at 1
1226     #help lines already generated ? no ? then do it
1227     [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1228     #already displayed all lines ? go back to the start
1229     [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1230     local sln=$help_zle_sln
1231     #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1232     help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1233     zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1234 }
1235 zle -N help-zle
1236
1237 ## complete word from currently visible Screen or Tmux buffer.
1238 if check_com -c screen || check_com -c tmux; then
1239     _complete_screen_display() {
1240         [[ "$TERM" != "screen" ]] && return 1
1241
1242         local TMPFILE=$(mktemp)
1243         local -U -a _screen_display_wordlist
1244         trap "rm -f $TMPFILE" EXIT
1245
1246         # fill array with contents from screen hardcopy
1247         if ((${+TMUX})); then
1248             #works, but crashes tmux below version 1.4
1249             #luckily tmux -V option to ask for version, was also added in 1.4
1250             tmux -V &>/dev/null || return
1251             tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1252         else
1253             screen -X hardcopy $TMPFILE
1254             # screen sucks, it dumps in latin1, apparently always. so recode it
1255             # to system charset
1256             check_com recode && recode latin1 $TMPFILE
1257         fi
1258         _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1259         # remove PREFIX to be completed from that array
1260         _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1261         compadd -a _screen_display_wordlist
1262     }
1263     #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1264     bindkey -r "^xS"
1265     compdef -k _complete_screen_display complete-word '^xS'
1266 fi
1267
1268 # Load a few more functions and tie them to widgets, so they can be bound:
1269
1270 function zrcautozle() {
1271     emulate -L zsh
1272     local fnc=$1
1273     zrcautoload $fnc && zle -N $fnc
1274 }
1275
1276 function zrcgotwidget() {
1277     (( ${+widgets[$1]} ))
1278 }
1279
1280 function zrcgotkeymap() {
1281     [[ -n ${(M)keymaps:#$1} ]]
1282 }
1283
1284 zrcautozle insert-files
1285 zrcautozle edit-command-line
1286 zrcautozle insert-unicode-char
1287 if zrcautoload history-search-end; then
1288     zle -N history-beginning-search-backward-end history-search-end
1289     zle -N history-beginning-search-forward-end  history-search-end
1290 fi
1291 zle -C hist-complete complete-word _generic
1292 zstyle ':completion:hist-complete:*' completer _history
1293
1294 # The actual terminal setup hooks and bindkey-calls:
1295
1296 # An array to note missing features to ease diagnosis in case of problems.
1297 typeset -ga grml_missing_features
1298
1299 function zrcbindkey() {
1300     if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1301         bindkey "$@"
1302     fi
1303 }
1304
1305 function bind2maps () {
1306     local i sequence widget
1307     local -a maps
1308
1309     while [[ "$1" != "--" ]]; do
1310         maps+=( "$1" )
1311         shift
1312     done
1313     shift
1314
1315     if [[ "$1" == "-s" ]]; then
1316         shift
1317         sequence="$1"
1318     else
1319         sequence="${key[$1]}"
1320     fi
1321     widget="$2"
1322
1323     [[ -z "$sequence" ]] && return 1
1324
1325     for i in "${maps[@]}"; do
1326         zrcbindkey -M "$i" "$sequence" "$widget"
1327     done
1328 }
1329
1330 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1331     function zle-smkx () {
1332         emulate -L zsh
1333         printf '%s' ${terminfo[smkx]}
1334     }
1335     function zle-rmkx () {
1336         emulate -L zsh
1337         printf '%s' ${terminfo[rmkx]}
1338     }
1339     function zle-line-init () {
1340         zle-smkx
1341     }
1342     function zle-line-finish () {
1343         zle-rmkx
1344     }
1345     zle -N zle-line-init
1346     zle -N zle-line-finish
1347 else
1348     for i in {s,r}mkx; do
1349         (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1350     done
1351     unset i
1352 fi
1353
1354 typeset -A key
1355 key=(
1356     Home     "${terminfo[khome]}"
1357     End      "${terminfo[kend]}"
1358     Insert   "${terminfo[kich1]}"
1359     Delete   "${terminfo[kdch1]}"
1360     Up       "${terminfo[kcuu1]}"
1361     Down     "${terminfo[kcud1]}"
1362     Left     "${terminfo[kcub1]}"
1363     Right    "${terminfo[kcuf1]}"
1364     PageUp   "${terminfo[kpp]}"
1365     PageDown "${terminfo[knp]}"
1366     BackTab  "${terminfo[kcbt]}"
1367 )
1368
1369 # Guidelines for adding key bindings:
1370 #
1371 #   - Do not add hardcoded escape sequences, to enable non standard key
1372 #     combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1373 #
1374 #   - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1375 #     the same key.
1376 #
1377 #   - All keys from the $key[] mapping are obviously okay.
1378 #
1379 #   - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1380 #     '\ex' are allowed in here as well.
1381
1382 bind2maps emacs             -- Home   beginning-of-somewhere
1383 bind2maps       viins vicmd -- Home   vi-beginning-of-line
1384 bind2maps emacs             -- End    end-of-somewhere
1385 bind2maps       viins vicmd -- End    vi-end-of-line
1386 bind2maps emacs viins       -- Insert overwrite-mode
1387 bind2maps             vicmd -- Insert vi-insert
1388 bind2maps emacs             -- Delete delete-char
1389 bind2maps       viins vicmd -- Delete vi-delete-char
1390 bind2maps emacs viins vicmd -- Up     up-line-or-search
1391 bind2maps emacs viins vicmd -- Down   down-line-or-search
1392 bind2maps emacs             -- Left   backward-char
1393 bind2maps       viins vicmd -- Left   vi-backward-char
1394 bind2maps emacs             -- Right  forward-char
1395 bind2maps       viins vicmd -- Right  vi-forward-char
1396 bind2maps       viins vicmd -- Right  vi-forward-char
1397 #k# Perform abbreviation expansion
1398 bind2maps emacs viins       -- -s '^x.' zleiab
1399 #k# Display list of abbreviations that would expand
1400 bind2maps emacs viins       -- -s '^xb' help-show-abk
1401 #k# mkdir -p <dir> from string under cursor or marked area
1402 bind2maps emacs viins       -- -s '^xM' inplaceMkDirs
1403 #k# display help for keybindings and ZLE
1404 bind2maps emacs viins       -- -s '^xz' help-zle
1405 #k# Insert files and test globbing
1406 bind2maps emacs viins       -- -s "^xf" insert-files
1407 #k# Edit the current line in \kbd{\$EDITOR}
1408 bind2maps emacs viins       -- -s '\ee' edit-command-line
1409 #k# search history backward for entry beginning with typed text
1410 bind2maps emacs viins       -- -s '^xp' history-beginning-search-backward-end
1411 #k# search history forward for entry beginning with typed text
1412 bind2maps emacs viins       -- -s '^xP' history-beginning-search-forward-end
1413 #k# search history backward for entry beginning with typed text
1414 bind2maps emacs viins       -- PageUp history-beginning-search-backward-end
1415 #k# search history forward for entry beginning with typed text
1416 bind2maps emacs viins       -- PageDown history-beginning-search-forward-end
1417 bind2maps emacs viins       -- -s "^x^h" commit-to-history
1418 #k# Kill left-side word or everything up to next slash
1419 bind2maps emacs viins       -- -s '\ev' slash-backward-kill-word
1420 #k# Kill left-side word or everything up to next slash
1421 bind2maps emacs viins       -- -s '\e^h' slash-backward-kill-word
1422 #k# Kill left-side word or everything up to next slash
1423 bind2maps emacs viins       -- -s '\e^?' slash-backward-kill-word
1424 # Do history expansion on space:
1425 bind2maps emacs viins       -- -s ' ' magic-space
1426 #k# Trigger menu-complete
1427 bind2maps emacs viins       -- -s '\ei' menu-complete  # menu completion via esc-i
1428 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1429 bind2maps emacs viins       -- -s '^ed' insert-datestamp
1430 #k# Insert last typed word
1431 bind2maps emacs viins       -- -s "\em" insert-last-typed-word
1432 #k# A smart shortcut for \kbd{fg<enter>}
1433 bind2maps emacs viins       -- -s '^z' grml-zsh-fg
1434 #k# prepend the current command with "sudo"
1435 bind2maps emacs viins       -- -s "^os" sudo-command-line
1436 #k# jump to after first word (for adding options)
1437 bind2maps emacs viins       -- -s '^x1' jump_after_first_word
1438 #k# complete word from history with menu
1439 bind2maps emacs viins       -- -s "^x^x" hist-complete
1440
1441 # insert unicode character
1442 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an Â§
1443 # See for example http://unicode.org/charts/ for unicode characters code
1444 #k# Insert Unicode character
1445 bind2maps emacs viins       -- -s '^xi' insert-unicode-char
1446
1447 # use the new *-pattern-* widgets for incremental history search
1448 if zrcgotwidget history-incremental-pattern-search-backward; then
1449     for seq wid in '^r' history-incremental-pattern-search-backward \
1450                    '^s' history-incremental-pattern-search-forward
1451     do
1452         bind2maps emacs viins vicmd -- -s $seq $wid
1453     done
1454 fi
1455
1456 if zrcgotkeymap menuselect; then
1457     #m# k Shift-tab Perform backwards menu completion
1458     bind2maps menuselect -- BackTab reverse-menu-complete
1459
1460     #k# menu selection: pick item but stay in the menu
1461     bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1462     # also use + and INSERT since it's easier to press repeatedly
1463     bind2maps menuselect -- -s '+' accept-and-menu-complete
1464     bind2maps menuselect -- Insert accept-and-menu-complete
1465
1466     # accept a completion and try to complete again by using menu
1467     # completion; very useful with completing directories
1468     # by using 'undo' one's got a simple file browser
1469     bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1470 fi
1471
1472 # Finally, here are still a few hardcoded escape sequences; Special sequences
1473 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1474 # standardised and most of the time are not available in a terminals terminfo
1475 # entry.
1476 #
1477 # While we do not encourage adding bindings like these, we will keep these for
1478 # backward compatibility.
1479
1480 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1481 ## the command line.
1482 # URxvt sequences:
1483 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1484 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1485 # These are for xterm:
1486 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1487 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1488 ## the same for alt-left-arrow and alt-right-arrow
1489 # URxvt again:
1490 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1491 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1492 # Xterm again:
1493 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1494 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1495 # Also try ESC Left/Right:
1496 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1497 bind2maps emacs viins vicmd -- -s '\e'${key[Left]}  backward-word
1498
1499 # autoloading
1500
1501 zrcautoload zmv
1502 zrcautoload zed
1503
1504 # we don't want to quote/espace URLs on our own...
1505 # if autoload -U url-quote-magic ; then
1506 #    zle -N self-insert url-quote-magic
1507 #    zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1508 # else
1509 #    print 'Notice: no url-quote-magic available :('
1510 # fi
1511 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1512
1513 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1514 alias run-help >&/dev/null && unalias run-help
1515 for rh in run-help{,-git,-svk,-svn}; do
1516     zrcautoload $rh
1517 done; unset rh
1518
1519 # command not found handling
1520
1521 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1522 function command_not_found_handler() {
1523     emulate -L zsh
1524     if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1525         ${GRML_ZSH_CNF_HANDLER} $1
1526     fi
1527     return 1
1528 }
1529
1530 # history
1531
1532 ZSHDIR=${ZDOTDIR:-${HOME}/.zsh}
1533
1534 #v#
1535 HISTFILE=${ZDOTDIR:-${HOME}}/.zsh_history
1536 isgrmlcd && HISTSIZE=500  || HISTSIZE=5000
1537 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1538
1539 # dirstack handling
1540
1541 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1542 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1543
1544 if [[ -f ${DIRSTACKFILE} ]] && [[ ${#dirstack[*]} -eq 0 ]] ; then
1545     dirstack=( ${(f)"$(< $DIRSTACKFILE)"} )
1546     # "cd -" won't work after login by just setting $OLDPWD, so
1547     [[ -d $dirstack[1] ]] && cd $dirstack[1] && cd $OLDPWD
1548 fi
1549
1550 chpwd() {
1551     if (( $DIRSTACKSIZE <= 0 )) || [[ -z $DIRSTACKFILE ]]; then return; fi
1552     local -ax my_stack
1553     my_stack=( ${PWD} ${dirstack} )
1554     if is42 ; then
1555         builtin print -l ${(u)my_stack} >! ${DIRSTACKFILE}
1556     else
1557         uprint my_stack >! ${DIRSTACKFILE}
1558     fi
1559 }
1560
1561 # directory based profiles
1562
1563 if is433 ; then
1564
1565 # chpwd_profiles(): Directory Profiles, Quickstart:
1566 #
1567 # In .zshrc.local:
1568 #
1569 #   zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)'   profile grml
1570 #   zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1571 #   chpwd_profiles
1572 #
1573 # For details see the `grmlzshrc.5' manual page.
1574 function chpwd_profiles() {
1575     local profile context
1576     local -i reexecute
1577
1578     context=":chpwd:profiles:$PWD"
1579     zstyle -s "$context" profile profile || profile='default'
1580     zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1581
1582     if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1583         typeset -g CHPWD_PROFILE
1584         local CHPWD_PROFILES_INIT=1
1585         (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1586     elif [[ $profile != $CHPWD_PROFILE ]]; then
1587         (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1588             && chpwd_leave_profile_${CHPWD_PROFILE}
1589     fi
1590     if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1591         (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1592     fi
1593
1594     CHPWD_PROFILE="${profile}"
1595     return 0
1596 }
1597
1598 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1599
1600 fi # is433
1601
1602 # Prompt setup for grml:
1603
1604 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1605 # in prompts to get a red "foo" embedded, but it's good to keep these for
1606 # backwards compatibility).
1607 if is437; then
1608     BLUE="%F{blue}"
1609     RED="%F{red}"
1610     GREEN="%F{green}"
1611     CYAN="%F{cyan}"
1612     MAGENTA="%F{magenta}"
1613     YELLOW="%F{yellow}"
1614     WHITE="%F{white}"
1615     NO_COLOR="%f"
1616 elif zrcautoload colors && colors 2>/dev/null ; then
1617     BLUE="%{${fg[blue]}%}"
1618     RED="%{${fg_bold[red]}%}"
1619     GREEN="%{${fg[green]}%}"
1620     CYAN="%{${fg[cyan]}%}"
1621     MAGENTA="%{${fg[magenta]}%}"
1622     YELLOW="%{${fg[yellow]}%}"
1623     WHITE="%{${fg[white]}%}"
1624     NO_COLOR="%{${reset_color}%}"
1625 else
1626     BLUE=$'%{\e[1;34m%}'
1627     RED=$'%{\e[1;31m%}'
1628     GREEN=$'%{\e[1;32m%}'
1629     CYAN=$'%{\e[1;36m%}'
1630     WHITE=$'%{\e[1;37m%}'
1631     MAGENTA=$'%{\e[1;35m%}'
1632     YELLOW=$'%{\e[1;33m%}'
1633     NO_COLOR=$'%{\e[0m%}'
1634 fi
1635
1636 # First, the easy ones: PS2..4:
1637
1638 # secondary prompt, printed when the shell needs more information to complete a
1639 # command.
1640 PS2='\`%_> '
1641 # selection prompt used within a select loop.
1642 PS3='?# '
1643 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1644 PS4='+%N:%i:%_> '
1645
1646 # Some additional features to use with our prompt:
1647 #
1648 #    - battery status
1649 #    - debian_chroot
1650 #    - vcs_info setup and version specific fixes
1651
1652 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1653 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1654     if ! islinux && ! isopenbsd ; then
1655         # not yet supported
1656         GRML_DISPLAY_BATTERY=0
1657     fi
1658 fi
1659
1660 battery() {
1661 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1662     if islinux ; then
1663         batterylinux
1664     elif isopenbsd ; then
1665         batteryopenbsd
1666     fi
1667 fi
1668 }
1669
1670 batterylinux(){
1671 GRML_BATTERY_LEVEL=''
1672 local batteries bat capacity
1673 batteries=( /sys/class/power_supply/BAT*(N) )
1674 if (( $#batteries > 0 )) ; then
1675     for bat in $batteries ; do
1676         capacity=$(< $bat/capacity)
1677         case $(< $bat/status) in
1678         Charging)
1679             GRML_BATTERY_LEVEL+=" ^"
1680             ;;
1681         Discharging)
1682             if (( capacity < 20 )) ; then
1683                 GRML_BATTERY_LEVEL+=" !v"
1684             else
1685                 GRML_BATTERY_LEVEL+=" v"
1686             fi
1687             ;;
1688         *) # Full, Unknown
1689             GRML_BATTERY_LEVEL+=" ="
1690             ;;
1691         esac
1692         GRML_BATTERY_LEVEL+="${capacity}%%"
1693     done
1694 fi
1695 }
1696
1697 batteryopenbsd(){
1698 GRML_BATTERY_LEVEL=''
1699 local batfull batwarn batnow num
1700 for num in 0 1 ; do
1701     bat=$(sysctl -n hw.sensors.acpibat${num})
1702     if [[ ! -z $bat ]]; then
1703         batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1704         batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1705         batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1706         case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1707             *" discharging"*)
1708                 if (( batnow < batwarn )) ; then
1709                     GRML_BATTERY_LEVEL+=" !v"
1710                 else
1711                     GRML_BATTERY_LEVEL+=" v"
1712                 fi
1713                 ;;
1714             *" charging"*)
1715                 GRML_BATTERY_LEVEL+=" ^"
1716                 ;;
1717             *)
1718                 GRML_BATTERY_LEVEL+=" ="
1719                 ;;
1720         esac
1721         GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1722     fi
1723 done
1724 }
1725
1726 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1727 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1728     debian_chroot=$(</etc/debian_chroot)
1729 fi
1730
1731 # gather version control information for inclusion in a prompt
1732
1733 if zrcautoload vcs_info; then
1734     # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1735     # function, which can cause a lot of trouble with our directory-based
1736     # profiles. So:
1737     if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1738         function VCS_INFO_realpath () {
1739             setopt localoptions NO_shwordsplit chaselinks
1740             ( builtin cd -q $1 2> /dev/null && pwd; )
1741         }
1742     fi
1743
1744     zstyle ':vcs_info:*' max-exports 2
1745
1746     if [[ -o restricted ]]; then
1747         zstyle ':vcs_info:*' enable NONE
1748     fi
1749 fi
1750
1751 typeset -A grml_vcs_coloured_formats
1752 typeset -A grml_vcs_plain_formats
1753
1754 grml_vcs_plain_formats=(
1755     format "(%s%)-[%b] "    "zsh: %r"
1756     actionformat "(%s%)-[%b|%a] " "zsh: %r"
1757     rev-branchformat "%b:%r"
1758 )
1759
1760 grml_vcs_coloured_formats=(
1761     format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1762     actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1763     rev-branchformat "%b${RED}:${YELLOW}%r"
1764 )
1765
1766 typeset GRML_VCS_COLOUR_MODE=xxx
1767
1768 grml_vcs_info_toggle_colour () {
1769     emulate -L zsh
1770     if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
1771         grml_vcs_info_set_formats coloured
1772     else
1773         grml_vcs_info_set_formats plain
1774     fi
1775     return 0
1776 }
1777
1778 grml_vcs_info_set_formats () {
1779     emulate -L zsh
1780     #setopt localoptions xtrace
1781     local mode=$1 AF F BF
1782     if [[ $mode == coloured ]]; then
1783         AF=${grml_vcs_coloured_formats[actionformat]}
1784         F=${grml_vcs_coloured_formats[format]}
1785         BF=${grml_vcs_coloured_formats[rev-branchformat]}
1786         GRML_VCS_COLOUR_MODE=coloured
1787     else
1788         AF=${grml_vcs_plain_formats[actionformat]}
1789         F=${grml_vcs_plain_formats[format]}
1790         BF=${grml_vcs_plain_formats[rev-branchformat]}
1791         GRML_VCS_COLOUR_MODE=plain
1792     fi
1793
1794     zstyle ':vcs_info:*'              actionformats "$AF" "zsh: %r"
1795     zstyle ':vcs_info:*'              formats       "$F"  "zsh: %r"
1796     zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat  "$BF"
1797     return 0
1798 }
1799
1800 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1801 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1802 if [[ "$TERM" == dumb ]] ; then
1803     grml_vcs_info_set_formats plain
1804 else
1805     grml_vcs_info_set_formats coloured
1806 fi
1807
1808 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
1809
1810 # This actually defines three prompts:
1811 #
1812 #    - grml
1813 #    - grml-large
1814 #    - grml-chroot
1815 #
1816 # They all share the same code and only differ with respect to which items they
1817 # contain. The main source of documentation is the `prompt_grml_help' function
1818 # below, which gets called when the user does this: prompt -h grml
1819
1820 function prompt_grml_help () {
1821     cat <<__EOF0__
1822   prompt grml
1823
1824     This is the prompt as used by the grml-live system <http://grml.org>. It is
1825     a rather simple one-line prompt, that by default looks something like this:
1826
1827         <user>@<host> <current-working-directory>[ <vcs_info-data>]%
1828
1829     The prompt itself integrates with zsh's prompt themes system (as you are
1830     witnessing right now) and is configurable to a certain degree. In
1831     particular, these aspects are customisable:
1832
1833         - The items used in the prompt (e.g. you can remove \`user' from
1834           the list of activated items, which will cause the user name to
1835           be omitted from the prompt string).
1836
1837         - The attributes used with the items are customisable via strings
1838           used before and after the actual item.
1839
1840     The available items are: at, battery, change-root, date, grml-chroot,
1841     history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
1842     shell-level, time, user, vcs
1843
1844     The actual configuration is done via zsh's \`zstyle' mechanism. The
1845     context, that is used while looking up styles is:
1846
1847         ':prompt:grml:<left-or-right>:<subcontext>'
1848
1849     Here <left-or-right> is either \`left' or \`right', signifying whether the
1850     style should affect the left or the right prompt. <subcontext> is either
1851     \`setup' or 'items:<item>', where \`<item>' is one of the available items.
1852
1853     The styles:
1854
1855         - use-rprompt (boolean): If \`true' (the default), print a sad smiley
1856           in $RPROMPT if the last command a returned non-successful error code.
1857           (This in only valid if <left-or-right> is "right"; ignored otherwise)
1858
1859         - items (list): The list of items used in the prompt. If \`vcs' is
1860           present in the list, the theme's code invokes \`vcs_info'
1861           accordingly. Default (left): rc change-root user at host path vcs
1862           percent; Default (right): sad-smiley
1863
1864     Available styles in 'items:<item>' are: pre, post. These are strings that
1865     are inserted before (pre) and after (post) the item in question. Thus, the
1866     following would cause the user name to be printed in red instead of the
1867     default blue:
1868
1869         zstyle ':prompt:grml:*:items:user' pre '%F{red}'
1870
1871     Note, that the \`post' style may remain at its default value, because its
1872     default value is '%f', which turns the foreground text attribute off (which
1873     is exactly, what is still required with the new \`pre' value).
1874 __EOF0__
1875 }
1876
1877 function prompt_grml-chroot_help () {
1878     cat <<__EOF0__
1879   prompt grml-chroot
1880
1881     This is a variation of the grml prompt, see: prompt -h grml
1882
1883     The main difference is the default value of the \`items' style. The rest
1884     behaves exactly the same. Here are the defaults for \`grml-chroot':
1885
1886         - left: grml-chroot user at host path percent
1887         - right: (empty list)
1888 __EOF0__
1889 }
1890
1891 function prompt_grml-large_help () {
1892     cat <<__EOF0__
1893   prompt grml-large
1894
1895     This is a variation of the grml prompt, see: prompt -h grml
1896
1897     The main difference is the default value of the \`items' style. In
1898     particular, this theme uses _two_ lines instead of one with the plain
1899     \`grml' theme. The rest behaves exactly the same. Here are the defaults
1900     for \`grml-large':
1901
1902         - left: rc jobs history shell-level change-root time date newline user
1903                 at host path vcs percent
1904         - right: sad-smiley
1905 __EOF0__
1906 }
1907
1908 function grml_prompt_setup () {
1909     emulate -L zsh
1910     autoload -Uz vcs_info
1911     autoload -Uz add-zsh-hook
1912     add-zsh-hook precmd prompt_$1_precmd
1913 }
1914
1915 function prompt_grml_setup () {
1916     grml_prompt_setup grml
1917 }
1918
1919 function prompt_grml-chroot_setup () {
1920     grml_prompt_setup grml-chroot
1921 }
1922
1923 function prompt_grml-large_setup () {
1924     grml_prompt_setup grml-large
1925 }
1926
1927 # These maps define default tokens and pre-/post-decoration for items to be
1928 # used within the themes. All defaults may be customised in a context sensitive
1929 # matter by using zsh's `zstyle' mechanism.
1930 typeset -gA grml_prompt_pre_default \
1931             grml_prompt_post_default \
1932             grml_prompt_token_default \
1933             grml_prompt_token_function
1934
1935 grml_prompt_pre_default=(
1936     at                ''
1937     battery           ' '
1938     change-root       ''
1939     date              '%F{blue}'
1940     grml-chroot       '%F{red}'
1941     history           '%F{green}'
1942     host              ''
1943     jobs              '%F{cyan}'
1944     newline           ''
1945     path              '%B'
1946     percent           ''
1947     rc                '%B%F{red}'
1948     rc-always         ''
1949     sad-smiley        ''
1950     shell-level       '%F{red}'
1951     time              '%F{blue}'
1952     user              '%B%F{blue}'
1953     vcs               ''
1954 )
1955
1956 grml_prompt_post_default=(
1957     at                ''
1958     battery           ''
1959     change-root       ''
1960     date              '%f'
1961     grml-chroot       '%f '
1962     history           '%f'
1963     host              ''
1964     jobs              '%f'
1965     newline           ''
1966     path              '%b'
1967     percent           ''
1968     rc                '%f%b'
1969     rc-always         ''
1970     sad-smiley        ''
1971     shell-level       '%f'
1972     time              '%f'
1973     user              '%f%b'
1974     vcs               ''
1975 )
1976
1977 grml_prompt_token_default=(
1978     at                '@'
1979     battery           'GRML_BATTERY_LEVEL'
1980     change-root       'debian_chroot'
1981     date              '%D{%Y-%m-%d}'
1982     grml-chroot       'GRML_CHROOT'
1983     history           '{history#%!} '
1984     host              '%m '
1985     jobs              '[%j running job(s)] '
1986     newline           $'\n'
1987     path              '%40<..<%~%<< '
1988     percent           '%# '
1989     rc                '%(?..%? )'
1990     rc-always         '%?'
1991     sad-smiley        '%(?..:()'
1992     shell-level       '%(3L.+ .)'
1993     time              '%D{%H:%M:%S} '
1994     user              '%n'
1995     vcs               '0'
1996 )
1997
1998 function grml_theme_has_token () {
1999     if (( ARGC != 1 )); then
2000         printf 'usage: grml_theme_has_token <name>\n'
2001         return 1
2002     fi
2003     (( ${+grml_prompt_token_default[$1]} ))
2004 }
2005
2006 function GRML_theme_add_token_usage () {
2007     cat <<__EOF__
2008   Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2009
2010     <name> is the name for the newly added token. If the \`-f' or \`-i' options
2011     are used, <token/function> is the name of the function (see below for
2012     details). Otherwise it is the literal token string to be used. <pre> and
2013     <post> are optional.
2014
2015   Options:
2016
2017     -f <function>   Use a function named \`<function>' each time the token
2018                     is to be expanded.
2019
2020     -i <function>   Use a function named \`<function>' to initialise the
2021                     value of the token _once_ at runtime.
2022
2023     The functions are called with one argument: the token's new name. The
2024     return value is expected in the \$REPLY parameter. The use of these
2025     options is mutually exclusive.
2026
2027     There is a utility function \`grml_theme_has_token', which you can use
2028     to test if a token exists before trying to add it. This can be a guard
2029     for situations in which a \`grml_theme_add_token' call may happen more
2030     than once.
2031
2032   Example:
2033
2034     To add a new token \`day' that expands to the current weekday in the
2035     current locale in green foreground colour, use this:
2036
2037       grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2038
2039     Another example would be support for \$VIRTUAL_ENV:
2040
2041       function virtual_env_prompt () {
2042         REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2043       }
2044       grml_theme_add_token virtual-env -f virtual_env_prompt
2045
2046     After that, you will be able to use a changed \`items' style to
2047     assemble your prompt.
2048 __EOF__
2049 }
2050
2051 function grml_theme_add_token () {
2052     emulate -L zsh
2053     local name token pre post
2054     local -i init funcall
2055
2056     if (( ARGC == 0 )); then
2057         GRML_theme_add_token_usage
2058         return 0
2059     fi
2060
2061     init=0
2062     funcall=0
2063     pre=''
2064     post=''
2065     name=$1
2066     shift
2067     if [[ $1 == '-f' ]]; then
2068         funcall=1
2069         shift
2070     elif [[ $1 == '-i' ]]; then
2071         init=1
2072         shift
2073     fi
2074
2075     if (( ARGC == 0 )); then
2076         printf '
2077 grml_theme_add_token: No token-string/function-name provided!\n\n'
2078         GRML_theme_add_token_usage
2079         return 1
2080     fi
2081     token=$1
2082     shift
2083     if (( ARGC != 0 && ARGC != 2 )); then
2084         printf '
2085 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2086         GRML_theme_add_token_usage
2087         return 1
2088     fi
2089     if (( ARGC )); then
2090         pre=$1
2091         post=$2
2092         shift 2
2093     fi
2094
2095     if grml_theme_has_token $name; then
2096         printf '
2097 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2098         GRML_theme_add_token_usage
2099         return 2
2100     fi
2101     if (( init )); then
2102         $token $name
2103         token=$REPLY
2104     fi
2105     grml_prompt_pre_default[$name]=$pre
2106     grml_prompt_post_default[$name]=$post
2107     if (( funcall )); then
2108         grml_prompt_token_function[$name]=$token
2109         grml_prompt_token_default[$name]=23
2110     else
2111         grml_prompt_token_default[$name]=$token
2112     fi
2113 }
2114
2115 function grml_typeset_and_wrap () {
2116     emulate -L zsh
2117     local target="$1"
2118     local new="$2"
2119     local left="$3"
2120     local right="$4"
2121
2122     if (( ${+parameters[$new]} )); then
2123         typeset -g "${target}=${(P)target}${left}${(P)new}${right}"
2124     fi
2125 }
2126
2127 function grml_prompt_addto () {
2128     emulate -L zsh
2129     local target="$1"
2130     local lr it apre apost new v
2131     local -a items
2132     shift
2133
2134     [[ $target == PS1 ]] && lr=left || lr=right
2135     zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2136     typeset -g "${target}="
2137     for it in "${items[@]}"; do
2138         zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2139             || apre=${grml_prompt_pre_default[$it]}
2140         zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2141             || apost=${grml_prompt_post_default[$it]}
2142         zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2143             || new=${grml_prompt_token_default[$it]}
2144         typeset -g "${target}=${(P)target}${apre}"
2145         if (( ${+grml_prompt_token_function[$it]} )); then
2146             ${grml_prompt_token_function[$it]} $it
2147             typeset -g "${target}=${(P)target}${REPLY}"
2148         else
2149             case $it in
2150             battery)
2151                 grml_typeset_and_wrap $target $new '' ''
2152                 ;;
2153             change-root)
2154                 grml_typeset_and_wrap $target $new '(' ')'
2155                 ;;
2156             grml-chroot)
2157                 if [[ -n ${(P)new} ]]; then
2158                     typeset -g "${target}=${(P)target}(CHROOT)"
2159                 fi
2160                 ;;
2161             vcs)
2162                 v="vcs_info_msg_${new}_"
2163                 if (( ! vcscalled )); then
2164                     vcs_info
2165                     vcscalled=1
2166                 fi
2167                 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2168                     typeset -g "${target}=${(P)target}${(P)v}"
2169                 fi
2170                 ;;
2171             *) typeset -g "${target}=${(P)target}${new}" ;;
2172             esac
2173         fi
2174         typeset -g "${target}=${(P)target}${apost}"
2175     done
2176 }
2177
2178 function prompt_grml_precmd () {
2179     emulate -L zsh
2180     local grmltheme=grml
2181     local -a left_items right_items
2182     left_items=(rc change-root user at host path vcs percent)
2183     right_items=(sad-smiley)
2184
2185     prompt_grml_precmd_worker
2186 }
2187
2188 function prompt_grml-chroot_precmd () {
2189     emulate -L zsh
2190     local grmltheme=grml-chroot
2191     local -a left_items right_items
2192     left_items=(grml-chroot user at host path percent)
2193     right_items=()
2194
2195     prompt_grml_precmd_worker
2196 }
2197
2198 function prompt_grml-large_precmd () {
2199     emulate -L zsh
2200     local grmltheme=grml-large
2201     local -a left_items right_items
2202     left_items=(rc jobs history shell-level change-root time date newline
2203                 user at host path vcs percent)
2204     right_items=(sad-smiley)
2205
2206     prompt_grml_precmd_worker
2207 }
2208
2209 function prompt_grml_precmd_worker () {
2210     emulate -L zsh
2211     local -i vcscalled=0
2212
2213     grml_prompt_addto PS1 "${left_items[@]}"
2214     if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2215         grml_prompt_addto RPS1 "${right_items[@]}"
2216     fi
2217 }
2218
2219 grml_prompt_fallback() {
2220     setopt prompt_subst
2221     precmd() {
2222         (( ${+functions[vcs_info]} )) && vcs_info
2223     }
2224
2225     p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2226     p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2227     if (( EUID == 0 )); then
2228         PROMPT="${BLUE}${p0}${RED}${p1}"
2229     else
2230         PROMPT="${RED}${p0}${BLUE}${p1}"
2231     fi
2232     unset p0 p1
2233 }
2234
2235 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2236     # Since we define the required functions in here and not in files in
2237     # $fpath, we need to stick the theme's name into `$prompt_themes'
2238     # ourselves, since promptinit does not pick them up otherwise.
2239     prompt_themes+=( grml grml-chroot grml-large )
2240     # Also, keep the array sorted...
2241     prompt_themes=( "${(@on)prompt_themes}" )
2242 else
2243     print 'Notice: no promptinit available :('
2244     grml_prompt_fallback
2245 fi
2246
2247 if is437; then
2248     # The prompt themes use modern features of zsh, that require at least
2249     # version 4.3.7 of the shell. Use the fallback otherwise.
2250     if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2251         zstyle ':prompt:grml:right:setup' items sad-smiley battery
2252         add-zsh-hook precmd battery
2253     fi
2254     if [[ "$TERM" == dumb ]] ; then
2255         zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2256         zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2257         for i in rc user path jobs history date time shell-level; do
2258             zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2259             zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2260         done
2261         unset i
2262         zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2263     elif (( EUID == 0 )); then
2264         zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2265     fi
2266
2267     # Finally enable one of the prompts.
2268     if [[ -n $GRML_CHROOT ]]; then
2269         prompt grml-chroot
2270     elif [[ $GRMLPROMPT -gt 0 ]]; then
2271         prompt grml-large
2272     else
2273         prompt grml
2274     fi
2275 else
2276     grml_prompt_fallback
2277 fi
2278
2279 # Terminal-title wizardry
2280
2281 function ESC_print () {
2282     info_print $'\ek' $'\e\\' "$@"
2283 }
2284 function set_title () {
2285     info_print  $'\e]0;' $'\a' "$@"
2286 }
2287
2288 function info_print () {
2289     local esc_begin esc_end
2290     esc_begin="$1"
2291     esc_end="$2"
2292     shift 2
2293     printf '%s' ${esc_begin}
2294     printf '%s' "$*"
2295     printf '%s' "${esc_end}"
2296 }
2297
2298 function grml_reset_screen_title () {
2299     # adjust title of xterm
2300     # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2301     [[ ${NOTITLE:-} -gt 0 ]] && return 0
2302     case $TERM in
2303         (xterm*|rxvt*)
2304             set_title ${(%):-"%n@%m: %~"}
2305             ;;
2306     esac
2307 }
2308
2309 function grml_vcs_to_screen_title () {
2310     if [[ $TERM == screen* ]] ; then
2311         if [[ -n ${vcs_info_msg_1_} ]] ; then
2312             ESC_print ${vcs_info_msg_1_}
2313         else
2314             ESC_print "zsh"
2315         fi
2316     fi
2317 }
2318
2319 function grml_maintain_name () {
2320     # set hostname if not running on host with name 'grml'
2321     if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
2322        NAME="@$HOSTNAME"
2323     fi
2324 }
2325
2326 function grml_cmd_to_screen_title () {
2327     # get the name of the program currently running and hostname of local
2328     # machine set screen window title if running in a screen
2329     if [[ "$TERM" == screen* ]] ; then
2330         local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2331         ESC_print ${CMD}
2332     fi
2333 }
2334
2335 function grml_control_xterm_title () {
2336     case $TERM in
2337         (xterm*|rxvt*)
2338             set_title "${(%):-"%n@%m:"}" "$1"
2339             ;;
2340     esac
2341 }
2342
2343 zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2344 if [[ $NOPRECMD -eq 0 ]]; then
2345     add-zsh-hook precmd grml_reset_screen_title
2346     add-zsh-hook precmd grml_vcs_to_screen_title
2347     add-zsh-hook preexec grml_maintain_name
2348     add-zsh-hook preexec grml_cmd_to_screen_title
2349     if [[ $NOTITLE -eq 0 ]]; then
2350         add-zsh-hook preexec grml_control_xterm_title
2351     fi
2352 fi
2353
2354 # 'hash' some often used directories
2355 #d# start
2356 hash -d deb=/var/cache/apt/archives
2357 hash -d doc=/usr/share/doc
2358 hash -d linux=/lib/modules/$(command uname -r)/build/
2359 hash -d log=/var/log
2360 hash -d slog=/var/log/syslog
2361 hash -d src=/usr/src
2362 hash -d templ=/usr/share/doc/grml-templates
2363 hash -d tt=/usr/share/doc/texttools-doc
2364 hash -d www=/var/www
2365 #d# end
2366
2367 # some aliases
2368 if check_com -c screen ; then
2369     if [[ $UID -eq 0 ]] ; then
2370         if [[ -r /etc/grml/screenrc ]]; then
2371             alias screen="${commands[screen]} -c /etc/grml/screenrc"
2372         fi
2373     elif [[ -r $HOME/.screenrc ]] ; then
2374         alias screen="${commands[screen]} -c $HOME/.screenrc"
2375     else
2376         if [[ -r /etc/grml/screenrc_grml ]]; then
2377             alias screen="${commands[screen]} -c /etc/grml/screenrc_grml"
2378         else
2379             if [[ -r /etc/grml/screenrc ]]; then
2380                 alias screen="${commands[screen]} -c /etc/grml/screenrc"
2381             fi
2382         fi
2383     fi
2384 fi
2385
2386 # do we have GNU ls with color-support?
2387 if [[ "$TERM" != dumb ]]; then
2388     #a1# List files with colors (\kbd{ls -F \ldots})
2389     alias ls='ls -F '${ls_options:+"${ls_options[*]}"}
2390     #a1# List all files, with colors (\kbd{ls -la \ldots})
2391     alias la='ls -la '${ls_options:+"${ls_options[*]}"}
2392     #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2393     alias ll='ls -l '${ls_options:+"${ls_options[*]}"}
2394     #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2395     alias lh='ls -hAl '${ls_options:+"${ls_options[*]}"}
2396     #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -lF \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2397     alias l='ls -lF '${ls_options:+"${ls_options[*]}"}
2398 else
2399     alias ls='ls -F'
2400     alias la='ls -la'
2401     alias ll='ls -l'
2402     alias lh='ls -hAl'
2403     alias l='ls -lF'
2404 fi
2405
2406 alias mdstat='cat /proc/mdstat'
2407 alias ...='cd ../../'
2408
2409 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2410 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2411     alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2412 fi
2413
2414 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2415 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2416 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2417
2418 # make sure it is not assigned yet
2419 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2420 utf2iso() {
2421     if isutfenv ; then
2422         for ENV in $(env | command grep -i '.utf') ; do
2423             eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2424         done
2425     fi
2426 }
2427
2428 # make sure it is not assigned yet
2429 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2430 iso2utf() {
2431     if ! isutfenv ; then
2432         for ENV in $(env | command grep -i '\.iso') ; do
2433             eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2434         done
2435     fi
2436 }
2437
2438 # especially for roadwarriors using GNU screen and ssh:
2439 if ! check_com asc &>/dev/null ; then
2440   asc() { autossh -t "$@" 'screen -RdU' }
2441   compdef asc=ssh
2442 fi
2443
2444 #f1# Hints for the use of zsh on grml
2445 zsh-help() {
2446     print "$bg[white]$fg[black]
2447 zsh-help - hints for use of zsh on grml
2448 =======================================$reset_color"
2449
2450     print '
2451 Main configuration of zsh happens in /etc/zsh/zshrc.
2452 That file is part of the package grml-etc-core, if you want to
2453 use them on a non-grml-system just get the tar.gz from
2454 http://deb.grml.org/ or (preferably) get it from the git repository:
2455
2456   http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2457
2458 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2459 The file is still there, but it is empty for backwards compatibility.
2460
2461 For your own changes use these two files:
2462     $HOME/.zshrc.pre
2463     $HOME/.zshrc.local
2464
2465 The former is sourced very early in our zshrc, the latter is sourced
2466 very lately.
2467
2468 System wide configuration without touching configuration files of grml
2469 can take place in /etc/zsh/zshrc.local.
2470
2471 For information regarding zsh start at http://grml.org/zsh/
2472
2473 Take a look at grml'\''s zsh refcard:
2474 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2475
2476 Check out the main zsh refcard:
2477 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2478
2479 And of course visit the zsh-lovers:
2480 % man zsh-lovers
2481
2482 You can adjust some options through environment variables when
2483 invoking zsh without having to edit configuration files.
2484 Basically meant for bash users who are not used to the power of
2485 the zsh yet. :)
2486
2487   "NOCOR=1    zsh" => deactivate automatic correction
2488   "NOMENU=1   zsh" => do not use auto menu completion
2489                       (note: use ctrl-d for completion instead!)
2490   "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2491   "NOTITLE=1  zsh" => disable setting the title of xterms without disabling
2492                       preexec() and precmd() completely
2493   "GRML_DISPLAY_BATTERY=1  zsh"
2494                    => activate battery status on right side of prompt (WIP)
2495   "COMMAND_NOT_FOUND=1 zsh"
2496                    => Enable a handler if an external command was not found
2497                       The command called in the handler can be altered by setting
2498                       the GRML_ZSH_CNF_HANDLER variable, the default is:
2499                       "/usr/share/command-not-found/command-not-found"
2500
2501 A value greater than 0 is enables a feature; a value equal to zero
2502 disables it. If you like one or the other of these settings, you can
2503 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2504 zshrc.'
2505
2506     print "
2507 $bg[white]$fg[black]
2508 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2509 Enjoy your grml system with the zsh!$reset_color"
2510 }
2511
2512 # debian stuff
2513 if [[ -r /etc/debian_version ]] ; then
2514     #a3# Execute \kbd{apt-cache search}
2515     alias acs='apt-cache search'
2516     #a3# Execute \kbd{apt-cache show}
2517     alias acsh='apt-cache show'
2518     #a3# Execute \kbd{apt-cache policy}
2519     alias acp='apt-cache policy'
2520     #a3# Execute \kbd{apt-get dist-upgrade}
2521     salias adg="apt-get dist-upgrade"
2522     #a3# Execute \kbd{apt-get install}
2523     salias agi="apt-get install"
2524     #a3# Execute \kbd{aptitude install}
2525     salias ati="aptitude install"
2526     #a3# Execute \kbd{apt-get upgrade}
2527     salias ag="apt-get upgrade"
2528     #a3# Execute \kbd{apt-get update}
2529     salias au="apt-get update"
2530     #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2531     salias -a up="aptitude update ; aptitude safe-upgrade"
2532     #a3# Execute \kbd{dpkg-buildpackage}
2533     alias dbp='dpkg-buildpackage'
2534     #a3# Execute \kbd{grep-excuses}
2535     alias ge='grep-excuses'
2536
2537     # get a root shell as normal user in live-cd mode:
2538     if isgrmlcd && [[ $UID -ne 0 ]] ; then
2539        alias su="sudo su"
2540      fi
2541
2542     #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
2543     salias llog="$PAGER /var/log/syslog"     # take a look at the syslog
2544     #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
2545     salias tlog="tail -f /var/log/syslog"    # follow the syslog
2546 fi
2547
2548 # sort installed Debian-packages by size
2549 if check_com -c dpkg-query ; then
2550     #a3# List installed Debian-packages sorted by size
2551     alias debs-by-size="dpkg-query -Wf 'x \${Installed-Size} \${Package} \${Status}\n' | sed -ne '/^x  /d' -e '/^x \(.*\) install ok installed$/s//\1/p' | sort -nr"
2552 fi
2553
2554 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2555 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2556     if check_com -c wodim; then
2557         cdrecord() {
2558             cat <<EOMESS
2559 cdrecord is not provided under its original name by Debian anymore.
2560 See #377109 in the BTS of Debian for more details.
2561
2562 Please use the wodim binary instead
2563 EOMESS
2564             return 1
2565         }
2566     fi
2567 fi
2568
2569 # Use hard limits, except for a smaller stack and no core dumps
2570 unlimit
2571 is425 && limit stack 8192
2572 isgrmlcd && limit core 0 # important for a live-cd-system
2573 limit -s
2574
2575 # grmlstuff
2576 grmlstuff() {
2577 # people should use 'grml-x'!
2578     if check_com -c 915resolution; then
2579         855resolution() {
2580             echo "Please use 915resolution as resolution modifying tool for Intel \
2581 graphic chipset."
2582             return -1
2583         }
2584     fi
2585
2586     #a1# Output version of running grml
2587     alias grml-version='cat /etc/grml_version'
2588
2589     if check_com -c grml-debootstrap ; then
2590         debian2hd() {
2591             echo "Installing debian to harddisk is possible by using grml-debootstrap."
2592             return 1
2593         }
2594     fi
2595 }
2596
2597 # now run the functions
2598 isgrml && checkhome
2599 is4    && isgrml    && grmlstuff
2600 is4    && grmlcomp
2601
2602 # keephack
2603 is4 && xsource "/etc/zsh/keephack"
2604
2605 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2606 # You use it as follows:
2607 # $ NTREF=/reference/file
2608 # $ ls -l *(e:nt:)
2609 # This lists all the files in the current directory newer than the reference file.
2610 # You can also specify the reference file inline; note quotes:
2611 # $ ls -l *(e:'nt ~/.zshenv':)
2612 is4 && nt() {
2613     if [[ -n $1 ]] ; then
2614         local NTREF=${~1}
2615     fi
2616     [[ $REPLY -nt $NTREF ]]
2617 }
2618
2619 # shell functions
2620
2621 #f1# Reload an autoloadable function
2622 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2623 compdef _functions freload
2624
2625 #f1# List symlinks in detail (more detailed version of 'readlink -f' and 'whence -s')
2626 sll() {
2627     [[ -z "$1" ]] && printf 'Usage: %s <file(s)>\n' "$0" && return 1
2628     local file
2629     for file in "$@" ; do
2630         while [[ -h "$file" ]] ; do
2631             ls -l $file
2632             file=$(readlink "$file")
2633         done
2634     done
2635 }
2636
2637 # TODO: Is it supported to use pager settings like this?
2638 #   PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
2639 # with respect to wordsplitting. (ie. ${=PAGER})
2640 if check_com -c $PAGER ; then
2641     #f3# View Debian's changelog of given package(s)
2642     dchange() {
2643         emulate -L zsh
2644         [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
2645
2646         local package
2647         for package in "$@" ; do
2648             if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
2649                 $PAGER /usr/share/doc/${package}/changelog.Debian.gz
2650             elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
2651                 $PAGER /usr/share/doc/${package}/changelog.gz
2652             elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
2653                 $PAGER /usr/share/doc/${package}/changelog
2654             else
2655                 if check_com -c aptitude ; then
2656                     echo "No changelog for package $package found, using aptitude to retrieve it."
2657                     aptitude changelog "$package"
2658                 elif check_com -c apt-get ; then
2659                     echo "No changelog for package $package found, using apt-get to retrieve it."
2660                     apt-get changelog "$package"
2661                 else
2662                     echo "No changelog for package $package found, sorry."
2663                 fi
2664             fi
2665         done
2666     }
2667     _dchange() { _files -W /usr/share/doc -/ }
2668     compdef _dchange dchange
2669
2670     #f3# View Debian's NEWS of a given package
2671     dnews() {
2672         emulate -L zsh
2673         if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
2674             $PAGER /usr/share/doc/$1/NEWS.Debian.gz
2675         else
2676             if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
2677                 $PAGER /usr/share/doc/$1/NEWS.gz
2678             else
2679                 echo "No NEWS file for package $1 found, sorry."
2680                 return 1
2681             fi
2682         fi
2683     }
2684     _dnews() { _files -W /usr/share/doc -/ }
2685     compdef _dnews dnews
2686
2687     #f3# View Debian's copyright of a given package
2688     dcopyright() {
2689         emulate -L zsh
2690         if [[ -r /usr/share/doc/$1/copyright ]] ; then
2691             $PAGER /usr/share/doc/$1/copyright
2692         else
2693             echo "No copyright file for package $1 found, sorry."
2694             return 1
2695         fi
2696     }
2697     _dcopyright() { _files -W /usr/share/doc -/ }
2698     compdef _dcopyright dcopyright
2699
2700     #f3# View upstream's changelog of a given package
2701     uchange() {
2702         emulate -L zsh
2703         if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2704             $PAGER /usr/share/doc/$1/changelog.gz
2705         else
2706             echo "No changelog for package $1 found, sorry."
2707             return 1
2708         fi
2709     }
2710     _uchange() { _files -W /usr/share/doc -/ }
2711     compdef _uchange uchange
2712 fi
2713
2714 # zsh profiling
2715 profile() {
2716     ZSH_PROFILE_RC=1 $SHELL "$@"
2717 }
2718
2719 #f1# Edit an alias via zle
2720 edalias() {
2721     [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2722 }
2723 compdef _aliases edalias
2724
2725 #f1# Edit a function via zle
2726 edfunc() {
2727     [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
2728 }
2729 compdef _functions edfunc
2730
2731 # use it e.g. via 'Restart apache2'
2732 #m# f6 Start() \kbd{/etc/init.d/\em{process}}\quad\kbd{start}
2733 #m# f6 Restart() \kbd{/etc/init.d/\em{process}}\quad\kbd{restart}
2734 #m# f6 Stop() \kbd{/etc/init.d/\em{process}}\quad\kbd{stop}
2735 #m# f6 Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{reload}
2736 #m# f6 Force-Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{force-reload}
2737 #m# f6 Status() \kbd{/etc/init.d/\em{process}}\quad\kbd{status}
2738 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2739     __start_stop() {
2740         local action_="${1:l}"  # e.g Start/Stop/Restart
2741         local service_="$2"
2742         local param_="$3"
2743
2744         local service_target_="$(readlink /etc/init.d/$service_)"
2745         if [[ $service_target_ == "/usr/bin/sv" ]]; then
2746             # runit
2747             case "${action_}" in
2748                 start) if [[ ! -e /etc/service/$service_ ]]; then
2749                            $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2750                        else
2751                            $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2752                        fi ;;
2753                 # there is no reload in runits sysv emulation
2754                 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2755                 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2756             esac
2757         else
2758             # sysvinit
2759             $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2760         fi
2761     }
2762
2763     _grmlinitd() {
2764         local -a scripts
2765         scripts=( /etc/init.d/*(x:t) )
2766         _describe "service startup script" scripts
2767     }
2768
2769     for i in Start Restart Stop Force-Reload Reload Status ; do
2770         eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
2771         compdef _grmlinitd $i
2772     done
2773 fi
2774
2775 #f1# Provides useful information on globbing
2776 H-Glob() {
2777     echo -e "
2778     /      directories
2779     .      plain files
2780     @      symbolic links
2781     =      sockets
2782     p      named pipes (FIFOs)
2783     *      executable plain files (0100)
2784     %      device files (character or block special)
2785     %b     block special files
2786     %c     character special files
2787     r      owner-readable files (0400)
2788     w      owner-writable files (0200)
2789     x      owner-executable files (0100)
2790     A      group-readable files (0040)
2791     I      group-writable files (0020)
2792     E      group-executable files (0010)
2793     R      world-readable files (0004)
2794     W      world-writable files (0002)
2795     X      world-executable files (0001)
2796     s      setuid files (04000)
2797     S      setgid files (02000)
2798     t      files with the sticky bit (01000)
2799
2800   print *(m-1)          # Files modified up to a day ago
2801   print *(a1)           # Files accessed a day ago
2802   print *(@)            # Just symlinks
2803   print *(Lk+50)        # Files bigger than 50 kilobytes
2804   print *(Lk-50)        # Files smaller than 50 kilobytes
2805   print **/*.c          # All *.c files recursively starting in \$PWD
2806   print **/*.c~file.c   # Same as above, but excluding 'file.c'
2807   print (foo|bar).*     # Files starting with 'foo' or 'bar'
2808   print *~*.*           # All Files that do not contain a dot
2809   chmod 644 *(.^x)      # make all plain non-executable files publically readable
2810   print -l *(.c|.h)     # Lists *.c and *.h
2811   print **/*(g:users:)  # Recursively match all files that are owned by group 'users'
2812   echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
2813 }
2814 alias help-zshglob=H-Glob
2815
2816 # grep for running process, like: 'any vim'
2817 any() {
2818     emulate -L zsh
2819     unsetopt KSH_ARRAYS
2820     if [[ -z "$1" ]] ; then
2821         echo "any - grep for process(es) by keyword" >&2
2822         echo "Usage: any <keyword>" >&2 ; return 1
2823     else
2824         ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
2825     fi
2826 }
2827
2828
2829 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
2830 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
2831 [[ -r /proc/1/maps ]] && \
2832 deswap() {
2833     print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
2834     cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/')  > /dev/null
2835     print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
2836 }
2837
2838 # a wrapper for vim, that deals with title setting
2839 #   VIM_OPTIONS
2840 #       set this array to a set of options to vim you always want
2841 #       to have set when calling vim (in .zshrc.local), like:
2842 #           VIM_OPTIONS=( -p )
2843 #       This will cause vim to send every file given on the
2844 #       commandline to be send to it's own tab (needs vim7).
2845 if check_com vim; then
2846     vim() {
2847         VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
2848     }
2849 fi
2850
2851 ssl_hashes=( sha512 sha256 sha1 md5 )
2852
2853 for sh in ${ssl_hashes}; do
2854     eval 'ssl-cert-'${sh}'() {
2855         emulate -L zsh
2856         if [[ -z $1 ]] ; then
2857             printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
2858             return 1
2859         fi
2860         openssl x509 -noout -fingerprint -'${sh}' -in $1
2861     }'
2862 done; unset sh
2863
2864 ssl-cert-fingerprints() {
2865     emulate -L zsh
2866     local i
2867     if [[ -z $1 ]] ; then
2868         printf 'usage: ssl-cert-fingerprints <file>\n'
2869         return 1
2870     fi
2871     for i in ${ssl_hashes}
2872         do ssl-cert-$i $1;
2873     done
2874 }
2875
2876 ssl-cert-info() {
2877     emulate -L zsh
2878     if [[ -z $1 ]] ; then
2879         printf 'usage: ssl-cert-info <file>\n'
2880         return 1
2881     fi
2882     openssl x509 -noout -text -in $1
2883     ssl-cert-fingerprints $1
2884 }
2885
2886 # make sure our environment is clean regarding colors
2887 for color in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $color
2888
2889 # "persistent history"
2890 # just write important commands you always need to ~/.important_commands
2891 if [[ -r ~/.important_commands ]] ; then
2892     fc -R ~/.important_commands
2893 fi
2894
2895 # load the lookup subsystem if it's available on the system
2896 zrcautoload lookupinit && lookupinit
2897
2898 # variables
2899
2900 # set terminal property (used e.g. by msgid-chooser)
2901 export COLORTERM="yes"
2902
2903 # aliases
2904
2905 # general
2906 #a2# Execute \kbd{du -sch}
2907 alias da='du -sch'
2908 #a2# Execute \kbd{jobs -l}
2909 alias j='jobs -l'
2910
2911 # listing stuff
2912 #a2# Execute \kbd{ls -lSrah}
2913 alias dir="ls -lSrah"
2914 #a2# Only show dot-directories
2915 alias lad='ls -d .*(/)'
2916 #a2# Only show dot-files
2917 alias lsa='ls -a .*(.)'
2918 #a2# Only files with setgid/setuid/sticky flag
2919 alias lss='ls -l *(s,S,t)'
2920 #a2# Only show symlinks
2921 alias lsl='ls -l *(@)'
2922 #a2# Display only executables
2923 alias lsx='ls -l *(*)'
2924 #a2# Display world-{readable,writable,executable} files
2925 alias lsw='ls -ld *(R,W,X.^ND/)'
2926 #a2# Display the ten biggest files
2927 alias lsbig="ls -flh *(.OL[1,10])"
2928 #a2# Only show directories
2929 alias lsd='ls -d *(/)'
2930 #a2# Only show empty directories
2931 alias lse='ls -d *(/^F)'
2932 #a2# Display the ten newest files
2933 alias lsnew="ls -rtlh *(D.om[1,10])"
2934 #a2# Display the ten oldest files
2935 alias lsold="ls -rtlh *(D.Om[1,10])"
2936 #a2# Display the ten smallest files
2937 alias lssmall="ls -Srl *(.oL[1,10])"
2938 #a2# Display the ten newest directories and ten newest .directories
2939 alias lsnewdir="ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
2940 #a2# Display the ten oldest directories and ten oldest .directories
2941 alias lsolddir="ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
2942
2943 # some useful aliases
2944 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
2945 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
2946
2947 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
2948 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
2949 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
2950 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
2951
2952 # work around non utf8 capable software in utf environment via $LANG and luit
2953 if check_com isutfenv && check_com luit ; then
2954     if check_com -c mrxvt ; then
2955         isutfenv && [[ -n "$LANG" ]] && \
2956             alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
2957     fi
2958
2959     if check_com -c aterm ; then
2960         isutfenv && [[ -n "$LANG" ]] && \
2961             alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
2962     fi
2963
2964     if check_com -c centericq ; then
2965         isutfenv && [[ -n "$LANG" ]] && \
2966             alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
2967     fi
2968 fi
2969
2970 # useful functions
2971
2972 #f5# Backup \kbd{file {\rm to} file\_timestamp}
2973 bk() {
2974     emulate -L zsh
2975     cp -b $1 $1_`date --iso-8601=m`
2976 }
2977
2978 #f5# cd to directoy and list files
2979 cl() {
2980     emulate -L zsh
2981     cd $1 && ls -a
2982 }
2983
2984 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
2985 cd() {
2986     if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
2987         [[ ! -e ${1:h} ]] && return 1
2988         print "Correcting ${1} to ${1:h}"
2989         builtin cd ${1:h}
2990     else
2991         builtin cd "$@"
2992     fi
2993 }
2994
2995 #f5# Create Directoy and \kbd{cd} to it
2996 mkcd() {
2997     if (( ARGC != 1 )); then
2998         printf 'usage: mkcd <new-directory>\n'
2999         return 1;
3000     fi
3001     if [[ ! -d "$1" ]]; then
3002         command mkdir -p "$1"
3003     else
3004         printf '`%s'\'' already exists: cd-ing.\n' "$1"
3005     fi
3006     builtin cd "$1"
3007 }
3008
3009 #f5# Create temporary directory and \kbd{cd} to it
3010 cdt() {
3011     local t
3012     t=$(mktemp -d)
3013     echo "$t"
3014     builtin cd "$t"
3015 }
3016
3017 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3018 accessed() {
3019     emulate -L zsh
3020     print -l -- *(a-${1:-1})
3021 }
3022
3023 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3024 changed() {
3025     emulate -L zsh
3026     print -l -- *(c-${1:-1})
3027 }
3028
3029 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3030 modified() {
3031     emulate -L zsh
3032     print -l -- *(m-${1:-1})
3033 }
3034 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3035 check_com new || alias new=modified
3036
3037 # use colors when GNU grep with color-support
3038 if (( $#grep_options > 0 )); then
3039     o=${grep_options:+"${grep_options[*]}"}
3040     #a2# Execute \kbd{grep -{}-color=auto}
3041     alias grep='grep '$o
3042     alias egrep='egrep '$o
3043     unset o
3044 fi
3045
3046 # Translate DE<=>EN
3047 # 'translate' looks up fot a word in a file with language-to-language
3048 # translations (field separator should be " : "). A typical wordlist looks
3049 # like at follows:
3050 #  | english-word : german-transmission
3051 # It's also only possible to translate english to german but not reciprocal.
3052 # Use the following oneliner to turn back the sort order:
3053 #  $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3054 #    /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3055 #f5# Translates a word
3056 trans() {
3057     emulate -L zsh
3058     case "$1" in
3059         -[dD]*)
3060             translate -l de-en $2
3061             ;;
3062         -[eE]*)
3063             translate -l en-de $2
3064             ;;
3065         *)
3066             echo "Usage: $0 { -D | -E }"
3067             echo "         -D == German to English"
3068             echo "         -E == English to German"
3069     esac
3070 }
3071
3072 # Usage: simple-extract <file>
3073 # Using option -d deletes the original archive file.
3074 #f5# Smart archive extractor
3075 simple-extract() {
3076     emulate -L zsh
3077     setopt extended_glob noclobber
3078     local DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3079     local RC=0
3080     zparseopts -D -E "d=DELETE_ORIGINAL"
3081     for ARCHIVE in "${@}"; do
3082         case $ARCHIVE in
3083             *(tar.bz2|tbz2|tbz))
3084                 DECOMP_CMD="tar -xvjf -"
3085                 USES_STDIN=true
3086                 USES_STDOUT=false
3087                 ;;
3088             *(tar.gz|tgz))
3089                 DECOMP_CMD="tar -xvzf -"
3090                 USES_STDIN=true
3091                 USES_STDOUT=false
3092                 ;;
3093             *(tar.xz|txz|tar.lzma))
3094                 DECOMP_CMD="tar -xvJf -"
3095                 USES_STDIN=true
3096                 USES_STDOUT=false
3097                 ;;
3098             *tar)
3099                 DECOMP_CMD="tar -xvf -"
3100                 USES_STDIN=true
3101                 USES_STDOUT=false
3102                 ;;
3103             *rar)
3104                 DECOMP_CMD="unrar x"
3105                 USES_STDIN=false
3106                 USES_STDOUT=false
3107                 ;;
3108             *lzh)
3109                 DECOMP_CMD="lha x"
3110                 USES_STDIN=false
3111                 USES_STDOUT=false
3112                 ;;
3113             *7z)
3114                 DECOMP_CMD="7z x"
3115                 USES_STDIN=false
3116                 USES_STDOUT=false
3117                 ;;
3118             *(zip|jar))
3119                 DECOMP_CMD="unzip"
3120                 USES_STDIN=false
3121                 USES_STDOUT=false
3122                 ;;
3123             *deb)
3124                 DECOMP_CMD="ar -x"
3125                 USES_STDIN=false
3126                 USES_STDOUT=false
3127                 ;;
3128             *bz2)
3129                 DECOMP_CMD="bzip2 -d -c -"
3130                 USES_STDIN=true
3131                 USES_STDOUT=true
3132                 ;;
3133             *(gz|Z))
3134                 DECOMP_CMD="gzip -d -c -"
3135                 USES_STDIN=true
3136                 USES_STDOUT=true
3137                 ;;
3138             *(xz|lzma))
3139                 DECOMP_CMD="xz -d -c -"
3140                 USES_STDIN=true
3141                 USES_STDOUT=true
3142                 ;;
3143             *)
3144                 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3145                 RC=$((RC+1))
3146                 continue
3147                 ;;
3148         esac
3149
3150         if ! check_com ${DECOMP_CMD[(w)1]}; then
3151             echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3152             RC=$((RC+2))
3153             continue
3154         fi
3155
3156         GZTARGET="${ARCHIVE:t:r}"
3157         if [[ -f $ARCHIVE ]] ; then
3158
3159             print "Extracting '$ARCHIVE' ..."
3160             if $USES_STDIN; then
3161                 if $USES_STDOUT; then
3162                     ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3163                 else
3164                     ${=DECOMP_CMD} < "$ARCHIVE"
3165                 fi
3166             else
3167                 if $USES_STDOUT; then
3168                     ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3169                 else
3170                     ${=DECOMP_CMD} "$ARCHIVE"
3171                 fi
3172             fi
3173             [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3174
3175         elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3176             if check_com curl; then
3177                 WGET_CMD="curl -L -k -s -o -"
3178             elif check_com wget; then
3179                 WGET_CMD="wget -q -O - --no-check-certificate"
3180             else
3181                 print "ERROR: neither wget nor curl is installed" >&2
3182                 RC=$((RC+4))
3183                 continue
3184             fi
3185             print "Downloading and Extracting '$ARCHIVE' ..."
3186             if $USES_STDIN; then
3187                 if $USES_STDOUT; then
3188                     ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3189                     RC=$((RC+$?))
3190                 else
3191                     ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3192                     RC=$((RC+$?))
3193                 fi
3194             else
3195                 if $USES_STDOUT; then
3196                     ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3197                 else
3198                     ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3199                 fi
3200             fi
3201
3202         else
3203             print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3204             RC=$((RC+8))
3205         fi
3206     done
3207     return $RC
3208 }
3209
3210 __archive_or_uri()
3211 {
3212     _alternative \
3213         'files:Archives:_files -g "*.(#l)(tar.bz2|tbz2|tbz|tar.gz|tgz|tar.xz|txz|tar.lzma|tar|rar|lzh|7z|zip|jar|deb|bz2|gz|Z|xz|lzma)"' \
3214         '_urls:Remote Archives:_urls'
3215 }
3216
3217 _simple_extract()
3218 {
3219     _arguments \
3220         '-d[delete original archivefile after extraction]' \
3221         '*:Archive Or Uri:__archive_or_uri'
3222 }
3223 compdef _simple_extract simple-extract
3224 alias se=simple-extract
3225
3226 #f5# Set all ulimit parameters to \kbd{unlimited}
3227 allulimit() {
3228     ulimit -c unlimited
3229     ulimit -d unlimited
3230     ulimit -f unlimited
3231     ulimit -l unlimited
3232     ulimit -n unlimited
3233     ulimit -s unlimited
3234     ulimit -t unlimited
3235 }
3236
3237 #f5# Change the xterm title from within GNU-screen
3238 xtrename() {
3239     emulate -L zsh
3240     if [[ $1 != "-f" ]] ; then
3241         if [[ -z ${DISPLAY} ]] ; then
3242             printf 'xtrename only makes sense in X11.\n'
3243             return 1
3244         fi
3245     else
3246         shift
3247     fi
3248     if [[ -z $1 ]] ; then
3249         printf 'usage: xtrename [-f] "title for xterm"\n'
3250         printf '  renames the title of xterm from _within_ screen.\n'
3251         printf '  also works without screen.\n'
3252         printf '  will not work if DISPLAY is unset, use -f to override.\n'
3253         return 0
3254     fi
3255     print -n "\eP\e]0;${1}\C-G\e\\"
3256     return 0
3257 }
3258
3259 # Create small urls via http://goo.gl using curl(1).
3260 # API reference: https://code.google.com/apis/urlshortener/
3261 function zurl() {
3262     emulate -L zsh
3263     setopt extended_glob
3264
3265     if [[ -z $1 ]]; then
3266         print "USAGE: zurl <URL>"
3267         return 1
3268     fi
3269
3270     local PN url prog api json contenttype item
3271     local -a data
3272     PN=$0
3273     url=$1
3274
3275     # Prepend 'http://' to given URL where necessary for later output.
3276     if [[ ${url} != http(s|)://* ]]; then
3277         url='http://'${url}
3278     fi
3279
3280     if check_com -c curl; then
3281         prog=curl
3282     else
3283         print "curl is not available, but mandatory for ${PN}. Aborting."
3284         return 1
3285     fi
3286     api='https://www.googleapis.com/urlshortener/v1/url'
3287     contenttype="Content-Type: application/json"
3288     json="{\"longUrl\": \"${url}\"}"
3289     data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3290     # Parse the response
3291     for item in "${data[@]}"; do
3292         case "$item" in
3293             ' '#'"id":'*)
3294                 item=${item#*: \"}
3295                 item=${item%\",*}
3296                 printf '%s\n' "$item"
3297                 return 0
3298                 ;;
3299         esac
3300     done
3301     return 1
3302 }
3303
3304 #f2# Find history events by search pattern and list them by date.
3305 whatwhen()  {
3306     emulate -L zsh
3307     local usage help ident format_l format_s first_char remain first last
3308     usage='USAGE: whatwhen [options] <searchstring> <search range>'
3309     help='Use `whatwhen -h'\'' for further explanations.'
3310     ident=${(l,${#${:-Usage: }},, ,)}
3311     format_l="${ident}%s\t\t\t%s\n"
3312     format_s="${format_l//(\\t)##/\\t}"
3313     # Make the first char of the word to search for case
3314     # insensitive; e.g. [aA]
3315     first_char=[${(L)1[1]}${(U)1[1]}]
3316     remain=${1[2,-1]}
3317     # Default search range is `-100'.
3318     first=${2:-\-100}
3319     # Optional, just used for `<first> <last>' given.
3320     last=$3
3321     case $1 in
3322         ("")
3323             printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3324             printf '%s\n%s\n\n' ${usage} ${help} && return 1
3325         ;;
3326         (-h)
3327             printf '%s\n\n' ${usage}
3328             print 'OPTIONS:'
3329             printf $format_l '-h' 'show help text'
3330             print '\f'
3331             print 'SEARCH RANGE:'
3332             printf $format_l "'0'" 'the whole history,'
3333             printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3334             printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3335             printf '\n%s\n' 'EXAMPLES:'
3336             printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3337             printf $format_l 'whatwhen zsh -250'
3338             printf $format_l 'whatwhen foo 1 99'
3339         ;;
3340         (\?)
3341             printf '%s\n%s\n\n' ${usage} ${help} && return 1
3342         ;;
3343         (*)
3344             # -l list results on stout rather than invoking $EDITOR.
3345             # -i Print dates as in YYYY-MM-DD.
3346             # -m Search for a - quoted - pattern within the history.
3347             fc -li -m "*${first_char}${remain}*" $first $last
3348         ;;
3349     esac
3350 }
3351
3352 # mercurial related stuff
3353 if check_com -c hg ; then
3354     # gnu like diff for mercurial
3355     # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3356     #f5# GNU like diff for mercurial
3357     hgdi() {
3358         emulate -L zsh
3359         for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3360     }
3361
3362     # build debian package
3363     #a2# Alias for \kbd{hg-buildpackage}
3364     alias hbp='hg-buildpackage'
3365
3366     # execute commands on the versioned patch-queue from the current repos
3367     alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3368
3369     # diffstat for specific version of a mercurial repository
3370     #   hgstat      => display diffstat between last revision and tip
3371     #   hgstat 1234 => display diffstat between revision 1234 and tip
3372     #f5# Diffstat for specific version of a mercurial repos
3373     hgstat() {
3374         emulate -L zsh
3375         [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3376     }
3377
3378 fi # end of check whether we have the 'hg'-executable
3379
3380 # grml-small cleanups
3381
3382 # The following is used to remove zsh-config-items that do not work
3383 # in grml-small by default.
3384 # If you do not want these adjustments (for whatever reason), set
3385 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3386 # sources if it is there).
3387
3388 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3389
3390     unset abk[V]
3391     unalias    'V'      &> /dev/null
3392     unfunction vman     &> /dev/null
3393     unfunction viless   &> /dev/null
3394     unfunction 2html    &> /dev/null
3395
3396     # manpages are not in grmlsmall
3397     unfunction manzsh   &> /dev/null
3398     unfunction man2     &> /dev/null
3399
3400 fi
3401
3402 zrclocal
3403
3404 ## genrefcard.pl settings
3405
3406 ### doc strings for external functions from files
3407 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3408
3409 ### example: split functions-search 8,16,24,32
3410 #@# split functions-search 8
3411
3412 ## END OF FILE #################################################################
3413 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4
3414 # Local variables:
3415 # mode: sh
3416 # End: