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.

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

Man pages for witness_node and cli_wallet #2000

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

Conversation

oxarbitrage
Copy link
Member

  • Added \n\nOptions to the app options in order for the created man to put the options in the OPTIONS section instead of the DESCRIPTION section like it is doing without this addition.

More info can be found at: https://github.com/oxarbitrage/documentation/blob/master/bitshares_man_pages.md

That page will probably need to be moved to the wiki if we go forward with this.

\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)

@@ -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.

@@ -0,0 +1,423 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH WITNESS_NODE "1" "September 2019" "witness_node 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.

See above.

here, each number is a group, number 1
means 0.01%.
.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 version info (5 lines)

missions_by_recipient to set max limit
value
.PP
witness plugin. <no description>
Copy link
Contributor

Choose a reason for hiding this comment

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

Section headers should be bold and left-aligned IMO.

(e.g. "1.6.5", quotes are required, may
specify multiple times)
.TP
\fB\-\-private\-key\fR arg (=["BTS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV","5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3"])
Copy link
Contributor

Choose a reason for hiding this comment

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

The default value gets wrapped awfully, with a dash in the middle of the key.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants