diff --git a/site/src/site/sphinx/en/options.md b/site/src/site/sphinx/en/options.md index 51bd2efb2..c008e554f 100644 --- a/site/src/site/sphinx/en/options.md +++ b/site/src/site/sphinx/en/options.md @@ -1,22 +1,22 @@ options === -### Global options +> Global options |Name| Default Value | Description | | ------------------------- | ----- | ---------------------------------------- | -| unsafe | false | Enable system-level class enhancement; JVM might crash, if you turn it on (use with great caution :exclamation:) | -| dump | false | Enable support for dumping enhanced class to external files; if turned on, class file will be dumped to`/${application dir}/arthas-class-dump/`,please check console output for specific location | -| batch-re-transform | true | re-transform matched classes in batch | -| json-format | false | Enable output in JSON format | -| disable-sub-class | false | Disabling child class matching: by default child class will be matched while matching target class; if you wish exact matching, you should turn it off | -| debug-for-asm | false | Print ASM-related debug message | -| save-result | false | Enable saving logs for task results: when true, all command results will be saved to `/home/admin/logs/arthas/arthas.log` | -| job-timeout | 1d | Default timeout for background jobs: jobs will be stopped once timed out (i.e. 1d, 2h, 3m, 25s)| +| unsafe | false | whether to enhance to system-level class. Use it with caution since JVM may hang| +| dump | false | whether to dump enhanced class to the external files. If it's on, enhanced class will be dumped into `/${application dir}/arthas-class-dump/`, the specific output path will be output in the console | +| batch-re-transform | true | whether to re-transform matched classes in batch| +| json-format | false | whether to output in JSON format| +| disable-sub-class | false | whether to enable matching child classes. The default value is `true`. If exact match is desire, turn off this flag| +| debug-for-asm | false | whether to enable ASM debugging log| +| save-result | false | whether to save execution result. All execution results will be saved to `/home/admin/logs/arthas/arthas.log` when it's turned on| +| job-timeout | 1d | default timeout for background jobs. Background job will be terminated once it's timed out (i.e. 1d, 2h, 3m, 25s)| ### Usage -Saving logs for command outputs, you can: +For example, to enable saving command execution result, input the command below: ``` $ options save-result true