blob: 8599918c12708bf2b988e4729d2d17ad81ec75a2 [file]
<!--
! Licensed to the Apache Software Foundation (ASF) under one or more
! contributor license agreements. See the NOTICE file distributed with
! this work for additional information regarding copyright ownership.
! The ASF licenses this file to You under the Apache License, Version 2.0
! (the "License"); you may not use this file except in compliance with
! the License. You may obtain a copy of the License at
!
! http://www.apache.org/licenses/LICENSE-2.0
!
! Unless required by applicable law or agreed to in writing, software
! distributed under the License is distributed on an "AS IS" BASIS,
! WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
! See the License for the specific language governing permissions and
! limitations under the License.
!-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>PDFBox Command Line Utilities</title>
</header>
<body>
<section>
<title>Description</title>
<p>
PDFBox comes with a series of command line utilities. They are available as windows binaries
and as standard Java applications.
</p>
<p>
In order to run them as java applications you need to add the following jars to your classpath
</p>
<ul>
<li>%PDFBOX_HOME%\external\log4j-1.2.9.jar</li>
<li>%PDFBOX_HOME%\lib\PDFBox-0.X.X.jar</li>
</ul>
<p>
PDFBox uses log4j for logging, if you do not set up log4j then you will get a warning like this
</p>
<note>
log4j:WARN No appenders could be found for logger (org.pdfbox.util.ResourceLoader).<br/>
log4j:WARN Please initialize the log4j system properly.
</note>
<p>
See the log4j <a href="http://logging.apache.org/log4j/docs/documentation.html">documentation</a> for more information on how to set up log4j.
</p>
<p>
In order to run them as window applications you will need to have the .NET framework installed and add
%PDFBOX_HOME%\bin to your path.
</p>
</section>
</body>
</document>