aboutsummaryrefslogtreecommitdiffstats
path: root/src/bin/ttyrec/main.rs
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2021-12-05 19:29:07 -0500
committerJesse Luehrs <doy@tozt.net>2021-12-05 19:29:07 -0500
commitd9611e009279eeb74d642f72adab9621577b33c8 (patch)
treeb0a6af1dc3fd14968b6146081cc269b5e559fee4 /src/bin/ttyrec/main.rs
parent071c1c58c284867a61dfca158f5cede825690355 (diff)
downloadttyrec-bin-d9611e009279eeb74d642f72adab9621577b33c8.tar.gz
ttyrec-bin-d9611e009279eeb74d642f72adab9621577b33c8.zip
fill out help output
Diffstat (limited to 'src/bin/ttyrec/main.rs')
-rw-r--r--src/bin/ttyrec/main.rs19
1 files changed, 16 insertions, 3 deletions
diff --git a/src/bin/ttyrec/main.rs b/src/bin/ttyrec/main.rs
index a6ccdf4..61835b5 100644
--- a/src/bin/ttyrec/main.rs
+++ b/src/bin/ttyrec/main.rs
@@ -8,11 +8,24 @@ use async_std::stream::StreamExt as _;
use pty_process::Command as _;
#[derive(Debug, structopt::StructOpt)]
-#[structopt(about = "ttyrec")]
+#[structopt(
+ name = "ttyrec",
+ about = "Records ttyrec files",
+ long_about = "\n\
+ This program will run a shell (or other program specified by the -c \
+ option), and record the full output, including timing information, \
+ for later playback (such as via the included `ttyplay` command)."
+)]
struct Opt {
- #[structopt(short, long, default_value = "ttyrec")]
+ #[structopt(
+ short,
+ long,
+ default_value = "ttyrec",
+ help = "File to save ttyrec data to"
+ )]
file: std::ffi::OsString,
- #[structopt(short, long)]
+
+ #[structopt(short, long, help = "Command to run [default: $SHELL]")]
cmd: Option<std::ffi::OsString>,
}