[Openvas-commits] r6227 - in trunk/openvas-manager: . doc

scm-commit@wald.intevation.org scm-commit at wald.intevation.org
Mon Dec 21 15:52:40 CET 2009


Author: mattm
Date: 2009-12-21 15:52:39 +0100 (Mon, 21 Dec 2009)
New Revision: 6227

Added:
   trunk/openvas-manager/doc/openvasmd.8
   trunk/openvas-manager/doc/openvasmd.html
Modified:
   trunk/openvas-manager/ChangeLog
   trunk/openvas-manager/doc/CMakeLists.txt
Log:
	* doc/openvasmd.html, doc/openvasmd.8: New files.

	* doc/CMakeLists.txt: Remove groff comments.  Prevent "clean" from
	removing extra documentation.
	(man, man-html): New targets.

Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog	2009-12-21 14:50:55 UTC (rev 6226)
+++ trunk/openvas-manager/ChangeLog	2009-12-21 14:52:39 UTC (rev 6227)
@@ -1,3 +1,11 @@
+2009-12-21  Matthew Mundell <matthew.mundell at intevation.de>
+
+	* doc/openvasmd.html, doc/openvasmd.8: New files.
+
+	* doc/CMakeLists.txt: Remove groff comments.  Prevent "clean" from
+	removing extra documentation.
+	(man, man-html): New targets.
+
 2009-12-21  Michael Wiegand <michael.wiegand at greenbone.net>
 
 	Post-release version bump.
@@ -10,7 +18,7 @@
 
 	* CHANGES: Updated.
 
-2009-12-18  Matthew Mundell <matthew.mundell at intevation.de>
+2009-12-21  Matthew Mundell <matthew.mundell at intevation.de>
 
 	* src/omp.c (omp_xml_handle_end_element): In CLIENT_CREATE_AGENT require
 	an installer.

Modified: trunk/openvas-manager/doc/CMakeLists.txt
===================================================================
--- trunk/openvas-manager/doc/CMakeLists.txt	2009-12-21 14:50:55 UTC (rev 6226)
+++ trunk/openvas-manager/doc/CMakeLists.txt	2009-12-21 14:52:39 UTC (rev 6227)
@@ -22,31 +22,6 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 
-## Check groff
-
-message (STATUS "Looking for groff...")
-
-find_program (GROFF_EXECUTABLE groff
-              PATHS /bin /usr/bin /usr/local/bin/
-              DOC "Groff location")
-
-message (STATUS "Looking for groff... ${GROFF_EXECUTABLE}")
-
-# if (GROFF_EXECUTABLE)
-#   message (STATUS "Checking if groff does HTML...")
-#   execute_process (COMMAND echo test | ${GROFF_EXECUTABLE} -T html
-#                    RESULT_VARIABLE GROFF_DOES_HTML
-# 				   OUTPUT_QUIET ERROR_QUIET)
-#
-#   if ("${GROFF_DOES_HTML}" MATCHES "^0$")
-#     set (GROFF_DOES_HTML true)
-#   else ("${GROFF_DOES_HTML}" MATCHES "^0$")
-#     set (GROFF_DOES_HTML false)
-#   endif ("${GROFF_DOES_HTML}" MATCHES "^0$")
-#
-#   message (STATUS "Checking if groff does HTML... ${GROFF_DOES_HTML}")
-# endif (GROFF_EXECUTABLE)
-
 ## Find xml2man
 
 message (STATUS "Looking for xmltoman...")
@@ -82,6 +57,9 @@
 
 ## build
 
+set_directory_properties (PROPERTIES CLEAN_NO_CUSTOM true)
+set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ".built-html;.built-html_full")
+
 include (FindDoxygen)
 
 if (NOT DOXYGEN_EXECUTABLE)
@@ -104,6 +82,12 @@
                    DEPENDS openvasmd.8 Doxyfile_full .built-html_full
                            .built-html_db db.png)
 
+add_custom_target (man COMMENT "Building manual page..."
+                   DEPENDS openvasmd.8)
+
+add_custom_target (man-html COMMENT "Building manual page HTML..."
+                   DEPENDS openvasmd.html)
+
 if (XMLTOMAN_EXECUTABLE)
   add_custom_command (OUTPUT openvasmd.8
 					  COMMAND sh
@@ -160,31 +144,6 @@
 					ARGS -c \"cd .. && ${DOXYGEN_EXECUTABLE} doc/Doxyfile_full && touch doc/.built-html_full\;\"
 					DEPENDS openvasmd.html Doxyfile_full ${DOC_FILES})
 
-# if (GROFF_DOES_HTML)
-#   add_custom_command (OUTPUT openvasmd.html
-# 					  COMMAND sh
-# 					  ARGS -c \"${GROFF_EXECUTABLE} -T html openvasmd.8 > openvasmd.html\;\"
-# 					  DEPENDS openvasmd.8)
-#   add_custom_command (OUTPUT .built-html
-# 					  COMMAND sh
-# 					  ARGS -c \"${DOXYGEN_EXECUTABLE} Doxyfile && touch .built-html\;\"
-# 					  DEPENDS openvasmd.html Doxyfile footer.html
-# 					          ../src/openvasmd.c
-# 							  ../README ../INSTALL)
-# else (GROFF_DOES_HTML)
-#   message (STATUS "WARNING: groff with HTML device is required for manpage in HTML docs.")
-#   add_custom_command (OUTPUT openvasmd.html
-#                       COMMAND echo "[Error: groff with HTML device is required to see manpage here]"
-# 					          > openvasmd.html)
-#   add_custom_command (OUTPUT .built-html
-# 					  COMMAND sh
-# 					  ARGS -c \"${DOXYGEN_EXECUTABLE} Doxyfile && touch .built-html\;\"
-# 					  DEPENDS openvasmd.html Doxyfile footer.html
-# 					          ../src/openvasmd.c
-# 							  ../README ../INSTALL)
-# endif (GROFF_DOES_HTML)
-
-
 ## Install
 
 # file (MAKE_DIRECTORY html/)

