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