Skip to content

Commit f39f49e

Browse files
committed
docs(README): Capitalization
1 parent db056c5 commit f39f49e

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@ View the [documentation](https://libtmux.git-pull.com/),
2222
Python 2.x will be deprecated in libtmux 0.9. The backports branch is
2323
[v0.8.x](https://github.com/tmux-python/libtmux/tree/v0.8.x).
2424

25-
# install
25+
# Install
2626

2727
```console
2828
$ pip install --user libtmux
2929
```
3030

31-
# open a tmux session
31+
# Open a tmux session
3232

33-
session name `foo`, window name `bar`
33+
Session name `foo`, window name `bar`
3434

3535
```console
3636
$ tmux new-session -s foo -n bar
3737
```
3838

39-
# pilot your tmux session via python
39+
# Pilot your tmux session via python
4040

4141
```console
4242
$ python
@@ -46,7 +46,7 @@ $ pip install --user ptpython
4646
$ ptpython
4747
```
4848

49-
connect to a live tmux session:
49+
Connect to a live tmux session:
5050

5151
```python
5252
>>> import libtmux
@@ -61,70 +61,70 @@ current tmux server / session / window pane.
6161
[tmuxp]: https://tmuxp.git-pull.com/
6262
[`tmuxp shell`]: https://tmuxp.git-pull.com/cli.html#shell
6363

64-
list sessions:
64+
List sessions:
6565

6666
```python
6767
>>> server.list_sessions()
6868
[Session($3 foo), Session($1 libtmux)]
6969
```
7070

71-
find session:
71+
Find session:
7272

7373
```python
7474
>>> server.get_by_id('$3')
7575
Session($3 foo)
7676
```
7777

78-
find session by dict lookup:
78+
Find session by dict lookup:
7979

8080
```python
8181
>>> server.find_where({ "session_name": "foo" })
8282
Session($3 foo)
8383
```
8484

85-
assign session to `session`:
85+
Assign session to `session`:
8686

8787
```python
8888
>>> session = server.find_where({ "session_name": "foo" })
8989
```
9090

91-
play with session:
91+
Control your session:
9292

9393
```python
9494
>>> session.new_window(attach=False, window_name="ha in the bg")
9595
Window(@8 2:ha in the bg, Session($3 foo))
9696
>>> session.kill_window("ha in")
9797
```
9898

99-
create new window in the background (don't switch to it):
99+
Create new window in the background (don't switch to it):
100100

101101
```python
102102
>>> w = session.new_window(attach=False, window_name="ha in the bg")
103103
Window(@11 3:ha in the bg, Session($3 foo))
104104
```
105105

106-
kill window object directly:
106+
Close window:
107107

108108
```python
109109
>>> w.kill_window()
110110
```
111111

112-
grab remaining tmux window:
112+
Grab remaining tmux window:
113113

114114
```python
115115
>>> window = session.attached_window
116116
>>> window.split_window(attach=False)
117117
Pane(%23 Window(@10 1:bar, Session($3 foo)))
118118
```
119119

120-
rename window:
120+
Rename window:
121121

122122
```python
123123
>>> window.rename_window('libtmuxower')
124124
Window(@10 1:libtmuxower, Session($3 foo))
125125
```
126126

127-
create panes by splitting window:
127+
Split window (create a new pane):
128128

129129
```python
130130
>>> pane = window.split_window()
@@ -134,7 +134,7 @@ create panes by splitting window:
134134
>>> pane = window.split_window(attach=False)
135135
```
136136

137-
send key strokes to panes:
137+
Type inside the pane (send key strokes):
138138

139139
```python
140140
>>> pane.send_keys('echo hey send now')
@@ -143,7 +143,7 @@ send key strokes to panes:
143143
>>> pane.enter()
144144
```
145145

146-
grab the output of pane:
146+
Grab the output of pane:
147147

148148
```python
149149
>>> pane.clear() # clear the pane
@@ -161,7 +161,7 @@ grab the output of pane:
161161
||----w |
162162
|| ||
163163

164-
powerful traversal features:
164+
Traverse and navigate:
165165

166166
>>> pane.window
167167
Window(@10 1:libtmuxower, Session($3 foo))

0 commit comments

Comments
 (0)