Browse Source

add man page

pull/29/head
wowario 4 months ago
parent
commit
718741b036
Signed by: wowario GPG Key ID: 24DCBE762DE9C111
  1. 28
      HACKING.md
  2. BIN
      src/assets/wowlet.1.gz
  3. 111
      src/assets/wowlet.1.md

28
HACKING.md

@ -1,17 +1,25 @@
# Documentation for developers
Feather is developed primarily on Linux. It uses Qt 5.15.* and chances are that your
WOWlet is developed primarily on Linux. It uses Qt 5.15.* and chances are that your
distro's package manager has a lower version. It is therefore recommended that you install
Qt manually using the online installer, which can be found here: https://www.qt.io/download
(under open-source).
## Jetbrains Clion
Feather was developed using JetBrains Clion since it integrates nicely
WOWlet was developed using JetBrains Clion since it integrates nicely
with CMake and comes with a built-in debugger. To pass CMake flags to CLion,
go to `File->Settings->Build->CMake`, set Build Type to `Debug` and set your
preferred CMake options/definitions.
## Man Page
There is a WOWlet's manual page, which can be accessed with: `man wowlet`
If a new option is introduced, please be sure to update the options section in
`src/assets/wowlet.1.md`, the month and year in line 3, and "manify" the document
by running this command: `pandoc wowlet.1.md -s -t man -o wowlet.1 && gzip wowlet.1`
## Requirements
### Ubuntu/Debian
@ -33,16 +41,16 @@ protobuf libgcrypt qrencode ccache cmake pkgconfig git
## CMake
After installing Qt you might have a folder called `/home/$user/Qt/`. You need to pass this to CMake
via the `CMAKE_PREFIX_PATH` definition. For me this is:
via the `CMAKE_PREFIX_PATH` definition.
```
-DCMAKE_PREFIX_PATH=/home/dsc/QtNew/5.15.0/gcc_64
-DCMAKE_PREFIX_PATH=/home/$user/QtNew/5.15.0/gcc_64
```
There are some Monero/Feather related options/definitions that you may pass:
There are some Wownero/WOWlet related options/definitions that you may pass:
- `-DXMRIG=OFF` - disable XMRig feature
- `-DTOR_BIN=/path/to/tor` - Embed a Tor executable inside Feather
- `-DTOR_BIN=/path/to/tor` - Embed a Tor executable inside WOWlet
- `-DDONATE_BEG=OFF` - disable the dreaded donate requests
And:
@ -74,9 +82,9 @@ Enable debugging symbols:
-DCMAKE_BUILD_TYPE=Debug
```
## Feather
## Wowlet
It's best to install Tor locally as a service and start Feather with `--use-local-tor`, this
It's best to install Tor locally as a service and start `wowlet` with `--use-local-tor`, this
prevents the child process from starting up and saves time.
#### Ubuntu/Debian
@ -96,9 +104,9 @@ brew services start tor
To skip the wizards and open a wallet directly use `--wallet-file`:
```bash
./feather --use-local-tor --wallet-file /home/user/Monero/wallets/bla.keys
./wowlet --use-local-tor --wallet-file /home/user/Wownero/wallets/bla.keys
```
It is recommended that you use `--stagenet` for development. Testnet is also possible,
but you'll have to provide Feather a testnet node of your own.
but you'll have to provide Wownero a testnet node of your own.

BIN
src/assets/wowlet.1.gz

111
src/assets/wowlet.1.md

@ -0,0 +1,111 @@
% WOWLET(1) wowlet 1.0
% WOWlet
% March 2021
# NAME
wowlet — Lightweight Wownero Wallet
# SYNOPSIS
**wowlet** [*OPTION*]
# DESCRIPTION
**WOWlet** is a free, open-source Wownero desktop wallet for Linux with ports for Mac OS and Windows.
# Options
**-h**, **\--help**
: Displays usage information.
**-v**, **\--version**
: Displays the current version number.
**\--use-local-tor**
: Use system wide installed Tor instead of the bundled.
**\--tor-port**
: Port of running Tor instance.
**\--debug**
: Run program in debug mode.
**\--quiet**
: Limit console output.
**\--use-local-tor**
: Use system wide installed Tor instead of the bundled.
**\--stagenet**
: Stagenet is for development purposes only.
**\--testnet**
: Testnet is for development purposes only.
**\--wallet-file**
: Path to wallet keys file.
**\--password**
: Wallet password (escape/quote as needed).
**\--daemon-address**
: Daemon address (IPv4:port).
**\--export-contacts**
: Output wallet contacts as CSV to specified path.
**\--export-txhistory**
: Output wallet transaction history as CSV to specified path.
**\--daemon**
: Start wowlet in the background and start a websocket server (IPv4:port).
**\--daemon-password**
: Password for connecting to the wowlet websocket service.
# EXAMPLES
**wowlet -v | \--version**
: Displays software version and then exits.
**wowlet -h | \--help**
: Displays software usage information and then exits.
**wowlet \--daemon 127.0.0.1:1234 \--daemon-password "sekrit"**
: Wallet starts in the background and exposes a websocket port that you can connect to using a websocket client.
# BUGS
See Git Issues: <https://git.wownero.com/wowlet/wowlet/issues>
# COPYRIGHT
(c) 2020-2021 The Monero Project.
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:
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. 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.
Loading…
Cancel
Save