summaryrefslogtreecommitdiffstats
path: root/doc/man/kapptemplate
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2022-06-13 13:47:50 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2022-06-13 15:42:17 +0900
commitd8521af7be8cafc64525755758d25f0b70072ea5 (patch)
tree502917d6e35afa2e8aed5dfa71bbc129eb388f28 /doc/man/kapptemplate
parent3cb0d9a6cdab412d4845af7a7994187f0a5507bb (diff)
downloadtdesdk-d8521af7be8cafc64525755758d25f0b70072ea5.tar.gz
tdesdk-d8521af7be8cafc64525755758d25f0b70072ea5.zip
Add man pages for TDE applications
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'doc/man/kapptemplate')
-rw-r--r--doc/man/kapptemplate/CMakeLists.txt7
-rw-r--r--doc/man/kapptemplate/kapptemplate.169
2 files changed, 76 insertions, 0 deletions
diff --git a/doc/man/kapptemplate/CMakeLists.txt b/doc/man/kapptemplate/CMakeLists.txt
new file mode 100644
index 00000000..24ccd704
--- /dev/null
+++ b/doc/man/kapptemplate/CMakeLists.txt
@@ -0,0 +1,7 @@
+file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 )
+
+INSTALL(
+ FILES ${_man_files}
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/kapptemplate/kapptemplate.1 b/doc/man/kapptemplate/kapptemplate.1
new file mode 100644
index 00000000..1010ecd5
--- /dev/null
+++ b/doc/man/kapptemplate/kapptemplate.1
@@ -0,0 +1,69 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH KAPPTEMPLATE 1 "January 31, 2004"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+kapptemplate \- creates a framework to develop a TDE application
+.SH SYNOPSIS
+.B kapptemplate
+[ \fB\-\-noinit\fP ] [ \fB\-\-default\fP ]
+.RB "[ " \-\-full\-app " | " \-\-kpart\-app " | " \-\-kpart\-plugin
+.RB " | " \-\-existing " ]"
+.PP
+.B kapptemplate \-\-help
+.SH DESCRIPTION
+\fBKAppTemplate\fP is a shell script that will create the necessary
+framework to develop various TDE applications. It takes care of the
+autoconf/automake code as well as providing a skeleton and example of
+what the code typically looks like.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH OPTIONS
+.SS General Options
+.TP
+\-\-help
+Display a full summary of options.
+.TP
+\-\-noinit
+Don't run 'make \-f Makefile.cvs'.
+.TP
+\-\-default
+Use default values instead of prompting.
+.SS Framework Types
+.TP
+\-\-full\-app
+Create a full featured TDE application.
+.TP
+\-\-kpart\-app
+Create a full featured KPart application.
+.TP
+\-\-kpart\-plugin
+Create a KPart plugin framework.
+.TP
+\-\-existing
+Converting existing source to an automake/autoconf TDE framework.
+.SH FILES
+.TP
+.I ~/.kapptemplate
+Stores default values.
+.SH SEE ALSO
+The original documentation from the program author
+is available in \fI/usr/share/doc/kapptemplate/\fP.
+.SH AUTHOR
+KAppTemplate was written by Kurt Granroth <granroth@kde.org>.
+.br
+This manual page was prepared by Ben Burton <bab@debian.org>
+for the Debian GNU/Linux system (but may be used by others).