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