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= "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]] == Dependencies ==* Rsync (The windows binary of rsync is distributed within the suite)  The following programs are not required for running ConTeXt, but their installation adds additional functionality. * curl : for including remote content* ghostscript : for converting PostScript images to PDF* graphicsmagick (convert) : for converting GIF and 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 == Disc space required ==ConTeXt macro files are small (less than 10MB), but the suite comes with various free fonts which considerably increase the size of the distribution (to around 200MB). == 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 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. So as not to get carried away under this approach, one can eventually group projects by vintage, period or season, according to cycles of productivity. == Standalone == * [[ConTeXt Standalone/FAQ|Standalone/FAQ]] * [[ConTeXt Standalone/Structure|Standalone/Structure]] * [[ConTeXt Standalone/Implementation|Standalone/Implementation]]* [[ConTeXt Standalone/TODO|Standalone/TODO]] * [[ConTeXt Standalone/Contents|Standalone/Contents]] * [[ConTeXt Standalone/TeX Live|Standalone/TeX Live]]* Browse the [http://minimals.contextgarden.net installation tree]   = Unix-like platforms (Linux/MacOS X/FreeBSD/Solaris) = === (MacOS X) Using the Command line: Terminal.app === If you do not what a command tool is, do not worry. It is simply a program in which commands are entered as text and then executed. The needed Terminal.app can be found in the Utilities-folder of the Applications-Folder. Once you have started Terminal, all you have to do is enter a command and press the RETURN-key and the command will be executed.  == Single user installation == Select a folder where you want to install ConTeXt. We recommend that you can use your <code>$HOME/context</code> directory. Create this folder. Then download and place it in <code>$HOME/context</code> directory. Open a terminal, then ... execute (Linux/FreeBSD/Solaris): {{note|You almost certainly want to [[Installation|install the newer ConTeXt LMTX]]. This guide is for installing the older, rarely-updated MkIV distribution.}} <pre> mkdir ~/context cd ~/context wget http://minimals.contextgarden.net/setup/first-setup.sh</pre> or (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: # --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> == System-wide installation == A system wide installation is '''only''' recommended for experienced users. You 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-like systems. * on Linux you can use <code>/opt/context</code>* on MacOS X you can use <code>/Applications/ConTeXt</code> Note 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: * <code>CONTEXT_HOME=/opt/context</code>* <code>TEXMFCACHE=$CONTEXT_HOME/tex/texmf-cache</code>* <code>chmod -R g+w $TEXMFCACHE</code> {{note|You almost certainly want to [[Installation|install the newer ConTeXt LMTX]]. This guide is for installing the older, rarely-updated MkIV distribution.}}

Go to a folder where <pre> # Create the /opt/context directory -- change as appropriate or desired if you # want to put ConTeXta different installation directory. We'll assume installation into <code>~ cd /opt mkdir context cd context< # Fetch the install script (use rsync on the mac, see above) wget http://minimals.contextgarden.net/setup/code>first-setup.sh # Install the latest beta of ConTeXt # This takes a long time, but so go have a coffee # Flags you can install it anywhere where you have writing permissionsadd to the first-setup. You can 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 several copies from 270 MB to several places without interference. ''(Mac users can also take a look at [[ConTeXt Minimals/Mac Installation]].)''200 MB

mkdir context && cd context rsync -ptv rsync://contextgarden sh .net/minimals/setup/first-setup.sh . ./first-setup.sh''... go and have a coffee ...''-modules=all

=== Usage # change ownership to real rather than effective id chown -R `id -r -u`: permanent ===`id -r -g` .</pre>

Put To customize the following line to <code>~/.bash_profile</code> or <code>~/.bashrc</code>: source ~/context/tex/setuptex ~/context/tex(t)csh users can use cache directory and other options, see the variant: source ~/context/tex/setuptex[[Custom_Configuration|Custom Configuration]] page.csh

In theory it should already suffice to add <code>export PATH=~/context/tex/texmf-<platform>/bin:$PATH</code>.==Font Directory===

=== UsageAdd the OSFONTDIR into ./tex/setuptex. Go to under the line: temporary ===

