Index: doc/user/09_appendix/action_reference.html =================================================================== --- doc/user/09_appendix/action_reference.html (revision 35730) +++ doc/user/09_appendix/action_reference.html (revision 35731) @@ -13,7 +13,7 @@ @@ -34,6 +34,7 @@ + @@ -114,6 +115,7 @@ + @@ -135,6 +137,7 @@ + @@ -163,6 +166,7 @@ + @@ -199,7 +203,9 @@ + + @@ -242,9 +248,11 @@ + + @@ -259,6 +267,7 @@ + @@ -293,6 +302,7 @@ + @@ -323,11 +333,13 @@ - + + + @@ -369,6 +381,7 @@ + @@ -397,10 +410,12 @@ + +
-This is pcb-rnd 3.0.0-dev (svn r35236) an interactive printed circuit board editor , Revision: 35241 +This is pcb-rnd 3.0.0 (svn r35666) an interactive printed circuit board editor , Revision: 35710
Action Description Syntax Plugin
AboutPresent the about boxAbout()dialogs plugin
autocropAutocrops the board dimensions to (extants + a margin of 1 grid), keeping the move and board size grid alignedautocrop()autocrop plugin
AutoPlaceSelectedAuto-place selected components.AutoPlaceSelected()autoplace plugin
AutoRouteAuto-route some or all rat lines.AutoRoute(AllRats|SelectedRats)autoroute plugin
awkExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
BackupBackup the current layout - save using the same method that the timed backup function usesBackup()
basExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
BellAttempt to produce audible notification (e.g. beep the speaker).Bell()oldactions plugin
DrcQueryImportImport a rule and related definitions from a file.DrcQueryImport([filename])drc_query
DrcQueryListRulesList all drc rules implemented in drc_queryDrcQueryListRules()drc_query
DrcQueryRuleModAutomated DRC rule editing (for scripting and import)DrcQueryRuleMod(clear, source)
DrcQueryRuleMod(create, rule_name)
DrcQueryRuleMod(get, rule_name, field_name)
DrcQueryRuleMod(set, rule_name, field_name, value)
DrcQueryRuleMod(remove, rule_name)
drc_query
duktapeExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
DumpActionsDump all actions available.DumpActions()
dumpconfPerform 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
DumpCsectPrint the cross-section of the board (layer stack)DumpCsect()draw_csect
ElementListAdds the given element if it doesn't already exist.ElementList(Start|Done|Need,,,)
ElementSetAttrSets or clears an element-specific attribute.ElementSetAttr(refdes,name[,value])
EnableVendorEnables automatic drill size mapping.EnableVendor()oldactions plugin
estutterExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
EvalConfPerform 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 databasediag plugin
ExecActionFileRun actions from the given file.ExecuteFile(filename)
ExecCommandRun shell commandSystem(shell_cmd)
fpasExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
fp_rehashFlush 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()
FreeRotateBufferRotates 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])
FsdTestCentral, DAD based File Selection Dialog demoFsdTest()lib_hid_common plugin
FullScreenHide widgets to get edit area full screenFullScreen(on|off|toggle)
GetMarkReturn mark properties in numeric form.GetMark(active|user_placed|x|y)act_read
GetParentDataReturn the closest upstream pcb_data_t * parent of an objectGetParentData([root_data,] idpath)act_read
ircnon-modal, single-instance, single-server, single-channel irc window for online supportirc()irc plugin
IsPointOnArcReturns 1 if point x;y with radius r is on the arc addressed by idpath, 0 else.IsPointOnArc(x, y, r, idpath)act_read
IsPointOnLineReturns 1 if point x;y with radius r is on the line addressed by idpath, 0 else.IsPointOnLine(x, y, r, idpath)act_read
javascriptExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
jostleMake room by moving wires away.Jostle(diameter)jostle plugin
jsExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
lLoads layout data.l [name] [format]shand_cmd plugin
LayerBindingChange the layer binding.LayerBinding(object)
LayerBinding(buffer)
dialogs plugin
LayerByStackLayer operations based on physical layer stackingLayerByStack(select, prev|next)
LoadVendorFromLoads the specified vendor lihata file. If second argument is "yes" or "pure", load in pure mode without side effects: do not reset or apply, only incrementally load.LoadVendorFrom(filename, [yes|no])vendor drill mapping
LogManages the central, in-memory log.Log(clear, [fromID, [toID])
Log(export, [filename, [text|lihata])
LogDialogOpen the log dialog.LogDialog()lib_hid_common plugin
luaExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
mLoads a layout into the current buffer.m [name]shand_cmd plugin
ManagePluginsManage plugins dialog.ManagePlugins()lib_hid_common plugin
MarkCrosshairSet/Reset the pcb_crosshair mark.MarkCrosshair()
MarkCrosshair(Center)
mawkExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
MenuDebugMenu debug helpers: save the merged menu in a fileMenuDebug(save, path)
MenuPatchManage menu patchesMenuPatch(load, cookie, path, desc)
MenuPatch(unload, cookie)
MenuPatch(list)
MenuPatch(InhibitInc|InhibitDec)
meshgenerate a mesh for simulationmesh()openems HID
MoveLayerMoves/Creates/Deletes Layers.MoveLayer(old,new)
MoveLayer(lid,group,gid)
MoveObjectMoves the object under the crosshair.pcb_move_obj(X,Y,[units])
MoveToCurrentLayerMoves objects to the current layer.MoveToCurrentLayer(Object|SelectedObjects)
mrubyExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
netPerform 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)
NetLengthReport physical network lengthNetLength(clear)
NetLength(object)
report plugin
netlistPerform 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)
pcb_sqrtscript plugin
pcb_srandscript plugin
pcb_tanscript plugin
perlExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
perpDraw a line perpendicular to another lineperp()ddraft plugin
PinoutPresent the subcircuit pinout boxPinout()dialogs plugin
PolyBoolPerform polygon boolean operation on the clipped polygons referred. A poly is either and idpath, selected, found or object (for the object under the cursor). When not specified, two object polygons are used.PstkProto([noundo,] unite|isect|sub, [poly1, poly2, [poly...]])act_draw
propprintPrint a property map of objects matching the scope. Scope is documented at PropEdit().PropPrint([scope])propedit
propsetChange the named property of scope or all selected objects to/by value. Scope is documented at PropEdit().propset([scope], name, value)propedit
proptoggleToggle the named property of scope or all selected objects, assuming the property is boolean. Scope is documented at PropEdit(). If create is true, non-existing attributes are created as true.proptoggle([scope], name, [create])propedit
pstklibPresent the padstack library dialog on board padstacks or the padstacks of a subcircuitpstklib([board|subcid|object], [retpid, [preselect]])dialogs plugin
pstklibPresent the padstack library dialog on board padstacks or the padstacks of a subcircuitpstklib([auto|board|subcid|object], [retpid, [preselect]])dialogs plugin
PstkNewCreate a padstack. For now data must be "pcb". glob_clearance=0 turns off global clearance. Returns the idpath of the new object or 0 on error.PstkNew([noundo,] data, protoID, x, y, glob_clearance, flags)act_draw
PstkProtoEditEdit a padstack prototype specified by its pointer.PstkProto([noundo,] proto, remove, layer_type)
PstkProto([noundo,] proto, copy, dst_layer_type, src_layer_type)
PstkProto([noundo,] proto, hdia, dia)
PstkProto([noundo,] proto, shape:line, layer_type, x1, y1, x2, y2, th, [square])
act_draw
PstkProtoTmpAllocate, insert or free a temporary padstack prototypePstkProto([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
PullerPull an arc-line junction tight.pcb_act_Puller()puller plugin
pyExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
pythonExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
q!Quits the application without confirming.q!shand_cmd plugin
qQuits the application after confirming.qshand_cmd plugin
queryPerform various queries on PCB data.query(dump, expr) - dry run: compile and dump an expression
query(eval|evalidp, expr) - compile and evaluate an expression and print a list of results on stdout
query(count, expr) - compile and evaluate an expression and return the number of matched objects (-1 on error)
query(select|unselect|view, expr) - select or unselect or build a view of objects matching an expression
query(setflag:flag|unsetflag:flag, expr) - set or unset a named flag on objects matching an expression
query(append, idplist, expr) - compile and run expr and append the idpath of resulting objects on idplist
query plugin
roundrectGenerate a rectangle with round cornersroundrect([where,] width[;height] [,rx[;ry] [,rotation [,cornstyle [,roundness]]]])shape plugin
RouteStyleWithout second argument: copies the indicated routing style into the current pen; with second argument sets or gets a field of the routing style.RouteStyle(style_id|style_name|@current, [set|get|del], [trace-thickness|trace-clearance|text-thickness|text-scale|font|via-proto|name], [value]])
RouteStyle(new, [name])
RouteStylesChangedTells the GUI that the routing styles have changed.RouteStylesChanged()oldactions plugin
rubyExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
sSaves layout data.s [name]
w [name]
shand_cmd plugin
SaveSave layout data to a user-selected file.Save()
Save(Layout|LayoutAs)
Save(AllConnections|AllUnusedPins|ElementConnections)
Save(PasteBuffer)
Save(DialogByPattern, pcb|footprint|font|buffer, none|board|fp, prompt, [default_pattern])
dialogs plugin
SaveFontToSave PCB font to a fileSaveFontTo([file, id])
splitUse one or more objects as cutting edge and trim or split other objects. First argument is the cutting edgetrim([selected|found|object], [selected|found|object])
split([selected|found|object], [selected|found|object])
ddraft plugin
StatusSetTextReplace status printout with text temporarily; turn status printout back on if text is not provided.StatusSetText([text])lib_hid_pcbui/status
strokeVarious gesture recognition related functionsstroke(gesture, seq)stroke plugin
sttExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
subcVarious operations on subcsubc(hash, [board|selected])
subc(loose, on|off|toggle|check)
SwapSidesSwaps the side of the board you're looking at.SwapSides(|v|h|r, [S])lib_hid_pcbui/actions
SystemRun shell commandSystem(shell_cmd)
tangDraw a line to be tangential to a circletang()ddraft plugin
tclExecute a script one-liner using a specific languageOneliner(lang, script)script plugin
Teardropsteardrops plugin
TedaxTestParseReturns 1 if the file looks like tEDAx (0 if not)TedaxTestParse(filename|FILE*)tEDAx IO
TextNewCreate 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 idpath of the new object or 0 on error.TextNew([noundo,] data, layer, fontID, x, y, rot, scale, thickness, text_string, flags)act_draw