]> ruderich.org/simon Gitweb - config/dotfiles.git/blobdiff - zsh/rc
zsh/rc: Documentation update.
[config/dotfiles.git] / zsh / rc
diff --git a/zsh/rc b/zsh/rc
index ccc8ea7638fcb3f85cca76e3fbe2e77f724687a9..be0b9a28e73bc1b5764c60ba0a3067d4b32fd51e 100644 (file)
--- a/zsh/rc
+++ b/zsh/rc
@@ -1,12 +1,54 @@
 # Zsh configuration file.
 
+# Copyright (C) 2011-2012  Simon Ruderich
+#
+# This file is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This file is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this file.  If not, see <http://www.gnu.org/licenses/>.
+
 
 source_debug ". ~/.zsh/rc"
 
+
+# HELPER FUNCTIONS
+
+# Return the name of the program which is called in the foreground with `fg`.
+# $1 is the name of the program (optional). If it's not 'fg' or 'fg *' it's
+# returned unchanged.
+resolve_fg_to_resumed_job_name() {
+    # $REPLY is used by convention for scalars ($reply for arrays) to return
+    # values from functions. unset it here to prevent problems when REPLY is
+    # bound to an integer or similar. Thanks to Mikachu in #zsh on Freenode
+    # (2012-09-27 17:14 CEST) for this hint.
+    unset REPLY
+
+    # Replace fg with the resumed job name.
+    if [[ $1 == fg ]]; then
+        REPLY="${jobtexts[%+]}"
+    elif [[ $1 == fg\ * ]]; then
+        REPLY="${jobtexts[${1#fg }]}"
+    # Normal program, return as is.
+    else
+        REPLY="$1"
+    fi
+}
+
+
 # MISCELLANEOUS SETTINGS
 
-# Be paranoid, new files are readable/writable by me only.
-umask 077
+# Be paranoid, new files are readable/writable by me only, but not as root.
+if [[ $UID -ne 0 ]]; then
+    umask 077
+fi
 
 # Disable beeps.
 setopt nobeep
@@ -26,7 +68,8 @@ setopt correct
 # Enable zsh's extended glob abilities.
 setopt extendedglob
 
-# Don't exit if <C-d> is pressed.
+# Don't exit if <C-D> is pressed. Prevents exiting the shell by accident (e.g.
+# pressing <C-D> twice).
 setopt ignoreeof
 
 
@@ -52,7 +95,7 @@ bindkey -a -r '^[OA' '^[OB' '^[OC' '^[OD' '^[[A' '^[[B' '^[[C' '^[[D'
 # Make sure every entry in $fpath is unique.
 typeset -U fpath
 # ~/.zsh/functions/completion is a symbolic link to the Completion directory
