README

   1 OVERVIEW
   2 ========
   3
   4 Eclim is an Eclipse plugin which exposes Eclipse features through a
   5 server interface.  When this server is started, the command line utility
   6 eclim can be used to issue requests to that server.
   7
   8 Eclim can be found at http://eclim.sourceforge.net/.
   9
  10 INSTALLATION
  11 ============
  12
  13 Get the installer for your platform from the Eclim downloads page and
  14 follow those instructions.  After the install procedure, you should have
  15 the eclim and eclimd executables in
  16
  17   $ECLIPSE_HOME/eclimd
  18   $ECLIPSE_HOME/plugins/org.eclim_1.4.5/bin/eclim
  19
  20 It might be convenient to drop a shellscript like
  21
  22 --8<---------------cut here---------------start------------->8---
  23 #!/bin/sh
  24 $ECLIPSE_HOME/plugins/org.eclim_1.4.5/bin/eclim $*
  25 --8<---------------cut here---------------end--------------->8---
  26
  27 into your PATH.
  28
  29 USAGE
  30 =====
  31
  32 To start using eclim, first you have to start the eclimd server process.
  33 Here are two possibilities:
  34
  35   1. Simply execute the eclimd executable.  This will start a headless
  36      eclipse instance in the background, so you have to do all your work
  37      in emacs.
  38
  39   2. Start Eclipse as usual and open the eclimd view, which starts the
  40      server, too.
  41
  42              Show View -> Other -> Eclim -> eclimd
  43
  44 Now you can issue commands via eclim.  As a starter, let's see which
  45 projects are in the current workspace.  The output should look like
  46 that:
  47
  48 --8<---------------cut here---------------start------------->8---
  49 % eclim -command project_list
  50 GraBaJa            - closed - /home/horn/uni/repos/grabaja
  51 GretlTest          - closed - /home/horn/workspace/GretlTest
  52 JDT                - closed - /home/horn/workspace/JDT
  53 SCLTest            - closed - /home/horn/workspace/SCLTest
  54 eclim              - closed - /home/horn/repos/eclim
  55 greqlscript        - closed - /home/horn/uni/repos/greqlscript
  56 gretl              - open   - /home/horn/uni/repos/gretl
  57 jgStreetMap        - closed - /home/horn/uni/repos/jgstreetmap
  58 jgralab            - open   - /home/horn/uni/repos/jgralab
  59 jgwnl              - closed - /home/horn/uni/repos/jgwnl
  60 rsleditor          - closed - /home/horn/uni/repos/rsleditor
  61 sclschema          - closed - /home/horn/uni/repos/sclschema
  62 sidiffadapter      - closed - /home/horn/uni/repos/sidiffadapter
  63 swank              - closed - /home/horn/workspace/swank
  64 --8<---------------cut here---------------end--------------->8---
  65
  66 For more commands refer to the eclim docs and source code.