search

matrix-org / pantalaimon

E2EE aware proxy daemon for matrix clients.
Apache License 2.0
279 stars 41 forks source link

5 pantalaimon filename is worng #134

Open Thaodan opened 2 years ago

Thaodan commented 2 years ago

Describe the bug man 5 pantalaimon title is pantalaimon.conf but the filename doesn't match it's title.

To Reproduce Steps to reproduce the behavior:

  1. Run man 5 pantalamon

Expected behavior The mentioned page should be found as 5 pantalaimon.conf.

Thaodan commented 2 years ago

This a regression comes from https://github.com/matrix-org/pantalaimon/commit/1faa787090a44e1a30777b6188412788babb43eb.

poljar commented 1 year ago

Well kinda. Depends on the convention you are going to use. A bunch of tools nowadays use the convention to display the configuration of a user command (section 1) or daemons (section 8) using the configuration files section, section 5.

This is quite useful if you know the program you are using, i.e. pantalaimon, but don't know the name of the configuration file, the file has a generic name (config), or multiple files can be used to configure the program.

You can always find out how to configure the program using man 5 pantalaimon.

Of course there are prominent examples that aren't using this convention, the gold standard being the man pages for ssh. I think it would be quite nice if the man page to configure ssh could be found using man 5 ssh instead of man ssh_config.