color config for code blocks
[smdp.git] / smdp.1
1 .\" This is the groff documentation source for MDP
2 .\"
3 .\" Preview with: groff -man -Tascii mdp.1
4 .\"           or: man -l mdp.1
5 .\"
6 .
7 .
8 .TH SMDP 1 "2016-04-02" "User Commands"
9 .SH NAME
10 smdp \- A suckless command-line based
11 markdown presentation tool
12 .SH SYNOPSIS
13 .B smdp
14 .RI [ OPTION ].\|.\|.\|
15 .RI [ FILE ]
16 .
17 .SH DESCRIPTION
18 .B smdp
19 is a command-line program that allows you to make elegant presentations from
20 .B markdown formatted
21 .IR FILE s.
22 .PP
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.
25 .B smdp
26 is a fork of
27 .B mdp
28 aimed to be more configurable and simple, please check out the original project too!
29
30 .SH OPTIONS
31 .SS "Input Control"
32 .TP
33 .IR FILE
34 The input file from which the presentation is read. If no file is specified,
35 or if the file name is
36 .BR \- ","
37 the presentation is read from standard input.
38 .SS "Output Control"
39 .TP
40 .BR \-e ", " \-\^\-expand
41 Enable character entity expansion (e.g. '>' becomes '>').
42 .TP
43 .BR \-s ", " \-\^\-noslidenum
44 Do not show slide number at the bottom.
45 .TP
46 .BR \-x ", " \-\^\-noslidemax
47 Show slide number, but not total number of slides.
48 .
49 .SS "Miscellaneous Options"
50 .TP
51 .BR \-d ", " \-\^\-debug
52 Enable debug messages on STDERR. Add multiple times to increases debug level.
53 .TP
54 .BR \-h ", " \-\^\-help
55 Display usage message and exit.
56 .TP
57 .BR \-v ", " \-\^\-version
58 Display version and license information.
59 .
60 .SH ENVIRONMENT VARIABLES
61 .SS "Output Control"
62 .TP
63 .BR MDP_LIST_HEAD[1-3],\ MDP_LIST_OPEN[1-3]
64 Controls the list characters of unordered lists.
65
66 The default is equivalent to:
67 .br
68 MDP_LIST_OPEN1=' |  '
69 .br
70 MDP_LIST_OPEN2=' |  '
71 .br
72 MDP_LIST_OPEN3=' |  '
73 .br
74 MDP_LIST_HEAD1=' +- '
75 .br
76 MDP_LIST_HEAD2=' +- '
77 .br
78 MDP_LIST_HEAD3=' +- '
79 .
80 .SH MARKDOWN FORMATTING
81 For a complete list of supported markups, refer the sample presentation
82 (sample.md) provided alongside
83 .BR smdp ,\|
84 or online available at
85 .IR https://github.com/MrPicklePinosaur/smdp .
86 .SS "Slides"
87 The input
88 .IR FILE
89 is split into multiple slides by horizontal rules. Each consisting of at least
90 3
91 .B \-\-\-
92 or
93 .B ***
94 characters on a single line.
95 .B This line must be prefixed by an completely empty line.
96 It can also contain spaces but no other characters.
97 .PP
98 If any slide is too large to fit into your current screen, an error message
99 will be displayed at the moment the presentation is launched.
100 .
101 .SS "Line-by-Line Mode"
102 .SS "Block-by-Block Mode"
103 A single
104 .BR "<br>" ", " "<BR>" " or " "^"
105 on an otherwise empty line signals
106 .B smdp
107 to stop output of the current slide (stop point) and wait for a key-press by
108 the user.
109 .PP
110 This enables the user to display bullet points or list items one by one
111 (line by line) or block by block.
112 .
113 .SS "Headers"
114 .B smdp
115 supports header lines in the format of
116 .BR @ "[DESCRIPTION] " [VALUE]
117 The first two header lines are displayed as title and author in top and
118 bottom bar.
119 .PP
120 Headers are only recognized at the top of the input
121 .IR FILE .
122 .
123 .SS "Line spanning markup"
124 Supported are headlines, code blocks, quotes and unordered lists.
125 .
126 .SS "In-line markup"
127 As well as bold text, underlined text and in-line code.
128 .
129 .SH COLOR SUPPORT
130 Most terminals are able to display 256 colors these days. But some of them
131 enable only 16 colors by default. To enjoy
132 .BR smdp "'s"
133 full capabilities, these terminals need to be signaled to enable 256 color
134 mode. This is usually done by setting the TERM environment variable.
135 .PP
136 .BR "export TERM=xterm-256color"
137 .
138 .SH KEYBOARD CONTROLS
139 .TP
140 .BR "h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down"
141 Display next/previous slide or continue after a stop point.
142 .TP
143 .BR "g, Home"
144 Jump to first slide.
145 .TP
146 .BR "G, End"
147 Jump to last slide.
148 .TP
149 .BR "1..N"
150 Jump to
151 .BR N "th"
152 slide.
153 .TP
154 .BR "r"
155 Reload the input
156 .IR FILE .\|
157 This key is disabled if input was read from standard input.
158 .TP
159 .BR "q"
160 Exit
161 .BR smdp "."
162 .
163 .SH CUSTOMIZATION
164 .B smdp
165 can be configured by modifying config.h and recompiling.
166 .SH AUTHOR
167 Written by Michael Goehler and others, see
168 .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
169 Forked and modified by pinosaur.
170 .SH COPYRIGHT
171 Copyright (C) 2018 Michael Goehler
172 .PP
173 This is free software; see the source for copying conditions. There is NO
174 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.