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
434 if ls --color=auto / >/dev/null 2>&1; then
435 ls_options+=( --color=auto )
436 elif ls -G / >/dev/null 2>&1; then
439 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
440 grep_options+=( --color=auto )
444 # this function checks if a command exists and returns either true
445 # or false. This avoids using 'which' and 'whence', which will
446 # avoid problems with aliases for which on certain weird systems. :-)
447 # Usage: check_com [-c|-g] word
448 # -c only checks for external commands
449 # -g does the usual tests and also checks for global aliases
452 local -i comonly gatoo
454 if [[ $1 == '-c' ]] ; then
457 elif [[ $1 == '-g' ]] ; then
464 if (( ${#argv} != 1 )) ; then
465 printf 'usage: check_com [-c] <command>\n' >&2
469 if (( comonly > 0 )) ; then
470 [[ -n ${commands[$1]} ]] && return 0
474 if [[ -n ${commands[$1]} ]] \
475 || [[ -n ${functions[$1]} ]] \
476 || [[ -n ${aliases[$1]} ]] \
477 || [[ -n ${reswords[(r)$1]} ]] ; then
482 if (( gatoo > 0 )) && [[ -n ${galiases[$1]} ]] ; then
489 # creates an alias and precedes the command with
490 # sudo if $EUID is not zero.
493 local only=0 ; local multi=0
495 while getopts ":hao" opt; do
500 printf 'usage: salias [-hoa] <alias-expression>\n'
501 printf ' -h shows this help text.\n'
502 printf ' -a replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
503 printf ' be careful using this option.\n'
504 printf ' -o only sets an alias if a preceding sudo would be needed.\n'
507 *) salias -h >&2; return 1 ;;
510 shift "$((OPTIND-1))"
512 if (( ${#argv} > 1 )) ; then
513 printf 'Too many arguments %s\n' "${#argv}"
517 key="${1%%\=*}" ; val="${1#*\=}"
518 if (( EUID == 0 )) && (( only == 0 )); then
519 alias -- "${key}=${val}"
520 elif (( EUID > 0 )) ; then
521 (( multi > 0 )) && val="${val// ; / ; sudo }"
522 alias -- "${key}=sudo ${val}"
528 # Check if we can read given files and source those we can.
530 if (( ${#argv} < 1 )) ; then
531 printf 'usage: xsource FILE(s)...\n' >&2
535 while (( ${#argv} > 0 )) ; do
536 [[ -r "$1" ]] && source "$1"
542 # Check if we can read a given file and 'cat(1)' it.
545 if (( ${#argv} != 1 )) ; then
546 printf 'usage: xcat FILE\n' >&2
550 [[ -r $1 ]] && cat $1
554 # Remove these functions again, they are of use only in these
555 # setup files. This should be called at the end of .zshrc.
560 funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
561 for func in $funcs ; do
562 [[ -n ${functions[$func]} ]] \
568 # this allows us to stay in sync with grml's zshrc and put own
569 # modifications in ~/.zshrc.local
571 xsource "/etc/zsh/zshrc.local"
572 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
577 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
578 xsource "/etc/default/locale"
581 for var in LANG LC_ALL LC_MESSAGES ; do
582 [[ -n ${(P)var} ]] && export $var
587 if check_com -c vim ; then
589 export EDITOR=${EDITOR:-vim}
591 export EDITOR=${EDITOR:-vi}
595 export PAGER=${PAGER:-less}
598 export MAIL=${MAIL:-/var/mail/$USER}
600 # color setup for ls:
601 check_com -c dircolors && eval $(dircolors -b)
602 # color setup for ls on OS X / FreeBSD:
603 isdarwin && export CLICOLOR=1
604 isfreebsd && export CLICOLOR=1
606 # do MacPorts setup on darwin
607 if isdarwin && [[ -d /opt/local ]]; then
608 # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
610 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
611 MANPATH="/opt/local/share/man:$MANPATH"
613 # do Fink setup on darwin
614 isdarwin && xsource /sw/bin/init.sh
616 # load our function and completion directories
617 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
618 fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
619 if [[ ${fdir} == '/usr/share/grml/zsh/functions' ]] ; then
620 for func in ${fdir}/**/[^_]*[^~](N.) ; do
621 zrcautoload ${func:t}
627 # support colors in less
628 export LESS_TERMCAP_mb=$'\E[01;31m'
629 export LESS_TERMCAP_md=$'\E[01;31m'
630 export LESS_TERMCAP_me=$'\E[0m'
631 export LESS_TERMCAP_se=$'\E[0m'
632 export LESS_TERMCAP_so=$'\E[01;44;33m'
633 export LESS_TERMCAP_ue=$'\E[0m'
634 export LESS_TERMCAP_us=$'\E[01;32m'
639 # report about cpu-/system-/user-time of command if running longer than
643 # watch for everyone but me and root
646 # automatically remove duplicates from these arrays
647 typeset -U path cdpath fpath manpath
651 for mod in parameter complist deltochar mathfunc ; do
652 zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
653 done && builtin unset -v mod
655 # autoload zsh modules when they are referenced
657 zmodload -a zsh/stat zstat
658 zmodload -a zsh/zpty zpty
659 zmodload -ap zsh/mapfile mapfile
663 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
664 if zrcautoload compinit ; then
665 compinit -d ${COMPDUMPFILE} || print 'Notice: no compinit available :('
667 print 'Notice: no compinit available :('
673 # called later (via is4 && grmlcomp)
674 # note: use 'zstyle' for getting current settings
675 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
677 # TODO: This could use some additional information
679 # Make sure the completion system is initialised
680 (( ${+_comps} )) || return 1
682 # allow one error for every three characters typed in approximate completer
683 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
685 # don't complete backup files as executables
686 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
688 # start menu completion only if it could find no unambiguous initial string
689 zstyle ':completion:*:correct:*' insert-unambiguous true
690 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
691 zstyle ':completion:*:correct:*' original true
693 # activate color-completion
694 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
696 # format on completion
697 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
699 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
700 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
702 # insert all expansions for expand completer
703 zstyle ':completion:*:expand:*' tag-order all-expansions
704 zstyle ':completion:*:history-words' list false
707 zstyle ':completion:*:history-words' menu yes
709 # ignore duplicate entries
710 zstyle ':completion:*:history-words' remove-all-dups yes
711 zstyle ':completion:*:history-words' stop yes
713 # match uppercase from lowercase
714 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
716 # separate matches into groups
717 zstyle ':completion:*:matches' group 'yes'
718 zstyle ':completion:*' group-name ''
720 if [[ "$NOMENU" -eq 0 ]] ; then
721 # if there are more than 5 options allow selecting from a menu
722 zstyle ':completion:*' menu select=5
724 # don't use any menus at all
728 zstyle ':completion:*:messages' format '%d'
729 zstyle ':completion:*:options' auto-description '%d'
731 # describe options in full
732 zstyle ':completion:*:options' description 'yes'
734 # on processes completion complete all user processes
735 zstyle ':completion:*:processes' command 'ps -au$USER'
737 # offer indexes before parameters in subscripts
738 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
740 # provide verbose completion information
741 zstyle ':completion:*' verbose true
743 # recent (as of Dec 2007) zsh versions are able to provide descriptions
744 # for commands (read: 1st word in the line) that it will list for the user
745 # to choose from. The following disables that, because it's not exactly fast.
746 zstyle ':completion:*:-command-:*:' verbose false
748 # set format for warnings
749 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
751 # define files to ignore for zcompile
752 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
753 zstyle ':completion:correct:' prompt 'correct to: %e'
755 # Ignore completion functions for commands you don't have:
756 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
758 # Provide more processes in completion of programs like killall:
759 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
761 # complete manual by their section
762 zstyle ':completion:*:manuals' separate-sections true
763 zstyle ':completion:*:manuals.*' insert-sections true
764 zstyle ':completion:*:man:*' menu yes select
766 # Search path for sudo completion
767 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
775 # provide .. as a completion
776 zstyle ':completion:*' special-dirs ..
778 # run rehash on completion so new installed program are found automatically:
780 (( CURRENT == 1 )) && rehash
785 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
786 if [[ "$NOCOR" -gt 0 ]] ; then
787 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
790 # try to be smart about when to use what completer...
792 zstyle -e ':completion:*' completer '
793 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
794 _last_try="$HISTNO$BUFFER$CURSOR"
795 reply=(_complete _match _ignored _prefix _files)
797 if [[ $words[1] == (rm|mv) ]] ; then
798 reply=(_complete _files)
800 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
805 # command for process lists, the local web server details and host completion
806 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
808 # Some functions, like _apt and _dpkg, are very slow. We can use a cache in
809 # order to speed things up
810 if [[ ${GRML_COMP_CACHING:-yes} == yes ]]; then
811 GRML_COMP_CACHE_DIR=${GRML_COMP_CACHE_DIR:-${ZDOTDIR:-$HOME}/.cache}
812 if [[ ! -d ${GRML_COMP_CACHE_DIR} ]]; then
813 command mkdir -p "${GRML_COMP_CACHE_DIR}"
815 zstyle ':completion:*' use-cache yes
816 zstyle ':completion:*:complete:*' cache-path "${GRML_COMP_CACHE_DIR}"
821 [[ -r ~/.ssh/config ]] && _ssh_config_hosts=(${${(s: :)${(ps:\t:)${${(@M)${(f)"$(<$HOME/.ssh/config)"}:#Host *}#Host }}}:#*[*?]*}) || _ssh_config_hosts=()
822 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
823 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
831 "$_ssh_config_hosts[@]"
836 zstyle ':completion:*:hosts' hosts $hosts
837 # TODO: so, why is this here?
838 # zstyle '*' hosts $hosts
840 # use generic completion system for programs not yet defined; (_gnu_generic works
841 # with commands that provide a --help option with "standard" gnu-like output.)
842 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
844 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
847 # see upgrade function in this file
848 compdef _hosts upgrade
851 # Keyboard setup: The following is based on the same code, we wrote for
852 # debian's setup. It ensures the terminal is in the right mode, when zle is
853 # active, so the values from $terminfo are valid. Therefore, this setup should
854 # work on all systems, that have support for `terminfo'. It also requires the
855 # zsh in use to have the `zsh/terminfo' module built.
857 # If you are customising your `zle-line-init()' or `zle-line-finish()'
858 # functions, make sure you call the following utility functions in there:
860 # - zle-line-init(): zle-smkx
861 # - zle-line-finish(): zle-rmkx
863 # Use emacs-like key bindings by default:
868 ## beginning-of-line OR beginning-of-buffer OR beginning of history
869 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
870 beginning-or-end-of-somewhere() {
872 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
873 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
874 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
876 zle .${WIDGET:s/somewhere/line-hist/} "$@"
877 if (( HISTNO != hno )); then
878 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
882 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
883 zle -N end-of-somewhere beginning-or-end-of-somewhere
885 # add a command line to the shells history without executing it
886 commit-to-history() {
887 print -s ${(z)BUFFER}
890 zle -N commit-to-history
892 # only slash should be considered as a word separator:
893 slash-backward-kill-word() {
894 local WORDCHARS="${WORDCHARS:s@/@}"
896 zle backward-kill-word
898 zle -N slash-backward-kill-word
900 # a generic accept-line wrapper
902 # This widget can prevent unwanted autocorrections from command-name
903 # to _command-name, rehash automatically on enter and call any number
904 # of builtin and user-defined widgets in different contexts.
906 # For a broader description, see:
907 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
909 # The code is imported from the file 'zsh/functions/accept-line' from
910 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
911 # distributed under the same terms as zsh itself.
913 # A newly added command will may not be found or will cause false
914 # correction attempts, if you got auto-correction set. By setting the
915 # following style, we force accept-line() to rehash, if it cannot
916 # find the first word on the command line in the $command[] hash.
917 zstyle ':acceptline:*' rehash true
919 function Accept-Line() {
920 setopt localoptions noksharrays
924 local alcontext=${1:-$alcontext}
926 zstyle -a ":acceptline:${alcontext}" actions subs
928 (( ${#subs} < 1 )) && return 0
931 for sub in ${subs} ; do
932 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
935 (( aldone > 0 )) && break
939 function Accept-Line-getdefault() {
943 zstyle -s ":acceptline:${alcontext}" default_action default_action
944 case ${default_action} in
946 printf ".accept-line"
949 printf ${default_action}
954 function Accept-Line-HandleContext() {
957 default_action=$(Accept-Line-getdefault)
958 zstyle -T ":acceptline:${alcontext}" call_default \
959 && zle ${default_action}
962 function accept-line() {
963 setopt localoptions noksharrays
966 local buf com fname format msg default_action
970 cmdline=(${(z)BUFFER})
974 Accept-Line 'preprocess'
976 zstyle -t ":acceptline:${alcontext}" rehash \
977 && [[ -z ${commands[$com]} ]] \
981 && [[ -n ${reswords[(r)$com]} ]] \
982 || [[ -n ${aliases[$com]} ]] \
983 || [[ -n ${functions[$com]} ]] \
984 || [[ -n ${builtins[$com]} ]] \
985 || [[ -n ${commands[$com]} ]] ; then
987 # there is something sensible to execute, just do it.
989 Accept-Line-HandleContext
994 if [[ -o correct ]] \
995 || [[ -o correctall ]] \
996 && [[ -n ${functions[$fname]} ]] ; then
998 # nothing there to execute but there is a function called
999 # _command_name; a completion widget. Makes no sense to
1000 # call it on the commandline, but the correct{,all} options
1001 # will ask for it nevertheless, so warn the user.
1002 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
1003 # Okay, we warned the user before, he called us again,
1004 # so have it his way.
1006 Accept-Line-HandleContext
1011 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
1013 Accept-Line-HandleContext
1015 # prepare warning message for the user, configurable via zstyle.
1016 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
1018 if [[ -z ${msg} ]] ; then
1019 msg="%c will not execute and completion %f exists."
1022 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
1027 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
1028 # If we are here, the commandline contains something that is not
1029 # executable, which is neither subject to _command_name correction
1030 # and is not empty. might be a variable assignment
1032 Accept-Line-HandleContext
1037 # If we got this far, the commandline only contains whitespace, or is empty.
1039 Accept-Line-HandleContext
1044 zle -N Accept-Line-HandleContext
1046 # power completion / abbreviation expansion / buffer expansion
1047 # see http://zshwiki.org/home/examples/zleiab for details
1048 # less risky than the global aliases but powerful as well
1049 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
1052 setopt interactivecomments
1054 # key # value (#d additional doc string)
1060 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1062 'Hl' ' --help |& less -r' #d (Display help in pager)
1066 'N' '&>/dev/null' #d (No Output)
1067 'R' '| tr A-z N-za-m' #d (ROT13)
1068 'SL' '| sort | less'
1073 'co' './configure && make && sudo make install'
1081 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1082 LBUFFER+=${abk[$MATCH]:-$MATCH}
1089 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1092 zle -N help-show-abk
1094 # press "ctrl-e d" to insert the actual date in the form yyyy-mm-dd
1095 insert-datestamp() { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1096 zle -N insert-datestamp
1098 # press esc-m for inserting last typed word again (thanks to caphuso!)
1099 insert-last-typed-word() { zle insert-last-word -- 0 -1 };
1100 zle -N insert-last-typed-word;
1102 function grml-zsh-fg() {
1103 if (( ${#jobstates} )); then
1105 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1106 BUFFER="${BUFFER}fg"
1109 zle -M 'No background jobs. Doing nothing.'
1114 # run command line as user root via sudo:
1115 sudo-command-line() {
1116 [[ -z $BUFFER ]] && zle up-history
1117 if [[ $BUFFER != sudo\ * ]]; then
1118 BUFFER="sudo $BUFFER"
1119 CURSOR=$(( CURSOR+5 ))
1122 zle -N sudo-command-line
1124 ### jump behind the first word on the cmdline.
1125 ### useful to add options.
1126 function jump_after_first_word() {
1128 words=(${(z)BUFFER})
1130 if (( ${#words} <= 1 )) ; then
1133 CURSOR=${#${words[1]}}
1136 zle -N jump_after_first_word
1138 #f5# Create directory under cursor or the selected area
1140 # Press ctrl-xM to create the directory under the cursor or the selected area.
1141 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1142 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1143 # directory does not exist yet -> press ctrl-XM and problem solved
1145 if ((REGION_ACTIVE==1)); then
1146 local F=$MARK T=$CURSOR
1147 if [[ $F -gt $T ]]; then
1151 # get marked area from buffer and eliminate whitespace
1152 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1153 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1155 local bufwords iword
1156 bufwords=(${(z)LBUFFER})
1158 bufwords=(${(z)BUFFER})
1159 PATHTOMKDIR="${(Q)bufwords[iword]}"
1161 [[ -z "${PATHTOMKDIR}" ]] && return 1
1162 PATHTOMKDIR=${~PATHTOMKDIR}
1163 if [[ -e "${PATHTOMKDIR}" ]]; then
1164 zle -M " path already exists, doing nothing"
1166 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1171 zle -N inplaceMkDirs
1173 #v1# set number of lines to display per page
1174 HELP_LINES_PER_PAGE=20
1175 #v1# set location of help-zle cache file
1176 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1177 # helper function for help-zle, actually generates the help text
1178 help_zle_parse_keybindings()
1182 unsetopt ksharrays #indexing starts at 1
1184 #v1# choose files that help-zle will parse for keybindings
1185 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1187 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1190 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1191 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1194 #fill with default keybindings, possibly to be overwriten in a file later
1195 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1196 local -A help_zle_keybindings
1197 help_zle_keybindings['<Ctrl>@']="set MARK"
1198 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1199 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1200 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1201 help_zle_keybindings['<Ctrl>_']="undo"
1202 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1203 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1204 help_zle_keybindings['<Ctrl>e']="goto end of line"
1205 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1206 help_zle_keybindings['<Alt>t']="transpose words"
1207 help_zle_keybindings['<Alt>s']="spellcheck word"
1208 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1209 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1210 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1211 help_zle_keybindings["<Alt>'"]="quote line"
1212 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1213 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1214 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1215 help_zle_keybindings['<Alt>l']="make next word lowercase"
1216 help_zle_keybindings['<Ctrl>xd']="preview expansion under cursor"
1217 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1218 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1219 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1220 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1221 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1222 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1223 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1224 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1226 #init global variables
1227 unset help_zle_lines help_zle_sln
1228 typeset -g -a help_zle_lines
1229 typeset -g help_zle_sln=1
1232 local lastkeybind_desc contents #last description starting with #k# that we found
1233 local num_lines_elapsed=0 #number of lines between last description and keybinding
1234 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1235 for f in $HELPZLE_KEYBINDING_FILES; do
1236 [[ -r "$f" ]] || continue #not readable ? skip it
1238 for cline in "${(f)contents}"; do
1239 #zsh pattern: matches lines like: #k# ..............
1240 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1241 lastkeybind_desc="$match[*]"
1243 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1244 # ignores lines that are commentend out
1245 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1246 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1247 #description prevously found ? description not more than 2 lines away ? keybinding not empty ?
1248 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1249 #substitute keybinding string with something readable
1250 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1251 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1252 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1253 help_zle_keybindings[${k}]=$lastkeybind_desc
1257 ((num_lines_elapsed++))
1262 #calculate length of keybinding column
1264 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1265 #convert the assoc array into preformated lines, which we are able to sort
1266 for k v in ${(kv)help_zle_keybindings[@]}; do
1267 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1268 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1270 #sort lines alphabetically
1271 help_zle_lines=("${(i)help_zle_lines[@]}")
1272 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1273 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1274 zcompile $HELP_ZLE_CACHE_FILE
1276 typeset -g help_zle_sln
1277 typeset -g -a help_zle_lines
1279 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1283 unsetopt ksharrays #indexing starts at 1
1284 #help lines already generated ? no ? then do it
1285 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1286 #already displayed all lines ? go back to the start
1287 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1288 local sln=$help_zle_sln
1289 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1290 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1291 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1295 ## complete word from currently visible Screen or Tmux buffer.
1296 if check_com -c screen || check_com -c tmux; then
1297 _complete_screen_display() {
1298 [[ "$TERM" != "screen" ]] && return 1
1300 local TMPFILE=$(mktemp)
1301 local -U -a _screen_display_wordlist
1302 trap "rm -f $TMPFILE" EXIT
1304 # fill array with contents from screen hardcopy
1305 if ((${+TMUX})); then
1306 #works, but crashes tmux below version 1.4
1307 #luckily tmux -V option to ask for version, was also added in 1.4
1308 tmux -V &>/dev/null || return
1309 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1311 screen -X hardcopy $TMPFILE
1312 # screen sucks, it dumps in latin1, apparently always. so recode it
1314 check_com recode && recode latin1 $TMPFILE
1316 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1317 # remove PREFIX to be completed from that array
1318 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1319 compadd -a _screen_display_wordlist
1321 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1323 compdef -k _complete_screen_display complete-word '^xS'
1326 # Load a few more functions and tie them to widgets, so they can be bound:
1328 function zrcautozle() {
1331 zrcautoload $fnc && zle -N $fnc
1334 function zrcgotwidget() {
1335 (( ${+widgets[$1]} ))
1338 function zrcgotkeymap() {
1339 [[ -n ${(M)keymaps:#$1} ]]
1342 zrcautozle insert-files
1343 zrcautozle edit-command-line
1344 zrcautozle insert-unicode-char
1345 if zrcautoload history-search-end; then
1346 zle -N history-beginning-search-backward-end history-search-end
1347 zle -N history-beginning-search-forward-end history-search-end
1349 zle -C hist-complete complete-word _generic
1350 zstyle ':completion:hist-complete:*' completer _history
1352 # The actual terminal setup hooks and bindkey-calls:
1354 # An array to note missing features to ease diagnosis in case of problems.
1355 typeset -ga grml_missing_features
1357 function zrcbindkey() {
1358 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1363 function bind2maps () {
1364 local i sequence widget
1367 while [[ "$1" != "--" ]]; do
1373 if [[ "$1" == "-s" ]]; then
1377 sequence="${key[$1]}"
1381 [[ -z "$sequence" ]] && return 1
1383 for i in "${maps[@]}"; do
1384 zrcbindkey -M "$i" "$sequence" "$widget"
1388 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1389 function zle-smkx () {
1391 printf '%s' ${terminfo[smkx]}
1393 function zle-rmkx () {
1395 printf '%s' ${terminfo[rmkx]}
1397 function zle-line-init () {
1400 function zle-line-finish () {
1403 zle -N zle-line-init
1404 zle -N zle-line-finish
1406 for i in {s,r}mkx; do
1407 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1414 Home "${terminfo[khome]}"
1415 End "${terminfo[kend]}"
1416 Insert "${terminfo[kich1]}"
1417 Delete "${terminfo[kdch1]}"
1418 Up "${terminfo[kcuu1]}"
1419 Down "${terminfo[kcud1]}"
1420 Left "${terminfo[kcub1]}"
1421 Right "${terminfo[kcuf1]}"
1422 PageUp "${terminfo[kpp]}"
1423 PageDown "${terminfo[knp]}"
1424 BackTab "${terminfo[kcbt]}"
1427 # Guidelines for adding key bindings:
1429 # - Do not add hardcoded escape sequences, to enable non standard key
1430 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1432 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1435 # - All keys from the $key[] mapping are obviously okay.
1437 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1438 # '\ex' are allowed in here as well.
1440 bind2maps emacs -- Home beginning-of-somewhere
1441 bind2maps viins vicmd -- Home vi-beginning-of-line
1442 bind2maps emacs -- End end-of-somewhere
1443 bind2maps viins vicmd -- End vi-end-of-line
1444 bind2maps emacs viins -- Insert overwrite-mode
1445 bind2maps vicmd -- Insert vi-insert
1446 bind2maps emacs -- Delete delete-char
1447 bind2maps viins vicmd -- Delete vi-delete-char
1448 bind2maps emacs viins vicmd -- Up up-line-or-search
1449 bind2maps emacs viins vicmd -- Down down-line-or-search
1450 bind2maps emacs -- Left backward-char
1451 bind2maps viins vicmd -- Left vi-backward-char
1452 bind2maps emacs -- Right forward-char
1453 bind2maps viins vicmd -- Right vi-forward-char
1454 #k# Perform abbreviation expansion
1455 bind2maps emacs viins -- -s '^x.' zleiab
1456 #k# Display list of abbreviations that would expand
1457 bind2maps emacs viins -- -s '^xb' help-show-abk
1458 #k# mkdir -p <dir> from string under cursor or marked area
1459 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1460 #k# display help for keybindings and ZLE
1461 bind2maps emacs viins -- -s '^xz' help-zle
1462 #k# Insert files and test globbing
1463 bind2maps emacs viins -- -s "^xf" insert-files
1464 #k# Edit the current line in \kbd{\$EDITOR}
1465 bind2maps emacs viins -- -s '\ee' edit-command-line
1466 #k# search history backward for entry beginning with typed text
1467 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1468 #k# search history forward for entry beginning with typed text
1469 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1470 #k# search history backward for entry beginning with typed text
1471 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1472 #k# search history forward for entry beginning with typed text
1473 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1474 bind2maps emacs viins -- -s "^x^h" commit-to-history
1475 #k# Kill left-side word or everything up to next slash
1476 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1477 #k# Kill left-side word or everything up to next slash
1478 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1479 #k# Kill left-side word or everything up to next slash
1480 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1481 # Do history expansion on space:
1482 bind2maps emacs viins -- -s ' ' magic-space
1483 #k# Trigger menu-complete
1484 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1485 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1486 bind2maps emacs viins -- -s '^ed' insert-datestamp
1487 #k# Insert last typed word
1488 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1489 #k# A smart shortcut for \kbd{fg<enter>}
1490 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1491 #k# prepend the current command with "sudo"
1492 bind2maps emacs viins -- -s "^os" sudo-command-line
1493 #k# jump to after first word (for adding options)
1494 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1495 #k# complete word from history with menu
1496 bind2maps emacs viins -- -s "^x^x" hist-complete
1498 # insert unicode character
1499 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1500 # See for example http://unicode.org/charts/ for unicode characters code
1501 #k# Insert Unicode character
1502 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1504 # use the new *-pattern-* widgets for incremental history search
1505 if zrcgotwidget history-incremental-pattern-search-backward; then
1506 for seq wid in '^r' history-incremental-pattern-search-backward \
1507 '^s' history-incremental-pattern-search-forward
1509 bind2maps emacs viins vicmd -- -s $seq $wid
1511 builtin unset -v seq wid
1514 if zrcgotkeymap menuselect; then
1515 #m# k Shift-tab Perform backwards menu completion
1516 bind2maps menuselect -- BackTab reverse-menu-complete
1518 #k# menu selection: pick item but stay in the menu
1519 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1520 # also use + and INSERT since it's easier to press repeatedly
1521 bind2maps menuselect -- -s '+' accept-and-menu-complete
1522 bind2maps menuselect -- Insert accept-and-menu-complete
1524 # accept a completion and try to complete again by using menu
1525 # completion; very useful with completing directories
1526 # by using 'undo' one's got a simple file browser
1527 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1530 # Finally, here are still a few hardcoded escape sequences; Special sequences
1531 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1532 # standardised and most of the time are not available in a terminals terminfo
1535 # While we do not encourage adding bindings like these, we will keep these for
1536 # backward compatibility.
1538 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1539 ## the command line.
1541 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1542 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1543 # These are for xterm:
1544 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1545 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1546 ## the same for alt-left-arrow and alt-right-arrow
1548 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1549 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1551 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1552 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1553 # Also try ESC Left/Right:
1554 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1555 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1562 # we don't want to quote/espace URLs on our own...
1563 # if autoload -U url-quote-magic ; then
1564 # zle -N self-insert url-quote-magic
1565 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1567 # print 'Notice: no url-quote-magic available :('
1569 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1571 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1572 alias run-help >&/dev/null && unalias run-help
1573 for rh in run-help{,-git,-svk,-svn}; do
1577 # command not found handling
1579 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1580 function command_not_found_handler() {
1582 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1583 ${GRML_ZSH_CNF_HANDLER} $1
1591 HISTFILE=${ZDOTDIR:-${HOME}}/.zsh_history
1592 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1593 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1597 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1598 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1600 if zstyle -T ':grml:chpwd:dirstack' enable; then
1601 typeset -gaU GRML_PERSISTENT_DIRSTACK
1602 function grml_dirstack_filter() {
1605 if zstyle -s ':grml:chpwd:dirstack' filter filter; then
1606 $filter $1 && return 0
1608 if zstyle -a ':grml:chpwd:dirstack' exclude exclude; then
1609 for entry in "${exclude[@]}"; do
1610 [[ $1 == ${~entry} ]] && return 0
1617 (( $DIRSTACKSIZE <= 0 )) && return
1618 [[ -z $DIRSTACKFILE ]] && return
1619 grml_dirstack_filter $PWD && return
1620 GRML_PERSISTENT_DIRSTACK=(
1621 $PWD "${(@)GRML_PERSISTENT_DIRSTACK[1,$DIRSTACKSIZE]}"
1623 builtin print -l ${GRML_PERSISTENT_DIRSTACK} >! ${DIRSTACKFILE}
1626 if [[ -f ${DIRSTACKFILE} ]]; then
1627 # Enabling NULL_GLOB via (N) weeds out any non-existing
1628 # directories from the saved dir-stack file.
1629 dirstack=( ${(f)"$(< $DIRSTACKFILE)"}(N) )
1630 # "cd -" won't work after login by just setting $OLDPWD, so
1631 [[ -d $dirstack[1] ]] && cd -q $dirstack[1] && cd -q $OLDPWD
1634 if zstyle -t ':grml:chpwd:dirstack' filter-on-load; then
1635 for i in "${dirstack[@]}"; do
1636 if ! grml_dirstack_filter "$i"; then
1637 GRML_PERSISTENT_DIRSTACK=(
1638 "${GRML_PERSISTENT_DIRSTACK[@]}"
1644 GRML_PERSISTENT_DIRSTACK=( "${dirstack[@]}" )
1648 # directory based profiles
1652 # chpwd_profiles(): Directory Profiles, Quickstart:
1656 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1657 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1660 # For details see the `grmlzshrc.5' manual page.
1661 function chpwd_profiles() {
1662 local profile context
1665 context=":chpwd:profiles:$PWD"
1666 zstyle -s "$context" profile profile || profile='default'
1667 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1669 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1670 typeset -g CHPWD_PROFILE
1671 local CHPWD_PROFILES_INIT=1
1672 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1673 elif [[ $profile != $CHPWD_PROFILE ]]; then
1674 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1675 && chpwd_leave_profile_${CHPWD_PROFILE}
1677 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1678 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1681 CHPWD_PROFILE="${profile}"
1685 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1689 # Prompt setup for grml:
1691 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1692 # in prompts to get a red "foo" embedded, but it's good to keep these for
1693 # backwards compatibility).
1699 MAGENTA="%F{magenta}"
1703 elif zrcautoload colors && colors 2>/dev/null ; then
1704 BLUE="%{${fg[blue]}%}"
1705 RED="%{${fg_bold[red]}%}"
1706 GREEN="%{${fg[green]}%}"
1707 CYAN="%{${fg[cyan]}%}"
1708 MAGENTA="%{${fg[magenta]}%}"
1709 YELLOW="%{${fg[yellow]}%}"
1710 WHITE="%{${fg[white]}%}"
1711 NO_COLOR="%{${reset_color}%}"
1713 BLUE=$'%{\e[1;34m%}'
1715 GREEN=$'%{\e[1;32m%}'
1716 CYAN=$'%{\e[1;36m%}'
1717 WHITE=$'%{\e[1;37m%}'
1718 MAGENTA=$'%{\e[1;35m%}'
1719 YELLOW=$'%{\e[1;33m%}'
1720 NO_COLOR=$'%{\e[0m%}'
1723 # First, the easy ones: PS2..4:
1725 # secondary prompt, printed when the shell needs more information to complete a
1728 # selection prompt used within a select loop.
1730 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1733 # Some additional features to use with our prompt:
1737 # - vcs_info setup and version specific fixes
1739 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1742 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1745 elif isopenbsd ; then
1747 elif isfreebsd ; then
1749 elif isdarwin ; then
1753 GRML_DISPLAY_BATTERY=0
1759 GRML_BATTERY_LEVEL=''
1760 local batteries bat capacity
1761 batteries=( /sys/class/power_supply/BAT*(N) )
1762 if (( $#batteries > 0 )) ; then
1763 for bat in $batteries ; do
1764 capacity=$(< $bat/capacity)
1765 case $(< $bat/status) in
1767 GRML_BATTERY_LEVEL+=" ^"
1770 if (( capacity < 20 )) ; then
1771 GRML_BATTERY_LEVEL+=" !v"
1773 GRML_BATTERY_LEVEL+=" v"
1777 GRML_BATTERY_LEVEL+=" ="
1780 GRML_BATTERY_LEVEL+="${capacity}%%"
1786 GRML_BATTERY_LEVEL=''
1787 local bat batfull batwarn batnow num
1789 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1790 if [[ -n $bat ]]; then
1791 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1792 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1793 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1794 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1796 if (( batnow < batwarn )) ; then
1797 GRML_BATTERY_LEVEL+=" !v"
1799 GRML_BATTERY_LEVEL+=" v"
1803 GRML_BATTERY_LEVEL+=" ^"
1806 GRML_BATTERY_LEVEL+=" ="
1809 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1815 GRML_BATTERY_LEVEL=''
1819 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1820 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1821 case $table[State] in
1823 if (( $table[Remaining-capacity] < 20 )) ; then
1824 GRML_BATTERY_LEVEL+=" !v"
1826 GRML_BATTERY_LEVEL+=" v"
1830 GRML_BATTERY_LEVEL+=" ^"
1833 GRML_BATTERY_LEVEL+=" ="
1836 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1842 GRML_BATTERY_LEVEL=''
1844 table=( ${$(pmset -g ps)[(w)7,8]%%(\%|);} )
1845 if [[ -n $table[2] ]] ; then
1848 GRML_BATTERY_LEVEL+=" ^"
1851 if (( $table[1] < 20 )) ; then
1852 GRML_BATTERY_LEVEL+=" !v"
1854 GRML_BATTERY_LEVEL+=" v"
1858 GRML_BATTERY_LEVEL+=" ="
1861 GRML_BATTERY_LEVEL+="$table[1]%%"
1865 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1866 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1867 debian_chroot=$(</etc/debian_chroot)
1870 # gather version control information for inclusion in a prompt
1872 if zrcautoload vcs_info; then
1873 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1874 # function, which can cause a lot of trouble with our directory-based
1876 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1877 function VCS_INFO_realpath () {
1878 setopt localoptions NO_shwordsplit chaselinks
1879 ( builtin cd -q $1 2> /dev/null && pwd; )
1883 zstyle ':vcs_info:*' max-exports 2
1885 if [[ -o restricted ]]; then
1886 zstyle ':vcs_info:*' enable NONE
1890 typeset -A grml_vcs_coloured_formats
1891 typeset -A grml_vcs_plain_formats
1893 grml_vcs_plain_formats=(
1894 format "(%s%)-[%b] " "zsh: %r"
1895 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1896 rev-branchformat "%b:%r"
1899 grml_vcs_coloured_formats=(
1900 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1901 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1902 rev-branchformat "%b${RED}:${YELLOW}%r"
1905 typeset GRML_VCS_COLOUR_MODE=xxx
1907 grml_vcs_info_toggle_colour () {
1909 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
1910 grml_vcs_info_set_formats coloured
1912 grml_vcs_info_set_formats plain
1917 grml_vcs_info_set_formats () {
1919 #setopt localoptions xtrace
1920 local mode=$1 AF F BF
1921 if [[ $mode == coloured ]]; then
1922 AF=${grml_vcs_coloured_formats[actionformat]}
1923 F=${grml_vcs_coloured_formats[format]}
1924 BF=${grml_vcs_coloured_formats[rev-branchformat]}
1925 GRML_VCS_COLOUR_MODE=coloured
1927 AF=${grml_vcs_plain_formats[actionformat]}
1928 F=${grml_vcs_plain_formats[format]}
1929 BF=${grml_vcs_plain_formats[rev-branchformat]}
1930 GRML_VCS_COLOUR_MODE=plain
1933 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
1934 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
1935 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
1939 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1940 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1941 if [[ "$TERM" == dumb ]] ; then
1942 grml_vcs_info_set_formats plain
1944 grml_vcs_info_set_formats coloured
1947 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
1949 # This actually defines three prompts:
1955 # They all share the same code and only differ with respect to which items they
1956 # contain. The main source of documentation is the `prompt_grml_help' function
1957 # below, which gets called when the user does this: prompt -h grml
1959 function prompt_grml_help () {
1963 This is the prompt as used by the grml-live system <http://grml.org>. It is
1964 a rather simple one-line prompt, that by default looks something like this:
1966 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
1968 The prompt itself integrates with zsh's prompt themes system (as you are
1969 witnessing right now) and is configurable to a certain degree. In
1970 particular, these aspects are customisable:
1972 - The items used in the prompt (e.g. you can remove \`user' from
1973 the list of activated items, which will cause the user name to
1974 be omitted from the prompt string).
1976 - The attributes used with the items are customisable via strings
1977 used before and after the actual item.
1979 The available items are: at, battery, change-root, date, grml-chroot,
1980 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
1981 shell-level, time, user, vcs
1983 The actual configuration is done via zsh's \`zstyle' mechanism. The
1984 context, that is used while looking up styles is:
1986 ':prompt:grml:<left-or-right>:<subcontext>'
1988 Here <left-or-right> is either \`left' or \`right', signifying whether the
1989 style should affect the left or the right prompt. <subcontext> is either
1990 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
1994 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
1995 in $RPROMPT if the last command a returned non-successful error code.
1996 (This in only valid if <left-or-right> is "right"; ignored otherwise)
1998 - items (list): The list of items used in the prompt. If \`vcs' is
1999 present in the list, the theme's code invokes \`vcs_info'
2000 accordingly. Default (left): rc change-root user at host path vcs
2001 percent; Default (right): sad-smiley
2003 Available styles in 'items:<item>' are: pre, post. These are strings that
2004 are inserted before (pre) and after (post) the item in question. Thus, the
2005 following would cause the user name to be printed in red instead of the
2008 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
2010 Note, that the \`post' style may remain at its default value, because its
2011 default value is '%f', which turns the foreground text attribute off (which
2012 is exactly, what is still required with the new \`pre' value).
2016 function prompt_grml-chroot_help () {
2020 This is a variation of the grml prompt, see: prompt -h grml
2022 The main difference is the default value of the \`items' style. The rest
2023 behaves exactly the same. Here are the defaults for \`grml-chroot':
2025 - left: grml-chroot user at host path percent
2026 - right: (empty list)
2030 function prompt_grml-large_help () {
2034 This is a variation of the grml prompt, see: prompt -h grml
2036 The main difference is the default value of the \`items' style. In
2037 particular, this theme uses _two_ lines instead of one with the plain
2038 \`grml' theme. The rest behaves exactly the same. Here are the defaults
2041 - left: rc jobs history shell-level change-root time date newline user
2042 at host path vcs percent
2047 function grml_prompt_setup () {
2049 autoload -Uz vcs_info
2050 # The following autoload is disabled for now, since this setup includes a
2051 # static version of the ‘add-zsh-hook’ function above. It needs to be
2052 # reenabled as soon as that static definition is removed again.
2053 #autoload -Uz add-zsh-hook
2054 add-zsh-hook precmd prompt_$1_precmd
2057 function prompt_grml_setup () {
2058 grml_prompt_setup grml
2061 function prompt_grml-chroot_setup () {
2062 grml_prompt_setup grml-chroot
2065 function prompt_grml-large_setup () {
2066 grml_prompt_setup grml-large
2069 # These maps define default tokens and pre-/post-decoration for items to be
2070 # used within the themes. All defaults may be customised in a context sensitive
2071 # matter by using zsh's `zstyle' mechanism.
2072 typeset -gA grml_prompt_pre_default \
2073 grml_prompt_post_default \
2074 grml_prompt_token_default \
2075 grml_prompt_token_function
2077 grml_prompt_pre_default=(
2082 grml-chroot '%F{red}'
2092 shell-level '%F{red}'
2098 grml_prompt_post_default=(
2119 grml_prompt_token_default=(
2121 battery 'GRML_BATTERY_LEVEL'
2122 change-root 'debian_chroot'
2124 grml-chroot 'GRML_CHROOT'
2125 history '{history#%!} '
2127 jobs '[%j running job(s)] '
2129 path '%40<..<%~%<< '
2133 sad-smiley '%(?..:()'
2134 shell-level '%(3L.+ .)'
2135 time '%D{%H:%M:%S} '
2140 function grml_theme_has_token () {
2141 if (( ARGC != 1 )); then
2142 printf 'usage: grml_theme_has_token <name>\n'
2145 (( ${+grml_prompt_token_default[$1]} ))
2148 function GRML_theme_add_token_usage () {
2150 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2152 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2153 are used, <token/function> is the name of the function (see below for
2154 details). Otherwise it is the literal token string to be used. <pre> and
2155 <post> are optional.
2159 -f <function> Use a function named \`<function>' each time the token
2162 -i <function> Use a function named \`<function>' to initialise the
2163 value of the token _once_ at runtime.
2165 The functions are called with one argument: the token's new name. The
2166 return value is expected in the \$REPLY parameter. The use of these
2167 options is mutually exclusive.
2169 There is a utility function \`grml_theme_has_token', which you can use
2170 to test if a token exists before trying to add it. This can be a guard
2171 for situations in which a \`grml_theme_add_token' call may happen more
2176 To add a new token \`day' that expands to the current weekday in the
2177 current locale in green foreground colour, use this:
2179 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2181 Another example would be support for \$VIRTUAL_ENV:
2183 function virtual_env_prompt () {
2184 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2186 grml_theme_add_token virtual-env -f virtual_env_prompt
2188 After that, you will be able to use a changed \`items' style to
2189 assemble your prompt.
2193 function grml_theme_add_token () {
2195 local name token pre post
2196 local -i init funcall
2198 if (( ARGC == 0 )); then
2199 GRML_theme_add_token_usage
2209 if [[ $1 == '-f' ]]; then
2212 elif [[ $1 == '-i' ]]; then
2217 if (( ARGC == 0 )); then
2219 grml_theme_add_token: No token-string/function-name provided!\n\n'
2220 GRML_theme_add_token_usage
2225 if (( ARGC != 0 && ARGC != 2 )); then
2227 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2228 GRML_theme_add_token_usage
2237 if grml_theme_has_token $name; then
2239 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2240 GRML_theme_add_token_usage
2247 grml_prompt_pre_default[$name]=$pre
2248 grml_prompt_post_default[$name]=$post
2249 if (( funcall )); then
2250 grml_prompt_token_function[$name]=$token
2251 grml_prompt_token_default[$name]=23
2253 grml_prompt_token_default[$name]=$token
2257 function grml_typeset_and_wrap () {
2264 if (( ${+parameters[$new]} )); then
2265 typeset -g "${target}=${(P)target}${left}${(P)new}${right}"
2269 function grml_prompt_addto () {
2272 local lr it apre apost new v
2276 [[ $target == PS1 ]] && lr=left || lr=right
2277 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2278 typeset -g "${target}="
2279 for it in "${items[@]}"; do
2280 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2281 || apre=${grml_prompt_pre_default[$it]}
2282 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2283 || apost=${grml_prompt_post_default[$it]}
2284 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2285 || new=${grml_prompt_token_default[$it]}
2286 typeset -g "${target}=${(P)target}${apre}"
2287 if (( ${+grml_prompt_token_function[$it]} )); then
2288 ${grml_prompt_token_function[$it]} $it
2289 typeset -g "${target}=${(P)target}${REPLY}"
2293 grml_typeset_and_wrap $target $new '' ''
2296 grml_typeset_and_wrap $target $new '(' ')'
2299 if [[ -n ${(P)new} ]]; then
2300 typeset -g "${target}=${(P)target}(CHROOT)"
2304 v="vcs_info_msg_${new}_"
2305 if (( ! vcscalled )); then
2309 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2310 typeset -g "${target}=${(P)target}${(P)v}"
2313 *) typeset -g "${target}=${(P)target}${new}" ;;
2316 typeset -g "${target}=${(P)target}${apost}"
2320 function prompt_grml_precmd () {
2322 local grmltheme=grml
2323 local -a left_items right_items
2324 left_items=(rc change-root user at host path vcs percent)
2325 right_items=(sad-smiley)
2327 prompt_grml_precmd_worker
2330 function prompt_grml-chroot_precmd () {
2332 local grmltheme=grml-chroot
2333 local -a left_items right_items
2334 left_items=(grml-chroot user at host path percent)
2337 prompt_grml_precmd_worker
2340 function prompt_grml-large_precmd () {
2342 local grmltheme=grml-large
2343 local -a left_items right_items
2344 left_items=(rc jobs history shell-level change-root time date newline
2345 user at host path vcs percent)
2346 right_items=(sad-smiley)
2348 prompt_grml_precmd_worker
2351 function prompt_grml_precmd_worker () {
2353 local -i vcscalled=0
2355 grml_prompt_addto PS1 "${left_items[@]}"
2356 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2357 grml_prompt_addto RPS1 "${right_items[@]}"
2361 grml_prompt_fallback() {
2364 (( ${+functions[vcs_info]} )) && vcs_info
2367 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2368 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2369 if (( EUID == 0 )); then
2370 PROMPT="${BLUE}${p0}${RED}${p1}"
2372 PROMPT="${RED}${p0}${BLUE}${p1}"
2377 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2378 # Since we define the required functions in here and not in files in
2379 # $fpath, we need to stick the theme's name into `$prompt_themes'
2380 # ourselves, since promptinit does not pick them up otherwise.
2381 prompt_themes+=( grml grml-chroot grml-large )
2382 # Also, keep the array sorted...
2383 prompt_themes=( "${(@on)prompt_themes}" )
2385 print 'Notice: no promptinit available :('
2386 grml_prompt_fallback
2390 # The prompt themes use modern features of zsh, that require at least
2391 # version 4.3.7 of the shell. Use the fallback otherwise.
2392 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2393 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2394 add-zsh-hook precmd battery
2396 if [[ "$TERM" == dumb ]] ; then
2397 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2398 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2399 for i in rc user path jobs history date time shell-level; do
2400 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2401 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2404 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2405 elif (( EUID == 0 )); then
2406 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2409 # Finally enable one of the prompts.
2410 if [[ -n $GRML_CHROOT ]]; then
2412 elif [[ $GRMLPROMPT -gt 0 ]]; then
2418 grml_prompt_fallback
2421 # Terminal-title wizardry
2423 function ESC_print () {
2424 info_print $'\ek' $'\e\\' "$@"
2426 function set_title () {
2427 info_print $'\e]0;' $'\a' "$@"
2430 function info_print () {
2431 local esc_begin esc_end
2435 printf '%s' ${esc_begin}
2437 printf '%s' "${esc_end}"
2440 function grml_reset_screen_title () {
2441 # adjust title of xterm
2442 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2443 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2446 set_title ${(%):-"%n@%m: %~"}
2451 function grml_vcs_to_screen_title () {
2452 if [[ $TERM == screen* ]] ; then
2453 if [[ -n ${vcs_info_msg_1_} ]] ; then
2454 ESC_print ${vcs_info_msg_1_}
2461 function grml_maintain_name () {
2462 # set hostname if not running on host with name 'grml'
2463 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
2468 function grml_cmd_to_screen_title () {
2469 # get the name of the program currently running and hostname of local
2470 # machine set screen window title if running in a screen
2471 if [[ "$TERM" == screen* ]] ; then
2472 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2477 function grml_control_xterm_title () {
2480 set_title "${(%):-"%n@%m:"}" "$1"
2485 # The following autoload is disabled for now, since this setup includes a
2486 # static version of the ‘add-zsh-hook’ function above. It needs to be
2487 # reenabled as soon as that static definition is removed again.
2488 #zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2489 if [[ $NOPRECMD -eq 0 ]]; then
2490 add-zsh-hook precmd grml_reset_screen_title
2491 add-zsh-hook precmd grml_vcs_to_screen_title
2492 add-zsh-hook preexec grml_maintain_name
2493 add-zsh-hook preexec grml_cmd_to_screen_title
2494 if [[ $NOTITLE -eq 0 ]]; then
2495 add-zsh-hook preexec grml_control_xterm_title
2499 # 'hash' some often used directories
2501 hash -d deb=/var/cache/apt/archives
2502 hash -d doc=/usr/share/doc
2503 hash -d linux=/lib/modules/$(command uname -r)/build/
2504 hash -d log=/var/log
2505 hash -d slog=/var/log/syslog
2506 hash -d src=/usr/src
2507 hash -d www=/var/www
2511 if check_com -c screen ; then
2512 if [[ $UID -eq 0 ]] ; then
2513 if [[ -r /etc/grml/screenrc ]]; then
2514 alias screen='screen -c /etc/grml/screenrc'
2516 elif [[ ! -r $HOME/.screenrc ]] ; then
2517 if [[ -r /etc/grml/screenrc_grml ]]; then
2518 alias screen='screen -c /etc/grml/screenrc_grml'
2520 if [[ -r /etc/grml/screenrc ]]; then
2521 alias screen='screen -c /etc/grml/screenrc'
2527 # do we have GNU ls with color-support?
2528 if [[ "$TERM" != dumb ]]; then
2529 #a1# List files with colors (\kbd{ls \ldots})
2530 alias ls="command ls ${ls_options:+${ls_options[*]}}"
2531 #a1# List all files, with colors (\kbd{ls -la \ldots})
2532 alias la="command ls -la ${ls_options:+${ls_options[*]}}"
2533 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2534 alias ll="command ls -l ${ls_options:+${ls_options[*]}}"
2535 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2536 alias lh="command ls -hAl ${ls_options:+${ls_options[*]}}"
2537 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -l \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2538 alias l="command ls -l ${ls_options:+${ls_options[*]}}"
2540 alias la='command ls -la'
2541 alias ll='command ls -l'
2542 alias lh='command ls -hAl'
2543 alias l='command ls -l'
2546 alias mdstat='cat /proc/mdstat'
2547 alias ...='cd ../../'
2549 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2550 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2551 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2554 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2555 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2556 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2558 # make sure it is not assigned yet
2559 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2563 for ENV in $(env | command grep -i '.utf') ; do
2564 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2569 # make sure it is not assigned yet
2570 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2572 if ! isutfenv ; then
2574 for ENV in $(env | command grep -i '\.iso') ; do
2575 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2580 # especially for roadwarriors using GNU screen and ssh:
2581 if ! check_com asc &>/dev/null ; then
2582 asc() { autossh -t "$@" 'screen -RdU' }
2586 #f1# Hints for the use of zsh on grml
2588 print "$bg[white]$fg[black]
2589 zsh-help - hints for use of zsh on grml
2590 =======================================$reset_color"
2593 Main configuration of zsh happens in /etc/zsh/zshrc.
2594 That file is part of the package grml-etc-core, if you want to
2595 use them on a non-grml-system just get the tar.gz from
2596 http://deb.grml.org/ or (preferably) get it from the git repository:
2598 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2600 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2601 The file is still there, but it is empty for backwards compatibility.
2603 For your own changes use these two files:
2607 The former is sourced very early in our zshrc, the latter is sourced
2610 System wide configuration without touching configuration files of grml
2611 can take place in /etc/zsh/zshrc.local.
2613 For information regarding zsh start at http://grml.org/zsh/
2615 Take a look at grml'\''s zsh refcard:
2616 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2618 Check out the main zsh refcard:
2619 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2621 And of course visit the zsh-lovers:
2624 You can adjust some options through environment variables when
2625 invoking zsh without having to edit configuration files.
2626 Basically meant for bash users who are not used to the power of
2629 "NOCOR=1 zsh" => deactivate automatic correction
2630 "NOMENU=1 zsh" => do not use auto menu completion
2631 (note: use ctrl-d for completion instead!)
2632 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2633 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2634 preexec() and precmd() completely
2635 "GRML_DISPLAY_BATTERY=1 zsh"
2636 => activate battery status on right side of prompt (WIP)
2637 "COMMAND_NOT_FOUND=1 zsh"
2638 => Enable a handler if an external command was not found
2639 The command called in the handler can be altered by setting
2640 the GRML_ZSH_CNF_HANDLER variable, the default is:
2641 "/usr/share/command-not-found/command-not-found"
2643 A value greater than 0 is enables a feature; a value equal to zero
2644 disables it. If you like one or the other of these settings, you can
2645 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2649 $bg[white]$fg[black]
2650 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2651 Enjoy your grml system with the zsh!$reset_color"
2655 if [[ -r /etc/debian_version ]] ; then
2656 #a3# Execute \kbd{apt-cache search}
2657 alias acs='apt-cache search'
2658 #a3# Execute \kbd{apt-cache show}
2659 alias acsh='apt-cache show'
2660 #a3# Execute \kbd{apt-cache policy}
2661 alias acp='apt-cache policy'
2662 #a3# Execute \kbd{apt-get dist-upgrade}
2663 salias adg="apt-get dist-upgrade"
2664 #a3# Execute \kbd{apt-get install}
2665 salias agi="apt-get install"
2666 #a3# Execute \kbd{aptitude install}
2667 salias ati="aptitude install"
2668 #a3# Execute \kbd{apt-get upgrade}
2669 salias ag="apt-get upgrade"
2670 #a3# Execute \kbd{apt-get update}
2671 salias au="apt-get update"
2672 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2673 salias -a up="aptitude update ; aptitude safe-upgrade"
2674 #a3# Execute \kbd{dpkg-buildpackage}
2675 alias dbp='dpkg-buildpackage'
2676 #a3# Execute \kbd{grep-excuses}
2677 alias ge='grep-excuses'
2679 # get a root shell as normal user in live-cd mode:
2680 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2684 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
2685 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2686 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
2687 salias tlog="tail -f /var/log/syslog" # follow the syslog
2690 # sort installed Debian-packages by size
2691 if check_com -c dpkg-query ; then
2692 #a3# List installed Debian-packages sorted by size
2693 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"
2696 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2697 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2698 if check_com -c wodim; then
2701 cdrecord is not provided under its original name by Debian anymore.
2702 See #377109 in the BTS of Debian for more details.
2704 Please use the wodim binary instead
2712 # No core dumps: important for a live-cd-system
2718 # people should use 'grml-x'!
2719 if check_com -c 915resolution; then
2721 echo "Please use 915resolution as resolution modifying tool for Intel \
2727 #a1# Output version of running grml
2728 alias grml-version='cat /etc/grml_version'
2730 if check_com -c grml-debootstrap ; then
2732 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2738 # now run the functions
2740 is4 && isgrml && grmlstuff
2744 is4 && xsource "/etc/zsh/keephack"
2746 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2747 # You use it as follows:
2748 # $ NTREF=/reference/file
2750 # This lists all the files in the current directory newer than the reference file.
2751 # You can also specify the reference file inline; note quotes:
2752 # $ ls -l *(e:'nt ~/.zshenv':)
2754 if [[ -n $1 ]] ; then
2757 [[ $REPLY -nt $NTREF ]]
2762 #f1# Reload an autoloadable function
2763 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2764 compdef _functions freload
2769 # e.g.: a -> b -> c -> d ....
2774 # if parameter is given with leading '=', lookup $PATH for parameter and resolve that
2778 # Note: limit for recursive symlinks on linux:
2779 # http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/fs/namei.c?id=refs/heads/master#l808
2780 # This limits recursive symlink follows to 8,
2781 # while limiting consecutive symlinks to 40.
2783 # When resolving and displaying information about symlinks, no check is made
2784 # that the displayed information does make any sense on your OS.
2785 # We leave that decission to the user.
2787 # The zstat module is used to detect symlink loops. zstat is available since zsh4.
2788 # With an older zsh you will need to abort with <C-c> in that case.
2789 # When a symlink loop is detected, a warning ist printed and further processing is stopped.
2791 # Module zstat is loaded by default in grml zshrc, no extra action needed for that.
2794 # If you happen to come accross a symlink that points to a destination on an other partition
2795 # with the same inode number, that will be marked as symlink loop though it is not.
2796 # Two hints for this situation:
2797 # I) Play lottery the same day, as you seem to be rather lucky right now.
2802 # 1 file/dir not accesible
2803 # 2 symlink loop detected
2805 #f1# List symlinks in detail (more detailed version of 'readlink -f', 'whence -s' and 'namei -l')
2807 if [[ -z ${1} ]] ; then
2808 printf 'Usage: %s <symlink(s)>\n' "${0}"
2812 local file jumpd curdir
2813 local -i RTN LINODE i
2818 for file in "${@}" ; do
2820 ls -l "${file:a}" || RTN=1
2822 while [[ -h "$file" ]] ; do
2824 LINODE=$(zstat -L +inode "${file}")
2825 for i in ${SEENINODES} ; do
2826 if (( ${i} == ${LINODE} )) ; then
2827 builtin cd "${curdir}"
2828 print "link loop detected, aborting!"
2832 SEENINODES+=${LINODE}
2837 if [[ -d ${jumpd} ]] ; then
2838 builtin cd "${jumpd}" || RTN=1
2840 file=$(readlink "$file")
2845 if [[ -d ${jumpd} ]] ; then
2846 builtin cd "${jumpd}" || RTN=1
2849 ls -l "${PWD}/${file}" || RTN=1
2852 if (( ${#} >= 1 )) ; then
2855 builtin cd "${curdir}"
2860 # TODO: Is it supported to use pager settings like this?
2861 # PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
2862 # with respect to wordsplitting. (ie. ${=PAGER})
2863 if check_com -c $PAGER ; then
2864 #f3# View Debian's changelog of given package(s)
2867 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
2870 for package in "$@" ; do
2871 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
2872 $PAGER /usr/share/doc/${package}/changelog.Debian.gz
2873 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
2874 $PAGER /usr/share/doc/${package}/changelog.gz
2875 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
2876 $PAGER /usr/share/doc/${package}/changelog
2878 if check_com -c aptitude ; then
2879 echo "No changelog for package $package found, using aptitude to retrieve it."
2880 aptitude changelog "$package"
2881 elif check_com -c apt-get ; then
2882 echo "No changelog for package $package found, using apt-get to retrieve it."
2883 apt-get changelog "$package"
2885 echo "No changelog for package $package found, sorry."
2890 _dchange() { _files -W /usr/share/doc -/ }
2891 compdef _dchange dchange
2893 #f3# View Debian's NEWS of a given package
2896 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
2897 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
2899 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
2900 $PAGER /usr/share/doc/$1/NEWS.gz
2902 echo "No NEWS file for package $1 found, sorry."
2907 _dnews() { _files -W /usr/share/doc -/ }
2908 compdef _dnews dnews
2910 #f3# View Debian's copyright of a given package
2913 if [[ -r /usr/share/doc/$1/copyright ]] ; then
2914 $PAGER /usr/share/doc/$1/copyright
2916 echo "No copyright file for package $1 found, sorry."
2920 _dcopyright() { _files -W /usr/share/doc -/ }
2921 compdef _dcopyright dcopyright
2923 #f3# View upstream's changelog of a given package
2926 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2927 $PAGER /usr/share/doc/$1/changelog.gz
2929 echo "No changelog for package $1 found, sorry."
2933 _uchange() { _files -W /usr/share/doc -/ }
2934 compdef _uchange uchange
2939 ZSH_PROFILE_RC=1 zsh "$@"
2942 #f1# Edit an alias via zle
2944 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2946 compdef _aliases edalias
2948 #f1# Edit a function via zle
2950 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
2952 compdef _functions edfunc
2954 # use it e.g. via 'Restart apache2'
2955 #m# f6 Start() \kbd{service \em{process}}\quad\kbd{start}
2956 #m# f6 Restart() \kbd{service \em{process}}\quad\kbd{restart}
2957 #m# f6 Stop() \kbd{service \em{process}}\quad\kbd{stop}
2958 #m# f6 Reload() \kbd{service \em{process}}\quad\kbd{reload}
2959 #m# f6 Force-Reload() \kbd{service \em{process}}\quad\kbd{force-reload}
2960 #m# f6 Status() \kbd{service \em{process}}\quad\kbd{status}
2961 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2963 local action_="${1:l}" # e.g Start/Stop/Restart
2967 local service_target_="$(readlink /etc/init.d/$service_)"
2968 if [[ $service_target_ == "/usr/bin/sv" ]]; then
2970 case "${action_}" in
2971 start) if [[ ! -e /etc/service/$service_ ]]; then
2972 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2974 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2976 # there is no reload in runits sysv emulation
2977 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2978 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2981 # sysv/sysvinit-utils, upstart
2982 if check_com -c service ; then
2983 $SUDO service "$service_" "${action_}" "$param_"
2985 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2992 scripts=( /etc/init.d/*(x:t) )
2993 _describe "service startup script" scripts
2996 for i in Start Restart Stop Force-Reload Reload Status ; do
2997 eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
2998 compdef _grmlinitd $i
3003 #f1# Provides useful information on globbing
3010 p named pipes (FIFOs)
3011 * executable plain files (0100)
3012 % device files (character or block special)
3013 %b block special files
3014 %c character special files
3015 r owner-readable files (0400)
3016 w owner-writable files (0200)
3017 x owner-executable files (0100)
3018 A group-readable files (0040)
3019 I group-writable files (0020)
3020 E group-executable files (0010)
3021 R world-readable files (0004)
3022 W world-writable files (0002)
3023 X world-executable files (0001)
3024 s setuid files (04000)
3025 S setgid files (02000)
3026 t files with the sticky bit (01000)
3028 print *(m-1) # Files modified up to a day ago
3029 print *(a1) # Files accessed a day ago
3030 print *(@) # Just symlinks
3031 print *(Lk+50) # Files bigger than 50 kilobytes
3032 print *(Lk-50) # Files smaller than 50 kilobytes
3033 print **/*.c # All *.c files recursively starting in \$PWD
3034 print **/*.c~file.c # Same as above, but excluding 'file.c'
3035 print (foo|bar).* # Files starting with 'foo' or 'bar'
3036 print *~*.* # All Files that do not contain a dot
3037 chmod 644 *(.^x) # make all plain non-executable files publically readable
3038 print -l *(.c|.h) # Lists *.c and *.h
3039 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
3040 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
3042 alias help-zshglob=H-Glob
3044 # grep for running process, like: 'any vim'
3048 if [[ -z "$1" ]] ; then
3049 echo "any - grep for process(es) by keyword" >&2
3050 echo "Usage: any <keyword>" >&2 ; return 1
3052 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
3057 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
3058 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
3059 [[ -r /proc/1/maps ]] && \
3061 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
3062 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
3063 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
3066 # a wrapper for vim, that deals with title setting
3068 # set this array to a set of options to vim you always want
3069 # to have set when calling vim (in .zshrc.local), like:
3070 # VIM_OPTIONS=( -p )
3071 # This will cause vim to send every file given on the
3072 # commandline to be send to it's own tab (needs vim7).
3073 if check_com vim; then
3075 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
3079 ssl_hashes=( sha512 sha256 sha1 md5 )
3081 for sh in ${ssl_hashes}; do
3082 eval 'ssl-cert-'${sh}'() {
3084 if [[ -z $1 ]] ; then
3085 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
3088 openssl x509 -noout -fingerprint -'${sh}' -in $1
3092 ssl-cert-fingerprints() {
3095 if [[ -z $1 ]] ; then
3096 printf 'usage: ssl-cert-fingerprints <file>\n'
3099 for i in ${ssl_hashes}
3106 if [[ -z $1 ]] ; then
3107 printf 'usage: ssl-cert-info <file>\n'
3110 openssl x509 -noout -text -in $1
3111 ssl-cert-fingerprints $1
3114 # make sure our environment is clean regarding colors
3115 for var in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $var
3116 builtin unset -v var
3118 # "persistent history"
3119 # just write important commands you always need to ~/.important_commands
3120 if [[ -r ~/.important_commands ]] ; then
3121 fc -R ~/.important_commands
3124 # load the lookup subsystem if it's available on the system
3125 zrcautoload lookupinit && lookupinit
3129 # set terminal property (used e.g. by msgid-chooser)
3130 export COLORTERM="yes"
3135 #a2# Execute \kbd{du -sch}
3139 #a2# Execute \kbd{ls -lSrah}
3140 alias dir="command ls -lSrah"
3141 #a2# Only show dot-directories
3142 alias lad='command ls -d .*(/)'
3143 #a2# Only show dot-files
3144 alias lsa='command ls -a .*(.)'
3145 #a2# Only files with setgid/setuid/sticky flag
3146 alias lss='command ls -l *(s,S,t)'
3147 #a2# Only show symlinks
3148 alias lsl='command ls -l *(@)'
3149 #a2# Display only executables
3150 alias lsx='command ls -l *(*)'
3151 #a2# Display world-{readable,writable,executable} files
3152 alias lsw='command ls -ld *(R,W,X.^ND/)'
3153 #a2# Display the ten biggest files
3154 alias lsbig="command ls -flh *(.OL[1,10])"
3155 #a2# Only show directories
3156 alias lsd='command ls -d *(/)'
3157 #a2# Only show empty directories
3158 alias lse='command ls -d *(/^F)'
3159 #a2# Display the ten newest files
3160 alias lsnew="command ls -rtlh *(D.om[1,10])"
3161 #a2# Display the ten oldest files
3162 alias lsold="command ls -rtlh *(D.Om[1,10])"
3163 #a2# Display the ten smallest files
3164 alias lssmall="command ls -Srl *(.oL[1,10])"
3165 #a2# Display the ten newest directories and ten newest .directories
3166 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
3167 #a2# Display the ten oldest directories and ten oldest .directories
3168 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
3170 # some useful aliases
3171 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
3172 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
3174 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3175 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3176 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3177 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3179 # work around non utf8 capable software in utf environment via $LANG and luit
3180 if check_com isutfenv && check_com luit ; then
3181 if check_com -c mrxvt ; then
3182 isutfenv && [[ -n "$LANG" ]] && \
3183 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3186 if check_com -c aterm ; then
3187 isutfenv && [[ -n "$LANG" ]] && \
3188 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3191 if check_com -c centericq ; then
3192 isutfenv && [[ -n "$LANG" ]] && \
3193 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3199 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3202 local current_date=$(date -u "+%Y-%m-%dT%H:%M:%SZ")
3203 local clean keep move verbose result all to_bk
3204 setopt extended_glob
3206 while getopts ":hacmrv" opt; do
3209 c) unset move clean && (( ++keep ));;
3210 m) unset keep clean && (( ++move ));;
3211 r) unset move keep && (( ++clean ));;
3214 bk [-hcmv] FILE [FILE ...]
3215 bk -r [-av] [FILE [FILE ...]]
3216 Backup a file or folder in place and append the timestamp
3217 Remove backups of a file or folder, or all backups in the current directory
3220 -h Display this help text
3221 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3222 -m Move the file/folder, using mv(1)
3223 -r Remove backups of the specified file or directory, using rm(1). If none
3224 is provided, remove all backups in the current directory.
3225 -a Remove all (even hidden) backups.
3228 The -c, -r and -m options are mutually exclusive. If specified at the same time,
3229 the last one is used.
3231 The return code is the sum of all cp/mv/rm return codes.
3234 \?) bk -h >&2; return 1;;
3237 shift "$((OPTIND-1))"
3238 if (( keep > 0 )); then
3239 if islinux || isfreebsd; then
3240 for to_bk in "$@"; do
3241 cp $verbose -a "${to_bk%/}" "${to_bk%/}_$current_date"
3245 for to_bk in "$@"; do
3246 cp $verbose -pR "${to_bk%/}" "${to_bk%/}_$current_date"
3250 elif (( move > 0 )); then
3251 while (( $# > 0 )); do
3252 mv $verbose "${1%/}" "${1%/}_$current_date"
3256 elif (( clean > 0 )); then
3257 if (( $# > 0 )); then
3258 for to_bk in "$@"; do
3259 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
3263 if (( all > 0 )); then
3264 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)
3266 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
3274 #f5# cd to directoy and list files
3280 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3282 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3283 [[ ! -e ${1:h} ]] && return 1
3284 print "Correcting ${1} to ${1:h}"
3291 #f5# Create Directoy and \kbd{cd} to it
3293 if (( ARGC != 1 )); then
3294 printf 'usage: mkcd <new-directory>\n'
3297 if [[ ! -d "$1" ]]; then
3298 command mkdir -p "$1"
3300 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3305 #f5# Create temporary directory and \kbd{cd} to it
3307 builtin cd "$(mktemp -d)"
3311 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3314 print -l -- *(a-${1:-1})
3317 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3320 print -l -- *(c-${1:-1})
3323 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3326 print -l -- *(m-${1:-1})
3328 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3329 check_com new || alias new=modified
3331 # use colors when GNU grep with color-support
3332 if (( $#grep_options > 0 )); then
3333 o=${grep_options:+"${grep_options[*]}"}
3334 #a2# Execute \kbd{grep -{}-color=auto}
3335 alias grep='grep '$o
3336 alias egrep='egrep '$o
3341 # 'translate' looks up a word in a file with language-to-language
3342 # translations (field separator should be " : "). A typical wordlist looks
3343 # like the following:
3344 # | english-word : german-translation
3345 # It's also only possible to translate english to german but not reciprocal.
3346 # Use the following oneliner to reverse the sort order:
3347 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3348 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3349 #f5# Translates a word
3354 translate -l de-en $2
3357 translate -l en-de $2
3360 echo "Usage: $0 { -D | -E }"
3361 echo " -D == German to English"
3362 echo " -E == English to German"
3366 # Usage: simple-extract <file>
3367 # Using option -d deletes the original archive file.
3368 #f5# Smart archive extractor
3371 setopt extended_glob noclobber
3372 local ARCHIVE DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3374 zparseopts -D -E "d=DELETE_ORIGINAL"
3375 for ARCHIVE in "${@}"; do
3377 *(tar.bz2|tbz2|tbz))
3378 DECOMP_CMD="tar -xvjf -"
3383 DECOMP_CMD="tar -xvzf -"
3387 *(tar.xz|txz|tar.lzma))
3388 DECOMP_CMD="tar -xvJf -"
3393 DECOMP_CMD="tar -xvf -"
3398 DECOMP_CMD="unrar x"
3423 DECOMP_CMD="bzip2 -d -c -"
3428 DECOMP_CMD="gzip -d -c -"
3433 DECOMP_CMD="xz -d -c -"
3438 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3444 if ! check_com ${DECOMP_CMD[(w)1]}; then
3445 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3450 GZTARGET="${ARCHIVE:t:r}"
3451 if [[ -f $ARCHIVE ]] ; then
3453 print "Extracting '$ARCHIVE' ..."
3454 if $USES_STDIN; then
3455 if $USES_STDOUT; then
3456 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3458 ${=DECOMP_CMD} < "$ARCHIVE"
3461 if $USES_STDOUT; then
3462 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3464 ${=DECOMP_CMD} "$ARCHIVE"
3467 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3469 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3470 if check_com curl; then
3471 WGET_CMD="curl -L -s -o -"
3472 elif check_com wget; then
3473 WGET_CMD="wget -q -O -"
3474 elif check_com fetch; then
3475 WGET_CMD="fetch -q -o -"
3477 print "ERROR: neither wget, curl nor fetch is installed" >&2
3481 print "Downloading and Extracting '$ARCHIVE' ..."
3482 if $USES_STDIN; then
3483 if $USES_STDOUT; then
3484 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3487 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3491 if $USES_STDOUT; then
3492 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3494 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3499 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3509 '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)"' \
3510 '_urls:Remote Archives:_urls'
3516 '-d[delete original archivefile after extraction]' \
3517 '*:Archive Or Uri:__archive_or_uri'
3519 compdef _simple_extract simple-extract
3520 alias se=simple-extract
3522 #f5# Change the xterm title from within GNU-screen
3525 if [[ $1 != "-f" ]] ; then
3526 if [[ -z ${DISPLAY} ]] ; then
3527 printf 'xtrename only makes sense in X11.\n'
3533 if [[ -z $1 ]] ; then
3534 printf 'usage: xtrename [-f] "title for xterm"\n'
3535 printf ' renames the title of xterm from _within_ screen.\n'
3536 printf ' also works without screen.\n'
3537 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3540 print -n "\eP\e]0;${1}\C-G\e\\"
3544 # Create small urls via http://goo.gl using curl(1).
3545 # API reference: https://code.google.com/apis/urlshortener/
3548 setopt extended_glob
3550 if [[ -z $1 ]]; then
3551 print "USAGE: zurl <URL>"
3555 local PN url prog api json contenttype item
3560 # Prepend 'http://' to given URL where necessary for later output.
3561 if [[ ${url} != http(s|)://* ]]; then
3565 if check_com -c curl; then
3568 print "curl is not available, but mandatory for ${PN}. Aborting."
3571 api='https://www.googleapis.com/urlshortener/v1/url'
3572 contenttype="Content-Type: application/json"
3573 json="{\"longUrl\": \"${url}\"}"
3574 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3575 # Parse the response
3576 for item in "${data[@]}"; do
3581 printf '%s\n' "$item"
3589 #f2# Find history events by search pattern and list them by date.
3592 local usage help ident format_l format_s first_char remain first last
3593 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3594 help='Use `whatwhen -h'\'' for further explanations.'
3595 ident=${(l,${#${:-Usage: }},, ,)}
3596 format_l="${ident}%s\t\t\t%s\n"
3597 format_s="${format_l//(\\t)##/\\t}"
3598 # Make the first char of the word to search for case
3599 # insensitive; e.g. [aA]
3600 first_char=[${(L)1[1]}${(U)1[1]}]
3602 # Default search range is `-100'.
3604 # Optional, just used for `<first> <last>' given.
3608 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3609 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3612 printf '%s\n\n' ${usage}
3614 printf $format_l '-h' 'show help text'
3616 print 'SEARCH RANGE:'
3617 printf $format_l "'0'" 'the whole history,'
3618 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3619 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3620 printf '\n%s\n' 'EXAMPLES:'
3621 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3622 printf $format_l 'whatwhen zsh -250'
3623 printf $format_l 'whatwhen foo 1 99'
3626 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3629 # -l list results on stout rather than invoking $EDITOR.
3630 # -i Print dates as in YYYY-MM-DD.
3631 # -m Search for a - quoted - pattern within the history.
3632 fc -li -m "*${first_char}${remain}*" $first $last
3637 # mercurial related stuff
3638 if check_com -c hg ; then
3639 # gnu like diff for mercurial
3640 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3641 #f5# GNU like diff for mercurial
3645 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3648 # build debian package
3649 #a2# Alias for \kbd{hg-buildpackage}
3650 alias hbp='hg-buildpackage'
3652 # execute commands on the versioned patch-queue from the current repos
3653 alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3655 # diffstat for specific version of a mercurial repository
3656 # hgstat => display diffstat between last revision and tip
3657 # hgstat 1234 => display diffstat between revision 1234 and tip
3658 #f5# Diffstat for specific version of a mercurial repos
3661 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3664 fi # end of check whether we have the 'hg'-executable
3666 # grml-small cleanups
3668 # The following is used to remove zsh-config-items that do not work
3669 # in grml-small by default.
3670 # If you do not want these adjustments (for whatever reason), set
3671 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3672 # sources if it is there).
3674 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3677 unalias 'V' &> /dev/null
3678 unfunction vman &> /dev/null
3679 unfunction viless &> /dev/null
3680 unfunction 2html &> /dev/null
3682 # manpages are not in grmlsmall
3683 unfunction manzsh &> /dev/null
3684 unfunction man2 &> /dev/null
3690 ## genrefcard.pl settings
3692 ### doc strings for external functions from files
3693 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3695 ### example: split functions-search 8,16,24,32
3696 #@# split functions-search 8
3698 ## END OF FILE #################################################################
3699 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4