summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/pdfpc/pdfpc-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/pdfpc/pdfpc-doc.tex')
-rw-r--r--macros/latex/contrib/pdfpc/pdfpc-doc.tex37
1 files changed, 21 insertions, 16 deletions
diff --git a/macros/latex/contrib/pdfpc/pdfpc-doc.tex b/macros/latex/contrib/pdfpc/pdfpc-doc.tex
index c700b45411..f4b959c6b6 100644
--- a/macros/latex/contrib/pdfpc/pdfpc-doc.tex
+++ b/macros/latex/contrib/pdfpc/pdfpc-doc.tex
@@ -14,21 +14,21 @@
% You should have received a copy of the GNU General Public License along
% with this program; if not, write to the Free Software Foundation, Inc.,
% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-% -------------------------------------------------------------------------------------------
+% -----------------------------------------------------------------------------
%
% Allow for defining some meta data and simple textual notes for use
% with the pdfpc presentation application <https://pdfpc.github.io>.
%
-% -------------------------------------------------------------------------------------------
+% -----------------------------------------------------------------------------
%
% Inspired by Carsten Brandt's <https://github.com/cebe/pdfpc-latex-notes>.
%
-% -------------------------------------------------------------------------------------------
+% -----------------------------------------------------------------------------
%
% Please report bugs and other problems as well as suggestions for improvements
% to the issue tracker at github <https://github.com/pdfpc/pdfpc/>
%
-% -------------------------------------------------------------------------------------------
+% -----------------------------------------------------------------------------
\documentclass[11pt]{ltxdoc}
\usepackage{iftex}
@@ -38,12 +38,14 @@
\usepackage{hyperref}
\newcommand*{\sty}[1]{\textsf{#1}}
-\def\param#1{\textit{\rmfamily\mdseries\ensuremath{\langle}#1\ensuremath{\rangle}}}
+\def\param#1%
+{\textit{\rmfamily\mdseries\ensuremath{\langle}#1\ensuremath{\rangle}}}
-\title{The \sty{pdfpc} package \\ {\large\url{https://github.com/pdfpc/pdfpc}}}
+\title{The \sty{pdfpc} package \\
+ {\large\url{https://github.com/pdfpc/latex-pdfpc}}}
\author{Evgeny Stambulchik}
-\date{2021/02/06 (v0.6.0)}
+\date{2022/07/05 (v0.7.0)}
\hypersetup{pdftitle={The pdfpc package}, pdfauthor={Evgeny Stambulchik}}
@@ -52,10 +54,10 @@
\thispagestyle{empty}
\begin{abstract}
-This package provides a convenient way to specify notes and to define certain
-meta properties of the presentation when used with
+This package provides a convenient way to specify notes and to define certain
+meta properties of the presentation when used with
\href{https://pdfpc.github.io/}{PDF Presenter Console (\texttt{pdfpc}), a
-GPLv2+ licensed multi-monitor PDF presentation viewer application available on
+GPLv3+ licensed multi-monitor PDF presentation viewer application available on
GitHub}\footnote{\url{https://pdfpc.github.io/}}.
\end{abstract}
@@ -72,7 +74,7 @@ kvoptions \\ xstring \\ iftex \\ hyperxmp
\section*{License}
-\textcopyright\ 2020 Evgeny Stambulchik
+\textcopyright\ 2020--2022 Evgeny Stambulchik
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -82,9 +84,9 @@ the Free Software Foundation; either version 3 of the License, or
This work consists of the following files:
\begin{itemize}
- \item "pdfpc.sty",
- \item "pdfpc-doc.tex"
- \item "pdfpc-doc.pdf" \emph{(compiled)}
+ \item ``pdfpc.sty''
+ \item ``pdfpc-doc.tex''
+ \item ``pdfpc-doc.pdf'' \emph{(compiled)}
\end{itemize}
\clearpage
@@ -92,9 +94,10 @@ This work consists of the following files:
\part{The documentation}
\section*{Loading \sty{pdfpc}}
-Load \sty{pdfpc} by adding \cmd{\usepackage\{pdfpc\}} to your preamble.
+Load \sty{pdfpc} by adding \cmd{\usepackage[\param{options}]\{pdfpc\}} to your
+preamble.
-The following \param{options} may be given as comma-separated list:
+The following options may be given as comma-separated list:
\begin{itemize}
\item \texttt{duration}
@@ -108,6 +111,8 @@ The following \param{options} may be given as comma-separated list:
\item \texttt{defaulttransition} (needs pdfpc v4.5 or higher)
\end{itemize}
+Alternatively, the options can be set using the \cmd{\pdfpcsetup} command
+like \cmd{\pdfpcsetup\{\param{option1=value1}[,~\ldots]\}}.
The meaning and possible values of most of these options are documented in
\textit{pdfpcrc(5)} man page of the pdfpc program. The rest are explained below.