'\" t
.\"     Title: rink-dates
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.21
.\"      Date: 2024-05-01
.\"    Manual: Rink Manual
.\"    Source: Rink Manual
.\"  Language: English
.\"
.TH "RINK\-DATES" "5" "2024-05-01" "Rink Manual" "Rink Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
rink-dates \- Rink file format for date patterns
.SH "SYNPOSIS"
.sp
Rink allows specifying datetimes using \fB#date#\fP syntax in queries. This
file defines the patterns that are used to try to match the specified
date.
.SH "DESCRIPTION"
.sp
Blank lines are ignored. Lines starting with # are ignored.
.sp
A date pattern is a sequence of keywords which each specify a token to
match. part of the sequence can be wrapped with [] to make it optional.
.sp
The valid keywords are:
.sp
\fBfullyear\fP
.RS 4
The full 4 digit year, like 2024. Must be exactly 4 digits.
.RE
.sp
\fBshortyear\fP
.RS 4
Shortened 2\-digit year, like 24. Must be exactly 2 digits.
.RE
.sp
\fBcentury\fP
.RS 4
The year with the last 2 digits cut off, like 20. Not the same as
the actual century number (which would be 21). Must be exactly 2 digits.
.RE
.sp
\fBmonthnum\fP
.RS 4
The current month number, like 03. Must be exactly 2 digits.
.RE
.sp
\fBday\fP
.RS 4
The current day of the month, like 3. Can be any number of digits.
.RE
.sp
\fBfullday\fP
.RS 4
The current day of the month, like 03. Must be exactly 2 digits.
.RE
.sp
\fBmin\fP
.RS 4
The current minute of the hour, like 05. Must be exactly 2 digits.
.RE
.sp
\fBordinal\fP
.RS 4
The current day of the year, like 083. Must be exactly 3 digits.
.RE
.sp
\fBisoyear\fP
.RS 4
The ISO year, like \-0001. Must be exactly 4 digits. ISO year unifies
CE and BCE such that 1BC is year 0, and 2BCE is year \-1.
.RE
.sp
\fBunix\fP
.RS 4
Unix timestamp, i.e. the number of 1/86400ths of a day elapsed since
January 1st, 1970. Can be any number of digits.
.RE
.sp
\fByear\fP
.RS 4
The current year, like 2024. Can be any number of digits.
.RE
.sp
\fBadbc\fP
.RS 4
Looks for \f(CRad\fP, \f(CRce\fP, \f(CRbc\fP, or \f(CRbce\fP (case insensitive). This allows
specifying dates prior to year 1 CE.
.RE
.sp
\fBhour12\fP
.RS 4
The current hour on a 12\-hour clock. Must be exactly 2 digits.
.RE
.sp
\fBhour24\fP
.RS 4
The current hour on a 24\-hour clock. Must be exactly 2 digits.
.RE
.sp
\fBmeridiem\fP
.RS 4
Looks for \f(CRam\fP or \f(CRpm\fP (case insensitive). This allows specifying
12\-hour time.
.RE
.sp
\fBsec\fP
.RS 4
The current second of the current minute. Must be exactly 2 digits.
Can optionally have a decimal point to specify time smaller than a
second.
.RE
.sp
\fBoffset\fP
.RS 4
Matches a timezone offset. This can either be the name of a timezone
like \f(CRUS/Pacific\fP or a fixed offset. The fixed offset can either be
in the form +07:00 or +0700.
.RE
.sp
\fBmonthname\fP
.RS 4
Matches English month names, case insensitive. Recognizes 3\-letter
names (like jan, feb, mar) and full names.
.RE
.sp
\fBweekday\fP
.RS 4
Makes English weekday names, case insensitive. Recognizes 3\-letter
names (like mon, tue, wed) and full names.
.RE
.sp
\fB\f(CR\-\fP\fP
.RS 4
Matches a literal \f(CR\-\fP character.
.RE
.sp
\fB\f(CR:\fP\fP
.RS 4
Matches a literal \f(CR:\fP character.
.RE
.sp
` `
.RS 4
A single space will match any amount of whitespace.
.RE
.sp
\fB\f(CR\*(Aq\fP\fP <\fIanything\fP> \fB\f(CR\*(Aq\fP\fP
.RS 4
Wrapping text in single quotes will match that text literally.
.RE
.SH "FILES"
.sp
Rink searches the following locations:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CR./rink/datepatterns.txt\fP
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CR\fI$XDG_CONFIG_DIR\fP/rink/datepatterns.txt\fP
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.  sp -1
.  IP \(bu 2.3
.\}
\f(CR/usr/share/rink/datepatterns.txt\fP
.RE
.SH "SEE ALSO"
.sp
rink(1), rink(5),
rink(7), rink\-defs(5)