Warning, /education/cantor/thirdparty/discount-2.2.6-patched/markdown.1 is written in an unsupported language. File is not indexed.
0001 .\" %A% 0002 .\" 0003 .Dd January 7, 2008 0004 .Dt MARKDOWN 1 0005 .Os MASTODON 0006 .Sh NAME 0007 .Nm markdown 0008 .Nd text to html conversion tool 0009 .Sh SYNOPSIS 0010 .Nm 0011 .Op Fl d 0012 .Op Fl T 0013 .Op Fl V 0014 .Op Fl b Ar url-base 0015 .Op Fl C Ar prefix 0016 .Op Fl F Pa bitmap 0017 .Op Fl f Ar flags 0018 .Op Fl n 0019 .Op Fl o Pa file 0020 .Op Fl S 0021 .Op Fl s Pa text 0022 .Op Fl t Pa text 0023 .Op Pa textfile 0024 .Sh DESCRIPTION 0025 The 0026 .Nm 0027 utility reads the 0028 .Xr markdown 7 Ns -formatted 0029 .Pa textfile 0030 .Pq or stdin if not specified, 0031 compiles it, and writes the html output 0032 to stdout. 0033 .Pp 0034 The options are as follows: 0035 .Bl -tag -width "-o file" 0036 .It Fl b Ar url-base 0037 Links in source beginning with / will be prefixed with 0038 .Ar url-base 0039 in the output. 0040 .It Fl C 0041 When processing markdown extra-style footnotes, use the 0042 given prefix instead of the default of 0043 .Ar fn . 0044 .It Fl d 0045 Instead of writing the html file, dump a parse 0046 tree to stdout. 0047 .It Fl f Ar flags 0048 Set or clear various translation flags. The flags 0049 are in a comma-delimited list, with an optional 0050 .Ar + 0051 (enable), 0052 .Ar - 0053 (disable), or 0054 .Ar no 0055 (disable) lprefix on each flag. 0056 .Bl -tag -width "definitionlist" 0057 .It Ar links 0058 Allow links. 0059 .It Ar image 0060 Allow images. 0061 .It Ar smarty 0062 Enable smartypants. 0063 .It Ar pants 0064 Enable smartypants. 0065 .It Ar html 0066 Allow raw html. 0067 .It Ar strict 0068 Disable superscript, strikethrough & relaxed emphasis. 0069 .It Ar ext 0070 Enable pseudo-protocols. 0071 .It Ar cdata 0072 Generate code for xml 0073 .Em ![CDATA[...]] . 0074 .It Ar superscript 0075 Enable superscript processing. 0076 .It Ar emphasis 0077 Emphasis happens 0078 .Em everywhere . 0079 .It Ar tables 0080 Don't process PHP Markdown Extra tables. 0081 .It Ar del 0082 Enable 0083 .Em ~~strikethrough~~ . 0084 .It Ar strikethrough 0085 Enable 0086 .Em ~~strikethrough~~ . 0087 .It Ar toc 0088 Enable table-of-contents processing. 0089 .It Ar 1.0 0090 Compatibility with MarkdownTest_1.0 0091 .It Ar autolink 0092 Make 0093 .Pa http://foo.com 0094 a link even without 0095 .Em <> . 0096 .It Ar safelink 0097 Paranoid check for link protocol. 0098 .It Ar header 0099 Process pandoc-style header blocks. 0100 .It Ar tabstop 0101 Expand tabs to 4 spaces. 0102 .It Ar divquote 0103 Allow 0104 .Pa >%class% 0105 blocks. 0106 .It Ar alphalist 0107 Allow alphabetic lists. 0108 .It Ar definitionlist 0109 Allow definition lists at all (default). Use 0110 .Em dldiscount 0111 and 0112 .Em dlextra 0113 to control which syntaxes are respected. 0114 .It Ar dldiscount 0115 Enable discount-style definition lists (default). 0116 .It Ar dlextra 0117 Enable extra-style definition lists (not default). Both styles may be enabled simultaneously. 0118 .It Ar footnote 0119 Allow markdown extra-style footnotes. 0120 .It Ar style 0121 Extract <style> blocks from the output. 0122 .It Ar fencedcode 0123 Allow fenced code blocks (not default). 0124 .It Ar idanchor 0125 Use id= anchors for table-of-contents links instead of <a name=/> (not default). 0126 .It Ar githubtags 0127 Allow underscore and dash in passed through element names (not default). 0128 .It Ar urlencodedanchor 0129 Use url-encoded chars for multibyte and nonalphanumeric chars rather than dots in toc links. 0130 .El 0131 .Pp 0132 As an example, the option 0133 .Fl f Ar nolinks,smarty 0134 tells 0135 .Nm 0136 to not allow \<a tags, and to do smarty 0137 pants processing. 0138 .It Fl F Ar bitmap 0139 Set translation flags. 0140 .Ar Bitmap 0141 is a bit map of the various configuration options 0142 described in 0143 .Xr markdown 3 0144 (the flag values are defined in 0145 .Pa mkdio.h ) 0146 .It Fl n 0147 Don't write generated html. 0148 .It Fl o Pa file 0149 Write the generated html to 0150 .Pa file . 0151 .It Fl S 0152 output <style> blocks. 0153 .It Fl V 0154 Show the version# and compile-time configuration data. 0155 .Pp 0156 If the version includes the string 0157 .Em DEBUG , 0158 .Nm 0159 was configured with memory allocation debugging. 0160 .Pp 0161 If the version includes the string 0162 .Em TAB , 0163 .Nm 0164 was configured to use the specified tabstop. 0165 .It Fl VV 0166 Show the version#, the compile-time configuration, and the 0167 run-time configuration. 0168 .It Fl t Ar text 0169 Use 0170 .Xr mkd_text 3 0171 to format 0172 .Ar text 0173 instead of processing stdin with the 0174 .Xr markdown 3 0175 function. 0176 .It Fl T 0177 If run with the table-of-content flag on, dump the 0178 table of contents before the formatted text. 0179 .It Fl s Ar text 0180 Use the 0181 .Xr markdown 3 0182 function to format 0183 .Ar text . 0184 .El 0185 .Sh RETURN VALUES 0186 The 0187 .Nm 0188 utility exits 0 on success, and >0 if an error occurs. 0189 .Sh SEE ALSO 0190 .Xr markdown 3 , 0191 .Xr markdown 7 , 0192 .Xr mkd-extensions 7 . 0193 .Sh AUTHOR 0194 .An David Parsons 0195 .Pq Li orc@pell.portland.or.us