summaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2020-08-20 15:53:01 +0200
committergregory guy <gregory-tde@laposte.net>2020-08-20 15:53:01 +0200
commita451e44f4ac9838eca11731780be425a1f46a0b8 (patch)
tree71e974dc4c85bd3773f037729895896ecc614fe8 /doc/man
parentf9ea8458f59dad5db45f34daca5417332b2f3212 (diff)
downloadtdepacman-a451e44f4ac9838eca11731780be425a1f46a0b8.tar.gz
tdepacman-a451e44f4ac9838eca11731780be425a1f46a0b8.zip
Rework of the README file.
Move the kpacman html api's files into the doc folder. Add a man page. Rework of the desktop file. Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/CMakeLists.txt5
-rw-r--r--doc/man/kpacman.142
2 files changed, 47 insertions, 0 deletions
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
new file mode 100644
index 0000000..8512250
--- /dev/null
+++ b/doc/man/CMakeLists.txt
@@ -0,0 +1,5 @@
+INSTALL(
+ FILES ${PROJECT_NAME}.1
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/kpacman.1 b/doc/man/kpacman.1
new file mode 100644
index 0000000..57476ca
--- /dev/null
+++ b/doc/man/kpacman.1
@@ -0,0 +1,42 @@
+.TH kpacman 1 "August 20, 2020"
+.SH NAME
+kpacman \- A pacman clone game for TDE.
+.SH SYNOPSIS
+.B kpacman
+.RI [Qt-options] [TDE-options] [URL]
+.SH DESCRIPTION
+Kpacman is a classic arcade game from the 80s in which you have
+to finish the tables by eating all the pac-gums to score as many points
+as possible.
+.PP
+.SH OPTIONS
+.SS
+.SS Generic Options:
+.TP
+.B --help
+Show help about options
+.TP
+.B --help-qt
+Show Qt specific options
+.TP
+.B --help-tde
+Show TDE specific options
+.TP
+.B --help-all
+Show all options
+.TP
+.B --author
+Show author information
+.TP
+.B -v, --version
+Show version information
+.TP
+.B --license
+Show license information
+.SS
+.PP
+.SH HOMEPAGE
+Homepage: https://mirror.git.trinitydesktop.org/gitea/TDE/kpacman
+.SH AUTHOR
+This manual page was written by gregory guy <gregory-tde@laposte.net>,
+for the Trinity Desktop Environment project (but may be used by others).