system-command-manuals

Outputs detailed manuals for query commands in Markdown format.

Command properties

PropertyDescription
Command typeDriver query
Required permissionNone
License usageNot counted
Parallel executionNot supported
Distributed executionNot supported

Syntax

system-command-manuals [lang={en|ko|en,ko}]

Options

lang={en|ko|en,ko}
Specifies the language of the manuals to output. Separate multiple languages with a comma. If not specified, manuals in all languages are output.
  • en: Output English manuals only
  • ko: Output Korean manuals only
  • en,ko: Output both English and Korean manuals

Output fields

FieldTypeDescription
namestringQuery command name
enstringQuery command manual in English
kostringQuery command manual in Korean

Error codes

Parsing errors
Error codeMessageDescription
95140Unsupported language: [lang]A value other than en or ko was specified for the lang option
Runtime errors

N/A

Description

The system-command-manuals command outputs detailed manuals for all query commands registered in the system in Markdown format. Each manual includes the command description, syntax, options, output fields, and usage examples.

If the lang option is not specified, manuals in both English (en) and Korean (ko) are output.

Examples

  1. Output query command manuals in all languages

    system-command-manuals
    

    Retrieves English and Korean manuals for all query commands registered in the system.

  2. Output Korean query command manuals

    system-command-manuals lang=ko
    

    Retrieves Korean manuals for all query commands.

  3. Retrieve the manual for a specific command

    system-command-manuals lang=ko | search name == "stats"
    

    Retrieves the Korean manual for the stats command.