1 .\" This is the groff documentation source for MDP
3 .\" Preview with: groff -man -Tascii mdp.1
8 .TH MDP 1 "2016-02-07" "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 \-f ", " \-\^\-nofade
37 Disable color fading in 256 color mode.
39 .BR \-i ", " \-\^\-invert
40 Swap black and white color.
42 .BR \-t ", " \-\^\-notrans
43 Disable transparency in transparent terminal.
45 .SS "Miscellaneous Options"
47 .BR \-d ", " \-\^\-debug
48 Enable debug messages on STDERR. Add multiple times to increases debug level.
50 .BR \-h ", " \-\^\-help
51 Display usage message and exit.
53 .BR \-v ", " \-\^\-version
54 Display version and license information.
56 .SH MARKDOWN FORMATTING
57 For a complete list of supported markups, refer the sample presentation
58 (sample.md) provided alongside
60 or online available at
61 .IR https://github.com/visit1985/mdp .
65 is split into multiple slides by horizontal rules. Each consisting of at least
70 characters on a single line.
71 .B This line must be prefixed by an completely empty line.
72 It can also contain spaces but no other characters.
74 If any slide is too large to fit into your current screen, an error message
75 will be displayed at the moment the presentation is launched.
77 .SS "Line-by-Line Mode"
78 .SS "Block-by-Block Mode"
80 .BR "<br>" ", " "<BR>" " or " "^"
81 on an otherwise empty line signals
83 to stop output of the current slide (stop point) and wait for a key-press by
86 This enables the user to display bullet points or list items one by one
87 (line by line) or block by block.
91 supports header lines in the format of
92 .BR @ "[DESCRIPTION] " [VALUE]
93 The first two header lines are displayed as title and author in top and
96 Headers are only recognized at the top of the input
99 .SS "Line spanning markup"
100 Supported are headlines, code blocks, quotes and unordered lists.
103 As well as bold text, underlined text and in-line code.
106 Most terminals are able to display 256 colors these days. But some of them
107 enable only 16 colors by default. To enjoy
109 full capabilities, these terminals need to be signaled to enable 256 color
110 mode. This is usually done by setting the TERM environment variable.
112 .BR "export TERM=xterm-256color"
114 .SH KEYBOARD CONTROLS
116 .BR "h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down"
117 Display next/previous slide or continue after a stop point.
133 This key is disabled if input was read from standard input.
140 Written by Michael Goehler and others, see
141 .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
143 Copyright (C) 2016 Michael Goehler
145 This is free software; see the source for copying conditions. There is NO
146 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.