aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-02-08 15:39:00 +0100
committerMattias Andrée <maandree@kth.se>2016-02-08 15:39:00 +0100
commit79f41f95efe3e1464dd5e17ee995205cb65a1242 (patch)
tree3611b393c9909930203cef1998007991311e850a
parentupdate dist (diff)
downloadread-quickly-79f41f95efe3e1464dd5e17ee995205cb65a1242.tar.gz
read-quickly-79f41f95efe3e1464dd5e17ee995205cb65a1242.tar.bz2
read-quickly-79f41f95efe3e1464dd5e17ee995205cb65a1242.tar.xz
m doc
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--README7
-rw-r--r--doc/info/rq.texinfo5
-rw-r--r--doc/man/rq.18
3 files changed, 18 insertions, 2 deletions
diff --git a/README b/README
index fcd9caf..8a29efa 100644
--- a/README
+++ b/README
@@ -8,6 +8,8 @@ DESCRIPTION
Displays a plain-text file word-by-word in the middle
of the terminal. Words are automatically paged in a
specifiable rate, by default 2 words per second.
+ This is a bit slow, you should turn it up when
+ gradually until your performance has been optimised.
Repeated words will be indicated by alternating reverse
video highlighting.
@@ -16,6 +18,8 @@ DESCRIPTION
If no file is specified, or if '-' i specified, stdin
will be paged.
+ rq uses a method called rapid serial visual presentation.
+
OPTIONS
None.
@@ -59,5 +63,6 @@ RATIONALE
SEE ALSO
No similar or otherwise related work known.
- Please inform me if you know any.
+ Please inform me if you know any. There probably
+ is a bunch.
diff --git a/doc/info/rq.texinfo b/doc/info/rq.texinfo
index 79ee1a0..de34eed 100644
--- a/doc/info/rq.texinfo
+++ b/doc/info/rq.texinfo
@@ -65,11 +65,16 @@ Texts. A copy of the license is included in the section entitled
@command{rq} displays a plain-text word-by-word in the middle
of the terminal. Words are automatically paged in a
specifiable rate, by default 2 words per second.
+This is a bit slow, you should turn it up when
+gradually until your performance has been optimised.
Repeated words will be indicated by alternating reverse
video highlighting.
Escape sequences are printed as-is.
+@command{rq} uses a method called rapid serial visual
+presentation.
+
@node Invoking
diff --git a/doc/man/rq.1 b/doc/man/rq.1
index ef88c73..9c7d087 100644
--- a/doc/man/rq.1
+++ b/doc/man/rq.1
@@ -8,6 +8,8 @@ rq \- read quickly
Displays a plain-text file word-by-word in the middle
of the terminal. Words are automatically paged in a
specifiable rate, by default 2 words per second.
+This is a bit slow, you should turn it up when
+gradually until your performance has been optimised.
Repeated words will be indicated by alternating reverse
video highlighting.
.PP
@@ -15,6 +17,9 @@ Escape sequences are printed as-is.
.PP
If no file is specified, or if \- i specified,
stdin will be paged.
+.PP
+.B rq
+uses a method called rapid serial visual presentation.
.SH OPTIONS
None.
.SH ENVIRONMENT
@@ -68,7 +73,8 @@ Go to next previous word.
This should be obvious.
.SH SEE ALSO
No similar or otherwise related work known.
-Please inform me if you know any.
+Please inform me if you know any. There probably
+is a bunch.
.SH AUTHORS
Principal author, Mattias Andrée. See the LICENSE file for the full
list of authors.