1 # Zsh configuration file.
3 # Copyright (C) 2011-2018 Simon Ruderich
5 # This file is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This file is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this file. If not, see <http://www.gnu.org/licenses/>.
19 # Warn when creating global variables from inside a function. Needs to be set
20 # before declaring a function.
21 setopt warn_create_global
26 # Return the name of the program which is called in the foreground with `fg`.
27 # $1 is the name of the program (optional). If it's not 'fg' or 'fg *' it's
29 zshrc_resolve_fg_to_resumed_job_name() {
30 # $REPLY is used by convention for scalars ($reply for arrays) to return
31 # values from functions. unset it here to prevent problems when REPLY is
32 # bound to an integer or similar. Thanks to Mikachu in #zsh on Freenode
33 # (2012-09-27 17:14 CEST) for this hint.
36 # Replace fg with the resumed job name.
37 if [[ $1 == fg ]]; then
39 elif [[ $1 == fg\ * ]]; then
40 REPLY=${jobtexts[${1#fg }]}
41 # Normal program, return as is.
48 # MISCELLANEOUS SETTINGS
52 # Load general shell setup commands. NOTE: Expand this when publishing the
54 source_config ~/.shell/rc
59 # Prevent overwriting existing files with '> filename', use '>| filename'
63 # Entering the name of a directory (if it's not a command) will automatically
64 # cd to that directory.
67 # When entering a nonexistent command name automatically try to find a similar
71 # Enable zsh's extended glob abilities.
74 # Don't exit if <C-D> is pressed. Prevents exiting the shell by accident (e.g.
75 # pressing <C-D> twice).
78 # Also display PID when suspending a process.
84 # Not all bindings are done here, only those not specific to a given section.
86 # Use Vi(m) style key bindings.
89 # Use jk to exit insert mode (jj is too slow to type).
90 bindkey 'jk' vi-cmd-mode
92 # I don't need the arrow keys, I use ^N and ^P for this (see below).
93 bindkey -r '^[OA' '^[OB' '^[OC' '^[OD' '^[[A' '^[[B' '^[[C' '^[[D'
94 # Also not in Vi mode.
95 bindkey -a -r '^[OA' '^[OB' '^[OC' '^[OD' '^[[A' '^[[B' '^[[C' '^[[D'
100 # Make sure every entry in $fpath is unique.
102 # ~/.zsh/functions/completion is a symbolic link to the Completion directory
103 # of a Zsh Git checkout. Use it to get the newest completions if available.
104 if [[ -d ~/.zsh/functions/completion ]]; then
105 fpath=(~/.zsh/functions/completion/*/*(/) $fpath)
107 # Set correct fpath to allow loading my functions (including completion
109 fpath=(~/.zsh/functions $fpath)
110 # Autoload my functions (except completion functions and hidden files). Thanks
111 # to caphuso from the Zsh example files for this idea. Check if there are any
112 # functions to load or autoload fails; thanks to okdana in #zsh on Freenode
113 # (2018-07-18 09:29 CEST) for the idea to use (#qNY1) for the check.
114 if [[ -d ~/.zsh/functions && -n ${fpath[1]}/^_*(#qNY1^/:t) ]]; then
115 autoload -Uz ${fpath[1]}/^_*(^/:t)
118 # Simulate hooks using _functions arrays for Zsh versions older than 4.3.4. At
119 # the moment only precmd(), preexec() and chpwd() are simulated.
120 if [[ $ZSH_VERSION != (4.3.<4->*|4.<4->*|<5->*) ]]; then
121 # Run all functions defined in the ${precmd,preexec,chpwd}_functions
124 for function in $precmd_functions; do
129 for function in $preexec_functions; do
134 for function in $chpwd_functions; do
140 # Load zmv (zsh move) which is a powerful file renamer.
146 # Use history and store it in ~/.zsh/history.
149 HISTFILE=~/.zsh/history
150 # Append to the history file instead of overwriting it and do it immediately
151 # when a command is executed.
153 setopt incappendhistory
154 # If the same command is run multiple times store it only once in the history.
155 setopt histignoredups
156 # Don't add lines starting with a space to the history.
157 setopt histignorespace
159 # Vim like completions of previous executed commands (also enter Vi-mode). If
160 # called at the beginning it just recalls old commands (like cursor up), if
161 # called after typing something, only lines starting with the typed text are
162 # returned. Very useful to get old commands quickly - in addition to the
163 # history commands (!..). Thanks to Mikachu in #zsh on Freenode (2010-01-17
164 # 12:47 CET) for the information how to a use function with bindkey.
165 zle -N zshrc-vi-history-beginning-search-backward
166 zshrc-vi-history-beginning-search-backward() {
167 local not_at_beginning_of_line
168 if [[ $CURSOR -ne 0 ]]; then
169 not_at_beginning_of_line=yes
172 zle history-beginning-search-backward
174 # Start Vi-mode and stay at the same position (Vi-mode moves one left,
177 if [[ -n $not_at_beginning_of_line ]]; then
181 bindkey '^P' zshrc-vi-history-beginning-search-backward
182 bindkey -a '^P' history-beginning-search-backward # binding for Vi-mode
183 # Here only Vi-mode is necessary as ^P enters Vi-mode and ^N only makes sense
185 bindkey -a '^N' history-beginning-search-forward
187 # Use current input when pressing Ctrl-R. Thanks to Mikachu in #zsh on
188 # Freenode (2016-07-08 20:54 CEST).
189 zshrc-history-incremental-pattern-search-backward() {
190 zle .history-incremental-pattern-search-backward $BUFFER
192 zle -N history-incremental-pattern-search-backward \
193 zshrc-history-incremental-pattern-search-backward
194 # Enable incremental search which is especially useful when the string is an
195 # argument and not the command.
196 bindkey '^R' history-incremental-pattern-search-backward
197 # Also enable my usual use of Ctrl-P/Ctrl-N to get the previous/next matching
199 if [[ $ZSH_VERSION == (4.<4->*|<5->*) ]]; then
200 bindkey -M isearch '^P' history-incremental-pattern-search-backward
201 bindkey -M isearch '^N' history-incremental-pattern-search-forward
204 # Automatically push cd-ed directories on the directory stack.
206 # Don't push duplicates on the directory stack.
207 setopt pushdignoredups
208 # Exchange the meaning of + and - when specifying a directory on the stack.
209 # This way cd -<Tab> lists the last used directory first, which is more
210 # natural because cd - goes to the last directory.
216 # Use colorized output, necessary for prompts and completions.
217 autoload -Uz colors; colors
219 # Necessary for $EPOCHSECONDS, the UNIX time.
220 zmodload zsh/datetime
222 # Some shortcuts for colors. The %{...%} tells zsh that the data in between
223 # doesn't need any space, necessary for correct prompt drawing. Use %F{color}
224 # in more recent zsh versions (here compatibility is important).
225 local red="%{${fg[red]}%}"
226 local blue="%{${fg[blue]}%}"
227 local green="%{${fg[green]}%}"
228 local yellow="%{${fg[yellow]}%}"
229 local default="%{${fg[default]}%}"
231 # vcs_info was added in 4.3.9 but it works in earlier versions too. So load it
232 # if the necessary files are available in ~/.zsh/functions/vcs_info (often a
233 # symbolic link to current checkout of Zsh's sources).
234 if [[ $ZSH_VERSION == (4.3.<9->*|4.<4->*|<5->*) ||
235 -d ~/.zsh/functions/vcs_info ]]; then
236 # Update fpath to allow loading the vcs_info functions.
237 if [[ -d ~/.zsh/functions/vcs_info ]]; then
238 fpath=(~/.zsh/functions/vcs_info/
239 ~/.zsh/functions/vcs_info/Backends
243 # Load vcs_info to display information about version control repositories.
244 autoload -Uz vcs_info
245 # Only look for certain VCS.
246 zstyle ':vcs_info:*' enable git
247 # Check the repository for changes so they can be used in %u/%c (see
248 # below). This comes with a speed penalty for bigger repositories.
249 zstyle ':vcs_info:*' check-for-changes yes
251 # Set style of vcs_info display. The current branch (green) and VCS (blue)
252 # is displayed. If there is an special action going on (merge, rebase)
253 # it's also displayed (red). Also display if there are unstaged or staged
255 if [[ $ZSH_VERSION == (4.3.<11->*|4.<4->*|<5->*) ||
256 -d ~/.zsh/functions/vcs_info ]]; then
257 zstyle ':vcs_info:*' formats \
258 "(${green}%b%u%c${default}:${blue}%s${default}%m)" \
259 "${green}%u%c${default}"
260 zstyle ':vcs_info:*' actionformats \
261 "(${green}%b%u%c${default}/${red}%a${default}:${blue}%s${default}%m)" \
262 "${green}%u%c${default}"
264 # In older versions %u and %c are not defined yet and are not
265 # correctly expanded.
266 zstyle ':vcs_info:*' formats \
267 "(${green}%b${default}:${blue}%s${default})"
268 zstyle ':vcs_info:*' actionformats \
269 "(${green}%b${default}/${red}%a${default}:${blue}%s${default})"
271 # Set style for formats/actionformats when unstaged (%u) and staged (%c)
272 # changes are detected in the repository; check-for-changes must be set to
273 # true for this to work. Thanks to Bart Trojanowski
274 # (http://jukie.net/~bart/blog/pimping-out-zsh-prompt) for the idea
275 # (2010-03-11 00:20 CET).
276 zstyle ':vcs_info:*' unstagedstr '¹'
277 zstyle ':vcs_info:*' stagedstr '²'
279 # Default to run vcs_info. If possible we prevent running it later for
280 # speed reasons. If set to a non empty value vcs_info is run.
281 zshrc_force_run_vcs_info=1
283 # Cache system inspired by Bart Trojanowski
284 # (http://jukie.net/~bart/blog/pimping-out-zsh-prompt).
285 zstyle ':vcs_info:*+pre-get-data:*' hooks pre-get-data
287 # Only Git and Mercurial support and need caching. Abort if any other
289 [[ $vcs != git && $vcs != hg ]] && return
291 # If the shell just started up or we changed directories (or for other
292 # custom reasons) we must run vcs_info.
293 if [[ -n $zshrc_force_run_vcs_info ]]; then
294 zshrc_force_run_vcs_info=
298 # Don't run vcs_info by default to speed up the shell.
300 # If a git/hg command was run then run vcs_info as the status might
301 # need to be updated.
302 case $(fc -ln $(($HISTCMD-1))) in
312 # Display number of WIP stashes (this excludes manually named commits
313 # which might be used for something else), thanks to
314 # http://eseth.org/2010/git-in-zsh.html (viewed on 2013-04-27) for the
315 # idea to display the stash count.
316 function +vi-git-stashes() {
317 if [[ -s ${hook_com[base]/.git/refs/stash} ]]; then
319 # Thanks to Valodim in #zsh on Freenode (2013-07-01 14:14 CEST)
320 # for the solution to "grep" the output with (M) and :#(...).
321 stashes=( ${(M)${(f)"$(git stash list 2>/dev/null)"}:#(*WIP*)} )
323 if [[ ${#stashes} -gt 0 ]]; then
324 hook_com[misc]+=" ${yellow}${#stashes}s${default}"
329 # Apply hooks to Git.
330 zstyle ':vcs_info:git*+set-message:*' hooks git-stashes
332 # Must run vcs_info when changing directories.
334 zshrc_force_run_vcs_info=1
336 chpwd_functions+=(prompt_chpwd)
338 # Used by prompt code below to determine if vcs_info should be run.
344 typeset -a zshrc_longrun_data
345 zshrc_longrun_data=()
346 # Display runtime in seconds for long running programs (> 60 seconds) and send
347 # a bell to notify me.
348 zshrc_longrun_preexec() {
353 zshrc_resolve_fg_to_resumed_job_name $program
356 # No background process found.
357 if [[ -z $program ]]; then
361 # Don't track the time for certain (possible) long running processes which
362 # need no automatic notification.
364 for ignore in elinks man mutt vim; do
366 $ignore | $ignore\ *)
367 zshrc_longrun_data=()
373 zshrc_longrun_data=($program $EPOCHSECONDS)
375 zshrc_longrun_precmd() {
376 # No previous timestamp available or disabled for this command, ignore.
377 if [[ -z $zshrc_longrun_data ]]; then
381 local difference=$(( EPOCHSECONDS - zshrc_longrun_data[2] ))
382 if [[ $difference -gt 60 ]]; then
384 echo -n "${fg[yellow]}"
385 echo -n "~> ${(V)zshrc_longrun_data[1]} took $difference seconds."
386 echo -n "${fg[default]}"
387 echo "\a" # send bell
390 # Clear status. Prevents displaying old status information when pressing
391 # enter with an empty command line.
392 zshrc_longrun_data=()
394 preexec_functions+=(zshrc_longrun_preexec)
395 precmd_functions+=(zshrc_longrun_precmd)
397 # Set the prompt. A two line prompt is used. On the top left the current
398 # working directory is displayed, on the right vcs_info (if available) and the
399 # current time in hex. On the bottom left current user name and host is shown,
400 # the exit code of the last command if it wasn't 0, the number of running jobs
403 # The prompt is in green and blue to make easily detectable, the error exit
404 # code in red and bold and the job count in yellow. Designed for dark
407 # Thanks to Adam's prompt for the basic idea of this prompt.
408 zshrc_prompt_precmd() {
409 # Regex to remove elements which take no space. Used to calculate the
410 # width of the top prompt. Thanks to Bart's and Adam's prompt code in
411 # Functions/Prompts/prompt_*_setup.
412 local zero='%([BSUbfksu]|([FB]|){*})'
414 # Call vcs_info before every prompt.
415 if [[ -n $zshrc_use_vcs_info ]]; then
422 # Setup. Create variables holding the formatted content.
424 # Current directory in yellow, truncated if necessary (WIDTH is replaced
426 local directory="${yellow}%WIDTH<..<%~%<<${default}"
427 # Minimal information about the VCS, only displayed if there are
428 # unstaged/staged changes.
429 local vcs_staged=${vcs_info_msg_1_}
431 # Information about the VCS in this directory.
432 local vcs=${vcs_info_msg_0_}
433 # Current time (seconds since epoch) in Hex in bright blue.
434 local seconds="${blue}%B0x$(([##16] EPOCHSECONDS))%b${default}"
436 # User name (%n) in bright green.
437 local user="${green}%B%n%b${default}"
438 # Host name (%m) in bright green; underlined if running on a remote system
440 local host="${green}%B%m%b${default}"
441 if [[ -n $SSH_CONNECTION ]]; then
445 # Number of background processes in yellow if not zero.
446 local background="%(1j.${yellow}%j${default}.)"
447 # Exit code in bright red in parentheses if not zero.
448 local exitcode="%(?..(${red}%B%?%b${default}%) )"
449 # Prompt symbol, % for normal users, # in red for root.
450 local symbol="%(!.${red}#${default}.%%)"
452 # Prefix characters in first and second line.
453 local top_prefix="${blue}%B.-%b${default}"
454 local bottom_prefix="${blue}%B'%b${default}"
456 # Combine them to create the prompt.
458 local top_left=${vcs_staged}
459 local top_right="${vcs}(${seconds})"
461 local width_top_prefix=${#${(S%%)top_prefix//$~zero/}}
462 local width_top_left=${#${(S%%)top_left//$~zero/}}
463 local width_top_right=${#${(S%%)top_right//$~zero/}}
465 # Calculate the maximum width of ${top_left}. -2 are the braces of
466 # ${top_left}, -1 is one separator from ${top_separator} (we want at least
467 # one between left and right parts).
468 local top_left_width_max=$((
469 COLUMNS - $width_top_prefix
470 - $width_top_left - 2
474 # Truncate directory if necessary.
475 top_left="(${directory/WIDTH/${top_left_width_max}})${top_left}"
476 width_top_left=${#${(S%%)top_left//$~zero/}}
478 # Calculate the width of the top prompt to fill the middle with "-".
480 COLUMNS - width_top_prefix - width_top_left - width_top_right
482 local top_separator="%B${blue}${(l:${width}::-:)}%b${default}"
484 PROMPT="${top_prefix}${top_left}${top_separator}${top_right}
485 ${bottom_prefix}${user}@${host} ${background}${symbol} ${exitcode}"
487 precmd_functions+=(zshrc_prompt_precmd)
490 # When GNU screen, tmux, xterm or rxvt is used set the name of the window to
491 # the currently running program.
493 # When a program is started preexec() sets the window's name to it; when it
494 # stops precmd() resets the window's name to 'zsh'. 'fg' is supported and sets
495 # the window's name to the resumed job.
497 # It works with GNU screen, tmux, xterm and rxvt.
499 # If a command is run with sudo or if the shell is running as root then a ! is
500 # added at the beginning of the command to make this clear. If a command is
501 # running on a different computer with ssh a @ is added at the beginning. If
502 # screen/tmux is running on the remote machine instead of @screen @:hostname
503 # (or @tmux ..; hostname replaced by the machine's hostname) is displayed.
504 # This only works if the .zshrc on the server also uses this command.
506 # screen* is necessary as `screen` uses screen.linux for example for a linux
508 if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
509 # Is set to a non empty value to reset the window name in the next
511 zshrc_window_reset=yes
513 zshrc_window_preexec() {
514 # Get the program name with its arguments.
515 local program_name=$1
517 # When sudo is used, use real program name instead, but with an
518 # exclamation mark at the beginning (handled below).
520 if [[ $program_name == sudo* ]]; then
521 program_name=${program_name#sudo }
527 zshrc_resolve_fg_to_resumed_job_name $program_name
530 # Remove all arguments from the program name.
531 program_name=${program_name%% *}
533 # Ignore often used commands which are only running for a very short
534 # time. This prevents a "blinking" name when it's changed to "cd" for
535 # example and then some milliseconds later back to "zsh".
536 [[ $program_name == (cd*|d|ls|l|la|ll|clear|c) ]] && return
538 # Change my shortcuts so the real name of the program is displayed.
539 case $program_name in
560 # Add an exclamation mark at the beginning if running with sudo or if
561 # running zsh as root.
562 if [[ -n $program_sudo || $UID -eq 0 ]]; then
563 program_name=!$program_name
566 # Add an at mark at the beginning if running through ssh on a
567 # different computer.
568 if [[ -n $SSH_CONNECTION ]]; then
569 program_name="@$program_name"
571 # If screen is running in SSH then display "@:hostname" as title
572 # in the term/outer screen.
573 if [[ $program_name == @screen || $program_name == @tmux ]]; then
574 program_name="@:${HOST//.*/}"
575 # Use "@:!hostname" for root screens.
576 elif [[ $program_name == @!screen || $program_name == @!tmux ]]; then
577 program_name="@:!${HOST//.*/}"
581 # Set the window name to the currently running program.
582 zshrc_window_title $program_name
584 # Tell precmd() to reset the window name when the program stops.
585 zshrc_window_reset=yes
588 zshrc_window_precmd() {
589 # Abort if no window name reset is necessary.
590 [[ -z $zshrc_window_reset ]] && return
592 # Reset the window name to 'zsh'.
594 # If the function was called with an argument then reset the window
595 # name to '.zsh' (used by clear alias).
600 # Prepend prefixes like in zshrc_window_preexec().
601 if [[ $UID -eq 0 ]]; then
604 if [[ -n $SSH_CONNECTION ]]; then
607 zshrc_window_title $name
609 # Just reset the name, so no screen reset necessary for the moment.
613 # Sets the window title. Works with GNU screen, tmux (which uses screen as
614 # TERM), xterm and rxvt. (V) escapes all non-printable characters, thanks
615 # to Mikachu in #zsh on Freenode (2010-08-07 17:09 CEST).
616 if [[ $TERM == screen* ]]; then
617 zshrc_window_title() {
618 print -n "\ek${(V)1}\e\\"
620 elif [[ $TERM == xterm* || $TERM == rxvt* ]]; then
621 zshrc_window_title() {
622 print -n "\e]2;${(V)1}\e\\"
625 # Fallback if another TERM is used.
626 zshrc_window_title() { }
629 # Add the preexec() and precmd() hooks.
630 preexec_functions+=(zshrc_window_preexec)
631 precmd_functions+=(zshrc_window_precmd)
633 # Fallback if another TERM is used, necessary to run screen (see below in
635 zshrc_window_preexec() { }
639 # COMPLETION SETTINGS
641 # Load the complist module which provides additional features to completion
642 # lists (coloring, scrolling).
643 zmodload zsh/complist
644 # Use new completion system, store dumpfile in ~/.zsh/cache to prevent
645 # cluttering of ~/. $fpath must be set before calling this. Thanks to Adlai in
646 # #zsh on Freenode (2009-08-07 21:05 CEST) for reminding me of the $fpath
648 autoload -Uz compinit; compinit -d ~/.zsh/cache/zcompdump
650 # Use cache to speed up some slow completions (dpkg, perl modules, etc.).
651 zstyle ':completion:*' use-cache yes
652 zstyle ':completion:*' cache-path ~/.zsh/cache
654 # List all files in the current directory when pressing tab on an empty input,
655 # behave like complete-word otherwise. Thanks to John Eikenberry [1] for the
656 # code, read on 2014-03-15.
658 # [1]: http://unix.stackexchange.com/a/32426
659 complete-word-or-complete-list-of-files() {
660 if [[ $#BUFFER == 0 ]]; then
664 zle backward-kill-word
669 zle -N complete-word-or-complete-list-of-files
670 # Let the completion system handle all completions, including expanding of
671 # shell wildcards (which is handled by other shell mechanisms if the default
672 # expand-or-complete is used).
673 bindkey '^I' complete-word-or-complete-list-of-files
674 # If there are multiple matches after pressing <Tab> always display them
675 # immediately without requiring another <Tab>. a<Tab> completes to aa and
676 # lists aaa, aab, aac as possible completions if the directory contains aaa,
677 # aab, aac, bbb instead of only completing to aa.
678 setopt nolistambiguous
679 # Support completions in the middle of a word, without this option zsh jumps
680 # to the end of the word before the completion process begins. Is required for
681 # the _prefix completer.
682 setopt completeinword
684 # Force a reload of the completion system if nothing matched; this fixes
685 # installing a program and then trying to tab-complete its name. Thanks to
686 # Alex Munroe [1] for the code, read on 2014-03-03.
688 # [1]: https://github.com/eevee/rc/blob/master/.zshrc
690 if (( CURRENT == 1 )); then
693 # We didn't really complete anything.
697 zstyle ':completion:::::' completer \
698 _force_rehash _expand _complete _prefix _ignored _approximate
700 # Match specification to be tried when completing items. Each group ('...') is
701 # tried after another if no matches were found, once matches are found no
702 # other groups are tried. Thanks to Mikachu in #zsh on Freenode (2012-08-28
703 # 18:48 CEST) for explanations.
705 # When matching also include the uppercase variant of typed characters
706 # ('m:{a-z}={A-Z}'); using '' before this group would try the unmodified match
707 # first, but I prefer to get all matches immediately (e.g. if Makefile and
708 # makefile exist in the current directory echo m<tab> matches both, with '' it
709 # would only match makefile because it found one match). This allows typing in
710 # lowercase most of the time and completion fixes the case, which is faster.
712 # Don't perform these fixes in _approximate to prevent it from changing the
713 # input too much. Thanks to the book "From Bash to Z Shell" page 249.
714 zstyle ':completion:*:(^approximate):*' matcher-list 'm:{a-z}={A-Z}'
716 # Allow one mistake per three characters. Thanks to the book "From Bash to Z
718 zstyle -e ':completion:*:approximate:*' max-errors \
719 'reply=( $(( ($#PREFIX + $#SUFFIX) / 3 )) )'
721 # Expand shell wildcards to all matching files after <Tab>. echo *<Tab>
722 # results in a b c if the directory contains the files a, b, c. Thanks to the
723 # book "From Bash to Z Shell" page 246.
724 zstyle ':completion:*:expand:*' tag-order all-expansions
725 # Keep prefixes unexpanded if possible: $HOME/<Tab> doesn't expand $HOME,
726 # while $HOME<Tab> does.
727 zstyle ':completion:*:expand:*' keep-prefix yes
729 # When completing multiple path components display all matching ambiguous
730 # components. For example /u/s/d/r/README<Tab> lists all matching READMEs
731 # instead of just the matching paths up to the r/ component. Can be slow if
732 # there are many matching files.
733 zstyle ':completion:*' list-suffixes yes
735 # Use ls-like colors for completions.
736 zstyle ':completion:*' list-colors ${(s.:.)LS_COLORS}
738 # Make completion lists scrollable so "do you wish to see all n possibilities"
739 # is no longer displayed. Display current position in percent (%p).
740 zstyle ':completion:*:default' list-prompt '%p'
741 # Display group name (%d) (like 'external command', 'alias', etc.), in bold.
742 # Also display a message if _approximate found errors and no matches were
744 zstyle ':completion:*' format ' %B%d%b:'
745 zstyle ':completion:*:corrections' format ' %B%d%b (errors: %e)'
746 zstyle ':completion:*:warnings' format ' %Bno matches for %d%b'
747 # Display different types of matches separately.
748 zstyle ':completion:*' group-name ''
750 # Separate man pages by section.
751 zstyle ':completion:*' separate-sections yes
753 # Don't draw trailing / in bold (new in zsh 4.3.11). Thanks to Mikachu in #zsh
754 # on Freenode for the fix (2010-12-17 13:46 CET).
755 zle_highlight=(suffix:none)
757 # Ignore completion functions.
758 zstyle ':completion:*:functions' ignored-patterns '_*'
760 # When offering typo corrections, do not propose anything which starts with an
761 # underscore (such as many of Zsh's shell functions). Thanks to paradigm [1]
762 # for the idea (read on 2013-04-07).
764 # [1]: https://github.com/paradigm/dotfiles/blob/master/.zshrc
767 # Ignore parent directory.
768 zstyle ':completion:*:(cd|mv|cp):*' ignore-parents parent pwd
769 # Always complete file names only once in the current line. This makes it easy
770 # to complete multiple file names because I can just press tab to get all
771 # possible values. Otherwise I would have to skip the first value again and
772 # again. Thanks to Mikachu in #zsh on Freenode (2011-08-11 14:42 CEST) for the
773 # hint to use other. other is necessary so prefix<Tab> lists both prefix and
774 # prefixrest if the directory contains prefix and prefixrest.
775 zstyle ':completion:*:all-files' ignore-line other
776 # Except for mv and cp, because I often want to use to similar names, so I
777 # complete to the same and change it.
778 zstyle ':completion:*:(mv|cp):all-files' ignore-line no
780 # Don't complete ./config.* files, this makes running ./configure much
781 # simpler. Thanks to Nomexous in #zsh on Freenode (2010-03-16 01:54 CET)
782 zstyle ':completion:*:*:-command-:*' ignored-patterns './config.*'
783 # Don't complete unwanted files with Vim. Thanks to Nomexous in #zsh on
784 # Freenode (2010-06-06 04:54 CEST). See below for a way to complete them.
785 zstyle ':completion:*:*:vim:*:all-files' ignored-patterns \
786 '*.aux' '*.log' '*.pdf' '*.bbl' '*.blg' '*.out' '*-blx.bib' '*.run.xml' \
791 # Provide a fallback completer which always completes files. Useful when Zsh's
792 # completion is too "smart". Thanks to Frank Terbeck <ft@bewatermyfriend.org>
793 # (http://www.zsh.org/mla/users/2009/msg01038.html).
794 zle -C complete-files complete-word _generic
795 zstyle ':completion:complete-files:*' completer _files
796 bindkey '^F' complete-files
798 # Completion for my wrapper scripts.
799 compdef slocate=locate
801 compdef srsync-incremental=rsync
805 # CUSTOM ALIASES AND FUNCTIONS
807 # If ^C is pressed while typing a command, add it to the history so it can be
808 # easily retrieved later and then abort like ^C normally does. This is useful
809 # when I want to abort an command to do something in between and then finish
810 # typing the command.
812 # Thanks to Vadim Zeitlin <vz-zsh@zeitlins.org> for a fix (--) so lines
813 # starting with - don't cause errors; and to Nadav Har'El
814 # <nyh@math.technion.ac.il> for a fix (-r) to handle whitespace/quotes
815 # correctly, both on the Zsh mailing list.
817 # Don't store this line in history if histignorespace is enabled and the
818 # line starts with a space.
819 if [[ -o histignorespace && ${BUFFER[1]} = ' ' ]]; then
823 # Store the current buffer in the history.
824 zle && print -s -r -- $BUFFER
826 # Return the default exit code so Zsh aborts the current command.
830 # Load aliases and similar functions also used by other shells.
831 if [[ -f ~/.shell/aliases ]]; then
835 # Make sure aliases are expanded when using sudo.
838 # Global aliases for often used redirections.
840 alias -g N='>/dev/null'
841 alias -g EN='2>/dev/null'
842 alias -g L='2>&1 | less'
843 alias -g LS='2>&1 | less -S' # -S prevents wrapping of long lines
844 alias -g D='2>&1 | colordiff | less'
845 # Global aliases for often used commands.
847 alias -g A1="| awk '{ print \$1 }'"
848 alias -g A2="| awk '{ print \$2 }'"
849 alias -g A3="| awk '{ print \$3 }'"
851 alias -g GB='| grep -vE "^Binary file .+ matches\$"'
855 alias -g SL='| sort | less'
858 alias -g X='-- "$(xsel -p || xclip -o)"' # X selection
860 # Make going up directories simple.
862 alias -g ....='../../..'
863 alias -g .....='../../../..'
865 # If the window naming feature is used (see above) then use ".zsh" (leading
866 # dot) as title name after running clear so it's clear to me that the window
867 # is empty. I open so much windows that I don't know in which I have something
868 # important. This helps me to remember which windows are empty (I run clear
869 # after I finished my work in a window).
870 if [[ -n $zshrc_window_reset ]]; then
871 alias clear='clear; zshrc_window_reset=yes; zshrc_window_precmd reset'
877 # Display all branches (except stash) in gitk but only 200 commits as this is
878 # much faster. Also put in the background and disown. Thanks to drizzd in #git
879 # on Freenode (2010-04-03 17:55 CEST).
880 (( $+commands[gitk] )) && gitk() {
881 command gitk --max-count=200 --branches --remotes --tags "$@" &
884 # Same for tig (except the disown part as it's no GUI program).
885 (( $+commands[tig] )) && tig() {
886 command tig --max-count=200 --branches --remotes --tags "$@"
889 # Choose the "best" PDF viewer available. Also setup completion for `pdf`.
890 if (( $+commands[katarakt] )); then
892 command katarakt "$@" 2>/dev/null &
895 # No completion for katarakt yet.
897 elif (( $+commands[xpdf] )); then
899 command xpdf "$@" 2>/dev/null &
903 elif (( $+commands[zathura] )); then
905 command zathura "$@" 2>/dev/null &
908 # No completion for zathura yet.
913 # OS SPECIFIC SETTINGS
915 if [[ $OSTYPE == linux* ]]; then
916 # Settings when creating Debian packages.
917 export DEBEMAIL=simon@ruderich.org
918 export DEBFULLNAME='Simon Ruderich'
922 # LOAD ADDITIONAL CONFIGURATION FILES
924 # Configuration options for rc.local.
926 # Multiplexer to use. By default GNU screen is used. Possible values: screen,
927 # tmux and empty (no multiplexer).
928 zshrc_use_multiplexer=screen
929 # Additional arguments for fortune.
930 zshrc_fortune_arguments=()
932 source_config ~/.zsh/rc.local
937 # Make sure the multiplexer is available. Otherwise the exec terminates our
939 if [[ -n $zshrc_use_multiplexer ]]; then
940 if ! (( $+commands[$zshrc_use_multiplexer] )); then
941 echo "Multiplexer '$zshrc_use_multiplexer' not found." >&2
942 zshrc_use_multiplexer=
946 # If not already in screen or tmux, reattach to a running session or create a
947 # new one. This also starts screen/tmux on a remote server when connecting
949 if [[ $TERM != dumb && $TERM != dialup && $TERM != linux
950 && -z $STY && -z $TMUX ]]; then
951 # Get running detached sessions.
952 if [[ $zshrc_use_multiplexer = screen ]]; then
953 session=$(screen -list | grep 'Detached' | awk '{ print $1; exit }')
954 elif [[ $zshrc_use_multiplexer = tmux ]]; then
955 session=$(tmux list-sessions 2>/dev/null \
956 | sed '/(attached)$/ d; s/^\([0-9]\{1,\}\).*$/\1/; q')
959 # As we exec later we have to set the title here.
960 if [[ $zshrc_use_multiplexer = screen ]]; then
961 zshrc_window_preexec screen
962 elif [[ $zshrc_use_multiplexer = tmux ]]; then
963 zshrc_window_preexec tmux
966 # Create a new session if none is running.
967 if [[ -z $session ]]; then
968 if [[ $zshrc_use_multiplexer = screen ]]; then
970 elif [[ $zshrc_use_multiplexer = tmux ]]; then
973 # Reattach to a running session.
975 if [[ $zshrc_use_multiplexer = screen ]]; then
976 exec screen -r $session
977 elif [[ $zshrc_use_multiplexer = tmux ]]; then
978 exec tmux attach-session -t $session
983 # Colorize stderr in bold red. Very useful when looking for errors.
984 if [[ $LD_PRELOAD != *libcoloredstderr.so* ]]; then
985 # coloredstderr found, use it.
986 if [[ -f ~/.zsh/libcoloredstderr.so ]]; then
987 export LD_PRELOAD="$HOME/.zsh/libcoloredstderr.so:$LD_PRELOAD"
988 export COLORED_STDERR_FDS=2,
989 export COLORED_STDERR_PRE=$'\033[91m' # bright red
990 export COLORED_STDERR_IGNORED_BINARIES=/usr/bin/tset
991 # Use the fallback solution.
993 # Thanks to http://gentoo-wiki.com/wiki/Zsh for the basic script and
994 # Mikachu in #zsh on Freenode (2010-03-07 04:03 CET) for some improvements
995 # (-r, printf). It's not yet perfect and doesn't work with su and git for
996 # example, but it can handle most interactive output quite well (even with
997 # no trailing new line) and in cases it doesn't work, the E alias can be
998 # used as workaround.
1000 # Moved in the "run commands" section to prevent one unnecessary zsh
1001 # process when starting GNU screen/tmux (see above).
1003 exec 2>>(while read -r -k -u 0 line; do
1004 printf '\e[91m%s\e[0m' $line
1008 # Reset doesn't work with this hack.
1010 command reset "$@" 2>&1
1015 # Display possible log messages from ~/.xinitrc (if `xmessage` wasn't
1016 # installed). No race condition as xinitrc has finished before a shell is
1017 # executed and only one shell is started on login.
1018 if [[ -f ~/.xinitrc.errors ]]; then
1019 echo "${fg_bold[red]}xinitrc failed!${fg_bold[default]}"
1021 cat ~/.xinitrc.errors
1022 rm ~/.xinitrc.errors
1026 # Run the following programs every 4 hours (and when zsh starts).
1030 (( $+commands[fortune] )) && fortune -ac "${zshrc_fortune_arguments[@]}"
1031 # Display reminders.
1032 (( $+commands[rem] )) && [[ -f ~/.reminders ]] && rem -h
1038 zmodload -F zsh/stat b:zstat
1040 # Remember startup time. Used to perform automatic restarts when ~/.zshrc is
1042 zshrc_startup_time=$EPOCHSECONDS
1044 # Automatically restart Zsh if ~/.zshrc was modified.
1045 zshrc_restart_precmd() {
1047 if ! zstat -A stat +mtime ~/.zshrc; then
1051 # ~/.zshrc wasn't modified, nothing to do.
1052 if [[ $stat -le $zshrc_startup_time ]]; then
1057 strftime -s startup '%Y-%m-%d %H:%M:%S' $zshrc_startup_time
1059 echo -n "${fg[magenta]}"
1060 echo -n "~/.zshrc modified since startup ($startup) ... "
1061 echo -n "${fg[default]}"
1063 if [[ -n $zshrc_disable_restart ]]; then
1064 echo 'automatic restart disabled.'
1068 # Don't exec if we have background processes because execing will let us
1069 # lose control over them.
1070 if [[ ${#${(k)jobstates}} -ne 0 ]]; then
1071 echo 'active background jobs!'
1075 # Try to start a new interactive shell. If it fails, something is wrong.
1076 # Don't kill our current session by execing it, abort instead.
1078 if [[ $? -ne 42 ]]; then
1079 echo -n ${fg_bold[red]}
1080 echo 'failed to start new zsh!'
1081 echo -n ${fg_bold[default]}
1085 echo 'restarting zsh.'
1090 precmd_functions+=(zshrc_restart_precmd)
1095 zshenv_reload_time=0 # load before first command
1096 zshenv_boot_time=$(date -d "$(uptime -s)" '+%s') # uptime in epoch seconds
1098 # Automatically source ~/.zsh/env.update when the file changes (and exists).
1099 # Can be used e.g. to update SSH_AGENT_PID and GPG_AGENT_INFO variables in
1100 # running zsh processes. Sourced immediately before executing shell commands
1101 # (preexec) to ensure the environment is always up to date.
1102 zshenv_reload_preexec() {
1104 file=~/.zsh/env.update
1107 if ! zstat -A stat +mtime $file 2>/dev/null; then
1110 # File was modified before reboot. Skip it to prevent loading of old
1112 if [[ $stat -lt $zshenv_boot_time ]]; then
1115 # File wasn't modified, nothing to do.
1116 if [[ $stat -le $zshenv_reload_time ]]; then
1119 zshenv_reload_time=$EPOCHSECONDS
1121 unsetopt warn_create_global
1123 setopt warn_create_global
1125 preexec_functions+=(zshenv_reload_preexec)