You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tde-packaging/ubuntu/raring/applications/kscope/debian/kscope.xml

125 lines
4.2 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
]>
<refentry>
<refentryinfo>
<author>
<firstname>Jonathan Patrick</firstname>
<surname>Davies</surname>
<email>jpatrick@ubuntu.com</email>
</author>
<copyright>
<year>2006</year>
<holder>Jonathan Patrick Davies</holder>
</copyright>
<!-- XXX IMPORTANT XXX -->
<!-- Keep this date up to date: -->
<date>2006-02-18</date>
<!-- ^^^^^^^^^^ -->
</refentryinfo>
<refmeta>
<refentrytitle>kscope</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>kscope</refname>
<refpurpose>a source browsing and editing environment</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>kscope</command>
<arg choice="opt">
<option><replaceable>Qt-options</replaceable></option>
</arg>
<arg choice="opt">
<option><replaceable>TDE-options</replaceable></option>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
KScope is a source browsing and editing environment for large projects written
in C (such as the Linux kernel).
</para>
<para>
KScope uses the Cscope code analysis engine to provide valuable information to
coders.
</para>
<para>
KScope also provides call-tree and call-graph views that can help developers
by visualising the relationships between different functions in the code base.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>
All <productname>TDE</productname> and <productname>Qt</productname>
programs accept a some common command-line options. KScope has no
application-specific options.
</para>
<para>
<variablelist>
<title>Generic options:</title>
<varlistentry>
<term> <option>--help</option> </term>
<listitem> <para>Show help about options</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>--help-qt</option> </term>
<listitem> <para>Show Qt specific options</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>--help-tde</option> </term>
<listitem> <para>Show TDE specific options</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>--help-all</option> </term>
<listitem> <para>Show all options</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>--author</option> </term>
<listitem> <para>Show author information</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>-v</option>, <option>--version</option> </term>
<listitem> <para>Show version information</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>--license</option> </term>
<listitem> <para>Show license information</para> </listitem>
</varlistentry>
<varlistentry>
<term> <option>--</option> </term>
<listitem> <para>Indicates end of options</para> </listitem>
</varlistentry>
</variablelist>
<!-- TODO * add all the rest of the options, but maybe find an automated
way to keep it up to date -->
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
KScope was written by Elad Lahav <email>elad_lahav@users.sf.net</email>.
</para>
</refsect1>
<refsect1>
<title>COPYRIGHT</title>
<para>
This manual page was written by Jonathan Patrick Davies
<email>jpatrick@ubuntu.com</email> for the
<productname>Ubuntu</productname> system (but may be used by others).
Permission is granted to copy, distribute and/or modify this document
under the terms of the <acronym>GNU</acronym> General Public License,
Version 2 or any later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in
<filename>/usr/share/common-licenses/GPL</filename>.
</para>
</refsect1>
</refentry>