aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2019-01-10 15:21:37 +0100
committerJohn Ankarström <john@ankarstrom.se>2019-01-10 15:22:11 +0100
commitebba43d156b6feb0fb845c603b1de1ea930ecd4e (patch)
tree632cf56cf906002a3cd04e0a622ca1b43406c703
parent69c54e2597e93aa98e5a0a0b8d9695d8263c3102 (diff)
downloadrepl-ebba43d156b6feb0fb845c603b1de1ea930ecd4e.tar.gz
added man page to readme
-rw-r--r--README.md52
1 files changed, 46 insertions, 6 deletions
diff --git a/README.md b/README.md
index 7e4235f..7736718 100644
--- a/README.md
+++ b/README.md
@@ -14,10 +14,50 @@ edit the Makefile and modify the `PREFIX` variable.
To uninstall both binary and man page, run `make uninstall`.
-### Usage
+***
- $ repl git
- git > status
- On branch master
- Your branch is up to date with 'origin/master'.
- git >
+REPL(1) - General Commands Manual
+
+### NAME
+
+**repl** - create a REPL out of any command
+
+### SYNPOSIS
+
+**repl**
+*command*
+
+### DESCRIPTION
+
+When invoked, the
+**repl**
+utility puts the user in a read-eval-print loop, in which it reads
+input from the user, appends it to the
+*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.
+
+**repl**
+is useful for command-line interfaces built on a
+"prefix command"
+that has to be typed over and over preceding the actual command, like
+git(1).
+
+### EXAMPLES
+
+ $ repl git
+ git > status
+ On branch master
+ Your branch is up to date with 'origin/master'.
+ git >
+
+### AUTHORS
+
+**repl**
+is written by
+John Ankarstr&#246;m,
+available {on the web|by e-mail} at john{.|@}ankarstrom.se.
+
+OpenBSD 6.4 - January 10, 2019