tyler.durden/lynis
1
0
Fork 0
mirror of https://github.com/CISOfy/lynis.git synced 2025-07-22 13:24:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Changed text, markup, added exit codes, and first time usage

Browse Source
This commit is contained in:
mboelen 2015-09-10 09:31:55 +02:00
parent 04b2a900c1
commit 02d735c4e1
1 changed files with 44 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
lynis.8
View File

@ -1,17 +1,17 @@
.TH Lynis 8 "30 April 2015" "1.18" "Unix System Administrator's Manual" .TH Lynis 8 "10 September 2015" "1.19" "Unix System Administrator's Manual"
.SH "NAME" .SH "NAME"
\fB \fB
\fB \fB
\fB \fB
Lynis \fP\- Run an system and security audit on the system Lynis \fP\- System and security auditing tool
\fB \fB
.SH "SYNOPSIS" .SH "SYNOPSIS"
.nf .nf
.fam C .fam C
\fBlynis\fP \-\-check-all(\-c) [other options] \fBlynis\fP [scan mode] [other options]
.fam T .fam T
.fi .fi
.SH "DESCRIPTION" .SH "DESCRIPTION"
@ -33,6 +33,17 @@ The following system areas may be checked:
\- Files part of software packages \- Files part of software packages
.IP .IP
\- Directories and files related to logging and auditing \- Directories and files related to logging and auditing
.SH "FIRST TIME USAGE"
When running \fBLynis\fP for the first time, run: lynis audit system --quick
.SH "SCAN MODES"
.IP audit system
Performs a system audit, which is the most common audit.
For more scan modes, see the helper utilities.
.SH "OPTIONS" .SH "OPTIONS"
.TP .TP
@ -43,7 +54,7 @@ quotes, like "Your Name".
.B \-\-checkall (or \-c) .B \-\-checkall (or \-c)
\fBLynis\fP performs a full check of the system, printing out the results of \fBLynis\fP performs a full check of the system, printing out the results of
each test to stdout. Additional information will be saved into a log file each test to stdout. Additional information will be saved into a log file
(default is /var/log/lynis.log). (default is /var/log/lynis.log). This option invokes scan mode "audit system".
.IP .IP
In case the outcome of a scan needs to be automated, use the report file. In case the outcome of a scan needs to be automated, use the report file.
.TP .TP
@ -111,33 +122,42 @@ with others. When running Lynis without any parameters, help will be shown and
the program will exit. the program will exit.
.RE .RE
.PP .PP
.SH "HELPERS" .SH "HELPERS"
Lynis has special helpers to do certain tasks. This way the framework of Lynis is 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 used, while at the same time storing most of the functionality in a separated
file. This speeds up execution and keeps the code clean. file. This speeds up execution and keeps the code clean.
.TP
.B audit .B audit
Run audit on the system or on other targets Run audit on the system or on other targets
.TP
.B update .B update
Run updater utility 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 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 as GPL v3, written by Michael Boelen and supported by CISOfy. Plugins may have their own license.
.RE
.PP
.SH "CONTACT INFORMATION"
To use a helper, run Lynis followed by the helper name.
.SH "EXIT CODES"
Lynis uses exit codes to signal any invoking script. Currently the following codes are used:
.IP 0
Program exited normally, nothing found
.IP 1
Fatal error
.IP 64
An unknown parameter is used, or incomplete
.IP 65
Incorrect data encountered
.IP 66
Can't open file or directory
.IP 78
Lynis found 1 or more warnings or configurations errors
.SH "BUGS"
Bugs can be reported via GitHub at https://github.com/CISOfy/lynis
.SH "DOCUMENTATION"
Supporting documentation can be found via https://cisofy.com/documentation/lynis/
.SH "LICENSING"
Lynis is licensed as GPL v3, written by Michael Boelen. Development is supported by CISOfy. Plugins may have their own license.
.SH "CONTACT INFORMATION"
Support requests and project related questions can be addressed via e-mail: lynis-dev@cisofy.com. Support requests and project related questions can be addressed via e-mail: lynis-dev@cisofy.com.