Skip to content

Commit 06eb9d4

Browse files
tonytony
committed
Updates to about_tmux and glossary
1 parent 5263366 commit 06eb9d4

File tree

2 files changed

+104
-117
lines changed

2 files changed

+104
-117
lines changed

‎doc/about_tmux.rst

Lines changed: 55 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,42 @@ Window Virtual Desktop or A desktop that stores it own
4848
Pane Application Performs operations
4949
=================== ====================== ===============================
5050

51-
Multiple terminals in one screen
52-
--------------------------------
51+
.. aafig::
52+
:textual:
53+
54+
+----------------------------------------------------------------+
55+
| +--------+--------+ +-----------------+ +-----------------+ |
56+
| | pane | pane | | pane | | pane | |
57+
| | | | | | | | |
58+
| | | | | | | | |
59+
| +--------+--------+ | | +-----------------+ |
60+
| | pane | pane | | | | pane | |
61+
| | | | | | | | |
62+
| | | | | | | | |
63+
| +--------+--------+ +-----------------+ +-----------------+ |
64+
| | window | | window | | window | |
65+
| \--------+--------/ \-----------------/ \-----------------/ |
66+
+----------------------------------------------------------------+
67+
| session |
68+
\----------------------------------------------------------------/
69+
70+
- 1 :term:`Server`.
71+
72+
- has 1 or more :term:`Session`.
73+
74+
- has 1 or more :term:`Window`.
75+
76+
- has 1 or more :term:`Pane`.
77+
78+
.. seealso:: :ref:`glossary` has a dictionary of tmux words.
79+
80+
CLI Power Tool
81+
--------------
82+
5383
Multiple applications or terminals to run on the same screen by splitting
5484
up 1 terminal into multiple.
5585

56-
Being able to run 2 or more terminals on one screen is convenient. This
57-
way one screen can be used to edit a file, and another may be used to
86+
One screen can be used to edit a file, and another may be used to
5887
``$ tail -F`` a logfile.
5988

6089
.. aafig::
@@ -83,41 +112,22 @@ way one screen can be used to edit a file, and another may be used to
83112

84113
tmux supports as manys terminals as you want.
85114

86-
It allows multiple layouts to view the apps
87-
-------------------------------------------
88-
89-
Different applications are viewable better in different layouts.
90-
91-
It allows switching between layouts such as...
92-
93-
Organize apps based on your needs
94-
---------------------------------
95-
96-
You can categorize and keep many terminals / applications separated into
97-
multiple windows.
98-
99-
In addition to being able to split the terminal into multiple panes, you
100-
can create new windows as much as you want.
101115

102116
.. aafig::
103117
:textual:
104118

105119
+---------+---------+
106120
| $ bash | $ bash |
107121
| | |
108-
| | |
109-
+---------+---------+
110-
| $ vim | $ bash |
111-
| | |
112-
| | |
113-
+---------+---------+
114-
| '1:sys* 2:vim' |
115-
+-------------------+
116-
|
117-
v
118-
/-----------------\
119-
|'switch-window 2'|
120-
\-----------------/
122+
| | | /-----------------\
123+
+---------+---------+ --> |'switch-window 2'|
124+
| $ vim | $ bash | \-----------------/
125+
| | | |
126+
| | | |
127+
+---------+---------+ |
128+
| '1:sys* 2:vim' | |
129+
+-------------------+ |
130+
/------------------------/
121131
|
122132
v
123133
+---------+---------+
@@ -204,93 +214,24 @@ Multitasking. Preserving the thinking you have.
204214

205215
.. _"train of thought": http://en.wikipedia.org/wiki/Train_of_thought
206216

207-
Core Concepts
208-
=============
209-
210-
.. seealso:: :ref:`glossary` has a dictionary of tmux words.
217+
First steps with tmux
218+
=====================
211219

212-
.. _server:
220+
Start a new session
221+
-------------------
213222

214-
Server
215-
------
223+
.. tip:: Common pitfall
216224

