summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/pdfoverlay/README.md
blob: e08949050c938e27e919e82c2a92d6ed8ab8d42e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# pdfoverlay — A LaTeX style for overlaying text on a PDF

The `pdfoverlay` package provides a simple interface to overlay text on to an
existing PDF. The text to be overlaid is typeset and positioned normally as
you would any other LaTeX document. Some or all of the pages of the PDF can be
included and not all pages of the PDF need have overlaid text. It’s also
possible to include text between pages of the PDF.

## Installation from TeXLive or MiKTeX

`pdfoverlay` is in TeXLive and MiKTeX and can be installed in the usual way
through your distribution. E.g., in TeXLive by running:

```
tlmgr install pdfoverlay
```

## Installation from CTAN

Download and unpack `pdfoverlay.zip` from CTAN at
https://ctan.org/pkg/pdfoverlay

Change to the `pdfoverlay` directory, then run:

```
tex pdfoverlay.ins
```

to generate `pdfoverlay.sty`.

Copy `pdfoverlay.sty` to `$TEXMFHOME/tex/latex/pdfoverlay/` and
`pdfoverlay.pdf` to `$TEXMFHOME/doc/latex/pdfoverlay/`.

You can find `$TEXMFHOME` by running:

```
kpsewhich -var-value=TEXMFHOME
```

## Installation from Git Source

`pdfoverlay` uses the `l3build` system.

Clone the git repository using:

```
git clone https://github.com/dcpurton/pdfoverlay.git
```

Change to the `pdfoverlay` directory, and then the style file
(`pdfoverlay.sty`) and documentation (`pdfoverlay.pdf`) can be installed by
running:

```
l3build install --full
```

## Licence

```
Copyright (c) 2018-2020 David Purton <dcpurton@marshwiggle.net>

This work may be distributed and/or modified under the conditions of
the LaTeX Project2 Public License, either version 1.3c of this license
or (at your option) any later version. The latest version of this
license is in
   http://www.latex-project.org/lppl.txt
and version 1.3c or later is part of all distributions of LaTeX
version 2005/12/01 or later.

This work is "maintained" (as per the LPPL maintenance status)
by David Purton.

This work consists of the files pdfoverlay.ins, pdfoverlay.dtx, README.md,
and the derived files pdfoverlay.sty and pdfoverlay.pdf
```