Windows Shortcut Creation
=========================

The CML :sup:`2` breakout utility is a single executable that requires
additional files. The following directions explain how to create a Windows
shortcut so that it could be associated to the "Start Menu" or the "Task Bar":

1. Download the CML :sup:`2` breakout utility and place into a directory for
   the executable and configuration files can be run and stored. (For example
   ``C:\Data-Local\CML2``)

2. Open up Windows Explorer, go to that directory, right click on the
   **breakout** executable name, and select **Create Shortcut**.

   .. figure:: _static/bodoc_6.png
      :width: 780px
      :align: center
      :alt: alternate text

      **Figure 1**: Creating a Windows Shortcut

3. Right-click on the Shortcut and make the following changes on the 'Shortcut'
   dialog panel:

   - Field **​"Target"**: Append the word ``ui`` to the end (separated with a
     space).
    
   - Field **"Start in"**: No changes need to be made, but this is where the
     Server and lab configuration files will bestored.

   .. figure:: _static/bodoc_7.png
      :width: 800px
      :align: center
      :alt: alternate text

      **Figure 2**: Modifying the Windows Shortcut Properties

   .. note:: You can also do the following additional changes:

      - Rename the shortcut to something short and more memorable
      - Change the icon on the shortcut to help distinguish
        the CML :sup:`2` Breakout executable from other DOS based
        windows/applications
      - Select 'Run minimized' so that the application is not showing
        the command window with all the log file output


4. Now, the shortcut will launch the CML :sup:`2` breakout utility in Graphical
   User interface mode, and you can "**Pin to Start**" or "**Pin to taskbar**".
