cmark

My personal build of CMark ✏️

cmark.1 (2459B)

 1 .TH "cmark" "1" "Feburary 11, 2020" "LOCAL" "General Commands Manual"
 2 .SH "NAME"
 3 \fBcmark\fR
 4 \- convert CommonMark formatted text to HTML
 5 .SH "SYNOPSIS"
 6 .HP 6n
 7 \fBcmark\fR
 8 [options]
 9 file*
10 .SH "DESCRIPTION"
11 \fBcmark\fR
12 converts Markdown formatted plain text to either HTML, groff man,
13 CommonMark XML, LaTeX, or CommonMark, using the conventions
14 described in the CommonMark spec.  It reads input from \fIstdin\fR
15 or the specified files (concatenating their contents) and writes
16 output to \fIstdout\fR.
17 .SH "OPTIONS"
18 .TP 12n
19 .B \-\-to, \-t \f[I]FORMAT\f[]
20 Specify output format (\f[C]html\f[], \f[C]man\f[], \f[C]xml\f[],
21 \f[C]latex\f[], \f[C]commonmark\f[]).
22 .TP 12n
23 .B \-\-width \f[I]WIDTH\f[]
24 Specify a column width to which to wrap the output. For no wrapping, use
25 the value 0 (the default).  This option currently only affects the
26 commonmark, latex, and man renderers.
27 .TP 12n
28 .B \-\-hardbreaks
29 Render soft breaks (newlines inside paragraphs in the CommonMark source)
30 as hard line breaks in the target format.  If this option is specified,
31 hard wrapping is disabled for CommonMark output, regardless of the value
32 given with \-\-width.
33 .TP 12n
34 .B \-\-nobreaks
35 Render soft breaks as spaces.  If this option is specified,
36 hard wrapping is disabled for all output formats, regardless of the value
37 given with \-\-width.
38 .TP 12n
39 .B \-\-sourcepos
40 Include source position attribute.
41 .TP 12n
42 .B \-\-validate-utf8
43 Validate UTF-8, replacing illegal sequences with U+FFFD.
44 .TP 12n
45 .B \-\-smart
46 Use smart punctuation.  Straight double and single quotes will
47 be rendered as curly quotes, depending on their position.
48 \f[C]\-\-\f[] will be rendered as an en-dash.
49 \f[C]\-\-\-\f[] will be rendered as an em-dash.
50 \f[C]...\f[] will be rendered as ellipses.
51 .TP 12n
52 .B \-\-safe
53 Omit raw HTML and potentially dangerous URLs (default).
54 Raw HTML is replaced by a placeholder comment
55 and potentially dangerous URLs are replaced by empty strings.
56 Potentially dangerous URLs are those that begin with `javascript:`,
57 `vbscript:`, `file:`, or `data:` (except for `image/png`,
58 `image/gif`, `image/jpeg`, or `image/webp` mime types).
59 .TP 12n
60 .B \-\-unsafe
61 Render raw HTML or potentially dangerous URLs, overriding
62 the default (\-\-safe) behavior.
63 .TP 12n
64 .B \-\-help
65 Print usage information.
66 .TP 12n
67 .B \-\-version
68 Print version.
69 .SH "AUTHORS"
70 John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.
71 .SH "SEE ALSO"
72 .PP
73 CommonMark spec:  \f[C]https://spec.commonmark.org\f[].