-# of a Zsh CVS checkout. Use it to get the newest completions if available.
+# of a Zsh Git checkout. Use it to get the newest completions if available.
 if [[ -d ~/.zsh/functions/completion ]]; then
     fpath=(~/.zsh/functions/completion/*/*(/) $fpath)
 fi
@@ -67,13 +110,7 @@ fi
 
 # Simulate hooks using _functions arrays for Zsh versions older than 4.3.4. At
 # the moment only precmd(), preexec() and chpwd() are simulated.
-#
-# At least 4.3.4 (not sure about later versions) has an error in add-zsh-hook
-# so the compatibility version is used there too.
-if [[ $ZSH_VERSION != (4.3.<5->|4.<4->*|<5->*) ]]; then
-    # Provide add-zsh-hook which was added in 4.3.4.
-    fpath=(~/.zsh/functions/compatibility $fpath)
-
+if [[ $ZSH_VERSION != (4.3.<4->*|4.<4->*|<5->*) ]]; then
     # Run all functions defined in the ${precmd,preexec,chpwd}_functions
     # arrays.
     function precmd() {
@@ -93,9 +130,6 @@ if [[ $ZSH_VERSION != (4.3.<5->|4.<4->*|<5->*) ]]; then
     }
 fi
 
-# Autoload add-zsh-hook to add/remove zsh hook functions easily.
-autoload -Uz add-zsh-hook
-
 # Load zmv (zsh move) which is a powerful file renamer.
 autoload -Uz zmv
 
@@ -171,7 +205,7 @@ local default="%{${fg[default]}%}"
 # vcs_info was added in 4.3.9 but it works in earlier versions too. So load it
 # if the necessary files are available in ~/.zsh/functions/vcs_info (often a
 # symbolic link to current checkout of Zsh's sources).
-if [[ $ZSH_VERSION == (4.3.<9->|4.<4->*|<5->*) ||
+if [[ $ZSH_VERSION == (4.3.<9->*|4.<4->*|<5->*) ||
       -d ~/.zsh/functions/vcs_info ]]; then
     # Update fpath to allow loading the vcs_info functions.
     if [[ -d ~/.zsh/functions/vcs_info ]]; then
@@ -192,7 +226,7 @@ if [[ $ZSH_VERSION == (4.3.<9->|4.<4->*|<5->*) ||
     # is displayed. If there is an special action going on (merge, rebase)
     # it's also displayed (red). Also display if there are unstaged or staged
     # (%u/%c) changes.
-    if [[ $ZSH_VERSION == (4.3.<11->|4.<4->*|<5->*) ||
+    if [[ $ZSH_VERSION == (4.3.<11->*|4.<4->*|<5->*) ||
           -d ~/.zsh/functions/vcs_info ]]; then
         zstyle ':vcs_info:*' formats \
             "($green%b%u%c$default:$blue%s$default)"
@@ -251,7 +285,7 @@ if [[ $ZSH_VERSION == (4.3.<9->|4.<4->*|<5->*) ||
     prompt_chpwd() {
         FORCE_RUN_VCS_INFO=1
     }
-    add-zsh-hook chpwd prompt_chpwd
+    chpwd_functions+=(prompt_chpwd)
 
     # Used by prompt code below to determine if vcs_info should be run.
     RUN_VCS_INFO=1
@@ -259,6 +293,53 @@ else
     RUN_VCS_INFO=
 fi
 
+typeset -a longrun_data
+longrun_data=()
+# Display runtime in seconds for long running programs (> 60 seconds) and send
+# a bell to notify me.
+longrun_preexec() {
+    local program="$3"
+
+    # Handle fg.
+    local REPLY
+    resolve_fg_to_resumed_job_name "$program"
+    program="$REPLY"
+
+    # Don't track the time for certain (possible) long running processes which
+    # need no automatic notification.
+    for ignore in elinks man mutt vim; do
+        case $program in
+            $ignore | $ignore\ *)
+                longrun_data=()
+                return
+                ;;
+        esac
+    done
+
+    longrun_data=("$program" $EPOCHSECONDS)
+}
+longrun_precmd() {
+    # No previous timestamp available or disabled for this command, ignore.
+    if [[ -z $longrun_data ]]; then
+        return
+    fi
+
+    local difference=$(( EPOCHSECONDS - longrun_data[2] ))
+    if [[ $difference -gt 60 ]]; then
+        echo
+        echo -n "${fg[yellow]}"
+        echo -n "~> ${(V)longrun_data[1]} took $difference seconds."
+        echo -n "${fg[default]}"
+        echo    "\a" # send bell
+    fi
+
+    # Clear status. Prevents displaying old status information when pressing
+    # enter with an empty command line.
+    longrun_data=()
+}
+preexec_functions+=(longrun_preexec)
+precmd_functions+=(longrun_precmd)
+
 # Set the prompt. A two line prompt is used. On the top left the current
 # working directory is displayed, on the right vcs_info (if available) and the
 # current time in hex. On the bottom left current user name and host is shown,
@@ -266,7 +347,8 @@ fi
 # if not 0.
 #
 # The prompt is in green and blue to make easily detectable, the error exit
-# code in red and bold and the job count in yellow.
+# code in red and bold and the job count in yellow. Designed for dark
+# terminals.
 #
 # Thanks to Adam's prompt for the basic idea of this prompt.
 prompt_precmd() {
@@ -282,52 +364,79 @@ prompt_precmd() {
         vcs_info_msg_0_=
     fi
 
-    local width width_left width_right
-    local top_left top_right
-
-    # Display the current time in HEX in bright blue and vcs_info (if used) on
-    # the right in the top prompt.
-    top_right="$vcs_info_msg_0_($blue%B0x$(([##16] EPOCHSECONDS))%b$default)"
-    width_right=${#${(S%%)top_right//$~zero/}}
-    # Remove it if it would get too long.
-    if [[ $(( COLUMNS - 4 - 1 - width_right )) -lt 0 ]]; then
-        top_right=
-        width_right=0
+    # Setup. Create variables holding the formatted content.
+
+    # Current directory in yellow, truncated if necessary (WIDTH is replaced
+    # below).
+    local directory="${yellow}%WIDTH<..<%~%<<${default}"
+
+    # Information about the VCS in this directory.
+    local vcs="${vcs_info_msg_0_}"
+    # Current time (seconds since epoch) in Hex in bright blue.
+    local seconds="${blue}%B0x$(([##16] EPOCHSECONDS))%b${default}"
+
+    # User name (%n) in bright green.
+    local user="${green}%B%n%b${default}"
+    # Host name (%m) in bright green; underlined if running on a remote system
+    # through SSH.
+    local host="${green}%B%m%b${default}"
+    if [[ -n $SSH_CONNECTION ]]; then
+        host="%U${host}%u"
     fi
 
-    # Display current directory on the left in the top prompt. Truncate the
-    # directory if necessary.
-    width=$(( COLUMNS - 4 - 1 - width_right ))
-    top_left=".-$default%b($yellow%$width<..<%~%<<$default)%B$blue"
+    # Number of background processes in yellow if not zero.
+    local background="%(1j.${yellow}%j${default}.)"
+    # Exit code in bright red in parentheses if not zero.
+    local exitcode="%(?..(${red}%B%?%b${default}%) )"
+
+    # Prefix characters in first and second line.
+    local top_prefix="${blue}%B.-%b${default}"
+    local bottom_prefix="${blue}%B'%b${default}"
+
+    # Combine them to create the prompt.
+
+    local top_right="${vcs}(${seconds})"
+
+    local width_top_prefix=${#${(S%%)top_prefix//$~zero/}}
+    local width_top_right=${#${(S%%)top_right//$~zero/}}
+
+    # Calculate the maximum width of ${top_left}. -2 are the braces of
+    # ${top_left}, -1 is one separator from ${top_separator} (we want at least
+    # one between left and right parts).
+    local top_left_width_max=$((
+        COLUMNS - $width_top_prefix - 2 - 1 - $width_top_right
+    ))
+    # Truncate directory if necessary.
+    local top_left="(${directory/WIDTH/${top_left_width_max}})"
+    local width_top_left=${#${(S%%)top_left//$~zero/}}
 
     # Calculate the width of the top prompt to fill the middle with "-".
-    width_left=${#${(S%%)top_left//$~zero/}}
-    width_right=${#${(S%%)top_right//$~zero/}}
-    width=$(( COLUMNS - width_left - width_right ))
-
-    PROMPT="$blue%B$top_left${(l:$width::-:)}%b$default$top_right
-$blue%B'%b$default\
-$green%B%n%b$default@$green%B%m%b$default %(1j.$yellow%j$default.)%# \
-%(?..($red%B%?%b$default%) )"
+    local width=$((
+        COLUMNS - width_top_prefix - width_top_left - width_top_right
+    ))
+    local top_separator="%B${blue}${(l:${width}::-:)}%b${default}"
+
+    PROMPT="${top_prefix}${top_left}${top_separator}${top_right}
+${bottom_prefix}${user}@${host} ${background}%# ${exitcode}"
 }
-add-zsh-hook precmd prompt_precmd
+precmd_functions+=(prompt_precmd)
 
 
-# When screen, xterm or rxvt is used set the name of the window to the
-# currently running program.
+# When GNU screen, tmux, xterm or rxvt is used set the name of the window to
+# the currently running program.
 #
 # When a program is started preexec() sets the window's name to it; when it
 # stops precmd() resets the window's name to 'zsh'. 'fg' is supported and sets
 # the window's name to the resumed job.
 #
-# It works with screen, xterm and rxvt.
+# It works with GNU screen, tmux, xterm and rxvt.
 #
 # If a command is run with sudo or if the shell is running as root then a ! is
 # added at the beginning of the command to make this clear. If a command is
 # running on a different computer with ssh a @ is added at the beginning. If
-# screen is running on the remote machine instead of @screen @:hostname
-# (hostname replaced by the machine's hostname) is displayed. This only works
-# if the .zshrc on the server also uses this command.
+# screen/tmux is running on the remote machine instead of @screen @:hostname
+# (or @tmux ..; hostname replaced by the machine's hostname) is displayed.
+# This only works if the .zshrc on the server also uses this command.
 #
 # screen* is necessary as `screen` uses screen.linux for example for a linux
 # console.
@@ -344,7 +453,7 @@ if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
         # Get the program name with its arguments.
         local program_name=$1
 
-        # When sudo is used use real program name instead, but with an
+        # When sudo is used, use real program name instead, but with an
         # exclamation mark at the beginning (handled below).
         local program_sudo=
         if [[ $program_name == sudo* ]]; then
@@ -352,12 +461,10 @@ if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
             program_sudo=yes
         fi
 
-        # Replace fg with the resumed job name.
-        if [[ $program_name == fg ]]; then
-            program_name=${jobtexts[%+]}
-        elif [[ $program_name == fg* ]]; then
-            program_name=${jobtexts[${program_name#fg }]}
-        fi
+        # Handle fg.
+        local REPLY
+        resolve_fg_to_resumed_job_name "$program_name"
+        program_name="$REPLY"
 
         # Remove all arguments from the program name.
         program_name=${program_name%% *}
@@ -396,10 +503,10 @@ if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
 
             # If screen is running in SSH then display "@:hostname" as title
             # in the term/outer screen.
-            if [[ $program_name == @screen ]]; then
+            if [[ $program_name == @screen || $program_name == @tmux ]]; then
                 program_name="@:${HOST//.*/}"
             # Use "@:!hostname" for root screens.
