Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Man pages for witness_node and cli_wallet #2000

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Man pages for witness_node and cli_wallet #2000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions programs/cli_wallet/cli_wallet.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH CLI_WALLET "1" "September 2019" "cli_wallet 2.0.171025-minor-fix-1-2549-g991bd756" "User Commands"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, the version is wrong. And not nice.
I would like to avoid having to update this version manually in each release, and I'd like to avoid requiring help2man for the build. Perhaps build this optionally if help2man is available? Or rename to cli_wallet.1.in and have cmake replace the version at build time?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to avoid having to update this version manually in each release

I agree with this.

.SH NAME
cli_wallet - Start the bitshares command line wallet.
.SH SYNOPSIS
\fBcli_wallet\fR [OPTIONS]...
.SH DESCRIPTION
Command Line BitShares Wallet
.SH OPTIONS
.TP
\fB\-h\fR [ \fB\-\-help\fR ]
Print this help message and exit.
.TP
\fB\-s\fR [ \fB\-\-server\-rpc\-endpoint\fR ] [=arg(=ws://127.0.0.1:8090)]
Server websocket RPC endpoint
.TP
\fB\-u\fR [ \fB\-\-server\-rpc\-user\fR ] arg
Server Username
.TP
\fB\-p\fR [ \fB\-\-server\-rpc\-password\fR ] arg
Server Password
.TP
\fB\-r\fR [ \fB\-\-rpc\-endpoint\fR ] [=arg(=127.0.0.1:8091)]
Endpoint for wallet websocket RPC to
listen on (DEPRECATED, use
rpc\-http\-endpoint instead)
.TP
\fB\-t\fR [ \fB\-\-rpc\-tls\-endpoint\fR ] [=arg(=127.0.0.1:8092)]
Endpoint for wallet websocket TLS RPC
to listen on
.TP
\fB\-c\fR [ \fB\-\-rpc\-tls\-certificate\fR ] [=arg(=server.pem)]
PEM certificate for wallet websocket
TLS RPC
.TP
\fB\-H\fR [ \fB\-\-rpc\-http\-endpoint\fR ] [=arg(=127.0.0.1:8093)]
Endpoint for wallet HTTP and websocket
RPC to listen on
.TP
\fB\-d\fR [ \fB\-\-daemon\fR ]
Run the wallet in daemon mode
.TP
\fB\-w\fR [ \fB\-\-wallet\-file\fR ] [=arg(=wallet.json)]
wallet to load
.TP
\fB\-\-chain\-id\fR arg
chain ID to connect to
.TP
\fB\-\-suggest\-brain\-key\fR
Suggest a safe brain key to use for
creating your account
.TP
\fB\-\-logs\-rpc\-console\-level\fR arg (=info)
Level of console logging. Allowed
levels: info, debug, warn, error, all
.TP
\fB\-\-logs\-rpc\-file\fR arg (=0)
Turn on/off file logging
.TP
\fB\-\-logs\-rpc\-file\-level\fR arg (=debug)
Level of file logging. Allowed levels:
info, debug, warn, error, all
.TP
\fB\-\-logs\-rpc\-file\-name\fR arg (=rpc.log)
File name for file rpc logs
.TP
\fB\-v\fR [ \fB\-\-version\fR ]
Display version information
.PP
SHA: 991bd756d7db1cf6d790b11bff05f28e625f735a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the version info. (5 lines)

Timestamp: 35 hours ago
SSL: OpenSSL 1.1.1 11 Sep 2018
Boost: 1.65.1
Websocket++: 0.7.0
.SH AUTHOR
The BitShares Core Team and contributors.
.SH "REPORTING BUGS"
https://github.com/bitshares/bitshares-core/issues/
.SH COPYRIGHT

The MIT license.
15 changes: 15 additions & 0 deletions programs/cli_wallet/cli_wallet.h2m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[NAME]
cli_wallet - Start the bitshares command line wallet.

[SYNOPSIS]
\fBcli_wallet\fR [OPTIONS]...

[AUTHOR]
The BitShares Core Team and contributors.

[REPORTING BUGS]
https://github.com/bitshares/bitshares-core/issues/

[COPYRIGHT]

The MIT license.
2 changes: 1 addition & 1 deletion programs/cli_wallet/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ int main( int argc, char** argv )
{
try {

boost::program_options::options_description opts;
boost::program_options::options_description opts("Command Line BitShares Wallet\n\nOptions");
opts.add_options()
("help,h", "Print this help message and exit.")
("server-rpc-endpoint,s", bpo::value<string>()->implicit_value("ws://127.0.0.1:8090"), "Server websocket RPC endpoint")
Expand Down
2 changes: 1 addition & 1 deletion programs/witness_node/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ int main(int argc, char** argv) {
app::application* node = new app::application();
fc::oexception unhandled_exception;
try {
bpo::options_description app_options("BitShares Witness Node");
bpo::options_description app_options("BitShares Witness Node\n\nOptions");
bpo::options_description cfg_options("BitShares Witness Node");
app_options.add_options()
("help,h", "Print this help message and exit.")
Expand Down
Loading