Skip to content

Commit 95da200

Browse files
committed
Describe package options, CLI flags in table form
1 parent e1c1a78 commit 95da200

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

pdfpc/pdfpc-doc.tex

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -108,23 +108,31 @@ \part{The documentation}
108108
\section*{Loading \sty{pdfpc}}
109109

110110
Load \sty{pdfpc} by adding \cmd{\usepackage[\param{options}]\{pdfpc\}} to your preamble.
111-
112111
The following options may be given as comma-separated list:
113112

114-
\begin{itemize}
115-
\item \texttt{duration}
116-
\item \texttt{starttime}
117-
\item \texttt{endtime}
118-
\item \texttt{enduserslide}
119-
\item \texttt{lastminutes}
120-
\item \texttt{hidenotes}
121-
\item \texttt{notesposition}
122-
\item \texttt{overridenote}
123-
\item \texttt{disablemarkdown}
124-
\item \texttt{defaulttransition} (needs pdfpc v4.5 or higher)
125-
\end{itemize}
113+
\begin{table}[h]
114+
\centering
115+
\begin{tabular}{ l l }
116+
\hline
117+
Package option & Equivalent \texttt{pdfpc} feature \\
118+
\hline
119+
\texttt{duration} & \texttt{--duration} \\
120+
\texttt{starttime} & \texttt{--start-time} \\
121+
\texttt{endtime} & \texttt{--end-time} \\
122+
\texttt{lastminutes} & \texttt{--last-minutes} \\
123+
\texttt{enduserslide} & Ctrl+e keybind \\
124+
\texttt{notesposition} & \texttt{--notes} \\
125+
\texttt{disablemarkdown} & \texttt{--note-format} \\
126+
\texttt{hidenotes} & \\
127+
\texttt{overridenote} & \\
128+
\texttt{defaulttransition} & \texttt{--page-transition} (\texttt{pdfpc} v4.5 or later) \\
129+
\hline
130+
\end{tabular}
131+
\end{table}
132+
133+
Options should be given as a comma-separated list.
134+
All options, aside from \texttt{overridenote}, can alternatively be set via a command of the form \cmd{\pdfpcsetup\{\param{option1=value1}[,~\ldots]\}}.
126135

127-
Alternatively, the options can be set using the \cmd{\pdfpcsetup} command like \cmd{\pdfpcsetup\{\param{option1=value1}[,~\ldots]\}} (except \texttt{overridenote}, which only works as a proper package option).
128136
The meaning and possible values of most of these options are documented in the \textit{pdfpc(1)} man page, provided by the \texttt{pdfpc} program.
129137
The rest are explained below.
130138

0 commit comments

Comments
 (0)