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