3. User Commands
The entering of user-commands is initiated by the action routine
Command() (the (":")
character) and finished by either
<Key>Return
or <Key>Escape to confirm or to abort. These two keybindings
cannot be changed from the resource file.
The triggering event, normally a key press, is ignored.
The input area will replace the bottom statusline. It pops
up when Command() is called. The arguments of the user-commands
are passed to the external commands without modification.
See also, the resource saveInTMP.
There are simple usage dialogs for each command and one for the
complete set of commands.
- `l [filename]'
- Loads a new datafile (layout) and, if confirmed, overwrites any existing unsaved data.
The filename and the searchpath (filePath) are passed to the
command defined by fileCommand.
If no filename is specified a file select box will popup.
- `le [filename]'
- Loads an element description into the paste buffer.
The filename and the searchpath (elementPath) are passed to the
command defined by elementCommand.
If no filename is specified a file select box will popup.
- `m [filename]'
- Loads an layout file into the paste buffer.
The filename and the searchpath (filePath) are passed to the
command defined by fileCommand.
If no filename is specified a file select box will popup.
- `q[!]'
- Quits the program without saving any data (after confirmation).
q! doesn't ask for confirmation, it just quits.
- `s [filename]'
- Data and the filename are passed to the command defined by the resource
saveCommand. It must read the layout data from stdin.
If no filename is entered, either the last one is used
again or, if it is not available, a file select box will pop up.
- `rn [filename]'
- Reads in a netlist file. If no filename is given
a file select box will pop up.
The file is read via the command defined by the
RatCommand resource. The command must send its output to stdout.
Netlists are used for generating rat's nests (see 2.11 Rats Nest) and for
verifying the board layout (which is also accomplished by the Ratsnest
command).
- `w[q] [filename]'
- These commands have been added for the convenience of
vi
users and
have the same functionality as s combined with q.
- `actionCommand'
- Causes the actionCommand to be executed. This allows you to initiate actions
for which no bindings exist in the resource file. It can be used to initiate any
action with whatever arguments you enter. This makes it possible to do things
that otherwise would be extremely tedious. For example, to change the drilling
hole diameter of all vias in the layout to 32 mils, you could select everything using the
selection menu, then type ":ChangeDrillSize(SelectedVias, 32)". (This will
only work provided the via's diameter is sufficiently large to accomodate a 32 mil hole).
Another example might be to set the grid to 1 mil by typing ":SetValue(Grid, 1)".
Note that some actions use the current cursor location, so be sure to place the cursor
where you want before entering the command. This is one of my favorite new
features in 1.5 and can be a powerful tool. Study the 5.2 Actions section to
see what actions are available.
This document was generated
by Build Daemon user on November, 19 2004
using texi2html