search

arkq / cmusfm

Last.fm standalone scrobbler for the cmus music player
GNU General Public License v3.0
232 stars 5 forks source link

Added cmusfm man page #49

Closed andgera closed 2 years ago

andgera commented 2 years ago

Added cmusfm man page

andgera commented 2 years ago

I've added man page setup logic to build the system. I used the logic from your bluez-alsa project as a template. Now, in order to install man pages, you need to add the --enable-manpages switch to the configuration. I don't know if it's good? Also rst2man is required to build man pages.

arkq commented 2 years ago

Now, in order to install man pages, you need to add the --enable-manpages switch to the configuration. I don't know if it's good?

I think that it is OK. I will review the man page itself later.

andgera commented 2 years ago

I will review the man page itself later.

Maybe some edits are needed. It is based on the README.md file

arkq commented 2 years ago

I've updated the man page a little bit, I hope you don't mind.

andgera commented 2 years ago

Yes, man pages are much better now. You did a great job on her. Not as an objection, just to draw your attention to the FILES section, it might be worth renaming it to CONFIGURATION, but if you think FILES is more correct, then so be it.

arkq commented 2 years ago

The FILES section is ok. In fact section names are defined by man specification. So, whenever predefined section fits it should be used. However, I've made one exception. The COMMANDS section should be named OPTIONS, but options does not fit here.... we've got only commands... so, I've changed that.