components/library/mozilla-nspr/files/nspr-config.xml

   1 <?xml version='1.0' encoding='utf-8'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <refentry id="nspr-config">
   6
   7   <refentryinfo>
   8     <date>15 October 2024</date>
   9     <title>Netscape Portable Runtime</title>
  10     <productname>nspr</productname>
  11     <productnumber>@version@</productnumber>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>nspr-config</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>nspr-config</refname>
  21     <refpurpose>Return meta information about nspr libraries</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>nspr-config</command>
  27       <arg><option>--prefix</option></arg>
  28       <arg><option>--exec-prefix</option></arg>
  29       <arg><option>--includedir</option></arg>
  30       <arg><option>--libs</option></arg>
  31       <arg><option>--cflags</option></arg>
  32       <arg><option>--libdir</option></arg>
  33       <arg><option>--version</option></arg>
  34     </cmdsynopsis>
  35   </refsynopsisdiv>
  36
  37 <refsection id="description">
  38     <title>Description</title>
  39     <para><command>nspr-config</command> is a shell script which can be used to obtain gcc options for building client pacakges of nspr.</para>
  40   </refsection>
  41
  42   <refsection>
  43     <title>Options</title>
  44
  45     <variablelist>
  46       <varlistentry>
  47         <term><option>--prefix</option></term>
  48         <listitem><simpara>Returns the top level system directory under which the nspr libraries are installed.</simpara></listitem>
  49       </varlistentry>
  50
  51       <varlistentry>
  52         <term><option>--exec-prefix</option></term>
  53         <listitem><simpara>Returns the top level system directory under which any nspr binaries would be installed.</simpara></listitem>
  54       </varlistentry>
  55
  56       <varlistentry>
  57         <term><option>--includedir</option> <replaceable>count</replaceable></term>
  58         <listitem><simpara>Returns the path to the directory were the nspr headers are installed.</simpara></listitem>
  59       </varlistentry>
  60
  61       <varlistentry>
  62         <term><option>--version</option></term>
  63         <listitem><simpara>Returns the upstream version of nspr in the form major_version-minor_version-patch_version.</simpara></listitem>
  64       </varlistentry>
  65
  66       <varlistentry>
  67         <term><option>--libs</option></term>
  68         <listitem><simpara>Returns the compiler linking flags.</simpara></listitem>
  69       </varlistentry>
  70
  71       <varlistentry>
  72         <term><option>--cflags</option></term>
  73         <listitem><simpara>Returns the compiler include flags.</simpara></listitem>
  74       </varlistentry>
  75
  76       <varlistentry>
  77         <term><option>--libdir</option></term>
  78         <listitem><simpara>Returns the path to the directory were the nspr libraries are installed.</simpara></listitem>
  79       </varlistentry>
  80
  81     </variablelist>
  82   </refsection>
  83
  84   <refsection>
  85     <title>Examples</title>
  86
  87     <para>The following example will query for both include path and linkage flags:
  88       <programlisting>
  89         /usr/bin/nspr-config --cflags --libs
  90       </programlisting>
  91     </para>
  92
  93
  94   </refsection>
  95
  96   <refsection>
  97     <title>Files</title>
  98
  99     <para><filename>/usr/bin/nspr-config</filename></para>
 100
 101   </refsection>
 102
 103   <refsection>
 104     <title>See also</title>
 105     <para>pkg-config(1)</para>
 106   </refsection>
 107
 108   <refsection id="authors">
 109     <title>Authors</title>
 110     <para>The NSPR liraries were written and maintained by developers with Netscape, Red Hat,  Sun, Oracle, Mozilla, and Google.</para>
 111     <para>
 112         Authors: Elio Maldonado &lt;emaldona@redhat.com>.
 113     </para>
 114   </refsection>
 115
 116 <!-- don't change -->
 117   <refsection id="license">
 118     <title>LICENSE</title>
 119     <para>Licensed under the Mozilla Public License, v. 2.0.  If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 120     </para>
 121   </refsection>
 122
 123 </refentry>
 124