https://rust-lang-nursery.github.io/cli-wg/ – tracking repo: https://github.com/rust-lang-nursery/cli-wg/issues
Hi all! I'm working on a simple CLI app and have gotten to writing the man(1) page for the app, so I'm looking for the current best way to do so. I found https://github.com/rust-clique/man ; is that the best option? I'm asking because it looks like that repo isn't that active—no commits in a couple of months, and the README example doesn't work (e.g., it uses the
.description method instead of the .help method in the code.
I also found https://rust-lang-nursery.github.io/cli-wg/in-depth/docs.html, which discusses rendering man pages from Clap, but that doesn't seem to be implemented (yet?)
I'd be happy to help out with the
man crate—it seems really cool and helpful (I'm a big fan of man pages for CLI apps!). But I don't want to spend time opening issues/PRs if the community or WG has moved on to a different solution
i'm at work right now, but we can talk later if you want, just ping me!
@killercup thanks for the reply. I'd be happy to help with the man crate! Just to be clear, though, it's not going to be depreciated when clap 3 has support for generating man pages, right? No sense on working on something that is about to be replaced/eliminated, after all
the internals of that might change drastically depending on what we want to do
(the roff crate for example is super simplistic right now)
@killercup Ok, cool. I've opened two issues and submitted one (minor) PR for
man (which, if merged, would close one of the issues). I'll probably wait a bit before getting started on the PR for the second issue to see if you/anyone else have other ideas for a good way to proceed.
@codesections hey, thanks for all the contributions to the man crate! the roff crate is pretty much just a POC so far, but @aoikonomopoulos_gitlab made an alternative impl some time ago: https://gitlab.com/aoikonomopoulos/rroff
if you're interested in working on a good roff crate and bring the design together, i'd love to add you as a contributor (and maybe move it to the clique github orga) :)
@codesections ah you need to explicitly accept the invitation it seems
What's the etiquette within CLIque for merging ones own PRs? I know some groups dislike that/want more code review but others like it to keep the pace of development up/avoid blockers
yes this is super informal and boils down to: best just have a quick chat about it and then get coding :)
:) Sounds about right to me! I think though, that at least in the short term, there's no a whole lot that
roff-rs needs to support the core work in man. So, unless anyone has particular features they'd like to see in roff-rs, I expect the majority of my time will be spent on man
It feels like
man is very close to being usable for most CLI apps (even if better integration with clap would be great in a post-clap-3.0.0 world)
(that reminds me to add the clique maintainers as owners of the crate on crates.io too. done)
Input has been super helpful; I love that it's active again; never saw it through to the end, so happy it's getting there ^_^
killercup @killercup is revising the CLIque 2019 roadmap to include "stick it to the
man"