Index: action_details.html =================================================================== --- action_details.html (revision 20702) +++ action_details.html (revision 20703) @@ -1,13 +1,27 @@ + + pcb-rnd user manual - action details + + + -

pcb-rnd actions

-

Action reference (details)

+

pcb-rnd actions (details)

-

addrats

+ +

addrats

+

+ +
Syntax summary: +AddRats(AllRats|SelectedRats|Close) +
Help text: +Add one or more rat lines to the board. +
Registered by:n/a +
+

Arguments:

@@ -33,9 +47,17 @@ Selects the shortest unselected rat on the board. +

-

adjustsizes

+

adjustsizes

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Displays a dialog box that lets the user change the board size, DRC parameters, and text scale.

The units are determined by the default display units. @@ -47,13 +69,32 @@ in favor of the preferences action. +

-

adjuststyle

+

adjuststyle

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Opens the window which allows editing of the route styles. +

-

align

+

align

+

+ +
Syntax summary: +Align(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]]) +
Help text: +Align subcircuits +
Registered by: +distalign plugin +
+

Example: Align(X, [Lefts/Rights/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]])
@@ -95,9 +136,20 @@

Defaults are Marks, First. +

-

aligntext

+

aligntext

+

+ +
Syntax summary: +AlignText(X/Y, [Lefts/Rights/Tops/Bottoms/Centers, [First/Last/pcb_crosshair/Average[, Gridless]]]) +
Help text: +Align Text Elements +
Registered by: +distaligntext plugin +
+

@@ -143,13 +195,34 @@

Defaults are Lefts/Tops, First +

-

applyvendor

+

applyvendor

+

+ +
Syntax summary: +ApplyVendor() +
Help text: +Applies the currently loaded vendor drill table to the current design. +
Registered by: +vendor drill mapping +
+

This will modify all of your drill holes to match the list of allowed sizes for your vendor. +

-

atomic

+

atomic

+

+ +
Syntax summary: +Atomic(Save|Restore|Close|Block) +
Help text: +Save or restore the undo serial number. +
Registered by:n/a +
+

This action allows making multiple-action bindings into an atomic operation that will be undone by a single Undo command. For example, to optimize rat lines, you'd delete the rats and re-add them. To group these into a single undo, you'd want the deletions and the additions to have the same undo serial number. So, you Save , delete the rats, @@ -189,17 +262,51 @@ Does a Restore if there was nothing to undo, else does a Close. +

-

attributes

+

attributes

+

+ +
Syntax summary: +Attributes(Layout|Layer|Element|Subc) +Attributes(Layer,layername) +
Help text: +Let the user edit the attributes of the layout, current or given +layer, or selected subcircuit. +
Registered by:n/a +
+

Pops up a dialog letting the user edit the attributes of the pcb, a subcircuit, or a layer. +

-

autoplaceselected

+

autoplaceselected

+

+ +
Syntax summary: +AutoPlaceSelected() +
Help text: +Auto-place selected components. +
Registered by: +autoplace plugin +
+

Attempts to re-arrange the selected components such that the nets connecting them are minimized. Note that you cannot undo this. +

-

autoroute

+

autoroute

+

+ +
Syntax summary: +AutoRoute(AllRats|SelectedRats) +
Help text: +Auto-route some or all rat lines. +
Registered by: +autoroute plugin +
+

Before autorouting, it's important to set up a few things. First, make sure any layers you aren't using are disabled, else the autorouter may use them. Next, make sure the current routing styles are set accordingly. Last, make sure "new lines clear polygons" is set, in case you eventually want to add a copper pour.

Autorouting takes a while. During this time, the program may not be responsive. @@ -223,13 +330,32 @@ Attempt to autoroute the selected rats. +

-

benchmark

+

benchmark

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

This action is used to speed-test the GUI rendering. It redraws the current screen as many times as possible in ten seconds. It reports the amount of time needed to draw the screen once, in average. +

-

boardflip

+

boardflip

+

+ +
Syntax summary: +BoardFlip([sides]) +
Help text: +Mirror the board over the x axis, optionally mirroring sides as well. +
Registered by: +boardflip plugin +
+

All objects on the board are up-down flipped (mirrored over the x axis).

Command line board flipping: @@ -239,25 +365,82 @@

To flip the board physically, use BoardFlip(sides) +

-

center

+

center

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Move the pointer to the center of the window, but only if it's currently within the window already. +

-

changeclearsize

+

changeclearsize

+

