Changes

< {{note|You almost certainly want to [[Installation]] | '''[[ConTeXt Minimals/Tree]]''' | [[ConTeXt Minimals/Structure]] | [[ConTeXt Minimals/Implementation]] | [[ConTeXt Minimals/TODO]] | [[install the newer ConTeXt Minimals/ContentsLMTX]] >. This guide is for installing the older, rarely-updated MkIV distribution.}}

They are hosted on The '''http://minimals.contextgarden.netConTeXt suite''' (equivalent is a complete, up-to '''rsync://contextgarden-date ConTeXt distribution that can be upgraded efficiently. It can also be used in parallel with existing TeX installations such as MikTeX, TeXLive, and so forth.net/minimals/''')The suite does not include LaTeX packages and binaries.

Everyone is invited Sometimes ConTeXt beta releases have issues. The ConTeXt suite allows you to test this distributionthe latest ConTeXt release without worrying whether upgrading will corrupt a critical project. Multiple ConTeXt suite installations are possible. This allows, but is kindly asked for patience example, a stable version and understanding until we tidy up the details. You need a beta version to have '''rsync''' installed, for windows it's shipped together with run in parallel on the minimalssame computer.

{{TOClimit|limit== Linux/Mac/FreeBSD/Solaris ==1}}

=== Prerequisites ==General Information =

You need '''rsync''', '''ruby''', around 200 MB free disk space (might change with time) and one of supported == Supported platforms (see below).==

