summaryrefslogtreecommitdiff
path: root/bin/hafas-m
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2023-10-28 23:16:16 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2023-10-28 23:16:16 +0200
commit6560d248393cde5fbff0451bcddb03435c4a7f08 (patch)
treea38d31d49cb97bf18b0b62e64ee51dab511e0e3a /bin/hafas-m
parentd681a04ee0fdaaf01cc3436d132423848482ef11 (diff)
hafas-m(1): Add warning for --json; exit status details
Diffstat (limited to 'bin/hafas-m')
-rwxr-xr-xbin/hafas-m14
1 files changed, 8 insertions, 6 deletions
diff --git a/bin/hafas-m b/bin/hafas-m
index cbab230..7a683b7 100755
--- a/bin/hafas-m
+++ b/bin/hafas-m
@@ -438,12 +438,14 @@ Date to list departures for. Default: today.
=item B<--json>
-Print result(s) as JSON.
+Print result(s) as JSON. This is a dump of internal data structures and not
+guaranteed to remain stable between minor versions. Please use the
+Travel::Status::DE::HAFAS(3pm) module if you need a proper API.
=item B<--list>
-List known HAFAS installations. A HAFAS service from this list can be querie
-using B<--service>.
+List known HAFAS installations and exit. Use B<-s>|B<--service> to select an
+operator from this list for a HAFAS request.
=item B<-m>, B<--mot> I<motlist>
@@ -468,13 +470,13 @@ Time to list departures for. Default: now.
=item B<-V>, B<--version>
-Show version information.
+Show version information and exit.
=back
=head1 EXIT STATUS
-Zero unless things went wrong.
+0 upon success, 1 upon internal error, 2 upon backend error.
=head1 CONFIGURATION
@@ -492,7 +494,7 @@ None.
=head1 BUGS AND LIMITATIONS
-The non-default services (anything other than DB) are not well tested.
+The non-default services (anything other than DB) are not well-tested.
=head1 AUTHOR