-            elif [[ $program_name == @!screen ]]; then
+            elif [[ $program_name == @!screen || $program_name == @!tmux ]]; then
                 program_name="@:!${HOST//.*/}"
             fi
         fi
@@ -436,9 +543,9 @@ if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
         window_reset=
     }
 
-    # Sets the window title. Works with screen, xterm and rxvt. (V) escapes
-    # all non-printable characters. Thanks to Mikachu in #zsh on Freenode
-    # (2010-08-07 17:09 CEST).
+    # Sets the window title. Works with GNU screen, tmux (which uses screen as
+    # TERM), xterm and rxvt. (V) escapes all non-printable characters, thanks
+    # to Mikachu in #zsh on Freenode (2010-08-07 17:09 CEST).
     if [[ $TERM == screen* ]]; then
         window_title() {
             print -n "\ek${(V)1}\e\\"
@@ -453,8 +560,8 @@ if [[ $TERM == screen* || $TERM == xterm* || $TERM == rxvt* ]]; then
     fi
 
     # Add the preexec() and precmd() hooks.
-    add-zsh-hook preexec window_preexec
-    add-zsh-hook precmd window_precmd
+    preexec_functions+=(window_preexec)
+    precmd_functions+=(window_precmd)
 else
     # Fallback if another TERM is used, necessary to run screen (see below in
     # "RUN COMMANDS").
@@ -494,10 +601,20 @@ setopt completeinword
 zstyle ':completion:::::' completer \
     _expand _complete _prefix _ignored _approximate
 
-# Try uppercase if the currently typed string doesn't match. This allows
-# typing in lowercase most of the time and completion fixes the case. Don't
-# perform these fixes in _approximate to prevent it from changing the input
-# too much. Thanks to the book "From Bash to Z Shell" page 249.
+# Match specification to be tried when completing items. Each group ('...') is
+# tried after another if no matches were found, once matches are found no
+# other groups are tried. Thanks to Mikachu in #zsh on Freenode (2012-08-28
+# 18:48 CEST) for explanations.
+#
+# When matching also include the uppercase variant of typed characters
+# ('m:{a-z}={A-Z}'); using '' before this group would try the unmodified match
+# first, but I prefer to get all matches immediately (e.g. if Makefile and
+# makefile exist in the current directory echo m<tab> matches both, with '' it
+# would only match makefile because it found one match). This allows typing in
+# lowercase most of the time and completion fixes the case, which is faster.
+#
+# Don't perform these fixes in _approximate to prevent it from changing the
+# input too much. Thanks to the book "From Bash to Z Shell" page 249.
 zstyle ':completion:*:(^approximate):*' matcher-list 'm:{a-z}={A-Z}'
 
 # Allow one mistake per three characters. Thanks to the book "From Bash to Z
@@ -526,7 +643,7 @@ zstyle ':completion:*' list-colors ${(s.:.)LS_COLORS}
 # is no longer displayed. Display current position in percent (%p).
 zstyle ':completion:*:default' list-prompt '%p'
 # Display group name (%d) (like 'external command', 'alias', etc.), in bold.
-# Also display a message if _approximate found errors and if no matches were
+# Also display a message if _approximate found errors and no matches were
 # found.
 zstyle ':completion:*'             format '    %B%d%b:'
 zstyle ':completion:*:corrections' format '    %B%d%b (errors: %e)'
@@ -585,6 +702,12 @@ bindkey '^F' complete-files
 # <nyh@math.technion.ac.il> for a fix (-r) to handle whitespace/quotes
 # correctly, both on the Zsh mailing list.
 TRAPINT() {
+    # Don't store this line in history if histignorespace is enabled and the
+    # line starts with a space.
+    if [[ -o histignorespace && ${BUFFER[1]} = " " ]]; then
+        return $1
+    fi
+
     # Store the current buffer in the history.
     zle && print -s -r -- $BUFFER
 
@@ -600,15 +723,21 @@ fi
 # Make sure aliases are expanded when using sudo.
 alias sudo='sudo '
 
-# Global aliases for often used commands in the command line.
+# Global aliases for often used redirections.
 alias -g E='2>&1'
-alias -g L='E | less'
-alias -g D='E | colordiff L'
+alias -g N='>/dev/null'
+alias -g EN='2>/dev/null'
+alias -g L='2>&1 | less'
+alias -g LS='2>&1 | less -S' # -S prevents wrapping of long lines
+alias -g D='2>&1 | colordiff | less'
+# Global aliases for often used commands.
+alias -g A='| awk'
 alias -g G='| grep'
-alias -g S='| sort'
-alias -g U='| uniq'
 alias -g H='| head'
+alias -g P='| perl'
+alias -g S='| sort'
 alias -g T='| tail'
+alias -g U='| uniq'
 
 # Make going up directories simple.
 alias -g ...='../..'
@@ -630,25 +759,38 @@ fi
 # Display all branches (except stash) in gitk but only 200 commits as this is
 # much faster. Also put in the background and disown. Thanks to drizzd in #git
 # on Freenode (2010-04-03 17:55 CEST).
-gitk() {
+(( $+commands[gitk] )) && gitk() {
     command gitk --max-count=200 --branches --remotes --tags "$@" &
     disown %command
 }
 # Same for tig (except the disown part as it's no GUI program).
-tig() {
+(( $+commands[tig] )) && tig() {
     command tig --max-count=200 --branches --remotes --tags "$@"
 }
 
 # Pipe output through less.
-tree() {
+(( $+commands[tree] )) && tree() {
     command tree -C "$@" | less
 }
 
-# Automatically disown.
-xpdf() {
-    command xpdf "$@" &
-    disown %command
-}
+# Choose the "best" PDF viewer available: xpdf, then zathura (in the past
+# zathura was preferred, but recent versions are completely broken: still no
+# working search and no page-wise scrolling anymore). Also setup completion
+# for `pdf`.
+if (( $+commands[xpdf] )); then
+    pdf() {
+        command xpdf "$@" 2>/dev/null &
+        disown %command
+    }
+    compdef _xpdf pdf
+elif (( $+commands[zathura] )); then
+    pdf() {
+        command zathura "$@" 2>/dev/null &
+        disown %command
+    }
+    # No completion for zathura yet.
+    compdef _xpdf pdf
+fi
 
 # GHCI doesn't use readline, force it if rlwrap is available.
 (( $+commands[rlwrap] )) && ghci() {
@@ -673,26 +815,48 @@ fi
 
 # LOAD ADDITIONAL CONFIGURATION FILES
 
+# Configuration option for rc.local to use GNU screen/tmux. By default GNU
+# screen is used. Possible values: screen, tmux and empty (no value).
+use_multiplexer=screen
+
 source_config ~/.zsh/rc.local
 
 
 # RUN COMMANDS
 
-# If not already in screen reattach to a running session or create a new one.
-# This also starts screen on a remote server when connecting through ssh.
-if [[ $TERM != dumb && $TERM != linux && -z $STY ]]; then
+# If not already in screen or tmux, reattach to a running session or create a
+# new one. This also starts screen/tmux on a remote server when connecting
+# through ssh.
+if [[ $TERM != dumb && $TERM != linux && -z $STY && -z $TMUX ]]; then
     # Get running detached sessions.
-    session=$(screen -list | grep 'Detached' | awk '{ print $1; exit }')
+    if [[ $use_multiplexer = screen ]]; then
+        session=$(screen -list | grep 'Detached' | awk '{ print $1; exit }')
+    elif [[ $use_multiplexer = tmux ]]; then
+        session=$(tmux list-sessions 2>/dev/null \
+                  | sed '/(attached)$/ d; s/^\([0-9]\{1,\}\).*$/\1/; q')
+    fi
 
     # As we exec later we have to set the title here.
-    window_preexec "screen"
+    if [[ $use_multiplexer = screen ]]; then
+        window_preexec "screen"
+    elif [[ $use_multiplexer = tmux ]]; then
+        window_preexec "tmux"
+    fi
 
     # Create a new session if none is running.
     if [[ -z $session ]]; then
-        exec screen
+        if [[ $use_multiplexer = screen ]]; then
+            exec screen
+        elif [[ $use_multiplexer = tmux ]]; then
+            exec tmux
+        fi
     # Reattach to a running session.
     else
-        exec screen -r $session
+        if [[ $use_multiplexer = screen ]]; then
+            exec screen -r $session
+        elif [[ $use_multiplexer = tmux ]]; then
+            exec tmux attach-session -t $session
+        fi
     fi
 fi
 
@@ -704,16 +868,19 @@ fi
 # cases it doesn't work, the E alias can be used as workaround.
 #
 # Moved in the "run commands" section to prevent one unnecessary zsh process
-# when starting screen (see above).
+# when starting GNU screen/tmux (see above).
 exec 2>>(while read -r -k -u 0 line; do
     printf '\e[91m%s\e[0m' "$line";
     print -n $'\0';
 done &)
 
-# Run reminder and redisplay it every four hours (if it's available).
+# Run the following programs every 4 hours (and when zsh starts).
 PERIOD=14400
 periodic() {
-    which rem > /dev/null && [ -f ~/.reminders ] && rem -h
+    # Display fortunes.
+    (( $+commands[fortune] )) && fortune -ac
+    # Display reminders.
+    (( $+commands[rem] )) && [[ -f ~/.reminders ]] && rem -h
 }