Rebuild developer-manual and tidy with 'HTML Tidy for FreeBSD version 5.8.0'
[privoxy.git] / doc / webserver / developer-manual / webserver-update.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "">
3 <html>
4 <head>
5   <title>Update the Webserver</title>
6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
7   <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
8   <link rel="PREVIOUS" title="Releasing a New Version" href="newrelease.html">
9   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
10   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
11 </head>
12 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
13   <div class="NAVHEADER">
14     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
15       <tr>
16         <th colspan="3" align="center">Privoxy Developer Manual</th>
17       </tr>
18       <tr>
19         <td width="10%" align="left" valign="bottom"><a href="newrelease.html" accesskey="P">Prev</a></td>
20         <td width="80%" align="center" valign="bottom"></td>
21         <td width="10%" align="right" valign="bottom">&nbsp;</td>
22       </tr>
23     </table>
24     <hr align="left" width="100%">
25   </div>
26   <div class="SECT1">
27     <h1 class="SECT1"><a name="WEBSERVER-UPDATE" id="WEBSERVER-UPDATE">7. Update the Webserver</a></h1>
28     <p>The webserver should be updated at least with each stable release. When updating, please follow these steps to
29     make sure that no broken links, inconsistent contents or permission problems will occur (as it has many times in
30     the past!):</p>
31     <p>If you have changed anything in the stable-branch documentation source SGML files, do:</p>
32     <table border="0" bgcolor="#E0E0E0" width="100%">
33       <tr>
34         <td>
35           <pre class="PROGRAMLISTING">  make dok &#38;&#38; make dok-tidy</pre>
36         </td>
37       </tr>
38     </table>
39     <p>That will generate <tt class="FILENAME">doc/webserver/user-manual</tt>, <tt class=
40     "FILENAME">doc/webserver/developer-manual</tt>, <tt class="FILENAME">doc/webserver/faq</tt>, <tt class=
41     "FILENAME">doc/webserver/index.html</tt> automatically.</p>
42     <p>If you changed the manual page sources, generate <tt class=
43     "FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt> by running <span class="QUOTE">"<b class=
44     "COMMAND">make man</b>"</span>. (This is a separate target due to dependencies on some obscure perl scripts [now in
45     Git, but not well tested]. See comments in <tt class="FILENAME">GNUmakefile</tt>.)</p>
46     <p>If you want to add new files to the webserver, create them locally in the <tt class=
47     "FILENAME">doc/webserver/*</tt> directory (or create new directories under <tt class=
48     "FILENAME">doc/webserver</tt>).</p>
49     <p>Next, commit any changes from the above steps to Git. All set? If these are docs in the stable branch, then
50     do:</p>
51     <table border="0" bgcolor="#E0E0E0" width="100%">
52       <tr>
53         <td>
54           <pre class="PROGRAMLISTING">  make webserver</pre>
55         </td>
56       </tr>
57     </table>
58     <p>This will do the upload to the SourceForge webserver (which is manually syncronized with <a href=
59     "" target="_top"></a>) and ensure all files and directories there are group
60     writable.</p>
61     <p>Please do <span class="emphasis"><i class="EMPHASIS">NOT</i></span> use any other means of transferring files to
62     the webserver to avoid permission problems. Also, please do not upload docs from development branches or versions.
63     The publicly posted docs should be in sync with the last official release.</p>
64   </div>
65   <div class="NAVFOOTER">
66     <hr align="left" width="100%">
67     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
68       <tr>
69         <td width="33%" align="left" valign="top"><a href="newrelease.html" accesskey="P">Prev</a></td>
70         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
71         <td width="33%" align="right" valign="top">&nbsp;</td>
72       </tr>
73       <tr>
74         <td width="33%" align="left" valign="top">Releasing a New Version</td>
75         <td width="34%" align="center" valign="top">&nbsp;</td>
76         <td width="33%" align="right" valign="top">&nbsp;</td>
77       </tr>
78     </table>
79   </div>
80 </body>
81 </html>