diff options
Diffstat (limited to '')
| -rw-r--r-- | README | 24 |
1 files changed, 12 insertions, 12 deletions
@@ -53,20 +53,20 @@ SYNOPSIS int libgeome_get_from_netservice(struct libgeome_context *, struct libgeome_data *, const struct libgeome_netservice *); - /* less fundament features omitted */ + /* less fundamental features omitted */ Link with -lgeome -lm. DESCRIPTION - libgeome is a library which provides functionally for looking up - the local user's location on the Globe. + libgeome is a library which provides functionality for looking up + the local user's location on the globe. To use libgeome, first create and initialise a struct libgeome_context which will be used for all other library calls. This can easily be done - by creating a statically allocated struct libgeome_context and call the + by creating a statically allocated struct libgeome_context and calling the libgeome_basic_context(3) function with it as the first argument and the name of the program as the second argument, optionally with - "libgeome" added make it clear where error messages are printed from. + "libgeome" added to make it clear where error messages are printed from. libgeome_get_from_file(3) can be used to check if the user has specified his location in /etc/geolocation (use NULL as the third argument) or any @@ -74,8 +74,8 @@ DESCRIPTION The next best thing is to use libgeome_get_from_timezone(3) to get a rough location based on the user's timezone. But if this doesn't work, - libgeome_get_from_time(3) must be used, which provides only gives an - approximate longitude based one the current timezone, which is affected + libgeome_get_from_time(3) must be used, which only provides an + approximate longitude based on the current timezone, which is affected by daylight saving, which may be desirable for some applications but not for other applications. @@ -86,16 +86,16 @@ DESCRIPTION The function libgeome_get_from_netservice(3) is used for this, and a list of services is provided in libgeome_netservices(3), with the number of services listed provided in libgeome_netservices_count(3). You can - also add custom services, or run local program, using the + also add custom services, or run a local program, using the libgeome_get_from_command(3) function. If it cannot parse the output, - can reformat it as "%s %s\n", <latitude>, <longitude>. + you can reformat it as "%s %s\n", <latitude>, <longitude>. - When alling a libgeome function, any struct libgeome_data must have + When calling a libgeome function, any struct libgeome_data must have its .requested_data set. This lets the called function 1) know what data to request, and 2) what fields are available in the application's version of the structure so that it doesn't write outside it if it is - out of date. There for it is critical that the application doesn't - simply set all but, but instead only recognised ones. + out of date. Therefore it is critical that the application does not + simply set all bits, but instead only the recognised ones. EXTENDED DESCRIPTION Runtime-optional dependencies |