@@ -8,37 +8,62 @@ tmuxp, a novel approach to manage `tmux(1)`_ (>= 1.8) workspaces through
88 :width: 45%
99 :align: center
1010
11- How tmuxp helps you tmux:
12-
13- - Save your most common tmux session layouts in JSON or YAML. See
14- a `simple `_ or `very elaborate `_ configuration.
15- - Store layouts personally (``~/.tmuxp ``) or include in your project,
16- see ``~/.tmuxp.{yaml,json} ``. See the `author's tmuxp configs `_ and the
17- the projects' `tmuxp.yaml `_.
18- - `Freeze `_ the layout of live sessions.
19- - Automate running such as sourcing into a `virtualenv `_. The configuration
20- also supports per window commands where all panes inherit commands. See
21- `Examples `_.
22- - Run a bootstrapping script to check environment / install dependencies /
23- setup project before loading starts so your development works across
24- systems. See this projects `bootstrap_env.py `_ and `before_script `_ example.
25- - Load tmux sessions in the background by passing ``-d `` flag.
26- - Load multiple tmux configurations ``tmuxp load config1.yaml
27- config2.yaml ``.
28- - Switch sessions from inside a current tmux session. tmuxp will detect
29- if you're in a session and offer to ``switch-client `` for you.
30- - Offer to re-attach a tmux session if your config is already loaded.
31- - For more things you can do with tmuxp, see `Examples `_.
32- - CLI auto-completion with `bash, zsh and tcsh `_.
33- - Use as a `python library `_, see the `python API quickstart `_.
34- - Well tested a gain against live tmux (1.8+ and git).
35- See `travis.yml `_, `tmuxp on Travis CI `_ and `testing `_ page.
36- - `Import `_ configs `teamocil `_ and `tmuxinator `_.
37- - Thorough `Documentation `_ (also in `中文 `_), `Source `_,
38- `Commands `_, `Internals `_.
39- - and `much, much more `_.
40-
41- Ready to begin? See the `Quickstart `_.
11+ Load a tmux session
12+ -------------------
13+
14+ Load tmux sessions via json and YAML, `tmuxinator `_ and
15+ `teamocil `_ style.
16+
17+ .. code-block :: yaml
18+
19+ session_name : 4-pane-split
20+ windows :
21+ - window_name : dev window
22+ layout : tiled
23+ shell_command_before :
24+ - cd ~/
25+ panes :
26+ - shell_command :
27+ - cd /var/log
28+ - ls -al | grep \.log
29+ - pwd
30+ - pwd
31+ - pwd
32+
33+ Save as ``mysession.yaml ``. And load:
34+
35+ .. code-block :: sh
36+
37+ $ tmuxp load ./mysession.yaml
38+
39+ See more `simple `_ or `very elaborate `_ config examples.
40+
41+ Store configs in (``~/.tmuxp ``) or include in your project as
42+ ``~/.tmuxp.{yaml,json} ``. See `author's tmuxp configs `_ and the
43+ the projects' `tmuxp.yaml `_.
44+
45+ bootstrap project dependencies before loading tmux. See the
46+ `bootstrap_env.py `_ and `before_script `_ example
47+
48+ Load sessions in the background by passing ``-d `` flag
49+
50+
51+ Freeze a tmux session
52+ ---------------------
53+
54+ .. code-block :: sh
55+
56+ $ tmuxp freeze
57+
58+ See more about `freezing tmux `_ sessions.
59+
60+ Docs / Reading material
61+ -----------------------
62+
63+ See the `Quickstart `_.
64+
65+ `Documentation `_ homepage (also in `中文 `_)
66+
4267Want to learn more about tmux itself? Read `The Tao of Tmux `_.
4368
4469.. _tmuxp on Travis CI : http://travis-ci.org/tony/tmuxp
@@ -55,19 +80,15 @@ Want to learn more about tmux itself? Read `The Tao of Tmux`_.
5580.. _tmuxinator : https://github.com/aziz/tmuxinator
5681.. _teamocil : https://github.com/remiprev/teamocil
5782.. _Examples : http://tmuxp.readthedocs.org/en/latest/examples.html
58- .. _ Freeze : http://tmuxp.readthedocs.org/en/latest/cli.html#freeze-sessions
83+ .. _ freezing tmux : http://tmuxp.readthedocs.org/en/latest/cli.html#freeze-sessions
5984.. _bootstrap_env.py : https://github.com/tony/tmuxp/blob/master/bootstrap_env.py
60- .. _Import : http://tmuxp.readthedocs.org/en/latest/cli.html#import
6185.. _travis.yml : http://tmuxp.readthedocs.org/en/latest/developing.html#travis-ci
6286.. _testing : http://tmuxp.readthedocs.org/en/latest/developing.html#test-runner
6387.. _python objects : http://tmuxp.readthedocs.org/en/latest/api.html#api
6488.. _tmuxp.yaml : https://github.com/tony/tmuxp/blob/master/.tmuxp.yaml
6589.. _simple : http://tmuxp.readthedocs.org/en/latest/examples.html#short-hand-inline
6690.. _very elaborate : http://tmuxp.readthedocs.org/en/latest/examples.html#super-advanced-dev-environment
67- .. _bash, zsh and tcsh : http://tmuxp.readthedocs.org/en/latest/cli.html#bash-completion
68- .. _much, much more : http://tmuxp.readthedocs.org/en/latest/about.html#minor-tweaks
6991.. _Quickstart : http://tmuxp.readthedocs.org/en/latest/quickstart.html
70- .. _Internals : http://tmuxp.readthedocs.org/en/latest/internals.html
7192.. _Commands : http://tmuxp.readthedocs.org/en/latest/cli.html
7293
7394Project details
0 commit comments