User guide

Installation

You can either download and install the package manually, or get it from Melpa.

Manual installation

  • Download the package of the latest version: eide-2.1.1.tar

  • Launch Emacs and install the package file:

    M-x package-install-file RET eide-2.1.1.tar
  • Add these lines in your ~/.emacs:

    (package-initialize)
    (eide-start)
  • Restart Emacs

Installation with Melpa

  • If you are connected to the internet behind a proxy, add the following line in your ~/.emacs:

    (setq url-proxy-services '(("http" . "<IP>:<PORT>")))
  • Add following lines in your ~/.emacs, depending on the version you want to install:

    • To install the latest release (recommended):

      (require 'package)
      (add-to-list 'package-archives '("melpa-stable" . "https://stable.melpa.org/packages/") t)
      (package-initialize)
    • To install the development version (git master):

      (require 'package)
      (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t)
      (package-initialize)
  • Launch Emacs and install eide package:

    M-x package-install RET eide
  • Add this line in your ~/.emacs:

    (eide-start)
  • Restart Emacs

Update with Melpa

  • Launch Emacs and list the packages:

    M-x package-list-packages
  • Press 'U' to select updates (if any) and 'x' to apply

  • Restart Emacs

Windows and clicks

Screenshot dark theme
Figure 1. Emacs-IDE windows layout with eide-dark color theme

Right click behaviour depends on the window at mouse position:

  • Over a source window, it hides/shows IDE windows ("menu" and "output").

  • Over menu window, it displays a menu with project oriented commands. Over a directory or a filename, it displays a menu with file oriented commands.

  • Over output window, it displays the list of existing temporary buffers in order to switch to one of them. Shift + right click displays the same list but for deletion purpose.

Configuration

Options provided in customization

Emacs-IDE provides some options in customization. To edit them, click on right button over "menu" window, and select "Customize" in popup menu.
At top level, you will find categories, and one specific option - called "Override Emacs settings" - that can globally disable all options in "Emacs settings" category, if disabled.

While other categories provide Emacs-IDE related options, "Emacs settings" category provides options that override standard Emacs behaviour:

  • F1-F12 key bindings, in order to provide easy access to basic IDE features (tags, cscope, grep, compilation…​).

  • Cscope update policy, in order to add an automatic mode that will update the database only when a file is modified in Emacs.

To save your settings, click on "Save for future sessions", and click on right button to exit customization.

Options provided by themes

Emacs-IDE provides two color themes (eide-dark and eide-light).

It also provides themes to customize some standard Emacs settings. I would recommend enabling the themes to Emacs beginners, because they enable useful options for coding and disable a few disturbing options. This is very subjective of course, but I believe that these settings can be useful for anyone. Advanced Emacs users may prefer to use their own customization.

The settings provided by these themes used to be enabled by default in previous Emacs-IDE releases (in "Emacs settings" category).
Now you have to enable these themes: click on right button over "menu" window, and select "Customize themes" in popup menu.
You can add one of the color themes (eide-dark or eide-light), and any of the following themes:

  • eide-browsing

  • eide-coding

  • eide-display

  • eide-settings

Workspaces and projects

The directory from which Emacs is launched stands as the root directory. You can change it during the session: click on right button over "menu" window, and select "Change root directory" in popup menu.

To create a project, select the directory of the source code tree as the root directory. Click on right button over "menu" window, and select "Create a project in this directory". The project is added to your workspace.

To open your project in future sessions, click on right button over "menu" window, select "Display projects list", and select your project.

Key bindings

Emacs-IDE defines a few key bindings:

  • Alt-left/down/right arrows = cut/copy/paste

  • Ctrl-left/middle/right click = cut/copy/paste

  • Alt-enter hides/shows IDE windows ("menu" and "output") (same as right click)

If you press Alt-enter to show the menu window, it forces the cursor focus on "menu" window. You can select a file with enter, and fold/unfold symbols with space. Press Alt-enter again to hide the "menu" window and force the focus on source file again.

Hosted by TuxFamily Website built with Asciidoctor