Menu
▾
▴
[Pcb-src-changes] pcb.git: branch: master updated (b7f4b2e152568afe1e22c4da79ee11ce93991b0a)
|
From: <gi...@gp...> - 2011-08-28 16:59:50
|
The branch, master has been updated
via b7f4b2e152568afe1e22c4da79ee11ce93991b0a (commit)
via 099c532f9ffa76eac8ea048942404724c3ed1ffb (commit)
via 132b7884f3d1b7756cbd3de3c6b2c5d8391f0275 (commit)
via a2bb61a37c8740ac97b78e13850b99dc823ece60 (commit)
via d0a4f57ed3db92168f43bad660aa3e837f835a72 (commit)
via 3ef060db9f824c1e93072cf732bbcb2bd5a1a252 (commit)
via ce68e2acbda0abbd0a37204d89e5a032d0e7f240 (commit)
via 7a1ede921654701b726e3a497d3dc2f8b2591f47 (commit)
via 684c98015b44be8d0894cd3e5fe399a69c4bc12d (commit)
via eb90f7eb41ea46d49286beff7136b2435e1347ae (commit)
via 45074652a9619be78de0834402884969f9797ddc (commit)
via e6581d531dcd196767bbf867918e0ae22a93effb (commit)
via ceea0e16b5495b7f41337bea8cfc82db315746cd (commit)
via bd1083bc23ede3f14148eba2a5da75ceece85c00 (commit)
via 99782e903aaf8c7c3e8d0cfbbfbafb19db66ac6c (commit)
via 883b043e44169c32c58318b8ba5ac6895a040c39 (commit)
via 6072ec8c18b69a6dc7bafd89390d331cf0c11b8b (commit)
via 12d7fee2edb20b4677ea7736eec8eb739db29957 (commit)
from 94a9388560fc43431ac331e477acdb0c7c571220 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
=========
Summary
=========
doc/pcb.texi | 312 ++------------
src/hid/bom/bom.c | 26 +-
src/hid/gcode/gcode.c | 2 +-
src/hid/gerber/gerber.c | 30 ++-
src/hid/gtk/gui-top-window.c | 24 +
src/hid/lesstif/main.c | 23 +
src/hid/lpr/lpr.c | 15 +-
src/hid/nelma/nelma.c | 46 ++-
src/hid/png/png.c | 121 +++++-
src/hid/ps/eps.c | 44 ++-
src/hid/ps/ps.c | 177 +++++++-
src/main.c | 968 +++++++++++++++++++++++++++++++++++++++---
12 files changed, 1400 insertions(+), 388 deletions(-)
=================
Commit Messages
=================
commit b7f4b2e152568afe1e22c4da79ee11ce93991b0a
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Unify HID description (no fullstop at end of description)
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 a4377db... 40a13b1... M src/hid/gcode/gcode.c
:100644 100644 9fd936c... 5ba410f... M src/hid/gerber/gerber.c
:100644 100644 8a7b76a... 259812c... M src/hid/lpr/lpr.c
:100644 100644 cf704a7... 9659b66... M src/hid/nelma/nelma.c
:100644 100644 f9db4ca... f00d407... M src/hid/png/png.c
:100644 100644 08ede88... 87202f6... M src/hid/ps/ps.c
commit 099c532f9ffa76eac8ea048942404724c3ed1ffb
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for ps HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 02448e5... 08ede88... M src/hid/ps/ps.c
commit 132b7884f3d1b7756cbd3de3c6b2c5d8391f0275
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for eps HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 903270e... d280594... M src/hid/ps/eps.c
commit a2bb61a37c8740ac97b78e13850b99dc823ece60
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for png HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 61437a0... f9db4ca... M src/hid/png/png.c
commit d0a4f57ed3db92168f43bad660aa3e837f835a72
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for nemla HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 d5a58d8... cf704a7... M src/hid/nelma/nelma.c
commit 3ef060db9f824c1e93072cf732bbcb2bd5a1a252
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for lpt HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 65f0491... 8a7b76a... M src/hid/lpr/lpr.c
commit ce68e2acbda0abbd0a37204d89e5a032d0e7f240
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for Gerber HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 8829527... 9fd936c... M src/hid/gerber/gerber.c
commit 7a1ede921654701b726e3a497d3dc2f8b2591f47
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for the BOM HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 70b0567... d217269... M src/hid/bom/bom.c
commit 684c98015b44be8d0894cd3e5fe399a69c4bc12d
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for commandline-options for GTK+ and lesstif GUI
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 e2beb3c... d9b3f11... M src/hid/gtk/gui-top-window.c
:100644 100644 30739e9... 1885761... M src/hid/lesstif/main.c
commit eb90f7eb41ea46d49286beff7136b2435e1347ae
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for DRC commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 e99ea2c... 171c1f7... M src/main.c
commit 45074652a9619be78de0834402884969f9797ddc
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for general gui commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 6b5b577... e99ea2c... M src/main.c
commit e6581d531dcd196767bbf867918e0ae22a93effb
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for path commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 692a805... 6b5b577... M src/main.c
commit ceea0e16b5495b7f41337bea8cfc82db315746cd
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for commandline commands
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 9e6b3ad... 692a805... M src/main.c
commit bd1083bc23ede3f14148eba2a5da75ceece85c00
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for layer names commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 376dd1d... 9e6b3ad... M src/main.c
commit 99782e903aaf8c7c3e8d0cfbbfbafb19db66ac6c
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for size commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 ee1abbc... 376dd1d... M src/main.c
commit 883b043e44169c32c58318b8ba5ac6895a040c39
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for color commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 fe957c4... ee1abbc... M src/main.c
commit 6072ec8c18b69a6dc7bafd89390d331cf0c11b8b
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Docu: Add general description for commandline options
... and for general options.
(Patch 3/19 of this patch-serie is missing on purpose)
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 06d3860... b6b2436... M doc/pcb.texi
:100644 100644 5ce6e53... fe957c4... M src/main.c
commit 12d7fee2edb20b4677ea7736eec8eb739db29957
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Remove out-dated docu for commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
:100644 100644 cb09c00... 06d3860... M doc/pcb.texi
=========
Changes
=========
commit b7f4b2e152568afe1e22c4da79ee11ce93991b0a
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Unify HID description (no fullstop at end of description)
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/gcode/gcode.c b/src/hid/gcode/gcode.c
index a4377db..40a13b1 100644
--- a/src/hid/gcode/gcode.c
+++ b/src/hid/gcode/gcode.c
@@ -1005,7 +1005,7 @@ hid_gcode_init ()
gcode_hid.struct_size = sizeof (HID);
gcode_hid.name = "gcode";
- gcode_hid.description = "G-CODE export.";
+ gcode_hid.description = "G-CODE export";
gcode_hid.exporter = 1;
gcode_hid.poly_before = 1;
diff --git a/src/hid/gerber/gerber.c b/src/hid/gerber/gerber.c
index 9fd936c..5ba410f 100644
--- a/src/hid/gerber/gerber.c
+++ b/src/hid/gerber/gerber.c
@@ -1270,7 +1270,7 @@ hid_gerber_init ()
gerber_hid.struct_size = sizeof (gerber_hid);
gerber_hid.name = "gerber";
- gerber_hid.description = "RS-274X (Gerber) export.";
+ gerber_hid.description = "RS-274X (Gerber) export";
gerber_hid.exporter = 1;
gerber_hid.get_export_options = gerber_get_export_options;
diff --git a/src/hid/lpr/lpr.c b/src/hid/lpr/lpr.c
index 8a7b76a..259812c 100644
--- a/src/hid/lpr/lpr.c
+++ b/src/hid/lpr/lpr.c
@@ -135,7 +135,7 @@ hid_lpr_init ()
lpr_hid.struct_size = sizeof (HID);
lpr_hid.name = "lpr";
- lpr_hid.description = "Postscript print.";
+ lpr_hid.description = "Postscript print";
lpr_hid.printer = 1;
lpr_hid.poly_before = 1;
diff --git a/src/hid/nelma/nelma.c b/src/hid/nelma/nelma.c
index cf704a7..9659b66 100644
--- a/src/hid/nelma/nelma.c
+++ b/src/hid/nelma/nelma.c
@@ -1074,7 +1074,7 @@ hid_nelma_init()
nelma_hid.struct_size = sizeof (HID);
nelma_hid.name = "nelma";
- nelma_hid.description = "Numerical analysis package export.";
+ nelma_hid.description = "Numerical analysis package export";
nelma_hid.exporter = 1;
nelma_hid.poly_before = 1;
diff --git a/src/hid/png/png.c b/src/hid/png/png.c
index f9db4ca..f00d407 100644
--- a/src/hid/png/png.c
+++ b/src/hid/png/png.c
@@ -1644,7 +1644,7 @@ hid_png_init ()
png_hid.struct_size = sizeof (HID);
png_hid.name = "png";
- png_hid.description = "GIF/JPEG/PNG export.";
+ png_hid.description = "GIF/JPEG/PNG export";
png_hid.exporter = 1;
png_hid.poly_before = 1;
diff --git a/src/hid/ps/ps.c b/src/hid/ps/ps.c
index 08ede88..87202f6 100644
--- a/src/hid/ps/ps.c
+++ b/src/hid/ps/ps.c
@@ -1527,7 +1527,7 @@ hid_ps_init ()
ps_hid.struct_size = sizeof (HID);
ps_hid.name = "ps";
- ps_hid.description = "Postscript export.";
+ ps_hid.description = "Postscript export";
ps_hid.exporter = 1;
ps_hid.poly_before = 1;
commit 099c532f9ffa76eac8ea048942404724c3ed1ffb
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for ps HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/ps/ps.c b/src/hid/ps/ps.c
index 02448e5..08ede88 100644
--- a/src/hid/ps/ps.c
+++ b/src/hid/ps/ps.c
@@ -145,57 +145,212 @@ static MediaType media_data[] = {
HID_Attribute ps_attribute_list[] = {
/* other HIDs expect this to be first. */
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --psfile <string>
+Name of the postscript output file. Can contain a path.
+@end ftable
+%end-doc
+*/
{"psfile", "Postscript output file",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_psfile 0
- {"drill-helper", "Prints a centering target in large drill holes",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@cindex drill-helper
+@item --drill-helper
+Print a centering target in large drill holes.
+@end ftable
+%end-doc
+*/
+ {"drill-helper", "Print a centering target in large drill holes",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_drillhelper 1
- {"align-marks", "Prints alignment marks on each layer",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@cindex align-marks
+@item --align-marks
+Print alignment marks on each sheet. This is meant to ease alignment during exposure.
+@end ftable
+%end-doc
+*/
+ {"align-marks", "Print alignment marks on each sheet",
HID_Boolean, 0, 0, {1, 0, 0}, 0, 0},
#define HA_alignmarks 2
- {"outline", "Prints outline on each layer",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --outline
+Print the contents of the outline layer on each sheet.
+@end ftable
+%end-doc
+*/
+ {"outline", "Print outline on each sheet",
HID_Boolean, 0, 0, {1, 0, 0}, 0, 0},
#define HA_outline 3
- {"mirror", "Prints mirror image of each layer",
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --mirror
+Print mirror image.
+@end ftable
+%end-doc
+*/
+ {"mirror", "Print mirror image of every page",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_mirror 4
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --fill-page
+Scale output to make the board fit the page.
+@end ftable
+%end-doc
+*/
{"fill-page", "Scale board to fill page",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_fillpage 5
- {"auto-mirror", "Prints mirror image of appropriate layers",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --auto-mirror
+Print mirror image of appropriate layers.
+@end ftable
+%end-doc
+*/
+ {"auto-mirror", "Print mirror image of appropriate layers",
HID_Boolean, 0, 0, {1, 0, 0}, 0, 0},
#define HA_automirror 6
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --ps-color
+Postscript output in color.
+@end ftable
+%end-doc
+*/
{"ps-color", "Prints in color",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_color 7
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@cindex ps-bloat
+@item --ps-bloat <num>
+Amount to add to trace/pad/pin edges.
+@end ftable
+%end-doc
+*/
{"ps-bloat", "Amount to add to trace/pad/pin edges",
HID_Coord, -MIL_TO_COORD (100), MIL_TO_COORD (100), {0, 0, 0}, 0, 0},
#define HA_psbloat 8
- {"ps-invert", "Draw images as white-on-black",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@cindex ps-invert
+@item --ps-invert
+Draw objects as white-on-black.
+@end ftable
+%end-doc
+*/
+ {"ps-invert", "Draw objects as white-on-black",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_psinvert 9
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --media <media-name>
+Size of the media, the postscript is fitted to. The parameter
+@code{<media-name>} can be any of the standard names for paper size: @samp{A0}
+to @samp{A10}, @samp{B0} to @samp{B10}, @samp{Letter}, @samp{11x17},
+@samp{Ledger}, @samp{Legal}, @samp{Executive}, @samp{A-Size}, @samp{B-size},
+@samp{C-Size}, @samp{D-size}, @samp{E-size}, @samp{US-Business_Card},
+@samp{Intl-Business_Card}.
+@end ftable
+%end-doc
+*/
{"media", "media type",
HID_Enum, 0, 0, {22, 0, 0}, medias, 0},
#define HA_media 10
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@cindex psfade
+@item --psfade <num>
+Fade amount for assembly drawings (0.0=missing, 1.0=solid).
+@end ftable
+%end-doc
+*/
{"psfade", "Fade amount for assembly drawings (0.0=missing, 1.0=solid)",
HID_Real, 0, 1, {0, 0, 0.40}, 0, 0},
#define HA_psfade 11
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --scale <num>
+Scale value to compensate for printer sizing errors (1.0 = full scale).
+@end ftable
+%end-doc
+*/
{"scale", "Scale value to compensate for printer sizing errors (1.0 = full scale)",
HID_Real, 0.01, 4, {0, 0, 1.00}, 0, 0},
#define HA_scale 12
- {"multi-file", "Produce multiple files, one per page, instead of a single file.",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@cindex multi-file
+@item --multi-file
+Produce multiple files, one per page, instead of a single multi page file.
+@end ftable
+%end-doc
+*/
+ {"multi-file", "Produce multiple files, one per page, instead of a single file",
HID_Boolean, 0, 0, {0, 0, 0.40}, 0, 0},
#define HA_multifile 13
- {"xcalib", "X-Axis calibration (paper width).",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --xcalib <num>
+Paper width. Used for x-Axis calibration.
+@end ftable
+%end-doc
+*/
+ {"xcalib", "Paper width. Used for x-Axis calibration",
HID_Real, 0, 0, {0, 0, 1.0}, 0, 0},
#define HA_xcalib 14
- {"ycalib", "Y-Axis calibration (paper height).",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --ycalib <num>
+Paper height. Used for y-Axis calibration.
+@end ftable
+%end-doc
+*/
+ {"ycalib", "Paper height. Used for y-Axis calibration",
HID_Real, 0, 0, {0, 0, 1.0}, 0, 0},
#define HA_ycalib 15
- {"drill-copper", "Draw drill holes in pins / vias, instead of leaving solid copper.",
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@item --drill-copper
+Draw drill holes in pins / vias, instead of leaving solid copper.
+@end ftable
+%end-doc
+*/
+ {"drill-copper", "Draw drill holes in pins / vias, instead of leaving solid copper",
HID_Boolean, 0, 0, {1, 0, 0}, 0, 0},
#define HA_drillcopper 16
+
+/* %start-doc options "91 Postscript Export"
+@ftable @code
+@cindex show-legend
+@item --show-legend
+Print file name and scale on printout.
+@end ftable
+%end-doc
+*/
{"show-legend", "Print file name and scale on printout",
HID_Boolean, 0, 0, {1, 0, 0}, 0, 0},
#define HA_legend 17
commit 132b7884f3d1b7756cbd3de3c6b2c5d8391f0275
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for eps HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/ps/eps.c b/src/hid/ps/eps.c
index 903270e..d280594 100644
--- a/src/hid/ps/eps.c
+++ b/src/hid/ps/eps.c
@@ -75,18 +75,60 @@ static int fast_erase = -1;
static HID_Attribute eps_attribute_list[] = {
/* other HIDs expect this to be first. */
+
+/* %start-doc options "92 Encapsulated Postscript Export"
+@ftable @code
+@item --eps-file <string>
+Name of the encapsulated postscript output file. Can contain a path.
+@end ftable
+%end-doc
+*/
{"eps-file", "Encapsulated Postscript output file",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_psfile 0
+
+/* %start-doc options "92 Encapsulated Postscript Export"
+@ftable @code
+@item --eps-scale <num>
+Scale EPS output by the parameter @samp{num}.
+@end ftable
+%end-doc
+*/
{"eps-scale", "EPS scale",
HID_Real, 0, 100, {0, 0, 1.0}, 0, 0},
#define HA_scale 1
+
+/* %start-doc options "92 Encapsulated Postscript Export"
+@ftable @code
+@cindex as-shown (EPS)
+@item --as-shown
+Export layers as shown on screen.
+@end ftable
+%end-doc
+*/
{"as-shown", "Export layers as shown on screen",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_as_shown 2
- {"monochrome", "Convert to monochrome (like the ps export)",
+
+/* %start-doc options "92 Encapsulated Postscript Export"
+@ftable @code
+@item --monochrome
+Convert output to monochrome.
+@end ftable
+%end-doc
+*/
+ {"monochrome", "Convert to monochrome",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_mono 3
+
+/* %start-doc options "92 Encapsulated Postscript Export"
+@ftable @code
+@cindex only-visible
+@item --only-visible
+Limit the bounds of the EPS file to the visible items.
+@end ftable
+%end-doc
+*/
{"only-visible", "Limit the bounds of the EPS file to the visible items",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_only_visible 4
commit a2bb61a37c8740ac97b78e13850b99dc823ece60
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for png HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/png/png.c b/src/hid/png/png.c
index 61437a0..f9db4ca 100644
--- a/src/hid/png/png.c
+++ b/src/hid/png/png.c
@@ -164,58 +164,161 @@ static const char *filetypes[] = {
HID_Attribute png_attribute_list[] = {
/* other HIDs expect this to be first. */
+
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --outfile <string>
+Name of the file to be exported to. Can contain a path.
+@end ftable
+%end-doc
+*/
{"outfile", "Graphics output file",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_pngfile 0
- {"dpi", "Scale factor (pixels/inch). 0 to scale to fix specified size",
- HID_Integer, 0, 10000, {100, 0, 0}, 0, 0},
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --dpi
+Scale factor in pixels/inch. Set to 0 to scale to size specified in the layout.
+@end ftable
+%end-doc
+*/
+ {"dpi", "Scale factor (pixels/inch). 0 to scale to specified size",
+ HID_Integer, 0, 1000, {100, 0, 0}, 0, 0},
#define HA_dpi 1
- {"x-max", "Maximum width (pixels). 0 to not constrain.",
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --x-max
+Width of the png image in pixels. No constraint, when set to 0.
+@end ftable
+%end-doc
+*/
+ {"x-max", "Maximum width (pixels). 0 to not constrain",
HID_Integer, 0, 10000, {0, 0, 0}, 0, 0},
#define HA_xmax 2
- {"y-max", "Maximum height (pixels). 0 to not constrain.",
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --y-max
+Height of the png output in pixels. No constraint, when set to 0.
+@end ftable
+%end-doc
+*/
+ {"y-max", "Maximum height (pixels). 0 to not constrain",
HID_Integer, 0, 10000, {0, 0, 0}, 0, 0},
#define HA_ymax 3
- {"xy-max", "Maximum width and height (pixels). 0 to not constrain.",
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --xy-max
+Maximum width and height of the PNG output in pixels. No constraint, when set to 0.
+@end ftable
+%end-doc
+*/
+ {"xy-max", "Maximum width and height (pixels). 0 to not constrain",
HID_Integer, 0, 10000, {0, 0, 0}, 0, 0},
#define HA_xymax 4
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --as-shown
+Export layers as shown on screen.
+@end ftable
+%end-doc
+*/
{"as-shown", "Export layers as shown on screen",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_as_shown 5
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --monochrome
+Convert output to monochrome.
+@end ftable
+%end-doc
+*/
{"monochrome", "Convert to monochrome",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_mono 6
- {"only-visible", "Limit the bounds of the PNG file to the visible items",
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --only-vivible
+Limit the bounds of the exported PNG image to the visible items.
+@end ftable
+%end-doc
+*/
+ {"only-visible", "Limit the bounds of the PNG image to the visible items",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_only_visible 7
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --use-alpha
+Make the background and any holes transparent.
+@end ftable
+%end-doc
+*/
{"use-alpha", "Make the background and any holes transparent",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_use_alpha 8
- {"format", "Graphics file format",
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --format <string>
+File format to be exported. Parameter @code{<string>} can be @samp{PNG},
+@samp{GIF}, or @samp{JPEG}.
+@end ftable
+%end-doc
+*/
+ {"format", "Export file format",
HID_Enum, 0, 0, {0, 0, 0}, filetypes, 0},
#define HA_filetype 9
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --png-bloat <num><dim>
+Amount of extra thickness to add to traces, pads, or pin edges. The parameter
+@samp{<num><dim>} is a number, appended by a dimension @samp{mm}, @samp{mil}, or
+@samp{pix}. If no dimension is given, the default dimension is 1/100 mil.
+@end ftable
+%end-doc
+*/
{"png-bloat", "Amount (in/mm/mil/pix) to add to trace/pad/pin edges (1 = 1/100 mil)",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_bloat 10
- {"photo-mode", "Photo-realistic mode",
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@cindex photo-mode
+@item --photo-mode
+Export a photo realistic image of the layout.
+@end ftable
+%end-doc
+*/
+ {"photo-mode", "Photo-realistic export mode",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_photo_mode 11
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --photo-flip-x
+In photo-realistic mode, export the reverse side of the layout. Left-right flip.
+@end ftable
+%end-doc
+*/
{"photo-flip-x", "Show reverse side of the board, left-right flip",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_photo_flip_x 12
+/* %start-doc options "93 PNG Options"
+@ftable @code
+@item --photo-flip-y
+In photo-realistic mode, export the reverse side of the layout. Up-down flip.
+@end ftable
+%end-doc
+*/
{"photo-flip-y", "Show reverse side of the board, up-down flip",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_photo_flip_y 13
commit d0a4f57ed3db92168f43bad660aa3e837f835a72
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for nemla HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/nelma/nelma.c b/src/hid/nelma/nelma.c
index d5a58d8..cf704a7 100644
--- a/src/hid/nelma/nelma.c
+++ b/src/hid/nelma/nelma.c
@@ -153,23 +153,59 @@ static const double nelma_air_epsilon = 8.85e-12;
HID_Attribute nelma_attribute_list[] = {
/* other HIDs expect this to be first. */
+
+/* %start-doc options "nelma Options"
+@ftable @code
+@item -- basename <string>
+File name prefix.
+@end ftable
+%end-doc
+*/
{"basename", "File name prefix",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_basename 0
- {"dpi", "Horizontal scale factor (grid points/inch).",
+/* %start-doc options "nelma Options"
+@ftable @code
+@item --dpi <num>
+Horizontal scale factor (grid points/inch).
+@end ftable
+%end-doc
+*/
+ {"dpi", "Horizontal scale factor (grid points/inch)",
HID_Integer, 0, 1000, {100, 0, 0}, 0, 0},
#define HA_dpi 1
- {"copper-height", "Copper layer height (um).",
+/* %start-doc options "nelma Options"
+@ftable @code
+@item --copper-height <num>
+Copper layer height (um).
+@end ftable
+%end-doc
+*/
+ {"copper-height", "Copper layer height (um)",
HID_Integer, 0, 200, {100, 0, 0}, 0, 0},
#define HA_copperh 2
- {"substrate-height", "Substrate layer height (um).",
+/* %start-doc options "nelma Options"
+@ftable @code
+@item --substrate-height <num>
+Substrate layer height (um).
+@end ftable
+%end-doc
+*/
+ {"substrate-height", "Substrate layer height (um)",
HID_Integer, 0, 10000, {2000, 0, 0}, 0, 0},
#define HA_substrateh 3
- {"substrate-epsilon", "Substrate relative epsilon.",
+/* %start-doc options "nelma Options"
+@ftable @code
+@item --substrate-epsilon <num>
+Substrate relative epsilon.
+@end ftable
+%end-doc
+*/
+ {"substrate-epsilon", "Substrate relative epsilon",
HID_Real, 0, 100, {0, 0, 4.0}, 0, 0},
#define HA_substratee 4
};
commit 3ef060db9f824c1e93072cf732bbcb2bd5a1a252
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for lpt HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/lpr/lpr.c b/src/hid/lpr/lpr.c
index 65f0491..8a7b76a 100644
--- a/src/hid/lpr/lpr.c
+++ b/src/hid/lpr/lpr.c
@@ -29,7 +29,18 @@ RCSID ("$Id$");
#define CRASH fprintf(stderr, "HID error: pcb called unimplemented PS function %s.\n", __FUNCTION__); abort()
static HID_Attribute base_lpr_options[] = {
- {"lprcommand", "Command to print",
+
+/* %start-doc options "98 lpr Printing Options"
+@ftable @code
+@item --lprcommand <string>
+Command to use for printing. Defaults to @code{lpr}. This can be used to produce
+PDF output with a virtual PDF printer. Example: @*
+@code{--lprcommand "lp -d CUPS-PDF-Printer"}.
+@end ftable
+@noindent In addition, all @ref{Postscript Export} options are valid.
+%end-doc
+*/
+ {"lprcommand", "Command to use for printing",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_lprcommand 0
};
commit ce68e2acbda0abbd0a37204d89e5a032d0e7f240
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for Gerber HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/gerber/gerber.c b/src/hid/gerber/gerber.c
index 8829527..9fd936c 100644
--- a/src/hid/gerber/gerber.c
+++ b/src/hid/gerber/gerber.c
@@ -334,13 +334,37 @@ static const char *name_style_names[] = {
};
static HID_Attribute gerber_options[] = {
+
+/* %start-doc options "90 Gerber Export"
+@ftable @code
+@item --gerberfile
+Gerber output file prefix. Can include a path.
+@end ftable
+%end-doc
+*/
{"gerberfile", "Gerber output file base",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_gerberfile 0
- {"all-layers", "Print all layers, even empty ones",
+
+/* %start-doc options "90 Gerber Export"
+@ftable @code
+@item --all-layers
+Output contains all layers, even empty ones.
+@end ftable
+%end-doc
+*/
+ {"all-layers", "Output all layers, even empty ones",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_all_layers 1
- {"verbose", "print file names and aperture counts",
+
+/* %start-doc options "90 Gerber Export"
+@ftable @code
+@item --verbose
+Print file names and aperture counts on stdout.
+@end ftable
+%end-doc
+*/
+ {"verbose", "Print file names and aperture counts on stdout",
HID_Boolean, 0, 0, {0, 0, 0}, 0, 0},
#define HA_verbose 2
{"copy-outline", "Copy outline onto other layers",
commit 7a1ede921654701b726e3a497d3dc2f8b2591f47
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for the BOM HID commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/bom/bom.c b/src/hid/bom/bom.c
index 70b0567..d217269 100644
--- a/src/hid/bom/bom.c
+++ b/src/hid/bom/bom.c
@@ -27,12 +27,34 @@
RCSID ("$Id$");
static HID_Attribute bom_options[] = {
- {"bomfile", "BOM output file",
+/* %start-doc options "8 BOM Creation"
+@ftable @code
+@item --bomfile <string>
+Name of the BOM output file.
+@end ftable
+%end-doc
+*/
+ {"bomfile", "Name of the BOM output file",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_bomfile 0
- {"xyfile", "XY output file",
+/* %start-doc options "8 BOM Creation"
+@ftable @code
+@item --xyfile <string>
+Name of the XY output file.
+@end ftable
+%end-doc
+*/
+ {"xyfile", "Name of the XY output file",
HID_String, 0, 0, {0, 0, 0}, 0, 0},
#define HA_xyfile 1
+
+/* %start-doc options "8 BOM Creation"
+@ftable @code
+@item --xy-unit
+Unit of XY dimensions. Defaults to mil.
+@end ftable
+%end-doc
+*/
{"xy-unit", "XY units",
HID_Unit, 0, 0, {-1, 0, 0}, NULL, 0},
#define HA_unit 2
commit 684c98015b44be8d0894cd3e5fe399a69c4bc12d
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for commandline-options for GTK+ and lesstif GUI
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/hid/gtk/gui-top-window.c b/src/hid/gtk/gui-top-window.c
index e2beb3c..d9b3f11 100644
--- a/src/hid/gtk/gui-top-window.c
+++ b/src/hid/gtk/gui-top-window.c
@@ -1908,14 +1908,38 @@ static int stdin_listen = 0;
static char *pcbmenu_path = "gpcb-menu.res";
HID_Attribute ghid_attribute_list[] = {
+
+/* %start-doc options "21 GTK+ GUI Options"
+@ftable @code
+@item --listen
+Listen for actions on stdin.
+@end ftable
+%end-doc
+*/
{"listen", "Listen for actions on stdin",
HID_Boolean, 0, 0, {0, 0, 0}, 0, &stdin_listen},
#define HA_listen 0
+/* %start-doc options "21 GTK+ GUI Options"
+@ftable @code
+@item --bg-image <string>
+File name of an image to put into the background of the GUI canvas. The image must
+be a color PPM image, in binary (not ASCII) format. It can be any size, and will be
+automatically scaled to fit the canvas.
+@end ftable
+%end-doc
+*/
{"bg-image", "Background Image",
HID_String, 0, 0, {0, 0, 0}, 0, &bg_image_file},
#define HA_bg_image 1
+/* %start-doc options "21 GTK+ GUI Options"
+@ftable @code
+@item --pcb-menu <string>
+Location of the @file{gpcb-menu.res} file which defines the menu for the GTK+ GUI.
+@end ftable
+%end-doc
+*/
{"pcb-menu", "Location of gpcb-menu.res file",
HID_String, 0, 0, {0, PCBLIBDIR "/gpcb-menu.res", 0}, 0, &pcbmenu_path}
#define HA_pcbmenu 2
diff --git a/src/hid/lesstif/main.c b/src/hid/lesstif/main.c
index 30739e9..1885761 100644
--- a/src/hid/lesstif/main.c
+++ b/src/hid/lesstif/main.c
@@ -198,14 +198,37 @@ HID_Attribute lesstif_attribute_list[] = {
HID_Boolean, 0, 0, {0, 0, 0}, 0, &use_private_colormap},
#define HA_colormap 0
+/* %start-doc options "22 lesstif GUI Options"
+@ftable @code
+@item --listen
+Listen for actions on stdin.
+@end ftable
+%end-doc
+*/
{"listen", "Listen on standard input for actions",
HID_Boolean, 0, 0, {0, 0, 0}, 0, &stdin_listen},
#define HA_listen 1
+/* %start-doc options "22 lesstif GUI Options"
+@ftable @code
+@item --bg-image <string>
+File name of an image to put into the background of the GUI canvas. The image must
+be a color PPM image, in binary (not ASCII) format. It can be any size, and will be
+automatically scaled to fit the canvas.
+@end ftable
+%end-doc
+*/
{"bg-image", "Background Image",
HID_String, 0, 0, {0, 0, 0}, 0, &background_image_file},
#define HA_bg_image 2
+/* %start-doc options "22 lesstif GUI Options"
+@ftable @code
+@item --pcb-menu <string>
+Location of the @file{pcb-menu.res} file which defines the menu for the lesstif GUI.
+@end ftable
+%end-doc
+*/
{"pcb-menu", "Location of pcb-menu.res file",
HID_String, 0, 0, {0, PCBLIBDIR "/pcb-menu.res", 0}, 0, &lesstif_pcbmenu_path}
#define HA_pcbmenu 3
commit eb90f7eb41ea46d49286beff7136b2435e1347ae
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for DRC commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/main.c b/src/main.c
index e99ea2c..171c1f7 100644
--- a/src/main.c
+++ b/src/main.c
@@ -874,13 +874,69 @@ Default value is @code{2mil}.
CSET (AlignmentDistance, MIL_TO_COORD(2), "alignment-distance",
"distance between the boards outline and alignment targets"),
- CSET (Bloat, MIL_TO_COORD(10), "bloat", 0),
- CSET (Shrink, MIL_TO_COORD(10), "shrink", 0),
+/* %start-doc options "7 DRC Options"
+All parameters should be given with an unit. If no unit is given, 1/100 mil
+(cmil) will be used for backward compability. Valid units are given in section
+@ref{Sizes}.
+%end-doc
+*/
+
+
+/* %start-doc options "7 DRC Options"
+@ftable @code
+@item --bloat <num>
+Minimum spacing. Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
+ CSET (Bloat, MIL_TO_COORD(10), "bloat", "DRC minimum spacing in 1/100 mil"),
+
+/* %start-doc options "7 DRC Options"
+@ftable @code
+@item --shrink <num>
+Minimum touching overlap. Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
+ CSET (Shrink, MIL_TO_COORD(10), "shrink", "DRC minimum overlap in 1/100 mils"),
+
+/* %start-doc options "7 DRC Options"
+@ftable @code
+@item --min-width <num>
+Minimum width of copper. Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
CSET (minWid, MIL_TO_COORD(10), "min-width", "DRC minimum copper spacing"),
+
+/* %start-doc options "7 DRC Options"
+@ftable @code
+@item --min-silk <num>
+Minimum width of lines in silk. Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
CSET (minSlk, MIL_TO_COORD(10), "min-silk", "DRC minimum silk width"),
+
+/* %start-doc options "7 DRC Options"
+@ftable @code
+@item --min-drill <num>
+Minimum diameter of holes. Default value is @code{15mil}.
+@end ftable
+%end-doc
+*/
CSET (minDrill, MIL_TO_COORD(15), "min-drill", "DRC minimum drill diameter"),
+
+/* %start-doc options "7 DRC Options"
+@ftable @code
+@item --min-ring <num>
+Minimum width of annular ring. Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
CSET (minRing, MIL_TO_COORD(10), "min-ring", "DRC minimum annular ring"),
+
/* %start-doc options "5 Sizes"
@ftable @code
@item --grid <num>
commit 45074652a9619be78de0834402884969f9797ddc
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for general gui commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/main.c b/src/main.c
index 6b5b577..e99ea2c 100644
--- a/src/main.c
+++ b/src/main.c
@@ -1224,16 +1224,93 @@ names, layer numbers and layer groups.
SSET (GnetlistProgram, NULL, "gnetlist",
"Sets the name and optionally full path to the gnetlist(3) program"),
- CSET (PinoutOffsetX, MIL_TO_COORD(1), "pinout-offset-x", 0),
- CSET (PinoutOffsetY, MIL_TO_COORD(1), "pinout-offset-y", 0),
- CSET (PinoutTextOffsetX, MIL_TO_COORD(8), "pinout-text-offset-x", 0),
- CSET (PinoutTextOffsetY, MIL_TO_COORD(-1), "pinout-text-offset-y", 0),
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --pinout-offset-x <num>
+Horizontal offset of the pin number display. Defaults to @code{100mil}.
+@end ftable
+%end-doc
+*/
+ CSET (PinoutOffsetX, MIL_TO_COORD(1), "pinout-offset-x",
+ "Horizontal offset of the pin number display in mil"),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --pinout-offset-y <num>
+Vertical offset of the pin number display. Defaults to @code{100mil}.
+@end ftable
+%end-doc
+*/
+ CSET (PinoutOffsetY, MIL_TO_COORD(1), "pinout-offset-y",
+ "Vertical offset of the pin number display in mil"),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --pinout-text-offset-x <num>
+Horizontal offset of the pin name display. Defaults to @code{800mil}.
+@end ftable
+%end-doc
+*/
+ CSET (PinoutTextOffsetX, MIL_TO_COORD(8), "pinout-text-offset-x",
+ "Horizontal offset of the pin name display in mil"),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --pinout-text-offset-y <num>
+Vertical offset of the pin name display. Defaults to @code{-100mil}.
+@end ftable
+%end-doc
+*/
+ CSET (PinoutTextOffsetY, MIL_TO_COORD(-1), "pinout-text-offset-y",
+ "Vertical offset of the pin name display in mil"),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --draw-grid
+If set, draw the grid at start-up.
+@end ftable
+%end-doc
+*/
+ BSET (DrawGrid, 0, "draw-grid", "If set, draw the grid at start-up"),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --clear-line
+If set, new lines clear polygons.
+@end ftable
+%end-doc
+*/
+ BSET (ClearLine, 1, "clear-line", "If set, new lines clear polygons"),
- BSET (DrawGrid, 0, "draw-grid", "default to drawing the grid at startup"),
- BSET (ClearLine, 1, "clear-line", 0),
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --full-poly
+If set, new polygons are full ones.
+@end ftable
+%end-doc
+*/
BSET (FullPoly, 0, "full-poly", 0),
- BSET (UniqueNames, 1, "unique-names", 0),
- BSET (SnapPin, 1, "snap-pin", 0),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --unique-names
+If set, you will not be permitted to change the name of an component to match that
+of another component.
+@end ftable
+%end-doc
+*/
+ BSET (UniqueNames, 1, "unique-names", "Prevents identical component names"),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --snap-pin
+If set, pin centers and pad end points are treated as additional grid points
+that the cursor can snap to.
+@end ftable
+%end-doc
+*/
+ BSET (SnapPin, 1, "snap-pin",
+ "If set, the cursor snaps to pads and pin centers"),
/* %start-doc options "1 General Options"
@ftable @code
@@ -1255,9 +1332,25 @@ If set, all data which would otherwise be lost are saved in a temporary file
BSET (SaveInTMP, 0, "save-in-tmp",
"When set, all data which would otherwise be lost are saved in /tmp"),
- BSET (AllDirectionLines, 0, "all-direction-lines", 0),
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --all-direction-lines
+Allow all directions, when drawing new lines.
+@end ftable
+%end-doc
+*/
+ BSET (AllDirectionLines, 0, "all-direction-lines",
+ "Allow all directions, when drawing new lines"),
+
+/* %start-doc options "2 General GUI Options"
+@ftable @code
+@item --show-number
+Pinout shows number.
+@end ftable
+%end-doc
+*/
+ BSET (ShowNumber, 0, "show-number", "Pinout shows number"),
- BSET (ShowNumber, 0, "show-number", 0),
/* %start-doc options "1 General Options"
@ftable @code
@item --reset-after-element
commit e6581d531dcd196767bbf867918e0ae22a93effb
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for path commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/main.c b/src/main.c
index 692a805..6b5b577 100644
--- a/src/main.c
+++ b/src/main.c
@@ -1073,6 +1073,13 @@ Defaults to @code{"ListLibraryContents.sh %p %f"}
SSET (LibraryContentsCommand, "ListLibraryContents.sh '%p' '%f'",
"lib-contents-command", "Command to query the contents of the library"),
+/* %start-doc options "5 Paths"
+@ftable @code
+@item --lib-newlib <string>
+Top level directory for the newlib style library.
+@end ftable
+%end-doc
+*/
SSET (LibraryTree, PCBTREEPATH, "lib-newlib",
"Top level directory for the newlib style library"),
@@ -1085,9 +1092,25 @@ Command to save to a file.
*/
SSET (SaveCommand, "", "save-command", "Command to save to a file"),
- SSET (LibraryFilename, LIBRARYFILENAME, "lib-name", 0),
+/* %start-doc options "5 Paths"
+@ftable @code
+@item --lib-name <string>
+The default filename for the library.
+@end ftable
+%end-doc
+*/
+ SSET (LibraryFilename, LIBRARYFILENAME, "lib-name",
+ "The default filename for the library"),
+
+/* %start-doc options "5 Paths"
+@ftable @code
+@item --default-font <string>
+The name of the default font.
+@end ftable
+%end-doc
+*/
SSET (FontFile, "default_font", "default-font",
- "File name of default font."),
+ "File name of default font"),
/* %start-doc options "1 General Options"
@ftable @code
@@ -1102,6 +1125,15 @@ A string that defines the route styles. Defaults to @*
":Fat,4000,6000,3500,1000:Skinny,600,2402,1181,600", "route-styles",
"A string that defines the route styles"),
+/* %start-doc options "5 Paths"
+@ftable @code
+@item --file-path <string>
+A colon separated list of directories or commands (starts with '|'). The path
+is passed to the program specified in @option{--file-command} together with the selected
+filename.
+@end ftable
+%end-doc
+*/
SSET (FilePath, "", "file-path", 0),
/* %start-doc options "6 Commands"
@@ -1113,7 +1145,16 @@ Command for reading a netlist. Sequence @code{%f} is replaced by the netlist fil
*/
SSET (RatCommand, "", "rat-command", "Command for reading a netlist"),
- SSET (FontPath, PCBLIBPATH, "font-path", 0),
+/* %start-doc options "5 Paths"
+@ftable @code
+@item --font-path <string>
+A colon separated list of directories to search the default font. Defaults to
+the default library path.
+@end ftable
+%end-doc
+*/
+ SSET (FontPath, PCBLIBPATH, "font-path",
+ "Colon separated list of directories to search the default font"),
/* %start-doc options "1 General Options"
@ftable @code
@@ -1126,7 +1167,16 @@ The path is passed to the program specified in @option{--element-command}.
SSET(ElementPath, PCBLIBPATH, "element-path",
"A colon separated list of directories or commands (starts with '|')"),
- SSET (LibraryPath, PCBLIBPATH, "lib-path", 0),
+/* %start-doc options "5 Paths"
+@ftable @code
+@item --lib-path <string>
+A colon separated list of directories that will be passed to the commands specified
+by @option{--element-command} and @option{--element-contents-command}.
+@end ftable
+%end-doc
+*/
+ SSET (LibraryPath, PCBLIBPATH, "lib-path",
+ "A colon separated list of directories"),
/* %start-doc options "1 General Options"
@ftable @code
commit ceea0e16b5495b7f41337bea8cfc82db315746cd
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for commandline commands
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/main.c b/src/main.c
index 9e6b3ad..692a805 100644
--- a/src/main.c
+++ b/src/main.c
@@ -992,21 +992,99 @@ Layer group string. Defaults to @code{"1,c:2:3:4:5:6,s:7:8"}.
*/
SSET (Groups, "1,c:2:3:4:5:6,s:7:8", "groups", "Layer group string"),
- SSET (FontCommand, "",
- "font-command", 0),
- SSET (FileCommand, "", "file-command", "Command to read a file."),
+
+/* %start-doc options "6 Commands"
+pcb uses external commands for input output operations. These commands can be
+configured at start-up to meet local requirements. The command string may include
+special sequences @code{%f}, @code{%p} or @code{%a}. These are replaced when the
+command is called. The sequence @code{%f} is replaced by the file name,
+@code{%p} gets the path and @code{%a} indicates a package name.
+%end-doc
+*/
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --font-command <string>
+Command to load a font.
+@end ftable
+%end-doc
+*/
+ SSET (FontCommand, "", "font-command", "Command to load a font"),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --file-command <string>
+Command to read a file.
+@end ftable
+%end-doc
+*/
+ SSET (FileCommand, "", "file-command", "Command to read a file"),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --element-command <string>
+Command to read a footprint. @*
+Defaults to @code{"M4PATH='%p';export M4PATH;echo 'include(%f)' | m4"}
+@end ftable
+%end-doc
+*/
SSET (ElementCommand,
"M4PATH='%p';export M4PATH;echo 'include(%f)' | " GNUM4,
- "element-command", 0),
- SSET (PrintFile, "%f.output", "print-file", 0),
- SSET (LibraryCommandDir, PCBLIBDIR, "lib-command-dir", 0),
+ "element-command", "Command to read a footprint"),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --print-file <string>
+Command to print to a file.
+@end ftable
+%end-doc
+*/
+ SSET (PrintFile, "%f.output", "print-file", "Command to print to a file"),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --lib-command-dir <string>
+Path to the command that queries the library.
+@end ftable
+%end-doc
+*/
+ SSET (LibraryCommandDir, PCBLIBDIR, "lib-command-dir",
+ "Path to the command that queries the library"),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --lib-command <string>
+Command to query the library. @*
+Defaults to @code{"QueryLibrary.sh '%p' '%f' %a"}
+@end ftable
+%end-doc
+*/
SSET (LibraryCommand, "QueryLibrary.sh '%p' '%f' %a",
- "lib-command", 0),
+ "lib-command", "Command to query the library"),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --lib-contents-command <string>
+Command to query the contents of the library. @*
+Defaults to @code{"ListLibraryContents.sh %p %f"}
+@end ftable
+%end-doc
+*/
SSET (LibraryContentsCommand, "ListLibraryContents.sh '%p' '%f'",
- "lib-contents-command", 0),
+ "lib-contents-command", "Command to query the contents of the library"),
+
SSET (LibraryTree, PCBTREEPATH, "lib-newlib",
"Top level directory for the newlib style library"),
- SSET (SaveCommand, "", "save-command", 0),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --save-command <string>
+Command to save to a file.
+@end ftable
+%end-doc
+*/
+ SSET (SaveCommand, "", "save-command", "Command to save to a file"),
+
SSET (LibraryFilename, LIBRARYFILENAME, "lib-name", 0),
SSET (FontFile, "default_font", "default-font",
"File name of default font."),
@@ -1025,7 +1103,16 @@ A string that defines the route styles. Defaults to @*
"A string that defines the route styles"),
SSET (FilePath, "", "file-path", 0),
- SSET (RatCommand, "", "rat-command", 0),
+
+/* %start-doc options "6 Commands"
+@ftable @code
+@item --rat-command <string>
+Command for reading a netlist. Sequence @code{%f} is replaced by the netlist filename.
+@end ftable
+%end-doc
+*/
+ SSET (RatCommand, "", "rat-command", "Command for reading a netlist"),
+
SSET (FontPath, PCBLIBPATH, "font-path", 0),
/* %start-doc options "1 General Options"
commit bd1083bc23ede3f14148eba2a5da75ceece85c00
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for layer names commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/main.c b/src/main.c
index 376dd1d..9e6b3ad 100644
--- a/src/main.c
+++ b/src/main.c
@@ -911,13 +911,76 @@ The default value is @code{60}.
ISET (BackupInterval, 60, "backup-interval",
"Time between automatic backups in seconds. Set to 0 to disable"),
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-1 <string>
+Name of the 1st Layer. Default is @code{"top"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (1, "top"),
+
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-2 <string>
+Name of the 2nd Layer. Default is @code{"ground"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (2, "ground"),
+
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-3 <string>
+Name of the 3nd Layer. Default is @code{"signal2"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (3, "signal2"),
+
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-4 <string>
+Name of the 4rd Layer. Default is @code{"signal3"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (4, "signal3"),
+
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-5 <string>
+Name of the 5rd Layer. Default is @code{"power"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (5, "power"),
+
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-6 <string>
+Name of the 6rd Layer. Default is @code{"bottom"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (6, "bottom"),
+
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-7 <string>
+Name of the 7rd Layer. Default is @code{"outline"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (7, "outline"),
+
+/* %start-doc options "4 Layer Names"
+@ftable @code
+@item --layer-name-8 <string>
+Name of the 8rd Layer. Default is @code{"spare"}.
+@end ftable
+%end-doc
+*/
LAYERNAME (8, "spare"),
/* %start-doc options "1 General Options"
commit 99782e903aaf8c7c3e8d0cfbbfbafb19db66ac6c
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for size commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/main.c b/src/main.c
index ee1abbc..376dd1d 100644
--- a/src/main.c
+++ b/src/main.c
@@ -757,16 +757,123 @@ Color of the mask layer. Default value is @code{"#ff0000"}
*/
COLOR (MaskColor, "#ff0000", "mask-color", "color for solder mask"),
- CSET (ViaThickness, MIL_TO_COORD(60), "via-thickness", 0),
- CSET (ViaDrillingHole, MIL_TO_COORD(28), "via-drilling-hole", 0),
+
+/* %start-doc options "5 Sizes"
+All parameters should be given with an unit. If no unit is given, 1/100 mil
+(cmil) will be used. Write units without space to the
+number like @code{3mm}, not @code{3 mm}.
+Valid Units are:
+ @table @samp
+ @item km
+ Kilometer
+ @item m
+ Meter
+ @item cm
+ Centimeter
+ @item mm
+ Millimeter
+ @item um
+ Micrometer
+ @item nm
+ Nanometer
+ @item in
+ Inch (1in = 0.0254m)
+ @item mil
+ Mil (1000mil = 1in)
+ @item cmil
+ Centimil (1/100 mil)
+@end table
+
+@ftable @code
+@item --via-thickness <num>
+Default diameter of vias. Default value is @code{60mil}.
+@end ftable
+%end-doc
+*/
+ CSET (ViaThickness, MIL_TO_COORD(60), "via-thickness",
+ "default diameter of vias in 1/100 mil"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --via-drilling-hole <num>
+Default diameter of holes. Default value is @code{28mil}.
+@end ftable
+%end-doc
+*/
+ CSET (ViaDrillingHole, MIL_TO_COORD(28), "via-drilling-hole",
+ "default diameter of holes"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --line-thickness <num>
+Default thickness of new lines. Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
CSET (LineThickness, MIL_TO_COORD(10), "line-thickness",
- "Initial thickness of new lines."),
- CSET (RatThickness, MIL_TO_COORD(10), "rat-thickness", 0),
- CSET (Keepaway, MIL_TO_COORD(10), "keepaway", 0),
- CSET (MaxWidth, MIL_TO_COORD(6000), "default-PCB-width", 0),
- CSET (MaxHeight, MIL_TO_COORD(5000), "default-PCB-height", 0),
- ISET (TextScale, 100, "text-scale", 0),
- CSET (AlignmentDistance, MIL_TO_COORD(2), "alignment-distance", 0),
+ "initial thickness of new lines"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --rat-thickness <num>
+Thickness of rats. Values from 1 to 19 are fixed width in screen pixels.
+Anything larger means PCB units (i.e. 100 means "1 mil"). Default value
+is @code{10mil}.
+@end ftable
+%end-doc
+*/
+ CSET (RatThickness, MIL_TO_COORD(10), "rat-thickness", "thickness of rat lines"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --keepaway <num>
+Default minimum distance between a track and adjacent copper.
+Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
+ CSET (Keepaway, MIL_TO_COORD(10), "keepaway", "minimum distance between adjacent copper"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --default-PCB-width <num>
+Default width of the canvas. Default value is @code{6000mil}.
+@end ftable
+%end-doc
+*/
+ CSET (MaxWidth, MIL_TO_COORD(6000), "default-PCB-width",
+ "default width of the canvas"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --default-PCB-height <num>
+Default height of the canvas. Default value is @code{5000mil}.
+@end ftable
+%end-doc
+*/
+ CSET (MaxHeight, MIL_TO_COORD(5000), "default-PCB-height",
+ "default height of the canvas"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --text-scale <num>
+Default text scale. This value is in percent. Default value is @code{100}.
+@end ftable
+%end-doc
+*/
+ ISET (TextScale, 100, "text-scale", "default text scale in percent"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --alignment-distance <num>
+Specifies the distance between the board outline and alignment targets.
+Default value is @code{2mil}.
+@end ftable
+%end-doc
+*/
+ CSET (AlignmentDistance, MIL_TO_COORD(2), "alignment-distance",
+ "distance between the boards outline and alignment targets"),
+
CSET (Bloat, MIL_TO_COORD(10), "bloat", 0),
CSET (Shrink, MIL_TO_COORD(10), "shrink", 0),
CSET (minWid, MIL_TO_COORD(10), "min-width", "DRC minimum copper spacing"),
@@ -774,9 +881,25 @@ Color of the mask layer. Default value is @code{"#ff0000"}
CSET (minDrill, MIL_TO_COORD(15), "min-drill", "DRC minimum drill diameter"),
CSET (minRing, MIL_TO_COORD(10), "min-ring", "DRC minimum annular ring"),
- CSET (Grid, MIL_TO_COORD(10), "grid", 0),
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --grid <num>
+Initial grid size. Default value is @code{10mil}.
+@end ftable
+%end-doc
+*/
+ CSET (Grid, MIL_TO_COORD(10), "grid", "Initial grid size in 1/100 mil"),
+
+/* %start-doc options "5 Sizes"
+@ftable @code
+@item --minimum polygon area <num>
+Minimum polygon area.
+@end ftable
+%end-doc
+*/
RSET (IsleArea, MIL_TO_COORD(100) * MIL_TO_COORD(100), "minimum polygon area", 0),
+
/* %start-doc options "1 General Options"
@ftable @code
@item --backup-interval
commit 883b043e44169c32c58318b8ba5ac6895a040c39
Author: Felix Ruoff <Fe...@po...>
Commit: Felix Ruoff <Fe...@po...>
Add docu for color commandline options
Most parts of this patch-serie was written by Kai-Martin Knaak.
Adaption to actual git HEAD and some modifications by Felix Ruoff.
diff --git a/src/main.c b/src/main.c
index fe957c4..ee1abbc 100644
--- a/src/main.c
+++ b/src/main.c
@@ -510,36 +510,195 @@ Set default grid units. Can be mm or mil. Defaults to mil.
{"grid-units", "Default grid units (mm|mil)", HID_String, 0, 0, {0, "mil", 0},
0, &grid_units},
- COLOR (BlackColor, "#000000", "black-color", "color for black"),
- COLOR (WhiteColor, "#ffffff", "white-color", "color for white"),
+/* %start-doc options "3 Colors"
+@ftable @code
+@item --black-color <string>
+Color value for black. Default: @samp{#000000}
+@end ftable
+%end-doc
+*/
+ COLOR (BlackColor, "#000000", "black-color", "color value of 'black'"),
+
+/* %start-doc options "3 Colors"
+@ftable @code
+@item --black-color <string>
+Color value for white. Default: @samp{#ffffff}
+@end ftable
+%end-doc
+*/
+ COLOR (WhiteColor, "#ffffff", "white-color", "color value of 'white'"),
+
+/* %start-doc options "3 Colors"
+@ftable @code
+@item --background-color <string>
+Background color of the canvas. Default: @samp{#e5e5e5}
+@end ftable
+%end-doc
+*/
COLOR (BackgroundColor, "#e5e5e5", "background-color",
"color for background"),
+
+/* %start-doc options "3 Colors"
+@ftable @code
+@item --crosshair-color <string>
+Color of the crosshair. Default: @samp{#ff0000}
+@end ftable
+%end-doc
+*/
COLOR (CrosshairColor, "#ff0000", "crosshair-color",
"color for the crosshair"),
- COLOR (CrossColor, "#cdcd00", "cross-color", "color for cross"),
- COLOR (ViaColor, "#7f7f7f", "via-color", "color for vias"),
+
+/* %start-doc options "3 Colors"
+@ftable @code
+@item --cross-color <string>
+Color of the cross. De...
[truncated message content] |
