📚 Install manpages automatically

zdharma-continuum / zinit

🌻 Flexible and fast ZSH plugin manager

MIT License

2.77k stars 122 forks source link

📚 Install manpages automatically #63

Open pschmitt opened 2 years ago

pschmitt commented 2 years ago

Following #12 it now makes sense to have zinit automatically detect manages in plugins and symlink them to ZPX/man/man[1-9].

This leads the creation of a new ice nomanpages to explicitly disable that behavior (analogue to nocompletions)

TODOs:

[ ] zinit detects manpages if there is a myplugin.1 file in the root of the repo
[ ] Alternative paths get searched as well such as man/myplugin.1 or doc/man1/myplugin.1
[ ] no manpage gets symlinked if nomanpage is used

ryaminal commented 2 years ago

i was thinking about starting work on this. wondering if there are thoughts if this belongs in zinit or as an annex? i'm leaning towards an annex but thought i'd ask.

pschmitt commented 2 years ago

I'd rather implement this in zinit rather than an annex. Zinit already creates the mandir and requiring an annex to simply do a cp *.1 $ZINIT[MAN_DIR] seems a bit overkill to me.

alichtman commented 2 years ago

Agreed: manpage management should probably belong in zinit itself.