Allow user to specify rgb.txt for imlib2 vhook

Originally committed as revision 9326 to svn://svn.ffmpeg.org/ffmpeg/trunk

1 files changed, 13 insertions, 0 deletions

diff --git a/doc/hooks.texi b/doc/hooks.texi
index 49504509f4..d4c4c5becb 100644
--- a/doc/hooks.texi
+++ b/doc/hooks.texi
@@ -67,8 +67,13 @@ with the full path to the font file, as in:
 @end example
 where 20 is the point size.
 
+You can specify the filename to read RGB color names from. If none are
+specified, these defaults are used: @file{/usr/share/X11/rgb.txt} and
+@file{/usr/lib/X11/rgb.txt}
+
 Options:
 @multitable @columnfractions .2 .8
+@item @option{-C <rgb.txt>}   @tab The filename to read RGB color names from
 @item @option{-c <color>}     @tab The color of the text
 @item @option{-F <fontname>}  @tab The font face and size
 @item @option{-t <text>}      @tab The text
@@ -137,6 +142,14 @@ Usage examples:
      a newline are treated as end-of-file. To create blank lines, use lines
      that consist of space characters only.
 
+   # Scrolling credits with custom color from a text file
+   ffmpeg -i input.avi -vhook \
+     'vhook/imlib2.so -C rgb.txt -c CustomColor1 -F VeraBd.ttf/16 -x 100 -y -1.0*N -f credits.txt' \
+     -sameq output.avi
+
+   This example does the same as the one above, but specifies an rgb.txt file
+   to be used, which has a custom made color in it.
+
    # scrolling credits from a graphics file
    ffmpeg -sameq -i input.avi \
      -vhook 'vhook/imlib2.so -x 0 -y -1.0*N -i credits.png' output.avi