Forrest logo
back to the asciidoctor tool

asciidoctor:tldr:185af

asciidoctor: Convert a specific `.adoc` file to a PDF using the `asciidoctor-pdf` library.
$ asciidoctor --backend=${pdf} --require=${asciidoctor-pdf} ${filename-adoc}
try on your machine

This command is using the 'asciidoctor' tool to convert an AsciiDoc file (${filename-adoc}) to a PDF format.

Here is a breakdown of the command syntax:

  • asciidoctor is the command used to run the 'asciidoctor' tool.
  • --backend=${pdf} is an option used to specify the output format. In this case, it is using the value stored in the variable '${pdf}' to set the output format as PDF. The exact value of '${pdf}' would be determined by the context where this command is being executed.
  • --require=${asciidoctor-pdf} is another option that tells Asciidoctor to load and use the Asciidoctor PDF extension. The value of '${asciidoctor-pdf}' would be the path or name of the 'asciidoctor-pdf' extension.
  • ${filename-adoc} is a placeholder indicating the name of the AsciiDoc source file that should be converted.

Overall, this command is converting an AsciiDoc file to PDF format using the 'asciidoctor' tool with the help of the Asciidoctor PDF extension.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the asciidoctor tool