1 .\" This is the groff documentation source for MDP
3 .\" Preview with: groff -man -Tascii mdp.1
8 .TH SMDP 1 "2016-04-02" "User Commands"
10 smdp \- A suckless 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.
28 aimed to be more configurable and simple, please check out the original project too!
34 The input file from which the presentation is read. If no file is specified,
35 or if the file name is
37 the presentation is read from standard input.
40 .BR \-c ", " \-\^\-nocodebg
41 Don't change the background color of code blocks.
43 .BR \-e ", " \-\^\-expand
44 Enable character entity expansion (e.g. '>' becomes '>').
46 .BR \-s ", " \-\^\-noslidenum
47 Do not show slide number at the bottom.
49 .BR \-x ", " \-\^\-noslidemax
50 Show slide number, but not total number of slides.
52 .SS "Miscellaneous Options"
54 .BR \-d ", " \-\^\-debug
55 Enable debug messages on STDERR. Add multiple times to increases debug level.
57 .BR \-h ", " \-\^\-help
58 Display usage message and exit.
60 .BR \-v ", " \-\^\-version
61 Display version and license information.
63 .SH ENVIRONMENT VARIABLES
66 .BR MDP_LIST_HEAD[1-3],\ MDP_LIST_OPEN[1-3]
67 Controls the list characters of unordered lists.
69 The default is equivalent to:
83 .SH MARKDOWN FORMATTING
84 For a complete list of supported markups, refer the sample presentation
85 (sample.md) provided alongside
87 or online available at
88 .IR https://github.com/MrPicklePinosaur/smdp .
92 is split into multiple slides by horizontal rules. Each consisting of at least
97 characters on a single line.
98 .B This line must be prefixed by an completely empty line.
99 It can also contain spaces but no other characters.
101 If any slide is too large to fit into your current screen, an error message
102 will be displayed at the moment the presentation is launched.
104 .SS "Line-by-Line Mode"
105 .SS "Block-by-Block Mode"
107 .BR "<br>" ", " "<BR>" " or " "^"
108 on an otherwise empty line signals
110 to stop output of the current slide (stop point) and wait for a key-press by
113 This enables the user to display bullet points or list items one by one
114 (line by line) or block by block.
118 supports header lines in the format of
119 .BR @ "[DESCRIPTION] " [VALUE]
120 The first two header lines are displayed as title and author in top and
123 Headers are only recognized at the top of the input
126 .SS "Line spanning markup"
127 Supported are headlines, code blocks, quotes and unordered lists.
130 As well as bold text, underlined text and in-line code.
133 Most terminals are able to display 256 colors these days. But some of them
134 enable only 16 colors by default. To enjoy
136 full capabilities, these terminals need to be signaled to enable 256 color
137 mode. This is usually done by setting the TERM environment variable.
139 .BR "export TERM=xterm-256color"
141 .SH KEYBOARD CONTROLS
143 .BR "h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down"
144 Display next/previous slide or continue after a stop point.
160 This key is disabled if input was read from standard input.
168 can be configured by modifying config.h and recompiling.
170 Written by Michael Goehler and others, see
171 .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
172 Forked and modified by pinosaur.
174 Copyright (C) 2018 Michael Goehler
176 This is free software; see the source for copying conditions. There is NO
177 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.