summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2019-11-28 22:33:34 +0100
committergregory guy <gregory-tde@laposte.net>2019-11-29 13:05:48 +0100
commit7f0fd2e067a983c24bc60bc2b99f926d77a7830c (patch)
tree2f6fc50ea1d541447975f543baec0a0bc94c1b4d /doc
parente5a40912abe45c70124e109cb0a4ce3c72180c06 (diff)
downloadknmap-7f0fd2e067a983c24bc60bc2b99f926d77a7830c.tar.gz
knmap-7f0fd2e067a983c24bc60bc2b99f926d77a7830c.zip
Drop automake build support.
Add basic cmake build instructions. Remove empty files: NEWS and TODO. Rework of the README, INSTALL and help page. Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am6
-rw-r--r--doc/en/Makefile.am3
-rw-r--r--doc/en/index.docbook27
3 files changed, 12 insertions, 24 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
deleted file mode 100644
index 79a09b7..0000000
--- a/doc/Makefile.am
+++ /dev/null
@@ -1,6 +0,0 @@
-# the SUBDIRS is filled automatically by am_edit. If files are
-# in this directory they are installed into the english dir
-
-KDE_LANG = en
-KDE_DOCS = knmap
-SUBDIRS = $(AUTODIRS)
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
deleted file mode 100644
index fb2ea2a..0000000
--- a/doc/en/Makefile.am
+++ /dev/null
@@ -1,3 +0,0 @@
-KDE_DOCS = knmap
-KDE_LANG = en
-kde_docs_KDEDOCS = new_scan.png
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
index c88b5c4..eb57fee 100644
--- a/doc/en/index.docbook
+++ b/doc/en/index.docbook
@@ -57,7 +57,7 @@
</para>
<para>
- The icons used in this application are from the Open Clip Art Library. I am indebted to those damn fine folk as my artistic ability is zero - which is marginally above my programming ability. :-(
+ The icons used in this application are from the Open Clip Art Library. I am indebted to those fine folk as my artistic ability is zero - which is marginally above my programming ability.
</para>
<para>
@@ -163,7 +163,7 @@
</para>
<para>
- The <computeroutput>Start nmap</computeroutput> and <computeroutput>Stop nmap</computeroutput> buttons should require no explanation. (No - I wont now launch into a multi-thousand word explanation of the bloody obvious.)
+ The <computeroutput>Start nmap</computeroutput> and <computeroutput>Stop nmap</computeroutput> buttons should require no explanation.
</para>
<para>
@@ -721,7 +721,10 @@
<chapter id="developers">
<title>Developer's Guide to &knmap;</title>
<para>
- The only item worthy of mention here is the file <computeroutput>nmap_manpage.html.diff</computeroutput>. This file contains a <computeroutput>diff</computeroutput> of the <computeroutput>nmap</computeroutput> version 3.93 HTML formatted <computeroutput>man</computeroutput> page and that distributed with &knmap;. You can use this to update your version of that <computeroutput>man</computeroutput> page.
+ One file is worth mentioning<computeroutput>nmap_manpage.html.diff</computeroutput>. This file contains a <computeroutput>diff</computeroutput> of the <computeroutput>nmap</computeroutput> version 3.93 HTML formatted <computeroutput>man</computeroutput> page and that distributed with &knmap;. You can use this to update your version of that <computeroutput>man</computeroutput> page.
+ </para>
+ <para>
+ You may find the source code as well as the current development at <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/knmap">https://mirror.git.trinitydesktop.org/gitea/TDE/knmap</ulink> .
</para>
</chapter>
@@ -750,32 +753,26 @@
<title>How to obtain &knmap;</title>
<para>
- Now let me see... You're reading this documentation - which come packaged with &knmap;, which means that you have &knmap; installed, which means that you have somehow obtained &knmap;, and now you want to know how to obtain &knmap;?
- </para>
-
- <para>
- You have _way_ too much time on your hands! ;-)
- </para>
-
- <para>
- Okay, Okay. Go to <ulink url="http://sourceforge.net/projects/knmap">http://sourceforge.net/projects/knmap</ulink> and follow the download links.
+ Knmap is part of the Trinity Desktop Project. For further information, please go to <ulink url="http://trinitydesktop.org">http://trinitydesktop.org/</ulink> .
</para>
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<para>
- &knmap; was developed and tested under Qt 3.3.4 / KDE 3.4 &amp; 3.5. YMMV vary if your configuration differs from this.
+ &knmap; will need the tqt3 and the tdelibs libraries.
</para>
<para>
- And, of course, you will need <computeroutput>nmap</computeroutput>. Go to <ulink url="http://www.insecure.org/nmap">http://www.insecure.org/nmap</ulink> for details on how to download <computeroutput>nmap</computeroutput>.
+ You will need <computeroutput>nmap</computeroutput>. Go to <ulink url="https://nmap.org">https://nmap.org/</ulink> for details on how to download <computeroutput>nmap</computeroutput>.
</para>
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
- &install.compile.documentation;
+ <para>
+ &knmap; relies on cmake to build, please read the INSTALL file for basic instructions.
+ </para>
</sect1>
</appendix>