From ebba43d156b6feb0fb845c603b1de1ea930ecd4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= Date: Thu, 10 Jan 2019 15:21:37 +0100 Subject: added man page to readme --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file 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öm, +available {on the web|by e-mail} at john{.|@}ankarstrom.se. + +OpenBSD 6.4 - January 10, 2019 -- cgit v1.2.3