Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

5 pantalaimon filename is worng #134

Open
Thaodan opened this issue Jul 10, 2022 · 2 comments
Open

5 pantalaimon filename is worng #134

Thaodan opened this issue Jul 10, 2022 · 2 comments

Comments

@Thaodan
Copy link

Thaodan commented Jul 10, 2022

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
Copy link
Author

Thaodan commented Jul 10, 2022

This a regression comes from 1faa787.

@poljar
Copy link
Collaborator

poljar commented Sep 12, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants