From afa97241af386e4874d92470c344086dcb2faf99 Mon Sep 17 00:00:00 2001 From: The MMGen Project Date: Mon, 16 Jun 2025 14:35:31 +0000 Subject: [PATCH] doc.wiki.cmds: update helpscreen documentation --- doc/wiki/cmds/command-help-addrgen.md | 3 ++- doc/wiki/cmds/command-help-keygen.md | 3 ++- doc/wiki/cmds/command-help-msg.md | 3 ++- doc/wiki/cmds/command-help-swaptxcreate.md | 14 ++++++++++++-- doc/wiki/cmds/command-help-swaptxdo.md | 14 ++++++++++++-- doc/wiki/cmds/command-help-txbump.md | 6 ++++-- doc/wiki/cmds/command-help-txcreate.md | 5 +++-- doc/wiki/cmds/command-help-txdo.md | 5 +++-- doc/wiki/cmds/command-help-txsign.md | 5 ++++- mmgen/data/version | 2 +- 10 files changed, 45 insertions(+), 15 deletions(-) diff --git a/doc/wiki/cmds/command-help-addrgen.md b/doc/wiki/cmds/command-help-addrgen.md index fb21843f..b0a69a55 100644 --- a/doc/wiki/cmds/command-help-addrgen.md +++ b/doc/wiki/cmds/command-help-addrgen.md @@ -99,6 +99,7 @@ ‘C’ compressed - Compressed P2PKH address ‘S’ segwit - Segwit P2SH-P2WPKH address ‘B’ bech32 - Native Segwit (Bech32) address + ‘X’ bech32x - Cross-chain Bech32 address ‘E’ ethereum - Ethereum address ‘Z’ zcash_z - Zcash z-address ‘M’ monero - Monero address @@ -120,5 +121,5 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v15.1.dev18 March 2025 MMGEN-ADDRGEN(1) + MMGEN-WALLET 15.1.dev44 June 2025 MMGEN-ADDRGEN(1) ``` diff --git a/doc/wiki/cmds/command-help-keygen.md b/doc/wiki/cmds/command-help-keygen.md index cba02cd3..00d079c1 100644 --- a/doc/wiki/cmds/command-help-keygen.md +++ b/doc/wiki/cmds/command-help-keygen.md @@ -104,6 +104,7 @@ ‘C’ compressed - Compressed P2PKH address ‘S’ segwit - Segwit P2SH-P2WPKH address ‘B’ bech32 - Native Segwit (Bech32) address + ‘X’ bech32x - Cross-chain Bech32 address ‘E’ ethereum - Ethereum address ‘Z’ zcash_z - Zcash z-address ‘M’ monero - Monero address @@ -125,5 +126,5 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN v15.1.dev18 March 2025 MMGEN-KEYGEN(1) + MMGEN-WALLET 15.1.dev44 June 2025 MMGEN-KEYGEN(1) ``` diff --git a/doc/wiki/cmds/command-help-msg.md b/doc/wiki/cmds/command-help-msg.md index 2a7bba3e..6d43a4df 100644 --- a/doc/wiki/cmds/command-help-msg.md +++ b/doc/wiki/cmds/command-help-msg.md @@ -45,6 +45,7 @@ ‘C’ compressed - Compressed P2PKH address ‘S’ segwit - Segwit P2SH-P2WPKH address ‘B’ bech32 - Native Segwit (Bech32) address + ‘X’ bech32x - Cross-chain Bech32 address ‘E’ ethereum - Ethereum address ‘Z’ zcash_z - Zcash z-address ‘M’ monero - Monero address @@ -106,5 +107,5 @@ Verify and display the exported JSON signature data: $ mmgen-msg verify signatures.json - MMGEN v15.1.dev18 March 2025 MMGEN-MSG(1) + MMGEN-WALLET 15.1.dev44 June 2025 MMGEN-MSG(1) ``` diff --git a/doc/wiki/cmds/command-help-swaptxcreate.md b/doc/wiki/cmds/command-help-swaptxcreate.md index 7790a1c8..33dea591 100644 --- a/doc/wiki/cmds/command-help-swaptxcreate.md +++ b/doc/wiki/cmds/command-help-swaptxcreate.md @@ -7,7 +7,7 @@ -a, --autosign Create a transaction for offline autosigning (see ‘mmgen-autosign’). The removable device is mounted and unmounted automatically - -A, --fee-adjust f Adjust transaction fee by factor 'f' (see below) + -A, --fee-adjust f Adjust transaction fee by factor ‘f’ (see below) -B, --no-blank Don't blank screen before displaying unspent outputs -c, --comment-file f Source the transaction's comment from file 'f' -C, --fee-estimate-confs c Desired number of confirmations for fee estimation @@ -143,6 +143,7 @@ ‘C’ compressed - Compressed P2PKH address ‘S’ segwit - Segwit P2SH-P2WPKH address ‘B’ bech32 - Native Segwit (Bech32) address + ‘X’ bech32x - Cross-chain Bech32 address ‘E’ ethereum - Ethereum address ‘Z’ zcash_z - Zcash z-address ‘M’ monero - Monero address @@ -244,5 +245,14 @@ $ mmgen-swaptxcreate ETH.USDT 1000 ETH.DAI E:01234ABC:3 - MMGEN-WALLET 15.1.dev37 May 2025 MMGEN-SWAPTXCREATE(1) + Create a RUNE-to-BTC swap transaction, proxying requests to the remote + Thornode server via Tor: + + $ mmgen-swaptxcreate --proxy=localhost:9050 RUNE 1000 BTC + + Same as above, but proxy requests via the I2P router running on host gw1: + + $ https_proxy=http://gw1:4444 mmgen-swaptxcreate --proxy=env RUNE 1000 BTC + + MMGEN-WALLET 15.1.dev47 June 2025 MMGEN-SWAPTXCREATE(1) ``` diff --git a/doc/wiki/cmds/command-help-swaptxdo.md b/doc/wiki/cmds/command-help-swaptxdo.md index e62071ee..06ae087b 100644 --- a/doc/wiki/cmds/command-help-swaptxdo.md +++ b/doc/wiki/cmds/command-help-swaptxdo.md @@ -4,7 +4,7 @@ OPTIONS: -h, --help Print this help message --longhelp Print help message for long (global) options - -A, --fee-adjust f Adjust transaction fee by factor 'f' (see below) + -A, --fee-adjust f Adjust transaction fee by factor ‘f’ (see below) -b, --brain-params l,p Use seed length 'l' and hash preset 'p' for brainwallet input -B, --no-blank Don't blank screen before displaying unspent outputs @@ -165,6 +165,7 @@ ‘C’ compressed - Compressed P2PKH address ‘S’ segwit - Segwit P2SH-P2WPKH address ‘B’ bech32 - Native Segwit (Bech32) address + ‘X’ bech32x - Cross-chain Bech32 address ‘E’ ethereum - Ethereum address ‘Z’ zcash_z - Zcash z-address ‘M’ monero - Monero address @@ -306,5 +307,14 @@ $ mmgen-swaptxdo ETH.USDT 1000 ETH.DAI E:01234ABC:3 - MMGEN-WALLET 15.1.dev37 May 2025 MMGEN-SWAPTXDO(1) + Create a RUNE-to-BTC swap transaction, proxying requests to the remote + Thornode server via Tor: + + $ mmgen-swaptxdo --proxy=localhost:9050 RUNE 1000 BTC + + Same as above, but proxy requests via the I2P router running on host gw1: + + $ https_proxy=http://gw1:4444 mmgen-swaptxdo --proxy=env RUNE 1000 BTC + + MMGEN-WALLET 15.1.dev47 June 2025 MMGEN-SWAPTXDO(1) ``` diff --git a/doc/wiki/cmds/command-help-txbump.md b/doc/wiki/cmds/command-help-txbump.md index 6f0a319c..e5cb7890 100644 --- a/doc/wiki/cmds/command-help-txbump.md +++ b/doc/wiki/cmds/command-help-txbump.md @@ -49,7 +49,9 @@ -v, --verbose Produce more verbose output -W, --allow-non-wallet-swap Allow signing of swap transactions that send funds to non-wallet addresses - -x, --proxy P Fetch the swap quote via SOCKS5 proxy ‘P’ (host:port) + -x, --proxy P Fetch the swap quote via SOCKS5h proxy ‘P’ (host:port). + Use special value ‘env’ to honor *_PROXY environment + vars instead. -y, --yes Answer 'yes' to prompts, suppress non-essential output -z, --show-hash-presets Show information on available hash presets @@ -118,5 +120,5 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN-WALLET 15.1.dev37 May 2025 MMGEN-TXBUMP(1) + MMGEN-WALLET 15.1.dev44 June 2025 MMGEN-TXBUMP(1) ``` diff --git a/doc/wiki/cmds/command-help-txcreate.md b/doc/wiki/cmds/command-help-txcreate.md index 02f35ac8..3dcbec8f 100644 --- a/doc/wiki/cmds/command-help-txcreate.md +++ b/doc/wiki/cmds/command-help-txcreate.md @@ -7,7 +7,7 @@ -a, --autosign Create a transaction for offline autosigning (see ‘mmgen-autosign’). The removable device is mounted and unmounted automatically - -A, --fee-adjust f Adjust transaction fee by factor 'f' (see below) + -A, --fee-adjust f Adjust transaction fee by factor ‘f’ (see below) -B, --no-blank Don't blank screen before displaying unspent outputs -c, --comment-file f Source the transaction's comment from file 'f' -C, --fee-estimate-confs c Desired number of confirmations for fee estimation @@ -81,6 +81,7 @@ ‘C’ compressed - Compressed P2PKH address ‘S’ segwit - Segwit P2SH-P2WPKH address ‘B’ bech32 - Native Segwit (Bech32) address + ‘X’ bech32x - Cross-chain Bech32 address ‘E’ ethereum - Ethereum address ‘Z’ zcash_z - Zcash z-address ‘M’ monero - Monero address @@ -123,5 +124,5 @@ $ mmgen-txcreate B - MMGEN-WALLET 15.1.dev37 May 2025 MMGEN-TXCREATE(1) + MMGEN-WALLET 15.1.dev44 June 2025 MMGEN-TXCREATE(1) ``` diff --git a/doc/wiki/cmds/command-help-txdo.md b/doc/wiki/cmds/command-help-txdo.md index d727b02f..69ce4c0b 100644 --- a/doc/wiki/cmds/command-help-txdo.md +++ b/doc/wiki/cmds/command-help-txdo.md @@ -4,7 +4,7 @@ OPTIONS: -h, --help Print this help message --longhelp Print help message for long (global) options - -A, --fee-adjust f Adjust transaction fee by factor 'f' (see below) + -A, --fee-adjust f Adjust transaction fee by factor ‘f’ (see below) -b, --brain-params l,p Use seed length 'l' and hash preset 'p' for brainwallet input -B, --no-blank Don't blank screen before displaying unspent outputs @@ -104,6 +104,7 @@ ‘C’ compressed - Compressed P2PKH address ‘S’ segwit - Segwit P2SH-P2WPKH address ‘B’ bech32 - Native Segwit (Bech32) address + ‘X’ bech32x - Cross-chain Bech32 address ‘E’ ethereum - Ethereum address ‘Z’ zcash_z - Zcash z-address ‘M’ monero - Monero address @@ -189,5 +190,5 @@ $ mmgen-txdo B - MMGEN-WALLET 15.1.dev37 May 2025 MMGEN-TXDO(1) + MMGEN-WALLET 15.1.dev44 June 2025 MMGEN-TXDO(1) ``` diff --git a/doc/wiki/cmds/command-help-txsign.md b/doc/wiki/cmds/command-help-txsign.md index 98c38c12..e35859eb 100644 --- a/doc/wiki/cmds/command-help-txsign.md +++ b/doc/wiki/cmds/command-help-txsign.md @@ -4,6 +4,9 @@ OPTIONS: -h, --help Print this help message --longhelp Print help message for long (global) options + -a, --autosign Sign a transaction created for offline autosigning (see + ‘mmgen-autosign’). The removable device is mounted and + unmounted automatically -b, --brain-params l,p Use seed length 'l' and hash preset 'p' for brainwallet input -d, --outdir d Specify an alternate directory 'd' for output @@ -82,5 +85,5 @@ MMGenWallet .mmdat wallet,w PlainHexSeedFile .hex hex,rawhex,plainhex - MMGEN-WALLET 15.1.dev37 May 2025 MMGEN-TXSIGN(1) + MMGEN-WALLET 15.1.dev47 June 2025 MMGEN-TXSIGN(1) ``` diff --git a/mmgen/data/version b/mmgen/data/version index c06fe99a..8709d4b4 100644 --- a/mmgen/data/version +++ b/mmgen/data/version @@ -1 +1 @@ -15.1.dev46 +15.1.dev47