Repository navigation
Have man papis page contain something in it, hopefully to lead into config options #1096
Description
Hi I have a suggestion to make after noticing myself expect certain things:
- I needed to check a certain papis setting
- Instinct: run
man papisand start searching - Friction:
No manual entry for papis- What I wanted was instead
man papis-config-settingsbut this is very hard to figure out
- What I wanted was instead
I understand that the manpages are auto-generated from our docs, and that generally works pretty well.
Would it make sense to make man papis lead directly to papis-config-settings manpage (or be a copy of it)?
Activity
tuurep commentedon Nov 11, 2025
I've also seen this convention of placing man pages about configs in section 5, like:
dunst(5)which is accessed byman 5 dunstSome discussion about that: https://unix.stackexchange.com/a/736087
What do you think of
papis(5)as a copy ofpapis-config-settings?tuurep commentedon Nov 11, 2025
Oh yeah,
papis-defaultis the one for the main command,papis, in a sense.Suggestion (if we have control over these things):
man papis=>man papis-defaultman 5 papis=>man papis-config-settingsalexfikl commentedon Nov 11, 2025
You should be able to get some good results there with a bit of work. You can add text only to the man pages in the rst docs using
so that they link better to each other. You can also add them to more appropriate sections using https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-man_pages. They're currently all added to section 1 in here:
papis/doc/source/conf.py
Lines 280 to 289 in cecfc53
Section 7 should also be more appropriate for the library structure description and whatnot.
tuurep commentedon Nov 11, 2025
That sounds promising, thanks
I'll get to it at some point :)