X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=mdp.1;h=01f2e7eb3a04c44f39a57bcf0b2c21efe8af843d;hb=96277f3ca3bb80c44eb559b782cdd7044cd71514;hp=9361e4f2e76a5fe9888ac62d70bf8fa3ac800f1e;hpb=0d91be86340f056df1590280fd3b3507ac23120f;p=smdp.git diff --git a/mdp.1 b/mdp.1 index 9361e4f..01f2e7e 100644 --- a/mdp.1 +++ b/mdp.1 @@ -5,7 +5,7 @@ .\" . . -.TH MDP 1 "2015-04-10" "User Commands" +.TH MDP 1 "2016-04-02" "User Commands" .SH NAME mdp \- A command-line based markdown presentation tool @@ -33,22 +33,48 @@ or if the file name is the presentation is read from standard input. .SS "Output Control" .TP -.BR \-f ", " \-\^\-nofade -Disable color fading in 256 color mode. +.BR \-c ", " \-\^\-nocodebg +Don't change the background color of code blocks. .TP -.BR \-i ", " \-\^\-invert -Swap black and white color. +.BR \-e ", " \-\^\-expand +Enable character entity expansion (e.g. '>' becomes '>'). .TP -.BR \-t ", " \-\^\-notrans -Disable transparency in transparent terminal. +.BR \-s ", " \-\^\-noslidenum +Do not show slide number at the bottom. +.TP +.BR \-x ", " \-\^\-noslidemax +Show slide number, but not total number of slides. . .SS "Miscellaneous Options" .TP +.BR \-d ", " \-\^\-debug +Enable debug messages on STDERR. Add multiple times to increases debug level. +.TP .BR \-h ", " \-\^\-help Display usage message and exit. .TP -.BR \-d ", " \-\^\-debug -Enable debug messages on STDERR. Add multiple times to increases debug level. +.BR \-v ", " \-\^\-version +Display version and license information. +. +.SH ENVIRONMENT VARIABLES +.SS "Output Control" +.TP +.BR MDP_LIST_HEAD[1-3],\ MDP_LIST_OPEN[1-3] +Controls the list characters of unordered lists. + +The default is equivalent to: +.br +MDP_LIST_OPEN1=' | ' +.br +MDP_LIST_OPEN2=' | ' +.br +MDP_LIST_OPEN3=' | ' +.br +MDP_LIST_HEAD1=' +- ' +.br +MDP_LIST_HEAD2=' +- ' +.br +MDP_LIST_HEAD3=' +- ' . .SH MARKDOWN FORMATTING For a complete list of supported markups, refer the sample presentation @@ -133,11 +159,14 @@ This key is disabled if input was read from standard input. Exit .BR mdp "." . +.SH CUSTOMIZATION +.B mdp +can be configured by modifying config.h and recompiling. .SH AUTHOR Written by Michael Goehler and others, see .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "." .SH COPYRIGHT -Copyright (C) 2015 Michael Goehler +Copyright (C) 2018 Michael Goehler .PP This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.