docs/nspr/index.rst

   1 NSPR
   2 ====
   3
   4 **Netscape Portable Runtime (NSPR)** provides a platform-neutral API for
   5 system level and libc-like functions. The API is used in the Mozilla
   6 clients, many of Red Hat's and Oracle's server applications, and other
   7 software offerings.
   8
   9 Documentation
  10 -------------
  11
  12 :ref:`About NSPR`
  13    This topic describes, in general terms, the goals of NSPR and a bit
  14    about how it does it.
  15 :ref:`NSPR API Reference`
  16    The reference describes each API public macro, structure and function
  17    in the NSPR API.
  18 :ref:`NSPR build instructions`
  19    How to checkout and build from source.
  20 :ref:`NSPR listing`
  21    All NSPR pages
  22
  23 .. _Getting_NSPR:
  24
  25 Getting NSPR
  26 ------------
  27
  28 NSPR is available in various source and binary packages, depending on
  29 your platform:
  30
  31 -  **Windows:** Build the source package, using the :ref:`NSPR build
  32    instructions`.
  33 -  **Mac:** Install the `MacPorts <http://www.macports.org/>`__ *nspr*
  34    package, or the `Homebrew <http://brew.sh>`__ *nspr* package.
  35 -  **Ubuntu:** Install the *libnspr4-dev* package via ``apt-get.``
  36 -  **Debian:** Install the *libnspr4-dev* package via ``apt-get``.
  37 -  **openSUSE Linux:** Install one or more of the following via ``yast``
  38    or ``zypper`` :
  39
  40    -  *mozilla-nspr* : Binary libraries for your platform
  41    -  *mozilla-nspr-32bit* : Binary libraries needed to run 32-bit
  42       programs on a 64-bit OS
  43    -  *mozilla-nspr-devel* : Files needed (in addition to the above
  44       libraries) to compile programs using NSPR
  45    -  *mozilla-nspr-debuginfo* : Debug information (including build
  46       symbols) for package *mozilla-nspr*
  47    -  *mozilla-nspr-debuginfo-32bit* : Debug information (including
  48       build symbols) for package *mozilla-nspr-32bit*
  49    -  *mozilla-nspr-debugsource* : Debug sources for all of the above
  50
  51 Community
  52 ---------
  53
  54 View Mozilla forums:
  55
  56 -  `Mailing list <https://lists.mozilla.org/listinfo/dev-tech-nspr>`__
  57 -  `Newsgroup <http://groups.google.com/group/mozilla.dev.tech.nspr>`__
  58 -  `RSS
  59    feed <http://groups.google.com/group/mozilla.dev.tech.nspr/feeds>`__
  60
  61 .. _Related_Topics:
  62
  63 Related Topics
  64 --------------
  65
  66 -  :ref:`Networking`, :ref:`Network Security Services (NSS)`