Skip to content

Commit 229e5da

Browse files
Merge pull request #962 from lightninglabs/docs-loop
Update loop documentation
2 parents 736c14e + 3920481 commit 229e5da

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/loop/loop.1

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,16 @@ list all instant out swaps
431431
.PP
432432
\fB--help, -h\fP: show help
433433

434+
.SH stop
435+
.PP
436+
stop the loop daemon
437+
438+
.PP
439+
\fB--help, -h\fP: show help
440+
441+
.PP
442+
\fB--wait\fP: wait until loopd fully shuts down
443+
434444
.SH static, s
435445
.PP
436446
perform on-chain to off-chain swaps using static addresses.

docs/loop/loop.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,25 @@ The following flags are supported:
468468
|-----------------|-------------|------|:-------------:|
469469
| `--help` (`-h`) | show help | bool | `false` |
470470

471+
### `stop` command
472+
473+
stop the loop daemon.
474+
475+
Requests loopd to perform a graceful shutdown.
476+
477+
Usage:
478+
479+
```bash
480+
$ loop [GLOBAL FLAGS] stop [COMMAND FLAGS] [ARGUMENTS...]
481+
```
482+
483+
The following flags are supported:
484+
485+
| Name | Description | Type | Default value |
486+
|-----------------|-----------------------------------|------|:-------------:|
487+
| `--wait` | wait until loopd fully shuts down | bool | `false` |
488+
| `--help` (`-h`) | show help | bool | `false` |
489+
471490
### `static` command (aliases: `s`)
472491

473492
perform on-chain to off-chain swaps using static addresses.

0 commit comments

Comments
 (0)