Improve section header in manpage

pradeep250677 / lz4

Automatically exported from code.google.com/p/lz4

0 stars 0 forks source link

Improve section header in manpage #111

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago

Currently, lz4.1 renders as being in section "man", which isn't correct at all 
(though mandb does correctly index it in section 1 based on path). I suggest 
the following simple change:

-.TH lz4 man
+.TH lz4 "1" "2014-02-05" "lz4" "User Commands"

Original issue reported on code.google.com by d...@falconindy.com on 5 Feb 2014 at 6:17

GoogleCodeExporter commented 8 years ago

Original comment by yann.col...@gmail.com on 5 Feb 2014 at 6:59

Added labels: Type-Enhancement
Removed labels: Type-Defect

GoogleCodeExporter commented 8 years ago

OK, no problem,
I just don't exactly understand the syntax of the proposed line.
Could you explain me a bit what it does ?
Thanks

Original comment by yann.col...@gmail.com on 5 Feb 2014 at 7:01

GoogleCodeExporter commented 8 years ago

Sure, here's a reference:

https://www.gnu.org/software/groff/manual/html_node/Man-usage.html

See the very first item explaining the extra arguments to .TH

Original comment by d...@falconindy.com on 5 Feb 2014 at 7:07

GoogleCodeExporter commented 8 years ago

great, thanks !

Original comment by yann.col...@gmail.com on 5 Feb 2014 at 7:12

Changed state: Accepted

GoogleCodeExporter commented 8 years ago

The following file
is a wip r114 version
implemented your welcomed suggestions for the man page.

Original comment by yann.col...@gmail.com on 27 Feb 2014 at 8:00

Attachments:

lz4-r114.tar.gz

GoogleCodeExporter commented 8 years ago

Fixed into r114

Original comment by yann.col...@gmail.com on 12 Mar 2014 at 2:57

Changed state: Fixed