Fix minor error in README.
[pdftools:pdfjoin.git] / pdfjoin.rst
1 .. -*- mode: rst ; ispell-local-dictionary: "american" -*-
2
3 ==========================
4 pdfjoin
5 ==========================
6
7 -------------------------------------------------------------
8 Join several PDF documents into a single one
9 -------------------------------------------------------------
10
11 :Author:    Hartmut Goebel <h.goebel@goebel-consult.de>
12 :Version:   Version |VERSION|
13 :Copyright: 2008-2011 by Hartmut Goebel
14 :Licence:   GNU Public Licence v3 (GPLv3)
15 :Manual section: 1
16
17 .. raw:: manpage
18
19    .\" disable justification (adjust text to left margin only)
20    .ad l
21
22
23 SYNOPSIS
24 ==========
25
26 ``pdfjoin`` <options> infile ...
27
28 DESCRIPTION
29 ============
30
31 ``pdfjoin`` can be used to join several PDF documents into a single
32 one. it will join all files passed as argument into a
33
34 ``pdfjoin`` has three modes of operation:
35
36 1) With no output path given: The droplet mode.
37
38    If no output path is passed to ``pdfjoin``, will look for a file
39    matching ``pdfjoin-*.pdf`` in the current directory, which has been
40    modified within the last 60 minutes. (More precise, the filename
41    must match the scheme as described in the next paragraph.)q If such
42    a file exists, all documents passed as arguments will be joined to
43    this one.
44
45    If such a file does not exist, it will be created first. The
46    filename will be ``pdfjoin-yyyddmm-hhmm.pdf`` with ``yyyddmm``
47    being the current date and ``hhmm`` being the current time.
48
49    This allows dropping one file after each other onto the droplet and
50    join them into the same output file -- assuming you are not waiting
51    more then 60 Minutes between each drop.
52
53 2) With an existing directory name is given as output path
54
55    This case works exactly like the droplet mode, except that the file
56    is searched for and created in the given directory.
57
58 3) With any other path given as output path:
59
60    In this case the given path is the filename searched for and
61    created if not existing yet.
62
63
64 OPTIONS
65 ========
66
67 General Options
68 --------------------
69
70 --version        Show program's version number and exit
71 -h, --help       Show help message and exit
72 -v, --verbose    Be verbose. Tell about scaling, rotation and number of
73                  pages. Can be used more than once to increase the
74                  verbosity.
75 -n, --dry-run    Show what would have been done, but do not generate files.
76
77 Defining Output
78 -----------------
79
80 -o OUTPUT, --output=OUTPUT
81                  Specify filename or directory to write file to
82                  (default: current directory)
83
84
85 EXAMPLES
86 ============
87
88 :pdfjoin infile1.pdf infile2.pdf infile3.pdf:
89        Creates a file named like ``pdfjoin-20120102-1415.pdf`` in the
90        current directory.
91
92 :pdfjoin infile1.pdf ; pdfjoin infile2.pdf ; pdfjoin infile3.pdf:
93        Same as above -- assuming the deplay between issuing each of
94        the commands is less than 60 minutes.
95
96 :pdfjoin infile1.pdf infile2.pdf infile3.pdf --output /tmp/foo:
97        Creates a file named like
98        ``/tmp/foo/pdfjoin-20120102-1415.pdf`` in the current
99        directory. But only if /tmp/foo already exisits!
100
101 :pdfjoin infile1.pdf --output /tmp/foo; pdfjoin infile3.pdf --output /tmp/foo:
102        Same as above -- again assuming the deplay between issuing each
103        of the commands is less than 60 minutes.
104
105 :pdfjoin infile1.pdf infile2.pdf infile3.pdf --output /tmp/foo.pdf:
106        Creates a file named like ``/tmp/foo.pdf`` in the current
107        directory. But only if /tmp/foo.pdf is no exiting directory!
108
109
110 SEE ALSO
111 =============
112
113 ``pdfposter``\(1) http://pypi.python.org/pypi/pdftools.pdfposter/,
114 ``pdfnup``\(1) http://pypi.python.org/pypi/pdfnup/,
115 ``pdfsplit``\(1) http://pypi.python.org/pypi/pdfsplit/,
116 ``pdfgrid``\(1) http://pypi.python.org/pypi/pdfgrid/
117
118 Project Homepage http://pdfposter.origo.ethz.ch/