Skip to content

Commit c13b0e7

Browse files
authored
Update README.md
Easier to read.
1 parent dca202b commit c13b0e7

File tree

1 file changed

+41
-53
lines changed

1 file changed

+41
-53
lines changed

README.md

Lines changed: 41 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Features:
44

5-
1. Enables logging of all output in the current pane<br/>
5+
1. Logging of all output in the current pane<br/>
66
After you start logging, everything that's typed and all the output will be
77
saved to a file. Convenient for keeping track of your work.
8-
2. Enables "screen capture" of the current pane<br/>
8+
2. Current pane "Screen Capture"<br/>
99
All the text visible in the current pane is saved to a file. Like a
1010
screenshot, but textual.
11-
3. Enables saving a complete history of the current pane<br/>
11+
3. Save a complete history of current pane<br/>
1212
Everything that has been typed and all the output since the creation of the
1313
current pane can be saved to a file.
1414
4. Clear pane history with `prefix + alt + c`
@@ -17,64 +17,38 @@ Tested and working on Linux, OSX and Cygwin.
1717

1818
### 1. Logging
1919

20-
Key binding: `prefix + shift + p`<br/>
21-
File path: `$HOME` (user home dir)<br/>
22-
File name format:
20+
Toggle (start/stop) logging in the current pane.
2321

24-
tmux-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log
25-
# Example file:
26-
# tmux-my-session-0-1-20140527T165614.log
22+
* Key binding: `prefix + shift + p`
23+
* File name format: `tmux-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log`
24+
* File path: `$HOME` (user home dir)
25+
* Example file: `~/tmux-my-session-0-1-20140527T165614.log`
2726

28-
Toggles (start/stop) logging in the current pane.
27+
### 2. "Screen Capture"
2928

30-
This feature improves the default `pipe-pane` logging mechanism by stripping
31-
ANSI codes. This is how the plain `pipe-pane` log output looks like if you're
32-
using terminal with coloring:
33-
34-
![garbled log output](/screenshots/garbled_log_output.png)
29+
Save visible text, in the current pane. Equivalent of a "texual screenshot".
3530

36-
Garbled characters are called ANSI codes. They enable colors in terminal, but
37-
are just making 'noise' in the textual log output.
38-
39-
A user will probably want to filter ANSI codes out of the log. Here's the same
40-
log as above when this plugin is used:
41-
42-
![proper log output](/screenshots/proper_log_output.png)
43-
44-
### 2. "Screen capture"
45-
46-
Key binding: `prefix + alt + p`<br/>
47-
File path: `$HOME` (user home dir)<br/>
48-
File name format:
49-
50-
tmux-screen-capture-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log
51-
# Example file:
52-
# tmux-screen-capture-my-session-0-1-20140527T165614.log
53-
54-
Visible text in the current pane is saved to a file. Equivalent of a "texual
55-
screenshot".
31+
* Key binding: `prefix + alt + p`
32+
* File name format: `tmux-screen-capture-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log`
33+
* File path: `$HOME` (user home dir)
34+
* Example file: `tmux-screen-capture-my-session-0-1-20140527T165614.log`
5635

5736
### 3. Save complete history
5837

59-
Key binding: `prefix + alt + shift + p`<br/>
60-
File path: `$HOME` (user home dir)<br/>
61-
File name format:
62-
63-
tmux-history-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log
64-
# Example file:
65-
# tmux-history-my-session-0-1-20140527T165614.log
66-
67-
Saves complete pane history to a file. Convenient if you retroactively remember
38+
Save complete pane history to a file. Convenient if you retroactively remember
6839
you need to log/save all the work.
6940

70-
**NOTE**: this functionality depends on the value of `history-limit` - it
71-
determines the number of lines Tmux keeps in the scrollback buffer. Everything
72-
Tmux kept will also be saved to a file.
41+
* Key binding: `prefix + alt + shift + p`
42+
* File name format: `tmux-history-#{session_name}-#{window_index}-#{pane_index}-%Y%m%dT%H%M%S.log`
43+
* File path: `$HOME` (user home dir)
44+
* Example file: `tmux-history-my-session-0-1-20140527T165614.log`
7345

74-
With modern computers it is ok to set this option to a high number:
46+
**NOTE**: this functionality depends on the value of `history-limit` - the number
47+
of lines Tmux keeps in the scrollback buffer. Only what Tmux kept will also be saved,
48+
to a file.
7549

76-
# in .tmux.conf
77-
set -g history-limit 50000
50+
Use `set -g history-limit 50000` in .tmux.conf, with modern computers
51+
it is ok to set this option to a high number.
7852

7953
### 4. Clear pane history
8054

@@ -111,15 +85,29 @@ You should now have all `tmux-logging` key bindings defined.
11185

11286
### Installing `ansifilter` (recommended for OSX users)
11387

114-
[ansifilter](http://www.andre-simon.de/doku/ansifilter/en/ansifilter.php)
115-
is a program specialized for removing (or working with) ANSI codes.
116-
11788
If you're on OSX, it is recommeneded to install `ansifilter`:
11889
`$ brew install ansifilter`
11990

91+
[ansifilter](http://www.andre-simon.de/doku/ansifilter/en/ansifilter.php)
92+
is a program specialized for removing (or working with) ANSI codes.
93+
12094
It helps with removing ANSI codes from the log. If `ansifilter` is not present,
12195
ANSI codes are removed with `sed`.
12296

97+
This feature improves the default `pipe-pane` logging mechanism by stripping
98+
ANSI codes. This is how the plain `pipe-pane` log output looks like if you're
99+
using terminal with coloring:
100+
101+
![garbled log output](/screenshots/garbled_log_output.png)
102+
103+
Garbled characters are called ANSI codes. They enable colors in terminal, but
104+
are just making 'noise' in the textual log output.
105+
106+
A user will probably want to filter ANSI codes out of the log. Here's the same
107+
log as above when this plugin is used:
108+
109+
![proper log output](/screenshots/proper_log_output.png)
110+
123111
### Other plugins
124112

125113
You might also find these useful:

0 commit comments

Comments
 (0)