system-command-manuals
Outputs detailed manuals for query commands in Markdown format.
Command properties
| Property | Description |
|---|---|
| Command type | Driver query |
| Required permission | None |
| License usage | Not counted |
| Parallel execution | Not supported |
| Distributed execution | Not 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 onlyko: Output Korean manuals onlyen,ko: Output both English and Korean manuals
Output fields
| Field | Type | Description |
|---|---|---|
| name | string | Query command name |
| en | string | Query command manual in English |
| ko | string | Query command manual in Korean |
Error codes
Parsing errors
| Error code | Message | Description |
|---|---|---|
| 95140 | Unsupported 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
-
Output query command manuals in all languages
system-command-manualsRetrieves English and Korean manuals for all query commands registered in the system.
-
Output Korean query command manuals
system-command-manuals lang=koRetrieves Korean manuals for all query commands.
-
Retrieve the manual for a specific command
system-command-manuals lang=ko | search name == "stats"Retrieves the Korean manual for the
statscommand.