diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ueda/man/ueda-mkbom.1	Mon Jul 20 00:24:37 2015 +0000
@@ -0,0 +1,73 @@
+.TH MKBOM 1 "" "International Free Computing Task Force" \
+"uEDA Suite Documentation"
+.SH NAME
+ueda-mkbom \- generate a procurement-oriented BOM
+.SH SYNOPSIS
+.B ueda-mkbom
+[
+.B \-c
+] [
+.B \-p
+.I popopt
+] [
+.B \-r
+]
+.SH DESCRIPTION
+.PP
+This program generates the procurement-oriented BOM as explained in the
+document
+.IR "Bill of Materials (BOM) handling in uEDA" .
+.PP
+The
+.B \-c
+option instructs
+.I ueda-mkbom
+to check the design for the completeness of the parts information.
+The procurement-oriented BOM contains only those components that have been
+reduced to parts.
+If a component has not been reduced to a part yet,
+.I ueda-mkbom
+ignores it; the
+.B \-c
+option causes a warning message to be emitted when this happens.
+.PP
+The
+.B \-p
+option specifies the population option for which the BOM should be produced.
+.I Popopt
+is either a comma-separated list of population group numbers to be included
+or the keyword
+.BR all .
+The latter requests that all components be included, even those which have a
+.B
+population_option=NO
+attribute specified.
+The default is equivalent to
+.BR \-p0 .
+.PP
+The
+.B \-r
+option causes a list of reference designators to be emitted for each part in
+the BOM indicating which components use that part.
+.SH FILES
+MCL	Master Component List
+.SH SEE ALSO
+ueda-shortbom(1)
+.br
+.I
+Bill of Materials (BOM) handling in uEDA
+.SH DIAGNOSTICS
+\fIXX\fP has no part defined
+.in +8
+These diagnostics are produced with the
+.B \-c
+option and should be self-explanatory.
+.in -8
+part \fIXX\fP: no identifying information for the BOM
+.in +8
+See the
+.I
+uEDA Master Component List (MCL) description
+for explanation of the attributes required by
+.IR ueda-mkbom .
+.in -8