aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2019-01-10 11:52:01 +0100
committerJohn Ankarström <john@ankarstrom.se>2019-01-10 11:52:01 +0100
commit2ba89e8763b38dd89b7a87e08c2063599dde0723 (patch)
treed90657bd130f9880ad4605c2b18998a4856fe310
parent20170d4e43032620774cc729c854daffbc1075ad (diff)
downloadrepl-2ba89e8763b38dd89b7a87e08c2063599dde0723.tar.gz
wrote manual
-rw-r--r--repl.140
1 files changed, 40 insertions, 0 deletions
diff --git a/repl.1 b/repl.1
new file mode 100644
index 0000000..fcee1d4
--- /dev/null
+++ b/repl.1
@@ -0,0 +1,40 @@
+.Dd $Mdocdate$
+.Dt REPL 1
+.Os
+.Sh NAME
+.Nm repl
+.Nd create a REPL out of any command
+.\"
+.Sh SYNPOSIS
+.Nm repl
+.Ar command
+.\"
+.Sh DESCRIPTION
+When invoked, the
+.Nm repl
+utility puts the user in a read-eval-print loop, in which it reads
+input from the user, appends it to the
+.Ar command
+provided by the single argument, and lets the shell evaluate the
+full string.
+
+Built on GNU readline, it supports history and Emacs key bindings.
+
+.Nm repl
+is useful for command-line interfaces built on a
+.Dq prefix command
+that has to be typed over and over preceding the actual command, like
+.Xr git 1 .
+.\"
+.Sh EXAMPLES
+.Dl $ repl git
+.Dl git > status
+.Dl On branch master
+.Dl Your branch is up to date with 'origin/master'.
+.Dl git >
+.\"
+.Sh AUTHORS
+.Nm repl
+is written by
+.An John Ankarström ,
+available {on the web|by e-mail} at john{.|@}ankarstrom.se.