217-
A server contains :ref:`session`'s.
218-
219-
tmux starts the server automatically if it's not running.
220-
221-
In advanced cases, multiple can be run by specifying ``[-L socket-name]``
222-
and ``[-S socket-path]``.
223-
224-
.. _client:
225-
226-
Client
227-
------
228-
229-
Attaches to a tmux :ref:`server`.
230-
231-
.. _session:
232-
233-
Session
234-
-------
235-
236-
Inside a tmux :ref:`server`.
225+
Running ``$ tmux list-sessions`` or any other command for listing tmux
226+
entities (such as ``$ tmux list-windows`` or ``$ tmux list-panes``).
227+
This can generate the error "failed to connect to server".
237228

238-
The session has 1 or more :ref:`window`. The bottom bar in tmux show a
239-
list of windows. Normally they can be navigated with ``Ctrl-a [0-9]``,
240-
``Ctrl-a n`` and ``Ctrl-a p``.
241-
242-
Sessions can have a ``session_name``.
243-
244-
Uniquely identified by ``session_id``.
245-
246-
.. aafig::
247-
:textual:
248-
249-
+----------------------------------------------------------------+
250-
| +--------+--------+ +-----------------+ +-----------------+ |
251-
| | pane | pane | | pane | | pane | |
252-
| | | | | | | | |
253-
| | | | | | | | |
254-
| +--------+--------+ | | +-----------------+ |
255-
| | pane | pane | | | | pane | |
256-
| | | | | | | | |
257-
| | | | | | | | |
258-
| +--------+--------+ +-----------------+ +-----------------+ |
259-
| | window | | window | | window | |
260-
| \--------+--------/ \-----------------/ \-----------------/ |
261-
+----------------------------------------------------------------+
262-
| session |
263-
\----------------------------------------------------------------/
264-
265-
.. _window:
266-
267-
Window
268-
------
269-
270-
Entity of a :ref:`session`.
271-
272-
Can have 1 or more :ref:`pane`.
273-
274-
panes can be organized with a layouts.
275-
276-
windows can have names.
277-
278-
.. _pane:
279-
280-
Pane
281-
----
282-
283-
Linked to a :ref:`window`.
284-
285-
a pseudoterminal.
286-
287-
.. _target:
288-
289-
Target
290-
------
229+
This could be because:
291230

292-
A target, cited in the manual as ``[-t target]`` can be a session, window
293-
or pane.
231+
- tmux server has killed its' last session, killing the server.
232+
- tmux server has encountered a crash. (tmux is highly stable,
233+
this will rarely happen)
234+
- tmux has not be launched yet at all.
294235

295236
License
296237
-------

‎doc/glossary.rst

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _glossary:
22

3-
==============
4-
tmuxp Glossary
5-
==============
3+
========
4+
Glossary
5+
========
66

77

88
.. glossary::
@@ -18,4 +18,50 @@ tmuxp Glossary
1818
kaptan
1919
configuration management library, see `kaptan on github`_.
2020

21+
Server
22+
Tmux runs in the background of your system as a process.
23+
24+
The server holds multiple :term:`Session`. By default, tmux
25+
automatically starts the server the first time ``$ tmux`` is ran.
26+
27+
A server contains :term:`session`'s.
28+
29+
tmux starts the server automatically if it's not running.
30+
31+
Advanced cases: multiple can be run by specifying
32+
``[-L socket-name]`` and ``[-S socket-path]``.
33+
34+
Client
35+
Attaches to a tmux :term:`server`. When you use tmux through CLI,
36+
you are using tmux as a client.
37+
38+
Session
39+
Inside a tmux :term:`server`.
40+
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``.
44+
45+
Sessions can have a ``session_name``.
46+
47+
Uniquely identified by ``session_id``.
48+
49+
Window
50+
Entity of a :term:`session`.
51+
52+
Can have 1 or more :term:`pane`.
53+
54+
Panes can be organized with a layouts.
55+
56+
Windows can have names.
57+
58+
Pane
59+
Linked to a :ref:`window`.
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+
2167
.. _kaptan on github: https://github.com/emre/kaptan

0 commit comments

Comments
 (0)