.. _get_started: Configuring the command-line environment ======================================== .. _get_started_start_the_command_line_tools: Configure the environment ------------------------- .. todo:: xcc is not the only thing which uses env variables. The tools use a set of environment variables when searching for header files, libraries and target devices (see :ref:`xcc_manual_environment_variables`). To add the tools to the path and configure the default set of environment variables: .. tab:: Linux Open a Terminal window, change to the installation directory and enter the following command: .. code-block:: bash $ source SetEnv .. tab:: Windows #. Choose :menuselection:`Start-->XMOS-->Command Prompt(15.x.x)`. This will open a DOS command prompt with the environment variables already set. #. *Recommendation:* Start a bash environment. For the sake of brevity, all the command line examples in this documentation assume that the user is using a `bash` environment. At the DOS command prompt, type: .. code-block:: doscon > bash To install `bash` and the basic Unix tools, see :ref:`Windows installation `. .. tab:: Mac Open a Terminal window, change to the installation directory and enter the following command: .. code-block:: bash $ SetEnv.command Quick check the environment --------------------------- You may wish to check that your tools environment has been correctly configured using, say, :option:`xcc --help`. To do this, type: .. code-block:: bash $ xcc --help If your environment is working, then this will print some quick help text. .. _get_started_version: Query the toolkit version ------------------------- To find the toolkit version: .. code-block:: bash $ cat "$XMOS_TOOL_PATH"/doc/version.txt The reported version should be provided in any bug report. The build version of individual tools within the toolkit can be found using their :samp:`--version` option. For example, :option:`xcc --version`. At time of writing, most individual tools report the same as the toolkit version.