Changes

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

The '''MinimalsConTeXt suite''' are an attempt is a complete, up-to provide the same functionality as the current [http://www.pragma-adedate ConTeXt distribution that can be upgraded efficiently.com/download-1It can also be used in parallel with existing TeX installations such as MikTeX, TeXLive, and so forth.htm Pragma's minimal ConTeXt distributions] in the zip filesThe suite does not include LaTeX packages and binaries.

They Sometimes ConTeXt beta releases have issues. The ConTeXt suite allows you to test the latest ConTeXt release without worrying whether upgrading will corrupt a critical project. Multiple ConTeXt suite installations are hosted on http://minimalspossible.contextgarden.net (equivalent This allows, for example, a stable version and a beta version to '''rsync://contextgarden.net/minimals/''')run in parallel on the same computer.

Everyone ConTeXt is invited to test this distributionalso included in TeXlive. The ConTeXt suite is updated continuously, but whereas ConTeXt in TeXlive is kindly asked for patience updated less often. In particular, <code>luatex</code> and understanding until we tidy up <code>metapost</code> are under active development and their binaries are updated frequently. ConTeXt follows these developments, indeed often drives development. As the binaries included in the detailsTeXlive distribution are only updated yearly, ConTeXt on TeXlive will necessarily be less current than the ConTeXt suite. You need to have '''rsync''' The ConTeXt suite is self-contained and can happily coexist alongside another installed, for windows it's shipped together with the minimalsTeX distribution.

{{TOClimit|limit= Goals =1}}

The minimals contain{| style="border:1px solid #DDDDDD;"* ConTeXt|- 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* Fonts|- align="left" style="background-color: most important TeX#EEEEEE;"! Windows, 32 bit| win32| Alias for mswin|-aware onesalign="left"* pdfTeX! Windows, XeTeX64 bit| win64| |- align="left" style="background-color:#EEEEEE;"! Linux, LuaTeX and Metapost 32-bit| linux| Debian 8|- align="left"! Linux, 64-bit| linux-64| Debian 8|- align="left" style="background-color:#EEEEEE;"! Linux, 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* (Solaris)* 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)

The needed files following programs are under:* http://minimals.contextgarden.net/setup/Well, to be honestnot required for running ConTeXt, all you need to run it on linux/mac is this script (the rest of files will be downloaded autematically):* http://minimals.contextgarden.net/setup/linux/first-setup.sh (<code>rsync -av rsync://contextgarden.net/minimals/setup/linux/first-setup.sh .</code>)Take a look at it, modify it if needed and run it. On Windows you can either take that command-line version from the zip or* [http://minimals.contextgarden.net/setup/context-installer/ContextMinimalInstallbut their installation adds additional functionality.exe Vyatcheslav's Windows Installer] with a GUI

* 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 about 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'Please ' 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.}} <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 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  # change ownership to real rather than effective id chown -R `id -r -u`:`id -r -g` .</pre> ===Cache=== To customize the cache directory and other options, see the [[Custom_Configuration|Custom Configuration]] page. ===Font Directory=== Add the OSFONTDIR into ./tex/setuptex. Go to under the line:  # TODO: we could set OSFONTDIR on Mac for example (if you don't have the line above, go to the end of the file) and add there:  export OSFONTDIR="/usr/local/share/fonts;$HOME/.fonts" For more information: [[Fonts in LuaTeX]] == 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 location permissions are correct for Apache to be able to access it (you will either need <code>sudo</code> privileges or name 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 simple 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 change!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 == 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</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 (It's a really stupid oneFor bash, one could also call the startup script is <code>$HOME/.bashrc</code>; for zsh it a prototypeis <code>HOME/.zshrc</code>).  source /installation-dir/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|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.

For nowupdating the ConTeXt suite, the main recipe to first update is to run <code>first-setup.sh</code> again, 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. A 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 similar -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>ctxtools --updatecontextcmd.exe</code> might be provided in , 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 futuresuite installs ConTeXt beta.If you want the stable version of ConTeXt, you can use   first-setup.bat --context=latest

first-setup.bat --modules= TODO =all

We need If the above installation instructions don't seem to:* create files <code>README INSTALL</code>* create a file <code>minimals.lua</code> (or some other self-explanatory name):** <b>rsync location</b> (default: <code>rsync://contextgarden.net/minimals</code>, could be anything)** ??? <b>installation location</b> (default is simply the current location (<code>pwd</code>))** <b>engines</b> (default: all - pdftex, xetex, luatexanswer your questions, metapost)** <b>formats</b> (defaultsee page [[Windows_Installation: english + dutch context for all the installed engines, metapost, metafun; optional_ConTeXt_Suite_with_SciTe| Windows Installation: other interfaces, plain pdftex, xetex)** <b>fonts</b> (need to be reorganized/improved anyway, perhaps a list of fonts should be fetched)** once in the future: <b>supported font encodings ConTeXt Suite with SciTe]] for pdftex</b> (default: texnansi, ec, optional: greek, t5, t2a, t2b, t2c, more detailed information...)** <b>third party modules</b> (list needs to be fetched form the garden, default)** <b>context version</b> (default: current, other options: beta, highly-experimental (for "Hans-and-Taco-only"), specific-date <font color="red">in the case of a fixed version issue a warning at next update</font>)** <b>interactive flag</b>: shoud the script ask for changes interactively again or should it simply reaspect & use them (defaut: interactive for the first time, after that automatic)

