vfc(1G)

NAME
     vfc - compiler for video formats

SYNOPSIS
     /usr/sbin/vfc [options] source

DESCRIPTION
     vfc compiles a video format source program source into a microcode image
     object file that you can load into hardware.  This microcode image
     generates the timing signals necessary to drive different video monitors.

     Video format object microcode is not binary compatible between different
     hardware types.  Although vfc is indepdendently re-targetable to a number
     of different hardware types, video format objects that were compiled to
     run with one hardware architecture will not necessarily run on another.
     For example, video format objects created for Infinite RealityTM will not
     work properly on Impact.

     On some hardware architectures, it is possible to load the video format
     object file directly to the hardware using the setmon(1G) command.
     However, some hardware architectures require you use an additional
     validation and layout tool to load hardware; for example, the Infinite
     Reality architecture requires use of the ircombine(1g) utility to build a
     video format combination from individual video format object files.



     Command line options are:

     -a  <option>,...
          Performs an analysis of the video format source.  Options are:

          ascii=<file> Generate a textual description of the video format to
          <file>.

          highlevel (boolean) Do not perform automated frame analysis.
          Instead, rely on the definitions of the vertical portions as
          specified in the .vfs file.

          postscript=<file> Generate a textual description of the video format
          to <file>.


     -c  <option>,...
          Specifies which configuration options should be used to compile the
          video format source file.


          chip=<chip-type> Specify the target chip architecture.
          board=<board-type> Specify the target board architecture.


     -i  <command>
          Specifies an alternate pre-processor to the standard c-language
          pre-processor available with Irix (/lib/cpp).  A typical alternative
          <command> is "/usr/bin/cc -E", the c-preprocessor included with the
          Irix Developer's Option.  Any alternative pre-processor must produce
          line identification directives compatible with /lib/cpp.


     -o  <file>
          Specifies the file name of the microcode video format object file.
          If you do not specify a name, the compiler creates the file a.vfo.


     -p  <string>
          Specifies a parameter passed to the C-language pre-processor which
          vfc uses to process its files.  The <string> is passed directly.
          You must use quotes to encapsulate the string if the string contains
          spaces.


     -s   Prints internal compiler statistics.




INSTRUCTIONS FOR SPECIFIC HARDWARE PLATFORMS
   Infinite Reality Systems
     You should use the following rules files:

          chip=voc1.def

          board=dg4.def

     You should place your resultant files in the following directory:

       /usr/gfx/ucode/KONA/dg4/vfo

     After building your video format, you must use ircombine(1G) to create a
     video format combination.

     Note that it is possible to redirect ircombine to use formats not in the
     proper directory.  You can use this to evaluate the format for use;
     however, if you neglect to move the format to the path specified above,
     the load will fail with an X protocol error.

DISCLAIMER
     The vfc program is provided as a complimentary tool that allows
     knowledgeable users to create custom video formats.  Although SGI will
     attempt to address bugs found in the operation of the program, there is
     no tutorial or instructional support available for creating new video
     formats.  Support is limited to the book accompanying this product.

     Moreover, SGI suggests caution when testing an unknown format on
     vulnerable monitors; some monitors can be damaged when attempting to lock
     to a video format other than which they were originally designed.  SGI
     cannot be held responsible for such damage.



SEE ALSO
     setmon(1G), ircombine(1G), XSGIvc(3)