2007-07-16 18:30:04 +02:00
|
|
|
% Installing pandoc
|
|
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
Installing from Source
|
|
|
|
|
======================
|
2007-07-16 18:30:04 +02:00
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
This method will work on all architectures, but requires that you first
|
|
|
|
|
install the GHC compiler and some build tools: [GNU `make`], `sed`,
|
|
|
|
|
`bash`, and `perl`. These are standard on unix systems (including MacOS
|
|
|
|
|
X). If you're using Windows, you can install [Cygwin].
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
[Cygwin]: http://www.cygwin.com/
|
|
|
|
|
[GNU `make`]: http://www.gnu.org/software/make/
|
|
|
|
|
|
|
|
|
|
Installing GHC
|
|
|
|
|
--------------
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2007-06-17 18:13:36 +02:00
|
|
|
To compile Pandoc, you'll need [GHC] version 6.6 or greater. If
|
2006-11-07 07:17:56 +01:00
|
|
|
you don't have GHC already, you can get it from the [GHC Download]
|
2007-07-16 18:30:04 +02:00
|
|
|
page. If you're running MacOS X, you can also install GHC using
|
|
|
|
|
[MacPorts] or [Fink].
|
2006-10-29 20:58:20 +01:00
|
|
|
|
|
|
|
|
[GHC]: http://www.haskell.org/ghc/
|
|
|
|
|
[GHC Download]: http://www.haskell.org/ghc/download.html
|
2007-07-16 18:30:04 +02:00
|
|
|
[MacPorts]: http://macports.org
|
|
|
|
|
[Fink]: http://finkproject.org
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
Getting the source
|
|
|
|
|
------------------
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
Download the source tarball from pandoc's [pandoc's google code site].
|
|
|
|
|
Extract the contents into a subdirectory:
|
|
|
|
|
|
|
|
|
|
tar xvzf pandoc-0.xy.tar.gz
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
[pandoc's google code site]: http://pandoc.googlecode.com
|
|
|
|
|
|
|
|
|
|
Installing Pandoc
|
|
|
|
|
-----------------
|
2006-10-29 20:58:20 +01:00
|
|
|
|
|
|
|
|
1. Change to the directory containing the Pandoc distribution.
|
|
|
|
|
|
|
|
|
|
2. Compile:
|
|
|
|
|
|
|
|
|
|
make
|
|
|
|
|
|
2006-11-19 22:24:33 +01:00
|
|
|
If you get "Unknown modifier" errors, it is probably because `make`
|
|
|
|
|
on your system is not [GNU `make`]. Try using `gmake` instead.
|
|
|
|
|
|
2006-10-29 20:58:20 +01:00
|
|
|
3. See if it worked (optional, but recommended):
|
|
|
|
|
|
|
|
|
|
make test
|
|
|
|
|
|
2007-08-16 21:27:56 +02:00
|
|
|
Note: if you see errors like the following, they're due to differences
|
|
|
|
|
between different versions of the xhtml library, and can safely be
|
|
|
|
|
disregarded:
|
|
|
|
|
|
|
|
|
|
2c2
|
|
|
|
|
< <html xmlns="http://www.w3.org/1999/xhtml"
|
|
|
|
|
---
|
|
|
|
|
> <html
|
|
|
|
|
|
2006-10-29 20:58:20 +01:00
|
|
|
4. Install:
|
|
|
|
|
|
2006-11-07 07:17:56 +01:00
|
|
|
sudo make install
|
2006-10-29 20:58:20 +01:00
|
|
|
|
|
|
|
|
Note: This installs `pandoc`, together with its wrappers and
|
2007-01-04 02:23:07 +01:00
|
|
|
documentation, into the `/usr/local` directory. If you'd rather
|
|
|
|
|
install `pandoc` somewhere else--say, in `/opt/local`--you can
|
|
|
|
|
set the `PREFIX` environment variable:
|
|
|
|
|
|
|
|
|
|
PREFIX=/opt/local sudo make install
|
|
|
|
|
|
|
|
|
|
If you don't have root privileges or would prefer to install
|
|
|
|
|
`pandoc` and the associated wrappers into your `~/bin` directory,
|
|
|
|
|
type this instead:
|
2006-10-29 20:58:20 +01:00
|
|
|
|
|
|
|
|
PREFIX=~ make install-exec
|
|
|
|
|
|
2006-11-07 07:17:56 +01:00
|
|
|
5. Build and install the Haskell libraries and library
|
2007-01-04 02:23:07 +01:00
|
|
|
documentation (optional--for Haskell programmers only):
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2006-11-07 07:17:56 +01:00
|
|
|
make build-all
|
|
|
|
|
sudo make install-all
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2007-07-16 18:30:04 +02:00
|
|
|
Note that building the library documentation requires [haddock].
|
|
|
|
|
|
|
|
|
|
[haddock]: http://www.haskell.org/haddock/
|
|
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
Removing Pandoc
|
|
|
|
|
---------------
|
2006-10-29 20:58:20 +01:00
|
|
|
|
|
|
|
|
Each of the installation steps described above can be reversed:
|
|
|
|
|
|
2006-11-07 07:17:56 +01:00
|
|
|
sudo make uninstall
|
2006-10-29 20:58:20 +01:00
|
|
|
|
|
|
|
|
PREFIX=~ make uninstall-exec
|
|
|
|
|
|
2006-11-07 07:17:56 +01:00
|
|
|
sudo make uninstall-all
|
2006-10-29 20:58:20 +01:00
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
Other targets
|
|
|
|
|
-------------
|
2006-12-31 20:12:53 +01:00
|
|
|
|
|
|
|
|
The following 'make' targets should not be needed by the average user,
|
|
|
|
|
but are documented here for packagers and developers:
|
|
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
### Building and installing
|
2006-12-31 20:12:53 +01:00
|
|
|
|
|
|
|
|
* `configure`: Performs the needed preprocessing to create a proper
|
|
|
|
|
Cabal package for Pandoc:
|
2007-11-04 00:27:58 +01:00
|
|
|
- Builds `ASCIIMathML.hs`, `DefaultHeaders.hs`, and `S5.hs`
|
|
|
|
|
from templates in `src/templates` and data in `src/ASCIIMathML.js`,
|
|
|
|
|
`src/ui`, and `src/headers`.
|
2006-12-31 20:12:53 +01:00
|
|
|
- Stores values of relevant environment variables in `vars` for
|
|
|
|
|
persistence.
|
|
|
|
|
- Runs Cabal's "configure" command.
|
|
|
|
|
* `build-exec`: Builds `pandoc` executable (using Cabal's "build"
|
|
|
|
|
command) and creates the wrappers `html2markdown` and `markdown2pdf`
|
2007-11-04 00:27:58 +01:00
|
|
|
from templates in `src/wrappers`.
|
2006-12-31 20:12:53 +01:00
|
|
|
* `build-doc`: Builds program documentation (e.g. `README.html`).
|
|
|
|
|
* `build-lib-doc`: Builds Haddock documentation for Pandoc libraries.
|
|
|
|
|
* `install-doc`, `uninstall-doc`: Installs/uninstalls user documentation
|
|
|
|
|
and man pages.
|
|
|
|
|
* `install-lib-doc`, `uninstall-lib-doc`: Installs/uninstalls library
|
|
|
|
|
documentation and man pages.
|
|
|
|
|
* `install-exec`, `uninstall-exec`: Installs/uninstalls programs
|
|
|
|
|
(`pandoc` and wrappers).
|
|
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
### Testing
|
2006-12-31 20:12:53 +01:00
|
|
|
|
|
|
|
|
* `test`: Runs Pandoc's test suite. (All tests should pass.)
|
|
|
|
|
* `test-markdown`: Runs the Markdown regression test suite, using
|
2007-07-16 18:30:04 +02:00
|
|
|
`pandoc --strict`. (Three of the tests will fail.)
|
2006-12-31 20:12:53 +01:00
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
### Cleaning
|
2006-12-31 20:12:53 +01:00
|
|
|
|
|
|
|
|
* `clean`: Restores directory to pre-build state, removing generated files.
|
|
|
|
|
* `distclean`: Like clean, but also cleans up files created by `make deb`.
|
|
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
### Packaging
|
2006-12-31 20:12:53 +01:00
|
|
|
|
2007-07-16 18:30:04 +02:00
|
|
|
* `tarball`: Creates a source tarball for distribution.
|
|
|
|
|
* `deb`: Creates debian packages in `..` directory.
|
2007-08-25 18:52:42 +02:00
|
|
|
* `macport`: Creates MacPorts Portfile in `macports` directory.
|
2007-08-25 19:35:53 +02:00
|
|
|
* `freebsd`: Creates freebsd Makefile and distinfo in `freebsd` directory.
|
2006-12-31 20:12:53 +01:00
|
|
|
* `win-pkg`: Creates a Windows binary package (presupposes `pandoc.exe`,
|
|
|
|
|
which must be created by building Pandoc on a Windows machine).
|
|
|
|
|
* `website`: Creates Pandoc's website in `web/pandoc` directory.
|
|
|
|
|
|
2007-08-26 18:13:05 +02:00
|
|
|
Installing pandoc using Cabal
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
Pandoc can also be installed using the standard Haskell packaging tool,
|
|
|
|
|
[Cabal](http://www.haskell.org/cabal/). You'll need GHC 6.6 or greater
|
|
|
|
|
(see [Installing GHC](#installing-ghc), above). Just download the source
|
|
|
|
|
tarball, unpack, and type:
|
|
|
|
|
|
|
|
|
|
runhaskell Setup.hs configure
|
|
|
|
|
runhaskell Setup.hs build
|
|
|
|
|
runhaskell Setup.hs install # this one as root
|
|
|
|
|
|
|
|
|
|
This will install the pandoc executable and the Haskell libraries,
|
|
|
|
|
but not the shell scripts, man pages, or other documentation.
|
|
|
|
|
|
2007-11-25 02:51:36 +01:00
|
|
|
Note: If you are using GHC 6.6.*, you will need to start by
|
|
|
|
|
replacing `pandoc.cabal` with a version suitable for GHC 6.6:
|
|
|
|
|
|
|
|
|
|
cp pandoc.cabal pandoc.cabal.orig
|
|
|
|
|
cp pandoc.cabal.ghc66 pandoc.cabal
|
|
|
|
|
|
2007-08-26 17:34:56 +02:00
|
|
|
Installing pandoc using MacPorts
|
|
|
|
|
================================
|
|
|
|
|
|
|
|
|
|
This is an alternative to compiling from source on MacOS X.
|
|
|
|
|
[MacPorts] is a system for building and maintaining \*nix software
|
|
|
|
|
on MacOS X computers. If you don't already have MacPorts, follow
|
|
|
|
|
[these instructions for installing
|
|
|
|
|
it](http://trac.macosforge.org/projects/macports/wiki/InstallingMacPorts).
|
|
|
|
|
|
2007-08-28 00:18:36 +02:00
|
|
|
Once you've installed MacPorts, you can install pandoc by typing:
|
2007-08-26 17:34:56 +02:00
|
|
|
|
2007-08-28 00:18:36 +02:00
|
|
|
sudo port sync # to get the most recent ports
|
2007-08-26 17:34:56 +02:00
|
|
|
sudo port install pandoc
|
|
|
|
|
|
2007-08-28 00:18:36 +02:00
|
|
|
Since pandoc depends on GHC, the process may take a long time.
|
2007-08-26 17:34:56 +02:00
|
|
|
|
|
|
|
|
Installing the Windows binary
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
Simply download the zip file from [pandoc's google code site].
|
|
|
|
|
Extract the files from the archive, and put `pandoc.exe` somewhere
|
|
|
|
|
in your PATH.
|
|
|
|
|
|
|
|
|
|
Note that the Windows binary distribution does not include the shell
|
|
|
|
|
scripts `markdown2pdf`, `html2markdown`, or `hsmarkdown`. If you need
|
|
|
|
|
these, compile from source.
|
|
|
|
|
|
|
|
|
|
Installing pandoc on Debian
|
|
|
|
|
===========================
|
|
|
|
|
|
2007-08-28 00:18:36 +02:00
|
|
|
Pandoc is now in the debian unstable archive, and can be installed
|
|
|
|
|
using `apt-get` (as root):
|
2007-08-26 17:34:56 +02:00
|
|
|
|
2007-08-28 00:18:36 +02:00
|
|
|
apt-get install pandoc # the program, shell scripts, and docs
|
|
|
|
|
apt-get install libghc6-pandoc-dev # the libraries
|
|
|
|
|
apt-get install pandoc-doc # library documentation
|
2007-08-26 17:34:56 +02:00
|
|
|
|
2007-08-28 00:18:36 +02:00
|
|
|
Thanks to Recai Oktaş for setting up the debian packages.
|
2007-08-26 17:34:56 +02:00
|
|
|
|
|
|
|
|
Installing pandoc on FreeBSD
|
|
|
|
|
============================
|
|
|
|
|
|
|
|
|
|
Pandoc is in the FreeBSD ports repository (`textproc/pandoc`) and can be
|
|
|
|
|
installed in the normal way:
|
|
|
|
|
|
|
|
|
|
cd /usr/ports/textproc/pandoc
|
|
|
|
|
make install clean # as root
|
|
|
|
|
|
|
|
|
|
Alternatively, you can use `pkg_add`:
|
|
|
|
|
|
|
|
|
|
pkg_add -r pandoc
|
|
|
|
|
|
|
|
|
|
Note that the version of pandoc in FreeBSD's official repository may be
|
|
|
|
|
somewhat older than the most recent version.
|
|
|
|
|
|
