.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8. .TH CM2XETEX "1" "December 2018" "recommonmark (Debian 0.4.0+ds-5)" "recommonmark Python package" .SH NAME cm2xetex \- convert CommonMark file to XeTeX source .SH SYNOPSIS .B cm2xetex [\fI\,options\/\fR] [\fI\, \/\fR[\fI\,\/\fR]] .SH DESCRIPTION Generate xetex document from markdown sources. Reads from (default is stdin) and writes to (default is stdout). See 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 Use 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 Remove all elements with classes="" from the document tree. Warning: potentially dangerous; use with caution. (Multiple\-use option.) .TP \fB\-\-strip\-class=\fR Remove all classes="" attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple\-use option.) .TP \fB\-\-report=\fR, \fB\-r\fR Report system messages at or higher than : "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 Halt execution at system messages at or above . 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 Enable a non\-zero exit status for non\-halting system messages at or above . 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 Send the output of system messages to . .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, \fB\-i\fR Specify the encoding and optionally the error handler of input text. Default: :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, \fB\-o\fR 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, \fB\-e\fR 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, \fB\-l\fR Specify the language (as BCP 47 language tag). Default: en. .TP \fB\-\-record\-dependencies=\fR Write output file dependencies to . .TP \fB\-\-config=\fR Read configuration settings from , 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. .SS "LaTeX-Specific Options:" .TP \fB\-\-documentclass\fR=\fI\,DOCUMENTCLASS\/\fR Specify documentclass. Default is "article". .TP \fB\-\-documentoptions\fR=\fI\,DOCUMENTOPTIONS\/\fR Specify document options. Multiple options can be given, separated by commas. Default is "a4paper". .TP \fB\-\-docutils\-footnotes\fR Footnotes with numbers/symbols by Docutils. (default) .TP \fB\-\-footnote\-references=\fR Format for footnote references: one of "superscript" or "brackets". Default is "superscript". .TP \fB\-\-use\-latex\-citations\fR Use \ecite command for citations. .TP \fB\-\-figure\-citations\fR Use figure floats for citations (might get mixed with real figures). (default) .TP \fB\-\-attribution=\fR Format for block quote attributions: one of "dash" (em\-dash prefix), "parentheses"/"parens", or "none". Default is "dash". .TP \fB\-\-stylesheet=\fR Specify LaTeX packages/stylesheets. A style is referenced with \eusepackage if extension is ".sty" or omitted and with \einput else. Overrides previous \fB\-\-stylesheet\fR and \fB\-\-stylesheet\-path\fR settings. .TP \fB\-\-stylesheet\-path=\fR Comma separated list of LaTeX packages/stylesheets. Relative paths are expanded if a matching file is found in the \fB\-\-stylesheet\-dirs\fR. With \fB\-\-linkstylesheet\fR, the path is rewritten relative to the output *.tex file. .TP \fB\-\-link\-stylesheet\fR Link to the stylesheet(s) in the output file. (default) .TP \fB\-\-embed\-stylesheet\fR Embed the stylesheet(s) in the output file. Stylesheets must be accessible during processing. .TP \fB\-\-stylesheet\-dirs=\fR Comma\-separated list of directories where stylesheets are found. Used by \fB\-\-stylesheet\-path\fR when expanding relative path arguments. Default: "." .TP \fB\-\-latex\-preamble\fR=\fI\,LATEX_PREAMBLE\/\fR Customization by LaTeX code in the preamble. Default: select PDF standard fonts (Times, Helvetica, Courier). .TP \fB\-\-template=\fR Specify the template file. Default: "default.tex". .TP \fB\-\-use\-latex\-toc\fR Table of contents by LaTeX. (default) .TP \fB\-\-use\-docutils\-toc\fR Table of contents by Docutils (without page numbers). .TP \fB\-\-use\-part\-section\fR Add parts on top of the section hierarchy. .TP \fB\-\-use\-docutils\-docinfo\fR Attach author and date to the document info table. (default) .TP \fB\-\-use\-latex\-docinfo\fR Attach author and date to the document title. .TP \fB\-\-topic\-abstract\fR Typeset abstract as topic. (default) .TP \fB\-\-use\-latex\-abstract\fR Use LaTeX abstract environment for the document's abstract. .TP \fB\-\-hyperlink\-color\fR=\fI\,HYPERLINK_COLOR\/\fR Color of any hyperlinks embedded in text (default: "blue", "false" to disable). .TP \fB\-\-hyperref\-options\fR=\fI\,HYPERREF_OPTIONS\/\fR Additional options to the "hyperref" package (default: ""). .TP \fB\-\-compound\-enumerators\fR Enable compound enumerators for nested enumerated lists (e.g. "1.2.a.ii"). Default: disabled. .TP \fB\-\-no\-compound\-enumerators\fR Disable compound enumerators for nested enumerated lists. This is the default. .TP \fB\-\-section\-prefix\-for\-enumerators\fR Enable section ("." subsection ...) prefixes for compound enumerators. This has no effect without \fB\-\-compound\-enumerators\fR.Default: disabled. .TP \fB\-\-no\-section\-prefix\-for\-enumerators\fR Disable section prefixes for compound enumerators. This is the default. .TP \fB\-\-section\-enumerator\-separator=\fR Set the separator between section number and enumerator for compound enumerated lists. Default is "\-". .TP \fB\-\-literal\-block\-env\fR=\fI\,LITERAL_BLOCK_ENV\/\fR When possible, use the specified environment for literal\-blocks. Default is quoting of whitespace and special chars. .TP \fB\-\-use\-verbatim\-when\-possible\fR When possible, use verbatim for literal\-blocks. Compatibility alias for "\-\-literal\-blockenv=verbatim". .TP \fB\-\-table\-style=\fR Table style. "standard" with horizontal and vertical lines, "booktabs" (LaTeX booktabs style) only horizontal lines above and below the table and below the header or "borderless". Default: "standard" .TP \fB\-\-graphicx\-option\fR=\fI\,GRAPHICX_OPTION\/\fR LaTeX graphicx package option. Possible values are "dvips", "pdftex". "auto" includes LaTeX code to use "pdftex" if processing with pdf(la)tex and dvips otherwise. Default is no option. .TP \fB\-\-font\-encoding\fR=\fI\,FONT_ENCODING\/\fR LaTeX font encoding. Possible values are "", "T1" (default), "OT1", "LGR,T1" or any other combination of options to the `fontenc` package. .TP \fB\-\-reference\-label\fR=\fI\,REFERENCE_LABEL\/\fR Per default the latex\-writer puts the reference title into hyperreferences. Specify "ref*" or "pageref*" to get the section number or the page number. .TP \fB\-\-use\-bibtex\fR=\fI\,USE_BIBTEX\/\fR Specify style and database for bibtex, for example "\-\- use\-bibtex=mystyle,mydb1,mydb2". .SH AUTHOR Steve Genoud and Luca Barbato .SH COPYRIGHT Copyright (C) 2014 Steve Genoud and Luca Barbato