Skip to content

Commit e55bbfd

Browse files
committed
Doc updates
1 parent 7e25f60 commit e55bbfd

File tree

3 files changed

+33
-34
lines changed

3 files changed

+33
-34
lines changed

doc/about.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ About
88

99
tmuxp helps you manage tmux workspaces.
1010

11-
tmuxp is build upon an object relational mapper for tmux. End-users may
12-
use YAML, JSON and :py:obj:`dict` configurations to launch workspaces like
11+
Built on a object relational mapper for tmux. tmux users can reload common
12+
workspaces from YAML, JSON and :py:obj:`dict` configurations like
1313
`tmuxinator`_ and `teamocil`_.
1414

1515
To jump right in, see :ref:`quickstart` and :ref:`examples`.
1616

1717
Interested in some kung-fu or joining the effort? :ref:`api` and
1818
:ref:`developing`
1919

20-
License is `BSD-licensed`_. Code can be found at github at
21-
http://github.com/tony/tmuxp.
20+
`BSD-licensed`_. Code can be found on `github
21+
<http://github.com/tony/tmuxp.>`_
2222

2323
Differences from tmuxinator / teamocil
2424
--------------------------------------

doc/about_tmux.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -308,17 +308,15 @@ Windows can be *named upon creation*.
308308
309309
$ tmuxp new-window [-n window-name]
310310
311-
.. _Rename window:
312-
313311
Windows can be *renamed after creation*.
314312

315-
=============== =========================================================
313+
=============== ==========================================================
316314
Command .. code-block:: bash
317315

318316
$ tmux rename-window <new-name>
319317

320318
Short cut ``Prefix`` + ``,``
321-
=============== =========================================================
319+
=============== ==========================================================
322320

323321
Creating new windows
324322
--------------------
@@ -330,7 +328,7 @@ Command .. code-block:: bash
330328

331329
Short cut ``Prefix`` + ``c``
332330

333-
You may then :ref:`Rename window`.
331+
You may then rename window.
334332
=============== =========================================================
335333

336334
Traverse windows

doc/cli.rst

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,32 @@
44
Command Line Interface
55
======================
66

7+
.. _bash_completion:
8+
9+
Bash completion
10+
"""""""""""""""
11+
12+
For bash, ``.bashrc``:
13+
14+
.. code-block:: bash
15+
16+
$ source tmuxp.bash
17+
18+
For tcsh, ``.tcshrc``:
19+
20+
.. code-block:: bash
21+
22+
$ complete tmuxp 'p/*/`tmuxp.tcsh`/'
23+
24+
For zsh, ``.zshrc``:
25+
26+
.. code-block:: bash
27+
28+
$ source tmuxp.zsh
29+
30+
.. _commands:
31+
32+
733
.. _cli_freeze:
834

935
Freeze sessions
@@ -89,31 +115,6 @@ Convert between YAML and JSON
89115
tmuxp automatically will prompt to convert ``.yaml`` to ``.json`` and
90116
``.json`` to ``.yaml``.
91117

92-
.. _bash_completion:
93-
94-
Bash completion
95-
"""""""""""""""
96-
97-
For bash, ``.bashrc``:
98-
99-
.. code-block:: bash
100-
101-
$ source tmuxp.bash
102-
103-
For tcsh, ``.tcshrc``:
104-
105-
.. code-block:: bash
106-
107-
$ complete tmuxp 'p/*/`tmuxp.tcsh`/'
108-
109-
For zsh, ``.zshrc``:
110-
111-
.. code-block:: bash
112-
113-
$ source tmuxp.zsh
114-
115-
.. _commands:
116-
117118
Other commands
118119
""""""""""""""
119120

0 commit comments

Comments
 (0)