Eclim Documentation

As stated in the project description, eclim's main goal is to bring Eclipse functionality to the Vim editor. Here you will find documentation on the functionality that eclim provides.

The eclim documentation is broken up into two parts. The first is the comprehensive documentation which details the usage and purpose of every command and setting. This portion is found on the "Documentation" tab which you are currently on. You may use the menu on this tab, which is located to the left, to navigate these docs. Here you will find configuration information (settings, suggested mappings, etc.), and the detailed functionality documentation which is broken up into categories (common functionality, java development functionality, etc.).

The second portion of the documentation consists of a set of guides which are written to help you perform specific tasks. These guides are located on the "Home" tab under the "Guides" section of the left hand menu. You may return to the "Home" tab at any time by simply clicking the corresponding tab located in the upper left.

Before diving in, you should first familiarize yourself with the following commands. After that, take a look at the docs for managing projects. Then feel free to move onto the other categories.

• :PingEclim
  Pings eclimd to see if it is up and running.
• :ShutdownEclim
  Shuts down the current running eclimd instance.
• :EclimSettings
  Allows you to view / edit the global settings. For project level settings see the :ProjectSettings command on the project documentation page.

by Eric Van Dewoestine