IPP Sample Implementations

This code provides sample, non-production-ready implementations of IPP Clients, Printers, Proxies, and Systems. It makes use of the CUPS Library v3 and PDFio library projects to provide low-level HTTP, IPP, and PDF support. The ippserver and ipp3dprinter code was also inspired by the original CUPS ippeveprinter source code.

Note: This code is provided for educational purposes only. While we will make every effort to ensure the code is bug-free and regularly run the code through dynamic and static analysis tools, it is written for correctness, not performance, and so is not intended for use as a production solution. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

Getting the Code

Do not use the ZIP file available via the Github "Code" button on the main project page, as that archive is missing the libcups and PDFio submodules and will not compile.

The source code is available in semi-monthly release tarballs or via the Github repository. For a release tarball, run the following commands:

tar xvzf ippsample-VERSION.tar.gz
cd ippsample-VERSION

Similarly, the release ZIP file can be extracted with the following commands:

unzip ippsample-VERSION.zip
cd ippsample-VERSION

From the Github sources, clone the repository with the --recurse-submodules option or use the git submodule commands:

git clone --recurse-submodules git@github.com:istopwg/ippsample.git
cd ippsample

git clone git@github.com:istopwg/ippsample.git
cd ippsample
git submodule update --init --recursive

To update an already-cloned repository:

git pull
git submodule update --init --recursive

Building the Code

The IPP sample code uses a configure script on POSIX platforms to take care of any platform differences:

./configure --disable-shared OPTIONS
make

The following options are supported:

--enable-debug: Enable debugging and debug logging.
--disable-shared: Disable shared libraries (enabled otherwise).
--enable-maintainer: Enable warnings as errors.
--enable-sanitizer: Enable address sanitizer.
--enable-static: Enable static libraries.
--prefix=PATH: Configure the installation directory, the default is /usr/local.

On macOS, the "xcode" directory contains an Xcode workspace called "ippsample.xcworkspace" that can be used to build the code. Similarly, on Windows the "vcnet" directory contains a Visual Studio solution called "ippsample.sln" that can be used to build the code.

Testing the Code

The "test" target runs all of the unit tests and a full-up "system" test of the various programs:

make test

Resources

The IPP sample code includes per-specification ipptool test files under the "examples" directory.

The following documentation files may be of use as well:

BUILD.md: Detailed build instructions
CONTRIBUTING.md: How to contribute to the ippsample project
DEVELOPING.md: How to develop code for the ippsample project
DOCKER.md: How to build ippsample in a Docker container
PI.md: How to build ippsample for various Raspberry Pi boards
SCRIPTING.md: How to use the ippserver REST API
TESTING.md: How to test ippserver with the sample configuration under the test subdirectory
man/*: Man pages for each of the ippsample programs in nroff and HTML formats

ipp3dprinter

The ipp3dprinter program implements a single IPP 3D printer and can be configured to use a print command to do processing of document data.

ippdoclint

The ippdoclint program verifies and reports on document data. It is primarily used for testing IPP Clients with the ippeveprinter and ippserver programs.

ippproxy

The ippproxy program implements a generic IPP Proxy interface that allows you to connect a local IPP or PCL printer to an IPP Infrastructure Printer such as the ippserver program.

ippserver

The ippserver program implements the IPP System Service and provides a generic IPP Printer interface that allows you to host shared printers using the IPP Shared Infrastructure Extensions as well as support local printing or document processing.

ipptransform3d

The ipptransform3d program is a generic 3D file conversion utility that is used primarily with ippserver to support 3MF, G-code, and STL printing to 3D printers using the CuraEngine software.

Legal Stuff

This software is provided under the terms of the Apache License, Version 2.0. A copy of this license can be found in the file LICENSE. Additional legal information is provided in the file NOTICE.

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.