|
2 | 2 |
|
3 | 3 | # Glossary |
4 | 4 |
|
5 | | -```{eval-rst} |
6 | | -.. glossary:: |
| 5 | +```{glossary} |
7 | 6 |
|
8 | | - libtmux |
9 | | - Python library for interfacing with tmux through its objects. |
| 7 | +tmuxp |
| 8 | + A tool to manage workspaces with tmux. A pythonic abstraction of |
| 9 | + tmux. |
10 | 10 |
|
11 | | - tmuxp |
12 | | - A tool to manage workspaces with tmux, built on libtmux. |
| 11 | +tmux |
| 12 | +tmux(1) |
| 13 | + The tmux binary. Used internally to distinguish tmuxp is only a |
| 14 | + layer on top of tmux. |
13 | 15 |
|
14 | | - tmux(1) |
15 | | - The tmux binary. Used internally to distinguish tmuxp is only a |
16 | | - layer on top of tmux. |
| 16 | +kaptan |
| 17 | + configuration management library, see [kaptan on github](https://github.com/emre/kaptan). |
17 | 18 |
|
18 | | - kaptan |
19 | | - configuration management library, see `kaptan on github`_. |
| 19 | +Server |
| 20 | + Tmux runs in the background of your system as a process. |
20 | 21 |
|
21 | | - Server |
22 | | - Tmux runs in the background of your system as a process. |
| 22 | + The server holds multiple {term}`Session`. By default, tmux |
| 23 | + automatically starts the server the first time ``$ tmux`` is ran. |
23 | 24 |
|
24 | | - The server holds multiple :term:`Session`. By default, tmux |
25 | | - automatically starts the server the first time ``$ tmux`` is ran. |
| 25 | + A server contains {term}`session`'s. |
26 | 26 |
|
27 | | - A server contains :term:`session`'s. |
| 27 | + tmux starts the server automatically if it's not running. |
28 | 28 |
|
29 | | - tmux starts the server automatically if it's not running. |
| 29 | + Advanced cases: multiple can be run by specifying |
| 30 | + ``[-L socket-name]`` and ``[-S socket-path]``. |
30 | 31 |
|
31 | | - Advanced cases: multiple can be run by specifying |
32 | | - ``[-L socket-name]`` and ``[-S socket-path]``. |
| 32 | +Client |
| 33 | + Attaches to a tmux {term}`server`. When you use tmux through CLI, |
| 34 | + you are using tmux as a client. |
33 | 35 |
|
34 | | - Client |
35 | | - Attaches to a tmux :term:`server`. When you use tmux through CLI, |
36 | | - you are using tmux as a client. |
| 36 | +Session |
| 37 | + Inside a tmux {term}`server`. |
37 | 38 |
|
38 | | - Session |
39 | | - Inside a tmux :term:`server`. |
| 39 | + The session has 1 or more {term}`Window`. The bottom bar in tmux |
| 40 | + show a list of windows. Normally they can be navigated with |
| 41 | + ``Ctrl-a [0-9]``, ``Ctrl-a n`` and ``Ctrl-a p``. |
40 | 42 |
|
41 | | - The session has 1 or more :term:`Window`. The bottom bar in tmux |
42 | | - show a list of windows. Normally they can be navigated with |
43 | | - ``Ctrl-a [0-9]``, ``Ctrl-a n`` and ``Ctrl-a p``. |
| 43 | + Sessions can have a ``session_name``. |
44 | 44 |
|
45 | | - Sessions can have a ``session_name``. |
| 45 | + Uniquely identified by ``session_id``. |
46 | 46 |
|
47 | | - Uniquely identified by ``session_id``. |
| 47 | +Window |
| 48 | + Entity of a {term}`session`. |
48 | 49 |
|
49 | | - Window |
50 | | - Entity of a :term:`session`. |
| 50 | + Can have 1 or more {term}`pane`. |
51 | 51 |
|
52 | | - Can have 1 or more :term:`pane`. |
| 52 | + Panes can be organized with a layouts. |
53 | 53 |
|
54 | | - Panes can be organized with a layouts. |
| 54 | + Windows can have names. |
55 | 55 |
|
56 | | - Windows can have names. |
| 56 | +Pane |
| 57 | + Linked to a {term}`Window`. |
57 | 58 |
|
58 | | - Pane |
59 | | - Linked to a :term:`Window`. |
| 59 | + a pseudoterminal. |
60 | 60 |
|
61 | | - a pseudoterminal. |
62 | | -
|
63 | | - Target |
64 | | - A target, cited in the manual as ``[-t target]`` can be a session, |
65 | | - window or pane. |
66 | | -
|
67 | | -.. _kaptan on github: https://github.com/emre/kaptan |
| 61 | +Target |
| 62 | + A target, cited in the manual as ``[-t target]`` can be a session, |
| 63 | + window or pane. |
68 | 64 | ``` |
0 commit comments