feat: add docs to main (#1559)
This commit is contained in:
28
docs/zh/developer/install/cli/stop.md
Normal file
28
docs/zh/developer/install/cli/stop.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# `stop`
|
||||
|
||||
## 命令说明
|
||||
`stop` 命令用于停止已安装(或部分安装)的 Olares 系统中的各个组件。
|
||||
|
||||
```bash
|
||||
olares-cli stop [选项]
|
||||
```
|
||||
|
||||
## 选项
|
||||
|
||||
| 选项 | 简写 | 用途 | 是否必需 | 默认值 |
|
||||
|--------------------|------|------------------------------------------------------------------------------|----------|----------|
|
||||
| `--check-interval` | | 设置关闭过程中检查剩余进程的时间间隔(如 `5s`、`2m`、`3h`)。 | 否 | `10s` |
|
||||
| `--help` | `-h` | 显示命令帮助信息。 | 否 | 无 |
|
||||
| `--timeout` | | 设置等待优雅关闭的最长时间,超时后将使用 SIGKILL 强制终止(如 `5s`、`2m`、`3h`)。 | 否 | `1m` |
|
||||
|
||||
## 使用示例
|
||||
```bash
|
||||
# 停止 Olares 系统
|
||||
olares-cli stop
|
||||
|
||||
# 调整关闭超时时间
|
||||
olares-cli stop --timeout 2m
|
||||
|
||||
# 自定义检查间隔时间
|
||||
olares-cli stop --check-interval 5s
|
||||
```
|
||||
Reference in New Issue
Block a user