.\" Automatically generated by Pandoc 1.17.2
.\"
.TH "patat manual" "1" "April 26, 2017" "patat v0.5.1.2" ""
.hy
.SH NAME
.PP
patat \- Presentations Atop The ANSI Terminal
.SH SYNOPSIS
.PP
\f[C]patat\ [*options*]\ file\f[]
.SH DESCRIPTION
.SS Controls
.IP \[bu] 2
\f[B]Next slide\f[]: \f[C]space\f[], \f[C]enter\f[], \f[C]l\f[],
\f[C]→\f[]
.IP \[bu] 2
\f[B]Previous slide\f[]: \f[C]backspace\f[], \f[C]h\f[], \f[C]←\f[]
.IP \[bu] 2
\f[B]Go forward 10 slides\f[]: \f[C]j\f[], \f[C]↓\f[]
.IP \[bu] 2
\f[B]Go backward 10 slides\f[]: \f[C]k\f[], \f[C]↑\f[]
.IP \[bu] 2
\f[B]First slide\f[]: \f[C]0\f[]
.IP \[bu] 2
\f[B]Last slide\f[]: \f[C]G\f[]
.IP \[bu] 2
\f[B]Reload file\f[]: \f[C]r\f[]
.IP \[bu] 2
\f[B]Quit\f[]: \f[C]q\f[]
.PP
The \f[C]r\f[] key is very useful since it allows you to preview your
slides while you are writing them.
You can also use this to fix artifacts when the terminal is resized.
.SS Input format
.PP
The input format can be anything that Pandoc supports.
Plain markdown is usually the most simple solution:
.IP
.nf
\f[C]
\-\-\-
title:\ This\ is\ my\ presentation
author:\ Jane\ Doe
\&...

#\ This\ is\ a\ slide

Slide\ contents.\ \ Yay.

\-\-\-

#\ Important\ title

Things\ I\ like:

\-\ Markdown
\-\ Haskell
\-\ Pandoc
\f[]
.fi
.PP
Horizontal rulers (\f[C]\-\-\-\f[]) are used to split slides.
.PP
However, if you prefer not use these since they are a bit intrusive in
the markdown, you can also start every slide with a header.
In that case, the file should not contain a single horizontal ruler.
.PP
\f[C]patat\f[] will pick the most deeply nested header (e.g.
\f[C]h2\f[]) as the marker for a new slide.
Headers \f[I]above\f[] the most deeply nested header (e.g.
\f[C]h1\f[]) will turn into title slides, which are displayed as as a
slide containing only the centered title.
.PP
This means the following document is equivalent to the one we saw
before:
.IP
.nf
\f[C]
\-\-\-
title:\ This\ is\ my\ presentation
author:\ Jane\ Doe
\&...

#\ This\ is\ a\ slide

Slide\ contents.\ \ Yay.

#\ Important\ title

Things\ I\ like:

\-\ Markdown
\-\ Haskell
\-\ Pandoc
\f[]
.fi
.PP
And that following document contains three slides: a title slide,
followed by two content slides.
.IP
.nf
\f[C]
\-\-\-
title:\ This\ is\ my\ presentation
author:\ Jane\ Doe
\&...

#\ Chapter\ 1

##\ This\ is\ a\ slide

Slide\ contents.\ \ Yay.

##\ Another\ slide

Things\ I\ like:

\-\ Markdown
\-\ Haskell
\-\ Pandoc
\f[]
.fi
.PP
For more information, see \f[I]Advanced slide splitting\f[].
.SS Configuration
.PP
\f[C]patat\f[] is fairly configurable.
The configuration is done using \f[I]YAML\f[].
There are two places where you can put your configuration:
.IP "1." 3
In the presentation file itself, using the \f[I]Pandoc metadata
header\f[].
.IP "2." 3
In \f[C]$HOME/.patat.yaml\f[]
.PP
For example, we set an option \f[C]key\f[] to \f[C]val\f[] by using the
following file:
.IP
.nf
\f[C]
\-\-\-
title:\ Presentation\ with\ options
author:\ John\ Doe
patat:
\ \ \ \ key:\ val
\&...

