.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH CM2MAN "1" "December 2018" "recommonmark (Debian 0.4.0+ds-5)" "recommonmark Python package"
.SH NAME
cm2man \- convert CommonMark file to man page
.SH SYNOPSIS
.B cm2man
[\fI\,options\/\fR] [\fI\,<source> \/\fR[\fI\,<destination>\/\fR]]
.SH DESCRIPTION
Generate a manpage from markdown sources. Reads from <source> (default is
stdin) and writes to <destination> (default is stdout).  See
<http://docutils.sf.net/docs/user/config.html> for the full reference.
.SH OPTIONS
.SS "General Docutils Options:"
.TP
\fB\-\-title\fR=\fI\,TITLE\/\fR
Specify the document title as metadata.
.TP
\fB\-\-generator\fR, \fB\-g\fR
Include a "Generated by Docutils" credit and link.
.TP
\fB\-\-no\-generator\fR
Do not include a generator credit.
.TP
\fB\-\-date\fR, \fB\-d\fR
Include the date at the end of the document (UTC).
.TP
\fB\-\-time\fR, \fB\-t\fR
Include the time & date (UTC).
.TP
\fB\-\-no\-datestamp\fR
Do not include a datestamp of any kind.
.TP
\fB\-\-source\-link\fR, \fB\-s\fR
Include a "View document source" link.
.TP
\fB\-\-source\-url=\fR<URL>
Use <URL> for a source link; implies \fB\-\-source\-link\fR.
.TP
\fB\-\-no\-source\-link\fR
Do not include a "View document source" link.
.TP
\fB\-\-toc\-entry\-backlinks\fR
Link from section headers to TOC entries.  (default)
.TP
\fB\-\-toc\-top\-backlinks\fR
Link from section headers to the top of the TOC.
.TP
\fB\-\-no\-toc\-backlinks\fR
Disable backlinks to the table of contents.
.TP
\fB\-\-footnote\-backlinks\fR
Link from footnotes/citations to references. (default)
.TP
\fB\-\-no\-footnote\-backlinks\fR
Disable backlinks from footnotes and citations.
.TP
\fB\-\-section\-numbering\fR
Enable section numbering by Docutils.  (default)
.TP
\fB\-\-no\-section\-numbering\fR
Disable section numbering by Docutils.
.TP
\fB\-\-strip\-comments\fR
Remove comment elements from the document tree.
.TP
\fB\-\-leave\-comments\fR
Leave comment elements in the document tree. (default)
.TP
\fB\-\-strip\-elements\-with\-class=\fR<class>
Remove all elements with classes="<class>" from the
document tree. Warning: potentially dangerous; use
with caution. (Multiple\-use option.)
.TP
\fB\-\-strip\-class=\fR<class>
Remove all classes="<class>" attributes from elements
in the document tree. Warning: potentially dangerous;
use with caution. (Multiple\-use option.)
.TP
\fB\-\-report=\fR<level>, \fB\-r\fR <level>
Report system messages at or higher than <level>:
"info" or "1", "warning"/"2" (default), "error"/"3",
"severe"/"4", "none"/"5"
.TP
\fB\-\-verbose\fR, \fB\-v\fR
Report all system messages.  (Same as "\-\-report=1".)
.TP
\fB\-\-quiet\fR, \fB\-q\fR
Report no system messages.  (Same as "\-\-report=5".)
.TP
\fB\-\-halt=\fR<level>
Halt execution at system messages at or above <level>.
Levels as in \fB\-\-report\fR.  Default: 4 (severe).
.TP
\fB\-\-strict\fR
Halt at the slightest problem.  Same as "\-\-halt=info".
.TP
\fB\-\-exit\-status=\fR<level>
Enable a non\-zero exit status for non\-halting system
messages at or above <level>.  Default: 5 (disabled).
.TP
\fB\-\-debug\fR
Enable debug\-level system messages and diagnostics.
.TP
\fB\-\-no\-debug\fR
Disable debug output.  (default)
.TP
\fB\-\-warnings=\fR<file>
Send the output of system messages to <file>.
.TP
\fB\-\-traceback\fR
Enable Python tracebacks when Docutils is halted.
.TP
\fB\-\-no\-traceback\fR
Disable Python tracebacks.  (default)
.TP
\fB\-\-input\-encoding=\fR<name[:handler]>, \fB\-i\fR <name[:handler]>
Specify the encoding and optionally the error handler
of input text.  Default: <locale\-dependent>:strict.
.TP
\fB\-\-input\-encoding\-error\-handler\fR=\fI\,INPUT_ENCODING_ERROR_HANDLER\/\fR
Specify the error handler for undecodable characters.
Choices: "strict" (default), "ignore", and "replace".
.TP
\fB\-\-output\-encoding=\fR<name[:handler]>, \fB\-o\fR <name[:handler]>
Specify the text encoding and optionally the error
handler for output.  Default: UTF\-8:strict.
.TP
\fB\-\-output\-encoding\-error\-handler\fR=\fI\,OUTPUT_ENCODING_ERROR_HANDLER\/\fR
Specify error handler for unencodable output
characters; "strict" (default), "ignore", "replace",
"xmlcharrefreplace", "backslashreplace".
.TP
\fB\-\-error\-encoding=\fR<name[:handler]>, \fB\-e\fR <name[:handler]>
Specify text encoding and error handler for error
output.  Default text encoding: system encoding.
Default error handler: backslashreplace.
.TP
\fB\-\-error\-encoding\-error\-handler\fR=\fI\,ERROR_ENCODING_ERROR_HANDLER\/\fR
Specify the error handler for unencodable characters
in error output.  Default: backslashreplace.
.TP
\fB\-\-language=\fR<name>, \fB\-l\fR <name>
Specify the language (as BCP 47 language tag).
Default: en.
.TP
\fB\-\-record\-dependencies=\fR<file>
Write output file dependencies to <file>.
.TP
\fB\-\-config=\fR<file>
Read configuration settings from <file>, if it exists.
.TP
\fB\-\-version\fR, \fB\-V\fR
Show this program's version number and exit.
.TP
\fB\-\-help\fR, \fB\-h\fR
Show this help message and exit.
.SS "Standalone Reader:"
.TP
\fB\-\-no\-doc\-title\fR
Disable the promotion of a lone top\-level section
title to document title (and subsequent section title
to document subtitle promotion; enabled by default).
.TP
\fB\-\-no\-doc\-info\fR
Disable the bibliographic field list transform
(enabled by default).
.TP
\fB\-\-section\-subtitles\fR
Activate the promotion of lone subsection titles to
section subtitles (disabled by default).
.TP
\fB\-\-no\-section\-subtitles\fR
Deactivate the promotion of lone subsection titles.
.SH AUTHOR
Steve Genoud and Luca Barbato
.SH COPYRIGHT
Copyright (C) 2014 Steve Genoud and Luca Barbato