From 02d735c4e16c0d91fe9a04dcb55c8f18b3983c7d Mon Sep 17 00:00:00 2001 From: mboelen Date: Thu, 10 Sep 2015 09:31:55 +0200 Subject: Changed text, markup, added exit codes, and first time usage --- lynis.8 | 62 +++++++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 41 insertions(+), 21 deletions(-) (limited to 'lynis.8') diff --git a/lynis.8 b/lynis.8 index 8de5135f..742354a8 100644 --- a/lynis.8 +++ b/lynis.8 @@ -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" \fB \fB \fB -Lynis \fP\- Run an system and security audit on the system +Lynis \fP\- System and security auditing tool \fB .SH "SYNOPSIS" .nf .fam C -\fBlynis\fP \-\-check-all(\-c) [other options] +\fBlynis\fP [scan mode] [other options] .fam T .fi .SH "DESCRIPTION" @@ -33,6 +33,17 @@ The following system areas may be checked: \- Files part of software packages .IP \- 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" .TP @@ -43,7 +54,7 @@ quotes, like "Your Name". .B \-\-checkall (or \-c) \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 -(default is /var/log/lynis.log). +(default is /var/log/lynis.log). This option invokes scan mode "audit system". .IP In case the outcome of a scan needs to be automated, use the report file. .TP @@ -111,33 +122,42 @@ 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 + +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" -Discovered a bug? Please report them via GitHub: https://github.com/CISOfy/lynis -.RE -.PP -.SH "Documentation" +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/ -.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" +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. -- cgit v1.2.3