diff --git a/xmldoc/chapters/glossary.xml b/xmldoc/chapters/glossary.xml index 06127d798..8339924e3 100644 --- a/xmldoc/chapters/glossary.xml +++ b/xmldoc/chapters/glossary.xml @@ -1,18 +1,67 @@ - + + Glossary Terms that are used in conjunction with GPSBabel. + + + C + + CSV (Comma Separated Values) + + A ubiquitous text-based file format for tabular data. + GPSBabel includes multiple CSV modules + (unicsv, + xcsv, and a legacy + csv module). See + Choosing the Right CSV Format + for details. + + + + + csv (legacy module) + + GPSBabel's simplest CSV module, typically for files with + only Latitude, Longitude, and Name, and no header. + Generally not recommended for modern use. See + Choosing the Right CSV Format. + + + + + + + F + + Filter + + A GPSBabel operation () that + modifies or selects data as it flows through the program. + Examples include simplifying tracks, nuking certain data + types, or adding timestamps. For more details, see the + Advanced Usage section + and the Filters chapter. + + + + + G - + Geocaching GPS based "paper chase", see - - https://en.wikipedia.org/wiki/Geocaching + + https://en.wikipedia.org/wiki/Geocaching + + - + + I Itinerary @@ -21,6 +70,34 @@ + + + O + + Option + + A command-line argument that controls GPSBabel's + behavior (e.g., , ). + Options are processed strictly from left to right. See the + Invocation section for + basic options and the + full options list. + + + + + Suboption + + Additional parameters that modify the behavior of a + specific format or filter module. They are typically + comma-separated and follow the main option (e.g., + ). For more details, see the + Suboptions section. + + + + + P @@ -31,6 +108,7 @@ + R @@ -41,10 +119,12 @@ defining the route you want to pass while traveling, created by PC software, or generated inside a GPS device. They can be composed of existing waypoints, or new - "routepoints" might be generated. + "routepoints" might be generated. + + T @@ -55,10 +135,26 @@ of trackpoints within the track is important. Usually a trackpoint doesn't have a name or comment, but a timestamp. This distinguishes a trackpoint from a - waypoint. + waypoint. + + + + U + + unicsv (Universal CSV module) + + GPSBabel's recommended CSV module for most modern files, + especially those with a header row. It intelligently detects + fields and preserves additional data. See + Choosing the Right CSV Format. + + + + + W @@ -69,8 +165,24 @@ entered before, while or after you actually visit the place and might have tags like name, comment and the like. Usually used to mark special locations as your - home, a hotel or a geocache. + home, a hotel or a geocache. + + + + X + + xcsv (Extended CSV module) + + An advanced, highly customizable CSV module that + requires a separate "style file" to define its structure. + Useful for complex or non-standard CSV layouts. See + Choosing the Right CSV Format. + + + + + diff --git a/xmldoc/chapters/use.xml b/xmldoc/chapters/use.xml index 9b5d16342..be4c3789a 100644 --- a/xmldoc/chapters/use.xml +++ b/xmldoc/chapters/use.xml @@ -1,11 +1,29 @@ - + Usage
Invocation - If you're using GPSBabel, you will need to know how to do at least two things: -read data from a file, and write it to another file. There are four basic -options you need to know to do those things: - + + If you're using GPSBabel, you will need to know how to do + at least two things: read data from a file, and write it + to another file. There are four basic options you need + to know to do those things: + + + + + For Most Users: If you prefer + a visual interface over command-line arguments, GPSBabel also + provides a user-friendly + Graphical User + Interface (GUI) for Windows, macOS, and Linux. The GUI + simplifies common tasks like converting file formats and + applying basic filters without needing to memorize commands. + Most users find the GUI the easiest way to get started with + GPSBabel. + + + Command @@ -430,17 +448,50 @@ merged data to multiple destinations. gpsbabel.ini containing preferences you have provided. This option lets you pick a different file. See - for more info. - - 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. + for more info. + - 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. + 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. + + + Important Note: The use + of is generally not recommended for + modern file-to-file conversions, especially when dealing + with tracks or routes. It was primarily useful for older + serial GPS devices with very limited display capabilities + that needed short, synthesized names. For preserving rich + waypoint data or when working with tracks and routes, + avoid using this option. As noted in + , + can create havoc on tracks and routes due to its renaming + behavior breaking internal linkages. + + + + Work on routes. This option primarily tells + GPSBabel to process routes. In most modern file-to-file + conversions, GPSBabel attempts to process all available data + types (waypoints, tracks, and routes) by default. Therefore, + specifying , , or + is generally only necessary if you + explicitly wish to restrict the data being + processed to *only* routes, tracks, or waypoints respectively, + or when interacting with older serial devices or specific + formats that require these flags (such as + garmin for tracks/routes). + - Work on tracks. See - - for usage. + Work on tracks. See + for usage. + - Work on waypoints. This is the default. + Work on waypoints. This is the default. + See for usage. + 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 @@ -455,6 +506,7 @@ merged data to multiple destinations. , Print help. - Print version number. + Print version number. +