Hello\ world.
\f[]
.fi
.PP
Or we can use a normal presentation and have the following
\f[C]$HOME/.patat.yaml\f[]:
.IP
.nf
\f[C]
key:\ val
\f[]
.fi
.SS Line wrapping
.PP
Line wrapping can be enabled by setting \f[C]wrap:\ true\f[] in the
configuration.
This will re\-wrap all lines to fit the terminal width better.
.SS Auto advancing
.PP
By setting \f[C]autoAdvanceDelay\f[] to a number of seconds,
\f[C]patat\f[] will automatically advance to the next slide.
.IP
.nf
\f[C]
\-\-\-
title:\ Auto\-advance,\ yes\ please
author:\ John\ Doe
patat:
\ \ \ \ autoAdvanceDelay:\ 2
\&...

Hello\ World!

\-\-\-

This\ slide\ will\ be\ shown\ two\ seconds\ after\ the\ presentation\ starts.
\f[]
.fi
.PP
Note that changes to \f[C]autoAdvanceDelay\f[] are not picked up
automatically if you are running \f[C]patat\ \-\-watch\f[].
This requires restarting \f[C]patat\f[].
.SS Advanced slide splitting
.PP
You can control the way slide splitting works by setting the
\f[C]slideLevel\f[] variable.
This variable defaults to the least header that occurs before a
non\-header, but it can also be explicitly defined.
For example, in the following document, the \f[C]slideLevel\f[] defaults
to \f[B]2\f[]:
.IP
.nf
\f[C]
#\ This\ is\ a\ slide

##\ This\ is\ a\ nested\ header

This\ is\ some\ content
\f[]
.fi
.PP
With \f[C]slideLevel\f[] 2, the \f[C]h1\f[] will turn into a "title
slide", and the \f[C]h2\f[] will be displayed at the top of the second
slide.
We can customize this by setting \f[C]slideLevel\f[] manually:
.IP
.nf
\f[C]
\-\-\-
patat:
\ \ slideLevel:\ 1
\&...

#\ This\ is\ a\ slide

##\ This\ is\ a\ nested\ header

This\ is\ some\ content
\f[]
.fi
.PP
Now, we will only see one slide, which contains a nested header.
.SS Fragmented slides
.PP
By default, slides are always displayed "all at once".
If you want to display them fragment by fragment, there are two ways to
do that.
The most common case is that lists should be displayed incrementally.
.PP
This can be configured by settings \f[C]incrementalLists\f[] to
\f[C]true\f[] in the metadata block:
.IP
.nf
\f[C]
\-\-\-
title:\ Presentation\ with\ incremental\ lists
author:\ John\ Doe
patat:
\ \ \ \ incrementalLists:\ true
\&...

\-\ This\ list
\-\ is\ displayed
\-\ item\ by\ item
\f[]
.fi
.PP
Setting \f[C]incrementalLists\f[] works on \f[I]all\f[] lists in the
presentation.
To flip the setting for a specific list, wrap it in a block quote.
This will make the list incremental if \f[C]incrementalLists\f[] is not
set, and it will display the list all at once if
\f[C]incrementalLists\f[] is set to \f[C]true\f[].
.PP
This example contains a sublist which is also displayed incrementally,
and then a sublist which is displayed all at once (by merit of the block
quote).
.IP
.nf
\f[C]
\-\-\-
title:\ Presentation\ with\ incremental\ lists
author:\ John\ Doe
patat:
\ \ \ \ incrementalLists:\ true
\&...

\-\ This\ list
\-\ is\ displayed

\ \ \ \ *\ item
\ \ \ \ *\ by\ item

\-\ Or\ sometimes

\ \ \ \ >\ *\ all\ at
\ \ \ \ >\ *\ once
\f[]
.fi
.PP
Another way to break up slides is to use a pagraph only containing three
dots separated by spaces.
For example, this slide has two pauses:
.IP
.nf
\f[C]
Legen

\&.\ .\ .

wait\ for\ it

\&.\ .\ .

