+
-
+
For a detailed list of formats, please refer to the appendix. Index: doc/user/09_appendix/action_reference.html =================================================================== --- doc/user/09_appendix/action_reference.html (revision 13593) +++ doc/user/09_appendix/action_reference.html (revision 13594) @@ -10,7 +10,7 @@
| Action | Description | Syntax |
|---|---|---|
| ElementSetAttr | @@ -53,6 +53,15 @@||
| netlist | Perform various actions on netlists. | Net(find|select|rats|norats|clear[,net[,pin]]) Net(freeze|thaw|forcethaw) Net(swap) Net(add,net,pin) |
+
| DebugXY | +Debug action, with coordinates | +DebugXY(...) | +
| PadstackEdit | +interactive pad stack editor | +PadstackEdit(object) | +
| forcecolor | +change selected element's color to #RRGGBB, reset if does not start with '#' | +forcecolor(#RRGGBB) |
| LoadFontFrom | Load PCB font from a file | LoadFontFrom([file, id]) | @@ -65,6 +74,9 @@
| ToggleView | Toggle the visibility of the specified layer or layer group. | ToggleView(1..MAXLAYER) ToggleView(layername) ToggleView(Silk|Rats|Pins|Vias|Mask|BackSide) ToggleView(All, Open|Vis, Set|Clear|Toggle) |
+
| DumpLibrary | +Display the entire contents of the libraries. | +DumpLibrary() |
| CreateText | Create a new text object | CreateText(layer, fontID, X, Y, direction, scale, text) | @@ -83,6 +95,9 @@
| propedit | Run the property editor | propedit() | +
| PadstackConvert | +Convert selection or current buffer to padstack | +PadstackConvert(buffer|selected, [originx, originy]) |
| pscalib | ||
| EditLayer | Change a property or attribute of a layer. If the first argument starts with @, it is taken as the layer name to manipulate, else the action uses the current layer. Without arguments or if only a layer name is specified, interactive runs editing. | @@ -105,6 +120,9 @@|
| 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) |
+
| Brave | +Changes brave settings. | +Brave() Brave(setting, on|off) |
| distributetext | Distribute Text Elements | DistributeText(Y, [Lefts/Rights/Tops/Bottoms/Centers/Gaps, [First/Last/pcb_crosshair, First/Last/pcb_crosshair[, Gridless]]]) | @@ -134,6 +152,9 @@
| LoadFootprint | Loads a single footprint by name. | pcb_load_footprint(filename[,refdes,value]) | +
| OptAutoOnly | +Toggles the optimize-only-autorouted flag. | +OptAutoOnly() |
| New | Starts a new layout. | New([name]) | @@ -174,6 +195,9 @@
| ChkGridUnits | Return 1 if currently selected grid unit matches the expected (normally mm or mil) | ChkGridUnits(expected) | +
| mill | +Calculate toolpath for milling away copper | +mill() |
| ChangeSquare | Changes the square flag of pins and pads. | ChangeSquare(ToggleObject) ChangeSquare(SelectedElements|SelectedPins) ChangeSquare(Selected|SelectedObjects) |
@@ -186,6 +210,9 @@
| LoadLtspiceFrom | Loads the specified ltspice .net and .asc file - the netlist must be mentor netlist. | LoadLtspiceFrom(filename) | +
| extedit | +extedit(object|selected, [interactive|method]) | +Invoke an external program to edit a specific part of the current board. |
| DumpPlugins | Print plugins loaded in a format digestable by scripts. | DumpPlugins() | @@ -247,6 +274,12 @@
| Report | Produce various report. | Report(Object|DrillReport|FoundPins|NetLength|AllNetLengths|[,name]) | +
| shape | +Interactive shape generator. | +shape() | +
| Bell | +Attempt to produce audible notification (e.g. beep the speaker). | +Bell() |
| Undo | Undo recent changes. | undo() undo(ClearList) |
@@ -263,6 +296,12 @@
| FontEdit | Convert the current font to a PCB for editing. | FontEdit() | +
| 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]) | +
| Debug | +Debug action. | +Debug(...) |
| 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 |
@@ -317,12 +356,22 @@
| Atomic | Save or restore the undo serial number. | Atomic(Save|Restore|Close|Block) | +
| Info | +||
| PadstackPlace | +Place a pad stack (either proto_id, or if not specified, the default for style) | +PadstackPlace([proto_id|default], [x, y]) |
| dumplayers | Print info about each layer | dumplayers() | +
| Backup | +Backup the current layout - save using the same method that the timed backup function uses | +Backup() |
| dumpfonts | Print info about fonts | dumpfonts() | +
| circle | +Generate a filled circle (zero length round cap line) | +circle([where,] diameter) |
| d1 | debug action for development | d1() | @@ -380,9 +429,9 @@
| Unselect | Unselects the object at the pointer location or the specified objects. | Unselect(All|Block|Connection) Unselect(ElementByName|ObjectByName|PadByName|PinByName) Unselect(ElementByName|ObjectByName|PadByName|PinByName, Name) Unselect(TextByName|ViaByName) Unselect(TextByName|ViaByName, Name) |
-
| NetlistChanged | -Tells the GUI that the netlist has changed. | -NetlistChanged() | +
| Return | +Simulate a passing or failing action. | +Return(0|1) |
| ChangeSize | Changes the size of objects. | 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) |
@@ -389,6 +438,9 @@
| PrintActions | Print all actions available. | PrintActions() | +
| NetlistChanged | +Tells the GUI that the netlist has changed. | +NetlistChanged() |
| jostle | Move lines out of the way | Jostle(diameter) | @@ -395,6 +447,9 @@
| ChangeOctagon | Changes the octagon-flag of pins and vias. | ChangeOctagon(Object|ToggleObject|SelectedObjects|Selected) ChangeOctagon(SelectedElements|SelectedPins|SelectedVias) |
+
| ToggleVendor | +Toggles the state of automatic drill size mapping. | +ToggleVendor() |
| RemoveMenu | Recursively removes a new menu, popup (only path specified) or submenu. | RemoveMenu(path|cookie) | @@ -431,6 +486,9 @@
| AddRats | Add one or more rat lines to the board. | AddRats(AllRats|SelectedRats|Close) | +
| roundrect | +Generate a rectangle with round corners | +roundrect([where,] width[;height] [,rx[;ry] [,rotation]]) |
| LoadEeschemaFrom | Loads the specified eeschema .net file - the netlist must be an s-expression. | LoadEeschemaFrom(filename) | @@ -461,6 +519,9 @@
| 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() | +
| EnableVendor | +Enables automatic drill size mapping. | +EnableVendor() |
| Quit | Quits the application after confirming. | Quit() | @@ -485,7 +546,12 @@
| ChangePaste | Changes the no paste flag of objects. | ChangePaste(ToggleObject|Object|SelectedPads|Selected) | +
| Help | ||
| PolyCombine | +||
| DisableVendor | +Disables automatic drill size mapping. | +DisableVendor() | +
| PolyStitch | ||
| Select | Toggles or sets the selection. | Select(Object|ToggleObject) Select(All|Block|Connection) Select(ElementByName|ObjectByName|PadByName|PinByName) Select(ElementByName|ObjectByName|PadByName|PinByName, Name) Select(TextByName|ViaByName|NetByName) Select(TextByName|ViaByName|NetByName, Name) Select(Convert) |
Index: doc/user/09_appendix/bridges.svg
===================================================================
--- doc/user/09_appendix/bridges.svg (nonexistent)
+++ doc/user/09_appendix/bridges.svg (revision 13594)
@@ -0,0 +1,202 @@
+
+
+
+
Index: doc/user/09_appendix/src/Makefile
===================================================================
--- doc/user/09_appendix/src/Makefile (revision 13593)
+++ doc/user/09_appendix/src/Makefile (revision 13594)
@@ -1,5 +1,7 @@
-CLEANFILES=../action_reference.html ../dialogtable.html
+# NOTE: aagraph is at svn://repo.hu/projects/aagraph/trunk
+CLEANFILES=../action_reference.html ../dialogtable.html ../bridges.svg
+
all: ../action_reference.html ../dialogtable.html
../action_reference.html : ./dump_actions_to_html.sh ../../../../src/pcb-rnd
@@ -8,5 +10,8 @@
../dialogtable.html: pcb-rnd-dialogs ./process_dialogtable.sh ../../../../src/pcb-rnd
./process_dialogtable.sh > ../dialogtable.html
+../bridges.svg: bridges.txt
+ aagraph -Tsvg bridges.txt > ../bridges.svg
+
clean:
rm $(CLEANFILES)
Index: doc/user/09_appendix/src/bridges.txt
===================================================================
--- doc/user/09_appendix/src/bridges.txt (nonexistent)
+++ doc/user/09_appendix/src/bridges.txt (revision 13594)
@@ -0,0 +1,281 @@
+ *io--------------------------------------------------------------+
+ | [kica ] [gpcb ] [hyp_] [gsch] |
+ | [ frt_ ] [fido] [prtl] [eagl] |
+ +----------------------------------------------------------------+
+*inp---+ *hid--------+
+|[eesc]| *pcbrnd----------------------------------------------------------+ |[batch ] |
+|[mucs]| | | | |
+|[lept]| | | |[gtk ] |
+|[ltsp]| | | | |
+|[tcad]| | | |[lesstif] |
+|[edif]| | | | |
+|[netl]| | | |[remote] |
+|[hpgl]| +----------------------------------------------------------------+ +-----------+
++------+
+ *out-----------------------------------------------------------------+
+ | [bbrd] [bom_] [xy__] [gerb] [ipcd] [lpr_] [scad] | [web ]
+ | [stat] [ps__] [svg_] [png_] [nelm] [dxf_] |
+ +--------------------------------------------------------------------+
+%%
+
+[]
+ shape box
+
+
+[inp]
+ linecolor #cccccc
+ bgcolor #cccccc
+ textcolor #884433
+ label input-only
+ valign top
+
+[io]
+ linecolor #cccccc
+ bgcolor #cccccc
+ textcolor #884433
+ label input-output
+ valign top
+
+[out]
+ linecolor #cccccc
+ bgcolor #cccccc
+ textcolor #884433
+ label output-only
+ valign bottom
+
+[hid]
+ linecolor #cccccc
+ bgcolor #cccccc
+ textcolor #884433
+ label HID (GUI)
+ valign top
+
+
+[pcbrnd]
+ label pcb-rnd
+ bgcolor #00ffff
+
+
+[eesc]
+ label kicad\neeschema
+
+[mucs]
+ label mucs PCB\nautorouter
+
+[lept]
+ label lepton\nEDA
+
+[ltsp]
+ label LTSpice
+
+[tcad]
+ label TinyCAD
+
+[edif]
+ label (any)\nEDIF
+
+[netl]
+ label (any)\nnetlist
+
+[hpgl]
+ label HPGL\n(2D CAD)
+
+[bbrd]
+ label breadboard
+
+
+[hyp_]
+ label Mentor\nhyperlynx
+
+[gsch]
+ label gEDA\ngschem
+
+[kica]
+ label kicad\npcbnew
+
+[gpcb]
+ label gEDA\npcb
+
+[frt_]
+ label freerouting.net\nautorouter
+
+[fido]
+ label FidoCadJ\n(board)
+
+[prtl]
+ label Protel\nAutotrax
+
+[eagl]
+ label Eagle\n(board)
+
+
+
+[bbrd]
+ label breadboard
+
+[bom_]
+ label BOM
+
+[xy__]
+ label XY\ntemplated
+
+[gerb]
+ label gerber
+
+[ipcd]
+ label ipcd356\ne-tester
+
+[lpr_]
+ label lpr\n(print)
+
+[dxf_]
+ label dxf\n(2D CAD)
+
+[scad]
+ label openscad\n(3D CAD)
+
+[stat]
+ label stat\nstatistics
+
+[ps__]
+ label ps\npostscript
+
+[svg_]
+ label svg
+
+[png_]
+ label png\njpg, bmp
+
+[nelm]
+ label nelma\n(sim)
+
+
+
+
+
+[batch]
+ label batch\nCLI/automation
+
+[gtk]
+ label gtk\ngdk or gl render
+
+[lesstif]
+ label lesstif\n(motif)
+
+[remote]
+ label remote\n(network)
+
+[web]
+ label web client\n(javascript)
+ linecolor #aaaaaa
+ textcolor #aaaaaa
+
+
+-> pcbrnd bbrd.n
+ label .png
+
+-> pcbrnd bom_.n
+ label text
+
+-> pcbrnd xy__.n
+ label .xy
+
+-> pcbrnd gerb.n
+ label .grb, .cnc
+
+-> eesc.e pcbrnd
+ label import\nschematics
+
+-> pcbrnd ipcd.n
+ label IPC356D
+
+-> pcbrnd lpr_.n
+ label ps
+
+-> pcbrnd dxf_.n
+
+-> pcbrnd scad.n
+
+-> pcbrnd stat.n
+ label lihata
+
+-> pcbrnd ps__.n
+ label postscript
+
+-> pcbrnd svg_.n
+ label svg
+
+-> pcbrnd png_.n
+
+-> pcbrnd nelm.n
+
+
+
+-> mucs.e pcbrnd
+ label import\nnetlist
+
+-> lept.e pcbrnd
+ label import\nschematics
+
+-> ltsp.e pcbrnd
+ label import\nschematics
+
+-> tcad.e pcbrnd
+ label import\nschematics
+
+-> edif.e pcbrnd
+ label import\nschematics
+
+-> netl.e pcbrnd
+ label import\nnetlist
+
+-> hpgl.e pcbrnd
+ label import\nlines/arcs
+
+
+
+
+<-> hyp_.s pcbrnd
+ label board
+
+<-> gsch.s pcbrnd
+ label schematics
+
+<-> gpcb.s-0.3 pcbrnd
+ label board
+
+<-> gpcb.s+0.3 pcbrnd
+ label footprint
+
+<-> kica.s-0.4 pcbrnd
+ label board\ns-expr
+
+-> kica.s pcbrnd
+ label board\nlegacy
+
+<-> kica.s+0.4 pcbrnd
+ label footprint\ns-expr
+
+<-> frt_.s pcbrnd
+ label board
+
+<-> fido.s pcbrnd
+ label board
+
+<-> prtl.s pcbrnd
+ label board
+
+<-> eagl.s pcbrnd
+ label board
+
+
+<-> pcbrnd batch.w
+
+<-> pcbrnd gtk.w
+
+<-> pcbrnd lesstif.w
+
+<-> pcbrnd remote.w
+
+<-> remote.s web
+ label TCP/IP