litclock.1

.\"
.\" Copyright (c) 2022-2024, Sergey Bronnikov
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions are met:
.\"
.\"   * Redistributions of source code must retain the above copyright
.\"     notice, this list of conditions and the following disclaimer.
.\"
.\"   * Redistributions in binary form must reproduce the above copyright
.\"     notice, this list of conditions and the following disclaimer in the
.\"     documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: December 20 2022 $
.Dt LITCLOCK 1
.Os
.Sh NAME
.Nm litclock
.Nd clock using time quotes from a literature
.Sh SYNOPSIS
.Nm
.Op Fl p Ar path
.Op Fl t Ar time
.Op Fl l Ar lang
.Op Fl v
.Sh DESCRIPTION
.Nm
is a shell script for displaying clock using time quotes from a literature in a
terminal, with support for ANSI colors.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl p Ar path
Specify a path to a file with quotes.
.It Fl t Ar time
Specify a time a format HH:MM to use instead of current time.
.It Fl l Ar lang
Specify a language.
Possible values are "ru" and "en".
Default language is "ru".
.El
.Pp
By default litclock highlights a part of quote with time by red color.
With non-empty NO_COLOR
environment variable litclock will disable colored text output.
.Sh EXAMPLES
Display a quote for a current time:
.Pp
$ litclock
.Pp
"9:05am lay in bed, staring at ceiling"
 -- 'A Fraction of the Whole', Steve Toltz
.Pp
$ litclock -l ru -t 23:16
.Pp
Счастливые часов не наблюдают. (сейчас 23:16)
.Sh AUTHORS
.Nm
was written by
.An Sergey Bronnikov .
.Sh BUGS
Due to a limitations in
.Xr sh 1 ,
script shows latest quote for desired time.