Skip to content

Update loop documentation #962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Nov 22, 2025
Merged

Update loop documentation #962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/loop/loop.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,16 @@ list all instant out swaps
.PP
\fB--help, -h\fP: show help

.SH stop
.PP
stop the loop daemon

.PP
\fB--help, -h\fP: show help

.PP
\fB--wait\fP: wait until loopd fully shuts down

.SH static, s
.PP
perform on-chain to off-chain swaps using static addresses.
Expand Down
19 changes: 19 additions & 0 deletions docs/loop/loop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,25 @@ The following flags are supported:
|-----------------|-------------|------|:-------------:|
| `--help` (`-h`) | show help | bool | `false` |

### `stop` command

stop the loop daemon.

Requests loopd to perform a graceful shutdown.

Usage:

```bash
$ loop [GLOBAL FLAGS] stop [COMMAND FLAGS] [ARGUMENTS...]
```

The following flags are supported:

| Name | Description | Type | Default value |
|-----------------|-----------------------------------|------|:-------------:|
| `--wait` | wait until loopd fully shuts down | bool | `false` |
| `--help` (`-h`) | show help | bool | `false` |

### `static` command (aliases: `s`)

perform on-chain to off-chain swaps using static addresses.
Expand Down