15983N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

15983N/A<!--ArborText, Inc., 1988-1999, v.4002-->

15983N/A<!ENTITY cmd "libproxy">

15983N/A<!ENTITY % commonents SYSTEM "smancommon.ent">

15983N/A%commonents;

15983N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">

15983N/A%booktitles;

15983N/A<!ENTITY suncopy "Copyright (c) 2004,2009 Sun Microsystems, Inc. All Rights Reserved.">

15983N/A]>

15983N/A<?Pub UDT _bookmark _target>

15983N/A<?Pub Inc>

15983N/A<refentry id="libproxy-3">

15983N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>3</manvolnum>

15983N/A<refmiscinfo class="date">9 Feb 2009</refmiscinfo>

15983N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>

15983N/A<refmiscinfo class="software">&release;</refmiscinfo>

15983N/A<refmiscinfo class="arch">generic</refmiscinfo>

15983N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

15983N/A</refmeta>

15983N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>A library that provides

15983N/Aautomatic proxy configuration management</primary></indexterm>

15983N/A<refnamediv id="libproxy-3-name"><refname>&cmd;</refname>

15983N/A<refpurpose>a library that provides automatic proxy configuration management</refpurpose></refnamediv>

15983N/A<refsect1 id="libproxy-3-desc"><title>&desc-tt;</title>

15983N/A<para>

15983N/A<command>&cmd;</command> provides interfaces to get the proxy that will be used

15983N/Ato access network resources. It uses various plugins to get proxy configuration

15983N/Avia different mechanisms (e.g. environment variables, GConf, PAC).

15983N/A</para>

15983N/A<para>

15991N/AThe envvar plugin gets the proxy configuration from the http_proxy and no_proxy

15991N/Aenvironment variables. The file plugin gets proxy configuration from

15983N/A<filename>/etc/proxy.conf</filename> and

15983N/A<filename>$HOME/.proxy.conf</filename>. The gnome plugin gets the proxy

15983N/Aconfiguration via GConf, and if the configuration uses PAC, then the mozjs

15991N/Aplugin is used.

15991N/A</para>

15991N/A<para>

15991N/AThe order in which each proxy mechanism will be checked is specified by the

15991N/Aenvironment PX_CONFIG_ORDER. The default order is

15991N/A&quot;USER,SESSION,SYSTEM,envvar&quot;. USER, SESSION and SYSTEM are all

15991N/Acategories of proxy configuration. envvar means the plugin who get proxy

15991N/Asetting from the environment variable &quot;http_proxy&quot;.

15983N/A</para>

15983N/A<para>

15991N/AThe GConf plugin belongs to the SESSION category, so the GConf setting will be

15991N/Achecked before the environment variable.

15983N/A</para>

15983N/A<para>

15991N/A<command>&cmd;</command> also supports the feature of WPAD. But for the

15991N/Aconsideration of WPAD security risks, the wpad-fallback plugin is disabled by

15983N/Adefault. Users who want to enable this feature can set the PX_CONFIG_ORDER

15991N/Aenvironment variable to &quot;USER,SESSION,SYSTEM,envvar,wpad-fallback&quot;,

15983N/Aso the WPAD will be used if all the other plugins fail to find a proxy.

15983N/A</para>

15983N/A</refsect1>

15991N/A<refsect1 id="libproxy-3-envr"><title>&envr-tt;</title>

15983N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>

15991N/A5</manvolnum></citerefentry> for descriptions of environment variables.</para>

15991N/A<variablelist termlength="narrow">

15983N/A<varlistentry>

15983N/A<term><envar>http_proxy</envar></term>

15991N/A<listitem><para>

15983N/AURL of HTTP proxy to use.

15983N/A</para>

15991N/A</listitem></varlistentry>

15983N/A<varlistentry>

15991N/A<term><envar>no_proxy</envar></term>

15983N/A<listitem><para>

15983N/AA comma delimited list of hosts (or domains) for which proxying is not to be

15983N/Aused.

15983N/A</para>

15983N/A</listitem></varlistentry>

15983N/A</variablelist></refsect1>

15983N/A</refsect1>

15983N/A<refsect1 id="libproxy-3-file"><title>&file-tt;</title>

15983N/A<para>The following files are used by this application:</para>

15983N/A<variablelist termlength="wholeline">

15983N/A<varlistentry>

15983N/A<term><filename>/usr/lib/&cmd;.so</filename></term>

15983N/A<listitem><para>

15983N/Alibproxy shared library

15983N/A</para></listitem>

15983N/A</varlistentry>

15983N/A<varlistentry>

15983N/A<term><filename>/usr/lib/libproxy/*</filename></term>

15983N/A<listitem><para>

15983N/Alibproxy plugins

15983N/A</para></listitem>

15983N/A</varlistentry>

15983N/A<varlistentry>

15983N/A<term><filename>/etc/proxy.conf</filename></term>

15983N/A<term><filename>$HOME/.proxy.conf</filename></term>

15983N/A<listitem><para>

15983N/Aconfiguration file used by file plugin to look for proxy configuration

15983N/A</para></listitem>

15983N/A</varlistentry>

15983N/A</variablelist></refsect1>

15983N/A<refsect1 id="libproxy-3-attr"><title>&attr-tt;</title>

15983N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-3"><citerefentry>

15983N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

15983N/Afor descriptions of the following attributes:</para>

15983N/A<informaltable frame="all">

15983N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

15983N/A<colspec colname="COLSPEC1" colwidth="1*">

15983N/A<thead>

15983N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

15983N/Avalign="middle">ATTRIBUTE VALUE</entry></row>

15983N/A</thead>

15983N/A<tbody>

15983N/A<row><entry><para>Availability</para></entry><entry><para>library/libproxy</para></entry></row>

15983N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry colname="COLSPEC1"><para>Volatile</para></entry></row>

15983N/A</tbody>

15983N/A</tgroup>

15983N/A</informaltable>

15983N/A</refsect1>

15983N/A<refsect1 id="libproxy-3-also"><title>&also-tt;</title>

<para>

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gnome-interfaces</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>environ</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

<variablelist termlength="wholeline"><varlistentry>

<term><filename>&cmd home page:</filename></term>

<listitem><para><programlisting>

<literal>http://code.google.com/p/libproxy/</literal>

</programlisting>

</para></listitem>

</varlistentry></variablelist>

</refsect1>

<refsect1 id="libproxy-3-note"><title>&note-tt;</title>

<para>Written by Ke Wang, Sun Microsystems Inc., 2004, 2009.</para>

</refsect1>

</refentry>