If you are interested in the rendered version of the User’s Guide, please read them at docs.linbit.com.

You can download PDF versions for free from our home page.

• asciidoctor

• mandoc

• asciidoctor-pdf

We do not publish the official LINBIT fonts in that repository. Public projects have to be able to generate PDFs without LINBIT’s fonts, private ones are allowed to fail if the linbit-fonts directory does not exist. Actually they should fail, which is the default anyways.

If you build official PDFs/private projects, make sure that you cloned the internal linbit-fonts repository.

If you intend to generate the pdf versions of the Japanese user’s guides, make sure you downloaded this zip archive. Extract the archive to a genshingothic-fonts directory in the root of the documentation.

If you already built the linbit-documentation Docker image and use the -docker make targets, this action is taken care of for you.

These generate their output to output-$format. It is perfectly fine that these directories contain temporary files like symlinks. As already written, we want proper Makefiles, so if the source does not change re-executing these targets should only process files that changed.

These generate their output to output-$format-finalize. This is the final output. The one that is published to a web page/sent to a web developer. For example this generates tar archive files for UG9 that can be sent to someone who puts it on the web page.

It is usually the final target that is executed after multiple iterations of make pdf/make html and it is fine if that target alters the content of output-$format to generate output-$format-finalize. If possible it should not, but it is not a strict requirement.

The top-level Makefile also contains targets that end in "-docker". These can be used to generate the output with the previously describe "linbit-documentation" base image. For example one can execute make UG9-html-finalize-docker.

The -docker make targets depend on the "local" make targets. Using the Docker targets is preferred, for consistent results, unless you have a reason not to use them. As of January 2023, local make targets are untested and unsupported, except as they are run through the linbit-documentation Docker image.

The English version is the default, but if you want to build the Japanese version, you have to set the make variable "lang" accordingly (e.g., make UG9-html-finalize-docker lang=ja). Japanese version is created by English .adoc files and Japanese .po files. Pot files used for localization can be created by the pot target, (e.g, `make UG9-pot-docker). Make sure created pot files include correct sentences.