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