aboutsummaryrefslogtreecommitdiff
path: root/man/man1/cmark.1
blob: c425b8cae3c456534f8afb995feb133bccbac3c2 (plain)
  1. .TH "cmark" "1" "November 30, 2014" "LOCAL" "General Commands Manual"
  2. .SH "NAME"
  3. \fBcmark\fR
  4. \- convert CommonMark formatted text to HTML
  5. .SH "SYNOPSIS"
  6. .HP 6n
  7. \fBcmark\fR
  8. [\fB\-\-ast\fR]
  9. file*
  10. .SH "DESCRIPTION"
  11. \fBcmark\fR
  12. acts as a pipe, reading from
  13. \fRstdin\fR
  14. or from the specified files and writing to
  15. \fRstdout\fR.
  16. It converts Markdown formatted plain text to HTML (or groff man or
  17. an abstract representation of the AST), using the conventions
  18. described in the CommonMark spec.
  19. If multiple files are specified, the contents of the files are simply
  20. concatenated before parsing.
  21. .SH "OPTIONS"
  22. .TP 12n
  23. \-\-to, \-t \f[I]FORMAT\f[]
  24. Specify output format (\f[C]html\f[], \f[C]man\f[], \f[C]ast\f[]).
  25. .TP 12n
  26. \-\-sourcepos
  27. Include source position attribute.
  28. .TP 12n
  29. \-\-hardbreaks
  30. Treat newlines as hard line breaks.
  31. .TP 12n
  32. \-\-normalize
  33. Consolidate adjacent text nodes.
  34. .TP 12n
  35. \-\-help
  36. Print usage information.
  37. .TP 12n
  38. \-\-version
  39. Print version.
  40. .SH "AUTHORS"
  41. John MacFarlane