current/doc/source p-config.sgml,2.125,2.126

Update of /cvsroot/ijbswa/current/doc/source
In directory sfp-cvs-1.v30.ch3.sourceforge.com:/tmp/cvs-serv28250/doc/source

Modified Files:
	p-config.sgml 
Log Message:
Document the receive-buffer-size directive

Sponsored by: Robert Klemme


Index: p-config.sgml
===================================================================
RCS file: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v
retrieving revision 2.125
retrieving revision 2.126
diff -C2 -d -r2.125 -r2.126
*** p-config.sgml	8 Mar 2017 13:11:01 -0000	2.125
--- p-config.sgml	29 May 2017 10:02:37 -0000	2.126
***************
*** 3658,3665 ****
  </sect3>
  
! </sect2>
  
  <!--  ~  End section  ~  -->
  
  <!--   ~~~~~       New section      ~~~~~     -->
  
--- 3658,3739 ----
  </sect3>
  
! <!--  ~  End section  ~  -->
! 
! <!--   ~~~~~       New section      ~~~~~     -->
! 
! <sect3 renderas="sect4" id="receive-buffer-size"><title>receive-buffer-size</title>
! <variablelist>
!  <varlistentry>
!   <term>Specifies:</term>
!   <listitem>
!    <para>
!     The size of the buffer Privoxy uses to receive data from the server.
!    </para>
!   </listitem>
!  </varlistentry>
!  <varlistentry>
!   <term>Type of value:</term>
!   <listitem>
!    <para>
!     <replaceable>Size in bytes</replaceable>
!    </para>
!   </listitem>
!  </varlistentry>
!  <varlistentry>
!   <term>Default value:</term>
!   <listitem>
!    <para>5000</para>
!   </listitem>
!  </varlistentry>
!  <varlistentry>
!   <term>Notes:</term>
!   <listitem>
!    <para>
!     Increasing the receive-buffer-size increases Privoxy's memory usage but
!     can lower the number of context switches and thereby reduce the
!     cpu usage and potentially increase the throughput.
!    </para>
!    <para>
!     This is mostly relevant for fast network connections and
!     large downloads that don't require filtering.
!    </para>
!    <para>
!     Reducing the buffer size reduces the amount of memory Privoxy
!     needs to handle the request but increases the number of systemcalls
!     and may reduce the throughput.
!    </para>
!    <para>
!     A dtrace command like:
!     <quote>sudo dtrace -n 'syscall::read:return /execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0, 5, 20); @m = max(arg0)}'</quote>
!     can be used to properly tune the receive-buffer-size.
!     On systems without dtrace, strace or truss may be used as
!     less convenient alternatives.
!    </para>
!    <para>
!     If the buffer is too large it will increase Privoxy's memory
!     footprint without any benefit. As the memory is (currently)
!     cleared before using it, a buffer that is too large can
!     actually reduce the throughput.
!    </para>
!   </listitem>
!  </varlistentry>
!  <varlistentry>
!   <term>Examples:</term>
!   <listitem>
!    <para>
!     <screen>
!       # Increase the receive buffer size
!       receive-buffer-size 32768
!     </screen>
!    </para>
!   </listitem>
!  </varlistentry>
! </variablelist>
! </sect3>
  
  <!--  ~  End section  ~  -->
  
+ </sect2>
+ 
  <!--   ~~~~~       New section      ~~~~~     -->
  


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot