caspar-typesetting(7)

💖 caspar-typesetting — the manual page, but make it a group chat 💖

okay so bestie, you're reading caspar-typesetting(7), which lives in the MISCELLANEOUS corner of your man pages. it's giving "tiny Makefile snippets that do your homework for you." let's get into it. ✨

---

🌸 NAME 🌸

caspar-typesetting — Makefile snippets for common typesetting tasks

like, the whole vibe is: you write one line in a Makefile and suddenly your documents typeset themselves. no cap. 💅

---

🎀 SYNOPSIS 🎀

In a Makefile, write

include caspar/mk/docbook.mk

or

include caspar/mk/pod.mk

or

include caspar/mk/markdown.mk

periodt. that's it. that's the whole synopsis. 🦋

---

✨ DESCRIPTION ✨

The caspar docbook.mk, pod.mk and markdown.mk files are Makefile snippets for common typesetting tasks — think typesetting LaTeX (see [3]), DocBook XML, DocBook SGML (see [2]), POD (see [1]) and Markdown (see [4]) documents.

and the way that you literally just have to type make?? instead of stuff like jade -t tex -d caspar/print.dsl /usr/share/sgml/declaration/xml.dcl foobar.dbx?? bestie, that's main character energy. we are NOT typing that. 🙈

---

🌈 USAGE 🌈

💜 DocBook XML / LaTeX directories

In a directory where you maintain .dbx (Docbook XML) or .tex (LaTeX) files, do

$ echo include caspar/mk/docbook.mk > Makefile

$ vi karenina.dbx
$ make karenina.view
$ make karenina.print

$ vi svejk.tex
$ make svejk.view
$ make svejk.print

$ make
$ make clean

Other targets: filename.ps, filename.pdf, filename.2ps, filename.html, filename.printbig, filename.dvi.

Variables you might like to set in your Makefile: XMLDCL (default is /usr/share/sgml/declaration/xml.dcl; if you're not on a Debian GNU/Linux system, you'll likely have to adjust this), HTML_DSL, PRINT_DSL.

🫶 real talk: if you're not on Debian GNU/Linux, that XMLDCL default is probably not your girl. adjust it. she'll be fine, she's flexible.

🍓 POD directories

In a directory where you maintain .pod files, do

$ echo include caspar/mk/pod.mk > Makefile
$ vi lire.pod
$ perldoc ./lire.pod
$ make lire.pdf
$ make
$ less lire.overstrike-txt
$ make clean

Other targets: filename.ps, filename.html, filename.txt, ... (Similar to the ones supplied by docbook.mk).

🦋 Markdown directories

In a directory where you maintain .md files, do

$ echo include caspar/mk/markdown.mk > Makefile
$ vi lire.md
$ make lire.html
$ make
$ make clean

lowkey the easiest one. iconic. 👑

---

💅 EXAMPLES 💅

Some examples, bestie:

Overriding the caspar-supplied DSSSL files: Create your own print.dls and html.dsl, in the same directory as your Docbook XML files. Your Makefile should read:

PRINT_DSL = print.dsl
HTML_DSL = html.dsl
include caspar/mk/docbook.mk

Overriding the standard html-to-text convertor:

$ W3M=lynx make svejk.txt

slay. ✨

---

🧚 FILES 🧚

caspar/mk/docbook.mk, caspar/mk/pod.mk, caspar/mk/markdown.mk.

---

⭐ ENVIRONMENT ⭐

For docbook.mk:

• files: XMLDCL, HTML_DSL, PRINT_DSL
• utilities: JADE, PDFJADETEX, PDFLATEX, JADETEX, LATEX, W3M, DVIPS, PSNUP, LPR, GV
• settings: JADE_MAXERRORS

These variables can get adjusted in Makefile, as well as in the shell environment.

The files pod.mk and markdown.mk use no environment variables.

💀 not a single one. they're low maintenance. we love that for them.

---

💖 AUTHOR 💖

Joost van Baal-Ilić

---

🌟 SEE ALSO 🌟

• caspar(7) [1]
• perlpod(1) about Perl's Plain Old Documentation format

[2] DocBook: The Definitive Guide on http://docbook.org/,

[3] The LaTeX Project Homepage on http://www.latex-project.org/.

[4] John Gruber's Markdown homepage on https://daringfireball.net/projects/markdown/.

Some comments on advanced usage are in the files docbook.mk and pod.mk itself.

---

and that's the whole page, bestie!! this was caspar-typesetting, version 20220907, dated 7 сеп 2022 — yeah the date's in Serbian, we don't question it, we just respect it. 🎀 go forth and make something cute. iykyk. 💜✨