finesse.cli.docs.syntax¶
- finesse.cli.docs.syntax = <Command syntax>¶
Query the KatScript syntax documentation for query.
- Supports simple wildcard characters:
*matches 0 or more characters?matches any single character[abc]matches any characters in abc[!abc]matches any characters not in abc
If there is a
.in query, everything before that is assumed to be a directive and everything after to be a parameter.A
*is added to the end of each query term, pass –exact to prevent this.If no match is found some suggestions will be shown. Pass –no-suggestions to disable suggestions.
If directive is an empty string all syntax documentation will be shown.
For more detailed help try kat3 help.