Update readme

This commit is contained in:
2012-04-25 00:37:23 +01:00
parent c23af83df2
commit 2d4c43e737

View File

@@ -1,11 +1,11 @@
# Tmuxifier # Tmuxifier
Tmuxify your Tmux. Create, edit and load complex Tmux session, window and pane Tmuxify your Tmux. Create, edit, mangage and load complex Tmux session, window
configurations with ease. and pane configurations with ease.
In short, Tmuxifier allows you to easily create, edit and load "layout" In short, Tmuxifier allows you to easily create, edit, and load "layout"
files. A layout file is simply a shell script following a specific use pattern files, which are simple shell scripts where you use the `tmux` command and
of the `tmux` command to create Tmux sessions and windows. helper commands provided by tmuxifier to manage Tmux sessions and windows
### Window Layouts ### Window Layouts
@@ -31,9 +31,8 @@ looks like:
[example]: https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh [example]: https://github.com/jimeh/tmuxifier/blob/master/examples/example.window.sh
```bash ```bash
window_name "Example Window"
window_root "~/Desktop" window_root "~/Desktop"
tmux new-window -t "$session" -n "$window" new_window "Example Window"
tmux split-window -t "$session:$window.0" -v -p 20 "watch -t date" tmux split-window -t "$session:$window.0" -v -p 20 "watch -t date"
tmux split-window -t "$session:$window.1" -h -p 60 tmux split-window -t "$session:$window.1" -h -p 60
tmux select-pane -t "$session:$window.0" tmux select-pane -t "$session:$window.0"
@@ -67,7 +66,7 @@ And add the following to your `~/.profile` or equivalent:
### Custom Installaton Path ### Custom Installaton Path
To install Tmuxifier to a custom path, clone the repository to your desired 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` from
that same path. that same path.
```bash ```bash
@@ -86,7 +85,7 @@ export TMUXIFIER_LAYOUT_PATH="$HOME/.tmux-layouts"
### Disable Shell-Completion ### Disable Shell-Completion
Tmuxifier comes with shell-completion for bash and zsh shells. If for any Tmuxifier comes with shell-completion for bash and zsh. If for any
reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`. reason you need to disable it, just set `$TMUXIFIER_NO_COMPLETE`.
```bash ```bash