Skip to content

Commit 141d27c

Browse files
committed
docs(glossary): Use markdown
1 parent 01f5705 commit 141d27c

File tree

1 file changed

+39
-43
lines changed

1 file changed

+39
-43
lines changed

docs/glossary.md

Lines changed: 39 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,67 +2,63 @@
22

33
# Glossary
44

5-
```{eval-rst}
6-
.. glossary::
5+
```{glossary}
76
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.
1010
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.
1315
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).
1718
18-
kaptan
19-
configuration management library, see `kaptan on github`_.
19+
Server
20+
Tmux runs in the background of your system as a process.
2021
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.
2324
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.
2626
27-
A server contains :term:`session`'s.
27+
tmux starts the server automatically if it's not running.
2828
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]``.
3031
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.
3335
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`.
3738
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``.
4042
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``.
4444
45-
Sessions can have a ``session_name``.
45+
Uniquely identified by ``session_id``.
4646
47-
Uniquely identified by ``session_id``.
47+
Window
48+
Entity of a {term}`session`.
4849
49-
Window
50-
Entity of a :term:`session`.
50+
Can have 1 or more {term}`pane`.
5151
52-
Can have 1 or more :term:`pane`.
52+
Panes can be organized with a layouts.
5353
54-
Panes can be organized with a layouts.
54+
Windows can have names.
5555
56-
Windows can have names.
56+
Pane
57+
Linked to a {term}`Window`.
5758
58-
Pane
59-
Linked to a :term:`Window`.
59+
a pseudoterminal.
6060
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.
6864
```

0 commit comments

Comments
 (0)