Skip to content

Latest commit

 

History

History
145 lines (94 loc) · 4.7 KB

README.md

File metadata and controls

145 lines (94 loc) · 4.7 KB
Raw

IPP Sample Implementations

This code provides sample implementations of IPP Clients, Printers, Proxies, and Systems. It is largely based upon the CUPS software, with substantial changes to the original ippproxy and ippserver sample code to make them more general-purpose and configurable.

Version Apache 2.0 AppVeyor Build Status Build and Test ipp Total alerts Language grade: C/C++

Note: This code is provided for educational purposes only. It is not intended as a production solution of any kind, hasn't gone through any formal security testing or analysis, and might eat your pet...

Getting the Code

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

git clone --recurse-submodules [email protected]:istopwg/ippsample.git

git clone [email protected]:istopwg/ippsample.git
git submodule init
git submodule update

When updating an already-cloned repository:

git pull
git submodule update

Building the Code

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

./configure OPTIONS
make

The following options are supported:

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

On macOS, the "xcode" directory contains an Xcode workspace that can be used to build the code. Similarly, on Windows the "vcnet" directory contains a Visual Studio solution 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.

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.

ipptransform

The ipptransform program is a generic file conversion utility that is used primarily with ippeveprinter and ippserver to support rasterization of JPEG, PNG, and PDF documents for IPP Everywhere™ and HP PCL printers.

ipptransform3d

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

Legal Stuff

Copyright © 2014-2022 by the IEEE-ISTO Printer Working Group.

Copyright © 2007-2019 by Apple Inc.

Copyright © 1997-2007 by Easy Software Products.

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.