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