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 \-e ", " \-\^\-expand
37 Enable character entity expansion (e.g. '>' becomes '>').
39 .BR \-f ", " \-\^\-nofade
40 Disable color fading in 256 color mode.
42 .BR \-i ", " \-\^\-invert
43 Swap black and white color.
45 .BR \-t ", " \-\^\-notrans
46 Disable transparency in transparent terminal.
48 .SS "Miscellaneous Options"
50 .BR \-d ", " \-\^\-debug
51 Enable debug messages on STDERR. Add multiple times to increases debug level.
53 .BR \-h ", " \-\^\-help
54 Display usage message and exit.
56 .BR \-v ", " \-\^\-version
57 Display version and license information.
59 .SH ENVIRONMENT VARIABLES
62 .BR MDP_LIST_HEAD[1-3],\ MDP_LIST_OPEN[1-3]
63 Controls the list characters of unordered lists.
65 The default is equivalent to:
79 .SH MARKDOWN FORMATTING
80 For a complete list of supported markups, refer the sample presentation
81 (sample.md) provided alongside
83 or online available at
84 .IR https://github.com/visit1985/mdp .
88 is split into multiple slides by horizontal rules. Each consisting of at least
93 characters on a single line.
94 .B This line must be prefixed by an completely empty line.
95 It can also contain spaces but no other characters.
97 If any slide is too large to fit into your current screen, an error message
98 will be displayed at the moment the presentation is launched.
100 .SS "Line-by-Line Mode"
101 .SS "Block-by-Block Mode"
103 .BR "<br>" ", " "<BR>" " or " "^"
104 on an otherwise empty line signals
106 to stop output of the current slide (stop point) and wait for a key-press by
109 This enables the user to display bullet points or list items one by one
110 (line by line) or block by block.
114 supports header lines in the format of
115 .BR @ "[DESCRIPTION] " [VALUE]
116 The first two header lines are displayed as title and author in top and
119 Headers are only recognized at the top of the input
122 .SS "Line spanning markup"
123 Supported are headlines, code blocks, quotes and unordered lists.
126 As well as bold text, underlined text and in-line code.
129 Most terminals are able to display 256 colors these days. But some of them
130 enable only 16 colors by default. To enjoy
132 full capabilities, these terminals need to be signaled to enable 256 color
133 mode. This is usually done by setting the TERM environment variable.
135 .BR "export TERM=xterm-256color"
137 .SH KEYBOARD CONTROLS
139 .BR "h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down"
140 Display next/previous slide or continue after a stop point.
156 This key is disabled if input was read from standard input.
163 Written by Michael Goehler and others, see
164 .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
166 Copyright (C) 2016 Michael Goehler
168 This is free software; see the source for copying conditions. There is NO
169 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.