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

create documentation for zfs-toolbox #16

Open
igeo opened this issue Dec 4, 2012 · 1 comment
Open

create documentation for zfs-toolbox #16

igeo opened this issue Dec 4, 2012 · 1 comment

Comments

@igeo
Copy link

igeo commented Dec 4, 2012

I think a basic documentation is needed for people to use this toolbox. Currently, a user has to read the code to see the usage and figure out the behavior by reverse engineering.
Thanks

@joelweinberger
Copy link
Collaborator

That's a great point, and we definitely want to do that. For now, each of the scripts does have a help flag ("-h" or "--help") that gives the usage and some basic help information, but we definitely ought to create more comprehensive documentation at some point.

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

No branches or pull requests

2 participants