Skip to content

Commit aae8041

Browse files
authored
docs: Update help output (#209)
The README command line options list was a little out of date, so I just pasted in the current options and cleaned up the format. Hope that's okay.
1 parent f93974c commit aae8041

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -133,41 +133,41 @@ t-rec /bin/sh
133133

134134
### Full Options
135135

136-
```sh
137-
t-rec 0.7.0
136+
```text
137+
t-rec 0.7.6
138138
Sven Assmann <[email protected]>
139139
Blazingly fast terminal recorder that generates animated gif images for the web written in rust.
140140
141-
USAGE:
142-
t-rec [OPTIONS] [shell or program to launch]
143-
144-
ARGS:
145-
<shell or program to launch> If you want to start a different program than $SHELL you can
146-
pass it here. For example '/bin/sh'
147-
148-
OPTIONS:
149-
-b, --bg <bg> Background color when decors are used [default: transparent]
150-
[possible values: white, black, transparent]
151-
-d, --decor <decor> Decorates the animation with certain, mostly border effects
152-
[default: none] [possible values: shadow, none]
153-
-e, --end-pause <s | ms | m> to specify the pause time at the end of the animation, that
154-
time the gif will show the last frame
155-
-h, --help Print help information
156-
-l, --ls-win If you want to see a list of windows available for recording
157-
by their id, you can set env var 'WINDOWID' or `--win-id` to
158-
record this specific window only
159-
-m, --video Generates additionally to the gif a mp4 video of the recording
160-
-M, --video-only Generates only a mp4 video and not gif
161-
-n, --natural If you want a very natural typing experience and disable the
162-
idle detection and sampling optimization
163-
-q, --quiet Quiet mode, suppresses the banner: 'Press Ctrl+D to end
164-
recording'
165-
-s, --start-pause <s | ms | m> to specify the pause time at the start of the animation, that
166-
time the gif will show the first frame
167-
-v, --verbose Enable verbose insights for the curious
168-
-V, --version Print version information
169-
-w, --win-id <win-id> Window Id (see --ls-win) that should be captured, instead of
170-
the current terminal
141+
Usage: t-rec [OPTIONS] [shell or program to launch]
142+
143+
Arguments:
144+
[shell or program to launch] If you want to start a different program than $SHELL you can
145+
pass it here. For example '/bin/sh'
146+
147+
Options:
148+
-v, --verbose Enable verbose insights for the curious
149+
-q, --quiet Quiet mode, suppresses the banner:
150+
'Press Ctrl+D to end recording'
151+
-m, --video Generates additionally to the gif a mp4 video of the recording
152+
-M, --video-only Generates only a mp4 video and not gif
153+
-d, --decor <decor> Decorates the animation with certain, mostly border effects
154+
[default: none] [possible values: shadow, none]
155+
-b, --bg <bg> Background color when decors are used [default: transparent]
156+
[possible values: white, black, transparent]
157+
-n, --natural If you want a very natural typing experience and disable the idle
158+
detection and sampling optimization
159+
-l, --ls-win If you want to see a list of windows available for recording by
160+
their id, you can set env var 'WINDOWID' or `--win-id` to record
161+
this specific window only
162+
-w, --win-id <win-id> Window Id (see --ls-win) that should be captured, instead of
163+
the current terminal
164+
-e, --end-pause <s | ms | m> to specify the pause time at the end of the animation, that time
165+
the gif will show the last frame
166+
-s, --start-pause <s | ms | m> to specify the pause time at the start of the animation, that time
167+
the gif will show the first frame
168+
-o, --output <file> to specify the output file (without extension) [default: t-rec]
169+
-h, --help Print help
170+
-V, --version Print version
171171
```
172172

173173
### Disable idle detection & optimization

0 commit comments

Comments
 (0)