.. highlightlang:: us

.. index:: us_path

.. _us_path:

us_path
========

.. us.tag us_path NOTREADYENGLISH New5800 Programming.Debug

:ref:`us_path` sets and returns the environment variable ``uniscript-path``.

.. function::  svPath = us_path()
               ret = us_path(ssCommand)
               ret = us_path(ssCommand, ssPath)

.. us.params

**Parameters**

.. uparam:: ssCommand

   *ssCommand* is one of the following strings:

   .. list-table::
      :header-rows: 1

      * - Command
        - Description
      * - ``"a"`` or ``"add"``
        - Add *ssPath* to the list.
      * - ``"g"`` or ``"get"``
        - Returns the environment variable ``"uniscript-path"``, separated by a
          colon.
      * - ``"s"`` or ``"gets"``
        - Returns the environment variable ``"uniscript-path"`` as a string
          vector. Each element contains one path element.
      * - ``"m"`` or ``"match-remove"``
        - Removes a path from ``"uniscript-path"``. Wildcards ``*`` and ``?`` 
          can be used, see :ref:`strmatch`.
      * - ``"r"`` or ``"remove"``
        - Removes a single path.

.. uparam:: ssPath

   *ssPath* is a path.

.. us.comment

**Comment**

The function modifies or returns the environment variable ``uniscript-path``.
The modifications are **not** permanently saved.
The variable is used with the UniScript debugger to find the complete
file name of a UniScript file: 

::

   * search_path(getenv("uniscript-path"), "do_cmds.ic")
   D:\uniplot-64d\script\uniplot\do_cmds.ic
   * 

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2016.0
     - New.

.. seealso::
   :ref:`overview-programming`

:sub:`id-893639`