From 519d2bbfa25b2fabe7b15b416cc7086746cee32a Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Wed, 15 Jan 2020 18:27:30 +0100 Subject: documentation --- bin/db-iris | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/bin/db-iris b/bin/db-iris index 9a05056..8bd3148 100755 --- a/bin/db-iris +++ b/bin/db-iris @@ -613,6 +613,15 @@ or I
.I.I format, or C<< tomorrow >>. Note that typically only slight (a few hours max) deviations from the current time are supported by the IRIS backend, larger ones will not return data. +=item B<--json> + +List departures as JSON. Outputs a JSON list containing one hash for each +departure. The B<--output> option has no effect when using B<--json>. + +Note that JSON output is NOT compatible between releases. Its structure is not +part of the db-iris / Travel::Status::DE::IRIS versioning scheme; it may change +in backwards-incompatible ways anytime. + =item B<-l>, B<--lookahead> I Do not return results which are more than I minutes in the future. @@ -623,6 +632,14 @@ with a departure in less than I minutes. This guarantee holds only for I below 120. However, any non-negative number is accepted for this option. +=item B<--no-cache> + +If the Cache::File module is available, server replies are cached in +F<~/.cache/db-iris-schedule> and F<~/.cache/db-iris-realtime> (or paths +relative to C<$XDG_CACHE_HOME>, if set). Use this option to disable caching +altogether. Note that this will significantly decrease db-iris responsiveness, +especially on mobile networks such as WifiOnICE. + =item B<-o>, B<--output> I For each result, output I in addition to the normal time, delay, @@ -795,6 +812,14 @@ None. =back +=head1 RECOMMENDS + +=over + +=item * Cache::File(3pm) + +=back + =head1 BUGS AND LIMITATIONS There are no known bugs at the moment. -- cgit v1.2.3