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
166 function isgrmlcd () {
167 [[ -f /etc/grml_cd ]] && return 0
172 #f1# Checks whether or not you're running grml-small
173 function isgrmlsmall () {
174 if [[ ${${${(f)"$(</etc/grml_version)"}%% *}##*-} == 'small' ]]; then
180 function isgrmlsmall () { return 1 }
183 GRML_OSTYPE=$(uname -s)
185 function islinux () {
186 [[ $GRML_OSTYPE == "Linux" ]]
189 function isdarwin () {
190 [[ $GRML_OSTYPE == "Darwin" ]]
193 function isfreebsd () {
194 [[ $GRML_OSTYPE == "FreeBSD" ]]
197 function isopenbsd () {
198 [[ $GRML_OSTYPE == "OpenBSD" ]]
201 function issolaris () {
202 [[ $GRML_OSTYPE == "SunOS" ]]
205 #f1# are we running within an utf environment?
206 function isutfenv () {
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 && function 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 || function is-at-least () { return 1 }
359 # set some important options (as early as possible)
361 # append history list to the history file; this is the default but we make sure
362 # because it's required for share_history.
363 setopt append_history
365 # import new commands from the history file also in other zsh-session
366 is4 && setopt share_history
368 # save each command's beginning timestamp and the duration to the history file
369 setopt extended_history
371 # If a new command line being added to the history list duplicates an older
372 # one, the older command is removed from the list
373 is4 && setopt histignorealldups
375 # remove command lines from the history list when the first character on the
377 setopt histignorespace
379 # if a command is issued that can't be executed as a normal command, and the
380 # command is the name of a directory, perform the cd command to that directory.
383 # in order to use #, ~ and ^ for filename generation grep word
384 # *~(*.gz|*.bz|*.bz2|*.zip|*.Z) -> searches for word not in compressed files
385 # don't forget to quote '^', '~' and '#'!
388 # display PID when suspending processes as well
391 # report the status of backgrounds jobs immediately
394 # whenever a command completion is attempted, make sure the entire command path
398 # not just at the end
399 setopt completeinword
401 # Don't send SIGHUP to background processes when the shell exits.
404 # make cd push the old directory onto the directory stack.
410 # don't push the same dir twice.
411 setopt pushd_ignore_dups
413 # * shouldn't match dotfiles. ever.
416 # use zsh style word splitting
419 # don't error out when unset parameters are used
422 # setting some default values
425 NOPRECMD=${NOPRECMD:-0}
426 COMMAND_NOT_FOUND=${COMMAND_NOT_FOUND:-0}
427 GRML_ZSH_CNF_HANDLER=${GRML_ZSH_CNF_HANDLER:-/usr/share/command-not-found/command-not-found}
428 GRML_DISPLAY_BATTERY=${GRML_DISPLAY_BATTERY:-${BATTERY:-0}}
429 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
430 ZSH_NO_DEFAULT_LOCALE=${ZSH_NO_DEFAULT_LOCALE:-0}
432 typeset -ga ls_options
433 typeset -ga grep_options
435 # Colors on GNU ls(1)
436 if ls --color=auto / >/dev/null 2>&1; then
437 ls_options+=( --color=auto )
438 # Colors on FreeBSD and OSX ls(1)
439 elif ls -G / >/dev/null 2>&1; then
443 # Natural sorting order on GNU ls(1)
444 # OSX and IllumOS have a -v option that is not natural sorting
445 if ls --version |& grep -q 'GNU' >/dev/null 2>&1 && ls -v / >/dev/null 2>&1; then
449 # Color on GNU and FreeBSD grep(1)
450 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
451 grep_options+=( --color=auto )
455 # this function checks if a command exists and returns either true
456 # or false. This avoids using 'which' and 'whence', which will
457 # avoid problems with aliases for which on certain weird systems. :-)
458 # Usage: check_com [-c|-g] word
459 # -c only checks for external commands
460 # -g does the usual tests and also checks for global aliases
461 function check_com () {
463 local -i comonly gatoo
467 if [[ $1 == '-c' ]] ; then
470 elif [[ $1 == '-g' ]] ; then
475 if (( ${#argv} != 1 )) ; then
476 printf 'usage: check_com [-c|-g] <command>\n' >&2
480 if (( comonly > 0 )) ; then
481 (( ${+commands[$1]} )) && return 0
485 if (( ${+commands[$1]} )) \
486 || (( ${+functions[$1]} )) \
487 || (( ${+aliases[$1]} )) \
488 || (( ${+reswords[(r)$1]} )) ; then
492 if (( gatoo > 0 )) && (( ${+galiases[$1]} )) ; then
499 # creates an alias and precedes the command with
500 # sudo if $EUID is not zero.
503 local only=0 ; local multi=0
505 while getopts ":hao" opt; do
510 printf 'usage: salias [-hoa] <alias-expression>\n'
511 printf ' -h shows this help text.\n'
512 printf ' -a replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
513 printf ' be careful using this option.\n'
514 printf ' -o only sets an alias if a preceding sudo would be needed.\n'
517 *) salias -h >&2; return 1 ;;
520 shift "$((OPTIND-1))"
522 if (( ${#argv} > 1 )) ; then
523 printf 'Too many arguments %s\n' "${#argv}"
527 key="${1%%\=*}" ; val="${1#*\=}"
528 if (( EUID == 0 )) && (( only == 0 )); then
529 alias -- "${key}=${val}"
530 elif (( EUID > 0 )) ; then
531 (( multi > 0 )) && val="${val// ; / ; sudo }"
532 alias -- "${key}=sudo ${val}"
538 # Check if we can read given files and source those we can.
539 function xsource () {
540 if (( ${#argv} < 1 )) ; then
541 printf 'usage: xsource FILE(s)...\n' >&2
545 while (( ${#argv} > 0 )) ; do
546 [[ -r "$1" ]] && source "$1"
552 # Check if we can read a given file and 'cat(1)' it.
555 if (( ${#argv} != 1 )) ; then
556 printf 'usage: xcat FILE\n' >&2
560 [[ -r $1 ]] && cat $1
564 # Remove these functions again, they are of use only in these
565 # setup files. This should be called at the end of .zshrc.
566 function xunfunction () {
570 funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
571 for func in $funcs ; do
572 [[ -n ${functions[$func]} ]] \
578 # this allows us to stay in sync with grml's zshrc and put own
579 # modifications in ~/.zshrc.local
580 function zrclocal () {
581 xsource "/etc/zsh/zshrc.local"
582 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
587 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
588 xsource "/etc/default/locale"
591 for var in LANG LC_ALL LC_MESSAGES ; do
592 [[ -n ${(P)var} ]] && export $var
597 if check_com -c vim ; then
599 export EDITOR=${EDITOR:-vim}
601 export EDITOR=${EDITOR:-vi}
605 export PAGER=${PAGER:-less}
608 export MAIL=${MAIL:-/var/mail/$USER}
610 # color setup for ls:
611 check_com -c dircolors && eval $(dircolors -b)
612 # color setup for ls on OS X / FreeBSD:
613 isdarwin && export CLICOLOR=1
614 isfreebsd && export CLICOLOR=1
616 # do MacPorts setup on darwin
617 if isdarwin && [[ -d /opt/local ]]; then
618 # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
620 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
621 MANPATH="/opt/local/share/man:$MANPATH"
623 # do Fink setup on darwin
624 isdarwin && xsource /sw/bin/init.sh
626 # load our function and completion directories
627 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
628 fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
631 ffiles=(/usr/share/grml/zsh/functions/**/[^_]*[^~](N.:t))
632 (( ${#ffiles} > 0 )) && autoload -U "${ffiles[@]}"
635 # support colors in less
636 export LESS_TERMCAP_mb=$'\E[01;31m'
637 export LESS_TERMCAP_md=$'\E[01;31m'
638 export LESS_TERMCAP_me=$'\E[0m'
639 export LESS_TERMCAP_se=$'\E[0m'
640 export LESS_TERMCAP_so=$'\E[01;44;33m'
641 export LESS_TERMCAP_ue=$'\E[0m'
642 export LESS_TERMCAP_us=$'\E[01;32m'
647 # report about cpu-/system-/user-time of command if running longer than
651 # watch for everyone but me and root
654 # automatically remove duplicates from these arrays
655 typeset -U path PATH cdpath CDPATH fpath FPATH manpath MANPATH
659 for mod in parameter complist deltochar mathfunc ; do
660 zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
661 done && builtin unset -v mod
663 # autoload zsh modules when they are referenced
665 zmodload -a zsh/stat zstat
666 zmodload -a zsh/zpty zpty
667 zmodload -ap zsh/mapfile mapfile
671 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
672 if zrcautoload compinit ; then
673 compinit -d ${COMPDUMPFILE} || print 'Notice: no compinit available :('
675 print 'Notice: no compinit available :('
681 # called later (via is4 && grmlcomp)
682 # note: use 'zstyle' for getting current settings
683 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
684 function grmlcomp () {
685 # TODO: This could use some additional information
687 # Make sure the completion system is initialised
688 (( ${+_comps} )) || return 1
690 # allow one error for every three characters typed in approximate completer
691 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
693 # don't complete backup files as executables
694 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
696 # start menu completion only if it could find no unambiguous initial string
697 zstyle ':completion:*:correct:*' insert-unambiguous true
698 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
699 zstyle ':completion:*:correct:*' original true
701 # activate color-completion
702 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
704 # format on completion
705 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
707 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
708 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
710 # insert all expansions for expand completer
711 zstyle ':completion:*:expand:*' tag-order all-expansions
712 zstyle ':completion:*:history-words' list false
715 zstyle ':completion:*:history-words' menu yes
717 # ignore duplicate entries
718 zstyle ':completion:*:history-words' remove-all-dups yes
719 zstyle ':completion:*:history-words' stop yes
721 # match uppercase from lowercase
722 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
724 # separate matches into groups
725 zstyle ':completion:*:matches' group 'yes'
726 zstyle ':completion:*' group-name ''
728 if [[ "$NOMENU" -eq 0 ]] ; then
729 # if there are more than 5 options allow selecting from a menu
730 zstyle ':completion:*' menu select=5
732 # don't use any menus at all
736 zstyle ':completion:*:messages' format '%d'
737 zstyle ':completion:*:options' auto-description '%d'
739 # describe options in full
740 zstyle ':completion:*:options' description 'yes'
742 # on processes completion complete all user processes
743 zstyle ':completion:*:processes' command 'ps -au$USER'
745 # offer indexes before parameters in subscripts
746 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
748 # provide verbose completion information
749 zstyle ':completion:*' verbose true
751 # recent (as of Dec 2007) zsh versions are able to provide descriptions
752 # for commands (read: 1st word in the line) that it will list for the user
753 # to choose from. The following disables that, because it's not exactly fast.
754 zstyle ':completion:*:-command-:*:' verbose false
756 # set format for warnings
757 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
759 # define files to ignore for zcompile
760 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
761 zstyle ':completion:correct:' prompt 'correct to: %e'
763 # Ignore completion functions for commands you don't have:
764 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
766 # Provide more processes in completion of programs like killall:
767 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
769 # complete manual by their section
770 zstyle ':completion:*:manuals' separate-sections true
771 zstyle ':completion:*:manuals.*' insert-sections true
772 zstyle ':completion:*:man:*' menu yes select
774 # Search path for sudo completion
775 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
783 # provide .. as a completion
784 zstyle ':completion:*' special-dirs ..
786 # run rehash on completion so new installed program are found automatically:
787 function _force_rehash () {
788 (( CURRENT == 1 )) && rehash
793 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
794 if [[ "$NOCOR" -gt 0 ]] ; then
795 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
798 # try to be smart about when to use what completer...
800 zstyle -e ':completion:*' completer '
801 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
802 _last_try="$HISTNO$BUFFER$CURSOR"
803 reply=(_complete _match _ignored _prefix _files)
805 if [[ $words[1] == (rm|mv) ]] ; then
806 reply=(_complete _files)
808 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
813 # command for process lists, the local web server details and host completion
814 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
816 # Some functions, like _apt and _dpkg, are very slow. We can use a cache in
817 # order to speed things up
818 if [[ ${GRML_COMP_CACHING:-yes} == yes ]]; then
819 GRML_COMP_CACHE_DIR=${GRML_COMP_CACHE_DIR:-${ZDOTDIR:-$HOME}/.cache}
820 if [[ ! -d ${GRML_COMP_CACHE_DIR} ]]; then
821 command mkdir -p "${GRML_COMP_CACHE_DIR}"
823 zstyle ':completion:*' use-cache yes
824 zstyle ':completion:*:complete:*' cache-path "${GRML_COMP_CACHE_DIR}"
829 [[ -r ~/.ssh/config ]] && _ssh_config_hosts=(${${(s: :)${(ps:\t:)${${(@M)${(f)"$(<$HOME/.ssh/config)"}:#Host *}#Host }}}:#*[*?]*}) || _ssh_config_hosts=()
830 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
831 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
839 "$_ssh_config_hosts[@]"
844 zstyle ':completion:*:hosts' hosts $hosts
845 # TODO: so, why is this here?
846 # zstyle '*' hosts $hosts
848 # use generic completion system for programs not yet defined; (_gnu_generic works
849 # with commands that provide a --help option with "standard" gnu-like output.)
850 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
852 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
855 # see upgrade function in this file
856 compdef _hosts upgrade
859 # Keyboard setup: The following is based on the same code, we wrote for
860 # debian's setup. It ensures the terminal is in the right mode, when zle is
861 # active, so the values from $terminfo are valid. Therefore, this setup should
862 # work on all systems, that have support for `terminfo'. It also requires the
863 # zsh in use to have the `zsh/terminfo' module built.
865 # If you are customising your `zle-line-init()' or `zle-line-finish()'
866 # functions, make sure you call the following utility functions in there:
868 # - zle-line-init(): zle-smkx
869 # - zle-line-finish(): zle-rmkx
871 # Use emacs-like key bindings by default:
876 ## beginning-of-line OR beginning-of-buffer OR beginning of history
877 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
878 function beginning-or-end-of-somewhere () {
880 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
881 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
882 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
884 zle .${WIDGET:s/somewhere/line-hist/} "$@"
885 if (( HISTNO != hno )); then
886 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
890 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
891 zle -N end-of-somewhere beginning-or-end-of-somewhere
893 # add a command line to the shells history without executing it
894 function commit-to-history () {
895 print -s ${(z)BUFFER}
898 zle -N commit-to-history
900 # only slash should be considered as a word separator:
901 function slash-backward-kill-word () {
902 local WORDCHARS="${WORDCHARS:s@/@}"
904 zle backward-kill-word
906 zle -N slash-backward-kill-word
908 # a generic accept-line wrapper
910 # This widget can prevent unwanted autocorrections from command-name
911 # to _command-name, rehash automatically on enter and call any number
912 # of builtin and user-defined widgets in different contexts.
914 # For a broader description, see:
915 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
917 # The code is imported from the file 'zsh/functions/accept-line' from
918 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
919 # distributed under the same terms as zsh itself.
921 # A newly added command will may not be found or will cause false
922 # correction attempts, if you got auto-correction set. By setting the
923 # following style, we force accept-line() to rehash, if it cannot
924 # find the first word on the command line in the $command[] hash.
925 zstyle ':acceptline:*' rehash true
927 function Accept-Line () {
928 setopt localoptions noksharrays
932 local alcontext=${1:-$alcontext}
934 zstyle -a ":acceptline:${alcontext}" actions subs
936 (( ${#subs} < 1 )) && return 0
939 for sub in ${subs} ; do
940 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
943 (( aldone > 0 )) && break
947 function Accept-Line-getdefault () {
951 zstyle -s ":acceptline:${alcontext}" default_action default_action
952 case ${default_action} in
954 printf ".accept-line"
957 printf ${default_action}
962 function Accept-Line-HandleContext () {
965 default_action=$(Accept-Line-getdefault)
966 zstyle -T ":acceptline:${alcontext}" call_default \
967 && zle ${default_action}
970 function accept-line () {
971 setopt localoptions noksharrays
974 local buf com fname format msg default_action
978 cmdline=(${(z)BUFFER})
982 Accept-Line 'preprocess'
984 zstyle -t ":acceptline:${alcontext}" rehash \
985 && [[ -z ${commands[$com]} ]] \
989 && [[ -n ${reswords[(r)$com]} ]] \
990 || [[ -n ${aliases[$com]} ]] \
991 || [[ -n ${functions[$com]} ]] \
992 || [[ -n ${builtins[$com]} ]] \
993 || [[ -n ${commands[$com]} ]] ; then
995 # there is something sensible to execute, just do it.
997 Accept-Line-HandleContext
1002 if [[ -o correct ]] \
1003 || [[ -o correctall ]] \
1004 && [[ -n ${functions[$fname]} ]] ; then
1006 # nothing there to execute but there is a function called
1007 # _command_name; a completion widget. Makes no sense to
1008 # call it on the commandline, but the correct{,all} options
1009 # will ask for it nevertheless, so warn the user.
1010 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
1011 # Okay, we warned the user before, he called us again,
1012 # so have it his way.
1014 Accept-Line-HandleContext
1019 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
1021 Accept-Line-HandleContext
1023 # prepare warning message for the user, configurable via zstyle.
1024 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
1026 if [[ -z ${msg} ]] ; then
1027 msg="%c will not execute and completion %f exists."
1030 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
1035 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
1036 # If we are here, the commandline contains something that is not
1037 # executable, which is neither subject to _command_name correction
1038 # and is not empty. might be a variable assignment
1040 Accept-Line-HandleContext
1045 # If we got this far, the commandline only contains whitespace, or is empty.
1047 Accept-Line-HandleContext
1052 zle -N Accept-Line-HandleContext
1054 # power completion / abbreviation expansion / buffer expansion
1055 # see http://zshwiki.org/home/examples/zleiab for details
1056 # less risky than the global aliases but powerful as well
1057 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
1060 setopt interactivecomments
1062 # key # value (#d additional doc string)
1068 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1070 'Hl' ' --help |& less -r' #d (Display help in pager)
1074 'N' '&>/dev/null' #d (No Output)
1075 'R' '| tr A-z N-za-m' #d (ROT13)
1076 'SL' '| sort | less'
1081 'co' './configure && make && sudo make install'
1084 function zleiab () {
1089 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1090 LBUFFER+=${abk[$MATCH]:-$MATCH}
1095 function help-show-abk () {
1096 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1099 zle -N help-show-abk
1101 # press "ctrl-x d" to insert the actual date in the form yyyy-mm-dd
1102 function insert-datestamp () { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1103 zle -N insert-datestamp
1105 # press esc-m for inserting last typed word again (thanks to caphuso!)
1106 function insert-last-typed-word () { zle insert-last-word -- 0 -1 };
1107 zle -N insert-last-typed-word;
1109 function grml-zsh-fg () {
1110 if (( ${#jobstates} )); then
1112 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1113 BUFFER="${BUFFER}fg"
1116 zle -M 'No background jobs. Doing nothing.'
1121 # run command line as user root via sudo:
1122 function sudo-command-line () {
1123 [[ -z $BUFFER ]] && zle up-history
1124 if [[ $BUFFER != sudo\ * ]]; then
1125 BUFFER="sudo $BUFFER"
1126 CURSOR=$(( CURSOR+5 ))
1129 zle -N sudo-command-line
1131 ### jump behind the first word on the cmdline.
1132 ### useful to add options.
1133 function jump_after_first_word () {
1135 words=(${(z)BUFFER})
1137 if (( ${#words} <= 1 )) ; then
1140 CURSOR=${#${words[1]}}
1143 zle -N jump_after_first_word
1145 #f5# Create directory under cursor or the selected area
1146 function inplaceMkDirs () {
1147 # Press ctrl-xM to create the directory under the cursor or the selected area.
1148 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1149 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1150 # directory does not exist yet -> press ctrl-XM and problem solved
1152 if ((REGION_ACTIVE==1)); then
1153 local F=$MARK T=$CURSOR
1154 if [[ $F -gt $T ]]; then
1158 # get marked area from buffer and eliminate whitespace
1159 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1160 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1162 local bufwords iword
1163 bufwords=(${(z)LBUFFER})
1165 bufwords=(${(z)BUFFER})
1166 PATHTOMKDIR="${(Q)bufwords[iword]}"
1168 [[ -z "${PATHTOMKDIR}" ]] && return 1
1169 PATHTOMKDIR=${~PATHTOMKDIR}
1170 if [[ -e "${PATHTOMKDIR}" ]]; then
1171 zle -M " path already exists, doing nothing"
1173 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1178 zle -N inplaceMkDirs
1180 #v1# set number of lines to display per page
1181 HELP_LINES_PER_PAGE=20
1182 #v1# set location of help-zle cache file
1183 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1184 # helper function for help-zle, actually generates the help text
1185 function help_zle_parse_keybindings () {
1188 unsetopt ksharrays #indexing starts at 1
1190 #v1# choose files that help-zle will parse for keybindings
1191 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1193 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1196 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1197 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1200 #fill with default keybindings, possibly to be overwritten in a file later
1201 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1202 local -A help_zle_keybindings
1203 help_zle_keybindings['<Ctrl>@']="set MARK"
1204 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1205 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1206 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1207 help_zle_keybindings['<Ctrl>_']="undo"
1208 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1209 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1210 help_zle_keybindings['<Ctrl>e']="goto end of line"
1211 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1212 help_zle_keybindings['<Alt>t']="transpose words"
1213 help_zle_keybindings['<Alt>s']="spellcheck word"
1214 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1215 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1216 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1217 help_zle_keybindings["<Alt>'"]="quote line"
1218 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1219 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1220 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1221 help_zle_keybindings['<Alt>l']="make next word lowercase"
1222 help_zle_keybindings['<Ctrl>xG']="preview expansion under cursor"
1223 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1224 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1225 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1226 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1227 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1228 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1229 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1230 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1232 #init global variables
1233 unset help_zle_lines help_zle_sln
1234 typeset -g -a help_zle_lines
1235 typeset -g help_zle_sln=1
1238 local lastkeybind_desc contents #last description starting with #k# that we found
1239 local num_lines_elapsed=0 #number of lines between last description and keybinding
1240 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1241 for f in $HELPZLE_KEYBINDING_FILES; do
1242 [[ -r "$f" ]] || continue #not readable ? skip it
1244 for cline in "${(f)contents}"; do
1245 #zsh pattern: matches lines like: #k# ..............
1246 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1247 lastkeybind_desc="$match[*]"
1249 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1250 # ignores lines that are commentend out
1251 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1252 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1253 #description previously found ? description not more than 2 lines away ? keybinding not empty ?
1254 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1255 #substitute keybinding string with something readable
1256 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1257 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1258 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1259 help_zle_keybindings[${k}]=$lastkeybind_desc
1263 ((num_lines_elapsed++))
1268 #calculate length of keybinding column
1270 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1271 #convert the assoc array into preformated lines, which we are able to sort
1272 for k v in ${(kv)help_zle_keybindings[@]}; do
1273 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1274 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1276 #sort lines alphabetically
1277 help_zle_lines=("${(i)help_zle_lines[@]}")
1278 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1279 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1280 zcompile $HELP_ZLE_CACHE_FILE
1282 typeset -g help_zle_sln
1283 typeset -g -a help_zle_lines
1285 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1286 function help-zle () {
1288 unsetopt ksharrays #indexing starts at 1
1289 #help lines already generated ? no ? then do it
1290 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1291 #already displayed all lines ? go back to the start
1292 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1293 local sln=$help_zle_sln
1294 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1295 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1296 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1300 ## complete word from currently visible Screen or Tmux buffer.
1301 if check_com -c screen || check_com -c tmux; then
1302 function _complete_screen_display () {
1303 [[ "$TERM" != "screen" ]] && return 1
1305 local TMPFILE=$(mktemp)
1306 local -U -a _screen_display_wordlist
1307 trap "rm -f $TMPFILE" EXIT
1309 # fill array with contents from screen hardcopy
1310 if ((${+TMUX})); then
1311 #works, but crashes tmux below version 1.4
1312 #luckily tmux -V option to ask for version, was also added in 1.4
1313 tmux -V &>/dev/null || return
1314 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1316 screen -X hardcopy $TMPFILE
1317 # screen sucks, it dumps in latin1, apparently always. so recode it
1319 check_com recode && recode latin1 $TMPFILE
1321 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1322 # remove PREFIX to be completed from that array
1323 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1324 compadd -a _screen_display_wordlist
1326 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1328 compdef -k _complete_screen_display complete-word '^xS'
1331 # Load a few more functions and tie them to widgets, so they can be bound:
1333 function zrcautozle () {
1336 zrcautoload $fnc && zle -N $fnc
1339 function zrcgotwidget () {
1340 (( ${+widgets[$1]} ))
1343 function zrcgotkeymap () {
1344 [[ -n ${(M)keymaps:#$1} ]]
1347 zrcautozle insert-files
1348 zrcautozle edit-command-line
1349 zrcautozle insert-unicode-char
1350 if zrcautoload history-search-end; then
1351 zle -N history-beginning-search-backward-end history-search-end
1352 zle -N history-beginning-search-forward-end history-search-end
1354 zle -C hist-complete complete-word _generic
1355 zstyle ':completion:hist-complete:*' completer _history
1357 # The actual terminal setup hooks and bindkey-calls:
1359 # An array to note missing features to ease diagnosis in case of problems.
1360 typeset -ga grml_missing_features
1362 function zrcbindkey () {
1363 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1368 function bind2maps () {
1369 local i sequence widget
1372 while [[ "$1" != "--" ]]; do
1378 if [[ "$1" == "-s" ]]; then
1382 sequence="${key[$1]}"
1386 [[ -z "$sequence" ]] && return 1
1388 for i in "${maps[@]}"; do
1389 zrcbindkey -M "$i" "$sequence" "$widget"
1393 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1394 function zle-smkx () {
1396 printf '%s' ${terminfo[smkx]}
1398 function zle-rmkx () {
1400 printf '%s' ${terminfo[rmkx]}
1402 function zle-line-init () {
1405 function zle-line-finish () {
1408 zle -N zle-line-init
1409 zle -N zle-line-finish
1411 for i in {s,r}mkx; do
1412 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1419 Home "${terminfo[khome]}"
1420 End "${terminfo[kend]}"
1421 Insert "${terminfo[kich1]}"
1422 Delete "${terminfo[kdch1]}"
1423 Up "${terminfo[kcuu1]}"
1424 Down "${terminfo[kcud1]}"
1425 Left "${terminfo[kcub1]}"
1426 Right "${terminfo[kcuf1]}"
1427 PageUp "${terminfo[kpp]}"
1428 PageDown "${terminfo[knp]}"
1429 BackTab "${terminfo[kcbt]}"
1432 # Guidelines for adding key bindings:
1434 # - Do not add hardcoded escape sequences, to enable non standard key
1435 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1437 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1440 # - All keys from the $key[] mapping are obviously okay.
1442 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1443 # '\ex' are allowed in here as well.
1445 bind2maps emacs -- Home beginning-of-somewhere
1446 bind2maps viins vicmd -- Home vi-beginning-of-line
1447 bind2maps emacs -- End end-of-somewhere
1448 bind2maps viins vicmd -- End vi-end-of-line
1449 bind2maps emacs viins -- Insert overwrite-mode
1450 bind2maps vicmd -- Insert vi-insert
1451 bind2maps emacs -- Delete delete-char
1452 bind2maps viins vicmd -- Delete vi-delete-char
1453 bind2maps emacs viins vicmd -- Up up-line-or-search
1454 bind2maps emacs viins vicmd -- Down down-line-or-search
1455 bind2maps emacs -- Left backward-char
1456 bind2maps viins vicmd -- Left vi-backward-char
1457 bind2maps emacs -- Right forward-char
1458 bind2maps viins vicmd -- Right vi-forward-char
1459 #k# Perform abbreviation expansion
1460 bind2maps emacs viins -- -s '^x.' zleiab
1461 #k# Display list of abbreviations that would expand
1462 bind2maps emacs viins -- -s '^xb' help-show-abk
1463 #k# mkdir -p <dir> from string under cursor or marked area
1464 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1465 #k# display help for keybindings and ZLE
1466 bind2maps emacs viins -- -s '^xz' help-zle
1467 #k# Insert files and test globbing
1468 bind2maps emacs viins -- -s "^xf" insert-files
1469 #k# Edit the current line in \kbd{\$EDITOR}
1470 bind2maps emacs viins -- -s '\ee' edit-command-line
1471 #k# search history backward for entry beginning with typed text
1472 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1473 #k# search history forward for entry beginning with typed text
1474 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1475 #k# search history backward for entry beginning with typed text
1476 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1477 #k# search history forward for entry beginning with typed text
1478 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1479 bind2maps emacs viins -- -s "^x^h" commit-to-history
1480 #k# Kill left-side word or everything up to next slash
1481 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1482 #k# Kill left-side word or everything up to next slash
1483 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1484 #k# Kill left-side word or everything up to next slash
1485 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1486 # Do history expansion on space:
1487 bind2maps emacs viins -- -s ' ' magic-space
1488 #k# Trigger menu-complete
1489 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1490 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1491 bind2maps emacs viins -- -s '^xd' insert-datestamp
1492 #k# Insert last typed word
1493 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1494 #k# A smart shortcut for \kbd{fg<enter>}
1495 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1496 #k# prepend the current command with "sudo"
1497 bind2maps emacs viins -- -s "^os" sudo-command-line
1498 #k# jump to after first word (for adding options)
1499 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1500 #k# complete word from history with menu
1501 bind2maps emacs viins -- -s "^x^x" hist-complete
1503 # insert unicode character
1504 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1505 # See for example http://unicode.org/charts/ for unicode characters code
1506 #k# Insert Unicode character
1507 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1509 # use the new *-pattern-* widgets for incremental history search
1510 if zrcgotwidget history-incremental-pattern-search-backward; then
1511 for seq wid in '^r' history-incremental-pattern-search-backward \
1512 '^s' history-incremental-pattern-search-forward
1514 bind2maps emacs viins vicmd -- -s $seq $wid
1516 builtin unset -v seq wid
1519 if zrcgotkeymap menuselect; then
1520 #m# k Shift-tab Perform backwards menu completion
1521 bind2maps menuselect -- BackTab reverse-menu-complete
1523 #k# menu selection: pick item but stay in the menu
1524 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1525 # also use + and INSERT since it's easier to press repeatedly
1526 bind2maps menuselect -- -s '+' accept-and-menu-complete
1527 bind2maps menuselect -- Insert accept-and-menu-complete
1529 # accept a completion and try to complete again by using menu
1530 # completion; very useful with completing directories
1531 # by using 'undo' one's got a simple file browser
1532 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1535 # Finally, here are still a few hardcoded escape sequences; Special sequences
1536 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1537 # standardised and most of the time are not available in a terminals terminfo
1540 # While we do not encourage adding bindings like these, we will keep these for
1541 # backward compatibility.
1543 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1544 ## the command line.
1546 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1547 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1548 # These are for xterm:
1549 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1550 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1551 ## the same for alt-left-arrow and alt-right-arrow
1553 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1554 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1556 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1557 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1558 # Also try ESC Left/Right:
1559 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1560 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1567 # we don't want to quote/espace URLs on our own...
1568 # if autoload -U url-quote-magic ; then
1569 # zle -N self-insert url-quote-magic
1570 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1572 # print 'Notice: no url-quote-magic available :('
1574 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1576 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1577 alias run-help >&/dev/null && unalias run-help
1578 for rh in run-help{,-git,-ip,-openssl,-p4,-sudo,-svk,-svn}; do
1582 # command not found handling
1584 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1585 function command_not_found_handler () {
1587 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1588 ${GRML_ZSH_CNF_HANDLER} $1
1596 HISTFILE=${HISTFILE:-${ZDOTDIR:-${HOME}}/.zsh_history}
1597 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1598 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1602 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1603 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1605 if zstyle -T ':grml:chpwd:dirstack' enable; then
1606 typeset -gaU GRML_PERSISTENT_DIRSTACK
1607 function grml_dirstack_filter () {
1610 if zstyle -s ':grml:chpwd:dirstack' filter filter; then
1611 $filter $1 && return 0
1613 if zstyle -a ':grml:chpwd:dirstack' exclude exclude; then
1614 for entry in "${exclude[@]}"; do
1615 [[ $1 == ${~entry} ]] && return 0
1622 (( ZSH_SUBSHELL )) && return
1623 (( $DIRSTACKSIZE <= 0 )) && return
1624 [[ -z $DIRSTACKFILE ]] && return
1625 grml_dirstack_filter $PWD && return
1626 GRML_PERSISTENT_DIRSTACK=(
1627 $PWD "${(@)GRML_PERSISTENT_DIRSTACK[1,$DIRSTACKSIZE]}"
1629 builtin print -l ${GRML_PERSISTENT_DIRSTACK} >! ${DIRSTACKFILE}
1632 if [[ -f ${DIRSTACKFILE} ]]; then
1633 # Enabling NULL_GLOB via (N) weeds out any non-existing
1634 # directories from the saved dir-stack file.
1635 dirstack=( ${(f)"$(< $DIRSTACKFILE)"}(N) )
1636 # "cd -" won't work after login by just setting $OLDPWD, so
1637 [[ -d $dirstack[1] ]] && cd -q $dirstack[1] && cd -q $OLDPWD
1640 if zstyle -t ':grml:chpwd:dirstack' filter-on-load; then
1641 for i in "${dirstack[@]}"; do
1642 if ! grml_dirstack_filter "$i"; then
1643 GRML_PERSISTENT_DIRSTACK=(
1644 "${GRML_PERSISTENT_DIRSTACK[@]}"
1650 GRML_PERSISTENT_DIRSTACK=( "${dirstack[@]}" )
1654 # directory based profiles
1658 # chpwd_profiles(): Directory Profiles, Quickstart:
1662 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1663 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1666 # For details see the `grmlzshrc.5' manual page.
1667 function chpwd_profiles () {
1668 local profile context
1671 context=":chpwd:profiles:$PWD"
1672 zstyle -s "$context" profile profile || profile='default'
1673 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1675 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1676 typeset -g CHPWD_PROFILE
1677 local CHPWD_PROFILES_INIT=1
1678 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1679 elif [[ $profile != $CHPWD_PROFILE ]]; then
1680 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1681 && chpwd_leave_profile_${CHPWD_PROFILE}
1683 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1684 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1687 CHPWD_PROFILE="${profile}"
1691 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1695 # Prompt setup for grml:
1697 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1698 # in prompts to get a red "foo" embedded, but it's good to keep these for
1699 # backwards compatibility).
1705 MAGENTA="%F{magenta}"
1709 elif zrcautoload colors && colors 2>/dev/null ; then
1710 BLUE="%{${fg[blue]}%}"
1711 RED="%{${fg_bold[red]}%}"
1712 GREEN="%{${fg[green]}%}"
1713 CYAN="%{${fg[cyan]}%}"
1714 MAGENTA="%{${fg[magenta]}%}"
1715 YELLOW="%{${fg[yellow]}%}"
1716 WHITE="%{${fg[white]}%}"
1717 NO_COLOR="%{${reset_color}%}"
1719 BLUE=$'%{\e[1;34m%}'
1721 GREEN=$'%{\e[1;32m%}'
1722 CYAN=$'%{\e[1;36m%}'
1723 WHITE=$'%{\e[1;37m%}'
1724 MAGENTA=$'%{\e[1;35m%}'
1725 YELLOW=$'%{\e[1;33m%}'
1726 NO_COLOR=$'%{\e[0m%}'
1729 # First, the easy ones: PS2..4:
1731 # secondary prompt, printed when the shell needs more information to complete a
1734 # selection prompt used within a select loop.
1736 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1739 # Some additional features to use with our prompt:
1743 # - vcs_info setup and version specific fixes
1745 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1747 function battery () {
1748 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1751 elif isopenbsd ; then
1753 elif isfreebsd ; then
1755 elif isdarwin ; then
1759 GRML_DISPLAY_BATTERY=0
1764 function batterylinux () {
1765 GRML_BATTERY_LEVEL=''
1766 local batteries bat capacity
1767 batteries=( /sys/class/power_supply/BAT*(N) )
1768 if (( $#batteries > 0 )) ; then
1769 for bat in $batteries ; do
1770 if [[ -e $bat/capacity ]]; then
1771 capacity=$(< $bat/capacity)
1773 typeset -F energy_full=$(< $bat/energy_full)
1774 typeset -F energy_now=$(< $bat/energy_now)
1775 typeset -i capacity=$(( 100 * $energy_now / $energy_full))
1777 case $(< $bat/status) in
1779 GRML_BATTERY_LEVEL+=" ^"
1782 if (( capacity < 20 )) ; then
1783 GRML_BATTERY_LEVEL+=" !v"
1785 GRML_BATTERY_LEVEL+=" v"
1789 GRML_BATTERY_LEVEL+=" ="
1792 GRML_BATTERY_LEVEL+="${capacity}%%"
1797 function batteryopenbsd () {
1798 GRML_BATTERY_LEVEL=''
1799 local bat batfull batwarn batnow num
1801 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1802 if [[ -n $bat ]]; then
1803 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1804 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1805 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1806 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1808 if (( batnow < batwarn )) ; then
1809 GRML_BATTERY_LEVEL+=" !v"
1811 GRML_BATTERY_LEVEL+=" v"
1815 GRML_BATTERY_LEVEL+=" ^"
1818 GRML_BATTERY_LEVEL+=" ="
1821 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1826 function batteryfreebsd () {
1827 GRML_BATTERY_LEVEL=''
1831 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1832 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1833 case $table[State] in
1835 if (( $table[Remaining-capacity] < 20 )) ; then
1836 GRML_BATTERY_LEVEL+=" !v"
1838 GRML_BATTERY_LEVEL+=" v"
1842 GRML_BATTERY_LEVEL+=" ^"
1845 GRML_BATTERY_LEVEL+=" ="
1848 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1853 function batterydarwin () {
1854 GRML_BATTERY_LEVEL=''
1856 table=( ${$(pmset -g ps)[(w)7,8]%%(\%|);} )
1857 if [[ -n $table[2] ]] ; then
1860 GRML_BATTERY_LEVEL+=" ^"
1863 if (( $table[1] < 20 )) ; then
1864 GRML_BATTERY_LEVEL+=" !v"
1866 GRML_BATTERY_LEVEL+=" v"
1870 GRML_BATTERY_LEVEL+=" ="
1873 GRML_BATTERY_LEVEL+="$table[1]%%"
1877 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1878 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1879 debian_chroot=$(</etc/debian_chroot)
1882 # gather version control information for inclusion in a prompt
1884 if zrcautoload vcs_info; then
1885 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1886 # function, which can cause a lot of trouble with our directory-based
1888 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1889 function VCS_INFO_realpath () {
1890 setopt localoptions NO_shwordsplit chaselinks
1891 ( builtin cd -q $1 2> /dev/null && pwd; )
1895 zstyle ':vcs_info:*' max-exports 2
1897 if [[ -o restricted ]]; then
1898 zstyle ':vcs_info:*' enable NONE
1902 typeset -A grml_vcs_coloured_formats
1903 typeset -A grml_vcs_plain_formats
1905 grml_vcs_plain_formats=(
1906 format "(%s%)-[%b] " "zsh: %r"
1907 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1908 rev-branchformat "%b:%r"
1911 grml_vcs_coloured_formats=(
1912 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1913 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1914 rev-branchformat "%b${RED}:${YELLOW}%r"
1917 typeset GRML_VCS_COLOUR_MODE=xxx
1919 function grml_vcs_info_toggle_colour () {
1921 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
1922 grml_vcs_info_set_formats coloured
1924 grml_vcs_info_set_formats plain
1929 function grml_vcs_info_set_formats () {
1931 #setopt localoptions xtrace
1932 local mode=$1 AF F BF
1933 if [[ $mode == coloured ]]; then
1934 AF=${grml_vcs_coloured_formats[actionformat]}
1935 F=${grml_vcs_coloured_formats[format]}
1936 BF=${grml_vcs_coloured_formats[rev-branchformat]}
1937 GRML_VCS_COLOUR_MODE=coloured
1939 AF=${grml_vcs_plain_formats[actionformat]}
1940 F=${grml_vcs_plain_formats[format]}
1941 BF=${grml_vcs_plain_formats[rev-branchformat]}
1942 GRML_VCS_COLOUR_MODE=plain
1945 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
1946 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
1947 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
1951 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1952 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1953 if [[ "$TERM" == dumb ]] ; then
1954 grml_vcs_info_set_formats plain
1956 grml_vcs_info_set_formats coloured
1959 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
1961 # This actually defines three prompts:
1967 # They all share the same code and only differ with respect to which items they
1968 # contain. The main source of documentation is the `prompt_grml_help' function
1969 # below, which gets called when the user does this: prompt -h grml
1971 function prompt_grml_help () {
1975 This is the prompt as used by the grml-live system <http://grml.org>. It is
1976 a rather simple one-line prompt, that by default looks something like this:
1978 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
1980 The prompt itself integrates with zsh's prompt themes system (as you are
1981 witnessing right now) and is configurable to a certain degree. In
1982 particular, these aspects are customisable:
1984 - The items used in the prompt (e.g. you can remove \`user' from
1985 the list of activated items, which will cause the user name to
1986 be omitted from the prompt string).
1988 - The attributes used with the items are customisable via strings
1989 used before and after the actual item.
1991 The available items are: at, battery, change-root, date, grml-chroot,
1992 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
1993 shell-level, time, user, vcs
1995 The actual configuration is done via zsh's \`zstyle' mechanism. The
1996 context, that is used while looking up styles is:
1998 ':prompt:grml:<left-or-right>:<subcontext>'
2000 Here <left-or-right> is either \`left' or \`right', signifying whether the
2001 style should affect the left or the right prompt. <subcontext> is either
2002 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
2006 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
2007 in $RPROMPT if the last command a returned non-successful error code.
2008 (This in only valid if <left-or-right> is "right"; ignored otherwise)
2010 - items (list): The list of items used in the prompt. If \`vcs' is
2011 present in the list, the theme's code invokes \`vcs_info'
2012 accordingly. Default (left): rc change-root user at host path vcs
2013 percent; Default (right): sad-smiley
2015 - strip-sensitive-characters (boolean): If the \`prompt_subst' option
2016 is active in zsh, the shell performs lots of expansions on prompt
2017 variable strings, including command substitution. So if you don't
2018 control where some of your prompt strings is coming from, this is
2019 an exploitable weakness. Grml's zsh setup does not set this option
2020 and it is off in the shell in zsh-mode by default. If it *is* turned
2021 on however, this style becomes active, and there are two flavours of
2022 it: On per default is a global variant in the '*:setup' context. This
2023 strips characters after the whole prompt string was constructed. There
2024 is a second variant in the '*:items:<item>', that is off by default.
2025 It allows fine grained control over which items' data is stripped.
2026 The characters that are stripped are: \$ and \`.
2028 Available styles in 'items:<item>' are: pre, post. These are strings that
2029 are inserted before (pre) and after (post) the item in question. Thus, the
2030 following would cause the user name to be printed in red instead of the
2033 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
2035 Note, that the \`post' style may remain at its default value, because its
2036 default value is '%f', which turns the foreground text attribute off (which
2037 is exactly, what is still required with the new \`pre' value).
2041 function prompt_grml-chroot_help () {
2045 This is a variation of the grml prompt, see: prompt -h grml
2047 The main difference is the default value of the \`items' style. The rest
2048 behaves exactly the same. Here are the defaults for \`grml-chroot':
2050 - left: grml-chroot user at host path percent
2051 - right: (empty list)
2055 function prompt_grml-large_help () {
2059 This is a variation of the grml prompt, see: prompt -h grml
2061 The main difference is the default value of the \`items' style. In
2062 particular, this theme uses _two_ lines instead of one with the plain
2063 \`grml' theme. The rest behaves exactly the same. Here are the defaults
2066 - left: rc jobs history shell-level change-root time date newline user
2067 at host path vcs percent
2072 function grml_prompt_setup () {
2074 autoload -Uz vcs_info
2075 # The following autoload is disabled for now, since this setup includes a
2076 # static version of the ‘add-zsh-hook’ function above. It needs to be
2077 # re-enabled as soon as that static definition is removed again.
2078 #autoload -Uz add-zsh-hook
2079 add-zsh-hook precmd prompt_$1_precmd
2082 function prompt_grml_setup () {
2083 grml_prompt_setup grml
2086 function prompt_grml-chroot_setup () {
2087 grml_prompt_setup grml-chroot
2090 function prompt_grml-large_setup () {
2091 grml_prompt_setup grml-large
2094 # These maps define default tokens and pre-/post-decoration for items to be
2095 # used within the themes. All defaults may be customised in a context sensitive
2096 # matter by using zsh's `zstyle' mechanism.
2097 typeset -gA grml_prompt_pre_default \
2098 grml_prompt_post_default \
2099 grml_prompt_token_default \
2100 grml_prompt_token_function
2102 grml_prompt_pre_default=(
2107 grml-chroot '%F{red}'
2117 shell-level '%F{red}'
2123 grml_prompt_post_default=(
2144 grml_prompt_token_default=(
2146 battery 'GRML_BATTERY_LEVEL'
2147 change-root 'debian_chroot'
2149 grml-chroot 'GRML_CHROOT'
2150 history '{history#%!} '
2152 jobs '[%j running job(s)] '
2154 path '%40<..<%~%<< '
2158 sad-smiley '%(?..:()'
2159 shell-level '%(3L.+ .)'
2160 time '%D{%H:%M:%S} '
2165 function grml_theme_has_token () {
2166 if (( ARGC != 1 )); then
2167 printf 'usage: grml_theme_has_token <name>\n'
2170 (( ${+grml_prompt_token_default[$1]} ))
2173 function GRML_theme_add_token_usage () {
2175 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2177 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2178 are used, <token/function> is the name of the function (see below for
2179 details). Otherwise it is the literal token string to be used. <pre> and
2180 <post> are optional.
2184 -f <function> Use a function named \`<function>' each time the token
2187 -i <function> Use a function named \`<function>' to initialise the
2188 value of the token _once_ at runtime.
2190 The functions are called with one argument: the token's new name. The
2191 return value is expected in the \$REPLY parameter. The use of these
2192 options is mutually exclusive.
2194 There is a utility function \`grml_theme_has_token', which you can use
2195 to test if a token exists before trying to add it. This can be a guard
2196 for situations in which a \`grml_theme_add_token' call may happen more
2201 To add a new token \`day' that expands to the current weekday in the
2202 current locale in green foreground colour, use this:
2204 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2206 Another example would be support for \$VIRTUAL_ENV:
2208 function virtual_env_prompt () {
2209 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2211 grml_theme_add_token virtual-env -f virtual_env_prompt
2213 After that, you will be able to use a changed \`items' style to
2214 assemble your prompt.
2218 function grml_theme_add_token () {
2220 local name token pre post
2221 local -i init funcall
2223 if (( ARGC == 0 )); then
2224 GRML_theme_add_token_usage
2234 if [[ $1 == '-f' ]]; then
2237 elif [[ $1 == '-i' ]]; then
2242 if (( ARGC == 0 )); then
2244 grml_theme_add_token: No token-string/function-name provided!\n\n'
2245 GRML_theme_add_token_usage
2250 if (( ARGC != 0 && ARGC != 2 )); then
2252 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2253 GRML_theme_add_token_usage
2262 if grml_theme_has_token $name; then
2264 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2265 GRML_theme_add_token_usage
2272 grml_prompt_pre_default[$name]=$pre
2273 grml_prompt_post_default[$name]=$post
2274 if (( funcall )); then
2275 grml_prompt_token_function[$name]=$token
2276 grml_prompt_token_default[$name]=23
2278 grml_prompt_token_default[$name]=$token
2282 function grml_wrap_reply () {
2289 if (( ${+parameters[$new]} )); then
2290 REPLY="${left}${(P)new}${right}"
2296 function grml_prompt_addto () {
2299 local lr it apre apost new v REPLY
2303 [[ $target == PS1 ]] && lr=left || lr=right
2304 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2305 typeset -g "${target}="
2306 for it in "${items[@]}"; do
2307 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2308 || apre=${grml_prompt_pre_default[$it]}
2309 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2310 || apost=${grml_prompt_post_default[$it]}
2311 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2312 || new=${grml_prompt_token_default[$it]}
2313 if (( ${+grml_prompt_token_function[$it]} )); then
2314 ${grml_prompt_token_function[$it]} $it
2318 grml_wrap_reply $target $new '' ''
2321 grml_wrap_reply $target $new '(' ')'
2324 if [[ -n ${(P)new} ]]; then
2331 v="vcs_info_msg_${new}_"
2332 if (( ! vcscalled )); then
2336 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2345 # Strip volatile characters per item. This is off by default. See the
2346 # global stripping code a few lines below for details.
2347 if [[ -o prompt_subst ]] && zstyle -t ":prompt:${grmltheme}:${lr}:items:$it" \
2348 strip-sensitive-characters
2350 REPLY="${REPLY//[$\`]/}"
2352 typeset -g "${target}=${(P)target}${apre}${REPLY}${apost}"
2355 # Per default, strip volatile characters (in the prompt_subst case)
2356 # globally. If the option is off, the style has no effect. For more
2357 # control, this can be turned off and stripping can be configured on a
2358 # per-item basis (see above).
2359 if [[ -o prompt_subst ]] && zstyle -T ":prompt:${grmltheme}:${lr}:setup" \
2360 strip-sensitive-characters
2362 typeset -g "${target}=${${(P)target}//[$\`]/}"
2366 function prompt_grml_precmd () {
2368 local grmltheme=grml
2369 local -a left_items right_items
2370 left_items=(rc change-root user at host path vcs percent)
2371 right_items=(sad-smiley)
2373 prompt_grml_precmd_worker
2376 function prompt_grml-chroot_precmd () {
2378 local grmltheme=grml-chroot
2379 local -a left_items right_items
2380 left_items=(grml-chroot user at host path percent)
2383 prompt_grml_precmd_worker
2386 function prompt_grml-large_precmd () {
2388 local grmltheme=grml-large
2389 local -a left_items right_items
2390 left_items=(rc jobs history shell-level change-root time date newline
2391 user at host path vcs percent)
2392 right_items=(sad-smiley)
2394 prompt_grml_precmd_worker
2397 function prompt_grml_precmd_worker () {
2399 local -i vcscalled=0
2401 grml_prompt_addto PS1 "${left_items[@]}"
2402 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2403 grml_prompt_addto RPS1 "${right_items[@]}"
2407 function grml_prompt_fallback () {
2411 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2412 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2413 if (( EUID == 0 )); then
2414 PROMPT="${BLUE}${p0}${RED}${p1}"
2416 PROMPT="${RED}${p0}${BLUE}${p1}"
2420 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2421 # Since we define the required functions in here and not in files in
2422 # $fpath, we need to stick the theme's name into `$prompt_themes'
2423 # ourselves, since promptinit does not pick them up otherwise.
2424 prompt_themes+=( grml grml-chroot grml-large )
2425 # Also, keep the array sorted...
2426 prompt_themes=( "${(@on)prompt_themes}" )
2428 print 'Notice: no promptinit available :('
2429 grml_prompt_fallback
2430 function precmd () { (( ${+functions[vcs_info]} )) && vcs_info; }
2434 # The prompt themes use modern features of zsh, that require at least
2435 # version 4.3.7 of the shell. Use the fallback otherwise.
2436 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2437 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2438 add-zsh-hook precmd battery
2440 if [[ "$TERM" == dumb ]] ; then
2441 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2442 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2443 for i in rc user path jobs history date time shell-level; do
2444 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2445 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2448 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2449 elif (( EUID == 0 )); then
2450 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2453 # Finally enable one of the prompts.
2454 if [[ -n $GRML_CHROOT ]]; then
2456 elif [[ $GRMLPROMPT -gt 0 ]]; then
2462 grml_prompt_fallback
2463 function precmd () { (( ${+functions[vcs_info]} )) && vcs_info; }
2466 # Terminal-title wizardry
2468 function ESC_print () {
2469 info_print $'\ek' $'\e\\' "$@"
2471 function set_title () {
2472 info_print $'\e]0;' $'\a' "$@"
2475 function info_print () {
2476 local esc_begin esc_end
2480 printf '%s' ${esc_begin}
2482 printf '%s' "${esc_end}"
2485 function grml_reset_screen_title () {
2486 # adjust title of xterm
2487 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2488 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2491 set_title ${(%):-"%n@%m: %~"}
2496 function grml_vcs_to_screen_title () {
2497 if [[ $TERM == screen* ]] ; then
2498 if [[ -n ${vcs_info_msg_1_} ]] ; then
2499 ESC_print ${vcs_info_msg_1_}
2506 function grml_maintain_name () {
2507 # set hostname if not running on host with name 'grml'
2508 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
2513 function grml_cmd_to_screen_title () {
2514 # get the name of the program currently running and hostname of local
2515 # machine set screen window title if running in a screen
2516 if [[ "$TERM" == screen* ]] ; then
2517 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2522 function grml_control_xterm_title () {
2525 set_title "${(%):-"%n@%m:"}" "$1"
2530 # The following autoload is disabled for now, since this setup includes a
2531 # static version of the ‘add-zsh-hook’ function above. It needs to be
2532 # re-enabled as soon as that static definition is removed again.
2533 #zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2534 if [[ $NOPRECMD -eq 0 ]]; then
2535 add-zsh-hook precmd grml_reset_screen_title
2536 add-zsh-hook precmd grml_vcs_to_screen_title
2537 add-zsh-hook preexec grml_maintain_name
2538 add-zsh-hook preexec grml_cmd_to_screen_title
2539 if [[ $NOTITLE -eq 0 ]]; then
2540 add-zsh-hook preexec grml_control_xterm_title
2544 # 'hash' some often used directories
2546 hash -d deb=/var/cache/apt/archives
2547 hash -d doc=/usr/share/doc
2548 hash -d linux=/lib/modules/$(command uname -r)/build/
2549 hash -d log=/var/log
2550 hash -d slog=/var/log/syslog
2551 hash -d src=/usr/src
2552 hash -d www=/var/www
2556 if check_com -c screen ; then
2557 if [[ $UID -eq 0 ]] ; then
2558 if [[ -r /etc/grml/screenrc ]]; then
2559 alias screen='screen -c /etc/grml/screenrc'
2561 elif [[ ! -r $HOME/.screenrc ]] ; then
2562 if [[ -r /etc/grml/screenrc_grml ]]; then
2563 alias screen='screen -c /etc/grml/screenrc_grml'
2565 if [[ -r /etc/grml/screenrc ]]; then
2566 alias screen='screen -c /etc/grml/screenrc'
2572 # do we have GNU ls with color-support?
2573 if [[ "$TERM" != dumb ]]; then
2574 #a1# List files with colors (\kbd{ls \ldots})
2575 alias ls="command ls ${ls_options:+${ls_options[*]}}"
2576 #a1# List all files, with colors (\kbd{ls -la \ldots})
2577 alias la="command ls -la ${ls_options:+${ls_options[*]}}"
2578 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2579 alias ll="command ls -l ${ls_options:+${ls_options[*]}}"
2580 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2581 alias lh="command ls -hAl ${ls_options:+${ls_options[*]}}"
2582 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -l \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2583 alias l="command ls -l ${ls_options:+${ls_options[*]}}"
2585 alias la='command ls -la'
2586 alias ll='command ls -l'
2587 alias lh='command ls -hAl'
2588 alias l='command ls -l'
2591 if [[ -r /proc/mdstat ]]; then
2592 alias mdstat='cat /proc/mdstat'
2595 alias ...='cd ../../'
2597 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2598 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2599 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2602 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2603 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2604 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2606 # make sure it is not assigned yet
2607 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2608 function utf2iso () {
2611 for ENV in $(env | command grep -i '.utf') ; do
2612 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2617 # make sure it is not assigned yet
2618 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2619 function iso2utf () {
2620 if ! isutfenv ; then
2622 for ENV in $(env | command grep -i '\.iso') ; do
2623 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2628 # especially for roadwarriors using GNU screen and ssh:
2629 if ! check_com asc &>/dev/null ; then
2630 function asc () { autossh -t "$@" 'screen -RdU' }
2634 #f1# Hints for the use of zsh on grml
2635 function zsh-help () {
2636 print "$bg[white]$fg[black]
2637 zsh-help - hints for use of zsh on grml
2638 =======================================$reset_color"
2641 Main configuration of zsh happens in /etc/zsh/zshrc.
2642 That file is part of the package grml-etc-core, if you want to
2643 use them on a non-grml-system just get the tar.gz from
2644 http://deb.grml.org/ or (preferably) get it from the git repository:
2646 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2648 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2649 The file is still there, but it is empty for backwards compatibility.
2651 For your own changes use these two files:
2655 The former is sourced very early in our zshrc, the latter is sourced
2658 System wide configuration without touching configuration files of grml
2659 can take place in /etc/zsh/zshrc.local.
2661 For information regarding zsh start at http://grml.org/zsh/
2663 Take a look at grml'\''s zsh refcard:
2664 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2666 Check out the main zsh refcard:
2667 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2669 And of course visit the zsh-lovers:
2672 You can adjust some options through environment variables when
2673 invoking zsh without having to edit configuration files.
2674 Basically meant for bash users who are not used to the power of
2677 "NOCOR=1 zsh" => deactivate automatic correction
2678 "NOMENU=1 zsh" => do not use auto menu completion
2679 (note: use ctrl-d for completion instead!)
2680 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2681 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2682 preexec() and precmd() completely
2683 "GRML_DISPLAY_BATTERY=1 zsh"
2684 => activate battery status on right side of prompt (WIP)
2685 "COMMAND_NOT_FOUND=1 zsh"
2686 => Enable a handler if an external command was not found
2687 The command called in the handler can be altered by setting
2688 the GRML_ZSH_CNF_HANDLER variable, the default is:
2689 "/usr/share/command-not-found/command-not-found"
2691 A value greater than 0 is enables a feature; a value equal to zero
2692 disables it. If you like one or the other of these settings, you can
2693 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2697 $bg[white]$fg[black]
2698 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2699 Enjoy your grml system with the zsh!$reset_color"
2703 if [[ -r /etc/debian_version ]] ; then
2704 if [[ -z "$GRML_NO_APT_ALIASES" ]]; then
2705 #a3# Execute \kbd{apt-cache policy}
2706 alias acp='apt-cache policy'
2707 if check_com -c apt ; then
2708 #a3# Execute \kbd{apt search}
2709 alias acs='apt search'
2710 #a3# Execute \kbd{apt show}
2711 alias acsh='apt show'
2712 #a3# Execute \kbd{apt dist-upgrade}
2713 salias adg="apt dist-upgrade"
2714 #a3# Execute \kbd{apt upgrade}
2715 salias ag="apt upgrade"
2716 #a3# Execute \kbd{apt install}
2717 salias agi="apt install"
2718 #a3# Execute \kbd{apt update}
2719 salias au="apt update"
2721 alias acs='apt-cache search'
2722 alias acsh='apt-cache show'
2723 salias adg="apt-get dist-upgrade"
2724 salias ag="apt-get upgrade"
2725 salias agi="apt-get install"
2726 salias au="apt-get update"
2728 #a3# Execute \kbd{aptitude install}
2729 salias ati="aptitude install"
2730 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2731 salias -a up="aptitude update ; aptitude safe-upgrade"
2732 #a3# Execute \kbd{dpkg-buildpackage}
2733 alias dbp='dpkg-buildpackage'
2734 #a3# Execute \kbd{grep-excuses}
2735 alias ge='grep-excuses'
2738 # get a root shell as normal user in live-cd mode:
2739 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2745 # use /var/log/syslog iff present, fallback to journalctl otherwise
2746 if [ -e /var/log/syslog ] ; then
2747 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog || journalctl}
2748 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2749 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog || journalctl}
2750 salias tlog="tail -f /var/log/syslog" # follow the syslog
2751 elif check_com -c journalctl ; then
2752 salias llog="journalctl"
2753 salias tlog="journalctl -f"
2756 # sort installed Debian-packages by size
2757 if check_com -c dpkg-query ; then
2758 #a3# List installed Debian-packages sorted by size
2759 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"
2762 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2763 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2764 if check_com -c wodim; then
2765 function cdrecord () {
2767 cdrecord is not provided under its original name by Debian anymore.
2768 See #377109 in the BTS of Debian for more details.
2770 Please use the wodim binary instead
2778 # No core dumps: important for a live-cd-system
2783 function grmlstuff () {
2784 # people should use 'grml-x'!
2785 if check_com -c 915resolution; then
2786 function 855resolution () {
2787 echo "Please use 915resolution as resolution modifying tool for Intel \
2793 #a1# Output version of running grml
2794 alias grml-version='cat /etc/grml_version'
2796 if check_com -c grml-debootstrap ; then
2797 function debian2hd () {
2798 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2804 # now run the functions
2806 is4 && isgrml && grmlstuff
2810 is4 && xsource "/etc/zsh/keephack"
2812 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2813 # You use it as follows:
2814 # $ NTREF=/reference/file
2816 # This lists all the files in the current directory newer than the reference file.
2817 # You can also specify the reference file inline; note quotes:
2818 # $ ls -l *(e:'nt ~/.zshenv':)
2819 is4 && function nt () {
2820 if [[ -n $1 ]] ; then
2823 [[ $REPLY -nt $NTREF ]]
2828 #f1# Reload an autoloadable function
2829 function freload () { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2830 compdef _functions freload
2835 # e.g.: a -> b -> c -> d ....
2840 # if parameter is given with leading '=', lookup $PATH for parameter and resolve that
2844 # Note: limit for recursive symlinks on linux:
2845 # http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/fs/namei.c?id=refs/heads/master#l808
2846 # This limits recursive symlink follows to 8,
2847 # while limiting consecutive symlinks to 40.
2849 # When resolving and displaying information about symlinks, no check is made
2850 # that the displayed information does make any sense on your OS.
2851 # We leave that decission to the user.
2853 # The zstat module is used to detect symlink loops. zstat is available since zsh4.
2854 # With an older zsh you will need to abort with <C-c> in that case.
2855 # When a symlink loop is detected, a warning ist printed and further processing is stopped.
2857 # Module zstat is loaded by default in grml zshrc, no extra action needed for that.
2860 # If you happen to come across a symlink that points to a destination on another partition
2861 # with the same inode number, that will be marked as symlink loop though it is not.
2862 # Two hints for this situation:
2863 # I) Play lottery the same day, as you seem to be rather lucky right now.
2868 # 1 file/dir not accesible
2869 # 2 symlink loop detected
2871 #f1# List symlinks in detail (more detailed version of 'readlink -f', 'whence -s' and 'namei -l')
2873 if [[ -z ${1} ]] ; then
2874 printf 'Usage: %s <symlink(s)>\n' "${0}"
2878 local file jumpd curdir
2879 local -i 10 RTN LINODE i
2884 for file in "${@}" ; do
2886 ls -l "${file:a}" || RTN=1
2888 while [[ -h "$file" ]] ; do
2890 LINODE=$(zstat -L +inode "${file}")
2891 for i in ${SEENINODES} ; do
2892 if (( ${i} == ${LINODE} )) ; then
2893 builtin cd -q "${curdir}"
2894 print 'link loop detected, aborting!'
2898 SEENINODES+=${LINODE}
2903 if [[ -d ${jumpd} ]] ; then
2904 builtin cd -q "${jumpd}" || RTN=1
2906 file=$(readlink "$file")
2911 if [[ -d ${jumpd} ]] ; then
2912 builtin cd -q "${jumpd}" || RTN=1
2915 ls -l "${PWD}/${file}" || RTN=1
2918 if (( ${#} >= 1 )) ; then
2921 builtin cd -q "${curdir}"
2926 # TODO: Is it supported to use pager settings like this?
2927 # PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
2928 # with respect to wordsplitting. (ie. ${=PAGER})
2929 if check_com -c $PAGER ; then
2930 #f3# View Debian's changelog of given package(s)
2931 function dchange () {
2933 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
2936 for package in "$@" ; do
2937 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
2938 $PAGER /usr/share/doc/${package}/changelog.Debian.gz
2939 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
2940 $PAGER /usr/share/doc/${package}/changelog.gz
2941 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
2942 $PAGER /usr/share/doc/${package}/changelog
2944 if check_com -c aptitude ; then
2945 echo "No changelog for package $package found, using aptitude to retrieve it."
2946 aptitude changelog "$package"
2947 elif check_com -c apt-get ; then
2948 echo "No changelog for package $package found, using apt-get to retrieve it."
2949 apt-get changelog "$package"
2951 echo "No changelog for package $package found, sorry."
2956 function _dchange () { _files -W /usr/share/doc -/ }
2957 compdef _dchange dchange
2959 #f3# View Debian's NEWS of a given package
2962 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
2963 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
2965 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
2966 $PAGER /usr/share/doc/$1/NEWS.gz
2968 echo "No NEWS file for package $1 found, sorry."
2973 function _dnews () { _files -W /usr/share/doc -/ }
2974 compdef _dnews dnews
2976 #f3# View Debian's copyright of a given package
2977 function dcopyright () {
2979 if [[ -r /usr/share/doc/$1/copyright ]] ; then
2980 $PAGER /usr/share/doc/$1/copyright
2982 echo "No copyright file for package $1 found, sorry."
2986 function _dcopyright () { _files -W /usr/share/doc -/ }
2987 compdef _dcopyright dcopyright
2989 #f3# View upstream's changelog of a given package
2990 function uchange () {
2992 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2993 $PAGER /usr/share/doc/$1/changelog.gz
2995 echo "No changelog for package $1 found, sorry."
2999 function _uchange () { _files -W /usr/share/doc -/ }
3000 compdef _uchange uchange
3004 function profile () {
3005 ZSH_PROFILE_RC=1 zsh "$@"
3008 #f1# Edit an alias via zle
3009 function edalias () {
3010 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
3012 compdef _aliases edalias
3014 #f1# Edit a function via zle
3015 function edfunc () {
3016 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
3018 compdef _functions edfunc
3020 # use it e.g. via 'Restart apache2'
3021 #m# f6 Start() \kbd{service \em{process}}\quad\kbd{start}
3022 #m# f6 Restart() \kbd{service \em{process}}\quad\kbd{restart}
3023 #m# f6 Stop() \kbd{service \em{process}}\quad\kbd{stop}
3024 #m# f6 Reload() \kbd{service \em{process}}\quad\kbd{reload}
3025 #m# f6 Force-Reload() \kbd{service \em{process}}\quad\kbd{force-reload}
3026 #m# f6 Status() \kbd{service \em{process}}\quad\kbd{status}
3027 if [[ -d /etc/init.d || -d /etc/service ]] ; then
3028 function __start_stop () {
3029 local action_="${1:l}" # e.g Start/Stop/Restart
3033 local service_target_="$(readlink /etc/init.d/$service_)"
3034 if [[ $service_target_ == "/usr/bin/sv" ]]; then
3036 case "${action_}" in
3037 start) if [[ ! -e /etc/service/$service_ ]]; then
3038 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
3040 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
3042 # there is no reload in runits sysv emulation
3043 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
3044 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
3047 # sysv/sysvinit-utils, upstart
3048 if check_com -c service ; then
3049 $SUDO service "$service_" "${action_}" "$param_"
3051 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
3056 function _grmlinitd () {
3058 scripts=( /etc/init.d/*(x:t) )
3059 _describe "service startup script" scripts
3062 for i in Start Restart Stop Force-Reload Reload Status ; do
3063 eval "function $i () { __start_stop $i \"\$1\" \"\$2\" ; }"
3064 compdef _grmlinitd $i
3069 #f1# Provides useful information on globbing
3070 function H-Glob () {
3076 p named pipes (FIFOs)
3077 * executable plain files (0100)
3078 % device files (character or block special)
3079 %b block special files
3080 %c character special files
3081 r owner-readable files (0400)
3082 w owner-writable files (0200)
3083 x owner-executable files (0100)
3084 A group-readable files (0040)
3085 I group-writable files (0020)
3086 E group-executable files (0010)
3087 R world-readable files (0004)
3088 W world-writable files (0002)
3089 X world-executable files (0001)
3090 s setuid files (04000)
3091 S setgid files (02000)
3092 t files with the sticky bit (01000)
3094 print *(m-1) # Files modified up to a day ago
3095 print *(a1) # Files accessed a day ago
3096 print *(@) # Just symlinks
3097 print *(Lk+50) # Files bigger than 50 kilobytes
3098 print *(Lk-50) # Files smaller than 50 kilobytes
3099 print **/*.c # All *.c files recursively starting in \$PWD
3100 print **/*.c~file.c # Same as above, but excluding 'file.c'
3101 print (foo|bar).* # Files starting with 'foo' or 'bar'
3102 print *~*.* # All Files that do not contain a dot
3103 chmod 644 *(.^x) # make all plain non-executable files publically readable
3104 print -l *(.c|.h) # Lists *.c and *.h
3105 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
3106 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
3108 alias help-zshglob=H-Glob
3110 # grep for running process, like: 'any vim'
3114 if [[ -z "$1" ]] ; then
3115 echo "any - grep for process(es) by keyword" >&2
3116 echo "Usage: any <keyword>" >&2 ; return 1
3118 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
3123 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
3124 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
3125 [[ -r /proc/1/maps ]] && \
3126 function deswap () {
3127 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
3128 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
3129 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
3132 # a wrapper for vim, that deals with title setting
3134 # set this array to a set of options to vim you always want
3135 # to have set when calling vim (in .zshrc.local), like:
3136 # VIM_OPTIONS=( -p )
3137 # This will cause vim to send every file given on the
3138 # commandline to be send to it's own tab (needs vim7).
3139 if check_com vim; then
3141 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
3145 ssl_hashes=( sha512 sha256 sha1 md5 )
3147 for sh in ${ssl_hashes}; do
3148 eval 'ssl-cert-'${sh}'() {
3150 if [[ -z $1 ]] ; then
3151 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
3154 openssl x509 -noout -fingerprint -'${sh}' -in $1
3158 function ssl-cert-fingerprints () {
3161 if [[ -z $1 ]] ; then
3162 printf 'usage: ssl-cert-fingerprints <file>\n'
3165 for i in ${ssl_hashes}
3170 function ssl-cert-info () {
3172 if [[ -z $1 ]] ; then
3173 printf 'usage: ssl-cert-info <file>\n'
3176 openssl x509 -noout -text -in $1
3177 ssl-cert-fingerprints $1
3180 # make sure our environment is clean regarding colors
3181 builtin unset -v BLUE RED GREEN CYAN YELLOW MAGENTA WHITE NO_COLOR
3183 # "persistent history"
3184 # just write important commands you always need to $GRML_IMPORTANT_COMMANDS
3185 # defaults for backward compatibility to ~/.important_commands
3186 if [[ -r ~/.important_commands ]] ; then
3187 GRML_IMPORTANT_COMMANDS=~/.important_commands
3189 GRML_IMPORTANT_COMMANDS=${GRML_IMPORTANT_COMMANDS:-${ZDOTDIR:-${HOME}}/.important_commands}
3191 [[ -r ${GRML_IMPORTANT_COMMANDS} ]] && builtin fc -R ${GRML_IMPORTANT_COMMANDS}
3193 # load the lookup subsystem if it's available on the system
3194 zrcautoload lookupinit && lookupinit
3198 # set terminal property (used e.g. by msgid-chooser)
3199 export COLORTERM="yes"
3204 #a2# Execute \kbd{du -sch}
3205 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias da='du -sch'
3208 #a2# Execute \kbd{ls -lSrah}
3209 alias dir="command ls -lSrah"
3210 #a2# Only show dot-directories
3211 alias lad='command ls -d .*(/)'
3212 #a2# Only show dot-files
3213 alias lsa='command ls -a .*(.)'
3214 #a2# Only files with setgid/setuid/sticky flag
3215 alias lss='command ls -l *(s,S,t)'
3216 #a2# Only show symlinks
3217 alias lsl='command ls -l *(@)'
3218 #a2# Display only executables
3219 alias lsx='command ls -l *(*)'
3220 #a2# Display world-{readable,writable,executable} files
3221 alias lsw='command ls -ld *(R,W,X.^ND/)'
3222 #a2# Display the ten biggest files
3223 alias lsbig="command ls -flh *(.OL[1,10])"
3224 #a2# Only show directories
3225 alias lsd='command ls -d *(/)'
3226 #a2# Only show empty directories
3227 alias lse='command ls -d *(/^F)'
3228 #a2# Display the ten newest files
3229 alias lsnew="command ls -rtlh *(D.om[1,10])"
3230 #a2# Display the ten oldest files
3231 alias lsold="command ls -rtlh *(D.Om[1,10])"
3232 #a2# Display the ten smallest files
3233 alias lssmall="command ls -Srl *(.oL[1,10])"
3234 #a2# Display the ten newest directories and ten newest .directories
3235 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
3236 #a2# Display the ten oldest directories and ten oldest .directories
3237 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
3239 # some useful aliases
3240 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
3241 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
3243 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3244 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3245 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3246 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3248 # work around non utf8 capable software in utf environment via $LANG and luit
3249 if check_com isutfenv && check_com luit ; then
3250 if check_com -c mrxvt ; then
3251 isutfenv && [[ -n "$LANG" ]] && \
3252 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3255 if check_com -c aterm ; then
3256 isutfenv && [[ -n "$LANG" ]] && \
3257 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3260 if check_com -c centericq ; then
3261 isutfenv && [[ -n "$LANG" ]] && \
3262 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3268 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3271 local current_date=$(date -u "+%Y%m%dT%H%M%SZ")
3272 local clean keep move verbose result all to_bk
3273 setopt extended_glob
3275 while getopts ":hacmrv" opt; do
3278 c) unset move clean && (( ++keep ));;
3279 m) unset keep clean && (( ++move ));;
3280 r) unset move keep && (( ++clean ));;
3283 bk [-hcmv] FILE [FILE ...]
3284 bk -r [-av] [FILE [FILE ...]]
3285 Backup a file or folder in place and append the timestamp
3286 Remove backups of a file or folder, or all backups in the current directory
3289 -h Display this help text
3290 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3291 -m Move the file/folder, using mv(1)
3292 -r Remove backups of the specified file or directory, using rm(1). If none
3293 is provided, remove all backups in the current directory.
3294 -a Remove all (even hidden) backups.
3297 The -c, -r and -m options are mutually exclusive. If specified at the same time,
3298 the last one is used.
3300 The return code is the sum of all cp/mv/rm return codes.
3303 \?) bk -h >&2; return 1;;
3306 shift "$((OPTIND-1))"
3307 if (( keep > 0 )); then
3308 if islinux || isfreebsd; then
3309 for to_bk in "$@"; do
3310 cp $verbose -a "${to_bk%/}" "${to_bk%/}_$current_date"
3314 for to_bk in "$@"; do
3315 cp $verbose -pR "${to_bk%/}" "${to_bk%/}_$current_date"
3319 elif (( move > 0 )); then
3320 while (( $# > 0 )); do
3321 mv $verbose "${1%/}" "${1%/}_$current_date"
3325 elif (( clean > 0 )); then
3326 if (( $# > 0 )); then
3327 for to_bk in "$@"; do
3328 rm $verbose -rf "${to_bk%/}"_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z
3332 if (( all > 0 )); then
3333 rm $verbose -rf *_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z(D)
3335 rm $verbose -rf *_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z
3343 #f5# cd to directory and list files
3349 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3351 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3352 [[ ! -e ${1:h} ]] && return 1
3353 print "Correcting ${1} to ${1:h}"
3360 #f5# Create Directory and \kbd{cd} to it
3362 if (( ARGC != 1 )); then
3363 printf 'usage: mkcd <new-directory>\n'
3366 if [[ ! -d "$1" ]]; then
3367 command mkdir -p "$1"
3369 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3374 #f5# Create temporary directory and \kbd{cd} to it
3376 builtin cd "$(mktemp -d)"
3380 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3381 function accessed () {
3383 print -l -- *(a-${1:-1})
3386 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3387 function changed () {
3389 print -l -- *(c-${1:-1})
3392 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3393 function modified () {
3395 print -l -- *(m-${1:-1})
3397 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3398 check_com new || alias new=modified
3400 # use colors when GNU grep with color-support
3401 if (( $#grep_options > 0 )); then
3402 o=${grep_options:+"${grep_options[*]}"}
3403 #a2# Execute \kbd{grep -{}-color=auto}
3404 alias grep='grep '$o
3405 alias egrep='egrep '$o
3410 # 'translate' looks up a word in a file with language-to-language
3411 # translations (field separator should be " : "). A typical wordlist looks
3412 # like the following:
3413 # | english-word : german-translation
3414 # It's also only possible to translate english to german but not reciprocal.
3415 # Use the following oneliner to reverse the sort order:
3416 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3417 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3418 #f5# Translates a word
3423 translate -l de-en $2
3426 translate -l en-de $2
3429 echo "Usage: $0 { -D | -E }"
3430 echo " -D == German to English"
3431 echo " -E == English to German"
3435 # Usage: simple-extract <file>
3436 # Using option -d deletes the original archive file.
3437 #f5# Smart archive extractor
3438 function simple-extract () {
3440 setopt extended_glob noclobber
3441 local ARCHIVE DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3443 zparseopts -D -E "d=DELETE_ORIGINAL"
3444 for ARCHIVE in "${@}"; do
3446 *(tar.bz2|tbz2|tbz))
3447 DECOMP_CMD="tar -xvjf -"
3452 DECOMP_CMD="tar -xvzf -"
3456 *(tar.xz|txz|tar.lzma))
3457 DECOMP_CMD="tar -xvJf -"
3462 DECOMP_CMD="tar -xvf -"
3467 DECOMP_CMD="unrar x"
3492 DECOMP_CMD="bzip2 -d -c -"
3497 DECOMP_CMD="gzip -d -c -"
3502 DECOMP_CMD="xz -d -c -"
3507 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3513 if ! check_com ${DECOMP_CMD[(w)1]}; then
3514 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3519 GZTARGET="${ARCHIVE:t:r}"
3520 if [[ -f $ARCHIVE ]] ; then
3522 print "Extracting '$ARCHIVE' ..."
3523 if $USES_STDIN; then
3524 if $USES_STDOUT; then
3525 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3527 ${=DECOMP_CMD} < "$ARCHIVE"
3530 if $USES_STDOUT; then
3531 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3533 ${=DECOMP_CMD} "$ARCHIVE"
3536 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3538 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3539 if check_com curl; then
3540 WGET_CMD="curl -L -s -o -"
3541 elif check_com wget; then
3542 WGET_CMD="wget -q -O -"
3543 elif check_com fetch; then
3544 WGET_CMD="fetch -q -o -"
3546 print "ERROR: neither wget, curl nor fetch is installed" >&2
3550 print "Downloading and Extracting '$ARCHIVE' ..."
3551 if $USES_STDIN; then
3552 if $USES_STDOUT; then
3553 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3556 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3560 if $USES_STDOUT; then
3561 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3563 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3568 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3575 function __archive_or_uri () {
3577 '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)"' \
3578 '_urls:Remote Archives:_urls'
3581 function _simple_extract () {
3583 '-d[delete original archivefile after extraction]' \
3584 '*:Archive Or Uri:__archive_or_uri'
3586 compdef _simple_extract simple-extract
3587 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias se=simple-extract
3589 #f5# Change the xterm title from within GNU-screen
3590 function xtrename () {
3592 if [[ $1 != "-f" ]] ; then
3593 if [[ -z ${DISPLAY} ]] ; then
3594 printf 'xtrename only makes sense in X11.\n'
3600 if [[ -z $1 ]] ; then
3601 printf 'usage: xtrename [-f] "title for xterm"\n'
3602 printf ' renames the title of xterm from _within_ screen.\n'
3603 printf ' also works without screen.\n'
3604 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3607 print -n "\eP\e]0;${1}\C-G\e\\"
3611 # Create small urls via http://goo.gl using curl(1).
3612 # API reference: https://code.google.com/apis/urlshortener/
3615 setopt extended_glob
3617 if [[ -z $1 ]]; then
3618 print "USAGE: zurl <URL>"
3622 local PN url prog api json contenttype item
3627 # Prepend 'http://' to given URL where necessary for later output.
3628 if [[ ${url} != http(s|)://* ]]; then
3632 if check_com -c curl; then
3635 print "curl is not available, but mandatory for ${PN}. Aborting."
3638 api='https://www.googleapis.com/urlshortener/v1/url'
3639 contenttype="Content-Type: application/json"
3640 json="{\"longUrl\": \"${url}\"}"
3641 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3642 # Parse the response
3643 for item in "${data[@]}"; do
3648 printf '%s\n' "$item"
3656 #f2# Find history events by search pattern and list them by date.
3657 function whatwhen () {
3659 local usage help ident format_l format_s first_char remain first last
3660 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3661 help='Use `whatwhen -h'\'' for further explanations.'
3662 ident=${(l,${#${:-Usage: }},, ,)}
3663 format_l="${ident}%s\t\t\t%s\n"
3664 format_s="${format_l//(\\t)##/\\t}"
3665 # Make the first char of the word to search for case
3666 # insensitive; e.g. [aA]
3667 first_char=[${(L)1[1]}${(U)1[1]}]
3669 # Default search range is `-100'.
3671 # Optional, just used for `<first> <last>' given.
3675 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3676 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3679 printf '%s\n\n' ${usage}
3681 printf $format_l '-h' 'show help text'
3683 print 'SEARCH RANGE:'
3684 printf $format_l "'0'" 'the whole history,'
3685 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3686 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3687 printf '\n%s\n' 'EXAMPLES:'
3688 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3689 printf $format_l 'whatwhen zsh -250'
3690 printf $format_l 'whatwhen foo 1 99'
3693 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3696 # -l list results on stout rather than invoking $EDITOR.
3697 # -i Print dates as in YYYY-MM-DD.
3698 # -m Search for a - quoted - pattern within the history.
3699 fc -li -m "*${first_char}${remain}*" $first $last
3704 # mercurial related stuff
3705 if check_com -c hg ; then
3706 # gnu like diff for mercurial
3707 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3708 #f5# GNU like diff for mercurial
3712 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3715 # build debian package
3716 #a2# Alias for \kbd{hg-buildpackage}
3717 alias hbp='hg-buildpackage'
3719 # execute commands on the versioned patch-queue from the current repos
3720 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3722 # diffstat for specific version of a mercurial repository
3723 # hgstat => display diffstat between last revision and tip
3724 # hgstat 1234 => display diffstat between revision 1234 and tip
3725 #f5# Diffstat for specific version of a mercurial repos
3726 function hgstat () {
3728 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3731 fi # end of check whether we have the 'hg'-executable
3733 # grml-small cleanups
3735 # The following is used to remove zsh-config-items that do not work
3736 # in grml-small by default.
3737 # If you do not want these adjustments (for whatever reason), set
3738 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3739 # sources if it is there).
3741 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3744 unalias 'V' &> /dev/null
3745 unfunction vman &> /dev/null
3746 unfunction viless &> /dev/null
3747 unfunction 2html &> /dev/null
3749 # manpages are not in grmlsmall
3750 unfunction manzsh &> /dev/null
3751 unfunction man2 &> /dev/null
3757 ## genrefcard.pl settings
3759 ### doc strings for external functions from files
3760 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3762 ### example: split functions-search 8,16,24,32
3763 #@# split functions-search 8
3765 ## END OF FILE #################################################################
3766 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4