Skip to content

Commit 1a474a9

Browse files
committed
Initial docs for panes, servers, sessions, windows
1 parent 4ef28e2 commit 1a474a9

File tree

4 files changed

+23
-6
lines changed

4 files changed

+23
-6
lines changed

doc/panes.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,9 @@
44
Panes
55
=====
66

7-
In tmux,
7+
- hold `pseudoterminal`_'s (`pty(4)`_)
8+
- exist inside :ref:`Windows`
9+
- identified by ``%``, e.g. ``%313``
10+
11+
.. _pseudoterminal: https://en.wikipedia.org/wiki/Pseudoterminal
12+
.. _pty(4): https://www.freebsd.org/cgi/man.cgi?query=pty&sektion=4

doc/servers.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
.. _Servers:
22

3-
You *can* have >1 servers running of tmux at the same time.
4-
53
=======
64
Servers
75
=======
86

7+
- identified by *socket path* and *socket name*
8+
- may have >1 servers running of tmux at the same time.
9+
- hold :ref:`Sessions` (which hold :ref:`Windows`, which hold
10+
:ref:`Panes`)
11+
912
In tmux, a server is automatically started on your behalf
1013
when you first run tmux.
1114

12-
15+
.. autoclass:: libtmux.Server
16+
:members:
17+
:inherited-members:
18+
:private-members:
19+
:show-inheritance:
20+
:member-order: bysource

doc/sessions.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@
44
Sessions
55
========
66

7-
In tmux,
7+
- exist inside :ref:`Servers`
8+
- contain :ref:`Windows` (which hold :ref:`Panes`)
9+
- identified by ``$``, e.g. ``$313``

doc/windows.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@
44
Windows
55
=======
66

7-
In tmux,
7+
- exist inside :ref:`Sessions`
8+
- contain :ref:`Panes`
9+
- identified by ``@``, e.g. ``@313``

0 commit comments

Comments
 (0)