README.addescape

   1 $Id: README.addescape,v 1.1 2009/03/03 21:07:01 kristaps Exp $
   2
   3 This documents adding a new character escape to mdocterm(1).  Character
   4 escapes are only syntax-validated in the back-end.
   5
   6 Character escape may be in the form of \*x, \*(xx, \x, \(xx, \[n] and so
   7 on and so on.  All of these are recognised according to their byte
   8 length.
   9
  10 (1) If the escape is NOT recognised in enum tsym in term.h, add it.
  11
  12 (2) Modify/create static struct termenc termencN, where N is the number
  13 of characters in the encoding.  This is in mdocterm.c.
  14
  15 (3) Possibly modify nescape() to recognise a new termencN.
  16
  17 Everything else is automatic.