+ +
Syntax summary: +ChangeClearSize(Object, delta|style) +ChangeClearSize(SelectedPins|SelectedPads|SelectedVias, delta|style) +ChangeClearSize(SelectedLines|SelectedArcs, delta|style) +ChangeClearSize(Selected|SelectedObjects, delta|style) +
Help text: +Changes the clearance size of objects. +
Registered by:n/a +
+

If the solder mask is currently showing, this action changes the solder mask cutout size. If the mask is not showing, this action changes the polygon clearance. +

-

changeflag

+

changeflag

+

+ +
Syntax summary: +ChangeFlag(Object|Selected|SelectedObjects, flag, value) +ChangeFlag(SelectedLines|SelectedPins|SelectedVias, flag, value) +ChangeFlag(SelectedPads|SelectedTexts|SelectedNames, flag, value) +ChangeFlag(SelectedElements, flag, value) +flag = thermal | join +value = 0 | 1 +
Help text: +Sets or clears flags on objects. +
Registered by:n/a +
+

Toggles the given flag on the indicated object(s). The flag may be one of the flags listed above (thermal, join). The value may be the number 0 or 1. If the value is 0, the flag is cleared. If the value is 1, the flag is set. +

-

changejoin

+

changejoin

+

+ +
Syntax summary: +ChangeJoin(ToggleObject|SelectedLines|SelectedArcs|Selected) +
Help text: +Changes the join (clearance through polygons) of objects. +
Registered by:n/a +
+

The join flag determines whether a line or arc, drawn to intersect a polygon, electrically connects to the polygon or not. When joined, the line/arc is simply drawn over the polygon, making an electrical connection. When not joined, a gap is drawn between the line and the polygon, insulating them from each other. +

-

changename

+

changename

+

+ +
Syntax summary: +ChangeName(Object) +ChangeName(Layout|Layer) +
Help text: +Sets the name (or pin number) of objects. +
Registered by:n/a +
+

Arguments:

@@ -283,37 +466,119 @@ Changes the name of the currently active layer. +

-

changepinname

+

changepinname

+

+ +
Syntax summary: +ChangePinName(Refdes,PinNumber,PinName) +
Help text: +Sets the name of a specific pin on a specific subcircuit. +
Registered by:n/a +
+

This can be especially useful for annotating pin names from a schematic to the layout without requiring knowledge of the pcb file format.

Example: ChangePinName(U3, 7, VCC)
+

-

changesize

+

changesize

+

+ +
Syntax summary: +ChangeSize(Object, delta|style) +ChangeSize(SelectedObjects|Selected, delta|style) +ChangeSize(SelectedLines|SelectedPins|SelectedVias, delta|style) +ChangeSize(SelectedPads|SelectedTexts|SelectedNames, delta|style) +ChangeSize(SelectedElements, delta|style) +
Help text: +Changes the size of objects. +
Registered by:n/a +
+

For lines and arcs, this changes the width. For padstacks, this changes the shape size (but does not touch the hole diameter). For texts, this changes the scaling factor. For subcircuits, this changes the width of the silk layer lines and arcs for this subcircuit (TODO: is this still true?). +

-

changesizes

+

changesizes

+

+ +
Syntax summary: +ChangeSizes(Object, delta|style) +ChangeSizes(SelectedObjects|Selected, delta|style) +ChangeSizes(SelectedLines|SelectedPins|SelectedVias, delta|style) +ChangeSizes(SelectedPads|SelectedTexts|SelectedNames, delta|style) +ChangeSizes(SelectedElements, delta|style) +
Help text: +Changes all sizes of objects. +
Registered by:n/a +
+

Call ChangeSize, ChangeDrillSize and ChangeClearSize with the same arguments. If any of them did not fail, return success. +

-

chklayer

+

chklayer

+

+ +
Syntax summary: +ChkLayer(layerid) +
Help text: +Returns 1 if the specified layer is the active layer +
Registered by:n/a +
+

Returns 1 if the specified layer is the active layer. +

-

chkrst

+

chkrst

+

+ +
Syntax summary: +ChkRst(route_style_id) +
Help text: +Return 1 if route_style_id matches pen. +
Registered by:n/a +
+

Return 1 if route_style_id matches pen. +

-

chkview

+

chkview

+

+ +
Syntax summary: +ChkView(layerid) +
Help text: +Return 1 if layerid is visible. +
Registered by:n/a +
+

Return 1 if layerid is visible. Intended for menu item 'checked' fields. +

