aboutsummaryrefslogtreecommitdiff
path: root/man/man1/cmark.1
blob: 41185207c46f285fdd0b238ccea263f8996332e7 (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, using the conventions
  17. described in the CommonMark spec.
  18. If multiple files are specified, the contents of the files are simply
  19. concatenated before parsing.
  20. .SH "OPTIONS"
  21. .TP 12n
  22. \-\--ast
  23. Print an abstract syntax tree instead of HTML.
  24. .TP 12n
  25. \-\-help
  26. Print usage information.
  27. .TP 12n
  28. \-\-version
  29. Print version.
  30. .SH "AUTHORS"
  31. John MacFarlane