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

QOL: Update man pages, core documentation #2

Open
omeh-a opened this issue Feb 24, 2023 · 1 comment
Open

QOL: Update man pages, core documentation #2

omeh-a opened this issue Feb 24, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@omeh-a
Copy link
Member

omeh-a commented Feb 24, 2023

Currently, manual pages and main documentation wholly omit many important details about how to use ipbench or how it works. The most critical omission is a simple "new users" guide - currently it is very very difficult to figure out how to use ipbench without speaking to somebody who has used it already.

There is also a need for more developer-oriented documentation - guides for how to interact with clients over Telnet for example.

@omeh-a omeh-a added the documentation Improvements or additions to documentation label Feb 24, 2023
@TheEarthlord
Copy link
Contributor

#25 Man pages describing arguments with more precision, ipbench man page gives a short overview of suite structure.
#33 Describing use of xml for configuring the controller in ipbench man page.
#35 Describing commands to interact with ipbenchd via telent in ipbenchd man page.

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

No branches or pull requests

2 participants