Dary!
\f[]
.fi
.SS Theming
.PP
Colors and other properties can also be changed using this
configuration.
For example, we can have:
.IP
.nf
\f[C]
\-\-\-
author:\ \[aq]Jasper\ Van\ der\ Jeugt\[aq]
title:\ \[aq]This\ is\ a\ test\[aq]
patat:
\ \ \ \ wrap:\ true
\ \ \ \ theme:
\ \ \ \ \ \ \ \ emph:\ [vividBlue,\ onVividBlack,\ bold]
\ \ \ \ \ \ \ \ imageTarget:\ [onDullWhite,\ vividRed]
\&...

#\ This\ is\ a\ presentation

This\ is\ _emph_\ text.

![Hello](foo.png)
\f[]
.fi
.PP
The properties that can be given a list of styles are:
.PP
\f[C]blockQuote\f[], \f[C]borders\f[], \f[C]bulletList\f[],
\f[C]codeBlock\f[], \f[C]code\f[], \f[C]definitionList\f[],
\f[C]definitionTerm\f[], \f[C]emph\f[], \f[C]header\f[],
\f[C]imageTarget\f[], \f[C]imageText\f[], \f[C]linkTarget\f[],
\f[C]linkText\f[], \f[C]math\f[], \f[C]orderedList\f[], \f[C]quoted\f[],
\f[C]strikeout\f[], \f[C]strong\f[], \f[C]tableHeader\f[],
\f[C]tableSeparator\f[]
.PP
The accepted styles are:
.PP
\f[C]bold\f[], \f[C]dullBlack\f[], \f[C]dullBlue\f[], \f[C]dullCyan\f[],
\f[C]dullGreen\f[], \f[C]dullMagenta\f[], \f[C]dullRed\f[],
\f[C]dullWhite\f[], \f[C]dullYellow\f[], \f[C]onDullBlack\f[],
\f[C]onDullBlue\f[], \f[C]onDullCyan\f[], \f[C]onDullGreen\f[],
\f[C]onDullMagenta\f[], \f[C]onDullRed\f[], \f[C]onDullWhite\f[],
\f[C]onDullYellow\f[], \f[C]onVividBlack\f[], \f[C]onVividBlue\f[],
\f[C]onVividCyan\f[], \f[C]onVividGreen\f[], \f[C]onVividMagenta\f[],
\f[C]onVividRed\f[], \f[C]onVividWhite\f[], \f[C]onVividYellow\f[],
\f[C]underline\f[], \f[C]vividBlack\f[], \f[C]vividBlue\f[],
\f[C]vividCyan\f[], \f[C]vividGreen\f[], \f[C]vividMagenta\f[],
\f[C]vividRed\f[], \f[C]vividWhite\f[], \f[C]vividYellow\f[]
.SS Syntax Highlighting
.PP
As part of theming, syntax highlighting is also configurable.
This can be configured like this:
.IP
.nf
\f[C]
\-\-\-
patat:
\ \ theme:
\ \ \ \ syntaxHighlighting:
\ \ \ \ \ \ decVal:\ [bold,\ onDullRed]
\&...

\&...
\f[]
.fi
.PP
\f[C]decVal\f[] refers to "decimal values".
This is known as a "token type".
For a full list of token types, see \f[I]this list\f[] \-\- the names
are derived from there in an obvious way.
.SH OPTIONS
.TP
.B \f[C]\-w\f[], \f[C]\-\-watch\f[]
If you provide the \f[C]\-\-watch\f[] flag, \f[C]patat\f[] will watch
the presentation file for changes and reload automatically.
This is very useful when you are writing the presentation.
.RS
.RE
.TP
.B \f[C]\-f\f[], \f[C]\-\-force\f[]
Run the presentation even if the terminal claims it does not support
ANSI features.
.RS
.RE
.TP
.B \f[C]\-d\f[], \f[C]\-\-dump\f[]
Just dump all the slides to stdout.
This is useful for debugging.
.RS
.RE
.TP
.B \f[C]\-\-version\f[]
Display version information.
.RS
.RE
.SH SEE ALSO
.PP
pandoc(1)
.SH AUTHORS
Jasper Van der Jeugt.