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