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.
11 # Global Order: zshenv, zprofile, zshrc, zlogin
12 ################################################################################
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/>
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
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
30 # Doing so makes sure the right people get your patches for review and
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).
40 # Here is what they mean:
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'
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.
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@@)
75 # All of these tags (except for m and o) take two arguments, the first
76 # within the tag, the other after the tag:
78 # #<tag><section># <comment>
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:
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
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@@.
106 # just execute 'ZSH_PROFILE_RC=1 zsh' and run 'zprof' to get the details
107 if [[ $ZSH_PROFILE_RC -gt 0 ]] ; then
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
114 # check for version/system
115 # check for versions (compatibility reasons)
117 [[ $ZSH_VERSION == <4->* ]] && return 0
122 [[ $ZSH_VERSION == 4.<1->* || $ZSH_VERSION == <5->* ]] && return 0
127 [[ $ZSH_VERSION == 4.<2->* || $ZSH_VERSION == <5->* ]] && return 0
132 [[ $ZSH_VERSION == 4.2.<5->* || $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
137 [[ $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
142 [[ $ZSH_VERSION == 4.3.<3->* || $ZSH_VERSION == 4.<4->* \
143 || $ZSH_VERSION == <5->* ]] && return 0
148 [[ $ZSH_VERSION == 4.3.<9->* || $ZSH_VERSION == 4.<4->* \
149 || $ZSH_VERSION == <5->* ]] && return 0
153 #f1# Checks whether or not you're running grml
155 [[ -f /etc/grml_version ]] && return 0
159 #f1# Checks whether or not you're running a grml cd
161 [[ -f /etc/grml_cd ]] && return 0
166 #f1# Checks whether or not you're running grml-small
168 if [[ ${${${(f)"$(</etc/grml_version)"}%% *}##*-} == 'small' ]]; then
174 isgrmlsmall() { return 1 }
178 [[ $OSTYPE == darwin* ]] && return 0
183 [[ $OSTYPE == freebsd* ]] && return 0
187 #f1# are we running within an utf environment?
189 case "$LANG $CHARSET $LANGUAGE" in
196 # check for user, if not running as root set $SUDO to sudo
197 (( EUID != 0 )) && SUDO='sudo' || SUDO=''
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
209 # check for zsh v3.1.7+
211 if ! [[ ${ZSH_VERSION} == 3.1.<7->* \
212 || ${ZSH_VERSION} == 3.<2->.<->* \
213 || ${ZSH_VERSION} == <4->.<->* ]] ; then
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'
221 printf '-!- However, you are running zsh version %s.\n' "$ZSH_VERSION"
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'
226 printf '-!- DO NOT EXPECT THIS TO WORK FLAWLESSLY!\n'
227 printf '-!- If it does today, you'\''ve been lucky.\n'
229 printf '-!- Ye been warned!\n'
232 function zstyle() { : }
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() {
246 for fdir in ${fpath} ; do
247 [[ -e ${fdir}/${ffile} ]] && (( ffound = 1 ))
250 (( ffound == 0 )) && return 1
251 if [[ $ZSH_VERSION == 3.1.<6-> || $ZSH_VERSION == <4->* ]] ; then
252 autoload -U ${ffile} || return 1
254 autoload ${ffile} || return 1
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
262 zrcautoload is-at-least || is-at-least() { return 1 }
264 # set some important options (as early as possible)
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
270 # import new commands from the history file also in other zsh-session
271 is4 && setopt share_history
273 # save each command's beginning timestamp and the duration to the history file
274 setopt extended_history
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
280 # remove command lines from the history list when the first character on the
282 setopt histignorespace
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.
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 '#'!
293 # display PID when suspending processes as well
296 # try to avoid the 'zsh: no matches found...'
299 # report the status of backgrounds jobs immediately
302 # whenever a command completion is attempted, make sure the entire command path
306 # not just at the end
307 setopt completeinword
309 # Don't send SIGHUP to background processes when the shell exits.
312 # make cd push the old directory onto the directory stack.
318 # don't push the same dir twice.
319 setopt pushd_ignore_dups
321 # * shouldn't match dotfiles. ever.
324 # use zsh style word splitting
327 # don't error out when unset parameters are used
330 # setting some default values
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}
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
347 if grep --help 2> /dev/null | grep -q GNU || \
348 [[ $OSTYPE == freebsd* ]]; then
349 grep_options=( --color=auto )
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
361 local -i comonly gatoo
363 if [[ $1 == '-c' ]] ; then
366 elif [[ $1 == '-g' ]] ; then
373 if (( ${#argv} != 1 )) ; then
374 printf 'usage: check_com [-c] <command>\n' >&2
378 if (( comonly > 0 )) ; then
379 [[ -n ${commands[$1]} ]] && return 0
383 if [[ -n ${commands[$1]} ]] \
384 || [[ -n ${functions[$1]} ]] \
385 || [[ -n ${aliases[$1]} ]] \
386 || [[ -n ${reswords[(r)$1]} ]] ; then
391 if (( gatoo > 0 )) && [[ -n ${galiases[$1]} ]] ; then
398 # creates an alias and precedes the command with
399 # sudo if $EUID is not zero.
402 local only=0 ; local multi=0
403 while [[ $1 == -* ]] ; do
407 (--) shift ; break ;;
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'
416 (*) printf "unkown option: '%s'\n" "$1" ; return 1 ;;
421 if (( ${#argv} > 1 )) ; then
422 printf 'Too many arguments %s\n' "${#argv}"
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}"
437 # a "print -l ${(u)foo}"-workaround for pre-4.2.0 shells
439 # Where foo is the *name* of the parameter you want printed.
440 # Note that foo is no typo; $foo would be wrong here!
448 if [[ -z ${parameter} ]] ; then
449 printf 'usage: uprint <parameter>\n'
453 for w in ${(P)parameter} ; do
454 [[ -z ${(M)u:#$w} ]] && u=( $u $w )
461 # Check if we can read given files and source those we can.
463 if (( ${#argv} < 1 )) ; then
464 printf 'usage: xsource FILE(s)...\n' >&2
468 while (( ${#argv} > 0 )) ; do
469 [[ -r "$1" ]] && source "$1"
475 # Check if we can read a given file and 'cat(1)' it.
478 if (( ${#argv} != 1 )) ; then
479 printf 'usage: xcat FILE\n' >&2
483 [[ -r $1 ]] && cat $1
487 # Remove these functions again, they are of use only in these
488 # setup files. This should be called at the end of .zshrc.
492 funcs=(salias xcat xsource xunfunction zrcautoload)
494 for func in $funcs ; do
495 [[ -n ${functions[$func]} ]] \
501 # this allows us to stay in sync with grml's zshrc and put own
502 # modifications in ~/.zshrc.local
504 xsource "/etc/zsh/zshrc.local"
505 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
510 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
511 xsource "/etc/default/locale"
514 for var in LANG LC_ALL LC_MESSAGES ; do
515 [[ -n ${(P)var} ]] && export $var
518 xsource "/etc/sysconfig/keyboard"
520 TZ=$(xcat /etc/timezone)
523 if check_com -c vim ; then
525 export EDITOR=${EDITOR:-vim}
527 export EDITOR=${EDITOR:-vi}
531 export PAGER=${PAGER:-less}
534 export MAIL=${MAIL:-/var/mail/$USER}
536 # if we don't set $SHELL then aterm, rxvt,.. will use /bin/sh or /bin/bash :-/
537 export SHELL='/bin/zsh'
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
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
549 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
550 MANPATH="/opt/local/share/man:$MANPATH"
552 # do Fink setup on darwin
553 isdarwin && xsource /sw/bin/init.sh
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}
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'
578 # report about cpu-/system-/user-time of command if running longer than
582 # watch for everyone but me and root
585 # automatically remove duplicates from these arrays
586 typeset -U path cdpath fpath manpath
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 () {
594 if (( ${+functions[$name]} )) && [[ ${functions[$name]} == *${cap}* ]]; then
595 local w=${widgets[$name]}
597 [[ $w == user:* ]] && unfunction ${w#*:}
600 remove_widget zle-line-init smkx
601 remove_widget zle-line-finish rmkx
602 unfunction remove_widget
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
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
629 ## keybindings (run 'bindkeys' for details, more details via man zshzle)
630 # use emacs style per default:
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() {
639 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
640 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
641 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
643 zle .${WIDGET:s/somewhere/line-hist/} "$@"
644 if (( HISTNO != hno )); then
645 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
649 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
650 zle -N end-of-somewhere beginning-or-end-of-somewhere
653 #if [[ "$TERM" == screen ]] ; then
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
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
672 bindkey '\e[A' up-line-or-search # cursor up
673 bindkey '\e[B' down-line-or-search # <ESC>-
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
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
697 # bindkey -s '^l' "|less\n" # ctrl-L pipes to less
698 # bindkey -s '^b' " &\n" # ctrl-B runs it in the background
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
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
715 ## toggle the ,. abbreviation feature on/off
716 # NOABBREVIATION: default abbreviation-state
717 # 0 - enabled (default)
719 NOABBREVIATION=${NOABBREVIATION:-0}
721 grml_toggle_abbrev() {
722 if (( ${NOABBREVIATION} > 0 )) ; then
729 #k# Toggle abbreviation expansion on/off
730 zle -N grml_toggle_abbrev
731 bindkey '^xA' grml_toggle_abbrev
733 # add a command line to the shells history without executing it
734 commit-to-history() {
735 print -s ${(z)BUFFER}
738 zle -N commit-to-history
739 bindkey "^x^h" commit-to-history
741 # only slash should be considered as a word separator:
742 slash-backward-kill-word() {
743 local WORDCHARS="${WORDCHARS:s@/@}"
745 zle backward-kill-word
747 zle -N slash-backward-kill-word
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
756 # use the new *-pattern-* widgets for incremental history search
758 bindkey '^r' history-incremental-pattern-search-backward
759 bindkey '^s' history-incremental-pattern-search-forward
762 # a generic accept-line wrapper
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.
768 # For a broader description, see:
769 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
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.
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
781 function Accept-Line() {
782 setopt localoptions noksharrays
786 local alcontext=${1:-$alcontext}
788 zstyle -a ":acceptline:${alcontext}" actions subs
790 (( ${#subs} < 1 )) && return 0
793 for sub in ${subs} ; do
794 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
797 (( aldone > 0 )) && break
801 function Accept-Line-getdefault() {
805 zstyle -s ":acceptline:${alcontext}" default_action default_action
806 case ${default_action} in
808 printf ".accept-line"
811 printf ${default_action}
816 function Accept-Line-HandleContext() {
819 default_action=$(Accept-Line-getdefault)
820 zstyle -T ":acceptline:${alcontext}" call_default \
821 && zle ${default_action}
824 function accept-line() {
825 setopt localoptions noksharrays
828 local buf com fname format msg default_action
832 cmdline=(${(z)BUFFER})
836 Accept-Line 'preprocess'
838 zstyle -t ":acceptline:${alcontext}" rehash \
839 && [[ -z ${commands[$com]} ]] \
843 && [[ -n ${reswords[(r)$com]} ]] \
844 || [[ -n ${aliases[$com]} ]] \
845 || [[ -n ${functions[$com]} ]] \
846 || [[ -n ${builtins[$com]} ]] \
847 || [[ -n ${commands[$com]} ]] ; then
849 # there is something sensible to execute, just do it.
851 Accept-Line-HandleContext
856 if [[ -o correct ]] \
857 || [[ -o correctall ]] \
858 && [[ -n ${functions[$fname]} ]] ; then
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.
868 Accept-Line-HandleContext
873 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
875 Accept-Line-HandleContext
877 # prepare warning message for the user, configurable via zstyle.
878 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
880 if [[ -z ${msg} ]] ; then
881 msg="%c will not execute and completion %f exists."
884 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
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
894 Accept-Line-HandleContext
899 # If we got this far, the commandline only contains whitespace, or is empty.
901 Accept-Line-HandleContext
906 zle -N Accept-Line-HandleContext
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
915 setopt interactivecomments
917 # key # value (#d additional doc string)
923 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
925 'Hl' ' --help |& less -r' #d (Display help in pager)
929 'N' '&>/dev/null' #d (No Output)
930 'R' '| tr A-z N-za-m' #d (ROT13)
936 'co' './configure && make && sudo make install'
944 if (( NOABBREVIATION > 0 )) ; then
945 LBUFFER="${LBUFFER},."
949 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
950 LBUFFER+=${abk[$MATCH]:-$MATCH}
953 zle -N zleiab && bindkey ",." zleiab
955 #f# display contents of assoc array $abk
958 zle -M "$(print "Type ,. after these abbreviations to expand them:"; print -a -C 2 ${(kv)abk})"
960 #k# Display list of abbreviations that expand when followed by ,.
961 zle -N help-show-abk && bindkey '^xb' help-show-abk
964 zrcautoload zmv # who needs mmv or rename?
965 zrcautoload history-search-end
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 '*?[]^()~#{}='
972 # print 'Notice: no url-quote-magic available :('
974 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
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
983 if zrcautoload compinit ; then
984 compinit || print 'Notice: no compinit available :('
986 print 'Notice: no compinit available :('
990 is4 && zrcautoload zed # use ZLE editor to edit a file or function
993 for mod in complist deltochar mathfunc ; do
994 zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
997 # autoload zsh modules when they are referenced
999 zmodload -a zsh/stat zstat
1000 zmodload -a zsh/zpty zpty
1001 zmodload -ap zsh/mapfile mapfile
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
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
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
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
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
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
1036 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1037 bindkey '^ed' insert-datestamp
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;
1043 #k# Insert last typed word
1044 bindkey "\em" insert-last-typed-word
1046 function grml-zsh-fg() {
1047 if (( ${#jobstates} )); then
1049 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1050 BUFFER="${BUFFER}fg"
1053 zle -M 'No background jobs. Doing nothing.'
1057 #k# A smart shortcut for \kbd{fg<enter>}
1058 bindkey '^z' grml-zsh-fg
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 ))
1068 zle -N sudo-command-line
1070 #k# prepend the current command with "sudo"
1071 bindkey "^os" sudo-command-line
1073 ### jump behind the first word on the cmdline.
1074 ### useful to add options.
1075 function jump_after_first_word() {
1077 words=(${(z)BUFFER})
1079 if (( ${#words} <= 1 )) ; then
1082 CURSOR=${#${words[1]}}
1085 zle -N jump_after_first_word
1086 #k# jump to after first word (for adding options)
1087 bindkey '^x1' jump_after_first_word
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
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
1100 local TMPFILE=$(mktemp)
1101 local -U -a _screen_display_wordlist
1102 trap "rm -f $TMPFILE" EXIT
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
1111 screen -X hardcopy $TMPFILE
1112 # screen sucks, it dumps in latin1, apparently always. so recode it
1114 check_com recode && recode latin1 $TMPFILE
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
1121 #k# complete word from currently visible GNU screen buffer
1123 compdef -k _complete_screen_display complete-word '^xS'
1128 ZSHDIR=${ZDOTDIR:-${HOME}/.zsh}
1131 HISTFILE=${ZDOTDIR:-${HOME}}/.zsh_history
1132 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1133 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1137 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1138 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
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
1148 my_stack=( ${PWD} ${dirstack} )
1150 builtin print -l ${(u)my_stack} >! ${DIRSTACKFILE}
1152 uprint my_stack >! ${DIRSTACKFILE}
1156 # directory based profiles
1160 # chpwd_profiles(): Directory Profiles, Quickstart:
1164 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1165 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1168 # For details see the `grmlzshrc.5' manual page.
1169 function chpwd_profiles() {
1170 local profile context
1173 context=":chpwd:profiles:$PWD"
1174 zstyle -s "$context" profile profile || profile='default'
1175 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
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}
1185 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1186 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1189 CHPWD_PROFILE="${profile}"
1193 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
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
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'
1210 if [[ "$PERCENT" -lt 20 ]] ; then
1211 PERCENT="warning: ${PERCENT}%%"
1213 PERCENT="${PERCENT}%%"
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}%}"
1229 BLUE=$'%{\e[1;34m%}'
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%}'
1239 # gather version control information for inclusion in a prompt
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
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; )
1252 zstyle ':vcs_info:*' max-exports 2
1254 if [[ -o restricted ]]; then
1255 zstyle ':vcs_info:*' enable NONE
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"
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} " \
1271 zstyle ':vcs_info:*' formats "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR}%} " \
1273 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "%b${RED}:${YELLOW}%r"
1276 # command not found handling
1278 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1279 function command_not_found_handler() {
1281 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1282 ${GRML_ZSH_CNF_HANDLER} $1
1287 function prompt_grml_help () {
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:
1294 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
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:
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).
1304 - The attributes used with the items are customisable via strings
1305 used before and after the actual item.
1307 The available items are: rc, rc-always, change-root, user, at, host, path,
1308 vcs, percent, sad-smiley.
1310 The actual configuration is done via zsh's \`zstyle' mechanism. The
1311 context, that is used while looking up styles is:
1313 ':prompt:grml:<sub-context>'
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:
1319 zstyle ':prompt:grml:setup' items user at host path \\
1324 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
1325 in $RPROMPT if the last command a returned non-successful error
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
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
1337 zstyle ':prompt:grml:items:user' pre '%F{red}'
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).
1345 function prompt_grml_setup () {
1348 function prompt_grml_precmd () {
1352 if zrcautoload promptinit && promptinit 2>/dev/null ; then
1353 promptinit # people should be able to use their favourite prompt
1355 # Since we define the required functions in here and not in files in
1356 # $fpath, we need to stick the theme's name into `$prompt_themes'
1357 # ourselves, since promptinit does not pick them up otherwise.
1358 prompt_themes+=( grml )
1359 # Also, keep the array sorted...
1360 prompt_themes=( "${(@on)prompt_themes}" )
1362 print 'Notice: no promptinit available :('
1367 # make sure to use right prompt only when not running a command
1368 is41 && setopt transient_rprompt
1371 function ESC_print () {
1372 info_print $'\ek' $'\e\\' "$@"
1374 function set_title () {
1375 info_print $'\e]0;' $'\a' "$@"
1378 function info_print () {
1379 local esc_begin esc_end
1383 printf '%s' ${esc_begin}
1385 printf '%s' "${esc_end}"
1388 # TODO: revise all these NO* variables and especially their documentation
1389 # in zsh-help() below.
1390 is4 && [[ $NOPRECMD -eq 0 ]] && precmd () {
1391 [[ $NOPRECMD -gt 0 ]] && return 0
1392 # update VCS information
1393 (( ${+functions[vcs_info]} )) && vcs_info
1395 if [[ $TERM == screen* ]] ; then
1396 if [[ -n ${vcs_info_msg_1_} ]] ; then
1397 ESC_print ${vcs_info_msg_1_}
1402 # just use DONTSETRPROMPT=1 to be able to overwrite RPROMPT
1403 if [[ ${DONTSETRPROMPT:-} -eq 0 ]] ; then
1404 if [[ $BATTERY -gt 0 ]] ; then
1405 # update battery (dropped into $PERCENT) information
1407 RPROMPT="%(?..:() ${PERCENT}"
1412 # adjust title of xterm
1413 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
1414 [[ ${NOTITLE:-} -gt 0 ]] && return 0
1417 set_title ${(%):-"%n@%m: %~"}
1422 # preexec() => a function running before every command
1423 is4 && [[ $NOPRECMD -eq 0 ]] && \
1425 [[ $NOPRECMD -gt 0 ]] && return 0
1426 # set hostname if not running on host with name 'grml'
1427 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
1430 # get the name of the program currently running and hostname of local machine
1431 # set screen window title if running in a screen
1432 if [[ "$TERM" == screen* ]] ; then
1433 # local CMD=${1[(wr)^(*=*|sudo|ssh|-*)]} # don't use hostname
1434 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME" # use hostname
1437 # adjust title of xterm
1438 [[ ${NOTITLE} -gt 0 ]] && return 0
1441 set_title "${(%):-"%n@%m:"}" "$1"
1446 EXITCODE="%(?..%?%1v )"
1447 # secondary prompt, printed when the shell needs more information to complete a
1450 # selection prompt used within a select loop.
1452 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1455 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1456 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1457 debian_chroot=$(cat /etc/debian_chroot)
1460 # don't use colors on dumb terminals (like emacs):
1461 if [[ "$TERM" == dumb ]] ; then
1462 PROMPT="${EXITCODE}${debian_chroot:+($debian_chroot)}%n@%m %40<...<%B%~%b%<< "
1464 # only if $GRMLPROMPT is set (e.g. via 'GRMLPROMPT=1 zsh') use the extended
1465 # prompt set variable identifying the chroot you work in (used in the
1467 if [[ $GRMLPROMPT -gt 0 ]] ; then
1468 PROMPT="${RED}${EXITCODE}${CYAN}[%j running job(s)] ${GREEN}{history#%!} ${RED}%(3L.+.) ${BLUE}%* %D
1469 ${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "
1471 # This assembles the primary prompt string
1472 if (( EUID != 0 )); then
1473 PROMPT="${RED}${EXITCODE}${WHITE}${debian_chroot:+($debian_chroot)}${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "
1475 PROMPT="${BLUE}${EXITCODE}${WHITE}${debian_chroot:+($debian_chroot)}${RED}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "
1480 PROMPT="${PROMPT}"'${vcs_info_msg_0_}'"%# "
1482 # if we are inside a grml-chroot set a specific prompt theme
1483 if [[ -n "$GRML_CHROOT" ]] ; then
1484 PROMPT="%{$fg[red]%}(CHROOT) %{$fg_bold[red]%}%n%{$fg_no_bold[white]%}@%m %40<...<%B%~%b%<< %\# "
1487 # 'hash' some often used directories
1489 hash -d deb=/var/cache/apt/archives
1490 hash -d doc=/usr/share/doc
1491 hash -d linux=/lib/modules/$(command uname -r)/build/
1492 hash -d log=/var/log
1493 hash -d slog=/var/log/syslog
1494 hash -d src=/usr/src
1495 hash -d templ=/usr/share/doc/grml-templates
1496 hash -d tt=/usr/share/doc/texttools-doc
1497 hash -d www=/var/www
1501 if check_com -c screen ; then
1502 if [[ $UID -eq 0 ]] ; then
1503 if [[ -r /etc/grml/screenrc ]]; then
1504 alias screen="${commands[screen]} -c /etc/grml/screenrc"
1506 elif [[ -r $HOME/.screenrc ]] ; then
1507 alias screen="${commands[screen]} -c $HOME/.screenrc"
1509 if [[ -r /etc/grml/screenrc_grml ]]; then
1510 alias screen="${commands[screen]} -c /etc/grml/screenrc_grml"
1512 if [[ -r /etc/grml/screenrc ]]; then
1513 alias screen="${commands[screen]} -c /etc/grml/screenrc"
1519 # do we have GNU ls with color-support?
1520 if [[ "$TERM" != dumb ]]; then
1521 #a1# execute \kbd{@a@}:\quad ls with colors
1522 alias ls='ls -b -CF '${ls_options:+"${ls_options[*]}"}
1523 #a1# execute \kbd{@a@}:\quad list all files, with colors
1524 alias la='ls -la '${ls_options:+"${ls_options[*]}"}
1525 #a1# long colored list, without dotfiles (@a@)
1526 alias ll='ls -l '${ls_options:+"${ls_options[*]}"}
1527 #a1# long colored list, human readable sizes (@a@)
1528 alias lh='ls -hAl '${ls_options:+"${ls_options[*]}"}
1529 #a1# List files, append qualifier to filenames \\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
1530 alias l='ls -lF '${ls_options:+"${ls_options[*]}"}
1532 alias ls='ls -b -CF'
1539 alias mdstat='cat /proc/mdstat'
1540 alias ...='cd ../../'
1542 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
1543 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
1544 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
1547 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
1548 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
1549 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
1551 # make sure it is not assigned yet
1552 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
1555 for ENV in $(env | command grep -i '.utf') ; do
1556 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
1561 # make sure it is not assigned yet
1562 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
1564 if ! isutfenv ; then
1565 for ENV in $(env | command grep -i '\.iso') ; do
1566 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
1571 # especially for roadwarriors using GNU screen and ssh:
1572 if ! check_com asc &>/dev/null ; then
1573 asc() { autossh -t "$@" 'screen -RdU' }
1577 #f1# Hints for the use of zsh on grml
1579 print "$bg[white]$fg[black]
1580 zsh-help - hints for use of zsh on grml
1581 =======================================$reset_color"
1584 Main configuration of zsh happens in /etc/zsh/zshrc.
1585 That file is part of the package grml-etc-core, if you want to
1586 use them on a non-grml-system just get the tar.gz from
1587 http://deb.grml.org/ or (preferably) get it from the git repository:
1589 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
1591 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
1592 The file is still there, but it is empty for backwards compatibility.
1594 For your own changes use these two files:
1598 The former is sourced very early in our zshrc, the latter is sourced
1601 System wide configuration without touching configuration files of grml
1602 can take place in /etc/zsh/zshrc.local.
1604 For information regarding zsh start at http://grml.org/zsh/
1606 Take a look at grml'\''s zsh refcard:
1607 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
1609 Check out the main zsh refcard:
1610 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
1612 And of course visit the zsh-lovers:
1615 You can adjust some options through environment variables when
1616 invoking zsh without having to edit configuration files.
1617 Basically meant for bash users who are not used to the power of
1620 "NOCOR=1 zsh" => deactivate automatic correction
1621 "NOMENU=1 zsh" => do not use auto menu completion
1622 (note: use ctrl-d for completion instead!)
1623 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
1624 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
1625 preexec() and precmd() completely
1626 "BATTERY=1 zsh" => activate battery status (via acpi) on right side of prompt
1627 "COMMAND_NOT_FOUND=1 zsh"
1628 => Enable a handler if an external command was not found
1629 The command called in the handler can be altered by setting
1630 the GRML_ZSH_CNF_HANDLER variable, the default is:
1631 "/usr/share/command-not-found/command-not-found"
1633 A value greater than 0 is enables a feature; a value equal to zero
1634 disables it. If you like one or the other of these settings, you can
1635 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
1639 $bg[white]$fg[black]
1640 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
1641 Enjoy your grml system with the zsh!$reset_color"
1645 if [[ -r /etc/debian_version ]] ; then
1646 #a3# Execute \kbd{apt-cache search}
1647 alias acs='apt-cache search'
1648 #a3# Execute \kbd{apt-cache show}
1649 alias acsh='apt-cache show'
1650 #a3# Execute \kbd{apt-cache policy}
1651 alias acp='apt-cache policy'
1652 #a3# Execute \kbd{apt-get dist-upgrade}
1653 salias adg="apt-get dist-upgrade"
1654 #a3# Execute \kbd{apt-get install}
1655 salias agi="apt-get install"
1656 #a3# Execute \kbd{aptitude install}
1657 salias ati="aptitude install"
1658 #a3# Execute \kbd{apt-get upgrade}
1659 salias ag="apt-get upgrade"
1660 #a3# Execute \kbd{apt-get update}
1661 salias au="apt-get update"
1662 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
1663 salias -a up="aptitude update ; aptitude safe-upgrade"
1664 #a3# Execute \kbd{dpkg-buildpackage}
1665 alias dbp='dpkg-buildpackage'
1666 #a3# Execute \kbd{grep-excuses}
1667 alias ge='grep-excuses'
1669 # get a root shell as normal user in live-cd mode:
1670 if isgrmlcd && [[ $UID -ne 0 ]] ; then
1674 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
1675 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
1676 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
1677 salias tlog="tail -f /var/log/syslog" # follow the syslog
1680 # sort installed Debian-packages by size
1681 if check_com -c dpkg-query ; then
1682 #a3# List installed Debian-packages sorted by size
1683 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"
1686 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
1687 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
1688 if check_com -c wodim; then
1691 cdrecord is not provided under its original name by Debian anymore.
1692 See #377109 in the BTS of Debian for more details.
1694 Please use the wodim binary instead
1701 # Use hard limits, except for a smaller stack and no core dumps
1703 is425 && limit stack 8192
1704 isgrmlcd && limit core 0 # important for a live-cd-system
1709 # called later (via is4 && grmlcomp)
1710 # note: use 'zstyle' for getting current settings
1711 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
1713 # TODO: This could use some additional information
1715 # allow one error for every three characters typed in approximate completer
1716 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
1718 # don't complete backup files as executables
1719 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
1721 # start menu completion only if it could find no unambiguous initial string
1722 zstyle ':completion:*:correct:*' insert-unambiguous true
1723 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
1724 zstyle ':completion:*:correct:*' original true
1726 # activate color-completion
1727 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
1729 # format on completion
1730 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
1732 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
1733 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
1735 # insert all expansions for expand completer
1736 zstyle ':completion:*:expand:*' tag-order all-expansions
1737 zstyle ':completion:*:history-words' list false
1740 zstyle ':completion:*:history-words' menu yes
1742 # ignore duplicate entries
1743 zstyle ':completion:*:history-words' remove-all-dups yes
1744 zstyle ':completion:*:history-words' stop yes
1746 # match uppercase from lowercase
1747 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
1749 # separate matches into groups
1750 zstyle ':completion:*:matches' group 'yes'
1751 zstyle ':completion:*' group-name ''
1753 if [[ "$NOMENU" -eq 0 ]] ; then
1754 # if there are more than 5 options allow selecting from a menu
1755 zstyle ':completion:*' menu select=5
1757 # don't use any menus at all
1761 zstyle ':completion:*:messages' format '%d'
1762 zstyle ':completion:*:options' auto-description '%d'
1764 # describe options in full
1765 zstyle ':completion:*:options' description 'yes'
1767 # on processes completion complete all user processes
1768 zstyle ':completion:*:processes' command 'ps -au$USER'
1770 # offer indexes before parameters in subscripts
1771 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
1773 # provide verbose completion information
1774 zstyle ':completion:*' verbose true
1776 # recent (as of Dec 2007) zsh versions are able to provide descriptions
1777 # for commands (read: 1st word in the line) that it will list for the user
1778 # to choose from. The following disables that, because it's not exactly fast.
1779 zstyle ':completion:*:-command-:*:' verbose false
1781 # set format for warnings
1782 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
1784 # define files to ignore for zcompile
1785 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
1786 zstyle ':completion:correct:' prompt 'correct to: %e'
1788 # Ignore completion functions for commands you don't have:
1789 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
1791 # Provide more processes in completion of programs like killall:
1792 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
1794 # complete manual by their section
1795 zstyle ':completion:*:manuals' separate-sections true
1796 zstyle ':completion:*:manuals.*' insert-sections true
1797 zstyle ':completion:*:man:*' menu yes select
1799 # Search path for sudo completion
1800 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
1808 # provide .. as a completion
1809 zstyle ':completion:*' special-dirs ..
1811 # run rehash on completion so new installed program are found automatically:
1813 (( CURRENT == 1 )) && rehash
1818 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
1819 if [[ "$NOCOR" -gt 0 ]] ; then
1820 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
1823 # try to be smart about when to use what completer...
1825 zstyle -e ':completion:*' completer '
1826 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
1827 _last_try="$HISTNO$BUFFER$CURSOR"
1828 reply=(_complete _match _ignored _prefix _files)
1830 if [[ $words[1] == (rm|mv) ]] ; then
1831 reply=(_complete _files)
1833 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
1838 # command for process lists, the local web server details and host completion
1839 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
1842 [[ -d $ZSHDIR/cache ]] && zstyle ':completion:*' use-cache yes && \
1843 zstyle ':completion::complete:*' cache-path $ZSHDIR/cache/
1847 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
1848 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
1859 zstyle ':completion:*:hosts' hosts $hosts
1860 # TODO: so, why is this here?
1861 # zstyle '*' hosts $hosts
1863 # use generic completion system for programs not yet defined; (_gnu_generic works
1864 # with commands that provide a --help option with "standard" gnu-like output.)
1865 for compcom in cp deborphan df feh fetchipac head hnb ipacsum mv \
1866 pal stow tail uname ; do
1867 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
1870 # see upgrade function in this file
1871 compdef _hosts upgrade
1876 # people should use 'grml-x'!
1877 if check_com -c 915resolution; then
1879 echo "Please use 915resolution as resolution modifying tool for Intel \
1885 #a1# Output version of running grml
1886 alias grml-version='cat /etc/grml_version'
1888 if check_com -c rebuildfstab ; then
1889 #a1# Rebuild /etc/fstab
1890 alias grml-rebuildfstab='rebuildfstab -v -r -config'
1893 if check_com -c grml-debootstrap ; then
1895 echo "Installing debian to harddisk is possible by using grml-debootstrap."
1901 # now run the functions
1903 is4 && isgrml && grmlstuff
1907 is4 && xsource "/etc/zsh/keephack"
1909 # wonderful idea of using "e" glob qualifier by Peter Stephenson
1910 # You use it as follows:
1911 # $ NTREF=/reference/file
1913 # This lists all the files in the current directory newer than the reference file.
1914 # You can also specify the reference file inline; note quotes:
1915 # $ ls -l *(e:'nt ~/.zshenv':)
1917 if [[ -n $1 ]] ; then
1920 [[ $REPLY -nt $NTREF ]]
1925 #f1# Reload an autoloadable function
1926 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
1927 compdef _functions freload
1929 #f1# List symlinks in detail (more detailed version of 'readlink -f' and 'whence -s')
1931 [[ -z "$1" ]] && printf 'Usage: %s <file(s)>\n' "$0" && return 1
1932 for file in "$@" ; do
1933 while [[ -h "$file" ]] ; do
1935 file=$(readlink "$file")
1940 # TODO: Is it supported to use pager settings like this?
1941 # PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
1942 # with respect to wordsplitting. (ie. ${=PAGER})
1943 if check_com -c $PAGER ; then
1944 #f1# View Debian's changelog of a given package
1947 if [[ -r /usr/share/doc/$1/changelog.Debian.gz ]] ; then
1948 $PAGER /usr/share/doc/$1/changelog.Debian.gz
1949 elif [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
1950 $PAGER /usr/share/doc/$1/changelog.gz
1952 if check_com -c aptitude ; then
1953 echo "No changelog for package $1 found, using aptitude to retrieve it."
1955 aptitude -t unstable changelog $1
1957 aptitude changelog $1
1960 echo "No changelog for package $1 found, sorry."
1965 _dchange() { _files -W /usr/share/doc -/ }
1966 compdef _dchange dchange
1968 #f1# View Debian's NEWS of a given package
1971 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
1972 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
1974 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
1975 $PAGER /usr/share/doc/$1/NEWS.gz
1977 echo "No NEWS file for package $1 found, sorry."
1982 _dnews() { _files -W /usr/share/doc -/ }
1983 compdef _dnews dnews
1985 #f1# View Debian's copyright of a given package
1988 if [[ -r /usr/share/doc/$1/copyright ]] ; then
1989 $PAGER /usr/share/doc/$1/copyright
1991 echo "No copyright file for package $1 found, sorry."
1995 _dcopyright() { _files -W /usr/share/doc -/ }
1996 compdef _dcopyright dcopyright
1998 #f1# View upstream's changelog of a given package
2001 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2002 $PAGER /usr/share/doc/$1/changelog.gz
2004 echo "No changelog for package $1 found, sorry."
2008 _uchange() { _files -W /usr/share/doc -/ }
2009 compdef _uchange uchange
2014 ZSH_PROFILE_RC=1 $SHELL "$@"
2017 #f1# Edit an alias via zle
2019 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2021 compdef _aliases edalias
2023 #f1# Edit a function via zle
2025 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
2027 compdef _functions edfunc
2029 # use it e.g. via 'Restart apache2'
2030 #m# f6 Start() \kbd{/etc/init.d/\em{process}}\quad\kbd{start}
2031 #m# f6 Restart() \kbd{/etc/init.d/\em{process}}\quad\kbd{restart}
2032 #m# f6 Stop() \kbd{/etc/init.d/\em{process}}\quad\kbd{stop}
2033 #m# f6 Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{reload}
2034 #m# f6 Force-Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{force-reload}
2035 #m# f6 Status() \kbd{/etc/init.d/\em{process}}\quad\kbd{status}
2036 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2038 local action_="${1:l}" # e.g Start/Stop/Restart
2042 local service_target_="$(readlink /etc/init.d/$service_)"
2043 if [[ $service_target_ == "/usr/bin/sv" ]]; then
2045 case "${action_}" in
2046 start) if [[ ! -e /etc/service/$service_ ]]; then
2047 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2049 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2051 # there is no reload in runits sysv emulation
2052 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2053 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2057 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2063 scripts=( /etc/init.d/*(x:t) )
2064 _describe "service startup script" scripts
2067 for i in Start Restart Stop Force-Reload Reload Status ; do
2068 eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
2069 compdef _grmlinitd $i
2073 #f1# Provides useful information on globbing
2080 p named pipes (FIFOs)
2081 * executable plain files (0100)
2082 % device files (character or block special)
2083 %b block special files
2084 %c character special files
2085 r owner-readable files (0400)
2086 w owner-writable files (0200)
2087 x owner-executable files (0100)
2088 A group-readable files (0040)
2089 I group-writable files (0020)
2090 E group-executable files (0010)
2091 R world-readable files (0004)
2092 W world-writable files (0002)
2093 X world-executable files (0001)
2094 s setuid files (04000)
2095 S setgid files (02000)
2096 t files with the sticky bit (01000)
2098 print *(m-1) # Files modified up to a day ago
2099 print *(a1) # Files accessed a day ago
2100 print *(@) # Just symlinks
2101 print *(Lk+50) # Files bigger than 50 kilobytes
2102 print *(Lk-50) # Files smaller than 50 kilobytes
2103 print **/*.c # All *.c files recursively starting in \$PWD
2104 print **/*.c~file.c # Same as above, but excluding 'file.c'
2105 print (foo|bar).* # Files starting with 'foo' or 'bar'
2106 print *~*.* # All Files that do not contain a dot
2107 chmod 644 *(.^x) # make all plain non-executable files publically readable
2108 print -l *(.c|.h) # Lists *.c and *.h
2109 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
2110 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
2112 alias help-zshglob=H-Glob
2114 #v1# set number of lines to display per page
2115 HELP_LINES_PER_PAGE=20
2116 #v1# set location of help-zle cache file
2117 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
2118 #f1# helper function for help-zle, actually generates the help text
2119 help_zle_parse_keybindings()
2123 unsetopt ksharrays #indexing starts at 1
2125 #v1# choose files that help-zle will parse for keybindings
2126 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
2128 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
2130 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
2131 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
2134 #fill with default keybindings, possibly to be overwriten in a file later
2135 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
2136 local -A help_zle_keybindings
2137 help_zle_keybindings['<Ctrl>@']="set MARK"
2138 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
2139 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
2140 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
2141 help_zle_keybindings['<Ctrl>_']="undo"
2142 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
2143 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
2144 help_zle_keybindings['<Ctrl>e']="goto end of line"
2145 help_zle_keybindings['<Ctrl>t']="transpose charaters"
2146 help_zle_keybindings['<Alt>t']="transpose words"
2147 help_zle_keybindings['<Alt>s']="spellcheck word"
2148 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
2149 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
2150 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
2151 help_zle_keybindings["<Alt>'"]="quote line"
2152 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
2153 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
2154 help_zle_keybindings['<Alt>u']="make next word Uppercase"
2155 help_zle_keybindings['<Alt>l']="make next word lowercase"
2156 help_zle_keybindings['<Ctrl>xd']="preview expansion under cursor"
2157 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
2158 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
2159 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
2160 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
2161 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
2162 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
2163 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
2164 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
2166 #init global variables
2167 unset help_zle_lines help_zle_sln
2168 typeset -g -a help_zle_lines
2169 typeset -g help_zle_sln=1
2172 local lastkeybind_desc contents #last description starting with #k# that we found
2173 local num_lines_elapsed=0 #number of lines between last description and keybinding
2174 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
2175 for f in $HELPZLE_KEYBINDING_FILES; do
2176 [[ -r "$f" ]] || continue #not readable ? skip it
2178 for cline in "${(f)contents}"; do
2179 #zsh pattern: matches lines like: #k# ..............
2180 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
2181 lastkeybind_desc="$match[*]"
2183 #zsh pattern: matches lines that set a keybinding using bindkey or compdef -k
2184 # ignores lines that are commentend out
2185 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
2186 elif [[ "$cline" == [^#]#(bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
2187 #description prevously found ? description not more than 2 lines away ? keybinding not empty ?
2188 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
2189 #substitute keybinding string with something readable
2190 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
2191 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
2192 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
2193 help_zle_keybindings[${k}]=$lastkeybind_desc
2197 ((num_lines_elapsed++))
2202 #calculate length of keybinding column
2204 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
2205 #convert the assoc array into preformated lines, which we are able to sort
2206 for k v in ${(kv)help_zle_keybindings[@]}; do
2207 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
2208 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
2210 #sort lines alphabetically
2211 help_zle_lines=("${(i)help_zle_lines[@]}")
2212 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
2213 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
2214 zcompile $HELP_ZLE_CACHE_FILE
2216 typeset -g help_zle_sln
2217 typeset -g -a help_zle_lines
2219 #f1# Provides (partially autogenerated) help on keybindings and the zsh line editor
2223 unsetopt ksharrays #indexing starts at 1
2224 #help lines already generated ? no ? then do it
2225 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
2226 #already displayed all lines ? go back to the start
2227 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
2228 local sln=$help_zle_sln
2229 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
2230 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
2231 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
2233 #k# display help for keybindings and ZLE (cycle pages with consecutive use)
2234 zle -N help-zle && bindkey '^xz' help-zle
2236 # grep for running process, like: 'any vim'
2240 if [[ -z "$1" ]] ; then
2241 echo "any - grep for process(es) by keyword" >&2
2242 echo "Usage: any <keyword>" >&2 ; return 1
2244 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
2249 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
2250 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
2251 [[ -r /proc/1/maps ]] && \
2253 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
2254 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
2255 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
2258 # a wrapper for vim, that deals with title setting
2260 # set this array to a set of options to vim you always want
2261 # to have set when calling vim (in .zshrc.local), like:
2262 # VIM_OPTIONS=( -p )
2263 # This will cause vim to send every file given on the
2264 # commandline to be send to it's own tab (needs vim7).
2265 if check_com vim; then
2267 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
2271 # make a backup of a file
2273 cp -a "$1" "${1}_$(date --iso-8601=seconds)"
2276 ssl_hashes=( sha512 sha256 sha1 md5 )
2278 for sh in ${ssl_hashes}; do
2279 eval 'ssl-cert-'${sh}'() {
2281 if [[ -z $1 ]] ; then
2282 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
2285 openssl x509 -noout -fingerprint -'${sh}' -in $1
2289 ssl-cert-fingerprints() {
2292 if [[ -z $1 ]] ; then
2293 printf 'usage: ssl-cert-fingerprints <file>\n'
2296 for i in ${ssl_hashes}
2303 if [[ -z $1 ]] ; then
2304 printf 'usage: ssl-cert-info <file>\n'
2307 openssl x509 -noout -text -in $1
2308 ssl-cert-fingerprints $1
2311 # make sure our environment is clean regarding colors
2312 for color in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $color
2314 # "persistent history"
2315 # just write important commands you always need to ~/.important_commands
2316 if [[ -r ~/.important_commands ]] ; then
2317 fc -R ~/.important_commands
2320 # load the lookup subsystem if it's available on the system
2321 zrcautoload lookupinit && lookupinit
2325 # set terminal property (used e.g. by msgid-chooser)
2326 export COLORTERM="yes"
2331 #a2# Execute \kbd{du -sch}
2333 #a2# Execute \kbd{jobs -l}
2337 #a2# Execute \kbd{ls -lSrah}
2338 alias dir="ls -lSrah"
2339 #a2# Only show dot-directories
2340 alias lad='ls -d .*(/)'
2341 #a2# Only show dot-files
2342 alias lsa='ls -a .*(.)'
2343 #a2# Only files with setgid/setuid/sticky flag
2344 alias lss='ls -l *(s,S,t)'
2345 #a2# Only show symlinks
2346 alias lsl='ls -l *(@)'
2347 #a2# Display only executables
2348 alias lsx='ls -l *(*)'
2349 #a2# Display world-{readable,writable,executable} files
2350 alias lsw='ls -ld *(R,W,X.^ND/)'
2351 #a2# Display the ten biggest files
2352 alias lsbig="ls -flh *(.OL[1,10])"
2353 #a2# Only show directories
2354 alias lsd='ls -d *(/)'
2355 #a2# Only show empty directories
2356 alias lse='ls -d *(/^F)'
2357 #a2# Display the ten newest files
2358 alias lsnew="ls -rtlh *(D.om[1,10])"
2359 #a2# Display the ten oldest files
2360 alias lsold="ls -rtlh *(D.Om[1,10])"
2361 #a2# Display the ten smallest files
2362 alias lssmall="ls -Srl *(.oL[1,10])"
2363 #a2# Display the ten newest directories and ten newest .directories
2364 alias lsnewdir="ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
2365 #a2# Display the ten oldest directories and ten oldest .directories
2366 alias lsolddir="ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
2368 # some useful aliases
2369 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir $OLDCWD}
2370 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
2372 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
2373 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
2374 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
2376 # work around non utf8 capable software in utf environment via $LANG and luit
2377 if check_com isutfenv && check_com luit ; then
2378 if check_com -c mrxvt ; then
2379 isutfenv && [[ -n "$LANG" ]] && \
2380 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
2383 if check_com -c aterm ; then
2384 isutfenv && [[ -n "$LANG" ]] && \
2385 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
2388 if check_com -c centericq ; then
2389 isutfenv && [[ -n "$LANG" ]] && \
2390 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
2396 #f5# Backup \kbd{file {\rm to} file\_timestamp}
2399 cp -b $1 $1_`date --iso-8601=m`
2402 #f5# cd to directoy and list files
2408 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
2410 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
2411 [[ ! -e ${1:h} ]] && return 1
2412 print "Correcting ${1} to ${1:h}"
2419 #f5# Create Directoy and \kbd{cd} to it
2421 if (( ARGC != 1 )); then
2422 printf 'usage: mkcd <new-directory>\n'
2425 if [[ ! -d "$1" ]]; then
2426 command mkdir -p "$1"
2428 printf '`%s'\'' already exists: cd-ing.\n' "$1"
2433 #f5# Create temporary directory and \kbd{cd} to it
2441 #f5# Create directory under cursor or the selected area
2442 # Press ctrl-xM to create the directory under the cursor or the selected area.
2443 # To select an area press ctrl-@ or ctrl-space and use the cursor.
2444 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
2445 # directory does not exist yet -> press ctrl-XM and problem solved
2448 if ((REGION_ACTIVE==1)); then
2449 local F=$MARK T=$CURSOR
2450 if [[ $F -gt $T ]]; then
2454 # get marked area from buffer and eliminate whitespace
2455 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
2456 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
2458 local bufwords iword
2459 bufwords=(${(z)LBUFFER})
2461 bufwords=(${(z)BUFFER})
2462 PATHTOMKDIR="${(Q)bufwords[iword]}"
2464 [[ -z "${PATHTOMKDIR}" ]] && return 1
2465 PATHTOMKDIR=${~PATHTOMKDIR}
2466 if [[ -e "${PATHTOMKDIR}" ]]; then
2467 zle -M " path already exists, doing nothing"
2469 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
2473 #k# mkdir -p <dir> from string under cursor or marked area
2474 zle -N inplaceMkDirs && bindkey '^xM' inplaceMkDirs
2476 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
2479 print -l -- *(a-${1:-1})
2482 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
2485 print -l -- *(c-${1:-1})
2488 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
2491 print -l -- *(m-${1:-1})
2493 # modified() was named new() in earlier versions, add an alias for backwards compatibility
2494 check_com new || alias new=modified
2496 # use colors when GNU grep with color-support
2497 #a2# Execute \kbd{grep -{}-color=auto}
2498 (( $#grep_options > 0 )) && alias grep='grep '${grep_options:+"${grep_options[*]}"}
2501 # 'translate' looks up fot a word in a file with language-to-language
2502 # translations (field separator should be " : "). A typical wordlist looks
2504 # | english-word : german-transmission
2505 # It's also only possible to translate english to german but not reciprocal.
2506 # Use the following oneliner to turn back the sort order:
2507 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
2508 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
2509 #f5# Translates a word
2514 translate -l de-en $2
2517 translate -l en-de $2
2520 echo "Usage: $0 { -D | -E }"
2521 echo " -D == German to English"
2522 echo " -E == English to German"
2526 # Usage: simple-extract <file>
2527 # Using option -d deletes the original archive file.
2528 #f5# Smart archive extractor
2531 setopt extended_glob noclobber
2532 local DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
2534 zparseopts -D -E "d=DELETE_ORIGINAL"
2535 for ARCHIVE in "${@}"; do
2537 *(tar.bz2|tbz2|tbz))
2538 DECOMP_CMD="tar -xvjf -"
2543 DECOMP_CMD="tar -xvzf -"
2547 *(tar.xz|txz|tar.lzma))
2548 DECOMP_CMD="tar -xvJf -"
2553 DECOMP_CMD="tar -xvf -"
2558 DECOMP_CMD="unrar x"
2583 DECOMP_CMD="bzip2 -d -c -"
2588 DECOMP_CMD="gzip -d -c -"
2593 DECOMP_CMD="xz -d -c -"
2598 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
2604 if ! check_com ${DECOMP_CMD[(w)1]}; then
2605 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
2610 GZTARGET="${ARCHIVE:t:r}"
2611 if [[ -f $ARCHIVE ]] ; then
2613 print "Extracting '$ARCHIVE' ..."
2614 if $USES_STDIN; then
2615 if $USES_STDOUT; then
2616 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
2618 ${=DECOMP_CMD} < "$ARCHIVE"
2621 if $USES_STDOUT; then
2622 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
2624 ${=DECOMP_CMD} "$ARCHIVE"
2627 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
2629 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
2630 if check_com curl; then
2631 WGET_CMD="curl -L -k -s -o -"
2632 elif check_com wget; then
2633 WGET_CMD="wget -q -O - --no-check-certificate"
2635 print "ERROR: neither wget nor curl is installed" >&2
2639 print "Downloading and Extracting '$ARCHIVE' ..."
2640 if $USES_STDIN; then
2641 if $USES_STDOUT; then
2642 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
2645 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
2649 if $USES_STDOUT; then
2650 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
2652 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
2657 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
2667 '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)"' \
2668 '_urls:Remote Archives:_urls'
2674 '-d[delete original archivefile after extraction]' \
2675 '*:Archive Or Uri:__archive_or_uri'
2677 compdef _simple_extract simple-extract
2678 alias se=simple-extract
2680 #f5# Set all ulimit parameters to \kbd{unlimited}
2691 #f5# Change the xterm title from within GNU-screen
2694 if [[ $1 != "-f" ]] ; then
2695 if [[ -z ${DISPLAY} ]] ; then
2696 printf 'xtrename only makes sense in X11.\n'
2702 if [[ -z $1 ]] ; then
2703 printf 'usage: xtrename [-f] "title for xterm"\n'
2704 printf ' renames the title of xterm from _within_ screen.\n'
2705 printf ' also works without screen.\n'
2706 printf ' will not work if DISPLAY is unset, use -f to override.\n'
2709 print -n "\eP\e]0;${1}\C-G\e\\"
2713 # Create small urls via http://goo.gl using curl(1).
2714 # API reference: https://code.google.com/apis/urlshortener/
2717 setopt extended_glob
2719 if [[ -z $1 ]]; then
2720 print "USAGE: zurl <URL>"
2724 local PN url prog api json contenttype item
2729 # Prepend 'http://' to given URL where necessary for later output.
2730 if [[ ${url} != http(s|)://* ]]; then
2734 if check_com -c curl; then
2737 print "curl is not available, but mandatory for ${PN}. Aborting."
2740 api='https://www.googleapis.com/urlshortener/v1/url'
2741 contenttype="Content-Type: application/json"
2742 json="{\"longUrl\": \"${url}\"}"
2743 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
2744 # Parse the response
2745 for item in "${data[@]}"; do
2750 printf '%s\n' "$item"
2758 #f2# Find history events by search pattern and list them by date.
2761 local usage help ident format_l format_s first_char remain first last
2762 usage='USAGE: whatwhen [options] <searchstring> <search range>'
2763 help='Use `whatwhen -h'\'' for further explanations.'
2764 ident=${(l,${#${:-Usage: }},, ,)}
2765 format_l="${ident}%s\t\t\t%s\n"
2766 format_s="${format_l//(\\t)##/\\t}"
2767 # Make the first char of the word to search for case
2768 # insensitive; e.g. [aA]
2769 first_char=[${(L)1[1]}${(U)1[1]}]
2771 # Default search range is `-100'.
2773 # Optional, just used for `<first> <last>' given.
2777 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
2778 printf '%s\n%s\n\n' ${usage} ${help} && return 1
2781 printf '%s\n\n' ${usage}
2783 printf $format_l '-h' 'show help text'
2785 print 'SEARCH RANGE:'
2786 printf $format_l "'0'" 'the whole history,'
2787 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
2788 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
2789 printf '\n%s\n' 'EXAMPLES:'
2790 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
2791 printf $format_l 'whatwhen zsh -250'
2792 printf $format_l 'whatwhen foo 1 99'
2795 printf '%s\n%s\n\n' ${usage} ${help} && return 1
2798 # -l list results on stout rather than invoking $EDITOR.
2799 # -i Print dates as in YYYY-MM-DD.
2800 # -m Search for a - quoted - pattern within the history.
2801 fc -li -m "*${first_char}${remain}*" $first $last
2806 # mercurial related stuff
2807 if check_com -c hg ; then
2808 # gnu like diff for mercurial
2809 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
2810 #f5# GNU like diff for mercurial
2813 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
2816 # build debian package
2817 #a2# Alias for \kbd{hg-buildpackage}
2818 alias hbp='hg-buildpackage'
2820 # execute commands on the versioned patch-queue from the current repos
2821 alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
2823 # diffstat for specific version of a mercurial repository
2824 # hgstat => display diffstat between last revision and tip
2825 # hgstat 1234 => display diffstat between revision 1234 and tip
2826 #f5# Diffstat for specific version of a mercurial repos
2829 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
2832 fi # end of check whether we have the 'hg'-executable
2834 # grml-small cleanups
2836 # The following is used to remove zsh-config-items that do not work
2837 # in grml-small by default.
2838 # If you do not want these adjustments (for whatever reason), set
2839 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
2840 # sources if it is there).
2842 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
2845 unalias 'V' &> /dev/null
2846 unfunction vman &> /dev/null
2847 unfunction viless &> /dev/null
2848 unfunction 2html &> /dev/null
2850 # manpages are not in grmlsmall
2851 unfunction manzsh &> /dev/null
2852 unfunction man2 &> /dev/null
2858 ## genrefcard.pl settings
2860 ### doc strings for external functions from files
2861 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
2863 ### example: split functions-search 8,16,24,32
2864 #@# split functions-search 8
2866 ## END OF FILE #################################################################
2867 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4