[MPlayer-DOCS] main/TOOLS documentation?

[Diego Biurrun]

VMiklos writes:
> Diego Biurrun wrote:
>  > Huh?  sox is LGPL:
>  >
>  > http://sourceforge.net/projects/sox
>  >
>  > So this is bogus..
>  >
>  >>        Note:           It is not useful anyway, never was.
>  >
>  > Maybe it's time to remove it then.
> 
> ok, removed from the readme

Please don't.  As long as it is present in the TOOLS dir it should be
documented.

>  >>        Note:           Requires CVS JOCR/GOCR.
>  >
>  >
>  > Is this still true?  Maybe add a reference to the upcoming version.
> 
> he wrote this on Jul 28 2002, and since there was 3 stable release. i 
> suppose then only version >= 0.37 required
> 
> i recategorized the readme, did 's/\t/  /g' instead of 's/\t/        /g' 
> and fixed several typos

Looks better now, thanks.  I'm tempted to suggest some more changes:
Why not skip the indentation and add a blank line after the title as
well as two blank lines between tool descriptions, like so:


2.1 midentify

Author:       Tobias Diedrich

Description:  Runs 'mplayer -identify' for all arguments while preventing
              video window flashing.

Usage:        './midentify file1 [file2 ...]'


2.2 mpconsole


Also, I would suggest not numbering the tools and maybe even leaving
out the chapter numbers.  It's a PITA if you want to insert one in the
middle.

> if it's ok, i would continue with the subdirs

Yes, please do.

> encoding in 3-pass mode or creating SVCDs from a movie.

three pass mode

>                 be even more useful in combination with vo ggi to distribute the

Either "vo_ggi", "-vo ggi" or "the ggi video output driver".

>                 Where <parameters> are all possible commandline switches

command line

>                 writes the resulting moviefile to a CD-ROM and shuts down the

movie file

>                 computer. If you like, you can watch the mencoder output on

MEncoder

>   Description:  This script will download MS's codec dl interface as used by MS
>                 Media Player to attempt to locate the codecs listed in
>                 codecs.conf.

Hmm, that sounds awkward, how about: This script will use Microsofts
Media Player codec download infrastructure to aquire the codecs listed
in codecs.conf.

Diego