Changes

< {{note|You almost certainly want to [[New Installation|install the newer ConTeXt Minimals (Implementation)LMTX]] >. This guide is for installing the older, rarely-updated MkIV distribution.}}

[http://minimalsThe '''ConTeXt suite''' is a complete, up-to-date ConTeXt distribution that can be upgraded efficiently.contextgardenIt can also be used in parallel with existing TeX installations such as MikTeX, TeXLive, and so forth. The suite does not include LaTeX packages and binaries.net]

Sometimes ConTeXt beta releases have issues. The ''New Minimals'' are an attempt ConTeXt suite allows you to provide test the same functionalities as Pragma's minimal zip distributionslatest ConTeXt release without worrying whether upgrading will corrupt a critical project. Multiple ConTeXt suite installations are possible. As of today (2007-11-01)This allows, for example, they are hosted a stable version and a beta version to run in parallel on the contextgarden.net server (the same one as this wiki)computer.

They ConTeXt is also included in TeXlive. The ConTeXt suite is updated continuously, whereas ConTeXt in TeXlive is updated less often. In particular, <code>luatex</code> and <code>metapost</code> are under active development and their binaries areupdated frequently. ConTeXt follows these developments, right now, indeed often drives development. As the binaries included in a very early experimental beta stage. Everyone is invited to test this the TeXlive distributionare only updated yearly, but ConTeXt on TeXlive will necessarily be less current than the ConTeXt suite. The ConTeXt suite is kindly asked for patience self-contained and understanding until we tidy up the detailscan happily coexist alongside another installed TeX distribution.

The minimals (will) contain{| style="border:1px solid #DDDDDD;"|- align="left" ! Platform! Short name! Notes|- align="left" style="background-color:#EEEEEE;"! Windows| mswin| from [http://w32tex.org W32TeX]|- align="left"! Windows/CygWin| cygwin| same binaries as mswin|- align="left" style="background-color:#EEEEEE;"! Windows, 32 bit| win32| Alias for mswin|- align="left"! Windows, 64 bit| win64* ConTeXt| * Fonts|- align="left" style="background-color: most important TeX#EEEEEE;"! Linux, 32-bit| linux| Debian 8|-aware onesalign="left"* pdfTeX! Linux, XeTeX64-bit| linux-64| Debian 8|- align="left" style="background-color:#EEEEEE;"! Linux, LuaTeX and Metapost ARM (latest versionlow end.)| linux-arm| Raspbian 8|- align="left"! Linux, if possible)musl| linuxmusl-64| Alpine|- align="left" style="background-color:#EEEEEE;"* formats ! Mac OS X, Intel (need to be generated by user64-bit) for** ConTeXt| osx-64| Mac OS X 10.6|- align="left"! FreeBSD, 32-bit| freebsd||- align="left" style="background-color:#EEEEEE;"! FreeBSD, 64-bit| freebsd-amd64||- align="left"! OpenBSD 6.4, 32-bit| openbsd6.4||- align="left" style="background-color:#EEEEEE;"! OpenBSD 6.4, 64-bit| openbsd6.4-amd64||- align="left"! OpenBSD 6.5, 32-bit| openbsd6.5||- align="left" style="background-color:#EEEEEE;"! OpenBSD 6.5, 64-bit| openbsd6.5-amd64||- align="left"! Solaris, mptopdf and plain TeX for pdfTeXIntel| solaris-intel| Solaris 10 on [http://www.opencsw.org/XeTeXabout/LuaTeXOpenCSW]|- align="left" style="background-color:#EEEEEE;"! Solaris, Sparc| solaris-sparc** metafun and plain for Metapost| Solaris 10 on [http://www.opencsw.org/about/ OpenCSW]* ''it would be nice to have tex4ht as a package if someone can figure out what is needed to make it work''|}

* Windows* Linux* LinuxIf you want to support a new platform, 64 bit* Mac OS X Intel* Mac Os X PPC* other platforms on request (please send a mail write to the ntg-context mailing list)[[Mailing Lists]]

= Installation =Dependencies ==* Rsync (The windows binary of rsync is distributed within the suite)

Platform can be ''win'', ''linux'', ''linux-64'', ''osx-ppc'' or ''osx-intel'' * curl : for including remote content* ghostscript : for converting PostScript images to PDF* graphicsmagick (defaultconvert) : for converting GIF and TIFF images* inkscape : ''win'');for converting SVG and compressed SVGengine can be ''pdftex'', ''xetex'', ''luatex'', ''all'', or a comma-separated list of any of those * mupdf (default: ''all''mudraw). If you want to specify a list of engines, you would have to protect it on most shells: <code>--engine='xetex, luatex'</code>, for example. TeX root, obviously, is the location of your installation converting PDF to PNG (the directory where texmf trees like texmf, texmf-local, etc. are to be foundused for ePub covers), default* pstoedit : ''tex'' (relative for converting PostScript to the current directory).MetaPost outlines* zint : for providing barcodes* zip or 7zip : for EPUB generation

Most of == Disc space required ==ConTeXt macro files are small (less than 10MB), but the task of <code>mtx-update</code> is to run <code>rsync</code> to synchronize your local installation suite comes with various free fonts which considerably increase the repository. It is assumed that Unix users (including Mac OS X) would have an rsync client installed by default on their system; for Windows an rsync binary is provided as part size of the initial setup distribution (see next paragraphto around 200MB).

If you ''don't'' have an installed == Multiple instances of the installation ==Please note from the start that we recommend installing a complete ConTeXt distribution, you must download from [http://minimalsinstallation for each project in a production environment.contextgarden.net/setup/] The installation tree is portable (see Moving the appropriate zip archive for your systemInstallation Around, below) and run can be located under the shell / batch script in the top-level project's own directory (which should be called <code>context</code>); it . The advantage is to allow each project to use an instance of ConTeXt that is a very simple script adapted to its coding and that sets only gets updated purposely. Since the necessary environment ConTeXt Standalone is "bleeding edge" and subject to run mtx-updatedevelopment, certain details in commands, and it accepts exactly the same switches as mtx-updatesyntax or rendering may evolve slightly. By default it will install Having a vintage ConTeXt distribution suitable for pdfTeX on your system; the top-level directory tree for each production project insures that distribution will be <code>context/tex</code> until you tell it otherwise (with the <code>--texroot</code> switch)one can come back years later and produce identical results.

The rest of So as not to get carried away under this section is a manifest of how we would like things approach, one can eventually group projects by vintage, period or season, according to work (most cycles of it is already done!)productivity.

One should be able to download <code>setup.zip<* [[ConTeXt Standalone/FAQ|Standalone/code> (approx. 2MB) which would download all the other things (selected engines, fonts, modules, ...) on demand. It should contain:FAQ]] * some really basic documentation (README, INSTALL)[[ConTeXt Standalone/Structure|Standalone/Structure]] * setup script[[ConTeXt Standalone/Implementation|Standalone/Implementation]]* texmf-[os[ConTeXt Standalone/TODO|Standalone/TODO]] * [[ConTeXt Standalone/binContents|Standalone/luatex + texlua symbolic linkContents]] * [[ConTeXt Standalone/TeX Live|Standalone/TeX Live]]* Browse the [http://minimals.contextgarden.. [finishmenet installation tree]

* create a file <code>first-setup(.sh, .bat)</code> (or with some other self-explanatory name), which:** checks if rsync exists (if not, an error is issued, saying <code>please install rsync first</code>)** checks for perl and ruby and issues a similar error/warning (in fact, we can still proceed to the next step and download things even if perl & ruby are not installed, but that doesn't make much sense)** detects the platform (straightforward for windows, for unix= Unix-like platforms the same kind of detection is used as later in <code>setuptex<(Linux/code>)** does rsync to installation files themselves (in case mtx-update has changed in the mean time)** reads in <code>context-minimals-seetings.lua<MacOS X/code> (which engines, formats, fonts, modules to download ...) if interactive is set to true, ask for default settings again, otherwise respect those settings and continue** asks for installation location** creates (or updates) the file with settings (if interactive)** fetch files with rsync** create formats** suggest what to put into <code>.bash_profile<FreeBSD/code> (or equivalent locationsSolaris) to have context initilized automatically=

= Binaries == (MacOS X) Using the Command line: Terminal.app ===

Binaries are mostly taken from TeX Live 2007If you do not what a command tool is, but new ones do not worry. It is simply a program in which commands are used whenever availableentered as text and then executed. The needed Terminal.app can be found in the Utilities-folder of the Applications-Folder.

== Origin of Once you have started Terminal, all you have to do is enter a command and press the binaries ==RETURN-key and the command will be executed.

=== Core binaries ===''We will do our best to keep them as up to date as possible. If they're still not up to date for your platform and you know where to find them, please notify us, we will fix that. We might provide XeTeX and LuaTeX in separate packages execute (on TODO listLinux/FreeBSD/Solaris).''* pdftex* luatex* texlua, texluac ''(only symlinks on "unix" platforms, in Akira's distribution luatex.dll is used + 3 small executables)''* xetex, xdvipdfmx* ''metapost''** dvitomp** makempx** mpost** mpto ''(can this be replaced by ConTeXt's variant in future?)'':

=== Stubs & other ConTeXt-related ===* everything from <codepre>texmf mkdir ~/scriptscontext cd ~/context wget http:/stubs/minimals.contextgarden.net/setup/first-setup.sh</codepre>* luatools, mtxrun* texmfstart ''(take the latest version by Hans automatically: doesn't happen yet)''

=== Fontor (MacOS):<pre> mkdir ~/context cd ~/context rsync -av rsync://contextgarden.net/minimals/setup/first-related ===setup.sh .</pre>''Might be removed or moved to a special category of "fontSince the Mac does not have `wget` pre-related binaries", and only available as an additional packageinstalled.''* ''only left for testing Now run the `first-setup.sh` script:** afm2pl<pre>** afm2tfm # Install the latest beta of ConTeXt** ttf2afm # This takes a long time, so go have a coffee* Knuth's # Flags you can add to the first-setup.sh call:** pltotf # --modules=all # Install all third-party modules** tftopl # --context=latest # Install latest stable version** vftovp # --engine=luatex # Install only MkIV, leave out MkII** vptovf # # This shrinks the install from 270 MB to 200 MB

=== Might sh ./first-besetup.sh -removed-soon =modules==* dvipdfmxall* dvips</pre>

=== WindowsSystem-only =wide installation ==''Additional standard tools, such as unzip etc. TODO.''

There's a plan to provide three versions:* stable* betaon Linux you can use <code>/opt/context</code>* broken (for Hans, Taco and nerds only)And a plan to provide possibility to revert back to an older stable version. TODO.on MacOS X you can use <code>/Applications/ConTeXt</code>

Fonts are split in three packages:* used in both pdfTeX and XeTeX<code>CONTEXT_HOME=/opt/context</LuaTeX: mostly math (pfb, map, enc, tfm)code>* used in pdfTeX only: pfb, map, enc, tfm (those that are not present in "common")<code>TEXMFCACHE=$CONTEXT_HOME/tex/texmf-cache</code>* used in XeTeX<code>chmod -R g+w $TEXMFCACHE</LuaTeX only: otfcode>

Currently we have ({{note|You almost certainly want to [[Installation|install the latest versionnewer ConTeXt LMTX]]. This guide is for installing the older, in sync with CTAN):* Latin Modern* Antykwa Torunska* Iwona & Kurier* TeX Gyre* amsrarely-updated MkIV distribution.}}

Other fonts <pre> # Create the /opt/context directory -- change as appropriate or desired if you # want a different installation directory. cd /opt mkdir context cd context # Fetch the install script (use rsync on the mac, see above) wget http://minimals.contextgarden.net/setup/first-setup.sh # Install the latest beta of ConTeXt # This takes a long time, so go have a coffee # Flags you can add to be addedthe first-setup.sh call:* TODO # --modules=all # Install all third-party modules # --context=latest # Install latest stable version # --engine=luatex # Install only MkIV, leave out MkII # # This shrinks the install from 270 MB to 200 MB

It is possible that we'll provide a really minimal package with LM only, and additional three packages (common, for new TeX, for old TeX) with sh ./first-setup.sh --modules=all the other fonts.

= Third # change ownership to real rather than effective id chown -party modules & Other =R `id -r -u`:`id -r -g` .</pre>

= Hans(if you don's requests =t have the line above, go to the end of the file) and add there:

* upload rsync binaries from Delta (minimals export OSFONTDIR="/rsyncusr/windows)* reorganize fonts into fontslocal/datashare/e-foundryfonts;$HOME/texgyre/<everything>* list directory contents* list of files to fetch an old ConTeXt version.fonts"

== Apache webserver installation == Another common use case is invoking ConTeXt from within a web application. Because web directories are often self-contained, and in the case of Apache under Ubuntu, ownership of the directory and its contents are assigned to a user and group without a login shell, e.g., <code>www-data:www-data</code> this prevents a web application from invoking a ConTeXt installation done using either the single-user or system-wide method listed above. In this case the solution is to install ConTeXt within the website tree, and ideally in the public sub-tree. The public sub-tree is commonly the home directory for the application and relative pathnames are resolved as if immediately below it. For example, in the case of the PHP web framework Laravel, ConTeXt can be installed alongside other assets in the <path-to-document-root>/public/context directory: <pre> cd <path-to-document-root>/public mkdir context cd context wget http://minimals.contextgarden.net/setup/first-setup.sh # Install the latest beta of ConTeXt # This takes a long time, so go have a coffee # Flags you can add to the first-setup.sh call: # --modules=all # Install all third-party modules # --context=latest # Install latest stable version # --engine=luatex # Install only MkIV, leave out MkII # # This shrinks the install from 270 MB to 200 MB  sh ./first-setup.sh --modules=all</pre> Once installed, you need to ensure that the permissions are correct for Apache to be able to access it (you will either need <code>sudo</code> privileges or root access): <pre>$ cd <path-to-document-root>/public$ sudo chmod -R www-data:www-data context</pre> Now as part of your application's invocation of ConTeXt, you will need to set up the shell environment. This is easily done by creating a simple BASH shell script, also to be installed in the public part of the document tree: <pre> #!/usr/bin/env bash  # # proccontext.sh # # To be installed in <path-to-document-root>/public/bin  . <path-to-document-root>/public/context/tex/setuptex <path-to-document-root>/public/context/tex  cd tex/spool context $1 > /tmp/context_run.log</pre> Here the dynamically generated ConTeXt source file is expected to be found in the <code><path-to-document-root>/tex/spool</code> directory. Now within your application, you can invoke this shell script (in this case using PHP): <pre> $cmd = "bin/proccontext.sh $input_filename"; $last_line = system($cmd, $ret_val);</pre> And the output will once again be found in <code><path-to-document-root>/tex/spool</code>. ==Arch Linux==There’s a [https://aur.archlinux.org/packages/context-minimals-git PKGBUILD] inthe AUR, provided by Aditya [https://github.com/adityam/context-pkgbuild].Install it using your favorite AUR frontend, e.g. <pre>yaourt -S context-minimals-git</pre> This will get you a fresh, up-to-date Context tree in<tt>/opt/context-minimals</tt>. == The funtoo way == If you are using [http://funtoo.org funtoo] there are ebuilds that will make an installation as easy as installing any other package from portage. Take a look at the [[ConTeXt Standalone Funtoo]] Howto. This might also work for [http://www.gentoo.org gentoo], but is untested right now. == Proxy settings == The installation script uses <code>rsync</code> to fetch the required files. So, if you are behind a proxy server, you need to tell the details to rsync. The easiest way to set this is to set <code>RSYNC_PROXY</code> variable in the terminal or your startup script (<code>.bashrc</code> or the corresponding file for your shell). Replace username, password, proxyhost and proxyport with the correct information  export RSYNC_PROXY=username:password@proxyhost:proxyport Sometimes, when behind a firewall, port 873 may be closed for outgoing TCP connections. If port 22 is open for ssh connections, a trick that can be used is to connect to a computer located somewhere outside of the firewall and to tunnel port 873 (using the program <code>nc</code>).  export RSYNC_CONNECT_PROG='ssh tunnelhost nc %H 873'Ein Teil von jener Kraft where <code>tunnelhost</code> is the machine outside of the firewall on which you have <code>ssh</code> access. Of course, this machine must have <code>nc</code> and port 873 open for outgoing TCP connections. == Usage == ConTeXt suite works in a non-interfering manner because it does not put anything in your <code>$PATH</code> and does not set any system variables. This in turn means that in order to use it, you need to do some initialization. An intialization script called <code>setuptex</ Die stets das Böse code> is provided in <code>installation-dir/tex/</code>.  === Terminal/Command line === To run context from a terminal, source <code>setuptex</code>:  source /installation-dir/tex/setuptex === Exclusive usage === If you always use ConTeXt suite and '''never''' use LaTeX or plain TeX provided by another TeX distribution, you can add the following line to the startup script of your shell (For bash, the startup script is <code>$HOME/.bashrc</code>; for zsh it is <code>HOME/.zshrc</code>).  source /installation-dir/tex/setuptex Then <code>setuptex</code> willalways be sourced in your terminal. === Integrating with an editor === The easiest way to run ConTeXt from an editor is to open a terminal, und stets das Gute schafftsource {{code|setuptex}} in the terminal, and then open your editor '''from the same terminal'''. Another option is to add {{code|/installation-dir/tex/texmf-<platform>/bin}} to the {{code|$PATH}} that the editor searches. The details vary depending on the editor. See [[Text Editors]] for instructions on integrating ConTeXt with various editors. == Updating == For updating the ConTeXt suite, first update <code>first-setup.sh</code>, then run it. You couldalso create an alias or a little script “ctx-update”with the following example contents:<pre>cd /opt/contextrsync -ptv rsync://contextgarden.net/minimals/setup/first-setup.sh .sh ./first-setup.sh --modules=all</pre> To update retain currently-installed modules:<pre>sh ./first-setup.sh --keep</pre> == Uninstalling == ConTeXt suite does not touch anything outside its installation folder. So to uninstall it, you can simply remove the installation folder. == Remaking formats == Normally, the update script should create the formats for you. If for some reason you need to recreate the formats, you can do the following: * For making MKII format.  mktexlsr texexec --make --all  * For making XeTeX format  mktexlsr texexec --make --xtx --all  * For making MKIV format  mtxrun --generate context --make = Windows = If you want to use ConTeXt suite alongside MikTeX/TeXLive (needed if you also run LaTeX), follow the command-line installation method.  == Installation == === Command line method ===Download [http://minimals.contextgarden.net/setup/context-setup-mswin.zip context-setup-mswin.zip] or [http://minimals.contextgarden.net/setup/context-setup-win64.zip context-setup-win64.zip], and unzip to a directory where you want to install ConTeXt. It is recommended that you choose a directory that does not have a space in its full path. Then open <code>cmd.exe</code>, go to the installation directory and run {{note|You almost certainly want to [[Installation|install the newer ConTeXt LMTX]]. This guide is for installing the older, rarely-updated MkIV distribution.}}  first-setup.bat This takes a long time, so go have a coffee.  By default, the suite installs ConTeXt beta. If you want the stable version of ConTeXt, you can use   first-setup.bat --context=latest By default, the suite does ''not''install modules and other third party content. If you want the modules (and have the bandwidth), you can use  first-setup.bat --modules=all  If the above installation instructions don' t seem to answer your questions, see page [[Windows_Installation:_ConTeXt_Suite_with_SciTe| Windows Installation: ConTeXt Suite with SciTe]] for more detailed information. == Proxy settings == The installation script uses <code>rsync</code> to fetch the required files. So, if you are behind a proxy server, you need to tell the details to rsync. The easiest way to set this is to set <code>RSYNC_PROXY</code> variable in the terminal as (replace username, password, proxyhost and proxyport with the correct information)  set RSYNC_PROXY=username:password@proxyhost:proxyport or set the variable permanently as a Windows environment variable. Sometimes, when behind a firewall, port 873 may be closed for outgoing TCP connections. If port 22 is open for ssh connections, a trick that can be used is to connect to a computer located somewhere outside of the firewall and to tunnel port 873 (using the program <code>nc</code>).  export RSYNC_CONNECT_PROG='ssh tunnelhost nc %H 873' where <code>tunnelhost</code> is the machine outside of the firewall on which you have <code>ssh</code> access. Of course, this machine must have <code>nc</code> and port 873 open for outgoing TCP connections. == Usage == Before running ConTeXt, you need to run <code>setuptex.bat</code> which is provided in <code>installation-dir\tex\</code>. This can be done by typing installation-dir\tex\setuptex.bat on cmd.exe before you run ConTeXt. To avoid always having to type this, you can create a shortcut to cmd.exe and edit the command line to read (assuming you installed the suite in <code>C:\Programs</code>; otherwise replace <code>C:\Programs\</code> with your installation directory)  C:\WINDOWS\System32\cmd.exe /k C:\Programs\context\tex\setuptex.bat This starts up a new command shell with the environment pre-loaded. Within the new shell you can just type <code>context</code> to run ConTeXt. E.g.  C:\> context --version to check that you are running the version you think you're running. === Use ConTeXt with Cygwin ===After installing the ConTeXt suite, you can run it under Cygwin. With Cygwin, you may use gmake and other Unix tools for your automated workflow. # Run <code>setuptex.bat</code>in DOS command prompt# In the same DOS prompt, enter Cygwin by running <code>cygwin.bat</code> (in your Cygwin installation directory)# Under Cygwin prompt, run <code> context.cmd test.tex </code>. Note that the <code>.cmd</code> extension is needed under Cygwin. == Updating == If you used the command line method, just run <code>first-setup.bat</code> again to update the suite.  == Uninstallation == If you used the command-line installer, you can just delete the installation directory to uninstall the suite.  == Troubleshooting == * rsync sometimes has problems with paths with uppercase letters (like <code>c:\Temp</code> or <code>C:\Documents and Settings</code>). Installing into all-lowercase paths without spaces sometimes helps.* Directory-name length may also have an effect, due to Windows's 8.3 filename conventions. An indicator is if running "texexec --lua" on a file produces missing-file warnings containing Windows-created 8-character directory names, such as "C:\CONTEX~1\tex", where your ConTeXt directory is really "C:\context_minimals\tex". Be conservative and choose a short name like "C:\ctm\tex". Also, this may even work when an 8-character-or-less directory name like "C:\ctexmin\tex" doesn't.* If you're behind firewall and rsync times out, you need to open port 873 for outgoing TCP connections.* If you update luaTeX occasionally you may get something like  <code>engine mismatch (luv: This is LuaTeX, Version beta-<version>-<date1> (TeX Live 2013/dev)(rev <number1>) <> bin: This is LuaTeX, Version beta-<version>-<date1> (TeX Live 2012/W32TeX)(rev <number2>)), forcing remake</code> In which case your format will be remade every time you compile a file. In /texmf-mswin make sure that luatex.exe and texlua.exe have the same date; then also delete luatex.dll. This usually solves the problem. = Installing third party modules = The ConTeXt suite only comes with Taco's [[Bibliography|t-bib]] module. If you want to install [http://modules.contextgarden.net/ a new module], say Wolfgang's [[Letter|t-letter]] module, you can use first-setup.sh --modules="t-letter" If you want to install more than one extra module, you can separate them by commas. So, to install the t-letter and t-mathsets module, do sh ./first-setup.sh --modules="t-letter,t-mathsets" If you want to install all extra modules at once, do sh ./first-setup.sh --modules=all = Reverting to an older installation = If, for some reason, you want to revert to an older installation, you can do that by  sh ./first-setup.sh --context=date where <code>date</code> is the date of one of the stable releases of ConTeXt. The complete list of old releases that are available is [http://minimals.contextgarden.net/current/context/ here].  = Moving the installation tree around =  According to this post, http://archive.contextgarden.net/message/20101129.144331.d721372f.en.html it's safe to move the installation tree across directory or machines (say you don't have broadband access). You just have to clean and regenerate the cache (./tex/texmf-cache/luatex-cache) with mtxrun --generate = Notes =<references/> {{Installation navbox}} [[Category:Installation]][[Category:Standalone]]