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

[Feature request] Add a manpage #252

Closed
werdahias opened this issue Jan 10, 2023 · 9 comments · May be fixed by #257
Closed

[Feature request] Add a manpage #252

werdahias opened this issue Jan 10, 2023 · 9 comments · May be fixed by #257

Comments

@werdahias
Copy link

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.

@orf
Copy link
Owner

orf commented Jan 10, 2023

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
Copy link
Author

I'll work on it tomorrow

@werdahias
Copy link
Author

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

@werdahias
Copy link
Author

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.

@orf
Copy link
Owner

orf commented Jan 11, 2023

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!

@werdahias
Copy link
Author

see #253

@ChrissoChrisso
Copy link

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.

@orf
Copy link
Owner

orf commented Jan 17, 2023

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

@orf orf closed this as completed Jan 17, 2023
@orf
Copy link
Owner

orf commented Jun 2, 2023

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

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 a pull request may close this issue.

3 participants