aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2022-06-10 23:46:50 +0200
committerJohn Ankarström <john@ankarstrom.se>2022-06-10 23:46:50 +0200
commit92e817ce5417406006701f0c7060f8c692148fe6 (patch)
treec8d27cb51ca622d1cf2545919a4b2830899d287c /README
parentbe7d65efa1ca204f4aa78c054f25f612769eacee (diff)
downloadlightroff-92e817ce5417406006701f0c7060f8c692148fe6.tar.gz
Use UTF-8 encoding for README.
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 12 insertions, 12 deletions
diff --git a/README b/README
index 0c3b9f5..466345a 100644
--- a/README
+++ b/README
@@ -10,17 +10,17 @@
Xroff, an alternative troff syntax
- John Ankarstrm
+ John Ankarström
Introduction
Xroff is an alternative syntax for troff, visually inspired
-by SGML/XML. It differs from troff's default syntax in the
+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-
+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.*
2. Xroff requests may be used inline. The following works as
@@ -31,7 +31,7 @@ following ways:
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-
+XML, xroff is unstructured and imperative. There is no con‐
cept of closing tags.
Example
@@ -51,10 +51,10 @@ Example
wisi nec facilisis facilisis, est dui fermentum leo, quis tempor
ligula erat quis odio. Nunc porta vulputate tellus.
------------
+───────────
* For comparison, default troff requests begin
with a newline and a control character, usually a
-period or an apostrophe, and end with another new-
+period or an apostrophe, and end with another new‐
line.
** Before an inline request, xroff automatically
inserts a \c escape when appropriate.
@@ -67,23 +67,23 @@ inserts a \c escape when appropriate.
- -2-
+ ‐2‐
Xroff
The program xroff translates xroff source to troff source.
-Xroff-mode
+Xroff‐mode
-For Emacs users, there is a major mode named xroff-mode that
+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-
+improve the writing experience, I also recommend olivetti‐
mode.
Caveats
-Xroff does not treat indented lines specially. As such, in-
+Xroff does not treat indented lines specially. As such, in‐
dentation cannot be used to convey structure.