Sysquake for LaTeX - Installation

Installing Sysquake for LaTeX consists in three steps:

• Copy all Sysquake for LaTeX files to your hard disk. The default location is /opt/SysquakeLx on unix systems, and C:\Program Files\SysquakeForLaTeX on Windows.
• Update environment variables so that sysquakelatextool is found by the operating system and finds library files. This consists in adding the path of the directory containing sysquakelatextool to PATH, and setting a new environment variable SYSQUAKELXPATH to the semicolon-separated list of paths to library directories.
• Make your TeX distribution able to load the sysquake.sty package. In TDS-based distributions (TeX Live, teTex, MiKTeX, etc.), this means adding the path of TexFiles to the list of TDS roots.

LaTeX must also be able to execute external programs with \write18. Depending on the platform, this may require to add an option argument to pdflatex, such as -shell-escape or --enable-write18.

Windows

Install the latest release of MiKTeX (e.g. MiKTeX 2.6 2742). Then run Sysquake for LaTeX installer and follow the instructions.

The last step, as explained in the installer, is manual: make your TeX distribution aware of Sysquake for LaTeX. You should add a new root directory to the list of TDS directories.

In the Start menu, click MiKTeX>Settings and select the Roots tab. Click the Add button, select directory TexFiles of Sysquake for LaTeX, and confirm, clicking the main OK button of the MiKTeX Options window.

For other TeX distributions, please read their documentation. Sysquake for LaTeX installer is totally independent from any other software; you should just configure TeX so that it finds the file sysquake.sty.

Mac OS X

On Mac OS X, Sysquake for LaTeX is distributed as a package. To install it, just double-click its icon and accept everything. You will need an administrator password. An alias of the documentation entry file is put on the Desktop.

The Mac OS X package stores the distribution in /opt/SysquakeLx and creates the following symbolic links, also creating directories if they do not already exist:

ln -s /opt/SysquakeLx/bin/i386-darwin/sysquakelatextool \
  /usr/bin
ln -s /opt/SysquakeLx/TexFiles/tex/latex/sysquake.sty \
  ~/Library/texmf/tex/latex
ln -s /opt/SysquakeLx/TexFiles/tex/latex/sq-example.tex \
  ~/Library/texmf/tex/latex
ln -s /opt/SysquakeLx/TexFiles/doc/latex/sysquake/index.html \
  ~/Desktop/SQ-LaTeX.html

TeX Live on Linux and other Posix systems

Install the latest release of TeX Live (e.g. TeX Live 2007). Then follow the steps below:

• Unarchive the distribution of Sysquake for LaTeX for your platform to a suitable location, such as /opt/SysquakeLx.
• Have bin/i386-linux/sysquakelatextool in your PATH. There are two ways to do it: put a symbolic link to bin/i386-linux/sysquakelatextool in one of your existing program directories, such as /usr/bin or /usr/local/bin:

sudo ln -s /opt/SysquakeLx/bin/i386-linux/sysquakelatextool /usr/bin

or add /opt/SysquakeLx/SysquakeLx/bin/i386-linux to your environment variable PATH.

• Create a new environment variable named SYSQUAKELXPATH which contains a list of semicolon-separated paths for the directories containing .lml libraries. The default value is .;./Lib;/opt/SysquakeLx/Lib, which finds standard libraries if Sysquake for LaTeX is installed in /opt/SysquakeLx.
• Edit file texmf.cnf (type kpsewhich texmf.cnf in a terminal to find it) and append the full path of directory TexFiles to TEXMFLOCAL, separated from previous path(s) with a semicolon. For example:

TEXMFLOCAL = $SELFAUTOPARENT/../texmf-local;/opt/SysquakeLx/TexFiles