libproxy.3 revision 15993
15814N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
15814N/A<!--ArborText, Inc., 1988-1999, v.4002-->
15952N/A<!--ARC : LSARC 2009/088 Libproxy for Opensolaris-->
15814N/A<!ENTITY cmd "libproxy">
15814N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
15814N/A%commonents;
15814N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
15814N/A%booktitles;
15814N/A<!ENTITY suncopy "Copyright (c) 2004,2009 Sun Microsystems, Inc. All Rights Reserved.">
15814N/A]>
15814N/A<?Pub UDT _bookmark _target>
15814N/A<?Pub Inc>
15814N/A<refentry id="libproxy-3">
15814N/A<!-- %Z%%M% %I% %E% SMI; -->
15814N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>
15814N/A<refmiscinfo class="date">9 Feb 2009</refmiscinfo>
15814N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
15814N/A<refmiscinfo class="software">&release;</refmiscinfo>
15814N/A<refmiscinfo class="arch">generic</refmiscinfo>
15814N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
15814N/A</refmeta>
15814N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>A library that provides
15814N/Aautomatic proxy configuration management</primary></indexterm>
15814N/A<refnamediv id="libproxy-3-name"><refname>&cmd;</refname>
15814N/A<refpurpose>a library that provides automatic proxy configuration management</refpurpose></refnamediv>
15814N/A<refsect1 id="libproxy-3-desc"><title>&desc-tt;</title>
15814N/A<para>
15993N/A<command>&cmd;</command> provides interfaces to get the proxy that will be used
15993N/Ato access network resources. It uses various plugins to get proxy configuration
15993N/Avia different mechanisms (e.g. environment variables, GConf, PAC).
15993N/A</para>
15993N/A<para>
15993N/AThe envvar plugin gets the proxy configuration from the http_proxy and no_proxy
15993N/Aenvironment variables. The file plugin gets proxy configuration from
15993N/A<filename>/etc/proxy.conf</filename> and
15993N/A<filename>$HOME/.proxy.conf</filename>. The gnome plugin gets the proxy
15993N/Aconfiguration via GConf, and if the configuration uses PAC, then the mozjs
15993N/Aplugin is used.
15993N/A</para>
15993N/A<para>
15993N/AThe order in which each proxy mechanism will be checked is specified by the
15993N/Aenvironment PX_CONFIG_ORDER. The default order is
15963N/A&quot;USER,SESSION,SYSTEM,envvar&quot;. USER, SESSION and SYSTEM are all
15963N/Acategories of proxy configuration. envvar means the plugin who get proxy
15963N/Asetting from the environment variable &quot;http_proxy&quot;.
15993N/A</para>
15993N/A<para>
15993N/AThe GConf plugin belongs to the SESSION category, so the GConf setting will be
15993N/Achecked before the environment variable.
15993N/A</para>
15993N/A<para>
15993N/A<command>&cmd;</command> also supports the feature of WPAD. But for the
15993N/Aconsideration of WPAD security risks, the wpad-fallback plugin is disabled by
15993N/Adefault. Users who want to enable this feature can set the PX_CONFIG_ORDER
15993N/Aenvironment variable to &quot;USER,SESSION,SYSTEM,envvar,wpad-fallback&quot;,
15993N/Aso the WPAD will be used if all the other plugins fail to find a proxy.
15814N/A</para>
15814N/A</refsect1>
15990N/A<refsect1 id="libproxy-3-envr"><title>&envr-tt;</title>
15993N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
15993N/A5</manvolnum></citerefentry> for descriptions of environment variables.</para>
15993N/A<variablelist termlength="narrow">
15993N/A<varlistentry>
15993N/A<term><envar>http_proxy</envar></term>
15993N/A<listitem><para>
15993N/AURL of HTTP proxy to use.
15990N/A</para>
15993N/A</listitem></varlistentry>
15993N/A<varlistentry>
15993N/A<term><envar>no_proxy</envar></term>
15993N/A<listitem><para>
15993N/AA comma delimited list of hosts (or domains) for which proxying is not to be
15993N/Aused.
15993N/A</para>
15993N/A</listitem></varlistentry>
15993N/A</variablelist></refsect1>
15990N/A</refsect1>
15814N/A<refsect1 id="libproxy-3-file"><title>&file-tt;</title>
15814N/A<para>The following files are used by this application:</para>
15814N/A<variablelist termlength="wholeline">
15814N/A<varlistentry>
15814N/A<term><filename>/usr/lib/&cmd;.so</filename></term>
15814N/A<listitem><para>
15814N/Alibproxy shared library
15990N/A</para></listitem>
15990N/A</varlistentry>
15814N/A<varlistentry>
15814N/A<term><filename>/usr/lib/libproxy/*</filename></term>
15814N/A<listitem><para>
15814N/Alibproxy plugins
15990N/A</para></listitem>
15990N/A</varlistentry>
15990N/A<varlistentry>
15990N/A<term><filename>/etc/proxy.conf</filename></term>
15990N/A<term><filename>$HOME/.proxy.conf</filename></term>
15990N/A<listitem><para>
15990N/Aconfiguration file used by file plugin to look for proxy configuration
15990N/A</para></listitem>
15990N/A</varlistentry>
15814N/A</variablelist></refsect1>
15814N/A<refsect1 id="libproxy-3-attr"><title>&attr-tt;</title>
15814N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-3"><citerefentry>
15814N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
15814N/Afor descriptions of the following attributes:</para>
15814N/A<informaltable frame="all">
15814N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
15814N/A<colspec colname="COLSPEC1" colwidth="1*">
15814N/A<thead>
15814N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
15814N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
15814N/A</thead>
15814N/A<tbody>
15814N/A<row><entry><para>Availability</para></entry><entry><para>SUNWlibproxy</para></entry></row>
15814N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry colname="COLSPEC1"><para>Volatile</para></entry></row>
15814N/A</tbody>
15814N/A</tgroup>
15814N/A</informaltable>
15814N/A</refsect1>
15814N/A<refsect1 id="libproxy-3-also"><title>&also-tt;</title>
15814N/A<!--Reference to another man page-->
15814N/A<!--Reference to a Help manual-->
15814N/A<!--Reference to a book.-->
15814N/A<para>
15814N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
15990N/A<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
15990N/A<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>
15814N/A</para>
15814N/A<variablelist termlength="wholeline"><varlistentry>
15814N/A<term><filename>&cmd home page:</filename></term>
15814N/A<listitem><para><programlisting>
15814N/A<literal>http://code.google.com/p/libproxy/</literal>
15814N/A</programlisting>
15814N/A</para></listitem>
15814N/A</varlistentry></variablelist>
15814N/A</refsect1>
15814N/A<refsect1 id="libproxy-3-note"><title>&note-tt;</title>
15814N/A<para>Written by Ke Wang, Sun Microsystems Inc., 2004, 2009.</para>
15814N/A</refsect1>
15814N/A</refentry>