* improve <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)** does rsync to installation files themselves (in case mtx-update has changed in the mean time)** reads in <code>minimals.lua</code> (which engines, formats, fonts, modules to download ...) if interactive is set to true, ask for default == Proxy 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</code> (or equivalent locations) to have context initilized automatically==

set RSYNC_PROXY= Binaries =username:password@proxyhost:proxyport

Binaries are mostly taken from TeX Live 2007, but new ones are used whenever availableor set the variable permanently as a Windows environment variable.

== Origin 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 binaries ==firewall and to tunnel port 873 (using the program <code>nc</code>).

* TeX Live 2007 for most binaries and most platforms* Akira export RSYNC_CONNECT_PROG='ssh tunnelhost nc %H 873's [http://www.fsci.fuk.kindai.ac.jp/kakuto/win32-ptex/web2c75-e.html W32TeX] for windows binaries (including metapost, LuaTeX, pdfTeX and XeTeX) - automatic* for pdfTeX, XeTeX, LuaTeX and metapost for other platforms added manually whenever possible (nice if it could be automated, but no idea how)* texmf/scripts/context/stubs from ConTeXt

== List where <code>tunnelhost</code> is the machine outside of included binaries ==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.

=== Core binaries =Usage ==''We will do our best Before running ConTeXt, you need to keep them as up to date as possiblerun <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. If they're still not up To avoid always having to date for your platform and type this, you know where can create a shortcut to find them, please notify us, we will fix thatcmd. We might provide XeTeX exe and LuaTeX edit the command line to read (assuming you installed the suite in separate packages (on TODO list<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. * pdftex C:\> context --version* luatex* texlua, texluac to check that you are running the version you think you''(only symlinks on "unix" platforms, in Akira's distribution luatexre running.dll is used + 3 small executables)''* xetex, xdvipdfmx* ''metapost''=== Use ConTeXt with Cygwin ===** dvitompAfter installing the ConTeXt suite, you can run it under Cygwin. With Cygwin, you may use gmake and other Unix tools for your automated workflow.** makempx** mpost# Run <code>setuptex.bat</code> in DOS command prompt** mpto ''# In the same DOS prompt, enter Cygwin by running <code>cygwin.bat</code> (can this be replaced by ConTeXt's variant in future?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 ==

==Uninstallation = Font-related ===''Might be removed or moved to a special category of "font-related binaries", and only available as an additional package.''* ''only left for testing** afm2pl** afm2tfm** ttf2afm* Knuth's** pltotf** tftopl** vftovp** vptovf

=== MightIf you used the command-be-removed-soon ===* dvipdfmx* dvipsline installer, you can just delete the installation directory to uninstall the suite.

The Minimals provide several versions of ConTeXt:* stable* beta (suggested for living-on-the-edge ones; will default to stable if not available)* alpha (rarely used; will use beta if not available)* experimental (only for testing - not meant for general use)* date-based ones (currenty only a few versions available - planning to improve)You can use --context=XXXto get the desired version.= Troubleshooting ==

Fonts are split in three packages<code>engine mismatch (luv:* used in both pdfTeX and XeTeXThis is LuaTeX, Version beta-<version>-<date1> (TeX Live 2013/LuaTeX: mostly math dev)(pfb, map, enc, tfmrev <number1>)* used in pdfTeX only<> bin: pfbThis is LuaTeX, map, enc, tfm Version beta-<version>-<date1> (TeX Live 2012/W32TeX)(those that are not present in "common"rev <number2>)* used in XeTeX), forcing remake</LuaTeX only: otfcode>

Currently we 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 latest version, in sync with CTAN):* Latin Modern* Antykwa Torunska* Iwona & Kurier* TeX Gyre* amssame date; then also delete luatex.dll. This usually solves the problem.

It is possible that weThe ConTeXt suite only comes with Taco'll provide s [[Bibliography|t-bib]] module. If you want to install [http://modules.contextgarden.net/ a really minimal package with LM onlynew module], and additional three packages (common, for new TeXsay Wolfgang's [[Letter|t-letter]] module, for old TeX) with all the other fontsyou can use first-setup.sh --modules="t-letter"

= ThirdIf 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 --party modules & Other ="t-letter,t-mathsets"

* TODOIf you want to install all extra modules at once, do* also cont sh ./first-* from Hans's pagesetup.sh --modules=all

= Documentation Reverting to an older installation =

sh ./first-setup.sh --context= Implementation =date

See 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 [[New ConTeXt Minimals (Implementation)|implementation]http://minimals.contextgarden.net/current/context/ here] page.

''Ein Teil von jener Kraft, / Die stets das Böse will, und stets das Gute schafft.'' <code>:-)= Notes =<references/code>