diff ueda/man/ueda-getfps.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-getfps.1	Mon Jul 20 00:24:37 2015 +0000
@@ -0,0 +1,81 @@
+.TH GETFPS 1 "" "International Free Computing Task Force" \
+"uEDA Suite Documentation"
+.SH NAME
+ueda-getfps \- fetch all footprints for the board
+.SH SYNOPSIS
+.B ueda-getfps
+[
+.B \-c
+] [
+.B \-h
+]
+.B |
+.B ueda-runm4
+.SH DESCRIPTION
+.PP
+.I Ueda-getfps
+reads the MCL, extracts all
+.B footprint=
+attributes and generates a set of
+.IR m4 (1)
+macro calls which then needs to be run through
+.IR ueda-runm4 (1).
+The complete
+.B
+ueda-getfps | ueda-runm4
+pipeline produces the complete set of PCB elements (footprints) for the board.
+.PP
+The
+.B \-c
+option instructs
+.I ueda-getfps
+to check the design for the completeness of the pre-layout information.
+Normally components in the MCL which do not have a
+.B footprint=
+attribute or have it set to
+.B TBD
+are ignored, but the
+.B \-c
+option causes a warning message to be issued instead.
+.PP
+The
+.B \-h
+option causes
+a blank PCB template to be prepended as a header before the PCB elements
+so that the resulting pipeline output is a complete and valid PCB layout file.
+.SH FILES
+MCL	Master Component List
+.SH SEE ALSO
+ueda-cutelements(1), ueda-instfileelem(1), ueda-runm4(1)
+.br
+Introductory uEDA documentation
+.SH DIAGNOSTICS
+/usr/local/eda/ifctf-part-lib/m4-fp: bad directory
+.in +8
+The required IFCTF part library is not installed correctly.
+.in -8
+/usr/local/eda/file-element-dirs: No such file or directory
+.in +8
+If a requested footprint is not found in the M4 library, the M4 code
+automatically invokes
+.IR ueda-instfileelem (1)
+to look for it in the file element directories.
+If the latter are not installed, you see this rather cryptic error message.
+.in -8
+No footprint named \fIxxx\fP
+.in +8
+The requested footprint could not be found, neither in M4 nor in the file
+element libraries.
+.in -8
+\fIXX\fP has no footprint
+.br
+\fIXX\fP: footprint=TBD
+.in +8
+These diagnostics are produced with the
+.B \-c
+option and should be self-explanatory.
+.in -8
+.SH BUGS
+Exposing the
+.IR ueda-getfps | ueda-runm4
+pipeline to the user is ugly.