Merge pull request #728 from Marzal/docu

Improve help info with missing data
This commit is contained in:
Michael Boelen 2019-07-15 18:55:33 +02:00 committed by GitHub
commit c31a1318e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 4 deletions

View File

@ -56,7 +56,7 @@ measures to further tighten any possible misuse.
- SSH-7402 - detect other SSH daemons like dropbear - SSH-7402 - detect other SSH daemons like dropbear
- SSH-7406 - strip OpenSSH patch version and remove characters (carriage return) - SSH-7406 - strip OpenSSH patch version and remove characters (carriage return)
- SSH-7408 - changed text in suggestion and report - SSH-7408 - changed text in suggestion and report
- Whow changelog works again for newer versions - Show changelog works again for newer versions
- systemd service file adjusted - systemd service file adjusted
- bash completion script extended - bash completion script extended

View File

@ -108,11 +108,15 @@ GENERATE_HELP="
" "
UPDATE_ARGS="check info" UPDATE_ARGS="check | info"
UPDATE_HELP=" UPDATE_HELP="
${CYAN}update info${NORMAL} ${CYAN}update info${NORMAL}
Check version information Check and show version information
${CYAN}update check${NORMAL}
Just check if version is up-to-date
" "
@ -207,8 +211,11 @@ if [ $# -gt 0 ]; then
if [ $# -eq 1 ]; then if [ $# -eq 1 ]; then
case $1 in case $1 in
"audit") ${ECHOCMD} "${AUDIT_HELP}" ;; "audit") ${ECHOCMD} "${AUDIT_HELP}" ;;
"configure") ${ECHOCMD} "No help available yet" ;;
"generate") ${ECHOCMD} "${GENERATE_HELP}" ;;
"show") ${ECHOCMD} "${SHOW_HELP}" ;; "show") ${ECHOCMD} "${SHOW_HELP}" ;;
"update") ${ECHOCMD} "No help available yet" ;; "update") ${ECHOCMD} "${UPDATE_HELP}" ;;
"upload-only") ${ECHOCMD} "${UPLOAD_ONLY_HELP}" ;;
*) DisplayError "Unknown argument for 'commands'" *) DisplayError "Unknown argument for 'commands'"
esac esac
else else
@ -288,6 +295,7 @@ if [ $# -gt 0 ]; then
shift shift
case $1 in case $1 in
"audit") ${ECHOCMD} "${AUDIT_HELP}" ;; "audit") ${ECHOCMD} "${AUDIT_HELP}" ;;
"configure") ${ECHOCMD} "No help available yet" ;;
"generate") ${ECHOCMD} "${GENERATE_HELP}" ;; "generate") ${ECHOCMD} "${GENERATE_HELP}" ;;
"show") ${ECHOCMD} "${SHOW_HELP}" ;; "show") ${ECHOCMD} "${SHOW_HELP}" ;;
"update") ${ECHOCMD} "${UPDATE_HELP}" ;; "update") ${ECHOCMD} "${UPDATE_HELP}" ;;

View File

@ -41,6 +41,10 @@ When running \fBLynis\fP for the first time, run: lynis audit system
.SH "COMMANDS" .SH "COMMANDS"
.IP "audit \<type\>" .IP "audit \<type\>"
Perform an audit of the selected type Perform an audit of the selected type
.IP "configure \<parameters\>"
Change or add settings to the config file
.IP "generate \<parameter\>"
Generate specific details such as host IDs
.IP "show \<parameter\>" .IP "show \<parameter\>"
Show information, such as configuration and paths Show information, such as configuration and paths
.IP "update \<parameter\>" .IP "update \<parameter\>"