tivo-build-xcompiler version 2.6
================================

This package contains the script and patches used to build the
TiVo Series 1 PowerPC cross-compiler and GNU C library.

The cross-compiler can be run on Linux or Cygwin (Windows) hosts to produce
executable programs for TiVo Series 1, software releases 2.5.x and 3.0.
It might also work on an OpenBSD host - if not take a look at Todd Miller's
older OpenBSD version from http://www.courtesan.com/tivo/crossbuild.html .

Mike Baker <mbm@linux.com>, ppchacker@hotmail.com,
Todd Miller <millert@openbsd.org>, and Tim <maxwells_daemon@ntlworld.com>
(who now maintains it) contributed to this package
(see the CHANGES file for details).

User documentation:
      http://homepage.ntlworld.com/maxwells.daemon/tivo/compiler.html

Organization:
      $ROOT - contains the tivo-build.sh script and .tar.gz source from TiVo
      $SOURCE/toolchain - build directories - can be deleted when build complete
      $INSTALL (usually /usr/local/tivo) - cross-compiler installation directory
      $INSTALL/bin - GCC programs
      $INSTALL/lib - libraries
      $INSTALL/include - header include files

Build instructions:

1) Download the following archive files into this directory:-
     http://tivo.com/linux/25/TiVo-2.5.x-toolchain.tar.gz
     http://tivo.com/linux/25/TiVo-2.5.x-linux-2.1.tar.gz

   For TiVo software release 3.0, you may prefer instead to use
   (fix the LINUX_SOURCE path in tivo-build.sh):-
     http://www.tivo.com/linux/30/TiVo_3.0_linux_2.1.tar.gz
   Note that this makes no difference to the cross compiler, just a few files in
   $INSTALL/include/asm-ppc and linux, which probably won't make any difference.

   That toolchain archive contains binutils, gcc, gdb, and libc.
   Those four packages are alternatively available from
     http://www.tivo.com/linux/TiVo-many-powerpc-toolchain.tar.gz
     http://www.tivo.com/linux/TiVo-many-powerpc-devenv.tar.gz
   which has libc separated off into the devenv archive.

   Except for TiVo-2.5.x-toolchain.tar.gz, these archives are referenced from
   the official TiVo GPL page
     http://www.tivo.com/linux/

2) Edit tivo-build.sh and set INSTALL to the desired location.
   The default is /usr/local/tivo.

3) Run ./tivo-build.sh and sit back while things build.
   This will take quite some time.
   The GNU debugger (gdb) is not built because it doesn't work (and probably
   wouldn't be much use anyway).

   tivo-build.sh can be specified with an argument to limit which stages will be
   performed (though most stages require the previous ones to be complete), eg.
     ./tivo-build.sh 7    # just test
     ./tivo-build.sh 2-   # skip stage 1, unpacking the sources
   This is especially useful if you have problems at one stage and
   don't want to have to start from scratch after fixing them.

   WARNING: stage 1 removes all files in $SOURCE/toolchain (if present from
   an earlier build). You can remove $SOURCE/toolchain when the build is
   complete - it is not required to use the cross-compiler.

4) You should now have a working cross-build for PowerPC TiVos.
   To compile things, simply use the gcc in $INSTALL/bin
   (or put $INSTALL/bin first in your PATH when compiling for the TiVo).

5) The $SOURCE/tivo-libs.tgz is can be shipped to the TiVo.
   Unpack in, e.g., /var/hack/lib and set LD_LIBRARY_PATH=/var/hack/lib
   e.g.,
     cd /var/hack; gzip -cd lib.tgz | cpio -idmu -H tar
   If you don't want your programs to require those libraries, link
   statically or, better, with the -standalone option.