diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 48 |
1 files changed, 24 insertions, 24 deletions
@@ -7,7 +7,7 @@ - Xroff, an alternative troff syntax + Lightroff, an alternative troff syntax John Ankarström @@ -15,24 +15,24 @@ Introduction -Xroff is an alternative syntax for troff, visually inspired -by SGML/XML. It differs from troff’s default syntax in the -following ways: +Lightroff is an alternative syntax for troff, visually in‐ +spired by SGML/XML. It differs from troff’s default syntax +in the following ways: -1. Xroff requests begin with a less‐than sign and end with a - greater‐than sign, e.g., <SH 1>. These symbols may be es‐ - caped with a backslash.* +1. Lightroff requests begin with a less‐than sign and end + with a greater‐than sign, e.g., <SH 1>. These symbols may + be escaped with a backslash.* -2. Xroff requests may be used inline. The following works as - expected: (<ft B>bold<ft R>).** +2. Lightroff requests may be used inline. The following + works as expected: (<ft B>bold<ft R>).** -3. Xroff ignores empty lines. +3. Lightroff ignores empty lines. 4. Default troff syntax may be used between <![ and ]>. The similarities with XML end at the visual level. Unlike -XML, xroff is unstructured and imperative. There is no con‐ -cept of closing tags. +XML, lightroff is unstructured and imperative. There is no +concept of closing tags. Example @@ -56,8 +56,8 @@ Example with a newline and a control character, usually a period or an apostrophe, and end with another new‐ line. - ** Before an inline request, xroff automatically -inserts a \c escape when appropriate. + ** Before an inline request, lightroff automati‐ +cally inserts a \c escape when appropriate. @@ -70,22 +70,22 @@ inserts a \c escape when appropriate. ‐2‐ -Xroff +Lightroff -The program xroff translates xroff source to troff source. +The program lightroff translates lightroff source to troff +source. -Xroff‐mode +Lightroff‐mode -For Emacs users, there is a major mode named xroff‐mode that -provides syntax highlighting for xroff source. To further -improve the writing experience, I also recommend olivetti‐ -mode. +For Emacs users, there is a major mode named lightroff‐mode +that provides syntax highlighting for lightroff source. To +further improve the writing experience, I also recommend +olivetti‐mode. Caveats -Xroff does not treat indented lines specially. As such, in‐ -dentation cannot be used to convey structure. - +Lightroff does not treat indented lines specially. As such, +indentation cannot be used to convey structure. |