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 \-c ", " \-\^\-nocodebg
  41 Don't change the background color of code blocks.
  42 .TP
  43 .BR \-e ", " \-\^\-expand
  44 Enable character entity expansion (e.g. '&gt;' becomes '>').
  45 .TP
  46 .BR \-s ", " \-\^\-noslidenum
  47 Do not show slide number at the bottom.
  48 .TP
  49 .BR \-x ", " \-\^\-noslidemax
  50 Show slide number, but not total number of slides.
  51 .
  52 .SS "Miscellaneous Options"
  53 .TP
  54 .BR \-d ", " \-\^\-debug
  55 Enable debug messages on STDERR. Add multiple times to increases debug level.
  56 .TP
  57 .BR \-h ", " \-\^\-help
  58 Display usage message and exit.
  59 .TP
  60 .BR \-v ", " \-\^\-version
  61 Display version and license information.
  62 .
  63 .SH ENVIRONMENT VARIABLES
  64 .SS "Output Control"
  65 .TP
  66 .BR MDP_LIST_HEAD[1-3],\ MDP_LIST_OPEN[1-3]
  67 Controls the list characters of unordered lists.
  68
  69 The default is equivalent to:
  70 .br
  71 MDP_LIST_OPEN1=' |  '
  72 .br
  73 MDP_LIST_OPEN2=' |  '
  74 .br
  75 MDP_LIST_OPEN3=' |  '
  76 .br
  77 MDP_LIST_HEAD1=' +- '
  78 .br
  79 MDP_LIST_HEAD2=' +- '
  80 .br
  81 MDP_LIST_HEAD3=' +- '
  82 .
  83 .SH MARKDOWN FORMATTING
  84 For a complete list of supported markups, refer the sample presentation
  85 (sample.md) provided alongside
  86 .BR smdp ,\|
  87 or online available at
  88 .IR https://github.com/MrPicklePinosaur/smdp .
  89 .SS "Slides"
  90 The input
  91 .IR FILE
  92 is split into multiple slides by horizontal rules. Each consisting of at least
  93 3
  94 .B \-\-\-
  95 or
  96 .B ***
  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.
 100 .PP
 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.
 103 .
 104 .SS "Line-by-Line Mode"
 105 .SS "Block-by-Block Mode"
 106 A single
 107 .BR "<br>" ", " "<BR>" " or " "^"
 108 on an otherwise empty line signals
 109 .B smdp
 110 to stop output of the current slide (stop point) and wait for a key-press by
 111 the user.
 112 .PP
 113 This enables the user to display bullet points or list items one by one
 114 (line by line) or block by block.
 115 .
 116 .SS "Headers"
 117 .B smdp
 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
 121 bottom bar.
 122 .PP
 123 Headers are only recognized at the top of the input
 124 .IR FILE .
 125 .
 126 .SS "Line spanning markup"
 127 Supported are headlines, code blocks, quotes and unordered lists.
 128 .
 129 .SS "In-line markup"
 130 As well as bold text, underlined text and in-line code.
 131 .
 132 .SH COLOR SUPPORT
 133 Most terminals are able to display 256 colors these days. But some of them
 134 enable only 16 colors by default. To enjoy
 135 .BR smdp "'s"
 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.
 138 .PP
 139 .BR "export TERM=xterm-256color"
 140 .
 141 .SH KEYBOARD CONTROLS
 142 .TP
 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.
 145 .TP
 146 .BR "g, Home"
 147 Jump to first slide.
 148 .TP
 149 .BR "G, End"
 150 Jump to last slide.
 151 .TP
 152 .BR "1..N"
 153 Jump to
 154 .BR N "th"
 155 slide.
 156 .TP
 157 .BR "r"
 158 Reload the input
 159 .IR FILE .\|
 160 This key is disabled if input was read from standard input.
 161 .TP
 162 .BR "q"
 163 Exit
 164 .BR smdp "."
 165 .
 166 .SH CUSTOMIZATION
 167 .B smdp
 168 can be configured by modifying config.h and recompiling.
 169 .SH AUTHOR
 170 Written by Michael Goehler and others, see
 171 .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
 172 Forked and modified by pinosaur.
 173 .SH COPYRIGHT
 174 Copyright (C) 2018 Michael Goehler
 175 .PP
 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.