Downloaded and integrated latest wiki documentation from the geda website.
[geda-gaf/peter-b.git] / docs / wiki / geda_gerbv_mp.html
blob7de8951f364be884b6c9391fbc6215a9a49bfa0d
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
4 lang="en" dir="ltr">
5 <head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <title>geda:gerbv_mp</title>
8 <meta name="generator" content="DokuWiki Release rc2007-05-24" />
9 <meta name="robots" content="index,follow" />
10 <meta name="date" content="2007-05-24T22:27:24-0400" />
11 <meta name="keywords" content="geda,gerbv_mp" />
12 <link rel="search" type="application/opensearchdescription+xml" href="http://geda.seul.org/wiki/lib/exe/opensearch.php" title="geda Wiki" />
13 <link rel="start" href="http://geda.seul.org/wiki/" />
14 <link rel="contents" href="http://geda.seul.org/wiki/geda:gerbv_mp?do=index" title="Index" />
15 <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="http://geda.seul.org/wiki/feed.php" />
16 <link rel="alternate" type="application/rss+xml" title="Current Namespace" href="http://geda.seul.org/wiki/feed.php?mode=list&ns=geda" />
17 <link rel="alternate" type="text/html" title="Plain HTML" href="http://geda.seul.org/wiki/_export/xhtml/geda:gerbv_mp" />
18 <link rel="alternate" type="text/plain" title="Wiki Markup" href="http://geda.seul.org/wiki/_export/raw/geda:gerbv_mp" />
19 <link rel="stylesheet" media="all" type="text/css" href="lib/exe/css" />
20 <link rel="stylesheet" media="screen" type="text/css" href="lib/exe/001css" />
21 <link rel="stylesheet" media="print" type="text/css" href="lib/exe/002css" />
22 </head>
23 <body>
24 <div class="dokuwiki export">
28 <h1><a name="gerbv_man-page" id="gerbv_man-page">gerbv man-page</a></h1>
29 <div class="level1">
30 <pre class="code">gerbv(1) cvs-20051023 gerbv(1)
34 NAME
35 gerbv - Gerber Viewer
37 SYNOPSIS
38 gerbv [OPTIONS] [gerberfile[s]]
40 DESCRIPTION
41 gerbv is a viewer for Gerber files. Gerber files is generated from dif-
42 ferent PCB CAD programs and are sent to subcontractors to actually make
43 the PCB. gerbv also supports Excellon/NC drill files.
46 OPTIONS
47 Warning! On some platforms, which hasn’t long option available, only
48 short options are available.
51 gerbv Options
52 -V|--version Prints the version number of gerbv and exits.
54 -h|--help
55 Prints a brief usage guide.
57 -l &lt;filename&gt;|--log=&lt;filename&gt;
58 All error messages etc are stored in a file with filename &lt;file-
59 name&gt;.
61 -t &lt;filename&gt;|--tools=&lt;filename&gt;
62 Read Excellon tools from the file &lt;filename&gt;.
64 --geometry=&lt;width&gt;x&lt;height&gt;[&lt;+-&gt;x-position[&lt;+-&gt;y-position]]
65 Sets the the size of the window. X-position and y-position are
66 currently ignored by gerbv.
68 -p &lt;project filename&gt;|--project=&lt;project filename&gt;
69 Load a stored project. Please note that the project file must be
70 stored in the same directory as the gerber files.
73 GTK Options
74 --gtk-module=MODULE Load an additional GTK module
76 --g-fatal-warnings
77 Make all warnings fatal
79 --gtk-debug=FLAGS
80 GTK debugging flags to set
82 --gtk-no-debug=FLAGS
83 GTK debugging flags to unset
85 --gdk-debug=FLAGS
86 GDK debugging flags to set
88 --gdk-no-debug=FLAGS
89 GDK debugging flags to unset
91 --display=DISPLAY
92 X display to use
94 --sync Make X call synchronous
96 --no-xshm
97 Don’t use X shared memory extension
99 --name=NAME
100 Program name as used by the window manager
102 --class=CLASS
103 Program class as used by the window manager
106 GENERAL
107 When you start gerbv you can give the files to be loaded on the command
108 line, either as each file separated with a space or by using wildcards.
110 The user interface is graphical. Simply press left mouse button and the
111 image will pan as you move the mouse. To manipulate a layer, right-
112 click on one of the rightmost buttons. That will bring up a pop-up menu
113 where you can select what you want to do with that layer (load file,
114 change color, etc).
116 If you hold the mouse button over one the rightmost button a tooltips
117 will show you the name of the file loaded on that layer.
119 Default of concurrently loaded files are 20 layers. You can change this
120 during configure with:
122 ./configure with-maxfiles=&lt;number&gt;
125 ACTIVATION AND DEACTIVATION OF LAYERS
126 You can load several files at one time. You can then turn displaying of
127 the layers on and off by clicking on one of the rightmost buttons.
129 You can also control this from the keyboard. Press Alt, enter the num-
130 ber on the layer you want activate/deactivate on the numerical keypad
131 and then release the Alt key.
134 ZOOMING
135 Zooming can be handled by either menu choices, keypressing, middle
136 mouse button or scroll wheel. If you press Alt+I you will zoom in and
137 if you press Alt+O you will zoom out.If you press middle mouse button
138 you will zoom out, and if you press Shift and middle mouse button you
139 will zoom in. Scroll wheel works if you enabled that in your X server
140 and mapped it to button 4 and 5. You can also zoom in by pressing z and
141 zoom out by pressing shift+z (ie Z). You can make the image fit by
142 pressing f (there is also a menu alternativ for this).
144 You can also do zooming by outline. Press right mouse button, draw,
145 release. The dashed line shows how the zooming will be dependent on
146 the resolution of the window. The non-dashed outline will show what you
147 actually selected. If you change your mind when started to mark out-
148 line, you can always abort by pressing escape. By holding down the
149 shift key when you press the right mouse button, you will select an
150 area where the point you started at will be the center of your selec-
151 tion.
154 MEASUREMENTS
155 You can do measurement on the image displayed. By pressing shift, the
156 cursor changes to a plus. By using left mouse button you can draw the
157 lines that you want to measure. The result of the last measurement is
158 also displayed on the statusbar. All measurements are in the drawing
159 until you either zoom, pan or press the escape key.
161 The statusbar shows the current mouse position on the layer in the same
162 coordinates as in the file. Ie if you have (0,0) in the middle of the
163 image in the gerber files, the statusbar will show (0,0) at the same
164 place.
167 SUPERIMPOSING
168 When you load several Gerber files, you can display them &quot;on top of
169 each other&quot;, ie superimposing. The general way to display them are that
170 upper layers cover the layers beneath, which is called copy (GTK+
171 terms).
173 The other ways selectable are and, or, xor and invert. They map
174 directly to corresponding functions in GTK. In GTK they are described
175 as: &quot;For colored images, only GDK_COPY, GDK_XOR and GDK_INVERT are gen-
176 erally useful. For bitmaps, GDK_AND and GDK_OR are also useful.&quot;
179 PROJECTS
180 gerbv can also handle projects. A project consist of bunch of loaded
181 layers with their resp. color and the background color. The easiest way
182 to create a project is to load all files you want into the layer you
183 want, set all the colors etc and do a &quot;Save Project As...&quot;.
185 You load a project either from the menu bar or by using the commandline
186 switches -p or --project.
188 Currently there is a limit in that the project file must be in the same
189 directory as the gerber files to be loaded.
192 SCHEME
193 The project files are simple Scheme programs that is interpreted by a
194 built in Scheme interpreter. The Scheme interpreter is TinyScheme and
195 needs a Scheme program called init.scm to initialize itself. The search
196 path for init.scm is (in the following order)
197 /usr/local/gEDA-20060124/share/gerbv/scheme/share/gerbv/scheme/, the
198 directory with the executable gerbv, the directory gerbv was invoked
199 from and finally according to the environment variable
200 GERBV_SCHEMEINIT.
203 TOOLS FILE
204 Not every Excellon drill file is self-sufficient. Some CADs produce
205 .drd files where tools are only referenced, but never defined (such as
206 what diameter of the tool is.) Eagle CAD is one of such CADs, and there
207 are more since many board houses require Tools files.
209 A Tools file is a plain text file which you create in an editor. Each
210 line of the file describes one tool (the name and the diameter, in
211 inches):
213 T01 0.024
214 T02 0.040
217 These are the same tools (T01 etc.) that are used in the Drill file. A
218 standard practice with Eagle is to create an empty Tools file, run the
219 CAM processor, and the error report tells you which tools you &quot;forgot&quot;.
220 Then you put these tools into the file and rerun the CAM processor.
222 You load a tool file by using the commandline switches -t or --tools.
223 The file can have any name you wish, but Eagle expects the file type to
224 be &quot;.drl&quot;, so it makes sense to keep it this way. Some board houses are
225 still using CAM software from DOS era, so you may want to excercise
226 caution before going beyond the 8.3 naming convention.
228 When gerbv reads the Tools file it also checks that there are no dupli-
229 cate definitions of tools. This does happen from time to time as you
230 edit the file by hand, especially if you, during design, add or remove
231 parts from the board and then have to add new tools into the Tools
232 file. The duplicate tools are a very serious error which will stop
233 (HOLD) your board until you fix the Tools file and maybe the Excellon
234 file. gerbv will detect duplicate tools if they are present, and will
235 exit immediately to indicate such a fatal error in a very obvious way.
236 A message will also be printed to standard error.
238 If your Excellon file does not contain tool definitions then gerbv will
239 preconfigure the tools by deriving the diameter of the drill bit from
240 the tool number. This is probably not what you want, and you will see
241 warnings printed on the console.
244 ENVIRONMENT
245 GERBV_SCHEMEINIT
246 Defines where the init.scm file is stored. Used by scheme inter-
247 preter, which is used by the project reader.
250 AUTHOR
251 Stefan Petersen (spetm at users.sourceforge.net): Overall hacker and project leader
252 Andreas Andersson (e92_aan at e.kth.se): Drill file support and general hacking
253 Anders Eriksson (aenfaldor at users.sourceforge.net) : X and GTK+ ideas and hacking
256 COPYRIGHT
257 Copyright © 2001-2004 Stefan Petersen
259 This document can be freely redistributed according to the terms of the
260 GNU General Public License version 2.0
264 Version Feb 8th, 2004 gerbv(1)
265 </pre>
267 </div>
268 </div>
269 </body>
270 </html>