diff --git a/site/src/site/sphinx/en/options.md b/site/src/site/sphinx/en/options.md new file mode 100644 index 000000000..04bb88413 --- /dev/null +++ b/site/src/site/sphinx/en/options.md @@ -0,0 +1,26 @@ +options +=== + +> Global options + +| Name | Default Value | Description | +| ------------------ | ----- | ---------------------------------------- | +| unsafe | false | Enable support for system-level class enhancement, turn on this switch may crash JVM, please choose carefully! | +| dump | false | Enable support for dumping enhanced class to external file,if turned on,class file will be dumped to`/${application dir}/arthas-class-dump/`,please see console for specific location | +| batch-re-transform | true | Enable support for batch re-transform matched classes | +| json-format | false | Enable output in JSON format | +| disable-sub-class | false | Disabling child class matching,by default child class will be matched during matching target class,if you wish exact matching,you can turn this off | +| debug-for-asm | false | Print ASM related debug message | +| save-result | false | Enable saving logs for task results,when turn to true, all command results will be saved to `/home/admin/logs/arthas/arthas.log` | +| job-timeout | 1d | Default time-out time for back-stage tasks,if exceed this time,task will be stopped;i.e. 1d, 2h, 3m, 25s,representing day、hour、minute、second | + +### Usage + +For example,if you wish to save logs for command results, you can use following command: + +``` +$ options save-result true + NAME BEFORE-VALUE AFTER-VALUE +---------------------------------------- + save-result false true +``` \ No newline at end of file