X-Git-Url: https://git.danieliu.xyz/?a=blobdiff_plain;f=mdp.1;fp=mdp.1;h=0000000000000000000000000000000000000000;hb=6a328bf6617966ec88be7c7dd78e160933f84a94;hp=01f2e7eb3a04c44f39a57bcf0b2c21efe8af843d;hpb=96277f3ca3bb80c44eb559b782cdd7044cd71514;p=smdp.git diff --git a/mdp.1 b/mdp.1 deleted file mode 100644 index 01f2e7e..0000000 --- a/mdp.1 +++ /dev/null @@ -1,172 +0,0 @@ -.\" This is the groff documentation source for MDP -.\" -.\" Preview with: groff -man -Tascii mdp.1 -.\" or: man -l mdp.1 -.\" -. -. -.TH MDP 1 "2016-04-02" "User Commands" -.SH NAME -mdp \- A command-line based -markdown presentation tool -.SH SYNOPSIS -.B mdp -.RI [ OPTION ].\|.\|.\| -.RI [ FILE ] -. -.SH DESCRIPTION -.B mdp -is a command-line program that allows you to make elegant presentations from -.B markdown formatted -.IR FILE s. -.PP -It is as easy as write your presentation content in the text editor of your -preference and launch the presentation from the command-line. -. -.SH OPTIONS -.SS "Input Control" -.TP -.IR FILE -The input file from which the presentation is read. If no file is specified, -or if the file name is -.BR \- "," -the presentation is read from standard input. -.SS "Output Control" -.TP -.BR \-c ", " \-\^\-nocodebg -Don't change the background color of code blocks. -.TP -.BR \-e ", " \-\^\-expand -Enable character entity expansion (e.g. '>' becomes '>'). -.TP -.BR \-s ", " \-\^\-noslidenum -Do not show slide number at the bottom. -.TP -.BR \-x ", " \-\^\-noslidemax -Show slide number, but not total number of slides. -. -.SS "Miscellaneous Options" -.TP -.BR \-d ", " \-\^\-debug -Enable debug messages on STDERR. Add multiple times to increases debug level. -.TP -.BR \-h ", " \-\^\-help -Display usage message and exit. -.TP -.BR \-v ", " \-\^\-version -Display version and license information. -. -.SH ENVIRONMENT VARIABLES -.SS "Output Control" -.TP -.BR MDP_LIST_HEAD[1-3],\ MDP_LIST_OPEN[1-3] -Controls the list characters of unordered lists. - -The default is equivalent to: -.br -MDP_LIST_OPEN1=' | ' -.br -MDP_LIST_OPEN2=' | ' -.br -MDP_LIST_OPEN3=' | ' -.br -MDP_LIST_HEAD1=' +- ' -.br -MDP_LIST_HEAD2=' +- ' -.br -MDP_LIST_HEAD3=' +- ' -. -.SH MARKDOWN FORMATTING -For a complete list of supported markups, refer the sample presentation -(sample.md) provided alongside -.BR mdp ,\| -or online available at -.IR https://github.com/visit1985/mdp . -.SS "Slides" -The input -.IR FILE -is split into multiple slides by horizontal rules. Each consisting of at least -3 -.B \-\-\- -or -.B *** -characters on a single line. -.B This line must be prefixed by an completely empty line. -It can also contain spaces but no other characters. -.PP -If any slide is too large to fit into your current screen, an error message -will be displayed at the moment the presentation is launched. -. -.SS "Line-by-Line Mode" -.SS "Block-by-Block Mode" -A single -.BR "
" ", " "
" " or " "^" -on an otherwise empty line signals -.B mdp -to stop output of the current slide (stop point) and wait for a key-press by -the user. -.PP -This enables the user to display bullet points or list items one by one -(line by line) or block by block. -. -.SS "Headers" -.B mdp -supports header lines in the format of -.BR @ "[DESCRIPTION] " [VALUE] -The first two header lines are displayed as title and author in top and -bottom bar. -.PP -Headers are only recognized at the top of the input -.IR FILE . -. -.SS "Line spanning markup" -Supported are headlines, code blocks, quotes and unordered lists. -. -.SS "In-line markup" -As well as bold text, underlined text and in-line code. -. -.SH COLOR SUPPORT -Most terminals are able to display 256 colors these days. But some of them -enable only 16 colors by default. To enjoy -.BR mdp "'s" -full capabilities, these terminals need to be signaled to enable 256 color -mode. This is usually done by setting the TERM environment variable. -.PP -.BR "export TERM=xterm-256color" -. -.SH KEYBOARD CONTROLS -.TP -.BR "h, j, k, l, Arrow keys, Space, Enter, Backspace, Page Up, Page Down" -Display next/previous slide or continue after a stop point. -.TP -.BR "g, Home" -Jump to first slide. -.TP -.BR "G, End" -Jump to last slide. -.TP -.BR "1..N" -Jump to -.BR N "th" -slide. -.TP -.BR "r" -Reload the input -.IR FILE .\| -This key is disabled if input was read from standard input. -.TP -.BR "q" -Exit -.BR mdp "." -. -.SH CUSTOMIZATION -.B mdp -can be configured by modifying config.h and recompiling. -.SH AUTHOR -Written by Michael Goehler and others, see -.IR https://github.com/visit1985/mdp/blob/master/AUTHORS "." -.SH COPYRIGHT -Copyright (C) 2018 Michael Goehler -.PP -This is free software; see the source for copying conditions. There is NO -warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.