1 # Filename: /etc/zsh/zshrc
2 # Purpose: config file for zsh (z shell)
3 # Authors: grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
4 # Bug-Reports: see http://grml.org/bugs/
5 # License: This file is licensed under the GPL v2.
6 ################################################################################
7 # This file is sourced only for interactive shells. It
8 # should contain commands to set up aliases, functions,
9 # options, key bindings, etc.
11 # Global Order: zshenv, zprofile, zshrc, zlogin
12 ################################################################################
15 # If you are using this file as your ~/.zshrc file, please use ~/.zshrc.pre
16 # and ~/.zshrc.local for your own customisations. The former file is read
17 # before ~/.zshrc, the latter is read after it. Also, consider reading the
18 # refcard and the reference manual for this setup, both available from:
19 # <http://grml.org/zsh/>
22 # If you want to help to improve grml's zsh setup, clone the grml-etc-core
23 # repository from git.grml.org:
24 # git clone git://git.grml.org/grml-etc-core.git
26 # Make your changes, commit them; use 'git format-patch' to create a series
27 # of patches and send those to the following address via 'git send-email':
28 # grml-etc-core@grml.org
30 # Doing so makes sure the right people get your patches for review and
33 # zsh-refcard-tag documentation:
34 # You may notice strange looking comments in this file.
35 # These are there for a purpose. grml's zsh-refcard can now be
36 # automatically generated from the contents of the actual configuration
37 # file. However, we need a little extra information on which comments
38 # and what lines of code to take into account (and for what purpose).
40 # Here is what they mean:
42 # List of tags (comment types) used:
43 # #a# Next line contains an important alias, that should
44 # be included in the grml-zsh-refcard.
45 # (placement tag: @@INSERT-aliases@@)
46 # #f# Next line contains the beginning of an important function.
47 # (placement tag: @@INSERT-functions@@)
48 # #v# Next line contains an important variable.
49 # (placement tag: @@INSERT-variables@@)
50 # #k# Next line contains an important keybinding.
51 # (placement tag: @@INSERT-keybindings@@)
52 # #d# Hashed directories list generation:
53 # start denotes the start of a list of 'hash -d'
55 # end denotes its end.
56 # (placement tag: @@INSERT-hasheddirs@@)
57 # #A# Abbreviation expansion list generation:
58 # start denotes the beginning of abbreviations.
59 # end denotes their end.
60 # Lines within this section that end in '#d .*' provide
61 # extra documentation to be included in the refcard.
62 # (placement tag: @@INSERT-abbrev@@)
63 # #m# This tag allows you to manually generate refcard entries
64 # for code lines that are hard/impossible to parse.
66 # #m# k ESC-h Call the run-help function
67 # That would add a refcard entry in the keybindings table
68 # for 'ESC-h' with the given comment.
69 # So the syntax is: #m# <section> <argument> <comment>
70 # #o# This tag lets you insert entries to the 'other' hash.
71 # Generally, this should not be used. It is there for
72 # things that cannot be done easily in another way.
73 # (placement tag: @@INSERT-other-foobar@@)
75 # All of these tags (except for m and o) take two arguments, the first
76 # within the tag, the other after the tag:
78 # #<tag><section># <comment>
80 # Where <section> is really just a number, which are defined by the
81 # @secmap array on top of 'genrefcard.pl'. The reason for numbers
82 # instead of names is, that for the reader, the tag should not differ
83 # much from a regular comment. For zsh, it is a regular comment indeed.
84 # The numbers have got the following meanings:
93 # So, the following will add an entry to the 'functions' table in the
94 # 'system' section, with a (hopefully) descriptive comment:
95 # #f1# Edit an alias via zle
98 # It will then show up in the @@INSERT-aliases-system@@ replacement tag
99 # that can be found in 'grml-zsh-refcard.tex.in'.
100 # If the section number is omitted, the 'default' section is assumed.
101 # Furthermore, in 'grml-zsh-refcard.tex.in' @@INSERT-aliases@@ is
102 # exactly the same as @@INSERT-aliases-default@@. If you want a list of
103 # *all* aliases, for example, use @@INSERT-aliases-all@@.
106 # just execute 'ZSH_PROFILE_RC=1 zsh' and run 'zprof' to get the details
107 if [[ $ZSH_PROFILE_RC -gt 0 ]] ; then
111 # load .zshrc.pre to give the user the chance to overwrite the defaults
112 [[ -r ${ZDOTDIR:-${HOME}}/.zshrc.pre ]] && source ${ZDOTDIR:-${HOME}}/.zshrc.pre
114 # check for version/system
115 # check for versions (compatibility reasons)
117 [[ $ZSH_VERSION == <4->* ]] && return 0
122 [[ $ZSH_VERSION == 4.<1->* || $ZSH_VERSION == <5->* ]] && return 0
127 [[ $ZSH_VERSION == 4.<2->* || $ZSH_VERSION == <5->* ]] && return 0
132 [[ $ZSH_VERSION == 4.2.<5->* || $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
137 [[ $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
142 [[ $ZSH_VERSION == 4.3.<3->* || $ZSH_VERSION == 4.<4->* \
143 || $ZSH_VERSION == <5->* ]] && return 0
148 [[ $ZSH_VERSION == 4.3.<7->* || $ZSH_VERSION == 4.<4->* \
149 || $ZSH_VERSION == <5->* ]] && return 0
154 [[ $ZSH_VERSION == 4.3.<9->* || $ZSH_VERSION == 4.<4->* \
155 || $ZSH_VERSION == <5->* ]] && return 0
159 #f1# Checks whether or not you're running grml
161 [[ -f /etc/grml_version ]] && return 0
165 #f1# Checks whether or not you're running a grml cd
167 [[ -f /etc/grml_cd ]] && return 0
172 #f1# Checks whether or not you're running grml-small
174 if [[ ${${${(f)"$(</etc/grml_version)"}%% *}##*-} == 'small' ]]; then
180 isgrmlsmall() { return 1 }
183 GRML_OSTYPE=$(uname -s)
186 [[ $GRML_OSTYPE == "Linux" ]]
190 [[ $GRML_OSTYPE == "Darwin" ]]
194 [[ $GRML_OSTYPE == "FreeBSD" ]]
198 [[ $GRML_OSTYPE == "OpenBSD" ]]
201 #f1# are we running within an utf environment?
203 case "$LANG $CHARSET $LANGUAGE" in
210 # check for user, if not running as root set $SUDO to sudo
211 (( EUID != 0 )) && SUDO='sudo' || SUDO=''
213 # change directory to home on first invocation of zsh
214 # important for rungetty -> autologin
215 # Thanks go to Bart Schaefer!
216 isgrml && checkhome() {
217 if [[ -z "$ALREADY_DID_CD_HOME" ]] ; then
218 export ALREADY_DID_CD_HOME=$HOME
223 # check for zsh v3.1.7+
225 if ! [[ ${ZSH_VERSION} == 3.1.<7->* \
226 || ${ZSH_VERSION} == 3.<2->.<->* \
227 || ${ZSH_VERSION} == <4->.<->* ]] ; then
230 printf '-!- In this configuration we try to make use of features, that only\n'
231 printf '-!- require version 3.1.7 of the shell; That way this setup can be\n'
232 printf '-!- used with a wide range of zsh versions, while using fairly\n'
233 printf '-!- advanced features in all supported versions.\n'
235 printf '-!- However, you are running zsh version %s.\n' "$ZSH_VERSION"
237 printf '-!- While this *may* work, it might as well fail.\n'
238 printf '-!- Please consider updating to at least version 3.1.7 of zsh.\n'
240 printf '-!- DO NOT EXPECT THIS TO WORK FLAWLESSLY!\n'
241 printf '-!- If it does today, you'\''ve been lucky.\n'
243 printf '-!- Ye been warned!\n'
246 function zstyle() { : }
249 # autoload wrapper - use this one instead of autoload directly
250 # We need to define this function as early as this, because autoloading
251 # 'is-at-least()' needs it.
252 function zrcautoload() {
260 for fdir in ${fpath} ; do
261 [[ -e ${fdir}/${ffile} ]] && (( ffound = 1 ))
264 (( ffound == 0 )) && return 1
265 if [[ $ZSH_VERSION == 3.1.<6-> || $ZSH_VERSION == <4->* ]] ; then
266 autoload -U ${ffile} || return 1
268 autoload ${ffile} || return 1
273 # Load is-at-least() for more precise version checks Note that this test will
274 # *always* fail, if the is-at-least function could not be marked for
276 zrcautoload is-at-least || is-at-least() { return 1 }
278 # set some important options (as early as possible)
280 # append history list to the history file; this is the default but we make sure
281 # because it's required for share_history.
282 setopt append_history
284 # import new commands from the history file also in other zsh-session
285 is4 && setopt share_history
287 # save each command's beginning timestamp and the duration to the history file
288 setopt extended_history
290 # If a new command line being added to the history list duplicates an older
291 # one, the older command is removed from the list
292 is4 && setopt histignorealldups
294 # remove command lines from the history list when the first character on the
296 setopt histignorespace
298 # if a command is issued that can't be executed as a normal command, and the
299 # command is the name of a directory, perform the cd command to that directory.
302 # in order to use #, ~ and ^ for filename generation grep word
303 # *~(*.gz|*.bz|*.bz2|*.zip|*.Z) -> searches for word not in compressed files
304 # don't forget to quote '^', '~' and '#'!
307 # display PID when suspending processes as well
310 # try to avoid the 'zsh: no matches found...'
313 # report the status of backgrounds jobs immediately
316 # whenever a command completion is attempted, make sure the entire command path
320 # not just at the end
321 setopt completeinword
323 # Don't send SIGHUP to background processes when the shell exits.
326 # make cd push the old directory onto the directory stack.
332 # don't push the same dir twice.
333 setopt pushd_ignore_dups
335 # * shouldn't match dotfiles. ever.
338 # use zsh style word splitting
341 # don't error out when unset parameters are used
344 # setting some default values
347 NOPRECMD=${NOPRECMD:-0}
348 COMMAND_NOT_FOUND=${COMMAND_NOT_FOUND:-0}
349 GRML_ZSH_CNF_HANDLER=${GRML_ZSH_CNF_HANDLER:-/usr/share/command-not-found/command-not-found}
350 GRML_DISPLAY_BATTERY=${GRML_DISPLAY_BATTERY:-${BATTERY:-0}}
351 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
352 ZSH_NO_DEFAULT_LOCALE=${ZSH_NO_DEFAULT_LOCALE:-0}
354 typeset -ga ls_options
355 typeset -ga grep_options
356 if ls --color=auto / >/dev/null 2>&1; then
357 ls_options=( --color=auto )
358 elif ls -G / >/dev/null 2>&1; then
361 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
362 grep_options=( --color=auto )
366 # this function checks if a command exists and returns either true
367 # or false. This avoids using 'which' and 'whence', which will
368 # avoid problems with aliases for which on certain weird systems. :-)
369 # Usage: check_com [-c|-g] word
370 # -c only checks for external commands
371 # -g does the usual tests and also checks for global aliases
374 local -i comonly gatoo
376 if [[ $1 == '-c' ]] ; then
379 elif [[ $1 == '-g' ]] ; then
386 if (( ${#argv} != 1 )) ; then
387 printf 'usage: check_com [-c] <command>\n' >&2
391 if (( comonly > 0 )) ; then
392 [[ -n ${commands[$1]} ]] && return 0
396 if [[ -n ${commands[$1]} ]] \
397 || [[ -n ${functions[$1]} ]] \
398 || [[ -n ${aliases[$1]} ]] \
399 || [[ -n ${reswords[(r)$1]} ]] ; then
404 if (( gatoo > 0 )) && [[ -n ${galiases[$1]} ]] ; then
411 # creates an alias and precedes the command with
412 # sudo if $EUID is not zero.
415 local only=0 ; local multi=0
417 while [[ $1 == -* ]] ; do
421 (--) shift ; break ;;
423 printf 'usage: salias [-h|-o|-a] <alias-expression>\n'
424 printf ' -h shows this help text.\n'
425 printf ' -a replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
426 printf ' be careful using this option.\n'
427 printf ' -o only sets an alias if a preceding sudo would be needed.\n'
430 (*) printf "unkown option: '%s'\n" "$1" ; return 1 ;;
435 if (( ${#argv} > 1 )) ; then
436 printf 'Too many arguments %s\n' "${#argv}"
440 key="${1%%\=*}" ; val="${1#*\=}"
441 if (( EUID == 0 )) && (( only == 0 )); then
442 alias -- "${key}=${val}"
443 elif (( EUID > 0 )) ; then
444 (( multi > 0 )) && val="${val// ; / ; sudo }"
445 alias -- "${key}=sudo ${val}"
451 # a "print -l ${(u)foo}"-workaround for pre-4.2.0 shells
453 # Where foo is the *name* of the parameter you want printed.
454 # Note that foo is no typo; $foo would be wrong here!
462 if [[ -z ${parameter} ]] ; then
463 printf 'usage: uprint <parameter>\n'
467 for w in ${(P)parameter} ; do
468 [[ -z ${(M)u:#$w} ]] && u=( $u $w )
475 # Check if we can read given files and source those we can.
477 if (( ${#argv} < 1 )) ; then
478 printf 'usage: xsource FILE(s)...\n' >&2
482 while (( ${#argv} > 0 )) ; do
483 [[ -r "$1" ]] && source "$1"
489 # Check if we can read a given file and 'cat(1)' it.
492 if (( ${#argv} != 1 )) ; then
493 printf 'usage: xcat FILE\n' >&2
497 [[ -r $1 ]] && cat $1
501 # Remove these functions again, they are of use only in these
502 # setup files. This should be called at the end of .zshrc.
506 funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
507 for func in $funcs ; do
508 [[ -n ${functions[$func]} ]] \
514 # this allows us to stay in sync with grml's zshrc and put own
515 # modifications in ~/.zshrc.local
517 xsource "/etc/zsh/zshrc.local"
518 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
523 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
524 xsource "/etc/default/locale"
527 for var in LANG LC_ALL LC_MESSAGES ; do
528 [[ -n ${(P)var} ]] && export $var
532 if check_com -c vim ; then
534 export EDITOR=${EDITOR:-vim}
536 export EDITOR=${EDITOR:-vi}
540 export PAGER=${PAGER:-less}
543 export MAIL=${MAIL:-/var/mail/$USER}
545 # if we don't set $SHELL then aterm, rxvt,.. will use /bin/sh or /bin/bash :-/
546 if [[ -z "$SHELL" ]] ; then
548 if [[ -x "$SHELL" ]] ; then
553 # color setup for ls:
554 check_com -c dircolors && eval $(dircolors -b)
555 # color setup for ls on OS X / FreeBSD:
556 isdarwin && export CLICOLOR=1
557 isfreebsd && export CLICOLOR=1
559 # do MacPorts setup on darwin
560 if isdarwin && [[ -d /opt/local ]]; then
561 # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
563 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
564 MANPATH="/opt/local/share/man:$MANPATH"
566 # do Fink setup on darwin
567 isdarwin && xsource /sw/bin/init.sh
569 # load our function and completion directories
570 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
571 fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
572 if [[ ${fdir} == '/usr/share/grml/zsh/functions' ]] ; then
573 for func in ${fdir}/**/[^_]*[^~](N.) ; do
574 zrcautoload ${func:t}
580 # support colors in less
581 export LESS_TERMCAP_mb=$'\E[01;31m'
582 export LESS_TERMCAP_md=$'\E[01;31m'
583 export LESS_TERMCAP_me=$'\E[0m'
584 export LESS_TERMCAP_se=$'\E[0m'
585 export LESS_TERMCAP_so=$'\E[01;44;33m'
586 export LESS_TERMCAP_ue=$'\E[0m'
587 export LESS_TERMCAP_us=$'\E[01;32m'
592 # report about cpu-/system-/user-time of command if running longer than
596 # watch for everyone but me and root
599 # automatically remove duplicates from these arrays
600 typeset -U path cdpath fpath manpath
604 for mod in parameter complist deltochar mathfunc ; do
605 zmodload -i zsh/${mod} 2>/dev/null || print "Notice: no ${mod} available :("
608 # autoload zsh modules when they are referenced
610 zmodload -a zsh/stat zstat
611 zmodload -a zsh/zpty zpty
612 zmodload -ap zsh/mapfile mapfile
616 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
617 if zrcautoload compinit ; then
618 compinit -d ${COMPDUMPFILE} || print 'Notice: no compinit available :('
620 print 'Notice: no compinit available :('
626 # called later (via is4 && grmlcomp)
627 # note: use 'zstyle' for getting current settings
628 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
630 # TODO: This could use some additional information
632 # Make sure the completion system is initialised
633 (( ${+_comps} )) || return 1
635 # allow one error for every three characters typed in approximate completer
636 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
638 # don't complete backup files as executables
639 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
641 # start menu completion only if it could find no unambiguous initial string
642 zstyle ':completion:*:correct:*' insert-unambiguous true
643 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
644 zstyle ':completion:*:correct:*' original true
646 # activate color-completion
647 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
649 # format on completion
650 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
652 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
653 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
655 # insert all expansions for expand completer
656 zstyle ':completion:*:expand:*' tag-order all-expansions
657 zstyle ':completion:*:history-words' list false
660 zstyle ':completion:*:history-words' menu yes
662 # ignore duplicate entries
663 zstyle ':completion:*:history-words' remove-all-dups yes
664 zstyle ':completion:*:history-words' stop yes
666 # match uppercase from lowercase
667 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
669 # separate matches into groups
670 zstyle ':completion:*:matches' group 'yes'
671 zstyle ':completion:*' group-name ''
673 if [[ "$NOMENU" -eq 0 ]] ; then
674 # if there are more than 5 options allow selecting from a menu
675 zstyle ':completion:*' menu select=5
677 # don't use any menus at all
681 zstyle ':completion:*:messages' format '%d'
682 zstyle ':completion:*:options' auto-description '%d'
684 # describe options in full
685 zstyle ':completion:*:options' description 'yes'
687 # on processes completion complete all user processes
688 zstyle ':completion:*:processes' command 'ps -au$USER'
690 # offer indexes before parameters in subscripts
691 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
693 # provide verbose completion information
694 zstyle ':completion:*' verbose true
696 # recent (as of Dec 2007) zsh versions are able to provide descriptions
697 # for commands (read: 1st word in the line) that it will list for the user
698 # to choose from. The following disables that, because it's not exactly fast.
699 zstyle ':completion:*:-command-:*:' verbose false
701 # set format for warnings
702 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
704 # define files to ignore for zcompile
705 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
706 zstyle ':completion:correct:' prompt 'correct to: %e'
708 # Ignore completion functions for commands you don't have:
709 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
711 # Provide more processes in completion of programs like killall:
712 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
714 # complete manual by their section
715 zstyle ':completion:*:manuals' separate-sections true
716 zstyle ':completion:*:manuals.*' insert-sections true
717 zstyle ':completion:*:man:*' menu yes select
719 # Search path for sudo completion
720 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
728 # provide .. as a completion
729 zstyle ':completion:*' special-dirs ..
731 # run rehash on completion so new installed program are found automatically:
733 (( CURRENT == 1 )) && rehash
738 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
739 if [[ "$NOCOR" -gt 0 ]] ; then
740 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
743 # try to be smart about when to use what completer...
745 zstyle -e ':completion:*' completer '
746 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
747 _last_try="$HISTNO$BUFFER$CURSOR"
748 reply=(_complete _match _ignored _prefix _files)
750 if [[ $words[1] == (rm|mv) ]] ; then
751 reply=(_complete _files)
753 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
758 # command for process lists, the local web server details and host completion
759 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
762 [[ -d $ZSHDIR/cache ]] && zstyle ':completion:*' use-cache yes && \
763 zstyle ':completion::complete:*' cache-path $ZSHDIR/cache/
767 [[ -r ~/.ssh/config ]] && _ssh_config_hosts=(${${${(@M)${(f)"$(<$HOME/.ssh/config)"}:#Host *}#Host }:#*[*?]*}) || _ssh_config_hosts=()
768 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
769 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
777 "$_ssh_config_hosts[@]"
782 zstyle ':completion:*:hosts' hosts $hosts
783 # TODO: so, why is this here?
784 # zstyle '*' hosts $hosts
786 # use generic completion system for programs not yet defined; (_gnu_generic works
787 # with commands that provide a --help option with "standard" gnu-like output.)
788 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
789 pal stow tail uname ; do
790 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
793 # see upgrade function in this file
794 compdef _hosts upgrade
797 # Keyboard setup: The following is based on the same code, we wrote for
798 # debian's setup. It ensures the terminal is in the right mode, when zle is
799 # active, so the values from $terminfo are valid. Therefore, this setup should
800 # work on all systems, that have support for `terminfo'. It also requires the
801 # zsh in use to have the `zsh/terminfo' module built.
803 # If you are customising your `zle-line-init()' or `zle-line-finish()'
804 # functions, make sure you call the following utility functions in there:
806 # - zle-line-init(): zle-smkx
807 # - zle-line-finish(): zle-rmkx
809 # Use emacs-like key bindings by default:
814 ## beginning-of-line OR beginning-of-buffer OR beginning of history
815 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
816 beginning-or-end-of-somewhere() {
818 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
819 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
820 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
822 zle .${WIDGET:s/somewhere/line-hist/} "$@"
823 if (( HISTNO != hno )); then
824 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
828 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
829 zle -N end-of-somewhere beginning-or-end-of-somewhere
831 # add a command line to the shells history without executing it
832 commit-to-history() {
833 print -s ${(z)BUFFER}
836 zle -N commit-to-history
838 # only slash should be considered as a word separator:
839 slash-backward-kill-word() {
840 local WORDCHARS="${WORDCHARS:s@/@}"
842 zle backward-kill-word
844 zle -N slash-backward-kill-word
846 # a generic accept-line wrapper
848 # This widget can prevent unwanted autocorrections from command-name
849 # to _command-name, rehash automatically on enter and call any number
850 # of builtin and user-defined widgets in different contexts.
852 # For a broader description, see:
853 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
855 # The code is imported from the file 'zsh/functions/accept-line' from
856 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
857 # distributed under the same terms as zsh itself.
859 # A newly added command will may not be found or will cause false
860 # correction attempts, if you got auto-correction set. By setting the
861 # following style, we force accept-line() to rehash, if it cannot
862 # find the first word on the command line in the $command[] hash.
863 zstyle ':acceptline:*' rehash true
865 function Accept-Line() {
866 setopt localoptions noksharrays
870 local alcontext=${1:-$alcontext}
872 zstyle -a ":acceptline:${alcontext}" actions subs
874 (( ${#subs} < 1 )) && return 0
877 for sub in ${subs} ; do
878 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
881 (( aldone > 0 )) && break
885 function Accept-Line-getdefault() {
889 zstyle -s ":acceptline:${alcontext}" default_action default_action
890 case ${default_action} in
892 printf ".accept-line"
895 printf ${default_action}
900 function Accept-Line-HandleContext() {
903 default_action=$(Accept-Line-getdefault)
904 zstyle -T ":acceptline:${alcontext}" call_default \
905 && zle ${default_action}
908 function accept-line() {
909 setopt localoptions noksharrays
912 local buf com fname format msg default_action
916 cmdline=(${(z)BUFFER})
920 Accept-Line 'preprocess'
922 zstyle -t ":acceptline:${alcontext}" rehash \
923 && [[ -z ${commands[$com]} ]] \
927 && [[ -n ${reswords[(r)$com]} ]] \
928 || [[ -n ${aliases[$com]} ]] \
929 || [[ -n ${functions[$com]} ]] \
930 || [[ -n ${builtins[$com]} ]] \
931 || [[ -n ${commands[$com]} ]] ; then
933 # there is something sensible to execute, just do it.
935 Accept-Line-HandleContext
940 if [[ -o correct ]] \
941 || [[ -o correctall ]] \
942 && [[ -n ${functions[$fname]} ]] ; then
944 # nothing there to execute but there is a function called
945 # _command_name; a completion widget. Makes no sense to
946 # call it on the commandline, but the correct{,all} options
947 # will ask for it nevertheless, so warn the user.
948 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
949 # Okay, we warned the user before, he called us again,
950 # so have it his way.
952 Accept-Line-HandleContext
957 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
959 Accept-Line-HandleContext
961 # prepare warning message for the user, configurable via zstyle.
962 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
964 if [[ -z ${msg} ]] ; then
965 msg="%c will not execute and completion %f exists."
968 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
973 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
974 # If we are here, the commandline contains something that is not
975 # executable, which is neither subject to _command_name correction
976 # and is not empty. might be a variable assignment
978 Accept-Line-HandleContext
983 # If we got this far, the commandline only contains whitespace, or is empty.
985 Accept-Line-HandleContext
990 zle -N Accept-Line-HandleContext
992 # power completion / abbreviation expansion / buffer expansion
993 # see http://zshwiki.org/home/examples/zleiab for details
994 # less risky than the global aliases but powerful as well
995 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
998 setopt interactivecomments
1000 # key # value (#d additional doc string)
1006 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1008 'Hl' ' --help |& less -r' #d (Display help in pager)
1012 'N' '&>/dev/null' #d (No Output)
1013 'R' '| tr A-z N-za-m' #d (ROT13)
1014 'SL' '| sort | less'
1019 'co' './configure && make && sudo make install'
1027 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1028 LBUFFER+=${abk[$MATCH]:-$MATCH}
1035 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1038 zle -N help-show-abk
1040 # press "ctrl-e d" to insert the actual date in the form yyyy-mm-dd
1041 insert-datestamp() { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1042 zle -N insert-datestamp
1044 # press esc-m for inserting last typed word again (thanks to caphuso!)
1045 insert-last-typed-word() { zle insert-last-word -- 0 -1 };
1046 zle -N insert-last-typed-word;
1048 function grml-zsh-fg() {
1049 if (( ${#jobstates} )); then
1051 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1052 BUFFER="${BUFFER}fg"
1055 zle -M 'No background jobs. Doing nothing.'
1060 # run command line as user root via sudo:
1061 sudo-command-line() {
1062 [[ -z $BUFFER ]] && zle up-history
1063 if [[ $BUFFER != sudo\ * ]]; then
1064 BUFFER="sudo $BUFFER"
1065 CURSOR=$(( CURSOR+5 ))
1068 zle -N sudo-command-line
1070 ### jump behind the first word on the cmdline.
1071 ### useful to add options.
1072 function jump_after_first_word() {
1074 words=(${(z)BUFFER})
1076 if (( ${#words} <= 1 )) ; then
1079 CURSOR=${#${words[1]}}
1082 zle -N jump_after_first_word
1084 #f5# Create directory under cursor or the selected area
1086 # Press ctrl-xM to create the directory under the cursor or the selected area.
1087 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1088 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1089 # directory does not exist yet -> press ctrl-XM and problem solved
1091 if ((REGION_ACTIVE==1)); then
1092 local F=$MARK T=$CURSOR
1093 if [[ $F -gt $T ]]; then
1097 # get marked area from buffer and eliminate whitespace
1098 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1099 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1101 local bufwords iword
1102 bufwords=(${(z)LBUFFER})
1104 bufwords=(${(z)BUFFER})
1105 PATHTOMKDIR="${(Q)bufwords[iword]}"
1107 [[ -z "${PATHTOMKDIR}" ]] && return 1
1108 PATHTOMKDIR=${~PATHTOMKDIR}
1109 if [[ -e "${PATHTOMKDIR}" ]]; then
1110 zle -M " path already exists, doing nothing"
1112 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1117 zle -N inplaceMkDirs
1119 #v1# set number of lines to display per page
1120 HELP_LINES_PER_PAGE=20
1121 #v1# set location of help-zle cache file
1122 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1123 # helper function for help-zle, actually generates the help text
1124 help_zle_parse_keybindings()
1128 unsetopt ksharrays #indexing starts at 1
1130 #v1# choose files that help-zle will parse for keybindings
1131 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1133 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1135 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1136 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1139 #fill with default keybindings, possibly to be overwriten in a file later
1140 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1141 local -A help_zle_keybindings
1142 help_zle_keybindings['<Ctrl>@']="set MARK"
1143 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1144 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1145 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1146 help_zle_keybindings['<Ctrl>_']="undo"
1147 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1148 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1149 help_zle_keybindings['<Ctrl>e']="goto end of line"
1150 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1151 help_zle_keybindings['<Alt>t']="transpose words"
1152 help_zle_keybindings['<Alt>s']="spellcheck word"
1153 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1154 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1155 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1156 help_zle_keybindings["<Alt>'"]="quote line"
1157 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1158 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1159 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1160 help_zle_keybindings['<Alt>l']="make next word lowercase"
1161 help_zle_keybindings['<Ctrl>xd']="preview expansion under cursor"
1162 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1163 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1164 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1165 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1166 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1167 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1168 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1169 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1171 #init global variables
1172 unset help_zle_lines help_zle_sln
1173 typeset -g -a help_zle_lines
1174 typeset -g help_zle_sln=1
1177 local lastkeybind_desc contents #last description starting with #k# that we found
1178 local num_lines_elapsed=0 #number of lines between last description and keybinding
1179 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1180 for f in $HELPZLE_KEYBINDING_FILES; do
1181 [[ -r "$f" ]] || continue #not readable ? skip it
1183 for cline in "${(f)contents}"; do
1184 #zsh pattern: matches lines like: #k# ..............
1185 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1186 lastkeybind_desc="$match[*]"
1188 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1189 # ignores lines that are commentend out
1190 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1191 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1192 #description prevously found ? description not more than 2 lines away ? keybinding not empty ?
1193 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1194 #substitute keybinding string with something readable
1195 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1196 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1197 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1198 help_zle_keybindings[${k}]=$lastkeybind_desc
1202 ((num_lines_elapsed++))
1207 #calculate length of keybinding column
1209 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1210 #convert the assoc array into preformated lines, which we are able to sort
1211 for k v in ${(kv)help_zle_keybindings[@]}; do
1212 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1213 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1215 #sort lines alphabetically
1216 help_zle_lines=("${(i)help_zle_lines[@]}")
1217 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1218 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1219 zcompile $HELP_ZLE_CACHE_FILE
1221 typeset -g help_zle_sln
1222 typeset -g -a help_zle_lines
1224 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1228 unsetopt ksharrays #indexing starts at 1
1229 #help lines already generated ? no ? then do it
1230 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1231 #already displayed all lines ? go back to the start
1232 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1233 local sln=$help_zle_sln
1234 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1235 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1236 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1240 ## complete word from currently visible Screen or Tmux buffer.
1241 if check_com -c screen || check_com -c tmux; then
1242 _complete_screen_display() {
1243 [[ "$TERM" != "screen" ]] && return 1
1245 local TMPFILE=$(mktemp)
1246 local -U -a _screen_display_wordlist
1247 trap "rm -f $TMPFILE" EXIT
1249 # fill array with contents from screen hardcopy
1250 if ((${+TMUX})); then
1251 #works, but crashes tmux below version 1.4
1252 #luckily tmux -V option to ask for version, was also added in 1.4
1253 tmux -V &>/dev/null || return
1254 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1256 screen -X hardcopy $TMPFILE
1257 # screen sucks, it dumps in latin1, apparently always. so recode it
1259 check_com recode && recode latin1 $TMPFILE
1261 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1262 # remove PREFIX to be completed from that array
1263 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1264 compadd -a _screen_display_wordlist
1266 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1268 compdef -k _complete_screen_display complete-word '^xS'
1271 # Load a few more functions and tie them to widgets, so they can be bound:
1273 function zrcautozle() {
1276 zrcautoload $fnc && zle -N $fnc
1279 function zrcgotwidget() {
1280 (( ${+widgets[$1]} ))
1283 function zrcgotkeymap() {
1284 [[ -n ${(M)keymaps:#$1} ]]
1287 zrcautozle insert-files
1288 zrcautozle edit-command-line
1289 zrcautozle insert-unicode-char
1290 if zrcautoload history-search-end; then
1291 zle -N history-beginning-search-backward-end history-search-end
1292 zle -N history-beginning-search-forward-end history-search-end
1294 zle -C hist-complete complete-word _generic
1295 zstyle ':completion:hist-complete:*' completer _history
1297 # The actual terminal setup hooks and bindkey-calls:
1299 # An array to note missing features to ease diagnosis in case of problems.
1300 typeset -ga grml_missing_features
1302 function zrcbindkey() {
1303 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1308 function bind2maps () {
1309 local i sequence widget
1312 while [[ "$1" != "--" ]]; do
1318 if [[ "$1" == "-s" ]]; then
1322 sequence="${key[$1]}"
1326 [[ -z "$sequence" ]] && return 1
1328 for i in "${maps[@]}"; do
1329 zrcbindkey -M "$i" "$sequence" "$widget"
1333 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1334 function zle-smkx () {
1336 printf '%s' ${terminfo[smkx]}
1338 function zle-rmkx () {
1340 printf '%s' ${terminfo[rmkx]}
1342 function zle-line-init () {
1345 function zle-line-finish () {
1348 zle -N zle-line-init
1349 zle -N zle-line-finish
1351 for i in {s,r}mkx; do
1352 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1359 Home "${terminfo[khome]}"
1360 End "${terminfo[kend]}"
1361 Insert "${terminfo[kich1]}"
1362 Delete "${terminfo[kdch1]}"
1363 Up "${terminfo[kcuu1]}"
1364 Down "${terminfo[kcud1]}"
1365 Left "${terminfo[kcub1]}"
1366 Right "${terminfo[kcuf1]}"
1367 PageUp "${terminfo[kpp]}"
1368 PageDown "${terminfo[knp]}"
1369 BackTab "${terminfo[kcbt]}"
1372 # Guidelines for adding key bindings:
1374 # - Do not add hardcoded escape sequences, to enable non standard key
1375 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1377 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1380 # - All keys from the $key[] mapping are obviously okay.
1382 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1383 # '\ex' are allowed in here as well.
1385 bind2maps emacs -- Home beginning-of-somewhere
1386 bind2maps viins vicmd -- Home vi-beginning-of-line
1387 bind2maps emacs -- End end-of-somewhere
1388 bind2maps viins vicmd -- End vi-end-of-line
1389 bind2maps emacs viins -- Insert overwrite-mode
1390 bind2maps vicmd -- Insert vi-insert
1391 bind2maps emacs -- Delete delete-char
1392 bind2maps viins vicmd -- Delete vi-delete-char
1393 bind2maps emacs viins vicmd -- Up up-line-or-search
1394 bind2maps emacs viins vicmd -- Down down-line-or-search
1395 bind2maps emacs -- Left backward-char
1396 bind2maps viins vicmd -- Left vi-backward-char
1397 bind2maps emacs -- Right forward-char
1398 bind2maps viins vicmd -- Right vi-forward-char
1399 #k# Perform abbreviation expansion
1400 bind2maps emacs viins -- -s '^x.' zleiab
1401 #k# Display list of abbreviations that would expand
1402 bind2maps emacs viins -- -s '^xb' help-show-abk
1403 #k# mkdir -p <dir> from string under cursor or marked area
1404 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1405 #k# display help for keybindings and ZLE
1406 bind2maps emacs viins -- -s '^xz' help-zle
1407 #k# Insert files and test globbing
1408 bind2maps emacs viins -- -s "^xf" insert-files
1409 #k# Edit the current line in \kbd{\$EDITOR}
1410 bind2maps emacs viins -- -s '\ee' edit-command-line
1411 #k# search history backward for entry beginning with typed text
1412 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1413 #k# search history forward for entry beginning with typed text
1414 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1415 #k# search history backward for entry beginning with typed text
1416 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1417 #k# search history forward for entry beginning with typed text
1418 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1419 bind2maps emacs viins -- -s "^x^h" commit-to-history
1420 #k# Kill left-side word or everything up to next slash
1421 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1422 #k# Kill left-side word or everything up to next slash
1423 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1424 #k# Kill left-side word or everything up to next slash
1425 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1426 # Do history expansion on space:
1427 bind2maps emacs viins -- -s ' ' magic-space
1428 #k# Trigger menu-complete
1429 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1430 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1431 bind2maps emacs viins -- -s '^ed' insert-datestamp
1432 #k# Insert last typed word
1433 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1434 #k# A smart shortcut for \kbd{fg<enter>}
1435 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1436 #k# prepend the current command with "sudo"
1437 bind2maps emacs viins -- -s "^os" sudo-command-line
1438 #k# jump to after first word (for adding options)
1439 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1440 #k# complete word from history with menu
1441 bind2maps emacs viins -- -s "^x^x" hist-complete
1443 # insert unicode character
1444 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1445 # See for example http://unicode.org/charts/ for unicode characters code
1446 #k# Insert Unicode character
1447 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1449 # use the new *-pattern-* widgets for incremental history search
1450 if zrcgotwidget history-incremental-pattern-search-backward; then
1451 for seq wid in '^r' history-incremental-pattern-search-backward \
1452 '^s' history-incremental-pattern-search-forward
1454 bind2maps emacs viins vicmd -- -s $seq $wid
1458 if zrcgotkeymap menuselect; then
1459 #m# k Shift-tab Perform backwards menu completion
1460 bind2maps menuselect -- BackTab reverse-menu-complete
1462 #k# menu selection: pick item but stay in the menu
1463 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1464 # also use + and INSERT since it's easier to press repeatedly
1465 bind2maps menuselect -- -s '+' accept-and-menu-complete
1466 bind2maps menuselect -- Insert accept-and-menu-complete
1468 # accept a completion and try to complete again by using menu
1469 # completion; very useful with completing directories
1470 # by using 'undo' one's got a simple file browser
1471 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1474 # Finally, here are still a few hardcoded escape sequences; Special sequences
1475 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1476 # standardised and most of the time are not available in a terminals terminfo
1479 # While we do not encourage adding bindings like these, we will keep these for
1480 # backward compatibility.
1482 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1483 ## the command line.
1485 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1486 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1487 # These are for xterm:
1488 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1489 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1490 ## the same for alt-left-arrow and alt-right-arrow
1492 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1493 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1495 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1496 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1497 # Also try ESC Left/Right:
1498 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1499 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1506 # we don't want to quote/espace URLs on our own...
1507 # if autoload -U url-quote-magic ; then
1508 # zle -N self-insert url-quote-magic
1509 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1511 # print 'Notice: no url-quote-magic available :('
1513 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1515 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1516 alias run-help >&/dev/null && unalias run-help
1517 for rh in run-help{,-git,-svk,-svn}; do
1521 # command not found handling
1523 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1524 function command_not_found_handler() {
1526 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1527 ${GRML_ZSH_CNF_HANDLER} $1
1534 ZSHDIR=${ZDOTDIR:-${HOME}/.zsh}
1537 HISTFILE=${ZDOTDIR:-${HOME}}/.zsh_history
1538 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1539 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1543 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1544 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1546 if [[ -f ${DIRSTACKFILE} ]] && [[ ${#dirstack[*]} -eq 0 ]] ; then
1547 dirstack=( ${(f)"$(< $DIRSTACKFILE)"} )
1548 # "cd -" won't work after login by just setting $OLDPWD, so
1549 [[ -d $dirstack[1] ]] && cd $dirstack[1] && cd $OLDPWD
1553 if (( $DIRSTACKSIZE <= 0 )) || [[ -z $DIRSTACKFILE ]]; then return; fi
1555 my_stack=( ${PWD} ${dirstack} )
1557 builtin print -l ${(u)my_stack} >! ${DIRSTACKFILE}
1559 uprint my_stack >! ${DIRSTACKFILE}
1563 # directory based profiles
1567 # chpwd_profiles(): Directory Profiles, Quickstart:
1571 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1572 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1575 # For details see the `grmlzshrc.5' manual page.
1576 function chpwd_profiles() {
1577 local profile context
1580 context=":chpwd:profiles:$PWD"
1581 zstyle -s "$context" profile profile || profile='default'
1582 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1584 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1585 typeset -g CHPWD_PROFILE
1586 local CHPWD_PROFILES_INIT=1
1587 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1588 elif [[ $profile != $CHPWD_PROFILE ]]; then
1589 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1590 && chpwd_leave_profile_${CHPWD_PROFILE}
1592 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1593 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1596 CHPWD_PROFILE="${profile}"
1600 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1604 # Prompt setup for grml:
1606 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1607 # in prompts to get a red "foo" embedded, but it's good to keep these for
1608 # backwards compatibility).
1614 MAGENTA="%F{magenta}"
1618 elif zrcautoload colors && colors 2>/dev/null ; then
1619 BLUE="%{${fg[blue]}%}"
1620 RED="%{${fg_bold[red]}%}"
1621 GREEN="%{${fg[green]}%}"
1622 CYAN="%{${fg[cyan]}%}"
1623 MAGENTA="%{${fg[magenta]}%}"
1624 YELLOW="%{${fg[yellow]}%}"
1625 WHITE="%{${fg[white]}%}"
1626 NO_COLOR="%{${reset_color}%}"
1628 BLUE=$'%{\e[1;34m%}'
1630 GREEN=$'%{\e[1;32m%}'
1631 CYAN=$'%{\e[1;36m%}'
1632 WHITE=$'%{\e[1;37m%}'
1633 MAGENTA=$'%{\e[1;35m%}'
1634 YELLOW=$'%{\e[1;33m%}'
1635 NO_COLOR=$'%{\e[0m%}'
1638 # First, the easy ones: PS2..4:
1640 # secondary prompt, printed when the shell needs more information to complete a
1643 # selection prompt used within a select loop.
1645 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1648 # Some additional features to use with our prompt:
1652 # - vcs_info setup and version specific fixes
1654 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1657 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1660 elif isopenbsd ; then
1662 elif isfreebsd ; then
1664 elif isdarwin ; then
1668 GRML_DISPLAY_BATTERY=0
1674 GRML_BATTERY_LEVEL=''
1675 local batteries bat capacity
1676 batteries=( /sys/class/power_supply/BAT*(N) )
1677 if (( $#batteries > 0 )) ; then
1678 for bat in $batteries ; do
1679 capacity=$(< $bat/capacity)
1680 case $(< $bat/status) in
1682 GRML_BATTERY_LEVEL+=" ^"
1685 if (( capacity < 20 )) ; then
1686 GRML_BATTERY_LEVEL+=" !v"
1688 GRML_BATTERY_LEVEL+=" v"
1692 GRML_BATTERY_LEVEL+=" ="
1695 GRML_BATTERY_LEVEL+="${capacity}%%"
1701 GRML_BATTERY_LEVEL=''
1702 local bat batfull batwarn batnow num
1704 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1705 if [[ -n $bat ]]; then
1706 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1707 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1708 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1709 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1711 if (( batnow < batwarn )) ; then
1712 GRML_BATTERY_LEVEL+=" !v"
1714 GRML_BATTERY_LEVEL+=" v"
1718 GRML_BATTERY_LEVEL+=" ^"
1721 GRML_BATTERY_LEVEL+=" ="
1724 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1730 GRML_BATTERY_LEVEL=''
1734 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1735 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1736 case $table[State] in
1738 if (( $table[Remaining-capacity] < 20 )) ; then
1739 GRML_BATTERY_LEVEL+=" !v"
1741 GRML_BATTERY_LEVEL+=" v"
1745 GRML_BATTERY_LEVEL+=" ^"
1748 GRML_BATTERY_LEVEL+=" ="
1751 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1757 GRML_BATTERY_LEVEL=''
1759 table=( ${$(pmset -g ps)[(w)7,8]%%(\%|);} )
1760 if [[ -n $table[2] ]] ; then
1763 GRML_BATTERY_LEVEL+=" ^"
1766 if (( $table[1] < 20 )) ; then
1767 GRML_BATTERY_LEVEL+=" !v"
1769 GRML_BATTERY_LEVEL+=" v"
1773 GRML_BATTERY_LEVEL+=" ="
1776 GRML_BATTERY_LEVEL+="$table[1]%%"
1780 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1781 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1782 debian_chroot=$(</etc/debian_chroot)
1785 # gather version control information for inclusion in a prompt
1787 if zrcautoload vcs_info; then
1788 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1789 # function, which can cause a lot of trouble with our directory-based
1791 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1792 function VCS_INFO_realpath () {
1793 setopt localoptions NO_shwordsplit chaselinks
1794 ( builtin cd -q $1 2> /dev/null && pwd; )
1798 zstyle ':vcs_info:*' max-exports 2
1800 if [[ -o restricted ]]; then
1801 zstyle ':vcs_info:*' enable NONE
1805 typeset -A grml_vcs_coloured_formats
1806 typeset -A grml_vcs_plain_formats
1808 grml_vcs_plain_formats=(
1809 format "(%s%)-[%b] " "zsh: %r"
1810 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1811 rev-branchformat "%b:%r"
1814 grml_vcs_coloured_formats=(
1815 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1816 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1817 rev-branchformat "%b${RED}:${YELLOW}%r"
1820 typeset GRML_VCS_COLOUR_MODE=xxx
1822 grml_vcs_info_toggle_colour () {
1824 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
1825 grml_vcs_info_set_formats coloured
1827 grml_vcs_info_set_formats plain
1832 grml_vcs_info_set_formats () {
1834 #setopt localoptions xtrace
1835 local mode=$1 AF F BF
1836 if [[ $mode == coloured ]]; then
1837 AF=${grml_vcs_coloured_formats[actionformat]}
1838 F=${grml_vcs_coloured_formats[format]}
1839 BF=${grml_vcs_coloured_formats[rev-branchformat]}
1840 GRML_VCS_COLOUR_MODE=coloured
1842 AF=${grml_vcs_plain_formats[actionformat]}
1843 F=${grml_vcs_plain_formats[format]}
1844 BF=${grml_vcs_plain_formats[rev-branchformat]}
1845 GRML_VCS_COLOUR_MODE=plain
1848 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
1849 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
1850 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
1854 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1855 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1856 if [[ "$TERM" == dumb ]] ; then
1857 grml_vcs_info_set_formats plain
1859 grml_vcs_info_set_formats coloured
1862 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
1864 # This actually defines three prompts:
1870 # They all share the same code and only differ with respect to which items they
1871 # contain. The main source of documentation is the `prompt_grml_help' function
1872 # below, which gets called when the user does this: prompt -h grml
1874 function prompt_grml_help () {
1878 This is the prompt as used by the grml-live system <http://grml.org>. It is
1879 a rather simple one-line prompt, that by default looks something like this:
1881 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
1883 The prompt itself integrates with zsh's prompt themes system (as you are
1884 witnessing right now) and is configurable to a certain degree. In
1885 particular, these aspects are customisable:
1887 - The items used in the prompt (e.g. you can remove \`user' from
1888 the list of activated items, which will cause the user name to
1889 be omitted from the prompt string).
1891 - The attributes used with the items are customisable via strings
1892 used before and after the actual item.
1894 The available items are: at, battery, change-root, date, grml-chroot,
1895 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
1896 shell-level, time, user, vcs
1898 The actual configuration is done via zsh's \`zstyle' mechanism. The
1899 context, that is used while looking up styles is:
1901 ':prompt:grml:<left-or-right>:<subcontext>'
1903 Here <left-or-right> is either \`left' or \`right', signifying whether the
1904 style should affect the left or the right prompt. <subcontext> is either
1905 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
1909 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
1910 in $RPROMPT if the last command a returned non-successful error code.
1911 (This in only valid if <left-or-right> is "right"; ignored otherwise)
1913 - items (list): The list of items used in the prompt. If \`vcs' is
1914 present in the list, the theme's code invokes \`vcs_info'
1915 accordingly. Default (left): rc change-root user at host path vcs
1916 percent; Default (right): sad-smiley
1918 Available styles in 'items:<item>' are: pre, post. These are strings that
1919 are inserted before (pre) and after (post) the item in question. Thus, the
1920 following would cause the user name to be printed in red instead of the
1923 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
1925 Note, that the \`post' style may remain at its default value, because its
1926 default value is '%f', which turns the foreground text attribute off (which
1927 is exactly, what is still required with the new \`pre' value).
1931 function prompt_grml-chroot_help () {
1935 This is a variation of the grml prompt, see: prompt -h grml
1937 The main difference is the default value of the \`items' style. The rest
1938 behaves exactly the same. Here are the defaults for \`grml-chroot':
1940 - left: grml-chroot user at host path percent
1941 - right: (empty list)
1945 function prompt_grml-large_help () {
1949 This is a variation of the grml prompt, see: prompt -h grml
1951 The main difference is the default value of the \`items' style. In
1952 particular, this theme uses _two_ lines instead of one with the plain
1953 \`grml' theme. The rest behaves exactly the same. Here are the defaults
1956 - left: rc jobs history shell-level change-root time date newline user
1957 at host path vcs percent
1962 function grml_prompt_setup () {
1964 autoload -Uz vcs_info
1965 autoload -Uz add-zsh-hook
1966 add-zsh-hook precmd prompt_$1_precmd
1969 function prompt_grml_setup () {
1970 grml_prompt_setup grml
1973 function prompt_grml-chroot_setup () {
1974 grml_prompt_setup grml-chroot
1977 function prompt_grml-large_setup () {
1978 grml_prompt_setup grml-large
1981 # These maps define default tokens and pre-/post-decoration for items to be
1982 # used within the themes. All defaults may be customised in a context sensitive
1983 # matter by using zsh's `zstyle' mechanism.
1984 typeset -gA grml_prompt_pre_default \
1985 grml_prompt_post_default \
1986 grml_prompt_token_default \
1987 grml_prompt_token_function
1989 grml_prompt_pre_default=(
1994 grml-chroot '%F{red}'
2004 shell-level '%F{red}'
2010 grml_prompt_post_default=(
2031 grml_prompt_token_default=(
2033 battery 'GRML_BATTERY_LEVEL'
2034 change-root 'debian_chroot'
2036 grml-chroot 'GRML_CHROOT'
2037 history '{history#%!} '
2039 jobs '[%j running job(s)] '
2041 path '%40<..<%~%<< '
2045 sad-smiley '%(?..:()'
2046 shell-level '%(3L.+ .)'
2047 time '%D{%H:%M:%S} '
2052 function grml_theme_has_token () {
2053 if (( ARGC != 1 )); then
2054 printf 'usage: grml_theme_has_token <name>\n'
2057 (( ${+grml_prompt_token_default[$1]} ))
2060 function GRML_theme_add_token_usage () {
2062 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2064 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2065 are used, <token/function> is the name of the function (see below for
2066 details). Otherwise it is the literal token string to be used. <pre> and
2067 <post> are optional.
2071 -f <function> Use a function named \`<function>' each time the token
2074 -i <function> Use a function named \`<function>' to initialise the
2075 value of the token _once_ at runtime.
2077 The functions are called with one argument: the token's new name. The
2078 return value is expected in the \$REPLY parameter. The use of these
2079 options is mutually exclusive.
2081 There is a utility function \`grml_theme_has_token', which you can use
2082 to test if a token exists before trying to add it. This can be a guard
2083 for situations in which a \`grml_theme_add_token' call may happen more
2088 To add a new token \`day' that expands to the current weekday in the
2089 current locale in green foreground colour, use this:
2091 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2093 Another example would be support for \$VIRTUAL_ENV:
2095 function virtual_env_prompt () {
2096 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2098 grml_theme_add_token virtual-env -f virtual_env_prompt
2100 After that, you will be able to use a changed \`items' style to
2101 assemble your prompt.
2105 function grml_theme_add_token () {
2107 local name token pre post
2108 local -i init funcall
2110 if (( ARGC == 0 )); then
2111 GRML_theme_add_token_usage
2121 if [[ $1 == '-f' ]]; then
2124 elif [[ $1 == '-i' ]]; then
2129 if (( ARGC == 0 )); then
2131 grml_theme_add_token: No token-string/function-name provided!\n\n'
2132 GRML_theme_add_token_usage
2137 if (( ARGC != 0 && ARGC != 2 )); then
2139 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2140 GRML_theme_add_token_usage
2149 if grml_theme_has_token $name; then
2151 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2152 GRML_theme_add_token_usage
2159 grml_prompt_pre_default[$name]=$pre
2160 grml_prompt_post_default[$name]=$post
2161 if (( funcall )); then
2162 grml_prompt_token_function[$name]=$token
2163 grml_prompt_token_default[$name]=23
2165 grml_prompt_token_default[$name]=$token
2169 function grml_typeset_and_wrap () {
2176 if (( ${+parameters[$new]} )); then
2177 typeset -g "${target}=${(P)target}${left}${(P)new}${right}"
2181 function grml_prompt_addto () {
2184 local lr it apre apost new v
2188 [[ $target == PS1 ]] && lr=left || lr=right
2189 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2190 typeset -g "${target}="
2191 for it in "${items[@]}"; do
2192 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2193 || apre=${grml_prompt_pre_default[$it]}
2194 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2195 || apost=${grml_prompt_post_default[$it]}
2196 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2197 || new=${grml_prompt_token_default[$it]}
2198 typeset -g "${target}=${(P)target}${apre}"
2199 if (( ${+grml_prompt_token_function[$it]} )); then
2200 ${grml_prompt_token_function[$it]} $it
2201 typeset -g "${target}=${(P)target}${REPLY}"
2205 grml_typeset_and_wrap $target $new '' ''
2208 grml_typeset_and_wrap $target $new '(' ')'
2211 if [[ -n ${(P)new} ]]; then
2212 typeset -g "${target}=${(P)target}(CHROOT)"
2216 v="vcs_info_msg_${new}_"
2217 if (( ! vcscalled )); then
2221 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2222 typeset -g "${target}=${(P)target}${(P)v}"
2225 *) typeset -g "${target}=${(P)target}${new}" ;;
2228 typeset -g "${target}=${(P)target}${apost}"
2232 function prompt_grml_precmd () {
2234 local grmltheme=grml
2235 local -a left_items right_items
2236 left_items=(rc change-root user at host path vcs percent)
2237 right_items=(sad-smiley)
2239 prompt_grml_precmd_worker
2242 function prompt_grml-chroot_precmd () {
2244 local grmltheme=grml-chroot
2245 local -a left_items right_items
2246 left_items=(grml-chroot user at host path percent)
2249 prompt_grml_precmd_worker
2252 function prompt_grml-large_precmd () {
2254 local grmltheme=grml-large
2255 local -a left_items right_items
2256 left_items=(rc jobs history shell-level change-root time date newline
2257 user at host path vcs percent)
2258 right_items=(sad-smiley)
2260 prompt_grml_precmd_worker
2263 function prompt_grml_precmd_worker () {
2265 local -i vcscalled=0
2267 grml_prompt_addto PS1 "${left_items[@]}"
2268 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2269 grml_prompt_addto RPS1 "${right_items[@]}"
2273 grml_prompt_fallback() {
2276 (( ${+functions[vcs_info]} )) && vcs_info
2279 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2280 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2281 if (( EUID == 0 )); then
2282 PROMPT="${BLUE}${p0}${RED}${p1}"
2284 PROMPT="${RED}${p0}${BLUE}${p1}"
2289 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2290 # Since we define the required functions in here and not in files in
2291 # $fpath, we need to stick the theme's name into `$prompt_themes'
2292 # ourselves, since promptinit does not pick them up otherwise.
2293 prompt_themes+=( grml grml-chroot grml-large )
2294 # Also, keep the array sorted...
2295 prompt_themes=( "${(@on)prompt_themes}" )
2297 print 'Notice: no promptinit available :('
2298 grml_prompt_fallback
2302 # The prompt themes use modern features of zsh, that require at least
2303 # version 4.3.7 of the shell. Use the fallback otherwise.
2304 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2305 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2306 add-zsh-hook precmd battery
2308 if [[ "$TERM" == dumb ]] ; then
2309 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2310 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2311 for i in rc user path jobs history date time shell-level; do
2312 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2313 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2316 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2317 elif (( EUID == 0 )); then
2318 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2321 # Finally enable one of the prompts.
2322 if [[ -n $GRML_CHROOT ]]; then
2324 elif [[ $GRMLPROMPT -gt 0 ]]; then
2330 grml_prompt_fallback
2333 # Terminal-title wizardry
2335 function ESC_print () {
2336 info_print $'\ek' $'\e\\' "$@"
2338 function set_title () {
2339 info_print $'\e]0;' $'\a' "$@"
2342 function info_print () {
2343 local esc_begin esc_end
2347 printf '%s' ${esc_begin}
2349 printf '%s' "${esc_end}"
2352 function grml_reset_screen_title () {
2353 # adjust title of xterm
2354 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2355 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2358 set_title ${(%):-"%n@%m: %~"}
2363 function grml_vcs_to_screen_title () {
2364 if [[ $TERM == screen* ]] ; then
2365 if [[ -n ${vcs_info_msg_1_} ]] ; then
2366 ESC_print ${vcs_info_msg_1_}
2373 function grml_maintain_name () {
2374 # set hostname if not running on host with name 'grml'
2375 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
2380 function grml_cmd_to_screen_title () {
2381 # get the name of the program currently running and hostname of local
2382 # machine set screen window title if running in a screen
2383 if [[ "$TERM" == screen* ]] ; then
2384 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2389 function grml_control_xterm_title () {
2392 set_title "${(%):-"%n@%m:"}" "$1"
2397 zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2398 if [[ $NOPRECMD -eq 0 ]]; then
2399 add-zsh-hook precmd grml_reset_screen_title
2400 add-zsh-hook precmd grml_vcs_to_screen_title
2401 add-zsh-hook preexec grml_maintain_name
2402 add-zsh-hook preexec grml_cmd_to_screen_title
2403 if [[ $NOTITLE -eq 0 ]]; then
2404 add-zsh-hook preexec grml_control_xterm_title
2408 # 'hash' some often used directories
2410 hash -d deb=/var/cache/apt/archives
2411 hash -d doc=/usr/share/doc
2412 hash -d linux=/lib/modules/$(command uname -r)/build/
2413 hash -d log=/var/log
2414 hash -d slog=/var/log/syslog
2415 hash -d src=/usr/src
2416 hash -d www=/var/www
2420 if check_com -c screen ; then
2421 if [[ $UID -eq 0 ]] ; then
2422 if [[ -r /etc/grml/screenrc ]]; then
2423 alias screen="${commands[screen]} -c /etc/grml/screenrc"
2425 elif [[ -r $HOME/.screenrc ]] ; then
2426 alias screen="${commands[screen]} -c $HOME/.screenrc"
2428 if [[ -r /etc/grml/screenrc_grml ]]; then
2429 alias screen="${commands[screen]} -c /etc/grml/screenrc_grml"
2431 if [[ -r /etc/grml/screenrc ]]; then
2432 alias screen="${commands[screen]} -c /etc/grml/screenrc"
2438 # do we have GNU ls with color-support?
2439 if [[ "$TERM" != dumb ]]; then
2440 #a1# List files with colors (\kbd{ls -F \ldots})
2441 alias ls='command ls -F '${ls_options:+"${ls_options[*]}"}
2442 #a1# List all files, with colors (\kbd{ls -la \ldots})
2443 alias la='command ls -la '${ls_options:+"${ls_options[*]}"}
2444 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2445 alias ll='command ls -l '${ls_options:+"${ls_options[*]}"}
2446 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2447 alias lh='command ls -hAl '${ls_options:+"${ls_options[*]}"}
2448 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -lF \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2449 alias l='command ls -lF '${ls_options:+"${ls_options[*]}"}
2451 alias ls='command ls -F'
2452 alias la='command ls -la'
2453 alias ll='command ls -l'
2454 alias lh='command ls -hAl'
2455 alias l='command ls -lF'
2458 alias mdstat='cat /proc/mdstat'
2459 alias ...='cd ../../'
2461 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2462 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2463 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2466 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2467 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2468 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2470 # make sure it is not assigned yet
2471 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2474 for ENV in $(env | command grep -i '.utf') ; do
2475 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2480 # make sure it is not assigned yet
2481 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2483 if ! isutfenv ; then
2484 for ENV in $(env | command grep -i '\.iso') ; do
2485 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2490 # especially for roadwarriors using GNU screen and ssh:
2491 if ! check_com asc &>/dev/null ; then
2492 asc() { autossh -t "$@" 'screen -RdU' }
2496 #f1# Hints for the use of zsh on grml
2498 print "$bg[white]$fg[black]
2499 zsh-help - hints for use of zsh on grml
2500 =======================================$reset_color"
2503 Main configuration of zsh happens in /etc/zsh/zshrc.
2504 That file is part of the package grml-etc-core, if you want to
2505 use them on a non-grml-system just get the tar.gz from
2506 http://deb.grml.org/ or (preferably) get it from the git repository:
2508 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2510 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2511 The file is still there, but it is empty for backwards compatibility.
2513 For your own changes use these two files:
2517 The former is sourced very early in our zshrc, the latter is sourced
2520 System wide configuration without touching configuration files of grml
2521 can take place in /etc/zsh/zshrc.local.
2523 For information regarding zsh start at http://grml.org/zsh/
2525 Take a look at grml'\''s zsh refcard:
2526 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2528 Check out the main zsh refcard:
2529 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2531 And of course visit the zsh-lovers:
2534 You can adjust some options through environment variables when
2535 invoking zsh without having to edit configuration files.
2536 Basically meant for bash users who are not used to the power of
2539 "NOCOR=1 zsh" => deactivate automatic correction
2540 "NOMENU=1 zsh" => do not use auto menu completion
2541 (note: use ctrl-d for completion instead!)
2542 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2543 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2544 preexec() and precmd() completely
2545 "GRML_DISPLAY_BATTERY=1 zsh"
2546 => activate battery status on right side of prompt (WIP)
2547 "COMMAND_NOT_FOUND=1 zsh"
2548 => Enable a handler if an external command was not found
2549 The command called in the handler can be altered by setting
2550 the GRML_ZSH_CNF_HANDLER variable, the default is:
2551 "/usr/share/command-not-found/command-not-found"
2553 A value greater than 0 is enables a feature; a value equal to zero
2554 disables it. If you like one or the other of these settings, you can
2555 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2559 $bg[white]$fg[black]
2560 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2561 Enjoy your grml system with the zsh!$reset_color"
2565 if [[ -r /etc/debian_version ]] ; then
2566 #a3# Execute \kbd{apt-cache search}
2567 alias acs='apt-cache search'
2568 #a3# Execute \kbd{apt-cache show}
2569 alias acsh='apt-cache show'
2570 #a3# Execute \kbd{apt-cache policy}
2571 alias acp='apt-cache policy'
2572 #a3# Execute \kbd{apt-get dist-upgrade}
2573 salias adg="apt-get dist-upgrade"
2574 #a3# Execute \kbd{apt-get install}
2575 salias agi="apt-get install"
2576 #a3# Execute \kbd{aptitude install}
2577 salias ati="aptitude install"
2578 #a3# Execute \kbd{apt-get upgrade}
2579 salias ag="apt-get upgrade"
2580 #a3# Execute \kbd{apt-get update}
2581 salias au="apt-get update"
2582 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2583 salias -a up="aptitude update ; aptitude safe-upgrade"
2584 #a3# Execute \kbd{dpkg-buildpackage}
2585 alias dbp='dpkg-buildpackage'
2586 #a3# Execute \kbd{grep-excuses}
2587 alias ge='grep-excuses'
2589 # get a root shell as normal user in live-cd mode:
2590 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2594 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
2595 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2596 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
2597 salias tlog="tail -f /var/log/syslog" # follow the syslog
2600 # sort installed Debian-packages by size
2601 if check_com -c dpkg-query ; then
2602 #a3# List installed Debian-packages sorted by size
2603 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"
2606 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2607 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2608 if check_com -c wodim; then
2611 cdrecord is not provided under its original name by Debian anymore.
2612 See #377109 in the BTS of Debian for more details.
2614 Please use the wodim binary instead
2621 # Use hard limits, except for a smaller stack and no core dumps
2623 is425 && limit stack 8192
2624 isgrmlcd && limit core 0 # important for a live-cd-system
2629 # people should use 'grml-x'!
2630 if check_com -c 915resolution; then
2632 echo "Please use 915resolution as resolution modifying tool for Intel \
2638 #a1# Output version of running grml
2639 alias grml-version='cat /etc/grml_version'
2641 if check_com -c grml-debootstrap ; then
2643 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2649 # now run the functions
2651 is4 && isgrml && grmlstuff
2655 is4 && xsource "/etc/zsh/keephack"
2657 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2658 # You use it as follows:
2659 # $ NTREF=/reference/file
2661 # This lists all the files in the current directory newer than the reference file.
2662 # You can also specify the reference file inline; note quotes:
2663 # $ ls -l *(e:'nt ~/.zshenv':)
2665 if [[ -n $1 ]] ; then
2668 [[ $REPLY -nt $NTREF ]]
2673 #f1# Reload an autoloadable function
2674 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2675 compdef _functions freload
2677 #f1# List symlinks in detail (more detailed version of 'readlink -f' and 'whence -s')
2679 [[ -z "$1" ]] && printf 'Usage: %s <file(s)>\n' "$0" && return 1
2681 for file in "$@" ; do
2682 while [[ -h "$file" ]] ; do
2684 file=$(readlink "$file")
2689 # TODO: Is it supported to use pager settings like this?
2690 # PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
2691 # with respect to wordsplitting. (ie. ${=PAGER})
2692 if check_com -c $PAGER ; then
2693 #f3# View Debian's changelog of given package(s)
2696 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
2699 for package in "$@" ; do
2700 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
2701 $PAGER /usr/share/doc/${package}/changelog.Debian.gz
2702 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
2703 $PAGER /usr/share/doc/${package}/changelog.gz
2704 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
2705 $PAGER /usr/share/doc/${package}/changelog
2707 if check_com -c aptitude ; then
2708 echo "No changelog for package $package found, using aptitude to retrieve it."
2709 aptitude changelog "$package"
2710 elif check_com -c apt-get ; then
2711 echo "No changelog for package $package found, using apt-get to retrieve it."
2712 apt-get changelog "$package"
2714 echo "No changelog for package $package found, sorry."
2719 _dchange() { _files -W /usr/share/doc -/ }
2720 compdef _dchange dchange
2722 #f3# View Debian's NEWS of a given package
2725 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
2726 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
2728 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
2729 $PAGER /usr/share/doc/$1/NEWS.gz
2731 echo "No NEWS file for package $1 found, sorry."
2736 _dnews() { _files -W /usr/share/doc -/ }
2737 compdef _dnews dnews
2739 #f3# View Debian's copyright of a given package
2742 if [[ -r /usr/share/doc/$1/copyright ]] ; then
2743 $PAGER /usr/share/doc/$1/copyright
2745 echo "No copyright file for package $1 found, sorry."
2749 _dcopyright() { _files -W /usr/share/doc -/ }
2750 compdef _dcopyright dcopyright
2752 #f3# View upstream's changelog of a given package
2755 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2756 $PAGER /usr/share/doc/$1/changelog.gz
2758 echo "No changelog for package $1 found, sorry."
2762 _uchange() { _files -W /usr/share/doc -/ }
2763 compdef _uchange uchange
2768 ZSH_PROFILE_RC=1 $SHELL "$@"
2771 #f1# Edit an alias via zle
2773 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2775 compdef _aliases edalias
2777 #f1# Edit a function via zle
2779 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
2781 compdef _functions edfunc
2783 # use it e.g. via 'Restart apache2'
2784 #m# f6 Start() \kbd{/etc/init.d/\em{process}}\quad\kbd{start}
2785 #m# f6 Restart() \kbd{/etc/init.d/\em{process}}\quad\kbd{restart}
2786 #m# f6 Stop() \kbd{/etc/init.d/\em{process}}\quad\kbd{stop}
2787 #m# f6 Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{reload}
2788 #m# f6 Force-Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{force-reload}
2789 #m# f6 Status() \kbd{/etc/init.d/\em{process}}\quad\kbd{status}
2790 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2792 local action_="${1:l}" # e.g Start/Stop/Restart
2796 local service_target_="$(readlink /etc/init.d/$service_)"
2797 if [[ $service_target_ == "/usr/bin/sv" ]]; then
2799 case "${action_}" in
2800 start) if [[ ! -e /etc/service/$service_ ]]; then
2801 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2803 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2805 # there is no reload in runits sysv emulation
2806 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2807 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2811 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2817 scripts=( /etc/init.d/*(x:t) )
2818 _describe "service startup script" scripts
2821 for i in Start Restart Stop Force-Reload Reload Status ; do
2822 eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
2823 compdef _grmlinitd $i
2827 #f1# Provides useful information on globbing
2834 p named pipes (FIFOs)
2835 * executable plain files (0100)
2836 % device files (character or block special)
2837 %b block special files
2838 %c character special files
2839 r owner-readable files (0400)
2840 w owner-writable files (0200)
2841 x owner-executable files (0100)
2842 A group-readable files (0040)
2843 I group-writable files (0020)
2844 E group-executable files (0010)
2845 R world-readable files (0004)
2846 W world-writable files (0002)
2847 X world-executable files (0001)
2848 s setuid files (04000)
2849 S setgid files (02000)
2850 t files with the sticky bit (01000)
2852 print *(m-1) # Files modified up to a day ago
2853 print *(a1) # Files accessed a day ago
2854 print *(@) # Just symlinks
2855 print *(Lk+50) # Files bigger than 50 kilobytes
2856 print *(Lk-50) # Files smaller than 50 kilobytes
2857 print **/*.c # All *.c files recursively starting in \$PWD
2858 print **/*.c~file.c # Same as above, but excluding 'file.c'
2859 print (foo|bar).* # Files starting with 'foo' or 'bar'
2860 print *~*.* # All Files that do not contain a dot
2861 chmod 644 *(.^x) # make all plain non-executable files publically readable
2862 print -l *(.c|.h) # Lists *.c and *.h
2863 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
2864 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
2866 alias help-zshglob=H-Glob
2868 # grep for running process, like: 'any vim'
2872 if [[ -z "$1" ]] ; then
2873 echo "any - grep for process(es) by keyword" >&2
2874 echo "Usage: any <keyword>" >&2 ; return 1
2876 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
2881 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
2882 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
2883 [[ -r /proc/1/maps ]] && \
2885 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
2886 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
2887 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
2890 # a wrapper for vim, that deals with title setting
2892 # set this array to a set of options to vim you always want
2893 # to have set when calling vim (in .zshrc.local), like:
2894 # VIM_OPTIONS=( -p )
2895 # This will cause vim to send every file given on the
2896 # commandline to be send to it's own tab (needs vim7).
2897 if check_com vim; then
2899 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
2903 ssl_hashes=( sha512 sha256 sha1 md5 )
2905 for sh in ${ssl_hashes}; do
2906 eval 'ssl-cert-'${sh}'() {
2908 if [[ -z $1 ]] ; then
2909 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
2912 openssl x509 -noout -fingerprint -'${sh}' -in $1
2916 ssl-cert-fingerprints() {
2919 if [[ -z $1 ]] ; then
2920 printf 'usage: ssl-cert-fingerprints <file>\n'
2923 for i in ${ssl_hashes}
2930 if [[ -z $1 ]] ; then
2931 printf 'usage: ssl-cert-info <file>\n'
2934 openssl x509 -noout -text -in $1
2935 ssl-cert-fingerprints $1
2938 # make sure our environment is clean regarding colors
2939 for color in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $color
2941 # "persistent history"
2942 # just write important commands you always need to ~/.important_commands
2943 if [[ -r ~/.important_commands ]] ; then
2944 fc -R ~/.important_commands
2947 # load the lookup subsystem if it's available on the system
2948 zrcautoload lookupinit && lookupinit
2952 # set terminal property (used e.g. by msgid-chooser)
2953 export COLORTERM="yes"
2958 #a2# Execute \kbd{du -sch}
2962 #a2# Execute \kbd{ls -lSrah}
2963 alias dir="command ls -lSrah"
2964 #a2# Only show dot-directories
2965 alias lad='command ls -d .*(/)'
2966 #a2# Only show dot-files
2967 alias lsa='command ls -a .*(.)'
2968 #a2# Only files with setgid/setuid/sticky flag
2969 alias lss='command ls -l *(s,S,t)'
2970 #a2# Only show symlinks
2971 alias lsl='command ls -l *(@)'
2972 #a2# Display only executables
2973 alias lsx='command ls -l *(*)'
2974 #a2# Display world-{readable,writable,executable} files
2975 alias lsw='command ls -ld *(R,W,X.^ND/)'
2976 #a2# Display the ten biggest files
2977 alias lsbig="command ls -flh *(.OL[1,10])"
2978 #a2# Only show directories
2979 alias lsd='command ls -d *(/)'
2980 #a2# Only show empty directories
2981 alias lse='command ls -d *(/^F)'
2982 #a2# Display the ten newest files
2983 alias lsnew="command ls -rtlh *(D.om[1,10])"
2984 #a2# Display the ten oldest files
2985 alias lsold="command ls -rtlh *(D.Om[1,10])"
2986 #a2# Display the ten smallest files
2987 alias lssmall="command ls -Srl *(.oL[1,10])"
2988 #a2# Display the ten newest directories and ten newest .directories
2989 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
2990 #a2# Display the ten oldest directories and ten oldest .directories
2991 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
2993 # some useful aliases
2994 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
2995 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
2997 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
2998 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
2999 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3000 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3002 # work around non utf8 capable software in utf environment via $LANG and luit
3003 if check_com isutfenv && check_com luit ; then
3004 if check_com -c mrxvt ; then
3005 isutfenv && [[ -n "$LANG" ]] && \
3006 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3009 if check_com -c aterm ; then
3010 isutfenv && [[ -n "$LANG" ]] && \
3011 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3014 if check_com -c centericq ; then
3015 isutfenv && [[ -n "$LANG" ]] && \
3016 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3022 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3025 local current_date=$(date -u "+%Y-%m-%dT%H:%M:%SZ")
3026 local clean keep move verbose result
3027 setopt extended_glob
3030 bk [-hcmv] FILE [FILE ...]
3031 bk -r [-v] [FILE [FILE ...]]
3032 Backup a file or folder in place and append the timestamp
3033 Remove backups of a file or folder, or all backups in the current directory
3036 -h Display this help text
3037 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3038 -m Move the file/folder, using mv(1)
3039 -r Remove backups of the specified file or directory, using rm(1). If none
3040 is provided, remove all backups in the current directory.
3043 The -c, -r and -m options are mutually exclusive. If specified at the same time,
3044 the last one is used.
3046 The return code is the sum of all cp/mv/rm return codes.
3050 while getopts ":hcmrv" opt; do
3052 c) unset move clean && (( ++keep ));;
3053 m) unset keep clean && (( ++move ));;
3054 r) unset move keep && (( ++clean ));;
3057 \?) usage >&2; return 1;;
3060 shift "$((OPTIND-1))"
3061 if (( keep > 0 )); then
3062 while (( $# > 0 )); do
3063 if islinux ||Â isfreebsd; then
3064 cp $verbose -a "${1%/}" "${1%/}_$current_date"
3066 cp $verbose -pR "${1%/}" "${1%/}_$current_date"
3071 elif (( move > 0 )); then
3072 while (( $# > 0 )); do
3073 mv $verbose "${1%/}" "${1%/}_$current_date"
3077 elif (( clean > 0 )); then
3078 if (( $# > 0 )); then
3079 while (( $# > 0 )); do
3080 rm $verbose -rf "${1%/}"_[0-9](#c4,)-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3])(:[0-5][0-9])(#c2)Z
3085 rm $verbose -rf *_[0-9](#c4,)-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1])T([0-1][0-9]|2[0-3])(:[0-5][0-9])(#c2)Z
3092 #f5# cd to directoy and list files
3098 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3100 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3101 [[ ! -e ${1:h} ]] && return 1
3102 print "Correcting ${1} to ${1:h}"
3109 #f5# Create Directoy and \kbd{cd} to it
3111 if (( ARGC != 1 )); then
3112 printf 'usage: mkcd <new-directory>\n'
3115 if [[ ! -d "$1" ]]; then
3116 command mkdir -p "$1"
3118 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3123 #f5# Create temporary directory and \kbd{cd} to it
3131 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3134 print -l -- *(a-${1:-1})
3137 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3140 print -l -- *(c-${1:-1})
3143 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3146 print -l -- *(m-${1:-1})
3148 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3149 check_com new || alias new=modified
3151 # use colors when GNU grep with color-support
3152 if (( $#grep_options > 0 )); then
3153 o=${grep_options:+"${grep_options[*]}"}
3154 #a2# Execute \kbd{grep -{}-color=auto}
3155 alias grep='grep '$o
3156 alias egrep='egrep '$o
3161 # 'translate' looks up fot a word in a file with language-to-language
3162 # translations (field separator should be " : "). A typical wordlist looks
3164 # | english-word : german-transmission
3165 # It's also only possible to translate english to german but not reciprocal.
3166 # Use the following oneliner to turn back the sort order:
3167 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3168 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3169 #f5# Translates a word
3174 translate -l de-en $2
3177 translate -l en-de $2
3180 echo "Usage: $0 { -D | -E }"
3181 echo " -D == German to English"
3182 echo " -E == English to German"
3186 # Usage: simple-extract <file>
3187 # Using option -d deletes the original archive file.
3188 #f5# Smart archive extractor
3191 setopt extended_glob noclobber
3192 local DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3194 zparseopts -D -E "d=DELETE_ORIGINAL"
3195 for ARCHIVE in "${@}"; do
3197 *(tar.bz2|tbz2|tbz))
3198 DECOMP_CMD="tar -xvjf -"
3203 DECOMP_CMD="tar -xvzf -"
3207 *(tar.xz|txz|tar.lzma))
3208 DECOMP_CMD="tar -xvJf -"
3213 DECOMP_CMD="tar -xvf -"
3218 DECOMP_CMD="unrar x"
3243 DECOMP_CMD="bzip2 -d -c -"
3248 DECOMP_CMD="gzip -d -c -"
3253 DECOMP_CMD="xz -d -c -"
3258 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3264 if ! check_com ${DECOMP_CMD[(w)1]}; then
3265 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3270 GZTARGET="${ARCHIVE:t:r}"
3271 if [[ -f $ARCHIVE ]] ; then
3273 print "Extracting '$ARCHIVE' ..."
3274 if $USES_STDIN; then
3275 if $USES_STDOUT; then
3276 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3278 ${=DECOMP_CMD} < "$ARCHIVE"
3281 if $USES_STDOUT; then
3282 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3284 ${=DECOMP_CMD} "$ARCHIVE"
3287 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3289 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3290 if check_com curl; then
3291 WGET_CMD="curl -L -k -s -o -"
3292 elif check_com wget; then
3293 WGET_CMD="wget -q -O - --no-check-certificate"
3295 print "ERROR: neither wget nor curl is installed" >&2
3299 print "Downloading and Extracting '$ARCHIVE' ..."
3300 if $USES_STDIN; then
3301 if $USES_STDOUT; then
3302 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3305 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3309 if $USES_STDOUT; then
3310 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3312 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3317 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3327 '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)"' \
3328 '_urls:Remote Archives:_urls'
3334 '-d[delete original archivefile after extraction]' \
3335 '*:Archive Or Uri:__archive_or_uri'
3337 compdef _simple_extract simple-extract
3338 alias se=simple-extract
3340 #f5# Set all ulimit parameters to \kbd{unlimited}
3351 #f5# Change the xterm title from within GNU-screen
3354 if [[ $1 != "-f" ]] ; then
3355 if [[ -z ${DISPLAY} ]] ; then
3356 printf 'xtrename only makes sense in X11.\n'
3362 if [[ -z $1 ]] ; then
3363 printf 'usage: xtrename [-f] "title for xterm"\n'
3364 printf ' renames the title of xterm from _within_ screen.\n'
3365 printf ' also works without screen.\n'
3366 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3369 print -n "\eP\e]0;${1}\C-G\e\\"
3373 # Create small urls via http://goo.gl using curl(1).
3374 # API reference: https://code.google.com/apis/urlshortener/
3377 setopt extended_glob
3379 if [[ -z $1 ]]; then
3380 print "USAGE: zurl <URL>"
3384 local PN url prog api json contenttype item
3389 # Prepend 'http://' to given URL where necessary for later output.
3390 if [[ ${url} != http(s|)://* ]]; then
3394 if check_com -c curl; then
3397 print "curl is not available, but mandatory for ${PN}. Aborting."
3400 api='https://www.googleapis.com/urlshortener/v1/url'
3401 contenttype="Content-Type: application/json"
3402 json="{\"longUrl\": \"${url}\"}"
3403 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3404 # Parse the response
3405 for item in "${data[@]}"; do
3410 printf '%s\n' "$item"
3418 #f2# Find history events by search pattern and list them by date.
3421 local usage help ident format_l format_s first_char remain first last
3422 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3423 help='Use `whatwhen -h'\'' for further explanations.'
3424 ident=${(l,${#${:-Usage: }},, ,)}
3425 format_l="${ident}%s\t\t\t%s\n"
3426 format_s="${format_l//(\\t)##/\\t}"
3427 # Make the first char of the word to search for case
3428 # insensitive; e.g. [aA]
3429 first_char=[${(L)1[1]}${(U)1[1]}]
3431 # Default search range is `-100'.
3433 # Optional, just used for `<first> <last>' given.
3437 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3438 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3441 printf '%s\n\n' ${usage}
3443 printf $format_l '-h' 'show help text'
3445 print 'SEARCH RANGE:'
3446 printf $format_l "'0'" 'the whole history,'
3447 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3448 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3449 printf '\n%s\n' 'EXAMPLES:'
3450 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3451 printf $format_l 'whatwhen zsh -250'
3452 printf $format_l 'whatwhen foo 1 99'
3455 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3458 # -l list results on stout rather than invoking $EDITOR.
3459 # -i Print dates as in YYYY-MM-DD.
3460 # -m Search for a - quoted - pattern within the history.
3461 fc -li -m "*${first_char}${remain}*" $first $last
3466 # mercurial related stuff
3467 if check_com -c hg ; then
3468 # gnu like diff for mercurial
3469 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3470 #f5# GNU like diff for mercurial
3473 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3476 # build debian package
3477 #a2# Alias for \kbd{hg-buildpackage}
3478 alias hbp='hg-buildpackage'
3480 # execute commands on the versioned patch-queue from the current repos
3481 alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3483 # diffstat for specific version of a mercurial repository
3484 # hgstat => display diffstat between last revision and tip
3485 # hgstat 1234 => display diffstat between revision 1234 and tip
3486 #f5# Diffstat for specific version of a mercurial repos
3489 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3492 fi # end of check whether we have the 'hg'-executable
3494 # grml-small cleanups
3496 # The following is used to remove zsh-config-items that do not work
3497 # in grml-small by default.
3498 # If you do not want these adjustments (for whatever reason), set
3499 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3500 # sources if it is there).
3502 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3505 unalias 'V' &> /dev/null
3506 unfunction vman &> /dev/null
3507 unfunction viless &> /dev/null
3508 unfunction 2html &> /dev/null
3510 # manpages are not in grmlsmall
3511 unfunction manzsh &> /dev/null
3512 unfunction man2 &> /dev/null
3518 ## genrefcard.pl settings
3520 ### doc strings for external functions from files
3521 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3523 ### example: split functions-search 8,16,24,32
3524 #@# split functions-search 8
3526 ## END OF FILE #################################################################
3527 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4