Bump version to 0.6.0

This means that "init" session layouts can now be used to start and/or
re-attach to your main session.

Personally I have a "main" session layout with a couple of default
windows. I can now either start that session, or re-attach to it from
outside of Tmux by just running `tmuxifier s main`, instead of manually
creating a session named "main" and then loading my windows into it.

README.md

@@ -33,9 +33,10 @@ looks like:
 ```bash
 window_root "~/Desktop"
 new_window "Example Window"
-tmux split-window -t "$session:$window.0" -v -p 20 "watch -t date"
+split_v 20
-tmux split-window -t "$session:$window.1" -h -p 60
+run_cmd "watch -t date"
-tmux select-pane -t "$session:$window.0"
+split_h 60
+select_pane 0
 ```
 
 You can then load that window layout into a new window in the
@@ -51,16 +52,31 @@ Which will yield a Tmux window looking like this:
 
 ## Installation
 
+Clone the repo to your machine:
+
 ```bash
 git clone https://github.com/jimeh/tmuxifier.git ~/.tmuxifier
 ```
 
-And add the following to your `~/.profile`, `~/.bash_profile` or equivalent:
+### bash & zsh
+
+And add the following to your `~/.profile`, `~/.bash_profile`, `~/.zshrc` or
+equivalent:
 
 ```bash
 [[ -s "$HOME/.tmuxifier/init.sh" ]] && source "$HOME/.tmuxifier/init.sh"
 ```
 
+### tcsh
+
+Add the following to your `~/.cshrc`, `~/.tcshrc` or equivalent:
+
+```tcsh
+if ( -s "$HOME/.tmuxifier/init.sh" ) then
+  source "$HOME/.tmuxifier/init.sh"
+endif
+```
+
 ## Usage
 
 *__Note:__ This section needs expanding upon.*
@@ -116,8 +132,8 @@ in it.
 ### Custom Installaton Path
 
 To install Tmuxifier to a custom path, clone the repository to your desired
