Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an EXAMPLES sections to all man-pages #161

Open
16 of 49 tasks
postmodern opened this issue Jun 3, 2023 · 0 comments
Open
16 of 49 tasks

Add an EXAMPLES sections to all man-pages #161

postmodern opened this issue Jun 3, 2023 · 0 comments
Labels
docs Documentation good first issue Good first issue help-wanted Extra attention is needed

Comments

@postmodern
Copy link
Member

postmodern commented Jun 3, 2023

All man-pages should have an ## EXAMPLES section near the end (but before ## AUTHORS) with example commands showing various ways how to use the command.

  • man/ronin-asn.1.md
  • man/ronin-cert-dump.1.md
  • man/ronin-cert-gen.1.md
  • man/ronin-cert-grab.1.md
  • man/ronin-email-addr.1.md
  • man/ronin-hexdump.1.md
  • man/ronin-ip.1.md
  • man/ronin-new-project.1.md
  • man/ronin-new-script.1.md
  • man/ronin-new.1.md
  • man/ronin-proxy.1.md
  • man/ronin-unhexdump.1.md
  • man/ronin-banner-grab.1.md
  • man/ronin-bitflip.1.md
  • man/ronin-decode.1.md
  • man/ronin-decrypt.1.md
  • man/ronin-dns.1.md
  • man/ronin-encode.1.md
  • man/ronin-encrypt.1.md
  • man/ronin-entropy.1.md
  • man/ronin-escape.1.md
  • man/ronin-extract.1.md
  • man/ronin-grep.1.md
  • man/ronin-help.1.md
  • man/ronin-highlight.1.md
  • man/ronin-hmac.1.md
  • man/ronin-homoglyph.1.md
  • man/ronin-host.1.md
  • man/ronin-http.1.md
  • man/ronin-iprange.1.md
  • man/ronin-irb.1.md
  • man/ronin-md5.1.md
  • man/ronin-netcat.1.md
  • man/ronin-public-suffix-list.1.md
  • man/ronin-quote.1.md
  • man/ronin-rot.1.md
  • man/ronin-sha1.1.md
  • man/ronin-sha256.1.md
  • man/ronin-sha512.1.md
  • man/ronin-strings.1.md
  • man/ronin-tips.1.md
  • man/ronin-tld-list.1.md
  • man/ronin-typo.1.md
  • man/ronin-typosquat.1.md
  • man/ronin-unescape.1.md
  • man/ronin-unquote.1.md
  • man/ronin-url.1.md
  • man/ronin-xor.1.md
  • man/ronin.1.md

Obviously this will take some time, and a lot of commits and PRs, to fully complete.

@postmodern postmodern added docs Documentation help-wanted Extra attention is needed labels Jun 3, 2023
@postmodern postmodern changed the title Add ## EXAMPLES sections to all man-pages Add an ## EXAMPLES sections to all man-pages Jun 3, 2023
@postmodern postmodern changed the title Add an ## EXAMPLES sections to all man-pages Add an EXAMPLES sections to all man-pages Jun 3, 2023
@postmodern postmodern added the good first issue Good first issue label Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation good first issue Good first issue help-wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant