search

bartobri / bmenu

A general purpose terminal menu that focuses on ease of configuration and use.
GNU General Public License v3.0
136 stars 11 forks source link

Add man pages #9

Closed tekknolagi closed 6 years ago

tekknolagi commented 6 years ago

I've chosen to build the man page with Pandoc, but they could be built with another tool or by hand if desired. I based the man page off of the README.md.

bartobri commented 6 years ago

Hi @tekknolagi

Thanks for the contribution! There are some issues that are preventing me from merging this.

  1. The man page does not uninstall.
  2. The man page file perms are incorrect.
  3. When the man page is invoked there are indentation issues.
  4. The man page contains install instructions which are not needed.
  5. Generally, I don't think the README file is ideal for generating a man page automatically.
tekknolagi commented 6 years ago

Hi Brian,

  1. Oh, good point.
  2. Oops, I can look into this.
  3. Really! I didn't notice this. What sections are you looking at?
  4. I did not consider that in the slightest. That seems obvious in retrospect.
  5. The README is not used to generate the man page automatically, but I copied a lot of the content from it to create bmenu.1.md.

Cheers, Max