man-get-flags
)Parses man page files for command line flags
Sometimes you might want to programmatically search man
pages for any supported flag. Particularly if you’re writing a dynamic autocompletion. man-get-flags
does this and returns a JSON document.
You can either pipe a man page to man-get-flags
, or pass the name of the command as a parameter.
man-get-flags
returns a JSON document. Either an array or an object, depending on what flags (if any) are passed.
If no flags are passed, man-get-flags
will default to just parsing the man page for anything that looks like a flag (ie no descriptions or other detail).
<stdin> -> man-get-flags [--descriptions] -> <stdout>
man-get-flags command [--descriptions] -> <stdout>
» man-get-flags --descriptions find -> [{$.key =~ 'regex'}]
{
"-iregex": "eg: pattern -- Like -regex, but the match is case insensitive.",
"-regex": "eg: pattern -- True if the whole path of the file matches pattern using regular expression. To match a file named “./foo/xyzzy”, you can use the regular expression “.*/[xyz]*” or “.*/foo/.*”, but not “xyzzy” or “/foo/”."
}
--descriptions
return a map of flags with their described usage-d
shorthand for --descriptions
Due to the freeform nature of man pages - that they’re intended to be human readable rather than machine readable - and the flexibility that developers have to parse command line parameters however they wish, there will always be a margin for error with how reliably any parser can autodetect parameters. one requirement is that flags are hyphen prefixed, eg --flag
.
man-get-flags
man-summary
): Outputs a man page summary of a commandmurex-docs
): Displays the man pages for Murex builtinssummary
): Defines a summary help text for a commandThis document was generated from builtins/core/management/shell_doc.yaml.
This site's content is rebuilt automatically from murex's source code after each merge to the master
branch. Downloadable murex binaries are also built with the website.
Last built on Wed Sep 18 21:18:57 UTC 2024 against commit c037883c03788357164e9846c84d9f777251495d9452a8e.
Current version is 6.3.4225 (develop) which has been verified against tests cases.