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.}}

{{Note | The '''ConTeXt develops at suite''' is a fast pacecomplete, and sometimes beta releases have serious bugs. ConTeXt minimals allow you up-to test the latest -date ConTeXt release without having to worry if an upgrade will mess an critical projectdistribution that can be upgraded efficiently. You It can have two (or multiple) also be used in parallel ConTeXt minimalswith existing TeX installations such as MikTeX, TeXLive, and freeze one for your critical projects, so forth. The suite does not include LaTeX packages and use the other one for experimentingbinaries.}}

| short ! Short name| Binarties from| ! Notes

| Akira Kakuto (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

! Windows, 64 bit| win64| |- align="left" style="background-color:#EEEEEE;"! Linux, 32-bit

| contextgarden.net| compiled with glibc 2.3.6Debian 8|- align="left" style="background-color:#EEEEEE;"

| Peter MünsterDebian 8|- align="left" style="background-color:#EEEEEE;"! Linux, ARM (low end.)| Should be renamed to linux-amd64arm| 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

! LinuxFreeBSD, PowerPC| linux32-ppcbit| Piotr Kopszakfreebsd

! Mac OS XFreeBSD, Intel64-bit| osxfreebsd-intel| Mojca Miklavecamd64

! Mac OS XOpenBSD 6.4, PowerPC| osx32-ppcbit| Mojca Miklavecopenbsd6.4

! Mac OS XOpenBSD 6.4, Universal Binaries64-bit| osxopenbsd6.4-universal| Mojca Miklavecamd64

! FreeBSD| freebsdOpenBSD 6.5, 32-bit| Yue Wang, Diego Depaoliopenbsd6.5| Should be renamed to freebsd-intel

! FreeBSDOpenBSD 6.5, AMD6464-bit| freebsdopenbsd6.5-amd64| Michael Krauß|

| Michael Krauß|Solaris 10 on [http://www.opencsw.org/about/ OpenCSW]

| Vladimir Volovich| compiled Solaris 10 on solaris 8[http://www.opencsw.org/about/ OpenCSW]

We need volunteers for providing * 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 for other platforms. are compiled but are missing in the setup folder ATM (2019-07) If you want to support a new platform, please write to the [[ConTeXt 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.

== Dependences ==* curl : for including remote content* ghostscript : for converting PostScript images to PDF* graphicsmagick (convert) : for converting GIF and TIFF images* Ruby 1.8inkscape : for converting SVG and compressed SVG* Rsync mupdf (The windows binary of rsync are distributed with the minimalsmudraw): 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

ConTeXt macro files are small (less than 10MB), but the minimals suite comes with various free fonts which considerable 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.}} <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

== Installation tree == # change ownership to real rather than effective idBrowse the [http chown -R `id -r -u`:`id -r -g` .<//minimals.contextgarden.net installation tree]pre>

= Installation and use on Unix like platforms (Linux/Mac/FreeBSD/Solaris) ==Cache===

To customize the cache directory and other options, see the [[Custom_Configuration|Custom Configuration]] page. == Installation =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:

Select a folder where you want to install ConTeXt. For a single user installation, you can use your <codepre>$HOME/context cd </code> directory. For a multipath-user installation, in Linux you can use<code>/opt/code</code>; in Mac you can use <code>/Applications/ConTeXt</code> Note that, at present, while ''using'' MKIV, you need to have write permissions<ref>Actually, you only need write permission for <code-document-root>$TEXMFCACHE</code>.</ref> in the installation directory. In order to install the minimals, ownload [public mkdir context cd context wget http://minimals.contextgarden.net/setup/first-setup.sh first-setup.sh], and place it in your installation directory. Then open a terminal, go to the installation directory, and run

# 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 takes will get you a long timefresh, so go have a coffeeup-to-date Context tree in<tt>/opt/context-minimals</tt>.

sh 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:/first-setup/www.gentoo.org gentoo], but is untested right now.sh --context=current

== Usage Proxy settings ==

ConTeXt minimals works in a non-interfering manner because it does not put anything in your The installation script uses <code>$PATHrsync</code> and does not set any system variablesto fetch the required files. This in turn means that in order to use itSo, if you are behind a proxy server, you need to do some initializationtell the details to rsync. An intialization script called The easiest way to set this is to set <code>setuptexRSYNC_PROXY</code> is provided variable in the terminal or your startup script (<code>installation-dir/tex/.bashrc</code>or the corresponding file for your shell). Replace username, password, proxyhost and proxyport with the correct information

* '''bash''' users 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 use source be used is to connect to a computer located somewhere outside of the firewall and to tunnel port 873 (using the program <code>nc</installation-dir/tex/setuptexcode>).

* export RSYNC_CONNECT_PROG='ssh tunnelhost nc %H 873''zsh''' users can use . /installation-dir/tex/setuptex

* '''(t)csh''' users can use source where <code>tunnelhost</installation-dircode> is the machine outside of the firewall on which you have <code>ssh</texcode> access. Of course, this machine must have <code>nc</setuptexcode> and port 873 open for outgoing TCP connections.csh

If you run ConTeXt from an editor, you need to source <code>setuptex<=== Terminal/code> in a terminal and then open your editor from the same terminal. For information about configuring [http://smultron.sourceforge.net/ Smultron] and [http://www.uoregon.edu/~koch/texshop/obtaining.html TeXShop] (which are popular TeX editors on Mac) see[[ConTeXt Minimals/Mac Installation]]Command line ===

Depending on how your editor intializesIf you always use ConTeXt suite and '''never''' use LaTeX or plain TeX provided by another TeX distribution, you may still need 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 it /installation-dir/tex/setuptex Then <code>setuptex</code> will always be sourced in order your terminal. === Integrating with an editor === The easiest way to run ConTeXt directly from an editor is to open a terminal, source {{code|setuptex}} in the terminal, and then open your editor, '''from the same terminal'''. In theory, it Another option is sufficient to add <{{code>|/installation-dir/tex/texmf-<platform>/bin</}} to the {{code> to your path in order to use |$PATH}} that the minimalseditor searches. You can try to add this to The details vary depending on the paths that your editor searches. See [[Text Editors]] for instructions on integrating ConTeXt with various editors.

For updating the ConTeXt minimalssuite, just run first update <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 . If you have third party /first-setup.sh --modules =all</pre> To update retain currently-installed, you should usemodules:<pre> sh ./first-setup.sh --keepto upgrade. See [[ConTeXt_Minimals#Installint_third_party_modules| Installing third party modules]] for details.</pre>

ConTeXt minimals suite does not touch anything outside its installation folder. So to uninstall it, you can simply remove the installation folder.

luatools --selfupdate mtxrun --selfupdate luatools --generate

= Installation and use on Windows = If you want to use ConTeXt minimals suite alongside MikTeX/TeXLive (needed if you also run LaTeX), the follow the command-line installation method. Otherwise, you can follow either the command line or GUI installation 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 directy directory where you want to install ConTeXt. It is recommended that you choose a directory that does not have a space in its full pahtpath. 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.}}

By default, the minimals 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.

first-setup.bat --context=current= Proxy settings ==

There is also a [http set RSYNC_PROXY=username://minimals.contextgarden.net/setup/context-installer/ContextMinimalInstall.exe GUI installer] made by Vyatcheslav Yatskovsky. Download and run the installer and it will ask you where to install the minimals, which distribution to use (stable or beta) and whether or not you want to make formats. password@proxyhost:proxyport

{{note| The GUI installer asks if you want to or set environmental variables globallythe variable permanently as a Windows environment variable. Click this only if you do not use MikTeX or TeXLive and do not plan to use LaTeX}}

You should also see 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 [http:firewall and to tunnel port 873 (using the program <code>nc<//meetingcode>).contextgarden.net  export RSYNC_CONNECT_PROG='ssh tunnelhost nc %H 873' where <code>tunnelhost</2008code> is the machine outside of the firewall on which you have <code>ssh</talkscode> access. Of course, this machine must have <code>nc</2008-08-21-vyatcheslav-win-installer/windows_installer.pdf slides] giving details about the GUI installercode> and port 873 open for outgoing TCP connections.

If you used the GUI installer and said yes to setting the evironmental variables globally, then you can run ConTeXt from anywhere. Otherwise, before 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

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 minimals suite in <code>C:\Programs</code>; otherwise replace <code>C:\Programs\</code> with your installation directory)

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.

If you used the command line method, just run <code>first-setup.bat</code> again to update the minimals. If you used the GUI installer, just run the installer againsuite.

If you used the GUI command-line installer, you can use standard windows tools for uninstalationjust delete the installation directory to uninstall the suite.

* 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

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 Minimals suite only come 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 --extrasmodules="t-letter"

sh ./first-setup.sh --extrasmodules="t-letter,t-mathsets"

== Upgrading an installation with If you want to install all extra modules installed ==at once, doBy default, <code> sh ./first-setup.sh</code> does a clean upgrade. This means that anything in the tex tree that is not requested is deleted. In particular--modules=all = Reverting to an older installation = If, for some reason, this means that if you are upgrading a want to revert to an older installation with third party modules installed, but '''you can do not specify <code>that by  sh ./first-setup.sh --extrascontext=date where <module-namecode>date</code>, then is the date of one of the installed module will be deleted'''stable releases of ConTeXt. The complete list of old releases that are available is [http://minimals.contextgarden.net/current/context/ here]. One way   = Moving the installation tree around =  According to avoid this is post, http://archive.contextgarden.net/message/20101129.144331.d721372f.en.html it's safe to always specify move the modules that installation tree across directory or machines (say you want while upgradingdon't have broadband access). An easier alternative is You just have to upgrade using sh clean and regenerate the cache (./firsttex/texmf-cache/luatex-setup.sh cache) with mtxrun --keepwhich will not delete old unused files.generate

[[Category:MinimalsStandalone]]