]> git.ipfire.org Git - people/ms/libloc.git/commitdiff
location-downloader: Add man page
authorMichael Tremer <michael.tremer@ipfire.org>
Sun, 17 Nov 2019 14:55:31 +0000 (14:55 +0000)
committerMichael Tremer <michael.tremer@ipfire.org>
Sun, 17 Nov 2019 14:55:31 +0000 (14:55 +0000)
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
Makefile.am
man/location-downloader.txt [new file with mode: 0644]

index 859d9cdbe1798de9ea6198fad42b63b8b5d463bc..1b2c42c9660ad046f3544a3709391f1bf31d7366 100644 (file)
@@ -329,6 +329,7 @@ src_test_database_LDADD = \
 # ------------------------------------------------------------------------------
 
 MANPAGES = \
+       man/location-downloader.8 \
        man/location-query.8
 
 MANPAGES_TXT  = $(patsubst %.8,%.txt,$(MANPAGES))
diff --git a/man/location-downloader.txt b/man/location-downloader.txt
new file mode 100644 (file)
index 0000000..a03b60f
--- /dev/null
@@ -0,0 +1,45 @@
+= location-downloader(8)
+
+== NAME
+location-downloader - Download a location database
+
+== SYNOPSIS
+[verse]
+`location-downloader update`
+
+== DESCRIPTION
+The `location-downloader` command updates the local version of the
+location database.
+
+== OPTIONS
+
+--database FILE::
+-d FILE::
+       The path of the database which is being updated.
+       +
+       If this option is omitted, the system's database will be opened.
+
+--debug::
+       Enable debugging mode
+
+== COMMANDS
+
+'update'::
+       This command will try to update the local database.
+
+'--help'::
+       Shows a short help text on using this program.
+
+'--version'::
+       Shows the program's version and exists.
+
+== EXIT CODES
+The 'location-downloader' command will normally exit with code zero.
+If there has been a problem and the requested action could not be performed,
+the exit code is unequal to zero.
+
+== BUGS
+Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/.
+
+== AUTHORS
+Michael Tremer