Go to file
Tom Hughes 2b945f22ff Include GPLv3 text
Because LGPLv3 builds on top of GPLv3 the text of both licenses
need to be included. Also use the names that FSF reccomend.
2015-06-23 17:08:59 +01:00
debian Version 1.3.3 released 2014-03-15 16:11:32 +01:00
include/osmpbf Version 1.3.3 released 2014-03-15 16:11:32 +01:00
redhat Updated redhat spec and Makefile 2014-03-26 18:45:48 +04:00
resources Java file read demonstration, to help people getting started. 2012-10-19 23:00:21 +01:00
src Updated redhat spec and Makefile 2014-03-26 18:45:48 +04:00
src.java/crosby/binary Fix line endings (CRLF->LF), remove spaces at end of lines 2013-09-02 20:44:02 +02:00
tools Add support for large files 2014-03-17 22:01:55 +01:00
.gitignore Improved debian build, better README 2014-03-10 22:00:35 +01:00
CMakeLists.txt More compilation fixes 2013-07-22 23:13:26 +06:00
COPYING Include GPLv3 text 2015-06-23 17:08:59 +01:00
COPYING.LESSER Include GPLv3 text 2015-06-23 17:08:59 +01:00
README Improved build script. 2014-03-11 11:25:07 +01:00
ReleaseNotes.txt Version 1.3.3 released 2014-03-15 16:11:32 +01:00
build.sh Protobufs and common Java code for binary format. 2010-08-25 11:40:06 -05:00
build.xml Fix build.xml to work with Ubuntu 12.04 where protobuf jar has different name 2014-03-30 21:28:14 +02:00
magic add magic file 2011-06-05 11:51:11 +02:00
pom.xml Version 1.3.3 released 2014-03-15 16:11:32 +01:00

README

OSMPBF
======

Osmpbf is a Java/C library to read and write OpenStreetMap PBF files.
PBF (Protocol buffer Binary Format) is a binary file format for OpenStreetMap
data that uses Google Protocol Buffers as low-level storage.

For more information see http://wiki.openstreetmap.org/wiki/PBF_Format .


Java Version
============

To build the osmpbf.jar file run:
  ant

For a Java usage example, see src.java/crosby/binary/test/ReadFileExample.java


C Version
=========

To compile:
  make -C src

To install:
  make -C src install

There is a tool named osmpbf-outline that shows a debug output of the contents
of a PBF file. To compile it:
  make -C tools


Using the C Library
===================

To include in your program use:

#include <osmpbf/osmpbf.h>

and link with:
    -pthread -lz -lprotobuf-lite -losmpbf


Debian/Ubuntu Packages
======================

To build the Debian/Ubuntu packages:
  debuild -I -us -uc

To install the Debian/Ubuntu packages:
  sudo dpkg --install ../libosmpbf-dev_*.deb
  sudo dpkg --install ../libosmpbf-java_*.deb
  sudo dpkg --install ../osmpbf-bin_*.deb

To clean up after:
  debclean