-path and set `$TMUXIFIER` to that path, additionally loading `init.sh` from
+path and set `$TMUXIFIER` to that path, additionally loading `init.sh` or
-that same path.
+`init.tcsh` from that same path.
 
 ```bash
 export TMUXIFIER="$HOME/.dotfiles/tmuxifier"
@@ -135,7 +151,7 @@ export TMUXIFIER_LAYOUT_PATH="$HOME/.tmux-layouts"
 
 ### Disable Shell-Completion
 
-Tmuxifier comes with shell-completion for bash and zsh. If for any
+Tmuxifier comes with shell-completion for bash, zsh and tcsh. If for any
 reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`.
 
 ```bash
@@ -151,7 +167,7 @@ export TMUXIFIER_NO_COMPLETE=1
 ## Tmuxifier vs. Tmuxinator
 
 Though Tmuxifier is largely inspired by the excellent [Tmuxinator][] project,
-but does set itself apart in a number of ways:
+it does set itself apart in a number of ways:
 
 - Uses shell scripts to define Tmux sessions and windows instead of YAML
   files. The benefit is total control over Tmux, but the definition files are
@@ -184,7 +200,7 @@ But if that doesn't put you off, please enjoy Tmuxifier :)
 
 (The MIT license)
 
-Copyright (c) 2012 Jim Myhrberg.
+Copyright (c) 2013 Jim Myhrberg.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

bin/tmuxifier

@@ -9,7 +9,7 @@ else
 fi
 
 # Load tmuxifier environment variables.
-source "$TMUXIFIER/env.sh"
+source "$TMUXIFIER/lib/env.sh"
 
 export PATH="$TMUXIFIER/libexec:$PATH"
 

completion/tmuxifier.tcsh

@@ -0,0 +1,2 @@
+complete tmuxifier 'p@1@`tmuxifier commands`@' \
+                   'p@2@`tmuxifier completions $:-1`@'

examples/example.window.sh

@@ -7,8 +7,9 @@ window_root "~/Desktop"
 new_window "Example Window"
 
 # Split window into panes.
-tmux split-window -t "$session:$window.0" -v -p 20 "watch -t date"
+split_v 20
-tmux split-window -t "$session:$window.1" -h -p 60
+run_cmd "watch -t date"
+split_h 60
 
 # Set active pane.
-tmux select-pane -t "$session:$window.0"
+select_pane 0

init.tcsh

@@ -0,0 +1,13 @@
+# Set tmuxifier root path.
+if ( ! $?TMUXIFIER ) then
+  setenv TMUXIFIER "${HOME}/.tmuxifier"
+endif
+
+# Add `bin` directroy to `$PATH`.
+set path = ( $TMUXIFIER/bin $path )
+
+# If `tmuxifier` is available, and `$TMUXIFIER_NO_COMPLETE` is not set, then
+# load tmuxifier shell completion.
+if ( ! $?TMUXIFIER_NO_COMPLETE ) then
+  which tmuxifier > /dev/null && source "$TMUXIFIER/completion/tmuxifier.tcsh"
+endif

lib/layout-helpers.sh

@@ -17,8 +17,8 @@ new_window() {
   if [ -n "$2" ]; then local command=("$2"); fi
   if [ -n "$window" ]; then local winarg=(-n "$window"); fi
 
-  if [ -n "$window_root" ]; then cd "$window_root"; fi
   tmux new-window -t "$session:" "${winarg[@]}" "${command[@]}"
+  __go_to_window_or_session_path
 }
 
 # Split current window/pane vertically.
@@ -30,6 +30,7 @@ new_window() {
 split_v() {
   if [ -n "$1" ]; then local percentage=(-p "$1"); fi
   tmux split-window -t "$session:$window.$2" -v "${percentage[@]}"
+  __go_to_window_or_session_path
 }
 
 # Split current window/pane horizontally.
@@ -41,6 +42,7 @@ split_v() {
 split_h() {
   if [ -n "$1" ]; then local percentage=(-p "$1"); fi
   tmux split-window -t "$session:$window.$2" -h "${percentage[@]}"
+  __go_to_window_or_session_path
 }
 
 # Select a specific window.
@@ -61,6 +63,16 @@ select_pane() {
   tmux select-pane -t "$session:$window.$1"
 }
 
+# Send/paste keys to the currently active pane/window.
+#
+# Arguments:
+#   - $1: String to paste.
+#   - $2: (optional) Target pane ID to send input to.
+#
+send_keys() {
+  tmux send-keys -t "$session:$window.$2" "$1"
+}
+
 # Runs a shell command in the currently active pane/window.
 #
 # Arguments:
@@ -68,8 +80,8 @@ select_pane() {
 #   - $2: (optional) Target pane ID to run command in.
 #
 run_cmd() {
-  tmux send-keys -t "$session:$window.$2" -l "$1"
+  send_keys "$1" "$2"
-  tmux send-keys -t "$session:$window.$2" "C-m"
+  send_keys "C-m" "$2"
 }
 
 # Cusomize session root path. Default is `$HOME`.
@@ -170,12 +182,10 @@ initialize_session() {
     fi
 
     # In order to ensure only specified windows are created, we move the
-    # default window to position 99, and later remove it with the
+    # default window to position 999, and later remove it with the
-    # `finalize_session` function.
+    # `finalize_and_go_to_session` function.
-    tmux move-window -s "$session:0" -t "$session:99"
+    local first_window_index=$(__get_first_window_index)
-
+    tmux move-window -s "$session:$first_window_index" -t "$session:999"
-    # Ensure correct pane splitting.
-    __go_to_session
 
     # Session created, return ok exit status.
     return 0
@@ -195,7 +205,7 @@ initialize_session() {
 # to it here.
 #
 finalize_and_go_to_session() {
-  ! tmux kill-window -t "$session:99" 2>/dev/null
+  ! tmux kill-window -t "$session:999" 2>/dev/null
   if [[ "$(tmuxifier-current-session)" != "$session" ]]; then
     __go_to_session
   fi
@@ -217,6 +227,16 @@ __expand_path() {
   echo $(eval echo "$@")
 }
 
+__get_first_window_index() {
+  local index
+  index=$(tmux list-windows -t "$session:" -F "#{window_index}" 2>/dev/null)
+  if [ -n "$index" ]; then
+    echo "$index" | head -1
+  else
+    echo "0"
+  fi
+}
+
 __go_to_session() {
   if [ -z "$TMUX" ]; then
     tmux -u attach-session -t "$session:"
@@ -224,3 +244,11 @@ __go_to_session() {
     tmux -u switch-client -t "$session:"
   fi
 }
+
+__go_to_window_or_session_path() {
+  local window_or_session_root=${window_root-$session_root}
+  if [ -n "$window_or_session_root" ]; then
+    run_cmd "cd \"$window_or_session_root\""
+    send_keys "C-l"
+  fi
+}

lib/runtime.sh

@@ -3,7 +3,7 @@
 #
 
 # Load tmuxifier environment.
-source "$TMUXIFIER/env.sh"
+source "$TMUXIFIER/lib/env.sh"
 
 # Setup default variables.
 session_root="$HOME"

libexec/tmuxifier-alias

@@ -2,6 +2,14 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier alias <alias>
+
+Resolve a command alias to it's full name."
+  exit
+fi
+
 case "$1" in
   "session" | "ses" | "s" )
     echo "load-session"
@@ -9,25 +17,25 @@ case "$1" in
   "window" | "win" | "w" )
     echo "load-window"
     ;;
-  "new-ses" | "ns" )
+  "new-ses" | "nses" | "ns" )
     echo "new-session"
     ;;
-  "new-win" | "nw" )
+  "new-win" | "nwin" | "nw" )
     echo "new-window"
     ;;
-  "edit-ses" | "es" )
+  "edit-ses" | "eses" | "es" )
     echo "edit-session"
     ;;
-  "edit-win" | "ew" )
+  "edit-win" | "ewin" | "ew" )
     echo "edit-window"
     ;;
-  "ls" )
+  "l" )
     echo "list"
     ;;
-  "list-ses" | "lss" )
+  "list-ses" | "lses" | "ls" )
     echo "list-sessions"
     ;;
-  "list-win" | "lsw" )
+  "list-win" | "lwin" | "lw" )
     echo "list-windows"
     ;;
   * )

libexec/tmuxifier-commands

@@ -2,6 +2,15 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier commands
+
+List all available commands, includes internal commands not intended for
+normal use by users."
+  exit
+fi
+
 shopt -s nullglob
 
 { for path in ${PATH//:/$'\n'}; do

libexec/tmuxifier-completions

@@ -2,6 +2,14 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier completion <command>
+
+Print a list of available completions for specified command."
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   tmuxifier-commands
@@ -9,16 +17,15 @@ if [ "$1" == "--complete" ]; then
 fi
 
 has-completions() {
-  grep -i "^# provide tmuxifier completions" "$1" >/dev/null
+  grep -i "^# Provide tmuxifier completions" "$1" >/dev/null
 }
 
-command="$1"
+if [ -z "$1" ]; then
-if [ -z "$command" ]; then
   echo "$(tmuxifier-help completions)" >&2
   exit 1
 fi
 
-! command_path="$(tmuxifier-resolve-command-path "$command")"
+! command_path="$(tmuxifier-resolve-command-path "$1")"
 
 if [ -n "$command_path" ] && has-completions "$command_path"; then
   shift

libexec/tmuxifier-current-session

@@ -2,12 +2,18 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier current-session
+
+Outputs the name of the current Tmux session."
+  exit
+fi
+
 if [ -n "$TMUX" ]; then
-  for item in $(tmux list-sessions -F "#{?session_attached,1,0}:#S"); do
+  for item in $(tmux list-pane -F "#{session_name}");do
-    if [[ "$item" == "1:"* ]]; then
+    echo $item
-      echo ${item/1:/}
+    exit 0
-      exit 0
-    fi
   done
 fi
 

libexec/tmuxifier-edit-session

@@ -2,6 +2,16 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier edit-session <layout_name>
+
+Aliases: edit-ses, eses, es
+
+Open specified session layout for editing in \$EDITOR."
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   for item in $(tmuxifier-list-sessions); do

libexec/tmuxifier-edit-window

@@ -2,6 +2,16 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier edit-window <layout_name>
+
+Aliases: edit-win, ewin, ew
+
+Open specified window layout for editing in \$EDITOR."
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   for item in $(tmuxifier-list-windows); do

libexec/tmuxifier-help

@@ -2,33 +2,33 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  tmuxifier-help
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   tmuxifier-commands
   exit
 fi
 
+has-help() {
+  grep -i "^# Provide tmuxifier help" "$1" >/dev/null
+}
+
 command="$1"
-
+if [ -z "$1" ]; then
-# Ensure we have the correct command name in case an alias was given.
+  echo "usage: tmuxifier <command> [<args>]
-if [ -n "$command" ]; then
-  ! resolved="$(tmuxifier-alias "$command")"
-  if [ -n "$resolved" ]; then
-    command="$resolved"
-  fi
-fi
-
-case "$command" in
-  "" )
-    echo "usage: tmuxifier <command> [<args>]
 
 Some useful tmuxifier commands are:
    <command>      <alias>
    load-session   s        Load the specified session layout.
    load-window    w        Load the specified window layout into current session.
-   list           ls       List all session and window layouts.
+   list           l        List all session and window layouts.
-   list-sessions  lss      List session layouts.
+   list-sessions  ls       List session layouts.
-   list-windows   lsw      List window layouts.
+   list-windows   lw       List window layouts.
    new-session    ns       Create new session layout and open it with \$EDITOR.
    new-window     nw       Create new window layout and open it with \$EDITOR.
    edit-session   es       Edit specified session layout with \$EDITOR.
@@ -38,87 +38,25 @@ Some useful tmuxifier commands are:
    help                    Show this message.
 
 See 'tmuxifier help <command>' for information on a specific command."
-    ;;
+  exit
-  "load-session" )
+fi
-    echo "usage: tmuxifier load-session <layout_name>
 
-Aliases: session, ses, s
+! command_path="$(tmuxifier-resolve-command-path "$1")"
 
-Create a session using the session layout, unless the session already exists
+if [ -z "$command_path" ]; then
-in which case, we simply switch to the existing one."
+  echo "tmuxifier: no such command '$1'" >&2
-    ;;
+  exit 1
-  "load-window" )
+fi
-    echo "usage: tmuxifier load-window <layout_name>
 
-Aliases: window, win, w
+if has-help "$command_path"; then
-
+  shift
-Create a new window using the specified window layout in the current session."
+  exec "$command_path" --help "$@"
-    ;;
+else
-  "new-session" )
+  command="$(basename "$command_path")"
-    echo "usage: tmuxifier new-session <layout_name>
+  command="${command/tmuxifier\-/}"
-
+  echo "Sorry, the '$command' command isn't documented yet."
-Aliases: new-ses, ns
+  echo ""
-
+  echo "You can view the command's source here:"
-Create a new session layout and open it for editing in \$EDITOR."
+  echo "$command_path"
-    ;;
+  echo ""
-  "new-window" )
+fi
-    echo "usage: tmuxifier new-window <layout_name>
-
-Aliases: new-win, ws
-
-Create a new window layout and open it for editing in \$EDITOR."
-    ;;
-  "edit-session" )
-    echo "usage: tmuxifier edit-session <layout_name>
-
-Aliases: edit-ses, es
-
-Open specified session layout for editing in \$EDITOR."
-    ;;
-  "edit-window" )
-    echo "usage: tmuxifier edit-window <layout_name>
-
-Aliases: edit-win, ew
-
-Open specified window layout for editing in \$EDITOR."
-    ;;
-  "completions" )
-    echo "usage: tmuxifier completion <command>
-
-Print a list of available completions for specified command."
-    ;;
-  "list" )
-    echo "usage: tmuxifier list
-
-Aliases: ls
-
-List all available session and window layouts."
-    ;;
-  "list-sessions" )
-    echo "usage: tmuxifier list-sessions
-
-Aliases: list-ses, lss
-
-List all session layouts."
-    ;;
-  "list-windows" )
-    echo "usage: tmuxifier list-windows
-
-Aliases: list-win, lsw
-
-List all window layouts."
-    ;;
-  * )
-    ! command_path="$(tmuxifier-resolve-command-path "$command")"
-    if [ -n "$command_path" ]; then
-      echo "Sorry, the '$command' command isn't documented yet."
-      echo
-      echo "You can view the command's source here:"
-      echo "$command_path"
-      echo
-    else
-      echo "tmuxifier: no such command '$command'" >&2
-      exit 1
-    fi
-    ;;
-esac

libexec/tmuxifier-list

@@ -2,10 +2,24 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier list
+
+Aliases: l
+
+List all available session and window layouts."
+  exit
+fi
+
 echo ""
 echo "Sessions:"
-tmuxifier-list-sessions
+for item in $(tmuxifier-list-sessions); do
+  echo " - $item"
+done
 echo ""
 echo "Windows:"
-tmuxifier-list-windows
+for item in $(tmuxifier-list-windows); do
+  echo " - $item"
+done
 echo ""

libexec/tmuxifier-list-sessions

@@ -2,8 +2,18 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-list=$(find "$TMUXIFIER_LAYOUT_PATH" -name "*.session.sh")
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier list-sessions
+
+Aliases: list-ses, lses, ls
+
+List all session layouts."
+  exit
+fi
+
+list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.session.sh")
 for file in $list; do
   file=${file/$TMUXIFIER_LAYOUT_PATH\//}
-  echo "  ${file/.session.sh/}"
+  echo "${file/.session.sh/}"
 done

libexec/tmuxifier-list-windows

@@ -2,8 +2,18 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-list=$(find "$TMUXIFIER_LAYOUT_PATH" -name "*.window.sh")
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier list-windows
+
+Aliases: list-win, lwin, lw
+
+List all window layouts."
+  exit
+fi
+
+list=$(find -L "$TMUXIFIER_LAYOUT_PATH" -name "*.window.sh")
 for file in $list; do
   file=${file/$TMUXIFIER_LAYOUT_PATH\//}
-  echo "  ${file/.window.sh/}"
+  echo "${file/.window.sh/}"
 done

libexec/tmuxifier-load-session

@@ -2,6 +2,17 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier load-session <layout_name>
+
+Aliases: session, ses, s
+
+Create a session using the session layout, unless the session already exists
+in which case, we simply attach/switch to the existing one."
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   for item in $(tmuxifier-list-sessions); do
@@ -16,11 +27,7 @@ if [ -z "$1" ]; then
 fi
 
 # Load runtime functions.
-source "$TMUXIFIER/runtime.sh"
+source "$TMUXIFIER/lib/runtime.sh"
 
-if [ ! -z $TMUX ]; then
+# Load session file.
-  load_session "$1"
+load_session "$1"
-else
-  echo "tmuxifier: 'load-session' command can only be used from within Tmux."
-  exit 1
-fi

libexec/tmuxifier-load-window

@@ -2,6 +2,16 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier load-window <layout_name>
+
+Aliases: window, win, w
+
+Create a new window using the specified window layout in the current session."
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   for item in $(tmuxifier-list-windows); do
@@ -16,7 +26,7 @@ if [ -z "$1" ]; then
 fi
 
 # Load runtime functions.
-source "$TMUXIFIER/runtime.sh"
+source "$TMUXIFIER/lib/runtime.sh"
 
 if [ ! -z $TMUX ]; then
   session="$(tmuxifier-current-session)"

libexec/tmuxifier-new-session

@@ -2,6 +2,16 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier new-session <layout_name>
+
+Aliases: new-ses, nses, ns
+
+Create a new session layout and open it for editing in \$EDITOR."
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   for item in $(tmuxifier-list-sessions); do

libexec/tmuxifier-new-window

@@ -2,6 +2,16 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier new-window <layout_name>
+
+Aliases: new-win, nwin, nw
+
+Create a new window layout and open it for editing in \$EDITOR."
+  exit
+fi
+
 # Provide tmuxifier completions
 if [ "$1" == "--complete" ]; then
   for item in $(tmuxifier-list-windows); do

libexec/tmuxifier-resolve-command-path

@@ -2,6 +2,14 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier resolve-command-path <command_or_alias>
+
+Outputs the absolute path to the given command or command alias."
+  exit
+fi
+
 if [ -n "$1" ]; then
   ! command_path="$(command -v "tmuxifier-$1")"
   if [ -z "$command_path" ]; then

libexec/tmuxifier-version

@@ -2,4 +2,12 @@
 set -e
 [ -n "$TMUXIFIER_DEBUG" ] && set -x
 
-echo "0.2.1"
+# Provide tmuxifier help
+if [ "$1" == "--help" ]; then
+  echo "usage: tmuxifier version
+
+Outputs Tmuxifier version."
+  exit
+fi
+
+echo "0.6.0"

templates/window.sh

@@ -14,5 +14,9 @@ new_window "{{WINDOW_NAME}}"
 #run_cmd "top"     # runs in active pane
 #run_cmd "date" 1  # runs in pane 1
 
+# Paste text
+#send_keys "top"    # paste into active pane
+#send_keys "date" 1 # paste into active pane
+
 # Set active pane.
 #select_pane 0