mdp.1

   1 .\" This is the groff documentation source for MDP
   2 .\"
   3 .\" Preview with: groff -man -Tascii mdp.1
   4 .\"
   5
   6
   7 .TH MDP 1 "2015-4-10"
   8 .SH NAME
   9 mdp \- A command-line based markdown presentation tool
  10 .SH SYNOPSIS
  11 .BI "mdp [" options "] file"
  12 .SH DESCRIPTION
  13 .B mdp
  14 is a command-line program that allows you to make elegant presentations from
  15 markdown format files, and is as easy as write your presentation content in the
  16 text editor of your preference and trigger the presentation from the
  17 command-line.
  18 .SH OPTIONS
  19 .HP
  20 \fB\-f\fR, \fB\-\-nofade
  21 .IP
  22 Disable color fading in 256 color mode
  23 .HP
  24 \fB\-i\fR, \fB\-\-invert
  25 .IP
  26 Swap black and white color
  27 .HP
  28 \fB\-t\fR, \fB\-\-notrans
  29 .IP
  30 Disable transparency in transparent terminal
  31 .HP
  32 \fB\-h\fR, \fB\-\-help
  33 .IP
  34 Display usage message and exit
  35 .HP
  36 \fB\-d\fR, \fB\-\-debug
  37 .IP
  38 Enable debug messages on STDERR, add multiple times to increases debug level
  39 .SH PRESENTATION FILES
  40 .B mdp
  41 uses
  42 .B markdown
  43 format files, you can write your presentations content in that format using the
  44 text editor of your preference.
  45
  46 Horizontal rules are used as slide separator, if any slide are too large to fit
  47 into your current screen an error message will be displayed at the moment the
  48 presentation is initiated.
  49
  50 .SS
  51 Markdown formating supported
  52
  53 .B mdp
  54 supports headers prefixed by
  55 .B @
  56 symbol. The first two header lines are displayed as title and author in top and
  57 bottom bar.
  58
  59 .TP
  60 .RI Line-wide\ markup
  61 * headlines
  62
  63 * code
  64
  65 * quotes
  66
  67 * unordered list
  68 .TP
  69 .RI In-line\ markup
  70 * bold text
  71
  72 * underlined text
  73
  74 * code
  75
  76 .SH CONTROLS
  77 .HP
  78 \fBh\fR, \fBj\fR, \fBk\fR, \fBl\fR, \fBArrow Keys\fR, \fBSpace\fR, \fBEnter\fR, \fBBackspace\fR, \fBPage Up\fR, \fBPage Down\fR
  79 .IP
  80 Next/Previous slide
  81 .HP
  82 \fBg\fR, \fBHome\fR
  83 .IP
  84 Go to first slide
  85 .HP
  86 \fBG\fR, \fBEnd\fR
  87 .IP
  88 Go to last slide
  89 .HP
  90 \fB1-9\fR
  91 .IP
  92 Go to
  93 .B n
  94 slide
  95 .HP
  96 \fBr\fR
  97 .IP
  98 Reload input file
  99 .HP
 100 \fBq\fR
 101 .IP
 102 Exit
 103
 104 .SH DEBUG
 105 To make a debug version of
 106 .B mdp
 107 use:
 108 .IP
 109 .B $ make DEBUG=1
 110
 111 .SH AUTHOR
 112 Written by: Michel Gohler and contributors in the github repository at
 113 <wwwgithub.com/visit1985/mdp>
 114
 115 Extra credits in CREDITS file