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

man page: move "backintime-config (1)" into "backintime-config (5)" #1773

Open
buhtz opened this issue Jun 28, 2024 · 2 comments
Open

man page: move "backintime-config (1)" into "backintime-config (5)" #1773

buhtz opened this issue Jun 28, 2024 · 2 comments
Assignees
Labels
Discussion decision or consensus needed Documentation

Comments

@buhtz
Copy link
Member

buhtz commented Jun 28, 2024

The "backintime-config" man page describe the config file format for Back In Time. That man page lives in section 1 "Executable programs or shell commands" but should live in section 5 "File formats and conventions, e.g. /etc/passwd".
Also adapt the man page links in the other man pages.

See man man for details about man page sections.

I was searching the issues. Haven't we discussed this in the past?

I would say we don't need it but if someone is concerned about backwards compatibility we could add a backintime-config.1 man page just mention the movement to backintime-config.5.

See also #1772

@buhtz buhtz self-assigned this Jun 28, 2024
@buhtz buhtz added Documentation Discussion decision or consensus needed labels Jun 28, 2024
@buhtz buhtz added this to the 2nd release from now milestone Jun 28, 2024
@aryoda
Copy link
Contributor

aryoda commented Jun 28, 2024

I was searching the issues. Haven't we discussed this in the past?

Surprisingly not :-)

I would say we don't need it but if someone is concerned about backwards compatibility
we could add a backintime-config.1 man page just mention the movement to backintime-config.5

I am not concerned and think unless someone explicitly uses the man page section number to search for man pages (and therefore should be an advanced user) it still works as before.

@emtiu
Copy link
Member

emtiu commented Jul 9, 2024

I am not concerned and think unless someone explicitly uses the man page section number to search for man pages (and therefore should be an advanced user) it still works as before.

I agree, I don't think we need to maintain an empty backintime-config.1 man page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion decision or consensus needed Documentation
Projects
None yet
Development

No branches or pull requests

3 participants