discount-2.2.6-patched/Plan9/markdown.1

0001 .TH MARKDOWN 1
0002 .SH NAME
0003 markdown \- convert Markdown text to HTML
0004 .SH SYNOPSIS
0005 .B markdown
0006 [
0007 .B -dTV
0008 ]
0009 [
0010 .BI -b " url-base
0011 ]
0012 [
0013 .BI -F " bitmap
0014 ]
0015 [
0016 .BI -f " flags
0017 ]
0018 [
0019 .BI -o " ofile
0020 ]
0021 [
0022 .BI -s " text
0023 ]
0024 [
0025 .BI -t " text
0026 ]
0027 [
0028 .I file
0029 ]
0030 .SH DESCRIPTION
0031 The
0032 .I markdown
0033 utility reads the
0034 .IR Markdown (6)-formatted
0035 .I file
0036 (or standard input) and writes its
0037 .SM HTML
0038 fragment representation on standard output.
0039 .PP
0040 The options are:
0041 .TF dfdoptions
0042 .TP
0043 .BI -b " url-base
0044 Links in source begining with
0045 .B /
0046 will be prefixed with
0047 .I url-base
0048 in the output.
0049 .TP
0050 .B -d
0051 Instead of printing an
0052 .SM HTML
0053 fragment, print a parse tree.
0054 .TP
0055 .BI -F " bitmap
0056 Set translation flags.
0057 .I Bitmap
0058 is a bit map of the various configuration options described in
0059 .IR markdown (2).
0060 .TP
0061 .BI -f " flags
0062 Set or clear various translation
0063 .IR flags ,
0064 described below.
0065 .I Flags
0066 are in a comma-delimited list, with an optional
0067 .B +
0068 (set) prefix on each flag.
0069 .TP
0070 .BI -o " ofile
0071 Write the generated
0072 .SM HTML
0073 to
0074 .IR ofile .
0075 .TP
0076 .BI -s " text
0077 Use the
0078 .IR markdown (2)
0079 function to format the
0080 .I text
0081 on standard input.
0082 .TP
0083 .B -T
0084 Under
0085 .B -f
0086 .BR toc ,
0087 print the table of contents as an unordered list before the usual
0088 .SM HTML
0089 output.
0090 .TP
0091 .BI -t " text
0092 Use
0093 .IR mkd_text
0094 (in
0095 .IR markdown (2))
0096 to format
0097 .I text
0098 instead of processing standard input with
0099 .IR markdown .
0100 .TP
0101 .B -V
0102 Show version number and configuration. If the version includes the string
0103 .BR DL_TAG ,
0104 .I markdown
0105 was configured with definition list support. If the version includes the string
0106 .BR HEADER ,
0107 .I markdown
0108 was configured to support pandoc header blocks.
0109 .PD
0110 .SS TRANSLATION FLAGS
0111 The translation flags understood by
0112 .B -f
0113 are:
0114 .TF \ noheader
0115 .TP
0116 .B noimage
0117 Don't allow image tags.
0118 .TP
0119 .B nolinks
0120 Don't allow links.
0121 .TP
0122 .B nohtml
0123 Don't allow any embedded HTML.
0124 .TP
0125 .B cdata
0126 Generate valid XML output.
0127 .TP
0128 .B noheader
0129 Do not process pandoc headers.
0130 .TP
0131 .B notables
0132 Do not process the syntax extension for tables.
0133 .TP
0134 .B tabstops
0135 Use Markdown-standard 4-space tabstops.
0136 .TP
0137 .B strict
0138 Disable superscript and relaxed emphasis.
0139 .TP
0140 .B relax
0141 Enable superscript and relaxed emphasis (the default).
0142 .TP
0143 .B toc
0144 Enable table of contents support, generated from headings (in
0145 .IR markdown (6))
0146 in the source.
0147 .TP
0148 .B 1.0
0149 Revert to Markdown 1.0 compatibility.
0150 .PD
0151 .PP
0152 For example,
0153 .B -f nolinks,quot
0154 tells
0155 .I markdown
0156 not to allow
0157 .B <a>
0158 tags, and to expand double quotes.
0159 .SH SOURCE
0160 .B /sys/src/cmd/discount
0161 .SH SEE ALSO
0162 .IR markdown (2),
0163 .IR markdown (6)
0164 .PP
0165 http://daringfireball.net/projects/markdown/,
0166 ``Markdown''.
0167 .SH DIAGNOSTICS
0168 .I Markdown
0169 exits 0 on success and >0 if an error occurs.