[Feature request] Add a manpage

Question

[Feature request] Add a manpage

werdahias opened this issue 2 years ago · comments

Hi,
I'm just waiting for the clapv4 migration to finalize the gping debian package. Since it is a cli program a manpage would make sense. It could life at the root of the project (and installed from there during the build of the package). I can have a stab at it; it would be nice to have one for gping.

werdahias commented 2 years ago

see #253

Tom Forbes · Answer 1 · Wed Jan 11 2023 03:24:55 GMT+0800 (China Standard Time)

Hey! I'm ok with adding a manpage, but I personally don't use them and wouldn't know where to start when adding one.

I'm more than happy to accept even a half-baked manpage from you, to get us started?

werdahias · Answer 2 · Wed Jan 11 2023 06:34:53 GMT+0800 (China Standard Time)

I'll work on it tomorrow

werdahias · Answer 3 · Wed Jan 11 2023 18:32:38 GMT+0800 (China Standard Time)

There is clap_mangen which supposedly makes it very easy to generate it from the source code.

werdahias · Answer 4 · Thu Jan 12 2023 01:22:07 GMT+0800 (China Standard Time)

This is my draft: manpage.md
I'm not sure what values --interface takes. Also please think about generating it with clap-mangen (or similar crates) in case the options/syntax/whatever changes.

Tom Forbes · Answer 5 · Thu Jan 12 2023 01:43:38 GMT+0800 (China Standard Time)

Thank you! If you could create a pull request with that, I'll approve and merge it now. I have a release that's coming out soon as well.

I can automate the manpage at a later date, thank you for the research!

ChrissoChrisso · Answer 6 · Wed Jan 18 2023 03:19:32 GMT+0800 (China Standard Time)

I checked the draft and have an enhancement request for it. Can definitions for the abbreviations in gping's output be added to the manpage?

Asking because it would clear up any uncertainties or misunderstandings about what each field in indicating.

(Initially I was unsure about what the p95 and t/o fields are indicating, but now after googling I assume p95 to mean 95% of ping times have lower latency than the reported p95 time, and that t/o is the number of pings that have timed out since the graph started.)
By the way this is a awesome app!! Thank you.

Tom Forbes · Answer 7 · Wed Jan 18 2023 06:23:53 GMT+0800 (China Standard Time)

I tried to add clap-mangen in #257, but I'm not really happy with it. I'll try and revisit it.

With regards to adding t/o and p95 to the manpage, sure, but I'm not really sure how 😅. I'll take a look when I have time next week.

I'm going to close this for now as #253 is merged. thanks for the help @werdahias <3

Tom Forbes · Answer 8 · Sat Jun 03 2023 00:46:39 GMT+0800 (China Standard Time)

@werdahias is there any movement on the gping Debian package? Anything I can help with?