-

clrflag

+

clrflag

+

+ +
Syntax summary: +ClrFlag(Object|Selected|SelectedObjects, flag) +ClrFlag(SelectedLines|SelectedPins|SelectedVias, flag) +ClrFlag(SelectedPads|SelectedTexts|SelectedNames, flag) +ClrFlag(SelectedElements, flag) +flag = thermal | join +
Help text: +Clears flags on objects. +
Registered by:n/a +
+

Turns the given flag off, regardless of its previous setting. See changeflag . @@ -321,9 +586,17 @@ Example: ClrFlag(SelectedLines,join)
+

-

command

+

command

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

The command window allows the user to manually enter actions to be executed.

There are two ways to finish with the command window. If you press the @@ -345,9 +618,19 @@ down arrow keys to access command history. +

-

connection

+

connection

+

+ +
Syntax summary: +Connection(Find|ResetLinesAndPolygons|ResetPinsAndVias|Reset) +
Help text: +Searches connections of the object at the cursor position. +
Registered by:n/a +
+

Connections found with this action will be highlighted in the "connected-color" color and will have the "found" flag set.

Arguments: @@ -381,9 +664,19 @@ All "found" objects are marked "not found". +

-

cursor

+

cursor

+

+ +
Syntax summary: +Cursor(Type,DeltaUp,DeltaRight,Units) +
Help text: +Move the cursor. +
Registered by:n/a +
+

This action moves the mouse cursor. Unlike other actions which take coordinates, this action's coordinates are always relative to the user's view of the board. Thus, a positive DeltaUp may move the cursor away from the board origin if the board is inverted (flipped, looked from the bottom). @@ -451,13 +744,40 @@ moves you halfway across the board. +

-

disperseelements

+

disperseelements

+

+ +
Syntax summary: +DisperseElements(All|Selected) +
Help text: +Disperses subcircuits. +
Registered by:n/a +
+

Normally this is used when starting a board, by selecting all subcircuits and then dispersing them. This scatters the subcircuits around the board so that you can pick individual ones, rather than have all the subcircuits at the same 0,0 coordinate and thus impossible to choose from. +

-

display

+

display

+

+ +
Syntax summary: +Display(SubcID, template) +Display(Grid|Redraw|Pinout|PinOrPadName) +Display(CycleClip|CycleCrosshair|ToggleAllDirections|ToggleStartDirection) +Display(ToggleGrid|ToggleRubberBandMode|ToggleUniqueNames) +Display(ToggleName|ToggleClearLine|ToggleFullPoly|ToggleSnapPin) +Display(ToggleSnapOffGridLine|ToggleHighlightOnPoint|ToggleCheckPlanes) +Display(ToggleThindraw|ToggleThindrawPoly|ToggleOrthoMove|ToggleLocalRef) +Display(ToggleLiveRoute|ToggleShowDRC|ToggleAutoDRC|LockNames|OnlyNames) +
Help text: +Several display-related actions. +
Registered by:n/a +
+

Changes random display related global states.

@@ -637,9 +957,20 @@ Toggles whether the names of terminals will be displayed. If the cursor is over an subcircuit, all of its terminals are affected. +

-

distribute

+

distribute

+

+ +
Syntax summary: +Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) +
Help text: +Distribute subcircuits +
Registered by: +distalign plugin +
+

Example: Distribute(X, [Lefts/Rights/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]])
@@ -675,9 +1006,20 @@ Defaults are Marks, First, Last

Distributed subcircuits always retain the same relative order they had before they were distributed. +

-

distributetext

+

distributetext

+

