aboutsummaryrefslogtreecommitdiff
path: root/README.t
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2022-06-15 18:29:41 +0200
committerJohn Ankarström <john@ankarstrom.se>2022-06-15 18:29:41 +0200
commitbda0c167e13282185609619c63dd0b12164ae3cf (patch)
tree4e55b1631730bf8dc9f565c3f6863436c0687468 /README.t
parent4b03365723a61dcad79e6df3052621382702f0b3 (diff)
downloadlightroff-master.tar.gz
Rename to lightroff.HEADmaster
Diffstat (limited to 'README.t')
-rw-r--r--README.t32
1 files changed, 16 insertions, 16 deletions
diff --git a/README.t b/README.t
index 7bc4f4a..35af93c 100644
--- a/README.t
+++ b/README.t
@@ -15,7 +15,7 @@
\\f(CB\\$*\\fR\c
..
.TL
-.bi Xroff
+.bi Lightroff
, an alternative troff syntax
.AU
John Ankarström
@@ -23,32 +23,32 @@ John Ankarström
.SH 1
Introduction
.LP
-.i Xroff
+.i Lightroff
is an alternative syntax for troff, visually inspired by SGML/XML. It differs from troff's default syntax in the following ways:
.IP 1. 3
-Xroff requests begin with a less-than sign and end with a greater-than sign, e.g., \c
+Lightroff requests begin with a less-than sign and end with a greater-than sign, e.g., \c
.cw \<SH 1>
\&. These symbols may be escaped with a backslash.*
.IP 2.
-Xroff requests may be used inline. The following works as expected: \c
-.cw "(\<ft B>bold\<ft R>)"
+Lightroff requests may be used inline. The following works as expected: \c
+.cw "(<ft B>bold<ft R>)"
\&.**
.IP 3.
-Xroff ignores empty lines.
+Lightroff ignores empty lines.
.IP 4.
Default troff syntax may be used between \c
-.cw \<![
+.cw <![
and \c
.cw ]>
\&.
.LP
-The similarities with XML end at the visual level. Unlike XML, xroff is unstructured and imperative. There is no concept of closing tags.
+The similarities with XML end at the visual level. Unlike XML, lightroff is unstructured and imperative. There is no concept of closing tags.
.FS *
For comparison, default troff requests begin with a newline and a control character, usually a period or an apostrophe, and end with another newline.\c
.FE
.FS **
Before an inline request, \c
-.cw xroff
+.cw lightroff
automatically inserts a \c
.cw \\\\c
escape when appropriate.\c
@@ -74,20 +74,20 @@ wisi nec facilisis facilisis, est dui fermentum leo, quis tempor
ligula erat quis odio. Nunc porta vulputate tellus.
.ec
.SH 1
-.cwb Xroff
+.cwb Lightroff
.PP
The program \c
-.cw xroff
- translates xroff source to troff source.
+.cw lightroff
+ translates lightroff source to troff source.
.SH 1
-.cwb Xroff-mode
+.cwb Lightroff-mode
.PP
For Emacs users, there is a major mode named \c
-.cw xroff-mode
- that provides syntax highlighting for xroff source. To further improve the writing experience, I also recommend \c
+.cw lightroff-mode
+ that provides syntax highlighting for lightroff source. To further improve the writing experience, I also recommend \c
.cw olivetti-mode
\&.
.SH 1
Caveats
.LP
-Xroff does not treat indented lines specially. As such, indentation cannot be used to convey structure.
+Lightroff does not treat indented lines specially. As such, indentation cannot be used to convey structure.