EAGLE Help

Command Syntax


Command Syntax

EAGLE commands can be entered in different ways:

All these methods can be mixed.

Commands and parameters in CAPITAL LETTERS are entered directly (or selected in the command menu with the mouse). For the input there is no difference between small and capital letters.

Parameters in lowercase letters are replaced by names, number values or key words. Example:

Syntax: GRID grid_size grid_multiple;
Input: GRID 1 10;

Shorten key words

For command names and other key words, only so many characters must be entered that they clearly differ from other key words.

Alternative Parameters

The sign | means that alternative parameters can be indicated. Example:

Syntax: SET BEEP ON | OFF;
Input: SET BEEP ON;
or
SET BEEP OFF;

Repetition Points

The signs .. mean that the function can be executed several times or that several parameters of the same type are allowed. Example:

Syntax: DISPLAY option layer_name..
Input: DISPLAY TOP PINS VIAS

Coordinates

The sign * normally means that an object has to be selected with the left mouse button at this point in the command. Example:

Syntax: MOVE * *..
Input: MOVE
Mouse click on the first element to be moved
Mouse click on the target position
Mouse click on the second element to be moved
etc.

This example also explains the meaning of the repetition points for commands with mouse clicks.

For the program each mouse click is the input of a coordinate. If coordinates are to be entered as text, the input via the keyboard must be as follows:

(x y)
x and y are numbers in the unit which has been selected with the GRID command. The input as text is mainly required for script files.

Any combination of the following modifiers may follow the opening brace in order to simulate a particular key that is held pressed with the "mouse click" or to change the type of coordinates:
>right mouse button click
A Alt key
C Ctrl key
P Polar coordinates (relative to the mark, x = radius, y = angle in degrees, counterclockwise)
R Relative coordinates (relative to the mark)
S Shift key
For example, the input

(CR> 1 2)
would result in a "right button mouse click" at (1 2) relative to the mark, with the Ctrl key held down (of course what happens with this kind of input will depend on the actual command). Note that if there is currently no mark defined, coordinates with R or P will be relative to the drawing's origin. Also, the modifier characters are not case sensitive, their sequence doesn't matter and there doesn't have to be a blank between them and the first coordinate digit. So the above example could also be written as (r>c1 2). Values entered as "polar coordinates" will be stored internally as the corresponding pair of (x y) coordinates.

As an example for entering coordinates as text let's assume you wish to enter the exact dimensions for board outlines:

GRID 1 MM;
CHANGE LAYER DIMENSION;
WIRE 0 (0 0) (160 0) (160 100) (0 100) (0 0);
GRID LAST;
Decimal numbers

When entering decimal numbers in the command line of the editor window, you always have to use the dot as the decimal delimiter (as in 12.34), even if the actual system has a different character defined for this (for example the comma).

Semicolon

The semicolon (';') terminates commands. A command needs to be terminated with a semicolon if there fewer than the maximum possible number of options. For example the command

WINDOW;
redraws the drawing window, whereas
WINDOW FIT
scales the drawing to fit entirely into the drawing window. There is no semicolon necessary here because it is already clear that the command is complete.
Index Copyright © 2005 CadSoft Computer GmbH