+ +
Syntax summary: +DistributeText(Y, [Lefts/Rights/Tops/Bottoms/Centers/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) +
Help text: +Distribute Text Elements +
Registered by: +distaligntext plugin +
+

@@ -711,9 +1053,22 @@ Defaults are Lefts/Tops, First, Last

Distributed texts always retain the same relative order they had before they were distributed. +

-

djopt

+

djopt

+

+ +
Syntax summary: +djopt(debumpify|unjaggy|simple|vianudge|viatrim|orthopull) +djopt(auto) - all of the above +djopt(miter) +
Help text: +Perform various optimizations on the current board. +
Registered by: +djopt +
+

The different types of optimizations change your board in order to reduce the total trace length and via count.

Arguments: @@ -777,9 +1132,17 @@ Replaces 90 degree corners with a pair of 45 degree corners, to reduce RF losses and trace length. +

-

dowindows

+

dowindows

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Argument:

@@ -843,13 +1206,31 @@ Open the advanced search window. +

-

drc

+

drc

+

+ +
Syntax summary: +DRC() +
Help text: +Invoke the DRC check. +
Registered by:n/a +
+

Note that the design rule check uses the current board rule settings, not the current style settings. +

-

editlayergroups

+

editlayergroups

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Displays a dialog that lets the user view and change the layer groupings on a cross-section view.

@@ -859,9 +1240,19 @@ in favor of the preferences action. +

-

elementlist

+

elementlist

+

+ +
Syntax summary: +ElementList(Start|Done|Need,,,) +
Help text: +Adds the given element if it doesn't already exist. +
Registered by:n/a +
+

Arguments:

@@ -907,33 +1298,99 @@ with the list of subcircuits actually on the board. Any subcircuits that weren't listed are selected, so that the user may delete them. +

-

elementsetattr

+

elementsetattr

+

+ +
Syntax summary: +ElementSetAttr(refdes,name[,value]) +
Help text: +Sets or clears an element-specific attribute. +
Registered by:n/a +
+

If a value is specified, the named attribute is added (if not already present) or changed (if it is) to the given value. If the value is not specified, the given attribute is removed if present. +

-

executefile

+

executefile

+

+ +
Syntax summary: +ExecuteFile(filename) +
Help text: +Run actions from the given file. +
Registered by:n/a +
+

Lines starting with # are ignored. +

-

flip

+

flip

+

+ +
Syntax summary: +Flip(Object|Selected) +
Help text: +Flip a subcircuit to the opposite side of the board. +
Registered by:n/a +
+

Note that the location of the subcircuit will be symmetric about the cursor location; i.e. if the part you are pointing at will still be at the same spot once the subcircuit is on the other side. When flipping multiple subcircuits, this retains their positions relative to each other, not their absolute positions on the board. +

-

freerotatebuffer

+

freerotatebuffer

+

+ +
Syntax summary: +FreeRotateBuffer([Angle]) +
Help text: +Rotates the current paste buffer contents by the specified angle. The +angle is given in degrees. If no angle is given, the user is prompted +for one. +
Registered by:n/a +
+

Rotates the contents of the pastebuffer by an arbitrary angle. If no angle is given, the user is prompted for one. +

-

getxy

+

getxy

+

+ +
Syntax summary: +GetXY() +
Help text: +Get a coordinate. +
Registered by:n/a +
+

Prompts the user for a coordinate, if one is not already selected. +

-

import

+

import

+

+ +
Syntax summary: +Import() +Import([gnetlist|make[,source,source,...]]) +Import(setnewpoint[,(mark|center|X,Y)]) +Import(setdisperse,D,units) +
Help text: +Import schematics. +
Registered by: +import_sch plugin +
+

Imports subcircuits and netlist data from the schematics (or some other source). The first parameter, which is optional, is the mode. If not specified, the import::mode @@ -1123,23 +1580,61 @@ import::disperse attribute. +

-

importgui

+

importgui

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Displays a dialog that lets the user select the schematic(s) to import from, then saves that information in the layout's attributes for future imports. +

-

l

+

l

+

+ +
Syntax summary: +l [name] [format] +
Help text: +Loads layout data. +
Registered by: +shand_cmd plugin +
+

Loads a new datafile (layout) and, if confirmed, overwrites any existing unsaved data. If no filename is specified a file select box will popup. +

-

le

+

le

+

+ +
Syntax summary: +le [name] +
Help text: +Loads an element (subcircuit, footprint) into the current buffer. +
Registered by: +shand_cmd plugin +
+

The filename is passed to the footprint loader. If no filename is specified a file select box will popup. +

-

load

+

load

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

This action is a GUI front-end to the core's loadfrom action. If you happen to pass a filename, @@ -1147,13 +1642,33 @@ is called directly. Else, the user is prompted for a filename to load, and then loadfrom is called with that filename. +

-

loadfootprint

+

loadfootprint

+

+ +
Syntax summary: +pcb_load_footprint(filename[,refdes,value]) +
Help text: +Loads a single footprint by name. +
Registered by:n/a +
+

Loads a single footprint by name, rather than by reference or through the library. If a refdes and value are specified, those are inserted into the footprint as well. The footprint remains in the paste buffer. +

-

loadfrom

+

loadfrom

+

+ +
Syntax summary: +LoadFrom(Layout|LayoutToBuffer|SubcToBuffer|Netlist|Revert,filename[,format]) +
Help text: +Load layout data from a file. +
Registered by:n/a +
+

This action assumes you know what the filename is. The various GUIs should have a similar load action where the filename is optional, and will provide their own file selection mechanism to let you choose the file name. @@ -1195,9 +1710,20 @@ Re-loads the current layout from its disk file, reverting any changes you may have made. +

-

loadvendorfrom

+

loadvendorfrom

+

+ +
Syntax summary: +LoadVendorFrom(filename) +
Help text: +Loads the specified vendor lihata file. +
Registered by: +vendor drill mapping +
+

Arguments:

@@ -1211,29 +1737,85 @@ Name of the vendor lihata file. If not specified, the user will be prompted to enter one. +

-

m

+

m

+

+ +
Syntax summary: +m [name] +
Help text: +Loads a layout into the current buffer. +
Registered by: +shand_cmd plugin +
+

If no filename is specified a file select box will popup. +

-

markcrosshair

+

markcrosshair

+

+ +
Syntax summary: +MarkCrosshair() +MarkCrosshair(Center) +
Help text: +Set/Reset the pcb_crosshair mark. +
Registered by:n/a +
+

The "mark" is a small X-shaped target on the display which is treated like a second origin (the normal origin is the upper let corner of the board). The GUI will display a second set of coordinates for this mark, which tells you how far you are from it.

If no argument is given, the mark is toggled - disabled if it was enabled, or enabled at the current cursor position of disabled. If the Center argument is given, the mark is moved to the current cursor location. +

-

message

+

message

+

+ +
Syntax summary: +message(message) +
Help text: +Writes a message to the log window. +
Registered by:n/a +
+

This action displays a message to the log window. This action is primarily provided for use by scripts and external programs which may interface with pcb-rnd. If multiple arguments are given, each one is sent to the log window followed by a newline. +

-

mincleargap

+

mincleargap

+

+ +
Syntax summary: +MinClearGap(delta) +MinClearGap(Selected, delta) +
Help text: +Ensures that polygons are a minimum distance from objects. +
Registered by:n/a +
+

Checks all specified objects, and increases the polygon clearance if needed to ensure a minimum distance between their edges and the polygon edges. +

-

mode

+

mode

+

+ +
Syntax summary: +Mode(Arc|Arrow|Copy|InsertPoint|Line|Lock|Move|None|PasteBuffer) +Mode(Polygon|Rectangle|Remove|Rotate|Text|Thermal|Via) +Mode(Notify|Release|Cancel|Stroke) +Mode(Save|Restore) +
Help text: +Change or use the tool mode. +
Registered by:n/a +
+

Selects the tool or changes tool related global states.

@@ -1321,13 +1903,34 @@ Restores the tool to the last saved tool. +

-

morphpolygon

+

morphpolygon

+

+ +
Syntax summary: +pcb_poly_morph(Object|Selected) +
Help text: +Converts dead polygon islands into separate polygons. +
Registered by:n/a +
+

If a polygon is divided into unconnected "islands", you can use this command to convert the otherwise disappeared islands into separate polygons. Be sure the cursor is over a portion of the polygon that remains visible. Very small islands that may flake off are automatically deleted. +

-

movelayer

+

movelayer

+

+ +
Syntax summary: +MoveLayer(old,new) +MoveLayer(lid,group,gid) +
Help text: +Moves/Creates/Deletes Layers. +
Registered by:n/a +
+

Moves a layer, creates a new layer, or deletes a layer.

Arguments: @@ -1385,9 +1988,19 @@ +

-

moveobject

+

moveobject

+

+ +
Syntax summary: +pcb_move_obj(X,Y,[units]) +
Help text: +Moves the object under the crosshair. +
Registered by:n/a +
+

The code and @@ -1409,15 +2022,38 @@ and Y have no unit specified. If no unit unspecified in coords or units, nanometer is assumed. +

-

movetocurrentlayer

+

movetocurrentlayer

+

+ +
Syntax summary: +MoveToCurrentLayer(Object|SelectedObjects) +
Help text: +Moves objects to the current layer. +
Registered by:n/a +
+

Note that moving an subcircuit from a component layer to a solder layer, or from solder to component, won't automatically flip it. Use the flip action to do that. +

-

netlist

+

netlist

+

+ +
Syntax summary: +Net(find|select|rats|norats|clear[,net[,pin]]) +Net(freeze|thaw|forcethaw) +Net(swap) +Net(add,net,pin) +
Help text: +Perform various actions on netlists. +
Registered by:n/a +
+

Each of these actions apply to a specified set of nets. net and @@ -1529,17 +2165,52 @@ Temporarily prevents changes to the netlist from being reflected in the GUI. +

-

new

+

new

+

+ +
Syntax summary: +New([name]) +
Help text: +Starts a new layout. +
Registered by:n/a +
+

If a name is not given, one is prompted for. +

-

pan

+

pan

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Start or stop panning. To start call with Mode = 1, to stop call with Mode = 0. +

-

pastebuffer

+

pastebuffer

+

+ +
Syntax summary: +PasteBuffer(AddSelected|Clear|1..PCB_MAX_BUFFER) +PasteBuffer(Rotate, 1..3) +PasteBuffer(Convert|Restore|Mirror) +PasteBuffer(ToLayout, X, Y, units) +PasteBuffer(ToLayout, crosshair) +PasteBuffer(Save, Filename, [format], [force]) +PasteBuffer(Push) +PasteBuffer(Pop) +
Help text: +Various operations on the paste buffer. +
Registered by:n/a +
+

There are a number of paste buffers; the actual limit is a compile-time constant PCB_MAX_BUFFER @@ -1621,13 +2292,32 @@ Selects the given buffer to be the current paste buffer. +

-

polycombine

+

polycombine

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by: +polycombine plugin +
+

The selected polygons are combined together according to the ordering of their points. +

-

polygon

+

polygon

+

+ +
Syntax summary: +Polygon(Close|CloseHole|PreviousPoint) +
Help text: +Some polygon related stuff. +
Registered by:n/a +
+

Argument:

@@ -1653,55 +2343,153 @@ Resets the newly entered corner to the previous one. The Undo action will call Polygon(PreviousPoint) when appropriate to do so. +

-

polystitch

+

polystitch

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by: +polystitch plugin +
+

The polygon under the cursor (based on closest-corner) is stitched together with the polygon surrounding it on the same layer.

Use with pstoedit conversions where there's a "hole" in the shape - select the hole. +

- + +

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

This just pops up the specified menu. The menu must have been defined in the popups subtree in the menu lht file. +

-

print

+

print

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

This will find the default printing HID, prompt the user for its options, and print the layout. +

-

printcalibrate

+

printcalibrate

+

+ +
Syntax summary: +PrintCalibrate() +
Help text: +Calibrate the printer. +
Registered by:n/a +
+

This will print a calibration page, which you would measure and type the measurements in, so that future printouts will be more precise. +

-

promptfor

+

promptfor

+

+ +
Syntax summary: +PromptFor([message[,default]]) +
Help text: +Prompt for a response. +
Registered by:n/a +
+

This is mostly for testing the lesstif HID interface. The parameters are passed to the prompt_for() HID function, causing the user to be prompted for a response. The respose is simply printed to the user's stdout. +

-

puller

+

puller

+

+ +
Syntax summary: +pcb_act_Puller() +
Help text: +Pull an arc-line junction tight. +
Registered by: +puller plugin +
+

The puller action is a special-purpose optimization. When invoked while the crosshair is over the junction of an arc and a line, it will adjust the arc's angle and the connecting line's endpoint such that the line intersects the arc at a tangent. +

-

q

+

q

+

+ +
Syntax summary: +q +
Help text: +Quits the application after confirming. +
Registered by: +shand_cmd plugin +
+

If you have unsaved changes, you will be prompted to confirm (or save) before quitting, unless the action name included a !. +

-

quit

+

quit

+

+ +
Syntax summary: +Quit() +
Help text: +Quits the application after confirming. +
Registered by:n/a +
+

If you have unsaved changes, you will be prompted to confirm (or save) before quitting. +

-

redo

+

redo

+

+ +
Syntax summary: +redo() +
Help text: +Redo recent "undo" operations. +
Registered by:n/a +
+

The redo action allows you to recover from the last undo command. You might want to do this if you thought that undo was going to revert something other than what it actually did (in case you are confused about which operations are un-doable), or if you have been backing up through a long undo list and over-shoot your stopping point. Any change that is made since the undo in question will trim the redo list. For example if you add ten lines, then undo three of them you could use redo to put them back, but if you move a line on the board before performing the redo, you will lose the ability to "redo" the three "undone" lines. +

-

renumberblock

+

renumberblock

+

+ +
Syntax summary: +RenumberBlock(old_base,new_base) +
Help text: +TODO +
Registered by: +renumber plugin +
+

Example: RenumberBlock(oldnum,newnum)
@@ -1711,9 +2499,20 @@ Example: RenumberBlock(100,200)
will change R213 to R313. +

-

renumberbuffer

+

renumberbuffer

+

+ +
Syntax summary: +RenumberBlock(old_base,new_base) +
Help text: +TODO +
Registered by: +renumber plugin +
+

Example: RenumberBuffer(oldnum,newnum)
@@ -1721,9 +2520,20 @@ Same as renumberblock , but the paste buffer is renumbered. +

-

report

+

report

+

+ +
Syntax summary: +Report(Object|DrillReport|FoundPins|NetLength|NetLengthTo|AllNetLengths|[,name]) +
Help text: +Produce various report. +
Registered by: +report plugin +
+

Arguments:

@@ -1761,17 +2571,35 @@ The name and length of the net under the crosshair will be reported to the message log. An optional parameter specifies mm, mil, pcb, or in units +

-

reportdialog

+

reportdialog

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

This is a shortcut for report ( Object ). +

-

ripup

+

ripup

+

+ +
Syntax summary: +RipUp(All|Selected|Element) +
Help text: +Ripup auto-routed tracks +
Registered by:n/a +
+

Arguments:

@@ -1791,25 +2619,66 @@ Removes all selected lines and vias which were created by the autorouter. +

-

rn

+

rn

+

+ +
Syntax summary: +rn [name] +
Help text: +Reads netlist. +
Registered by: +shand_cmd plugin +
+

If no filename is given a file select box will pop up. +

-

rotate90

+

rotate90

+

+ +
Syntax summary: +pcb_move_obj(steps) +
Help text: +Rotates the object under the crosshair by 90 degree steps. +
Registered by:n/a +
+

Rotates the object under the mouse pointer by 90 degree steps . steps must be an integer between -3 and +3. +

-

s

+

s

+

+ +
Syntax summary: +s [name] +w [name] +
Help text: +Saves layout data. +
Registered by: +shand_cmd plugin +
+

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. +

-

save

+

save

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

This action is a GUI front-end to the core's saveto action. If you happen to pass a filename then @@ -1817,9 +2686,21 @@ is called directly. Else, the user is prompted for a filename to save, and then saveto is called with that filename. +

-

saveto

+

saveto

+

+ +
Syntax summary: +SaveTo(Layout|LayoutAs,filename,[fmt]) +SaveTo(AllConnections|AllUnusedPins|ElementConnections,filename) +SaveTo(PasteBuffer,filename,[fmt]) +
Help text: +Saves data to a file. +
Registered by:n/a +
+

Arguments:

@@ -1863,9 +2744,17 @@ Save the content of the active Buffer to a file. This is the graphical way to create a footprint. +

-

scroll

+

scroll

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Arguments:

@@ -1891,9 +2780,21 @@ WARNING: available in the GTK HID only. +

-

select

+

select

+

+ +
Syntax summary: +Select(Object|ToggleObject) +Select(All|Block|Connection) +Select(Convert) +
Help text: +Toggles or sets the selection. +
Registered by:n/a +
+

Arguments:

@@ -1933,13 +2834,37 @@ Converts the selected objects to a subcircuit. This uses the highest numbered paste buffer. +

-

selectlayer

+

selectlayer

+

+ +
Syntax summary: +SelectLayer(1..MAXLAYER|Silk|Rats) +
Help text: +Select which layer is the current layer. +
Registered by:n/a +
+

The specified layer becomes the currently active layer. It is made visible if it is not already visible +

-

setflag

+

setflag

+

+ +
Syntax summary: +SetFlag(Object|Selected|SelectedObjects, flag) +SetFlag(SelectedLines|SelectedPins|SelectedVias, flag) +SetFlag(SelectedPads|SelectedTexts|SelectedNames, flag) +SetFlag(SelectedElements, flag) +flag = thermal | join +
Help text: +Sets flags on objects. +
Registered by:n/a +
+

Turns the given flag on, regardless of its previous setting. See changeflag . @@ -1947,13 +2872,39 @@ Example: SetFlag(SelectedPins,thermal)
+

-

setsame

+

setsame

+

+ +
Syntax summary: +SetSame() +
Help text: +Sets current layer and sizes to match indicated item. +
Registered by:n/a +
+

When invoked over any line, arc, polygon, or via, this changes the current layer to be the layer that item is on, and changes the current sizes (thickness, clearance, etc) according to that item. +

-

setthermal

+

setthermal

+

+ +
Syntax summary: +SetThermal(Object|SelectedPins|SelectedVias|Selected, Style) +
Help text: +Set the thermal (on the current layer) of padstacks to the given style. +Style = 0 means no thermal. +Style = 1 has diagonal fingers with sharp edges. +Style = 2 has horizontal and vertical fingers with sharp edges. +Style = 3 is a solid connection to the plane. +Style = 4 has diagonal fingers with rounded edges. +Style = 5 has horizontal and vertical fingers with rounded edges. +
Registered by:n/a +
+

This changes how/whether padstacks connect to any rectangle or polygon on the current layer. The first argument can specify one object, or all selected padstacks. The second argument specifies the style of connection.

Thermal styles: @@ -2001,9 +2952,19 @@

Padstacks may have thermals whether or not there is a polygon available to connect with. However, they will have no visible effect until a polygon is drawn around the padstack. +

-

setunits

+

setunits

+

+ +
Syntax summary: +SetUnits(mm|mil) +
Help text: +Set the default measurement units. +
Registered by:n/a +
+

@@ -2021,9 +2982,19 @@ Sets the display units to millimeters.
+

-

setvalue

+

setvalue

+

+ +
Syntax summary: +SetValue(Grid|Line|LineSize|Text|TextScale, delta) +
Help text: +Change various board-wide values and sizes. +
Registered by:n/a +
+

Arguments:

@@ -2053,9 +3024,17 @@ Changes the size of new text. +

-

swapsides

+

swapsides

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

This action changes the way you view the board (flipping the board).

Arguments: @@ -2091,9 +3070,22 @@ If S is specified as a second argument, if the layer group for the side you're looking at is visible and currently active, and the layer group for the opposite is not visible (i.e. disabled), then this action will also swap which layer group is visible and active, effectively swapping the "working side" of the board. +

-

toggleview

+

toggleview

+

+ +
Syntax summary: +ToggleView(1..MAXLAYER) +ToggleView(layername) +ToggleView(Silk|Rats|Pins|Vias|BackSide) +ToggleView(All, Open|Vis, Set|Clear|Toggle) +
Help text: +Toggle the visibility of the specified layer or layer group. +
Registered by:n/a +
+

If you pass an integer, that layer is specified by index (the first layer is 1 @@ -2101,9 +3093,20 @@ , etc). If you pass a layer name, that layer is specified by name. When a layer is specified, the visibility of the layer group containing that layer is toggled.

If you pass a special layer name, the visibility of those components (silk, rats, etc) is toggled. Note that if you have a layer named the same as a special layer, the layer is chosen over the special layer. +

-

undo

+

undo

+

+ +
Syntax summary: +undo() +undo(ClearList) +
Help text: +Undo recent changes. +
Registered by:n/a +
+

The unlimited undo feature of pcb-rnd allows you to recover from most operations that materially affect you work. Calling pcb_undo without any parameter recovers from the last (non-undo) operation. @@ -2117,9 +3120,19 @@ Note that undo groups operations by serial number; changes with the same serial number will be undone (or redone) as a group. See atomic . +

-

unselect

+

unselect

+

+ +
Syntax summary: +Unselect(All|Block|Connection) +
Help text: +Unselects the object at the pointer location or the specified objects. +
Registered by:n/a +
+

Arguments:

@@ -2145,9 +3158,21 @@ Unselect all connections with the "found" flag set. +

-

w

+

w

+

+ +
Syntax summary: +s [name] +w [name] +
Help text: +Saves layout data. +
Registered by: +shand_cmd plugin +
+

This commands has been added for the convenience of vi @@ -2155,9 +3180,20 @@ users and has the same functionality as s . +

-

wq

+

wq

+

+ +
Syntax summary: +wq +
Help text: +Saves the layout data and quits. +
Registered by: +shand_cmd plugin +
+

This command has been added for the convenience of vi @@ -2167,9 +3203,17 @@ combined with q . +

-

zoom

+

zoom

+

+ +
Syntax summary:n/a +
Help text:n/a +
Registered by:n/a +
+

Changes the zoom (magnification) of the view of the board. If no arguments are passed, the view is scaled such that the board just fits inside the visible window (i.e. "view all"). Otherwise, factor specifies a change in zoom factor. It may be prefixed by @@ -2267,6 +3311,7 @@

Note that zoom factors of zero are silently ignored. +