From 791159e2ae660da0a6fbb945447580b9ba269f8d Mon Sep 17 00:00:00 2001 From: Birte Kristina Friesel Date: Sun, 13 Oct 2024 11:19:06 +0200 Subject: efa-m(1): Document station search by name and geolocation --- bin/efa-m | 61 +++++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 41 insertions(+), 20 deletions(-) diff --git a/bin/efa-m b/bin/efa-m index df9390b..c97db4b 100755 --- a/bin/efa-m +++ b/bin/efa-m @@ -599,6 +599,8 @@ B [B<-jLr>] [B<-d> I] [B<-t> I] [B<-l> I] [B<-p> I] [B<-s> I] [I] [IB<:>]I +B [B<-s> I] BI|IB<:>I + B [B<-s> I] I =head1 VERSION @@ -607,14 +609,20 @@ version 3.01 =head1 DESCRIPTION -B lists scheduled departures at location I or details about the -trip . +B is an interface to EFA public transport services. + +It can serve as a departure monitor, request details about a specific +trip/journey, and look up public transport stops by name or geolocation. +The operating mode depends on the contents of its mandatory argument. -In departure monitor mode, for each departure, it shows +=head2 Departure Monitor (I) + +Shows departures it I or I I. For each departure, +B shows =over -=item * scheduled departure time, +=item * estimated departure time (including delay, if available), =item * delay in minutes, @@ -636,14 +644,25 @@ but C<< efa "E Hbf" >> does not. By default, I refers to a stop, this can be changed by specifying I. Supported types are B
and B (point of interest). -In trip details mode, it prints trip information and lists arrival and -departure time, name, and platform of each stop on the trip's route. +=head2 Location Search (BI|IB<:>I) + +List stops that match I or that are located in the vicinity of +IB<:>I geocoordinates. + +=head2 Trip Details (I) + +List trip information as well as arrival and departure time, name, and platform +of each stop on the trip's route. =head1 OPTIONS +Values in brackets indicate options that only apply to the corresponding +operating mode(s). + + =over -=item B<-A>, B<--auto-url>, B<--discover-and-print> +=item B<-A>, B<--auto-url>, B<--discover-and-print> (monitor) Probe all known EFA entry points for the specified stop. Print the first result which was not an error. @@ -652,19 +671,21 @@ Note that this may take a while and will not necessarily return the best result. Also, using thi option by default is not recommended, as it puts EFA services under considerable additional load. -=item B<-d>, B<--date> I +=item B<-d>, B<--date> I (monitor) Show departures for I instead of today. May also be specified as I -=item B<-D>, B<--discover> +=item B<-D>, B<--discover> (monitor) Probe all known EFA entry points for the specified stop. Print the URLs and names of all entry points which did not return an error. -=item B<-j>, B<--with-jid> +=item B<-j>, B<--with-jid> (monitor) -Show journey IDs for each +Show journey ID for each departure. +The ID can be used to query details with a subsequent B invocation +(trip details mode). =item B<--json> @@ -672,14 +693,14 @@ Print result(s) as JSON and exit. This is a dump of internal data structures and not guaranteed to remain stable between minor versions. Please use the Travel::Status::DE::EFA(3pm) module if you need a proper API. -=item B<-L>, B<--linelist> +=item B<-L>, B<--linelist> (monitor) Do not show departures. Instead, list all lines serving the specified place. Note that this information may be incomplete -- only lines which are in service either at the time of the B call or at the time specifed using B<--date> and B<--time> are guaranteed to be included. -=item B<-l>, B<--line> I +=item B<-l>, B<--line> I (monitor) Only show departures of I (comma-separatad list, option may be repeated) @@ -689,7 +710,7 @@ repeated) List supported EFA services with their URLs (see B<-u>) and abbreviations (see B<-s>). -=item B<-m>, B<--mot> I +=item B<-m>, B<--mot> I (monitor) Only show departures whose type appears in I (comma-separated list, this option may be repeated). @@ -698,11 +719,11 @@ The following departure types ("modes of transport") are supported: zug, s-bahn, u-bahn, stadtbahn, tram, stadtbus, regionalbus, schnellbus, seilbahn, schiff, ast, sonstige -=item B<-o>, B<--offset> I +=item B<-o>, B<--offset> I (monitor) Ignore departures which are less than I from now. -=item B<-O>, B<--output> I +=item B<-O>, B<--output> I (monitor) For each result, show additional information as specified by I. I is a comma-separated list, the B<-O>/B<--output> option may @@ -748,12 +769,12 @@ availability, delay reasons, and more. =back -=item B<-p>, B<--platform> I +=item B<-p>, B<--platform> I (monitor) Only show departures at I (comma-separated list, option may be repeated). Note that the C<< Bstg. >> / C<< Gleis >> prefix must be omitted. -=item B<-r>, B<--relative> +=item B<-r>, B<--relative> (monitor) Show relative departure times in minutes (i.e. the time difference between the departure and the time of the request). In this case, realtime data is @@ -764,7 +785,7 @@ already included. Short name of the EFA entry point. See Travel::Status::DE::EFA(3pm) and the B<--list> option for a list of services. -=item B<-t>, B<--time> I +=item B<-t>, B<--time> I (monitor) Show departures starting at I