Skip to content

Commit a05c35b

Browse files
committed
Improve -[trw] usage
1 parent d4c9e20 commit a05c35b

File tree

1 file changed

+53
-9
lines changed

1 file changed

+53
-9
lines changed

xmldoc/chapters/use.xml

Lines changed: 53 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,24 @@
22
<title>Usage</title>
33
<section xml:id="Invocation">
44
<title>Invocation</title>
5-
<para>If you're using GPSBabel, you will need to know how to do at least two things:
6-
read data from a file, and write it to another file. There are four basic
7-
options you need to know to do those things:
8-
</para>
5+
<para>If you're using GPSBabel, you will need to know how to do
6+
at least two things: read data from a file, and write it
7+
to another file. There are four basic options you need
8+
to know to do those things:
9+
</para>
10+
<note>
11+
<para>
12+
<emphasis role="strong">For Most Users:</emphasis> If you prefer
13+
a visual interface over command-line arguments, GPSBabel also
14+
provides a user-friendly
15+
<link xlink:href="https://www.gpsbabel.org/gui/">Graphical User
16+
Interface (GUI)</link> for Windows, macOS, and Linux. The GUI
17+
simplifies common tasks like converting file formats and
18+
applying basic filters without needing to memorize commands.
19+
Most users find the GUI the easiest way to get started with
20+
GPSBabel.
21+
</para>
22+
</note>
923
<segmentedlist>
1024
<?dbhtml list-presentation="table"?>
1125
<segtitle>Command</segtitle>
@@ -432,15 +446,45 @@ merged data to multiple destinations.
432446
<xref linkend="inifile"/>
433447
for more info.</para>
434448
<para>
435-
<option>-s</option> Write "smart" names. This option influences some - but not all - of our writers to try to build "smart" waypoint names. For example, in modules that know about geocaching, it may replace "GC1234" with the actual name of the geocache.</para>
436449
<para>
437-
<option>-r</option> Work on routes. This option has a subtly different meaning in different cases. As the very first formats in GPSBabel were for serial GPSes and routes and tracks were large and thus time-consuming to transfer, the default was waypoints only with this option to turn on the extra data. Some of our file formats use this option to mean "work only on routes, even if you have tracks/waypoints", but we're trying to discourage that behavior and in most cases, consider it a bug. </para>
450+
<option>-s</option> Write "smart" names. This option influences
451+
some - but not all - of our writers to try to build "smart"
452+
waypoint names. For example, in modules that know about
453+
geocaching, it may replace "GC1234" with the actual name of
454+
the geocache.
455+
<note>
456+
<para>
457+
<emphasis role="strong">Important Note:</emphasis> The use
458+
of <option>-s</option> is generally not recommended for
459+
modern file-to-file conversions, especially when dealing
460+
with tracks or routes. It was primarily useful for older
461+
serial GPS devices with very limited display capabilities
462+
that needed short, synthesized names. For preserving rich
463+
waypoint data or when working with tracks and routes,
464+
avoid using this option. As noted in
465+
<xref linkend="Route_And_Track_Modes"/>, <option>-s</option>
466+
can create havoc on tracks and routes due to its renaming
467+
behavior breaking internal linkages.
468+
</para>
469+
</note>
438470
<para>
471+
<option>-r</option> Work on routes. This option primarily tells
472+
GPSBabel to process routes. In most modern file-to-file
473+
conversions, GPSBabel attempts to process all available data
474+
types (waypoints, tracks, and routes) by default. Therefore,
475+
specifying <option>-r</option>, <option>-t</option>, or
476+
<option>-w</option> is generally only necessary if you
477+
explicitly wish to <emphasis>restrict</emphasis> the data being
478+
processed to *only* routes, tracks, or waypoints respectively,
479+
or when interacting with older serial devices or specific
480+
formats that require these flags (such as
481+
<link linkend="fmt_garmin">garmin</link> for tracks/routes).
482+
</para>
439483
<option>-t</option> Work on tracks. See
440-
<option>-r</option>
441-
for usage.</para>
484+
<option>-r</option> for usage.</para>
442485
<para>
443-
<option>-w</option> Work on waypoints. This is the default. </para>
486+
<option>-w</option> Work on waypoints. This is the default. See
487+
<option>-r</option> for usage.
444488
<para>
445489
<option>-T</option> Enable Realtime tracking. This option isn't supported by the majority of our file formats, but repeatedly reads location from a GPS and writes it to a file as described in
446490
<xref linkend="tracking"/></para>

0 commit comments

Comments
 (0)