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 # try to avoid the 'zsh: no matches found...'
394 # report the status of backgrounds jobs immediately
397 # whenever a command completion is attempted, make sure the entire command path
401 # not just at the end
402 setopt completeinword
404 # Don't send SIGHUP to background processes when the shell exits.
407 # make cd push the old directory onto the directory stack.
413 # don't push the same dir twice.
414 setopt pushd_ignore_dups
416 # * shouldn't match dotfiles. ever.
419 # use zsh style word splitting
422 # don't error out when unset parameters are used
425 # setting some default values
428 NOPRECMD=${NOPRECMD:-0}
429 COMMAND_NOT_FOUND=${COMMAND_NOT_FOUND:-0}
430 GRML_ZSH_CNF_HANDLER=${GRML_ZSH_CNF_HANDLER:-/usr/share/command-not-found/command-not-found}
431 GRML_DISPLAY_BATTERY=${GRML_DISPLAY_BATTERY:-${BATTERY:-0}}
432 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
433 ZSH_NO_DEFAULT_LOCALE=${ZSH_NO_DEFAULT_LOCALE:-0}
435 typeset -ga ls_options
436 typeset -ga grep_options
437 if ls --color=auto / >/dev/null 2>&1; then
438 ls_options+=( --color=auto )
439 elif ls -G / >/dev/null 2>&1; then
442 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
443 grep_options+=( --color=auto )
447 # this function checks if a command exists and returns either true
448 # or false. This avoids using 'which' and 'whence', which will
449 # avoid problems with aliases for which on certain weird systems. :-)
450 # Usage: check_com [-c|-g] word
451 # -c only checks for external commands
452 # -g does the usual tests and also checks for global aliases
455 local -i comonly gatoo
457 if [[ $1 == '-c' ]] ; then
460 elif [[ $1 == '-g' ]] ; then
467 if (( ${#argv} != 1 )) ; then
468 printf 'usage: check_com [-c] <command>\n' >&2
472 if (( comonly > 0 )) ; then
473 [[ -n ${commands[$1]} ]] && return 0
477 if [[ -n ${commands[$1]} ]] \
478 || [[ -n ${functions[$1]} ]] \
479 || [[ -n ${aliases[$1]} ]] \
480 || [[ -n ${reswords[(r)$1]} ]] ; then
485 if (( gatoo > 0 )) && [[ -n ${galiases[$1]} ]] ; then
492 # creates an alias and precedes the command with
493 # sudo if $EUID is not zero.
496 local only=0 ; local multi=0
498 while getopts ":hao" opt; do
503 printf 'usage: salias [-hoa] <alias-expression>\n'
504 printf ' -h shows this help text.\n'
505 printf ' -a replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
506 printf ' be careful using this option.\n'
507 printf ' -o only sets an alias if a preceding sudo would be needed.\n'
510 *) salias -h >&2; return 1 ;;
513 shift "$((OPTIND-1))"
515 if (( ${#argv} > 1 )) ; then
516 printf 'Too many arguments %s\n' "${#argv}"
520 key="${1%%\=*}" ; val="${1#*\=}"
521 if (( EUID == 0 )) && (( only == 0 )); then
522 alias -- "${key}=${val}"
523 elif (( EUID > 0 )) ; then
524 (( multi > 0 )) && val="${val// ; / ; sudo }"
525 alias -- "${key}=sudo ${val}"
531 # Check if we can read given files and source those we can.
533 if (( ${#argv} < 1 )) ; then
534 printf 'usage: xsource FILE(s)...\n' >&2
538 while (( ${#argv} > 0 )) ; do
539 [[ -r "$1" ]] && source "$1"
545 # Check if we can read a given file and 'cat(1)' it.
548 if (( ${#argv} != 1 )) ; then
549 printf 'usage: xcat FILE\n' >&2
553 [[ -r $1 ]] && cat $1
557 # Remove these functions again, they are of use only in these
558 # setup files. This should be called at the end of .zshrc.
563 funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
564 for func in $funcs ; do
565 [[ -n ${functions[$func]} ]] \
571 # this allows us to stay in sync with grml's zshrc and put own
572 # modifications in ~/.zshrc.local
574 xsource "/etc/zsh/zshrc.local"
575 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
580 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
581 xsource "/etc/default/locale"
584 for var in LANG LC_ALL LC_MESSAGES ; do
585 [[ -n ${(P)var} ]] && export $var
590 if check_com -c vim ; then
592 export EDITOR=${EDITOR:-vim}
594 export EDITOR=${EDITOR:-vi}
598 export PAGER=${PAGER:-less}
601 export MAIL=${MAIL:-/var/mail/$USER}
603 # color setup for ls:
604 check_com -c dircolors && eval $(dircolors -b)
605 # color setup for ls on OS X / FreeBSD:
606 isdarwin && export CLICOLOR=1
607 isfreebsd && export CLICOLOR=1
609 # do MacPorts setup on darwin
610 if isdarwin && [[ -d /opt/local ]]; then
611 # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
613 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
614 MANPATH="/opt/local/share/man:$MANPATH"
616 # do Fink setup on darwin
617 isdarwin && xsource /sw/bin/init.sh
619 # load our function and completion directories
620 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
621 fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
622 if [[ ${fdir} == '/usr/share/grml/zsh/functions' ]] ; then
623 for func in ${fdir}/**/[^_]*[^~](N.) ; do
624 zrcautoload ${func:t}
630 # support colors in less
631 export LESS_TERMCAP_mb=$'\E[01;31m'
632 export LESS_TERMCAP_md=$'\E[01;31m'
633 export LESS_TERMCAP_me=$'\E[0m'
634 export LESS_TERMCAP_se=$'\E[0m'
635 export LESS_TERMCAP_so=$'\E[01;44;33m'
636 export LESS_TERMCAP_ue=$'\E[0m'
637 export LESS_TERMCAP_us=$'\E[01;32m'
642 # report about cpu-/system-/user-time of command if running longer than
646 # watch for everyone but me and root
649 # automatically remove duplicates from these arrays
650 typeset -U path cdpath fpath manpath
654 for mod in parameter complist deltochar mathfunc ; do
655 zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
656 done && builtin unset -v mod
658 # autoload zsh modules when they are referenced
660 zmodload -a zsh/stat zstat
661 zmodload -a zsh/zpty zpty
662 zmodload -ap zsh/mapfile mapfile
666 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
667 if zrcautoload compinit ; then
668 compinit -d ${COMPDUMPFILE} || print 'Notice: no compinit available :('
670 print 'Notice: no compinit available :('
676 # called later (via is4 && grmlcomp)
677 # note: use 'zstyle' for getting current settings
678 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
680 # TODO: This could use some additional information
682 # Make sure the completion system is initialised
683 (( ${+_comps} )) || return 1
685 # allow one error for every three characters typed in approximate completer
686 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
688 # don't complete backup files as executables
689 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
691 # start menu completion only if it could find no unambiguous initial string
692 zstyle ':completion:*:correct:*' insert-unambiguous true
693 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
694 zstyle ':completion:*:correct:*' original true
696 # activate color-completion
697 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
699 # format on completion
700 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
702 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
703 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
705 # insert all expansions for expand completer
706 zstyle ':completion:*:expand:*' tag-order all-expansions
707 zstyle ':completion:*:history-words' list false
710 zstyle ':completion:*:history-words' menu yes
712 # ignore duplicate entries
713 zstyle ':completion:*:history-words' remove-all-dups yes
714 zstyle ':completion:*:history-words' stop yes
716 # match uppercase from lowercase
717 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
719 # separate matches into groups
720 zstyle ':completion:*:matches' group 'yes'
721 zstyle ':completion:*' group-name ''
723 if [[ "$NOMENU" -eq 0 ]] ; then
724 # if there are more than 5 options allow selecting from a menu
725 zstyle ':completion:*' menu select=5
727 # don't use any menus at all
731 zstyle ':completion:*:messages' format '%d'
732 zstyle ':completion:*:options' auto-description '%d'
734 # describe options in full
735 zstyle ':completion:*:options' description 'yes'
737 # on processes completion complete all user processes
738 zstyle ':completion:*:processes' command 'ps -au$USER'
740 # offer indexes before parameters in subscripts
741 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
743 # provide verbose completion information
744 zstyle ':completion:*' verbose true
746 # recent (as of Dec 2007) zsh versions are able to provide descriptions
747 # for commands (read: 1st word in the line) that it will list for the user
748 # to choose from. The following disables that, because it's not exactly fast.
749 zstyle ':completion:*:-command-:*:' verbose false
751 # set format for warnings
752 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
754 # define files to ignore for zcompile
755 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
756 zstyle ':completion:correct:' prompt 'correct to: %e'
758 # Ignore completion functions for commands you don't have:
759 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
761 # Provide more processes in completion of programs like killall:
762 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
764 # complete manual by their section
765 zstyle ':completion:*:manuals' separate-sections true
766 zstyle ':completion:*:manuals.*' insert-sections true
767 zstyle ':completion:*:man:*' menu yes select
769 # Search path for sudo completion
770 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
778 # provide .. as a completion
779 zstyle ':completion:*' special-dirs ..
781 # run rehash on completion so new installed program are found automatically:
783 (( CURRENT == 1 )) && rehash
788 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
789 if [[ "$NOCOR" -gt 0 ]] ; then
790 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
793 # try to be smart about when to use what completer...
795 zstyle -e ':completion:*' completer '
796 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
797 _last_try="$HISTNO$BUFFER$CURSOR"
798 reply=(_complete _match _ignored _prefix _files)
800 if [[ $words[1] == (rm|mv) ]] ; then
801 reply=(_complete _files)
803 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
808 # command for process lists, the local web server details and host completion
809 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
812 [[ -d $ZSHDIR/cache ]] && zstyle ':completion:*' use-cache yes && \
813 zstyle ':completion::complete:*' cache-path $ZSHDIR/cache/
817 [[ -r ~/.ssh/config ]] && _ssh_config_hosts=(${${(s: :)${(ps:\t:)${${(@M)${(f)"$(<$HOME/.ssh/config)"}:#Host *}#Host }}}:#*[*?]*}) || _ssh_config_hosts=()
818 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
819 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
827 "$_ssh_config_hosts[@]"
832 zstyle ':completion:*:hosts' hosts $hosts
833 # TODO: so, why is this here?
834 # zstyle '*' hosts $hosts
836 # use generic completion system for programs not yet defined; (_gnu_generic works
837 # with commands that provide a --help option with "standard" gnu-like output.)
838 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
840 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
843 # see upgrade function in this file
844 compdef _hosts upgrade
847 # Keyboard setup: The following is based on the same code, we wrote for
848 # debian's setup. It ensures the terminal is in the right mode, when zle is
849 # active, so the values from $terminfo are valid. Therefore, this setup should
850 # work on all systems, that have support for `terminfo'. It also requires the
851 # zsh in use to have the `zsh/terminfo' module built.
853 # If you are customising your `zle-line-init()' or `zle-line-finish()'
854 # functions, make sure you call the following utility functions in there:
856 # - zle-line-init(): zle-smkx
857 # - zle-line-finish(): zle-rmkx
859 # Use emacs-like key bindings by default:
864 ## beginning-of-line OR beginning-of-buffer OR beginning of history
865 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
866 beginning-or-end-of-somewhere() {
868 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
869 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
870 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
872 zle .${WIDGET:s/somewhere/line-hist/} "$@"
873 if (( HISTNO != hno )); then
874 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
878 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
879 zle -N end-of-somewhere beginning-or-end-of-somewhere
881 # add a command line to the shells history without executing it
882 commit-to-history() {
883 print -s ${(z)BUFFER}
886 zle -N commit-to-history
888 # only slash should be considered as a word separator:
889 slash-backward-kill-word() {
890 local WORDCHARS="${WORDCHARS:s@/@}"
892 zle backward-kill-word
894 zle -N slash-backward-kill-word
896 # a generic accept-line wrapper
898 # This widget can prevent unwanted autocorrections from command-name
899 # to _command-name, rehash automatically on enter and call any number
900 # of builtin and user-defined widgets in different contexts.
902 # For a broader description, see:
903 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
905 # The code is imported from the file 'zsh/functions/accept-line' from
906 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
907 # distributed under the same terms as zsh itself.
909 # A newly added command will may not be found or will cause false
910 # correction attempts, if you got auto-correction set. By setting the
911 # following style, we force accept-line() to rehash, if it cannot
912 # find the first word on the command line in the $command[] hash.
913 zstyle ':acceptline:*' rehash true
915 function Accept-Line() {
916 setopt localoptions noksharrays
920 local alcontext=${1:-$alcontext}
922 zstyle -a ":acceptline:${alcontext}" actions subs
924 (( ${#subs} < 1 )) && return 0
927 for sub in ${subs} ; do
928 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
931 (( aldone > 0 )) && break
935 function Accept-Line-getdefault() {
939 zstyle -s ":acceptline:${alcontext}" default_action default_action
940 case ${default_action} in
942 printf ".accept-line"
945 printf ${default_action}
950 function Accept-Line-HandleContext() {
953 default_action=$(Accept-Line-getdefault)
954 zstyle -T ":acceptline:${alcontext}" call_default \
955 && zle ${default_action}
958 function accept-line() {
959 setopt localoptions noksharrays
962 local buf com fname format msg default_action
966 cmdline=(${(z)BUFFER})
970 Accept-Line 'preprocess'
972 zstyle -t ":acceptline:${alcontext}" rehash \
973 && [[ -z ${commands[$com]} ]] \
977 && [[ -n ${reswords[(r)$com]} ]] \
978 || [[ -n ${aliases[$com]} ]] \
979 || [[ -n ${functions[$com]} ]] \
980 || [[ -n ${builtins[$com]} ]] \
981 || [[ -n ${commands[$com]} ]] ; then
983 # there is something sensible to execute, just do it.
985 Accept-Line-HandleContext
990 if [[ -o correct ]] \
991 || [[ -o correctall ]] \
992 && [[ -n ${functions[$fname]} ]] ; then
994 # nothing there to execute but there is a function called
995 # _command_name; a completion widget. Makes no sense to
996 # call it on the commandline, but the correct{,all} options
997 # will ask for it nevertheless, so warn the user.
998 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
999 # Okay, we warned the user before, he called us again,
1000 # so have it his way.
1002 Accept-Line-HandleContext
1007 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
1009 Accept-Line-HandleContext
1011 # prepare warning message for the user, configurable via zstyle.
1012 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
1014 if [[ -z ${msg} ]] ; then
1015 msg="%c will not execute and completion %f exists."
1018 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
1023 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
1024 # If we are here, the commandline contains something that is not
1025 # executable, which is neither subject to _command_name correction
1026 # and is not empty. might be a variable assignment
1028 Accept-Line-HandleContext
1033 # If we got this far, the commandline only contains whitespace, or is empty.
1035 Accept-Line-HandleContext
1040 zle -N Accept-Line-HandleContext
1042 # power completion / abbreviation expansion / buffer expansion
1043 # see http://zshwiki.org/home/examples/zleiab for details
1044 # less risky than the global aliases but powerful as well
1045 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
1048 setopt interactivecomments
1050 # key # value (#d additional doc string)
1056 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1058 'Hl' ' --help |& less -r' #d (Display help in pager)
1062 'N' '&>/dev/null' #d (No Output)
1063 'R' '| tr A-z N-za-m' #d (ROT13)
1064 'SL' '| sort | less'
1069 'co' './configure && make && sudo make install'
1077 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1078 LBUFFER+=${abk[$MATCH]:-$MATCH}
1085 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1088 zle -N help-show-abk
1090 # press "ctrl-e d" to insert the actual date in the form yyyy-mm-dd
1091 insert-datestamp() { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1092 zle -N insert-datestamp
1094 # press esc-m for inserting last typed word again (thanks to caphuso!)
1095 insert-last-typed-word() { zle insert-last-word -- 0 -1 };
1096 zle -N insert-last-typed-word;
1098 function grml-zsh-fg() {
1099 if (( ${#jobstates} )); then
1101 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1102 BUFFER="${BUFFER}fg"
1105 zle -M 'No background jobs. Doing nothing.'
1110 # run command line as user root via sudo:
1111 sudo-command-line() {
1112 [[ -z $BUFFER ]] && zle up-history
1113 if [[ $BUFFER != sudo\ * ]]; then
1114 BUFFER="sudo $BUFFER"
1115 CURSOR=$(( CURSOR+5 ))
1118 zle -N sudo-command-line
1120 ### jump behind the first word on the cmdline.
1121 ### useful to add options.
1122 function jump_after_first_word() {
1124 words=(${(z)BUFFER})
1126 if (( ${#words} <= 1 )) ; then
1129 CURSOR=${#${words[1]}}
1132 zle -N jump_after_first_word
1134 #f5# Create directory under cursor or the selected area
1136 # Press ctrl-xM to create the directory under the cursor or the selected area.
1137 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1138 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1139 # directory does not exist yet -> press ctrl-XM and problem solved
1141 if ((REGION_ACTIVE==1)); then
1142 local F=$MARK T=$CURSOR
1143 if [[ $F -gt $T ]]; then
1147 # get marked area from buffer and eliminate whitespace
1148 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1149 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1151 local bufwords iword
1152 bufwords=(${(z)LBUFFER})
1154 bufwords=(${(z)BUFFER})
1155 PATHTOMKDIR="${(Q)bufwords[iword]}"
1157 [[ -z "${PATHTOMKDIR}" ]] && return 1
1158 PATHTOMKDIR=${~PATHTOMKDIR}
1159 if [[ -e "${PATHTOMKDIR}" ]]; then
1160 zle -M " path already exists, doing nothing"
1162 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1167 zle -N inplaceMkDirs
1169 #v1# set number of lines to display per page
1170 HELP_LINES_PER_PAGE=20
1171 #v1# set location of help-zle cache file
1172 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1173 # helper function for help-zle, actually generates the help text
1174 help_zle_parse_keybindings()
1178 unsetopt ksharrays #indexing starts at 1
1180 #v1# choose files that help-zle will parse for keybindings
1181 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1183 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1186 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1187 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1190 #fill with default keybindings, possibly to be overwriten in a file later
1191 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1192 local -A help_zle_keybindings
1193 help_zle_keybindings['<Ctrl>@']="set MARK"
1194 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1195 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1196 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1197 help_zle_keybindings['<Ctrl>_']="undo"
1198 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1199 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1200 help_zle_keybindings['<Ctrl>e']="goto end of line"
1201 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1202 help_zle_keybindings['<Alt>t']="transpose words"
1203 help_zle_keybindings['<Alt>s']="spellcheck word"
1204 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1205 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1206 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1207 help_zle_keybindings["<Alt>'"]="quote line"
1208 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1209 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1210 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1211 help_zle_keybindings['<Alt>l']="make next word lowercase"
1212 help_zle_keybindings['<Ctrl>xd']="preview expansion under cursor"
1213 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1214 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1215 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1216 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1217 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1218 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1219 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1220 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1222 #init global variables
1223 unset help_zle_lines help_zle_sln
1224 typeset -g -a help_zle_lines
1225 typeset -g help_zle_sln=1
1228 local lastkeybind_desc contents #last description starting with #k# that we found
1229 local num_lines_elapsed=0 #number of lines between last description and keybinding
1230 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1231 for f in $HELPZLE_KEYBINDING_FILES; do
1232 [[ -r "$f" ]] || continue #not readable ? skip it
1234 for cline in "${(f)contents}"; do
1235 #zsh pattern: matches lines like: #k# ..............
1236 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1237 lastkeybind_desc="$match[*]"
1239 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1240 # ignores lines that are commentend out
1241 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1242 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1243 #description prevously found ? description not more than 2 lines away ? keybinding not empty ?
1244 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1245 #substitute keybinding string with something readable
1246 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1247 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1248 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1249 help_zle_keybindings[${k}]=$lastkeybind_desc
1253 ((num_lines_elapsed++))
1258 #calculate length of keybinding column
1260 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1261 #convert the assoc array into preformated lines, which we are able to sort
1262 for k v in ${(kv)help_zle_keybindings[@]}; do
1263 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1264 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1266 #sort lines alphabetically
1267 help_zle_lines=("${(i)help_zle_lines[@]}")
1268 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1269 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1270 zcompile $HELP_ZLE_CACHE_FILE
1272 typeset -g help_zle_sln
1273 typeset -g -a help_zle_lines
1275 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1279 unsetopt ksharrays #indexing starts at 1
1280 #help lines already generated ? no ? then do it
1281 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1282 #already displayed all lines ? go back to the start
1283 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1284 local sln=$help_zle_sln
1285 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1286 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1287 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1291 ## complete word from currently visible Screen or Tmux buffer.
1292 if check_com -c screen || check_com -c tmux; then
1293 _complete_screen_display() {
1294 [[ "$TERM" != "screen" ]] && return 1
1296 local TMPFILE=$(mktemp)
1297 local -U -a _screen_display_wordlist
1298 trap "rm -f $TMPFILE" EXIT
1300 # fill array with contents from screen hardcopy
1301 if ((${+TMUX})); then
1302 #works, but crashes tmux below version 1.4
1303 #luckily tmux -V option to ask for version, was also added in 1.4
1304 tmux -V &>/dev/null || return
1305 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1307 screen -X hardcopy $TMPFILE
1308 # screen sucks, it dumps in latin1, apparently always. so recode it
1310 check_com recode && recode latin1 $TMPFILE
1312 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1313 # remove PREFIX to be completed from that array
1314 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1315 compadd -a _screen_display_wordlist
1317 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1319 compdef -k _complete_screen_display complete-word '^xS'
1322 # Load a few more functions and tie them to widgets, so they can be bound:
1324 function zrcautozle() {
1327 zrcautoload $fnc && zle -N $fnc
1330 function zrcgotwidget() {
1331 (( ${+widgets[$1]} ))
1334 function zrcgotkeymap() {
1335 [[ -n ${(M)keymaps:#$1} ]]
1338 zrcautozle insert-files
1339 zrcautozle edit-command-line
1340 zrcautozle insert-unicode-char
1341 if zrcautoload history-search-end; then
1342 zle -N history-beginning-search-backward-end history-search-end
1343 zle -N history-beginning-search-forward-end history-search-end
1345 zle -C hist-complete complete-word _generic
1346 zstyle ':completion:hist-complete:*' completer _history
1348 # The actual terminal setup hooks and bindkey-calls:
1350 # An array to note missing features to ease diagnosis in case of problems.
1351 typeset -ga grml_missing_features
1353 function zrcbindkey() {
1354 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1359 function bind2maps () {
1360 local i sequence widget
1363 while [[ "$1" != "--" ]]; do
1369 if [[ "$1" == "-s" ]]; then
1373 sequence="${key[$1]}"
1377 [[ -z "$sequence" ]] && return 1
1379 for i in "${maps[@]}"; do
1380 zrcbindkey -M "$i" "$sequence" "$widget"
1384 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1385 function zle-smkx () {
1387 printf '%s' ${terminfo[smkx]}
1389 function zle-rmkx () {
1391 printf '%s' ${terminfo[rmkx]}
1393 function zle-line-init () {
1396 function zle-line-finish () {
1399 zle -N zle-line-init
1400 zle -N zle-line-finish
1402 for i in {s,r}mkx; do
1403 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1410 Home "${terminfo[khome]}"
1411 End "${terminfo[kend]}"
1412 Insert "${terminfo[kich1]}"
1413 Delete "${terminfo[kdch1]}"
1414 Up "${terminfo[kcuu1]}"
1415 Down "${terminfo[kcud1]}"
1416 Left "${terminfo[kcub1]}"
1417 Right "${terminfo[kcuf1]}"
1418 PageUp "${terminfo[kpp]}"
1419 PageDown "${terminfo[knp]}"
1420 BackTab "${terminfo[kcbt]}"
1423 # Guidelines for adding key bindings:
1425 # - Do not add hardcoded escape sequences, to enable non standard key
1426 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1428 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1431 # - All keys from the $key[] mapping are obviously okay.
1433 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1434 # '\ex' are allowed in here as well.
1436 bind2maps emacs -- Home beginning-of-somewhere
1437 bind2maps viins vicmd -- Home vi-beginning-of-line
1438 bind2maps emacs -- End end-of-somewhere
1439 bind2maps viins vicmd -- End vi-end-of-line
1440 bind2maps emacs viins -- Insert overwrite-mode
1441 bind2maps vicmd -- Insert vi-insert
1442 bind2maps emacs -- Delete delete-char
1443 bind2maps viins vicmd -- Delete vi-delete-char
1444 bind2maps emacs viins vicmd -- Up up-line-or-search
1445 bind2maps emacs viins vicmd -- Down down-line-or-search
1446 bind2maps emacs -- Left backward-char
1447 bind2maps viins vicmd -- Left vi-backward-char
1448 bind2maps emacs -- Right forward-char
1449 bind2maps viins vicmd -- Right vi-forward-char
1450 #k# Perform abbreviation expansion
1451 bind2maps emacs viins -- -s '^x.' zleiab
1452 #k# Display list of abbreviations that would expand
1453 bind2maps emacs viins -- -s '^xb' help-show-abk
1454 #k# mkdir -p <dir> from string under cursor or marked area
1455 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1456 #k# display help for keybindings and ZLE
1457 bind2maps emacs viins -- -s '^xz' help-zle
1458 #k# Insert files and test globbing
1459 bind2maps emacs viins -- -s "^xf" insert-files
1460 #k# Edit the current line in \kbd{\$EDITOR}
1461 bind2maps emacs viins -- -s '\ee' edit-command-line
1462 #k# search history backward for entry beginning with typed text
1463 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1464 #k# search history forward for entry beginning with typed text
1465 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1466 #k# search history backward for entry beginning with typed text
1467 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1468 #k# search history forward for entry beginning with typed text
1469 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1470 bind2maps emacs viins -- -s "^x^h" commit-to-history
1471 #k# Kill left-side word or everything up to next slash
1472 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1473 #k# Kill left-side word or everything up to next slash
1474 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1475 #k# Kill left-side word or everything up to next slash
1476 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1477 # Do history expansion on space:
1478 bind2maps emacs viins -- -s ' ' magic-space
1479 #k# Trigger menu-complete
1480 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1481 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1482 bind2maps emacs viins -- -s '^ed' insert-datestamp
1483 #k# Insert last typed word
1484 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1485 #k# A smart shortcut for \kbd{fg<enter>}
1486 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1487 #k# prepend the current command with "sudo"
1488 bind2maps emacs viins -- -s "^os" sudo-command-line
1489 #k# jump to after first word (for adding options)
1490 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1491 #k# complete word from history with menu
1492 bind2maps emacs viins -- -s "^x^x" hist-complete
1494 # insert unicode character
1495 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1496 # See for example http://unicode.org/charts/ for unicode characters code
1497 #k# Insert Unicode character
1498 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1500 # use the new *-pattern-* widgets for incremental history search
1501 if zrcgotwidget history-incremental-pattern-search-backward; then
1502 for seq wid in '^r' history-incremental-pattern-search-backward \
1503 '^s' history-incremental-pattern-search-forward
1505 bind2maps emacs viins vicmd -- -s $seq $wid
1507 builtin unset -v seq wid
1510 if zrcgotkeymap menuselect; then
1511 #m# k Shift-tab Perform backwards menu completion
1512 bind2maps menuselect -- BackTab reverse-menu-complete
1514 #k# menu selection: pick item but stay in the menu
1515 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1516 # also use + and INSERT since it's easier to press repeatedly
1517 bind2maps menuselect -- -s '+' accept-and-menu-complete
1518 bind2maps menuselect -- Insert accept-and-menu-complete
1520 # accept a completion and try to complete again by using menu
1521 # completion; very useful with completing directories
1522 # by using 'undo' one's got a simple file browser
1523 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1526 # Finally, here are still a few hardcoded escape sequences; Special sequences
1527 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1528 # standardised and most of the time are not available in a terminals terminfo
1531 # While we do not encourage adding bindings like these, we will keep these for
1532 # backward compatibility.
1534 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1535 ## the command line.
1537 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1538 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1539 # These are for xterm:
1540 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1541 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1542 ## the same for alt-left-arrow and alt-right-arrow
1544 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1545 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1547 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1548 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1549 # Also try ESC Left/Right:
1550 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1551 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1558 # we don't want to quote/espace URLs on our own...
1559 # if autoload -U url-quote-magic ; then
1560 # zle -N self-insert url-quote-magic
1561 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1563 # print 'Notice: no url-quote-magic available :('
1565 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1567 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1568 alias run-help >&/dev/null && unalias run-help
1569 for rh in run-help{,-git,-svk,-svn}; do
1573 # command not found handling
1575 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1576 function command_not_found_handler() {
1578 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1579 ${GRML_ZSH_CNF_HANDLER} $1
1586 ZSHDIR=${ZDOTDIR:-${HOME}/.zsh}
1589 HISTFILE=${ZDOTDIR:-${HOME}}/.zsh_history
1590 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1591 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1595 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1596 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1598 typeset -gaU GRML_PERSISTENT_DIRSTACK
1599 function grml_dirstack_filter() {
1602 if zstyle -s ':grml:chpwd:dirstack' filter filter; then
1603 $filter $1 && return 0
1605 if zstyle -a ':grml:chpwd:dirstack' exclude exclude; then
1606 for entry in "${exclude[@]}"; do
1607 [[ $1 == ${~entry} ]] && return 0
1614 (( $DIRSTACKSIZE <= 0 )) && return
1615 [[ -z $DIRSTACKFILE ]] && return
1616 grml_dirstack_filter $PWD && return
1617 GRML_PERSISTENT_DIRSTACK=(
1618 $PWD "${(@)GRML_PERSISTENT_DIRSTACK[1,$DIRSTACKSIZE]}"
1620 builtin print -l ${GRML_PERSISTENT_DIRSTACK} >! ${DIRSTACKFILE}
1623 if [[ -f ${DIRSTACKFILE} ]] && [[ ${#dirstack[*]} -eq 0 ]] ; then
1624 # Enabling NULL_GLOB via (N) weeds out any non-existing
1625 # directories from the saved dir-stack file.
1626 dirstack=( ${(f)"$(< $DIRSTACKFILE)"}(N) )
1627 # "cd -" won't work after login by just setting $OLDPWD, so
1628 [[ -d $dirstack[1] ]] && cd $dirstack[1] && cd $OLDPWD
1631 if zstyle -T ':grml:chpwd:dirstack' filter-on-load; then
1632 for i in "${dirstack[@]}"; do
1633 if ! grml_dirstack_filter "$i"; then
1634 GRML_PERSISTENT_DIRSTACK=(
1635 "${GRML_PERSISTENT_DIRSTACK[@]}"
1641 GRML_PERSISTENT_DIRSTACK=( "${dirstack[@]}" )
1644 # directory based profiles
1648 # chpwd_profiles(): Directory Profiles, Quickstart:
1652 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1653 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1656 # For details see the `grmlzshrc.5' manual page.
1657 function chpwd_profiles() {
1658 local profile context
1661 context=":chpwd:profiles:$PWD"
1662 zstyle -s "$context" profile profile || profile='default'
1663 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1665 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1666 typeset -g CHPWD_PROFILE
1667 local CHPWD_PROFILES_INIT=1
1668 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1669 elif [[ $profile != $CHPWD_PROFILE ]]; then
1670 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1671 && chpwd_leave_profile_${CHPWD_PROFILE}
1673 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1674 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1677 CHPWD_PROFILE="${profile}"
1681 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1685 # Prompt setup for grml:
1687 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1688 # in prompts to get a red "foo" embedded, but it's good to keep these for
1689 # backwards compatibility).
1695 MAGENTA="%F{magenta}"
1699 elif zrcautoload colors && colors 2>/dev/null ; then
1700 BLUE="%{${fg[blue]}%}"
1701 RED="%{${fg_bold[red]}%}"
1702 GREEN="%{${fg[green]}%}"
1703 CYAN="%{${fg[cyan]}%}"
1704 MAGENTA="%{${fg[magenta]}%}"
1705 YELLOW="%{${fg[yellow]}%}"
1706 WHITE="%{${fg[white]}%}"
1707 NO_COLOR="%{${reset_color}%}"
1709 BLUE=$'%{\e[1;34m%}'
1711 GREEN=$'%{\e[1;32m%}'
1712 CYAN=$'%{\e[1;36m%}'
1713 WHITE=$'%{\e[1;37m%}'
1714 MAGENTA=$'%{\e[1;35m%}'
1715 YELLOW=$'%{\e[1;33m%}'
1716 NO_COLOR=$'%{\e[0m%}'
1719 # First, the easy ones: PS2..4:
1721 # secondary prompt, printed when the shell needs more information to complete a
1724 # selection prompt used within a select loop.
1726 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1729 # Some additional features to use with our prompt:
1733 # - vcs_info setup and version specific fixes
1735 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1738 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1741 elif isopenbsd ; then
1743 elif isfreebsd ; then
1745 elif isdarwin ; then
1749 GRML_DISPLAY_BATTERY=0
1755 GRML_BATTERY_LEVEL=''
1756 local batteries bat capacity
1757 batteries=( /sys/class/power_supply/BAT*(N) )
1758 if (( $#batteries > 0 )) ; then
1759 for bat in $batteries ; do
1760 capacity=$(< $bat/capacity)
1761 case $(< $bat/status) in
1763 GRML_BATTERY_LEVEL+=" ^"
1766 if (( capacity < 20 )) ; then
1767 GRML_BATTERY_LEVEL+=" !v"
1769 GRML_BATTERY_LEVEL+=" v"
1773 GRML_BATTERY_LEVEL+=" ="
1776 GRML_BATTERY_LEVEL+="${capacity}%%"
1782 GRML_BATTERY_LEVEL=''
1783 local bat batfull batwarn batnow num
1785 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1786 if [[ -n $bat ]]; then
1787 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1788 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1789 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1790 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1792 if (( batnow < batwarn )) ; then
1793 GRML_BATTERY_LEVEL+=" !v"
1795 GRML_BATTERY_LEVEL+=" v"
1799 GRML_BATTERY_LEVEL+=" ^"
1802 GRML_BATTERY_LEVEL+=" ="
1805 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1811 GRML_BATTERY_LEVEL=''
1815 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1816 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1817 case $table[State] in
1819 if (( $table[Remaining-capacity] < 20 )) ; then
1820 GRML_BATTERY_LEVEL+=" !v"
1822 GRML_BATTERY_LEVEL+=" v"
1826 GRML_BATTERY_LEVEL+=" ^"
1829 GRML_BATTERY_LEVEL+=" ="
1832 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1838 GRML_BATTERY_LEVEL=''
1840 table=( ${$(pmset -g ps)[(w)7,8]%%(\%|);} )
1841 if [[ -n $table[2] ]] ; then
1844 GRML_BATTERY_LEVEL+=" ^"
1847 if (( $table[1] < 20 )) ; then
1848 GRML_BATTERY_LEVEL+=" !v"
1850 GRML_BATTERY_LEVEL+=" v"
1854 GRML_BATTERY_LEVEL+=" ="
1857 GRML_BATTERY_LEVEL+="$table[1]%%"
1861 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1862 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1863 debian_chroot=$(</etc/debian_chroot)
1866 # gather version control information for inclusion in a prompt
1868 if zrcautoload vcs_info; then
1869 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1870 # function, which can cause a lot of trouble with our directory-based
1872 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1873 function VCS_INFO_realpath () {
1874 setopt localoptions NO_shwordsplit chaselinks
1875 ( builtin cd -q $1 2> /dev/null && pwd; )
1879 zstyle ':vcs_info:*' max-exports 2
1881 if [[ -o restricted ]]; then
1882 zstyle ':vcs_info:*' enable NONE
1886 typeset -A grml_vcs_coloured_formats
1887 typeset -A grml_vcs_plain_formats
1889 grml_vcs_plain_formats=(
1890 format "(%s%)-[%b] " "zsh: %r"
1891 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1892 rev-branchformat "%b:%r"
1895 grml_vcs_coloured_formats=(
1896 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1897 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1898 rev-branchformat "%b${RED}:${YELLOW}%r"
1901 typeset GRML_VCS_COLOUR_MODE=xxx
1903 grml_vcs_info_toggle_colour () {
1905 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
1906 grml_vcs_info_set_formats coloured
1908 grml_vcs_info_set_formats plain
1913 grml_vcs_info_set_formats () {
1915 #setopt localoptions xtrace
1916 local mode=$1 AF F BF
1917 if [[ $mode == coloured ]]; then
1918 AF=${grml_vcs_coloured_formats[actionformat]}
1919 F=${grml_vcs_coloured_formats[format]}
1920 BF=${grml_vcs_coloured_formats[rev-branchformat]}
1921 GRML_VCS_COLOUR_MODE=coloured
1923 AF=${grml_vcs_plain_formats[actionformat]}
1924 F=${grml_vcs_plain_formats[format]}
1925 BF=${grml_vcs_plain_formats[rev-branchformat]}
1926 GRML_VCS_COLOUR_MODE=plain
1929 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
1930 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
1931 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
1935 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1936 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1937 if [[ "$TERM" == dumb ]] ; then
1938 grml_vcs_info_set_formats plain
1940 grml_vcs_info_set_formats coloured
1943 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
1945 # This actually defines three prompts:
1951 # They all share the same code and only differ with respect to which items they
1952 # contain. The main source of documentation is the `prompt_grml_help' function
1953 # below, which gets called when the user does this: prompt -h grml
1955 function prompt_grml_help () {
1959 This is the prompt as used by the grml-live system <http://grml.org>. It is
1960 a rather simple one-line prompt, that by default looks something like this:
1962 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
1964 The prompt itself integrates with zsh's prompt themes system (as you are
1965 witnessing right now) and is configurable to a certain degree. In
1966 particular, these aspects are customisable:
1968 - The items used in the prompt (e.g. you can remove \`user' from
1969 the list of activated items, which will cause the user name to
1970 be omitted from the prompt string).
1972 - The attributes used with the items are customisable via strings
1973 used before and after the actual item.
1975 The available items are: at, battery, change-root, date, grml-chroot,
1976 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
1977 shell-level, time, user, vcs
1979 The actual configuration is done via zsh's \`zstyle' mechanism. The
1980 context, that is used while looking up styles is:
1982 ':prompt:grml:<left-or-right>:<subcontext>'
1984 Here <left-or-right> is either \`left' or \`right', signifying whether the
1985 style should affect the left or the right prompt. <subcontext> is either
1986 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
1990 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
1991 in $RPROMPT if the last command a returned non-successful error code.
1992 (This in only valid if <left-or-right> is "right"; ignored otherwise)
1994 - items (list): The list of items used in the prompt. If \`vcs' is
1995 present in the list, the theme's code invokes \`vcs_info'
1996 accordingly. Default (left): rc change-root user at host path vcs
1997 percent; Default (right): sad-smiley
1999 Available styles in 'items:<item>' are: pre, post. These are strings that
2000 are inserted before (pre) and after (post) the item in question. Thus, the
2001 following would cause the user name to be printed in red instead of the
2004 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
2006 Note, that the \`post' style may remain at its default value, because its
2007 default value is '%f', which turns the foreground text attribute off (which
2008 is exactly, what is still required with the new \`pre' value).
2012 function prompt_grml-chroot_help () {
2016 This is a variation of the grml prompt, see: prompt -h grml
2018 The main difference is the default value of the \`items' style. The rest
2019 behaves exactly the same. Here are the defaults for \`grml-chroot':
2021 - left: grml-chroot user at host path percent
2022 - right: (empty list)
2026 function prompt_grml-large_help () {
2030 This is a variation of the grml prompt, see: prompt -h grml
2032 The main difference is the default value of the \`items' style. In
2033 particular, this theme uses _two_ lines instead of one with the plain
2034 \`grml' theme. The rest behaves exactly the same. Here are the defaults
2037 - left: rc jobs history shell-level change-root time date newline user
2038 at host path vcs percent
2043 function grml_prompt_setup () {
2045 autoload -Uz vcs_info
2046 # The following autoload is disabled for now, since this setup includes a
2047 # static version of the ‘add-zsh-hook’ function above. It needs to be
2048 # reenabled as soon as that static definition is removed again.
2049 #autoload -Uz add-zsh-hook
2050 add-zsh-hook precmd prompt_$1_precmd
2053 function prompt_grml_setup () {
2054 grml_prompt_setup grml
2057 function prompt_grml-chroot_setup () {
2058 grml_prompt_setup grml-chroot
2061 function prompt_grml-large_setup () {
2062 grml_prompt_setup grml-large
2065 # These maps define default tokens and pre-/post-decoration for items to be
2066 # used within the themes. All defaults may be customised in a context sensitive
2067 # matter by using zsh's `zstyle' mechanism.
2068 typeset -gA grml_prompt_pre_default \
2069 grml_prompt_post_default \
2070 grml_prompt_token_default \
2071 grml_prompt_token_function
2073 grml_prompt_pre_default=(
2078 grml-chroot '%F{red}'
2088 shell-level '%F{red}'
2094 grml_prompt_post_default=(
2115 grml_prompt_token_default=(
2117 battery 'GRML_BATTERY_LEVEL'
2118 change-root 'debian_chroot'
2120 grml-chroot 'GRML_CHROOT'
2121 history '{history#%!} '
2123 jobs '[%j running job(s)] '
2125 path '%40<..<%~%<< '
2129 sad-smiley '%(?..:()'
2130 shell-level '%(3L.+ .)'
2131 time '%D{%H:%M:%S} '
2136 function grml_theme_has_token () {
2137 if (( ARGC != 1 )); then
2138 printf 'usage: grml_theme_has_token <name>\n'
2141 (( ${+grml_prompt_token_default[$1]} ))
2144 function GRML_theme_add_token_usage () {
2146 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2148 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2149 are used, <token/function> is the name of the function (see below for
2150 details). Otherwise it is the literal token string to be used. <pre> and
2151 <post> are optional.
2155 -f <function> Use a function named \`<function>' each time the token
2158 -i <function> Use a function named \`<function>' to initialise the
2159 value of the token _once_ at runtime.
2161 The functions are called with one argument: the token's new name. The
2162 return value is expected in the \$REPLY parameter. The use of these
2163 options is mutually exclusive.
2165 There is a utility function \`grml_theme_has_token', which you can use
2166 to test if a token exists before trying to add it. This can be a guard
2167 for situations in which a \`grml_theme_add_token' call may happen more
2172 To add a new token \`day' that expands to the current weekday in the
2173 current locale in green foreground colour, use this:
2175 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2177 Another example would be support for \$VIRTUAL_ENV:
2179 function virtual_env_prompt () {
2180 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2182 grml_theme_add_token virtual-env -f virtual_env_prompt
2184 After that, you will be able to use a changed \`items' style to
2185 assemble your prompt.
2189 function grml_theme_add_token () {
2191 local name token pre post
2192 local -i init funcall
2194 if (( ARGC == 0 )); then
2195 GRML_theme_add_token_usage
2205 if [[ $1 == '-f' ]]; then
2208 elif [[ $1 == '-i' ]]; then
2213 if (( ARGC == 0 )); then
2215 grml_theme_add_token: No token-string/function-name provided!\n\n'
2216 GRML_theme_add_token_usage
2221 if (( ARGC != 0 && ARGC != 2 )); then
2223 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2224 GRML_theme_add_token_usage
2233 if grml_theme_has_token $name; then
2235 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2236 GRML_theme_add_token_usage
2243 grml_prompt_pre_default[$name]=$pre
2244 grml_prompt_post_default[$name]=$post
2245 if (( funcall )); then
2246 grml_prompt_token_function[$name]=$token
2247 grml_prompt_token_default[$name]=23
2249 grml_prompt_token_default[$name]=$token
2253 function grml_typeset_and_wrap () {
2260 if (( ${+parameters[$new]} )); then
2261 typeset -g "${target}=${(P)target}${left}${(P)new}${right}"
2265 function grml_prompt_addto () {
2268 local lr it apre apost new v
2272 [[ $target == PS1 ]] && lr=left || lr=right
2273 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2274 typeset -g "${target}="
2275 for it in "${items[@]}"; do
2276 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2277 || apre=${grml_prompt_pre_default[$it]}
2278 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2279 || apost=${grml_prompt_post_default[$it]}
2280 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2281 || new=${grml_prompt_token_default[$it]}
2282 typeset -g "${target}=${(P)target}${apre}"
2283 if (( ${+grml_prompt_token_function[$it]} )); then
2284 ${grml_prompt_token_function[$it]} $it
2285 typeset -g "${target}=${(P)target}${REPLY}"
2289 grml_typeset_and_wrap $target $new '' ''
2292 grml_typeset_and_wrap $target $new '(' ')'
2295 if [[ -n ${(P)new} ]]; then
2296 typeset -g "${target}=${(P)target}(CHROOT)"
2300 v="vcs_info_msg_${new}_"
2301 if (( ! vcscalled )); then
2305 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2306 typeset -g "${target}=${(P)target}${(P)v}"
2309 *) typeset -g "${target}=${(P)target}${new}" ;;
2312 typeset -g "${target}=${(P)target}${apost}"
2316 function prompt_grml_precmd () {
2318 local grmltheme=grml
2319 local -a left_items right_items
2320 left_items=(rc change-root user at host path vcs percent)
2321 right_items=(sad-smiley)
2323 prompt_grml_precmd_worker
2326 function prompt_grml-chroot_precmd () {
2328 local grmltheme=grml-chroot
2329 local -a left_items right_items
2330 left_items=(grml-chroot user at host path percent)
2333 prompt_grml_precmd_worker
2336 function prompt_grml-large_precmd () {
2338 local grmltheme=grml-large
2339 local -a left_items right_items
2340 left_items=(rc jobs history shell-level change-root time date newline
2341 user at host path vcs percent)
2342 right_items=(sad-smiley)
2344 prompt_grml_precmd_worker
2347 function prompt_grml_precmd_worker () {
2349 local -i vcscalled=0
2351 grml_prompt_addto PS1 "${left_items[@]}"
2352 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2353 grml_prompt_addto RPS1 "${right_items[@]}"
2357 grml_prompt_fallback() {
2360 (( ${+functions[vcs_info]} )) && vcs_info
2363 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2364 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2365 if (( EUID == 0 )); then
2366 PROMPT="${BLUE}${p0}${RED}${p1}"
2368 PROMPT="${RED}${p0}${BLUE}${p1}"
2373 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2374 # Since we define the required functions in here and not in files in
2375 # $fpath, we need to stick the theme's name into `$prompt_themes'
2376 # ourselves, since promptinit does not pick them up otherwise.
2377 prompt_themes+=( grml grml-chroot grml-large )
2378 # Also, keep the array sorted...
2379 prompt_themes=( "${(@on)prompt_themes}" )
2381 print 'Notice: no promptinit available :('
2382 grml_prompt_fallback
2386 # The prompt themes use modern features of zsh, that require at least
2387 # version 4.3.7 of the shell. Use the fallback otherwise.
2388 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2389 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2390 add-zsh-hook precmd battery
2392 if [[ "$TERM" == dumb ]] ; then
2393 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2394 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2395 for i in rc user path jobs history date time shell-level; do
2396 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2397 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2400 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2401 elif (( EUID == 0 )); then
2402 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2405 # Finally enable one of the prompts.
2406 if [[ -n $GRML_CHROOT ]]; then
2408 elif [[ $GRMLPROMPT -gt 0 ]]; then
2414 grml_prompt_fallback
2417 # Terminal-title wizardry
2419 function ESC_print () {
2420 info_print $'\ek' $'\e\\' "$@"
2422 function set_title () {
2423 info_print $'\e]0;' $'\a' "$@"
2426 function info_print () {
2427 local esc_begin esc_end
2431 printf '%s' ${esc_begin}
2433 printf '%s' "${esc_end}"
2436 function grml_reset_screen_title () {
2437 # adjust title of xterm
2438 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2439 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2442 set_title ${(%):-"%n@%m: %~"}
2447 function grml_vcs_to_screen_title () {
2448 if [[ $TERM == screen* ]] ; then
2449 if [[ -n ${vcs_info_msg_1_} ]] ; then
2450 ESC_print ${vcs_info_msg_1_}
2457 function grml_maintain_name () {
2458 # set hostname if not running on host with name 'grml'
2459 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
2464 function grml_cmd_to_screen_title () {
2465 # get the name of the program currently running and hostname of local
2466 # machine set screen window title if running in a screen
2467 if [[ "$TERM" == screen* ]] ; then
2468 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2473 function grml_control_xterm_title () {
2476 set_title "${(%):-"%n@%m:"}" "$1"
2481 # The following autoload is disabled for now, since this setup includes a
2482 # static version of the ‘add-zsh-hook’ function above. It needs to be
2483 # reenabled as soon as that static definition is removed again.
2484 #zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2485 if [[ $NOPRECMD -eq 0 ]]; then
2486 add-zsh-hook precmd grml_reset_screen_title
2487 add-zsh-hook precmd grml_vcs_to_screen_title
2488 add-zsh-hook preexec grml_maintain_name
2489 add-zsh-hook preexec grml_cmd_to_screen_title
2490 if [[ $NOTITLE -eq 0 ]]; then
2491 add-zsh-hook preexec grml_control_xterm_title
2495 # 'hash' some often used directories
2497 hash -d deb=/var/cache/apt/archives
2498 hash -d doc=/usr/share/doc
2499 hash -d linux=/lib/modules/$(command uname -r)/build/
2500 hash -d log=/var/log
2501 hash -d slog=/var/log/syslog
2502 hash -d src=/usr/src
2503 hash -d www=/var/www
2507 if check_com -c screen ; then
2508 if [[ $UID -eq 0 ]] ; then
2509 if [[ -r /etc/grml/screenrc ]]; then
2510 alias screen="${commands[screen]} -c /etc/grml/screenrc"
2512 elif [[ -r $HOME/.screenrc ]] ; then
2513 alias screen="${commands[screen]} -c $HOME/.screenrc"
2515 if [[ -r /etc/grml/screenrc_grml ]]; then
2516 alias screen="${commands[screen]} -c /etc/grml/screenrc_grml"
2518 if [[ -r /etc/grml/screenrc ]]; then
2519 alias screen="${commands[screen]} -c /etc/grml/screenrc"
2525 # do we have GNU ls with color-support?
2526 if [[ "$TERM" != dumb ]]; then
2527 #a1# List files with colors (\kbd{ls \ldots})
2528 alias ls="command ls ${ls_options:+${ls_options[*]}}"
2529 #a1# List all files, with colors (\kbd{ls -la \ldots})
2530 alias la="command ls -la ${ls_options:+${ls_options[*]}}"
2531 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2532 alias ll="command ls -l ${ls_options:+${ls_options[*]}}"
2533 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2534 alias lh="command ls -hAl ${ls_options:+${ls_options[*]}}"
2535 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -l \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2536 alias l="command ls -l ${ls_options:+${ls_options[*]}}"
2538 alias la='command ls -la'
2539 alias ll='command ls -l'
2540 alias lh='command ls -hAl'
2541 alias l='command ls -l'
2544 alias mdstat='cat /proc/mdstat'
2545 alias ...='cd ../../'
2547 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2548 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2549 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2552 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2553 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2554 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2556 # make sure it is not assigned yet
2557 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2561 for ENV in $(env | command grep -i '.utf') ; do
2562 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2567 # make sure it is not assigned yet
2568 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2570 if ! isutfenv ; then
2572 for ENV in $(env | command grep -i '\.iso') ; do
2573 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2578 # especially for roadwarriors using GNU screen and ssh:
2579 if ! check_com asc &>/dev/null ; then
2580 asc() { autossh -t "$@" 'screen -RdU' }
2584 #f1# Hints for the use of zsh on grml
2586 print "$bg[white]$fg[black]
2587 zsh-help - hints for use of zsh on grml
2588 =======================================$reset_color"
2591 Main configuration of zsh happens in /etc/zsh/zshrc.
2592 That file is part of the package grml-etc-core, if you want to
2593 use them on a non-grml-system just get the tar.gz from
2594 http://deb.grml.org/ or (preferably) get it from the git repository:
2596 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2598 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2599 The file is still there, but it is empty for backwards compatibility.
2601 For your own changes use these two files:
2605 The former is sourced very early in our zshrc, the latter is sourced
2608 System wide configuration without touching configuration files of grml
2609 can take place in /etc/zsh/zshrc.local.
2611 For information regarding zsh start at http://grml.org/zsh/
2613 Take a look at grml'\''s zsh refcard:
2614 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2616 Check out the main zsh refcard:
2617 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2619 And of course visit the zsh-lovers:
2622 You can adjust some options through environment variables when
2623 invoking zsh without having to edit configuration files.
2624 Basically meant for bash users who are not used to the power of
2627 "NOCOR=1 zsh" => deactivate automatic correction
2628 "NOMENU=1 zsh" => do not use auto menu completion
2629 (note: use ctrl-d for completion instead!)
2630 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2631 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2632 preexec() and precmd() completely
2633 "GRML_DISPLAY_BATTERY=1 zsh"
2634 => activate battery status on right side of prompt (WIP)
2635 "COMMAND_NOT_FOUND=1 zsh"
2636 => Enable a handler if an external command was not found
2637 The command called in the handler can be altered by setting
2638 the GRML_ZSH_CNF_HANDLER variable, the default is:
2639 "/usr/share/command-not-found/command-not-found"
2641 A value greater than 0 is enables a feature; a value equal to zero
2642 disables it. If you like one or the other of these settings, you can
2643 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2647 $bg[white]$fg[black]
2648 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2649 Enjoy your grml system with the zsh!$reset_color"
2653 if [[ -r /etc/debian_version ]] ; then
2654 #a3# Execute \kbd{apt-cache search}
2655 alias acs='apt-cache search'
2656 #a3# Execute \kbd{apt-cache show}
2657 alias acsh='apt-cache show'
2658 #a3# Execute \kbd{apt-cache policy}
2659 alias acp='apt-cache policy'
2660 #a3# Execute \kbd{apt-get dist-upgrade}
2661 salias adg="apt-get dist-upgrade"
2662 #a3# Execute \kbd{apt-get install}
2663 salias agi="apt-get install"
2664 #a3# Execute \kbd{aptitude install}
2665 salias ati="aptitude install"
2666 #a3# Execute \kbd{apt-get upgrade}
2667 salias ag="apt-get upgrade"
2668 #a3# Execute \kbd{apt-get update}
2669 salias au="apt-get update"
2670 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2671 salias -a up="aptitude update ; aptitude safe-upgrade"
2672 #a3# Execute \kbd{dpkg-buildpackage}
2673 alias dbp='dpkg-buildpackage'
2674 #a3# Execute \kbd{grep-excuses}
2675 alias ge='grep-excuses'
2677 # get a root shell as normal user in live-cd mode:
2678 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2682 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
2683 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2684 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
2685 salias tlog="tail -f /var/log/syslog" # follow the syslog
2688 # sort installed Debian-packages by size
2689 if check_com -c dpkg-query ; then
2690 #a3# List installed Debian-packages sorted by size
2691 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"
2694 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2695 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2696 if check_com -c wodim; then
2699 cdrecord is not provided under its original name by Debian anymore.
2700 See #377109 in the BTS of Debian for more details.
2702 Please use the wodim binary instead
2709 # Use hard limits, except for a smaller stack and no core dumps
2711 is425 && limit stack 8192
2712 isgrmlcd && limit core 0 # important for a live-cd-system
2717 # people should use 'grml-x'!
2718 if check_com -c 915resolution; then
2720 echo "Please use 915resolution as resolution modifying tool for Intel \
2726 #a1# Output version of running grml
2727 alias grml-version='cat /etc/grml_version'
2729 if check_com -c grml-debootstrap ; then
2731 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2737 # now run the functions
2739 is4 && isgrml && grmlstuff
2743 is4 && xsource "/etc/zsh/keephack"
2745 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2746 # You use it as follows:
2747 # $ NTREF=/reference/file
2749 # This lists all the files in the current directory newer than the reference file.
2750 # You can also specify the reference file inline; note quotes:
2751 # $ ls -l *(e:'nt ~/.zshenv':)
2753 if [[ -n $1 ]] ; then
2756 [[ $REPLY -nt $NTREF ]]
2761 #f1# Reload an autoloadable function
2762 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2763 compdef _functions freload
2768 # e.g.: a -> b -> c -> d ....
2773 # if parameter is given with leading '=', lookup $PATH for parameter and resolve that
2777 # Note: limit for recursive symlinks on linux:
2778 # http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/fs/namei.c?id=refs/heads/master#l808
2779 # This limits recursive symlink follows to 8,
2780 # while limiting consecutive symlinks to 40.
2782 # When resolving and displaying information about symlinks, no check is made
2783 # that the displayed information does make any sense on your OS.
2784 # We leave that decission to the user.
2786 # The zstat module is used to detect symlink loops. zstat is available since zsh4.
2787 # With an older zsh you will need to abort with <C-c> in that case.
2788 # When a symlink loop is detected, a warning ist printed and further processing is stopped.
2790 # Module zstat is loaded by default in grml zshrc, no extra action needed for that.
2793 # If you happen to come accross a symlink that points to a destination on an other partition
2794 # with the same inode number, that will be marked as symlink loop though it is not.
2795 # Two hints for this situation:
2796 # I) Play lottery the same day, as you seem to be rather lucky right now.
2801 # 1 file/dir not accesible
2802 # 2 symlink loop detected
2804 #f1# List symlinks in detail (more detailed version of 'readlink -f', 'whence -s' and 'namei -l')
2806 if [[ -z ${1} ]] ; then
2807 printf 'Usage: %s <symlink(s)>\n' "${0}"
2811 local file jumpd curdir
2812 local -i RTN LINODE i
2817 for file in "${@}" ; do
2819 ls -l "${file:a}" || RTN=1
2821 while [[ -h "$file" ]] ; do
2823 LINODE=$(zstat -L +inode "${file}")
2824 for i in ${SEENINODES} ; do
2825 if (( ${i} == ${LINODE} )) ; then
2826 builtin cd "${curdir}"
2827 print "link loop detected, aborting!"
2831 SEENINODES+=${LINODE}
2836 if [[ -d ${jumpd} ]] ; then
2837 builtin cd "${jumpd}" || RTN=1
2839 file=$(readlink "$file")
2844 if [[ -d ${jumpd} ]] ; then
2845 builtin cd "${jumpd}" || RTN=1
2848 ls -l "${PWD}/${file}" || RTN=1
2851 if (( ${#} >= 1 )) ; then
2854 builtin cd "${curdir}"
2859 # TODO: Is it supported to use pager settings like this?
2860 # PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
2861 # with respect to wordsplitting. (ie. ${=PAGER})
2862 if check_com -c $PAGER ; then
2863 #f3# View Debian's changelog of given package(s)
2866 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
2869 for package in "$@" ; do
2870 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
2871 $PAGER /usr/share/doc/${package}/changelog.Debian.gz
2872 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
2873 $PAGER /usr/share/doc/${package}/changelog.gz
2874 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
2875 $PAGER /usr/share/doc/${package}/changelog
2877 if check_com -c aptitude ; then
2878 echo "No changelog for package $package found, using aptitude to retrieve it."
2879 aptitude changelog "$package"
2880 elif check_com -c apt-get ; then
2881 echo "No changelog for package $package found, using apt-get to retrieve it."
2882 apt-get changelog "$package"
2884 echo "No changelog for package $package found, sorry."
2889 _dchange() { _files -W /usr/share/doc -/ }
2890 compdef _dchange dchange
2892 #f3# View Debian's NEWS of a given package
2895 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
2896 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
2898 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
2899 $PAGER /usr/share/doc/$1/NEWS.gz
2901 echo "No NEWS file for package $1 found, sorry."
2906 _dnews() { _files -W /usr/share/doc -/ }
2907 compdef _dnews dnews
2909 #f3# View Debian's copyright of a given package
2912 if [[ -r /usr/share/doc/$1/copyright ]] ; then
2913 $PAGER /usr/share/doc/$1/copyright
2915 echo "No copyright file for package $1 found, sorry."
2919 _dcopyright() { _files -W /usr/share/doc -/ }
2920 compdef _dcopyright dcopyright
2922 #f3# View upstream's changelog of a given package
2925 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2926 $PAGER /usr/share/doc/$1/changelog.gz
2928 echo "No changelog for package $1 found, sorry."
2932 _uchange() { _files -W /usr/share/doc -/ }
2933 compdef _uchange uchange
2938 ZSH_PROFILE_RC=1 zsh "$@"
2941 #f1# Edit an alias via zle
2943 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2945 compdef _aliases edalias
2947 #f1# Edit a function via zle
2949 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
2951 compdef _functions edfunc
2953 # use it e.g. via 'Restart apache2'
2954 #m# f6 Start() \kbd{service \em{process}}\quad\kbd{start}
2955 #m# f6 Restart() \kbd{service \em{process}}\quad\kbd{restart}
2956 #m# f6 Stop() \kbd{service \em{process}}\quad\kbd{stop}
2957 #m# f6 Reload() \kbd{service \em{process}}\quad\kbd{reload}
2958 #m# f6 Force-Reload() \kbd{service \em{process}}\quad\kbd{force-reload}
2959 #m# f6 Status() \kbd{service \em{process}}\quad\kbd{status}
2960 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2962 local action_="${1:l}" # e.g Start/Stop/Restart
2966 local service_target_="$(readlink /etc/init.d/$service_)"
2967 if [[ $service_target_ == "/usr/bin/sv" ]]; then
2969 case "${action_}" in
2970 start) if [[ ! -e /etc/service/$service_ ]]; then
2971 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2973 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2975 # there is no reload in runits sysv emulation
2976 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2977 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2980 # sysv/sysvinit-utils, upstart
2981 if check_com -c service ; then
2982 $SUDO service "$service_" "${action_}" "$param_"
2984 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2991 scripts=( /etc/init.d/*(x:t) )
2992 _describe "service startup script" scripts
2995 for i in Start Restart Stop Force-Reload Reload Status ; do
2996 eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
2997 compdef _grmlinitd $i
3002 #f1# Provides useful information on globbing
3009 p named pipes (FIFOs)
3010 * executable plain files (0100)
3011 % device files (character or block special)
3012 %b block special files
3013 %c character special files
3014 r owner-readable files (0400)
3015 w owner-writable files (0200)
3016 x owner-executable files (0100)
3017 A group-readable files (0040)
3018 I group-writable files (0020)
3019 E group-executable files (0010)
3020 R world-readable files (0004)
3021 W world-writable files (0002)
3022 X world-executable files (0001)
3023 s setuid files (04000)
3024 S setgid files (02000)
3025 t files with the sticky bit (01000)
3027 print *(m-1) # Files modified up to a day ago
3028 print *(a1) # Files accessed a day ago
3029 print *(@) # Just symlinks
3030 print *(Lk+50) # Files bigger than 50 kilobytes
3031 print *(Lk-50) # Files smaller than 50 kilobytes
3032 print **/*.c # All *.c files recursively starting in \$PWD
3033 print **/*.c~file.c # Same as above, but excluding 'file.c'
3034 print (foo|bar).* # Files starting with 'foo' or 'bar'
3035 print *~*.* # All Files that do not contain a dot
3036 chmod 644 *(.^x) # make all plain non-executable files publically readable
3037 print -l *(.c|.h) # Lists *.c and *.h
3038 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
3039 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
3041 alias help-zshglob=H-Glob
3043 # grep for running process, like: 'any vim'
3047 if [[ -z "$1" ]] ; then
3048 echo "any - grep for process(es) by keyword" >&2
3049 echo "Usage: any <keyword>" >&2 ; return 1
3051 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
3056 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
3057 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
3058 [[ -r /proc/1/maps ]] && \
3060 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
3061 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
3062 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
3065 # a wrapper for vim, that deals with title setting
3067 # set this array to a set of options to vim you always want
3068 # to have set when calling vim (in .zshrc.local), like:
3069 # VIM_OPTIONS=( -p )
3070 # This will cause vim to send every file given on the
3071 # commandline to be send to it's own tab (needs vim7).
3072 if check_com vim; then
3074 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
3078 ssl_hashes=( sha512 sha256 sha1 md5 )
3080 for sh in ${ssl_hashes}; do
3081 eval 'ssl-cert-'${sh}'() {
3083 if [[ -z $1 ]] ; then
3084 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
3087 openssl x509 -noout -fingerprint -'${sh}' -in $1
3091 ssl-cert-fingerprints() {
3094 if [[ -z $1 ]] ; then
3095 printf 'usage: ssl-cert-fingerprints <file>\n'
3098 for i in ${ssl_hashes}
3105 if [[ -z $1 ]] ; then
3106 printf 'usage: ssl-cert-info <file>\n'
3109 openssl x509 -noout -text -in $1
3110 ssl-cert-fingerprints $1
3113 # make sure our environment is clean regarding colors
3114 for var in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $var
3115 builtin unset -v var
3117 # "persistent history"
3118 # just write important commands you always need to ~/.important_commands
3119 if [[ -r ~/.important_commands ]] ; then
3120 fc -R ~/.important_commands
3123 # load the lookup subsystem if it's available on the system
3124 zrcautoload lookupinit && lookupinit
3128 # set terminal property (used e.g. by msgid-chooser)
3129 export COLORTERM="yes"
3134 #a2# Execute \kbd{du -sch}
3138 #a2# Execute \kbd{ls -lSrah}
3139 alias dir="command ls -lSrah"
3140 #a2# Only show dot-directories
3141 alias lad='command ls -d .*(/)'
3142 #a2# Only show dot-files
3143 alias lsa='command ls -a .*(.)'
3144 #a2# Only files with setgid/setuid/sticky flag
3145 alias lss='command ls -l *(s,S,t)'
3146 #a2# Only show symlinks
3147 alias lsl='command ls -l *(@)'
3148 #a2# Display only executables
3149 alias lsx='command ls -l *(*)'
3150 #a2# Display world-{readable,writable,executable} files
3151 alias lsw='command ls -ld *(R,W,X.^ND/)'
3152 #a2# Display the ten biggest files
3153 alias lsbig="command ls -flh *(.OL[1,10])"
3154 #a2# Only show directories
3155 alias lsd='command ls -d *(/)'
3156 #a2# Only show empty directories
3157 alias lse='command ls -d *(/^F)'
3158 #a2# Display the ten newest files
3159 alias lsnew="command ls -rtlh *(D.om[1,10])"
3160 #a2# Display the ten oldest files
3161 alias lsold="command ls -rtlh *(D.Om[1,10])"
3162 #a2# Display the ten smallest files
3163 alias lssmall="command ls -Srl *(.oL[1,10])"
3164 #a2# Display the ten newest directories and ten newest .directories
3165 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
3166 #a2# Display the ten oldest directories and ten oldest .directories
3167 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
3169 # some useful aliases
3170 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
3171 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
3173 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3174 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3175 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3176 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3178 # work around non utf8 capable software in utf environment via $LANG and luit
3179 if check_com isutfenv && check_com luit ; then
3180 if check_com -c mrxvt ; then
3181 isutfenv && [[ -n "$LANG" ]] && \
3182 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3185 if check_com -c aterm ; then
3186 isutfenv && [[ -n "$LANG" ]] && \
3187 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3190 if check_com -c centericq ; then
3191 isutfenv && [[ -n "$LANG" ]] && \
3192 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3198 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3201 local current_date=$(date -u "+%Y-%m-%dT%H:%M:%SZ")
3202 local clean keep move verbose result all to_bk
3203 setopt extended_glob
3205 while getopts ":hacmrv" opt; do
3208 c) unset move clean && (( ++keep ));;
3209 m) unset keep clean && (( ++move ));;
3210 r) unset move keep && (( ++clean ));;
3213 bk [-hcmv] FILE [FILE ...]
3214 bk -r [-av] [FILE [FILE ...]]
3215 Backup a file or folder in place and append the timestamp
3216 Remove backups of a file or folder, or all backups in the current directory
3219 -h Display this help text
3220 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3221 -m Move the file/folder, using mv(1)
3222 -r Remove backups of the specified file or directory, using rm(1). If none
3223 is provided, remove all backups in the current directory.
3224 -a Remove all (even hidden) backups.
3227 The -c, -r and -m options are mutually exclusive. If specified at the same time,
3228 the last one is used.
3230 The return code is the sum of all cp/mv/rm return codes.
3233 \?) bk -h >&2; return 1;;
3236 shift "$((OPTIND-1))"
3237 if (( keep > 0 )); then
3238 if islinux || isfreebsd; then
3239 for to_bk in "$@"; do
3240 cp $verbose -a "${to_bk%/}" "${to_bk%/}_$current_date"
3244 for to_bk in "$@"; do
3245 cp $verbose -pR "${to_bk%/}" "${to_bk%/}_$current_date"
3249 elif (( move > 0 )); then
3250 while (( $# > 0 )); do
3251 mv $verbose "${1%/}" "${1%/}_$current_date"
3255 elif (( clean > 0 )); then
3256 if (( $# > 0 )); then
3257 for to_bk in "$@"; do
3258 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
3262 if (( all > 0 )); then
3263 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)
3265 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
3273 #f5# cd to directoy and list files
3279 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3281 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3282 [[ ! -e ${1:h} ]] && return 1
3283 print "Correcting ${1} to ${1:h}"
3290 #f5# Create Directoy and \kbd{cd} to it
3292 if (( ARGC != 1 )); then
3293 printf 'usage: mkcd <new-directory>\n'
3296 if [[ ! -d "$1" ]]; then
3297 command mkdir -p "$1"
3299 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3304 #f5# Create temporary directory and \kbd{cd} to it
3306 builtin cd "$(mktemp -d)"
3310 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3313 print -l -- *(a-${1:-1})
3316 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3319 print -l -- *(c-${1:-1})
3322 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3325 print -l -- *(m-${1:-1})
3327 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3328 check_com new || alias new=modified
3330 # use colors when GNU grep with color-support
3331 if (( $#grep_options > 0 )); then
3332 o=${grep_options:+"${grep_options[*]}"}
3333 #a2# Execute \kbd{grep -{}-color=auto}
3334 alias grep='grep '$o
3335 alias egrep='egrep '$o
3340 # 'translate' looks up a word in a file with language-to-language
3341 # translations (field separator should be " : "). A typical wordlist looks
3342 # like the following:
3343 # | english-word : german-translation
3344 # It's also only possible to translate english to german but not reciprocal.
3345 # Use the following oneliner to reverse the sort order:
3346 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3347 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3348 #f5# Translates a word
3353 translate -l de-en $2
3356 translate -l en-de $2
3359 echo "Usage: $0 { -D | -E }"
3360 echo " -D == German to English"
3361 echo " -E == English to German"
3365 # Usage: simple-extract <file>
3366 # Using option -d deletes the original archive file.
3367 #f5# Smart archive extractor
3370 setopt extended_glob noclobber
3371 local ARCHIVE DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3373 zparseopts -D -E "d=DELETE_ORIGINAL"
3374 for ARCHIVE in "${@}"; do
3376 *(tar.bz2|tbz2|tbz))
3377 DECOMP_CMD="tar -xvjf -"
3382 DECOMP_CMD="tar -xvzf -"
3386 *(tar.xz|txz|tar.lzma))
3387 DECOMP_CMD="tar -xvJf -"
3392 DECOMP_CMD="tar -xvf -"
3397 DECOMP_CMD="unrar x"
3422 DECOMP_CMD="bzip2 -d -c -"
3427 DECOMP_CMD="gzip -d -c -"
3432 DECOMP_CMD="xz -d -c -"
3437 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3443 if ! check_com ${DECOMP_CMD[(w)1]}; then
3444 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3449 GZTARGET="${ARCHIVE:t:r}"
3450 if [[ -f $ARCHIVE ]] ; then
3452 print "Extracting '$ARCHIVE' ..."
3453 if $USES_STDIN; then
3454 if $USES_STDOUT; then
3455 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3457 ${=DECOMP_CMD} < "$ARCHIVE"
3460 if $USES_STDOUT; then
3461 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3463 ${=DECOMP_CMD} "$ARCHIVE"
3466 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3468 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3469 if check_com curl; then
3470 WGET_CMD="curl -L -s -o -"
3471 elif check_com wget; then
3472 WGET_CMD="wget -q -O -"
3473 elif check_com fetch; then
3474 WGET_CMD="fetch -q -o -"
3476 print "ERROR: neither wget, curl nor fetch is installed" >&2
3480 print "Downloading and Extracting '$ARCHIVE' ..."
3481 if $USES_STDIN; then
3482 if $USES_STDOUT; then
3483 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3486 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3490 if $USES_STDOUT; then
3491 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3493 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3498 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3508 '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)"' \
3509 '_urls:Remote Archives:_urls'
3515 '-d[delete original archivefile after extraction]' \
3516 '*:Archive Or Uri:__archive_or_uri'
3518 compdef _simple_extract simple-extract
3519 alias se=simple-extract
3521 #f5# Set all ulimit parameters to \kbd{unlimited}
3532 #f5# Change the xterm title from within GNU-screen
3535 if [[ $1 != "-f" ]] ; then
3536 if [[ -z ${DISPLAY} ]] ; then
3537 printf 'xtrename only makes sense in X11.\n'
3543 if [[ -z $1 ]] ; then
3544 printf 'usage: xtrename [-f] "title for xterm"\n'
3545 printf ' renames the title of xterm from _within_ screen.\n'
3546 printf ' also works without screen.\n'
3547 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3550 print -n "\eP\e]0;${1}\C-G\e\\"
3554 # Create small urls via http://goo.gl using curl(1).
3555 # API reference: https://code.google.com/apis/urlshortener/
3558 setopt extended_glob
3560 if [[ -z $1 ]]; then
3561 print "USAGE: zurl <URL>"
3565 local PN url prog api json contenttype item
3570 # Prepend 'http://' to given URL where necessary for later output.
3571 if [[ ${url} != http(s|)://* ]]; then
3575 if check_com -c curl; then
3578 print "curl is not available, but mandatory for ${PN}. Aborting."
3581 api='https://www.googleapis.com/urlshortener/v1/url'
3582 contenttype="Content-Type: application/json"
3583 json="{\"longUrl\": \"${url}\"}"
3584 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3585 # Parse the response
3586 for item in "${data[@]}"; do
3591 printf '%s\n' "$item"
3599 #f2# Find history events by search pattern and list them by date.
3602 local usage help ident format_l format_s first_char remain first last
3603 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3604 help='Use `whatwhen -h'\'' for further explanations.'
3605 ident=${(l,${#${:-Usage: }},, ,)}
3606 format_l="${ident}%s\t\t\t%s\n"
3607 format_s="${format_l//(\\t)##/\\t}"
3608 # Make the first char of the word to search for case
3609 # insensitive; e.g. [aA]
3610 first_char=[${(L)1[1]}${(U)1[1]}]
3612 # Default search range is `-100'.
3614 # Optional, just used for `<first> <last>' given.
3618 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3619 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3622 printf '%s\n\n' ${usage}
3624 printf $format_l '-h' 'show help text'
3626 print 'SEARCH RANGE:'
3627 printf $format_l "'0'" 'the whole history,'
3628 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3629 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3630 printf '\n%s\n' 'EXAMPLES:'
3631 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3632 printf $format_l 'whatwhen zsh -250'
3633 printf $format_l 'whatwhen foo 1 99'
3636 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3639 # -l list results on stout rather than invoking $EDITOR.
3640 # -i Print dates as in YYYY-MM-DD.
3641 # -m Search for a - quoted - pattern within the history.
3642 fc -li -m "*${first_char}${remain}*" $first $last
3647 # mercurial related stuff
3648 if check_com -c hg ; then
3649 # gnu like diff for mercurial
3650 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3651 #f5# GNU like diff for mercurial
3655 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3658 # build debian package
3659 #a2# Alias for \kbd{hg-buildpackage}
3660 alias hbp='hg-buildpackage'
3662 # execute commands on the versioned patch-queue from the current repos
3663 alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3665 # diffstat for specific version of a mercurial repository
3666 # hgstat => display diffstat between last revision and tip
3667 # hgstat 1234 => display diffstat between revision 1234 and tip
3668 #f5# Diffstat for specific version of a mercurial repos
3671 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3674 fi # end of check whether we have the 'hg'-executable
3676 # grml-small cleanups
3678 # The following is used to remove zsh-config-items that do not work
3679 # in grml-small by default.
3680 # If you do not want these adjustments (for whatever reason), set
3681 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3682 # sources if it is there).
3684 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3687 unalias 'V' &> /dev/null
3688 unfunction vman &> /dev/null
3689 unfunction viless &> /dev/null
3690 unfunction 2html &> /dev/null
3692 # manpages are not in grmlsmall
3693 unfunction manzsh &> /dev/null
3694 unfunction man2 &> /dev/null
3700 ## genrefcard.pl settings
3702 ### doc strings for external functions from files
3703 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3705 ### example: split functions-search 8,16,24,32
3706 #@# split functions-search 8
3708 ## END OF FILE #################################################################
3709 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4