karchnu/groff-template
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
This repository is a template for troff documents. Here is the product, once compiled: https://t.karchnu.fr/doc/grofftut.pdf
13 Commits 2 Branches 0 Tags 315 KiB
Roff 64.1%
Perl 19.2%
Shell 10.4%
Makefile 6.3%
2d7efc21fd
Go to file
Karchnu 2d7efc21fd Readme: how to compile.
2022-01-07 16:33:14 +01:00
bin Notes on troffrc + groff options. 2022-01-07 13:32:50 +01:00
.source-highlight_groff-output-definition First commit. 2021-10-11 05:57:55 +02:00
are-you.pdf First commit. 2021-10-11 05:57:55 +02:00
bibliography First commit. 2021-10-11 05:57:55 +02:00
grofftut.ms Small fixes (-P -e and image), eqn mentioned in the readme. 2022-01-07 10:36:37 +01:00
header.ms Header: date fixed. 2022-01-07 09:40:32 +01:00
macros.ms New macros. 2022-01-07 09:40:23 +01:00
Makefile main -> grofftut 2021-10-29 04:43:52 +02:00
Makefile.in Notes on troffrc + groff options. 2022-01-07 13:32:50 +01:00
README.md Readme: how to compile. 2022-01-07 16:33:14 +01:00

README.md

Troff template (batteries included)

This repository is an introduction to the good old tools to produce documents:

  • roff as the language to describe documents (groff is the implementation)
  • tbl and hdtbl for tables
  • eqn for math equations
  • pic for drawing images
  • grap for drawing graphs
  • refer for handling references and bibliography
  • etc.

It also includes a few examples of custom macros and images.

Furthermore, this repository includes:

  • UTF-8 characters translation into ms macros (via a script)
  • source code highlight (via the source-highlight software and a script)
  • A makefile to automatically call every tool in right order; just type make!

How to compile

You need groff installed on your system, and source-highlight (or remove the right line in the makefile).

Then:

make

If you have entr on your system, you can also recompile your file each time you modify it:

make serve

Read the makefile for more options.

Preview

https://t.karchnu.fr/doc/grofftut.pdf

(Read this document on a PDF viewer, not directly in your browser!)

Limitations

Images are poorly handled, and they aren't easily managed with roff by default. Some macros exist to do it properly, but it still is to include in custom macros then to document.

Browser preview is ugly as fuck. It may have something to do with font embedding, I have to investigate, but right now you just can't have a nice preview on a browser.