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

Reference documentation for jobs #11498

Merged
merged 4 commits into from
Mar 1, 2019
Merged

Conversation

acammack-r7
Copy link
Contributor

@acammack-r7 acammack-r7 commented Feb 28, 2019

Adds documentation for the jobs command and a reusable doc fragment for how Metasploit builds ranges of ids and IPs. Minor tweak to the check command to use all IPs passed for my own sanity.

Verification

  • msfconsole
  • help jobs should show extra, helpful help
  • In an exploit module check 127.0.0.1, 127.0.0.2 actually checks those IPs

#11407

@busterb
Copy link
Member

busterb commented Feb 28, 2019

LGTM, thanks @acammack-r7

@busterb busterb merged commit 26dadef into rapid7:master Mar 1, 2019
@busterb
Copy link
Member

busterb commented Mar 1, 2019

Release Notes

This adds extended documentation for the jobs command to msfconsole.

@gdavidson-r7 gdavidson-r7 added the rn-enhancement release notes enhancement label Mar 19, 2019
@h00die
Copy link
Contributor

h00die commented Mar 23, 2019

it looks like this puts markdown text on the command line, and the -d flag used for info doesn't open it in a browser. Am I missing something here?

@acammack-r7
Copy link
Contributor Author

It's a bit a tricky. I definitely didn't want the extra help to be entirely gated behind help -d because it would be nearly impossible for newcomers to find (help help is currently an Easter egg and none of the readily google-able guides would mention it). Another issue is that any rendered documentation should be able to link between various documents, so the info -d trick of rendering just the one page to a tempfile would need to be rethought or augmented. I'm not opposed to adding it for symmetry, but it needs a bit of care to be really useful (my idea would be along the lines of gem server when you have docs installed).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement rn-enhancement release notes enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants