summaryrefslogtreecommitdiff
path: root/bin/db-wagenreihung
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2020-04-26 13:39:24 +0200
committerDaniel Friesel <derf@finalrewind.org>2020-04-26 13:39:24 +0200
commit639f8678effc8f604f345d9ec57c23d9487c630d (patch)
tree97cd768fc3be9793b1ec8045035d7070d76c7634 /bin/db-wagenreihung
parent5f8332567182d1d44b5e79a5128f7babc754575e (diff)
Minor documentation update
Diffstat (limited to 'bin/db-wagenreihung')
-rwxr-xr-xbin/db-wagenreihung31
1 files changed, 26 insertions, 5 deletions
diff --git a/bin/db-wagenreihung b/bin/db-wagenreihung
index e143ef8..e8d1c82 100755
--- a/bin/db-wagenreihung
+++ b/bin/db-wagenreihung
@@ -162,16 +162,37 @@ B<db-wagenreihung> I<station> I<train-number>
version 0.02
+This is beta software: API and output format may change without notice.
+
=head1 DESCRIPTION
-db-wagenreihung shows wagon orders as reported by the Deutsche Bahn Wagon Order
-API. At the moment, only long-distance ICE trains operated by Deutsche
-Bahn are supported. Most IC/EC lines also work, but results may not be
-entirely correct.
+db-wagenreihung shows the wagon order of train I<train-number> at station
+I<station> (must be a name or DS100 code) as reported by the Deutsche Bahn
+Wagon Order API. As of April 2020, long-distance IC/EC/ICFE trains are widely
+supported, and some regions (e.g. Stuttgart/Karlsruhe) also provide wagon
+orders for select regional trains. Data accuracy varies, but seems to be
+improving over time.
+
+It is not possible to request the wagon order at a train's terminus station.
+This is a known limitation.
The departure of I<train-number> must be in the time range between now and
two hours in the future.
+=head1 EXAMPLES
+
+=over
+
+=item db-wagenreihung 'Essen Hbf' 723
+
+Show wagon order of ICE 723 at Essen Hbf
+
+=item db-wagenreihung TS 3259
+
+Show wagon order of IRE 3259 at Stuttgart Hbf
+
+=back
+
=head1 DEPENDENCIES
=over
@@ -186,7 +207,7 @@ two hours in the future.
=head1 AUTHOR
-Copyright (C) 2018-2019 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
+Copyright (C) 2018-2020 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>
=head1 LICENSE