search

bit-team / backintime

Back In Time - An easy-to-use backup tool for GNU Linux using rsync in the back
https://backintime.readthedocs.io
GNU General Public License v2.0
2.03k stars 201 forks source link

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

Open buhtz opened 3 months ago

buhtz commented 3 months ago

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

aryoda commented 3 months ago

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 commented 2 months ago

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.