Browse Source

man pages

duke
Duke Leto 3 years ago
parent
commit
9be07c1452
  1. 14
      contrib/devtools/gen-manpages.sh
  2. 8
      doc/man/hush-cli.1
  3. 8
      doc/man/hush-tx.1
  4. 10
      doc/man/hushd.1

14
contrib/devtools/gen-manpages.sh

@ -12,14 +12,16 @@ HUSHTX=${HUSHTX:-$SRCDIR/hush-tx}
[ ! -x $HUSHD ] && echo "$HUSHD not found or not executable." && exit 1
# TODO: this does not work correctly, when help2man is installed, it still fails
# Check if help2man is installed
# If not then display error to user and exit
if ! command -v help2man &> /dev/null
then
echo "help2man could not be found"
echo "Please install from your Linux package manager and try again"
exit
fi
#if ! command -v help2man &> /dev/null
#then
# echo "help2man could not be found"
# echo "Please install from your Linux package manager and try again"
# echo "On Debian-based systems you can do: apt-get install help2man"
# exit
#fi
# use this if hushd is not running
#HUSHVER="v3.6.2"

8
doc/man/hush-cli.1

@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
.TH HUSH-CLI "1" "March 2021" "hush-cli v3.7.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH HUSH-CLI "1" "April 2021" "hush-cli v3.7.1" "User Commands"
.SH NAME
hush-cli \- manual page for hush-cli v3.7.0
hush-cli \- manual page for hush-cli v3.7.1
.SH DESCRIPTION
Hush RPC client version v3.7.0\-af5f461d0
Hush RPC client version v3.7.1\-2da07fe58\-dirty
.PP
In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>.

8
doc/man/hush-tx.1

@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
.TH HUSH-TX "1" "March 2021" "hush-tx v3.7.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH HUSH-TX "1" "April 2021" "hush-tx v3.7.1" "User Commands"
.SH NAME
hush-tx \- manual page for hush-tx v3.7.0
hush-tx \- manual page for hush-tx v3.7.1
.SH DESCRIPTION
hush\-tx utility version v3.7.0\-af5f461d0
hush\-tx utility version v3.7.1\-2da07fe58\-dirty
.SS "Usage:"
.TP
hush\-tx [options] <hex\-tx> [commands]

10
doc/man/hushd.1

@ -1,9 +1,9 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
.TH HUSHD "1" "March 2021" "hushd v3.7.0" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.13.
.TH HUSHD "1" "April 2021" "hushd v3.7.1" "User Commands"
.SH NAME
hushd \- manual page for hushd v3.7.0
hushd \- manual page for hushd v3.7.1
.SH DESCRIPTION
Hush Daemon version v3.7.0\-af5f461d0
Hush Daemon version v3.7.1\-2da07fe58\-dirty
.PP
In order to ensure you are adequately protecting your privacy when using Hush,
please see <https://hush.is/security/>.
@ -556,7 +556,7 @@ multiple times
.HP
\fB\-rpcthreads=\fR<n>
.IP
Set the number of threads to service RPC calls (default: 4)
Set the number of threads to service RPC calls (default: 8)
.PP
Metrics Options (only if \fB\-daemon\fR and \fB\-printtoconsole\fR are not set):
.HP

Loading…
Cancel
Save