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/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
768 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
779 zstyle ':completion:*:hosts' hosts $hosts
780 # TODO: so, why is this here?
781 # zstyle '*' hosts $hosts
783 # use generic completion system for programs not yet defined; (_gnu_generic works
784 # with commands that provide a --help option with "standard" gnu-like output.)
785 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
786 pal stow tail uname ; do
787 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
790 # see upgrade function in this file
791 compdef _hosts upgrade
794 # Keyboard setup: The following is based on the same code, we wrote for
795 # debian's setup. It ensures the terminal is in the right mode, when zle is
796 # active, so the values from $terminfo are valid. Therefore, this setup should
797 # work on all systems, that have support for `terminfo'. It also requires the
798 # zsh in use to have the `zsh/terminfo' module built.
800 # If you are customising your `zle-line-init()' or `zle-line-finish()'
801 # functions, make sure you call the following utility functions in there:
803 # - zle-line-init(): zle-smkx
804 # - zle-line-finish(): zle-rmkx
806 # Use emacs-like key bindings by default:
811 ## beginning-of-line OR beginning-of-buffer OR beginning of history
812 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
813 beginning-or-end-of-somewhere() {
815 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
816 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
817 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
819 zle .${WIDGET:s/somewhere/line-hist/} "$@"
820 if (( HISTNO != hno )); then
821 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
825 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
826 zle -N end-of-somewhere beginning-or-end-of-somewhere
828 # add a command line to the shells history without executing it
829 commit-to-history() {
830 print -s ${(z)BUFFER}
833 zle -N commit-to-history
835 # only slash should be considered as a word separator:
836 slash-backward-kill-word() {
837 local WORDCHARS="${WORDCHARS:s@/@}"
839 zle backward-kill-word
841 zle -N slash-backward-kill-word
843 # a generic accept-line wrapper
845 # This widget can prevent unwanted autocorrections from command-name
846 # to _command-name, rehash automatically on enter and call any number
847 # of builtin and user-defined widgets in different contexts.
849 # For a broader description, see:
850 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
852 # The code is imported from the file 'zsh/functions/accept-line' from
853 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
854 # distributed under the same terms as zsh itself.
856 # A newly added command will may not be found or will cause false
857 # correction attempts, if you got auto-correction set. By setting the
858 # following style, we force accept-line() to rehash, if it cannot
859 # find the first word on the command line in the $command[] hash.
860 zstyle ':acceptline:*' rehash true
862 function Accept-Line() {
863 setopt localoptions noksharrays
867 local alcontext=${1:-$alcontext}
869 zstyle -a ":acceptline:${alcontext}" actions subs
871 (( ${#subs} < 1 )) && return 0
874 for sub in ${subs} ; do
875 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
878 (( aldone > 0 )) && break
882 function Accept-Line-getdefault() {
886 zstyle -s ":acceptline:${alcontext}" default_action default_action
887 case ${default_action} in
889 printf ".accept-line"
892 printf ${default_action}
897 function Accept-Line-HandleContext() {
900 default_action=$(Accept-Line-getdefault)
901 zstyle -T ":acceptline:${alcontext}" call_default \
902 && zle ${default_action}
905 function accept-line() {
906 setopt localoptions noksharrays
909 local buf com fname format msg default_action
913 cmdline=(${(z)BUFFER})
917 Accept-Line 'preprocess'
919 zstyle -t ":acceptline:${alcontext}" rehash \
920 && [[ -z ${commands[$com]} ]] \
924 && [[ -n ${reswords[(r)$com]} ]] \
925 || [[ -n ${aliases[$com]} ]] \
926 || [[ -n ${functions[$com]} ]] \
927 || [[ -n ${builtins[$com]} ]] \
928 || [[ -n ${commands[$com]} ]] ; then
930 # there is something sensible to execute, just do it.
932 Accept-Line-HandleContext
937 if [[ -o correct ]] \
938 || [[ -o correctall ]] \
939 && [[ -n ${functions[$fname]} ]] ; then
941 # nothing there to execute but there is a function called
942 # _command_name; a completion widget. Makes no sense to
943 # call it on the commandline, but the correct{,all} options
944 # will ask for it nevertheless, so warn the user.
945 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
946 # Okay, we warned the user before, he called us again,
947 # so have it his way.
949 Accept-Line-HandleContext
954 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
956 Accept-Line-HandleContext
958 # prepare warning message for the user, configurable via zstyle.
959 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
961 if [[ -z ${msg} ]] ; then
962 msg="%c will not execute and completion %f exists."
965 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
970 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
971 # If we are here, the commandline contains something that is not
972 # executable, which is neither subject to _command_name correction
973 # and is not empty. might be a variable assignment
975 Accept-Line-HandleContext
980 # If we got this far, the commandline only contains whitespace, or is empty.
982 Accept-Line-HandleContext
987 zle -N Accept-Line-HandleContext
989 # power completion / abbreviation expansion / buffer expansion
990 # see http://zshwiki.org/home/examples/zleiab for details
991 # less risky than the global aliases but powerful as well
992 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
995 setopt interactivecomments
997 # key # value (#d additional doc string)
1003 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1005 'Hl' ' --help |& less -r' #d (Display help in pager)
1009 'N' '&>/dev/null' #d (No Output)
1010 'R' '| tr A-z N-za-m' #d (ROT13)
1011 'SL' '| sort | less'
1016 'co' './configure && make && sudo make install'
1024 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1025 LBUFFER+=${abk[$MATCH]:-$MATCH}
1032 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1035 zle -N help-show-abk
1037 # press "ctrl-e d" to insert the actual date in the form yyyy-mm-dd
1038 insert-datestamp() { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1039 zle -N insert-datestamp
1041 # press esc-m for inserting last typed word again (thanks to caphuso!)
1042 insert-last-typed-word() { zle insert-last-word -- 0 -1 };
1043 zle -N insert-last-typed-word;
1045 function grml-zsh-fg() {
1046 if (( ${#jobstates} )); then
1048 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1049 BUFFER="${BUFFER}fg"
1052 zle -M 'No background jobs. Doing nothing.'
1057 # run command line as user root via sudo:
1058 sudo-command-line() {
1059 [[ -z $BUFFER ]] && zle up-history
1060 if [[ $BUFFER != sudo\ * ]]; then
1061 BUFFER="sudo $BUFFER"
1062 CURSOR=$(( CURSOR+5 ))
1065 zle -N sudo-command-line
1067 ### jump behind the first word on the cmdline.
1068 ### useful to add options.
1069 function jump_after_first_word() {
1071 words=(${(z)BUFFER})
1073 if (( ${#words} <= 1 )) ; then
1076 CURSOR=${#${words[1]}}
1079 zle -N jump_after_first_word
1081 #f5# Create directory under cursor or the selected area
1083 # Press ctrl-xM to create the directory under the cursor or the selected area.
1084 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1085 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1086 # directory does not exist yet -> press ctrl-XM and problem solved
1088 if ((REGION_ACTIVE==1)); then
1089 local F=$MARK T=$CURSOR
1090 if [[ $F -gt $T ]]; then
1094 # get marked area from buffer and eliminate whitespace
1095 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1096 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1098 local bufwords iword
1099 bufwords=(${(z)LBUFFER})
1101 bufwords=(${(z)BUFFER})
1102 PATHTOMKDIR="${(Q)bufwords[iword]}"
1104 [[ -z "${PATHTOMKDIR}" ]] && return 1
1105 PATHTOMKDIR=${~PATHTOMKDIR}
1106 if [[ -e "${PATHTOMKDIR}" ]]; then
1107 zle -M " path already exists, doing nothing"
1109 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1114 zle -N inplaceMkDirs
1116 #v1# set number of lines to display per page
1117 HELP_LINES_PER_PAGE=20
1118 #v1# set location of help-zle cache file
1119 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1120 # helper function for help-zle, actually generates the help text
1121 help_zle_parse_keybindings()
1125 unsetopt ksharrays #indexing starts at 1
1127 #v1# choose files that help-zle will parse for keybindings
1128 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1130 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1132 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1133 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1136 #fill with default keybindings, possibly to be overwriten in a file later
1137 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1138 local -A help_zle_keybindings
1139 help_zle_keybindings['<Ctrl>@']="set MARK"
1140 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1141 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1142 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1143 help_zle_keybindings['<Ctrl>_']="undo"
1144 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1145 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1146 help_zle_keybindings['<Ctrl>e']="goto end of line"
1147 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1148 help_zle_keybindings['<Alt>t']="transpose words"
1149 help_zle_keybindings['<Alt>s']="spellcheck word"
1150 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1151 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1152 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1153 help_zle_keybindings["<Alt>'"]="quote line"
1154 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1155 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1156 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1157 help_zle_keybindings['<Alt>l']="make next word lowercase"
1158 help_zle_keybindings['<Ctrl>xd']="preview expansion under cursor"
1159 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1160 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1161 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1162 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1163 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1164 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1165 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1166 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1168 #init global variables
1169 unset help_zle_lines help_zle_sln
1170 typeset -g -a help_zle_lines
1171 typeset -g help_zle_sln=1
1174 local lastkeybind_desc contents #last description starting with #k# that we found
1175 local num_lines_elapsed=0 #number of lines between last description and keybinding
1176 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1177 for f in $HELPZLE_KEYBINDING_FILES; do
1178 [[ -r "$f" ]] || continue #not readable ? skip it
1180 for cline in "${(f)contents}"; do
1181 #zsh pattern: matches lines like: #k# ..............
1182 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1183 lastkeybind_desc="$match[*]"
1185 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1186 # ignores lines that are commentend out
1187 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1188 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1189 #description prevously found ? description not more than 2 lines away ? keybinding not empty ?
1190 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1191 #substitute keybinding string with something readable
1192 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1193 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1194 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1195 help_zle_keybindings[${k}]=$lastkeybind_desc
1199 ((num_lines_elapsed++))
1204 #calculate length of keybinding column
1206 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1207 #convert the assoc array into preformated lines, which we are able to sort
1208 for k v in ${(kv)help_zle_keybindings[@]}; do
1209 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1210 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1212 #sort lines alphabetically
1213 help_zle_lines=("${(i)help_zle_lines[@]}")
1214 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1215 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1216 zcompile $HELP_ZLE_CACHE_FILE
1218 typeset -g help_zle_sln
1219 typeset -g -a help_zle_lines
1221 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1225 unsetopt ksharrays #indexing starts at 1
1226 #help lines already generated ? no ? then do it
1227 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1228 #already displayed all lines ? go back to the start
1229 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1230 local sln=$help_zle_sln
1231 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1232 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1233 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1237 ## complete word from currently visible Screen or Tmux buffer.
1238 if check_com -c screen || check_com -c tmux; then
1239 _complete_screen_display() {
1240 [[ "$TERM" != "screen" ]] && return 1
1242 local TMPFILE=$(mktemp)
1243 local -U -a _screen_display_wordlist
1244 trap "rm -f $TMPFILE" EXIT
1246 # fill array with contents from screen hardcopy
1247 if ((${+TMUX})); then
1248 #works, but crashes tmux below version 1.4
1249 #luckily tmux -V option to ask for version, was also added in 1.4
1250 tmux -V &>/dev/null || return
1251 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1253 screen -X hardcopy $TMPFILE
1254 # screen sucks, it dumps in latin1, apparently always. so recode it
1256 check_com recode && recode latin1 $TMPFILE
1258 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1259 # remove PREFIX to be completed from that array
1260 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1261 compadd -a _screen_display_wordlist
1263 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1265 compdef -k _complete_screen_display complete-word '^xS'
1268 # Load a few more functions and tie them to widgets, so they can be bound:
1270 function zrcautozle() {
1273 zrcautoload $fnc && zle -N $fnc
1276 function zrcgotwidget() {
1277 (( ${+widgets[$1]} ))
1280 function zrcgotkeymap() {
1281 [[ -n ${(M)keymaps:#$1} ]]
1284 zrcautozle insert-files
1285 zrcautozle edit-command-line
1286 zrcautozle insert-unicode-char
1287 if zrcautoload history-search-end; then
1288 zle -N history-beginning-search-backward-end history-search-end
1289 zle -N history-beginning-search-forward-end history-search-end
1291 zle -C hist-complete complete-word _generic
1292 zstyle ':completion:hist-complete:*' completer _history
1294 # The actual terminal setup hooks and bindkey-calls:
1296 # An array to note missing features to ease diagnosis in case of problems.
1297 typeset -ga grml_missing_features
1299 function zrcbindkey() {
1300 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1305 function bind2maps () {
1306 local i sequence widget
1309 while [[ "$1" != "--" ]]; do
1315 if [[ "$1" == "-s" ]]; then
1319 sequence="${key[$1]}"
1323 [[ -z "$sequence" ]] && return 1
1325 for i in "${maps[@]}"; do
1326 zrcbindkey -M "$i" "$sequence" "$widget"
1330 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1331 function zle-smkx () {
1333 printf '%s' ${terminfo[smkx]}
1335 function zle-rmkx () {
1337 printf '%s' ${terminfo[rmkx]}
1339 function zle-line-init () {
1342 function zle-line-finish () {
1345 zle -N zle-line-init
1346 zle -N zle-line-finish
1348 for i in {s,r}mkx; do
1349 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1356 Home "${terminfo[khome]}"
1357 End "${terminfo[kend]}"
1358 Insert "${terminfo[kich1]}"
1359 Delete "${terminfo[kdch1]}"
1360 Up "${terminfo[kcuu1]}"
1361 Down "${terminfo[kcud1]}"
1362 Left "${terminfo[kcub1]}"
1363 Right "${terminfo[kcuf1]}"
1364 PageUp "${terminfo[kpp]}"
1365 PageDown "${terminfo[knp]}"
1366 BackTab "${terminfo[kcbt]}"
1369 # Guidelines for adding key bindings:
1371 # - Do not add hardcoded escape sequences, to enable non standard key
1372 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1374 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1377 # - All keys from the $key[] mapping are obviously okay.
1379 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1380 # '\ex' are allowed in here as well.
1382 bind2maps emacs -- Home beginning-of-somewhere
1383 bind2maps viins vicmd -- Home vi-beginning-of-line
1384 bind2maps emacs -- End end-of-somewhere
1385 bind2maps viins vicmd -- End vi-end-of-line
1386 bind2maps emacs viins -- Insert overwrite-mode
1387 bind2maps vicmd -- Insert vi-insert
1388 bind2maps emacs -- Delete delete-char
1389 bind2maps viins vicmd -- Delete vi-delete-char
1390 bind2maps emacs viins vicmd -- Up up-line-or-search
1391 bind2maps emacs viins vicmd -- Down down-line-or-search
1392 bind2maps emacs -- Left backward-char
1393 bind2maps viins vicmd -- Left vi-backward-char
1394 bind2maps emacs -- Right forward-char
1395 bind2maps viins vicmd -- Right vi-forward-char
1396 #k# Perform abbreviation expansion
1397 bind2maps emacs viins -- -s '^x.' zleiab
1398 #k# Display list of abbreviations that would expand
1399 bind2maps emacs viins -- -s '^xb' help-show-abk
1400 #k# mkdir -p <dir> from string under cursor or marked area
1401 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1402 #k# display help for keybindings and ZLE
1403 bind2maps emacs viins -- -s '^xz' help-zle
1404 #k# Insert files and test globbing
1405 bind2maps emacs viins -- -s "^xf" insert-files
1406 #k# Edit the current line in \kbd{\$EDITOR}
1407 bind2maps emacs viins -- -s '\ee' edit-command-line
1408 #k# search history backward for entry beginning with typed text
1409 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1410 #k# search history forward for entry beginning with typed text
1411 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1412 #k# search history backward for entry beginning with typed text
1413 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1414 #k# search history forward for entry beginning with typed text
1415 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1416 bind2maps emacs viins -- -s "^x^h" commit-to-history
1417 #k# Kill left-side word or everything up to next slash
1418 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1419 #k# Kill left-side word or everything up to next slash
1420 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1421 #k# Kill left-side word or everything up to next slash
1422 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1423 # Do history expansion on space:
1424 bind2maps emacs viins -- -s ' ' magic-space
1425 #k# Trigger menu-complete
1426 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1427 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1428 bind2maps emacs viins -- -s '^ed' insert-datestamp
1429 #k# Insert last typed word
1430 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1431 #k# A smart shortcut for \kbd{fg<enter>}
1432 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1433 #k# prepend the current command with "sudo"
1434 bind2maps emacs viins -- -s "^os" sudo-command-line
1435 #k# jump to after first word (for adding options)
1436 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1437 #k# complete word from history with menu
1438 bind2maps emacs viins -- -s "^x^x" hist-complete
1440 # insert unicode character
1441 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1442 # See for example http://unicode.org/charts/ for unicode characters code
1443 #k# Insert Unicode character
1444 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1446 # use the new *-pattern-* widgets for incremental history search
1447 if zrcgotwidget history-incremental-pattern-search-backward; then
1448 for seq wid in '^r' history-incremental-pattern-search-backward \
1449 '^s' history-incremental-pattern-search-forward
1451 bind2maps emacs viins vicmd -- -s $seq $wid
1455 if zrcgotkeymap menuselect; then
1456 #m# k Shift-tab Perform backwards menu completion
1457 bind2maps menuselect -- BackTab reverse-menu-complete
1459 #k# menu selection: pick item but stay in the menu
1460 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1461 # also use + and INSERT since it's easier to press repeatedly
1462 bind2maps menuselect -- -s '+' accept-and-menu-complete
1463 bind2maps menuselect -- Insert accept-and-menu-complete
1465 # accept a completion and try to complete again by using menu
1466 # completion; very useful with completing directories
1467 # by using 'undo' one's got a simple file browser
1468 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1471 # Finally, here are still a few hardcoded escape sequences; Special sequences
1472 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1473 # standardised and most of the time are not available in a terminals terminfo
1476 # While we do not encourage adding bindings like these, we will keep these for
1477 # backward compatibility.
1479 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1480 ## the command line.
1482 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1483 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1484 # These are for xterm:
1485 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1486 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1487 ## the same for alt-left-arrow and alt-right-arrow
1489 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1490 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1492 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1493 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1494 # Also try ESC Left/Right:
1495 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1496 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1503 # we don't want to quote/espace URLs on our own...
1504 # if autoload -U url-quote-magic ; then
1505 # zle -N self-insert url-quote-magic
1506 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1508 # print 'Notice: no url-quote-magic available :('
1510 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1512 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1513 alias run-help >&/dev/null && unalias run-help
1514 for rh in run-help{,-git,-svk,-svn}; do
1518 # command not found handling
1520 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1521 function command_not_found_handler() {
1523 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1524 ${GRML_ZSH_CNF_HANDLER} $1
1531 ZSHDIR=${ZDOTDIR:-${HOME}/.zsh}
1534 HISTFILE=${ZDOTDIR:-${HOME}}/.zsh_history
1535 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1536 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1540 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1541 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1543 if [[ -f ${DIRSTACKFILE} ]] && [[ ${#dirstack[*]} -eq 0 ]] ; then
1544 dirstack=( ${(f)"$(< $DIRSTACKFILE)"} )
1545 # "cd -" won't work after login by just setting $OLDPWD, so
1546 [[ -d $dirstack[1] ]] && cd $dirstack[1] && cd $OLDPWD
1550 if (( $DIRSTACKSIZE <= 0 )) || [[ -z $DIRSTACKFILE ]]; then return; fi
1552 my_stack=( ${PWD} ${dirstack} )
1554 builtin print -l ${(u)my_stack} >! ${DIRSTACKFILE}
1556 uprint my_stack >! ${DIRSTACKFILE}
1560 # directory based profiles
1564 # chpwd_profiles(): Directory Profiles, Quickstart:
1568 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1569 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1572 # For details see the `grmlzshrc.5' manual page.
1573 function chpwd_profiles() {
1574 local profile context
1577 context=":chpwd:profiles:$PWD"
1578 zstyle -s "$context" profile profile || profile='default'
1579 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1581 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1582 typeset -g CHPWD_PROFILE
1583 local CHPWD_PROFILES_INIT=1
1584 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1585 elif [[ $profile != $CHPWD_PROFILE ]]; then
1586 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1587 && chpwd_leave_profile_${CHPWD_PROFILE}
1589 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1590 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1593 CHPWD_PROFILE="${profile}"
1597 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1601 # Prompt setup for grml:
1603 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1604 # in prompts to get a red "foo" embedded, but it's good to keep these for
1605 # backwards compatibility).
1611 MAGENTA="%F{magenta}"
1615 elif zrcautoload colors && colors 2>/dev/null ; then
1616 BLUE="%{${fg[blue]}%}"
1617 RED="%{${fg_bold[red]}%}"
1618 GREEN="%{${fg[green]}%}"
1619 CYAN="%{${fg[cyan]}%}"
1620 MAGENTA="%{${fg[magenta]}%}"
1621 YELLOW="%{${fg[yellow]}%}"
1622 WHITE="%{${fg[white]}%}"
1623 NO_COLOR="%{${reset_color}%}"
1625 BLUE=$'%{\e[1;34m%}'
1627 GREEN=$'%{\e[1;32m%}'
1628 CYAN=$'%{\e[1;36m%}'
1629 WHITE=$'%{\e[1;37m%}'
1630 MAGENTA=$'%{\e[1;35m%}'
1631 YELLOW=$'%{\e[1;33m%}'
1632 NO_COLOR=$'%{\e[0m%}'
1635 # First, the easy ones: PS2..4:
1637 # secondary prompt, printed when the shell needs more information to complete a
1640 # selection prompt used within a select loop.
1642 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1645 # Some additional features to use with our prompt:
1649 # - vcs_info setup and version specific fixes
1651 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1654 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1657 elif isopenbsd ; then
1659 elif isfreebsd ; then
1661 elif isdarwin ; then
1665 GRML_DISPLAY_BATTERY=0
1671 GRML_BATTERY_LEVEL=''
1672 local batteries bat capacity
1673 batteries=( /sys/class/power_supply/BAT*(N) )
1674 if (( $#batteries > 0 )) ; then
1675 for bat in $batteries ; do
1676 capacity=$(< $bat/capacity)
1677 case $(< $bat/status) in
1679 GRML_BATTERY_LEVEL+=" ^"
1682 if (( capacity < 20 )) ; then
1683 GRML_BATTERY_LEVEL+=" !v"
1685 GRML_BATTERY_LEVEL+=" v"
1689 GRML_BATTERY_LEVEL+=" ="
1692 GRML_BATTERY_LEVEL+="${capacity}%%"
1698 GRML_BATTERY_LEVEL=''
1699 local bat batfull batwarn batnow num
1701 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1702 if [[ -n $bat ]]; then
1703 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1704 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1705 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1706 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1708 if (( batnow < batwarn )) ; then
1709 GRML_BATTERY_LEVEL+=" !v"
1711 GRML_BATTERY_LEVEL+=" v"
1715 GRML_BATTERY_LEVEL+=" ^"
1718 GRML_BATTERY_LEVEL+=" ="
1721 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1727 GRML_BATTERY_LEVEL=''
1731 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1732 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1733 case $table[State] in
1735 if (( $table[Remaining-capacity] < 20 )) ; then
1736 GRML_BATTERY_LEVEL+=" !v"
1738 GRML_BATTERY_LEVEL+=" v"
1742 GRML_BATTERY_LEVEL+=" ^"
1745 GRML_BATTERY_LEVEL+=" ="
1748 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1754 GRML_BATTERY_LEVEL=''
1756 table=( ${$(pmset -g ps)[(w)7,8]%%(\%|);} )
1757 if [[ -n $table[2] ]] ; then
1760 GRML_BATTERY_LEVEL+=" ^"
1763 if (( $table[1] < 20 )) ; then
1764 GRML_BATTERY_LEVEL+=" !v"
1766 GRML_BATTERY_LEVEL+=" v"
1770 GRML_BATTERY_LEVEL+=" ="
1773 GRML_BATTERY_LEVEL+="$table[1]%%"
1777 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1778 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1779 debian_chroot=$(</etc/debian_chroot)
1782 # gather version control information for inclusion in a prompt
1784 if zrcautoload vcs_info; then
1785 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1786 # function, which can cause a lot of trouble with our directory-based
1788 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1789 function VCS_INFO_realpath () {
1790 setopt localoptions NO_shwordsplit chaselinks
1791 ( builtin cd -q $1 2> /dev/null && pwd; )
1795 zstyle ':vcs_info:*' max-exports 2
1797 if [[ -o restricted ]]; then
1798 zstyle ':vcs_info:*' enable NONE
1802 typeset -A grml_vcs_coloured_formats
1803 typeset -A grml_vcs_plain_formats
1805 grml_vcs_plain_formats=(
1806 format "(%s%)-[%b] " "zsh: %r"
1807 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1808 rev-branchformat "%b:%r"
1811 grml_vcs_coloured_formats=(
1812 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1813 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1814 rev-branchformat "%b${RED}:${YELLOW}%r"
1817 typeset GRML_VCS_COLOUR_MODE=xxx
1819 grml_vcs_info_toggle_colour () {
1821 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
1822 grml_vcs_info_set_formats coloured
1824 grml_vcs_info_set_formats plain
1829 grml_vcs_info_set_formats () {
1831 #setopt localoptions xtrace
1832 local mode=$1 AF F BF
1833 if [[ $mode == coloured ]]; then
1834 AF=${grml_vcs_coloured_formats[actionformat]}
1835 F=${grml_vcs_coloured_formats[format]}
1836 BF=${grml_vcs_coloured_formats[rev-branchformat]}
1837 GRML_VCS_COLOUR_MODE=coloured
1839 AF=${grml_vcs_plain_formats[actionformat]}
1840 F=${grml_vcs_plain_formats[format]}
1841 BF=${grml_vcs_plain_formats[rev-branchformat]}
1842 GRML_VCS_COLOUR_MODE=plain
1845 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
1846 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
1847 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
1851 # Change vcs_info formats for the grml prompt. The 2nd format sets up
1852 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
1853 if [[ "$TERM" == dumb ]] ; then
1854 grml_vcs_info_set_formats plain
1856 grml_vcs_info_set_formats coloured
1859 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
1861 # This actually defines three prompts:
1867 # They all share the same code and only differ with respect to which items they
1868 # contain. The main source of documentation is the `prompt_grml_help' function
1869 # below, which gets called when the user does this: prompt -h grml
1871 function prompt_grml_help () {
1875 This is the prompt as used by the grml-live system <http://grml.org>. It is
1876 a rather simple one-line prompt, that by default looks something like this:
1878 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
1880 The prompt itself integrates with zsh's prompt themes system (as you are
1881 witnessing right now) and is configurable to a certain degree. In
1882 particular, these aspects are customisable:
1884 - The items used in the prompt (e.g. you can remove \`user' from
1885 the list of activated items, which will cause the user name to
1886 be omitted from the prompt string).
1888 - The attributes used with the items are customisable via strings
1889 used before and after the actual item.
1891 The available items are: at, battery, change-root, date, grml-chroot,
1892 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
1893 shell-level, time, user, vcs
1895 The actual configuration is done via zsh's \`zstyle' mechanism. The
1896 context, that is used while looking up styles is:
1898 ':prompt:grml:<left-or-right>:<subcontext>'
1900 Here <left-or-right> is either \`left' or \`right', signifying whether the
1901 style should affect the left or the right prompt. <subcontext> is either
1902 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
1906 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
1907 in $RPROMPT if the last command a returned non-successful error code.
1908 (This in only valid if <left-or-right> is "right"; ignored otherwise)
1910 - items (list): The list of items used in the prompt. If \`vcs' is
1911 present in the list, the theme's code invokes \`vcs_info'
1912 accordingly. Default (left): rc change-root user at host path vcs
1913 percent; Default (right): sad-smiley
1915 Available styles in 'items:<item>' are: pre, post. These are strings that
1916 are inserted before (pre) and after (post) the item in question. Thus, the
1917 following would cause the user name to be printed in red instead of the
1920 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
1922 Note, that the \`post' style may remain at its default value, because its
1923 default value is '%f', which turns the foreground text attribute off (which
1924 is exactly, what is still required with the new \`pre' value).
1928 function prompt_grml-chroot_help () {
1932 This is a variation of the grml prompt, see: prompt -h grml
1934 The main difference is the default value of the \`items' style. The rest
1935 behaves exactly the same. Here are the defaults for \`grml-chroot':
1937 - left: grml-chroot user at host path percent
1938 - right: (empty list)
1942 function prompt_grml-large_help () {
1946 This is a variation of the grml prompt, see: prompt -h grml
1948 The main difference is the default value of the \`items' style. In
1949 particular, this theme uses _two_ lines instead of one with the plain
1950 \`grml' theme. The rest behaves exactly the same. Here are the defaults
1953 - left: rc jobs history shell-level change-root time date newline user
1954 at host path vcs percent
1959 function grml_prompt_setup () {
1961 autoload -Uz vcs_info
1962 autoload -Uz add-zsh-hook
1963 add-zsh-hook precmd prompt_$1_precmd
1966 function prompt_grml_setup () {
1967 grml_prompt_setup grml
1970 function prompt_grml-chroot_setup () {
1971 grml_prompt_setup grml-chroot
1974 function prompt_grml-large_setup () {
1975 grml_prompt_setup grml-large
1978 # These maps define default tokens and pre-/post-decoration for items to be
1979 # used within the themes. All defaults may be customised in a context sensitive
1980 # matter by using zsh's `zstyle' mechanism.
1981 typeset -gA grml_prompt_pre_default \
1982 grml_prompt_post_default \
1983 grml_prompt_token_default \
1984 grml_prompt_token_function
1986 grml_prompt_pre_default=(
1991 grml-chroot '%F{red}'
2001 shell-level '%F{red}'
2007 grml_prompt_post_default=(
2028 grml_prompt_token_default=(
2030 battery 'GRML_BATTERY_LEVEL'
2031 change-root 'debian_chroot'
2033 grml-chroot 'GRML_CHROOT'
2034 history '{history#%!} '
2036 jobs '[%j running job(s)] '
2038 path '%40<..<%~%<< '
2042 sad-smiley '%(?..:()'
2043 shell-level '%(3L.+ .)'
2044 time '%D{%H:%M:%S} '
2049 function grml_theme_has_token () {
2050 if (( ARGC != 1 )); then
2051 printf 'usage: grml_theme_has_token <name>\n'
2054 (( ${+grml_prompt_token_default[$1]} ))
2057 function GRML_theme_add_token_usage () {
2059 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2061 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2062 are used, <token/function> is the name of the function (see below for
2063 details). Otherwise it is the literal token string to be used. <pre> and
2064 <post> are optional.
2068 -f <function> Use a function named \`<function>' each time the token
2071 -i <function> Use a function named \`<function>' to initialise the
2072 value of the token _once_ at runtime.
2074 The functions are called with one argument: the token's new name. The
2075 return value is expected in the \$REPLY parameter. The use of these
2076 options is mutually exclusive.
2078 There is a utility function \`grml_theme_has_token', which you can use
2079 to test if a token exists before trying to add it. This can be a guard
2080 for situations in which a \`grml_theme_add_token' call may happen more
2085 To add a new token \`day' that expands to the current weekday in the
2086 current locale in green foreground colour, use this:
2088 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2090 Another example would be support for \$VIRTUAL_ENV:
2092 function virtual_env_prompt () {
2093 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2095 grml_theme_add_token virtual-env -f virtual_env_prompt
2097 After that, you will be able to use a changed \`items' style to
2098 assemble your prompt.
2102 function grml_theme_add_token () {
2104 local name token pre post
2105 local -i init funcall
2107 if (( ARGC == 0 )); then
2108 GRML_theme_add_token_usage
2118 if [[ $1 == '-f' ]]; then
2121 elif [[ $1 == '-i' ]]; then
2126 if (( ARGC == 0 )); then
2128 grml_theme_add_token: No token-string/function-name provided!\n\n'
2129 GRML_theme_add_token_usage
2134 if (( ARGC != 0 && ARGC != 2 )); then
2136 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2137 GRML_theme_add_token_usage
2146 if grml_theme_has_token $name; then
2148 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2149 GRML_theme_add_token_usage
2156 grml_prompt_pre_default[$name]=$pre
2157 grml_prompt_post_default[$name]=$post
2158 if (( funcall )); then
2159 grml_prompt_token_function[$name]=$token
2160 grml_prompt_token_default[$name]=23
2162 grml_prompt_token_default[$name]=$token
2166 function grml_typeset_and_wrap () {
2173 if (( ${+parameters[$new]} )); then
2174 typeset -g "${target}=${(P)target}${left}${(P)new}${right}"
2178 function grml_prompt_addto () {
2181 local lr it apre apost new v
2185 [[ $target == PS1 ]] && lr=left || lr=right
2186 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2187 typeset -g "${target}="
2188 for it in "${items[@]}"; do
2189 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2190 || apre=${grml_prompt_pre_default[$it]}
2191 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2192 || apost=${grml_prompt_post_default[$it]}
2193 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2194 || new=${grml_prompt_token_default[$it]}
2195 typeset -g "${target}=${(P)target}${apre}"
2196 if (( ${+grml_prompt_token_function[$it]} )); then
2197 ${grml_prompt_token_function[$it]} $it
2198 typeset -g "${target}=${(P)target}${REPLY}"
2202 grml_typeset_and_wrap $target $new '' ''
2205 grml_typeset_and_wrap $target $new '(' ')'
2208 if [[ -n ${(P)new} ]]; then
2209 typeset -g "${target}=${(P)target}(CHROOT)"
2213 v="vcs_info_msg_${new}_"
2214 if (( ! vcscalled )); then
2218 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2219 typeset -g "${target}=${(P)target}${(P)v}"
2222 *) typeset -g "${target}=${(P)target}${new}" ;;
2225 typeset -g "${target}=${(P)target}${apost}"
2229 function prompt_grml_precmd () {
2231 local grmltheme=grml
2232 local -a left_items right_items
2233 left_items=(rc change-root user at host path vcs percent)
2234 right_items=(sad-smiley)
2236 prompt_grml_precmd_worker
2239 function prompt_grml-chroot_precmd () {
2241 local grmltheme=grml-chroot
2242 local -a left_items right_items
2243 left_items=(grml-chroot user at host path percent)
2246 prompt_grml_precmd_worker
2249 function prompt_grml-large_precmd () {
2251 local grmltheme=grml-large
2252 local -a left_items right_items
2253 left_items=(rc jobs history shell-level change-root time date newline
2254 user at host path vcs percent)
2255 right_items=(sad-smiley)
2257 prompt_grml_precmd_worker
2260 function prompt_grml_precmd_worker () {
2262 local -i vcscalled=0
2264 grml_prompt_addto PS1 "${left_items[@]}"
2265 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2266 grml_prompt_addto RPS1 "${right_items[@]}"
2270 grml_prompt_fallback() {
2273 (( ${+functions[vcs_info]} )) && vcs_info
2276 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2277 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2278 if (( EUID == 0 )); then
2279 PROMPT="${BLUE}${p0}${RED}${p1}"
2281 PROMPT="${RED}${p0}${BLUE}${p1}"
2286 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2287 # Since we define the required functions in here and not in files in
2288 # $fpath, we need to stick the theme's name into `$prompt_themes'
2289 # ourselves, since promptinit does not pick them up otherwise.
2290 prompt_themes+=( grml grml-chroot grml-large )
2291 # Also, keep the array sorted...
2292 prompt_themes=( "${(@on)prompt_themes}" )
2294 print 'Notice: no promptinit available :('
2295 grml_prompt_fallback
2299 # The prompt themes use modern features of zsh, that require at least
2300 # version 4.3.7 of the shell. Use the fallback otherwise.
2301 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2302 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2303 add-zsh-hook precmd battery
2305 if [[ "$TERM" == dumb ]] ; then
2306 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2307 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2308 for i in rc user path jobs history date time shell-level; do
2309 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2310 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2313 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2314 elif (( EUID == 0 )); then
2315 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2318 # Finally enable one of the prompts.
2319 if [[ -n $GRML_CHROOT ]]; then
2321 elif [[ $GRMLPROMPT -gt 0 ]]; then
2327 grml_prompt_fallback
2330 # Terminal-title wizardry
2332 function ESC_print () {
2333 info_print $'\ek' $'\e\\' "$@"
2335 function set_title () {
2336 info_print $'\e]0;' $'\a' "$@"
2339 function info_print () {
2340 local esc_begin esc_end
2344 printf '%s' ${esc_begin}
2346 printf '%s' "${esc_end}"
2349 function grml_reset_screen_title () {
2350 # adjust title of xterm
2351 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2352 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2355 set_title ${(%):-"%n@%m: %~"}
2360 function grml_vcs_to_screen_title () {
2361 if [[ $TERM == screen* ]] ; then
2362 if [[ -n ${vcs_info_msg_1_} ]] ; then
2363 ESC_print ${vcs_info_msg_1_}
2370 function grml_maintain_name () {
2371 # set hostname if not running on host with name 'grml'
2372 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != $(hostname) ]] ; then
2377 function grml_cmd_to_screen_title () {
2378 # get the name of the program currently running and hostname of local
2379 # machine set screen window title if running in a screen
2380 if [[ "$TERM" == screen* ]] ; then
2381 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2386 function grml_control_xterm_title () {
2389 set_title "${(%):-"%n@%m:"}" "$1"
2394 zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2395 if [[ $NOPRECMD -eq 0 ]]; then
2396 add-zsh-hook precmd grml_reset_screen_title
2397 add-zsh-hook precmd grml_vcs_to_screen_title
2398 add-zsh-hook preexec grml_maintain_name
2399 add-zsh-hook preexec grml_cmd_to_screen_title
2400 if [[ $NOTITLE -eq 0 ]]; then
2401 add-zsh-hook preexec grml_control_xterm_title
2405 # 'hash' some often used directories
2407 hash -d deb=/var/cache/apt/archives
2408 hash -d doc=/usr/share/doc
2409 hash -d linux=/lib/modules/$(command uname -r)/build/
2410 hash -d log=/var/log
2411 hash -d slog=/var/log/syslog
2412 hash -d src=/usr/src
2413 hash -d www=/var/www
2417 if check_com -c screen ; then
2418 if [[ $UID -eq 0 ]] ; then
2419 if [[ -r /etc/grml/screenrc ]]; then
2420 alias screen="${commands[screen]} -c /etc/grml/screenrc"
2422 elif [[ -r $HOME/.screenrc ]] ; then
2423 alias screen="${commands[screen]} -c $HOME/.screenrc"
2425 if [[ -r /etc/grml/screenrc_grml ]]; then
2426 alias screen="${commands[screen]} -c /etc/grml/screenrc_grml"
2428 if [[ -r /etc/grml/screenrc ]]; then
2429 alias screen="${commands[screen]} -c /etc/grml/screenrc"
2435 # do we have GNU ls with color-support?
2436 if [[ "$TERM" != dumb ]]; then
2437 #a1# List files with colors (\kbd{ls -F \ldots})
2438 alias ls='command ls -F '${ls_options:+"${ls_options[*]}"}
2439 #a1# List all files, with colors (\kbd{ls -la \ldots})
2440 alias la='command ls -la '${ls_options:+"${ls_options[*]}"}
2441 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2442 alias ll='command ls -l '${ls_options:+"${ls_options[*]}"}
2443 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2444 alias lh='command ls -hAl '${ls_options:+"${ls_options[*]}"}
2445 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -lF \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2446 alias l='command ls -lF '${ls_options:+"${ls_options[*]}"}
2448 alias ls='command ls -F'
2449 alias la='command ls -la'
2450 alias ll='command ls -l'
2451 alias lh='command ls -hAl'
2452 alias l='command ls -lF'
2455 alias mdstat='cat /proc/mdstat'
2456 alias ...='cd ../../'
2458 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2459 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2460 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2463 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2464 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2465 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2467 # make sure it is not assigned yet
2468 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2471 for ENV in $(env | command grep -i '.utf') ; do
2472 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2477 # make sure it is not assigned yet
2478 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2480 if ! isutfenv ; then
2481 for ENV in $(env | command grep -i '\.iso') ; do
2482 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2487 # especially for roadwarriors using GNU screen and ssh:
2488 if ! check_com asc &>/dev/null ; then
2489 asc() { autossh -t "$@" 'screen -RdU' }
2493 #f1# Hints for the use of zsh on grml
2495 print "$bg[white]$fg[black]
2496 zsh-help - hints for use of zsh on grml
2497 =======================================$reset_color"
2500 Main configuration of zsh happens in /etc/zsh/zshrc.
2501 That file is part of the package grml-etc-core, if you want to
2502 use them on a non-grml-system just get the tar.gz from
2503 http://deb.grml.org/ or (preferably) get it from the git repository:
2505 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2507 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2508 The file is still there, but it is empty for backwards compatibility.
2510 For your own changes use these two files:
2514 The former is sourced very early in our zshrc, the latter is sourced
2517 System wide configuration without touching configuration files of grml
2518 can take place in /etc/zsh/zshrc.local.
2520 For information regarding zsh start at http://grml.org/zsh/
2522 Take a look at grml'\''s zsh refcard:
2523 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2525 Check out the main zsh refcard:
2526 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2528 And of course visit the zsh-lovers:
2531 You can adjust some options through environment variables when
2532 invoking zsh without having to edit configuration files.
2533 Basically meant for bash users who are not used to the power of
2536 "NOCOR=1 zsh" => deactivate automatic correction
2537 "NOMENU=1 zsh" => do not use auto menu completion
2538 (note: use ctrl-d for completion instead!)
2539 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2540 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2541 preexec() and precmd() completely
2542 "GRML_DISPLAY_BATTERY=1 zsh"
2543 => activate battery status on right side of prompt (WIP)
2544 "COMMAND_NOT_FOUND=1 zsh"
2545 => Enable a handler if an external command was not found
2546 The command called in the handler can be altered by setting
2547 the GRML_ZSH_CNF_HANDLER variable, the default is:
2548 "/usr/share/command-not-found/command-not-found"
2550 A value greater than 0 is enables a feature; a value equal to zero
2551 disables it. If you like one or the other of these settings, you can
2552 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2556 $bg[white]$fg[black]
2557 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2558 Enjoy your grml system with the zsh!$reset_color"
2562 if [[ -r /etc/debian_version ]] ; then
2563 #a3# Execute \kbd{apt-cache search}
2564 alias acs='apt-cache search'
2565 #a3# Execute \kbd{apt-cache show}
2566 alias acsh='apt-cache show'
2567 #a3# Execute \kbd{apt-cache policy}
2568 alias acp='apt-cache policy'
2569 #a3# Execute \kbd{apt-get dist-upgrade}
2570 salias adg="apt-get dist-upgrade"
2571 #a3# Execute \kbd{apt-get install}
2572 salias agi="apt-get install"
2573 #a3# Execute \kbd{aptitude install}
2574 salias ati="aptitude install"
2575 #a3# Execute \kbd{apt-get upgrade}
2576 salias ag="apt-get upgrade"
2577 #a3# Execute \kbd{apt-get update}
2578 salias au="apt-get update"
2579 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2580 salias -a up="aptitude update ; aptitude safe-upgrade"
2581 #a3# Execute \kbd{dpkg-buildpackage}
2582 alias dbp='dpkg-buildpackage'
2583 #a3# Execute \kbd{grep-excuses}
2584 alias ge='grep-excuses'
2586 # get a root shell as normal user in live-cd mode:
2587 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2591 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog}
2592 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2593 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog}
2594 salias tlog="tail -f /var/log/syslog" # follow the syslog
2597 # sort installed Debian-packages by size
2598 if check_com -c dpkg-query ; then
2599 #a3# List installed Debian-packages sorted by size
2600 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"
2603 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2604 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2605 if check_com -c wodim; then
2608 cdrecord is not provided under its original name by Debian anymore.
2609 See #377109 in the BTS of Debian for more details.
2611 Please use the wodim binary instead
2618 # Use hard limits, except for a smaller stack and no core dumps
2620 is425 && limit stack 8192
2621 isgrmlcd && limit core 0 # important for a live-cd-system
2626 # people should use 'grml-x'!
2627 if check_com -c 915resolution; then
2629 echo "Please use 915resolution as resolution modifying tool for Intel \
2635 #a1# Output version of running grml
2636 alias grml-version='cat /etc/grml_version'
2638 if check_com -c grml-debootstrap ; then
2640 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2646 # now run the functions
2648 is4 && isgrml && grmlstuff
2652 is4 && xsource "/etc/zsh/keephack"
2654 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2655 # You use it as follows:
2656 # $ NTREF=/reference/file
2658 # This lists all the files in the current directory newer than the reference file.
2659 # You can also specify the reference file inline; note quotes:
2660 # $ ls -l *(e:'nt ~/.zshenv':)
2662 if [[ -n $1 ]] ; then
2665 [[ $REPLY -nt $NTREF ]]
2670 #f1# Reload an autoloadable function
2671 freload() { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2672 compdef _functions freload
2674 #f1# List symlinks in detail (more detailed version of 'readlink -f' and 'whence -s')
2676 [[ -z "$1" ]] && printf 'Usage: %s <file(s)>\n' "$0" && return 1
2678 for file in "$@" ; do
2679 while [[ -h "$file" ]] ; do
2681 file=$(readlink "$file")
2686 # TODO: Is it supported to use pager settings like this?
2687 # PAGER='less -Mr' - If so, the use of $PAGER here needs fixing
2688 # with respect to wordsplitting. (ie. ${=PAGER})
2689 if check_com -c $PAGER ; then
2690 #f3# View Debian's changelog of given package(s)
2693 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
2696 for package in "$@" ; do
2697 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
2698 $PAGER /usr/share/doc/${package}/changelog.Debian.gz
2699 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
2700 $PAGER /usr/share/doc/${package}/changelog.gz
2701 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
2702 $PAGER /usr/share/doc/${package}/changelog
2704 if check_com -c aptitude ; then
2705 echo "No changelog for package $package found, using aptitude to retrieve it."
2706 aptitude changelog "$package"
2707 elif check_com -c apt-get ; then
2708 echo "No changelog for package $package found, using apt-get to retrieve it."
2709 apt-get changelog "$package"
2711 echo "No changelog for package $package found, sorry."
2716 _dchange() { _files -W /usr/share/doc -/ }
2717 compdef _dchange dchange
2719 #f3# View Debian's NEWS of a given package
2722 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
2723 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
2725 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
2726 $PAGER /usr/share/doc/$1/NEWS.gz
2728 echo "No NEWS file for package $1 found, sorry."
2733 _dnews() { _files -W /usr/share/doc -/ }
2734 compdef _dnews dnews
2736 #f3# View Debian's copyright of a given package
2739 if [[ -r /usr/share/doc/$1/copyright ]] ; then
2740 $PAGER /usr/share/doc/$1/copyright
2742 echo "No copyright file for package $1 found, sorry."
2746 _dcopyright() { _files -W /usr/share/doc -/ }
2747 compdef _dcopyright dcopyright
2749 #f3# View upstream's changelog of a given package
2752 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
2753 $PAGER /usr/share/doc/$1/changelog.gz
2755 echo "No changelog for package $1 found, sorry."
2759 _uchange() { _files -W /usr/share/doc -/ }
2760 compdef _uchange uchange
2765 ZSH_PROFILE_RC=1 $SHELL "$@"
2768 #f1# Edit an alias via zle
2770 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
2772 compdef _aliases edalias
2774 #f1# Edit a function via zle
2776 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
2778 compdef _functions edfunc
2780 # use it e.g. via 'Restart apache2'
2781 #m# f6 Start() \kbd{/etc/init.d/\em{process}}\quad\kbd{start}
2782 #m# f6 Restart() \kbd{/etc/init.d/\em{process}}\quad\kbd{restart}
2783 #m# f6 Stop() \kbd{/etc/init.d/\em{process}}\quad\kbd{stop}
2784 #m# f6 Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{reload}
2785 #m# f6 Force-Reload() \kbd{/etc/init.d/\em{process}}\quad\kbd{force-reload}
2786 #m# f6 Status() \kbd{/etc/init.d/\em{process}}\quad\kbd{status}
2787 if [[ -d /etc/init.d || -d /etc/service ]] ; then
2789 local action_="${1:l}" # e.g Start/Stop/Restart
2793 local service_target_="$(readlink /etc/init.d/$service_)"
2794 if [[ $service_target_ == "/usr/bin/sv" ]]; then
2796 case "${action_}" in
2797 start) if [[ ! -e /etc/service/$service_ ]]; then
2798 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
2800 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2802 # there is no reload in runits sysv emulation
2803 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
2804 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
2808 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
2814 scripts=( /etc/init.d/*(x:t) )
2815 _describe "service startup script" scripts
2818 for i in Start Restart Stop Force-Reload Reload Status ; do
2819 eval "$i() { __start_stop $i \"\$1\" \"\$2\" ; }"
2820 compdef _grmlinitd $i
2824 #f1# Provides useful information on globbing
2831 p named pipes (FIFOs)
2832 * executable plain files (0100)
2833 % device files (character or block special)
2834 %b block special files
2835 %c character special files
2836 r owner-readable files (0400)
2837 w owner-writable files (0200)
2838 x owner-executable files (0100)
2839 A group-readable files (0040)
2840 I group-writable files (0020)
2841 E group-executable files (0010)
2842 R world-readable files (0004)
2843 W world-writable files (0002)
2844 X world-executable files (0001)
2845 s setuid files (04000)
2846 S setgid files (02000)
2847 t files with the sticky bit (01000)
2849 print *(m-1) # Files modified up to a day ago
2850 print *(a1) # Files accessed a day ago
2851 print *(@) # Just symlinks
2852 print *(Lk+50) # Files bigger than 50 kilobytes
2853 print *(Lk-50) # Files smaller than 50 kilobytes
2854 print **/*.c # All *.c files recursively starting in \$PWD
2855 print **/*.c~file.c # Same as above, but excluding 'file.c'
2856 print (foo|bar).* # Files starting with 'foo' or 'bar'
2857 print *~*.* # All Files that do not contain a dot
2858 chmod 644 *(.^x) # make all plain non-executable files publically readable
2859 print -l *(.c|.h) # Lists *.c and *.h
2860 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
2861 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
2863 alias help-zshglob=H-Glob
2865 # grep for running process, like: 'any vim'
2869 if [[ -z "$1" ]] ; then
2870 echo "any - grep for process(es) by keyword" >&2
2871 echo "Usage: any <keyword>" >&2 ; return 1
2873 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
2878 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
2879 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
2880 [[ -r /proc/1/maps ]] && \
2882 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
2883 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
2884 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
2887 # a wrapper for vim, that deals with title setting
2889 # set this array to a set of options to vim you always want
2890 # to have set when calling vim (in .zshrc.local), like:
2891 # VIM_OPTIONS=( -p )
2892 # This will cause vim to send every file given on the
2893 # commandline to be send to it's own tab (needs vim7).
2894 if check_com vim; then
2896 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
2900 ssl_hashes=( sha512 sha256 sha1 md5 )
2902 for sh in ${ssl_hashes}; do
2903 eval 'ssl-cert-'${sh}'() {
2905 if [[ -z $1 ]] ; then
2906 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
2909 openssl x509 -noout -fingerprint -'${sh}' -in $1
2913 ssl-cert-fingerprints() {
2916 if [[ -z $1 ]] ; then
2917 printf 'usage: ssl-cert-fingerprints <file>\n'
2920 for i in ${ssl_hashes}
2927 if [[ -z $1 ]] ; then
2928 printf 'usage: ssl-cert-info <file>\n'
2931 openssl x509 -noout -text -in $1
2932 ssl-cert-fingerprints $1
2935 # make sure our environment is clean regarding colors
2936 for color in BLUE RED GREEN CYAN YELLOW MAGENTA WHITE ; unset $color
2938 # "persistent history"
2939 # just write important commands you always need to ~/.important_commands
2940 if [[ -r ~/.important_commands ]] ; then
2941 fc -R ~/.important_commands
2944 # load the lookup subsystem if it's available on the system
2945 zrcautoload lookupinit && lookupinit
2949 # set terminal property (used e.g. by msgid-chooser)
2950 export COLORTERM="yes"
2955 #a2# Execute \kbd{du -sch}
2959 #a2# Execute \kbd{ls -lSrah}
2960 alias dir="command ls -lSrah"
2961 #a2# Only show dot-directories
2962 alias lad='command ls -d .*(/)'
2963 #a2# Only show dot-files
2964 alias lsa='command ls -a .*(.)'
2965 #a2# Only files with setgid/setuid/sticky flag
2966 alias lss='command ls -l *(s,S,t)'
2967 #a2# Only show symlinks
2968 alias lsl='command ls -l *(@)'
2969 #a2# Display only executables
2970 alias lsx='command ls -l *(*)'
2971 #a2# Display world-{readable,writable,executable} files
2972 alias lsw='command ls -ld *(R,W,X.^ND/)'
2973 #a2# Display the ten biggest files
2974 alias lsbig="command ls -flh *(.OL[1,10])"
2975 #a2# Only show directories
2976 alias lsd='command ls -d *(/)'
2977 #a2# Only show empty directories
2978 alias lse='command ls -d *(/^F)'
2979 #a2# Display the ten newest files
2980 alias lsnew="command ls -rtlh *(D.om[1,10])"
2981 #a2# Display the ten oldest files
2982 alias lsold="command ls -rtlh *(D.Om[1,10])"
2983 #a2# Display the ten smallest files
2984 alias lssmall="command ls -Srl *(.oL[1,10])"
2985 #a2# Display the ten newest directories and ten newest .directories
2986 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
2987 #a2# Display the ten oldest directories and ten oldest .directories
2988 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
2990 # some useful aliases
2991 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
2992 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
2994 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
2995 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
2996 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
2997 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
2999 # work around non utf8 capable software in utf environment via $LANG and luit
3000 if check_com isutfenv && check_com luit ; then
3001 if check_com -c mrxvt ; then
3002 isutfenv && [[ -n "$LANG" ]] && \
3003 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3006 if check_com -c aterm ; then
3007 isutfenv && [[ -n "$LANG" ]] && \
3008 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3011 if check_com -c centericq ; then
3012 isutfenv && [[ -n "$LANG" ]] && \
3013 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3019 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3022 local current_date=$(date -u "+%Y-%m-%dT%H:%M:%SZ")
3023 local keep move verbose result
3026 bk [-hcmv] FILE [FILE ...]
3027 Backup a file or folder in place and append the timestamp
3030 -h Display this help text
3031 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3032 -m Move the file/folder, using mv(1)
3035 The -c and -m options can't be used at the same time. If both specified, the
3038 The return code is the sum of all cp/mv return codes.
3042 while getopts ":hcmv" opt; do
3044 c) unset move && (( ++keep ));;
3045 m) unset keep && (( ++move ));;
3048 \?) usage >&2; return 1;;
3051 shift "$((OPTIND-1))"
3052 if (( keep > 0 )); then
3053 while (( $# > 0 )); do
3055 cp $verbose -a "$1" "$1_$current_date"
3056 elif isfreebsd; then
3057 if [[ -d "$1" ]] && [[ "$1" == */ ]]; then
3058 echo "cowardly refusing to copy $1 's content; see cp(1)" >&2; return 1
3060 cp $verbose -a "$1" "$1_$current_date"
3063 cp $verbose -pR "$1" "$1_$current_date"
3068 elif (( move > 0 )); then
3069 while (( $# > 0 )); do
3070 mv $verbose "$1" "$1_$current_date"
3078 #f5# cd to directoy and list files
3084 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3086 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3087 [[ ! -e ${1:h} ]] && return 1
3088 print "Correcting ${1} to ${1:h}"
3095 #f5# Create Directoy and \kbd{cd} to it
3097 if (( ARGC != 1 )); then
3098 printf 'usage: mkcd <new-directory>\n'
3101 if [[ ! -d "$1" ]]; then
3102 command mkdir -p "$1"
3104 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3109 #f5# Create temporary directory and \kbd{cd} to it
3117 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3120 print -l -- *(a-${1:-1})
3123 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3126 print -l -- *(c-${1:-1})
3129 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3132 print -l -- *(m-${1:-1})
3134 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3135 check_com new || alias new=modified
3137 # use colors when GNU grep with color-support
3138 if (( $#grep_options > 0 )); then
3139 o=${grep_options:+"${grep_options[*]}"}
3140 #a2# Execute \kbd{grep -{}-color=auto}
3141 alias grep='grep '$o
3142 alias egrep='egrep '$o
3147 # 'translate' looks up fot a word in a file with language-to-language
3148 # translations (field separator should be " : "). A typical wordlist looks
3150 # | english-word : german-transmission
3151 # It's also only possible to translate english to german but not reciprocal.
3152 # Use the following oneliner to turn back the sort order:
3153 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3154 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3155 #f5# Translates a word
3160 translate -l de-en $2
3163 translate -l en-de $2
3166 echo "Usage: $0 { -D | -E }"
3167 echo " -D == German to English"
3168 echo " -E == English to German"
3172 # Usage: simple-extract <file>
3173 # Using option -d deletes the original archive file.
3174 #f5# Smart archive extractor
3177 setopt extended_glob noclobber
3178 local DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3180 zparseopts -D -E "d=DELETE_ORIGINAL"
3181 for ARCHIVE in "${@}"; do
3183 *(tar.bz2|tbz2|tbz))
3184 DECOMP_CMD="tar -xvjf -"
3189 DECOMP_CMD="tar -xvzf -"
3193 *(tar.xz|txz|tar.lzma))
3194 DECOMP_CMD="tar -xvJf -"
3199 DECOMP_CMD="tar -xvf -"
3204 DECOMP_CMD="unrar x"
3229 DECOMP_CMD="bzip2 -d -c -"
3234 DECOMP_CMD="gzip -d -c -"
3239 DECOMP_CMD="xz -d -c -"
3244 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3250 if ! check_com ${DECOMP_CMD[(w)1]}; then
3251 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3256 GZTARGET="${ARCHIVE:t:r}"
3257 if [[ -f $ARCHIVE ]] ; then
3259 print "Extracting '$ARCHIVE' ..."
3260 if $USES_STDIN; then
3261 if $USES_STDOUT; then
3262 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3264 ${=DECOMP_CMD} < "$ARCHIVE"
3267 if $USES_STDOUT; then
3268 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3270 ${=DECOMP_CMD} "$ARCHIVE"
3273 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3275 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3276 if check_com curl; then
3277 WGET_CMD="curl -L -k -s -o -"
3278 elif check_com wget; then
3279 WGET_CMD="wget -q -O - --no-check-certificate"
3281 print "ERROR: neither wget nor curl is installed" >&2
3285 print "Downloading and Extracting '$ARCHIVE' ..."
3286 if $USES_STDIN; then
3287 if $USES_STDOUT; then
3288 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3291 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3295 if $USES_STDOUT; then
3296 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3298 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3303 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3313 '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)"' \
3314 '_urls:Remote Archives:_urls'
3320 '-d[delete original archivefile after extraction]' \
3321 '*:Archive Or Uri:__archive_or_uri'
3323 compdef _simple_extract simple-extract
3324 alias se=simple-extract
3326 #f5# Set all ulimit parameters to \kbd{unlimited}
3337 #f5# Change the xterm title from within GNU-screen
3340 if [[ $1 != "-f" ]] ; then
3341 if [[ -z ${DISPLAY} ]] ; then
3342 printf 'xtrename only makes sense in X11.\n'
3348 if [[ -z $1 ]] ; then
3349 printf 'usage: xtrename [-f] "title for xterm"\n'
3350 printf ' renames the title of xterm from _within_ screen.\n'
3351 printf ' also works without screen.\n'
3352 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3355 print -n "\eP\e]0;${1}\C-G\e\\"
3359 # Create small urls via http://goo.gl using curl(1).
3360 # API reference: https://code.google.com/apis/urlshortener/
3363 setopt extended_glob
3365 if [[ -z $1 ]]; then
3366 print "USAGE: zurl <URL>"
3370 local PN url prog api json contenttype item
3375 # Prepend 'http://' to given URL where necessary for later output.
3376 if [[ ${url} != http(s|)://* ]]; then
3380 if check_com -c curl; then
3383 print "curl is not available, but mandatory for ${PN}. Aborting."
3386 api='https://www.googleapis.com/urlshortener/v1/url'
3387 contenttype="Content-Type: application/json"
3388 json="{\"longUrl\": \"${url}\"}"
3389 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3390 # Parse the response
3391 for item in "${data[@]}"; do
3396 printf '%s\n' "$item"
3404 #f2# Find history events by search pattern and list them by date.
3407 local usage help ident format_l format_s first_char remain first last
3408 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3409 help='Use `whatwhen -h'\'' for further explanations.'
3410 ident=${(l,${#${:-Usage: }},, ,)}
3411 format_l="${ident}%s\t\t\t%s\n"
3412 format_s="${format_l//(\\t)##/\\t}"
3413 # Make the first char of the word to search for case
3414 # insensitive; e.g. [aA]
3415 first_char=[${(L)1[1]}${(U)1[1]}]
3417 # Default search range is `-100'.
3419 # Optional, just used for `<first> <last>' given.
3423 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3424 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3427 printf '%s\n\n' ${usage}
3429 printf $format_l '-h' 'show help text'
3431 print 'SEARCH RANGE:'
3432 printf $format_l "'0'" 'the whole history,'
3433 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3434 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3435 printf '\n%s\n' 'EXAMPLES:'
3436 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3437 printf $format_l 'whatwhen zsh -250'
3438 printf $format_l 'whatwhen foo 1 99'
3441 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3444 # -l list results on stout rather than invoking $EDITOR.
3445 # -i Print dates as in YYYY-MM-DD.
3446 # -m Search for a - quoted - pattern within the history.
3447 fc -li -m "*${first_char}${remain}*" $first $last
3452 # mercurial related stuff
3453 if check_com -c hg ; then
3454 # gnu like diff for mercurial
3455 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3456 #f5# GNU like diff for mercurial
3459 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3462 # build debian package
3463 #a2# Alias for \kbd{hg-buildpackage}
3464 alias hbp='hg-buildpackage'
3466 # execute commands on the versioned patch-queue from the current repos
3467 alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3469 # diffstat for specific version of a mercurial repository
3470 # hgstat => display diffstat between last revision and tip
3471 # hgstat 1234 => display diffstat between revision 1234 and tip
3472 #f5# Diffstat for specific version of a mercurial repos
3475 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3478 fi # end of check whether we have the 'hg'-executable
3480 # grml-small cleanups
3482 # The following is used to remove zsh-config-items that do not work
3483 # in grml-small by default.
3484 # If you do not want these adjustments (for whatever reason), set
3485 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3486 # sources if it is there).
3488 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3491 unalias 'V' &> /dev/null
3492 unfunction vman &> /dev/null
3493 unfunction viless &> /dev/null
3494 unfunction 2html &> /dev/null
3496 # manpages are not in grmlsmall
3497 unfunction manzsh &> /dev/null
3498 unfunction man2 &> /dev/null
3504 ## genrefcard.pl settings
3506 ### doc strings for external functions from files
3507 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3509 ### example: split functions-search 8,16,24,32
3510 #@# split functions-search 8
3512 ## END OF FILE #################################################################
3513 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4