Just type . ~/context/tex/setuptex ~/context/texto switch from system-wide TeX distribution (if you don't have the line above, go to the minimals inside current shell.end of the file) and add there:

export OSFONTDIR=== Updating ==="/usr/local/share/fonts;$HOME/.fonts"

For now just run <code>./first-setup.sh</code> again. This will change - the name is not most self-explanatory at the moment.In theory mtxrun --script updateshould work, but it has not been tested yet.more information: [[Fonts in LuaTeX]]

=== Uninstalling =Apache webserver installation ==

Just remove 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 folder (distribution did not touch anything else)directory and its contents are assigned to a user and group without a login shell, e.g., <code>www-data: rm www-rf ~data</contextcode> this prevents a web application from invoking a ConTeXt installation done using either the single-user or system-wide method listed above.

(Not sure if you ''have'' For example, in the case of the PHP web framework Laravel, ConTeXt can be installed alongside other assets in the <path-to run the first command); ctxtools -document-updateroot>/public/context directory:

texexec <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-make setup.sh call: # --modules=all # Install all third-party modules # --context=latest # Install latest stable version # --pdftex uk enengine=luatex # Install only MkIV, leave out MkII # # This shrinks the install from 270 MB to 200 MB

texexec sh ./first--make setup.sh --modules=all --xetex uk en</pre>

luatools <pre>$ cd <path-to-ini document-root>/public$ sudo chmod -compile R www-data:www-verbose cont-uk cont-endata context</pre>

''(For those who don't need MikTeX # # proccontext.sh # # To be installed in <path-to-document-root>/TeX Live and prefer Graphical user interface.)''public/bin

Download and run [http: . <path-to-document-root>/public/context/tex/minimals.contextgarden.netsetuptex <path-to-document-root>/setuppublic/context-installer/ContextMinimalInstall.exe the GUI installer] (made by Vyatcheslav Yatskovsky).tex

Slides from author's presentation can be downloaded [http: cd tex/spool context $1 > /meeting.contextgardentmp/context_run.net/2008log</talks/2008-08-21-vyatcheslav-win-installer/windows_installer.pdf here].pre>

Use standard windows tool for uninstalling Here the applicationdynamically generated ConTeXt source file is expected to be found in the <code><path-to-document-root>/tex/spool</code> directory.

=== InstallationNow within your application, you can invoke this shell script (in this case using PHP): local & command-line ===

''(For those who need MikTeX<pre> $cmd = "bin/TeX Live and are comfortable with command-lineproccontext.sh $input_filename"; $last_line = system($cmd, $ret_val)'';</pre>

Download and unzip [http:And the output will once again be found in <code><path-to-document-root>/tex/minimals.contextgarden.netspool</setup/context-setup-mswin.zip context-setup-mswincode>.zip]

Run <code>first==Arch Linux==There’s a [https://aur.archlinux.org/packages/context-minimals-setupgit PKGBUILD] inthe AUR, provided by Aditya [https://github.bat<com/adityam/code>context-pkgbuild].Install it using your favorite AUR frontend, go for a coffeee.g.

Before being able to use ConTeXt you need to run setuptex.bat to initialize the environment. A simple way to do it is to create a file <codepre>startcontext.batyaourt -S context-minimals-git</codepre> (use any name) somewhere in PATH and put this line into it

C:\Programs\This will get you a fresh, up-to-date Context tree in<tt>/opt/context\tex\setuptex-minimals</tt>.bat C:\Programs\context\tex

Another method is to create 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 shortcut to cmdlook at the [[ConTeXt Standalone Funtoo]] Howto.exe and edit the command line to read CThis might also work for [http:\WINDOWS\System32\cmd//www.exe /k C:\Programs\context\tex\setuptexgentoo.bat C:\Programs\context\texThis starts up a new command shell with the environment pre-loadedorg gentoo], but is untested right now.

* rsync sometimes has problems with paths with uppercase letters (like c export RSYNC_PROXY=username:\Temp or cpassword@proxyhost:\Documents and Settings). Installing into all-lowercase paths without spaces sometimes helps.* If you're behind firewall and rsync times out you need to open port 873 for outgoing TCP connections.proxyport

The minimals contain:* export RSYNC_CONNECT_PROG='ssh tunnelhost nc %H 873''ConTeXt''': current, beta + some older releases* '''Fonts''': most important TeX-aware ones* '''Binaries''': latest version of pdfTeX, XeTeX, LuaTeX, Metapost* '''Formats''' (need to be generated by user) for** ConTeXt, mptopdf and plain TeX for pdfTeX/XeTeX/LuaTeX** metafun and plain for Metapost

See [[ConTeXt Minimalswhere <code>tunnelhost</Contents]]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.

= Configuration = Usage ==

=== What to install ===* ConTeXt suite works in a non--'''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.mminterfering manner because it does not put anything in your <code>$PATH</code> and does not set any system variables.dd''; default: '''current''')=== What This in turn means that in order to do ===* --'''force''' (as opposed use it, you need to --dryrun; do the real thing; this some initialization. An intialization script called <code>setuptex</code> 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'' (installation path; default: '''tex''')=== Rsync Server ===''(currently there's only one anyway)''* --'''server'''=''repository-url'' (default: '''provided in <code>rsync:installation-dir/tex/contextgarden.net</code>''')* --'''module'''=''string'' (default: '''minimals''')* --'''rsync'''=''name-of-rsync-binary'' (default: '''rsync''') ''Why do we need this?''.

= Supported platforms == Terminal/Command line ===

{| style="borderTo run context from a terminal, source <code>setuptex</code>:1px solid #DDDDDD;"| source /installation- aligndir/tex/setuptex === Exclusive usage =="left" style="background 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-color:#EEEEEE;"dir/tex/setuptex Then <code>setuptex</code> will always be sourced in your terminal. ! Windows=== Integrating with an editor ===| mswinThe easiest way to run ConTeXt from an editor is to open a terminal, source {{code| Akira Kakuto (W32TeX)setuptex}} 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"= 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:! Linux<pre>| linuxcd /opt/context| rsync -ptv rsync://contextgarden.net/minimals/setup/first-setup.sh .| compiled with glibc 2sh .3/first-setup.6sh --modules=all</pre> |To update retain currently-installed modules:<pre>sh ./first-setup.sh -- alignkeep</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 ="left" style="background 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 --color:#EEEEEE;"make = Windows = ! LinuxIf you want to use ConTeXt suite alongside MikTeX/TeXLive (needed if you also run LaTeX), 64follow the command-bitline installation method.  | linux== 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-64win64.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| Peter Münster{{note| we consider renaming it You almost certainly want to linux[[Installation|install the newer ConTeXt LMTX]]. This guide is for installing the older, rarely-amd64updated 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 -- aligncontext="left"latest ! LinuxBy default, the suite does ''not'' install modules and other third party content. If you want the modules (and have the bandwidth), PowerPCyou can use | linux first-setup.bat --ppcmodules=all  If the above installation instructions don't seem to answer your questions, see page [[Windows_Installation:_ConTeXt_Suite_with_SciTe| Piotr KopszakWindows Installation: ConTeXt Suite with SciTe]] for more detailed information.||- align="left" style="background-colorProxy 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:#EEEEEE;"proxyport or set the variable permanently as a Windows environment variable. ! Mac OS XSometimes, Intelwhen 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'| osx-intel| Mojca Miklavecwhere <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"= Usage == ! Mac OS XBefore running ConTeXt, PowerPCyou need to run <code>setuptex.bat</code> which is provided in <code>installation-dir\tex\</code>. This can be done by typing| osx installation-ppcdir\tex\setuptex.bat| Mojca Miklavec|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 -- alignversion to check that you are running the version you think you're running. === Use ConTeXt with Cygwin =="left" style="background-color: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#EEEEEE;"In the same DOS prompt, enter Cygwin by running <code>cygwin.bat</code> (in your Cygwin installation directory)! Mac OS X# Under Cygwin prompt, Universal Binariesrun <code> context.cmd test.tex </code>. Note that the <code>.cmd</code> extension is needed under Cygwin. == Updating ==| osxIf you used the command line method, just run <code>first-universalsetup.bat</code> again to update the suite. | Mojca Miklavec|== Uninstallation == |If you used the command- alignline installer, you can just delete the installation directory to uninstall the suite.  == Troubleshooting =="left"! FreeBSD| freebsd* 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.| Yue Wang* Directory-name length may also have an effect, Diego Depaoli| we consider renaming it due to freebsdWindows's 8.3 filename conventions. An indicator is if running "texexec -intel|- align=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"left. Be conservative and choose a short name like " style=C:\ctm\tex"background. Also, this may even work when an 8-character-or-colorless directory name like "C:#EEEEEE;\ctexmin\tex"doesn't.! FreeBSD* If you're behind firewall and rsync times out, AMD64you need to open port 873 for outgoing TCP connections.| freebsd* 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-amd64mswin 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"! SolarisIf you want to install more than one extra module, you can separate them by commas. So, Intelto install the t-letter and t-mathsets module, do| solaris sh ./first-setup.sh --modules="t-letter,t-intelmathsets"| Michael Krauß|If you want to install all extra modules at once, do| sh ./first-setup.sh -- alignmodules="left" styleall = Reverting to an older installation ="background-color:#EEEEEE;"! SolarisIf, 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 =