99
1010.. module :: libtmux
1111
12- libtmux is an *abstraction layer * against tmux' command line arguments.
12+ libtmux is an `abstraction layer `_ for tmux.
13+
14+ It builds upon the concept of targets ``-t ``, to direct commands against
15+ individual session, windows and panes and ``FORMATS ``, template variables
16+ exposed by tmux to describe their properties.
1317
1418:class: `common.TmuxRelationalObject ` acts as a container to connect the
1519relations of :class: `Server `, :class: `Session `, :class: `Window ` and
@@ -25,8 +29,10 @@ Object Child Parent
2529======================== ======================= =========================
2630
2731Internally, tmux allows multiple servers to be ran on a system. Each one
28- uses a socket. Most users worry since tmux will communicate to a default
29- server automatically. If one doesn't exist, tmux does it for you.
32+ uses a socket. The server-client architecture is executed so cleanly,
33+ many users don't think about it. tmux automatically connects to a default
34+ socket name and location for you if none (``-L ``, ``-S ``) is specified.
35+ A server will be created automatically upon starting if none exists.
3036
3137A server can have multiple sessions. ``Ctrl-a s `` can be used to switch
3238between sessions running on the server.
@@ -49,7 +55,7 @@ Object Prefix Example
4955Similarities to Tmux and Pythonics
5056----------------------------------
5157
52- libtmux is was built in the spirit of understanding how tmux operates
58+ libtmux was built in the spirit of understanding how tmux operates
5359and how python objects and tools can abstract the API's in a pleasant way.
5460
5561libtmux uses ``FORMATTERS `` in tmux to give identity attributes to
@@ -82,8 +88,8 @@ To assert pane, window and session data, libtmux will use
8288:meth: `Server.list_sessions() `, :meth: `Session.list_windows() `,
8389:meth: `Window.list_panes() ` to update objects.
8490
85- Idiosyncrasies
86- --------------
91+ Naming conventions
92+ ------------------
8793
8894Because this is a python abstraction and commands like ``new-window ``
8995have dashes (-) replaced with underscores (_).
@@ -95,4 +101,3 @@ Reference
95101- tmux source code http://sourceforge.net/p/tmux/tmux-code/ci/master/tree/
96102
97103.. _abstraction layer : http://en.wikipedia.org/wiki/Abstraction_layer
98- .. _ORM : http://en.wikipedia.org/wiki/Object-relational_mapping
0 commit comments