Updated manpage to resolve Issue #58

README.md

@@ -146,23 +146,21 @@ what you give to `--grpc-bin-addr` .
 
 These are some of the most used command line options for lightwalletd:
 
-
-| CLI option | Default                   | What it does                  |
-|------------|:--------------:|------------------------------:|
+| CLI option       | Default        | What it does                  |
+|------------------|:--------------:|------------------------------:|
 | --grpc-bind-addr | 127.0.0.1:9067 | address and port to listen on via GRPC |
 | --http-bind-addr | 127.0.0.1:9068 | address and port to listen on vi HTTP |
-| --tls-cert  | blank             | the path to a TLS certificate |
-| --tls-key   | blank             | the path to a TLS key file    |
-| --no-tls    | false             | Disable TLS, serve un-encrypted traffic |
-| --data-dir  | /var/lib/lightwalletd | Sets the lightwalletd data directory |
-| --log-file  | blank             | log file to write to                  |
-| --log-level | logrus.InfoLevel | log level 1 thru 7 (something from logrus)|
-| --hush-conf-path | blank             | conf file to pull RPC creds from |
-| --cache-size| 40000             | number of blocks to hold in the cache |
-| --rpcport   | 18031             | RPC port                         |
-
-
-Run `./lightwalletd --help` to see all options.
+| --tls-cert       | blank          | the path to a TLS certificate |
+| --tls-key        | blank          | the path to a TLS key file    |
+| --no-tls         | false          | Disable TLS, serve un-encrypted traffic |
+| --data-dir       | /var/lib/lightwalletd | Sets the lightwalletd data directory |
+| --log-file       | blank          | log file to write to          |
+| --log-level      | logrus.InfoLevel | log level 1 thru 7 (something from logrus) |
+| --hush-conf-path | blank          | conf file to pull RPC creds from |
+| --rpcport        | 18031          | RPC port                      |
+| version          | n/a            | Display lightwalletd version  |
+
+Run `./lightwalletd --help` or `./lightwalletd help` to see all options.
 
 ## Developing
 

doc/man/lightwalletd.1

@@ -1,4 +1,4 @@
-.TH LIGHTWALLET "1" "June 2023" "lightwalletd v0.1.3" "User Commands"
+.TH LIGHTWALLETD "1" "May 2024" "lightwalletd v0.1.3" "User Commands"
 .SH NAME
 lightwalletd \- manual page for hush lightwalletd v0.1.3
 .SH DESCRIPTION
@@ -12,60 +12,103 @@ please see <https://hush.is/security/>.
 .B lightwalletd [options]
 Start Hush lightwalletd
 .TP
-lightwalletd --help
+lightwalletd completion
+Generate the autocompletion script for the specified shell
+.TP
+lightwalletd help
 List available command line options
 .TP
-lightwalletd --version
+lightwalletd version
 Display version information
 .SH OPTIONS
 .HP
-\fB\-help | -h | -?
+\fB\--help | help | -h | -?
 .IP
 Display command line options
 .HP
-\fB\--hush-conf-path\fR [conf_file location]
+\fB\--config \fRstring
+.IP
+Configure your lightwalletd config file location (default is current directory, lightwalletd.yaml)
+.HP
+\fB\--data-dir \fR [location]
 .IP
-Configures your HUSH3.conf file location to pull RPC creds from (default "./HUSH3.conf")
+Configure your lightwalletd data directory (such as db) (default "/var/lib/lightwalletd")
 .HP
-\fB\--data-dir\fR [location]
+\fB\--gen-cert-very-insecure
 .IP
-Configures your lightwalletd data directory (such as db) (default "/var/lib/lightwalletd")
+Configure lightwalled to run with a self-signed TLS certificate. ONLY do this for debugging & DO NOT use in production!
 .HP
 \fB\--grpc-bind-addr \fRlocalhost:chosen_port
 .IP
-The address to listen for grpc on (default "localhost:9067")
+Configure the address and port to listen for grpc on (default "localhost:9067")
+.HP
+\fB\--grpc-logging-insecure
+.IP
+Configure lightwalled to enable grpc logging to stderr
+.HP
+\fB\--http-bind-addr \fRstring
+.IP
+Configure the address and port to listen for http on (default "localhost:9068")
+.HP
+\fB\--hush-conf-path\fR [conf_file location]
+.IP
+Configure your HUSH3.conf file location to pull RPC creds from (default "./HUSH3.conf")
+.HP
+\fB\--log-file \fRstring
+.IP
+Configure log file to write to (default "./server.log")
+.HP
+\fB\--log-level \fRint
+.IP
+Configure log level (logrus 1-7) (default 4)
 .HP
 \fB\--no-tls
 .IP
 Run without TLS, only safe if a reverse proxy like nginx does TLS on localhost.
 .HP
-\fB\--cache-size \fRint
+\fB\--ping-very-insecure
 .IP
-Set number of blocks to hold in the cache (default 40000)
+Configure lightwalled to allow Ping GRPC for testing.
 .HP
-\fB\--log-file \fRstring
+\fB\--redownload
+.IP
+Re-fetch all blocks from hushd; reinitialize local cache files
+.HP
+\fB\--rpchost \fRstring
+.IP
+Configure RPC host used.
+.HP
+\fB\--rpcpassword \fRstring
+.IP
+Configure RPC password used (default value used from HUSH3.conf)
+.HP
+\fB\--rpcport \fRstring
+.IP
+Configure RPC host port used (default value used from HUSH3.conf)
+.HP
+\fB\--rpcuser \fRstring
 .IP
-Set log file to write to
+Configure RPC username used (default value used from HUSH3.conf)
 .HP
-\fB\--log-level \fRuint
+\fB\--sync-from-height \fRint
 .IP
-log level (logrus 1-7) (default 4)
+Re-fetch blocks from hushd start at this height (default -1)
 .HP
 \fB\--tls-cert \fRstring
 .IP
-the path to a TLS certificate (optional)
+Configure the path to a TLS certificate (default "./cert.pem")
 .HP
 \fB\--tls-key \fRstring
 .IP
-the path to a TLS key file (optional)
+Configure the path to a TLS key file (default "./cert.key")
 
 .SH COPYRIGHT
 In order to ensure you are adequately protecting your privacy when using Hush,
 please see <https://hush.is/security/>.
 
-Copyright (C) 2021-2023 Jahway603 and The Hush Developers
+Copyright (C) 2021-2024 Jahway603 and The Hush Developers
 
 This is experimental Free Software! Fuck Yeah!!!!!
 
-Distributed under the GPLv3 software license, see the accompanying file COPYING
+Distributed under the GPLv3 software license, see the accompanying file LICENSE 
 or <https://www.gnu.org/licenses/gpl-3.0.en.html>.