Scroll to navigation

CM2LATEX(1) recommonmark Python package CM2LATEX(1)

NAME

cm2latex - convert CommonMark file to LaTeX source

SYNOPSIS

cm2latex [options] [<source> [<destination>]]

DESCRIPTION

Generate latex document 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.

OPTIONS

General Docutils Options:

Specify the document title as metadata.
Include a "Generated by Docutils" credit and link.
Do not include a generator credit.
Include the date at the end of the document (UTC).
Include the time & date (UTC).
Do not include a datestamp of any kind.
Include a "View document source" link.
Use <URL> for a source link; implies --source-link.
Do not include a "View document source" link.
Link from section headers to TOC entries. (default)
Link from section headers to the top of the TOC.
Disable backlinks to the table of contents.
Link from footnotes/citations to references. (default)
Disable backlinks from footnotes and citations.
Enable section numbering by Docutils. (default)
Disable section numbering by Docutils.
Remove comment elements from the document tree.
Leave comment elements in the document tree. (default)
Remove all elements with classes="<class>" from the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)
Remove all classes="<class>" attributes from elements in the document tree. Warning: potentially dangerous; use with caution. (Multiple-use option.)
Report system messages at or higher than <level>: "info" or "1", "warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5"
Report all system messages. (Same as "--report=1".)
Report no system messages. (Same as "--report=5".)
Halt execution at system messages at or above <level>. Levels as in --report. Default: 4 (severe).
Halt at the slightest problem. Same as "--halt=info".
Enable a non-zero exit status for non-halting system messages at or above <level>. Default: 5 (disabled).
Enable debug-level system messages and diagnostics.
Disable debug output. (default)
Send the output of system messages to <file>.
Enable Python tracebacks when Docutils is halted.
Disable Python tracebacks. (default)
Specify the encoding and optionally the error handler of input text. Default: <locale-dependent>:strict.
Specify the error handler for undecodable characters. Choices: "strict" (default), "ignore", and "replace".
Specify the text encoding and optionally the error handler for output. Default: UTF-8:strict.
Specify error handler for unencodable output characters; "strict" (default), "ignore", "replace", "xmlcharrefreplace", "backslashreplace".
Specify text encoding and error handler for error output. Default: ascii:backslashreplace.
Specify the error handler for unencodable characters in error output. Default: backslashreplace.
Specify the language (as BCP 47 language tag). Default: en.
Write output file dependencies to <file>.
Read configuration settings from <file>, if it exists.
Show this program's version number and exit.
Show this help message and exit.

Standalone Reader:

Disable the promotion of a lone top-level section title to document title (and subsequent section title to document subtitle promotion; enabled by default).
Disable the bibliographic field list transform (enabled by default).
Activate the promotion of lone subsection titles to section subtitles (disabled by default).
Deactivate the promotion of lone subsection titles.

LaTeX-Specific Options:

Specify documentclass. Default is "article".
Specify document options. Multiple options can be given, separated by commas. Default is "a4paper".
Footnotes with numbers/symbols by Docutils. (default)
Alias for --docutils-footnotes (deprecated)
Use figure floats for footnote text (deprecated)
Format for footnote references: one of "superscript" or "brackets". Default is "superscript".
Use \cite command for citations.
Use figure floats for citations (might get mixed with real figures). (default)
Format for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". Default is "dash".
Specify LaTeX packages/stylesheets. A style is referenced with \usepackage if extension is ".sty" or omitted and with \input else. Overrides previous --stylesheet and --stylesheet-path settings.
Comma separated list of LaTeX packages/stylesheets. Relative paths are expanded if a matching file is found in the --stylesheet-dirs. With --linkstylesheet, the path is rewritten relative to the output *.tex file.
Link to the stylesheet(s) in the output file. (default)
Embed the stylesheet(s) in the output file. Stylesheets must be accessible during processing.
Comma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: "."
Customization by LaTeX code in the preamble. Default: select PDF standard fonts (Times, Helvetica, Courier).
Specify the template file. Default: "default.tex".
Table of contents by LaTeX. (default)
Table of contents by Docutils (without page numbers).
Add parts on top of the section hierarchy.
Attach author and date to the document info table. (default)
Attach author and date to the document title.
Typeset abstract as topic. (default)
Use LaTeX abstract environment for the document's abstract.
Color of any hyperlinks embedded in text (default: "blue", "false" to disable).
Additional options to the "hyperref" package (default: "").
Enable compound enumerators for nested enumerated lists (e.g. "1.2.a.ii"). Default: disabled.
Disable compound enumerators for nested enumerated lists. This is the default.
Enable section ("." subsection ...) prefixes for compound enumerators. This has no effect without --compound-enumerators.Default: disabled.
Disable section prefixes for compound enumerators. This is the default.
Set the separator between section number and enumerator for compound enumerated lists. Default is "-".
When possibile, use the specified environment for literal-blocks. Default is quoting of whitespace and special chars.
When possibile, use verbatim for literal-blocks. Compatibility alias for "--literal-blockenv=verbatim".
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"
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.
LaTeX font encoding. Possible values are "", "T1" (default), "OT1", "LGR,T1" or any other combination of options to the `fontenc` package.
Per default the latex-writer puts the reference title into hyperreferences. Specify "ref*" or "pageref*" to get the section number or the page number.
Specify style and database for bibtex, for example "--use-bibtex=mystyle,mydb1,mydb2".

AUTHOR

Steve Genoud and Luca Barbato

COPYRIGHT

Copyright (C) 2014 Steve Genoud and Luca Barbato

October 2016 recommonmark (Debian 0.4.0+ds-2)