diff options
| author |   schwarze <schwarze@openbsd.org> | 2017-03-08 19:40:46 +0000 |
|---|---|---|
| committer | schwarze <schwarze@openbsd.org> | 2017-03-08 19:40:46 +0000 |
| commit | 7f384ba5e4ff68280d66b461eb2c6f84fa02b218 (patch) | |
| tree | a33f5485818c1f1134461f48f721a14aefbdad44 /usr.bin/mandoc/mandoc.1 | |
| parent | format string mishandling (diff) | |
| download | wireguard-openbsd-7f384ba5e4ff68280d66b461eb2c6f84fa02b218.tar.xz wireguard-openbsd-7f384ba5e4ff68280d66b461eb2c6f84fa02b218.zip | |
Document that -T markdown produces ASCII output, and the implied
limitations. Of course, we could write UTF-8 output instead,
but even the CommonMark specification doesn't require parsers
to support that, so portability would be doubtful.
While here, provide a link to the CommonMark specification.
Diffstat (limited to 'usr.bin/mandoc/mandoc.1')
| -rw-r--r-- | usr.bin/mandoc/mandoc.1 | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/usr.bin/mandoc/mandoc.1 b/usr.bin/mandoc/mandoc.1 index e60f1fec44f..6981414e8ef 100644 --- a/usr.bin/mandoc/mandoc.1 +++ b/usr.bin/mandoc/mandoc.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mandoc.1,v 1.101 2017/03/06 17:25:24 schwarze Exp $ +.\" $OpenBSD: mandoc.1,v 1.102 2017/03/08 19:40:46 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: March 6 2017 $ +.Dd $Mdocdate: March 8 2017 $ .Dt MANDOC 1 .Os .Sh NAME @@ -465,6 +465,16 @@ input to the format conforming to .Lk http://daringfireball.net/projects/markdown/syntax.text\ "John Gruber's 2004 specification" . +The output also almost conforms to the +.Lk http://commonmark.org/ CommonMark +specification. +.Pp +The character set used for the markdown output is ASCII. +Non-ASCII characters are encoded as HTML entities. +Since that is not possible in literal font contexts, because these +are rendered as code spans and code blocks in the markdown output, +non-ASCII characters are transliterated to ASCII approximations in +these contexts. .Pp Markdown is a very weak markup language, so all semantic markup is lost, and even part of the presentational markup may be lost. |