From c0ae2e217b7f1fb0171017ce5afb8eb8898470db Mon Sep 17 00:00:00 2001 From: mboelen Date: Tue, 26 Aug 2014 17:33:55 +0200 Subject: Initial import --- lynis.8 | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 lynis.8 (limited to 'lynis.8') diff --git a/lynis.8 b/lynis.8 new file mode 100644 index 00000000..d3e848f6 --- /dev/null +++ b/lynis.8 @@ -0,0 +1,113 @@ +.TH Lynis 8 "23 February 2014" "1.12" "Unix System Administrator's Manual" + + +.SH "NAME" +\fB +\fB +\fB +Lynis \fP\- Run an system and security audit on the system +\fB +.SH "SYNOPSIS" +.nf +.fam C + +\fBlynis\fP \-\-check-all(\-c) [other options] +.fam T +.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. +.PP +The following system areas may be checked: +.IP +\- Boot loader files +.IP +\- Configuration files +.IP +\- Common files by software packages +.IP +\- Directories and files related to logging and auditing +.SH "OPTIONS" + +.TP +.B \-\-auditor +Define the name of the auditor/pen-tester. When a full name is used, add double +quotes, like "Michael Boelen". + +.TP +.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). +.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). +.TP +.B \-\-debug +Display debug information to screen for troubleshooting purposes. +.TP +.B \-\-logfile +Defines location and name of log file, instead of default /var/log/lynis.log. +.TP +.B \-\-no\-colors +Do not use colors for messages, warnings and sections. +.TP +.B \-\-no\-log +Redirect all logging information to /dev/null, prevent sensitive information to +be written to disk. +.TP +.B \-\-plugin\-dir +Define location where plugins can be found. +.TP +.B \-\-quick (\-Q) +Do a quick scan (don't wait for user input) +.TP +.B \-\-quiet (\-q) +Try to run as silent as possible, showing only warnings. This option activates +\-\-quick as well. +.TP +.B \-\-reverse\-colors +Optimize screen output for light backgrounds. +.TP +.B \-\-tests TEST-IDs +Only run the specific test(s). When using multiple tests, add quotes around the +line. +.TP +.B \-\-upload +Upload data to Lynis Enterprise server. +.TP +.B \-\-view\-categories +Display all available test categories +.RE +.PP +.RS +Multiple parameters are allowed, though some parameters can only be used together +with others. When running Lynis without any parameters, help will be shown and +the program will exit. +.RE +.PP +.SH "BUGS" +There are no known bugs. Bugs can be reported directly to author. +.RE +.PP +.SH "LICENSING" +Lynis is licensed under the GPL v3 license and under development by Michael +Boelen. +.RE +.PP +.SH "CONTACT INFORMATION" + +Project related questions and comments can be asked via +http://www.rootkit.nl/contact/. Commercial inquiries via http://cisofy.com. -- cgit v1.2.3