"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "INSTALL.md" between
pandoc-2.11.1.1.tar.gz and pandoc-2.11.2.tar.gz

About: Pandoc converts files from one markup format into another.

INSTALL.md  (pandoc-2.11.1.1):INSTALL.md  (pandoc-2.11.2)
skipping to change at line 52 skipping to change at line 52
There is a package installer at pandoc's [download page]. There is a package installer at pandoc's [download page].
If you later want to uninstall the package, you can do so If you later want to uninstall the package, you can do so
by downloading [this script][uninstaller] by downloading [this script][uninstaller]
and running it with `perl uninstall-pandoc.pl`. and running it with `perl uninstall-pandoc.pl`.
Alternatively, you can install pandoc using Alternatively, you can install pandoc using
[Homebrew](http://brew.sh): [Homebrew](http://brew.sh):
brew install pandoc brew install pandoc
To include pandoc's citation parser:
brew install pandoc-citeproc
Homebrew can also install other software that integrates with Pandoc. Homebrew can also install other software that integrates with Pandoc.
For example, to install [librsvg] (its `rsvg-convert` covers formats For example, to install [librsvg] (its `rsvg-convert` covers formats
without SVG support), [Python] (to use Pandoc filters), and without SVG support), [Python] (to use Pandoc filters), and
[BasicTeX] (to typeset PDFs with [LaTeX]): [BasicTeX] (to typeset PDFs with [LaTeX]):
brew install librsvg python homebrew/cask/basictex brew install librsvg python homebrew/cask/basictex
Note: On unsupported versions of macOS (more than three releases old), Note: On unsupported versions of macOS (more than three releases old),
Homebrew installs from source, which takes additional time and disk space Homebrew installs from source, which takes additional time and disk space
for the `ghc` compiler and dependent Haskell libraries. for the `ghc` compiler and dependent Haskell libraries.
skipping to change at line 89 skipping to change at line 85
## Linux ## Linux
Check whether the pandoc version in your package manager is Check whether the pandoc version in your package manager is
not outdated. Pandoc is in the [Debian], [Ubuntu], [Slackware], not outdated. Pandoc is in the [Debian], [Ubuntu], [Slackware],
[Arch], [Fedora], [NiXOS], [openSUSE], [gentoo] and [Void] repositories. [Arch], [Fedora], [NiXOS], [openSUSE], [gentoo] and [Void] repositories.
To get the latest release, we provide a binary package for amd64 To get the latest release, we provide a binary package for amd64
architecture on the **[download page]**. architecture on the **[download page]**.
This provides both `pandoc` and `pandoc-citeproc`. The executable is statically linked and
The executables are statically linked and has no dynamic dependencies or dependencies on external
have no dynamic dependencies or dependencies on external
data files. Note: because of the static data files. Note: because of the static
linking, the pandoc binary from this package cannot use lua linking, the pandoc binary from this package cannot use lua
filters that require external lua modules written in C. filters that require external lua modules written in C.
Both a tarball and a deb installer are provided. To install the deb: Both a tarball and a deb installer are provided. To install the deb:
sudo dpkg -i $DEB sudo dpkg -i $DEB
where `$DEB` is the path to the downloaded deb. This will where `$DEB` is the path to the downloaded deb. This will
install the `pandoc` and `pandoc-citeproc` executables and install the `pandoc` executable and man page.
man pages.
If you use an RPM-based distro, you may be able to install If you use an RPM-based distro, you may be able to install
the deb from our download page using `alien`. the deb from our download page using `alien`.
On any distro, you may install from the tarball into `$DEST` On any distro, you may install from the tarball into `$DEST`
(say, `/usr/local/` or `$HOME/.local`) by doing (say, `/usr/local/` or `$HOME/.local`) by doing
tar xvzf $TGZ --strip-components 1 -C $DEST tar xvzf $TGZ --strip-components 1 -C $DEST
where `$TGZ` is the path to the downloaded zipped tarball. where `$TGZ` is the path to the downloaded zipped tarball.
skipping to change at line 152 skipping to change at line 146
Pandoc is in the [NetBSD] and [FreeBSD ports] repositories. Pandoc is in the [NetBSD] and [FreeBSD ports] repositories.
## Docker ## Docker
The official Docker images for pandoc can be found at The official Docker images for pandoc can be found at
<https://github.com/pandoc/dockerfiles> and at <https://github.com/pandoc/dockerfiles> and at
[dockerhub](https://hub.docker.com/). [dockerhub](https://hub.docker.com/).
The [pandoc/core](https://hub.docker.com/r/pandoc/core) The [pandoc/core](https://hub.docker.com/r/pandoc/core)
image contains `pandoc` and `pandoc-citeproc`. image contains `pandoc`.
The [pandoc/latex](https://hub.docker.com/r/pandoc/latex) The [pandoc/latex](https://hub.docker.com/r/pandoc/latex)
image also contains the minimal LaTeX installation needed image also contains the minimal LaTeX installation needed
to produce PDFs using pandoc. to produce PDFs using pandoc.
To run pandoc using Docker, converting `README.md` to `README.pdf`: To run pandoc using Docker, converting `README.md` to `README.pdf`:
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` pandoc/latex R EADME.md -o README.pdf docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` pandoc/latex R EADME.md -o README.pdf
## GitHub Actions ## GitHub Actions
skipping to change at line 249 skipping to change at line 243
cabal install cabal install
5. Make sure the `$CABALDIR/bin` directory is in your path. You should 5. Make sure the `$CABALDIR/bin` directory is in your path. You should
now be able to run `pandoc`: now be able to run `pandoc`:
pandoc --help pandoc --help
[Not sure where `$CABALDIR` is?](http://www.haskell.org/haskellwiki/Cabal-In stall#The_cabal-install_configuration_file) [Not sure where `$CABALDIR` is?](http://www.haskell.org/haskellwiki/Cabal-In stall#The_cabal-install_configuration_file)
5. If you want to process citations with pandoc, you will also need to 5. By default `pandoc` uses the "i;unicode-casemap" method
install a separate package, `pandoc-citeproc`. This can be installed
using cabal:
cabal install pandoc-citeproc
By default `pandoc-citeproc` uses the "i;unicode-casemap" method
to sort bibliography entries (RFC 5051). If you would like to to sort bibliography entries (RFC 5051). If you would like to
use the locale-sensitive unicode collation algorithm instead, use the locale-sensitive unicode collation algorithm instead,
specify the `unicode_collation` flag: specify the `icu` flag (which affects the dependency `citeproc`):
cabal install pandoc-citeproc -funicode_collation cabal install pandoc -ficu
Note that this requires the `text-icu` library, which in turn Note that this requires the `text-icu` library, which in turn
depends on the C library `icu4c`. Installation directions depends on the C library `icu4c`. Installation directions
vary by platform. Here is how it might work on macOS with Homebrew: vary by platform. Here is how it might work on macOS with Homebrew:
brew install icu4c brew install icu4c
stack install pandoc-citeproc \ stack install pandoc \
--flag "pandoc-citeproc:unicode_collation" \ --flag "citeproc:icu" \
--extra-lib-dirs=/usr/local/opt/icu4c/lib \ --extra-lib-dirs=/usr/local/opt/icu4c/lib \
--extra-include-dirs=/usr/local/opt/icu4c/include --extra-include-dirs=/usr/local/opt/icu4c/include
6. The `pandoc.1` man page will be installed automatically. cabal shows 6. The `pandoc.1` man page will be installed automatically. cabal shows
you where it is installed: you may need to set your `MANPATH` you where it is installed: you may need to set your `MANPATH`
accordingly. If `MANUAL.txt` has been modified, the man page can be accordingly. If `MANUAL.txt` has been modified, the man page can be
rebuilt: `make man/pandoc.1`. rebuilt: `make man/pandoc.1`.
The `pandoc-citeproc.1` man page will also be installed automatically.
### Custom cabal method ### Custom cabal method
This is a step-by-step procedure that offers maximal control This is a step-by-step procedure that offers maximal control
over the build and installation. Most users should use the over the build and installation. Most users should use the
quick install, but this information may be of use to packagers. quick install, but this information may be of use to packagers.
For more details, see the [Cabal User's Guide]. These instructions For more details, see the [Cabal User's Guide]. These instructions
assume that the pandoc source directory is your working directory. assume that the pandoc source directory is your working directory.
You will need cabal version 2.0 or higher. You will need cabal version 2.0 or higher.
1. Install dependencies: in addition to the [Haskell platform], 1. Install dependencies: in addition to the [Haskell platform],
 End of changes. 9 change blocks. 
23 lines changed or deleted 9 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)