.TH litclock 1
.SH NAME
litclock \- display a clock using quotes from literature
.SH
.B litclock
[
.B -q
.I quotelist
]
[
.B -t
.I hh:mm
]
.SH DESCRIPTION
.I Litclock
will pull a quote from 
.I quotefile
(defualt
.IR $home /lib/litclock.csv)
and display it in a large font on a colored background,
highlighting the part of the quote matching the current time,
followed by the work the quote is from and the work's author.
.I Litclock
will update the display as the time progresses.
.PP
If a
.I -t
argument is given, litclock will use
.I hh:mm
instead of the current time when pulling a quote from the list.
This is mostly used for testing.
.PP
.I Litclock
runs both on Plan 9 and on Unix, using plan9port,
Under unix it will use
.IR fontsrv (4)
to use a nicer system font.
It detects unix by looking for the
.I service
environment variable either being blank or set to
.LR unix .
.PP
.L Quotefile
is a csv-formatted file using
.B |
characters for separators. The fileds in order are:
.SS hhmm
The time the quote corresponds to, formatted as a 24-hour
.RI " hh:mm "
value.
.SS match
The substring of the quote which contains the time;
this is matched case-insensitively.
.SS message
The body of the quote.
.SS work
The title of the work the quote is from.
.SS author
The author of the work.
.SS nsfw
Contains the string
.RI " nsfw "
if the database considers the quore potentially "not safe for work".
.SH FILES
.PP
.IR $home /lib/litclock.csv
.PP
.I https://github.com/JohannesNE/literature-clock/blob/master/litclock_annotated.csv
.SH SOURCE
.B http://a.9srv.net/src/litclock.c
.SH SEE ALSO
.PP
.IR marquee (1),
.IR wordwrap (2)
.PP
.I https://github.com/JohannesNE/literature-clock/blob/master/litclock_annotated.csv
.SH BUGS
.PP
Owing to its origin from a web app, the original database uses
.IR <br> -style
line breaks. Modify the original like so:
.EX
sed 's/\\<br ?.?\\>/\\\\n/g' < original > output
.EE
.PP
We do not offer any filtering of "nsfw"-tagged entries.
.PP
If the database contains multiple lines for a given time, we just pick the first.
It would be better to randomize.
.PP
If the time moves on to a time without an entry in the database,
.I litclock
is supposed to leave the previous message intact, but this is questionable.
It crashes if you start on a time without an entry.
.PP
There is no fallback mechanism for characters in the input text
which aren't in the display font.
.PP
It should be possible to set the color, font, and possibly the margin.
.PP
Tabs in the input are just rendered as a single space.
.PP
The Plan 9 fonts shipped with the system don't offer much variety
of style (roman, bold, italic) within the same font and size, so the
defaults used here are not as satisfying as those used with
.IR fontsrv (4).
You may want to import some fonts when running on Plan 9.