summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/attachfile/README
blob: 7ccc0274db378d35a29bbfe025e90cb5afd23fce (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
		 +---------------------------------+
		 |	THE ATTACHFILE PACKAGE	   |
		 | Scott Pakin, scott+af@pakin.org |
		 +---------------------------------+


Description
-----------

Starting with PDF 1.3 (Adobe Acrobat 4.0), PDF files can contain file
attachments -- arbitrary files that a reader can extract, just like
attachments to an e-mail message.  The attachfile package brings this
functionality to pdfLaTeX and provides some additional features not
available in Acrobat, such as the ability to use arbitrary LaTeX code
for the file icon -- including things like \includegraphics, tabular,
and math.  Settings can be made either globally or on a per-attachment
basis.  attachfile makes it easy to attach files and customize their
appearance in the enclosing document.


Copyright and license
---------------------

Copyright (C) 2011 Scott Pakin <scott+af@pakin.org>

This package may be distributed and/or modified under the conditions
of the LaTeX Project 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 2006/05/20 or later.


Building attachfile
and its documentation
---------------------

tex attachfile.ins       <== Produces attachfile.sty (the package proper)
pdflatex attachfile.dtx  <== Produces attachfile.pdf (documentation)
makeindex -s gind.ist attachfile  <== Produces attachfile.ind (index)
makeindex -s gglo.ist attachfile.glo -o attachfile.gls  <== (change log)
pdflatex attachfile.dtx  <== Merges index + change log into the documentation
pdflatex attachfile.dtx  <== Produces final version of attachfile.pdf

Note that attachfile comes with pre-built documentation (PDF format,
U.S. letter-sized paper), so you really need to perform only the first
step above unless you're unhappy with the documentation as provided.