Updated message

[killerfish]

Do you guys think we ought to have a command duckpan help?

[moollaza]

@killerfish I'm not sure we necessarily want to use duckpan --help -- that provides completely differnt output from our own help command.

Previously duckpan help would spit out text to STDOUT which came from the POD in bin/duckpan, separately there was man duckpan which I believe used different text. Then there's also duckpan --help which is automatically provided by GetOpt::Long to show the various commands and their options. Unfortunately, the duckpan --help output is useless because we haven't documented the functions for GetOpt::Long. Also, it's really designed to explain the arguments for that specific command rather than all the options available.

i.e. duckpan --help and duckpan server --help output different things, highlighting the available params for each command

That stuff aside, having a duckpan help command doesn't hinder us at all so I think we might as well keep it. I just think the output needs to be useful and not get in your way. The man page text is great and detailed, but I feel there is a difference (or perhaps there should be) between a help command and reading a man page. Git is of course very complex, and the difference between git help and man git is quite clear. What's neat is that git log -h prints a few lines to STDOUT but git log --help goes to the man page. All that amounts to a ton of repeated documentation IMO though...

For the most part, DuckPAN isn't really that complicated and devs don't have many options/arguments to worry about (-v is about the only thing they'd need?) so perhaps there isn't much need for a man page, but the info we have in there still needs to be easily accessible.

[moollaza]

I had made some related issues about this stuff a long time ago: #41 #18

[killerfish]

@moollaza can you verify that the help command works for you?

[killerfish]

Issue was that duckpan help wasnt working, and it gave this output
[ERROR] Unknown command. Use duckpan help to see the list of available DuckPAN commands. So i thought perhaps the intention was to use --help. Looking at the earlier commits, i see that due to changes in #161, we removed this line which triggered help regardless of the command. We dont actually have a command help, going to add it, we can scrap this pr.

[moollaza]

@killerfish duckpan help does work as expected for me -- it displays the POD in bin/duckpan, the output is identical to man duckpan