===========
Check Shell
===========

.. default-domain:: bash

.. file:: colors.bsh

Script to inspect the shell you are running, to make sure you are running the expected shell. Commonly used in script you source

:Arguments: ``$1...`` - Valid names of shells
:Return Value: * ``0`` - Check passed
               * ``1`` - Check failed
:Uses: * ``/proc`` or ``ps``. ``ps`` must support the ``-p`` and ``-o`` flags.

.. rubric:: Example

.. code-block:: bash

   check_shell bash
   check_shell zsh bash
   check_shell csh fish