digininja / CeWL

CeWL is a Custom Word List Generator
1.96k stars 258 forks source link

"Display the usage" msg clean up #28

Closed alibkaba closed 6 years ago

alibkaba commented 6 years ago

cewl.rb between line 524 and 563

It looks a lot better and a lot less busy in the "options" area. You always want to put the short version of an option before the long version. It should look uniformed and easy to look through. Also fixed a few other things.


def usage
  puts "Usage: cewl [OPTIONS] ... <url>

    OPTIONS:
      -h, --help: Show help.
      -k, --keep: Keep the downloaded file.
      -d <x>,--depth <x>: Depth to spider to, default 2.
      -m, --min_word_length: Minimum word length, default 3.
      -o, --offsite: Let the spider visit other sites.
      -w, --write: Write the output to the file.
      -u, --ua <agent>: User agent to send.
      -n, --no-words: Don't output the wordlist.
      -a, --meta: include meta data.
      --meta_file file: Output file for meta data.
      -e, --email: Include email addresses.
      --email_file <file>: Output file for email addresses.
      --meta-temp-dir <dir>: The temporary directory used by exiftool when parsing files, default /tmp.
      -c, --count: Show the count for each word found.
      -v, --verbose: Verbose.
      --debug: Extra debug information.

      AUTHENTICATION:
      --auth_type: Digest or basic.
      --auth_user: Authentication username.
      --auth_pass: Authentication password.

      PROXY SUPPORT:
      --proxy_host: Proxy host.
      --proxy_port: Proxy port, default 8080.
      --proxy_username: Username for proxy, if required.
      --proxy_password: Password for proxy, if required.

      HEADERS:
      --header, -H: In format name:value - can pass multiple.

      <url>: The site to spider.
"
  exit 0
end
digininja commented 6 years ago

Send in a pull request and I'll have a look at it.

Robin

On Mon, 1 Jan 2018, 23:41 alibkaba, notifications@github.com wrote:

cewl.rb between line 524 and 563

It looks a lot better and a lot less busy in the "options" area. You always want to put the short version of an option before the long version. It should look uniformed and easy to look through. Also fixed a few other things.

def usage puts "Usage: cewl [OPTIONS] ...

OPTIONS:
  -h, --help: Show help.
  -k, --keep: Keep the downloaded file.
  -d <x>,--depth <x>: Depth to spider to, default 2.
  -m, --min_word_length: Minimum word length, default 3.
  -o, --offsite: Let the spider visit other sites.
  -w, --write: Write the output to the file.
  -u, --ua <agent>: User agent to send.
  -n, --no-words: Don't output the wordlist.
  -a, --meta: include meta data.
  --meta_file file: Output file for meta data.
  -e, --email: Include email addresses.
  --email_file <file>: Output file for email addresses.
  --meta-temp-dir <dir>: The temporary directory used by exiftool when parsing files, default /tmp.
  -c, --count: Show the count for each word found.
  -v, --verbose: Verbose.
  --debug: Extra debug information.

  AUTHENTICATION:
  --auth_type: Digest or basic.
  --auth_user: Authentication username.
  --auth_pass: Authentication password.

  PROXY SUPPORT:
  --proxy_host: Proxy host.
  --proxy_port: Proxy port, default 8080.
  --proxy_username: Username for proxy, if required.
  --proxy_password: Password for proxy, if required.

  HEADERS:
  --header, -H: In format name:value - can pass multiple.

  <url>: The site to spider.

" exit 0 end

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/digininja/CeWL/issues/28, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHJWVu4g4uAV9a8k3E0594Xx5mUpWrdks5tGW0xgaJpZM4RQNLY .

alibkaba commented 6 years ago

I made some additional changes. Since authentication, proxy support and headers are options, I tabbed them up OPTIONS. image

alibkaba commented 6 years ago

I made a second pull request for another version..feel free to pick whichever you like. Update cewl.rb #30 or Update cewl.rb #31 (I personally prefer #31 because its clean, not too busy like nmap -h but we're also not wasting space)

image

digininja commented 6 years ago

PR #31 merged, thanks.