mirror of
https://github.com/lightninglabs/loop.git
synced 2026-08-13 12:33:03 +02:00
docs: regenerate reservation CLI reference
Regenerate the command reference after adding reservation quote and purchase commands.
This commit is contained in:
parent
fb6e6101e8
commit
696f7984a7
2 changed files with 32 additions and 0 deletions
12
docs/loop.1
12
docs/loop.1
|
|
@ -388,6 +388,18 @@ list all reservations
|
|||
.PP
|
||||
\fB--help, -h\fP: show help
|
||||
|
||||
.SS new, n
|
||||
create a new reservation
|
||||
|
||||
.PP
|
||||
\fB--amt\fP="": the amount in satoshis for the reservation (default: 0)
|
||||
|
||||
.PP
|
||||
\fB--expiry\fP="": the relative block height at which the reservation expires (default: 0)
|
||||
|
||||
.PP
|
||||
\fB--help, -h\fP: show help
|
||||
|
||||
.SH instantout
|
||||
perform an instant off-chain to on-chain swap (looping out)
|
||||
|
||||
|
|
|
|||
20
docs/loop.md
20
docs/loop.md
|
|
@ -455,6 +455,26 @@ The following flags are supported:
|
|||
|-----------------|-------------|------|:-------------:|
|
||||
| `--help` (`-h`) | show help | bool | `false` |
|
||||
|
||||
### `reservations new` subcommand (aliases: `n`)
|
||||
|
||||
create a new reservation.
|
||||
|
||||
Create a new reservation with the given value and expiry.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
$ loop [GLOBAL FLAGS] reservations new [COMMAND FLAGS] [ARGUMENTS...]
|
||||
```
|
||||
|
||||
The following flags are supported:
|
||||
|
||||
| Name | Description | Type | Default value |
|
||||
|-----------------|------------------------------------------------------------|------|:-------------:|
|
||||
| `--amt="…"` | the amount in satoshis for the reservation | uint | `0` |
|
||||
| `--expiry="…"` | the relative block height at which the reservation expires | uint | `0` |
|
||||
| `--help` (`-h`) | show help | bool | `false` |
|
||||
|
||||
### `instantout` command
|
||||
|
||||
perform an instant off-chain to on-chain swap (looping out).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue