Update manuals for CVS and new commands
[spider.git] / html / adminmanual_en-10.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20">
5  <TITLE>The DXSpider Administration Manual v1.51: CVS</TITLE>
6  <LINK HREF="adminmanual_en-11.html" REL=next>
7  <LINK HREF="adminmanual_en-9.html" REL=previous>
8  <LINK HREF="adminmanual_en.html#toc10" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="adminmanual_en-11.html">Next</A>
13 <A HREF="adminmanual_en-9.html">Previous</A>
14 <A HREF="adminmanual_en.html#toc10">Contents</A>
15 <HR>
16 <H2><A NAME="s10">10.</A> <A HREF="adminmanual_en.html#toc10">CVS</A></H2>
17
18 <H2><A NAME="ss10.1">10.1</A> <A HREF="adminmanual_en.html#toc10.1">CVS from a Linux platform</A>
19 </H2>
20
21 <P>CVS stands for "Concurrent Versions System" and the CVS for DXSpider is held
22 at 
23 <A HREF="http://www.sourceforge.net">Sourceforge</A>.  This means
24 that it is possible to update your DXSpider installation to the latest
25 sources by using a few simple commands.  A graphical interface to CVS for
26 Windows is explained in the next section.</P>
27
28 <P>Please be aware that if you update your system using CVS, it is possible that
29 you could be running code that is very beta and not fully tested.  There is
30 a possibility that it could be unstable.</P>
31
32 <P>I am of course assuming that you have a machine with both DXSpider and
33 Internet access running.</P>
34
35 <P>BEFORE YOU EVEN CONSIDER STARTING WITH THIS MAKE A BACKUP OF YOUR
36 ENTIRE SPIDER TREE!!</P>
37
38 <P>Assuming you are connected to the Internet, you need to login to the
39 CVS repository and then update your Spider source.  There are several
40 steps which are listed below ...</P>
41
42 <P>First login as the user <EM>sysop</EM>.  Next you need to connect to the CVS
43 repository.  You do this with the command below ...</P>
44 <P>
45 <PRE>
46 cvs -d:pserver:anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
47 </PRE>
48 </P>
49 <P>You will get a password prompt.  Simply hit return here and your machine should
50 return to a normal linux prompt.</P>
51
52 <P>What happens next depends on whether you have an existing installation that
53 you want to update with the latest and greatest or whether you just want
54 to see what is there and/or run it on a new machine for testing.</P>
55 <P>If you are installing Spider from CVS then change directory to /home/sysop</P>
56 <P>If you are wanting to update Spider then cd to /tmp</P>
57
58 <P>The next step will create a brand new 'spider' directory in your current
59 directory.</P>
60 <P>
61 <PRE>
62 cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/dxspider co spider
63 </PRE>
64 </P>
65 <P>This command is all on one line.</P>
66
67 <P>Hopefully your screen should show you downloading files.  The -z3 simply compresses
68 the download to improve speed.
69 When this has finished, you will have exactly the same as if you had untarred a full
70 tarball PLUS some extra directories and files that CVS needs to do the magic that
71 it does.</P>
72
73 <P>Now if you are doing a new installation, that's it.  Carry on as if you have
74 just downloaded and untarred the lastest tarball.</P>
75
76 <P>If you want to upgrade your current installation then do this ...</P>
77 <P>
78 <BLOCKQUOTE><CODE>
79 <PRE>
80 tar cvfz /tmp/s.tgz spider
81 cd /
82 tar xvfzp /tmp/s.tgz
83 </PRE>
84 </CODE></BLOCKQUOTE>
85 </P>
86 <P>This is assuming you downloaded to the /tmp directory of course.</P>
87
88 <P>NOTE:  the 'p' on the end of the 'xvfz' is IMPORTANT!   It keeps the permissions
89 correct.  YOU WERE LOGGED IN AS THE USER SYSOP WEREN'T YOU?????</P>
90 <P>Remember to recompile the C client (cd /spider/src; make)</P>
91
92 <P>At this point the files have been upgraded.  You can (usually) restart the cluster
93 in your own time.  However, if you attempt to use any new commands or features
94 expect it to be fatal!  At least your cluster will have been restarted then so it
95 will be too late to worry about it!</P>
96
97 <P>Now the magic part!  From now on when you want to update, simply connect to the
98 Internet and then, as the user <EM>sysop</EM> ...</P>
99 <P>
100 <BLOCKQUOTE><CODE>
101 <PRE>
102 cd /spider
103 cvs -z3 update -d
104 </PRE>
105 </CODE></BLOCKQUOTE>
106 </P>
107 <P>and your files will be updated.  As above, remember to recompile the "C" client
108 if it has been updated (CVS will tell you) and restart if any of the perl scripts
109 have been altered or added, again, CVS will tell you.</P>
110
111 <P>You will find any changes documented in the /spider/Changes file.</P>
112
113 <H2><A NAME="ss10.2">10.2</A> <A HREF="adminmanual_en.html#toc10.2">CVS from a Windows platform</A>
114 </H2>
115
116 <P>After the initial setup, an update to your DXSpider software is no more than a couple
117 of clicks away.  This section is intended to explain and illustrate the use of the
118 WinCVS application to update your DXSpider software.  The current stable version of
119 WinCVS is Ver. 1.2.  You can get this software at:</P>
120 <P>
121 <A HREF="http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip">http://prdownloads.sourceforge.net/cvsgui/WinCvs120.zip</A></P>
122 <P>Pick your download mirror and then install WinCVS after the download is complete.</P>
123 <P>In this next section I have included a series of links to .jpg files to take advantage of the
124 picture and 1000 words equivalency.  The .jpg files are in the C:\spider\html directory.  If
125 someone using a Linux system is reading this section from boredom, the files are in
126 /home/sysop/spider/html.  One aside, a Linux user can also get a copy of gcvs and do your updates
127 graphically as opposed to from the command line.  The following descriptions are almost identical
128 between WinCvs and gcvs.  The following screen shots have duplicate links, depending upon whether
129 you are viewing this information under the Windows or Linux operating system.</P>
130 <P>When WinCVS is installed, running, and you are connected to the internet, the initial screen looks like:</P>
131 <P>
132 <A HREF="initial.jpg">initial.jpg</A></P>
133 <P>If you want, you can also look at these .jpg files with another viewer that might provide some
134 better clarity to the image.  On the left is the directory tree for your hard disk.  Notice that
135 the spider directory has a gray highlight.</P>
136 <P>To start configuring WinCVS, click on Admin at the top of the screen and then Preferences.  This 
137 should get you:</P>
138 <P>
139 <A HREF="pref-gen.jpg">pref-gen.jpg</A></P>
140 <P>In the top line for CVSROOT, enter:
141 <BLOCKQUOTE><CODE>
142 <PRE>
143 anonymous@cvs.DXSpider.sourceforge.net:/cvsroot/dxspider login
144 </PRE>
145 </CODE></BLOCKQUOTE>
146 </P>
147 <P>and select
148 <BLOCKQUOTE><CODE>
149 <PRE>
150 "passwd" file on the cvs server
151 </PRE>
152 </CODE></BLOCKQUOTE>
153 </P>
154 <P>for Authentication on the General tab.</P>
155 <P>Next, move to the right to the Ports tab.</P>
156 <P>
157 <A HREF="pref-ports.jpg">pref-ports.jpg</A></P>
158 <P>In here, check the box on the second line down for the "pserver" port.  Enter a port number of 2401.</P>
159 <P>Finally, go to the WinCvs tab all the way to the right.</P>
160 <P>
161 <A HREF="pref-wincvs.jpg">pref-wincvs.jpg</A></P>
162 <P>Enter Notepad as the viewer to open files.  For the HOME folder, put "C:\spider" and click OK
163 because the configuration is now complete.</P>
164 <P>You are now ready to upgrade your copy of DXSpider.  Click on the greyed Spider folder
165 shown in the directory tree on the left of the WinCVS display.  Two things should happen.  The Spider
166 folder will be selected and the greyed-out arrow located just below the word Query in the top line will
167 turn to solid green.</P>
168 <P>For anyone using gcvs under Linux, the green arrow is located on the extreme left of the display,
169 under the word File.  A gcvs screen looks like:</P>
170 <P>
171 <A HREF="gcvs.jpg">gcvs.jpg</A></P>
172 <P>Click on the now green arrow to start the download process.  An Update Settings box will be displayed
173 to which you can simply say OK.</P>
174 <P>
175 <A HREF="update-OK.jpg">update-OK.jpg</A></P>
176 <P>For future reference, the Update Settings box is the place where you can enter information to revert
177 to a prior version of DXSpider.  Information on reverting to a Before Date is contained in the WinCVS
178 manual.</P>
179 <P>After a short period of time, a series of file names will scroll by in the lower pane of the WinCVS
180 window.  Eventually you should see
181 <BLOCKQUOTE><CODE>
182 <PRE>
183 *****CVS exited normally with code 0*****
184 </PRE>
185 </CODE></BLOCKQUOTE>
186
187 appear in the lower pane.  You're done.  The updated files are in place ready for you to stop and then
188 restart your DXSpider.  After the restart, you're running with the latest version of DXSpider.</P>
189 <P>
190 <A HREF="completed.jpg">completed.jpg</A></P>
191 <P>To paraphrase from the CVS section... Now the magic part!  From now on when you want to update, simply
192 connect to the Internet and start WinCVS.
193 <BLOCKQUOTE><CODE>
194 <PRE>
195 Click on the greyed-out Spider directory in the left screen
196 Click on the green down arrow
197 Click OK on the Update Settings dialog box
198 Restart your Spider software
199 </PRE>
200 </CODE></BLOCKQUOTE>
201 </P>
202
203 <HR>
204 <A HREF="adminmanual_en-11.html">Next</A>
205 <A HREF="adminmanual_en-9.html">Previous</A>
206 <A HREF="adminmanual_en.html#toc10">Contents</A>
207 </BODY>
208 </HTML>