You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@notes_opts = Rex::Parser::Arguments.new(
[ '-a', '--add' ] => [ false, 'Add a note to the list of addresses, instead of listing.' ],
[ '-d', '--delete' ] => [ false, 'Delete the notes instead of searching.' ],
[ '-n', '--note' ] => [ true, 'Set the data for a new note (only with -a).', '<note>' ],
[ '-t', '--type' ] => [ true, 'Search for a list of types, or set single type for add.', '<type1,type2>' ],
[ '-h', '--help' ] => [ false, 'Show this help information.' ],
[ '-R', '--rhosts' ] => [ false, 'Set RHOSTS from the results of the search.' ],
[ '-o', '--output' ] => [ true, 'Save the notes to a csv file.', '<filename>' ],
[ '-O', '--order' ] => [ true, 'Order rows by specified column number.', '<column id>' ],
[ '-u', '--update' ] => [ false, 'Update a note. Not officially supported.' ]
)
Summary
notes -h
states that we can use this example command
notes -S 'nmap.nse.(http|rtsp)'
Example documentation
But this flag is neither documented here
missing documentation for search parameter
nor is it working correctly when used like this.
Acutally there seems to be code handling the
-S
parameter:existing code for handling undocumented parameter
Motivation
To be consistent between parameter documentation, examples and code behind.
Steps to resolve this issue
EITHER
search_term
OR
-S
parameter additionally to the example and test it accordingly e.g.Draft the doc
-S, --search <filter> Search string to filter by
Open a pull request
Sorry for not proposing a PR but I could not figure out why the undocumented parameter is not working as expected.
The text was updated successfully, but these errors were encountered: