Installing Caret5 Software

  1. Download a Caret distribution from the Download Page.
  2. Unzip the file in the desired location (/Applications on a Mac, if desired).  When a distribution is unzipped, it will create a subdirectory named "caret".
  3. Executables (caret5, etc) are located in "caret/bin...".  The "bin..." directory is unique for each operating system and 32/64-bit architecture.
  4. If you want to run Caret from the command line, it will be necessary to set your PATH environment variable to the "bin..." directory in your caret distribution.
  5. See your friendly system administrator for assistance or post to the caret user's email list.

Installing Caret5 on Linux Systems

A user has reported a problem with Caret crashing on a Linux system when displaying a volume.  The crash has to do with  caret trying to render text which ultimately uses the FreeType library.  Check for the file ".fonts.conf" in your home directory.  If it exists, rename it and see what happens.

If your Linux operating system has the program "glxgears" or "/usr/bin/glxgears", try running it.  If it crashes you definitely have a problem with your OpenGL drivers and libraries.

If your operating system is upgraded YOU MUST update your OpenGL drivers and libraries.  They are obtained from the manufacturer of the graphics card.

Installing Caret5 on Mac OSX Systems

Adding Caret5 to the Dock

To place caret5 in the Dock, open up a finder and navigate to the caret installation's "caret/macosx32_apps" or "caret/macosx64_apps" directory.  Drag the Caret5 icon from Finder into the Dock.  This allows Caret to be started from the Dock like other Mac applications.

Enable Double-clicking of a Spec File in Finder to Start Caret5. 

It may be possible to set up your Mac so that you can navigate to a directory and double-click a spec file to start Caret.  To set this up, use Finder to locate a Spec File.  Hold down the "control" key and then click the mouse over the spec file to pop-up a menu.  From the menu, select Get Info.  Click the arrow next to Open with" to show additional items.  Click on the control immediately below Open with: and select Other...".  Use the dialog that is displayed to navigate to the "caret/macosx32_apps" or "caret/macosx64_apps" directory.  Change Enable from Recommended Applications to All Applications.  Select the caret5 icon and press the Add button. 

Installing Caret5 on Windows XP

Creating a Shortcut on the Windows XP Desktop

  1. Place the mouse so that it is NOT over any icons on the Desktop.
  2. Press the right mouse button and a popup menu is displayed.  From the popup menu, move the mouse to the New menu, and select Shortcut.
  3. Press the Browse button, and, in the Browse for Folder Dialog, go into caret’s “caret/bin_windows32” or "caret/bin_windows64" directory and select the file caret5.  Press the OK push button on the Browse for Folder Dialog.
  4. Press the Next push button on the Create Shortcut Dialog.
  5. On the next page, leave the name of the shortcut caret5 and press the Finish push button.
  6. Double-click the Caret5 icon on the Desktop to start Caret5.

Setting the Path Environment Variable so that Caret5 and caret_command May Be Started from a Command Line Window

  1. From the Start Menu, select Control Panel.
  2. Double-click the System Icon.
  3. On the System Properties Dialog, click the Advanced tab.
  4. Press the Environment Variables push button near the bottom of the System Properties Dialog.
  5. In the Environment Variables Dialog, there are two types of environment variables.  The bottom set of environment variables, System variables, will set the Path for all users on the computer.  User variables for <login-name> will only set the Path environment variable for the currently logged in user. 
  6. If there is no Path environment variable, press the New push button.  In the Edit Variable Dialog that pops up, enter Path for the Variable name and then enter the Variable value, full path to the bin_windows32/64 directory, "C:\caret\bin_windows32".  Note that only the directory is needed.  Press the OK push button to close the Edit Variable Dialog.
  7. If there is a Path environment variable, press the Edit push button.  In the Edit Variable Dialog, press the left mouse button in the Variable value text box, press the Home key to get to the beginning of the value, press the left mouse button before the first character, and then enter C:\caret\bin_windows32;" (a semicolon is required between all directory names in the PATH).  Press the OK push button to close the Edit Variable Dialog.
  8. Press the OK push button on the Environment Variables Dialog.
  9. Press the OK push button on the System Properties Dialog.
  10. Close the Control Panel Window.
  11. Using the Start Menu button, move the mouse over All Programs, and from the Accessories Menu, select Command Prompt.
  12. In the Command Prompt Window, enter the command caret5  If the Path Environment variable has been set correctly, Caret5 will start.  If not, check the previous steps.

Enable Double-clicking a “.spec” File to Start Caret5 in Windows

  1. From the Taskbar, select the Start menu and choose Control Panel.
  2. This step is only necessary if the Control Panel is in Category View.  If it is, you will see Pick A Category near the top of the Window’s contents.  If so, click Appearance and Themes.  If not, continue to the next step.
  3. Double-click Folder Options.
  4. Select the File Types tab.
  5. Scroll through the list of file types looking for SPEC.  If SPEC is found, press the mouse once on it to select it and then press the Delete button.  If the Delete button is disabled, first press the Restore button which will enable the Delete button.  Confirm that you want to delete the SPEC extension.
  6. Press the New button and the Create New Extension dialog will appear.
  7. Enter SPEC for the file extension and press the OK button to close the Create New Extension dialog.
  8. In the Details for SPEC Extension section, press the Advanced button to display the Edit File Type dialog.
  9. Press the New button to display the New Action dialog.
  10. Enter open for the Action.
  11. Press the Browse button and find the file caret5.exe which is located in your caret distribution’s C:\caret\bin_windows32 directory.  Select caret5.exe and press the Open button to close the Open With dialog.
  12. Press OK on the New Action dialog to close it.
  13. Press the OK button on the Edit File Type Dialog to close it.
  14. Press Close on the Folder Options dialog.
  15. Double click a Spec File and Caret5 should start with the Spec File Dialog listing the Spec File’s data files.

"OpenGL Error: invalid enumerant" Message


If this message is displayed, try restarting caret5 from the command line as "caret5 -notext".  If this eliminates the error message and caret5 is being run on a Linux system, try updating the "FreeType" library.  If that does not solve the problem try updating the OpenGL library.  On Windows, try updating the OpenGL library.