From e0548714dfbe67da6e2543e0fcc469a1da9e0eea Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 2 Dec 2015 14:34:58 +0100 Subject: add readme MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..7f6c65f --- /dev/null +++ b/README @@ -0,0 +1,60 @@ +NAME + rq - read quickly + +SYNOPSIS + rq [FILE] + +DESCRIPTION + Displays a plain-text file word-by-word in the middle + of the terminal. Words are automatically paged in a + specifyable rate, by default 2 words per second. + Repeated words will be indicated by alternating reverse + video highlighting. + + Escape sequences are printed as-is. + + If no file is specified, or if '-' i specified, stdin + will be paged. + +OPTIONS + None. + +ENVIRONMENT + RQ_RATE + The rate at which the words will be printed. + Defaults to 120 words per minute. + + This should a positive integer optionally + followed by a unit. If no unit is specified, + words per minute will be used. Value units + are (case, insensitive): + + wpm + w/m + /m + wpmin + w/min + /min Words per minute. + + wpsec + w/sec + /sec + wps + w/s + /s + Hz Words per second. + +COMMANDS + + Increase word rate. + - Decrease word rate. + p Pause/resume. + q Exit. + left Go to the previous word. + up Go to the previous word. + right Go to next previous word. + down Go to next previous word. + +SEE ALSO + No similar or otherwise related work known. + Please inform me if you know any. + -- cgit v1.2.3-70-g09d2