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.
Caution: enabling external programs can be dangerous if you typeset tex files from dubious origin. Depending on your needs, you may prefer a separate configuration to typeset tex files which use Sysquake for LaTeX, keeping the standard, more secure configuration for other files. Sysquake for LaTeX should be used only with tex files you trust.
Install the latest release of MiKTeX (e.g. MiKTeX 2.9.6161). Then run the installer of Sysquake for LaTeX and follow the instructions.
The last steps, as explained in the installer, are manual:
- Make your TeX distribution aware of Sysquake for LaTeX. You should add a new root directory to the list of TDS directories.
- Configure your LaTeX editor to run pdflatex.exe with the argument -shell-escape. In TeXworks, for instance, in menu Edit>Preferences, Typesetting tab, double-click pdfLaTeX+MakeIndex+BibTeX in the Processing tool list, click the "+" button, type --tex-option=--shell-escape, then click the up arrow button to move the new option before $fullname$.
In the Start menu, submenu MiKTeX 2.9 (or equivalent), MiKTeX Settings (or MiKTeX Settings (Admin)) 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.
Install the latest release of TeX Live (e.g. TeX Live 2016), then run Sysquake for LaTeX installer and follow the instructions.
The last steps are manual:
- Make sure sysquakelatextool.exe is in the search path. Open the Command Prompt application (e.g. by entering cmd in menu Start>Run), and type sysquakelatextool. You should read a few lines beginning with a percent. If you get an error message instead (e.g. 'sysquakelatextool' is not recognized...), you should add its path to the PATH environment variable. Select menu Start>Control Panel, then System, Advanced tab, Environment Variables button, double-click the User variable PATH and add sysquakelatextool.exe's path followed by a semicolon at the beginning of what already exists. E.g.
TEXMFLOCAL = $SELFAUTOPARENT/../texmf-local,C:\Program Files\SysquakeForLaTeX\TexFiles
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 and can run sysquakelatextool.exe.
On macOS, 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 macOS 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
You should make sure to enable the execution of external programs with \write18. In TeXShop, for instance, open TeXShop preferences (menu TeXShop>Preferences), display the Engine tab, then in pdfTeX/Latex field, replace pdflatex --file-line-error --synctex=1 with pdflatex --file-line-error --synctex=1 -shell-escape.
Ubuntu, Debian or Linux Mint
Sysquake for LaTeX is available as a deb package, with a dependency on the texlive package which will also be installed if it isn't already done. Double-clicking its icon should open the default package management utility for your system. You can then read its description and install it.
Alternatively, in a terminal window, you can type the following command (replace the star and specify the exact filename if you have several versions):
sudo dpkg -i sysquakelx-*.deb
Should you want to remove Sysquake for LaTeX, you can type the following command:
sudo dpkg -r sysquakelx
Manual installation on Linux
Sysquake for LaTeX is also available as a tgz archive, which can run on other Linux distributions and gives you total flexibility for file location. The steps below give you general directions.
- Install the latest release of TeX Live (e.g. TeX Live 2016). On a Linux distribution using rpm packages like RedHat, Fedora or CentOS, you can type
sudo yum install texlive tex-live-latex
On a Linux distribution using deb packages like Debian, Ubuntu or Linux Mint, you can install TeX Live with the package manager:
sudo apt-get install -y texlive-latex-base
tar xfz sysquakelx-*.tgz sudo mkdir -p /opt sudo cp -R SysquakeLx /opt
sudo mkdir -p /usr/local/bin sudo ln -s /opt/SysquakeLx/bin/i386-linux/sysquakelatextool /usr/local/bin
or add /opt/SysquakeLx/SysquakeLx/bin/i386-linux to your environment variable PATH.
ln -s /opt/SysquakeLx/TexFiles /usr/local/share/texmf/SysquakeLx