datatools/reldate.1.html at main · caltechlibrary/datatools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>datatools</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="search.html">Search</a></li>
    <li><a href="https://github.com/caltechlibrary/datatools">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>reldate</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>reldate <a href="#options">OPTIONS</a> [TIME_DESCRPTION]</p>
<h1 id="description">DESCRIPTION</h1>
<p>reldate is a small command line utility which returns the relative
date in YYYY-MM-DD format. This is helpful when scripting various time
relationships. The difference in time returned are determined by the
time increments provided.</p>
<p>Time increments are a positive or negative integer. Time unit can be
either day(s), week(s), month(s), or year(s). Weekday names are case
insentive (e.g. Monday and monday). They can be abbreviated to the first
three letters of the name, e.g. Sunday can be Sun, Monday can be Mon,
Tuesday can be Tue, Wednesday can be Wed, Thursday can be Thu, Friday
can be Fri or Saturday can be Sat.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>
display help
</dd>
<dt>-license</dt>
<dd>
display license
</dd>
<dt>-version</dt>
<dd>
display version
</dd>
<dt>-e, -end-of-month</dt>
<dd>
Display the end of month day. E.g. 2012-02-29
</dd>
<dt>-f, -from</dt>
<dd>
Date the relative time is calculated from.
</dd>
<dt>-nl, -newline</dt>
<dd>
if true add a trailing newline
</dd>
<dt>-quiet</dt>
<dd>
suppress error messages
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>If today was 2014-08-03 and you wanted the date three days in the
past try–</p>
<pre><code>    reldate 3 days</code></pre>
<p>The output would be</p>
<pre><code>    2014-08-06</code></pre>
<p>TIME UNITS</p>
<p>Supported time units are</p>
<ul>
<li>day(s)</li>
<li>week(s)</li>
<li>year(s)</li>
</ul>
<p>Specifying a date to calucate from</p>
<p>reldate handles dates in the YYYY-MM-DD format (e.g. March 1, 2014
would be 2014-03-01). By default reldate uses today as the date to
calculate relative time from. If you use the –from option you can it
will calculate the relative date from that specific date.</p>
<pre><code>   reldate --from=2014-08-03 3 days</code></pre>
<p>Will yield</p>
<pre><code>    2014-08-06</code></pre>
<h2 id="negative-increments">NEGATIVE INCREMENTS</h2>
<p>Command line arguments traditionally start with a dash which we also
use to denote a nagative number. To tell the command line process that
to not treat negative numbers as an “option” precede your time increment
and time unit with a double dash.</p>
<pre><code>    reldate --from=2014-08-03 -- -3 days</code></pre>
<p>Will yield</p>
<pre><code>    2014-07-31</code></pre>
<h2 id="relative-week-days">RELATIVE WEEK DAYS</h2>
<p>You can calculate a date from a weekday name (e.g. Saturday, Monday,
Tuesday) knowning a day (e.g. 2015-02-10 or the current date of the
week) occurring in a week. A common case would be wanting to figure out
the Monday date of a week containing 2015-02-10. The week is presumed to
start on Sunday (i.e. 0) and finish with Saturday (e.g. 6).</p>
<pre><code>    reldate --from=2015-02-10 Monday</code></pre>
<p>will yield</p>
<pre><code>    2015-02-09</code></pre>
<p>As that is the Monday of the week containing 2015-02-10. Weekday
names case insensitive and can be the first three letters of the English
names or full English names (e.g. Monday, monday, Mon, mon).</p>
<p>reldate 1.3.5</p>
</section>
<footer-global></footer-global>
</body>
</html>