comparison ueda/man/ueda-mkbom.1 @ 0:cd92449fdb51

initial import of ueda and ifctf-part-lib from ifctfvax CVS
author Space Falcon <falcon@ivan.Harhan.ORG>
date Mon, 20 Jul 2015 00:24:37 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:cd92449fdb51
1 .TH MKBOM 1 "" "International Free Computing Task Force" \
2 "uEDA Suite Documentation"
3 .SH NAME
4 ueda-mkbom \- generate a procurement-oriented BOM
5 .SH SYNOPSIS
6 .B ueda-mkbom
7 [
8 .B \-c
9 ] [
10 .B \-p
11 .I popopt
12 ] [
13 .B \-r
14 ]
15 .SH DESCRIPTION
16 .PP
17 This program generates the procurement-oriented BOM as explained in the
18 document
19 .IR "Bill of Materials (BOM) handling in uEDA" .
20 .PP
21 The
22 .B \-c
23 option instructs
24 .I ueda-mkbom
25 to check the design for the completeness of the parts information.
26 The procurement-oriented BOM contains only those components that have been
27 reduced to parts.
28 If a component has not been reduced to a part yet,
29 .I ueda-mkbom
30 ignores it; the
31 .B \-c
32 option causes a warning message to be emitted when this happens.
33 .PP
34 The
35 .B \-p
36 option specifies the population option for which the BOM should be produced.
37 .I Popopt
38 is either a comma-separated list of population group numbers to be included
39 or the keyword
40 .BR all .
41 The latter requests that all components be included, even those which have a
42 .B
43 population_option=NO
44 attribute specified.
45 The default is equivalent to
46 .BR \-p0 .
47 .PP
48 The
49 .B \-r
50 option causes a list of reference designators to be emitted for each part in
51 the BOM indicating which components use that part.
52 .SH FILES
53 MCL Master Component List
54 .SH SEE ALSO
55 ueda-shortbom(1)
56 .br
57 .I
58 Bill of Materials (BOM) handling in uEDA
59 .SH DIAGNOSTICS
60 \fIXX\fP has no part defined
61 .in +8
62 These diagnostics are produced with the
63 .B \-c
64 option and should be self-explanatory.
65 .in -8
66 part \fIXX\fP: no identifying information for the BOM
67 .in +8
68 See the
69 .I
70 uEDA Master Component List (MCL) description
71 for explanation of the attributes required by
72 .IR ueda-mkbom .
73 .in -8