{| style="border:1px solid #DDDDDD;"|- align="left" ! Platform! Short name! Notes|- align= Installation "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| |- align="left" style="background-color:#EEEEEE;"! Linux, 32-bit| linux| Debian 8|- align="left"! Linux, 64-bit| linux-64| Debian 8|- align="left" style="background-color:#EEEEEE;"! Linux, ARM (low end.)| linux-arm| Raspbian 8|- align="left"! Linux, musl| linuxmusl-64| Alpine|- align="left" style="background-color:#EEEEEE;"! Mac OS X, Intel (64-bit)| 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, Intel| solaris-intel| Solaris 10 on [http://www.opencsw.org/about/ OpenCSW]|- align="left" style="background-color:#EEEEEE;"! Solaris, Sparc| solaris-sparc| Solaris 10 on [http://www.opencsw.org/about/ OpenCSW]|} * If you run into problems installing, check the available architectures in the minimal’s [http://minimals.contextgarden.net/setup/ setup folder]!* OpenBSD 6.4 binaries are compiled but are missing in the setup folder ATM (2019-07) If you want to support a new platform, please write to the [[Mailing Lists]]

Go to a folder where you want to put ConTeXt. We'll assume installation into <code>~/context</code>, but you can install it anywhere where you have writing permissions. You can install several copies to several places without interference. == Dependencies ==''* Rsync (Mac users can also take a look at [[ConTeXt Minimals/Mac Installation]].The windows binary of rsync is distributed within the suite)''

''* curl : for including remote content* ghostscript : for converting PostScript images to PDF* graphicsmagick (For those who mostly use ConTeXt convert) : for converting GIF and [almost] never LaTeX.TIFF images* inkscape : for converting SVG and compressed SVG* mupdf (mudraw) : for converting PDF to PNG (used for ePub covers)''* pstoedit : for converting PostScript to MetaPost outlines* zint : for providing barcodes* zip or 7zip : for EPUB generation

Put the following line to <code>~/.bash_profile</code> or <code>~/.bashrc</code>: source ~/context/tex/setuptex ~/context/tex== Disc space required ==ConTeXt macro files are small (tless than 10MB)csh users can use , but the variant: source ~/context/tex/setuptexsuite comes with various free fonts which considerably increase the size of the distribution (to around 200MB).csh

In theory it should already suffice == Multiple instances of the installation ==Please note from the start that we recommend installing a complete ConTeXt installation for each project in a production environment. The installation tree is portable (see Moving the Installation Around, below) and can be located under the project's own directory. The advantage is to allow each project to use an instance of ConTeXt that is adapted to its coding and that only gets updated purposely. Since the ConTeXt Standalone is "bleeding edge" and subject to add <code>export PATH=~/context/tex/texmf-<platform>/bin:$PATH</code>development, certain details in commands, syntax or rendering may evolve slightly. Having a vintage ConTeXt tree for each production project insures that one can come back years later and produce identical results.

Just type* [[ConTeXt Standalone/FAQ|Standalone/FAQ]] * [[ConTeXt Standalone/Structure|Standalone/Structure]] . ~* [[ConTeXt Standalone/Implementation|Standalone/contextImplementation]]* [[ConTeXt Standalone/texTODO|Standalone/setuptex ~TODO]] * [[ConTeXt Standalone/contextContents|Standalone/texContents]] to switch from system-wide * [[ConTeXt Standalone/TeX Live|Standalone/TeX distribution to Live]]* Browse the [http://minimals inside current shell.contextgarden.net installation tree]

=== Uninstalling ==Unix-like platforms (Linux/MacOS X/FreeBSD/Solaris) =

Just remove the folder === (distribution did not touch anything elseMacOS X)Using the Command line: rm -rf ~/contextTerminal.app ===

(Not sure if Once you have started Terminal, all you ''have'' to run do is enter a command and press the RETURN-key and the first command); ctxtools --updatewill be executed.

luatools {{note|You almost certainly want to [[Installation|install the newer ConTeXt LMTX]]. This guide is for installing the older, rarely--ini --compile --verbose cont-uk cont-enupdated MkIV distribution.}}

=== Installationor (MacOS):<pre> mkdir ~/context cd ~/context rsync -av rsync://contextgarden.net/minimals/setup/first-setup.sh .</pre>Since the Mac does not have `wget` pre-installed. Now run the `first-setup.sh` script:<pre> # 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: global & GUI # --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

''(For those who don't need MikTeX sh ./TeX Live and prefer Graphical user interfacefirst-setup.)''sh --modules=all</pre>

Download and run [http://minimals.contextgarden.net/setup/context== System-installer/ContextMinimalInstall.exe the GUI installer] (made by Vyatcheslav Yatskovsky).wide installation ==

Slides from authorA system wide installation is 's presentation can be downloaded [http://meeting''only''' recommended for experienced users.contextgarden.net/2008/talks/2008You will need administrator rights on the Mac as only administrators are allowed to install programs in the Applications folder, or root (sudo) privileges on other unix-08-21-vyatcheslav-win-installer/windows_installer.pdf here]like systems.

=== InstallationNote that, at present, while ''using'' MkIV, you need to have write permissions for the <code>$TEXMFCACHE</code> directory. This effectively means that only one user will be able to generate the formats unless you set the group permissions appropriately. For example: local & command-line ===

''(For those who need MikTeX* <code>CONTEXT_HOME=/TeX Live and are comfortable with commandopt/context</code>* <code>TEXMFCACHE=$CONTEXT_HOME/tex/texmf-line.)''cache</code>* <code>chmod -R g+w $TEXMFCACHE</code>

Download and unzip {{note|You almost certainly want to [http://minimals[Installation|install the newer ConTeXt LMTX]].contextgarden.net/setup/contextThis guide is for installing the older, rarely-setup-mswinupdated MkIV distribution.zip context-setup-mswin.zip]}}

Run <codepre> # 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.bat</code>sh # Install the latest beta of ConTeXt # This takes a long time, so go for 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

Before being able to use ConTeXt you need to run setuptex sh .bat to initialize the environment/first-setup. A simple way to do it is to create a file <code>startcontext.bat</code> (use any name) somewhere in PATH and put this line into itsh --modules=all

C # change ownership to real rather than effective id chown -R `id -r -u`:\Programs\context\tex\setuptex`id -r -g` .bat C:\Programs\context\tex</pre>

For uninstalling just delete To customize the folder with minimalscache directory and other options, see the [[Custom_Configuration|Custom Configuration]] page.

=== Troubleshooting Font Directory===

* rsync sometimes has problems with paths with uppercase letters (like c:\Temp or c:\Documents and Settings)Add the OSFONTDIR into . Installing into all-lowercase paths without spaces sometimes helps/tex/setuptex.* If you're behind firewall and rsync times out you need Go to open port 873 for outgoing TCP connections.under the line:

The minimals contain:* '''ConTeXt'(if you don'': currentt have the line above, beta + some older releases* '''Fonts''': most important TeX-aware ones* '''Binaries''': latest version go to the end of pdfTeX, XeTeX, LuaTeX, Metapost* '''Formats''' (need to be generated by userthe file) for** ConTeXt, mptopdf and plain TeX for pdfTeX/XeTeX/LuaTeX** metafun and plain for Metapostadd there:

See [[ConTeXt Minimals export OSFONTDIR="/usr/local/share/fonts;$HOME/Contents]].fonts"

=== What to install ===* --'''platform'''=''name-of-platform'' (see supported platforms; default: the one we are working on)* --'''engines'''=''list-of-engines'' (options: luatex, xetex, pdftex, all; default: '''all''')* --'''context'''=''version'' (options: current, beta, alpha, ''yyyy.mm.dd''; default: '''current''')=== What to do ===* --'''force''' (as opposed to --dryrun; do the real thing; this is '''needed''') ''needs to be fixed''* --'''update''' (update minimal tree)* --'''make''' (make formats and generate file databases)* --state (update tree using saved state) ''needs to be implemented/fixed''* --keep (as apposed to --delete; don't delete unused or obsolete files) ''needs to be improved''=== Where to install ===* --'''texroot'''=''path'' (Apache webserver installation path; default: '''tex''')=== Rsync Server ===''(currently there's only one anyway)''* --'''server'''=''repository-url'' (default: '''<code>rsync://contextgarden.net</code>''')* --'''module'''=''string'' (default: '''minimals''')* --'''rsync'''=''name-of-rsync-binary'' (default: '''rsync''') ''Why do we need this?''

{| style="borderIn 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:1px solid //minimals.contextgarden.net/setup/first-setup.sh #DDDDDD;"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:| # -- alignmodules="left" styleall # Install all third-party modules # --context="backgroundlatest # Install latest stable version # --color:engine=luatex # Install only MkIV, leave out MkII # #EEEEEE;"This shrinks the install from 270 MB to 200 MB  sh ./first-setup.sh --modules=all! Windows</pre>| mswin| Akira Kakuto Once installed, you need to ensure that the permissions are correct for Apache to be able to access it (W32TeXyou will either need <code>sudo</code> privileges or root access): <pre>|$ cd <path-to-document-root>/public|$ sudo chmod -R www-data:www- align="left"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> #! Linux/usr/bin/env bash | linux #| contextgarden # proccontext.netsh # # To be installed in <path-to-document-root>/public/bin | compiled with glibc 2 .3<path-to-document-root>/public/context/tex/setuptex <path-to-document-root>/public/context/tex  cd tex/spool context $1 > /tmp/context_run.6log</pre> |Here the dynamically generated ConTeXt source file is expected to be found in the <code><path-to-document- alignroot>/tex/spool</code> directory. Now within your application, you can invoke this shell script (in this case using PHP): <pre> $cmd ="leftbin/proccontext.sh $input_filename" style; $last_line ="backgroundsystem($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-colorgit PKGBUILD] inthe AUR, provided by Aditya [https:#EEEEEE;"//github.com/adityam/context-pkgbuild].Install it using your favorite AUR frontend, e.g. <pre>yaourt -S context-minimals-git</pre> ! LinuxThis will get you a fresh, 64up-to-bitdate Context tree in| linux<tt>/opt/context-64minimals</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' 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 ==| Peter Münster| we consider renaming 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 linuxdo some initialization. An intialization script called <code>setuptex</code> is provided in <code>installation-amd64dir/tex/</code>.  === Terminal/Command line === To run context from a terminal, source <code>setuptex</code>: | source /installation- aligndir/tex/setuptex ="left"== Exclusive usage === ! Mac OS XIf 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, Intelthe startup script is <code>$HOME/.bashrc</code>; for zsh it is <code>HOME/.zshrc</code>).| osx source /installation-inteldir/tex/setuptex Then <code>setuptex</code> will always be sourced in your terminal. === Integrating with an editor === The easiest way to run ConTeXt from an editor is to open a terminal, source {{code| Mojca Miklavecsetuptex}} in the terminal, and then open your editor '''from the same terminal'''. | Another option is to add {{code|/installation-dir/tex/texmf- align<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 =="left" style 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="backgroundall</pre> To update retain currently-colorinstalled modules:#EEEEEE;"! Mac OS X<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>, PowerPCgo to the installation directory and run {{note|You almost certainly want to [[Installation| osxinstall the newer ConTeXt LMTX]]. This guide is for installing the older, rarely-ppcupdated MkIV distribution.}} | Mojca Miklavec 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 -- aligncontext="left"latest ! Mac OS XBy default, the suite does ''not'' install modules and other third party content. If you want the modules (and have the bandwidth), Universal Binariesyou can use| osx first-setup.bat --universalmodules=all  If the above installation instructions don't seem to answer your questions, see page [[Windows_Installation:_ConTeXt_Suite_with_SciTe| Mojca MiklavecWindows 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.||- align="left" style="backgroundUsage == 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-colorloaded. 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)#EEEEEE;"Under Cygwin prompt, run <code> context.cmd test.tex </code>. Note that the <code>.cmd</code> extension is needed under Cygwin. ! FreeBSD== Updating ==| freebsd| Yue WangIf you used the command line method, Diego Depaolijust run <code>first-setup.bat</code> again to update the suite.  == Uninstallation == | we consider renaming it If you used the command-line installer, you can just delete the installation directory to freebsduninstall 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-intellowercase 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- align=less directory name like "leftC:\ctexmin\tex"doesn't.* If you're behind firewall and rsync times out, you need to open port 873 for outgoing TCP connections.! Solaris* 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>)), Intelforcing remake</code> | solarisIn which case your format will be remade every time you compile a file. In /texmf-intelmswin 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| Michael Krauß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 -- alignmodules="leftt-letter" style 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="backgroundt-color:#EEEEEE;letter,t-mathsets"! SolarisIf 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, Sparcyou can do that by | solaris sh ./first-setup.sh --sparccontext=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].| Vladimir Volovich| compiled on solaris 8|}= Moving the installation tree around =