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 # If a new command line being added to the history list duplicates an older
436 # one, the older command is removed from the list
437 is4 && setopt histignorealldups
439 # remove command lines from the history list when the first character on the
441 setopt histignorespace
443 # if a command is issued that can't be executed as a normal command, and the
444 # command is the name of a directory, perform the cd command to that directory.
447 # in order to use #, ~ and ^ for filename generation grep word
448 # *~(*.gz|*.bz|*.bz2|*.zip|*.Z) -> searches for word not in compressed files
449 # don't forget to quote '^', '~' and '#'!
452 # display PID when suspending processes as well
455 # report the status of backgrounds jobs immediately
458 # whenever a command completion is attempted, make sure the entire command path
462 # not just at the end
463 setopt completeinword
465 # Don't send SIGHUP to background processes when the shell exits.
468 # make cd push the old directory onto the directory stack.
474 # don't push the same dir twice.
475 setopt pushd_ignore_dups
477 # * shouldn't match dotfiles. ever.
480 # use zsh style word splitting
483 # don't error out when unset parameters are used
486 # setting some default values
489 NOPRECMD=${NOPRECMD:-0}
490 COMMAND_NOT_FOUND=${COMMAND_NOT_FOUND:-0}
491 GRML_ZSH_CNF_HANDLER=${GRML_ZSH_CNF_HANDLER:-/usr/share/command-not-found/command-not-found}
492 GRML_DISPLAY_BATTERY=${GRML_DISPLAY_BATTERY:-${BATTERY:-0}}
493 GRMLSMALL_SPECIFIC=${GRMLSMALL_SPECIFIC:-1}
494 ZSH_NO_DEFAULT_LOCALE=${ZSH_NO_DEFAULT_LOCALE:-0}
496 typeset -ga ls_options
497 typeset -ga grep_options
499 # Colors on GNU ls(1)
500 if ls --color=auto / >/dev/null 2>&1; then
501 ls_options+=( --color=auto )
502 # Colors on FreeBSD and OSX ls(1)
503 elif ls -G / >/dev/null 2>&1; then
507 # Natural sorting order on GNU ls(1)
508 # OSX and IllumOS have a -v option that is not natural sorting
509 if ls --version |& grep -q 'GNU' >/dev/null 2>&1 && ls -v / >/dev/null 2>&1; then
513 # Color on GNU and FreeBSD grep(1)
514 if grep --color=auto -q "a" <<< "a" >/dev/null 2>&1; then
515 grep_options+=( --color=auto )
519 # this function checks if a command exists and returns either true
520 # or false. This avoids using 'which' and 'whence', which will
521 # avoid problems with aliases for which on certain weird systems. :-)
522 # Usage: check_com [-c|-g] word
523 # -c only checks for external commands
524 # -g does the usual tests and also checks for global aliases
525 function check_com () {
527 local -i comonly gatoo
531 if [[ $1 == '-c' ]] ; then
534 elif [[ $1 == '-g' ]] ; then
539 if (( ${#argv} != 1 )) ; then
540 printf 'usage: check_com [-c|-g] <command>\n' >&2
544 if (( comonly > 0 )) ; then
545 (( ${+commands[$1]} )) && return 0
549 if (( ${+commands[$1]} )) \
550 || (( ${+functions[$1]} )) \
551 || (( ${+aliases[$1]} )) \
552 || (( ${+reswords[(r)$1]} )) ; then
556 if (( gatoo > 0 )) && (( ${+galiases[$1]} )) ; then
563 # creates an alias and precedes the command with
564 # sudo if $EUID is not zero.
567 local only=0 ; local multi=0
569 while getopts ":hao" opt; do
574 printf 'usage: salias [-hoa] <alias-expression>\n'
575 printf ' -h shows this help text.\n'
576 printf ' -a replace '\'' ; '\'' sequences with '\'' ; sudo '\''.\n'
577 printf ' be careful using this option.\n'
578 printf ' -o only sets an alias if a preceding sudo would be needed.\n'
581 *) salias -h >&2; return 1 ;;
584 shift "$((OPTIND-1))"
586 if (( ${#argv} > 1 )) ; then
587 printf 'Too many arguments %s\n' "${#argv}"
591 key="${1%%\=*}" ; val="${1#*\=}"
592 if (( EUID == 0 )) && (( only == 0 )); then
593 alias -- "${key}=${val}"
594 elif (( EUID > 0 )) ; then
595 (( multi > 0 )) && val="${val// ; / ; sudo }"
596 alias -- "${key}=sudo ${val}"
602 # Check if we can read given files and source those we can.
603 function xsource () {
604 if (( ${#argv} < 1 )) ; then
605 printf 'usage: xsource FILE(s)...\n' >&2
609 while (( ${#argv} > 0 )) ; do
610 [[ -r "$1" ]] && source "$1"
616 # Check if we can read a given file and 'cat(1)' it.
619 if (( ${#argv} != 1 )) ; then
620 printf 'usage: xcat FILE\n' >&2
624 [[ -r $1 ]] && cat $1
628 # Remove these functions again, they are of use only in these
629 # setup files. This should be called at the end of .zshrc.
630 function xunfunction () {
634 funcs=(salias xcat xsource xunfunction zrcautoload zrcautozle)
635 for func in $funcs ; do
636 [[ -n ${functions[$func]} ]] \
642 # this allows us to stay in sync with grml's zshrc and put own
643 # modifications in ~/.zshrc.local
644 function zrclocal () {
645 xsource "/etc/zsh/zshrc.local"
646 xsource "${ZDOTDIR:-${HOME}}/.zshrc.local"
651 if (( ZSH_NO_DEFAULT_LOCALE == 0 )); then
652 xsource "/etc/default/locale"
655 for var in LANG LC_ALL LC_MESSAGES ; do
656 [[ -n ${(P)var} ]] && export $var
661 if check_com -c vim ; then
663 export EDITOR=${EDITOR:-vim}
665 export EDITOR=${EDITOR:-vi}
669 export PAGER=${PAGER:-less}
672 export MAIL=${MAIL:-/var/mail/$USER}
674 # color setup for ls:
675 check_com -c dircolors && eval $(dircolors -b)
676 # color setup for ls on OS X / FreeBSD:
677 isdarwin && export CLICOLOR=1
678 isfreebsd && export CLICOLOR=1
680 # do MacPorts setup on darwin
681 if isdarwin && [[ -d /opt/local ]]; then
682 # Note: PATH gets set in /etc/zprofile on Darwin, so this can't go into
684 PATH="/opt/local/bin:/opt/local/sbin:$PATH"
685 MANPATH="/opt/local/share/man:$MANPATH"
687 # do Fink setup on darwin
688 isdarwin && xsource /sw/bin/init.sh
690 # load our function and completion directories
691 for fdir in /usr/share/grml/zsh/completion /usr/share/grml/zsh/functions; do
692 fpath=( ${fdir} ${fdir}/**/*(/N) ${fpath} )
695 ffiles=(/usr/share/grml/zsh/functions/**/[^_]*[^~](N.:t))
696 (( ${#ffiles} > 0 )) && autoload -U "${ffiles[@]}"
699 # support colors in less
700 export LESS_TERMCAP_mb=$'\E[01;31m'
701 export LESS_TERMCAP_md=$'\E[01;31m'
702 export LESS_TERMCAP_me=$'\E[0m'
703 export LESS_TERMCAP_se=$'\E[0m'
704 export LESS_TERMCAP_so=$'\E[01;44;33m'
705 export LESS_TERMCAP_ue=$'\E[0m'
706 export LESS_TERMCAP_us=$'\E[01;32m'
711 # report about cpu-/system-/user-time of command if running longer than
715 # watch for everyone but me and root
718 # automatically remove duplicates from these arrays
719 typeset -U path PATH cdpath CDPATH fpath FPATH manpath MANPATH
723 for mod in parameter complist deltochar mathfunc ; do
724 zmodload -i zsh/${mod} 2>/dev/null
725 grml_status_feature mod:$mod $?
726 done && builtin unset -v mod
728 # autoload zsh modules when they are referenced
730 zmodload -a zsh/stat zstat
731 zmodload -a zsh/zpty zpty
732 zmodload -ap zsh/mapfile mapfile
736 COMPDUMPFILE=${COMPDUMPFILE:-${ZDOTDIR:-${HOME}}/.zcompdump}
737 if zrcautoload compinit ; then
739 zstyle -a ':grml:completion:compinit' arguments tmp
740 compinit -d ${COMPDUMPFILE} "${tmp[@]}"
741 grml_status_feature compinit $?
744 grml_status_feature compinit 1
750 # called later (via is4 && grmlcomp)
751 # note: use 'zstyle' for getting current settings
752 # press ^xh (control-x h) for getting tags in context; ^x? (control-x ?) to run complete_debug with trace output
753 function grmlcomp () {
754 # TODO: This could use some additional information
756 # Make sure the completion system is initialised
757 (( ${+_comps} )) || return 1
759 # allow one error for every three characters typed in approximate completer
760 zstyle ':completion:*:approximate:' max-errors 'reply=( $((($#PREFIX+$#SUFFIX)/3 )) numeric )'
762 # don't complete backup files as executables
763 zstyle ':completion:*:complete:-command-::commands' ignored-patterns '(aptitude-*|*\~)'
765 # start menu completion only if it could find no unambiguous initial string
766 zstyle ':completion:*:correct:*' insert-unambiguous true
767 zstyle ':completion:*:corrections' format $'%{\e[0;31m%}%d (errors: %e)%{\e[0m%}'
768 zstyle ':completion:*:correct:*' original true
770 # activate color-completion
771 zstyle ':completion:*:default' list-colors ${(s.:.)LS_COLORS}
773 # format on completion
774 zstyle ':completion:*:descriptions' format $'%{\e[0;31m%}completing %B%d%b%{\e[0m%}'
776 # automatically complete 'cd -<tab>' and 'cd -<ctrl-d>' with menu
777 # zstyle ':completion:*:*:cd:*:directory-stack' menu yes select
779 # insert all expansions for expand completer
780 zstyle ':completion:*:expand:*' tag-order all-expansions
781 zstyle ':completion:*:history-words' list false
784 zstyle ':completion:*:history-words' menu yes
786 # ignore duplicate entries
787 zstyle ':completion:*:history-words' remove-all-dups yes
788 zstyle ':completion:*:history-words' stop yes
790 # match uppercase from lowercase
791 zstyle ':completion:*' matcher-list 'm:{a-z}={A-Z}'
793 # separate matches into groups
794 zstyle ':completion:*:matches' group 'yes'
795 zstyle ':completion:*' group-name ''
797 if [[ "$NOMENU" -eq 0 ]] ; then
798 # if there are more than 5 options allow selecting from a menu
799 zstyle ':completion:*' menu select=5
801 # don't use any menus at all
805 zstyle ':completion:*:messages' format '%d'
806 zstyle ':completion:*:options' auto-description '%d'
808 # describe options in full
809 zstyle ':completion:*:options' description 'yes'
811 # on processes completion complete all user processes
812 zstyle ':completion:*:processes' command 'ps -au$USER'
814 # offer indexes before parameters in subscripts
815 zstyle ':completion:*:*:-subscript-:*' tag-order indexes parameters
817 # provide verbose completion information
818 zstyle ':completion:*' verbose true
820 # recent (as of Dec 2007) zsh versions are able to provide descriptions
821 # for commands (read: 1st word in the line) that it will list for the user
822 # to choose from. The following disables that, because it's not exactly fast.
823 zstyle ':completion:*:-command-:*:' verbose false
825 # set format for warnings
826 zstyle ':completion:*:warnings' format $'%{\e[0;31m%}No matches for:%{\e[0m%} %d'
828 # define files to ignore for zcompile
829 zstyle ':completion:*:*:zcompile:*' ignored-patterns '(*~|*.zwc)'
830 zstyle ':completion:correct:' prompt 'correct to: %e'
832 # Ignore completion functions for commands you don't have:
833 zstyle ':completion::(^approximate*):*:functions' ignored-patterns '_*'
835 # Provide more processes in completion of programs like killall:
836 zstyle ':completion:*:processes-names' command 'ps c -u ${USER} -o command | uniq'
838 # complete manual by their section
839 zstyle ':completion:*:manuals' separate-sections true
840 zstyle ':completion:*:manuals.*' insert-sections true
841 zstyle ':completion:*:man:*' menu yes select
843 # Search path for sudo completion
844 zstyle ':completion:*:sudo:*' command-path /usr/local/sbin \
852 # provide .. as a completion
853 zstyle ':completion:*' special-dirs ..
855 # run rehash on completion so new installed program are found automatically:
856 function _force_rehash () {
857 (( CURRENT == 1 )) && rehash
862 # some people don't like the automatic correction - so run 'NOCOR=1 zsh' to deactivate it
863 if [[ "$NOCOR" -gt 0 ]] ; then
864 zstyle ':completion:*' completer _oldlist _expand _force_rehash _complete _files _ignored
867 # try to be smart about when to use what completer...
869 zstyle -e ':completion:*' completer '
870 if [[ $_last_try != "$HISTNO$BUFFER$CURSOR" ]] ; then
871 _last_try="$HISTNO$BUFFER$CURSOR"
872 reply=(_complete _match _ignored _prefix _files)
874 if [[ $words[1] == (rm|mv) ]] ; then
875 reply=(_complete _files)
877 reply=(_oldlist _expand _force_rehash _complete _ignored _correct _approximate _files)
882 # command for process lists, the local web server details and host completion
883 zstyle ':completion:*:urls' local 'www' '/var/www/' 'public_html'
885 # Some functions, like _apt and _dpkg, are very slow. We can use a cache in
886 # order to speed things up
887 if [[ ${GRML_COMP_CACHING:-yes} == yes ]]; then
888 GRML_COMP_CACHE_DIR=${GRML_COMP_CACHE_DIR:-${ZDOTDIR:-$HOME}/.cache}
889 if [[ ! -d ${GRML_COMP_CACHE_DIR} ]]; then
890 command mkdir -p "${GRML_COMP_CACHE_DIR}"
892 zstyle ':completion:*' use-cache yes
893 zstyle ':completion:*:complete:*' cache-path "${GRML_COMP_CACHE_DIR}"
898 [[ -r ~/.ssh/config ]] && _ssh_config_hosts=(${${(s: :)${(ps:\t:)${${(@M)${(f)"$(<$HOME/.ssh/config)"}:#Host *}#Host }}}:#*[*?]*}) || _ssh_config_hosts=()
899 [[ -r ~/.ssh/known_hosts ]] && _ssh_hosts=(${${${${(f)"$(<$HOME/.ssh/known_hosts)"}:#[\|]*}%%\ *}%%,*}) || _ssh_hosts=()
900 [[ -r /etc/hosts ]] && : ${(A)_etc_hosts:=${(s: :)${(ps:\t:)${${(f)~~"$(</etc/hosts)"}%%\#*}##[:blank:]#[^[:blank:]]#}}} || _etc_hosts=()
908 if check_com hostname ; then
909 localname=$(hostname)
910 elif check_com hostnamectl ; then
911 localname=$(hostnamectl --static)
913 localname="$(uname -n)"
918 "$_ssh_config_hosts[@]"
923 zstyle ':completion:*:hosts' hosts $hosts
924 # TODO: so, why is this here?
925 # zstyle '*' hosts $hosts
927 # use generic completion system for programs not yet defined; (_gnu_generic works
928 # with commands that provide a --help option with "standard" gnu-like output.)
929 for compcom in cp deborphan df feh fetchipac gpasswd head hnb ipacsum mv \
931 [[ -z ${_comps[$compcom]} ]] && compdef _gnu_generic ${compcom}
934 # see upgrade function in this file
935 compdef _hosts upgrade
938 # Keyboard setup: The following is based on the same code, we wrote for
939 # debian's setup. It ensures the terminal is in the right mode, when zle is
940 # active, so the values from $terminfo are valid. Therefore, this setup should
941 # work on all systems, that have support for `terminfo'. It also requires the
942 # zsh in use to have the `zsh/terminfo' module built.
944 # If you are customising your `zle-line-init()' or `zle-line-finish()'
945 # functions, make sure you call the following utility functions in there:
947 # - zle-line-init(): zle-smkx
948 # - zle-line-finish(): zle-rmkx
950 # Use emacs-like key bindings by default:
955 ## beginning-of-line OR beginning-of-buffer OR beginning of history
956 ## by: Bart Schaefer <schaefer@brasslantern.com>, Bernhard Tittelbach
957 function beginning-or-end-of-somewhere () {
959 if [[ ( "${LBUFFER[-1]}" == $'\n' && "${WIDGET}" == beginning-of* ) || \
960 ( "${RBUFFER[1]}" == $'\n' && "${WIDGET}" == end-of* ) ]]; then
961 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
963 zle .${WIDGET:s/somewhere/line-hist/} "$@"
964 if (( HISTNO != hno )); then
965 zle .${WIDGET:s/somewhere/buffer-or-history/} "$@"
969 zle -N beginning-of-somewhere beginning-or-end-of-somewhere
970 zle -N end-of-somewhere beginning-or-end-of-somewhere
972 # add a command line to the shells history without executing it
973 function commit-to-history () {
974 print -rs ${(z)BUFFER}
977 zle -N commit-to-history
979 # only slash should be considered as a word separator:
980 function slash-backward-kill-word () {
981 local WORDCHARS="${WORDCHARS:s@/@}"
983 zle backward-kill-word
985 zle -N slash-backward-kill-word
987 # a generic accept-line wrapper
989 # This widget can prevent unwanted autocorrections from command-name
990 # to _command-name, rehash automatically on enter and call any number
991 # of builtin and user-defined widgets in different contexts.
993 # For a broader description, see:
994 # <http://bewatermyfriend.org/posts/2007/12-26.11-50-38-tooltime.html>
996 # The code is imported from the file 'zsh/functions/accept-line' from
997 # <http://ft.bewatermyfriend.org/comp/zsh/zsh-dotfiles.tar.bz2>, which
998 # distributed under the same terms as zsh itself.
1000 # A newly added command will may not be found or will cause false
1001 # correction attempts, if you got auto-correction set. By setting the
1002 # following style, we force accept-line() to rehash, if it cannot
1003 # find the first word on the command line in the $command[] hash.
1004 zstyle ':acceptline:*' rehash true
1006 function Accept-Line () {
1007 setopt localoptions noksharrays
1011 local alcontext=${1:-$alcontext}
1013 zstyle -a ":acceptline:${alcontext}" actions subs
1015 (( ${#subs} < 1 )) && return 0
1018 for sub in ${subs} ; do
1019 [[ ${sub} == 'accept-line' ]] && sub='.accept-line'
1022 (( aldone > 0 )) && break
1026 function Accept-Line-getdefault () {
1028 local default_action
1030 zstyle -s ":acceptline:${alcontext}" default_action default_action
1031 case ${default_action} in
1033 printf ".accept-line"
1036 printf ${default_action}
1041 function Accept-Line-HandleContext () {
1044 default_action=$(Accept-Line-getdefault)
1045 zstyle -T ":acceptline:${alcontext}" call_default \
1046 && zle ${default_action}
1049 function accept-line () {
1050 setopt localoptions noksharrays
1053 local buf com fname format msg default_action
1057 cmdline=(${(z)BUFFER})
1061 Accept-Line 'preprocess'
1063 zstyle -t ":acceptline:${alcontext}" rehash \
1064 && [[ -z ${commands[$com]} ]] \
1067 if [[ -n ${com} ]] \
1068 && [[ -n ${reswords[(r)$com]} ]] \
1069 || [[ -n ${aliases[$com]} ]] \
1070 || [[ -n ${functions[$com]} ]] \
1071 || [[ -n ${builtins[$com]} ]] \
1072 || [[ -n ${commands[$com]} ]] ; then
1074 # there is something sensible to execute, just do it.
1076 Accept-Line-HandleContext
1081 if [[ -o correct ]] \
1082 || [[ -o correctall ]] \
1083 && [[ -n ${functions[$fname]} ]] ; then
1085 # nothing there to execute but there is a function called
1086 # _command_name; a completion widget. Makes no sense to
1087 # call it on the commandline, but the correct{,all} options
1088 # will ask for it nevertheless, so warn the user.
1089 if [[ ${LASTWIDGET} == 'accept-line' ]] ; then
1090 # Okay, we warned the user before, he called us again,
1091 # so have it his way.
1093 Accept-Line-HandleContext
1098 if zstyle -t ":acceptline:${alcontext}" nocompwarn ; then
1100 Accept-Line-HandleContext
1102 # prepare warning message for the user, configurable via zstyle.
1103 zstyle -s ":acceptline:${alcontext}" compwarnfmt msg
1105 if [[ -z ${msg} ]] ; then
1106 msg="%c will not execute and completion %f exists."
1109 zformat -f msg "${msg}" "c:${com}" "f:${fname}"
1114 elif [[ -n ${buf//[$' \t\n']##/} ]] ; then
1115 # If we are here, the commandline contains something that is not
1116 # executable, which is neither subject to _command_name correction
1117 # and is not empty. might be a variable assignment
1119 Accept-Line-HandleContext
1124 # If we got this far, the commandline only contains whitespace, or is empty.
1126 Accept-Line-HandleContext
1131 zle -N Accept-Line-HandleContext
1133 # power completion / abbreviation expansion / buffer expansion
1134 # see http://zshwiki.org/home/examples/zleiab for details
1135 # less risky than the global aliases but powerful as well
1136 # just type the abbreviation key and afterwards 'ctrl-x .' to expand it
1139 setopt interactivecomments
1141 # key # value (#d additional doc string)
1147 'G' '|& grep '${grep_options:+"${grep_options[*]}"}
1149 'Hl' ' --help |& less -r' #d (Display help in pager)
1153 'N' '&>/dev/null' #d (No Output)
1154 'R' '| tr A-z N-za-m' #d (ROT13)
1155 'SL' '| sort | less'
1160 'co' './configure && make && sudo make install'
1163 function zleiab () {
1168 LBUFFER=${LBUFFER%%(#m)[.\-+:|_a-zA-Z0-9]#}
1169 LBUFFER+=${abk[$MATCH]:-$MATCH}
1174 function help-show-abk () {
1175 zle -M "$(print "Available abbreviations for expansion:"; print -a -C 2 ${(kv)abk})"
1178 zle -N help-show-abk
1180 # press "ctrl-x d" to insert the actual date in the form yyyy-mm-dd
1181 function insert-datestamp () { LBUFFER+=${(%):-'%D{%Y-%m-%d}'}; }
1182 zle -N insert-datestamp
1184 # press esc-m for inserting last typed word again (thanks to caphuso!)
1185 function insert-last-typed-word () { zle insert-last-word -- 0 -1 };
1186 zle -N insert-last-typed-word;
1188 function grml-zsh-fg () {
1189 if (( ${#jobstates} )); then
1191 [[ -o hist_ignore_space ]] && BUFFER=' ' || BUFFER=''
1192 BUFFER="${BUFFER}fg"
1195 zle -M 'No background jobs. Doing nothing.'
1200 # run command line as user root via sudo:
1201 function sudo-command-line () {
1202 [[ -z $BUFFER ]] && zle up-history
1204 if [[ ${BUFFER} == ${cmd}* ]]; then
1205 CURSOR=$(( CURSOR-${#cmd} ))
1206 BUFFER="${BUFFER#$cmd}"
1208 BUFFER="${cmd}${BUFFER}"
1209 CURSOR=$(( CURSOR+${#cmd} ))
1213 zle -N sudo-command-line
1215 ### jump behind the first word on the cmdline.
1216 ### useful to add options.
1217 function jump_after_first_word () {
1219 words=(${(z)BUFFER})
1221 if (( ${#words} <= 1 )) ; then
1224 CURSOR=${#${words[1]}}
1227 zle -N jump_after_first_word
1229 #f5# Create directory under cursor or the selected area
1230 function inplaceMkDirs () {
1231 # Press ctrl-xM to create the directory under the cursor or the selected area.
1232 # To select an area press ctrl-@ or ctrl-space and use the cursor.
1233 # Use case: you type "mv abc ~/testa/testb/testc/" and remember that the
1234 # directory does not exist yet -> press ctrl-XM and problem solved
1236 if ((REGION_ACTIVE==1)); then
1237 local F=$MARK T=$CURSOR
1238 if [[ $F -gt $T ]]; then
1242 # get marked area from buffer and eliminate whitespace
1243 PATHTOMKDIR=${BUFFER[F+1,T]%%[[:space:]]##}
1244 PATHTOMKDIR=${PATHTOMKDIR##[[:space:]]##}
1246 local bufwords iword
1247 bufwords=(${(z)LBUFFER})
1249 bufwords=(${(z)BUFFER})
1250 PATHTOMKDIR="${(Q)bufwords[iword]}"
1252 [[ -z "${PATHTOMKDIR}" ]] && return 1
1253 PATHTOMKDIR=${~PATHTOMKDIR}
1254 if [[ -e "${PATHTOMKDIR}" ]]; then
1255 zle -M " path already exists, doing nothing"
1257 zle -M "$(mkdir -p -v "${PATHTOMKDIR}")"
1262 zle -N inplaceMkDirs
1264 #v1# set number of lines to display per page
1265 HELP_LINES_PER_PAGE=20
1266 #v1# set location of help-zle cache file
1267 HELP_ZLE_CACHE_FILE=~/.cache/zsh_help_zle_lines.zsh
1268 # helper function for help-zle, actually generates the help text
1269 function help_zle_parse_keybindings () {
1272 unsetopt ksharrays #indexing starts at 1
1274 #v1# choose files that help-zle will parse for keybindings
1275 ((${+HELPZLE_KEYBINDING_FILES})) || HELPZLE_KEYBINDING_FILES=( /etc/zsh/zshrc ~/.zshrc.pre ~/.zshrc ~/.zshrc.local )
1277 if [[ -r $HELP_ZLE_CACHE_FILE ]]; then
1280 for f ($HELPZLE_KEYBINDING_FILES) [[ $f -nt $HELP_ZLE_CACHE_FILE ]] && load_cache=1
1281 [[ $load_cache -eq 0 ]] && . $HELP_ZLE_CACHE_FILE && return
1284 #fill with default keybindings, possibly to be overwritten in a file later
1285 #Note that due to zsh inconsistency on escaping assoc array keys, we encase the key in '' which we will remove later
1286 local -A help_zle_keybindings
1287 help_zle_keybindings['<Ctrl>@']="set MARK"
1288 help_zle_keybindings['<Ctrl>x<Ctrl>j']="vi-join lines"
1289 help_zle_keybindings['<Ctrl>x<Ctrl>b']="jump to matching brace"
1290 help_zle_keybindings['<Ctrl>x<Ctrl>u']="undo"
1291 help_zle_keybindings['<Ctrl>_']="undo"
1292 help_zle_keybindings['<Ctrl>x<Ctrl>f<c>']="find <c> in cmdline"
1293 help_zle_keybindings['<Ctrl>a']="goto beginning of line"
1294 help_zle_keybindings['<Ctrl>e']="goto end of line"
1295 help_zle_keybindings['<Ctrl>t']="transpose charaters"
1296 help_zle_keybindings['<Alt>t']="transpose words"
1297 help_zle_keybindings['<Alt>s']="spellcheck word"
1298 help_zle_keybindings['<Ctrl>k']="backward kill buffer"
1299 help_zle_keybindings['<Ctrl>u']="forward kill buffer"
1300 help_zle_keybindings['<Ctrl>y']="insert previously killed word/string"
1301 help_zle_keybindings["<Alt>'"]="quote line"
1302 help_zle_keybindings['<Alt>"']="quote from mark to cursor"
1303 help_zle_keybindings['<Alt><arg>']="repeat next cmd/char <arg> times (<Alt>-<Alt>1<Alt>0a -> -10 times 'a')"
1304 help_zle_keybindings['<Alt>u']="make next word Uppercase"
1305 help_zle_keybindings['<Alt>l']="make next word lowercase"
1306 help_zle_keybindings['<Ctrl>xG']="preview expansion under cursor"
1307 help_zle_keybindings['<Alt>q']="push current CL into background, freeing it. Restore on next CL"
1308 help_zle_keybindings['<Alt>.']="insert (and interate through) last word from prev CLs"
1309 help_zle_keybindings['<Alt>,']="complete word from newer history (consecutive hits)"
1310 help_zle_keybindings['<Alt>m']="repeat last typed word on current CL"
1311 help_zle_keybindings['<Ctrl>v']="insert next keypress symbol literally (e.g. for bindkey)"
1312 help_zle_keybindings['!!:n*<Tab>']="insert last n arguments of last command"
1313 help_zle_keybindings['!!:n-<Tab>']="insert arguments n..N-2 of last command (e.g. mv s s d)"
1314 help_zle_keybindings['<Alt>h']="show help/manpage for current command"
1316 #init global variables
1317 unset help_zle_lines help_zle_sln
1318 typeset -g -a help_zle_lines
1319 typeset -g help_zle_sln=1
1322 local lastkeybind_desc contents #last description starting with #k# that we found
1323 local num_lines_elapsed=0 #number of lines between last description and keybinding
1324 #search config files in the order they a called (and thus the order in which they overwrite keybindings)
1325 for f in $HELPZLE_KEYBINDING_FILES; do
1326 [[ -r "$f" ]] || continue #not readable ? skip it
1328 for cline in "${(f)contents}"; do
1329 #zsh pattern: matches lines like: #k# ..............
1330 if [[ "$cline" == (#s)[[:space:]]#\#k\#[[:space:]]##(#b)(*)[[:space:]]#(#e) ]]; then
1331 lastkeybind_desc="$match[*]"
1333 #zsh pattern: matches lines that set a keybinding using bind2map, bindkey or compdef -k
1334 # ignores lines that are commentend out
1335 # grabs first in '' or "" enclosed string with length between 1 and 6 characters
1336 elif [[ "$cline" == [^#]#(bind2maps[[:space:]](*)-s|bindkey|compdef -k)[[:space:]](*)(#b)(\"((?)(#c1,6))\"|\'((?)(#c1,6))\')(#B)(*) ]]; then
1337 #description previously found ? description not more than 2 lines away ? keybinding not empty ?
1338 if [[ -n $lastkeybind_desc && $num_lines_elapsed -lt 2 && -n $match[1] ]]; then
1339 #substitute keybinding string with something readable
1340 k=${${${${${${${match[1]/\\e\^h/<Alt><BS>}/\\e\^\?/<Alt><BS>}/\\e\[5~/<PageUp>}/\\e\[6~/<PageDown>}//(\\e|\^\[)/<Alt>}//\^/<Ctrl>}/3~/<Alt><Del>}
1341 #put keybinding in assoc array, possibly overwriting defaults or stuff found in earlier files
1342 #Note that we are extracting the keybinding-string including the quotes (see Note at beginning)
1343 help_zle_keybindings[${k}]=$lastkeybind_desc
1347 ((num_lines_elapsed++))
1352 #calculate length of keybinding column
1354 for k (${(k)help_zle_keybindings[@]}) ((kstrlen < ${#k})) && kstrlen=${#k}
1355 #convert the assoc array into preformated lines, which we are able to sort
1356 for k v in ${(kv)help_zle_keybindings[@]}; do
1357 #pad keybinding-string to kstrlen chars and remove outermost characters (i.e. the quotes)
1358 help_zle_lines+=("${(r:kstrlen:)k[2,-2]}${v}")
1360 #sort lines alphabetically
1361 help_zle_lines=("${(i)help_zle_lines[@]}")
1362 [[ -d ${HELP_ZLE_CACHE_FILE:h} ]] || mkdir -p "${HELP_ZLE_CACHE_FILE:h}"
1363 echo "help_zle_lines=(${(q)help_zle_lines[@]})" >| $HELP_ZLE_CACHE_FILE
1364 zcompile $HELP_ZLE_CACHE_FILE
1366 typeset -g help_zle_sln
1367 typeset -g -a help_zle_lines
1369 # Provides (partially autogenerated) help on keybindings and the zsh line editor
1370 function help-zle () {
1372 unsetopt ksharrays #indexing starts at 1
1373 #help lines already generated ? no ? then do it
1374 [[ ${+functions[help_zle_parse_keybindings]} -eq 1 ]] && {help_zle_parse_keybindings && unfunction help_zle_parse_keybindings}
1375 #already displayed all lines ? go back to the start
1376 [[ $help_zle_sln -gt ${#help_zle_lines} ]] && help_zle_sln=1
1377 local sln=$help_zle_sln
1378 #note that help_zle_sln is a global var, meaning we remember the last page we viewed
1379 help_zle_sln=$((help_zle_sln + HELP_LINES_PER_PAGE))
1380 zle -M "${(F)help_zle_lines[sln,help_zle_sln-1]}"
1384 ## complete word from currently visible Screen or Tmux buffer.
1385 if check_com -c screen || check_com -c tmux; then
1386 function _complete_screen_display () {
1387 [[ "$TERM" != "screen" ]] && return 1
1389 local TMPFILE=$(mktemp)
1390 local -U -a _screen_display_wordlist
1391 trap "rm -f $TMPFILE" EXIT
1393 # fill array with contents from screen hardcopy
1394 if ((${+TMUX})); then
1395 #works, but crashes tmux below version 1.4
1396 #luckily tmux -V option to ask for version, was also added in 1.4
1397 tmux -V &>/dev/null || return
1398 tmux -q capture-pane \; save-buffer -b 0 $TMPFILE \; delete-buffer -b 0
1400 screen -X hardcopy $TMPFILE
1401 # screen sucks, it dumps in latin1, apparently always. so recode it
1403 check_com recode && recode latin1 $TMPFILE
1405 _screen_display_wordlist=( ${(QQ)$(<$TMPFILE)} )
1406 # remove PREFIX to be completed from that array
1407 _screen_display_wordlist[${_screen_display_wordlist[(i)$PREFIX]}]=""
1408 compadd -a _screen_display_wordlist
1410 #m# k CTRL-x\,\,\,S Complete word from GNU screen buffer
1412 compdef -k _complete_screen_display complete-word '^xS'
1415 # Load a few more functions and tie them to widgets, so they can be bound:
1417 function zrcautozle () {
1420 zrcautoload $fnc && zle -N $fnc
1423 function zrcgotwidget () {
1424 (( ${+widgets[$1]} ))
1427 function zrcgotkeymap () {
1428 [[ -n ${(M)keymaps:#$1} ]]
1431 zrcautozle insert-files
1432 zrcautozle edit-command-line
1433 zrcautozle insert-unicode-char
1434 if zrcautoload history-search-end; then
1435 zle -N history-beginning-search-backward-end history-search-end
1436 zle -N history-beginning-search-forward-end history-search-end
1438 zle -C hist-complete complete-word _generic
1439 zstyle ':completion:hist-complete:*' completer _history
1441 # The actual terminal setup hooks and bindkey-calls:
1443 # An array to note missing features to ease diagnosis in case of problems.
1444 typeset -ga grml_missing_features
1446 function zrcbindkey () {
1447 if (( ARGC )) && zrcgotwidget ${argv[-1]}; then
1452 function bind2maps () {
1453 local i sequence widget
1456 while [[ "$1" != "--" ]]; do
1462 if [[ "$1" == "-s" ]]; then
1466 sequence="${key[$1]}"
1470 [[ -z "$sequence" ]] && return 1
1472 for i in "${maps[@]}"; do
1473 zrcbindkey -M "$i" "$sequence" "$widget"
1477 if (( ${+terminfo[smkx]} )) && (( ${+terminfo[rmkx]} )); then
1478 function zle-smkx () {
1480 printf '%s' ${terminfo[smkx]}
1482 function zle-rmkx () {
1484 printf '%s' ${terminfo[rmkx]}
1486 function zle-line-init () {
1489 function zle-line-finish () {
1492 zle -N zle-line-init
1493 zle -N zle-line-finish
1495 for i in {s,r}mkx; do
1496 (( ${+terminfo[$i]} )) || grml_missing_features+=($i)
1503 Home "${terminfo[khome]}"
1504 End "${terminfo[kend]}"
1505 Insert "${terminfo[kich1]}"
1506 Delete "${terminfo[kdch1]}"
1507 Up "${terminfo[kcuu1]}"
1508 Down "${terminfo[kcud1]}"
1509 Left "${terminfo[kcub1]}"
1510 Right "${terminfo[kcuf1]}"
1511 PageUp "${terminfo[kpp]}"
1512 PageDown "${terminfo[knp]}"
1513 BackTab "${terminfo[kcbt]}"
1516 # Guidelines for adding key bindings:
1518 # - Do not add hardcoded escape sequences, to enable non standard key
1519 # combinations such as Ctrl-Meta-Left-Cursor. They are not easily portable.
1521 # - Adding Ctrl characters, such as '^b' is okay; note that '^b' and '^B' are
1524 # - All keys from the $key[] mapping are obviously okay.
1526 # - Most terminals send "ESC x" when Meta-x is pressed. Thus, sequences like
1527 # '\ex' are allowed in here as well.
1529 bind2maps emacs -- Home beginning-of-somewhere
1530 bind2maps viins vicmd -- Home vi-beginning-of-line
1531 bind2maps emacs -- End end-of-somewhere
1532 bind2maps viins vicmd -- End vi-end-of-line
1533 bind2maps emacs viins -- Insert overwrite-mode
1534 bind2maps vicmd -- Insert vi-insert
1535 bind2maps emacs -- Delete delete-char
1536 bind2maps viins vicmd -- Delete vi-delete-char
1537 bind2maps emacs viins vicmd -- Up up-line-or-search
1538 bind2maps emacs viins vicmd -- Down down-line-or-search
1539 bind2maps emacs -- Left backward-char
1540 bind2maps viins vicmd -- Left vi-backward-char
1541 bind2maps emacs -- Right forward-char
1542 bind2maps viins vicmd -- Right vi-forward-char
1543 #k# Perform abbreviation expansion
1544 bind2maps emacs viins -- -s '^x.' zleiab
1545 #k# Display list of abbreviations that would expand
1546 bind2maps emacs viins -- -s '^xb' help-show-abk
1547 #k# mkdir -p <dir> from string under cursor or marked area
1548 bind2maps emacs viins -- -s '^xM' inplaceMkDirs
1549 #k# display help for keybindings and ZLE
1550 bind2maps emacs viins -- -s '^xz' help-zle
1551 #k# Insert files and test globbing
1552 bind2maps emacs viins -- -s "^xf" insert-files
1553 #k# Edit the current line in \kbd{\$EDITOR}
1554 bind2maps emacs viins -- -s '\ee' edit-command-line
1555 #k# search history backward for entry beginning with typed text
1556 bind2maps emacs viins -- -s '^xp' history-beginning-search-backward-end
1557 #k# search history forward for entry beginning with typed text
1558 bind2maps emacs viins -- -s '^xP' history-beginning-search-forward-end
1559 #k# search history backward for entry beginning with typed text
1560 bind2maps emacs viins -- PageUp history-beginning-search-backward-end
1561 #k# search history forward for entry beginning with typed text
1562 bind2maps emacs viins -- PageDown history-beginning-search-forward-end
1563 bind2maps emacs viins -- -s "^x^h" commit-to-history
1564 #k# Kill left-side word or everything up to next slash
1565 bind2maps emacs viins -- -s '\ev' slash-backward-kill-word
1566 #k# Kill left-side word or everything up to next slash
1567 bind2maps emacs viins -- -s '\e^h' slash-backward-kill-word
1568 #k# Kill left-side word or everything up to next slash
1569 bind2maps emacs viins -- -s '\e^?' slash-backward-kill-word
1570 # Do history expansion on space:
1571 bind2maps emacs viins -- -s ' ' magic-space
1572 #k# Trigger menu-complete
1573 bind2maps emacs viins -- -s '\ei' menu-complete # menu completion via esc-i
1574 #k# Insert a timestamp on the command line (yyyy-mm-dd)
1575 bind2maps emacs viins -- -s '^xd' insert-datestamp
1576 #k# Insert last typed word
1577 bind2maps emacs viins -- -s "\em" insert-last-typed-word
1578 #k# A smart shortcut for \kbd{fg<enter>}
1579 bind2maps emacs viins -- -s '^z' grml-zsh-fg
1580 #k# prepend the current command with "sudo"
1581 bind2maps emacs viins -- -s "^os" sudo-command-line
1582 #k# jump to after first word (for adding options)
1583 bind2maps emacs viins -- -s '^x1' jump_after_first_word
1584 #k# complete word from history with menu
1585 bind2maps emacs viins -- -s "^x^x" hist-complete
1587 # insert unicode character
1588 # usage example: 'ctrl-x i' 00A7 'ctrl-x i' will give you an §
1589 # See for example http://unicode.org/charts/ for unicode characters code
1590 #k# Insert Unicode character
1591 bind2maps emacs viins -- -s '^xi' insert-unicode-char
1593 # use the new *-pattern-* widgets for incremental history search
1594 if zrcgotwidget history-incremental-pattern-search-backward; then
1595 for seq wid in '^r' history-incremental-pattern-search-backward \
1596 '^s' history-incremental-pattern-search-forward
1598 bind2maps emacs viins vicmd -- -s $seq $wid
1600 builtin unset -v seq wid
1603 if zrcgotkeymap menuselect; then
1604 #m# k Shift-tab Perform backwards menu completion
1605 bind2maps menuselect -- BackTab reverse-menu-complete
1607 #k# menu selection: pick item but stay in the menu
1608 bind2maps menuselect -- -s '\e^M' accept-and-menu-complete
1609 # also use + and INSERT since it's easier to press repeatedly
1610 bind2maps menuselect -- -s '+' accept-and-menu-complete
1611 bind2maps menuselect -- Insert accept-and-menu-complete
1613 # accept a completion and try to complete again by using menu
1614 # completion; very useful with completing directories
1615 # by using 'undo' one's got a simple file browser
1616 bind2maps menuselect -- -s '^o' accept-and-infer-next-history
1619 # Finally, here are still a few hardcoded escape sequences; Special sequences
1620 # like Ctrl-<Cursor-key> etc do suck a fair bit, because they are not
1621 # standardised and most of the time are not available in a terminals terminfo
1624 # While we do not encourage adding bindings like these, we will keep these for
1625 # backward compatibility.
1627 ## use Ctrl-left-arrow and Ctrl-right-arrow for jumping to word-beginnings on
1628 ## the command line.
1630 bind2maps emacs viins vicmd -- -s '\eOc' forward-word
1631 bind2maps emacs viins vicmd -- -s '\eOd' backward-word
1632 # These are for xterm:
1633 bind2maps emacs viins vicmd -- -s '\e[1;5C' forward-word
1634 bind2maps emacs viins vicmd -- -s '\e[1;5D' backward-word
1635 ## the same for alt-left-arrow and alt-right-arrow
1637 bind2maps emacs viins vicmd -- -s '\e\e[C' forward-word
1638 bind2maps emacs viins vicmd -- -s '\e\e[D' backward-word
1640 bind2maps emacs viins vicmd -- -s '^[[1;3C' forward-word
1641 bind2maps emacs viins vicmd -- -s '^[[1;3D' backward-word
1642 # Also try ESC Left/Right:
1643 bind2maps emacs viins vicmd -- -s '\e'${key[Right]} forward-word
1644 bind2maps emacs viins vicmd -- -s '\e'${key[Left]} backward-word
1651 # we don't want to quote/espace URLs on our own...
1652 # if autoload -U url-quote-magic ; then
1653 # zle -N self-insert url-quote-magic
1654 # zstyle ':url-quote-magic:*' url-metas '*?[]^()~#{}='
1656 # print 'Notice: no url-quote-magic available :('
1659 # url-quote doesn't work without bracketed-paste-magic since Zsh 5.1
1660 alias url-quote='autoload -U bracketed-paste-magic url-quote-magic;
1661 zle -N bracketed-paste bracketed-paste-magic; zle -N self-insert url-quote-magic'
1663 alias url-quote='autoload -U url-quote-magic ; zle -N self-insert url-quote-magic'
1666 #m# k ESC-h Call \kbd{run-help} for the 1st word on the command line
1667 alias run-help >&/dev/null && unalias run-help
1668 for rh in run-help{,-git,-ip,-openssl,-p4,-sudo,-svk,-svn}; do
1672 # command not found handling
1674 (( ${COMMAND_NOT_FOUND} == 1 )) &&
1675 function command_not_found_handler () {
1677 if [[ -x ${GRML_ZSH_CNF_HANDLER} ]] ; then
1678 ${GRML_ZSH_CNF_HANDLER} $1
1686 HISTFILE=${HISTFILE:-${ZDOTDIR:-${HOME}}/.zsh_history}
1687 isgrmlcd && HISTSIZE=500 || HISTSIZE=5000
1688 isgrmlcd && SAVEHIST=1000 || SAVEHIST=10000 # useful for setopt append_history
1692 DIRSTACKSIZE=${DIRSTACKSIZE:-20}
1693 DIRSTACKFILE=${DIRSTACKFILE:-${ZDOTDIR:-${HOME}}/.zdirs}
1695 if zstyle -T ':grml:chpwd:dirstack' enable; then
1696 typeset -gaU GRML_PERSISTENT_DIRSTACK
1697 function grml_dirstack_filter () {
1700 if zstyle -s ':grml:chpwd:dirstack' filter filter; then
1701 $filter $1 && return 0
1703 if zstyle -a ':grml:chpwd:dirstack' exclude exclude; then
1704 for entry in "${exclude[@]}"; do
1705 [[ $1 == ${~entry} ]] && return 0
1712 (( ZSH_SUBSHELL )) && return
1713 (( $DIRSTACKSIZE <= 0 )) && return
1714 [[ -z $DIRSTACKFILE ]] && return
1715 grml_dirstack_filter $PWD && return
1716 GRML_PERSISTENT_DIRSTACK=(
1717 $PWD "${(@)GRML_PERSISTENT_DIRSTACK[1,$DIRSTACKSIZE]}"
1719 builtin print -l ${GRML_PERSISTENT_DIRSTACK} >! ${DIRSTACKFILE}
1722 if [[ -f ${DIRSTACKFILE} ]]; then
1723 # Enabling NULL_GLOB via (N) weeds out any non-existing
1724 # directories from the saved dir-stack file.
1725 dirstack=( ${(f)"$(< $DIRSTACKFILE)"}(N) )
1726 # "cd -" won't work after login by just setting $OLDPWD, so
1727 [[ -d $dirstack[1] ]] && cd -q $dirstack[1] && cd -q $OLDPWD
1730 if zstyle -t ':grml:chpwd:dirstack' filter-on-load; then
1731 for i in "${dirstack[@]}"; do
1732 if ! grml_dirstack_filter "$i"; then
1733 GRML_PERSISTENT_DIRSTACK=(
1734 "${GRML_PERSISTENT_DIRSTACK[@]}"
1740 GRML_PERSISTENT_DIRSTACK=( "${dirstack[@]}" )
1744 # directory based profiles
1748 # chpwd_profiles(): Directory Profiles, Quickstart:
1752 # zstyle ':chpwd:profiles:/usr/src/grml(|/|/*)' profile grml
1753 # zstyle ':chpwd:profiles:/usr/src/debian(|/|/*)' profile debian
1756 # For details see the `grmlzshrc.5' manual page.
1757 function chpwd_profiles () {
1758 local profile context
1761 context=":chpwd:profiles:$PWD"
1762 zstyle -s "$context" profile profile || profile='default'
1763 zstyle -T "$context" re-execute && reexecute=1 || reexecute=0
1765 if (( ${+parameters[CHPWD_PROFILE]} == 0 )); then
1766 typeset -g CHPWD_PROFILE
1767 local CHPWD_PROFILES_INIT=1
1768 (( ${+functions[chpwd_profiles_init]} )) && chpwd_profiles_init
1769 elif [[ $profile != $CHPWD_PROFILE ]]; then
1770 (( ${+functions[chpwd_leave_profile_$CHPWD_PROFILE]} )) \
1771 && chpwd_leave_profile_${CHPWD_PROFILE}
1773 if (( reexecute )) || [[ $profile != $CHPWD_PROFILE ]]; then
1774 (( ${+functions[chpwd_profile_$profile]} )) && chpwd_profile_${profile}
1777 CHPWD_PROFILE="${profile}"
1781 chpwd_functions=( ${chpwd_functions} chpwd_profiles )
1785 # Prompt setup for grml:
1787 # set colors for use in prompts (modern zshs allow for the use of %F{red}foo%f
1788 # in prompts to get a red "foo" embedded, but it's good to keep these for
1789 # backwards compatibility).
1795 MAGENTA="%F{magenta}"
1799 elif zrcautoload colors && colors 2>/dev/null ; then
1800 BLUE="%{${fg[blue]}%}"
1801 RED="%{${fg_bold[red]}%}"
1802 GREEN="%{${fg[green]}%}"
1803 CYAN="%{${fg[cyan]}%}"
1804 MAGENTA="%{${fg[magenta]}%}"
1805 YELLOW="%{${fg[yellow]}%}"
1806 WHITE="%{${fg[white]}%}"
1807 NO_COLOR="%{${reset_color}%}"
1809 BLUE=$'%{\e[1;34m%}'
1811 GREEN=$'%{\e[1;32m%}'
1812 CYAN=$'%{\e[1;36m%}'
1813 WHITE=$'%{\e[1;37m%}'
1814 MAGENTA=$'%{\e[1;35m%}'
1815 YELLOW=$'%{\e[1;33m%}'
1816 NO_COLOR=$'%{\e[0m%}'
1819 # First, the easy ones: PS2..4:
1821 # secondary prompt, printed when the shell needs more information to complete a
1824 # selection prompt used within a select loop.
1826 # the execution trace prompt (setopt xtrace). default: '+%N:%i>'
1829 # Some additional features to use with our prompt:
1833 # - vcs_info setup and version specific fixes
1835 # display battery status on right side of prompt using 'GRML_DISPLAY_BATTERY=1' in .zshrc.pre
1837 function battery () {
1838 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]] ; then
1841 elif isopenbsd ; then
1843 elif isfreebsd ; then
1845 elif isdarwin ; then
1849 GRML_DISPLAY_BATTERY=0
1854 function batterylinux () {
1855 GRML_BATTERY_LEVEL=''
1856 local batteries bat capacity
1857 batteries=( /sys/class/power_supply/BAT*(N) )
1858 if (( $#batteries > 0 )) ; then
1859 for bat in $batteries ; do
1860 if [[ -e $bat/capacity ]]; then
1861 capacity=$(< $bat/capacity)
1863 typeset -F energy_full=$(< $bat/energy_full)
1864 typeset -F energy_now=$(< $bat/energy_now)
1865 typeset -i capacity=$(( 100 * $energy_now / $energy_full))
1867 case $(< $bat/status) in
1869 GRML_BATTERY_LEVEL+=" ^"
1872 if (( capacity < 20 )) ; then
1873 GRML_BATTERY_LEVEL+=" !v"
1875 GRML_BATTERY_LEVEL+=" v"
1879 GRML_BATTERY_LEVEL+=" ="
1882 GRML_BATTERY_LEVEL+="${capacity}%%"
1887 function batteryopenbsd () {
1888 GRML_BATTERY_LEVEL=''
1889 local bat batfull batwarn batnow num
1891 bat=$(sysctl -n hw.sensors.acpibat${num} 2>/dev/null)
1892 if [[ -n $bat ]]; then
1893 batfull=${"$(sysctl -n hw.sensors.acpibat${num}.amphour0)"%% *}
1894 batwarn=${"$(sysctl -n hw.sensors.acpibat${num}.amphour1)"%% *}
1895 batnow=${"$(sysctl -n hw.sensors.acpibat${num}.amphour3)"%% *}
1896 case "$(sysctl -n hw.sensors.acpibat${num}.raw0)" in
1898 if (( batnow < batwarn )) ; then
1899 GRML_BATTERY_LEVEL+=" !v"
1901 GRML_BATTERY_LEVEL+=" v"
1905 GRML_BATTERY_LEVEL+=" ^"
1908 GRML_BATTERY_LEVEL+=" ="
1911 GRML_BATTERY_LEVEL+="${$(( 100 * batnow / batfull ))%%.*}%%"
1916 function batteryfreebsd () {
1917 GRML_BATTERY_LEVEL=''
1921 table=( ${=${${${${${(M)${(f)"$(acpiconf -i $num 2>&1)"}:#(State|Remaining capacity):*}%%( ##|%)}//:[ $'\t']##/@}// /-}//@/ }} )
1922 if [[ -n $table ]] && [[ $table[State] != "not-present" ]] ; then
1923 case $table[State] in
1925 if (( $table[Remaining-capacity] < 20 )) ; then
1926 GRML_BATTERY_LEVEL+=" !v"
1928 GRML_BATTERY_LEVEL+=" v"
1932 GRML_BATTERY_LEVEL+=" ^"
1935 GRML_BATTERY_LEVEL+=" ="
1938 GRML_BATTERY_LEVEL+="$table[Remaining-capacity]%%"
1943 function batterydarwin () {
1944 GRML_BATTERY_LEVEL=''
1946 table=( ${$(pmset -g ps)[(w)8,9]%%(\%|);} )
1947 if [[ -n $table[2] ]] ; then
1950 GRML_BATTERY_LEVEL+=" ^"
1953 if (( $table[1] < 20 )) ; then
1954 GRML_BATTERY_LEVEL+=" !v"
1956 GRML_BATTERY_LEVEL+=" v"
1960 GRML_BATTERY_LEVEL+=" ="
1963 GRML_BATTERY_LEVEL+="$table[1]%%"
1967 # set variable debian_chroot if running in a chroot with /etc/debian_chroot
1968 if [[ -z "$debian_chroot" ]] && [[ -r /etc/debian_chroot ]] ; then
1969 debian_chroot=$(</etc/debian_chroot)
1972 # gather version control information for inclusion in a prompt
1974 if zrcautoload vcs_info; then
1975 # `vcs_info' in zsh versions 4.3.10 and below have a broken `_realpath'
1976 # function, which can cause a lot of trouble with our directory-based
1978 if [[ ${ZSH_VERSION} == 4.3.<-10> ]] ; then
1979 function VCS_INFO_realpath () {
1980 setopt localoptions NO_shwordsplit chaselinks
1981 ( builtin cd -q $1 2> /dev/null && pwd; )
1985 zstyle ':vcs_info:*' max-exports 2
1987 if [[ -o restricted ]]; then
1988 zstyle ':vcs_info:*' enable NONE
1992 typeset -A grml_vcs_coloured_formats
1993 typeset -A grml_vcs_plain_formats
1995 grml_vcs_plain_formats=(
1996 format "(%s%)-[%b] " "zsh: %r"
1997 actionformat "(%s%)-[%b|%a] " "zsh: %r"
1998 rev-branchformat "%b:%r"
2001 grml_vcs_coloured_formats=(
2002 format "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${MAGENTA}]${NO_COLOR} "
2003 actionformat "${MAGENTA}(${NO_COLOR}%s${MAGENTA})${YELLOW}-${MAGENTA}[${GREEN}%b${YELLOW}|${RED}%a${MAGENTA}]${NO_COLOR} "
2004 rev-branchformat "%b${RED}:${YELLOW}%r"
2007 typeset GRML_VCS_COLOUR_MODE=xxx
2009 function grml_vcs_info_toggle_colour () {
2011 if [[ $GRML_VCS_COLOUR_MODE == plain ]]; then
2012 grml_vcs_info_set_formats coloured
2014 grml_vcs_info_set_formats plain
2019 function grml_vcs_info_set_formats () {
2021 #setopt localoptions xtrace
2022 local mode=$1 AF F BF
2023 if [[ $mode == coloured ]]; then
2024 AF=${grml_vcs_coloured_formats[actionformat]}
2025 F=${grml_vcs_coloured_formats[format]}
2026 BF=${grml_vcs_coloured_formats[rev-branchformat]}
2027 GRML_VCS_COLOUR_MODE=coloured
2029 AF=${grml_vcs_plain_formats[actionformat]}
2030 F=${grml_vcs_plain_formats[format]}
2031 BF=${grml_vcs_plain_formats[rev-branchformat]}
2032 GRML_VCS_COLOUR_MODE=plain
2035 zstyle ':vcs_info:*' actionformats "$AF" "zsh: %r"
2036 zstyle ':vcs_info:*' formats "$F" "zsh: %r"
2037 zstyle ':vcs_info:(sv[nk]|bzr):*' branchformat "$BF"
2041 # Change vcs_info formats for the grml prompt. The 2nd format sets up
2042 # $vcs_info_msg_1_ to contain "zsh: repo-name" used to set our screen title.
2043 if [[ "$TERM" == dumb ]] ; then
2044 grml_vcs_info_set_formats plain
2046 grml_vcs_info_set_formats coloured
2049 # Now for the fun part: The grml prompt themes in `promptsys' mode of operation
2051 # This actually defines three prompts:
2057 # They all share the same code and only differ with respect to which items they
2058 # contain. The main source of documentation is the `prompt_grml_help' function
2059 # below, which gets called when the user does this: prompt -h grml
2061 function prompt_grml_help () {
2065 This is the prompt as used by the grml-live system <http://grml.org>. It is
2066 a rather simple one-line prompt, that by default looks something like this:
2068 <user>@<host> <current-working-directory>[ <vcs_info-data>]%
2070 The prompt itself integrates with zsh's prompt themes system (as you are
2071 witnessing right now) and is configurable to a certain degree. In
2072 particular, these aspects are customisable:
2074 - The items used in the prompt (e.g. you can remove \`user' from
2075 the list of activated items, which will cause the user name to
2076 be omitted from the prompt string).
2078 - The attributes used with the items are customisable via strings
2079 used before and after the actual item.
2081 The available items are: at, battery, change-root, date, grml-chroot,
2082 history, host, jobs, newline, path, percent, rc, rc-always, sad-smiley,
2083 shell-level, time, user, vcs
2085 The actual configuration is done via zsh's \`zstyle' mechanism. The
2086 context, that is used while looking up styles is:
2088 ':prompt:grml:<left-or-right>:<subcontext>'
2090 Here <left-or-right> is either \`left' or \`right', signifying whether the
2091 style should affect the left or the right prompt. <subcontext> is either
2092 \`setup' or 'items:<item>', where \`<item>' is one of the available items.
2096 - use-rprompt (boolean): If \`true' (the default), print a sad smiley
2097 in $RPROMPT if the last command a returned non-successful error code.
2098 (This in only valid if <left-or-right> is "right"; ignored otherwise)
2100 - items (list): The list of items used in the prompt. If \`vcs' is
2101 present in the list, the theme's code invokes \`vcs_info'
2102 accordingly. Default (left): rc change-root user at host path vcs
2103 percent; Default (right): sad-smiley
2105 - strip-sensitive-characters (boolean): If the \`prompt_subst' option
2106 is active in zsh, the shell performs lots of expansions on prompt
2107 variable strings, including command substitution. So if you don't
2108 control where some of your prompt strings is coming from, this is
2109 an exploitable weakness. Grml's zsh setup does not set this option
2110 and it is off in the shell in zsh-mode by default. If it *is* turned
2111 on however, this style becomes active, and there are two flavours of
2112 it: On per default is a global variant in the '*:setup' context. This
2113 strips characters after the whole prompt string was constructed. There
2114 is a second variant in the '*:items:<item>', that is off by default.
2115 It allows fine grained control over which items' data is stripped.
2116 The characters that are stripped are: \$ and \`.
2118 Available styles in 'items:<item>' are: pre, post. These are strings that
2119 are inserted before (pre) and after (post) the item in question. Thus, the
2120 following would cause the user name to be printed in red instead of the
2123 zstyle ':prompt:grml:*:items:user' pre '%F{red}'
2125 Note, that the \`post' style may remain at its default value, because its
2126 default value is '%f', which turns the foreground text attribute off (which
2127 is exactly, what is still required with the new \`pre' value).
2131 function prompt_grml-chroot_help () {
2135 This is a variation of the grml prompt, see: prompt -h grml
2137 The main difference is the default value of the \`items' style. The rest
2138 behaves exactly the same. Here are the defaults for \`grml-chroot':
2140 - left: grml-chroot user at host path percent
2141 - right: (empty list)
2145 function prompt_grml-large_help () {
2149 This is a variation of the grml prompt, see: prompt -h grml
2151 The main difference is the default value of the \`items' style. In
2152 particular, this theme uses _two_ lines instead of one with the plain
2153 \`grml' theme. The rest behaves exactly the same. Here are the defaults
2156 - left: rc jobs history shell-level change-root time date newline user
2157 at host path vcs percent
2162 function grml_prompt_setup () {
2164 autoload -Uz vcs_info
2165 # The following autoload is disabled for now, since this setup includes a
2166 # static version of the ‘add-zsh-hook’ function above. It needs to be
2167 # re-enabled as soon as that static definition is removed again.
2168 #autoload -Uz add-zsh-hook
2169 add-zsh-hook precmd prompt_$1_precmd
2172 function prompt_grml_setup () {
2173 grml_prompt_setup grml
2176 function prompt_grml-chroot_setup () {
2177 grml_prompt_setup grml-chroot
2180 function prompt_grml-large_setup () {
2181 grml_prompt_setup grml-large
2184 # These maps define default tokens and pre-/post-decoration for items to be
2185 # used within the themes. All defaults may be customised in a context sensitive
2186 # matter by using zsh's `zstyle' mechanism.
2187 typeset -gA grml_prompt_pre_default \
2188 grml_prompt_post_default \
2189 grml_prompt_token_default \
2190 grml_prompt_token_function
2192 grml_prompt_pre_default=(
2197 grml-chroot '%F{red}'
2207 shell-level '%F{red}'
2213 grml_prompt_post_default=(
2234 grml_prompt_token_default=(
2236 battery 'GRML_BATTERY_LEVEL'
2237 change-root 'debian_chroot'
2239 grml-chroot 'GRML_CHROOT'
2240 history '{history#%!} '
2242 jobs '[%j running job(s)] '
2244 path '%40<..<%~%<< '
2248 sad-smiley '%(?..:()'
2249 shell-level '%(3L.+ .)'
2250 time '%D{%H:%M:%S} '
2255 function grml_theme_has_token () {
2256 if (( ARGC != 1 )); then
2257 printf 'usage: grml_theme_has_token <name>\n'
2260 (( ${+grml_prompt_token_default[$1]} ))
2263 function GRML_theme_add_token_usage () {
2265 Usage: grml_theme_add_token <name> [-f|-i] <token/function> [<pre> <post>]
2267 <name> is the name for the newly added token. If the \`-f' or \`-i' options
2268 are used, <token/function> is the name of the function (see below for
2269 details). Otherwise it is the literal token string to be used. <pre> and
2270 <post> are optional.
2274 -f <function> Use a function named \`<function>' each time the token
2277 -i <function> Use a function named \`<function>' to initialise the
2278 value of the token _once_ at runtime.
2280 The functions are called with one argument: the token's new name. The
2281 return value is expected in the \$REPLY parameter. The use of these
2282 options is mutually exclusive.
2284 There is a utility function \`grml_theme_has_token', which you can use
2285 to test if a token exists before trying to add it. This can be a guard
2286 for situations in which a \`grml_theme_add_token' call may happen more
2291 To add a new token \`day' that expands to the current weekday in the
2292 current locale in green foreground colour, use this:
2294 grml_theme_add_token day '%D{%A}' '%F{green}' '%f'
2296 Another example would be support for \$VIRTUAL_ENV:
2298 function virtual_env_prompt () {
2299 REPLY=\${VIRTUAL_ENV+\${VIRTUAL_ENV:t} }
2301 grml_theme_add_token virtual-env -f virtual_env_prompt
2303 After that, you will be able to use a changed \`items' style to
2304 assemble your prompt.
2308 function grml_theme_add_token () {
2310 local name token pre post
2311 local -i init funcall
2313 if (( ARGC == 0 )); then
2314 GRML_theme_add_token_usage
2324 if [[ $1 == '-f' ]]; then
2327 elif [[ $1 == '-i' ]]; then
2332 if (( ARGC == 0 )); then
2334 grml_theme_add_token: No token-string/function-name provided!\n\n'
2335 GRML_theme_add_token_usage
2340 if (( ARGC != 0 && ARGC != 2 )); then
2342 grml_theme_add_token: <pre> and <post> need to by specified _both_!\n\n'
2343 GRML_theme_add_token_usage
2352 if grml_theme_has_token $name; then
2354 grml_theme_add_token: Token `%s'\'' exists! Giving up!\n\n' $name
2355 GRML_theme_add_token_usage
2363 grml_prompt_pre_default[$name]=$pre
2364 grml_prompt_post_default[$name]=$post
2365 if (( funcall )); then
2366 grml_prompt_token_function[$name]=$token
2367 grml_prompt_token_default[$name]=23
2369 grml_prompt_token_default[$name]=$token
2373 function grml_wrap_reply () {
2380 if (( ${+parameters[$new]} )); then
2381 REPLY="${left}${(P)new}${right}"
2387 function grml_prompt_addto () {
2390 local lr it apre apost new v REPLY
2394 [[ $target == PS1 ]] && lr=left || lr=right
2395 zstyle -a ":prompt:${grmltheme}:${lr}:setup" items items || items=( "$@" )
2396 typeset -g "${target}="
2397 for it in "${items[@]}"; do
2398 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" pre apre \
2399 || apre=${grml_prompt_pre_default[$it]}
2400 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" post apost \
2401 || apost=${grml_prompt_post_default[$it]}
2402 zstyle -s ":prompt:${grmltheme}:${lr}:items:$it" token new \
2403 || new=${grml_prompt_token_default[$it]}
2404 if (( ${+grml_prompt_token_function[$it]} )); then
2406 ${grml_prompt_token_function[$it]} $it
2410 grml_wrap_reply $target $new '' ''
2413 grml_wrap_reply $target $new '(' ')'
2416 if [[ -n ${(P)new} ]]; then
2423 v="vcs_info_msg_${new}_"
2424 if (( ! vcscalled )); then
2428 if (( ${+parameters[$v]} )) && [[ -n "${(P)v}" ]]; then
2437 # Strip volatile characters per item. This is off by default. See the
2438 # global stripping code a few lines below for details.
2439 if [[ -o prompt_subst ]] && zstyle -t ":prompt:${grmltheme}:${lr}:items:$it" \
2440 strip-sensitive-characters
2442 REPLY="${REPLY//[$\`]/}"
2444 typeset -g "${target}=${(P)target}${apre}${REPLY}${apost}"
2447 # Per default, strip volatile characters (in the prompt_subst case)
2448 # globally. If the option is off, the style has no effect. For more
2449 # control, this can be turned off and stripping can be configured on a
2450 # per-item basis (see above).
2451 if [[ -o prompt_subst ]] && zstyle -T ":prompt:${grmltheme}:${lr}:setup" \
2452 strip-sensitive-characters
2454 typeset -g "${target}=${${(P)target}//[$\`]/}"
2458 function prompt_grml_precmd () {
2460 local grmltheme=grml
2461 local -a left_items right_items
2462 left_items=(rc change-root user at host path vcs percent)
2463 right_items=(sad-smiley)
2465 prompt_grml_precmd_worker
2468 function prompt_grml-chroot_precmd () {
2470 local grmltheme=grml-chroot
2471 local -a left_items right_items
2472 left_items=(grml-chroot user at host path percent)
2475 prompt_grml_precmd_worker
2478 function prompt_grml-large_precmd () {
2480 local grmltheme=grml-large
2481 local -a left_items right_items
2482 left_items=(rc jobs history shell-level change-root time date newline
2483 user at host path vcs percent)
2484 right_items=(sad-smiley)
2486 prompt_grml_precmd_worker
2489 function prompt_grml_precmd_worker () {
2491 local -i vcscalled=0
2493 grml_prompt_addto PS1 "${left_items[@]}"
2494 if zstyle -T ":prompt:${grmltheme}:right:setup" use-rprompt; then
2495 grml_prompt_addto RPS1 "${right_items[@]}"
2499 function grml_prompt_fallback () {
2503 p0="${RED}%(?..%? )${WHITE}${debian_chroot:+($debian_chroot)}"
2504 p1="${BLUE}%n${NO_COLOR}@%m %40<...<%B%~%b%<< "'${vcs_info_msg_0_}'"%# "
2505 if (( EUID == 0 )); then
2506 PROMPT="${BLUE}${p0}${RED}${p1}"
2508 PROMPT="${RED}${p0}${BLUE}${p1}"
2512 if zrcautoload promptinit && promptinit 2>/dev/null ; then
2513 grml_status_feature promptinit 0
2514 # Since we define the required functions in here and not in files in
2515 # $fpath, we need to stick the theme's name into `$prompt_themes'
2516 # ourselves, since promptinit does not pick them up otherwise.
2517 prompt_themes+=( grml grml-chroot grml-large )
2518 # Also, keep the array sorted...
2519 prompt_themes=( "${(@on)prompt_themes}" )
2521 grml_status_feature promptinit 1
2522 grml_prompt_fallback
2523 function precmd () { (( ${+functions[vcs_info]} )) && vcs_info; }
2527 # The prompt themes use modern features of zsh, that require at least
2528 # version 4.3.7 of the shell. Use the fallback otherwise.
2529 if [[ $GRML_DISPLAY_BATTERY -gt 0 ]]; then
2530 zstyle ':prompt:grml:right:setup' items sad-smiley battery
2531 add-zsh-hook precmd battery
2533 if [[ "$TERM" == dumb ]] ; then
2534 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" pre ''
2535 zstyle ":prompt:grml(|-large|-chroot):*:items:grml-chroot" post ' '
2536 for i in rc user path jobs history date time shell-level; do
2537 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" pre ''
2538 zstyle ":prompt:grml(|-large|-chroot):*:items:$i" post ''
2541 zstyle ':prompt:grml(|-large|-chroot):right:setup' use-rprompt false
2542 elif (( EUID == 0 )); then
2543 zstyle ':prompt:grml(|-large|-chroot):*:items:user' pre '%B%F{red}'
2546 # Finally enable one of the prompts.
2547 if [[ -n $GRML_CHROOT ]]; then
2549 elif [[ $GRMLPROMPT -gt 0 ]]; then
2555 grml_prompt_fallback
2556 function precmd () { (( ${+functions[vcs_info]} )) && vcs_info; }
2559 # make sure to use right prompt only when not running a command
2560 is41 && setopt transient_rprompt
2562 # Terminal-title wizardry
2564 function ESC_print () {
2565 info_print $'\ek' $'\e\\' "$@"
2567 function set_title () {
2568 info_print $'\e]0;' $'\a' "$@"
2571 function info_print () {
2572 local esc_begin esc_end
2576 printf '%s' ${esc_begin}
2578 printf '%s' "${esc_end}"
2581 function grml_reset_screen_title () {
2582 # adjust title of xterm
2583 # see http://www.faqs.org/docs/Linux-mini/Xterm-Title.html
2584 [[ ${NOTITLE:-} -gt 0 ]] && return 0
2586 (xterm*|rxvt*|alacritty)
2587 set_title ${(%):-"%n@%m: %~"}
2592 function grml_vcs_to_screen_title () {
2593 if [[ $TERM == screen* ]] ; then
2594 if [[ -n ${vcs_info_msg_1_} ]] ; then
2595 ESC_print ${vcs_info_msg_1_}
2602 function grml_maintain_name () {
2604 localname="$(uname -n)"
2606 # set hostname if not running on local machine
2607 if [[ -n "$HOSTNAME" ]] && [[ "$HOSTNAME" != "${localname}" ]] ; then
2612 function grml_cmd_to_screen_title () {
2613 # get the name of the program currently running and hostname of local
2614 # machine set screen window title if running in a screen
2615 if [[ "$TERM" == screen* ]] ; then
2616 local CMD="${1[(wr)^(*=*|sudo|ssh|-*)]}$NAME"
2621 function grml_control_xterm_title () {
2623 (xterm*|rxvt*|alacritty)
2624 set_title "${(%):-"%n@%m:"}" "$2"
2629 # The following autoload is disabled for now, since this setup includes a
2630 # static version of the ‘add-zsh-hook’ function above. It needs to be
2631 # re-enabled as soon as that static definition is removed again.
2632 #zrcautoload add-zsh-hook || add-zsh-hook () { :; }
2633 if [[ $NOPRECMD -eq 0 ]]; then
2634 add-zsh-hook precmd grml_reset_screen_title
2635 add-zsh-hook precmd grml_vcs_to_screen_title
2636 add-zsh-hook preexec grml_maintain_name
2637 add-zsh-hook preexec grml_cmd_to_screen_title
2638 if [[ $NOTITLE -eq 0 ]]; then
2639 add-zsh-hook preexec grml_control_xterm_title
2643 # 'hash' some often used directories
2645 hash -d deb=/var/cache/apt/archives
2646 hash -d doc=/usr/share/doc
2647 hash -d linux=/lib/modules/$(command uname -r)/build/
2648 hash -d log=/var/log
2649 hash -d slog=/var/log/syslog
2650 hash -d src=/usr/src
2651 hash -d www=/var/www
2655 if check_com -c screen ; then
2656 if [[ $UID -eq 0 ]] ; then
2657 if [[ -r /etc/grml/screenrc ]]; then
2658 alias screen='screen -c /etc/grml/screenrc'
2660 elif [[ ! -r $HOME/.screenrc ]] ; then
2661 if [[ -r /etc/grml/screenrc_grml ]]; then
2662 alias screen='screen -c /etc/grml/screenrc_grml'
2664 if [[ -r /etc/grml/screenrc ]]; then
2665 alias screen='screen -c /etc/grml/screenrc'
2671 # do we have GNU ls with color-support?
2672 if [[ "$TERM" != dumb ]]; then
2673 #a1# List files with colors (\kbd{ls \ldots})
2674 alias ls="command ls ${ls_options:+${ls_options[*]}}"
2675 #a1# List all files, with colors (\kbd{ls -la \ldots})
2676 alias la="command ls -la ${ls_options:+${ls_options[*]}}"
2677 #a1# List files with long colored list, without dotfiles (\kbd{ls -l \ldots})
2678 alias ll="command ls -l ${ls_options:+${ls_options[*]}}"
2679 #a1# List files with long colored list, human readable sizes (\kbd{ls -hAl \ldots})
2680 alias lh="command ls -hAl ${ls_options:+${ls_options[*]}}"
2681 #a1# List files with long colored list, append qualifier to filenames (\kbd{ls -l \ldots})\\&\quad(\kbd{/} for directories, \kbd{@} for symlinks ...)
2682 alias l="command ls -l ${ls_options:+${ls_options[*]}}"
2684 alias la='command ls -la'
2685 alias ll='command ls -l'
2686 alias lh='command ls -hAl'
2687 alias l='command ls -l'
2690 if [[ -r /proc/mdstat ]]; then
2691 alias mdstat='cat /proc/mdstat'
2694 alias ...='cd ../../'
2696 # generate alias named "$KERNELVERSION-reboot" so you can use boot with kexec:
2697 if [[ -x /sbin/kexec ]] && [[ -r /proc/cmdline ]] ; then
2698 alias "$(uname -r)-reboot"="kexec -l --initrd=/boot/initrd.img-"$(uname -r)" --command-line=\"$(cat /proc/cmdline)\" /boot/vmlinuz-"$(uname -r)""
2701 # see http://www.cl.cam.ac.uk/~mgk25/unicode.html#term for details
2702 alias term2iso="echo 'Setting terminal to iso mode' ; print -n '\e%@'"
2703 alias term2utf="echo 'Setting terminal to utf-8 mode'; print -n '\e%G'"
2705 # make sure it is not assigned yet
2706 [[ -n ${aliases[utf2iso]} ]] && unalias utf2iso
2707 function utf2iso () {
2710 for ENV in $(env | command grep -i '.utf') ; do
2711 eval export "$(echo $ENV | sed 's/UTF-8/iso885915/ ; s/utf8/iso885915/')"
2716 # make sure it is not assigned yet
2717 [[ -n ${aliases[iso2utf]} ]] && unalias iso2utf
2718 function iso2utf () {
2719 if ! isutfenv ; then
2721 for ENV in $(env | command grep -i '\.iso') ; do
2722 eval export "$(echo $ENV | sed 's/iso.*/UTF-8/ ; s/ISO.*/UTF-8/')"
2727 # especially for roadwarriors using GNU screen and ssh:
2728 if ! check_com asc &>/dev/null ; then
2729 function asc () { autossh -t "$@" 'screen -RdU' }
2733 #f1# Hints for the use of zsh on grml
2734 function zsh-help () {
2735 print "$bg[white]$fg[black]
2736 zsh-help - hints for use of zsh on grml
2737 =======================================$reset_color"
2740 Main configuration of zsh happens in /etc/zsh/zshrc.
2741 That file is part of the package grml-etc-core, if you want to
2742 use them on a non-grml-system just get the tar.gz from
2743 http://deb.grml.org/ or (preferably) get it from the git repository:
2745 http://git.grml.org/f/grml-etc-core/etc/zsh/zshrc
2747 This version of grml'\''s zsh setup does not use skel/.zshrc anymore.
2748 The file is still there, but it is empty for backwards compatibility.
2750 For your own changes use these two files:
2754 The former is sourced very early in our zshrc, the latter is sourced
2757 System wide configuration without touching configuration files of grml
2758 can take place in /etc/zsh/zshrc.local.
2760 For information regarding zsh start at http://grml.org/zsh/
2762 Take a look at grml'\''s zsh refcard:
2763 % xpdf =(zcat /usr/share/doc/grml-docs/zsh/grml-zsh-refcard.pdf.gz)
2765 Check out the main zsh refcard:
2766 % '$BROWSER' http://www.bash2zsh.com/zsh_refcard/refcard.pdf
2768 And of course visit the zsh-lovers:
2771 You can adjust some options through environment variables when
2772 invoking zsh without having to edit configuration files.
2773 Basically meant for bash users who are not used to the power of
2776 "NOCOR=1 zsh" => deactivate automatic correction
2777 "NOMENU=1 zsh" => do not use auto menu completion
2778 (note: use ctrl-d for completion instead!)
2779 "NOPRECMD=1 zsh" => disable the precmd + preexec commands (set GNU screen title)
2780 "NOTITLE=1 zsh" => disable setting the title of xterms without disabling
2781 preexec() and precmd() completely
2782 "GRML_DISPLAY_BATTERY=1 zsh"
2783 => activate battery status on right side of prompt (WIP)
2784 "COMMAND_NOT_FOUND=1 zsh"
2785 => Enable a handler if an external command was not found
2786 The command called in the handler can be altered by setting
2787 the GRML_ZSH_CNF_HANDLER variable, the default is:
2788 "/usr/share/command-not-found/command-not-found"
2790 A value greater than 0 is enables a feature; a value equal to zero
2791 disables it. If you like one or the other of these settings, you can
2792 add them to ~/.zshrc.pre to ensure they are set when sourcing grml'\''s
2796 $bg[white]$fg[black]
2797 Please report wishes + bugs to the grml-team: http://grml.org/bugs/
2798 Enjoy your grml system with the zsh!$reset_color"
2802 if [[ -r /etc/debian_version ]] ; then
2803 if [[ -z "$GRML_NO_APT_ALIASES" ]]; then
2804 #a3# Execute \kbd{apt-cache policy}
2805 alias acp='apt-cache policy'
2806 if check_com -c apt ; then
2807 #a3# Execute \kbd{apt search}
2808 alias acs='apt search'
2809 #a3# Execute \kbd{apt show}
2810 alias acsh='apt show'
2811 #a3# Execute \kbd{apt dist-upgrade}
2812 salias adg="apt dist-upgrade"
2813 #a3# Execute \kbd{apt upgrade}
2814 salias ag="apt upgrade"
2815 #a3# Execute \kbd{apt install}
2816 salias agi="apt install"
2817 #a3# Execute \kbd{apt update}
2818 salias au="apt update"
2820 alias acs='apt-cache search'
2821 alias acsh='apt-cache show'
2822 salias adg="apt-get dist-upgrade"
2823 salias ag="apt-get upgrade"
2824 salias agi="apt-get install"
2825 salias au="apt-get update"
2827 #a3# Execute \kbd{aptitude install}
2828 salias ati="aptitude install"
2829 #a3# Execute \kbd{aptitude update ; aptitude safe-upgrade}
2830 salias -a up="aptitude update ; aptitude safe-upgrade"
2831 #a3# Execute \kbd{dpkg-buildpackage}
2832 alias dbp='dpkg-buildpackage'
2833 #a3# Execute \kbd{grep-excuses}
2834 alias ge='grep-excuses'
2837 # get a root shell as normal user in live-cd mode:
2838 if isgrmlcd && [[ $UID -ne 0 ]] ; then
2844 # use /var/log/syslog iff present, fallback to journalctl otherwise
2845 if [ -e /var/log/syslog ] ; then
2846 #a1# Take a look at the syslog: \kbd{\$PAGER /var/log/syslog || journalctl}
2847 salias llog="$PAGER /var/log/syslog" # take a look at the syslog
2848 #a1# Take a look at the syslog: \kbd{tail -f /var/log/syslog || journalctl}
2849 salias tlog="tail -f /var/log/syslog" # follow the syslog
2850 elif check_com -c journalctl ; then
2851 salias llog="journalctl"
2852 salias tlog="journalctl -f"
2855 # sort installed Debian-packages by size
2856 if check_com -c dpkg-query ; then
2857 #a3# List installed Debian-packages sorted by size
2858 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"
2861 # if cdrecord is a symlink (to wodim) or isn't present at all warn:
2862 if [[ -L /usr/bin/cdrecord ]] || ! check_com -c cdrecord; then
2863 if check_com -c wodim; then
2864 function cdrecord () {
2866 cdrecord is not provided under its original name by Debian anymore.
2867 See #377109 in the BTS of Debian for more details.
2869 Please use the wodim binary instead
2877 # No core dumps: important for a live-cd-system
2882 function grmlstuff () {
2883 # people should use 'grml-x'!
2884 if check_com -c 915resolution; then
2885 function 855resolution () {
2886 echo "Please use 915resolution as resolution modifying tool for Intel \
2892 #a1# Output version of running grml
2893 alias grml-version='cat /etc/grml_version'
2895 if check_com -c grml-debootstrap ; then
2896 function debian2hd () {
2897 echo "Installing debian to harddisk is possible by using grml-debootstrap."
2902 if check_com -c tmate && check_com -c qrencode ; then
2903 function grml-remote-support() {
2904 tmate -L grml-remote-support new -s grml-remote-support -d
2905 tmate -L grml-remote-support wait tmate-ready
2906 tmate -L grml-remote-support display -p '#{tmate_ssh}' | qrencode -t ANSI
2907 echo "tmate session: $(tmate -L grml-remote-support display -p '#{tmate_ssh}')"
2909 echo "Scan this QR code and send it to your support team."
2914 # now run the functions
2916 is4 && isgrml && grmlstuff
2920 is4 && xsource "/etc/zsh/keephack"
2922 # wonderful idea of using "e" glob qualifier by Peter Stephenson
2923 # You use it as follows:
2924 # $ NTREF=/reference/file
2926 # This lists all the files in the current directory newer than the reference file.
2927 # You can also specify the reference file inline; note quotes:
2928 # $ ls -l *(e:'nt ~/.zshenv':)
2929 is4 && function nt () {
2930 if [[ -n $1 ]] ; then
2933 [[ $REPLY -nt $NTREF ]]
2938 #f1# Reload an autoloadable function
2939 function freload () { while (( $# )); do; unfunction $1; autoload -U $1; shift; done }
2940 compdef _functions freload
2945 # e.g.: a -> b -> c -> d ....
2950 # if parameter is given with leading '=', lookup $PATH for parameter and resolve that
2954 # Note: limit for recursive symlinks on linux:
2955 # http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/fs/namei.c?id=refs/heads/master#l808
2956 # This limits recursive symlink follows to 8,
2957 # while limiting consecutive symlinks to 40.
2959 # When resolving and displaying information about symlinks, no check is made
2960 # that the displayed information does make any sense on your OS.
2961 # We leave that decission to the user.
2963 # The zstat module is used to detect symlink loops. zstat is available since zsh4.
2964 # With an older zsh you will need to abort with <C-c> in that case.
2965 # When a symlink loop is detected, a warning ist printed and further processing is stopped.
2967 # Module zstat is loaded by default in grml zshrc, no extra action needed for that.
2970 # If you happen to come across a symlink that points to a destination on another partition
2971 # with the same inode number, that will be marked as symlink loop though it is not.
2972 # Two hints for this situation:
2973 # I) Play lottery the same day, as you seem to be rather lucky right now.
2978 # 1 file/dir not accesible
2979 # 2 symlink loop detected
2981 #f1# List symlinks in detail (more detailed version of 'readlink -f', 'whence -s' and 'namei -l')
2983 if [[ -z ${1} ]] ; then
2984 printf 'Usage: %s <symlink(s)>\n' "${0}"
2988 local file jumpd curdir
2989 local -i 10 RTN LINODE i
2994 for file in "${@}" ; do
2996 ls -l "${file:a}" || RTN=1
2998 while [[ -h "$file" ]] ; do
3000 LINODE=$(zstat -L +inode "${file}")
3001 for i in ${SEENINODES} ; do
3002 if (( ${i} == ${LINODE} )) ; then
3003 builtin cd -q "${curdir}"
3004 print 'link loop detected, aborting!'
3008 SEENINODES+=${LINODE}
3013 if [[ -d ${jumpd} ]] ; then
3014 builtin cd -q "${jumpd}" || RTN=1
3016 file=$(readlink "$file")
3021 if [[ -d ${jumpd} ]] ; then
3022 builtin cd -q "${jumpd}" || RTN=1
3025 ls -l "${PWD}/${file}" || RTN=1
3028 if (( ${#} >= 1 )) ; then
3031 builtin cd -q "${curdir}"
3036 if check_com -c $PAGER ; then
3037 #f3# View Debian's changelog of given package(s)
3038 function dchange () {
3040 [[ -z "$1" ]] && printf 'Usage: %s <package_name(s)>\n' "$0" && return 1
3044 # `less` as $PAGER without e.g. `|lesspipe %s` inside $LESSOPEN can't properly
3045 # read *.gz files, try to detect this to use vi instead iff available
3048 if [[ ${$(typeset -p PAGER)[2]} = -a ]] ; then
3049 viewer=($PAGER) # support PAGER=(less -Mr) but leave array untouched
3051 viewer=(${=PAGER}) # support PAGER='less -Mr'
3054 if [[ ${viewer[1]:t} = less ]] && [[ -z "${LESSOPEN}" ]] && check_com vi ; then
3058 for package in "$@" ; do
3059 if [[ -r /usr/share/doc/${package}/changelog.Debian.gz ]] ; then
3060 $viewer /usr/share/doc/${package}/changelog.Debian.gz
3061 elif [[ -r /usr/share/doc/${package}/changelog.gz ]] ; then
3062 $viewer /usr/share/doc/${package}/changelog.gz
3063 elif [[ -r /usr/share/doc/${package}/changelog ]] ; then
3064 $viewer /usr/share/doc/${package}/changelog
3066 if check_com -c aptitude ; then
3067 echo "No changelog for package $package found, using aptitude to retrieve it."
3068 aptitude changelog "$package"
3069 elif check_com -c apt-get ; then
3070 echo "No changelog for package $package found, using apt-get to retrieve it."
3071 apt-get changelog "$package"
3073 echo "No changelog for package $package found, sorry."
3078 function _dchange () { _files -W /usr/share/doc -/ }
3079 compdef _dchange dchange
3081 #f3# View Debian's NEWS of a given package
3084 if [[ -r /usr/share/doc/$1/NEWS.Debian.gz ]] ; then
3085 $PAGER /usr/share/doc/$1/NEWS.Debian.gz
3087 if [[ -r /usr/share/doc/$1/NEWS.gz ]] ; then
3088 $PAGER /usr/share/doc/$1/NEWS.gz
3090 echo "No NEWS file for package $1 found, sorry."
3095 function _dnews () { _files -W /usr/share/doc -/ }
3096 compdef _dnews dnews
3098 #f3# View Debian's copyright of a given package
3099 function dcopyright () {
3101 if [[ -r /usr/share/doc/$1/copyright ]] ; then
3102 $PAGER /usr/share/doc/$1/copyright
3104 echo "No copyright file for package $1 found, sorry."
3108 function _dcopyright () { _files -W /usr/share/doc -/ }
3109 compdef _dcopyright dcopyright
3111 #f3# View upstream's changelog of a given package
3112 function uchange () {
3114 if [[ -r /usr/share/doc/$1/changelog.gz ]] ; then
3115 $PAGER /usr/share/doc/$1/changelog.gz
3117 echo "No changelog for package $1 found, sorry."
3121 function _uchange () { _files -W /usr/share/doc -/ }
3122 compdef _uchange uchange
3126 function profile () {
3127 ZSH_PROFILE_RC=1 zsh "$@"
3130 #f1# Edit an alias via zle
3131 function edalias () {
3132 [[ -z "$1" ]] && { echo "Usage: edalias <alias_to_edit>" ; return 1 } || vared aliases'[$1]' ;
3134 compdef _aliases edalias
3136 #f1# Edit a function via zle
3137 function edfunc () {
3138 [[ -z "$1" ]] && { echo "Usage: edfunc <function_to_edit>" ; return 1 } || zed -f "$1" ;
3140 compdef _functions edfunc
3142 # use it e.g. via 'Restart apache2'
3143 #m# f6 Start() \kbd{service \em{process}}\quad\kbd{start}
3144 #m# f6 Restart() \kbd{service \em{process}}\quad\kbd{restart}
3145 #m# f6 Stop() \kbd{service \em{process}}\quad\kbd{stop}
3146 #m# f6 Reload() \kbd{service \em{process}}\quad\kbd{reload}
3147 #m# f6 Force-Reload() \kbd{service \em{process}}\quad\kbd{force-reload}
3148 #m# f6 Status() \kbd{service \em{process}}\quad\kbd{status}
3149 if [[ -d /etc/init.d || -d /etc/service ]] ; then
3150 function __start_stop () {
3151 local action_="${1:l}" # e.g Start/Stop/Restart
3155 local service_target_="$(readlink /etc/init.d/$service_)"
3156 if [[ $service_target_ == "/usr/bin/sv" ]]; then
3158 case "${action_}" in
3159 start) if [[ ! -e /etc/service/$service_ ]]; then
3160 $SUDO ln -s "/etc/sv/$service_" "/etc/service/"
3162 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
3164 # there is no reload in runits sysv emulation
3165 reload) $SUDO "/etc/init.d/$service_" "force-reload" "$param_" ;;
3166 *) $SUDO "/etc/init.d/$service_" "${action_}" "$param_" ;;
3169 # sysv/sysvinit-utils, upstart
3170 if check_com -c service ; then
3171 $SUDO service "$service_" "${action_}" "$param_"
3173 $SUDO "/etc/init.d/$service_" "${action_}" "$param_"
3178 function _grmlinitd () {
3180 scripts=( /etc/init.d/*(x:t) )
3181 _describe "service startup script" scripts
3184 for i in Start Restart Stop Force-Reload Reload Status ; do
3185 eval "function $i () { __start_stop $i \"\$1\" \"\$2\" ; }"
3186 compdef _grmlinitd $i
3191 #f1# Provides useful information on globbing
3192 function H-Glob () {
3198 p named pipes (FIFOs)
3199 * executable plain files (0100)
3200 % device files (character or block special)
3201 %b block special files
3202 %c character special files
3203 r owner-readable files (0400)
3204 w owner-writable files (0200)
3205 x owner-executable files (0100)
3206 A group-readable files (0040)
3207 I group-writable files (0020)
3208 E group-executable files (0010)
3209 R world-readable files (0004)
3210 W world-writable files (0002)
3211 X world-executable files (0001)
3212 s setuid files (04000)
3213 S setgid files (02000)
3214 t files with the sticky bit (01000)
3216 print *(m-1) # Files modified up to a day ago
3217 print *(a1) # Files accessed a day ago
3218 print *(@) # Just symlinks
3219 print *(Lk+50) # Files bigger than 50 kilobytes
3220 print *(Lk-50) # Files smaller than 50 kilobytes
3221 print **/*.c # All *.c files recursively starting in \$PWD
3222 print **/*.c~file.c # Same as above, but excluding 'file.c'
3223 print (foo|bar).* # Files starting with 'foo' or 'bar'
3224 print *~*.* # All Files that do not contain a dot
3225 chmod 644 *(.^x) # make all plain non-executable files publically readable
3226 print -l *(.c|.h) # Lists *.c and *.h
3227 print **/*(g:users:) # Recursively match all files that are owned by group 'users'
3228 echo /proc/*/cwd(:h:t:s/self//) # Analogous to >ps ax | awk '{print $1}'<"
3230 alias help-zshglob=H-Glob
3232 # grep for running process, like: 'any vim'
3236 if [[ -z "$1" ]] ; then
3237 echo "any - grep for process(es) by keyword" >&2
3238 echo "Usage: any <keyword>" >&2 ; return 1
3240 ps xauwww | grep -i "${grep_options[@]}" "[${1[1]}]${1[2,-1]}"
3245 # After resuming from suspend, system is paging heavily, leading to very bad interactivity.
3246 # taken from $LINUX-KERNELSOURCE/Documentation/power/swsusp.txt
3247 [[ -r /proc/1/maps ]] && \
3248 function deswap () {
3249 print 'Reading /proc/[0-9]*/maps and sending output to /dev/null, this might take a while.'
3250 cat $(sed -ne 's:.* /:/:p' /proc/[0-9]*/maps | sort -u | grep -v '^/dev/') > /dev/null
3251 print 'Finished, running "swapoff -a; swapon -a" may also be useful.'
3254 # a wrapper for vim, that deals with title setting
3256 # set this array to a set of options to vim you always want
3257 # to have set when calling vim (in .zshrc.local), like:
3258 # VIM_OPTIONS=( -p )
3259 # This will cause vim to send every file given on the
3260 # commandline to be send to it's own tab (needs vim7).
3261 if check_com vim; then
3263 VIM_PLEASE_SET_TITLE='yes' command vim ${VIM_OPTIONS} "$@"
3267 ssl_hashes=( sha512 sha256 sha1 md5 )
3269 for sh in ${ssl_hashes}; do
3270 eval 'ssl-cert-'${sh}'() {
3272 if [[ -z $1 ]] ; then
3273 printf '\''usage: %s <file>\n'\'' "ssh-cert-'${sh}'"
3276 openssl x509 -noout -fingerprint -'${sh}' -in $1
3280 function ssl-cert-fingerprints () {
3283 if [[ -z $1 ]] ; then
3284 printf 'usage: ssl-cert-fingerprints <file>\n'
3287 for i in ${ssl_hashes}
3292 function ssl-cert-info () {
3294 if [[ -z $1 ]] ; then
3295 printf 'usage: ssl-cert-info <file>\n'
3298 openssl x509 -noout -text -in $1
3299 ssl-cert-fingerprints $1
3302 # make sure our environment is clean regarding colors
3303 builtin unset -v BLUE RED GREEN CYAN YELLOW MAGENTA WHITE NO_COLOR
3305 # "persistent history"
3306 # just write important commands you always need to $GRML_IMPORTANT_COMMANDS
3307 # defaults for backward compatibility to ~/.important_commands
3308 if [[ -r ~/.important_commands ]] ; then
3309 GRML_IMPORTANT_COMMANDS=~/.important_commands
3311 GRML_IMPORTANT_COMMANDS=${GRML_IMPORTANT_COMMANDS:-${ZDOTDIR:-${HOME}}/.important_commands}
3313 [[ -r ${GRML_IMPORTANT_COMMANDS} ]] && builtin fc -R ${GRML_IMPORTANT_COMMANDS}
3315 # load the lookup subsystem if it's available on the system
3316 zrcautoload lookupinit && lookupinit
3320 # set terminal property (used e.g. by msgid-chooser)
3321 export COLORTERM="yes"
3326 #a2# Execute \kbd{du -sch}
3327 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias da='du -sch'
3330 #a2# Execute \kbd{ls -lSrah}
3331 alias dir="command ls -lSrah"
3332 #a2# Only show dot-directories
3333 alias lad='command ls -d .*(/)'
3334 #a2# Only show dot-files
3335 alias lsa='command ls -a .*(.)'
3336 #a2# Only files with setgid/setuid/sticky flag
3337 alias lss='command ls -l *(s,S,t)'
3338 #a2# Only show symlinks
3339 alias lsl='command ls -l *(@)'
3340 #a2# Display only executables
3341 alias lsx='command ls -l *(*)'
3342 #a2# Display world-{readable,writable,executable} files
3343 alias lsw='command ls -ld *(R,W,X.^ND/)'
3344 #a2# Display the ten biggest files
3345 alias lsbig="command ls -flh *(.OL[1,10])"
3346 #a2# Only show directories
3347 alias lsd='command ls -d *(/)'
3348 #a2# Only show empty directories
3349 alias lse='command ls -d *(/^F)'
3350 #a2# Display the ten newest files
3351 alias lsnew="command ls -rtlh *(D.om[1,10])"
3352 #a2# Display the ten oldest files
3353 alias lsold="command ls -rtlh *(D.Om[1,10])"
3354 #a2# Display the ten smallest files
3355 alias lssmall="command ls -Srl *(.oL[1,10])"
3356 #a2# Display the ten newest directories and ten newest .directories
3357 alias lsnewdir="command ls -rthdl *(/om[1,10]) .*(D/om[1,10])"
3358 #a2# Display the ten oldest directories and ten oldest .directories
3359 alias lsolddir="command ls -rthdl *(/Om[1,10]) .*(D/Om[1,10])"
3361 # some useful aliases
3362 #a2# Remove current empty directory. Execute \kbd{cd ..; rmdir \$OLDCWD}
3363 alias rmcdir='cd ..; rmdir $OLDPWD || cd $OLDPWD'
3365 #a2# ssh with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3366 alias insecssh='ssh -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3367 #a2# scp with StrictHostKeyChecking=no \\&\quad and UserKnownHostsFile unset
3368 alias insecscp='scp -o "StrictHostKeyChecking=no" -o "UserKnownHostsFile=/dev/null"'
3370 # work around non utf8 capable software in utf environment via $LANG and luit
3371 if check_com isutfenv && check_com luit ; then
3372 if check_com -c mrxvt ; then
3373 isutfenv && [[ -n "$LANG" ]] && \
3374 alias mrxvt="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit mrxvt"
3377 if check_com -c aterm ; then
3378 isutfenv && [[ -n "$LANG" ]] && \
3379 alias aterm="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit aterm"
3382 if check_com -c centericq ; then
3383 isutfenv && [[ -n "$LANG" ]] && \
3384 alias centericq="LANG=${LANG/(#b)(*)[.@]*/$match[1].iso885915} luit centericq"
3390 #f5# Backup \kbd{file_or_folder {\rm to} file_or_folder\_timestamp}
3393 local current_date=$(date -u "+%Y%m%dT%H%M%SZ")
3394 local clean keep move verbose result all to_bk
3395 setopt extended_glob
3397 while getopts ":hacmrv" opt; do
3400 c) unset move clean && (( ++keep ));;
3401 m) unset keep clean && (( ++move ));;
3402 r) unset move keep && (( ++clean ));;
3405 bk [-hcmv] FILE [FILE ...]
3406 bk -r [-av] [FILE [FILE ...]]
3407 Backup a file or folder in place and append the timestamp
3408 Remove backups of a file or folder, or all backups in the current directory
3411 -h Display this help text
3412 -c Keep the file/folder as is, create a copy backup using cp(1) (default)
3413 -m Move the file/folder, using mv(1)
3414 -r Remove backups of the specified file or directory, using rm(1). If none
3415 is provided, remove all backups in the current directory.
3416 -a Remove all (even hidden) backups.
3419 The -c, -r and -m options are mutually exclusive. If specified at the same time,
3420 the last one is used.
3422 The return code is the sum of all cp/mv/rm return codes.
3425 \?) bk -h >&2; return 1;;
3428 shift "$((OPTIND-1))"
3429 if (( keep > 0 )); then
3430 if islinux || isfreebsd; then
3431 for to_bk in "$@"; do
3432 cp $verbose -a "${to_bk%/}" "${to_bk%/}_$current_date"
3436 for to_bk in "$@"; do
3437 cp $verbose -pR "${to_bk%/}" "${to_bk%/}_$current_date"
3441 elif (( move > 0 )); then
3442 while (( $# > 0 )); do
3443 mv $verbose "${1%/}" "${1%/}_$current_date"
3447 elif (( clean > 0 )); then
3448 if (( $# > 0 )); then
3449 for to_bk in "$@"; do
3450 rm $verbose -rf "${to_bk%/}"_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z
3454 if (( all > 0 )); then
3455 rm $verbose -rf *_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z(D)
3457 rm $verbose -rf *_[0-9](#c8)T([0-1][0-9]|2[0-3])([0-5][0-9])(#c2)Z
3465 #f5# cd to directory and list files
3471 # smart cd function, allows switching to /etc when running 'cd /etc/fstab'
3473 if (( ${#argv} == 1 )) && [[ -f ${1} ]]; then
3474 [[ ! -e ${1:h} ]] && return 1
3475 print "Correcting ${1} to ${1:h}"
3482 #f5# Create Directory and \kbd{cd} to it
3484 if (( ARGC != 1 )); then
3485 printf 'usage: mkcd <new-directory>\n'
3488 if [[ ! -d "$1" ]]; then
3489 command mkdir -p "$1"
3491 printf '`%s'\'' already exists: cd-ing.\n' "$1"
3496 #f5# Create temporary directory and \kbd{cd} to it
3498 builtin cd "$(mktemp -d)"
3502 #f5# List files which have been accessed within the last {\it n} days, {\it n} defaults to 1
3503 function accessed () {
3505 print -l -- *(a-${1:-1})
3508 #f5# List files which have been changed within the last {\it n} days, {\it n} defaults to 1
3509 function changed () {
3511 print -l -- *(c-${1:-1})
3514 #f5# List files which have been modified within the last {\it n} days, {\it n} defaults to 1
3515 function modified () {
3517 print -l -- *(m-${1:-1})
3519 # modified() was named new() in earlier versions, add an alias for backwards compatibility
3520 check_com new || alias new=modified
3522 # use colors when GNU grep with color-support
3523 if (( $#grep_options > 0 )); then
3524 o=${grep_options:+"${grep_options[*]}"}
3525 #a2# Execute \kbd{grep -{}-color=auto}
3526 alias grep='grep '$o
3527 alias egrep='egrep '$o
3532 # 'translate' looks up a word in a file with language-to-language
3533 # translations (field separator should be " : "). A typical wordlist looks
3534 # like the following:
3535 # | english-word : german-translation
3536 # It's also only possible to translate english to german but not reciprocal.
3537 # Use the following oneliner to reverse the sort order:
3538 # $ awk -F ':' '{ print $2" : "$1" "$3 }' \
3539 # /usr/local/lib/words/en-de.ISO-8859-1.vok > ~/.translate/de-en.ISO-8859-1.vok
3540 #f5# Translates a word
3545 translate -l de-en $2
3548 translate -l en-de $2
3551 echo "Usage: $0 { -D | -E }"
3552 echo " -D == German to English"
3553 echo " -E == English to German"
3557 # Usage: simple-extract <file>
3558 # Using option -d deletes the original archive file.
3559 #f5# Smart archive extractor
3560 function simple-extract () {
3562 setopt extended_glob noclobber
3563 local ARCHIVE DELETE_ORIGINAL DECOMP_CMD USES_STDIN USES_STDOUT GZTARGET WGET_CMD
3565 zparseopts -D -E "d=DELETE_ORIGINAL"
3566 for ARCHIVE in "${@}"; do
3568 *(tar.bz2|tbz2|tbz))
3569 DECOMP_CMD="tar -xvjf -"
3574 DECOMP_CMD="tar -xvzf -"
3578 *(tar.xz|txz|tar.lzma))
3579 DECOMP_CMD="tar -xvJf -"
3584 DECOMP_CMD="tar --zstd -xvf -"
3589 DECOMP_CMD="lrzuntar"
3594 DECOMP_CMD="tar -xvf -"
3599 DECOMP_CMD="unrar x"
3624 DECOMP_CMD="bzip2 -d -c -"
3629 DECOMP_CMD="gzip -d -c -"
3634 DECOMP_CMD="xz -d -c -"
3639 DECOMP_CMD="zstd -d -c -"
3644 DECOMP_CMD="lrunzip -"
3649 print "ERROR: '$ARCHIVE' has unrecognized archive type." >&2
3655 if ! check_com ${DECOMP_CMD[(w)1]}; then
3656 echo "ERROR: ${DECOMP_CMD[(w)1]} not installed." >&2
3661 GZTARGET="${ARCHIVE:t:r}"
3662 if [[ -f $ARCHIVE ]] ; then
3664 print "Extracting '$ARCHIVE' ..."
3665 if $USES_STDIN; then
3666 if $USES_STDOUT; then
3667 ${=DECOMP_CMD} < "$ARCHIVE" > $GZTARGET
3669 ${=DECOMP_CMD} < "$ARCHIVE"
3672 if $USES_STDOUT; then
3673 ${=DECOMP_CMD} "$ARCHIVE" > $GZTARGET
3675 ${=DECOMP_CMD} "$ARCHIVE"
3678 [[ $? -eq 0 && -n "$DELETE_ORIGINAL" ]] && rm -f "$ARCHIVE"
3680 elif [[ "$ARCHIVE" == (#s)(https|http|ftp)://* ]] ; then
3681 if check_com curl; then
3682 WGET_CMD="curl -L -s -o -"
3683 elif check_com wget; then
3684 WGET_CMD="wget -q -O -"
3685 elif check_com fetch; then
3686 WGET_CMD="fetch -q -o -"
3688 print "ERROR: neither wget, curl nor fetch is installed" >&2
3692 print "Downloading and Extracting '$ARCHIVE' ..."
3693 if $USES_STDIN; then
3694 if $USES_STDOUT; then
3695 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD} > $GZTARGET
3698 ${=WGET_CMD} "$ARCHIVE" | ${=DECOMP_CMD}
3702 if $USES_STDOUT; then
3703 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE") > $GZTARGET
3705 ${=DECOMP_CMD} =(${=WGET_CMD} "$ARCHIVE")
3710 print "ERROR: '$ARCHIVE' is neither a valid file nor a supported URI." >&2
3717 function __archive_or_uri () {
3719 '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)"' \
3720 '_urls:Remote Archives:_urls'
3723 function _simple_extract () {
3725 '-d[delete original archivefile after extraction]' \
3726 '*:Archive Or Uri:__archive_or_uri'
3728 compdef _simple_extract simple-extract
3729 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias se=simple-extract
3731 #f5# Change the xterm title from within GNU-screen
3732 function xtrename () {
3734 if [[ $1 != "-f" ]] ; then
3735 if [[ -z ${DISPLAY} ]] ; then
3736 printf 'xtrename only makes sense in X11.\n'
3742 if [[ -z $1 ]] ; then
3743 printf 'usage: xtrename [-f] "title for xterm"\n'
3744 printf ' renames the title of xterm from _within_ screen.\n'
3745 printf ' also works without screen.\n'
3746 printf ' will not work if DISPLAY is unset, use -f to override.\n'
3749 print -n "\eP\e]0;${1}\C-G\e\\"
3753 # Create small urls via http://goo.gl using curl(1).
3754 # API reference: https://code.google.com/apis/urlshortener/
3757 setopt extended_glob
3759 if [[ -z $1 ]]; then
3760 print "USAGE: zurl <URL>"
3764 local PN url prog api json contenttype item
3769 # Prepend 'http://' to given URL where necessary for later output.
3770 if [[ ${url} != http(s|)://* ]]; then
3774 if check_com -c curl; then
3777 print "curl is not available, but mandatory for ${PN}. Aborting."
3780 api='https://www.googleapis.com/urlshortener/v1/url'
3781 contenttype="Content-Type: application/json"
3782 json="{\"longUrl\": \"${url}\"}"
3783 data=(${(f)"$($prog --silent -H ${contenttype} -d ${json} $api)"})
3784 # Parse the response
3785 for item in "${data[@]}"; do
3790 printf '%s\n' "$item"
3798 #f2# Find history events by search pattern and list them by date.
3799 function whatwhen () {
3801 local usage help ident format_l format_s first_char remain first last
3802 usage='USAGE: whatwhen [options] <searchstring> <search range>'
3803 help='Use `whatwhen -h'\'' for further explanations.'
3804 ident=${(l,${#${:-Usage: }},, ,)}
3805 format_l="${ident}%s\t\t\t%s\n"
3806 format_s="${format_l//(\\t)##/\\t}"
3807 # Make the first char of the word to search for case
3808 # insensitive; e.g. [aA]
3809 first_char=[${(L)1[1]}${(U)1[1]}]
3811 # Default search range is `-100'.
3813 # Optional, just used for `<first> <last>' given.
3817 printf '%s\n\n' 'ERROR: No search string specified. Aborting.'
3818 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3821 printf '%s\n\n' ${usage}
3823 printf $format_l '-h' 'show help text'
3825 print 'SEARCH RANGE:'
3826 printf $format_l "'0'" 'the whole history,'
3827 printf $format_l '-<n>' 'offset to the current history number; (default: -100)'
3828 printf $format_s '<[-]first> [<last>]' 'just searching within a give range'
3829 printf '\n%s\n' 'EXAMPLES:'
3830 printf ${format_l/(\\t)/} 'whatwhen grml' '# Range is set to -100 by default.'
3831 printf $format_l 'whatwhen zsh -250'
3832 printf $format_l 'whatwhen foo 1 99'
3835 printf '%s\n%s\n\n' ${usage} ${help} && return 1
3838 # -l list results on stout rather than invoking $EDITOR.
3839 # -i Print dates as in YYYY-MM-DD.
3840 # -m Search for a - quoted - pattern within the history.
3841 fc -li -m "*${first_char}${remain}*" $first $last
3846 # mercurial related stuff
3847 if check_com -c hg ; then
3848 # gnu like diff for mercurial
3849 # http://www.selenic.com/mercurial/wiki/index.cgi/TipsAndTricks
3850 #f5# GNU like diff for mercurial
3854 for i in $(hg status -marn "$@") ; diff -ubwd <(hg cat "$i") "$i"
3857 # build debian package
3858 #a2# Alias for \kbd{hg-buildpackage}
3859 alias hbp='hg-buildpackage'
3861 # execute commands on the versioned patch-queue from the current repos
3862 [[ -n "$GRML_NO_SMALL_ALIASES" ]] || alias mq='hg -R $(readlink -f $(hg root)/.hg/patches)'
3864 # diffstat for specific version of a mercurial repository
3865 # hgstat => display diffstat between last revision and tip
3866 # hgstat 1234 => display diffstat between revision 1234 and tip
3867 #f5# Diffstat for specific version of a mercurial repos
3868 function hgstat () {
3870 [[ -n "$1" ]] && hg diff -r $1 -r tip | diffstat || hg export tip | diffstat
3873 fi # end of check whether we have the 'hg'-executable
3875 # disable bracketed paste mode for dumb terminals
3876 [[ "$TERM" == dumb ]] && unset zle_bracketed_paste
3878 # grml-small cleanups and workarounds
3880 # The following is used to remove zsh-config-items that do not work
3881 # in grml-small by default.
3882 # If you do not want these adjustments (for whatever reason), set
3883 # $GRMLSMALL_SPECIFIC to 0 in your .zshrc.pre file (which this configuration
3884 # sources if it is there).
3886 if (( GRMLSMALL_SPECIFIC > 0 )) && isgrmlsmall ; then
3891 unalias 'V' &> /dev/null
3892 unfunction vman &> /dev/null
3893 unfunction viless &> /dev/null
3894 unfunction 2html &> /dev/null
3896 # manpages are not in grmlsmall
3897 unfunction manzsh &> /dev/null
3898 unfunction man2 &> /dev/null
3902 # See https://github.com/grml/grml/issues/56
3903 if ! [[ -x ${commands[dig]} ]]; then
3904 function dig_after_all () {
3908 unfunction dig_after_all
3911 if [[ -x ${commands[dig]} ]]; then
3916 printf 'This installation does not include `dig'\'' for size reasons.\n'
3917 printf 'Try `drill'\'' as a light weight alternative.\n'
3921 if [[ -x ${commands[dig]} ]]; then
3923 zle -M 'Found `dig'\'' installed. '
3925 zle -M 'Try `drill'\'' instead of `dig'\''.'
3934 unfunction grml_status_feature
3936 ## genrefcard.pl settings
3938 ### doc strings for external functions from files
3939 #m# f5 grml-wallpaper() Sets a wallpaper (try completion for possible values)
3941 ### example: split functions-search 8,16,24,32
3942 #@# split functions-search 8
3944 ## END OF FILE #################################################################
3945 # vim:filetype=zsh foldmethod=marker autoindent expandtab shiftwidth=4