chubek / roff-dossier Goto Github PK

In this repository, you'll find riches if you are a typesetting nerd, and a UNIX geek, like me.

The aim of this document is to help people understand ROFF, and its uses beyond that of manpages -- which is being slowly superceded by mandoc(1) anyways.

1. First, in the 'documents' directory:

• Short History of ROFF
• The Terse Syntax of ROFF
• Macros in ROFF
• Escape Sequences in ROFF
• Registers in ROFF
• ROFF and UNIX Manpages

2. And then, head to the 'datasets' directory to find CSV datasets of:

• Reqeusts aka Commands
• Escape Sequences
• Pre-defined Registers
• Keywords (GROFF-only)

(All these come with a short description, mind you -- The requests have their signature)

3. And finally, there are several examples in the examples directory. You can process them with GROFF. For example, to make PDF from them:

cat document.roff | groff -Tpdf

To just print them out to your terminal:

cat document.roff | groff -Tascii | less

The 'roff-utils' directory just contains a very WIP Scheme script. I will add stuff to it later. If you wish to stay alert about additions, changes, etc to this repository, start it perhaps?

I am working on an implementation of ROFF.

My email: chubakbidpaa [at] riseup [dot] net.

Take care.

Sony PS 1: If you liked this, take a gander at my PostScript dossier. I have a lot of projects cooking, like atm, I am working on 'RuppVM', a stack machine with Green threads, FFI, and stop-the-world GC I already have the ISA half-baked. Here is where RuppVM will reside til the end of time!. Also, it goes without saying, check my Github profile homepage here.

Sony PS 2: I don't really like hosting on Github. But it's the only way to be 'seen' you know?