File: pdfjoin.sgml

package info (click to toggle)
pdfjam 1.20-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny
  • size: 196 kB
  • ctags: 9
  • sloc: sh: 596; makefile: 47
file content (239 lines) | stat: -rw-r--r-- 8,129 bytes parent folder | download | duplicates (2)
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Matti</firstname>">
  <!ENTITY dhsurname   "<surname>Peltomaki</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>September 26, 2004</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>ppv@fyslab.hut.fi</email>">
  <!ENTITY dhusername  "Matti Peltomaki">
  <!ENTITY dhucpackage "<refentrytitle>pdfjoin</refentrytitle>">
  <!ENTITY dhpackage   "pdfjoin">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>concatenate the multiple PDF files into a single file</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option>--paper <replaceable>papersize</replaceable></option></arg>
      <arg><option>--orient <replaceable>orientation</replaceable></option></arg>
      <arg><option>--fitpaper <replaceable>fitpaper</replaceable></option></arg>
      <arg><option>--trim <replaceable>trimspec</replaceable></option></arg>
      <arg><option>--offset <replaceable>offset</replaceable></option></arg>
      <arg><option>--noautoscale <replaceable>noautoscale
                  </replaceable></option></arg>
      <arg><option>--outfile <replaceable>out.pdf</replaceable></option></arg>
      <arg><option>--tidy <replaceable>tidy</replaceable></option></arg>
      <arg choice=req>source.pdf</arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command. </para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
      Instead, it has inline documentation 
      accessible with <command>&dhpackage --help</command>.</para>

    <para><command>&dhpackage;</command> 
    which concatenates the pages of multiple PDF files together into a 
    single PDF file.
    It depends on a working installation of (pdf)LaTeX.
    </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>A summary of options is included below. </para>

    <variablelist>
      <varlistentry>
        <term>
          <option>--paper <replaceable>papersize</replaceable></option>
        </term>
        <listitem>
          <para>A LaTeX papersize, for example a4paper or letterpaper.
	  The default is a4paper.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--orient <replaceable>orientation</replaceable></option>
        </term>
        <listitem>
          <para>The output page orientation; one of landscape, portrait
	  or auto. The auto option guesses the orientation so as to 
	  minimize paper consumption. The default is auto.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--fitpaper <replaceable>fitpaper</replaceable></option>
        </term>
        <listitem>
          <para>True or false according to whether output page sizes and
	  orientations should match those of the input pages. Use of
	  <option>--fitpaper true</option> overrides <option>--orient
	  </option>. </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--trim <replaceable>trimspec</replaceable></option>
        </term>
        <listitem>
	<para>A page-trimming specification such as "1cm 1cm 1cm 1cm"
	(including the quoting). The default is "0 0 0 0", i.e. no trimming
	at all. Note that trimming does not mix well with using 
	<option>--frame true</option>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--offset <replaceable>offset</replaceable></option>
        </term>
        <listitem>
	<para>The offset of the position of output pages, such as
	"1cm 0.5cm" (including the quoting). 
	The default is "0 0", i.e. no offset at all. See
	the manual for the pdfLaTeX pdfpages package for further details.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--noautoscale <replaceable>noautoscale</replaceable></option>
        </term>
        <listitem>
	<para>True or false according to whether or not logical pages should
	not be scaled to fit. The default is false. </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--outfile <replaceable>out.pdf</replaceable></option>
        </term>
        <listitem>
	<para>The name of the output file. The default is 
	pdfjoined.pdf. </para>
        </listitem>
      </varlistentry>      
      <varlistentry>
        <term>
          <option>--tidy <replaceable>tidy</replaceable></option>
        </term>
        <listitem>
	<para>True or false according to whether or ot temporary files
	should be deleted immediately. If this is set to false, 
	the temporary files are left in /var/tmp. The default is true.</para>
        </listitem>
      </varlistentry>      
     </variablelist>
  </refsect1>


  <refsect1>
     <title>CONFIGURATION FILES</title>
     <para>
        Configuration of pdf90 involves specifying the location of pdflatex, the location of temporary files, etc.  This is done in a block of lines at the top of the pdf90 shell script
        itself;  settings  made  there  are  over-ridden  by  any  that   are   found   at   a   site-wide   configuration   file   (at   /etc/pdfnup.conf,   /usr/share/etc/pdfnup.conf,
        /usr/local/share/pdfnup.conf, or /usr/local/etc/pdfnup.conf) which in turn are over-ridden by any that are found in a user-defaults file at ~/.pdfnup.conf.
     </para>
  </refsect1>


        <refsect1>
    <title>SEE ALSO</title>

    <para><command>psmerge</command> (1), pdfLaTeX pdfpages package manual.</para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para><command>pdfjoin</command> is written by 
    David Firth.</para>

    <para>This manual page was written by &dhusername; (&dhemail;) for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 or any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->