source: squid-ssl/trunk/fuentes/helpers/storeid_rewrite/file/storeid_file_rewrite.8 @ 5496

Last change on this file since 5496 was 5496, checked in by Juanma, 22 months ago

Initial release

File size: 7.2 KB
Line 
1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v
7.if n .sp
8..
9.de Vb \" Begin verbatim text
10.ft CW
11.nf
12.ne \\$1
13..
14.de Ve \" End verbatim text
15.ft R
16.fi
17..
18.\" Set up some character translations and predefined strings.  \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26.ie n \{\
27.    ds -- \(*W-
28.    ds PI pi
29.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31.    ds L" ""
32.    ds R" ""
33.    ds C` ""
34.    ds C' ""
35'br\}
36.el\{\
37.    ds -- \|\(em\|
38.    ds PI \(*p
39.    ds L" ``
40.    ds R" ''
41.    ds C`
42.    ds C'
43'br\}
44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el       .ds Aq '
48.\"
49.\" If the F register is turned on, we'll generate index entries on stderr for
50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51.\" entries marked with X<> in POD.  Of course, you'll have to process the
52.\" output yourself in some meaningful fashion.
53.\"
54.\" Avoid warning from groff about undefined register 'F'.
55.de IX
56..
57.nr rF 0
58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
60.    if \nF \{
61.        de IX
62.        tm Index:\\$1\t\\n%\t"\\$2"
63..
64.        if !\nF==2 \{
65.            nr % 0
66.            nr F 2
67.        \}
68.    \}
69.\}
70.rr rF
71.\"
72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74.    \" fudge factors for nroff and troff
75.if n \{\
76.    ds #H 0
77.    ds #V .8m
78.    ds #F .3m
79.    ds #[ \f1
80.    ds #] \fP
81.\}
82.if t \{\
83.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84.    ds #V .6m
85.    ds #F 0
86.    ds #[ \&
87.    ds #] \&
88.\}
89.    \" simple accents for nroff and troff
90.if n \{\
91.    ds ' \&
92.    ds ` \&
93.    ds ^ \&
94.    ds , \&
95.    ds ~ ~
96.    ds /
97.\}
98.if t \{\
99.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105.\}
106.    \" troff and (daisy-wheel) nroff accents
107.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114.ds ae a\h'-(\w'a'u*4/10)'e
115.ds Ae A\h'-(\w'A'u*4/10)'E
116.    \" corrections for vroff
117.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119.    \" for low resolution devices (crt and lpr)
120.if \n(.H>23 .if \n(.V>19 \
121\{\
122.    ds : e
123.    ds 8 ss
124.    ds o a
125.    ds d- d\h'-1'\(ga
126.    ds D- D\h'-1'\(hy
127.    ds th \o'bp'
128.    ds Th \o'LP'
129.    ds ae ae
130.    ds Ae AE
131.\}
132.rm #[ #] #H #V #F C
133.\" ========================================================================
134.\"
135.IX Title "STOREID_FILE_REWRITE 8"
136.TH STOREID_FILE_REWRITE 8 "2015-11-28" "perl v5.20.2" "User Contributed Perl Documentation"
137.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents.
139.if n .ad l
140.nh
141.SH "NAME"
142.Vb 1
143\& storeid_file_rewrite \- File based Store\-ID helper for Squid
144.Ve
145.SH "SYNOPSIS"
146.IX Header "SYNOPSIS"
147.Vb 1
148\& storeid_file_rewrite filepath
149.Ve
150.SH "DESCRIPTION"
151.IX Header "DESCRIPTION"
152This program acts as a store_id helper program, rewriting URLs passed
153by Squid into storage-ids that can be used to achieve better caching
154for websites that use different URLs for the same content.
155.PP
156It takes a text file with two tab separated columns.
157Column 1: Regular expression to match against the \s-1URL\s0
158Column 2: Rewrite rule to generate a Store-ID
159Eg:
160^http:\e/\e/[^\e.]+\e.dl\e.sourceforge\e.net\e/(.*)     http://dl.sourceforge.net.squid.internal/$1
161.PP
162Rewrite rules are matched in the same order as they appear in the rules file.
163So for best performance, sort it in order of frequency of occurrence.
164.PP
165This program will automatically detect the existence of a concurrecy channel-ID and adjust appropriately.
166It may be used with any value 0 or above for the store_id_children concurrency= parameter.
167.SH "OPTIONS"
168.IX Header "OPTIONS"
169The only command line parameter this helper takes is the regex rules file name.
170.SH "AUTHOR"
171.IX Header "AUTHOR"
172This program and documentation was written by \fIAlan Mizrahi <alan@mizrahi.com.ve\fR>
173.PP
174Based on prior work by \fIEliezer Croitoru <eliezer@ngtech.co.il\fR>
175.SH "COPYRIGHT"
176.IX Header "COPYRIGHT"
177.Vb 5
178\& * Copyright (C) 1996\-2015 The Squid Software Foundation and contributors
179\& *
180\& * Squid software is distributed under GPLv2+ license and includes
181\& * contributions from numerous individuals and organizations.
182\& * Please see the COPYING and CONTRIBUTORS files for details.
183\&
184\& Copyright (C) 2013 Alan Mizrahi <alan@mizrahi.com.ve>
185\& Based on code from Eliezer Croitoru <eliezer@ngtech.co.il>
186\&
187\& This program is free software; you can redistribute it and/or modify
188\& it under the terms of the GNU General Public License as published by
189\& the Free Software Foundation; either version 2 of the License, or
190\& (at your option) any later version.
191\&
192\& This program is distributed in the hope that it will be useful,
193\& but WITHOUT ANY WARRANTY; without even the implied warranty of
194\& MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
195\& GNU General Public License for more details.
196\&
197\& You should have received a copy of the GNU General Public License
198\& along with this program; if not, write to the Free Software
199\& Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111\-1307, USA.
200.Ve
201.SH "QUESTIONS"
202.IX Header "QUESTIONS"
203Questions on the usage of this program can be sent to the \fISquid Users mailing list <squid\-users@squid\-cache.org\fR>
204.SH "REPORTING BUGS"
205.IX Header "REPORTING BUGS"
206Bug reports need to be made in English.
207See http://wiki.squid\-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
208.PP
209Report bugs or bug fixes using http://bugs.squid\-cache.org/
210.PP
211Report serious security bugs to \fISquid Bugs <squid\-bugs@squid\-cache.org\fR>
212.PP
213Report ideas for new improvements to the \fISquid Developers mailing list <squid\-dev@squid\-cache.org\fR>
214.SH "SEE ALSO"
215.IX Header "SEE ALSO"
216squid (8), \s-1GPL \\fIs0\fR\|(7),
217.PP
218The Squid wiki http://wiki.squid\-cache.org/Features/StoreID
219.PP
220The Squid Configuration Manual http://www.squid\-cache.org/Doc/config/
Note: See TracBrowser for help on using the repository browser.