1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

Documentation/UserGuide

Introduction

ShellEd is a superb shell script editor for Eclipse. The great benefits of this plug-in are the integration of man page information for content assist/hover help and the ability to run your project's shell scripts without having to leave Eclipse to start up a terminal.

It also comes with all the features you'd expect from a full-featured Eclipse code editor such as syntax highlighting, code-folding and outline view.

Getting Started

Configuring the Preferences

It may be that you cannot read the man page information due to back text on black background.
For version 2.0.1 Window/Preferences/Shell Script/Editor doesn't help.
In this case it's usefull to change the background or foreground color for tooltips in your system.
(Ubuntu-11.04-german: System/Einstellungen/Erscheinungsbild/<dein Thema>/Anpassen.../Farben/Minihilfen)
(Ubuntu-english: please add..)

Configuring an Interpreter

To verify that Eclipse is set up correctly for Shell Script development you need to make sure that an interpreter is configured. Select the menu item Window -> Preferences (on Mac OS X, select Eclipse -> Preferences) to open the workbench preferences. Then choose the Shell Script -> Interpreters preference page to show the current interpreter configuration.

If there are no interpreters listed, you may add an interpreter manually by pressing the Add button, or let ShellEd try to automatically discover interpreters by pressing the Search button. Once you have added one or more interpreters, you may select which interpreter to use by default by checking the box next to the interpreter's name.

New Shell Script Project

To create a new shell script project, select the menu item File -> New -> Project and select Shell Script Project from the list of available project types.

On the next page, you will be asked to choose a name and location for the project and to choose an interpreter.

If there are no interpreters configured in ShellEd, it will say that your default interpreter is "currently undefined." You will still be allowed to create the project, but you will not be able to run or debug your shell scripts. It is highly recommended that you configure at least one interpreter and you may do so at this point by clicking the Configure Interpreters link, which will take you to the preferences page described in the previous section.

After clicking the Finish button, the newly created shell script project will be visible in the Project Explorer type views.

Existing Projects

You probably have shell scripts in other projects that you want to run and debug. In this case, you can add shell script support to existing, non-shell script projects by right-clicking them and choosing the ShellEd -> Add Shell Script Support menu item.

Updating This Guide

This user's guide is maintained in a collaborative wiki. We would welcome any corrections or additions to this document, so if you wish to make any changes for inclusion in the next release of ShellEd, please visit the following URL:

http://sourceforge.net/apps/trac/shelled/wiki/Documentation/UserGuide

Note that you'll need to sign in with your SourceForge account before editing the wiki.

Attachments