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 typeset -A GRML_STATUS_FEATURES
113 function grml_status_feature () {
117 if (( success == 0 )); then
118 GRML_STATUS_FEATURES[$f]=success
120 GRML_STATUS_FEATURES[$f]=failure
125 function grml_status_features () {
129 if [[ $mode == -h ]] || [[ $mode == --help ]]; then
131 grml_status_features [-h|--help|-|+|+-|FEATURE]
133 Prints a summary of features the grml setup is trying to load. The
134 result of loading a feature is recorded. This function lets you query
137 The function takes one argument: "-h" or "--help" to display this help
138 text, "+" to display a list of all successfully loaded features, "-" for
139 a list of all features that failed to load. "+-" to show a list of all
140 features with their statuses.
142 Any other word is considered to by a feature and prints its status.
144 The default mode is "+-".
148 if [[ $mode != - ]] && [[ $mode != + ]] && [[ $mode != +- ]]; then
149 this="${GRML_STATUS_FEATURES[$mode]}"
150 if [[ -z $this ]]; then
158 for key in ${(ok)GRML_STATUS_FEATURES}; do
159 this="${GRML_STATUS_FEATURES[$key]}"
160 if [[ $this == success ]] && [[ $mode == *+* ]]; then
161 printf '%-16s %s\n' $key $this
163 if [[ $this == failure ]] && [[ $mode == *-* ]]; then
164 printf '%-16s %s\n' $key $this
170 # load .zshrc.pre to give the user the chance to overwrite the defaults
171 [[ -r ${ZDOTDIR:-${HOME}}/.zshrc.pre ]] && source ${ZDOTDIR:-${HOME}}/.zshrc.pre
173 # check for version/system
174 # check for versions (compatibility reasons)
176 [[ $ZSH_VERSION == 5.<1->* ]] && return 0
181 [[ $ZSH_VERSION == <4->* ]] && return 0
186 [[ $ZSH_VERSION == 4.<1->* || $ZSH_VERSION == <5->* ]] && return 0
191 [[ $ZSH_VERSION == 4.<2->* || $ZSH_VERSION == <5->* ]] && return 0
196 [[ $ZSH_VERSION == 4.2.<5->* || $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
201 [[ $ZSH_VERSION == 4.<3->* || $ZSH_VERSION == <5->* ]] && return 0
206 [[ $ZSH_VERSION == 4.3.<3->* || $ZSH_VERSION == 4.<4->* \
207 || $ZSH_VERSION == <5->* ]] && return 0
212 [[ $ZSH_VERSION == 4.3.<7->* || $ZSH_VERSION == 4.<4->* \
213 || $ZSH_VERSION == <5->* ]] && return 0
218 [[ $ZSH_VERSION == 4.3.<9->* || $ZSH_VERSION == 4.<4->* \
219 || $ZSH_VERSION == <5->* ]] && return 0
223 #f1# Checks whether or not you're running grml
225 [[ -f /etc/grml_version ]] && return 0
229 #f1# Checks whether or not you're running a grml cd
230 function isgrmlcd () {
231 [[ -f /etc/grml_cd ]] && return 0
236 #f1# Checks whether or not you're running grml-small
237 function isgrmlsmall () {
238 if [[ ${${${(f)"$(</etc/grml_version)"}%% *}##*-} == 'small' ]]; then
244 function isgrmlsmall () { return 1 }
247 GRML_OSTYPE=$(uname -s)
249 function islinux () {
250 [[ $GRML_OSTYPE == "Linux" ]]
253 function isdarwin () {
254 [[ $GRML_OSTYPE == "Darwin" ]]
257 function isfreebsd () {
258 [[ $GRML_OSTYPE == "FreeBSD" ]]
261 function isopenbsd () {
262 [[ $GRML_OSTYPE == "OpenBSD" ]]
265 function issolaris () {
266 [[ $GRML_OSTYPE == "SunOS" ]]
269 #f1# are we running within an utf environment?
270 function isutfenv () {
271 case "$LANG $CHARSET $LANGUAGE" in
278 # check for user, if not running as root set $SUDO to sudo
279 (( EUID != 0 )) && SUDO='sudo' || SUDO=''
281 # change directory to home on first invocation of zsh
282 # important for rungetty -> autologin
283 # Thanks go to Bart Schaefer!
284 isgrml && function checkhome () {
285 if [[ -z "$ALREADY_DID_CD_HOME" ]] ; then
286 export ALREADY_DID_CD_HOME=$HOME
291 # check for zsh v3.1.7+
293 if ! [[ ${ZSH_VERSION} == 3.1.<7->* \
294 || ${ZSH_VERSION} == 3.<2->.<->* \
295 || ${ZSH_VERSION} == <4->.<->* ]] ; then
298 printf '-!- In this configuration we try to make use of features, that only\n'
299 printf '-!- require version 3.1.7 of the shell; That way this setup can be\n'
300 printf '-!- used with a wide range of zsh versions, while using fairly\n'
301 printf '-!- advanced features in all supported versions.\n'
303 printf '-!- However, you are running zsh version %s.\n' "$ZSH_VERSION"
305 printf '-!- While this *may* work, it might as well fail.\n'
306 printf '-!- Please consider updating to at least version 3.1.7 of zsh.\n'
308 printf '-!- DO NOT EXPECT THIS TO WORK FLAWLESSLY!\n'
309 printf '-!- If it does today, you'\''ve been lucky.\n'
311 printf '-!- Ye been warned!\n'
314 function zstyle () { : }
317 # autoload wrapper - use this one instead of autoload directly
318 # We need to define this function as early as this, because autoloading
319 # 'is-at-least()' needs it.
320 function zrcautoload () {
328 for fdir in ${fpath} ; do
329 [[ -e ${fdir}/${ffile} ]] && (( ffound = 1 ))
332 (( ffound == 0 )) && return 1
333 if [[ $ZSH_VERSION == 3.1.<6-> || $ZSH_VERSION == <4->* ]] ; then
334 autoload -U ${ffile} || return 1
336 autoload ${ffile} || return 1
341 # The following is the ‘add-zsh-hook’ function from zsh upstream. It is
342 # included here to make the setup work with older versions of zsh (prior to
343 # 4.3.7) in which this function had a bug that triggers annoying errors during
344 # shell startup. This is exactly upstreams code from f0068edb4888a4d8fe94def,
345 # with just a few adjustments in coding style to make the function look more
346 # compact. This definition can be removed as soon as we raise the minimum
347 # version requirement to 4.3.7 or newer.
348 function add-zsh-hook () {
349 # Add to HOOK the given FUNCTION.
350 # HOOK is one of chpwd, precmd, preexec, periodic, zshaddhistory,
351 # zshexit, zsh_directory_name (the _functions subscript is not required).
353 # With -d, remove the function from the hook instead; delete the hook
354 # variable if it is empty.
356 # -D behaves like -d, but pattern characters are active in the function
357 # name, so any matching function will be deleted from the hook.
359 # Without -d, the FUNCTION is marked for autoload; -U is passed down to
360 # autoload if that is given, as are -z and -k. (This is harmless if the
361 # function is actually defined inline.)
365 chpwd precmd preexec periodic zshaddhistory zshexit
368 local usage="Usage: $0 hook function\nValid hooks are:\n $hooktypes"
371 integer del list help
372 while getopts "dDhLUzk" opt; do
378 ([Uzk]) autoopts+=(-$opt) ;;
382 shift $(( OPTIND - 1 ))
384 typeset -mp "(${1:-${(@j:|:)hooktypes}})_functions"
386 elif (( help || $# != 2 || ${hooktypes[(I)$1]} == 0 )); then
387 print -u$(( 2 - help )) $usage
388 return $(( 1 - help ))
390 local hook="${1}_functions"
393 # delete, if hook is set
394 if (( ${(P)+hook} )); then
395 if (( del == 2 )); then
396 set -A $hook ${(P)hook:#${~fn}}
398 set -A $hook ${(P)hook:#$fn}
400 # unset if no remaining entries --- this can give better
401 # performance in some cases
402 if (( ! ${(P)#hook} )); then
407 if (( ${(P)+hook} )); then
408 if (( ${${(P)hook}[(I)$fn]} == 0 )); then
409 set -A $hook ${(P)hook} $fn
414 autoload $autoopts -- $fn
418 # Load is-at-least() for more precise version checks Note that this test will
419 # *always* fail, if the is-at-least function could not be marked for
421 zrcautoload is-at-least || function is-at-least () { return 1 }
423 # set some important options (as early as possible)
425 # append history list to the history file; this is the default but we make sure
426 # because it's required for share_history.
427 setopt append_history
429 # import new commands from the history file also in other zsh-session
430 is4 && setopt share_history
432 # save each command's beginning timestamp and the duration to the history file
433 setopt extended_history
435 # remove command lines from the history list when the first character on the
437 setopt histignorespace
439 # if a command is issued that can't be executed as a normal command, and the
440 # command is the name of a directory, perform the cd command to that directory.
443 # in order to use #, ~ and ^ for filename generation grep word
444 # *~(*.gz|*.bz|*.bz2|*.zip|*.Z) -> searches for word not in compressed files
445 # don't forget to quote '^', '~' and '#'!
448 # display PID when suspending processes as well
451 # report the status of backgrounds jobs immediately
454 # whenever a command completion is attempted, make sure the entire command path
458 # not just at the end
459 setopt completeinword
461 # Don't send SIGHUP to background processes when the shell exits.
464 # make cd push the old directory onto the directory stack.
470 # don't push the same dir twice.
471 setopt pushd_ignore_dups
473 # * shouldn't match dotfiles. ever.
476 # use zsh style word splitting
479 # don't error out when unset parameters are used
482 # setting some default values
484 NOETCHOSTS=${NOETCHOSTS:-0}
486 NOPRECMD=${NOPRECMD:-0}
487 COMMAND_NOT_FOUND=${COMMAND_NOT_FOUND:-0}
488 GRML_ZSH_CNF_HANDLER=${GRML_ZSH_CNF_HANDLER:-/usr/share/command-not-found/command-not-found}
489 GRML_DISPLAY_BATTERY=${GRML_DISPLAY_BATTERY:-${BATTERY:-0}}
490 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
491 ZSH_NO_DEFAULT_LOCALE=${ZSH_NO_DEFAULT_LOCALE:-0}
493 typeset -ga ls_options
494 typeset -ga grep_options
496 # Colors on GNU ls(1)
497 if ls --color=auto / >/dev/null 2>&1; then
498 ls_options+=( --color=auto )
499 # Colors on FreeBSD and OSX ls(1)
500 elif ls -G / >/dev/null 2>&1; then
504 # Natural sorting order on GNU ls(1)
505 # OSX and IllumOS have a -v option that is not natural sorting
506 if ls --version |& grep -q 'GNU' >/dev/null 2>&1 && ls -v / >/dev/null 2>&1; then
510 # Color on GNU and FreeBSD grep(1)
511 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
512 grep_options+=( --color=auto )
516 # this function checks if a command exists and returns either true
517 # or false. This avoids using 'which' and 'whence', which will
518 # avoid problems with aliases for which on certain weird systems. :-)
519 # Usage: check_com [-c|-g] word
520 # -c only checks for external commands
521 # -g does the usual tests and also checks for global aliases
522 function check_com () {
524 local -i comonly gatoo
528 if [[ $1 == '-c' ]] ; then
531 elif [[ $1 == '-g' ]] ; then
536 if (( ${#argv} != 1 )) ; then
537 printf 'usage: check_com [-c|-g] <command>\n' >&2
541 if (( comonly > 0 )) ; then
542 (( ${+commands[$1]} )) && return 0
546 if (( ${+commands[$1]} )) \
547 || (( ${+functions[$1]} )) \
548 || (( ${+aliases[$1]} )) \
549 || (( ${+reswords[(r)$1]} )) ; then
553 if (( gatoo > 0 )) && (( ${+galiases[$1]} )) ; then
560 # creates an alias and precedes the command with
561 # sudo if $EUID is not zero.
564 local only=0 ; local multi=0
566 while getopts ":hao" opt; do
571 printf 'usage: salias [-hoa] <alias-expression>\n'
572 printf ' -h shows this help text.\n'
573 printf ' -a replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
574 printf ' be careful using this option.\n'
575 printf ' -o only sets an alias if a preceding sudo would be needed.\n'
578 *) salias -h >&2; return 1 ;;
581 shift "$((OPTIND-1))"
583 if (( ${#argv} > 1 )) ; then
584 printf 'Too many arguments %s\n' "${#argv}"
588 key="${1%%\=*}" ; val="${1#*\=}"
589 if (( EUID == 0 )) && (( only == 0 )); then
590 alias -- "${key}=${val}"
591 elif (( EUID > 0 )) ; then
592 (( multi > 0 )) && val="${val// ; / ; sudo }"
593 alias -- "${key}=sudo ${val}"
599 # Check if we can read given files and source those we can.
600 function xsource () {
601 if (( ${#argv} < 1 )) ; then
602 printf 'usage: xsource FILE(s)...\n' >&2
606 while (( ${#argv} > 0 )) ; do
607 [[ -r "$1" ]] && source "$1"
613 # Check if we can read a given file and 'cat(1)' it.
616 if (( ${#argv} != 1 )) ; then
617 printf 'usage: xcat FILE\n' >&2
621 [[ -r $1 ]] && cat $1
625 # Remove these functions again, they are of use only in these
626 # setup files. This should be called at the end of .zshrc.
627 function xunfunction () {
631 funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
632 for func in $funcs ; do
633 [[ -n ${functions[$func]} ]] \
639 # this allows us to stay in sync with grml's zshrc and put own
640 # modifications in ~/.zshrc.local
641 function zrclocal () {
642 xsource "/etc/zsh/zshrc.local"
643 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
648 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
649 xsource "/etc/default/locale"
652 for var in LANG LC_ALL LC_MESSAGES ; do
653 [[ -n ${(P)var} ]] && export $var
658 if check_com -c vim ; then
660 export EDITOR=${EDITOR:-vim}
662 export EDITOR=${EDITOR:-vi}
666 export PAGER=${PAGER:-less}
669 export MAIL=${MAIL:-/var/mail/$USER}
671 # color setup for ls:
672 check_com -c dircolors && eval $(dircolors -b)
673 # color setup for ls on OS X / FreeBSD:
674 isdarwin && export CLICOLOR=1
675 isfreebsd && export CLICOLOR=1
677 # do MacPorts setup on darwin
678 if isdarwin && [[ -d /opt/local ]]; then
679 # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
681 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
682 MANPATH="/opt/local/share/man:$MANPATH"
684 # do Fink setup on darwin
685 isdarwin && xsource /sw/bin/init.sh
687 # load our function and completion directories
688 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
689 fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
692 ffiles=(/usr/share/grml/zsh/functions/**/[^_]*[^~](N.:t))
693 (( ${#ffiles} > 0 )) && autoload -U "${ffiles[@]}"
696 # support colors in less
697 export LESS_TERMCAP_mb=$'\E[01;31m'
698 export LESS_TERMCAP_md=$'\E[01;31m'
699 export LESS_TERMCAP_me=$'\E[0m'
700 export LESS_TERMCAP_se=$'\E[0m'
701 export LESS_TERMCAP_so=$'\E[01;44;33m'
702 export LESS_TERMCAP_ue=$'\E[0m'
703 export LESS_TERMCAP_us=$'\E[01;32m'
708 # report about cpu-/system-/user-time of command if running longer than
712 # watch for everyone but me and root
715 # automatically remove duplicates from these arrays
716 typeset -U path PATH cdpath CDPATH fpath FPATH manpath MANPATH
720 for mod in parameter complist deltochar mathfunc ; do
721 zmodload -i zsh/${mod} 2>/dev/null
722 grml_status_feature mod:$mod $?
723 done && builtin unset -v mod
725 # autoload zsh modules when they are referenced
727 zmodload -a zsh/stat zstat
728 zmodload -a zsh/zpty zpty
729 zmodload -ap zsh/mapfile mapfile
733 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
734 if zrcautoload compinit ; then
736 zstyle -a ':grml:completion:compinit' arguments tmp
737 compinit -d ${COMPDUMPFILE} "${tmp[@]}"
738 grml_status_feature compinit $?
741 grml_status_feature compinit 1
747 # called later (via is4 && grmlcomp)
748 # note: use 'zstyle' for getting current settings
749 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
750 function grmlcomp () {
751 # TODO: This could use some additional information
753 # Make sure the completion system is initialised
754 (( ${+_comps} )) || return 1
756 # allow one error for every three characters typed in approximate completer
757 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
759 # don't complete backup files as executables
760 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
762 # start menu completion only if it could find no unambiguous initial string
763 zstyle ':completion:*:correct:*' insert-unambiguous true
764 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
765 zstyle ':completion:*:correct:*' original true
767 # activate color-completion
768 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
770 # format on completion
771 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
773 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
774 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
776 # insert all expansions for expand completer
777 zstyle ':completion:*:expand:*' tag-order all-expansions
778 zstyle ':completion:*:history-words' list false
781 zstyle ':completion:*:history-words' menu yes
783 # ignore duplicate entries
784 zstyle ':completion:*:history-words' remove-all-dups yes
785 zstyle ':completion:*:history-words' stop yes
787 # match uppercase from lowercase
788 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
790 # separate matches into groups
791 zstyle ':completion:*:matches' group 'yes'
792 zstyle ':completion:*' group-name ''
794 if [[ "$NOMENU" -eq 0 ]] ; then
795 # if there are more than 5 options allow selecting from a menu
796 zstyle ':completion:*' menu select=5
798 # don't use any menus at all
802 zstyle ':completion:*:messages' format '%d'
803 zstyle ':completion:*:options' auto-description '%d'
805 # describe options in full
806 zstyle ':completion:*:options' description 'yes'
808 # on processes completion complete all user processes
809 zstyle ':completion:*:processes' command 'ps -au$USER'
811 # offer indexes before parameters in subscripts
812 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
814 # provide verbose completion information
815 zstyle ':completion:*' verbose true
817 # recent (as of Dec 2007) zsh versions are able to provide descriptions
818 # for commands (read: 1st word in the line) that it will list for the user
819 # to choose from. The following disables that, because it's not exactly fast.
820 zstyle ':completion:*:-command-:*:' verbose false
822 # set format for warnings
823 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
825 # define files to ignore for zcompile
826 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
827 zstyle ':completion:correct:' prompt 'correct to: %e'
829 # Ignore completion functions for commands you don't have:
830 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
832 # Provide more processes in completion of programs like killall:
833 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
835 # complete manual by their section
836 zstyle ':completion:*:manuals' separate-sections true
837 zstyle ':completion:*:manuals.*' insert-sections true
838 zstyle ':completion:*:man:*' menu yes select
840 # Search path for sudo completion
841 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
849 # provide .. as a completion
850 zstyle ':completion:*' special-dirs ..
852 # run rehash on completion so new installed program are found automatically:
853 function _force_rehash () {
854 (( CURRENT == 1 )) && rehash
859 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
860 if [[ "$NOCOR" -gt 0 ]] ; then
861 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
864 # try to be smart about when to use what completer...
866 zstyle -e ':completion:*' completer '
867 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
868 _last_try="$HISTNO$BUFFER$CURSOR"
869 reply=(_complete _match _ignored _prefix _files)
871 if [[ $words[1] == (rm|mv) ]] ; then
872 reply=(_complete _files)
874 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
879 # command for process lists, the local web server details and host completion
880 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
882 # Some functions, like _apt and _dpkg, are very slow. We can use a cache in
883 # order to speed things up
884 if [[ ${GRML_COMP_CACHING:-yes} == yes ]]; then
885 GRML_COMP_CACHE_DIR=${GRML_COMP_CACHE_DIR:-${ZDOTDIR:-$HOME}/.cache}
886 if [[ ! -d ${GRML_COMP_CACHE_DIR} ]]; then
887 command mkdir -p "${GRML_COMP_CACHE_DIR}"
889 zstyle ':completion:*' use-cache yes
890 zstyle ':completion:*:complete:*' cache-path "${GRML_COMP_CACHE_DIR}"
895 [[ -r ~/.ssh/config ]] && _ssh_config_hosts=(${${(s: :)${(ps:\t:)${${(@M)${(f)"$(<$HOME/.ssh/config)"}:#Host *}#Host }}}:#*[*?]*}) || _ssh_config_hosts=()
896 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
897 [[ -r /etc/hosts ]] && [[ "$NOETCHOSTS" -eq 0 ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(grep -v '^0\.0\.0.\0\|^127\.0\.0\.1\|^::1 ' /etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
905 localname="$(uname -n)"
908 "$_ssh_config_hosts[@]"
913 zstyle ':completion:*:hosts' hosts $hosts
914 # TODO: so, why is this here?
915 # zstyle '*' hosts $hosts
917 # use generic completion system for programs not yet defined; (_gnu_generic works
918 # with commands that provide a --help option with "standard" gnu-like output.)
919 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
921 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
924 # see upgrade function in this file
925 compdef _hosts upgrade
928 # Keyboard setup: The following is based on the same code, we wrote for
929 # debian's setup. It ensures the terminal is in the right mode, when zle is
930 # active, so the values from $terminfo are valid. Therefore, this setup should
931 # work on all systems, that have support for `terminfo'. It also requires the
932 # zsh in use to have the `zsh/terminfo' module built.
934 # If you are customising your `zle-line-init()' or `zle-line-finish()'
935 # functions, make sure you call the following utility functions in there:
937 # - zle-line-init(): zle-smkx
938 # - zle-line-finish(): zle-rmkx
940 # Use emacs-like key bindings by default:
945 ## beginning-of-line OR beginning-of-buffer OR beginning of history
946 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
947 function beginning-or-end-of-somewhere () {
949 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
950 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
951 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
953 zle .${WIDGET:s/somewhere/line-hist/} "$@"
954 if (( HISTNO != hno )); then
955 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
959 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
960 zle -N end-of-somewhere beginning-or-end-of-somewhere
962 # add a command line to the shells history without executing it
963 function commit-to-history () {
964 print -rs ${(z)BUFFER}
967 zle -N commit-to-history
969 # only slash should be considered as a word separator:
970 function slash-backward-kill-word () {
971 local WORDCHARS="${WORDCHARS:s@/@}"
973 zle backward-kill-word
975 zle -N slash-backward-kill-word
977 # a generic accept-line wrapper
979 # This widget can prevent unwanted autocorrections from command-name
980 # to _command-name, rehash automatically on enter and call any number
981 # of builtin and user-defined widgets in different contexts.
983 # For a broader description, see:
984 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
986 # The code is imported from the file 'zsh/functions/accept-line' from
987 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
988 # distributed under the same terms as zsh itself.
990 # A newly added command will may not be found or will cause false
991 # correction attempts, if you got auto-correction set. By setting the
992 # following style, we force accept-line() to rehash, if it cannot
993 # find the first word on the command line in the $command[] hash.
994 zstyle ':acceptline:*' rehash true
996 function Accept-Line () {
997 setopt localoptions noksharrays
1001 local alcontext=${1:-$alcontext}
1003 zstyle -a ":acceptline:${alcontext}" actions subs
1005 (( ${#subs} < 1 )) && return 0
1008 for sub in ${subs} ; do
1009 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
1012 (( aldone > 0 )) && break
1016 function Accept-Line-getdefault () {
1018 local default_action
1020 zstyle -s ":acceptline:${alcontext}" default_action default_action
1021 case ${default_action} in
1023 printf ".accept-line"
1026 printf ${default_action}
1031 function Accept-Line-HandleContext () {
1034 default_action=$(Accept-Line-getdefault)
1035 zstyle -T ":acceptline:${alcontext}" call_default \
1036 && zle ${default_action}
1039 function accept-line () {
1040 setopt localoptions noksharrays
1043 local buf com fname format msg default_action
1047 cmdline=(${(z)BUFFER})
1051 Accept-Line 'preprocess'
1053 zstyle -t ":acceptline:${alcontext}" rehash \
1054 && [[ -z ${commands[$com]} ]] \
1057 if [[ -n ${com} ]] \
1058 && [[ -n ${reswords[(r)$com]} ]] \
1059 || [[ -n ${aliases[$com]} ]] \
1060 || [[ -n ${functions[$com]} ]] \
1061 || [[ -n ${builtins[$com]} ]] \
1062 || [[ -n ${commands[$com]} ]] ; then
1064 # there is something sensible to execute, just do it.
1066 Accept-Line-HandleContext
1071 if [[ -o correct ]] \
1072 || [[ -o correctall ]] \
1073 && [[ -n ${functions[$fname]} ]] ; then
1075 # nothing there to execute but there is a function called
1076 # _command_name; a completion widget. Makes no sense to
1077 # call it on the commandline, but the correct{,all} options
1078 # will ask for it nevertheless, so warn the user.
1079 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
1080 # Okay, we warned the user before, he called us again,
1081 # so have it his way.
1083 Accept-Line-HandleContext
1088 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
1090 Accept-Line-HandleContext
1092 # prepare warning message for the user, configurable via zstyle.
1093 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
1095 if [[ -z ${msg} ]] ; then
1096 msg="%c will not execute and completion %f exists."
1099 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
1104 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
1105 # If we are here, the commandline contains something that is not
1106 # executable, which is neither subject to _command_name correction
1107 # and is not empty. might be a variable assignment
1109 Accept-Line-HandleContext
1114 # If we got this far, the commandline only contains whitespace, or is empty.
1116 Accept-Line-HandleContext
1121 zle -N Accept-Line-HandleContext
1123 # power completion / abbreviation expansion / buffer expansion
1124 # see http://zshwiki.org/home/examples/zleiab for details
1125 # less risky than the global aliases but powerful as well
1126 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
1129 setopt interactivecomments
1131 # key # value (#d additional doc string)
1137 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1139 'Hl' ' --help |& less -r' #d (Display help in pager)
1143 'N' '&>/dev/null' #d (No Output)
1144 'R' '| tr A-z N-za-m' #d (ROT13)
1145 'SL' '| sort | less'
1150 'co' './configure && make && sudo make install'
1153 function zleiab () {
1158 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1159 LBUFFER+=${abk[$MATCH]:-$MATCH}
1164 function help-show-abk () {
1165 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1168 zle -N help-show-abk
1170 # press "ctrl-x d" to insert the actual date in the form yyyy-mm-dd
1171 function insert-datestamp () { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1172 zle -N insert-datestamp
1174 # press esc-m for inserting last typed word again (thanks to caphuso!)
1175 function insert-last-typed-word () { zle insert-last-word -- 0 -1 };
1176 zle -N insert-last-typed-word;
1178 function grml-zsh-fg () {
1179 if (( ${#jobstates} )); then
1181 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1182 BUFFER="${BUFFER}fg"
1185 zle -M 'No background jobs. Doing nothing.'
1190 # run command line as user root via sudo:
1191 function sudo-command-line () {
1192 [[ -z $BUFFER ]] && zle up-history
1194 if [[ ${BUFFER} == ${cmd}* ]]; then
1195 CURSOR=$(( CURSOR-${#cmd} ))
1196 BUFFER="${BUFFER#$cmd}"
1198 BUFFER="${cmd}${BUFFER}"
1199 CURSOR=$(( CURSOR+${#cmd} ))
1203 zle -N sudo-command-line
1205 ### jump behind the first word on the cmdline.
1206 ### useful to add options.
1207 function jump_after_first_word () {
1209 words=(${(z)BUFFER})
1211 if (( ${#words} <= 1 )) ; then
1214 CURSOR=${#${words[1]}}
1217 zle -N jump_after_first_word
1219 #f5# Create directory under cursor or the selected area
1220 function inplaceMkDirs () {
1221 # Press ctrl-xM to create the directory under the cursor or the selected area.
1222 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1223 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1224 # directory does not exist yet -> press ctrl-XM and problem solved
1226 if ((REGION_ACTIVE==1)); then
1227 local F=$MARK T=$CURSOR
1228 if [[ $F -gt $T ]]; then
1232 # get marked area from buffer and eliminate whitespace
1233 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1234 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1236 local bufwords iword
1237 bufwords=(${(z)LBUFFER})
1239 bufwords=(${(z)BUFFER})
1240 PATHTOMKDIR="${(Q)bufwords[iword]}"
1242 [[ -z "${PATHTOMKDIR}" ]] && return 1
1243 PATHTOMKDIR=${~PATHTOMKDIR}
1244 if [[ -e "${PATHTOMKDIR}" ]]; then
1245 zle -M " path already exists, doing nothing"
1247 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1252 zle -N inplaceMkDirs
1254 #v1# set number of lines to display per page
1255 HELP_LINES_PER_PAGE=20
1256 #v1# set location of help-zle cache file
1257 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1258 # helper function for help-zle, actually generates the help text
1259 function help_zle_parse_keybindings () {
1262 unsetopt ksharrays #indexing starts at 1
1264 #v1# choose files that help-zle will parse for keybindings
1265 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1267 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1270 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1271 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1274 #fill with default keybindings, possibly to be overwritten in a file later
1275 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1276 local -A help_zle_keybindings
1277 help_zle_keybindings['<Ctrl>@']="set MARK"
1278 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1279 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1280 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1281 help_zle_keybindings['<Ctrl>_']="undo"
1282 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1283 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1284 help_zle_keybindings['<Ctrl>e']="goto end of line"
1285 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1286 help_zle_keybindings['<Alt>t']="transpose words"
1287 help_zle_keybindings['<Alt>s']="spellcheck word"
1288 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1289 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1290 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1291 help_zle_keybindings["<Alt>'"]="quote line"
1292 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1293 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1294 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1295 help_zle_keybindings['<Alt>l']="make next word lowercase"
1296 help_zle_keybindings['<Ctrl>xG']="preview expansion under cursor"
1297 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1298 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1299 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1300 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1301 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1302 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1303 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1304 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1306 #init global variables
1307 unset help_zle_lines help_zle_sln
1308 typeset -g -a help_zle_lines
1309 typeset -g help_zle_sln=1
1312 local lastkeybind_desc contents #last description starting with #k# that we found
1313 local num_lines_elapsed=0 #number of lines between last description and keybinding
1314 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1315 for f in $HELPZLE_KEYBINDING_FILES; do
1316 [[ -r "$f" ]] || continue #not readable ? skip it
1318 for cline in "${(f)contents}"; do
1319 #zsh pattern: matches lines like: #k# ..............
1320 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1321 lastkeybind_desc="$match[*]"
1323 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1324 # ignores lines that are commentend out
1325 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1326 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1327 #description previously found ? description not more than 2 lines away ? keybinding not empty ?
1328 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1329 #substitute keybinding string with something readable
1330 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1331 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1332 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1333 help_zle_keybindings[${k}]=$lastkeybind_desc
1337 ((num_lines_elapsed++))
1342 #calculate length of keybinding column
1344 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1345 #convert the assoc array into preformated lines, which we are able to sort
1346 for k v in ${(kv)help_zle_keybindings[@]}; do
1347 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1348 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1350 #sort lines alphabetically
1351 help_zle_lines=("${(i)help_zle_lines[@]}")
1352 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1353 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1354 zcompile $HELP_ZLE_CACHE_FILE
1356 typeset -g help_zle_sln
1357 typeset -g -a help_zle_lines
1359 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1360 function help-zle () {
1362 unsetopt ksharrays #indexing starts at 1
1363 #help lines already generated ? no ? then do it
1364 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1365 #already displayed all lines ? go back to the start
1366 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1367 local sln=$help_zle_sln
1368 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1369 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1370 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1374 ## complete word from currently visible Screen or Tmux buffer.
1375 if check_com -c screen || check_com -c tmux; then
1376 function _complete_screen_display () {
1377 [[ "$TERM" != "screen" ]] && return 1
1379 local TMPFILE=$(mktemp)
1380 local -U -a _screen_display_wordlist
1381 trap "rm -f $TMPFILE" EXIT
1383 # fill array with contents from screen hardcopy
1384 if ((${+TMUX})); then
1385 #works, but crashes tmux below version 1.4
1386 #luckily tmux -V option to ask for version, was also added in 1.4
1387 tmux -V &>/dev/null || return
1388 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1390 screen -X hardcopy $TMPFILE
1391 # screen sucks, it dumps in latin1, apparently always. so recode it
1393 check_com recode && recode latin1 $TMPFILE
1395 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1396 # remove PREFIX to be completed from that array
1397 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1398 compadd -a _screen_display_wordlist
1400 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1402 compdef -k _complete_screen_display complete-word '^xS'
1405 # Load a few more functions and tie them to widgets, so they can be bound:
1407 function zrcautozle () {
1410 zrcautoload $fnc && zle -N $fnc
1413 function zrcgotwidget () {
1414 (( ${+widgets[$1]} ))
1417 function zrcgotkeymap () {
1418 [[ -n ${(M)keymaps:#$1} ]]
1421 zrcautozle insert-files
1422 zrcautozle edit-command-line
1423 zrcautozle insert-unicode-char
1424 if zrcautoload history-search-end; then
1425 zle -N history-beginning-search-backward-end history-search-end
1426 zle -N history-beginning-search-forward-end history-search-end
1428 zle -C hist-complete complete-word _generic
1429 zstyle ':completion:hist-complete:*' completer _history
1431 # The actual terminal setup hooks and bindkey-calls:
1433 # An array to note missing features to ease diagnosis in case of problems.
1434 typeset -ga grml_missing_features
1436 function zrcbindkey () {
1437 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1442 function bind2maps () {
1443 local i sequence widget
1446 while [[ "$1" != "--" ]]; do
1452 if [[ "$1" == "-s" ]]; then
1456 sequence="${key[$1]}"
1460 [[ -z "$sequence" ]] && return 1
1462 for i in "${maps[@]}"; do
1463 zrcbindkey -M "$i" "$sequence" "$widget"
1467 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1468 function zle-smkx () {
1470 printf '%s' ${terminfo[smkx]}
1472 function zle-rmkx () {
1474 printf '%s' ${terminfo[rmkx]}
1476 function zle-line-init () {
1479 function zle-line-finish () {
1482 zle -N zle-line-init
1483 zle -N zle-line-finish
1485 for i in {s,r}mkx; do
1486 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1493 Home "${terminfo[khome]}"
1494 End "${terminfo[kend]}"
1495 Insert "${terminfo[kich1]}"
1496 Delete "${terminfo[kdch1]}"
1497 Up "${terminfo[kcuu1]}"
1498 Down "${terminfo[kcud1]}"
1499 Left "${terminfo[kcub1]}"
1500 Right "${terminfo[kcuf1]}"
1501 PageUp "${terminfo[kpp]}"
1502 PageDown "${terminfo[knp]}"
1503 BackTab "${terminfo[kcbt]}"
1506 # Guidelines for adding key bindings:
1508 # - Do not add hardcoded escape sequences, to enable non standard key
1509 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1511 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1514 # - All keys from the $key[] mapping are obviously okay.
1516 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1517 # '\ex' are allowed in here as well.
1519 bind2maps emacs -- Home beginning-of-somewhere
1520 bind2maps viins vicmd -- Home vi-beginning-of-line
1521 bind2maps emacs -- End end-of-somewhere
1522 bind2maps viins vicmd -- End vi-end-of-line
1523 bind2maps emacs viins -- Insert overwrite-mode
1524 bind2maps vicmd -- Insert vi-insert
1525 bind2maps emacs -- Delete delete-char
1526 bind2maps viins vicmd -- Delete vi-delete-char
1527 bind2maps emacs viins vicmd -- Up up-line-or-search
1528 bind2maps emacs viins vicmd -- Down down-line-or-search
1529 bind2maps emacs -- Left backward-char
1530 bind2maps viins vicmd -- Left vi-backward-char
1531 bind2maps emacs -- Right forward-char
1532 bind2maps viins vicmd -- Right vi-forward-char
1533 #k# Perform abbreviation expansion
1534 bind2maps emacs viins -- -s '^x.' zleiab
1535 #k# Display list of abbreviations that would expand
1536 bind2maps emacs viins -- -s '^xb' help-show-abk
1537 #k# mkdir -p <dir> from string under cursor or marked area
1538 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1539 #k# display help for keybindings and ZLE
1540 bind2maps emacs viins -- -s '^xz' help-zle
1541 #k# Insert files and test globbing
1542 bind2maps emacs viins -- -s "^xf" insert-files
1543 #k# Edit the current line in \kbd{\$EDITOR}
1544 bind2maps emacs viins -- -s '\ee' edit-command-line
1545 #k# search history backward for entry beginning with typed text
1546 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1547 #k# search history forward for entry beginning with typed text
1548 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1549 #k# search history backward for entry beginning with typed text
1550 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1551 #k# search history forward for entry beginning with typed text
1552 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1553 bind2maps emacs viins -- -s "^x^h" commit-to-history
1554 #k# Kill left-side word or everything up to next slash
1555 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1556 #k# Kill left-side word or everything up to next slash
1557 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1558 #k# Kill left-side word or everything up to next slash
1559 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1560 # Do history expansion on space:
1561 bind2maps emacs viins -- -s ' ' magic-space
1562 #k# Trigger menu-complete
1563 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1564 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1565 bind2maps emacs viins -- -s '^xd' insert-datestamp
1566 #k# Insert last typed word
1567 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1568 #k# A smart shortcut for \kbd{fg<enter>}
1569 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1570 #k# prepend the current command with "sudo"
1571 bind2maps emacs viins -- -s "^os" sudo-command-line
1572 #k# jump to after first word (for adding options)
1573 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1574 #k# complete word from history with menu
1575 bind2maps emacs viins -- -s "^x^x" hist-complete
1577 # insert unicode character
1578 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1579 # See for example http://unicode.org/charts/ for unicode characters code
1580 #k# Insert Unicode character
1581 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1583 # use the new *-pattern-* widgets for incremental history search
1584 if zrcgotwidget history-incremental-pattern-search-backward; then
1585 for seq wid in '^r' history-incremental-pattern-search-backward \
1586 '^s' history-incremental-pattern-search-forward
1588 bind2maps emacs viins vicmd -- -s $seq $wid
1590 builtin unset -v seq wid
1593 if zrcgotkeymap menuselect; then
1594 #m# k Shift-tab Perform backwards menu completion
1595 bind2maps menuselect -- BackTab reverse-menu-complete
1597 #k# menu selection: pick item but stay in the menu
1598 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1599 # also use + and INSERT since it's easier to press repeatedly
1600 bind2maps menuselect -- -s '+' accept-and-menu-complete
1601 bind2maps menuselect -- Insert accept-and-menu-complete
1603 # accept a completion and try to complete again by using menu
1604 # completion; very useful with completing directories
1605 # by using 'undo' one's got a simple file browser
1606 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1609 # Finally, here are still a few hardcoded escape sequences; Special sequences
1610 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1611 # standardised and most of the time are not available in a terminals terminfo
1614 # While we do not encourage adding bindings like these, we will keep these for
1615 # backward compatibility.
1617 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1618 ## the command line.
1620 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1621 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1622 # These are for xterm:
1623 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1624 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1625 ## the same for alt-left-arrow and alt-right-arrow
1627 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1628 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1630 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1631 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1632 # Also try ESC Left/Right:
1633 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1634 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1641 # we don't want to quote/espace URLs on our own...
1642 # if autoload -U url-quote-magic ; then
1643 # zle -N self-insert url-quote-magic
1644 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1646 # print 'Notice: no url-quote-magic available :('
1649 # url-quote doesn't work without bracketed-paste-magic since Zsh 5.1
1650 alias url-quote='autoload -U bracketed-paste-magic url-quote-magic;
1651 zle -N bracketed-paste bracketed-paste-magic; zle -N self-insert url-quote-magic'
1653 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1656 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1657 alias run-help >&/dev/null && unalias run-help
1658 for rh in run-help{,-git,-ip,-openssl,-p4,-sudo,-svk,-svn}; do
1662 # command not found handling
1664 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1665 function command_not_found_handler () {
1667 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1668 ${GRML_ZSH_CNF_HANDLER} $1
1676 HISTFILE=${HISTFILE:-${ZDOTDIR:-${HOME}}/.zsh_history}
1677 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1678 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1682 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1683 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1685 if zstyle -T ':grml:chpwd:dirstack' enable; then
1686 typeset -gaU GRML_PERSISTENT_DIRSTACK
1687 function grml_dirstack_filter () {
1690 if zstyle -s ':grml:chpwd:dirstack' filter filter; then
1691 $filter $1 && return 0
1693 if zstyle -a ':grml:chpwd:dirstack' exclude exclude; then
1694 for entry in "${exclude[@]}"; do
1695 [[ $1 == ${~entry} ]] && return 0
1702 (( ZSH_SUBSHELL )) && return
1703 (( $DIRSTACKSIZE <= 0 )) && return
1704 [[ -z $DIRSTACKFILE ]] && return
1705 grml_dirstack_filter $PWD && return
1706 GRML_PERSISTENT_DIRSTACK=(
1707 $PWD "${(@)GRML_PERSISTENT_DIRSTACK[1,$DIRSTACKSIZE]}"
1709 builtin print -l ${GRML_PERSISTENT_DIRSTACK} >! ${DIRSTACKFILE}
1712 if [[ -f ${DIRSTACKFILE} ]]; then
1713 # Enabling NULL_GLOB via (N) weeds out any non-existing
1714 # directories from the saved dir-stack file.
1715 dirstack=( ${(f)"$(< $DIRSTACKFILE)"}(N) )
1716 # "cd -" won't work after login by just setting $OLDPWD, so
1717 [[ -d $dirstack[1] ]] && cd -q $dirstack[1] && cd -q $OLDPWD
1720 if zstyle -t ':grml:chpwd:dirstack' filter-on-load; then
1721 for i in "${dirstack[@]}"; do
1722 if ! grml_dirstack_filter "$i"; then
1723 GRML_PERSISTENT_DIRSTACK=(
1724 "${GRML_PERSISTENT_DIRSTACK[@]}"
1730 GRML_PERSISTENT_DIRSTACK=( "${dirstack[@]}" )
1734 # directory based profiles
1738 # chpwd_profiles(): Directory Profiles, Quickstart:
1742 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1743 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1746 # For details see the `grmlzshrc.5' manual page.
1747 function chpwd_profiles () {
1748 local profile context
1751 context=":chpwd:profiles:$PWD"
1752 zstyle -s "$context" profile profile || profile='default'
1753 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1755 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1756 typeset -g CHPWD_PROFILE
1757 local CHPWD_PROFILES_INIT=1
1758 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1759 elif [[ $profile != $CHPWD_PROFILE ]]; then
1760 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1761 && chpwd_leave_profile_${CHPWD_PROFILE}
1763 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1764 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1767 CHPWD_PROFILE="${profile}"
1771 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1775 # Prompt setup for grml:
1777 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1778 # in prompts to get a red "foo" embedded, but it's good to keep these for
1779 # backwards compatibility).
1785 MAGENTA="%F{magenta}"
1789 elif zrcautoload colors && colors 2>/dev/null ; then
1790 BLUE="%{${fg[blue]}%}"
1791 RED="%{${fg_bold[red]}%}"
1792 GREEN="%{${fg[green]}%}"
1793 CYAN="%{${fg[cyan]}%}"
1794 MAGENTA="%{${fg[magenta]}%}"
1795 YELLOW="%{${fg[yellow]}%}"
1796 WHITE="%{${fg[white]}%}"
1797 NO_COLOR="%{${reset_color}%}"
1799 BLUE=$'%{\e[1;34m%}'
1801 GREEN=$'%{\e[1;32m%}'
1802 CYAN=$'%{\e[1;36m%}'
1803 WHITE=$'%{\e[1;37m%}'
1804 MAGENTA=$'%{\e[1;35m%}'
1805 YELLOW=$'%{\e[1;33m%}'
1806 NO_COLOR=$'%{\e[0m%}'
1809 # First, the easy ones: PS2..4:
1811 # secondary prompt, printed when the shell needs more information to complete a
1814 # selection prompt used within a select loop.
1816 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1819 # Some additional features to use with our prompt:
1823 # - vcs_info setup and version specific fixes
1825 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1827 function battery () {
1828 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1831 elif isopenbsd ; then
1833 elif isfreebsd ; then
1835 elif isdarwin ; then
1839 GRML_DISPLAY_BATTERY=0
1844 function batterylinux () {
1845 GRML_BATTERY_LEVEL=''
1846 local batteries bat capacity
1847 batteries=( /sys/class/power_supply/BAT*(N) )
1848 if (( $#batteries > 0 )) ; then
1849 for bat in $batteries ; do
1850 if [[ -e $bat/capacity ]]; then
1851 capacity=$(< $bat/capacity)
1853 typeset -F energy_full=$(< $bat/energy_full)
1854 typeset -F energy_now=$(< $bat/energy_now)
1855 typeset -i capacity=$(( 100 * $energy_now / $energy_full))
1857 case $(< $bat/status) in
1859 GRML_BATTERY_LEVEL+=" ^"
1862 if (( capacity < 20 )) ; then
1863 GRML_BATTERY_LEVEL+=" !v"
1865 GRML_BATTERY_LEVEL+=" v"
1869 GRML_BATTERY_LEVEL+=" ="
1872 GRML_BATTERY_LEVEL+="${capacity}%%"
1877 function batteryopenbsd () {
1878 GRML_BATTERY_LEVEL=''
1879 local bat batfull batwarn batnow num
1881 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1882 if [[ -n $bat ]]; then
1883 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1884 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1885 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1886 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1888 if (( batnow < batwarn )) ; then
1889 GRML_BATTERY_LEVEL+=" !v"
1891 GRML_BATTERY_LEVEL+=" v"
1895 GRML_BATTERY_LEVEL+=" ^"
1898 GRML_BATTERY_LEVEL+=" ="
1901 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1906 function batteryfreebsd () {
1907 GRML_BATTERY_LEVEL=''
1911 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1912 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1913 case $table[State] in
1915 if (( $table[Remaining-capacity] < 20 )) ; then
1916 GRML_BATTERY_LEVEL+=" !v"
1918 GRML_BATTERY_LEVEL+=" v"
1922 GRML_BATTERY_LEVEL+=" ^"
1925 GRML_BATTERY_LEVEL+=" ="
1928 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1933 function batterydarwin () {
1934 GRML_BATTERY_LEVEL=''
1936 table=( ${$(pmset -g ps)[(w)8,9]%%(\%|);} )
1937 if [[ -n $table[2] ]] ; then
1940 GRML_BATTERY_LEVEL+=" ^"
1943 if (( $table[1] < 20 )) ; then
1944 GRML_BATTERY_LEVEL+=" !v"
1946 GRML_BATTERY_LEVEL+=" v"
1950 GRML_BATTERY_LEVEL+=" ="
1953 GRML_BATTERY_LEVEL+="$table[1]%%"
1957 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1958 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1959 debian_chroot=$(</etc/debian_chroot)
1962 # gather version control information for inclusion in a prompt
1964 if zrcautoload vcs_info; then
1965 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1966 # function, which can cause a lot of trouble with our directory-based
1968 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1969 function VCS_INFO_realpath () {
1970 setopt localoptions NO_shwordsplit chaselinks
1971 ( builtin cd -q $1 2> /dev/null && pwd; )
1975 zstyle ':vcs_info:*' max-exports 2
1977 if [[ -o restricted ]]; then
1978 zstyle ':vcs_info:*' enable NONE
1982 typeset -A grml_vcs_coloured_formats
1983 typeset -A grml_vcs_plain_formats
1985 grml_vcs_plain_formats=(
1986 format "(%s%)-[%b] " "zsh: %r"
1987 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1988 rev-branchformat "%b:%r"
1991 grml_vcs_coloured_formats=(
1992 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
1993 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
1994 rev-branchformat "%b${RED}:${YELLOW}%r"
1997 typeset GRML_VCS_COLOUR_MODE=xxx
1999 function grml_vcs_info_toggle_colour () {
2001 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
2002 grml_vcs_info_set_formats coloured
2004 grml_vcs_info_set_formats plain
2009 function grml_vcs_info_set_formats () {
2011 #setopt localoptions xtrace
2012 local mode=$1 AF F BF
2013 if [[ $mode == coloured ]]; then
2014 AF=${grml_vcs_coloured_formats[actionformat]}
2015 F=${grml_vcs_coloured_formats[format]}
2016 BF=${grml_vcs_coloured_formats[rev-branchformat]}
2017 GRML_VCS_COLOUR_MODE=coloured
2019 AF=${grml_vcs_plain_formats[actionformat]}
2020 F=${grml_vcs_plain_formats[format]}
2021 BF=${grml_vcs_plain_formats[rev-branchformat]}
2022 GRML_VCS_COLOUR_MODE=plain
2025 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
2026 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
2027 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
2031 # Change vcs_info formats for the grml prompt. The 2nd format sets up
2032 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
2033 if [[ "$TERM" == dumb ]] ; then
2034 grml_vcs_info_set_formats plain
2036 grml_vcs_info_set_formats coloured
2039 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
2041 # This actually defines three prompts:
2047 # They all share the same code and only differ with respect to which items they
2048 # contain. The main source of documentation is the `prompt_grml_help' function
2049 # below, which gets called when the user does this: prompt -h grml
2051 function prompt_grml_help () {
2055 This is the prompt as used by the grml-live system <http://grml.org>. It is
2056 a rather simple one-line prompt, that by default looks something like this:
2058 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
2060 The prompt itself integrates with zsh's prompt themes system (as you are
2061 witnessing right now) and is configurable to a certain degree. In
2062 particular, these aspects are customisable:
2064 - The items used in the prompt (e.g. you can remove \`user' from
2065 the list of activated items, which will cause the user name to
2066 be omitted from the prompt string).
2068 - The attributes used with the items are customisable via strings
2069 used before and after the actual item.
2071 The available items are: at, battery, change-root, date, grml-chroot,
2072 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
2073 shell-level, time, user, vcs
2075 The actual configuration is done via zsh's \`zstyle' mechanism. The
2076 context, that is used while looking up styles is:
2078 ':prompt:grml:<left-or-right>:<subcontext>'
2080 Here <left-or-right> is either \`left' or \`right', signifying whether the
2081 style should affect the left or the right prompt. <subcontext> is either
2082 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
2086 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
2087 in $RPROMPT if the last command a returned non-successful error code.
2088 (This in only valid if <left-or-right> is "right"; ignored otherwise)
2090 - items (list): The list of items used in the prompt. If \`vcs' is
2091 present in the list, the theme's code invokes \`vcs_info'
2092 accordingly. Default (left): rc change-root user at host path vcs
2093 percent; Default (right): sad-smiley
2095 - strip-sensitive-characters (boolean): If the \`prompt_subst' option
2096 is active in zsh, the shell performs lots of expansions on prompt
2097 variable strings, including command substitution. So if you don't
2098 control where some of your prompt strings is coming from, this is
2099 an exploitable weakness. Grml's zsh setup does not set this option
2100 and it is off in the shell in zsh-mode by default. If it *is* turned
2101 on however, this style becomes active, and there are two flavours of
2102 it: On per default is a global variant in the '*:setup' context. This
2103 strips characters after the whole prompt string was constructed. There
2104 is a second variant in the '*:items:<item>', that is off by default.
2105 It allows fine grained control over which items' data is stripped.
2106 The characters that are stripped are: \$ and \`.
2108 Available styles in 'items:<item>' are: pre, post. These are strings that
2109 are inserted before (pre) and after (post) the item in question. Thus, the
2110 following would cause the user name to be printed in red instead of the
2113 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
2115 Note, that the \`post' style may remain at its default value, because its
2116 default value is '%f', which turns the foreground text attribute off (which
2117 is exactly, what is still required with the new \`pre' value).
2121 function prompt_grml-chroot_help () {
2125 This is a variation of the grml prompt, see: prompt -h grml
2127 The main difference is the default value of the \`items' style. The rest
2128 behaves exactly the same. Here are the defaults for \`grml-chroot':
2130 - left: grml-chroot user at host path percent
2131 - right: (empty list)
2135 function prompt_grml-large_help () {
2139 This is a variation of the grml prompt, see: prompt -h grml
2141 The main difference is the default value of the \`items' style. In
2142 particular, this theme uses _two_ lines instead of one with the plain
2143 \`grml' theme. The rest behaves exactly the same. Here are the defaults
2146 - left: rc jobs history shell-level change-root time date newline user
2147 at host path vcs percent
2152 function grml_prompt_setup () {
2154 autoload -Uz vcs_info
2155 # The following autoload is disabled for now, since this setup includes a
2156 # static version of the ‘add-zsh-hook’ function above. It needs to be
2157 # re-enabled as soon as that static definition is removed again.
2158 #autoload -Uz add-zsh-hook
2159 add-zsh-hook precmd prompt_$1_precmd
2162 function prompt_grml_setup () {
2163 grml_prompt_setup grml
2166 function prompt_grml-chroot_setup () {
2167 grml_prompt_setup grml-chroot
2170 function prompt_grml-large_setup () {
2171 grml_prompt_setup grml-large
2174 # These maps define default tokens and pre-/post-decoration for items to be
2175 # used within the themes. All defaults may be customised in a context sensitive
2176 # matter by using zsh's `zstyle' mechanism.
2177 typeset -gA grml_prompt_pre_default \
2178 grml_prompt_post_default \
2179 grml_prompt_token_default \
2180 grml_prompt_token_function
2182 grml_prompt_pre_default=(
2187 grml-chroot '%F{red}'
2197 shell-level '%F{red}'
2203 grml_prompt_post_default=(
2224 grml_prompt_token_default=(
2226 battery 'GRML_BATTERY_LEVEL'
2227 change-root 'debian_chroot'
2229 grml-chroot 'GRML_CHROOT'
2230 history '{history#%!} '
2232 jobs '[%j running job(s)] '
2234 path '%40<..<%~%<< '
2238 sad-smiley '%(?..:()'
2239 shell-level '%(3L.+ .)'
2240 time '%D{%H:%M:%S} '
2245 function grml_theme_has_token () {
2246 if (( ARGC != 1 )); then
2247 printf 'usage: grml_theme_has_token <name>\n'
2250 (( ${+grml_prompt_token_default[$1]} ))
2253 function GRML_theme_add_token_usage () {
2255 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2257 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2258 are used, <token/function> is the name of the function (see below for
2259 details). Otherwise it is the literal token string to be used. <pre> and
2260 <post> are optional.
2264 -f <function> Use a function named \`<function>' each time the token
2267 -i <function> Use a function named \`<function>' to initialise the
2268 value of the token _once_ at runtime.
2270 The functions are called with one argument: the token's new name. The
2271 return value is expected in the \$REPLY parameter. The use of these
2272 options is mutually exclusive.
2274 There is a utility function \`grml_theme_has_token', which you can use
2275 to test if a token exists before trying to add it. This can be a guard
2276 for situations in which a \`grml_theme_add_token' call may happen more
2281 To add a new token \`day' that expands to the current weekday in the
2282 current locale in green foreground colour, use this:
2284 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2286 Another example would be support for \$VIRTUAL_ENV:
2288 function virtual_env_prompt () {
2289 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2291 grml_theme_add_token virtual-env -f virtual_env_prompt
2293 After that, you will be able to use a changed \`items' style to
2294 assemble your prompt.
2298 function grml_theme_add_token () {
2300 local name token pre post
2301 local -i init funcall
2303 if (( ARGC == 0 )); then
2304 GRML_theme_add_token_usage
2314 if [[ $1 == '-f' ]]; then
2317 elif [[ $1 == '-i' ]]; then
2322 if (( ARGC == 0 )); then
2324 grml_theme_add_token: No token-string/function-name provided!\n\n'
2325 GRML_theme_add_token_usage
2330 if (( ARGC != 0 && ARGC != 2 )); then
2332 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2333 GRML_theme_add_token_usage
2342 if grml_theme_has_token $name; then
2344 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2345 GRML_theme_add_token_usage
2353 grml_prompt_pre_default[$name]=$pre
2354 grml_prompt_post_default[$name]=$post
2355 if (( funcall )); then
2356 grml_prompt_token_function[$name]=$token
2357 grml_prompt_token_default[$name]=23
2359 grml_prompt_token_default[$name]=$token
2363 function grml_wrap_reply () {
2370 if (( ${+parameters[$new]} )); then
2371 REPLY="${left}${(P)new}${right}"
2377 function grml_prompt_addto () {
2380 local lr it apre apost new v REPLY
2384 [[ $target == PS1 ]] && lr=left || lr=right
2385 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2386 typeset -g "${target}="
2387 for it in "${items[@]}"; do
2388 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2389 || apre=${grml_prompt_pre_default[$it]}
2390 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2391 || apost=${grml_prompt_post_default[$it]}
2392 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2393 || new=${grml_prompt_token_default[$it]}
2394 if (( ${+grml_prompt_token_function[$it]} )); then
2396 ${grml_prompt_token_function[$it]} $it
2400 grml_wrap_reply $target $new '' ''
2403 grml_wrap_reply $target $new '(' ')'
2406 if [[ -n ${(P)new} ]]; then
2413 v="vcs_info_msg_${new}_"
2414 if (( ! vcscalled )); then
2418 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2427 # Strip volatile characters per item. This is off by default. See the
2428 # global stripping code a few lines below for details.
2429 if [[ -o prompt_subst ]] && zstyle -t ":prompt:${grmltheme}:${lr}:items:$it" \
2430 strip-sensitive-characters
2432 REPLY="${REPLY//[$\`]/}"
2434 typeset -g "${target}=${(P)target}${apre}${REPLY}${apost}"
2437 # Per default, strip volatile characters (in the prompt_subst case)
2438 # globally. If the option is off, the style has no effect. For more
2439 # control, this can be turned off and stripping can be configured on a
2440 # per-item basis (see above).
2441 if [[ -o prompt_subst ]] && zstyle -T ":prompt:${grmltheme}:${lr}:setup" \
2442 strip-sensitive-characters
2444 typeset -g "${target}=${${(P)target}//[$\`]/}"
2448 function prompt_grml_precmd () {
2450 local grmltheme=grml
2451 local -a left_items right_items
2452 left_items=(rc change-root user at host path vcs percent)
2453 right_items=(sad-smiley)
2455 prompt_grml_precmd_worker
2458 function prompt_grml-chroot_precmd () {
2460 local grmltheme=grml-chroot
2461 local -a left_items right_items
2462 left_items=(grml-chroot user at host path percent)
2465 prompt_grml_precmd_worker
2468 function prompt_grml-large_precmd () {
2470 local grmltheme=grml-large
2471 local -a left_items right_items
2472 left_items=(rc jobs history shell-level change-root time date newline
2473 user at host path vcs percent)
2474 right_items=(sad-smiley)
2476 prompt_grml_precmd_worker
2479 function prompt_grml_precmd_worker () {
2481 local -i vcscalled=0
2483 grml_prompt_addto PS1 "${left_items[@]}"
2484 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2485 grml_prompt_addto RPS1 "${right_items[@]}"
2489 function grml_prompt_fallback () {
2493 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2494 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2495 if (( EUID == 0 )); then
2496 PROMPT="${BLUE}${p0}${RED}${p1}"
2498 PROMPT="${RED}${p0}${BLUE}${p1}"
2502 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2503 grml_status_feature promptinit 0
2504 # Since we define the required functions in here and not in files in
2505 # $fpath, we need to stick the theme's name into `$prompt_themes'
2506 # ourselves, since promptinit does not pick them up otherwise.
2507 prompt_themes+=( grml grml-chroot grml-large )
2508 # Also, keep the array sorted...
2509 prompt_themes=( "${(@on)prompt_themes}" )
2511 grml_status_feature promptinit 1
2512 grml_prompt_fallback
2513 function precmd () { (( ${+functions[vcs_info]} )) && vcs_info; }
2517 # The prompt themes use modern features of zsh, that require at least
2518 # version 4.3.7 of the shell. Use the fallback otherwise.
2519 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2520 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2521 add-zsh-hook precmd battery
2523 if [[ "$TERM" == dumb ]] ; then
2524 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2525 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2526 for i in rc user path jobs history date time shell-level; do
2527 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2528 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2531 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2532 elif (( EUID == 0 )); then
2533 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2536 # Finally enable one of the prompts.
2537 if [[ -n $GRML_CHROOT ]]; then
2539 elif [[ $GRMLPROMPT -gt 0 ]]; then
2545 grml_prompt_fallback
2546 function precmd () { (( ${+functions[vcs_info]} )) && vcs_info; }
2549 # make sure to use right prompt only when not running a command
2550 is41 && setopt transient_rprompt
2552 # Terminal-title wizardry
2554 function ESC_print () {
2555 info_print $'\ek' $'\e\\' "$@"
2557 function set_title () {
2558 info_print $'\e]0;' $'\a' "$@"
2561 function info_print () {
2562 local esc_begin esc_end
2566 printf '%s' ${esc_begin}
2568 printf '%s' "${esc_end}"
2571 function grml_reset_screen_title () {
2572 # adjust title of xterm
2573 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2574 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2576 (xterm*|rxvt*|alacritty|foot)
2577 set_title ${(%):-"%n@%m: %~"}
2582 function grml_vcs_to_screen_title () {
2583 if [[ $TERM == screen* ]] ; then
2584 if [[ -n ${vcs_info_msg_1_} ]] ; then
2585 ESC_print ${vcs_info_msg_1_}
2592 function grml_maintain_name () {
2594 localname="$(uname -n)"
2596 # set hostname if not running on local machine
2597 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != "${localname}" ]] ; then
2602 function grml_cmd_to_screen_title () {
2603 # get the name of the program currently running and hostname of local
2604 # machine set screen window title if running in a screen
2605 if [[ "$TERM" == screen* ]] ; then
2606 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2611 function grml_control_xterm_title () {
2613 (xterm*|rxvt*|alacritty|foot)
2614 set_title "${(%):-"%n@%m:"}" "$2"
2619 # The following autoload is disabled for now, since this setup includes a
2620 # static version of the ‘add-zsh-hook’ function above. It needs to be
2621 # re-enabled as soon as that static definition is removed again.
2622 #zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2623 if [[ $NOPRECMD -eq 0 ]]; then
2624 add-zsh-hook precmd grml_reset_screen_title
2625 add-zsh-hook precmd grml_vcs_to_screen_title
2626 add-zsh-hook preexec grml_maintain_name
2627 add-zsh-hook preexec grml_cmd_to_screen_title
2628 if [[ $NOTITLE -eq 0 ]]; then
2629 add-zsh-hook preexec grml_control_xterm_title
2633 # 'hash' some often used directories
2635 hash -d deb=/var/cache/apt/archives
2636 hash -d doc=/usr/share/doc
2637 hash -d linux=/lib/modules/$(command uname -r)/build/
2638 hash -d log=/var/log
2639 hash -d slog=/var/log/syslog
2640 hash -d src=/usr/src
2641 hash -d www=/var/www
2645 if check_com -c screen ; then
2646 if [[ $UID -eq 0 ]] ; then
2647 if [[ -r /etc/grml/screenrc ]]; then
2648 alias screen='screen -c /etc/grml/screenrc'
2650 elif [[ ! -r $HOME/.screenrc ]] ; then
2651 if [[ -r /etc/grml/screenrc_grml ]]; then
2652 alias screen='screen -c /etc/grml/screenrc_grml'
2654 if [[ -r /etc/grml/screenrc ]]; then
2655 alias screen='screen -c /etc/grml/screenrc'
2661 # do we have GNU ls with color-support?
2662 if [[ "$TERM" != dumb ]]; then
2663 #a1# List files with colors (\kbd{ls \ldots})
2664 alias ls="command ls ${ls_options:+${ls_options[*]}}"
2665 #a1# List all files, with colors (\kbd{ls -la \ldots})
2666 alias la="command ls -la ${ls_options:+${ls_options[*]}}"
2667 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2668 alias ll="command ls -l ${ls_options:+${ls_options[*]}}"
2669 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2670 alias lh="command ls -hAl ${ls_options:+${ls_options[*]}}"
2671 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -l \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2672 alias l="command ls -l ${ls_options:+${ls_options[*]}}"
2674 alias la='command ls -la'
2675 alias ll='command ls -l'
2676 alias lh='command ls -hAl'
2677 alias l='command ls -l'
2680 # use ip from iproute2 with color support
2681 if ip -color=auto addr show dev lo >/dev/null 2>&1; then
2682 alias ip='command ip -color=auto'
2685 if [[ -r /proc/mdstat ]]; then
2686 alias mdstat='cat /proc/mdstat'
2689 alias ...='cd ../../'
2691 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2692 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2693 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2696 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2697 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2698 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2700 # make sure it is not assigned yet
2701 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2702 function utf2iso () {
2705 for ENV in $(env | command grep -i '.utf') ; do
2706 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2711 # make sure it is not assigned yet
2712 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2713 function iso2utf () {
2714 if ! isutfenv ; then
2716 for ENV in $(env | command grep -i '\.iso') ; do
2717 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2722 # especially for roadwarriors using GNU screen and ssh:
2723 if ! check_com asc &>/dev/null ; then
2724 function asc () { autossh -t "$@" 'screen -RdU' }
2728 #f1# Hints for the use of zsh on grml
2729 function zsh-help () {
2730 print "$bg[white]$fg[black]
2731 zsh-help - hints for use of zsh on grml
2732 =======================================$reset_color"
2735 Main configuration of zsh happens in /etc/zsh/zshrc.
2736 That file is part of the package grml-etc-core, if you want to
2737 use them on a non-grml-system just get the tar.gz from
2738 http://deb.grml.org/ or (preferably) get it from the git repository:
2740 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2742 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2743 The file is still there, but it is empty for backwards compatibility.
2745 For your own changes use these two files:
2749 The former is sourced very early in our zshrc, the latter is sourced
2752 System wide configuration without touching configuration files of grml
2753 can take place in /etc/zsh/zshrc.local.
2755 For information regarding zsh start at http://grml.org/zsh/
2757 Take a look at grml'\''s zsh refcard:
2758 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2760 Check out the main zsh refcard:
2761 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2763 And of course visit the zsh-lovers:
2766 You can adjust some options through environment variables when
2767 invoking zsh without having to edit configuration files.
2768 Basically meant for bash users who are not used to the power of
2771 "NOCOR=1 zsh" => deactivate automatic correction
2772 "NOMENU=1 zsh" => do not use auto menu completion
2773 (note: use ctrl-d for completion instead!)
2774 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2775 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2776 preexec() and precmd() completely
2777 "GRML_DISPLAY_BATTERY=1 zsh"
2778 => activate battery status on right side of prompt (WIP)
2779 "COMMAND_NOT_FOUND=1 zsh"
2780 => Enable a handler if an external command was not found
2781 The command called in the handler can be altered by setting
2782 the GRML_ZSH_CNF_HANDLER variable, the default is:
2783 "/usr/share/command-not-found/command-not-found"
2785 A value greater than 0 is enables a feature; a value equal to zero
2786 disables it. If you like one or the other of these settings, you can
2787 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2791 $bg[white]$fg[black]
2792 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2793 Enjoy your grml system with the zsh!$reset_color"
2797 if [[ -r /etc/debian_version ]] ; then
2798 if [[ -z "$GRML_NO_APT_ALIASES" ]]; then
2799 #a3# Execute \kbd{apt-cache policy}
2800 alias acp='apt-cache policy'
2801 if check_com -c apt ; then
2802 #a3# Execute \kbd{apt search}
2803 alias acs='apt search'
2804 #a3# Execute \kbd{apt show}
2805 alias acsh='apt show'
2806 #a3# Execute \kbd{apt dist-upgrade}
2807 salias adg="apt dist-upgrade"
2808 #a3# Execute \kbd{apt upgrade}
2809 salias ag="apt upgrade"
2810 #a3# Execute \kbd{apt install}
2811 salias agi="apt install"
2812 #a3# Execute \kbd{apt update}
2813 salias au="apt update"
2815 alias acs='apt-cache search'
2816 alias acsh='apt-cache show'
2817 salias adg="apt-get dist-upgrade"
2818 salias ag="apt-get upgrade"
2819 salias agi="apt-get install"
2820 salias au="apt-get update"
2822 #a3# Execute \kbd{aptitude install}
2823 salias ati="aptitude install"
2824 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2825 salias -a up="aptitude update ; aptitude safe-upgrade"
2826 #a3# Execute \kbd{dpkg-buildpackage}
2827 alias dbp='dpkg-buildpackage'
2828 #a3# Execute \kbd{grep-excuses}
2829 alias ge='grep-excuses'
2832 # get a root shell as normal user in live-cd mode:
2833 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2839 # use /var/log/syslog iff present, fallback to journalctl otherwise
2840 if [ -e /var/log/syslog ] ; then
2841 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog || journalctl}
2842 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2843 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog || journalctl}
2844 salias tlog="tail -f /var/log/syslog" # follow the syslog
2845 elif check_com -c journalctl ; then
2846 salias llog="journalctl"
2847 salias tlog="journalctl -f"
2850 # sort installed Debian-packages by size
2851 if check_com -c dpkg-query ; then
2852 #a3# List installed Debian-packages sorted by size
2853 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"
2856 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2857 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2858 if check_com -c wodim; then
2859 function cdrecord () {
2861 cdrecord is not provided under its original name by Debian anymore.
2862 See #377109 in the BTS of Debian for more details.
2864 Please use the wodim binary instead
2872 # No core dumps: important for a live-cd-system
2877 function grmlstuff () {
2878 # people should use 'grml-x'!
2879 if check_com -c 915resolution; then
2880 function 855resolution () {
2881 echo "Please use 915resolution as resolution modifying tool for Intel \
2887 #a1# Output version of running grml
2888 alias grml-version='cat /etc/grml_version'
2890 if check_com -c grml-debootstrap ; then
2891 function debian2hd () {
2892 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2897 if check_com -c tmate && check_com -c qrencode ; then
2898 function grml-remote-support() {
2899 tmate -L grml-remote-support new -s grml-remote-support -d
2900 tmate -L grml-remote-support wait tmate-ready
2901 tmate -L grml-remote-support display -p '#{tmate_ssh}' | qrencode -t ANSI
2902 echo "tmate session: $(tmate -L grml-remote-support display -p '#{tmate_ssh}')"
2904 echo "Scan this QR code and send it to your support team."
2909 # now run the functions
2911 is4 && isgrml && grmlstuff
2915 is4 && xsource "/etc/zsh/keephack"
2917 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2918 # You use it as follows:
2919 # $ NTREF=/reference/file
2921 # This lists all the files in the current directory newer than the reference file.
2922 # You can also specify the reference file inline; note quotes:
2923 # $ ls -l *(e:'nt ~/.zshenv':)
2924 is4 && function nt () {
2925 if [[ -n $1 ]] ; then
2928 [[ $REPLY -nt $NTREF ]]
2933 #f1# Reload an autoloadable function
2934 function freload () { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2935 compdef _functions freload
2940 # e.g.: a -> b -> c -> d ....
2945 # if parameter is given with leading '=', lookup $PATH for parameter and resolve that
2949 # Note: limit for recursive symlinks on linux:
2950 # http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/fs/namei.c?id=refs/heads/master#l808
2951 # This limits recursive symlink follows to 8,
2952 # while limiting consecutive symlinks to 40.
2954 # When resolving and displaying information about symlinks, no check is made
2955 # that the displayed information does make any sense on your OS.
2956 # We leave that decission to the user.
2958 # The zstat module is used to detect symlink loops. zstat is available since zsh4.
2959 # With an older zsh you will need to abort with <C-c> in that case.
2960 # When a symlink loop is detected, a warning ist printed and further processing is stopped.
2962 # Module zstat is loaded by default in grml zshrc, no extra action needed for that.
2965 # If you happen to come across a symlink that points to a destination on another partition
2966 # with the same inode number, that will be marked as symlink loop though it is not.
2967 # Two hints for this situation:
2968 # I) Play lottery the same day, as you seem to be rather lucky right now.
2973 # 1 file/dir not accesible
2974 # 2 symlink loop detected
2976 #f1# List symlinks in detail (more detailed version of 'readlink -f', 'whence -s' and 'namei -l')
2978 if [[ -z ${1} ]] ; then
2979 printf 'Usage: %s <symlink(s)>\n' "${0}"
2983 local file jumpd curdir
2984 local -i 10 RTN LINODE i
2989 for file in "${@}" ; do
2991 ls -l "${file:a}" || RTN=1
2993 while [[ -h "$file" ]] ; do
2995 LINODE=$(zstat -L +inode "${file}")
2996 for i in ${SEENINODES} ; do
2997 if (( ${i} == ${LINODE} )) ; then
2998 builtin cd -q "${curdir}"
2999 print 'link loop detected, aborting!'
3003 SEENINODES+=${LINODE}
3008 if [[ -d ${jumpd} ]] ; then
3009 builtin cd -q "${jumpd}" || RTN=1
3011 file=$(readlink "$file")
3016 if [[ -d ${jumpd} ]] ; then
3017 builtin cd -q "${jumpd}" || RTN=1
3020 ls -l "${PWD}/${file}" || RTN=1
3023 if (( ${#} >= 1 )) ; then
3026 builtin cd -q "${curdir}"
3031 if check_com -c $PAGER ; then
3032 #f3# View Debian's changelog of given package(s)
3033 function dchange () {
3035 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
3039 # `less` as $PAGER without e.g. `|lesspipe %s` inside $LESSOPEN can't properly
3040 # read *.gz files, try to detect this to use vi instead iff available
3043 if [[ ${$(typeset -p PAGER)[2]} = -a ]] ; then
3044 viewer=($PAGER) # support PAGER=(less -Mr) but leave array untouched
3046 viewer=(${=PAGER}) # support PAGER='less -Mr'
3049 if [[ ${viewer[1]:t} = less ]] && [[ -z "${LESSOPEN}" ]] && check_com vi ; then
3053 for package in "$@" ; do
3054 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
3055 $viewer /usr/share/doc/${package}/changelog.Debian.gz
3056 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
3057 $viewer /usr/share/doc/${package}/changelog.gz
3058 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
3059 $viewer /usr/share/doc/${package}/changelog
3061 if check_com -c aptitude ; then
3062 echo "No changelog for package $package found, using aptitude to retrieve it."
3063 aptitude changelog "$package"
3064 elif check_com -c apt-get ; then
3065 echo "No changelog for package $package found, using apt-get to retrieve it."
3066 apt-get changelog "$package"
3068 echo "No changelog for package $package found, sorry."
3073 function _dchange () { _files -W /usr/share/doc -/ }
3074 compdef _dchange dchange
3076 #f3# View Debian's NEWS of a given package
3079 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
3080 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
3082 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
3083 $PAGER /usr/share/doc/$1/NEWS.gz
3085 echo "No NEWS file for package $1 found, sorry."
3090 function _dnews () { _files -W /usr/share/doc -/ }
3091 compdef _dnews dnews
3093 #f3# View Debian's copyright of a given package
3094 function dcopyright () {
3096 if [[ -r /usr/share/doc/$1/copyright ]] ; then
3097 $PAGER /usr/share/doc/$1/copyright
3099 echo "No copyright file for package $1 found, sorry."
3103 function _dcopyright () { _files -W /usr/share/doc -/ }
3104 compdef _dcopyright dcopyright
3106 #f3# View upstream's changelog of a given package
3107 function uchange () {
3109 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
3110 $PAGER /usr/share/doc/$1/changelog.gz
3112 echo "No changelog for package $1 found, sorry."
3116 function _uchange () { _files -W /usr/share/doc -/ }
3117 compdef _uchange uchange
3121 function profile () {
3122 ZSH_PROFILE_RC=1 zsh "$@"
3125 #f1# Edit an alias via zle
3126 function edalias () {
3127 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
3129 compdef _aliases edalias
3131 #f1# Edit a function via zle
3132 function edfunc () {
3133 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
3135 compdef _functions edfunc
3137 # use it e.g. via 'Restart apache2'
3138 #m# f6 Start() \kbd{service \em{process}}\quad\kbd{start}
3139 #m# f6 Restart() \kbd{service \em{process}}\quad\kbd{restart}
3140 #m# f6 Stop() \kbd{service \em{process}}\quad\kbd{stop}
3141 #m# f6 Reload() \kbd{service \em{process}}\quad\kbd{reload}
3142 #m# f6 Force-Reload() \kbd{service \em{process}}\quad\kbd{force-reload}
3143 #m# f6 Status() \kbd{service \em{process}}\quad\kbd{status}
3144 if [[ -d /etc/init.d || -d /etc/service ]] ; then
3145 function __start_stop () {
3146 local action_="${1:l}" # e.g Start/Stop/Restart
3150 local service_target_="$(readlink /etc/init.d/$service_)"
3151 if [[ $service_target_ == "/usr/bin/sv" ]]; then
3153 case "${action_}" in
3154 start) if [[ ! -e /etc/service/$service_ ]]; then
3155 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
3157 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
3159 # there is no reload in runits sysv emulation
3160 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
3161 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
3164 # sysv/sysvinit-utils, upstart
3165 if check_com -c service ; then
3166 $SUDO service "$service_" "${action_}" "$param_"
3168 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
3173 function _grmlinitd () {
3175 scripts=( /etc/init.d/*(x:t) )
3176 _describe "service startup script" scripts
3179 for i in Start Restart Stop Force-Reload Reload Status ; do
3180 eval "function $i () { __start_stop $i \"\$1\" \"\$2\" ; }"
3181 compdef _grmlinitd $i
3186 #f1# Provides useful information on globbing
3187 function H-Glob () {
3193 p named pipes (FIFOs)
3194 * executable plain files (0100)
3195 % device files (character or block special)
3196 %b block special files
3197 %c character special files
3198 r owner-readable files (0400)
3199 w owner-writable files (0200)
3200 x owner-executable files (0100)
3201 A group-readable files (0040)
3202 I group-writable files (0020)
3203 E group-executable files (0010)
3204 R world-readable files (0004)
3205 W world-writable files (0002)
3206 X world-executable files (0001)
3207 s setuid files (04000)
3208 S setgid files (02000)
3209 t files with the sticky bit (01000)
3211 print *(m-1) # Files modified up to a day ago
3212 print *(a1) # Files accessed a day ago
3213 print *(@) # Just symlinks
3214 print *(Lk+50) # Files bigger than 50 kilobytes
3215 print *(Lk-50) # Files smaller than 50 kilobytes
3216 print **/*.c # All *.c files recursively starting in \$PWD
3217 print **/*.c~file.c # Same as above, but excluding 'file.c'
3218 print (foo|bar).* # Files starting with 'foo' or 'bar'
3219 print *~*.* # All Files that do not contain a dot
3220 chmod 644 *(.^x) # make all plain non-executable files publically readable
3221 print -l *(.c|.h) # Lists *.c and *.h
3222 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
3223 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
3225 alias help-zshglob=H-Glob
3227 # grep for running process, like: 'any vim'
3231 if [[ -z "$1" ]] ; then
3232 echo "any - grep for process(es) by keyword" >&2
3233 echo "Usage: any <keyword>" >&2 ; return 1
3235 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
3240 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
3241 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
3242 [[ -r /proc/1/maps ]] && \
3243 function deswap () {
3244 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
3245 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
3246 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
3249 # a wrapper for vim, that deals with title setting
3251 # set this array to a set of options to vim you always want
3252 # to have set when calling vim (in .zshrc.local), like:
3253 # VIM_OPTIONS=( -p )
3254 # This will cause vim to send every file given on the
3255 # commandline to be send to it's own tab (needs vim7).
3256 if check_com vim; then
3258 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
3262 ssl_hashes=( sha512 sha256 sha1 md5 )
3264 for sh in ${ssl_hashes}; do
3265 eval 'ssl-cert-'${sh}'() {
3267 if [[ -z $1 ]] ; then
3268 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
3271 openssl x509 -noout -fingerprint -'${sh}' -in $1
3275 function ssl-cert-fingerprints () {
3278 if [[ -z $1 ]] ; then
3279 printf 'usage: ssl-cert-fingerprints <file>\n'
3282 for i in ${ssl_hashes}
3287 function ssl-cert-info () {
3289 if [[ -z $1 ]] ; then
3290 printf 'usage: ssl-cert-info <file>\n'
3293 openssl x509 -noout -text -in $1
3294 ssl-cert-fingerprints $1
3297 # make sure our environment is clean regarding colors
3298 builtin unset -v BLUE RED GREEN CYAN YELLOW MAGENTA WHITE NO_COLOR
3300 # "persistent history"
3301 # just write important commands you always need to $GRML_IMPORTANT_COMMANDS
3302 # defaults for backward compatibility to ~/.important_commands
3303 if [[ -r ~/.important_commands ]] ; then
3304 GRML_IMPORTANT_COMMANDS=~/.important_commands
3306 GRML_IMPORTANT_COMMANDS=${GRML_IMPORTANT_COMMANDS:-${ZDOTDIR:-${HOME}}/.important_commands}
3308 [[ -r ${GRML_IMPORTANT_COMMANDS} ]] && builtin fc -R ${GRML_IMPORTANT_COMMANDS}
3310 # load the lookup subsystem if it's available on the system
3311 zrcautoload lookupinit && lookupinit
3315 # set terminal property (used e.g. by msgid-chooser)
3316 case "${COLORTERM}" in
3321 export COLORTERM="yes"
3328 #a2# Execute \kbd{du -sch}
3329 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias da='du -sch'
3332 #a2# Execute \kbd{ls -lSrah}
3333 alias dir="command ls -lSrah"
3334 #a2# Only show dot-directories
3335 alias lad='command ls -d .*(/)'
3336 #a2# Only show dot-files
3337 alias lsa='command ls -a .*(.)'
3338 #a2# Only files with setgid/setuid/sticky flag
3339 alias lss='command ls -l *(s,S,t)'
3340 #a2# Only show symlinks
3341 alias lsl='command ls -l *(@)'
3342 #a2# Display only executables
3343 alias lsx='command ls -l *(*)'
3344 #a2# Display world-{readable,writable,executable} files
3345 alias lsw='command ls -ld *(R,W,X.^ND/)'
3346 #a2# Display the ten biggest files
3347 alias lsbig="command ls -flh *(.OL[1,10])"
3348 #a2# Only show directories
3349 alias lsd='command ls -d *(/)'
3350 #a2# Only show empty directories
3351 alias lse='command ls -d *(/^F)'
3352 #a2# Display the ten newest files
3353 alias lsnew="command ls -rtlh *(D.om[1,10])"
3354 #a2# Display the ten oldest files
3355 alias lsold="command ls -rtlh *(D.Om[1,10])"
3356 #a2# Display the ten smallest files
3357 alias lssmall="command ls -Srl *(.oL[1,10])"
3358 #a2# Display the ten newest directories and ten newest .directories
3359 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
3360 #a2# Display the ten oldest directories and ten oldest .directories
3361 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
3363 # some useful aliases
3364 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
3365 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
3367 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3368 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3369 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3370 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3372 # work around non utf8 capable software in utf environment via $LANG and luit
3373 if check_com isutfenv && check_com luit ; then
3374 if check_com -c mrxvt ; then
3375 isutfenv && [[ -n "$LANG" ]] && \
3376 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3379 if check_com -c aterm ; then
3380 isutfenv && [[ -n "$LANG" ]] && \
3381 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3384 if check_com -c centericq ; then
3385 isutfenv && [[ -n "$LANG" ]] && \
3386 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3392 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3395 local current_date=$(date -u "+%Y%m%dT%H%M%SZ")
3396 local clean keep move verbose result all to_bk
3397 setopt extended_glob
3399 while getopts ":hacmrv" opt; do
3402 c) unset move clean && (( ++keep ));;
3403 m) unset keep clean && (( ++move ));;
3404 r) unset move keep && (( ++clean ));;
3407 bk [-hcmv] FILE [FILE ...]
3408 bk -r [-av] [FILE [FILE ...]]
3409 Backup a file or folder in place and append the timestamp
3410 Remove backups of a file or folder, or all backups in the current directory
3413 -h Display this help text
3414 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3415 -m Move the file/folder, using mv(1)
3416 -r Remove backups of the specified file or directory, using rm(1). If none
3417 is provided, remove all backups in the current directory.
3418 -a Remove all (even hidden) backups.
3421 The -c, -r and -m options are mutually exclusive. If specified at the same time,
3422 the last one is used.
3424 The return code is the sum of all cp/mv/rm return codes.
3427 \?) bk -h >&2; return 1;;
3430 shift "$((OPTIND-1))"
3431 if (( keep > 0 )); then
3432 if islinux || isfreebsd; then
3433 for to_bk in "$@"; do
3434 cp $verbose -a "${to_bk%/}" "${to_bk%/}_$current_date"
3438 for to_bk in "$@"; do
3439 cp $verbose -pR "${to_bk%/}" "${to_bk%/}_$current_date"
3443 elif (( move > 0 )); then
3444 while (( $# > 0 )); do
3445 mv $verbose "${1%/}" "${1%/}_$current_date"
3449 elif (( clean > 0 )); then
3450 if (( $# > 0 )); then
3451 for to_bk in "$@"; do
3452 rm $verbose -rf "${to_bk%/}"_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z
3456 if (( all > 0 )); then
3457 rm $verbose -rf *_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z(D)
3459 rm $verbose -rf *_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z
3467 #f5# cd to directory and list files
3473 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3475 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3476 [[ ! -e ${1:h} ]] && return 1
3477 print "Correcting ${1} to ${1:h}"
3484 #f5# Create Directory and \kbd{cd} to it
3486 if (( ARGC != 1 )); then
3487 printf 'usage: mkcd <new-directory>\n'
3490 if [[ ! -d "$1" ]]; then
3491 command mkdir -p "$1"
3493 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3498 #f5# Create temporary directory and \kbd{cd} to it
3500 builtin cd "$(mktemp -d)"
3504 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3505 function accessed () {
3507 print -l -- *(a-${1:-1})
3510 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3511 function changed () {
3513 print -l -- *(c-${1:-1})
3516 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3517 function modified () {
3519 print -l -- *(m-${1:-1})
3521 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3522 check_com new || alias new=modified
3524 # use colors when GNU grep with color-support
3525 if (( $#grep_options > 0 )); then
3526 o=${grep_options:+"${grep_options[*]}"}
3527 #a2# Execute \kbd{grep -{}-color=auto}
3528 alias grep='grep '$o
3529 alias egrep='egrep '$o
3534 # 'translate' looks up a word in a file with language-to-language
3535 # translations (field separator should be " : "). A typical wordlist looks
3536 # like the following:
3537 # | english-word : german-translation
3538 # It's also only possible to translate english to german but not reciprocal.
3539 # Use the following oneliner to reverse the sort order:
3540 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3541 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3542 #f5# Translates a word
3547 translate -l de-en $2
3550 translate -l en-de $2
3553 echo "Usage: $0 { -D | -E }"
3554 echo " -D == German to English"
3555 echo " -E == English to German"
3559 # Usage: simple-extract <file>
3560 # Using option -d deletes the original archive file.
3561 #f5# Smart archive extractor
3562 function simple-extract () {
3564 setopt extended_glob noclobber
3565 local ARCHIVE DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3567 zparseopts -D -E "d=DELETE_ORIGINAL"
3568 for ARCHIVE in "${@}"; do
3570 *(tar.bz2|tbz2|tbz))
3571 DECOMP_CMD="tar -xvjf -"
3576 DECOMP_CMD="tar -xvzf -"
3580 *(tar.xz|txz|tar.lzma))
3581 DECOMP_CMD="tar -xvJf -"
3586 DECOMP_CMD="tar --zstd -xvf -"
3591 DECOMP_CMD="lrzuntar"
3596 DECOMP_CMD="tar -xvf -"
3601 DECOMP_CMD="unrar x"
3626 DECOMP_CMD="bzip2 -d -c -"
3631 DECOMP_CMD="gzip -d -c -"
3636 DECOMP_CMD="xz -d -c -"
3641 DECOMP_CMD="zstd -d -c -"
3646 DECOMP_CMD="lrunzip -"
3651 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3657 if ! check_com ${DECOMP_CMD[(w)1]}; then
3658 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3663 GZTARGET="${ARCHIVE:t:r}"
3664 if [[ -f $ARCHIVE ]] ; then
3666 print "Extracting '$ARCHIVE' ..."
3667 if $USES_STDIN; then
3668 if $USES_STDOUT; then
3669 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3671 ${=DECOMP_CMD} < "$ARCHIVE"
3674 if $USES_STDOUT; then
3675 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3677 ${=DECOMP_CMD} "$ARCHIVE"
3680 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3682 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3683 if check_com curl; then
3684 WGET_CMD="curl -L -s -o -"
3685 elif check_com wget; then
3686 WGET_CMD="wget -q -O -"
3687 elif check_com fetch; then
3688 WGET_CMD="fetch -q -o -"
3690 print "ERROR: neither wget, curl nor fetch is installed" >&2
3694 print "Downloading and Extracting '$ARCHIVE' ..."
3695 if $USES_STDIN; then
3696 if $USES_STDOUT; then
3697 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3700 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3704 if $USES_STDOUT; then
3705 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3707 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3712 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3719 function __archive_or_uri () {
3721 '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)"' \
3722 '_urls:Remote Archives:_urls'
3725 function _simple_extract () {
3727 '-d[delete original archivefile after extraction]' \
3728 '*:Archive Or Uri:__archive_or_uri'
3730 compdef _simple_extract simple-extract
3731 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias se=simple-extract
3733 #f5# Change the xterm title from within GNU-screen
3734 function xtrename () {
3736 if [[ $1 != "-f" ]] ; then
3737 if [[ -z ${DISPLAY} ]] ; then
3738 printf 'xtrename only makes sense in X11.\n'
3744 if [[ -z $1 ]] ; then
3745 printf 'usage: xtrename [-f] "title for xterm"\n'
3746 printf ' renames the title of xterm from _within_ screen.\n'
3747 printf ' also works without screen.\n'
3748 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3751 print -n "\eP\e]0;${1}\C-G\e\\"
3755 # Create small urls via http://goo.gl using curl(1).
3756 # API reference: https://code.google.com/apis/urlshortener/
3759 setopt extended_glob
3761 if [[ -z $1 ]]; then
3762 print "USAGE: zurl <URL>"
3766 local PN url prog api json contenttype item
3771 # Prepend 'http://' to given URL where necessary for later output.
3772 if [[ ${url} != http(s|)://* ]]; then
3776 if check_com -c curl; then
3779 print "curl is not available, but mandatory for ${PN}. Aborting."
3782 api='https://www.googleapis.com/urlshortener/v1/url'
3783 contenttype="Content-Type: application/json"
3784 json="{\"longUrl\": \"${url}\"}"
3785 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3786 # Parse the response
3787 for item in "${data[@]}"; do
3792 printf '%s\n' "$item"
3800 #f2# Find history events by search pattern and list them by date.
3801 function whatwhen () {
3803 local usage help ident format_l format_s first_char remain first last
3804 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3805 help='Use `whatwhen -h'\'' for further explanations.'
3806 ident=${(l,${#${:-Usage: }},, ,)}
3807 format_l="${ident}%s\t\t\t%s\n"
3808 format_s="${format_l//(\\t)##/\\t}"
3809 # Make the first char of the word to search for case
3810 # insensitive; e.g. [aA]
3811 first_char=[${(L)1[1]}${(U)1[1]}]
3813 # Default search range is `-100'.
3815 # Optional, just used for `<first> <last>' given.
3819 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3820 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3823 printf '%s\n\n' ${usage}
3825 printf $format_l '-h' 'show help text'
3827 print 'SEARCH RANGE:'
3828 printf $format_l "'0'" 'the whole history,'
3829 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3830 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3831 printf '\n%s\n' 'EXAMPLES:'
3832 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3833 printf $format_l 'whatwhen zsh -250'
3834 printf $format_l 'whatwhen foo 1 99'
3837 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3840 # -l list results on stout rather than invoking $EDITOR.
3841 # -i Print dates as in YYYY-MM-DD.
3842 # -m Search for a - quoted - pattern within the history.
3843 fc -li -m "*${first_char}${remain}*" $first $last
3848 # mercurial related stuff
3849 if check_com -c hg ; then
3850 # gnu like diff for mercurial
3851 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3852 #f5# GNU like diff for mercurial
3856 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3859 # build debian package
3860 #a2# Alias for \kbd{hg-buildpackage}
3861 alias hbp='hg-buildpackage'
3863 # execute commands on the versioned patch-queue from the current repos
3864 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3866 # diffstat for specific version of a mercurial repository
3867 # hgstat => display diffstat between last revision and tip
3868 # hgstat 1234 => display diffstat between revision 1234 and tip
3869 #f5# Diffstat for specific version of a mercurial repos
3870 function hgstat () {
3872 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3875 fi # end of check whether we have the 'hg'-executable
3877 # disable bracketed paste mode for dumb terminals
3878 [[ "$TERM" == dumb ]] && unset zle_bracketed_paste
3880 # grml-small cleanups and workarounds
3882 # The following is used to remove zsh-config-items that do not work
3883 # in grml-small by default.
3884 # If you do not want these adjustments (for whatever reason), set
3885 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3886 # sources if it is there).
3888 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3893 unalias 'V' &> /dev/null
3894 unfunction vman &> /dev/null
3895 unfunction viless &> /dev/null
3896 unfunction 2html &> /dev/null
3898 # manpages are not in grmlsmall
3899 unfunction manzsh &> /dev/null
3900 unfunction man2 &> /dev/null
3904 # See https://github.com/grml/grml/issues/56
3905 if ! [[ -x ${commands[dig]} ]]; then
3906 function dig_after_all () {
3910 unfunction dig_after_all
3913 if [[ -x ${commands[dig]} ]]; then
3918 printf 'This installation does not include `dig'\'' for size reasons.\n'
3919 printf 'Try `drill'\'' as a light weight alternative.\n'
3923 if [[ -x ${commands[dig]} ]]; then
3925 zle -M 'Found `dig'\'' installed. '
3927 zle -M 'Try `drill'\'' instead of `dig'\''.'
3936 unfunction grml_status_feature
3938 ## genrefcard.pl settings
3940 ### doc strings for external functions from files
3941 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3943 ### example: split functions-search 8,16,24,32
3944 #@# split functions-search 8
3946 ## END OF FILE #################################################################
3947 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4