Added: trunk/openvas-manager/doc/openvasmd.8
===================================================================
--- trunk/openvas-manager/doc/openvasmd.8	2009-12-21 14:50:55 UTC (rev 6226)
+++ trunk/openvas-manager/doc/openvasmd.8	2009-12-21 14:52:39 UTC (rev 6227)
@@ -0,0 +1,39 @@
+.TH openvamd 8 User Manuals
+.SH NAME
+openvamd \- The manager layer of the OpenVAS Security Scanner
+.SH SYNOPSIS
+\fBopenvasmd OPTION
+\f1
+.SH DESCRIPTION
+The OpenVAS security scanner consists of a server and client. The scanner, openvassd(8), does the actual scanning, and the client, OpenVAS-Client(1), provides a user interface to the server. 
+
+The manager is a program that provides a layer between the server and client. This reduces the amount of work done by the server, thus reducing the amount of work done with high system privileges. 
+.SH OPTIONS
+.TP
+\fB-a, --listen=\fIADDRESS\fB\f1
+Listen on ADDRESS.
+.TP
+\fB-l, --slisten=\fIADDRESS\fB\f1
+Connect to server (openvassd) at address ADDRESS.
+.TP
+\fB-p, --port=\fINUMBER\fB\f1
+Listen on port number \fINUMBER\f1.
+.TP
+\fB-s, --sport=\fINUMBER\fB\f1
+Connect to server (openvassd) on port number \fINUMBER\f1.
+.TP
+\fB-v, --version\f1
+Print version.
+.TP
+\fB-?, --help\f1
+Show help.
+.SH EXAMPLES
+openvasmd --port 1241 --sport 7772
+
+Serve the client on port 1241 and connect to the server on 7772.
+.SH SEE ALSO
+\fBopenvas(1)\f1, \fBopenvassd(8)\f1
+.SH MORE INFORMATION ABOUT THE OPENVAS PROJECT
+The canonical places where you will find more information about the OpenVAS project are: \fBhttp://www.openvas.org/\f1 (Official site) \fBhttp://www.openvas.org/doku.php?id=mailing_lists\f1 (Mailing lists) 
+.SH COPYRIGHT
+The OpenVAS manager is release under the GNU GPL, version 2.

Added: trunk/openvas-manager/doc/openvasmd.html
===================================================================
--- trunk/openvas-manager/doc/openvasmd.html	2009-12-21 14:50:55 UTC (rev 6226)
+++ trunk/openvas-manager/doc/openvasmd.html	2009-12-21 14:52:39 UTC (rev 6227)
@@ -0,0 +1,106 @@
+<body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">
+<tr><td><h1>openvamd</h1>
+<h2>The manager layer of the OpenVAS Security Scanner</h2>
+
+
+  <h2>Synopsis</h2>
+<b>
+	openvasmd OPTION<br>
+
+  </b>
+
+
+  <h2>Description</h2>
+
+	<p>
+	  The OpenVAS security scanner consists of a server and client.  The
+	  scanner, openvassd(8), does the actual scanning, and the client,
+	  OpenVAS-Client(1), provides a user interface to the server.
+	</p>
+
+	<p>
+	  The manager is a program that provides a layer between the server and
+	  client.  This reduces the amount of work done by the server, thus
+	  reducing the amount of work done with high system privileges.
+	</p>
+  
+
+
+  <h2>Options</h2>
+
+	
+	  <p><b>-a, --listen=<em>ADDRESS</em></b></p>
+	  <p>Listen on ADDRESS.</p>
+	
+
+	
+	  <p><b>-l, --slisten=<em>ADDRESS</em></b></p>
+	  
+		<p>Connect to server (openvassd) at address ADDRESS.</p>
+	  
+	
+
+	
+	  <p><b>-p, --port=<em>NUMBER</em></b></p>
+	  
+		<p>Listen on port number <em>NUMBER</em>.</p>
+	  
+	
+
+	
+	  <p><b>-s, --sport=<em>NUMBER</em></b></p>
+	  
+		<p>Connect to server (openvassd) on port number <em>NUMBER</em>.</p>
+	  
+	
+
+	
+	  <p><b>-v, --version</b></p>
+	  <p>Print version.</p>
+	
+
+	
+	  <p><b>-?, --help</b></p>
+	  <p>Show help.</p>
+	
+  
+
+  <h2>EXAMPLES</h2>
+
+	<p>openvasmd --port 1241 --sport 7772</p>
+	<p>Serve the client on port 1241 and connect to the server on 7772.</p>
+  
+
+
+  <h2>SEE ALSO</h2>
+
+	<p>
+	  <b>openvas (1)</b>,
+	  <b>openvassd (8)</b>
+	</p>
+  
+
+
+  <h2>MORE INFORMATION ABOUT THE OpenVAS PROJECT</h2>
+
+	<p>
+	  The canonical places where you will find more information
+	  about the OpenVAS project are:
+
+	  <a href = "http://www.openvas.org/">http://www.openvas.org/</a>
+		(Official site)
+
+	  <a href = "http://www.openvas.org/doku.php?id=mailing_lists">http://www.openvas.org/doku.php?id=mailing_lists</a>
+		(Mailing lists)
+	</p>
+  
+
+
+  <h2>COPYRIGHT</h2>
+
+	<p>The OpenVAS manager is release under the GNU GPL, version 2.</p>
+  
+
+
+</td></tr></table></center>
+</body>



More information about the Openvas-commits mailing list