[MPlayer-dev-eng] man page rewrite

[Jonas Jermann]

On Thu, Sep 05, 2002 at 02:17:36PM +0200, Jonas Jermann wrote:
> I'm almost ready to start with the manpage rewrite (will only 
> take a few hours).
> 
> I wrote a manpage.txt guide for the man page, if it's wanted,
> I'll commit it too (tech). Maybe a general documentation.txt
> would be better (for tech,wishlist,html,manpage), donno.
> 
> To the questions/comments:
>     - May I start commiting?
>     - mplayer.1.new is just a testing version (-cdda,-vc examples)
>     - Should I commit in small pieces or all-in-one (IMO
>       translator don't need to convert it anyway).
>     - Some settings look great for man but bad for html. I took 
>       the html compliant version.
>     - The man page doesn't (didn't) comply with the standard in 
>       some points (eg. italic parameters), but IMHO it looks ugly 
>       so I let the old version.
>     - I proposed a section order change based on Diego's idea
>       (player, demuxer, osd, audio, video, decoding, encoding)
>     - See manpage.txt for more details (comments are welcome)

I commited the rewrite. There are still bugs:
    - All (except) paragraphs after a .RE command is wrong 
      indented.
    -> I moved everything at the beginning (workaround)
    - The groff html output has some problems with the .IP 
      options (the indentation after an automatic newline isn't  
      the same as for short .IP parameter (no indentation)).
    -> Still unsolved, can be regulated with the SS variable in 
      the header (very small or very big values look better in 
      html, values around 18 look good in the man page).
    - Also the automatic newline after paragraphs (Mozilla at 
      least) doesn't look very nice IMHO (to big spacing).
    - The warnings about adjusting lines etc still remain

Could someone please check:
    - the man page
    - the html output of groff, man2html and rman

Suggestions are welcome. :)

Regards
    Jonas