summaryrefslogtreecommitdiffstats
path: root/doc/man/kspy
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/kspy
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/kspy')
-rw-r--r--doc/man/kspy/CMakeLists.txt7
-rw-r--r--doc/man/kspy/testkspy.146
2 files changed, 53 insertions, 0 deletions
diff --git a/doc/man/kspy/CMakeLists.txt b/doc/man/kspy/CMakeLists.txt
new file mode 100644
index 00000000..24ccd704
--- /dev/null
+++ b/doc/man/kspy/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/kspy/testkspy.1 b/doc/man/kspy/testkspy.1
new file mode 100644
index 00000000..afdc702a
--- /dev/null
+++ b/doc/man/kspy/testkspy.1
@@ -0,0 +1,46 @@
+.\" 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 TESTKSPY 1 "May 3, 2001"
+.\" 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
+testkspy \- show off KSpy's capabilities
+.SH SYNOPSIS
+.B testkspy
+.RI "[ " generic-options " ]"
+.SH DESCRIPTION
+\fBtestkspy\fP is a small application that shows off KSpy's capabilities.
+It simply uses KSpy to spy on itself.
+.PP
+\fBKSpy\fP is a tiny library which can be used to graphically display
+the TQObjects in use by a TQt/TDE app. In addition to the object tree,
+you can also view the properties, signals and slots of any QObject.
+.PP
+Basically it provides much the same info as QObject::dumpObjectTree() and
+QObject::dumpObjectInfo(), but in a much more convenient form. KSpy has
+minimal overhead for the application, because the kspy library is
+loaded dynamically using KLibLoader.
+.PP
+This utility is part of the TDE Software Development Kit.
+.SH OPTIONS
+For a full summary of options, run \fItestkspy \-\-help\fP.
+.SH SEE ALSO
+Instructions on using KSpy with your own applications can be found in
+\fI/usr/share/doc/kspy/README\fP.
+.SH AUTHOR
+KSpy was written by Richard Moore <rich@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).