Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

INSTALL.md — reorganise info on static binaries and add conda-forge install options #10098

Merged
merged 2 commits into from
Aug 28, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 41 additions & 5 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ The simplest way to get the latest pandoc release is to use the installer.
Download the latest installer
</a>

For alternative ways to install pandoc, see below
under the heading for your operating system.
For alternative ways to install pandoc, see below under the heading for
your operating system. In cases where a statically linked executable is
installed, the pandoc binary from this package cannot use lua filters that
require external lua modules written in C.
iandol marked this conversation as resolved.
Show resolved Hide resolved

## Windows

Expand Down Expand Up @@ -39,6 +41,18 @@ Or, you can install pandoc using

winget install --source winget --exact --id JohnMacFarlane.Pandoc

Or, you can install pandoc using a [Conda
forge](https://anaconda.org/conda-forge/pandoc) tool, like
[`conda`](https://conda.pydata.org/docs/intro.html),
[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or
[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other
packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via
`librsvg` etc.). Note this is a statically-linked executable:

conda install -c conda-forge pandoc
pixi global install pandoc
micromamba install pandoc

Using multiple installation methods can result in two separate
installations of pandoc; it is recommended to properly uninstall
pandoc before switching to an alternative installation method.
Expand Down Expand Up @@ -70,6 +84,18 @@ Note: On unsupported versions of macOS (more than three releases old),
Homebrew installs from source, which takes additional time and disk space
for the `ghc` compiler and dependent Haskell libraries.

Or, you can install pandoc using a [Conda
forge](https://anaconda.org/conda-forge/pandoc) tool, like
[`conda`](https://conda.pydata.org/docs/intro.html),
[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or
[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other
packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via
`librsvg` etc.). Note this is a statically-linked executable:

conda install -c conda-forge pandoc
pixi global install pandoc
micromamba install pandoc

iandol marked this conversation as resolved.
Show resolved Hide resolved
We also provide a zip file containing the binaries and man
pages, for those who prefer not to use the installer. Simply
unzip the file and move the binaries and man pages to
Expand Down Expand Up @@ -97,9 +123,7 @@ architecture on the **[download page]**.

The executable is statically linked and
has no dynamic dependencies or dependencies on external
data files. Note: because of the static
linking, the pandoc binary from this package cannot use lua
filters that require external lua modules written in C.
data files.

Both a tarball and a deb installer are provided. To install the deb:

Expand All @@ -122,6 +146,18 @@ a tarball, try instead

ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST

Or, you can install pandoc using a [Conda
forge](https://anaconda.org/conda-forge/pandoc) tool, like
[`conda`](https://conda.pydata.org/docs/intro.html),
[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or
[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other
packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via
`librsvg` etc.). Note this is a statically-linked executable:

conda install -c conda-forge pandoc
pixi global install pandoc
micromamba install pandoc

You can also install from source, using the
instructions below under [Compiling from source].
Note that most distros have the Haskell platform in their
Expand Down