discount-2.2.6-patched/Plan9/README.md

0001 # *Discount* Markdown compiler on Plan 9
0002
0003 ## Build
0004     % CONFIG='--with-tabstops=7' mk config
0005     % mk test
0006     % mk install
0007     % markdown -V
0008     markdown: discount X.Y.Z TAB=7
0009
0010 ### Configuration
0011 To select features and extensions, `--with-tabstops=7` may be replaced by zero or more of:
0012
0013 * `--enable-pandoc-header`:  Use pandoc-style header blocks
0014 * `--enable-superscript`:  `A^B` becomes A<sup>B</sup>
0015 * `--enable-amalloc`:  Enable memory allocation debugging
0016 * `--with-tabstops=`*N*:  Set tabstops to *N* characters (default 4)
0017 * `--enable-alpha-list`:  Enable `(a)/(b)/(c)` list markers
0018 * `--enable-all-features`:  Turn on all stable optional features
0019
0020 ## Notes
0021 1. This is not a port from POSIX to native Plan 9 APIs. The supplied
0022 `mkfile` merely drives Discount's own `configure.sh` through Plan 9's
0023 *APE* environment (in *pcc*(1)) to build the Discount source, then
0024 copies the result to locations appropriate for system-wide use on
0025 Plan 9.
0026
0027 2. There are a few other *mk*(1) targets:
0028     * `install.libs`:  Discount includes a C library and header.
0029 Installation is optional.  Plan 9 binaries are statically linked.
0030     * `install.man`:  Add manual pages for *markdown* in sections 1, 2, and 6.
0031     * `install.progs`:  Extra programs.  *makepage* writes complete XHTML
0032 documents, rather than fragments.  *mkd2html* is similar, but produces
0033 HTML.