aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDerek Brown <[email protected]>2015-04-15 17:36:27 -0400
committerHenrik Nord <[email protected]>2015-10-14 10:52:54 +0200
commitf4b99c9bc3c1f8a52b35d0731253b5052e695b32 (patch)
treec4865d482679cba09e7c80f10e3c1fb108aa0040
parent60be19014474a39d9b611ef7749bffa1f6096bc1 (diff)
downloadotp-f4b99c9bc3c1f8a52b35d0731253b5052e695b32.tar.gz
otp-f4b99c9bc3c1f8a52b35d0731253b5052e695b32.tar.bz2
otp-f4b99c9bc3c1f8a52b35d0731253b5052e695b32.zip
Add details on the FOP formatter
I found that I needed to take the two steps I added to INSTALL.md for this PR, or else fop execution when doing a "make docs" would fail with either a Java ClassNotFoundException or command "fop" not found: * Adding the FOP install directory to $FOP_HOME * Adding the fop script to $PATH
-rw-r--r--HOWTO/INSTALL.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/HOWTO/INSTALL.md b/HOWTO/INSTALL.md
index 0dab438b10..2f7088ba11 100644
--- a/HOWTO/INSTALL.md
+++ b/HOWTO/INSTALL.md
@@ -210,6 +210,14 @@ the `$PATH`.
$ export PATH=$ERL_TOP/bin:$PATH # Assuming bash/sh
+For the FOP print formatter, two steps must be taken:
+
+* Adding the location of your installation of `fop` in `$FOP_HOME`.
+
+ $ export FOP_HOME=/path/to/fop/dir # Assuming bash/sh
+
+* Adding the `fop` script (in `$FOP_HOME`) to your `$PATH`, either by adding `$FOP_HOME` to `$PATH`, or by copying the `fop` script to a directory already in your `$PATH`.
+
Build the documentation.
$ make docs