[Git][debian-gis-team/tilemaker][patch-queue/master] 2 commits: Add man page for tilemaker

[ǝɹʇʇɐʃǝ◖ xıʃǝɟ (@xamanu)]

ǝɹʇʇɐʃǝ◖ xıʃǝɟ pushed to branch patch-queue/master at Debian GIS Project / tilemaker


Commits:
197b44cc by Felix Delattre at 2021-10-08T11:34:51+00:00
Add man page for tilemaker

- - - - -
fad0dc7a by Felix Delattre at 2021-10-08T11:35:15+00:00
Avoid forcing version setting through git.

- - - - -


3 changed files:

- CMakeLists.txt
- Makefile
- + docs/man/tilemaker.1


Changes:

=====================================
CMakeLists.txt
=====================================
@@ -58,10 +58,12 @@ include_directories(${ZLIB_INCLUDE_DIR})
 
 set(CMAKE_CXX_STANDARD 14)
 
-execute_process(
-	COMMAND git describe --tags --abbrev=0
-	OUTPUT_VARIABLE tm_version)
-add_compile_definitions(TM_VERSION=${tm_version})
+if(!TM_VERSION)
+	execute_process(
+		COMMAND git describe --tags --abbrev=0
+		OUTPUT_VARIABLE tm_version)
+	add_compile_definitions(TM_VERSION=${tm_version})
+endif()
 
 if(MSVC)
  	find_package(unofficial-sqlite3 CONFIG REQUIRED)
@@ -109,4 +111,6 @@ if(MSVC)
     target_link_libraries(tilemaker unofficial::sqlite3::sqlite3)
 endif()
 
+install(FILES docs/man/tilemaker.1 DESTINATION share/man/man1)
+
 install(TARGETS tilemaker RUNTIME DESTINATION bin)


=====================================
Makefile
=====================================
@@ -61,6 +61,7 @@ endif
 
 # Main includes
 
+MANPREFIX := /usr/share/man
 TM_VERSION := $(shell git describe --tags --abbrev=0)
 CXXFLAGS := -O3 -Wall -Wno-unknown-pragmas -Wno-sign-compare -std=c++14 -pthread -fPIE -DTM_VERSION=$(TM_VERSION) $(CONFIG)
 LIB := -L/usr/local/lib -lz $(LUA_LIBS) -lboost_program_options -lsqlite3 -lboost_filesystem -lboost_system -lboost_iostreams -lprotobuf -lshp
@@ -84,6 +85,8 @@ tilemaker: include/osmformat.pb.o include/vector_tile.pb.o src/mbtiles.o src/pbf
 
 install:
 	install -m 0755 tilemaker /usr/local/bin
+	install -m 0755 -d ${DESTDIR}${MANPREFIX}/man1/
+	install docs/man/tilemaker.1 ${DESTDIR}${MANPREFIX}/man1/
 
 clean:
 	rm -f tilemaker src/*.o include/*.o


=====================================
docs/man/tilemaker.1
=====================================
@@ -0,0 +1,54 @@
+.\" Manpage for tilemaker.
+.TH man 1 "27 Aug 2021" "1.0" "tilemaker man page"
+.SH NAME
+tilemaker \- Generates vector tiles from OpenStreetMap data
+.SH SYNOPSIS
+tilemaker --input input.osm.pbf --output output.mbtiles
+.SH DESCRIPTION
+This manual page documents briefly the
+.B tilemaker
+command.
+.PP
+.B tilemaker
+generates vector tiles without from OpenStreetMap planet and diff
+files without any complex stack or need for database.
+.PP
+This program follows the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below:
+.TP
+\fB\-\-input
+Source path and file from OpenStreetMap (.osm.pbf).
+.TP
+\fB\-\-output
+Target path and file for vector tiles (.mbtiles/.sqlite).
+.TP
+\fB\-\-config
+Specific config file (.json). If is nothing provided, tilemaker expects a
+`config.json` file in the current directory.
+.TP
+\fB\-\-process
+Lua processing script for processing tags (.lua). If is nothing provided,
+tilemaker expects a `process.lua` file in the current directory.
+.TP
+\fB\-\-store
+Path to the directory as a temporary store during processing.
+If specifcied tilemaker uses on-disk storage instead of holding everything
+in RAM.
+.TP
+\fB\-\-merge
+Merge with existing .mbtiles/.sqlite file.
+.TP
+\fB\-\-verbose
+Outputs any issues encountered during tile creation.
+.TP
+\fB\-\-threads
+Number of threads (automatically detected if 0).
+.TP
+\fB\-\-help
+Show help message for tilemaker.
+.PP
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+This manual page was written by tilemaker contributors.



View it on GitLab: https://salsa.debian.org/debian-gis-team/tilemaker/-/compare/45bcb5eab8f254fa02f5943aaa37b7894d69a5d2...fad0dc7a8a74a6a5def93e952fb4ccb21e40a9d6

-- 
View it on GitLab: https://salsa.debian.org/debian-gis-team/tilemaker/-/compare/45bcb5eab8f254fa02f5943aaa37b7894d69a5d2...fad0dc7a8a74a6a5def93e952fb4ccb21e40a9d6
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-grass-devel/attachments/20211008/748f82d3/attachment-0001.htm>