Makefile should install the man page

[yurivict]

No description provided.

[rofl0r]

which manpage ?

[yurivict]

docs/reaver.1.gz

[soxrok2212]

The manpage is severely outdated. Will need to be updated beforehand.

[rofl0r]

i don't intend to maintain it. do you ? if not, let's just remove it.

[soxrok2212]

It is not my priority right now. Perhaps @kcdtv wants to take on the task.

Also, the help menu and wiki gives more than enough information.

[yurivict]

I can't maintain random manpages.
But it's certainly nice to have them.

[rofl0r]

oh, you can speak ? :)

i agree it's nice, but in case of reaver its just a copy of output of ./reaver --help. any place where it is duplicated represents a maintainance burden, i'm already unhappy about having the output duplicated in the README.

[rofl0r]

thinking of it, we may make it an empty manpage which says "run reaver --help to see possible options". that would be acceptable. but it is really helpful ?

[yurivict]

No, it should be either meaningfully maintained, or removed.

[yurivict]

As a comparison, jq https://github.com/stedolan/jq prints the brief usage explanation with --help, and has a detailed documentation in its man page.
Or you can just maintain a man page and print the same text when it is called with --help.

[kcdtv]

Hi!
I personally like the fact to have the options in shell when I execute an incorrect command line; I would not change that.
I don't have neither a lot of time to dedicate to that but I think that it is a good idea to have an up to date man page.
So I propose myself to do it (slowly. there is no hurry for that, isn't it?)

[kcdtv]

@ sox: And you are "assigned" to (for?at?) spelling and grammar check... 😺

[kcdtv]

I've checked a little and that is my proposal:
I will update README.REAVER and READEME.WASH which are perfects to be used as a man page for each tool.
So we keep things as they are until the updating is done and than we introduce man reaver and man wash displaying the specific readme from the tool called.
I do not see any advantage in creating a short and a long version of the actual option stdout in shell.
Let's keep it simple and do not overthink it. We just add a good man page as we agree that is a good idea.

[rofl0r]

ok, so can it be removed for now ? btw: your links above are both 404

[soxrok2212]

I don't think they are meant to be links. I'll check over grammar 👍

[rofl0r]

oh, i didn't get this point of @kctdv earlier:

So we keep things as they are until the updating is done and than we introduce man reaver and man wash displaying the specific readme from the tool called.

you can't just use a textfile or .md file as manpage, manpages need to be written in a special format called nroff. some projects generate the manpage at make time using a tool from text input, but i think that is overkill - i actually hate that behaviour since most of the time those tools have a shit-load of dependencies, and not having it installed will make your build fail. example is tinyproxy which requires a2x tool from asciidoc.

[rofl0r]

i unpacked the manpage so one can actually take a look at its anatomy and content. https://github.com/t6x/reaver-wps-fork-t6x/blob/8ba3acbff2593616e5a05155bee7553a30c10c1f/docs/reaver.1

as one can see, this format is quite odd and maintaining it by hand requires extensive study of the nroff format.

[kcdtv]

Thanks for your explanations. That is more work than what I thought with this very weird "mise-en- page"...

[nuncan]

Honestly, lets not roll out a manpage, this is free software, and if bugs exists those should take priority. Not to mention this tool is famous, google can resolve questions, and if that isnt enough theres the help flag and if you still cant figure it out. Clone it down and read it, its not Chinese, its well structured with good naming conventions.

Plus is keeps the 12 year olds from getting in trouble