~ubuntu-branches/ubuntu/precise/pcb/precise

« back to all changes in this revision

Viewing changes to doc/pcb.man.raw

  • Committer: Bazaar Package Importer
  • Author(s): Hamish Moffatt
  • Date: 2005-02-20 13:14:00 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050220131400-pfz66g5vhx0azl8f
Tags: 1.99j+20050127-2
* Improved package description: (closes: #295405)
* Fixed dependency: tk84 -> tk8.4 (closes: #295404)
* Updated README.debian (closes: #269578)
* Applied patch to src/djopt.c to allow compilation with gcc-4.0
  (closes: #294319), thanks to Andreas Jochens for the patch.
* Prevent example files from being compressed

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\"
2
 
.\"                            COPYRIGHT
3
 
.\"
4
 
.\"  PCB, interactive printed circuit board design
5
 
.\"  Copyright (C) 1994,1995,1996 Thomas Nau
6
 
.\"
7
 
.\"  This program is free software; you can redistribute it and/or modify
8
 
.\"  it under the terms of the GNU General Public License as published by
9
 
.\"  the Free Software Foundation; either version 2 of the License, or
10
 
.\"  (at your option) any later version.
11
 
.\"
12
 
.\"  This program is distributed in the hope that it will be useful,
13
 
.\"  but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 
.\"  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 
.\"  GNU General Public License for more details.
16
 
.\"
17
 
.\"  You should have received a copy of the GNU General Public License
18
 
.\"  along with this program; if not, write to the Free Software
19
 
.\"  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
 
.\"
21
 
.\"  Contact addresses for paper mail and Email:
22
 
.\"  Thomas Nau, Schlehenweg 15, 88471 Baustetten, Germany
23
 
.\"  Thomas.Nau@rz.uni-ulm.de
24
 
.\"
25
 
.\"  RCS: $Id: pcb.man.raw,v 145.1 1997/07/26 13:12:05 nau Exp $
26
 
.\"
27
 
.TH PCB 1 \" -*- nroff -*-
28
 
 
29
 
.SH NAME
30
 
Pcb \- X11 interactive printed circuit board layout system
31
 
 
32
 
.SH VERSION
33
 
 
34
 
.P
35
 
The current release is: RELEASE
36
 
 
37
 
.SH SYNOPSIS
38
 
.B pcb
39
 
[\-option ...] [\-toolkit_option ...] [description file]
40
 
 
41
 
or
42
 
 
43
 
.B pcb
44
 
\-specialoption
45
 
 
46
 
.SH DESCRIPTION
47
 
 
48
 
.P 
49
 
\fIPcb\fP is a handy tool for the \fIX Window System\fP build to design
50
 
printed circuit boards. All coordinate units are 1/1000 inch.
51
 
It implements the most needed features like:
52
 
 
53
 
.IP
54
 
* A layout consists of lines, arcs, polygons, elements (lines, pins and arcs),
55
 
vias and text information seperated into several layers. Each of them
56
 
is identified by a unique name and color (if supported by your display).
57
 
SMD circuits are also supported.
58
 
.IP
59
 
* MAX_LAYER layers are supported in addition to a silkscreen layer.
60
 
Visibility of pins and SMD pads and vias is controllable.
61
 
.IP
62
 
* All files are 7 bit ASCII and can be preprocessed with any UNIX command
63
 
that writes it's results to \fIstdout\fP (\fIGNU m4\fP is required).
64
 
.IP
65
 
* The layout grid is anywhere in the range from 1/1000 inch up to 250/1000
66
 
inch. The maximum is defined at compilation time.
67
 
.IP
68
 
* Zooming is supported.
69
 
.IP
70
 
* A copy of the current data is saved temporarily in /tmp to
71
 
ensure that nothing is lost during critical sections of the program.
72
 
.IP
73
 
* An unlimited (depending on memory) undo operations
74
 
is supported. Also redo is available in case you change your made.
75
 
 
76
 
.P
77
 
Pcb is intended to be a simple tool without memory and time consuming
78
 
features like autorouter and autoplacement. It worked well for several
79
 
people on an \fIAtari\fP platform till it was ported to \fIX11\fP
80
 
in 1994. Most of the settings can be specified by resources, passed
81
 
in the command-line or changed at runtime. Layout related settings are saved
82
 
together with the data.
83
 
 
84
 
.SH OPTIONS
85
 
 
86
 
.P
87
 
Beside the toolkit options, Pcb recognizes some command-line options
88
 
with following syntax:
89
 
\-option switches it on, +option switches it off
90
 
 
91
 
.TP
92
 
.BI \-alldirections,+alldirections
93
 
Enables or disables lines in any direction. Overrides the resource
94
 
\fIallDirectionLines\fP.
95
 
.TP
96
 
.BI \-backup " <value>"
97
 
Time in seconds between two backups. Overrides the resource
98
 
\fIbackupInterval\fP.
99
 
.TP
100
 
.BI \-c " <value>"
101
 
Number of characters per output-line. Overrides the resource
102
 
\fIcharactersPerLine\fP.
103
 
.TP
104
 
.BI \-fontfile " <filename>"
105
 
The default font is read from this file. The file is, together with a path,
106
 
passed to an external program. The path is defined by the resource
107
 
\fIfontPath\fP wheras the command uses \fIfontCommand\fP.
108
 
Overwrittes the resource \fIfontFile\fP.
109
 
.TP
110
 
.BI \-lelement " <\fIUNIX\fP command>"
111
 
Sets the command to be executed when an element is loaded.
112
 
The command may contain %f which is replaced by the filename and %p
113
 
which is replaced by the element search-path. The command must write it's
114
 
results to \fIstdout\fP. The resource \fIelementCommand\fP is overwritten.
115
 
.TP
116
 
.BI \-lfile " <\fIUNIX\fP command>"
117
 
Sets the command to be executed when an layout file is loaded.
118
 
The command may contain %f which is replaced by the filename and %p which is
119
 
replaced by the search-path. The command must write it's results to
120
 
\fIstdout\fP. The resource \fIfileCommand\fP is overwritten.
121
 
.TP
122
 
.BI \-lfont " <\fIUNIX\fP command>"
123
 
Sets the command to be executed when an fontfile is loaded.
124
 
The command may contain %f which is replaced by the filename and %p which
125
 
is replaced by the font search-path. The command must write it's results to
126
 
\fIstdout\fP. The resource \fIfontCommand\fP is overwritten.
127
 
.TP
128
 
.BI \-lg " <layergroups>"
129
 
This option overwrites the resource \fIlayerGroups\fP. See its description
130
 
for more information.
131
 
.TP
132
 
.BI \-libname " <filename>"
133
 
The default filename for the library. Overwrites the resource
134
 
\fIlibraryFilename\fP.
135
 
.TP
136
 
.BI \-libpath " <path>"
137
 
The default search path for the the library. Overwrites the resource
138
 
\fIlibraryPath\fP.
139
 
.TP
140
 
.BI \-llib " <\fIUNIX\fP command>"
141
 
Sets the command to be executed when an element is loaded from the library.
142
 
The command may contain %f and %p to pass the requested filename
143
 
and the searchpath to the command. %a is replaces by the three arguments
144
 
\fItemplate\fP, \fIvalue\fP and \fIpackage\fP. The command must write
145
 
the data to its standard output. The related resource is \fIlibraryCommand\fP.
146
 
.TP
147
 
.BI \-llibcont " <\fIUNIX\fP command>"
148
 
The command lists the contents of the library.
149
 
The command may contain %f and %p to pass the library filename
150
 
and the searchpath to the command.
151
 
The related resource is \fIlibraryContentsCommand\fP.
152
 
.TP
153
 
.BI \-loggeometry " <geometry>"
154
 
Determines the geometry of the logging window.
155
 
.TP
156
 
.BI \-pnl " <positiv integer value>"
157
 
Defines the maximum length of a pin name to be displayed in a pinout
158
 
window. Overwrittes the resource \fPpinoutNameLength\fI.
159
 
.TP
160
 
.BI \-pz " <positiv integer value>"
161
 
Sets the zoom factor for pinout window according to the
162
 
formula: scale = 1:(2^value). The resource \fPpinoutZoom\fI is
163
 
overwritten.
164
 
.TP
165
 
.BI \-reset/+reset
166
 
If enabled, all found connections are reset after an element has been scanned.
167
 
This setting is only used while scanning connections to all elements.
168
 
Overrides the resource \fIresetAfterElement\fP.
169
 
.TP
170
 
.BI \-ring/+ring
171
 
Overrides the resource \fIringBellWhenFinished\fP. If enabled, the bell
172
 
on the keyboard is rang when connection searching has finished.
173
 
.TP
174
 
.BI \-s/+s
175
 
Enables/Disables the saving of the previous commandline. Overrides the
176
 
\fIsaveLastCommand\fP resource.
177
 
.TP
178
 
.BI \-save/+save
179
 
Overrides the resource \fIsaveInTMP\fP. If enabled all data is saved
180
 
in a temporary file in the directory \fI/tmp\fP instead of being lost.
181
 
.TP
182
 
.BI \-sfile " <\fIUNIX\fP command>"
183
 
Sets the command to be executed when an layout file is saved.
184
 
The command may contain %f which is replaced by the filename. The command
185
 
must read it's data from \fIstdin\fP. The resource \fIsaveCommand\fP is
186
 
overwritten.
187
 
.TP
188
 
.BI \-size " <width>x<height>"
189
 
Overrides the resource \fIsize\fP which determines the maximum size
190
 
of a layout.
191
 
.TP .BI \-v " <\-100..100>"
192
 
Sets the volume of the X-speaker. Overrides the resource \fIvolume\fP.
193
 
 
194
 
 
195
 
.P
196
 
In addition to these 'normal-work-options' you will find additional
197
 
special options, \fI\-copyright\fP, \fI-help\fP and \fI\-version\fP,
198
 
which print out the GNU COPYLEFT notice, a usage message and the current
199
 
version.
200
 
 
201
 
 
202
 
.SH X11 Interface
203
 
 
204
 
.P
205
 
There are several resources, actions and menus available.
206
 
For a detailed description see the GNU info file or the printed manual.
207
 
 
208
 
 
209
 
.SH SEE ALSO
210
 
 
211
 
X(1), Xlib Resource Manager documentation, Xt resource documentation,
212
 
Athena Widget Set
213
 
 
214
 
PCB manual.
215
 
 
216
 
 
217
 
.SH COPYRIGHT
218
 
 
219
 
PCB, interactive printed circuit board design,
220
 
Copyright (C) 1994, 1995, 1996 Thomas Nau
221
 
 
222
 
This program is free software; you can redistribute it and/or modify
223
 
it under the terms of the GNU General Public License as published by
224
 
the Free Software Foundation; either version 2 of the License, or
225
 
(at your option) any later version.
226
 
 
227
 
This program is distributed in the hope that it will be useful,
228
 
but WITHOUT ANY WARRANTY; without even the implied warranty of
229
 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
230
 
GNU General Public License for more details.
231
 
 
232
 
 
233
 
.SH AUTHOR
234
 
 
235
 
Thomas Nau, Thomas.Nau@rz.uni-ulm.de
236
 
 
237
 
Schlehenweg 15, 88471 Baustetten, Germany
238
 
 
239
 
 
240
 
.SH ACKNOWLEDGEMENT
241
 
 
242
 
harry eaton (haceaton@aplcomm.jhuapl.edu) for many new features
243
 
and bug fixes.
244
 
 
245
 
Bernhard (Bernhard.Daeubler@physik.uni-ulm.de) and Harald Daeubler
246
 
(Harald.Daeubler@physik.uni-ulm.de) for helpful hints, testing and
247
 
a neverending stream of new options and ideas.
248
 
 
249
 
Roland Merk (merk@faw.uni-ulm.de) for his help during the hard days of
250
 
learning X11 programming.
251
 
 
252
 
Erland Unruh (Erland.Unruh@malmo.trab.se) for alpha and beta testing of
253
 
the early releases.
254
 
 
255
 
Many, many others who donated some of their time for developing new
256
 
circuit-files, did testing and came up with several bug-fixes and
257
 
improvements. Thanks to all of them.