[Openvas-commits] r1369 - trunk/openvas-compendium

scm-commit@wald.intevation.org scm-commit at wald.intevation.org
Thu Sep 18 11:44:10 CEST 2008


Author: mwiegand
Date: 2008-09-18 11:44:09 +0200 (Thu, 18 Sep 2008)
New Revision: 1369

Modified:
   trunk/openvas-compendium/ChangeLog
   trunk/openvas-compendium/openvas-compendium.tex
Log:
* openvas-compendium.tex: Added chapter regarding file locations.


Modified: trunk/openvas-compendium/ChangeLog
===================================================================
--- trunk/openvas-compendium/ChangeLog	2008-09-17 14:39:03 UTC (rev 1368)
+++ trunk/openvas-compendium/ChangeLog	2008-09-18 09:44:09 UTC (rev 1369)
@@ -1,3 +1,7 @@
+2008-09-18  Michael Wiegand <michael.wiegand at intevation.de>
+
+	* openvas-compendium.tex: Added chapter regarding file locations.
+
 2008-09-17  Michael Wiegand <michael.wiegand at intevation.de>
 
 	* openvas-compendium.tex: Make use of verbatim environment more

Modified: trunk/openvas-compendium/openvas-compendium.tex
===================================================================
--- trunk/openvas-compendium/openvas-compendium.tex	2008-09-17 14:39:03 UTC (rev 1368)
+++ trunk/openvas-compendium/openvas-compendium.tex	2008-09-18 09:44:09 UTC (rev 1369)
@@ -1031,6 +1031,84 @@
 trace file.
 \clearpage
 
+\xname{openvas-file-locations}
+\chapter{OpenVAS File Locations}
+\compendiumauthor{Michael Wiegand}
+
+The OpenVAS components will install files to different locations on your
+system during installation. This chapter aims to give you a rough idea of what
+will be installed where.
+
+Please note that the locations presented here refer to a standard installation
+from source. These locations may differ according to the choices made when
+configuring and compiling the individual components; if you installed OpenVAS
+from binary packages provided for your distribution, the package maintainers
+may have chosen different locations according to the distributions guidelines.
+
+Be aware that most of these directories will of course contain files additional
+to the ones described in the following sections; this chapter only points out
+which files will be place by OpenVAS in certain locations.
+
+\xname{usr-local-bin}
+\section{/usr/local/bin}
+
+This directory holds executables that can be useful for configuration and setup
+of certain components (\verb|libopenvas-config|, \verb|openvasd-config|,
+\verb|openvas-libnasl-config| and \verb|openvas-mkrand|) as well as a tool for
+generating client certificates (\verb|openvas-mkcert-client|) and a standalone
+NASL interpreter (\verb|openvas-nasl|).
+
+\xname{usr-local-etc-openvas}
+\section{/usr/local/etc/openvas}
+
+This directory holds the system-wide configuration data for OpenVAS including
+the file for the access rules and the user database.
+
+\xname{usr-local-include-openvas}
+\section{/usr/local/include/openvas}
+
+This directory contains the include files for OpenVAS.
+
+\xname{usr-local-lib}
+\section{/usr/local/lib}
+
+This directory holds the library files of the different OpenVAS components and
+-- in the \verb|openvas/plugins| subdirectory -- the installed plugins.
+
+\xname{usr-local-sbin}
+\section{/usr/local/sbin}
+
+This directory holds several executables useful for system administrators for
+tasks like user and certificate management (\verb|openvas-adduser|,
+\verb|openvas-mkcert|, \verb|openvas-rmuser|) or feed management
+(\verb|openvas-check-signature|, \verb|openvas-nvt-sync|) as well as the
+executable for the OpenVAS server itself (\verb|openvasd|).
+
+\xname{usr-local-share-man}
+\section{/usr/local/share/man}
+
+This directory contains the manual pages for the individual executables provided
+by OpenVAS. Some manual pages are also located in \verb|/usr/local/man|.
+
+\xname{usr-local-var-lib-openvas}
+\section{/usr/local/var/lib/openvas}
+
+This directory contains data relevant to the specific OpenVAS installation,
+like certificates (in the \verb|CA| and \verb|private/CA| subdirectories), the
+OpenVAS services database and files pertaining to specific users of this
+OpenVAS installation (in the \verb|users| subdirectory).
+
+\xname{usr-local-var-log-openvas}
+\section{/usr/local/var/log/openvas}
+
+This directory holds the log files of the OpenVAS-Server component.
+
+\xname{usr-local-var-run}
+\section{/usr/local/var/run}
+
+This directory contains runtime data of a running OpenVAS system, like the
+process identifier file \verb|openvasd.pid|.
+
 \xname{installing-and-configuring-openvas-client}
 \chapter{Installing and Configuring OpenVAS-Client}
 \compendiumauthor{Tim Brown, Jan-Oliver Wagner and Michael Wiegand}



More information about the Openvas-commits mailing list