https://github.com/chubek/roff-dossier
A dossier on the ROFF page formatting and typesetting language
https://github.com/chubek/roff-dossier
csv-dataset documents groff linux-manpages markdown nroff posix roff troff typesetting unix-manpages
Last synced: 10 months ago
JSON representation
A dossier on the ROFF page formatting and typesetting language
- Host: GitHub
- URL: https://github.com/chubek/roff-dossier
- Owner: Chubek
- Created: 2024-05-07T00:09:59.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T13:54:30.000Z (about 2 years ago)
- Last Synced: 2024-05-10T14:27:23.091Z (about 2 years ago)
- Topics: csv-dataset, documents, groff, linux-manpages, markdown, nroff, posix, roff, troff, typesetting, unix-manpages
- Language: Scheme
- Homepage:
- Size: 346 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### ROFF: Not Just for Manpages!
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.
#### Your Guide to this Repository
1. First, in the 'documents' directory:
* [Short History of ROFF](documents/ROFF-HISTORY.md)
* [The Terse Syntax of ROFF](documents/ROFF-SYNTAX.md)
* [Macros in ROFF](documents/ROFF-MACROS.md)
* [Escape Sequences in ROFF](documents/ROFF-ESCAPES.md)
* [Registers in ROFF](documents/ROFF-REGISTERS.md)
* [ROFF and UNIX Manpages](documents/ROFF-MANPAGES.md)
2. And then, head to the 'datasets' directory to find CSV datasets of:
* [Reqeusts aka Commands](datasets/roff-requests.csv)
* [Escape Sequences](datasets/roff-escapes.csv)
* [Pre-defined Registers](datasets/roff-registers.csv)
* [Keywords (GROFF-only)](datasets/roff-filekw.csv)
(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](github.com/Chubek/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!](github.com/Chubek/RuppVM). Also, it goes without saying, check my Github profile homepage [here](github.com/Chubek).
Sony PS 2: I don't really like hosting on Github. But it's the only way to be 'seen' you know?