ctuffli / smart

Application to output the SMART values of disks (mirror)
ISC License
12 stars 1 forks source link

Missing manual page for smart command #4

Closed cemeyer closed 3 years ago

cemeyer commented 5 years ago

It'd be good to provide and install a manual page documenting the options to the smart command.

ctuffli commented 5 years ago

Yup, fair request. I haven't really done a man page before so let me see if I can coax (trick?) one of the instigators of this code into making one. Failing that, "how hard could it be?"

cemeyer commented 5 years ago

It's pretty easy! I'd suggest starting from an example page from a similar type of program and then referencing the mdoc(7) page, which provides a high-level overview of typical sections and goes into the nitty gritty formatting details, as needed.

You can use man ./foo.N to do a visual check without installing the page, and the port textproc/igor is a useful manual page linter. Use like: igor ./foo.N.

ctuffli commented 3 years ago

After an embarrassingly long time, fixed with 87b9b30da24925ac220f25825fa66d22cb85dc42

cemeyer commented 3 years ago

Thanks!