76b66908808a56ebeb8aeb065283ea7efeb5f362
[privoxy.git] / doc / webserver / developer-manual / webserver-update.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3
4 <html>
5 <head>
6   <meta name="generator" content=
7   "HTML Tidy for Linux/x86 (vers 7 December 2008), see www.w3.org">
8
9   <title>Update the Webserver</title>
10   <meta name="GENERATOR" content=
11   "Modular DocBook HTML Stylesheet Version 1.79">
12   <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
13   <link rel="PREVIOUS" title="Releasing a New Version" href=
14   "newrelease.html">
15   <link rel="NEXT" title=
16   "Contacting the developers, Bug Reporting and Feature Requests" href=
17   "contact.html">
18   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
19   <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
20   <style type="text/css">
21 body {
22   background-color: #EEEEEE;
23   color: #000000;
24   }
25   :link { color: #0000FF }
26   :visited { color: #840084 }
27   :active { color: #0000FF }
28   span.c3 {font-style: italic}
29   table.c2 {background-color: #E0E0E0}
30   hr.c1 {text-align: left}
31   </style>
32 </head>
33
34 <body class="SECT1">
35   <div class="NAVHEADER">
36     <table summary="Header navigation table" width="100%" border="0"
37     cellpadding="0" cellspacing="0">
38       <tr>
39         <th colspan="3" align="center">Privoxy Developer Manual</th>
40       </tr>
41
42       <tr>
43         <td width="10%" align="left" valign="bottom"><a href=
44         "newrelease.html" accesskey="P">Prev</a></td>
45
46         <td width="80%" align="center" valign="bottom"></td>
47
48         <td width="10%" align="right" valign="bottom"><a href="contact.html"
49         accesskey="N">Next</a></td>
50       </tr>
51     </table>
52     <hr class="c1" width="100%">
53   </div>
54
55   <div class="SECT1">
56     <h1 class="SECT1"><a name="WEBSERVER-UPDATE" id="WEBSERVER-UPDATE">7.
57     Update the Webserver</a></h1>
58
59     <p>The webserver should be updated at least with each stable release.
60     When updating, please follow these steps to make sure that no broken
61     links, inconsistent contents or permission problems will occur (as it has
62     many times in the past!):</p>
63
64     <p>If you have changed anything in the stable-branch documentation source
65     SGML files, do:</p>
66
67     <table class="c2" border="0" width="100%">
68       <tr>
69         <td>
70           <pre class="PROGRAMLISTING">
71   make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
72 </pre>
73         </td>
74       </tr>
75     </table>
76
77     <p>That will generate <tt class=
78     "FILENAME">doc/webserver/user-manual</tt>, <tt class=
79     "FILENAME">doc/webserver/developer-manual</tt>, <tt class=
80     "FILENAME">doc/webserver/faq</tt>, <tt class=
81     "FILENAME">doc/pdf/*.pdf</tt> and <tt class=
82     "FILENAME">doc/webserver/index.html</tt> automatically.</p>
83
84     <p>If you changed the manual page sources, generate <tt class=
85     "FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt> by running
86     <span class="QUOTE">"<b class="COMMAND">make man</b>"</span>. (This is a
87     separate target due to dependencies on some obscure perl scripts [now in
88     CVS, but not well tested]. See comments in <tt class=
89     "FILENAME">GNUmakefile</tt>.)</p>
90
91     <p>If you want to add new files to the webserver, create them locally in
92     the <tt class="FILENAME">doc/webserver/*</tt> directory (or create new
93     directories under <tt class="FILENAME">doc/webserver</tt>).</p>
94
95     <p>Next, commit any changes from the above steps to CVS. All set? If
96     these are docs in the stable branch, then do:</p>
97
98     <table class="c2" border="0" width="100%">
99       <tr>
100         <td>
101           <pre class="PROGRAMLISTING">
102   make webserver
103 </pre>
104         </td>
105       </tr>
106     </table>
107
108     <p>This will do the upload to <a href="http://www.privoxy.org/" target=
109     "_top">the webserver</a> (www.privoxy.org) and ensure all files and
110     directories there are group writable.</p>
111
112     <p>Please do <span class="emphasis EMPHASIS c3">NOT</span> use any other
113     means of transferring files to the webserver to avoid permission
114     problems. Also, please do not upload docs from development branches or
115     versions. The publicly posted docs should be in sync with the last
116     official release.</p>
117   </div>
118
119   <div class="NAVFOOTER">
120     <hr class="c1" width="100%">
121
122     <table summary="Footer navigation table" width="100%" border="0"
123     cellpadding="0" cellspacing="0">
124       <tr>
125         <td width="33%" align="left" valign="top"><a href="newrelease.html"
126         accesskey="P">Prev</a></td>
127
128         <td width="34%" align="center" valign="top"><a href="index.html"
129         accesskey="H">Home</a></td>
130
131         <td width="33%" align="right" valign="top"><a href="contact.html"
132         accesskey="N">Next</a></td>
133       </tr>
134
135       <tr>
136         <td width="33%" align="left" valign="top">Releasing a New
137         Version</td>
138
139         <td width="34%" align="center" valign="top">&nbsp;</td>
140
141         <td width="33%" align="right" valign="top">Contacting the developers,
142         Bug Reporting and Feature Requests</td>
143       </tr>
144     </table>
145   </div>
146 </body>
147 </html>