diff --git a/README.md b/README.md index c67841a..7a5c20b 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,26 @@ Manageable report from lynis text output. ## Help Statement +``` +./lynis_report.pl -h|--help -v|--verbose -E|--excel -o|--output + +Where: + +-h|--help Display this useful message, then exit. +-v|--verbose Display more detailed output. This is typically used for + debugging, but may provide insight when running into problems. +-E|--excel Output the report in Microsoft Excel binary format. This + options is not yet implemented (NYI). +-o|--output Specifies the output file to print the report to. +``` * HTML out features (default) + * Summarizes the lynis report into a single HTML file. * Excel out features + * Breaks out sections into worksheets. * PDF out features + * Copy of the HTML report ported to PDF. + ## TODO: -* Excel out WIP! * PDF out needs refinement * Other output formats? diff --git a/lynis_report.pl b/lynis_report.pl index 52fb996..18257aa 100755 --- a/lynis_report.pl +++ b/lynis_report.pl @@ -2005,10 +2005,10 @@ $0 -h|--help -v|--verbose -E|--excel -o|--output Where: -h|--help Display this useful message, then exit. --v|--verbose Display more detailed output. This is typically used for - debugging, but may provide insight when running into problems. +-v|--verbose Display more detailed output. This is typically used for + debugging, but may provide insight when running into problems. -E|--excel Output the report in Microsoft Excel binary format. This - options is not yet implemented (NYI). + options is not yet implemented (NYI). -o|--output Specifies the output file to print the report to. END