From 3772f18c84aa7b2414b62602b472fd1269e985af Mon Sep 17 00:00:00 2001 From: Raymond Nook <59678453+developStorm@users.noreply.github.com> Date: Thu, 11 Apr 2024 15:48:20 -0700 Subject: [PATCH 1/2] docs: add module help usage to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 587725ae..cd349449 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,18 @@ $ make ZGrab2 supports modules. For example, to run the ssh module use -``` +```bash ./zgrab2 ssh ``` +To retrieve detailed command-line usage and options for a specific module, append -h to the command: + +```bash +./zgrab2 [module] -h +``` + +This will display the module-specific options, as well as the application-wide options, including usage examples, available flags, and descriptions for each option. + Module specific options must be included after the module. Application specific options can be specified at any time. ## Input Format From 96751902c1ffbaddf6a29f1e561542cef4c13652 Mon Sep 17 00:00:00 2001 From: Raymond Nook <59678453+developStorm@users.noreply.github.com> Date: Fri, 12 Apr 2024 10:53:15 -0700 Subject: [PATCH 2/2] patch: markdown syntax --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd349449..bf568c63 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ ZGrab2 supports modules. For example, to run the ssh module use ./zgrab2 ssh ``` -To retrieve detailed command-line usage and options for a specific module, append -h to the command: +To retrieve detailed command-line usage and options for a specific module, append `-h` to the command: ```bash ./zgrab2 [module] -h