Skip to content

Commit 0b293fc

Browse files
committed
Fix epoch reference in the manual
1 parent 1dbe30a commit 0b293fc

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

docs/manual.rst

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Synopsis
2020
[--hide-pattern] [--show-pattern]
2121
[--hide-range] [--show-range {hidden,limits,median,quartiles,graph}]
2222
[--hide-samples] [--show-samples]
23-
[--min-timestamp WHEN] [--max-timestamp WHEN] [--epoch WHEN ]
23+
[--min-timestamp WHEN] [--max-timestamp WHEN]
24+
[--timestamps [UNIT since] EPOCH]
2425
[--max-numeric-len LEN] [--sample-bytes SIZE]
2526
[--strip-whitespace] [--no-strip-whitespace]
2627
[--csv-format FIELD[QUOTE]] [--yaml-safe] [--no-yaml-safe]
@@ -145,13 +146,19 @@ Optional Arguments
145146
absolute timestamp (in ISO-8601 format) or a duration to be added to the
146147
current timestamp
147148

148-
.. option:: --epoch WHEN
149+
.. option:: --timestamps [UNIT since] EPOCH
149150

150-
The epoch from which datetimes are measured. Can be specified as an
151-
absolute timestamp (in ISO-8601 format: YYYY-mm-ddTHH:MM:SS), or one of the
152-
special strings, "unix" (which is equivalent to 1970-01-01) or
153-
"excel" (which is roughly equivalent to 1900-01-01, with some adjustments).
154-
The default is "unix"
151+
The units and epoch from which numeric representations of datetimes are
152+
measured. Can be specified as a string in the form:
153+
154+
* 'duration since timestamp' (for example 'days since 1970-01-01' or
155+
'seconds since 1900-01-01')
156+
157+
* a standalone timestamp (in ISO-8601 format)
158+
159+
* one of the special strings "unix" (equivalent to 'seconds since
160+
1970-01-01'; this is also the default) or "excel" (roughly equivalent to
161+
'days since 1900-01-01')
155162

156163
.. option:: --max-numeric-len LEN
157164

0 commit comments

Comments
 (0)