<!--
- File : $Source: /cvsroot/ijbswa/current/doc/source/privoxy-man-page.sgml,v $
+ File : doc/source/privoxy-man-page.sgml
Purpose : Manual Page
- This file belongs into
- ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: privoxy-man-page.sgml,v 2.39 2011/11/13 17:03:54 fabiankeil Exp $
-
- Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
<!entity copyright SYSTEM "copyright.sgml">
<!entity license SYSTEM "license.sgml">
<!entity authors SYSTEM "p-authors.sgml">
-<!entity p-version "3.0.19">
-<!entity p-status "stable">
-<!entity % p-not-stable "IGNORE">
-<!entity % p-stable "INCLUDE">
+<!entity p-version "3.0.33">
+<!entity p-status "UNRELEASED">
+<!entity % p-not-stable "INCLUDE">
+<!entity % p-stable "IGNORE">
<!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
-<!entity % p-authors-formal "IGNORE"> <!-- exclude additional formating -->
+<!entity % p-authors-formal "IGNORE"> <!-- exclude additional formatting -->
<!entity my-copy "(C)"> <!-- db2man barfs on copyright symbol -->
<!entity % seealso-extra "IGNORE"> <!-- for excluding sections of seealso -->
]>
<refentry id="privoxy">
<refentryinfo>
- <date>2009-02-15</date>
+ <date>2012-11-08</date>
</refentryinfo>
<refmeta>
<refentrytitle>privoxy</refentrytitle>
- <manvolnum>1</manvolnum>
+ <manvolnum>8</manvolnum>
<refmiscinfo>
Privoxy &p-version;<![%p-not-stable;[ &p-status;]]>
</refmiscinfo>
<refsynopsisdiv>
<cmdsynopsis>
<command>privoxy</command>
+ <arg><option>--chroot</option></arg>
+ <arg><option>--config-test</option></arg>
<arg><option>--help</option></arg>
- <arg><option>--version</option></arg>
<arg><option>--no-daemon</option></arg>
<arg><option>--pidfile </option><replaceable class="parameter">pidfile</replaceable></arg>
- <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
- <arg><option>--chroot</option></arg>
<arg><option>--pre-chroot-nslookup </option><replaceable class="parameter">hostname</replaceable></arg>
+ <arg><option>--user </option><replaceable class="parameter">user[.group]</replaceable></arg>
+ <arg><option>--version</option></arg>
<arg><replaceable class="parameter">configfile</replaceable></arg>
</cmdsynopsis>
</para>
<variablelist>
+
<varlistentry>
- <term>--help</term>
+ <term>--chroot</term>
+ <listitem>
+ <para>
+ Before changing to the user ID given in the --user option, chroot to
+ that user's home directory, i.e. make the kernel pretend to the
+ <command>Privoxy</command> process that the directory tree starts
+ there. If set up carefully, this can limit the impact of possible
+ vulnerabilities in <command>Privoxy</command> to the files contained in
+ that hierarchy.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--config-test</term>
<listitem>
<para>
- Print brief usage info and exit.
+ Exit after loading the configuration files before binding to
+ the listen address. The exit code signals whether or not the
+ configuration files have been successfully loaded.
+ </para>
+ <para>
+ If the exit code is 1, at least one of the configuration files
+ is invalid, if it is 0, all the configuration files have been
+ successfully loaded (but may still contain errors that can
+ currently only be detected at run time).
</para>
+ <para>
+ This option doesn't affect the log setting, combination with
+ "--no-daemon" is recommended if a configured log file shouldn't
+ be used.
+ </para>
</listitem>
</varlistentry>
<varlistentry>
- <term>--version</term>
+ <term>--help</term>
<listitem>
<para>
- Print version info and exit.
+ Print brief usage info and exit.
</para>
</listitem>
</varlistentry>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>--pre-chroot-nslookup <replaceable class="parameter">hostname</replaceable></term>
+ <listitem>
+ <para>
+ Initialize the resolver library using <replaceable class="parameter">hostname</replaceable>
+ before chroot'ing. On some systems this reduces the number of files
+ that must be copied into the chroot tree.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry>
<term>--user <replaceable class="parameter">user[.group]</replaceable></term>
<listitem>
</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>--chroot</term>
- <listitem>
- <para>
- Before changing to the user ID given in the --user option, chroot to
- that user's home directory, i.e. make the kernel pretend to the
- <command>Privoxy</command> process that the directory tree starts
- there. If set up carefully, this can limit the impact of possible
- vulnerabilities in <command>Privoxy</command> to the files contained in
- that hierarchy.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>--pre-chroot-nslookup <replaceable class="parameter">hostname</replaceable></term>
- <listitem>
- <para>
- Initialize the resolver library using <replaceable class="parameter">hostname</replaceable>
- before chroot'ing. On some systems this reduces the number of files
- that must be copied into the chroot tree.
- </para>
- </listitem>
+ <term>--version</term>
+ <listitem>
+ <para>
+ Print version info and exit.
+ </para>
+ </listitem>
</varlistentry>
+
</variablelist>
<para>
</para>
<para>
See the <ulink
- url="http://www.privoxy.org/user-manual/"><citetitle>User Manual</citetitle></ulink> for a detailed
+ url="https://www.privoxy.org/user-manual/"><citetitle>User Manual</citetitle></ulink> for a detailed
explanation of installation, general usage, all configuration options, new
features and notes on upgrading.
</para>
<refsect1><title>Signals</title>
<para>
<!-- command tag is used here to get proper looking format -->
- <command>Privoxy</command> terminates on the <command>SIGINT</command>,
- <command>SIGTERM</command> and <command>SIGABRT</command> signals. Log
+ <command>Privoxy</command> terminates on the <command>SIGINT</command>
+ and <command>SIGTERM</command> signals. Log
rotation scripts may cause a re-opening of the logfile by sending a
<command>SIGHUP</command> to <command>Privoxy</command>. Note that unlike
other daemons, <command>Privoxy</command> does not need to be made aware of
config file changes by <command>SIGHUP</command> -- it will detect them
- automatically.
+ automatically. Signals other than the ones listed above aren't explicitly
+ handled and result in the default action defined by the operating system.
</para>
</refsect1>