You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
wowlet/src/assets/wowlet.1.md

112 lines
3.2 KiB

3 years ago
% WOWLET(1) wowlet 1.0
3 years ago
% WOWlet
3 years ago
% March 2021
# NAME
3 years ago
wowlet — Lightweight Wownero Wallet
3 years ago
# SYNOPSIS
3 years ago
**wowlet** [*OPTION*]
3 years ago
# DESCRIPTION
3 years ago
**WOWlet** is a free, open-source Wownero desktop wallet for Linux with ports for Mac OS and Windows.
3 years ago
# Options
3 years ago
3 years ago
**-h**, **\--help**
3 years ago
3 years ago
: Displays usage information.
3 years ago
3 years ago
**-v**, **\--version**
3 years ago
3 years ago
: Displays the current version number.
3 years ago
3 years ago
**\--use-local-tor**
3 years ago
3 years ago
: Use system wide installed Tor instead of the bundled.
3 years ago
3 years ago
**\--tor-port**
3 years ago
3 years ago
: Port of running Tor instance.
3 years ago
3 years ago
**\--debug**
3 years ago
3 years ago
: Run program in debug mode.
3 years ago
3 years ago
**\--quiet**
3 years ago
3 years ago
: Limit console output.
3 years ago
3 years ago
**\--use-local-tor**
3 years ago
3 years ago
: Use system wide installed Tor instead of the bundled.
3 years ago
3 years ago
**\--stagenet**
3 years ago
: Stagenet is for development purposes only.
3 years ago
3 years ago
**\--testnet**
3 years ago
3 years ago
: Testnet is for development purposes only.
3 years ago
3 years ago
**\--wallet-file**
3 years ago
3 years ago
: Path to wallet keys file.
3 years ago
3 years ago
**\--password**
3 years ago
3 years ago
: Wallet password (escape/quote as needed).
3 years ago
3 years ago
**\--daemon-address**
3 years ago
3 years ago
: Daemon address (IPv4:port).
3 years ago
3 years ago
**\--export-contacts**
3 years ago
3 years ago
: Output wallet contacts as CSV to specified path.
3 years ago
3 years ago
**\--export-txhistory**
3 years ago
3 years ago
: Output wallet transaction history as CSV to specified path.
3 years ago
3 years ago
**\--daemon**
3 years ago
3 years ago
: Start wowlet in the background and start a websocket server (IPv4:port).
3 years ago
3 years ago
**\--daemon-password**
3 years ago
3 years ago
: Password for connecting to the wowlet websocket service.
3 years ago
# EXAMPLES
3 years ago
3 years ago
**wowlet -v | \--version**
3 years ago
3 years ago
: Displays software version and then exits.
3 years ago
3 years ago
**wowlet -h | \--help**
3 years ago
3 years ago
: Displays software usage information and then exits.
3 years ago
3 years ago
**wowlet \--daemon 127.0.0.1:1234 \--daemon-password "sekrit"**
3 years ago
3 years ago
: Wallet starts in the background and exposes a websocket port that you can connect to using a websocket client.
3 years ago
# BUGS
3 years ago
See Git Issues: <https://git.wownero.com/wowlet/wowlet/issues>
3 years ago
# COPYRIGHT
3 years ago
(c) 2020-2021 The Monero Project.
3 years ago
3 years ago
License: BSD-3-clause. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
3 years ago
3 years ago
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3 years ago
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.