|
1 | | -libtmux - library for managing tmux workspaces |
| 1 | +libtmux - scripting library for tmux |
2 | 2 |
|
3 | 3 | |pypi| |docs| |build-status| |coverage| |license| |
4 | 4 |
|
5 | | -libtmux is the library that powers `tmuxp`_, a tool that helps tmux users |
6 | | -manage their workspaces. |
| 5 | +libtmux is the tool behind `tmuxp`_, a tmux workspace manager in python. |
7 | 6 |
|
8 | | -Take control of tmux via python. |
| 7 | +it builds upon tmux' `target`_ and `formats`_ to create an object |
| 8 | +mappings to traverse, inspect and interact with live tmux sesssions. |
9 | 9 |
|
10 | | -View the `documentation`_ homepage, `API`_ information and `architectural |
| 10 | +view the `documentation`_ homepage, `API`_ information and `architectural |
11 | 11 | details`_. |
12 | 12 |
|
13 | | -.. _tmuxp: https://github.com/tony/tmuxp |
14 | | -.. _documentation: https://libtmux.readthedocs.io/ |
15 | | -.. _API: https://libtmux.readthedocs.io/api.html |
16 | | -.. _architectural details: https://libtmux.readthedocs.io/internals.html |
17 | | - |
18 | 13 | install |
19 | 14 | ------- |
20 | 15 |
|
@@ -61,12 +56,12 @@ find session:: |
61 | 56 |
|
62 | 57 | find session by dict lookup:: |
63 | 58 |
|
64 | | - >>> server.findWhere({ "session_name": "foo" }) |
| 59 | + >>> server.find_where({ "session_name": "foo" }) |
65 | 60 | Session($3 foo) |
66 | 61 |
|
67 | 62 | assign session to ``session``:: |
68 | 63 |
|
69 | | - >>> session = server.findWhere({ "session_name": "foo" }) |
| 64 | + >>> session = server.find_where({ "session_name": "foo" }) |
70 | 65 |
|
71 | 66 | play with session:: |
72 | 67 |
|
@@ -131,6 +126,15 @@ powerful traversal features:: |
131 | 126 | >>> pane.window.session |
132 | 127 | Session($3 foo) |
133 | 128 |
|
| 129 | +.. _BSD: http://opensource.org/licenses/BSD-3-Clause |
| 130 | +.. _developing and testing: http://libtmux.readthedocs.io/developing.html |
| 131 | +.. _tmuxp: https://github.com/tony/tmuxp |
| 132 | +.. _documentation: https://libtmux.readthedocs.io/ |
| 133 | +.. _API: https://libtmux.readthedocs.io/api.html |
| 134 | +.. _architectural details: https://libtmux.readthedocs.io/internals.html |
| 135 | +.. _formats: http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#FORMAT |
| 136 | +.. _target: http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#COMMANDS |
| 137 | + |
134 | 138 | Project details |
135 | 139 | --------------- |
136 | 140 |
|
@@ -168,10 +172,6 @@ tests .. code-block:: bash |
168 | 172 | $ make test |
169 | 173 | ============== ========================================================== |
170 | 174 |
|
171 | | -.. _BSD: http://opensource.org/licenses/BSD-3-Clause |
172 | | -.. _developing and testing: http://libtmux.readthedocs.io/developing.html |
173 | | -.. _Issues tracker: https://github.com/tony/libtmux/issues |
174 | | - |
175 | 175 | .. |pypi| image:: https://img.shields.io/pypi/v/libtmux.svg |
176 | 176 | :alt: Python Package |
177 | 177 | :target: http://badge.fury.io/py/libtmux |
|
0 commit comments