| 1 | .TH POLIPO 1 |
|---|
| 2 | .SH NAME |
|---|
| 3 | polipo \- a caching web proxy |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .B polipo |
|---|
| 6 | [ |
|---|
| 7 | .B \-h |
|---|
| 8 | | |
|---|
| 9 | .B \-v |
|---|
| 10 | | |
|---|
| 11 | .B \-x |
|---|
| 12 | ] [ |
|---|
| 13 | .B \-c |
|---|
| 14 | .I config |
|---|
| 15 | ] [ |
|---|
| 16 | .IB var=val |
|---|
| 17 | ]... |
|---|
| 18 | .SH DESCRIPTION |
|---|
| 19 | Polipo is a caching HTTP proxy. It listens to requests for web pages |
|---|
| 20 | from your browser and forwards them to web servers, and forwards the |
|---|
| 21 | servers' replies to your browser. In the process, it optimises and |
|---|
| 22 | cleans up the network traffic. |
|---|
| 23 | .PP |
|---|
| 24 | By default, Polipo listens on TCP port 8123. Please configure your |
|---|
| 25 | web browser to use the proxy on |
|---|
| 26 | .B localhost |
|---|
| 27 | port 8123. |
|---|
| 28 | .SH OPTIONS |
|---|
| 29 | .TP |
|---|
| 30 | .B \-h |
|---|
| 31 | Display help and exit. |
|---|
| 32 | .TP |
|---|
| 33 | .B \-v |
|---|
| 34 | Display the list of configuration variables and exit. |
|---|
| 35 | .TP |
|---|
| 36 | .B \-x |
|---|
| 37 | Purge the on-disk cache and exit. |
|---|
| 38 | .TP |
|---|
| 39 | .B \-c |
|---|
| 40 | Select an alternate configuration file. |
|---|
| 41 | .TP |
|---|
| 42 | .IB var = val |
|---|
| 43 | Change the value of a configuration variable. |
|---|
| 44 | .SH FILES |
|---|
| 45 | .TP |
|---|
| 46 | .B /etc/polipo/config |
|---|
| 47 | The default location of Polipo's configuration file. |
|---|
| 48 | .TP |
|---|
| 49 | .B /etc/polipo/forbidden |
|---|
| 50 | The default location of the list of forbidden URLs. |
|---|
| 51 | .TP |
|---|
| 52 | .B /var/cache/polipo/ |
|---|
| 53 | The default location of the on-disk cache. |
|---|
| 54 | .TP |
|---|
| 55 | .B /usr/share/polipo/www/ |
|---|
| 56 | The default root of the local web space. |
|---|
| 57 | .SH SIGNALS |
|---|
| 58 | .TP |
|---|
| 59 | .B SIGUSR1 |
|---|
| 60 | write out all in-memory objects to disk and reload the forbidden URLs file. |
|---|
| 61 | .TP |
|---|
| 62 | .B SIGUSR2 |
|---|
| 63 | write out all in-memory objects to disk, discard all in-memory |
|---|
| 64 | objects, and reload the forbidden URLs file. |
|---|
| 65 | .TP |
|---|
| 66 | .B SIGTERM, SIGINT, SIGHUP |
|---|
| 67 | write out all in-memory objects to disk and quit. |
|---|
| 68 | .SH SECURITY |
|---|
| 69 | The internal web server will follow symbolic links that point outside |
|---|
| 70 | the local document tree. You should run Polipo in a chroot jail if that |
|---|
| 71 | is a problem. |
|---|
| 72 | .PP |
|---|
| 73 | There is no reason to run Polipo as root. |
|---|
| 74 | .SH FULL DOCUMENTATION |
|---|
| 75 | The full manual for Polipo is maintained in a texinfo file, and is |
|---|
| 76 | normally available through a web server internal to Polipo. Please |
|---|
| 77 | make sure that Polipo is running, and point your favourite web browser |
|---|
| 78 | at |
|---|
| 79 | .IP |
|---|
| 80 | http://localhost:8123/ |
|---|
| 81 | .PP |
|---|
| 82 | Alternatively, you may type |
|---|
| 83 | .IP |
|---|
| 84 | $ info polipo |
|---|
| 85 | .PP |
|---|
| 86 | at a shell prompt, or |
|---|
| 87 | .IP |
|---|
| 88 | C-h i m polipo RET |
|---|
| 89 | .PP |
|---|
| 90 | in |
|---|
| 91 | .BR Emacs . |
|---|
| 92 | .SH AUTHOR |
|---|
| 93 | Polipo was written by Juliusz Chroboczek. |
|---|
