Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/CISOfy/lynis.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormboelen <michael@cisofy.com>2015-04-30 02:20:03 +0300
committermboelen <michael@cisofy.com>2015-04-30 02:20:03 +0300
commitb2b9f7627a82ebb6426498e6bf345cd176446001 (patch)
tree746897593800ace626eff2545fca8a8a3f18cfe9 /lynis.8
parent508cf7ac719a621b54fd554b35fb77ca269f073c (diff)
Updates to several sections and point to documentation
Diffstat (limited to 'lynis.8')
-rw-r--r--lynis.847
1 files changed, 31 insertions, 16 deletions
diff --git a/lynis.8 b/lynis.8
index 38be837d..8de5135f 100644
--- a/lynis.8
+++ b/lynis.8
@@ -1,4 +1,4 @@
-.TH Lynis 8 "30 January 2015" "1.17" "Unix System Administrator's Manual"
+.TH Lynis 8 "30 April 2015" "1.18" "Unix System Administrator's Manual"
.SH "NAME"
@@ -16,13 +16,13 @@ Lynis \fP\- Run an system and security audit on the system
.fi
.SH "DESCRIPTION"
-\fBLynis\fP is an auditing tool for Unix (specialists). It checks the system
-and software configuration and logs all the found information into a log file
-for debugging purposes, and in a report file suitable to create fancy looking
-auditing reports.
-\fBLynis\fP can be run as a cronjob, or from the command line. It needs to have
-full access to the system, so running it as root (or with sudo rights) is
-required.
+\fBLynis\fP is a security auditing tool for Linux and Unix systems. It checks
+the system and software configurations, to determine any improvements.
+All details are logged in a log file. Findings and other data is stored in a
+report file, which can be used to create auditing reports.
+\fBLynis\fP can be run as a cronjob, or from the command line. Lynis prefers
+root permissions (or sudo), so it can access all parts of the system, however it
+not required (see pentest mode).
.PP
The following system areas may be checked:
.IP
@@ -30,7 +30,7 @@ The following system areas may be checked:
.IP
\- Configuration files
.IP
-\- Common files by software packages
+\- Files part of software packages
.IP
\- Directories and files related to logging and auditing
.SH "OPTIONS"
@@ -39,7 +39,6 @@ The following system areas may be checked:
.B \-\-auditor <full name>
Define the name of the auditor/pen-tester. When a full name is used, add double
quotes, like "Your Name".
-
.TP
.B \-\-checkall (or \-c)
\fBLynis\fP performs a full check of the system, printing out the results of
@@ -48,9 +47,6 @@ each test to stdout. Additional information will be saved into a log file
.IP
In case the outcome of a scan needs to be automated, use the report file.
.TP
-.B \-\-check\-update (or \-\-info)
-Show program, database and update information.
-.TP
.B \-\-cronjob
Perform automatic scan with cron safe options (no colors, no questions, no
breaks).
@@ -115,14 +111,33 @@ with others. When running Lynis without any parameters, help will be shown and
the program will exit.
.RE
.PP
+
+.SH "HELPERS"
+Lynis has special helpers to do certain tasks. This way the framework of Lynis is
+used, while at the same time storing most of the functionality in a separated
+file. This speeds up execution and keeps the code clean.
+.TP
+.B audit
+Run audit on the system or on other targets
+.TP
+.B update
+Run updater utility
+.TP
+To use a helper, run Lynis followed by the helper name
+.RE
+.PP
.SH "BUGS"
-Discovered a bug? Please report them via e-mail (lynis-dev@cisofy.com) or via GitHub: https://github.com/CISOfy/Lynis
+Discovered a bug? Please report them via GitHub: https://github.com/CISOfy/lynis
+.RE
+.PP
+.SH "Documentation"
+Supporting documentation can be found via https://cisofy.com/documentation/lynis/
.RE
.PP
.SH "LICENSING"
-Lynis is licensed with the GPL v3 license and under development by CISOfy and Michael Boelen. Plugins have their own license.
+Lynis is licensed as GPL v3, written by Michael Boelen and supported by CISOfy. Plugins may have their own license.
.RE
.PP
.SH "CONTACT INFORMATION"
-Support and project related questions are addressed via https://cisofy.com/support/.
+Support requests and project related questions can be addressed via e-mail: lynis-dev@cisofy.com.