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 \-e ", " \-\^\-expand
  37 Enable character entity expansion (e.g. '&gt;' becomes '>').
  38 .TP
  39 .BR \-f ", " \-\^\-nofade
  40 Disable color fading in 256 color mode.
  41 .TP
  42 .BR \-i ", " \-\^\-invert
  43 Swap black and white color.
  44 .TP
  45 .BR \-t ", " \-\^\-notrans
  46 Disable transparency in transparent terminal.
  47 .
  48 .SS "Miscellaneous Options"
  49 .TP
  50 .BR \-d ", " \-\^\-debug
  51 Enable debug messages on STDERR. Add multiple times to increases debug level.
  52 .TP
  53 .BR \-h ", " \-\^\-help
  54 Display usage message and exit.
  55 .TP
  56 .BR \-v ", " \-\^\-version
  57 Display version and license information.
  58 .
  59 .SH MARKDOWN FORMATTING
  60 For a complete list of supported markups, refer the sample presentation
  61 (sample.md) provided alongside
  62 .BR mdp ,\|
  63 or online available at
  64 .IR https://github.com/visit1985/mdp .
  65 .SS "Slides"
  66 The input
  67 .IR FILE
  68 is split into multiple slides by horizontal rules. Each consisting of at least
  69 3
  70 .B \-\-\-
  71 or
  72 .B ***
  73 characters on a single line.
  74 .B This line must be prefixed by an completely empty line.
  75 It can also contain spaces but no other characters.
  76 .PP
  77 If any slide is too large to fit into your current screen, an error message
  78 will be displayed at the moment the presentation is launched.
  79 .
  80 .SS "Line-by-Line Mode"
  81 .SS "Block-by-Block Mode"
  82 A single
  83 .BR "<br>" ", " "<BR>" " or " "^"
  84 on an otherwise empty line signals
  85 .B mdp
  86 to stop output of the current slide (stop point) and wait for a key-press by
  87 the user.
  88 .PP
  89 This enables the user to display bullet points or list items one by one
  90 (line by line) or block by block.
  91 .
  92 .SS "Headers"
  93 .B mdp
  94 supports header lines in the format of
  95 .BR @ "[DESCRIPTION] " [VALUE]
  96 The first two header lines are displayed as title and author in top and
  97 bottom bar.
  98 .PP
  99 Headers are only recognized at the top of the input
 100 .IR FILE .
 101 .
 102 .SS "Line spanning markup"
 103 Supported are headlines, code blocks, quotes and unordered lists.
 104 .
 105 .SS "In-line markup"
 106 As well as bold text, underlined text and in-line code.
 107 .
 108 .SH COLOR SUPPORT
 109 Most terminals are able to display 256 colors these days. But some of them
 110 enable only 16 colors by default. To enjoy
 111 .BR mdp "'s"
 112 full capabilities, these terminals need to be signaled to enable 256 color
 113 mode. This is usually done by setting the TERM environment variable.
 114 .PP
 115 .BR "export TERM=xterm-256color"
 116 .
 117 .SH KEYBOARD CONTROLS
 118 .TP
 119 .BR "h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down"
 120 Display next/previous slide or continue after a stop point.
 121 .TP
 122 .BR "g, Home"
 123 Jump to first slide.
 124 .TP
 125 .BR "G, End"
 126 Jump to last slide.
 127 .TP
 128 .BR "1..N"
 129 Jump to
 130 .BR N "th"
 131 slide.
 132 .TP
 133 .BR "r"
 134 Reload the input
 135 .IR FILE .\|
 136 This key is disabled if input was read from standard input.
 137 .TP
 138 .BR "q"
 139 Exit
 140 .BR mdp "."
 141 .
 142 .SH AUTHOR
 143 Written by Michael Goehler and others, see
 144 .IR https://github.com/visit1985/mdp/blob/master/AUTHORS "."
 145 .SH COPYRIGHT
 146 Copyright (C) 2016 Michael Goehler
 147 .PP
 148 This is free software; see the source for copying conditions. There is NO
 149 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.