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

What should be expected behavior of --html builtin option ? #850

Closed
siteshwar opened this issue Sep 9, 2018 · 3 comments
Closed

What should be expected behavior of --html builtin option ? #850

siteshwar opened this issue Sep 9, 2018 · 3 comments

Comments

@siteshwar
Copy link
Contributor

All builtins support --html option that outputs a html help page on terminal. This is not very helpful. I would expect it to automatically show help page in browser. We need something similar to what fish does with help command. Comments ?

@krader1961
Copy link
Contributor

I concur. Having an option to emit HTML output is borderline useless and greatly complicates the getopt() implementation. It's one of the reasons I'd like to see the documentation switched to something like Sphinx. Producing a HTML version of the documentation should be done at build time not run time. See #507.

@krader1961
Copy link
Contributor

Any reason not to close this as a dup of #507? Once we resolve that issue we will be able to automatically generate a HTML version of each command's documentation. Which can then be used by a hypothetical help command such as the fish implementation. I also want to see the DocOpt based documentation/flag parsing via optget() replaced with the borg standard getopt_long() so that we can eliminate the src/lib/libast/misc/optget.c module.

@krader1961 krader1961 added duplicate and removed RFC labels Aug 23, 2019
@krader1961
Copy link
Contributor

Once we extricate the documentation from the source and switch to a more modern markup language this becomes moot. So closing as a duplicate of #507.

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

No branches or pull requests

2 participants