[MPlayer-dev-eng] man page format

[Diego Biurrun]

Jonas Jermann writes:
 > 
 > Actually this mail was ment for Diego but I'm happy about any
 > input. ;)

Post this stuff to the list, I think it is of general interest.

 > I worked a bit on the man page and got the following format.
 > It produces at least acceptable groff output. It looks a bit 
 > ulgy as Mozilla always adds a newline after a <p> -> after 
 > suboption title. Check it out and comment (just see -cdda 
 > option, the rest didn't change yet).

I think this is more than a start.  The output looks quite decent
already.  We should put it up on the web already and improve it later
on.

 > Some comments:
 >     - RSx defined at beginning
 >     - suboptions handled this way:
 > 
 > [...]
 > Available options are:
 > .RS 10
 > 
 > subopt1
 > .RSx
 > description
 > .RE
 > 
 > subopt2
 > .RSx
 > description
 > .RS +2
 > sub descr1
 > .RE
 > .RS +2
 > sub descr2
 > .RE
 > [...]
 > .RE
 > 
 > [...]
 > end of suboptx
 > .RE
 > .RE
 > .TP
 > [...]    
 >       
 > The main problem is the cryptic/messy/disordred view of the 
 > sources (-> problem for man page writers). I tried other things 
 > too (tbl), but the result was not that good.

Shouldn't be too much of a problem.  In the worst case you will have
to write a short documentation-howto.txt for DOCS/tech/ ;)

 > IMHO:
 >     - it should be all the same for all suboptions -> OK
 >       -> spacing from left is always same
 >       -> always newline before new suboption
 >     - we should solve the disturbing window view problem -> OK
 >       (except synopsis but that's a smaler problem)
 >       -> now you just have to add a rule like keep a line under 
 >          80 but nothing like design/etc...

Looks like an acceptable solution to me.  Well done!

Diego