diff options
| -rw-r--r-- | Makefile | 7 | ||||
| -rw-r--r-- | man/CMakeLists.txt | 18 | ||||
| -rw-r--r-- | man/man1/cmark.1 | 34 |
3 files changed, 52 insertions, 7 deletions
@@ -21,13 +21,13 @@ JSMODULES=$(wildcard js/lib/*.js) .PHONY: all spec leakcheck clean fuzztest dingus upload jshint test testjs benchjs update-site upload-site check npm debug mingw archive tarball ziparchive testarchive testtarball testziparchive testlib bench apidoc -all: $(BUILDDIR) $(SRCDIR)/html/html_unescape.h $(SRCDIR)/case_fold_switch.inc +all: $(BUILDDIR) @make -C $(BUILDDIR) check: @cmake --version > /dev/null || (echo "You need cmake to build this program: http://www.cmake.org/download/" && exit 1) -$(BUILDDIR): check +$(BUILDDIR): check $(SRCDIR)/html/html_unescape.h $(SRCDIR)/case_fold_switch.inc man/man1/cmark.1 mkdir -p $(BUILDDIR); \ cd $(BUILDDIR); \ cmake .. -G "$(GENERATOR)" -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) @@ -71,6 +71,9 @@ clean: $(PROG): all +man/man1/cmark.1: man/cmark.1.md + mkdir -p man/man1 && pandoc -t man -s $< -o $@ + apidoc: src/cmark.h doxygen Doxyfile diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt index ddffc8d..4aba777 100644 --- a/man/CMakeLists.txt +++ b/man/CMakeLists.txt @@ -5,12 +5,20 @@ add_custom_target(manpages ALL DEPENDS ${MANDEST}/man1/cmark.1 ) +# This is a temporary fallback until we get a cmark-based +# build procedure for the man pages: add_custom_command(OUTPUT ${MANDEST}/man1/cmark.1 - DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/cmark.1.md - COMMAND pandoc "-s" "-t" "man" - ${CMAKE_CURRENT_SOURCE_DIR}/cmark.1.md - -o ${MANDEST}/man1/cmark.1 - VERBATIM) + DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/man1/cmark.1 + COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/man1/cmark.1 + ${MANDEST}/man1/cmark.1 VERBATIM +) + +# add_custom_command(OUTPUT ${MANDEST}/man1/cmark.1 +# DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/cmark.1.md +# COMMAND pandoc "-s" "-t" "man" +# ${CMAKE_CURRENT_SOURCE_DIR}/cmark.1.md +# "-o" ${MANDEST}/man1/cmark.1 +# VERBATIM) INSTALL(FILES ${MANDEST}/man1/cmark.1 DESTINATION share/man/man1) diff --git a/man/man1/cmark.1 b/man/man1/cmark.1 new file mode 100644 index 0000000..3681456 --- /dev/null +++ b/man/man1/cmark.1 @@ -0,0 +1,34 @@ +.TH "cmark" "1" "October 22, 2014" "cmark manual" "" +.SH NAME +.PP +cmark \- convert CommonMark formatted text to HTML +.SH SYNOPSIS +.PP +cmark [\f[I]options\f[]] [file*] +.SH DESCRIPTION +.PP +\f[C]cmark\f[] acts as a pipe, reading from stdin or from the specified +files and writing to stdout. +It converts Markdown formatted plain text to HTML, using the conventions +described in the CommonMark spec. +If multiple files are specified, the contents of the files are simply +concatenated before parsing. +.SH OPTIONS +.TP +.B \f[C]\-\-ast\f[] +Print an abstract syntax tree instead of HTML. +.RS +.RE +.TP +.B \f[C]\-\-help\f[] +Print usage information. +.RS +.RE +.TP +.B \f[C]\-\-version\f[] +Print version. +.RS +.RE +.SH AUTHORS +.PP +John MacFarlane |