search

Canop / dysk

A linux utility to get information on filesystems, like df but better
https://dystroy.org/dysk
MIT License
890 stars 25 forks source link

lfs needs a man page #45

Closed lemmy04 closed 1 year ago

lemmy04 commented 2 years ago

please create a manpage

separated out from #39

werdahias commented 1 year ago

If someone could provide me with all options for lfs I could work up a draft. I am working towards getting lfs into debian.

Canop commented 1 year ago

The list of options is available with lfs --help but for this page to be useful you'd need to add at least the examples that can be found on https://dystroy.org/lfs/

werdahias commented 1 year ago

Ok, I'll look into it

Canop commented 1 year ago

Do you suggest lfs installs the man page, that a script be provided for that, or just to have the man page bundled with lfs ?

heitorPB commented 1 year ago

Can the man page be generated by Cargo at build time?

werdahias commented 1 year ago

iirc clap mangen can do that

Canop commented 1 year ago

@heitorPB lfs currently uses the argh library to manage its launch arguments. I don't think it supports man page generation. Regarding clap, that I use on other projects, I don't know how good it is to build interesting man pages with examples.

werdahias commented 1 year ago

@Canop I'd wite a manpage to be shipped with the debian package since that is required. You could use it however you see fit

werdahias commented 1 year ago

fyi: implementation with man:

https://github.com/dropbox/rust-brotli/pull/81/files