annotate README @ 1:6ea97e3f7cb5 default tip

ignore log and upload, because they change in a live setup
author markus schnalke <meillo@marmaro.de>
date Thu, 29 Aug 2013 13:59:09 +0200 (2013-08-29)
parents 8f7e68d54c6d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
1 pdfconcat
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
2 ---------
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
3
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
4 This program concatenates PDF files and optionally converts text
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
5 within them into bitmaps. The concatenation is done with Ghostscript (gs);
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
6 the detextification is done with a gs-conversion to tiff and tiff2pdf
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
7 (package libtiff-tools) afterwards. Detextification is only in gray-scale.
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
8
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
9
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
10 Contents:
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
11
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
12 - bin/pdfconcat shell script to concatenate PDF files
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
13 - bin/pdfdetextify shell script to convert text to images in PDF files
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
14 - pdfconcat.php web interface to invoke the scripts
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
15
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
16 - log log file of web interface invocations (writable)
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
17 - bin/monthly shell script to sum up the usage by month
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
18
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
19 - upload/ directory to store the converted files (writable)
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
20 - bin/cleanup.cron helper script to remove old uploaded files
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
21
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
22 - .user.ini php config file to increase the max upload file size
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
23
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
24
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
25 Installation:
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
26
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
27 You need a Unix system. Ensure you have gs and tiff2pdf (in the package
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
28 libtiff-tools) available.
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
29
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
30 To use the bin/pdf* tools on the command line only, copy them to your $PATH
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
31 and make them executable.
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
32
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
33 To set up the program including the web interface, copy the files to a place
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
34 below the webserver root. Make bin/pdf{concat,detextify} executable for
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
35 www-data. Make the log and the upload directory writable by www-data. Install
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
36 a cronjob to clean up the upload directory. Ensure that the max upload file
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
37 size of PHP is large enough.
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
38
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
39
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
40 More or less helpful information sources on the PDF conversion:
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
41
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
42 http://stackoverflow.com/questions/6002261/pdf-to-tiff-imagemagick-problem
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
43 http://www.asmail.be/msg0055376363.html
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
44 http://kvz.io/blog/2007/11/28/php-tiff2pdf/
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
45 http://phpdave.wordpress.com/tag/php-pdf-to-tiff/
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
46
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
47
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
48 2013, markus schnalke <meillo@marmaro.de>
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
49 Written at KIT-Library, Karlsruhe.
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
50
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
51 This program is in the public domain. -- Dieses Programm hat nicht die
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
52 notwendige Schoepfungshoehe um urheberrechtlich geschuetzt zu sein. If
8f7e68d54c6d initial commit: should be already usable
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
53 you though need a license, use it under the CC0 license.