Index: trunk/doc/user/09_appendix/action_reference.html =================================================================== --- trunk/doc/user/09_appendix/action_reference.html (revision 26553) +++ trunk/doc/user/09_appendix/action_reference.html (revision 26554) @@ -13,19 +13,25 @@
Action | Description | Syntax | Plugin |
---|---|---|---|
About | Present the about box | About() | dialogs plugin | +
acompnet | Attempt to auto-complete the current network | acompnet() | acompnet plugin |
AddRats | Add one or more rat lines to the board. | AddRats(AllRats|SelectedRats|Close) | |
AddTimer | Add a new timer | AddTimer(action, period, [repeat], [userdata]) | script plugin |
AdjustStyle | Open the dialog box for editing the route styles. | AdjustStyle([routestyle_idx]) | lib_hid_pcbui/route_style | +
align | Align subcircuits | Align(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]]) | distalign plugin | +
aligntext | Align Text Elements | AlignText(X/Y, [Lefts/Rights/Tops/Bottoms/Centers, [First/Last/pcb_crosshair/Average[, Gridless]]]) | distaligntext plugin |
ApplyVendor | Applies the currently loaded vendor drill table to the current design. | ApplyVendor() | vendor drill mapping |
ArcNew | Create a pcb arc segment on a layer. For now data must be "pcb". Returns the ID of the new object or 0 on error. | ArcNew([noundo,] data, layer, centx, centy, radiusx, radiusy, start_ang, delta_ang, thickness, clearance, flags) | act_draw | +
asm | Interactive assembly assistant | asm() | asm plugin |
Atomic | Save or restore the undo serial number. | Atomic(Save|Restore|Close|Block) | |
Attributes | Let the user edit the attributes of the layout, current or given layer, or selected subcircuit. | Attributes(Layout|Layer|Element|Subc) Attributes(Layer,layername) | + |
autocrop | Autocrops the board dimensions to (extants + a margin of 1 grid), keeping the move and board size grid aligned | autocrop() | autocrop plugin |
AutoPlaceSelected | Auto-place selected components. | AutoPlaceSelected() | autoplace plugin |
AutoRoute | Auto-route some or all rat lines. | AutoRoute(AllRats|SelectedRats) | autoroute plugin | +
awk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Backup | Backup the current layout - save using the same method that the timed backup function uses | Backup() | |
Bell | Attempt to produce audible notification (e.g. beep the speaker). | Bell() | oldactions plugin |
Benchmark | Benchmark the GUI speed. | Benchmark() | @@ -32,6 +38,7 @@ |
BoardFlip | Mirror the board over the x axis, optionally mirroring sides as well. | BoardFlip([sides]) | |
Brave | Changes brave settings. | Brave() Brave(setting, on|off) | |
BrowseScripts | Present a dialog box for browsing scripts | BrowseScripts() | script plugin | +
cam | Export jobs for feeding cam processes | cam(exec, script, [options]) cam(call, jobname, [options]) cam([gui]) | cam exporter |
Center | Moves the pointer to the center of the window. | Center() | lib_hid_pcbui/actions |
ChangeAngle | Changes the start angle, delta angle or both angles of an arc. | ChangeAngle(Object, start|delta|both, delta) ChangeAngle(SelectedObjects|Selected, start|delta|both, delta) ChangeAngle(SelectedArcs, start|delta|both, delta) | |
ChangeClearSize | Changes the clearance size of objects. | ChangeClearSize(Object, delta|style) ChangeClearSize(SelectedPins|SelectedPads|SelectedVias, delta|style) ChangeClearSize(SelectedLines|SelectedArcs, delta|style) ChangeClearSize(Selected|SelectedObjects, delta|style) | @@ -57,33 +64,54 @@ |
ChkSubcID | Return 1 if currently shown subc ID matches the requested pattern | ChkSubcID(pattern) | |
ChkTermID | Return 1 if currently shown term ID matches the requested pattern | ChkTermID(pattern) | |
ChkView | Return 1 if layerid is visible. | ChkView(layerid) | + |
circle | Generate a filled circle (zero length round cap line) | circle([where,] diameter) | shape plugin | +
claimnet | Claim existing connections and create a new net | ClaimNet(object|selected|found,[netname]) | |
ClearOctagon | oldactions plugin | ||
ClearSquare | oldactions plugin | ||
ClipInhibit | ClipInhibit Feature Template. | ClipInhibit([on|off|check]) | + |
cli_MessageBox | Intenal: CLI frontend action. Do not use directly. | + | |
cli_PromptFor | Intenal: CLI frontend action. Do not use directly. | ||
ClrFlag | Clears flags on objects. | ClrFlag(Object|Selected|SelectedObjects, flag) ClrFlag(SelectedLines|SelectedPins|SelectedVias, flag) ClrFlag(SelectedPads|SelectedTexts|SelectedNames, flag) ClrFlag(SelectedElements, flag) flag = thermal | join | |
Command | Displays the command line input in the status area. | Command() | lib_hid_pcbui/actions | +
conf | Perform various operations on the configuration tree. | conf(set, path, value, [role], [policy]) - change a config setting to an absolute value conf(delta, path, value, [role], [policy]) - change a config setting by a delta value (numerics-only) conf(toggle, path, [role]) - invert boolean value of a flag; if no role given, overwrite the highest prio config conf(reset, role) - reset the in-memory lihata of a role conf(iseq, path, value) - returns whether the value of a conf item matches value (for menu checked's) | |
Connection | Searches connections of the object at the cursor position. | Connection(Find|ResetLinesAndPolygons|ResetPinsAndVias|Reset) | + |
constraint | Configure or remove a drawing constraint | constraint(type, off) constraint(type, value, [value...]) | ddraft plugin | +
cpcb | Executed external autorouter cpcb to route the board or parts of the board | cpcb(board|selected, [command]) | cpcb plugin |
CreateMenu | Creates a new menu, popup (only path specified) or submenu (at least path and action are specified) | CreateMenu(path) CreateMenu(path, action, tooltip, cookie) | |
CreateText | Create a new text object | CreateText(layer, fontID, X, Y, direction, scale, text) | |
Cursor | Move the cursor. | Cursor(Type,DeltaUp,DeltaRight,Units) | |
CycleDrag | Cycle through which object is being dragged | CycleDrag() | - |
DRC | Invoke the DRC check. Results are presented as the argument requests. | DRC([list|simple|print|log|dump]) | + |
d1 | debug action for development | d1() | diag plugin | +
dad | Manipulate Dynamic Attribute Dialogs | dad(dlgname, new) - create new dialog dad(dlgname, label, text) - append a label widget dad(dlgname, button, text) - append a button widget dad(dlgname, button_closes, label, retval, ...) - standard close buttons dad(dlgname, enum, choices) - append an enum (combo box) widget; choices is a tab separated list dad(dlgname, bool, [label]) - append an checkbox widget (default off) dad(dlgname, integer|real|coord, min, max, [label]) - append an input field dad(dlgname, string) - append a single line text input field dad(dlgname, progress) - append a progress bar (set to 0) dad(dlgname, tree, cols, istree, [header]) - append tree-table widget; header is like enum values dad(dlgname, tree_append, row, cells) - append after row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_append_under, row, cells) - append at the end of the list under row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_insert, row, cells) - insert before row (0 means first item of the root); cells is like enum values; returns a row pointer dad(dlgname, begin_hbox) - begin horizontal box dad(dlgname, begin_vbox) - begin vertical box dad(dlgname, begin_hpane) - begin horizontal paned box dad(dlgname, begin_vpane) - begin vertical paned box dad(dlgname, begin_table, cols) - begin table layout box dad(dlgname, begin_tabbed, tabnames) - begin a view with tabs; tabnames are like choices in an enum; must have as many children widgets as many names it has dad(dlgname, end) - end the last begin dad(dlgname, flags, flg1, flg2, ...) - change the flags of the last created widget dad(dlgname, onchange, action) - set the action to be called on widget change dad(dlgname, run, title) - present dlgname as a non-modal dialog dad(dlgname, run_modal, title) - present dlgname as a modal dialog dad(dlgname, exists) - returns wheter the named dialog exists (0 or 1) dad(dlgname, set, widgetID, val) - changes the value of a widget in a running dialog dad(dlgname, get, widgetID, [unit]) - return the current value of a widget | lib_hid_common plugin | +
ddraft | Enter 2d drafting CLI mode or execute command | ddraft([command]) | ddraft plugin |
Debug | Debug action. | Debug(...) | oldactions plugin |
DebugXY | Debug action, with coordinates | DebugXY(...) | oldactions plugin | -
DelGroup | Remove a layer group; if the first argument is not specified, the current group is removed | DelGroup([@group]) | |
Delete | Delete stuff. | Delete(Object|Selected) Delete(AllRats|SelectedRats) | |
DeleteRats | Delete rat lines. | DeleteRats(AllRats|Selected|SelectedRats) | + |
DelGroup | Remove a layer group; if the first argument is not specified, the current group is removed | DelGroup([@group]) | |
DescribeLocation | Return a string constant (valud until the next call) containing a short description at x;y (object, net, etc.) | DescribeLocation(x, y) | lib_hid_pcbui/status |
DisableVendor | Disables automatic drill size mapping. | DisableVendor() | oldactions plugin |
DisperseElements | Disperses subcircuits. | DisperseElements(All|Selected) | |
Display | Several display-related actions. | 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) | + |
distribute | Distribute subcircuits | Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distalign plugin | +
distributetext | Distribute Text Elements | DistributeText(Y, [Lefts/Rights/Tops/Bottoms/Centers/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distaligntext plugin | +
djopt | Perform various optimizations on the current board. | djopt(debumpify|unjaggy|simple|vianudge|viatrim|orthopull) djopt(auto) - all of the above djopt(miter) | djopt | +
dlg_test | test the attribute dialog | dlg_test() | dialogs plugin | +
DRC | Invoke the DRC check. Results are presented as the argument requests. | DRC([list|simple|print|log|dump]) | |
DrcDialog | Execute drc checks and invoke a view list dialog box for presenting the results | DrcDialog([list|simple]) | dialogs plugin |
DumpActions | Dump all actions available. | DumpActions() | + |
dumpconf | Perform various operations on the configuration tree. | dumpconf(native, [verbose], [prefix]) - dump the native (binary) config tree to stdout dumpconf(lihata, role, [prefix]) - dump in-memory lihata representation of a config tree | diag plugin |
DumpCsect | Print the cross-section of the board (layer stack) | DumpCsect() | draw_csect | +
dumpdata | Dump an aspect of the data | dumpdata() | diag plugin | +
dumpflags | dump flags, optionally using the format string provided by the user | dumpflags([fmt]) | diag plugin | +
dumpfonts | Print info about fonts | dumpfonts() | diag plugin | +
dumpids | Dump the ID hash | DumpIDs() | diag plugin | +
dumplayers | Print info about each layer | dumplayers([all]) | diag plugin |
DumpLibrary | Display the entire contents of the libraries. | DumpLibrary() | oldactions plugin |
DumpObjFlags | Print a script processable digest of all flags, per object type | DumpObjFlags() | |
DumpPluginDirs | Print plugins directories in a format digestable by scripts. | DumpPluginDirs() | |
DumpPlugins | Print plugins loaded in a format digestable by scripts. | DumpPlugins() | + |
dumpundo | Print info about fonts | dumpfonts() | diag plugin |
DumpVersion | Dump version in script readable format. | DumpVersion() | |
DupGroup | Duplicate a layer group; if the first argument is not specified, the current group is duplicated | DupGroup([@group]) | |
EditGroup | Change a property or attribute of a layer group. If the first argument starts with @, it is taken as the group name to manipulate, else the action uses the current layer's group. Without arguments or if only a layer name is specified, interactive runs editing. | Editgroup([@group], [name=text|type=+bit|type=-bit])] Editlayer([@layer], attrib, key=value) | @@ -91,21 +119,26 @@ |
ElementList | Adds the given element if it doesn't already exist. | ElementList(Start|Done|Need, | |
ElementSetAttr | Sets or clears an element-specific attribute. | ElementSetAttr(refdes,name[,value]) | |
EnableVendor | Enables automatic drill size mapping. | EnableVendor() | oldactions plugin | +
estutter | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
EvalConf | Perform various operations on the configuration tree. | EvalConf(path) - evaluate a config path in different config sources to figure how it ended up in the native database | diag plugin |
ExecCommand | Run shell command | System(shell_cmd) | |
ExecuteFile | Run actions from the given file. | ExecuteFile(filename) | |
ExpFeatTmp | Experimental Feature Template. | ExpFeatTmp(...) | experimental features plugin |
Export | Export the current layout, e.g. Export(png, --dpi, 600) | Export(exporter, [exporter-args]) | + |
ExportcpcbTo | Dumps the current board in c-pcb format. | ExportcpcbTo(filename) | cpcb plugin |
ExportGUI | Open the export dialog. | ExportGUI() | dialogs plugin |
ExportOldConn | Export galvanic connection data in an old, custom file format. | ExportOldConn(AllConnections|AllUnusedPins|ElementConnections,filename) | export_oldconn HID | +
ExportScadPoly | exports all selected polygons to an openscad script; only the outmost contour of each poly is exported | ScadExportPoly(filename) | openscad HID |
ExportSTL | Export a three dimensional triangulated surface model in stl | ExportSTL() | export_stl HID | -
ExportScadPoly | exports all selected polygons to an openscad script; only the outmost contour of each poly is exported | ScadExportPoly(filename) | openscad HID | -
ExportcpcbTo | Dumps the current board in c-pcb format. | ExportcpcbTo(filename) | cpcb plugin | +
extedit | extedit(object|selected|buffer, [interactive|method]) | Invoke an external program to edit a specific part of the current board. | extedit plugin | +
find2perf | Measure the peformance of find2.c | find2perf() | diag plugin |
FlagEdit | Change the layer binding. | FlagEdit(object) | dialogs plugin |
Flip | Flip a subcircuit to the opposite side of the board. | Flip(Object|Selected) | |
FontEdit | Convert the current font to a PCB for editing. | FontEdit() | fontmode plugin |
FontSave | Convert the current PCB back to a font. | FontSave() | fontmode plugin |
Fontsel | Open the font selection dialog | Fontsel() | dialogs plugin | +
forcecolor | change selected objects' color to #RRGGBB, reset if does not start with '#' | forcecolor(#RRGGBB) | diag plugin | +
fp_rehash | Flush the library index; rescan all library search paths and rebuild the library index. Useful if there are changes in the library during a pcb-rnd session. | fp_rehash() | |
FreeRotateBuffer | 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. | FreeRotateBuffer([Angle]) | |
FullScreen | Hide widgets to get edit area full screen | FullScreen(on|off|toggle) | |
GetParentData | Return the closest upstream pcb_data_t * parent of an object | GetParentData([root_data,] idpath) | act_read | @@ -115,18 +148,28 @@
GlobalPuller | Pull all traces tight. | pcb_act_GlobalPuller([Found|Selected]) | puller plugin |
Grid | Set the grid. | grid(set, [name:]size[@offs][!unit]) grid(+|up) grid(-|down) grid(#N) grid(idx, N) | |
GroupPropGui | Change group flags and properties | GroupPropGui(groupid) | dialogs plugin | +
gui_FallbackColorPick | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | +|
gui_MessageBox | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | +|
gui_PromptFor | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | +|
h | Print a help message for commands. | h | shand_cmd plugin |
Help | On-line action help | Help() | |
IDP | Basic idpath manipulation. | IDP([print|free], idpath) | act_read |
IDPList | Basic idpath list manipulation. | IDPList(alloc) IDPList(free|clear|print|dup|length, list) IDPList(get|pop|remove, list, idx) IDPList(prepend|append|push, list, idpath) | act_read | -
IOIncompatList | Present the format incompatibilities of the last save to file operation. | IOIncompatList([list|simple]) | - |
IOIncompatListDialog | Present the format incompatibilities of the last save to file operation in a GUI dialog. | IOIncompatListDialog([list|simple]) | dialogs plugin |
Import | Import schematics. | Import() Import([gnetlist|make[,source,source,...]]) Import(setnewpoint[,(mark|center|X,Y)]) Import(setdisperse,D,units) | import_sch plugin | +
ImportcpcbFrom | Loads the auto-routed tracks from the specified c-pcb output. | ImportcpcbFrom(filename) | cpcb plugin |
ImportGUI | Asks user which schematics to import into PCB. | ImportGUI() | dialogs plugin | -
ImportcpcbFrom | Loads the auto-routed tracks from the specified c-pcb output. | ImportcpcbFrom(filename) | cpcb plugin |
Info | report plugin | ||
InfoBarFileChanged | Present the "file changed" warning info bar with buttons to reload or cancel | InfoBarFileChanged(open|close) | dialogs plugin | +
integrity | perform integrirty check on the current board and generate errors if needed | integrity() | diag plugin | +
IOIncompatList | Present the format incompatibilities of the last save to file operation. | IOIncompatList([list|simple]) | + |
IOIncompatListDialog | Present the format incompatibilities of the last save to file operation in a GUI dialog. | IOIncompatListDialog([list|simple]) | dialogs plugin | +
javascript | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
jostle | Make room by moving wires away. | Jostle(diameter) | jostle plugin | +
js | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
l | Loads layout data. | l [name] [format] | shand_cmd plugin |
LayerBinding | Change the layer binding. | LayerBinding(object) LayerBinding(selected) LayerBinding(buffer) | dialogs plugin |
LayerPropGui | Change layer flags and properties | LayerPropGui(layerid) | dialogs plugin | +
le | Loads an element (subcircuit, footprint) into the current buffer. | le [name] | shand_cmd plugin |
LibraryChanged | Tells the GUI that the libraries have changed. | LibraryChanged() | oldactions plugin |
LibraryDialog | Open the library dialog. | libraryDialog() | dialogs plugin |
LineNew | Create a pcb line segment on a layer. For now data must be "pcb". Returns the ID of the new object or 0 on error. | LineNew([noundo,] data, layer, X1, Y1, X2, Y2, Thickness, Clearance, Flags) | act_draw | @@ -142,6 +185,7 @@
LoadFpcbnlFrom | Loads the specified freepcb netlist. | LoadFpcbnlFrom(filename) | fpcb_nl importer |
LoadFrom | Load layout data from a file. | LoadFrom(Layout|LayoutToBuffer|SubcToBuffer|Netlist|Revert,filename[,format]) | |
LoadHpglFrom | Loads the specified hpgl plot file to the current buffer | LoadHpglFrom(filename) | hpgl importer | +
LoadhypFrom | Loads the specified Hyperlynx file. | LoadhypFrom(filename[, "debug"]...) | hyp importer |
LoadIpc356From | Loads the specified IPC356-D netlist | LoadIpc356From(filename, [nonet], [nopad], [nosubc]) | ipcd356 importer |
LoadLtspiceFrom | Loads the specified ltspice .net and .asc file - the netlist must be mentor netlist. | LoadLtspiceFrom(filename) | ltspice importer |
LoadMentorFrom | Loads the specified Mentor Graphics Design Capture schematics flat .edf file. | LoadMentorFrom(filename) | mentor_sch importer | @@ -151,13 +195,17 @@
LoadTinycadFrom | Loads the specified tinycad .net file - the netlist must be tinycad netlist output. | LoadTinycadFrom(filename) | tinycad importer |
LoadTtfGlyphs | Loads glyphs from an outline ttf in the specified source range, optionally remapping them to dstchars range in the pcb-rnd font | LoadTtfGlyphs(filename, srcglyps, [dstchars]) | ttf importer |
LoadVendorFrom | Loads the specified vendor lihata file. | LoadVendorFrom(filename) | vendor drill mapping | -
LoadhypFrom | Loads the specified Hyperlynx file. | LoadhypFrom(filename[, "debug"]...) | hyp importer |
Log | Manages the central, in-memory log. | Log(clear, [fromID, [toID]) Log(export, [filename, [text|lihata]) | |
LogDialog | Open the log dialog. | LogDialog() | lib_hid_common plugin | +
lua | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
m | Loads a layout into the current buffer. | m [name] | shand_cmd plugin |
ManagePlugins | Manage plugins dialog. | ManagePlugins() | dialogs plugin |
MarkCrosshair | Set/Reset the pcb_crosshair mark. | MarkCrosshair() MarkCrosshair(Center) | + |
mawk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
mesh | generate a mesh for simulation | mesh() | openems HID |
Message | Writes a message to the log window. | message([ERROR|WARNING|INFO|DEBUG,] message) | |
MessageBox | Open a modal message dialog box with title and label. If icon string is not empty, display the named icon on the left. Present one or more window close buttons with different text and return value. | MessageBox(icon, title, label, button_txt, button_retval, ...) | + |
mill | Calculate toolpath for milling away copper | mill() | millpath plugin |
MinClearGap | Ensures that polygons are a minimum distance from objects. | MinClearGap(delta) MinClearGap(Selected, delta) | |
MinMaskGap | oldactions plugin | ||
Mode | Change or use the tool mode. | 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) | @@ -165,6 +213,9 @@ |
MoveLayer | Moves/Creates/Deletes Layers. | MoveLayer(old,new) MoveLayer(lid,group,gid) | |
MoveObject | Moves the object under the crosshair. | pcb_move_obj(X,Y,[units]) | |
MoveToCurrentLayer | Moves objects to the current layer. | MoveToCurrentLayer(Object|SelectedObjects) | + |
mruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
net | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | + |
netlist | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | |
NetlistChanged | Tells the GUI that the netlist has changed. | NetlistChanged() | oldactions plugin |
NetlistDialog | Open the netlist dialog. | NetlistDialog() | dialogs plugin |
New | Starts a new layout. | New([name]) | @@ -174,15 +225,19 @@ |
OpenemsExcitation | Select which openEMS excitation method should be exported and manipulate the associated parameters. When invoked without arguments a dialog box with the same functionality is presented. | OpenemsExcitation([interactive]) OpenemsExcitation(select, excitationname) OpenemsExcitation(set, [excitationnme], paramname, paramval) OpenemsExcitation(get, [excitationnme], paramname) | openems HID |
OptAutoOnly | Toggles the optimize-only-autorouted flag. | OptAutoOnly() | oldactions plugin |
OrderPCB | Order the board from a fab | orderPCB([gui]) | order plugin | -
PCBChanged | Tells the GUI that the whole PCB has changed. The optional "revert"parameter can be used as a hint to the GUI that the same design is beingreloaded, and that it might keep some viewport settings | PCBChanged([revert]) | oldactions plugin |
PadstackBreakup | Break up a padstack into one non-padstack object per layer type (the hole is ignored) | PadstackBreakup(buffer|selected|objet) | |
PadstackConvert | Convert selection or current buffer to padstack | PadstackConvert(buffer|selected, [originx, originy]) | |
PadstackEdit | interactive pad stack editor | PadstackEdit(object, [tab]) | dialogs plugin |
PadstackPlace | Place a pad stack (either proto_id, or if not specified, the default for style) | PadstackPlace([proto_id|default], [x, y]) | |
Pan | Start or stop panning (Mode = 1 to start, 0 to stop) | Pan(Mode) | lib_hid_pcbui/actions | +
paral | Draw a line perpendicular to another line | perp() | ddraft plugin |
PasteBuffer | Various operations on the paste buffer. | 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) | + |
PCBChanged | Tells the GUI that the whole PCB has changed. The optional "revert"parameter can be used as a hint to the GUI that the same design is beingreloaded, and that it might keep some viewport settings | PCBChanged([revert]) | oldactions plugin | +
perl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
perp | Draw a line perpendicular to another line | perp() | ddraft plugin |
Pinout | Present the subcircuit pinout box | Pinout() | dialogs plugin |
PolyCombine | polycombine plugin | +||
Polygon | Some polygon related stuff. | Polygon(Close|CloseHole|PreviousPoint) | |
PolyHatch | hatch the selected polygon(s) with lines of the current style; lines are drawn on the current layer; flags are h:horizontal, v:vertical, c:contour, p:poly | PolyHatch([spacing], [hvcp]) PolyHatch(interactive) | lib_polyhelp |
PolyNew | Create an empty polygon. For now data must be "pcb". Use PolyNewPoint to add points. Returns a polygon pointer valid until PolyNewEnd() is called. | PolyNew([noundo,] data, layer, ptlist, clearance, flags) | act_draw |
PolyNewEnd | Close and place a polygon started by PolyNew. Returns the ID of the new object or 0 on error. | PolyNewEnd([noundo,] data, layer, poly) | act_draw | @@ -191,7 +246,6 @@
PolyNewPoints | Add a list of points to a polygon created by PolyNew. Returns 0 on success. | PolyNewPoints([noundo,] poly, ptlist) | act_draw |
PolyOffs | replicate the outer contour of the selected polygon(s) with growing or shrinking them by offset; the new polygon is drawn on the current layer | PolyOffs(offset) | lib_polyhelp |
PolyStitch | polystitch plugin | -||
Polygon | Some polygon related stuff. | Polygon(Close|CloseHole|PreviousPoint) | |
Popup | Bring up the popup menu specified by MenuName, optionally modified with the object type under the cursor. | Popup(MenuName, [obj-type]) | lib_hid_pcbui/actions |
Preferences | Present the preferences dialog, optionally opening the tab requested. | Preferences([tabname]) | dialogs plugin |
Present the print export dialog for printing the layout from the GUI. | Print() | @@ -204,15 +258,26 @@ | |
PrintUsage | Print command line arguments of pcb-rnd or a plugin loaded. | PrintUsage() PrintUsage(plugin) | |
PrintVersion | Print version. | PrintVersion() | |
PromptFor | Prompt for a string. Returns the string (or NULL on cancel) | PromptFor([message[,default[,title]]]) | + |
propedit | propedit(object[:id]|layer[:id]|layergrp[:id]|pcb|selection|selected) | propedit | +|
propprint | Print a property map of objects matching the scope. Scope is documented at PropEdit(). | PropPrint([scope]) | propedit | +
propset | Change the named property of all selected objects to/by value. Scope is documented at PropEdit(). | propset([scope], name, value) | propedit | +
pscalib | ps HID | +||
pstklib | Present the padstack library dialog on board padstacks or the padstacks of a subcircuit | pstklib([board|subcid|object]) | dialogs plugin |
PstkNew | Create a padstack. For now data must be "pcb". glob_clearance=0 turns off global clearance. Returns the ID of the new object or 0 on error. | PstkNew([noundo,] data, protoID, x, y, glob_clearance, flags) | act_draw |
PstkProtoEdit | Edit a padstack prototype specified by its pointer. | PstkProto([noundo,] proto, remove, layer_type PstkProto([noundo,] proto, copy, dst_layer_type, src_layer_type) | act_draw |
PstkProtoTmp | Allocate, insert or free a temporary padstack prototype | PstkProto([noundo,] new) PstkProto([noundo,] dup, idpath) PstkProto([noundo,] dup, data, src_proto_id) PstkProto([noundo,] insert, idpath|data, proto) PstkProto([noundo,] insert_dup, idpath|data, proto) PstkProto([noundo,] free, proto) | act_draw |
Puller | Pull an arc-line junction tight. | pcb_act_Puller() | puller plugin | +
py | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
python | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
q! | Quits the application without confirming. | q! | shand_cmd plugin | +
q | Quits the application after confirming. | q | shand_cmd plugin | +
query | Perform various queries on PCB data. | query(dump, expr) - dry run: compile and dump an expression query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist | |
QueryCompileField | With "compile": precompiles textual field name to field ID; with "free": frees the memory allocated for a previously precompiled fieldID. | QueryCompileField(compile, fieldname) QueryCompileField(free, fieldID) | |
QueryObj | Return the value of a field of an object, addressed by the object's idpath and the field's name or precompiled ID. Returns NIL on error. | QueryObj(idpath, [.fieldname|fieldID]) | |
Quit | Quits the application after confirming. | Quit() | |
Redo | Redo recent "undo" operations. | redo() | |
Redraw | Redraw the entire screen | Redraw() | + |
regpoly | Generate regular polygon. Where is x;y and radius is either r or rx;ry. Rotation is in degrees. | regpoly([where,] corners, radius [,rotation]) | shape plugin |
ReloadScript | Reload a fungw script | ReloadScript(id) | script plugin |
RemoveMenu | Recursively removes a new menu, popup (only path specified) or submenu. | RemoveMenu(path|cookie) | |
RemoveSelected | Removes any selected objects. | pcb_remove_selected() | @@ -223,9 +288,13 @@ |
Report | Produce various report. | Report(Object|DrillReport|FoundPins|NetLength|NetLengthTo|AllNetLengths|[,name]) | report plugin |
ReportObject | Report on the object under the crosshair | ReportObject() | report plugin |
RipUp | Ripup auto-routed tracks | RipUp(All|Selected|Element) | + |
rn | Reads netlist. | rn [name] | shand_cmd plugin |
Rotate90 | Rotates the object under the crosshair by 90 degree steps. | pcb_move_obj(steps) | + |
roundrect | Generate a rectangle with round corners | roundrect([where,] width[;height] [,rx[;ry] [,rotation [,cornstyle [,roundness]]]]) | shape plugin |
RouteStyle | Copies the indicated routing style into the current pen. | RouteStyle(style_id|style_name) | |
RouteStylesChanged | Tells the GUI that the routing styles have changed. | RouteStylesChanged() | oldactions plugin | +
ruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
s | Saves layout data. | s [name] w [name] | shand_cmd plugin |
Save | Save layout data to a user-selected file. | Save() Save(Layout|LayoutAs) Save(AllConnections|AllUnusedPins|ElementConnections) Save(PasteBuffer) | dialogs plugin |
SaveFontTo | Save PCB font to a file | SaveFontTo([file, id]) | |
SavePatch | Save netlist patch for back annotation. | SavePatch(filename) | @@ -245,16 +314,28 @@ |
SetThermal | 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. | SetThermal(Object|SelectedPins|SelectedVias|Selected, Style) | |
SetUnits | Set the default measurement units. | SetUnits(mm|mil) | |
SetValue | Change various board-wide values and sizes. | SetValue(Grid|Line|LineSize|Text|TextScale, delta) | + |
shape | Interactive shape generator. | shape() | shape plugin | +
skline | Tool for drawing sketch lines | skline() | sketch_route plugin | +
skretriangulate | Reconstruct CDT on all layer groups | skretriangulate() | sketch_route plugin | +
sktransform | Transform sketch to geometrical wiring | sktransform(rect|oct|alldir) | sketch_route plugin | +
smartdisperse | Disperse subcircuits into clusters, by netlist connections | SmartDisperse([All|Selected]) | smartdisperse plugin | +
split | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin |
StatusSetText | Replace status printout with text temporarily; turn status printout back on if text is not provided. | StatusSetText([text]) | lib_hid_pcbui/status | +
stroke | Various gesture recognition related functions | stroke(gesture, seq) | stroke plugin | +
stt | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | +
subc | Various operations on subc | subc(hash, [board|selected]) subc(loose, on|off|toggle|check) | |
SwapSides | Swaps the side of the board you're looking at. | SwapSides(|v|h|r, [S]) | lib_hid_pcbui/actions |
SwitchHID | Switch to another HID. | SwitchHID(lesstif|gtk|batch) | |
System | Run shell command | System(shell_cmd) | + |
tang | Draw a line to be tangential to a circle | tang() | ddraft plugin | +
tcl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin |
Teardrops | teardrops plugin | ||
TextNew | Create a pcb text on a layer. For now data must be "pcb". Font id 0 is the default font. Thickness 0 means default, calculated thickness. Scale=100 is the original font size. Returns the ID of the new object or 0 on error. | TextNew([noundo,] data, layer, fontID, x, y, rot, scale, thickness, test_string, flags) | act_draw | -
ToPoly | convert a closed loop of lines and arcs into a polygon | ToPoly() ToPoly(outline) | lib_polyhelp |
ToggleHideName | oldactions plugin | ||
ToggleVendor | Toggles the state of automatic drill size mapping. | ToggleVendor() | oldactions plugin |
ToggleView | Toggle the visibility of the specified layer or layer group. | ToggleView(1..MAXLAYER) ToggleView(layername) ToggleView(Silk|Rats|Pins|Vias|BackSide) ToggleView(All, Open|Vis, Set|Clear|Toggle) | + |
ToPoly | convert a closed loop of lines and arcs into a polygon | ToPoly() ToPoly(outline) | lib_polyhelp | +
trim | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin |
Undo | Undo recent changes. | undo() undo(ClearList) | |
UndoDialog | Open the undo dialog. | UndoDialog() | dialogs plugin |
UnloadScript | Unload a fungw script | UnloadScript(id) | script plugin | @@ -261,91 +342,10 @@
UnloadVendor | Unloads the current vendor drill mapping table. | UnloadVendor() | vendor drill mapping |
Unselect | Unselects the object at the pointer location or the specified objects. | Unselect(All|Block|Connection) | |
ViewList | Present a new empty view list | viewlist([name, [winid]]) | dialogs plugin | +
w | Saves layout data. | s [name] w [name] | shand_cmd plugin | +
wq | Saves the layout data and quits. | wq | shand_cmd plugin |
Zoom | GUI zoom | Zoom() Zoom([+|-|=]factor) Zoom(x1, y1, x2, y2) Zoom(selected) Zoom(?) Zoom(get) Zoom(found) | lib_hid_pcbui/actions |
ZoomTo | GUI zoom | Zoom() Zoom([+|-|=]factor) Zoom(x1, y1, x2, y2) Zoom(selected) Zoom(?) Zoom(get) Zoom(found) | lib_hid_pcbui/actions | -
acompnet | Attempt to auto-complete the current network | acompnet() | acompnet plugin | -
align | Align subcircuits | Align(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks, [First/Last/pcb_crosshair/Average[, Gridless]]]) | distalign plugin | -
aligntext | Align Text Elements | AlignText(X/Y, [Lefts/Rights/Tops/Bottoms/Centers, [First/Last/pcb_crosshair/Average[, Gridless]]]) | distaligntext plugin | -
asm | Interactive assembly assistant | asm() | asm plugin | -
autocrop | Autocrops the board dimensions to (extants + a margin of 1 grid), keeping the move and board size grid aligned | autocrop() | autocrop plugin | -
awk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
cam | Export jobs for feeding cam processes | cam(exec, script, [options]) cam(call, jobname, [options]) cam([gui]) | cam exporter | -
circle | Generate a filled circle (zero length round cap line) | circle([where,] diameter) | shape plugin | -
claimnet | Claim existing connections and create a new net | ClaimNet(object|selected|found,[netname]) | - |
cli_MessageBox | Intenal: CLI frontend action. Do not use directly. | - | |
cli_PromptFor | Intenal: CLI frontend action. Do not use directly. | - | |
conf | Perform various operations on the configuration tree. | conf(set, path, value, [role], [policy]) - change a config setting to an absolute value conf(delta, path, value, [role], [policy]) - change a config setting by a delta value (numerics-only) conf(toggle, path, [role]) - invert boolean value of a flag; if no role given, overwrite the highest prio config conf(reset, role) - reset the in-memory lihata of a role conf(iseq, path, value) - returns whether the value of a conf item matches value (for menu checked's) | - |
constraint | Configure or remove a drawing constraint | constraint(type, off) constraint(type, value, [value...]) | ddraft plugin | -
cpcb | Executed external autorouter cpcb to route the board or parts of the board | cpcb(board|selected, [command]) | cpcb plugin | -
d1 | debug action for development | d1() | diag plugin | -
dad | Manipulate Dynamic Attribute Dialogs | dad(dlgname, new) - create new dialog dad(dlgname, label, text) - append a label widget dad(dlgname, button, text) - append a button widget dad(dlgname, button_closes, label, retval, ...) - standard close buttons dad(dlgname, enum, choices) - append an enum (combo box) widget; choices is a tab separated list dad(dlgname, bool, [label]) - append an checkbox widget (default off) dad(dlgname, integer|real|coord, min, max, [label]) - append an input field dad(dlgname, string) - append a single line text input field dad(dlgname, progress) - append a progress bar (set to 0) dad(dlgname, tree, cols, istree, [header]) - append tree-table widget; header is like enum values dad(dlgname, tree_append, row, cells) - append after row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_append_under, row, cells) - append at the end of the list under row (0 means last item of the root); cells is like enum values; returns a row pointer dad(dlgname, tree_insert, row, cells) - insert before row (0 means first item of the root); cells is like enum values; returns a row pointer dad(dlgname, begin_hbox) - begin horizontal box dad(dlgname, begin_vbox) - begin vertical box dad(dlgname, begin_hpane) - begin horizontal paned box dad(dlgname, begin_vpane) - begin vertical paned box dad(dlgname, begin_table, cols) - begin table layout box dad(dlgname, begin_tabbed, tabnames) - begin a view with tabs; tabnames are like choices in an enum; must have as many children widgets as many names it has dad(dlgname, end) - end the last begin dad(dlgname, flags, flg1, flg2, ...) - change the flags of the last created widget dad(dlgname, onchange, action) - set the action to be called on widget change dad(dlgname, run, title) - present dlgname as a non-modal dialog dad(dlgname, run_modal, title) - present dlgname as a modal dialog dad(dlgname, exists) - returns wheter the named dialog exists (0 or 1) dad(dlgname, set, widgetID, val) - changes the value of a widget in a running dialog dad(dlgname, get, widgetID, [unit]) - return the current value of a widget | lib_hid_common plugin | -
ddraft | Enter 2d drafting CLI mode or execute command | ddraft([command]) | ddraft plugin | -
distribute | Distribute subcircuits | Distribute(X/Y, [Lefts/Rights/Tops/Bottoms/Centers/Marks/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distalign plugin | -
distributetext | Distribute Text Elements | DistributeText(Y, [Lefts/Rights/Tops/Bottoms/Centers/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | distaligntext plugin | -
djopt | Perform various optimizations on the current board. | djopt(debumpify|unjaggy|simple|vianudge|viatrim|orthopull) djopt(auto) - all of the above djopt(miter) | djopt | -
dlg_test | test the attribute dialog | dlg_test() | dialogs plugin | -
dumpconf | Perform various operations on the configuration tree. | dumpconf(native, [verbose], [prefix]) - dump the native (binary) config tree to stdout dumpconf(lihata, role, [prefix]) - dump in-memory lihata representation of a config tree | diag plugin | -
dumpdata | Dump an aspect of the data | dumpdata() | diag plugin | -
dumpflags | dump flags, optionally using the format string provided by the user | dumpflags([fmt]) | diag plugin | -
dumpfonts | Print info about fonts | dumpfonts() | diag plugin | -
dumpids | Dump the ID hash | DumpIDs() | diag plugin | -
dumplayers | Print info about each layer | dumplayers([all]) | diag plugin | -
dumpundo | Print info about fonts | dumpfonts() | diag plugin | -
estutter | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
extedit | extedit(object|selected|buffer, [interactive|method]) | Invoke an external program to edit a specific part of the current board. | extedit plugin | -
find2perf | Measure the peformance of find2.c | find2perf() | diag plugin | -
forcecolor | change selected objects' color to #RRGGBB, reset if does not start with '#' | forcecolor(#RRGGBB) | diag plugin | -
fp_rehash | Flush the library index; rescan all library search paths and rebuild the library index. Useful if there are changes in the library during a pcb-rnd session. | fp_rehash() | - |
gui_FallbackColorPick | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | -|
gui_MessageBox | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | -|
gui_PromptFor | Intenal: GUI frontend action. Do not use directly. | lib_hid_common plugin | -|
h | Print a help message for commands. | h | shand_cmd plugin | -
integrity | perform integrirty check on the current board and generate errors if needed | integrity() | diag plugin | -
javascript | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
jostle | Make room by moving wires away. | Jostle(diameter) | jostle plugin | -
js | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
l | Loads layout data. | l [name] [format] | shand_cmd plugin | -
le | Loads an element (subcircuit, footprint) into the current buffer. | le [name] | shand_cmd plugin | -
lua | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
m | Loads a layout into the current buffer. | m [name] | shand_cmd plugin | -
mawk | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
mesh | generate a mesh for simulation | mesh() | openems HID | -
mill | Calculate toolpath for milling away copper | mill() | millpath plugin | -
mruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
net | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | - |
netlist | Perform various actions on netlists. | Net(find|select|rats|norats||ripup|addrats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin)Net([rename|merge],srcnet,dstnet) | - |
paral | Draw a line perpendicular to another line | perp() | ddraft plugin | -
perl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
perp | Draw a line perpendicular to another line | perp() | ddraft plugin | -
propedit | propedit(object[:id]|layer[:id]|layergrp[:id]|pcb|selection|selected) | propedit | -|
propprint | Print a property map of objects matching the scope. Scope is documented at PropEdit(). | PropPrint([scope]) | propedit | -
propset | Change the named property of all selected objects to/by value. Scope is documented at PropEdit(). | propset([scope], name, value) | propedit | -
pscalib | ps HID | -||
pstklib | Present the padstack library dialog on board padstacks or the padstacks of a subcircuit | pstklib([board|subcid|object]) | dialogs plugin | -
py | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
python | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
q! | Quits the application without confirming. | q! | shand_cmd plugin | -
q | Quits the application after confirming. | q | shand_cmd plugin | -
query | Perform various queries on PCB data. | query(dump, expr) - dry run: compile and dump an expression query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist | - |
regpoly | Generate regular polygon. Where is x;y and radius is either r or rx;ry. Rotation is in degrees. | regpoly([where,] corners, radius [,rotation]) | shape plugin | -
rn | Reads netlist. | rn [name] | shand_cmd plugin | -
roundrect | Generate a rectangle with round corners | roundrect([where,] width[;height] [,rx[;ry] [,rotation [,cornstyle [,roundness]]]]) | shape plugin | -
ruby | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
s | Saves layout data. | s [name] w [name] | shand_cmd plugin | -
shape | Interactive shape generator. | shape() | shape plugin | -
skline | Tool for drawing sketch lines | skline() | sketch_route plugin | -
skretriangulate | Reconstruct CDT on all layer groups | skretriangulate() | sketch_route plugin | -
sktransform | Transform sketch to geometrical wiring | sktransform(rect|oct|alldir) | sketch_route plugin | -
smartdisperse | Disperse subcircuits into clusters, by netlist connections | SmartDisperse([All|Selected]) | smartdisperse plugin | -
split | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin | -
stroke | Various gesture recognition related functions | stroke(gesture, seq) | stroke plugin | -
stt | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
subc | Various operations on subc | subc(hash, [board|selected]) subc(loose, on|off|toggle|check) | - |
tang | Draw a line to be tangential to a circle | tang() | ddraft plugin | -
tcl | Execute a script one-liner using a specific language | Oneliner(lang, script) | script plugin | -
trim | Use one or more objects as cutting edge and trim or split other objects. First argument is the cutting edge | trim([selected|found|object], [selected|found|object]) split([selected|found|object], [selected|found|object]) | ddraft plugin | -
w | Saves layout data. | s [name] w [name] | shand_cmd plugin | -
wq | Saves the layout data and quits. | wq | shand_cmd plugin |