FreeCalypso > hg > ueda-linux

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 SHORTBOM 1 "" "International Free Computing Task Force" \
2 "uEDA Suite Documentation"
3 .SH NAME
4 ueda-shortbom \- generate a short BOM from the MCL
5 .SH SYNOPSIS
6 .B ueda-shortbom
7 [
8 .B \-a
9 ] [
10 .B \-p
11 .I popopt
12 ] [
13 .B \-s
14 .I sep
15 ] [
16 .B \-t
17 ]
18 .SH DESCRIPTION
19 .PP
20 This program generates a short BOM as explained in the
21 document
22 .IR "Bill of Materials (BOM) handling in uEDA" .
23 .PP
24 The default output is intended for a display or printer with fixed
25 character spacing; ASCII space characters are inserted between columns.
26 The number of spaces inserted is determined by the width of the widest
27 entry in each column plus the column separation.
28 The latter defaults to 2 spaces but can be changed with the
29 .B \-s
30 option.
31 .PP
32 The
33 .B \-t
34 option selects an alternative output format in which the columns are
35 separated by a single ASCII tab character.
36 This format is ideal for feeding to
37 .IR tbl (1)
38 and ultimately to
39 .IR troff (1).
40 The column headings are also suppressed in this output format on the
41 assumption that they can be made prettier in the post-processing.
42 .PP
43 The
44 .B \-p
45 option specifies the population option for which the BOM should be produced.
46 .I Popopt
47 is either a comma-separated list of population group numbers to be included
48 or the keyword
49 .BR all .
50 The latter requests that all components be included, even those which have a
51 .B
52 population_option=NO
53 attribute specified.
54 The default is equivalent to
55 .BR \-p0 .
56 .PP
57 The
58 .B \-a
59 option requests the generation of an assembly BOM.
60 The assembly BOM differs from the corresponding ``regular'' short BOM in that if
61 a component is to be socketed, the part information emitted is for the socket
62 rather than the component to be pushed into it.
63 .SH FILES
64 MCL Master Component List
65 .SH SEE ALSO
66 ueda-mkbom(1)
67 .br
68 .I
69 Bill of Materials (BOM) handling in uEDA