update README.packaging

git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@9637 67ed7778-7388-44ab-90cf-0a291f65f57c

1 files changed, 78 insertions, 3 deletions

diff --git a/README.packaging b/README.packaging
index 0274c9bdd..716628876 100644
--- a/README.packaging
+++ b/README.packaging
@@ -7,15 +7,70 @@ packages (.debs, .rpms, ports, emerges, etc. pp.)
 
 
 ========================================================================
+libgphoto2 and libgphoto2_port
+==============================
+
+The libgphoto2 library builds on the libgphoto2_port library, which is
+thus internally contained within every libgphoto2 release. By
+installing libgphoto2, you always also install libgphoto2_port.
+
+
+========================================================================
+Installed files
+===============
+
+A standard install of libgphoto2 into --prefix=/usr does about this:
+
+   * The most important files:
+     * /usr/lib/libgphoto2.{a,la,so}
+     * /usr/lib/libgphoto2/<VERSION>/*.{a,la,so}        (camlibs)
+     * /usr/lib/libgphoto2_port.{a,la,so}
+     * /usr/lib/libgphoto2_port/<VERSION>/*.{a,la,so}   (iolibs)
+     In most cases, you can remove the *.a and *.la files from the
+     list of files to ship.
+   * Packaging helpers:
+     * /usr/lib/libgphoto2/print-camera-list
+     * /usr/lib/libgphoto2/print-usb-usermap (linux-hotplug, obsolete)
+     * /usr/sbin/check-mtp-device
+     * /usr/sbin/check-ptp-camera
+   * Documentation:
+     * Man pages:
+       * /usr/man/man3/libgphoto3.1
+       * /usr/man/man3/libgphoto3_port.1
+     * /usr/share/doc/libgphoto2/camlibs/README.*    (camlib docs)
+     * /usr/share/doc/libgphoto2/{README,AUTHORS,NEWS}
+     * /usr/share/doc/libgphoto2/apidocs.html/       API docs
+     * /usr/share/doc/libgphoto2_port/{README,AUTHORS,NEWS}
+     You may want to install these files into your custom locations.
+     If you separate library from libfoo-devel packages, the former
+     should probably ship with the camlib docs, and the general README
+     and NEWS.
+   * Translated strings:
+     * /usr/share/locale/*/LC_MESSAGES/libgphoto2-2.mo
+     * /usr/share/locale/*/LC_MESSAGES/libgphoto2_port-0.mo
+     * /usr/share/libgphoto2/<VERSION>/konica/*
+       These files are required for the konica camlib to work at all.
+   * For developers:
+     * /usr/include/gphoto2/gphoto2*.h
+     * /usr/lib/libgphoto2.pc
+     * /usr/lib/libgphoto2_port.pc
+
+
+========================================================================
 Permission setup
 ================
 
+We consider it a bug in the package if the package does not offer a
+way for the user to just plug in his camera and use it. This may at
+most require adding the user to a "camera" or "plugdev" group.
+
 You will want to create HAL or UDEV rules by running this utility:
 
-    print-camera-list
+   * print-camera-list
 
 This utility requires libgphoto2 and its camlibs being installed,
 either
+
    * at package building time by doing a DESTDIR based temporary
      install somewhere and setting LD_LIBRARY_PATH and CAMLIBS before
      running print-camera-list
@@ -24,8 +79,8 @@ either
 The UDEV rules require two helper scripts/binaries, which obviously
 need to be installed by the package:
 
-    check_mtp_device
-    check_ptp_camera
+   * check-mtp-device
+   * check-ptp-camera
 
 You can either use fixed permissions in the generated rules, or call
 your own permission setup script to dynamically decide what to do.
@@ -34,5 +89,25 @@ your own permission setup script to dynamically decide what to do.
 
 
 ========================================================================
+Development packages
+====================
+
+The recommended way to use libgphoto2 in a build process is to use
+pkg-config and thus these files really should be shipped in a package:
+
+   * /usr/lib/pkgconfig/libgphoto2.pc
+   * /usr/lib/pkgconfig/libgphoto2_port.pc
+
+We are still shipping
+
+   * /usr/bin/gphoto2-config
+   * /usr/bin/gphoto2-port-config
+
+for compatibility reasons, but that will obviously break when you have
+a /usr/lib64 vs. /usr/lib conflict. That problem is one the packager
+will have to resolve - we consider this mechanism obsolete.
+
+
+========================================================================
 End of file.
 ========================================================================