aboutsummaryrefslogtreecommitdiff
path: root/man/man1/cmark.1
blob: 368145615eff38df06a9fc2a1c1051450d625687 (plain)
  1. .TH "cmark" "1" "October 22, 2014" "cmark manual" ""
  2. .SH NAME
  3. .PP
  4. cmark \- convert CommonMark formatted text to HTML
  5. .SH SYNOPSIS
  6. .PP
  7. cmark [\f[I]options\f[]] [file*]
  8. .SH DESCRIPTION
  9. .PP
  10. \f[C]cmark\f[] acts as a pipe, reading from stdin or from the specified
  11. files and writing to stdout.
  12. It converts Markdown formatted plain text to HTML, using the conventions
  13. described in the CommonMark spec.
  14. If multiple files are specified, the contents of the files are simply
  15. concatenated before parsing.
  16. .SH OPTIONS
  17. .TP
  18. .B \f[C]\-\-ast\f[]
  19. Print an abstract syntax tree instead of HTML.
  20. .RS
  21. .RE
  22. .TP
  23. .B \f[C]\-\-help\f[]
  24. Print usage information.
  25. .RS
  26. .RE
  27. .TP
  28. .B \f[C]\-\-version\f[]
  29. Print version.
  30. .RS
  31. .RE
  32. .SH AUTHORS
  33. .PP
  34. John MacFarlane