Skip to content

Commit ad424fb

Browse files
committed
about tmux updates
1 parent 0a1469e commit ad424fb

File tree

1 file changed

+135
-21
lines changed

1 file changed

+135
-21
lines changed

doc/about_tmux.rst

Lines changed: 135 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,9 @@ Text-based window manager
4141
------------------- ---------------------- -------------------------------
4242
Multiplexer Multi-tasking Multiple applications
4343
simulataneously.
44-
Session Desktop Applications are visible here
44+
Sessio Desktop Applications are visible here
4545
Window Virtual Desktop or A desktop that stores it own
46-
applications
47-
screen
46+
applications screen
4847
Pane Application Performs operations
4948
=================== ====================== ===============================
5049

@@ -153,15 +152,15 @@ sandwich, and re-(attach), all applications are still running!
153152
.. aafig::
154153
:textual:
155154

156-
+--------+--------+
157-
| $ bash | $ bash |
158-
| | |
155+
+--------+--------+
156+
| $ bash | $ bash |
157+
| | |
159158
| | | /------------\
160159
+--------+--------+ --> | detach |
161160
| $ vim | $ bash | | 'Ctrl-b b' |
162161
| | | \------------/
163-
| | | |
164-
+--------+--------+ |
162+
| | | |
163+
+--------+--------+ |
165164
/------------------/
166165
|
167166
v
@@ -174,20 +173,20 @@ sandwich, and re-(attach), all applications are still running!
174173
| |
175174
| |
176175
+-----------------------+
177-
v
178-
|
179-
v
180-
+-----------------------+
181-
| $ [screen detached] |
182-
| $ tmux attach |
176+
v
177+
|
178+
v
179+
+-----------------------+
180+
| $ [screen detached] |
181+
| $ tmux attach |
183182
| | /------------\
184183
| | --> | attaching |
185184
| | \------------/
186-
| | |
187-
| | |
188-
+-----------------------+ |
189-
/
190-
/-------------------------
185+
| | |
186+
| | |
187+
+-----------------------+ |
188+
/
189+
/---------------------------
191190
|
192191
v
193192
+--------+--------+
@@ -214,12 +213,41 @@ Multitasking. Preserving the thinking you have.
214213

215214
.. _"train of thought": http://en.wikipedia.org/wiki/Train_of_thought
216215

217-
First steps with tmux
218-
=====================
216+
Installing tmux
217+
---------------
218+
219+
Tmux is a common package / port on most Linux and BSD systems.
220+
221+
Instead of creating a page for how to install tmux on every distro in the
222+
world, using google for "How to install tmux on <my distro>" may suit your
223+
purpose as package names and directions change when distributions release
224+
a new version.
225+
226+
It's best that you use the latest stable release of tmux available. This
227+
can been seen on `tmux homepage`_.
228+
229+
**Mac OS X** users may install that latest stable version of tmux through
230+
`MacPorts`_, `fink`_ or `Homebrew`_ (aka brew).
231+
232+
If **compiling from source**, the dependencies are `libevent`_ and
233+
`ncurses`_.
234+
235+
.. _tmux homepage: http://tmux.sourceforge.net/
236+
.. _libevent: http://www.monkey.org/~provos/libevent/
237+
.. _ncurses: http://invisible-island.net/ncurses/
238+
.. _MacPorts: http://www.macports.org/
239+
.. _Fink: http://fink.thetis.ig42.org/
240+
.. _Homebrew: http://www.brew.sh
219241

220242
Start a new session
221243
-------------------
222244

245+
.. code-block:: bash
246+
247+
$ tmux
248+
249+
That's all it takes to launch yourself into a tmux session.
250+
223251
.. tip:: Common pitfall
224252

225253
Running ``$ tmux list-sessions`` or any other command for listing tmux
@@ -233,6 +261,92 @@ Start a new session
233261
this will rarely happen)
234262
- tmux has not be launched yet at all.
235263

264+
Tmux hotkeys
265+
------------
266+
267+
.. note::
268+
269+
The **prefix** key is a known stumbling block for new tmux users,
270+
please pay attention!
271+
272+
Tmux hot keys have to be pressed in a special way. **Read this
273+
carefully**, then try it yourself.
274+
275+
First, you press the *prefix* key. This is ``C-a`` by default.
276+
277+
Release. Then pause. For less than second. Then type what's next.
278+
279+
``C-b o`` means: Press ``Ctrl`` and ``b`` at the same time. Then
280+
press ``o``.
281+
282+
283+
**Remember, prefix + short cut!**. ``C`` is ``Ctrl`` key.
284+
285+
=================== ====================================================
286+
Short cut Action
287+
------------------- ----------------------------------------------------
288+
``C-b`` Send the prefix key (C-b) through to the
289+
application.
290+
``C-o`` Rotate the panes in the current window forwards.
291+
``C-z`` Suspend the tmux client.
292+
``!`` Break the current pane out of the window.
293+
``"`` Split the current pane into two, top and bottom.
294+
``#`` List all paste buffers.
295+
``$`` Rename the current session.
296+
``%`` Split the current pane into two, left and right.
297+
``&`` Kill the current window.
298+
``'`` Prompt for a window index to select.
299+
``,`` Rename the current window.
300+
``-`` Delete the most recently copied buffer of text.
301+
``.`` Prompt for an index to move the current window.
302+
``0 to 9`` Select windows 0 to 9.
303+
``:`` Enter the tmux command prompt.
304+
``;`` Move to the previously active pane.
305+
``=`` Choose which buffer to paste interactively from a
306+
list.
307+
``?`` List all key bindings.
308+
``D`` Choose a client to detach.
309+
``[`` Enter copy mode to copy text or view the history.
310+
``]`` Paste the most recently copied buffer of text.
311+
``c`` Create a new window.
312+
``d`` Detach the current client.
313+
``f`` Prompt to search for text in open windows.
314+
``i`` Display some information about the current window.
315+
``l`` Move to the previously selected window.
316+
``n`` Change to the next window.
317+
``o`` Select the next pane in the current window.
318+
``p`` Change to the previous window.
319+
``q`` Briefly display pane indexes.
320+
``r`` Force redraw of the attached client.
321+
``s`` Select a new session for the attached client
322+
interactively.
323+
``L`` Switch the attached client back to the last session.
324+
``t`` Show the time.
325+
``w`` Choose the current window interactively.
326+
``x`` Kill the current pane.
327+
``{`` Swap the current pane with the previous pane.
328+
``}`` Swap the current pane with the next pane.
329+
``~`` Show previous messages from tmux, if any.
330+
``Page Up`` Enter copy mode and scroll one page up.
331+
``Up, Down`` Change to the pane above, below, to the left, or to
332+
``Left, Right`` the right of the current pane.
333+
``M-1 to M-5`` Arrange panes in one of the five preset layouts:
334+
even-horizontal, even-vertical, main-horizontal,
335+
main-vertical, or tiled.
336+
``M-n`` Move to the next window with a bell or activity
337+
marker.
338+
``M-o`` Rotate the panes in the current window backwards.
339+
``M-p`` Move to the previous window with a bell or activity
340+
marker.
341+
``C-Up, C-Down`` Resize the current pane in steps of one cell.
342+
``C-Left, C-Right``
343+
344+
``M-Up, M-Down`` Resize the current pane in steps of five cells.
345+
``M-Left, M-Right``
346+
=================== ====================================================
347+
348+
Source: tmux manpage.
349+
236350
License
237351
-------
238352

0 commit comments

Comments
 (0)