Members/atton/pmux: README.md annotate

annotate README.md @ 3:ea02332d9254

Rename bin file mux -> pmux $ ln -s bin/pmuxinator bin/pmux $ gsed -e 's/tmuxinator/pmuxinator/g' -i bin/* $ gsed -e 's/Tmuxinator/Pmuxinator/g' -i bin/*

author	Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
date	Mon, 21 Jul 2014 08:34:59 +0900
parents	67a6071afec7
children

rev	line source
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	1 # Pmuxinator
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	2
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	3 [![Gem Version](https://badge.fury.io/rb/pmuxinator.png)](http://badge.fury.io/rb/pmuxinator) [![Build Status](https://secure.travis-ci.org/pmuxinator/pmuxinator.png)](http://travis-ci.org/pmuxinator/pmuxinator?branch=master) [![Coverage Status](https://coveralls.io/repos/pmuxinator/pmuxinator/badge.png)](https://coveralls.io/r/pmuxinator/pmuxinator) [![Code Climate](https://codeclimate.com/github/pmuxinator/pmuxinator.png)](https://codeclimate.com/github/pmuxinator/pmuxinator) [![Dependency Status](https://gemnasium.com/pmuxinator/pmuxinator.png)](https://gemnasium.com/pmuxinator/pmuxinator)
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	4
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	5 Create and manage tmux sessions easily.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	6
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	7 ![Screenshot](https://f.cloud.github.com/assets/141213/916084/065fef7c-fe82-11e2-9c23-a9622c7d83c3.png)
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	8
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	9 ## Installation
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	10
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	11 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	12 gem install pmuxinator
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	13 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	14
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	15 ## Editor and Shell
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	16
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	17 pmuxinator uses your shell's default editor for opening files. If you're not
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	18 sure what that is type:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	19
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	20 ``` bash
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	21 echo $EDITOR
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	22 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	23
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	24 For me that produces "vim" If you want to change your default editor simply
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	25 put a line in ~/.bashrc that changes it. Mine looks like this:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	26
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	27 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	28 export EDITOR='vim'
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	29 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	30
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	31 ## tmux
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	32
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	33 The recommended version of tmux to use is 1.8. Your mileage may vary for
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	34 earlier versions. Refer to the FAQ for any odd behaviour.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	35
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	36 ### base-index
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	37
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	38 If you use a `base-index` other than the default, please be sure to also set the `pane-base-index`
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	39
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	40 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	41 set-window-option -g pane-base-index 1
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	42 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	43
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	44 ## Completion
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	45
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	46 Download the appropriate completion file from the repo and `source` the file.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	47 The following are example where the completion file has been downloaded into
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	48 `~/.bin`.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	49
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	50 ### bash
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	51
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	52 Add the following to your `~/.bashrc`:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	53
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	54 source ~/.bin/pmuxinator.bash
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	55
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	56 ### zsh
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	57
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	58 Add the following to your `~/.zshrc`:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	59
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	60 source ~/.bin/pmuxinator.zsh
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	61
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	62 ### fish
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	63
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	64 Move `pmuxinator.fish` to your `completions` folder:
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	65
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	66 cp ~/.bin/pmuxinator.fish ~/.config/completions/
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	67
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	68 ## Usage
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	69
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	70 A working knowledge of tmux is assumed. You should understand what windows and
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	71 panes are in tmux. If not please consult the [man pages](http://manpages.ubuntu.com/manpages/precise/en/man1/tmux.1.html#contenttoc6) for tmux.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	72
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	73 ### Create a project
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	74
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	75 Create or edit your projects with:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	76
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	77 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	78 pmuxinator new [project]
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	79 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	80
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	81 For editing you can also use `pmuxinator open [project]`. `new` is aliased to
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	82 `o`,`open` and `n`. Your default editor (`$EDITOR`) is used to open the file.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	83 If this is a new project you will see this default config:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	84
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	85 ```yaml
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	86 # ~/.pmuxinator/sample.yml
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	87
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	88 name: sample
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	89 root: ~/
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	90
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	91 # Optional. tmux socket
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	92 # socket_name: foo
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	93
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	94 # Runs before everything. Use it to start daemons etc.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	95 # pre: sudo /etc/rc.d/mysqld start
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	96
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	97 # Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	98 # pre_window: rbenv shell 2.0.0-p247
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	99
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	100 # Pass command line options to tmux. Useful for specifying a different tmux.conf.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	101 # tmux_options: -f ~/.tmux.mac.conf
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	102
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	103 # Change the command to call tmux. This can be used by derivatives/wrappers like byobu.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	104 # tmux_command: byobu
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	105
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	106 windows:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	107 - editor:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	108 layout: main-vertical
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	109 panes:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	110 - vim
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	111 - guard
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	112 - server: bundle exec rails s
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	113 - logs: tail -f log/development.log
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	114 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	115
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	116 ## Windows
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	117
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	118 The windows option allows the specification of any number of tmux windows. Each window is denoted by a YAML array entry, followed by a name
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	119 and command to be run.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	120
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	121 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	122 windows:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	123 - editor: vim
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	124 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	125
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	126 ## Panes
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	127
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	128 **_Note that if you wish to use panes, make sure that you do not have `.` in your project name. tmux uses `.` to delimit between window and pane indices,
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	129 and pmuxinator uses the project name in combination with these indices to target the correct pane or window._**
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	130
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	131 Panes are optional and are children of window entries, but unlike windows, they do not need a name. In the following example, the `editor` window has 2 panes, one running vim, the other guard.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	132
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	133 ```yaml
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	134 windows:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	135 - editor:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	136 layout: main-vertical
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	137 panes:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	138 - vim
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	139 - guard
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	140 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	141
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	142 The layout setting gets handed down to tmux directly, so you can choose from
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	143 one of [the five standard layouts](http://manpages.ubuntu.com/manpages/precise/en/man1/tmux.1.html#contenttoc6)
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	144 or [specify your own](http://stackoverflow.com/a/9976282/183537).
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	145
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	146 ## Interpreter Managers & Environment Variables
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	147
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	148 To use pmuxinator with rbenv, RVM, NVM etc, use the `pre_window` option.
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	149
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	150 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	151 pre_window: rbenv shell 2.0.0-p247
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	152 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	153
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	154 These command(s) will run before any subsequent commands in all panes and windows.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	155
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	156 ## Passing directly to send-keys
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	157
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	158 pmuxinator passes commands directly to send keys. This differs from simply chaining commands together using `&&` or `;`, in that
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	159 tmux will directly send the commands to a shell as if you typed them in. This allows commands to be executed on a remote server over
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	160 SSH for example.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	161
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	162 To support this both the window and pane options can take an array as an argument:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	163
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	164 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	165 name: sample
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	166 root: ~/
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	167
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	168 windows:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	169 - stats:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	170 - ssh stats@example.com
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	171 - tail -f /var/log/stats.log
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	172 - logs:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	173 layout: main-vertical
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	174 panes:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	175 - logs:
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	176 - ssh logs@example.com
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	177 - cd /var/logs
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	178 - tail -f development.log
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	179 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	180
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	181 ## Starting a session
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	182
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	183 This will fire up tmux with all the tabs and panes you configured.
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	184
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	185 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	186 pmuxinator start [project]
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	187 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	188
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	189 ## Shorthand
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	190
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	191 A shorthand alias for pmuxinator can also be used.
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	192
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	193 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	194 mux [command]
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	195 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	196
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	197 ## Other Commands
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	198
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	199 Copy an existing project. Aliased to `c` and `cp`
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	200 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	201 pmuxinator copy [existing] [new]
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	202 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	203
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	204 List all the projects you have configured. Aliased to `l` and `ls`
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	205 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	206 pmuxinator list
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	207 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	208
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	209 Remove a project. Aliased to `rm`
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	210 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	211 pmuxinator delete [project]
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	212 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	213
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	214 Remove all pmuxinator configs, aliases and scripts. Aliased to `i`
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	215 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	216 pmuxinator implode
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	217 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	218
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	219 Examines your environment and identifies problems with your configuration
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	220 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	221 pmuxinator doctor
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	222 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	223
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	224 Shows pmuxinator's help. Aliased to `h`
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	225 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	226 pmuxinator help
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	227 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	228
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	229 Shows the shell commands that get executed for a project
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	230 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	231 pmuxinator debug [project]
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	232 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	233
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	234 Shows pmuxinator's version.
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	235 ```
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	236 pmuxinator version
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	237 ```
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	238
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	239 ## FAQ
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	240
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	241 ### Window names are not displaying properly?
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	242
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	243 Add `export DISABLE_AUTO_TITLE=true` to your `.zshrc` or `.bashrc`
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	244
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	245 ## Contributing
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	246
2 67a6071afec7 Rename tmuxinator -> pmuxinator Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: 0 diff changeset	247 To contribute, please read the [contributing guide](https://github.com/pmuxinator/pmuxinator/blob/master/CONTRIBUTING.md).
0 39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	248
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	249 ## Copyright
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	250
39b72942a4d2 Clone tmuxinator from github Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp> parents: diff changeset	251 Copyright (c) 2010-2013 Allen Bargi. See LICENSE for further details.

Mercurial > hg > Members > atton > pmux

annotate README.md @ 3:ea02332d9254