diff ueda/man/ueda-runm4.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-runm4.1	Mon Jul 20 00:24:37 2015 +0000
@@ -0,0 +1,49 @@
+.TH RUNM4 1 "" "International Free Computing Task Force" \
+"uEDA Suite Documentation"
+.SH NAME
+ueda-runm4 \- run m4 with the PCB footprint library loaded
+.SH SYNOPSIS
+.B ueda-runm4
+.SH DESCRIPTION
+.PP
+.I Ueda-runm4
+is a simple
+.IR sh (1)
+script that invokes
+.IR m4 (1)
+with all macros of the IFCTF PCB footprint library loaded and available
+for use.
+Input may be given on stdin which uses these macros and output will be
+produced on stdout with all macros correctly expanded.
+.PP
+.I Ueda-runm4
+is normally run as a post-processor for
+.IR ueda-getfps (1).
+.SH FILES
+/usr/local/eda/ifctf-part-lib		IFCTF part library
+.SH SEE ALSO
+ueda-getfps(1), ueda-instfileelem(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
+.SH BUGS
+The M4 code in the IFCTF part library uses some features only present
+in the 4.3BSD-Quasijarus version of
+.IR m4 (1).