mmgen/mmgen-wallet
1
0
Fork 0
Code Issues Pull requests Projects Releases 28 Packages Wiki Activity

update manpage footers for v15.0.0

The MMGen Project 2024-09-20 13:44:56 +00:00
commit fea90c2467
Signed by: mmgen
GPG key ID: 3F8B1861E32B7DA2
31 changed files with 90 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Getting-Started-with-MMGen-Wallet.md

@ -873,11 +873,11 @@ Signed transaction written to file 'ABCDEF[0.1].sigtx'
*Instead of using a hot wallet, you should consider setting up [transaction
autosigning][07] on your offline machine. Autosigning makes it possible to
transact directly from cold storage in a secure and convenient way. Autosigning
is available for Linux-based systems and is tailored for use with Raspberry Pi
and other single-board computers, for which LED support is provided. Old
laptops with their network interfaces disabled also make acceptable signing
devices.*
transact directly from cold storage in a secure and convenient way. Ideally,
your autosigning device should be a Raspberry Pi or other single-board computer
for which MMGen Wallet provides LED support. However, an old laptop running
Linux or macOS would also suffice, provided its network interfaces are removed
or disabled.*
To use MMGen Wallet for not only cold storage but also day-to-day transacting,
it’s possible to place a portion of your funds in a “hot wallet” on your online
@ -1106,7 +1106,7 @@ install it with `pip install --no-isolation`.
Note that additional dependencies may appear from version to version, causing
an offline installation to fail. Consult the latest release notes in
`doc/release-notes` or your platform’s installation page in the wiki
([Linux][li], [Windows][wi]) for more information.
([Linux, macOS][li], [Windows][wi]) for more information.
##### <a id="a_udd">Development version:</a>
@ -1152,5 +1152,5 @@ $ python3 -m pip install user --upgrade dist/*.whl
[ax]: Altcoin-and-Forkcoin-Support#a_xmr
[cp]: https://gitlab.com/MMGen/mmgen-wallet/-/commits/master
[mx]: command-help-xmrwallet
[li]: Install-MMGen-Wallet-on-Linux
[li]: Install-MMGen-Wallet-on-Linux-or-macOS
[wi]: Install-MMGen-Wallet-on-Microsoft-Windows

2
Home.md

@ -11,7 +11,7 @@ are performed via the `/` key.
> #### [Install on Microsoft Windows](Install-MMGen-Wallet-on-Microsoft-Windows)
> #### [Install on Debian, Ubuntu, Raspbian, Armbian or Arch Linux](Install-MMGen-Wallet-on-Linux)
> #### [Install on Linux or macOS](Install-MMGen-Wallet-on-Linux-or-macOS)
### Using MMGen Wallet

29
Install-Bitcoind.md

@ -45,8 +45,8 @@ more low-powered computer as your online machine.
>> At the end of the installation process, uncheck the Run box to prevent the
>> client from starting.
>>
>> **Linux:** Unpack the archive and copy the `bitcoind` and `bitcoin-cli`
>> binaries to `/usr/local/bin`.
>> **Linux, macOS:** Unpack the archive and copy the `bitcoind` and
>> `bitcoin-cli` binaries to `/usr/local/bin`.
> **Bitcoin Cash Node (optional):**
@ -57,8 +57,9 @@ more low-powered computer as your online machine.
>> Navigate to `C:\Program Files\Bitcoin-Cash-Node\daemon` and rename the file
>> `bitcoind` to `bitcoind-bchn` and `bitcoin-cli` to `bitcoin-cli-bchn`.
>>
>> **Linux:** Unpack the archive, rename `bitcoind` to `bitcoind-bchn` and
>> copy it to `/usr/local/bin`.
>> **Linux, macOS:** Unpack the archive, rename `bitcoind` to `bitcoind-bchn`,
>> and `bitcoin-cli` to `bitcoin-cli-bchn`, and copy the renamed files to
>> `/usr/local/bin`.
> **Litecoin (optional):**
@ -66,7 +67,7 @@ more low-powered computer as your online machine.
>> At the end of the installation process, uncheck the Run box to prevent the
>> client from starting.
>>
>> **Linux:** Unpack the archive and copy the `litecoind` and
>> **Linux, macOS:** Unpack the archive and copy the `litecoind` and
>> `litecoin-cli` binaries to `/usr/local/bin`.
### <a id="a_r">Run (both online and offline computers):</a>
@ -92,9 +93,9 @@ $ litecoind
>> Note that the `--listen=0` argument is required only when running Bitcoin
>> Core and Bitcoin Cash Node simultaneously.
> **Linux:**
> **Linux, macOS:**
>> Linux users start their daemons like this:
>> Linux and macOS users start their daemons like this:
```text
# Bitcoin Core:
@ -102,7 +103,9 @@ $ bitcoind --daemon
# Bitcoin Cash Node:
$ mkdir ~/.bitcoin-bchn
$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --datadir=$HOME/.bitcoin-bchn --usecashaddr=0
$ BCH_DATADIR="$HOME/.bitcoin-bchn" # Linux
$ BCH_DATADIR="$HOME/Library/Application Support/Bitcoin-Cash-Node" # macOS
$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --usecashaddr=0 --datadir="$BCH_DATADIR"
# Litecoin:
$ litecoind --daemon
@ -111,20 +114,18 @@ $ litecoind --daemon
> Communicate with your daemons like this:
```text
# Core:
# Bitcoin Core:
$ bitcoin-cli help
# Bitcoin Cash Node:
$ bitcoin-cli-bchn --rpcport=8432 help
$ BCH_DATADIR="$HOME/.bitcoin-bchn" # Linux
$ BCH_DATADIR="$HOME/Library/Application Support/Bitcoin-Cash-Node" # macOS
$ bitcoin-cli-bchn --rpcport=8432 --datadir="$BCH_DATADIR" help
# Litecoin:
$ litecoin-cli help
```
> Warning: If you’re using an existing Bitcoin or Litecoin installation, **move
> your wallet.dat out of harm’s way** before starting the daemon. The new
> wallet now created will be used as your **tracking wallet**.
> If you’re connected to the Internet, the daemon(s) will begin downloading and
> verifying the blockchain. This can take from several hours to several days
> depending on the speed of your computer, the size of the blockchain(s) in

14
Install-MMGen-Wallet-on-Linux.md → Install-MMGen-Wallet-on-Linux-or-macOS.md

@ -6,7 +6,7 @@ altcoin support, additional installation steps are required. See*
For computers with no Internet connection, see **Note for offline machines** below.
### Install required packages from your Linux distribution:
### Install required packages from your distribution:
#### Debian/Ubuntu:
@ -20,14 +20,20 @@ $ sudo apt-get install curl git gcc libtool make autoconf libgmp-dev libssl-dev
$ sudo pacman -S curl git gcc libtool make autoconf automake autogen pcre python-pip libsecp256k1
```
#### macOS:
```text
$ brew install python bash autoconf coreutils gcc libmpc libtool readline secp256k1
```
You may wish to use a [virtual environment][vv] to keep your MMGen Wallet
installation isolated from the rest of your Python packages.
If you choose not to use a virtual environment, then you may need to add
`--break-system-packages` to the `pip install` command line, depending on your
Python version and Linux distribution. Note that this will not in fact break
any system packages, as pip installs all packages under the user’s home
directory when invoked as user.
Python and OS versions. Note that this will not in fact break any system
packages, as pip installs all packages under the user’s home directory when
invoked as user.
### Upgrade the Python build tools:

4
Install-MMGen-Wallet-on-Microsoft-Windows.md

@ -403,8 +403,8 @@ syncing the blockchain will be painfully slow.
Congratulations, your installation is now complete, and you can proceed to
[**Getting Started with MMGen Wallet**][gs]. Note that all features supported
by MMGen Wallet on Linux, except for [autosigning][ax], are now supported on
MSYS2 too. Please be aware of the following, however:
by MMGen Wallet on Linux and macOS, except for [autosigning][ax], are now
supported on MSYS2 too. Please be aware of the following, however:
+ Non-ASCII filenames cannot be used with the `mmgen-xmrwallet` utility. This
is an issue with the Monero wallet RPC daemon rather than MMGen.

4
Install-the-Offline-Bitcoind.md

@ -1,7 +1,7 @@
The bitcoin daemon on the **offline machine** is used solely for signing
transactions and is therefore run without a blockchain. The binary included
in the Bitcoin Core release is just fine for this purpose. Windows and Linux
binaries can be obtained [here][00] or [here][01].
in the Bitcoin Core release is just fine for this purpose. Binaries for your
platform can be obtained [here][00] or [here][01].
After installation, locate the bitcoind executable, place it on your execution
path and start it with the command:

8
Test-Suite.md

@ -16,7 +16,7 @@ platforms may be much slower.
## Quick start
### Container setup (if applicable)
### LXC container setup (if applicable)
The test suite requires the `/dev/loopX` devices to exist and be enabled. If
you’re running in an LXC container, note that only privileged containers allow
@ -146,7 +146,7 @@ $ git clone https://github.com/10gic/vanitygen-plusplus
$ cd vanitygen-plusplus
$ git checkout -b vanitygen-plus e7858035d092 # rewind to fork commit
$ make keyconv # ‘mingw32-make.exe keyconv’ for MSYS2
$ sudo install --strip keyconv /usr/local/bin # Linux
$ sudo install --strip keyconv /usr/local/bin # Linux, macOS
$ install --strip keyconv.exe /usr/local/bin # MSYS2
$ cd ..
```
@ -173,8 +173,8 @@ OpenEthereum package:
$ pacman -S openethereum
```
For 64-bit Windows and Linux systems, ‘ethkey’ can be found in the zip archives
distributed with [this release][oz].
For 64-bit Windows, Linux and macOS systems, ‘ethkey’ can be found in the zip
archives distributed with [this release][oz].
For other systems (i.e. Debian/Ubuntu ARM), tests involving ‘ethkey’ are skipped.

4
_Sidebar.md

@ -3,7 +3,7 @@
#### Download/Install
* [Install on Microsoft Windows][1]
* [Install on Debian, Ubuntu, Raspbian, Armbian or Arch Linux][2]
* [Install on Linux or macOS][2]
#### Using MMGen Wallet
@ -18,7 +18,7 @@
* [Tool API][11]
[1]: Install-MMGen-Wallet-on-Microsoft-Windows
[2]: Install-MMGen-Wallet-on-Linux
[2]: Install-MMGen-Wallet-on-Linux-or-macOS
[3]: Getting-Started-with-MMGen-Wallet
[4]: MMGen-Wallet-Quick-Start-with-Regtest-Mode
[5]: MMGen-command-help

2
command-help-addrgen.md

@ -115,5 +115,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-ADDRGEN(1)
MMGEN v15.0.0 September 2024 MMGEN-ADDRGEN(1)
```

2
command-help-addrimport.md

@ -31,5 +31,5 @@
It’s recommended to use ‘--rpc-backend=aio’ with ‘--rescan’.
MMGEN v14.1.0 July 2024 MMGEN-ADDRIMPORT(1)
MMGEN v15.0.0 September 2024 MMGEN-ADDRIMPORT(1)
```

35
command-help-autosign.md

@ -13,6 +13,11 @@
-M, --mnemonic-fmt F During setup, prompt for mnemonic seed phrase of format
'F' (choices: 'mmgen','bip39'; default: 'mmgen')
-n, --no-summary Don’t print a transaction summary
-r, --macos-ramdisk-size S Set the size (in MB) of the ramdisk used to store
the offline signing wallet(s) on macOS machines. By
default, a runtime-calculated value will be used. This
option is of interest only for setups with unusually
large Monero wallets
-s, --stealth-led Stealth LED mode - signal busy and error only, and only
after successful authorization.
-S, --full-summary Print a full summary of each signed transaction after
@ -32,10 +37,19 @@
gen_key - generate the wallet encryption key and copy it to the removable
device mounted at mountpoint ‘/mnt/mmgen_autosign’ (as currently
configured)
setup - generate both wallet encryption key and temporary signing wallet
xmr_setup - set up temporary Monero signing wallets. This operation needn’t
be performed by the user directly in most cases, as Monero setup
is done by the ‘setup’ command when --xmrwallets is specified
setup - full setup: run ‘gen_key’ and create temporary signing wallet(s)
for all configured coins
xmr_setup - set up Monero temporary signing wallet(s). Not required during
normal operation: use ‘setup’ with --xmrwallets instead
macos_ramdisk_setup - set up the ramdisk used for storing the temporary signing
wallet(s) (macOS only). Required only when creating the wallet(s)
manually, without ‘setup’
macos_ramdisk_delete - delete the macOS ramdisk
disable_swap - disable disk swap to prevent potentially sensitive data in
volatile memory from being swapped to disk. Applicable only when
creating temporary signing wallet(s) manually, without ‘setup’
enable_swap - reenable disk swap. For testing only, should not be invoked in
a production environment
wait - start in loop mode: wait-mount-sign-unmount-wait
wipe_key - wipe the wallet encryption key on the removable device, making
signing transactions or stealing the user’s seed impossible.
@ -58,12 +72,13 @@
the status LED indicates whether the program is busy or in standby mode, i.e.
ready for device insertion or removal.
The removable device must have a partition labeled MMGEN_TX with a user-
writable root directory.
The removable device must have a partition with a filesystem labeled MMGEN_TX
and a user-writable root directory. For interoperability between OS-es, it’s
recommended to use the exFAT file system.
On both the signing and online machines the mountpoint ‘/mnt/mmgen_autosign’
(as currently configured) must exist and ‘/etc/fstab’ must contain the
following entry:
(as currently configured) must exist. Linux (not macOS) machines must have
an ‘/etc/fstab’ with the following entry:
LABEL=MMGEN_TX /mnt/mmgen_autosign auto noauto,user 0 0
@ -89,7 +104,7 @@
be created in this way and used for signing (note, however, that for XMR
operations only one wallet is supported).
Autosigning is currently available only on Linux-based platforms.
Autosigning is currently supported on Linux and macOS only.
SECURITY NOTE
@ -110,5 +125,5 @@
Always remember to power off the signing machine when your signing session
is over.
MMGEN v14.1.0 July 2024 MMGEN-AUTOSIGN(1)
MMGEN v15.0.0 September 2024 MMGEN-AUTOSIGN(1)
```

2
command-help-keygen.md

@ -120,5 +120,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-KEYGEN(1)
MMGEN v15.0.0 September 2024 MMGEN-KEYGEN(1)
```

2
command-help-msg.md

@ -104,5 +104,5 @@
Verify and display the exported JSON signature data:
$ mmgen-msg verify signatures.json
MMGEN v14.1.0 July 2024 MMGEN-MSG(1)
MMGEN v15.0.0 September 2024 MMGEN-MSG(1)
```

2
command-help-passchg.md

@ -52,5 +52,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-PASSCHG(1)
MMGEN v15.0.0 September 2024 MMGEN-PASSCHG(1)
```

2
command-help-passgen.md

@ -100,5 +100,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-PASSGEN(1)
MMGEN v15.0.0 September 2024 MMGEN-PASSGEN(1)
```

2
command-help-regtest.md

@ -25,5 +25,5 @@
wallet_cli - execute a wallet RPC call with supplied arguments (wallet
is first argument)
MMGEN v14.1.0 July 2024 MMGEN-REGTEST(1)
MMGEN v15.0.0 September 2024 MMGEN-REGTEST(1)
```

2
command-help-seedjoin.md

@ -61,5 +61,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-SEEDJOIN(1)
MMGEN v15.0.0 September 2024 MMGEN-SEEDJOIN(1)
```

2
command-help-seedsplit.md

@ -143,5 +143,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-SEEDSPLIT(1)
MMGEN v15.0.0 September 2024 MMGEN-SEEDSPLIT(1)
```

2
command-help-subwalletgen.md

@ -96,5 +96,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-SUBWALLETGEN(1)
MMGEN v15.0.0 September 2024 MMGEN-SUBWALLETGEN(1)
```

2
command-help-tool(detail).md

@ -1240,5 +1240,5 @@ Optional KEYWORD ARGS (type and default value shown in square brackets):
```
```text
MMGEN v14.1.0 July 2024 MMGEN-TOOL(DETAIL)(1)
MMGEN v15.0.0 September 2024 MMGEN-TOOL(DETAIL)(1)
```

2
command-help-tool(usage).md

@ -187,5 +187,5 @@ EXAMPLES:
Same as above, but supply input via STDIN:
$ echo "deadbeefcafe" | mmgen-tool hexreverse -
MMGEN v14.1.0 July 2024 MMGEN-TOOL(USAGE)(1)
MMGEN v15.0.0 September 2024 MMGEN-TOOL(USAGE)(1)
```

2
command-help-tool.md

@ -198,5 +198,5 @@
Type ‘mmgen-tool help <command>’ for help on a particular command
MMGEN v14.1.0 July 2024 MMGEN-TOOL(1)
MMGEN v15.0.0 September 2024 MMGEN-TOOL(1)
```

2
command-help-txbump.md

@ -94,5 +94,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-TXBUMP(1)
MMGEN v15.0.0 September 2024 MMGEN-TXBUMP(1)
```

2
command-help-txcreate.md

@ -102,5 +102,5 @@
$ mmgen-txcreate S
MMGEN v14.1.0 July 2024 MMGEN-TXCREATE(1)
MMGEN v15.0.0 September 2024 MMGEN-TXCREATE(1)
```

2
command-help-txdo.md

@ -165,5 +165,5 @@
$ mmgen-txdo S
MMGEN v14.1.0 July 2024 MMGEN-TXDO(1)
MMGEN v15.0.0 September 2024 MMGEN-TXDO(1)
```

2
command-help-txsend.md

@ -18,5 +18,5 @@
-v, --verbose Be more verbose
-y, --yes Answer 'yes' to prompts, suppress non-essential output
MMGEN v14.1.0 July 2024 MMGEN-TXSEND(1)
MMGEN v15.0.0 September 2024 MMGEN-TXSEND(1)
```

2
command-help-txsign.md

@ -79,5 +79,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-TXSIGN(1)
MMGEN v15.0.0 September 2024 MMGEN-TXSIGN(1)
```

2
command-help-walletchk.md

@ -50,5 +50,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-WALLETCHK(1)
MMGEN v15.0.0 September 2024 MMGEN-WALLETCHK(1)
```

2
command-help-walletconv.md

@ -61,5 +61,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-WALLETCONV(1)
MMGEN v15.0.0 September 2024 MMGEN-WALLETCONV(1)
```

2
command-help-walletgen.md

@ -53,5 +53,5 @@
MMGenWallet .mmdat wallet,w
PlainHexSeedFile .hex hex,rawhex,plainhex
MMGEN v14.1.0 July 2024 MMGEN-WALLETGEN(1)
MMGEN v15.0.0 September 2024 MMGEN-WALLETGEN(1)
```

2
command-help-xmrwallet.md

@ -500,5 +500,5 @@
to delete your old hot wallets, make sure to do so securely using ‘shred’,
‘wipe’ or some other secure deletion utility.
MMGEN v14.1.0 July 2024 MMGEN-XMRWALLET(1)
MMGEN v15.0.0 September 2024 MMGEN-XMRWALLET(1)
```