1 .\" This is the groff documentation source for MDP
3 .\" Preview with: groff -man -Tascii mdp.1
8 .TH MDP 1 "2016-04-02" "User Commands"
10 mdp \- A command-line based
11 markdown presentation tool
14 .RI [ OPTION ].\|.\|.\|
19 is a command-line program that allows you to make elegant presentations from
23 It is as easy as write your presentation content in the text editor of your
24 preference and launch the presentation from the command-line.
30 The input file from which the presentation is read. If no file is specified,
31 or if the file name is
33 the presentation is read from standard input.
36 .BR \-c ", " \-\^\-nocodebg
37 Don't change the background color of code blocks.
39 .BR \-e ", " \-\^\-expand
40 Enable character entity expansion (e.g. '>' becomes '>').
42 .BR \-f ", " \-\^\-nofade
43 Disable color fading in 256 color mode.
45 .BR \-i ", " \-\^\-invert
46 Swap black and white color.
48 .BR \-s ", " \-\^\-noslidenum
49 Do not show slide number at the bottom.
51 .BR \-t ", " \-\^\-notrans
52 Disable transparency in transparent terminal.
54 .BR \-x ", " \-\^\-noslidemax
55 Show slide number, but not total number of slides.
57 .SS "Miscellaneous Options"
59 .BR \-d ", " \-\^\-debug
60 Enable debug messages on STDERR. Add multiple times to increases debug level.
62 .BR \-h ", " \-\^\-help
63 Display usage message and exit.
65 .BR \-v ", " \-\^\-version
66 Display version and license information.
68 .SH ENVIRONMENT VARIABLES
71 .BR MDP_LIST_HEAD[1-3],\ MDP_LIST_OPEN[1-3]
72 Controls the list characters of unordered lists.
74 The default is equivalent to:
88 .SH MARKDOWN FORMATTING
89 For a complete list of supported markups, refer the sample presentation
90 (sample.md) provided alongside
92 or online available at
93 .IR https://github.com/visit1985/mdp .
97 is split into multiple slides by horizontal rules. Each consisting of at least
102 characters on a single line.
103 .B This line must be prefixed by an completely empty line.
104 It can also contain spaces but no other characters.
106 If any slide is too large to fit into your current screen, an error message
107 will be displayed at the moment the presentation is launched.
109 .SS "Line-by-Line Mode"
110 .SS "Block-by-Block Mode"
112 .BR "<br>" ", " "<BR>" " or " "^"
113 on an otherwise empty line signals
115 to stop output of the current slide (stop point) and wait for a key-press by
118 This enables the user to display bullet points or list items one by one
119 (line by line) or block by block.
123 supports header lines in the format of
124 .BR @ "[DESCRIPTION] " [VALUE]
125 The first two header lines are displayed as title and author in top and
128 Headers are only recognized at the top of the input
131 .SS "Line spanning markup"
132 Supported are headlines, code blocks, quotes and unordered lists.
135 As well as bold text, underlined text and in-line code.
138 Most terminals are able to display 256 colors these days. But some of them
139 enable only 16 colors by default. To enjoy
141 full capabilities, these terminals need to be signaled to enable 256 color
142 mode. This is usually done by setting the TERM environment variable.
144 .BR "export TERM=xterm-256color"
146 .SH KEYBOARD CONTROLS
148 .BR "h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down"
149 Display next/previous slide or continue after a stop point.
165 This key is disabled if input was read from standard input.
172 Written by Michael Goehler and others, see
173 .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
175 Copyright (C) 2018 Michael Goehler
177 This is free software; see the source for copying conditions. There is NO
178 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.