summaryrefslogtreecommitdiffstats
path: root/doc/man/scripts/kdemangen.pl.1
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 22:39:15 +0900
commit4c8afb5e944f7bb9268c81e914b2a2fbc05b557e (patch)
tree6181a7ee4852860f6c34b9f1217e344e9ad2ebc1 /doc/man/scripts/kdemangen.pl.1
parentda7d3c409917e968ee36cb44b4f47dde222a650b (diff)
downloadtdesdk-4c8afb5e.tar.gz
tdesdk-4c8afb5e.zip
Add man pages for TDE applications
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it> (cherry picked from commit d8521af7be8cafc64525755758d25f0b70072ea5)
Diffstat (limited to 'doc/man/scripts/kdemangen.pl.1')
-rw-r--r--doc/man/scripts/kdemangen.pl.151
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/man/scripts/kdemangen.pl.1 b/doc/man/scripts/kdemangen.pl.1
new file mode 100644
index 00000000..8acd79df
--- /dev/null
+++ b/doc/man/scripts/kdemangen.pl.1
@@ -0,0 +1,51 @@
+.\" 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 KDEMANGEN.PL 1 "October 15, 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
+kdemangen.pl \- automatically create a draft manpage for a TDE app
+.SH SYNOPSIS
+.B kdemangen.pl
+.I /path/to/application
+.SH DESCRIPTION
+\fBkdemangen.pl\fP will automatically create a draft manpage for a TDE
+application. Manpages are always better when hand-tailored, but this
+should give you a fairly good start.
+.PP
+To create the manpage, it will use the \-\-author and \-\-help\-all
+output for the application passed on the command line.
+It will also use the description in the
+Debian control file if one is available. To make use of this additional
+feature, you must run kdemangen.pl from within the \fIdebian/\fP
+subdirectory of the application sources.
+.PP
+The new manpage will be written to standard output.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH WARNING
+This utility will only work for a full TDE application that uses
+TDECmdLineArgs (which most full TDE applications do).
+.SH EXAMPLE
+.RS
+cd /path/to/tde/srcs/tdeedu/debian
+.br
+kdemangen /usr/bin/kstars > kstars.1
+.RE
+.SH AUTHOR
+kdemangen.pl was written by Dominique Devriese <devriese@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).