diff ueda/man/ueda-shortbom.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-shortbom.1	Mon Jul 20 00:24:37 2015 +0000
@@ -0,0 +1,69 @@
+.TH SHORTBOM 1 "" "International Free Computing Task Force" \
+"uEDA Suite Documentation"
+.SH NAME
+ueda-shortbom \- generate a short BOM from the MCL
+.SH SYNOPSIS
+.B ueda-shortbom
+[
+.B \-a
+] [
+.B \-p
+.I popopt
+] [
+.B \-s
+.I sep
+] [
+.B \-t
+]
+.SH DESCRIPTION
+.PP
+This program generates a short BOM as explained in the
+document
+.IR "Bill of Materials (BOM) handling in uEDA" .
+.PP
+The default output is intended for a display or printer with fixed
+character spacing; ASCII space characters are inserted between columns.
+The number of spaces inserted is determined by the width of the widest
+entry in each column plus the column separation.
+The latter defaults to 2 spaces but can be changed with the
+.B \-s
+option.
+.PP
+The
+.B \-t
+option selects an alternative output format in which the columns are
+separated by a single ASCII tab character.
+This format is ideal for feeding to
+.IR tbl (1)
+and ultimately to
+.IR troff (1).
+The column headings are also suppressed in this output format on the
+assumption that they can be made prettier in the post-processing.
+.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 \-a
+option requests the generation of an assembly BOM.
+The assembly BOM differs from the corresponding ``regular'' short BOM in that if
+a component is to be socketed, the part information emitted is for the socket
+rather than the component to be pushed into it.
+.SH FILES
+MCL	Master Component List
+.SH SEE ALSO
+ueda-mkbom(1)
+.br
+.I
+Bill of Materials (BOM) handling in uEDA