brennen
/
text-markdown-discount


								.\"     %A%

								.\"

								.Dd January 7, 2008

								.Dt MARKDOWN 1

								.Os MASTODON

								.Sh NAME

								.Nm markdown

								.Nd text to html conversion tool

								.Sh SYNOPSIS

								.Nm

								.Op Fl d

								.Op Fl T

								.Op Fl V

								.Op Fl b Ar url-base

								.Op Fl F Pa bitmap

								.Op Fl f Ar flags

								.Op Fl o Pa file

								.Op Fl s Pa text

								.Op Fl t Pa text

								.Op Pa textfile

								.Sh DESCRIPTION

								The

								.Nm

								utility reads the

								.Xr markdown 7 Ns -formatted

								.Pa textfile

								.Pq or stdin if not specified,

								compiles it, and writes the html output

								to stdout.

								.Pp

								The options are as follows:

								.Bl -tag -width "-o file"

								.It Fl b Ar url-base

								Links in source begining with / will be prefixed with

								.Ar url-base

								in the output.

								.It Fl d

								Instead of writing the html file, dump a parse

								tree to stdout.

								.It Fl f Ar flags

								Set or clear various translation flags.   The flags

								are in a comma-delimited list, with an optional

								.Ar +

								(set) prefix on each flag.

								.Bl -tag -width "NOHEADER"

								.It Ar noimage

								Don't allow image tags.

								.It Ar nolinks

								Don't allow links.

								.It Ar nohtml

								Don't allow

								.B any

								embedded html.

								.It Ar cdata

								Generate valid XML output.

								.It Ar noheader

								Do not process pandoc headers.

								.It Ar notables

								Do not process Markdown Extra-style tables.

								.It Ar tabstops

								Use markdown-standard 4-space tabstops.

								@STRICT@.It Ar strict

								@STRICT@Disable superscript and relaxed emphasis.

								@STRICT@.It Ar relax

								@STRICT@Enable superscript and relaxed emphasis (this is the default.)

								.It Ar toc

								Enable table-of-contents support

								.It Ar 1.0

								Revert to Markdown 1.0 compatability.

								.El

								.Pp

								As an example, the option

								.Fl f Ar nolinks,quot

								tells

								.Nm

								to not allow \<a tags, and to expand

								double-quotes.

								.It Fl F Ar bitmap

								Set translation flags.

								.Ar Bitmap

								is a bit map of the various configuration options

								described in

								.Xr markdown 3

								(the flag values are defined in

								.Pa mkdio.h )

								.It Fl V

								Show the version# and configuration data.

								.Pp

								If the version includes the string

								.Em DL_TAG ,

								.Nm

								was configured with definition list support.

								.Pp

								If the version includes the string

								.Em HEADER ,

								.Nm

								was configured to support pandoc header blocks.

								.It Fl o Pa file

								Write the generated html to

								.Pa file .

								.It Fl t Ar text

								Use

								.Xr mkd_text 3

								to format

								.Ar text

								instead of processing stdin with the

								.Xr markdown 3

								function.

								.It Fl T

								If run with the table-of-content flag on, dump the

								table of contents before the formatted text.

								.It Fl s Ar text

								Use the

								.Xr markdown 3

								function to format

								.Ar text .

								.El

								.Sh RETURN VALUES

								The

								.Nm

								utility exits 0 on success, and >0 if an error occurs.

								.Sh SEE ALSO

								.Xr markdown 3 ,

								.Xr markdown 7 ,

								.Xr mkd-extensions 7 .

								.Sh AUTHOR

								.An David Parsons

								.Pq Li orc@pell.chi.il.us