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.<7->* || $ZSH_VERSION == 4.<4->* \
149 || $ZSH_VERSION == <5->* ]] && return 0
154 [[ $ZSH_VERSION == 4.3.<9->* || $ZSH_VERSION == 4.<4->* \
155 || $ZSH_VERSION == <5->* ]] && return 0
159 #f1# Checks whether or not you're running grml
161 [[ -f /etc/grml_version ]] && return 0
165 #f1# Checks whether or not you're running a grml cd
167 [[ -f /etc/grml_cd ]] && return 0
172 #f1# Checks whether or not you're running grml-small
174 if [[ ${${${(f)"$(</etc/grml_version)"}%% *}##*-} == 'small' ]]; then
180 isgrmlsmall() { return 1 }
183 GRML_OSTYPE=$(uname -s)
186 [[ $GRML_OSTYPE == "Linux" ]]
190 [[ $GRML_OSTYPE == "Darwin" ]]
194 [[ $GRML_OSTYPE == "FreeBSD" ]]
198 [[ $GRML_OSTYPE == "OpenBSD" ]]
202 [[ $GRML_OSTYPE == "SunOS" ]]
205 #f1# are we running within an utf environment?
207 case "$LANG $CHARSET $LANGUAGE" in
214 # check for user, if not running as root set $SUDO to sudo
215 (( EUID != 0 )) && SUDO='sudo' || SUDO=''
217 # change directory to home on first invocation of zsh
218 # important for rungetty -> autologin
219 # Thanks go to Bart Schaefer!
220 isgrml && checkhome() {
221 if [[ -z "$ALREADY_DID_CD_HOME" ]] ; then
222 export ALREADY_DID_CD_HOME=$HOME
227 # check for zsh v3.1.7+
229 if ! [[ ${ZSH_VERSION} == 3.1.<7->* \
230 || ${ZSH_VERSION} == 3.<2->.<->* \
231 || ${ZSH_VERSION} == <4->.<->* ]] ; then
234 printf '-!- In this configuration we try to make use of features, that only\n'
235 printf '-!- require version 3.1.7 of the shell; That way this setup can be\n'
236 printf '-!- used with a wide range of zsh versions, while using fairly\n'
237 printf '-!- advanced features in all supported versions.\n'
239 printf '-!- However, you are running zsh version %s.\n' "$ZSH_VERSION"
241 printf '-!- While this *may* work, it might as well fail.\n'
242 printf '-!- Please consider updating to at least version 3.1.7 of zsh.\n'
244 printf '-!- DO NOT EXPECT THIS TO WORK FLAWLESSLY!\n'
245 printf '-!- If it does today, you'\''ve been lucky.\n'
247 printf '-!- Ye been warned!\n'
250 function zstyle() { : }
253 # autoload wrapper - use this one instead of autoload directly
254 # We need to define this function as early as this, because autoloading
255 # 'is-at-least()' needs it.
256 function zrcautoload() {
264 for fdir in ${fpath} ; do
265 [[ -e ${fdir}/${ffile} ]] && (( ffound = 1 ))
268 (( ffound == 0 )) && return 1
269 if [[ $ZSH_VERSION == 3.1.<6-> || $ZSH_VERSION == <4->* ]] ; then
270 autoload -U ${ffile} || return 1
272 autoload ${ffile} || return 1
277 # The following is the ‘add-zsh-hook’ function from zsh upstream. It is
278 # included here to make the setup work with older versions of zsh (prior to
279 # 4.3.7) in which this function had a bug that triggers annoying errors during
280 # shell startup. This is exactly upstreams code from f0068edb4888a4d8fe94def,
281 # with just a few adjustments in coding style to make the function look more
282 # compact. This definition can be removed as soon as we raise the minimum
283 # version requirement to 4.3.7 or newer.
284 function add-zsh-hook() {
285 # Add to HOOK the given FUNCTION.
286 # HOOK is one of chpwd, precmd, preexec, periodic, zshaddhistory,
287 # zshexit, zsh_directory_name (the _functions subscript is not required).
289 # With -d, remove the function from the hook instead; delete the hook
290 # variable if it is empty.
292 # -D behaves like -d, but pattern characters are active in the function
293 # name, so any matching function will be deleted from the hook.
295 # Without -d, the FUNCTION is marked for autoload; -U is passed down to
296 # autoload if that is given, as are -z and -k. (This is harmless if the
297 # function is actually defined inline.)
301 chpwd precmd preexec periodic zshaddhistory zshexit
304 local usage="Usage: $0 hook function\nValid hooks are:\n $hooktypes"
307 integer del list help
308 while getopts "dDhLUzk" opt; do
314 ([Uzk]) autoopts+=(-$opt) ;;
318 shift $(( OPTIND - 1 ))
320 typeset -mp "(${1:-${(@j:|:)hooktypes}})_functions"
322 elif (( help || $# != 2 || ${hooktypes[(I)$1]} == 0 )); then
323 print -u$(( 2 - help )) $usage
324 return $(( 1 - help ))
326 local hook="${1}_functions"
329 # delete, if hook is set
330 if (( ${(P)+hook} )); then
331 if (( del == 2 )); then
332 set -A $hook ${(P)hook:#${~fn}}
334 set -A $hook ${(P)hook:#$fn}
336 # unset if no remaining entries --- this can give better
337 # performance in some cases
338 if (( ! ${(P)#hook} )); then
343 if (( ${(P)+hook} )); then
344 if (( ${${(P)hook}[(I)$fn]} == 0 )); then
345 set -A $hook ${(P)hook} $fn
350 autoload $autoopts -- $fn
354 # Load is-at-least() for more precise version checks Note that this test will
355 # *always* fail, if the is-at-least function could not be marked for
357 zrcautoload is-at-least || is-at-least() { return 1 }
359 # set some important options (as early as possible)
361 # append history list to the history file; this is the default but we make sure
362 # because it's required for share_history.
363 setopt append_history
365 # import new commands from the history file also in other zsh-session
366 is4 && setopt share_history
368 # save each command's beginning timestamp and the duration to the history file
369 setopt extended_history
371 # If a new command line being added to the history list duplicates an older
372 # one, the older command is removed from the list
373 is4 && setopt histignorealldups
375 # remove command lines from the history list when the first character on the
377 setopt histignorespace
379 # if a command is issued that can't be executed as a normal command, and the
380 # command is the name of a directory, perform the cd command to that directory.
383 # in order to use #, ~ and ^ for filename generation grep word
384 # *~(*.gz|*.bz|*.bz2|*.zip|*.Z) -> searches for word not in compressed files
385 # don't forget to quote '^', '~' and '#'!
388 # display PID when suspending processes as well
391 # report the status of backgrounds jobs immediately
394 # whenever a command completion is attempted, make sure the entire command path
398 # not just at the end
399 setopt completeinword
401 # Don't send SIGHUP to background processes when the shell exits.
404 # make cd push the old directory onto the directory stack.
410 # don't push the same dir twice.
411 setopt pushd_ignore_dups
413 # * shouldn't match dotfiles. ever.
416 # use zsh style word splitting
419 # don't error out when unset parameters are used
422 # setting some default values
425 NOPRECMD=${NOPRECMD:-0}
426 COMMAND_NOT_FOUND=${COMMAND_NOT_FOUND:-0}
427 GRML_ZSH_CNF_HANDLER=${GRML_ZSH_CNF_HANDLER:-/usr/share/command-not-found/command-not-found}
428 GRML_DISPLAY_BATTERY=${GRML_DISPLAY_BATTERY:-${BATTERY:-0}}
429 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
430 ZSH_NO_DEFAULT_LOCALE=${ZSH_NO_DEFAULT_LOCALE:-0}
432 typeset -ga ls_options
433 typeset -ga grep_options
435 # Colors on GNU ls(1)
436 if ls --color=auto / >/dev/null 2>&1; then
437 ls_options+=( --color=auto )
438 # Colors on FreeBSD and OSX ls(1)
439 elif ls -G / >/dev/null 2>&1; then
443 # Natural sorting order on GNU ls(1)
444 if ls -v / >/dev/null 2>&1; then
448 # Color on GNU and FreeBSD grep(1)
449 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
450 grep_options+=( --color=auto )
454 # this function checks if a command exists and returns either true
455 # or false. This avoids using 'which' and 'whence', which will
456 # avoid problems with aliases for which on certain weird systems. :-)
457 # Usage: check_com [-c|-g] word
458 # -c only checks for external commands
459 # -g does the usual tests and also checks for global aliases
462 local -i comonly gatoo
464 if [[ $1 == '-c' ]] ; then
467 elif [[ $1 == '-g' ]] ; then
474 if (( ${#argv} != 1 )) ; then
475 printf 'usage: check_com [-c] <command>\n' >&2
479 if (( comonly > 0 )) ; then
480 [[ -n ${commands[$1]} ]] && return 0
484 if [[ -n ${commands[$1]} ]] \
485 || [[ -n ${functions[$1]} ]] \
486 || [[ -n ${aliases[$1]} ]] \
487 || [[ -n ${reswords[(r)$1]} ]] ; then
492 if (( gatoo > 0 )) && [[ -n ${galiases[$1]} ]] ; then
499 # creates an alias and precedes the command with
500 # sudo if $EUID is not zero.
503 local only=0 ; local multi=0
505 while getopts ":hao" opt; do
510 printf 'usage: salias [-hoa] <alias-expression>\n'
511 printf ' -h shows this help text.\n'
512 printf ' -a replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
513 printf ' be careful using this option.\n'
514 printf ' -o only sets an alias if a preceding sudo would be needed.\n'
517 *) salias -h >&2; return 1 ;;
520 shift "$((OPTIND-1))"
522 if (( ${#argv} > 1 )) ; then
523 printf 'Too many arguments %s\n' "${#argv}"
527 key="${1%%\=*}" ; val="${1#*\=}"
528 if (( EUID == 0 )) && (( only == 0 )); then
529 alias -- "${key}=${val}"
530 elif (( EUID > 0 )) ; then
531 (( multi > 0 )) && val="${val// ; / ; sudo }"
532 alias -- "${key}=sudo ${val}"
538 # Check if we can read given files and source those we can.
540 if (( ${#argv} < 1 )) ; then
541 printf 'usage: xsource FILE(s)...\n' >&2
545 while (( ${#argv} > 0 )) ; do
546 [[ -r "$1" ]] && source "$1"
552 # Check if we can read a given file and 'cat(1)' it.
555 if (( ${#argv} != 1 )) ; then
556 printf 'usage: xcat FILE\n' >&2
560 [[ -r $1 ]] && cat $1
564 # Remove these functions again, they are of use only in these
565 # setup files. This should be called at the end of .zshrc.
570 funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
571 for func in $funcs ; do
572 [[ -n ${functions[$func]} ]] \
578 # this allows us to stay in sync with grml's zshrc and put own
579 # modifications in ~/.zshrc.local
581 xsource "/etc/zsh/zshrc.local"
582 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
587 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
588 xsource "/etc/default/locale"
591 for var in LANG LC_ALL LC_MESSAGES ; do
592 [[ -n ${(P)var} ]] && export $var
597 if check_com -c vim ; then
599 export EDITOR=${EDITOR:-vim}
601 export EDITOR=${EDITOR:-vi}
605 export PAGER=${PAGER:-less}
608 export MAIL=${MAIL:-/var/mail/$USER}
610 # color setup for ls:
611 check_com -c dircolors && eval $(dircolors -b)
612 # color setup for ls on OS X / FreeBSD:
613 isdarwin && export CLICOLOR=1
614 isfreebsd && export CLICOLOR=1
616 # do MacPorts setup on darwin
617 if isdarwin && [[ -d /opt/local ]]; then
618 # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
620 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
621 MANPATH="/opt/local/share/man:$MANPATH"
623 # do Fink setup on darwin
624 isdarwin && xsource /sw/bin/init.sh
626 # load our function and completion directories
627 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
628 fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
629 if [[ ${fdir} == '/usr/share/grml/zsh/functions' ]] ; then
630 for func in ${fdir}/**/[^_]*[^~](N.) ; do
631 zrcautoload ${func:t}
637 # support colors in less
638 export LESS_TERMCAP_mb=$'\E[01;31m'
639 export LESS_TERMCAP_md=$'\E[01;31m'
640 export LESS_TERMCAP_me=$'\E[0m'
641 export LESS_TERMCAP_se=$'\E[0m'
642 export LESS_TERMCAP_so=$'\E[01;44;33m'
643 export LESS_TERMCAP_ue=$'\E[0m'
644 export LESS_TERMCAP_us=$'\E[01;32m'
649 # report about cpu-/system-/user-time of command if running longer than
653 # watch for everyone but me and root
656 # automatically remove duplicates from these arrays
657 typeset -U path cdpath fpath manpath
661 for mod in parameter complist deltochar mathfunc ; do
662 zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
663 done && builtin unset -v mod
665 # autoload zsh modules when they are referenced
667 zmodload -a zsh/stat zstat
668 zmodload -a zsh/zpty zpty
669 zmodload -ap zsh/mapfile mapfile
673 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
674 if zrcautoload compinit ; then
675 compinit -d ${COMPDUMPFILE} || print 'Notice: no compinit available :('
677 print 'Notice: no compinit available :('
683 # called later (via is4 && grmlcomp)
684 # note: use 'zstyle' for getting current settings
685 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
687 # TODO: This could use some additional information
689 # Make sure the completion system is initialised
690 (( ${+_comps} )) || return 1
692 # allow one error for every three characters typed in approximate completer
693 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
695 # don't complete backup files as executables
696 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
698 # start menu completion only if it could find no unambiguous initial string
699 zstyle ':completion:*:correct:*' insert-unambiguous true
700 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
701 zstyle ':completion:*:correct:*' original true
703 # activate color-completion
704 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
706 # format on completion
707 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
709 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
710 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
712 # insert all expansions for expand completer
713 zstyle ':completion:*:expand:*' tag-order all-expansions
714 zstyle ':completion:*:history-words' list false
717 zstyle ':completion:*:history-words' menu yes
719 # ignore duplicate entries
720 zstyle ':completion:*:history-words' remove-all-dups yes
721 zstyle ':completion:*:history-words' stop yes
723 # match uppercase from lowercase
724 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
726 # separate matches into groups
727 zstyle ':completion:*:matches' group 'yes'
728 zstyle ':completion:*' group-name ''
730 if [[ "$NOMENU" -eq 0 ]] ; then
731 # if there are more than 5 options allow selecting from a menu
732 zstyle ':completion:*' menu select=5
734 # don't use any menus at all
738 zstyle ':completion:*:messages' format '%d'
739 zstyle ':completion:*:options' auto-description '%d'
741 # describe options in full
742 zstyle ':completion:*:options' description 'yes'
744 # on processes completion complete all user processes
745 zstyle ':completion:*:processes' command 'ps -au$USER'
747 # offer indexes before parameters in subscripts
748 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
750 # provide verbose completion information
751 zstyle ':completion:*' verbose true
753 # recent (as of Dec 2007) zsh versions are able to provide descriptions
754 # for commands (read: 1st word in the line) that it will list for the user
755 # to choose from. The following disables that, because it's not exactly fast.
756 zstyle ':completion:*:-command-:*:' verbose false
758 # set format for warnings
759 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
761 # define files to ignore for zcompile
762 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
763 zstyle ':completion:correct:' prompt 'correct to: %e'
765 # Ignore completion functions for commands you don't have:
766 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
768 # Provide more processes in completion of programs like killall:
769 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
771 # complete manual by their section
772 zstyle ':completion:*:manuals' separate-sections true
773 zstyle ':completion:*:manuals.*' insert-sections true
774 zstyle ':completion:*:man:*' menu yes select
776 # Search path for sudo completion
777 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
785 # provide .. as a completion
786 zstyle ':completion:*' special-dirs ..
788 # run rehash on completion so new installed program are found automatically:
790 (( CURRENT == 1 )) && rehash
795 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
796 if [[ "$NOCOR" -gt 0 ]] ; then
797 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
800 # try to be smart about when to use what completer...
802 zstyle -e ':completion:*' completer '
803 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
804 _last_try="$HISTNO$BUFFER$CURSOR"
805 reply=(_complete _match _ignored _prefix _files)
807 if [[ $words[1] == (rm|mv) ]] ; then
808 reply=(_complete _files)
810 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
815 # command for process lists, the local web server details and host completion
816 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
818 # Some functions, like _apt and _dpkg, are very slow. We can use a cache in
819 # order to speed things up
820 if [[ ${GRML_COMP_CACHING:-yes} == yes ]]; then
821 GRML_COMP_CACHE_DIR=${GRML_COMP_CACHE_DIR:-${ZDOTDIR:-$HOME}/.cache}
822 if [[ ! -d ${GRML_COMP_CACHE_DIR} ]]; then
823 command mkdir -p "${GRML_COMP_CACHE_DIR}"
825 zstyle ':completion:*' use-cache yes
826 zstyle ':completion:*:complete:*' cache-path "${GRML_COMP_CACHE_DIR}"
831 [[ -r ~/.ssh/config ]] && _ssh_config_hosts=(${${(s: :)${(ps:\t:)${${(@M)${(f)"$(<$HOME/.ssh/config)"}:#Host *}#Host }}}:#*[*?]*}) || _ssh_config_hosts=()
832 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
833 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
841 "$_ssh_config_hosts[@]"
846 zstyle ':completion:*:hosts' hosts $hosts
847 # TODO: so, why is this here?
848 # zstyle '*' hosts $hosts
850 # use generic completion system for programs not yet defined; (_gnu_generic works
851 # with commands that provide a --help option with "standard" gnu-like output.)
852 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
854 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
857 # see upgrade function in this file
858 compdef _hosts upgrade
861 # Keyboard setup: The following is based on the same code, we wrote for
862 # debian's setup. It ensures the terminal is in the right mode, when zle is
863 # active, so the values from $terminfo are valid. Therefore, this setup should
864 # work on all systems, that have support for `terminfo'. It also requires the
865 # zsh in use to have the `zsh/terminfo' module built.
867 # If you are customising your `zle-line-init()' or `zle-line-finish()'
868 # functions, make sure you call the following utility functions in there:
870 # - zle-line-init(): zle-smkx
871 # - zle-line-finish(): zle-rmkx
873 # Use emacs-like key bindings by default:
878 ## beginning-of-line OR beginning-of-buffer OR beginning of history
879 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
880 beginning-or-end-of-somewhere() {
882 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
883 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
884 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
886 zle .${WIDGET:s/somewhere/line-hist/} "$@"
887 if (( HISTNO != hno )); then
888 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
892 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
893 zle -N end-of-somewhere beginning-or-end-of-somewhere
895 # add a command line to the shells history without executing it
896 commit-to-history() {
897 print -s ${(z)BUFFER}
900 zle -N commit-to-history
902 # only slash should be considered as a word separator:
903 slash-backward-kill-word() {
904 local WORDCHARS="${WORDCHARS:s@/@}"
906 zle backward-kill-word
908 zle -N slash-backward-kill-word
910 # a generic accept-line wrapper
912 # This widget can prevent unwanted autocorrections from command-name
913 # to _command-name, rehash automatically on enter and call any number
914 # of builtin and user-defined widgets in different contexts.
916 # For a broader description, see:
917 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
919 # The code is imported from the file 'zsh/functions/accept-line' from
920 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
921 # distributed under the same terms as zsh itself.
923 # A newly added command will may not be found or will cause false
924 # correction attempts, if you got auto-correction set. By setting the
925 # following style, we force accept-line() to rehash, if it cannot
926 # find the first word on the command line in the $command[] hash.
927 zstyle ':acceptline:*' rehash true
929 function Accept-Line() {
930 setopt localoptions noksharrays
934 local alcontext=${1:-$alcontext}
936 zstyle -a ":acceptline:${alcontext}" actions subs
938 (( ${#subs} < 1 )) && return 0
941 for sub in ${subs} ; do
942 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
945 (( aldone > 0 )) && break
949 function Accept-Line-getdefault() {
953 zstyle -s ":acceptline:${alcontext}" default_action default_action
954 case ${default_action} in
956 printf ".accept-line"
959 printf ${default_action}
964 function Accept-Line-HandleContext() {
967 default_action=$(Accept-Line-getdefault)
968 zstyle -T ":acceptline:${alcontext}" call_default \
969 && zle ${default_action}
972 function accept-line() {
973 setopt localoptions noksharrays
976 local buf com fname format msg default_action
980 cmdline=(${(z)BUFFER})
984 Accept-Line 'preprocess'
986 zstyle -t ":acceptline:${alcontext}" rehash \
987 && [[ -z ${commands[$com]} ]] \
991 && [[ -n ${reswords[(r)$com]} ]] \
992 || [[ -n ${aliases[$com]} ]] \
993 || [[ -n ${functions[$com]} ]] \
994 || [[ -n ${builtins[$com]} ]] \
995 || [[ -n ${commands[$com]} ]] ; then
997 # there is something sensible to execute, just do it.
999 Accept-Line-HandleContext
1004 if [[ -o correct ]] \
1005 || [[ -o correctall ]] \
1006 && [[ -n ${functions[$fname]} ]] ; then
1008 # nothing there to execute but there is a function called
1009 # _command_name; a completion widget. Makes no sense to
1010 # call it on the commandline, but the correct{,all} options
1011 # will ask for it nevertheless, so warn the user.
1012 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
1013 # Okay, we warned the user before, he called us again,
1014 # so have it his way.
1016 Accept-Line-HandleContext
1021 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
1023 Accept-Line-HandleContext
1025 # prepare warning message for the user, configurable via zstyle.
1026 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
1028 if [[ -z ${msg} ]] ; then
1029 msg="%c will not execute and completion %f exists."
1032 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
1037 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
1038 # If we are here, the commandline contains something that is not
1039 # executable, which is neither subject to _command_name correction
1040 # and is not empty. might be a variable assignment
1042 Accept-Line-HandleContext
1047 # If we got this far, the commandline only contains whitespace, or is empty.
1049 Accept-Line-HandleContext
1054 zle -N Accept-Line-HandleContext
1056 # power completion / abbreviation expansion / buffer expansion
1057 # see http://zshwiki.org/home/examples/zleiab for details
1058 # less risky than the global aliases but powerful as well
1059 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
1062 setopt interactivecomments
1064 # key # value (#d additional doc string)
1070 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1072 'Hl' ' --help |& less -r' #d (Display help in pager)
1076 'N' '&>/dev/null' #d (No Output)
1077 'R' '| tr A-z N-za-m' #d (ROT13)
1078 'SL' '| sort | less'
1083 'co' './configure && make && sudo make install'
1091 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1092 LBUFFER+=${abk[$MATCH]:-$MATCH}
1099 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1102 zle -N help-show-abk
1104 # press "ctrl-e d" to insert the actual date in the form yyyy-mm-dd
1105 insert-datestamp() { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1106 zle -N insert-datestamp
1108 # press esc-m for inserting last typed word again (thanks to caphuso!)
1109 insert-last-typed-word() { zle insert-last-word -- 0 -1 };
1110 zle -N insert-last-typed-word;
1112 function grml-zsh-fg() {
1113 if (( ${#jobstates} )); then
1115 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1116 BUFFER="${BUFFER}fg"
1119 zle -M 'No background jobs. Doing nothing.'
1124 # run command line as user root via sudo:
1125 sudo-command-line() {
1126 [[ -z $BUFFER ]] && zle up-history
1127 if [[ $BUFFER != sudo\ * ]]; then
1128 BUFFER="sudo $BUFFER"
1129 CURSOR=$(( CURSOR+5 ))
1132 zle -N sudo-command-line
1134 ### jump behind the first word on the cmdline.
1135 ### useful to add options.
1136 function jump_after_first_word() {
1138 words=(${(z)BUFFER})
1140 if (( ${#words} <= 1 )) ; then
1143 CURSOR=${#${words[1]}}
1146 zle -N jump_after_first_word
1148 #f5# Create directory under cursor or the selected area
1150 # Press ctrl-xM to create the directory under the cursor or the selected area.
1151 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1152 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1153 # directory does not exist yet -> press ctrl-XM and problem solved
1155 if ((REGION_ACTIVE==1)); then
1156 local F=$MARK T=$CURSOR
1157 if [[ $F -gt $T ]]; then
1161 # get marked area from buffer and eliminate whitespace
1162 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1163 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1165 local bufwords iword
1166 bufwords=(${(z)LBUFFER})
1168 bufwords=(${(z)BUFFER})
1169 PATHTOMKDIR="${(Q)bufwords[iword]}"
1171 [[ -z "${PATHTOMKDIR}" ]] && return 1
1172 PATHTOMKDIR=${~PATHTOMKDIR}
1173 if [[ -e "${PATHTOMKDIR}" ]]; then
1174 zle -M " path already exists, doing nothing"
1176 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1181 zle -N inplaceMkDirs
1183 #v1# set number of lines to display per page
1184 HELP_LINES_PER_PAGE=20
1185 #v1# set location of help-zle cache file
1186 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1187 # helper function for help-zle, actually generates the help text
1188 help_zle_parse_keybindings()
1192 unsetopt ksharrays #indexing starts at 1
1194 #v1# choose files that help-zle will parse for keybindings
1195 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1197 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1200 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1201 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1204 #fill with default keybindings, possibly to be overwriten in a file later
1205 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1206 local -A help_zle_keybindings
1207 help_zle_keybindings['<Ctrl>@']="set MARK"
1208 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1209 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1210 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1211 help_zle_keybindings['<Ctrl>_']="undo"
1212 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1213 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1214 help_zle_keybindings['<Ctrl>e']="goto end of line"
1215 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1216 help_zle_keybindings['<Alt>t']="transpose words"
1217 help_zle_keybindings['<Alt>s']="spellcheck word"
1218 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1219 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1220 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1221 help_zle_keybindings["<Alt>'"]="quote line"
1222 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1223 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1224 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1225 help_zle_keybindings['<Alt>l']="make next word lowercase"
1226 help_zle_keybindings['<Ctrl>xd']="preview expansion under cursor"
1227 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1228 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1229 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1230 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1231 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1232 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1233 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1234 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1236 #init global variables
1237 unset help_zle_lines help_zle_sln
1238 typeset -g -a help_zle_lines
1239 typeset -g help_zle_sln=1
1242 local lastkeybind_desc contents #last description starting with #k# that we found
1243 local num_lines_elapsed=0 #number of lines between last description and keybinding
1244 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1245 for f in $HELPZLE_KEYBINDING_FILES; do
1246 [[ -r "$f" ]] || continue #not readable ? skip it
1248 for cline in "${(f)contents}"; do
1249 #zsh pattern: matches lines like: #k# ..............
1250 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1251 lastkeybind_desc="$match[*]"
1253 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1254 # ignores lines that are commentend out
1255 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1256 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1257 #description prevously found ? description not more than 2 lines away ? keybinding not empty ?
1258 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1259 #substitute keybinding string with something readable
1260 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1261 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1262 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1263 help_zle_keybindings[${k}]=$lastkeybind_desc
1267 ((num_lines_elapsed++))
1272 #calculate length of keybinding column
1274 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1275 #convert the assoc array into preformated lines, which we are able to sort
1276 for k v in ${(kv)help_zle_keybindings[@]}; do
1277 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1278 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1280 #sort lines alphabetically
1281 help_zle_lines=("${(i)help_zle_lines[@]}")
1282 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1283 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1284 zcompile $HELP_ZLE_CACHE_FILE
1286 typeset -g help_zle_sln
1287 typeset -g -a help_zle_lines
1289 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1293 unsetopt ksharrays #indexing starts at 1
1294 #help lines already generated ? no ? then do it
1295 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1296 #already displayed all lines ? go back to the start
1297 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1298 local sln=$help_zle_sln
1299 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1300 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1301 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1305 ## complete word from currently visible Screen or Tmux buffer.
1306 if check_com -c screen || check_com -c tmux; then
1307 _complete_screen_display() {
1308 [[ "$TERM" != "screen" ]] && return 1
1310 local TMPFILE=$(mktemp)
1311 local -U -a _screen_display_wordlist
1312 trap "rm -f $TMPFILE" EXIT
1314 # fill array with contents from screen hardcopy
1315 if ((${+TMUX})); then
1316 #works, but crashes tmux below version 1.4
1317 #luckily tmux -V option to ask for version, was also added in 1.4
1318 tmux -V &>/dev/null || return
1319 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1321 screen -X hardcopy $TMPFILE
1322 # screen sucks, it dumps in latin1, apparently always. so recode it
1324 check_com recode && recode latin1 $TMPFILE
1326 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1327 # remove PREFIX to be completed from that array
1328 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1329 compadd -a _screen_display_wordlist
1331 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1333 compdef -k _complete_screen_display complete-word '^xS'
1336 # Load a few more functions and tie them to widgets, so they can be bound:
1338 function zrcautozle() {
1341 zrcautoload $fnc && zle -N $fnc
1344 function zrcgotwidget() {
1345 (( ${+widgets[$1]} ))
1348 function zrcgotkeymap() {
1349 [[ -n ${(M)keymaps:#$1} ]]
1352 zrcautozle insert-files
1353 zrcautozle edit-command-line
1354 zrcautozle insert-unicode-char
1355 if zrcautoload history-search-end; then
1356 zle -N history-beginning-search-backward-end history-search-end
1357 zle -N history-beginning-search-forward-end history-search-end
1359 zle -C hist-complete complete-word _generic
1360 zstyle ':completion:hist-complete:*' completer _history
1362 # The actual terminal setup hooks and bindkey-calls:
1364 # An array to note missing features to ease diagnosis in case of problems.
1365 typeset -ga grml_missing_features
1367 function zrcbindkey() {
1368 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1373 function bind2maps () {
1374 local i sequence widget
1377 while [[ "$1" != "--" ]]; do
1383 if [[ "$1" == "-s" ]]; then
1387 sequence="${key[$1]}"
1391 [[ -z "$sequence" ]] && return 1
1393 for i in "${maps[@]}"; do
1394 zrcbindkey -M "$i" "$sequence" "$widget"
1398 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1399 function zle-smkx () {
1401 printf '%s' ${terminfo[smkx]}
1403 function zle-rmkx () {
1405 printf '%s' ${terminfo[rmkx]}
1407 function zle-line-init () {
1410 function zle-line-finish () {
1413 zle -N zle-line-init
1414 zle -N zle-line-finish
1416 for i in {s,r}mkx; do
1417 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1424 Home "${terminfo[khome]}"
1425 End "${terminfo[kend]}"
1426 Insert "${terminfo[kich1]}"
1427 Delete "${terminfo[kdch1]}"
1428 Up "${terminfo[kcuu1]}"
1429 Down "${terminfo[kcud1]}"
1430 Left "${terminfo[kcub1]}"
1431 Right "${terminfo[kcuf1]}"
1432 PageUp "${terminfo[kpp]}"
1433 PageDown "${terminfo[knp]}"
1434 BackTab "${terminfo[kcbt]}"
1437 # Guidelines for adding key bindings:
1439 # - Do not add hardcoded escape sequences, to enable non standard key
1440 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1442 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1445 # - All keys from the $key[] mapping are obviously okay.
1447 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1448 # '\ex' are allowed in here as well.
1450 bind2maps emacs -- Home beginning-of-somewhere
1451 bind2maps viins vicmd -- Home vi-beginning-of-line
1452 bind2maps emacs -- End end-of-somewhere
1453 bind2maps viins vicmd -- End vi-end-of-line
1454 bind2maps emacs viins -- Insert overwrite-mode
1455 bind2maps vicmd -- Insert vi-insert
1456 bind2maps emacs -- Delete delete-char
1457 bind2maps viins vicmd -- Delete vi-delete-char
1458 bind2maps emacs viins vicmd -- Up up-line-or-search
1459 bind2maps emacs viins vicmd -- Down down-line-or-search
1460 bind2maps emacs -- Left backward-char
1461 bind2maps viins vicmd -- Left vi-backward-char
1462 bind2maps emacs -- Right forward-char
1463 bind2maps viins vicmd -- Right vi-forward-char
1464 #k# Perform abbreviation expansion
1465 bind2maps emacs viins -- -s '^x.' zleiab
1466 #k# Display list of abbreviations that would expand
1467 bind2maps emacs viins -- -s '^xb' help-show-abk
1468 #k# mkdir -p <dir> from string under cursor or marked area
1469 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1470 #k# display help for keybindings and ZLE
1471 bind2maps emacs viins -- -s '^xz' help-zle
1472 #k# Insert files and test globbing
1473 bind2maps emacs viins -- -s "^xf" insert-files
1474 #k# Edit the current line in \kbd{\$EDITOR}
1475 bind2maps emacs viins -- -s '\ee' edit-command-line
1476 #k# search history backward for entry beginning with typed text
1477 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1478 #k# search history forward for entry beginning with typed text
1479 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1480 #k# search history backward for entry beginning with typed text
1481 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1482 #k# search history forward for entry beginning with typed text
1483 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1484 bind2maps emacs viins -- -s "^x^h" commit-to-history
1485 #k# Kill left-side word or everything up to next slash
1486 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1487 #k# Kill left-side word or everything up to next slash
1488 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1489 #k# Kill left-side word or everything up to next slash
1490 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1491 # Do history expansion on space:
1492 bind2maps emacs viins -- -s ' ' magic-space
1493 #k# Trigger menu-complete
1494 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1495 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1496 bind2maps emacs viins -- -s '^ed' insert-datestamp
1497 #k# Insert last typed word
1498 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1499 #k# A smart shortcut for \kbd{fg<enter>}
1500 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1501 #k# prepend the current command with "sudo"
1502 bind2maps emacs viins -- -s "^os" sudo-command-line
1503 #k# jump to after first word (for adding options)
1504 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1505 #k# complete word from history with menu
1506 bind2maps emacs viins -- -s "^x^x" hist-complete
1508 # insert unicode character
1509 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1510 # See for example http://unicode.org/charts/ for unicode characters code
1511 #k# Insert Unicode character
1512 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1514 # use the new *-pattern-* widgets for incremental history search
1515 if zrcgotwidget history-incremental-pattern-search-backward; then
1516 for seq wid in '^r' history-incremental-pattern-search-backward \
1517 '^s' history-incremental-pattern-search-forward
1519 bind2maps emacs viins vicmd -- -s $seq $wid
1521 builtin unset -v seq wid
1524 if zrcgotkeymap menuselect; then
1525 #m# k Shift-tab Perform backwards menu completion
1526 bind2maps menuselect -- BackTab reverse-menu-complete
1528 #k# menu selection: pick item but stay in the menu
1529 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1530 # also use + and INSERT since it's easier to press repeatedly
1531 bind2maps menuselect -- -s '+' accept-and-menu-complete
1532 bind2maps menuselect -- Insert accept-and-menu-complete
1534 # accept a completion and try to complete again by using menu
1535 # completion; very useful with completing directories
1536 # by using 'undo' one's got a simple file browser
1537 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1540 # Finally, here are still a few hardcoded escape sequences; Special sequences
1541 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1542 # standardised and most of the time are not available in a terminals terminfo
1545 # While we do not encourage adding bindings like these, we will keep these for
1546 # backward compatibility.
1548 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1549 ## the command line.
1551 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1552 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1553 # These are for xterm:
1554 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1555 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1556 ## the same for alt-left-arrow and alt-right-arrow
1558 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1559 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1561 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1562 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1563 # Also try ESC Left/Right:
1564 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1565 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1572 # we don't want to quote/espace URLs on our own...
1573 # if autoload -U url-quote-magic ; then
1574 # zle -N self-insert url-quote-magic
1575 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1577 # print 'Notice: no url-quote-magic available :('
1579 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1581 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1582 alias run-help >&/dev/null && unalias run-help
1583 for rh in run-help{,-git,-svk,-svn}; do
1587 # command not found handling
1589 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1590 function command_not_found_handler() {
1592 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1593 ${GRML_ZSH_CNF_HANDLER} $1
1601 HISTFILE=${ZDOTDIR:-${HOME}}/.zsh_history
1602 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1603 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1607 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1608 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1610 typeset -gaU GRML_PERSISTENT_DIRSTACK
1611 function grml_dirstack_filter() {
1614 if zstyle -s ':grml:chpwd:dirstack' filter filter; then
1615 $filter $1 && return 0
1617 if zstyle -a ':grml:chpwd:dirstack' exclude exclude; then
1618 for entry in "${exclude[@]}"; do
1619 [[ $1 == ${~entry} ]] && return 0
1626 (( $DIRSTACKSIZE <= 0 )) && return
1627 [[ -z $DIRSTACKFILE ]] && return
1628 grml_dirstack_filter $PWD && return
1629 GRML_PERSISTENT_DIRSTACK=(
1630 $PWD "${(@)GRML_PERSISTENT_DIRSTACK[1,$DIRSTACKSIZE]}"
1632 builtin print -l ${GRML_PERSISTENT_DIRSTACK} >! ${DIRSTACKFILE}
1635 if [[ -f ${DIRSTACKFILE} ]]; then
1636 # Enabling NULL_GLOB via (N) weeds out any non-existing
1637 # directories from the saved dir-stack file.
1638 dirstack=( ${(f)"$(< $DIRSTACKFILE)"}(N) )
1639 # "cd -" won't work after login by just setting $OLDPWD, so
1640 [[ -d $dirstack[1] ]] && cd -q $dirstack[1] && cd -q $OLDPWD
1643 if zstyle -T ':grml:chpwd:dirstack' filter-on-load; then
1644 for i in "${dirstack[@]}"; do
1645 if ! grml_dirstack_filter "$i"; then
1646 GRML_PERSISTENT_DIRSTACK=(
1647 "${GRML_PERSISTENT_DIRSTACK[@]}"
1653 GRML_PERSISTENT_DIRSTACK=( "${dirstack[@]}" )
1656 # directory based profiles
1660 # chpwd_profiles(): Directory Profiles, Quickstart:
1664 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1665 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1668 # For details see the `grmlzshrc.5' manual page.
1669 function chpwd_profiles() {
1670 local profile context
1673 context=":chpwd:profiles:$PWD"
1674 zstyle -s "$context" profile profile || profile='default'
1675 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1677 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1678 typeset -g CHPWD_PROFILE
1679 local CHPWD_PROFILES_INIT=1
1680 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1681 elif [[ $profile != $CHPWD_PROFILE ]]; then
1682 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1683 && chpwd_leave_profile_${CHPWD_PROFILE}
1685 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1686 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1689 CHPWD_PROFILE="${profile}"
1693 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1697 # Prompt setup for grml:
1699 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1700 # in prompts to get a red "foo" embedded, but it's good to keep these for
1701 # backwards compatibility).
1707 MAGENTA="%F{magenta}"
1711 elif zrcautoload colors && colors 2>/dev/null ; then
1712 BLUE="%{${fg[blue]}%}"
1713 RED="%{${fg_bold[red]}%}"
1714 GREEN="%{${fg[green]}%}"
1715 CYAN="%{${fg[cyan]}%}"
1716 MAGENTA="%{${fg[magenta]}%}"
1717 YELLOW="%{${fg[yellow]}%}"
1718 WHITE="%{${fg[white]}%}"
1719 NO_COLOR="%{${reset_color}%}"
1721 BLUE=$'%{\e[1;34m%}'
1723 GREEN=$'%{\e[1;32m%}'
1724 CYAN=$'%{\e[1;36m%}'
1725 WHITE=$'%{\e[1;37m%}'
1726 MAGENTA=$'%{\e[1;35m%}'
1727 YELLOW=$'%{\e[1;33m%}'
1728 NO_COLOR=$'%{\e[0m%}'
1731 # First, the easy ones: PS2..4:
1733 # secondary prompt, printed when the shell needs more information to complete a
1736 # selection prompt used within a select loop.
1738 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1741 # Some additional features to use with our prompt:
1745 # - vcs_info setup and version specific fixes
1747 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1750 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1753 elif isopenbsd ; then
1755 elif isfreebsd ; then
1757 elif isdarwin ; then
1761 GRML_DISPLAY_BATTERY=0
1767 GRML_BATTERY_LEVEL=''
1768 local batteries bat capacity
1769 batteries=( /sys/class/power_supply/BAT*(N) )
1770 if (( $#batteries > 0 )) ; then
1771 for bat in $batteries ; do
1772 capacity=$(< $bat/capacity)
1773 case $(< $bat/status) in
1775 GRML_BATTERY_LEVEL+=" ^"
1778 if (( capacity < 20 )) ; then
1779 GRML_BATTERY_LEVEL+=" !v"
1781 GRML_BATTERY_LEVEL+=" v"
1785 GRML_BATTERY_LEVEL+=" ="
1788 GRML_BATTERY_LEVEL+="${capacity}%%"
1794 GRML_BATTERY_LEVEL=''
1795 local bat batfull batwarn batnow num
1797 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1798 if [[ -n $bat ]]; then
1799 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1800 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1801 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1802 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1804 if (( batnow < batwarn )) ; then
1805 GRML_BATTERY_LEVEL+=" !v"
1807 GRML_BATTERY_LEVEL+=" v"
1811 GRML_BATTERY_LEVEL+=" ^"
1814 GRML_BATTERY_LEVEL+=" ="
1817 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1823 GRML_BATTERY_LEVEL=''
1827 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1828 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1829 case $table[State] in
1831 if (( $table[Remaining-capacity] < 20 )) ; then
1832 GRML_BATTERY_LEVEL+=" !v"
1834 GRML_BATTERY_LEVEL+=" v"
1838 GRML_BATTERY_LEVEL+=" ^"
1841 GRML_BATTERY_LEVEL+=" ="
1844 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1850 GRML_BATTERY_LEVEL=''
1852 table=( ${$(pmset -g ps)[(w)7,8]%%(\%|);} )
1853 if [[ -n $table[2] ]] ; then
1856 GRML_BATTERY_LEVEL+=" ^"
1859 if (( $table[1] < 20 )) ; then
1860 GRML_BATTERY_LEVEL+=" !v"
1862 GRML_BATTERY_LEVEL+=" v"
1866 GRML_BATTERY_LEVEL+=" ="
1869 GRML_BATTERY_LEVEL+="$table[1]%%"
1873 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1874 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1875 debian_chroot=$(</etc/debian_chroot)
1878 # gather version control information for inclusion in a prompt
1880 if zrcautoload vcs_info; then
1881 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1882 # function, which can cause a lot of trouble with our directory-based
1884 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1885 function VCS_INFO_realpath () {
1886 setopt localoptions NO_shwordsplit chaselinks
1887 ( builtin cd -q $1 2> /dev/null && pwd; )
1891 zstyle ':vcs_info:*' max-exports 2
1893 if [[ -o restricted ]]; then
1894 zstyle ':vcs_info:*' enable NONE
1898 typeset -A grml_vcs_coloured_formats
1899 typeset -A grml_vcs_plain_formats
1901 grml_vcs_plain_formats=(
1902 format "(%s%)-[%b] " "zsh: %r"
1903 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1904 rev-branchformat "%b:%r"
1907 grml_vcs_coloured_formats=(
1908 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1909 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1910 rev-branchformat "%b${RED}:${YELLOW}%r"
1913 typeset GRML_VCS_COLOUR_MODE=xxx
1915 grml_vcs_info_toggle_colour () {
1917 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
1918 grml_vcs_info_set_formats coloured
1920 grml_vcs_info_set_formats plain
1925 grml_vcs_info_set_formats () {
1927 #setopt localoptions xtrace
1928 local mode=$1 AF F BF
1929 if [[ $mode == coloured ]]; then
1930 AF=${grml_vcs_coloured_formats[actionformat]}
1931 F=${grml_vcs_coloured_formats[format]}
1932 BF=${grml_vcs_coloured_formats[rev-branchformat]}
1933 GRML_VCS_COLOUR_MODE=coloured
1935 AF=${grml_vcs_plain_formats[actionformat]}
1936 F=${grml_vcs_plain_formats[format]}
1937 BF=${grml_vcs_plain_formats[rev-branchformat]}
1938 GRML_VCS_COLOUR_MODE=plain
1941 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
1942 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
1943 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
1947 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1948 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1949 if [[ "$TERM" == dumb ]] ; then
1950 grml_vcs_info_set_formats plain
1952 grml_vcs_info_set_formats coloured
1955 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
1957 # This actually defines three prompts:
1963 # They all share the same code and only differ with respect to which items they
1964 # contain. The main source of documentation is the `prompt_grml_help' function
1965 # below, which gets called when the user does this: prompt -h grml
1967 function prompt_grml_help () {
1971 This is the prompt as used by the grml-live system <http://grml.org>. It is
1972 a rather simple one-line prompt, that by default looks something like this:
1974 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
1976 The prompt itself integrates with zsh's prompt themes system (as you are
1977 witnessing right now) and is configurable to a certain degree. In
1978 particular, these aspects are customisable:
1980 - The items used in the prompt (e.g. you can remove \`user' from
1981 the list of activated items, which will cause the user name to
1982 be omitted from the prompt string).
1984 - The attributes used with the items are customisable via strings
1985 used before and after the actual item.
1987 The available items are: at, battery, change-root, date, grml-chroot,
1988 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
1989 shell-level, time, user, vcs
1991 The actual configuration is done via zsh's \`zstyle' mechanism. The
1992 context, that is used while looking up styles is:
1994 ':prompt:grml:<left-or-right>:<subcontext>'
1996 Here <left-or-right> is either \`left' or \`right', signifying whether the
1997 style should affect the left or the right prompt. <subcontext> is either
1998 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
2002 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
2003 in $RPROMPT if the last command a returned non-successful error code.
2004 (This in only valid if <left-or-right> is "right"; ignored otherwise)
2006 - items (list): The list of items used in the prompt. If \`vcs' is
2007 present in the list, the theme's code invokes \`vcs_info'
2008 accordingly. Default (left): rc change-root user at host path vcs
2009 percent; Default (right): sad-smiley
2011 Available styles in 'items:<item>' are: pre, post. These are strings that
2012 are inserted before (pre) and after (post) the item in question. Thus, the
2013 following would cause the user name to be printed in red instead of the
2016 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
2018 Note, that the \`post' style may remain at its default value, because its
2019 default value is '%f', which turns the foreground text attribute off (which
2020 is exactly, what is still required with the new \`pre' value).
2024 function prompt_grml-chroot_help () {
2028 This is a variation of the grml prompt, see: prompt -h grml
2030 The main difference is the default value of the \`items' style. The rest
2031 behaves exactly the same. Here are the defaults for \`grml-chroot':
2033 - left: grml-chroot user at host path percent
2034 - right: (empty list)
2038 function prompt_grml-large_help () {
2042 This is a variation of the grml prompt, see: prompt -h grml
2044 The main difference is the default value of the \`items' style. In
2045 particular, this theme uses _two_ lines instead of one with the plain
2046 \`grml' theme. The rest behaves exactly the same. Here are the defaults
2049 - left: rc jobs history shell-level change-root time date newline user
2050 at host path vcs percent
2055 function grml_prompt_setup () {
2057 autoload -Uz vcs_info
2058 # The following autoload is disabled for now, since this setup includes a
2059 # static version of the ‘add-zsh-hook’ function above. It needs to be
2060 # reenabled as soon as that static definition is removed again.
2061 #autoload -Uz add-zsh-hook
2062 add-zsh-hook precmd prompt_$1_precmd
2065 function prompt_grml_setup () {
2066 grml_prompt_setup grml
2069 function prompt_grml-chroot_setup () {
2070 grml_prompt_setup grml-chroot
2073 function prompt_grml-large_setup () {
2074 grml_prompt_setup grml-large
2077 # These maps define default tokens and pre-/post-decoration for items to be
2078 # used within the themes. All defaults may be customised in a context sensitive
2079 # matter by using zsh's `zstyle' mechanism.
2080 typeset -gA grml_prompt_pre_default \
2081 grml_prompt_post_default \
2082 grml_prompt_token_default \
2083 grml_prompt_token_function
2085 grml_prompt_pre_default=(
2090 grml-chroot '%F{red}'
2100 shell-level '%F{red}'
2106 grml_prompt_post_default=(
2127 grml_prompt_token_default=(
2129 battery 'GRML_BATTERY_LEVEL'
2130 change-root 'debian_chroot'
2132 grml-chroot 'GRML_CHROOT'
2133 history '{history#%!} '
2135 jobs '[%j running job(s)] '
2137 path '%40<..<%~%<< '
2141 sad-smiley '%(?..:()'
2142 shell-level '%(3L.+ .)'
2143 time '%D{%H:%M:%S} '
2148 function grml_theme_has_token () {
2149 if (( ARGC != 1 )); then
2150 printf 'usage: grml_theme_has_token <name>\n'
2153 (( ${+grml_prompt_token_default[$1]} ))
2156 function GRML_theme_add_token_usage () {
2158 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2160 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2161 are used, <token/function> is the name of the function (see below for
2162 details). Otherwise it is the literal token string to be used. <pre> and
2163 <post> are optional.
2167 -f <function> Use a function named \`<function>' each time the token
2170 -i <function> Use a function named \`<function>' to initialise the
2171 value of the token _once_ at runtime.
2173 The functions are called with one argument: the token's new name. The
2174 return value is expected in the \$REPLY parameter. The use of these
2175 options is mutually exclusive.
2177 There is a utility function \`grml_theme_has_token', which you can use
2178 to test if a token exists before trying to add it. This can be a guard
2179 for situations in which a \`grml_theme_add_token' call may happen more
2184 To add a new token \`day' that expands to the current weekday in the
2185 current locale in green foreground colour, use this:
2187 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2189 Another example would be support for \$VIRTUAL_ENV:
2191 function virtual_env_prompt () {
2192 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2194 grml_theme_add_token virtual-env -f virtual_env_prompt
2196 After that, you will be able to use a changed \`items' style to
2197 assemble your prompt.
2201 function grml_theme_add_token () {
2203 local name token pre post
2204 local -i init funcall
2206 if (( ARGC == 0 )); then
2207 GRML_theme_add_token_usage
2217 if [[ $1 == '-f' ]]; then
2220 elif [[ $1 == '-i' ]]; then
2225 if (( ARGC == 0 )); then
2227 grml_theme_add_token: No token-string/function-name provided!\n\n'
2228 GRML_theme_add_token_usage
2233 if (( ARGC != 0 && ARGC != 2 )); then
2235 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2236 GRML_theme_add_token_usage
2245 if grml_theme_has_token $name; then
2247 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2248 GRML_theme_add_token_usage
2255 grml_prompt_pre_default[$name]=$pre
2256 grml_prompt_post_default[$name]=$post
2257 if (( funcall )); then
2258 grml_prompt_token_function[$name]=$token
2259 grml_prompt_token_default[$name]=23
2261 grml_prompt_token_default[$name]=$token
2265 function grml_typeset_and_wrap () {
2272 if (( ${+parameters[$new]} )); then
2273 typeset -g "${target}=${(P)target}${left}${(P)new}${right}"
2277 function grml_prompt_addto () {
2280 local lr it apre apost new v
2284 [[ $target == PS1 ]] && lr=left || lr=right
2285 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2286 typeset -g "${target}="
2287 for it in "${items[@]}"; do
2288 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2289 || apre=${grml_prompt_pre_default[$it]}
2290 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2291 || apost=${grml_prompt_post_default[$it]}
2292 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2293 || new=${grml_prompt_token_default[$it]}
2294 typeset -g "${target}=${(P)target}${apre}"
2295 if (( ${+grml_prompt_token_function[$it]} )); then
2296 ${grml_prompt_token_function[$it]} $it
2297 typeset -g "${target}=${(P)target}${REPLY}"
2301 grml_typeset_and_wrap $target $new '' ''
2304 grml_typeset_and_wrap $target $new '(' ')'
2307 if [[ -n ${(P)new} ]]; then
2308 typeset -g "${target}=${(P)target}(CHROOT)"
2312 v="vcs_info_msg_${new}_"
2313 if (( ! vcscalled )); then
2317 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2318 typeset -g "${target}=${(P)target}${(P)v}"
2321 *) typeset -g "${target}=${(P)target}${new}" ;;
2324 typeset -g "${target}=${(P)target}${apost}"
2328 function prompt_grml_precmd () {
2330 local grmltheme=grml
2331 local -a left_items right_items
2332 left_items=(rc change-root user at host path vcs percent)
2333 right_items=(sad-smiley)
2335 prompt_grml_precmd_worker
2338 function prompt_grml-chroot_precmd () {
2340 local grmltheme=grml-chroot
2341 local -a left_items right_items
2342 left_items=(grml-chroot user at host path percent)
2345 prompt_grml_precmd_worker
2348 function prompt_grml-large_precmd () {
2350 local grmltheme=grml-large
2351 local -a left_items right_items
2352 left_items=(rc jobs history shell-level change-root time date newline
2353 user at host path vcs percent)
2354 right_items=(sad-smiley)
2356 prompt_grml_precmd_worker
2359 function prompt_grml_precmd_worker () {
2361 local -i vcscalled=0
2363 grml_prompt_addto PS1 "${left_items[@]}"
2364 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2365 grml_prompt_addto RPS1 "${right_items[@]}"
2369 grml_prompt_fallback() {
2372 (( ${+functions[vcs_info]} )) && vcs_info
2375 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2376 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2377 if (( EUID == 0 )); then
2378 PROMPT="${BLUE}${p0}${RED}${p1}"
2380 PROMPT="${RED}${p0}${BLUE}${p1}"
2385 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2386 # Since we define the required functions in here and not in files in
2387 # $fpath, we need to stick the theme's name into `$prompt_themes'
2388 # ourselves, since promptinit does not pick them up otherwise.
2389 prompt_themes+=( grml grml-chroot grml-large )
2390 # Also, keep the array sorted...
2391 prompt_themes=( "${(@on)prompt_themes}" )
2393 print 'Notice: no promptinit available :('
2394 grml_prompt_fallback
2398 # The prompt themes use modern features of zsh, that require at least
2399 # version 4.3.7 of the shell. Use the fallback otherwise.
2400 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2401 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2402 add-zsh-hook precmd battery
2404 if [[ "$TERM" == dumb ]] ; then
2405 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2406 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2407 for i in rc user path jobs history date time shell-level; do
2408 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2409 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2412 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2413 elif (( EUID == 0 )); then
2414 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2417 # Finally enable one of the prompts.
2418 if [[ -n $GRML_CHROOT ]]; then
2420 elif [[ $GRMLPROMPT -gt 0 ]]; then
2426 grml_prompt_fallback
2429 # Terminal-title wizardry
2431 function ESC_print () {
2432 info_print $'\ek' $'\e\\' "$@"
2434 function set_title () {
2435 info_print $'\e]0;' $'\a' "$@"
2438 function info_print () {
2439 local esc_begin esc_end
2443 printf '%s' ${esc_begin}
2445 printf '%s' "${esc_end}"
2448 function grml_reset_screen_title () {
2449 # adjust title of xterm
2450 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2451 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2454 set_title ${(%):-"%n@%m: %~"}
2459 function grml_vcs_to_screen_title () {
2460 if [[ $TERM == screen* ]] ; then
2461 if [[ -n ${vcs_info_msg_1_} ]] ; then
2462 ESC_print ${vcs_info_msg_1_}
2469 function grml_maintain_name () {
2470 # set hostname if not running on host with name 'grml'
2471 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
2476 function grml_cmd_to_screen_title () {
2477 # get the name of the program currently running and hostname of local
2478 # machine set screen window title if running in a screen
2479 if [[ "$TERM" == screen* ]] ; then
2480 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2485 function grml_control_xterm_title () {
2488 set_title "${(%):-"%n@%m:"}" "$1"
2493 # The following autoload is disabled for now, since this setup includes a
2494 # static version of the ‘add-zsh-hook’ function above. It needs to be
2495 # reenabled as soon as that static definition is removed again.
2496 #zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2497 if [[ $NOPRECMD -eq 0 ]]; then
2498 add-zsh-hook precmd grml_reset_screen_title
2499 add-zsh-hook precmd grml_vcs_to_screen_title
2500 add-zsh-hook preexec grml_maintain_name
2501 add-zsh-hook preexec grml_cmd_to_screen_title
2502 if [[ $NOTITLE -eq 0 ]]; then
2503 add-zsh-hook preexec grml_control_xterm_title
2507 # 'hash' some often used directories
2509 hash -d deb=/var/cache/apt/archives
2510 hash -d doc=/usr/share/doc
2511 hash -d linux=/lib/modules/$(command uname -r)/build/
2512 hash -d log=/var/log
2513 hash -d slog=/var/log/syslog
2514 hash -d src=/usr/src
2515 hash -d www=/var/www
2519 if check_com -c screen ; then
2520 if [[ $UID -eq 0 ]] ; then
2521 if [[ -r /etc/grml/screenrc ]]; then
2522 alias screen='screen -c /etc/grml/screenrc'
2524 elif [[ ! -r $HOME/.screenrc ]] ; then
2525 if [[ -r /etc/grml/screenrc_grml ]]; then
2526 alias screen='screen -c /etc/grml/screenrc_grml'
2528 if [[ -r /etc/grml/screenrc ]]; then
2529 alias screen='screen -c /etc/grml/screenrc'
2535 # do we have GNU ls with color-support?
2536 if [[ "$TERM" != dumb ]]; then
2537 #a1# List files with colors (\kbd{ls \ldots})
2538 alias ls="command ls ${ls_options:+${ls_options[*]}}"
2539 #a1# List all files, with colors (\kbd{ls -la \ldots})
2540 alias la="command ls -la ${ls_options:+${ls_options[*]}}"
2541 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2542 alias ll="command ls -l ${ls_options:+${ls_options[*]}}"
2543 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2544 alias lh="command ls -hAl ${ls_options:+${ls_options[*]}}"
2545 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -l \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2546 alias l="command ls -l ${ls_options:+${ls_options[*]}}"
2548 alias la='command ls -la'
2549 alias ll='command ls -l'
2550 alias lh='command ls -hAl'
2551 alias l='command ls -l'
2554 alias mdstat='cat /proc/mdstat'
2555 alias ...='cd ../../'
2557 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2558 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2559 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2562 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2563 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2564 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2566 # make sure it is not assigned yet
2567 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2571 for ENV in $(env | command grep -i '.utf') ; do
2572 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2577 # make sure it is not assigned yet
2578 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2580 if ! isutfenv ; then
2582 for ENV in $(env | command grep -i '\.iso') ; do
2583 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2588 # especially for roadwarriors using GNU screen and ssh:
2589 if ! check_com asc &>/dev/null ; then
2590 asc() { autossh -t "$@" 'screen -RdU' }
2594 #f1# Hints for the use of zsh on grml
2596 print "$bg[white]$fg[black]
2597 zsh-help - hints for use of zsh on grml
2598 =======================================$reset_color"
2601 Main configuration of zsh happens in /etc/zsh/zshrc.
2602 That file is part of the package grml-etc-core, if you want to
2603 use them on a non-grml-system just get the tar.gz from
2604 http://deb.grml.org/ or (preferably) get it from the git repository:
2606 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2608 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2609 The file is still there, but it is empty for backwards compatibility.
2611 For your own changes use these two files:
2615 The former is sourced very early in our zshrc, the latter is sourced
2618 System wide configuration without touching configuration files of grml
2619 can take place in /etc/zsh/zshrc.local.
2621 For information regarding zsh start at http://grml.org/zsh/
2623 Take a look at grml'\''s zsh refcard:
2624 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2626 Check out the main zsh refcard:
2627 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2629 And of course visit the zsh-lovers:
2632 You can adjust some options through environment variables when
2633 invoking zsh without having to edit configuration files.
2634 Basically meant for bash users who are not used to the power of
2637 "NOCOR=1 zsh" => deactivate automatic correction
2638 "NOMENU=1 zsh" => do not use auto menu completion
2639 (note: use ctrl-d for completion instead!)
2640 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2641 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2642 preexec() and precmd() completely
2643 "GRML_DISPLAY_BATTERY=1 zsh"
2644 => activate battery status on right side of prompt (WIP)
2645 "COMMAND_NOT_FOUND=1 zsh"
2646 => Enable a handler if an external command was not found
2647 The command called in the handler can be altered by setting
2648 the GRML_ZSH_CNF_HANDLER variable, the default is:
2649 "/usr/share/command-not-found/command-not-found"
2651 A value greater than 0 is enables a feature; a value equal to zero
2652 disables it. If you like one or the other of these settings, you can
2653 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2657 $bg[white]$fg[black]
2658 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2659 Enjoy your grml system with the zsh!$reset_color"
2663 if [[ -r /etc/debian_version ]] ; then
2664 #a3# Execute \kbd{apt-cache search}
2665 alias acs='apt-cache search'
2666 #a3# Execute \kbd{apt-cache show}
2667 alias acsh='apt-cache show'
2668 #a3# Execute \kbd{apt-cache policy}
2669 alias acp='apt-cache policy'
2670 #a3# Execute \kbd{apt-get dist-upgrade}
2671 salias adg="apt-get dist-upgrade"
2672 #a3# Execute \kbd{apt-get install}
2673 salias agi="apt-get install"
2674 #a3# Execute \kbd{aptitude install}
2675 salias ati="aptitude install"
2676 #a3# Execute \kbd{apt-get upgrade}
2677 salias ag="apt-get upgrade"
2678 #a3# Execute \kbd{apt-get update}
2679 salias au="apt-get update"
2680 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2681 salias -a up="aptitude update ; aptitude safe-upgrade"
2682 #a3# Execute \kbd{dpkg-buildpackage}
2683 alias dbp='dpkg-buildpackage'
2684 #a3# Execute \kbd{grep-excuses}
2685 alias ge='grep-excuses'
2687 # get a root shell as normal user in live-cd mode:
2688 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2692 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
2693 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2694 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
2695 salias tlog="tail -f /var/log/syslog" # follow the syslog
2698 # sort installed Debian-packages by size
2699 if check_com -c dpkg-query ; then
2700 #a3# List installed Debian-packages sorted by size
2701 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"
2704 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2705 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2706 if check_com -c wodim; then
2709 cdrecord is not provided under its original name by Debian anymore.
2710 See #377109 in the BTS of Debian for more details.
2712 Please use the wodim binary instead
2720 # No core dumps: important for a live-cd-system
2726 # people should use 'grml-x'!
2727 if check_com -c 915resolution; then
2729 echo "Please use 915resolution as resolution modifying tool for Intel \
2735 #a1# Output version of running grml
2736 alias grml-version='cat /etc/grml_version'
2738 if check_com -c grml-debootstrap ; then
2740 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2746 # now run the functions
2748 is4 && isgrml && grmlstuff
2752 is4 && xsource "/etc/zsh/keephack"
2754 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2755 # You use it as follows:
2756 # $ NTREF=/reference/file
2758 # This lists all the files in the current directory newer than the reference file.
2759 # You can also specify the reference file inline; note quotes:
2760 # $ ls -l *(e:'nt ~/.zshenv':)
2762 if [[ -n $1 ]] ; then
2765 [[ $REPLY -nt $NTREF ]]
2770 #f1# Reload an autoloadable function
2771 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2772 compdef _functions freload
2777 # e.g.: a -> b -> c -> d ....
2782 # if parameter is given with leading '=', lookup $PATH for parameter and resolve that
2786 # Note: limit for recursive symlinks on linux:
2787 # http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/fs/namei.c?id=refs/heads/master#l808
2788 # This limits recursive symlink follows to 8,
2789 # while limiting consecutive symlinks to 40.
2791 # When resolving and displaying information about symlinks, no check is made
2792 # that the displayed information does make any sense on your OS.
2793 # We leave that decission to the user.
2795 # The zstat module is used to detect symlink loops. zstat is available since zsh4.
2796 # With an older zsh you will need to abort with <C-c> in that case.
2797 # When a symlink loop is detected, a warning ist printed and further processing is stopped.
2799 # Module zstat is loaded by default in grml zshrc, no extra action needed for that.
2802 # If you happen to come accross a symlink that points to a destination on an other partition
2803 # with the same inode number, that will be marked as symlink loop though it is not.
2804 # Two hints for this situation:
2805 # I) Play lottery the same day, as you seem to be rather lucky right now.
2810 # 1 file/dir not accesible
2811 # 2 symlink loop detected
2813 #f1# List symlinks in detail (more detailed version of 'readlink -f', 'whence -s' and 'namei -l')
2815 if [[ -z ${1} ]] ; then
2816 printf 'Usage: %s <symlink(s)>\n' "${0}"
2820 local file jumpd curdir
2821 local -i RTN LINODE i
2826 for file in "${@}" ; do
2828 ls -l "${file:a}" || RTN=1
2830 while [[ -h "$file" ]] ; do
2832 LINODE=$(zstat -L +inode "${file}")
2833 for i in ${SEENINODES} ; do
2834 if (( ${i} == ${LINODE} )) ; then
2835 builtin cd "${curdir}"
2836 print "link loop detected, aborting!"
2840 SEENINODES+=${LINODE}
2845 if [[ -d ${jumpd} ]] ; then
2846 builtin cd "${jumpd}" || RTN=1
2848 file=$(readlink "$file")
2853 if [[ -d ${jumpd} ]] ; then
2854 builtin cd "${jumpd}" || RTN=1
2857 ls -l "${PWD}/${file}" || RTN=1
2860 if (( ${#} >= 1 )) ; then
2863 builtin cd "${curdir}"
2868 # TODO: Is it supported to use pager settings like this?
2869 # PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
2870 # with respect to wordsplitting. (ie. ${=PAGER})
2871 if check_com -c $PAGER ; then
2872 #f3# View Debian's changelog of given package(s)
2875 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
2878 for package in "$@" ; do
2879 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
2880 $PAGER /usr/share/doc/${package}/changelog.Debian.gz
2881 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
2882 $PAGER /usr/share/doc/${package}/changelog.gz
2883 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
2884 $PAGER /usr/share/doc/${package}/changelog
2886 if check_com -c aptitude ; then
2887 echo "No changelog for package $package found, using aptitude to retrieve it."
2888 aptitude changelog "$package"
2889 elif check_com -c apt-get ; then
2890 echo "No changelog for package $package found, using apt-get to retrieve it."
2891 apt-get changelog "$package"
2893 echo "No changelog for package $package found, sorry."
2898 _dchange() { _files -W /usr/share/doc -/ }
2899 compdef _dchange dchange
2901 #f3# View Debian's NEWS of a given package
2904 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
2905 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
2907 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
2908 $PAGER /usr/share/doc/$1/NEWS.gz
2910 echo "No NEWS file for package $1 found, sorry."
2915 _dnews() { _files -W /usr/share/doc -/ }
2916 compdef _dnews dnews
2918 #f3# View Debian's copyright of a given package
2921 if [[ -r /usr/share/doc/$1/copyright ]] ; then
2922 $PAGER /usr/share/doc/$1/copyright
2924 echo "No copyright file for package $1 found, sorry."
2928 _dcopyright() { _files -W /usr/share/doc -/ }
2929 compdef _dcopyright dcopyright
2931 #f3# View upstream's changelog of a given package
2934 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2935 $PAGER /usr/share/doc/$1/changelog.gz
2937 echo "No changelog for package $1 found, sorry."
2941 _uchange() { _files -W /usr/share/doc -/ }
2942 compdef _uchange uchange
2947 ZSH_PROFILE_RC=1 zsh "$@"
2950 #f1# Edit an alias via zle
2952 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2954 compdef _aliases edalias
2956 #f1# Edit a function via zle
2958 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
2960 compdef _functions edfunc
2962 # use it e.g. via 'Restart apache2'
2963 #m# f6 Start() \kbd{service \em{process}}\quad\kbd{start}
2964 #m# f6 Restart() \kbd{service \em{process}}\quad\kbd{restart}
2965 #m# f6 Stop() \kbd{service \em{process}}\quad\kbd{stop}
2966 #m# f6 Reload() \kbd{service \em{process}}\quad\kbd{reload}
2967 #m# f6 Force-Reload() \kbd{service \em{process}}\quad\kbd{force-reload}
2968 #m# f6 Status() \kbd{service \em{process}}\quad\kbd{status}
2969 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2971 local action_="${1:l}" # e.g Start/Stop/Restart
2975 local service_target_="$(readlink /etc/init.d/$service_)"
2976 if [[ $service_target_ == "/usr/bin/sv" ]]; then
2978 case "${action_}" in
2979 start) if [[ ! -e /etc/service/$service_ ]]; then
2980 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2982 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2984 # there is no reload in runits sysv emulation
2985 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2986 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2989 # sysv/sysvinit-utils, upstart
2990 if check_com -c service ; then
2991 $SUDO service "$service_" "${action_}" "$param_"
2993 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
3000 scripts=( /etc/init.d/*(x:t) )
3001 _describe "service startup script" scripts
3004 for i in Start Restart Stop Force-Reload Reload Status ; do
3005 eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
3006 compdef _grmlinitd $i
3011 #f1# Provides useful information on globbing
3018 p named pipes (FIFOs)
3019 * executable plain files (0100)
3020 % device files (character or block special)
3021 %b block special files
3022 %c character special files
3023 r owner-readable files (0400)
3024 w owner-writable files (0200)
3025 x owner-executable files (0100)
3026 A group-readable files (0040)
3027 I group-writable files (0020)
3028 E group-executable files (0010)
3029 R world-readable files (0004)
3030 W world-writable files (0002)
3031 X world-executable files (0001)
3032 s setuid files (04000)
3033 S setgid files (02000)
3034 t files with the sticky bit (01000)
3036 print *(m-1) # Files modified up to a day ago
3037 print *(a1) # Files accessed a day ago
3038 print *(@) # Just symlinks
3039 print *(Lk+50) # Files bigger than 50 kilobytes
3040 print *(Lk-50) # Files smaller than 50 kilobytes
3041 print **/*.c # All *.c files recursively starting in \$PWD
3042 print **/*.c~file.c # Same as above, but excluding 'file.c'
3043 print (foo|bar).* # Files starting with 'foo' or 'bar'
3044 print *~*.* # All Files that do not contain a dot
3045 chmod 644 *(.^x) # make all plain non-executable files publically readable
3046 print -l *(.c|.h) # Lists *.c and *.h
3047 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
3048 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
3050 alias help-zshglob=H-Glob
3052 # grep for running process, like: 'any vim'
3056 if [[ -z "$1" ]] ; then
3057 echo "any - grep for process(es) by keyword" >&2
3058 echo "Usage: any <keyword>" >&2 ; return 1
3060 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
3065 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
3066 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
3067 [[ -r /proc/1/maps ]] && \
3069 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
3070 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
3071 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
3074 # a wrapper for vim, that deals with title setting
3076 # set this array to a set of options to vim you always want
3077 # to have set when calling vim (in .zshrc.local), like:
3078 # VIM_OPTIONS=( -p )
3079 # This will cause vim to send every file given on the
3080 # commandline to be send to it's own tab (needs vim7).
3081 if check_com vim; then
3083 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
3087 ssl_hashes=( sha512 sha256 sha1 md5 )
3089 for sh in ${ssl_hashes}; do
3090 eval 'ssl-cert-'${sh}'() {
3092 if [[ -z $1 ]] ; then
3093 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
3096 openssl x509 -noout -fingerprint -'${sh}' -in $1
3100 ssl-cert-fingerprints() {
3103 if [[ -z $1 ]] ; then
3104 printf 'usage: ssl-cert-fingerprints <file>\n'
3107 for i in ${ssl_hashes}
3114 if [[ -z $1 ]] ; then
3115 printf 'usage: ssl-cert-info <file>\n'
3118 openssl x509 -noout -text -in $1
3119 ssl-cert-fingerprints $1
3122 # make sure our environment is clean regarding colors
3123 for var in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $var
3124 builtin unset -v var
3126 # "persistent history"
3127 # just write important commands you always need to ~/.important_commands
3128 if [[ -r ~/.important_commands ]] ; then
3129 fc -R ~/.important_commands
3132 # load the lookup subsystem if it's available on the system
3133 zrcautoload lookupinit && lookupinit
3137 # set terminal property (used e.g. by msgid-chooser)
3138 export COLORTERM="yes"
3143 #a2# Execute \kbd{du -sch}
3147 #a2# Execute \kbd{ls -lSrah}
3148 alias dir="command ls -lSrah"
3149 #a2# Only show dot-directories
3150 alias lad='command ls -d .*(/)'
3151 #a2# Only show dot-files
3152 alias lsa='command ls -a .*(.)'
3153 #a2# Only files with setgid/setuid/sticky flag
3154 alias lss='command ls -l *(s,S,t)'
3155 #a2# Only show symlinks
3156 alias lsl='command ls -l *(@)'
3157 #a2# Display only executables
3158 alias lsx='command ls -l *(*)'
3159 #a2# Display world-{readable,writable,executable} files
3160 alias lsw='command ls -ld *(R,W,X.^ND/)'
3161 #a2# Display the ten biggest files
3162 alias lsbig="command ls -flh *(.OL[1,10])"
3163 #a2# Only show directories
3164 alias lsd='command ls -d *(/)'
3165 #a2# Only show empty directories
3166 alias lse='command ls -d *(/^F)'
3167 #a2# Display the ten newest files
3168 alias lsnew="command ls -rtlh *(D.om[1,10])"
3169 #a2# Display the ten oldest files
3170 alias lsold="command ls -rtlh *(D.Om[1,10])"
3171 #a2# Display the ten smallest files
3172 alias lssmall="command ls -Srl *(.oL[1,10])"
3173 #a2# Display the ten newest directories and ten newest .directories
3174 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
3175 #a2# Display the ten oldest directories and ten oldest .directories
3176 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
3178 # some useful aliases
3179 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
3180 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
3182 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3183 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3184 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3185 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3187 # work around non utf8 capable software in utf environment via $LANG and luit
3188 if check_com isutfenv && check_com luit ; then
3189 if check_com -c mrxvt ; then
3190 isutfenv && [[ -n "$LANG" ]] && \
3191 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3194 if check_com -c aterm ; then
3195 isutfenv && [[ -n "$LANG" ]] && \
3196 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3199 if check_com -c centericq ; then
3200 isutfenv && [[ -n "$LANG" ]] && \
3201 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3207 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3210 local current_date=$(date -u "+%Y-%m-%dT%H:%M:%SZ")
3211 local clean keep move verbose result all to_bk
3212 setopt extended_glob
3214 while getopts ":hacmrv" opt; do
3217 c) unset move clean && (( ++keep ));;
3218 m) unset keep clean && (( ++move ));;
3219 r) unset move keep && (( ++clean ));;
3222 bk [-hcmv] FILE [FILE ...]
3223 bk -r [-av] [FILE [FILE ...]]
3224 Backup a file or folder in place and append the timestamp
3225 Remove backups of a file or folder, or all backups in the current directory
3228 -h Display this help text
3229 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3230 -m Move the file/folder, using mv(1)
3231 -r Remove backups of the specified file or directory, using rm(1). If none
3232 is provided, remove all backups in the current directory.
3233 -a Remove all (even hidden) backups.
3236 The -c, -r and -m options are mutually exclusive. If specified at the same time,
3237 the last one is used.
3239 The return code is the sum of all cp/mv/rm return codes.
3242 \?) bk -h >&2; return 1;;
3245 shift "$((OPTIND-1))"
3246 if (( keep > 0 )); then
3247 if islinux || isfreebsd; then
3248 for to_bk in "$@"; do
3249 cp $verbose -a "${to_bk%/}" "${to_bk%/}_$current_date"
3253 for to_bk in "$@"; do
3254 cp $verbose -pR "${to_bk%/}" "${to_bk%/}_$current_date"
3258 elif (( move > 0 )); then
3259 while (( $# > 0 )); do
3260 mv $verbose "${1%/}" "${1%/}_$current_date"
3264 elif (( clean > 0 )); then
3265 if (( $# > 0 )); then
3266 for to_bk in "$@"; do
3267 rm $verbose -rf "${to_bk%/}"_[0-9](#c4,)-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3])(:[0-5][0-9])(#c2)Z
3271 if (( all > 0 )); then
3272 rm $verbose -rf *_[0-9](#c4,)-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3])(:[0-5][0-9])(#c2)Z(D)
3274 rm $verbose -rf *_[0-9](#c4,)-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3])(:[0-5][0-9])(#c2)Z
3282 #f5# cd to directoy and list files
3288 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3290 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3291 [[ ! -e ${1:h} ]] && return 1
3292 print "Correcting ${1} to ${1:h}"
3299 #f5# Create Directoy and \kbd{cd} to it
3301 if (( ARGC != 1 )); then
3302 printf 'usage: mkcd <new-directory>\n'
3305 if [[ ! -d "$1" ]]; then
3306 command mkdir -p "$1"
3308 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3313 #f5# Create temporary directory and \kbd{cd} to it
3315 builtin cd "$(mktemp -d)"
3319 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3322 print -l -- *(a-${1:-1})
3325 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3328 print -l -- *(c-${1:-1})
3331 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3334 print -l -- *(m-${1:-1})
3336 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3337 check_com new || alias new=modified
3339 # use colors when GNU grep with color-support
3340 if (( $#grep_options > 0 )); then
3341 o=${grep_options:+"${grep_options[*]}"}
3342 #a2# Execute \kbd{grep -{}-color=auto}
3343 alias grep='grep '$o
3344 alias egrep='egrep '$o
3349 # 'translate' looks up a word in a file with language-to-language
3350 # translations (field separator should be " : "). A typical wordlist looks
3351 # like the following:
3352 # | english-word : german-translation
3353 # It's also only possible to translate english to german but not reciprocal.
3354 # Use the following oneliner to reverse the sort order:
3355 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3356 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3357 #f5# Translates a word
3362 translate -l de-en $2
3365 translate -l en-de $2
3368 echo "Usage: $0 { -D | -E }"
3369 echo " -D == German to English"
3370 echo " -E == English to German"
3374 # Usage: simple-extract <file>
3375 # Using option -d deletes the original archive file.
3376 #f5# Smart archive extractor
3379 setopt extended_glob noclobber
3380 local ARCHIVE DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3382 zparseopts -D -E "d=DELETE_ORIGINAL"
3383 for ARCHIVE in "${@}"; do
3385 *(tar.bz2|tbz2|tbz))
3386 DECOMP_CMD="tar -xvjf -"
3391 DECOMP_CMD="tar -xvzf -"
3395 *(tar.xz|txz|tar.lzma))
3396 DECOMP_CMD="tar -xvJf -"
3401 DECOMP_CMD="tar -xvf -"
3406 DECOMP_CMD="unrar x"
3431 DECOMP_CMD="bzip2 -d -c -"
3436 DECOMP_CMD="gzip -d -c -"
3441 DECOMP_CMD="xz -d -c -"
3446 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3452 if ! check_com ${DECOMP_CMD[(w)1]}; then
3453 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3458 GZTARGET="${ARCHIVE:t:r}"
3459 if [[ -f $ARCHIVE ]] ; then
3461 print "Extracting '$ARCHIVE' ..."
3462 if $USES_STDIN; then
3463 if $USES_STDOUT; then
3464 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3466 ${=DECOMP_CMD} < "$ARCHIVE"
3469 if $USES_STDOUT; then
3470 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3472 ${=DECOMP_CMD} "$ARCHIVE"
3475 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3477 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3478 if check_com curl; then
3479 WGET_CMD="curl -L -s -o -"
3480 elif check_com wget; then
3481 WGET_CMD="wget -q -O -"
3482 elif check_com fetch; then
3483 WGET_CMD="fetch -q -o -"
3485 print "ERROR: neither wget, curl nor fetch is installed" >&2
3489 print "Downloading and Extracting '$ARCHIVE' ..."
3490 if $USES_STDIN; then
3491 if $USES_STDOUT; then
3492 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3495 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3499 if $USES_STDOUT; then
3500 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3502 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3507 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3517 '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)"' \
3518 '_urls:Remote Archives:_urls'
3524 '-d[delete original archivefile after extraction]' \
3525 '*:Archive Or Uri:__archive_or_uri'
3527 compdef _simple_extract simple-extract
3528 alias se=simple-extract
3530 #f5# Change the xterm title from within GNU-screen
3533 if [[ $1 != "-f" ]] ; then
3534 if [[ -z ${DISPLAY} ]] ; then
3535 printf 'xtrename only makes sense in X11.\n'
3541 if [[ -z $1 ]] ; then
3542 printf 'usage: xtrename [-f] "title for xterm"\n'
3543 printf ' renames the title of xterm from _within_ screen.\n'
3544 printf ' also works without screen.\n'
3545 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3548 print -n "\eP\e]0;${1}\C-G\e\\"
3552 # Create small urls via http://goo.gl using curl(1).
3553 # API reference: https://code.google.com/apis/urlshortener/
3556 setopt extended_glob
3558 if [[ -z $1 ]]; then
3559 print "USAGE: zurl <URL>"
3563 local PN url prog api json contenttype item
3568 # Prepend 'http://' to given URL where necessary for later output.
3569 if [[ ${url} != http(s|)://* ]]; then
3573 if check_com -c curl; then
3576 print "curl is not available, but mandatory for ${PN}. Aborting."
3579 api='https://www.googleapis.com/urlshortener/v1/url'
3580 contenttype="Content-Type: application/json"
3581 json="{\"longUrl\": \"${url}\"}"
3582 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3583 # Parse the response
3584 for item in "${data[@]}"; do
3589 printf '%s\n' "$item"
3597 #f2# Find history events by search pattern and list them by date.
3600 local usage help ident format_l format_s first_char remain first last
3601 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3602 help='Use `whatwhen -h'\'' for further explanations.'
3603 ident=${(l,${#${:-Usage: }},, ,)}
3604 format_l="${ident}%s\t\t\t%s\n"
3605 format_s="${format_l//(\\t)##/\\t}"
3606 # Make the first char of the word to search for case
3607 # insensitive; e.g. [aA]
3608 first_char=[${(L)1[1]}${(U)1[1]}]
3610 # Default search range is `-100'.
3612 # Optional, just used for `<first> <last>' given.
3616 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3617 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3620 printf '%s\n\n' ${usage}
3622 printf $format_l '-h' 'show help text'
3624 print 'SEARCH RANGE:'
3625 printf $format_l "'0'" 'the whole history,'
3626 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3627 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3628 printf '\n%s\n' 'EXAMPLES:'
3629 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3630 printf $format_l 'whatwhen zsh -250'
3631 printf $format_l 'whatwhen foo 1 99'
3634 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3637 # -l list results on stout rather than invoking $EDITOR.
3638 # -i Print dates as in YYYY-MM-DD.
3639 # -m Search for a - quoted - pattern within the history.
3640 fc -li -m "*${first_char}${remain}*" $first $last
3645 # mercurial related stuff
3646 if check_com -c hg ; then
3647 # gnu like diff for mercurial
3648 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3649 #f5# GNU like diff for mercurial
3653 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3656 # build debian package
3657 #a2# Alias for \kbd{hg-buildpackage}
3658 alias hbp='hg-buildpackage'
3660 # execute commands on the versioned patch-queue from the current repos
3661 alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3663 # diffstat for specific version of a mercurial repository
3664 # hgstat => display diffstat between last revision and tip
3665 # hgstat 1234 => display diffstat between revision 1234 and tip
3666 #f5# Diffstat for specific version of a mercurial repos
3669 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3672 fi # end of check whether we have the 'hg'-executable
3674 # grml-small cleanups
3676 # The following is used to remove zsh-config-items that do not work
3677 # in grml-small by default.
3678 # If you do not want these adjustments (for whatever reason), set
3679 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3680 # sources if it is there).
3682 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3685 unalias 'V' &> /dev/null
3686 unfunction vman &> /dev/null
3687 unfunction viless &> /dev/null
3688 unfunction 2html &> /dev/null
3690 # manpages are not in grmlsmall
3691 unfunction manzsh &> /dev/null
3692 unfunction man2 &> /dev/null
3698 ## genrefcard.pl settings
3700 ### doc strings for external functions from files
3701 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3703 ### example: split functions-search 8,16,24,32
3704 #@# split functions-search 8
3706 ## END OF FILE #################################################################
3707 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4