diff options
author | gregory guy <gregory-tde@laposte.net> | 2020-05-21 16:18:26 +0200 |
---|---|---|
committer | Slávek Banko <slavek.banko@axis.cz> | 2020-05-26 01:20:46 +0200 |
commit | 368ee23e036f50097ed148eaedfbead308a7ff26 (patch) | |
tree | 929f7183629323992259d20fa1a6a701a9f7a83b /doc/man | |
parent | 8e16b376dc531edfdf7b7d8dc13d3d9a15d81c0c (diff) | |
download | kscope-368ee23e036f50097ed148eaedfbead308a7ff26.tar.gz kscope-368ee23e036f50097ed148eaedfbead308a7ff26.zip |
Add a man page.
Move the kscope.desktop file into XDG_APPS_INSTALL_DIR directory,
see TDE/tde#26 and bug 2408.
Delete empty folder templates.
Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/CMakeLists.txt | 5 | ||||
-rw-r--r-- | doc/man/kscope.1 | 76 |
2 files changed, 81 insertions, 0 deletions
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/kscope.1 b/doc/man/kscope.1 new file mode 100644 index 0000000..d11f8b6 --- /dev/null +++ b/doc/man/kscope.1 @@ -0,0 +1,76 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH kscope 1 2006-02-18 "" "" +.SH NAME +kscope \- a source browsing and editing environment +.SH SYNOPSIS +'nh +.fi +.ad l +\fBkscope\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[ +\fB\fIQt-options\fB\fR +] [ +\fB\fITDE-options\fB\fR +] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +KScope is a source browsing and editing environment for large projects written +in C (such as the Linux kernel). +.PP +KScope uses the Cscope code analysis engine to provide valuable information to +coders. +.PP +KScope also provides call-tree and call-graph views that can help developers +by visualising the relationships between different functions in the code base. +.SH OPTIONS +All TDE and Qt +programs accept a some common command-line options. KScope has no +application-specific options. +.PP +.TP +\*(T<\fB\-\-help\fR\*(T> +Show help about options +.TP +\*(T<\fB\-\-help\-qt\fR\*(T> +Show Qt specific options +.TP +\*(T<\fB\-\-help\-tde\fR\*(T> +Show TDE specific options +.TP +\*(T<\fB\-\-help\-all\fR\*(T> +Show all options +.TP +\*(T<\fB\-\-author\fR\*(T> +Show author information +.TP +\*(T<\fB\-v\fR\*(T>, \*(T<\fB\-\-version\fR\*(T> +Show version information +.TP +\*(T<\fB\-\-license\fR\*(T> +Show license information +.TP +\*(T<\fB\-\-\fR\*(T> +Indicates end of options +.SH AUTHOR +KScope was written by Elad Lahav <\*(T<elad_lahav@users.sf.net\*(T>>. +.SH COPYRIGHT +This manual page was written by Jonathan Patrick Davies +<\*(T<jpatrick@ubuntu.com\*(T>> for the +Ubuntu system (but may be used by others). +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU General Public License, +Version 2 or any later version published by the Free Software Foundation. +.PP +On Debian systems, the complete text of the GNU General Public +License can be found in +\*(T<\fI/usr/share/common\-licenses/GPL\fR\*(T>. |