summaryrefslogtreecommitdiffstats
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
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>
-rw-r--r--README2
-rw-r--r--doc/kpacman-api/Kpacman.html (renamed from kpacman-api/Kpacman.html)0
-rw-r--r--doc/kpacman-api/all-globals.html (renamed from kpacman-api/all-globals.html)0
-rw-r--r--doc/kpacman-api/full-list-Kpacman.html (renamed from kpacman-api/full-list-Kpacman.html)0
-rw-r--r--doc/kpacman-api/header-list.html (renamed from kpacman-api/header-list.html)0
-rw-r--r--doc/kpacman-api/hier.html (renamed from kpacman-api/hier.html)0
-rw-r--r--doc/kpacman-api/index-long.html (renamed from kpacman-api/index-long.html)0
-rw-r--r--doc/kpacman-api/index.html (renamed from kpacman-api/index.html)0
-rw-r--r--doc/kpacman-api/kpacman_h.html (renamed from kpacman-api/kpacman_h.html)0
-rw-r--r--doc/man/CMakeLists.txt5
-rw-r--r--doc/man/kpacman.142
-rw-r--r--kpacman/kpacman.desktop6
12 files changed, 53 insertions, 2 deletions
diff --git a/README b/README
index 3686278..caa4ce8 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
- kpacman - A pacman game for KDE.
+ kpacman - A pacman clone game for TDE.
Kpacman is a classic arcade game.
diff --git a/kpacman-api/Kpacman.html b/doc/kpacman-api/Kpacman.html
index 5127d4b..5127d4b 100644
--- a/kpacman-api/Kpacman.html
+++ b/doc/kpacman-api/Kpacman.html
diff --git a/kpacman-api/all-globals.html b/doc/kpacman-api/all-globals.html
index a65f90c..a65f90c 100644
--- a/kpacman-api/all-globals.html
+++ b/doc/kpacman-api/all-globals.html
diff --git a/kpacman-api/full-list-Kpacman.html b/doc/kpacman-api/full-list-Kpacman.html
index 12b336a..12b336a 100644
--- a/kpacman-api/full-list-Kpacman.html
+++ b/doc/kpacman-api/full-list-Kpacman.html
diff --git a/kpacman-api/header-list.html b/doc/kpacman-api/header-list.html
index c463cc9..c463cc9 100644
--- a/kpacman-api/header-list.html
+++ b/doc/kpacman-api/header-list.html
diff --git a/kpacman-api/hier.html b/doc/kpacman-api/hier.html
index 2698a4a..2698a4a 100644
--- a/kpacman-api/hier.html
+++ b/doc/kpacman-api/hier.html
diff --git a/kpacman-api/index-long.html b/doc/kpacman-api/index-long.html
index 6d2a179..6d2a179 100644
--- a/kpacman-api/index-long.html
+++ b/doc/kpacman-api/index-long.html
diff --git a/kpacman-api/index.html b/doc/kpacman-api/index.html
index d90c367..d90c367 100644
--- a/kpacman-api/index.html
+++ b/doc/kpacman-api/index.html
diff --git a/kpacman-api/kpacman_h.html b/doc/kpacman-api/kpacman_h.html
index ecd4846..ecd4846 100644
--- a/kpacman-api/kpacman_h.html
+++ b/doc/kpacman-api/kpacman_h.html
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).
diff --git a/kpacman/kpacman.desktop b/kpacman/kpacman.desktop
index 72503ff..a0ac50a 100644
--- a/kpacman/kpacman.desktop
+++ b/kpacman/kpacman.desktop
@@ -4,9 +4,13 @@ Exec=kpacman -caption "%c" %i %m
Icon=kpacman.png
MiniIcon=kpacman.png
X-DocPath=kpacman/index.html
-Comment=
+Comment=A simple clone of the classic arcade game Pac-Man
Comment[de]=
Terminal=false
Name=Kpacman
Name[de]=Kpacman
+Name[fr]=Kpacman
+GenericName=Arcade Game
+GenericName[fr]=Jeux d'arcade
Categories=Qt;TDE;Game;ArcadeGame;
+Keywords=arcade;pacman;dots;ghosts;level;