diff options
Diffstat (limited to '')
| -rw-r--r-- | libtellurian_distance.3 | 44 |
1 files changed, 41 insertions, 3 deletions
diff --git a/libtellurian_distance.3 b/libtellurian_distance.3 index 49181b3..f6f9135 100644 --- a/libtellurian_distance.3 +++ b/libtellurian_distance.3 @@ -1,8 +1,8 @@ -.TH LIBTELLURIAN_DISTANCE 3 libtellurian +.TH LIBTELLURIAN_DISTANCE 3 LIBTELLURIAN .SH NAME libtellurian_distance \- Calculate distance between two locations -.SH SYNPOSIS +.SH SYNOPSIS .nf #include <libtellurian.h> @@ -51,7 +51,7 @@ unless is .IR NULL , and the forward azimuth for the second point -will be calculated and stored, in degress, in +will be calculated and stored, in degrees, in .I *azimuth2_out unless .I azimuth2_out @@ -104,6 +104,44 @@ functions do not return any value. .SH ERRORS None. +.SH APPLICATION USAGE +The application should use +.BR libtellurian_azimuth () +or +.BR libtellurian_azimuth_radians () +whenever the distance will not be used by the +application, likewise, if +.I *azimuth1_out +will not be used +.I azimuth1_out +should be set to +.I NULL +and if +.I *azimuth2_out +will not be used +.I azimuth2_out +should be set to +.IR NULL . +Although this currently has almost no impact on +the application, future versions of the library +may select different methods for performing the +calculations depending on what output is enabled. + +.SH NOTES +The (forward) azimuths are defined as the +direction you travelling when you travel +along a great ellipsoid (which is the +shortest distance) from +.RI ( latitude1 ", " longitude1 ) +in the direction of +.RI ( latitude2 ", " longitude2 ). +Hence, +.I *azimuth2_out +will be the direction you would continue +along the great ellipsoid, \m[red]not\m[] +the direction for returning to +.RI ( latitude1 ", " longitude1 ). + .SH SEE ALSO .BR libtellurian (7), .BR libtellurian_coarse_distance (3) |