<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man tidy-proxy.sgml > tidy-proxy.1'.  You may view
     the manual page with: `docbook-to-man tidy-proxy.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

tidy-proxy.1: tidy-proxy.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Jonas</firstname>">
  <!ENTITY dhsurname   "<surname>Meurer</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>January 13, 2003</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>jonas@freesources.org</email>">
  <!ENTITY dhusername  "Jonas Meurer">
  <!ENTITY dhucpackage "<refentrytitle>TIDY-PROXY</refentrytitle>">
  <!ENTITY dhpackage   "tidy-proxy">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2001</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>small http proxy which tidies html</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option> \-\-host</option> hostname</arg><arg><option> \-p</option> port</arg><arg><option> \-d</option></arg><arg><option> \-l</option> {1|2}</arg><arg><option> \-\-action</option> {t|v}</arg><arg><option> \-\-tidy\-cmd</option> tidy\-command</arg><arg><option> \-\-validate\-cmd</option> validate command</arg><arg><option> \-\-pid</option> pid\-file</arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>&dhpackage; is a small proxy server written in perl. using this
     proxy web-pages are checked for HTML errors with tidy or validate
     while they are downloaded.
     The results are displayed on top of that page.
     &dhpackage; is mainly intended for developing dynamic web-pages.
     </para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term><option>\-\-host</option> *host*</term>
        <listitem>
          <para>the host parameter sets the listening address for tidy-proxy. [default: localhost]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-p, \-\-port</option> *port*</term>
        <listitem>
          <para>port sets the listening port for tidy-proxy. [default: 9090]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-d, \-\-nodaemon</option></term>
        <listitem>
          <para>run tidy-proxy in foreground</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-l, \-\-level</option> *level*</term>
        <listitem>
          <para>level sets the filtering level for tidy-proxy 1: Warnings 2: Errors</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-\-action</option> *t|v*</term>
        <listitem>
          <para>set if to use *t*idy or *v*alidate. [default: tidy]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-\-tidy\-cmd</option> *cmd*</term>
        <listitem>
          <para>Command to use for tidy. [default: /usr/bin/tidy]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-\-validate\-cmd</option> *cmd*</term>
        <listitem>
          <para>Command to use for validate. [default: /usr/bin/validate]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-\-pid</option> *pid\-file*</term>
        <listitem>
          <para>Create a pid file. Works only in daemon mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-\-dest\-host</option> *destination host*</term>
        <listitem>
          <para>run tidy-proxy in reverse-proxy mode. tidy-proxy acts as normal
          webserver and forwards every request to *destination host*. If you
          use this option, you probably want to enable --loc-rewrite.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-\-loc\-rewrite</option></term>
        <listitem>
          <para>rewrite the Location and the Host header in reverse-proxy mode.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-\-email</option> *email@adr.org*</term>
        <listitem>
          <para>Send email report, if invalid page is found (instead of reporting
          it). This option requires Email::Simple, Email::Simple::Creator and
          Email::Send.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>\-h, \-?, \-\-help</option></term>
        <listitem>
          <para>Prints help message.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>tidy(1), validate(1)</para>
  </refsect1>
  <refsect1>
    <title>COPYRIGHT</title>

    <para>Copyright (C) 2003-2006: &dhusername; <&dhemail;>

      This program is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published by
      the Free Software Foundation; version 2.

      This  program  is  distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
      General Public License for more details.

      You should have received a copy of the GNU General Public License
      along with this program; if not, write to the Free Software
      Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
      02110-1301, USA.
      </para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


