refdes_renum: warn of possible number clash with non-conforming values
[geda-gaf/whiteaudio.git] / docs / wiki / geda-gerbv_mp.html
blob3bfb4c619c7edac2fe8c0fcde7db76824daa6ba1
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 <title></title>
6 <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
7 <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
8 <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 </head>
12 <body>
15 <h1 class="sectionedit782"><a name="gerbv_man-page" id="gerbv_man-page">gerbv man-page</a></h1>
16 <div class="level1">
17 <pre class="code">gerbv(1) cvs-20051023 gerbv(1)
21 NAME
22 gerbv - Gerber Viewer
24 SYNOPSIS
25 gerbv [OPTIONS] [gerberfile[s]]
27 DESCRIPTION
28 gerbv is a viewer for Gerber files. Gerber files is generated from dif-
29 ferent PCB CAD programs and are sent to subcontractors to actually make
30 the PCB. gerbv also supports Excellon/NC drill files.
33 OPTIONS
34 Warning! On some platforms, which hasn’t long option available, only
35 short options are available.
38 gerbv Options
39 -V|--version Prints the version number of gerbv and exits.
41 -h|--help
42 Prints a brief usage guide.
44 -l &lt;filename&gt;|--log=&lt;filename&gt;
45 All error messages etc are stored in a file with filename &lt;file-
46 name&gt;.
48 -t &lt;filename&gt;|--tools=&lt;filename&gt;
49 Read Excellon tools from the file &lt;filename&gt;.
51 --geometry=&lt;width&gt;x&lt;height&gt;[&lt;+-&gt;x-position[&lt;+-&gt;y-position]]
52 Sets the the size of the window. X-position and y-position are
53 currently ignored by gerbv.
55 -p &lt;project filename&gt;|--project=&lt;project filename&gt;
56 Load a stored project. Please note that the project file must be
57 stored in the same directory as the gerber files.
60 GTK Options
61 --gtk-module=MODULE Load an additional GTK module
63 --g-fatal-warnings
64 Make all warnings fatal
66 --gtk-debug=FLAGS
67 GTK debugging flags to set
69 --gtk-no-debug=FLAGS
70 GTK debugging flags to unset
72 --gdk-debug=FLAGS
73 GDK debugging flags to set
75 --gdk-no-debug=FLAGS
76 GDK debugging flags to unset
78 --display=DISPLAY
79 X display to use
81 --sync Make X call synchronous
83 --no-xshm
84 Don’t use X shared memory extension
86 --name=NAME
87 Program name as used by the window manager
89 --class=CLASS
90 Program class as used by the window manager
93 GENERAL
94 When you start gerbv you can give the files to be loaded on the command
95 line, either as each file separated with a space or by using wildcards.
97 The user interface is graphical. Simply press left mouse button and the
98 image will pan as you move the mouse. To manipulate a layer, right-
99 click on one of the rightmost buttons. That will bring up a pop-up menu
100 where you can select what you want to do with that layer (load file,
101 change color, etc).
103 If you hold the mouse button over one the rightmost button a tooltips
104 will show you the name of the file loaded on that layer.
106 Default of concurrently loaded files are 20 layers. You can change this
107 during configure with:
109 ./configure with-maxfiles=&lt;number&gt;
112 ACTIVATION AND DEACTIVATION OF LAYERS
113 You can load several files at one time. You can then turn displaying of
114 the layers on and off by clicking on one of the rightmost buttons.
116 You can also control this from the keyboard. Press Alt, enter the num-
117 ber on the layer you want activate/deactivate on the numerical keypad
118 and then release the Alt key.
121 ZOOMING
122 Zooming can be handled by either menu choices, keypressing, middle
123 mouse button or scroll wheel. If you press Alt+I you will zoom in and
124 if you press Alt+O you will zoom out.If you press middle mouse button
125 you will zoom out, and if you press Shift and middle mouse button you
126 will zoom in. Scroll wheel works if you enabled that in your X server
127 and mapped it to button 4 and 5. You can also zoom in by pressing z and
128 zoom out by pressing shift+z (ie Z). You can make the image fit by
129 pressing f (there is also a menu alternativ for this).
131 You can also do zooming by outline. Press right mouse button, draw,
132 release. The dashed line shows how the zooming will be dependent on
133 the resolution of the window. The non-dashed outline will show what you
134 actually selected. If you change your mind when started to mark out-
135 line, you can always abort by pressing escape. By holding down the
136 shift key when you press the right mouse button, you will select an
137 area where the point you started at will be the center of your selec-
138 tion.
141 MEASUREMENTS
142 You can do measurement on the image displayed. By pressing shift, the
143 cursor changes to a plus. By using left mouse button you can draw the
144 lines that you want to measure. The result of the last measurement is
145 also displayed on the statusbar. All measurements are in the drawing
146 until you either zoom, pan or press the escape key.
148 The statusbar shows the current mouse position on the layer in the same
149 coordinates as in the file. Ie if you have (0,0) in the middle of the
150 image in the gerber files, the statusbar will show (0,0) at the same
151 place.
154 SUPERIMPOSING
155 When you load several Gerber files, you can display them &quot;on top of
156 each other&quot;, ie superimposing. The general way to display them are that
157 upper layers cover the layers beneath, which is called copy (GTK+
158 terms).
160 The other ways selectable are and, or, xor and invert. They map
161 directly to corresponding functions in GTK. In GTK they are described
162 as: &quot;For colored images, only GDK_COPY, GDK_XOR and GDK_INVERT are gen-
163 erally useful. For bitmaps, GDK_AND and GDK_OR are also useful.&quot;
166 PROJECTS
167 gerbv can also handle projects. A project consist of bunch of loaded
168 layers with their resp. color and the background color. The easiest way
169 to create a project is to load all files you want into the layer you
170 want, set all the colors etc and do a &quot;Save Project As...&quot;.
172 You load a project either from the menu bar or by using the commandline
173 switches -p or --project.
175 Currently there is a limit in that the project file must be in the same
176 directory as the gerber files to be loaded.
179 SCHEME
180 The project files are simple Scheme programs that is interpreted by a
181 built in Scheme interpreter. The Scheme interpreter is TinyScheme and
182 needs a Scheme program called init.scm to initialize itself. The search
183 path for init.scm is (in the following order)
184 /usr/local/gEDA-20060124/share/gerbv/scheme/share/gerbv/scheme/, the
185 directory with the executable gerbv, the directory gerbv was invoked
186 from and finally according to the environment variable
187 GERBV_SCHEMEINIT.
190 TOOLS FILE
191 Not every Excellon drill file is self-sufficient. Some CADs produce
192 .drd files where tools are only referenced, but never defined (such as
193 what diameter of the tool is.) Eagle CAD is one of such CADs, and there
194 are more since many board houses require Tools files.
196 A Tools file is a plain text file which you create in an editor. Each
197 line of the file describes one tool (the name and the diameter, in
198 inches):
200 T01 0.024
201 T02 0.040
204 These are the same tools (T01 etc.) that are used in the Drill file. A
205 standard practice with Eagle is to create an empty Tools file, run the
206 CAM processor, and the error report tells you which tools you &quot;forgot&quot;.
207 Then you put these tools into the file and rerun the CAM processor.
209 You load a tool file by using the commandline switches -t or --tools.
210 The file can have any name you wish, but Eagle expects the file type to
211 be &quot;.drl&quot;, so it makes sense to keep it this way. Some board houses are
212 still using CAM software from DOS era, so you may want to excercise
213 caution before going beyond the 8.3 naming convention.
215 When gerbv reads the Tools file it also checks that there are no dupli-
216 cate definitions of tools. This does happen from time to time as you
217 edit the file by hand, especially if you, during design, add or remove
218 parts from the board and then have to add new tools into the Tools
219 file. The duplicate tools are a very serious error which will stop
220 (HOLD) your board until you fix the Tools file and maybe the Excellon
221 file. gerbv will detect duplicate tools if they are present, and will
222 exit immediately to indicate such a fatal error in a very obvious way.
223 A message will also be printed to standard error.
225 If your Excellon file does not contain tool definitions then gerbv will
226 preconfigure the tools by deriving the diameter of the drill bit from
227 the tool number. This is probably not what you want, and you will see
228 warnings printed on the console.
231 ENVIRONMENT
232 GERBV_SCHEMEINIT
233 Defines where the init.scm file is stored. Used by scheme inter-
234 preter, which is used by the project reader.
237 AUTHOR
238 Stefan Petersen (spetm at users.sourceforge.net): Overall hacker and project leader
239 Andreas Andersson (e92_aan at e.kth.se): Drill file support and general hacking
240 Anders Eriksson (aenfaldor at users.sourceforge.net) : X and GTK+ ideas and hacking
243 COPYRIGHT
244 Copyright © 2001-2004 Stefan Petersen
246 This document can be freely redistributed according to the terms of the
247 GNU General Public License version 2.0
251 Version Feb 8th, 2004 gerbv(1)</pre>
253 </div>
254 </body>
255 </html>