summaryrefslogtreecommitdiffstats
path: root/README.txt
diff options
context:
space:
mode:
authorJoel Sherrill <joel@rtems.org>2016-11-08 18:19:39 -0600
committerJoel Sherrill <joel@rtems.org>2016-11-08 18:19:39 -0600
commit4cb5e55941718d48a0f7d592988c187907373e24 (patch)
tree755fce3c71728abc9b6ab782f25f5eb80f04e6c7 /README.txt
parent969b4cd88cad3bdde76117597069330cdb6e2e65 (diff)
downloadrtems-docs-4cb5e55941718d48a0f7d592988c187907373e24.tar.bz2
README.txt: Add notes on Centos 6 and 7
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt51
1 files changed, 46 insertions, 5 deletions
diff --git a/README.txt b/README.txt
index 6a230e8..6e94c50 100644
--- a/README.txt
+++ b/README.txt
@@ -32,6 +32,7 @@ production level.
The hosts which produce production quality is:
FreeBSD
+ CentOS 6 and 7 (if using texlive, not RPMs of texlive)
Host Setup
----------
@@ -47,7 +48,20 @@ Sphinx Per User Install
You can use this method to install a personal version of Sphinx if your host
does not provide a suitable package:
- $ pip install -U Sphinx
+ $ pip install -U sphinx
+
+On some hosts, this may complain that a newer version of pip is available.
+If so, then upgrade pip into your personal area.
+
+ $ pip install --upgrade --user pip
+
+The personal area for these tools is ${HOME}/.local/bin. It should
+be PREPENDED to your path. On a 32-bit install of CentOS 6, these
+were the PATH modifications to use the local install of Texlive
+and sphinx:
+
+ export PATH=/usr/local/texlive/2016/bin/i386-linux/:${PATH}
+ export PATH=${HOME}/.local/bin:${PATH}
FreeBSD
~~~~~~~
@@ -67,10 +81,10 @@ Single HTML:
# pkg install npm
# npm install -g inliner
-CentOS 7
-~~~~~~~~
+CentOS 6 and 7
+~~~~~~~~~~~~~~
-PDF Quality: poor
+PDF Quality: production
Sphinx:
@@ -78,13 +92,40 @@ Sphinx:
PDF:
- # yum install -y texlive-*
+ WARNING: Do NOT use the RPMs for texlive. They are incomplete and, in
+ the best case, result in ugly PDFs.
+
+ As root, install texlive per the instructions at
+ http://tug.org/texlive/acquire-netinstall.html
+
+ # wget http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz
+ # tar xf install-tl-unx.tar.gz
+ # cd install-tl-20161106
+ NOTE: The date in the name of the directory will change.
+ # ./install-tl
+ - Use the command line system. Select "O" for options if you want to
+ change from A4 to US letter paper size by default.
+ - Select "I" to install
+ - The tools will be installed into a directory like the following:
+ /usr/local/texlive/2016/bin/i386-linux/
+
+ NOTE: The year (2016) and host OS (i386-linux) will change to
+ reflect 32 or 64 bit and OS name.
Single HTML:
# yum install npm
# npm install -g inliner
+PATH:
+
+ Ensure the appropriate directories are PREPENDED to your PATH before
+ building the documentation. Examples are shown below:
+
+ export PATH=/usr/local/texlive/2016/bin/i386-linux/:${PATH}
+ export PATH=${HOME}/.local/bin:${PATH}
+
+
Arch Linux
~~~~~~~~~~