diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b94efee --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +# temporary compile results +*.o + +# Binary excutions +mdp +mdp.exe + +# Other temporary files +.DS_Store +.idea +*~ +*.swp +*.sublime-workspace +*.out +tags diff --git a/Makefile b/Makefile index 0db1ec6..02ef0fc 100644 --- a/Makefile +++ b/Makefile @@ -65,6 +65,7 @@ install -m 644 mdp.1 $(DESTDIR)$(PREFIX)/share/man/man1/$(TARGET).1 uninstall: - $(RM) $(DESTDIR)$(PREFIX)/$(TARGET) + $(RM) $(DESTDIR)$(PREFIX)/bin/$(TARGET) + $(RM) $(DESTDIR)$(PREFIX)/share/man/man1/$(TARGET).1 .PHONY: all clean install src uninstall diff --git a/README.md b/README.md index c05f04a..7d390d7 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ $ make install $ mdp sample.md -- On Arch, you can use the existing [AUR package](https://aur.archlinux.org/packages/mdp-git/). +- On Arch Linux, you can use the existing [package](https://www.archlinux.org/packages/community/x86_64/mdp/). - on Cygwin you can use the existing [package](https://cygwin.com/cgi-bin2/package-grep.cgi?grep=mdp.exe) from the setup program. - On Debian, you can use the existing [DEB package](https://tracker.debian.org/pkg/mdp-src), or run `apt-get install mdp`. - On FreeBSD, you can use the port [misc/mdp](http://www.freshports.org/misc/mdp). diff --git a/include/cstack.h b/include/cstack.h index e762c90..18608f3 100644 --- a/include/cstack.h +++ b/include/cstack.h @@ -23,8 +23,8 @@ * * struct: cstack_t which defines char stack type in heap memory * - * function: cstack_init to intialize struct of type cstack_t - * function: cstack_t->push to add one char on top if the stack + * function: cstack_init to initialize struct of type cstack_t + * function: cstack_t->push to add one char on top of the stack * function: cstack_t->pop to remove the top char from the stack * function: cstack_t->top to test if the top char is a given char * function: cstack_t->empty to test if the stack is empty diff --git a/include/cstring.h b/include/cstring.h index 1940596..f0314fb 100644 --- a/include/cstring.h +++ b/include/cstring.h @@ -23,7 +23,7 @@ * * struct: cstring_t which defines a expandable c string type in heap memory * - * function: cstring_init to intialize struct of type cstring_t + * function: cstring_init to initialize struct of type cstring_t * function: cstring_t->expand to add one character to the struct * function: cstring_t->expand_arr to add a string to the struct * function: cstring_t->strip to remove a substring diff --git a/include/markdown.h b/include/markdown.h index 8e33c8e..d353896 100644 --- a/include/markdown.h +++ b/include/markdown.h @@ -21,7 +21,7 @@ * along with this program. If not, see . * * - * enum: line_bitmask which enumerates markdown formating bits + * enum: line_bitmask which enumerates markdown formatting bits * * struct: deck_t the root object representing a deck of slides * struct: slide_t a linked list element of type slide contained in a deck diff --git a/include/parser.h b/include/parser.h index afc736e..751afdd 100644 --- a/include/parser.h +++ b/include/parser.h @@ -25,7 +25,7 @@ * * function: markdown_load is the main function which reads a file handle, * and initializes deck, slides and lines - * function: markdown_analyse which is used to identify line wide formating + * function: markdown_analyse which is used to identify line wide formatting * rules in given line * function: markdown_debug to print a report of the generated data structure * function: adjust_line_length to calculate line length excluding markup diff --git a/include/url.h b/include/url.h index 330e4be..34c5bc9 100644 --- a/include/url.h +++ b/include/url.h @@ -20,7 +20,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . * - * function: url_init to intialize a new url object + * function: url_init to initialize a new url object */ typedef struct _url_t { diff --git a/include/viewer.h b/include/viewer.h index 1b2b509..2dbc266 100644 --- a/include/viewer.h +++ b/include/viewer.h @@ -25,7 +25,7 @@ * * function: ncurses_display initializes ncurses, defines colors, calculates * window geometry and handles key strokes - * function: add_line detects inline markdown formating and prints line char + * function: add_line detects inline markdown formatting and prints line char * by char * function: fade_in, fade_out implementing color fading in 256 color mode * function: int_length to calculate decimal length of slide count diff --git a/mdp.1 b/mdp.1 index 700eb32..f40e43e 100644 --- a/mdp.1 +++ b/mdp.1 @@ -33,6 +33,9 @@ the presentation is read from standard input. .SS "Output Control" .TP +.BR \-c ", " \-\^\-nocodebg +Don't change the background color of code blocks. +.TP .BR \-e ", " \-\^\-expand Enable character entity expansion (e.g. '>' becomes '>'). .TP @@ -42,8 +45,14 @@ .BR \-i ", " \-\^\-invert Swap black and white color. .TP +.BR \-s ", " \-\^\-noslidenum +Do not show slide number at the bottom. +.TP .BR \-t ", " \-\^\-notrans Disable transparency in transparent terminal. +.TP +.BR \-x ", " \-\^\-noslidemax +Show slide number, but not total number of slides. . .SS "Miscellaneous Options" .TP diff --git a/sample.md b/sample.md index 502bb2b..88bcd34 100644 --- a/sample.md +++ b/sample.md @@ -102,7 +102,7 @@ -> # Supported markdown formatting <- -You can also use [pandoc](http://pandoc.org/demo/example9/pandocs-markdown.html)'s fenced code block +You can also use [pandoc](https://pandoc.org/MANUAL.html#fenced-code-blocks)'s fenced code block extension. Use at least three ~ chars to open and at least as many or more ~ for closing.