From a451e44f4ac9838eca11731780be425a1f46a0b8 Mon Sep 17 00:00:00 2001 From: gregory guy Date: Thu, 20 Aug 2020 15:53:01 +0200 Subject: [PATCH] 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 --- README | 2 +- {kpacman-api => doc/kpacman-api}/Kpacman.html | 0 .../kpacman-api}/all-globals.html | 0 .../kpacman-api}/full-list-Kpacman.html | 0 .../kpacman-api}/header-list.html | 0 {kpacman-api => doc/kpacman-api}/hier.html | 0 .../kpacman-api}/index-long.html | 0 {kpacman-api => doc/kpacman-api}/index.html | 0 .../kpacman-api}/kpacman_h.html | 0 doc/man/CMakeLists.txt | 5 +++ doc/man/kpacman.1 | 42 +++++++++++++++++++ kpacman/kpacman.desktop | 6 ++- 12 files changed, 53 insertions(+), 2 deletions(-) rename {kpacman-api => doc/kpacman-api}/Kpacman.html (100%) rename {kpacman-api => doc/kpacman-api}/all-globals.html (100%) rename {kpacman-api => doc/kpacman-api}/full-list-Kpacman.html (100%) rename {kpacman-api => doc/kpacman-api}/header-list.html (100%) rename {kpacman-api => doc/kpacman-api}/hier.html (100%) rename {kpacman-api => doc/kpacman-api}/index-long.html (100%) rename {kpacman-api => doc/kpacman-api}/index.html (100%) rename {kpacman-api => doc/kpacman-api}/kpacman_h.html (100%) create mode 100644 doc/man/CMakeLists.txt create mode 100644 doc/man/kpacman.1 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 similarity index 100% rename from kpacman-api/Kpacman.html rename to doc/kpacman-api/Kpacman.html diff --git a/kpacman-api/all-globals.html b/doc/kpacman-api/all-globals.html similarity index 100% rename from kpacman-api/all-globals.html rename to doc/kpacman-api/all-globals.html diff --git a/kpacman-api/full-list-Kpacman.html b/doc/kpacman-api/full-list-Kpacman.html similarity index 100% rename from kpacman-api/full-list-Kpacman.html rename to doc/kpacman-api/full-list-Kpacman.html diff --git a/kpacman-api/header-list.html b/doc/kpacman-api/header-list.html similarity index 100% rename from kpacman-api/header-list.html rename to doc/kpacman-api/header-list.html diff --git a/kpacman-api/hier.html b/doc/kpacman-api/hier.html similarity index 100% rename from kpacman-api/hier.html rename to doc/kpacman-api/hier.html diff --git a/kpacman-api/index-long.html b/doc/kpacman-api/index-long.html similarity index 100% rename from kpacman-api/index-long.html rename to doc/kpacman-api/index-long.html diff --git a/kpacman-api/index.html b/doc/kpacman-api/index.html similarity index 100% rename from kpacman-api/index.html rename to doc/kpacman-api/index.html diff --git a/kpacman-api/kpacman_h.html b/doc/kpacman-api/kpacman_h.html similarity index 100% rename from kpacman-api/kpacman_h.html rename to 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 , +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;