Annotation of www/cvsup.html, Revision 1.129
1.74 xsa 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2: "http://www.w3.org/TR/html4/loose.dtd">
1.21 naddy 3: <html>
1.1 brian 4: <head>
5: <title>OpenBSD CVSup</title>
1.21 naddy 6: <link rev="made" href="mailto:www@openbsd.org">
1.74 xsa 7: <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
1.21 naddy 8: <meta name="resource-type" content="document">
9: <meta name="description" content="How to get OpenBSD updates via Internet using CVSup">
10: <meta name="keywords" content="openbsd,cvsup,updates">
11: <meta name="distribution" content="global">
1.107 nick 12: <meta name="copyright" content="This document copyright 2000-2007 by OpenBSD.">
1.1 brian 13: </head>
14:
1.7 brian 15: <body bgcolor="#FFFFFF" text="#000000" link="#23238E">
1.1 brian 16:
1.74 xsa 17: <a href="index.html"><img alt="[OpenBSD]" height="30" width="141"
18: src="images/smalltitle.gif" border="0"></a>
1.7 brian 19:
20: <h2><font color="#e00000">CVSup</font></h2>
1.21 naddy 21: <hr>
1.1 brian 22:
1.7 brian 23: <h3>Table of Contents</h3>
24: <ul>
25: <li><a href="#cvsup">What Is CVSup?</a></li>
1.114 nick 26: <li><a href="#CVS">What Is CVS?</a></li>
1.7 brian 27: <li><a href="#starting">Getting Started Using CVSup</a></li>
1.113 nick 28: <li><a href="#using">Using CVS to Work With Your Repository</a></li>
1.7 brian 29: <li><a href="#checkout">Running CVSup in Checkout Mode</a></li>
30: <li><a href="#CVSROOT">Available CVSup Servers</a></li>
1.1 brian 31: </ul>
32:
1.21 naddy 33: <hr>
1.1 brian 34:
1.9 naddy 35:
1.21 naddy 36: <h3><a name="cvsup"><font color="#0000e0">What Is CVSup?</font></a></h3>
1.1 brian 37:
38: <p>
39: <b>CVSup</b> is a software package for distributing and updating source
1.58 naddy 40: trees from a master <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cvs&sektion=1">cvs(1)</a> repository on a remote server host. The OpenBSD
1.1 brian 41: sources are maintained in a CVS repository on a central development machine
42: in Canada. With CVSup, OpenBSD users can easily keep their own source trees
43: up to date.
44:
45: <p>
46: <b>CVSup</b> uses the so-called pull model of updating. Under the pull
47: model, each client asks the server for updates, if and when they are
48: wanted. The server waits passively for update requests from its clients.
49: Thus all updates are instigated by the client. The server never sends
50: unsolicited updates. Users must either run the <b>CVSup</b> client
1.58 naddy 51: manually to get an update, or they must set up a <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cron&sektion=8">cron(8)</a> job to run it
1.1 brian 52: automatically on a regular basis.
53:
54: <p>
55: The term <b>CVSup</b>, capitalized just so, refers to the entire software
1.119 naddy 56: package. Its main components are the client <tt>cvsup</tt>
57: (or its alternative implementation <tt>csup</tt>) which runs on
1.1 brian 58: each user's machine, and the server <tt>cvsupd</tt> which runs at each of
59: the OpenBSD CVSup mirror sites.
60:
61: <p>
1.107 nick 62: The OpenBSD Project currently has six main source repositories:
1.1 brian 63:
64: <ul>
1.9 naddy 65: <li><b>src</b> - Houses all source code for the OpenBSD Operating System.</li>
1.127 steven 66: <li><b>ports</b> - Houses the <a href="faq/ports/index.html">OpenBSD Ports</a>.</li>
1.124 nick 67: <li><b>www</b> - Houses all OpenBSD web pages (including this one).</li>
1.88 matthieu 68: <li><b>X11</b> - Houses OpenBSD's adaptation of the
1.89 matthieu 69: <a href="http://www.XFree86.org/">XFree86-3</a> software project.
70: This is here just for historical purposes, most users will have no
71: reason to use this tree, it is no longer being used.
1.115 deraadt 72: <li><b>XF4</b> - Houses OpenBSD's adaptation of the XFree86-4 source tree.
73: <li><b>xenocara</b> - Houses OpenBSD's active X.org v7 source tree.
1.1 brian 74: </ul>
75:
1.21 naddy 76: <h3><a name="CVS"><font color="#0000e0">What Is CVS?</font></a></h3>
1.1 brian 77:
78: <p>
79: CVS is the source code control system used to manage the OpenBSD source
1.7 brian 80: tree. It is described in more detail <a href="anoncvs.html#CVS">here</a>.
1.50 naddy 81: Note that CVS and CVSup are entirely different programs. Although
82: CVS can be used for remote file access, it is not optimized for
83: wholesale source tree distribution over the net, and CVSup can be
84: easily an order of magnitude more efficient for this task.
1.1 brian 85:
1.2 brian 86: <h3>
1.21 naddy 87: <a name="starting"><font color="#0000e0">Getting Started Using CVSup</font></a>
1.2 brian 88: </h3>
1.1 brian 89:
90: <p>
1.59 naddy 91: Building CVSup from the sources can prove cumbersome since it is
92: written in Modula-3. The <tt>lang/ezm3</tt> port provides a smaller
93: distribution of the Modula-3 compiler and runtime system for people
94: whose only need for Modula-3 is to build CVSup. Nevertheless, if
95: you only care about running CVSup, it is recommended that you
96: download the cvsup package from the <a href="ftp.html">ftp mirror
97: sites</a> instead of building your own from the <tt>net/cvsup</tt>
98: port. Currently the OpenBSD ports of Ezm3 and consequently CVSup
99: are only available on the i386 platform.
1.1 brian 100:
101: <p>
1.119 naddy 102: Alternatively, the csup package is written in C and provides a drop-in
103: compatible client.
104:
105: <p>
1.50 naddy 106: For further information about CVSup, see the author's
1.109 mbalmer 107: <a href="http://www.cvsup.org/">project homepage</a>.
1.9 naddy 108:
109: <p>
1.50 naddy 110: In order to mirror the OpenBSD repository with CVSup,
111: the following configuration file might be used:
1.1 brian 112:
113: <pre>
114: # Defaults that apply to all the collections
115: *default release=cvs
116: *default delete use-rel-suffix
117: *default umask=002
1.121 sthen 118: *default host=mirror.osn.de
1.1 brian 119: *default base=/cvs
120: *default prefix=/cvs
121:
122: # If your network link is a T1 or faster, comment out the following line.
123: *default compress
124:
125: OpenBSD-all
126: #OpenBSD-src
127: #OpenBSD-www
128: #OpenBSD-ports
129: #OpenBSD-x11
1.20 brian 130: #OpenBSD-xf4
1.110 mbalmer 131: #OpenBSD-xenocara
1.1 brian 132: </pre>
133:
134: <p>
135: This directs cvsup to refresh all OpenBSD distributions from
1.121 sthen 136: <b>mirror.osn.de</b> with a <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=umask&sektion=2">umask(2)</a> that permits group write
1.1 brian 137: permission to the local repository.
138:
139: <p>
140: Assuming this file is saved as <tt>cvs-supfile</tt>, the
1.39 horacio 141: following command would be used to invoke the cvsup GUI:
1.1 brian 142: <pre>
143: cvsup cvs-supfile
144: </pre>
1.9 naddy 145: <p>
1.1 brian 146: whereas for batch mode, the following might be used:
147: <pre>
148: cvsup -g -L 2 cvs-supfile
149: </pre>
150:
1.21 naddy 151: <h3><a name="using">
1.113 nick 152: <font color="#0000e0">Using CVS to Work With Your Repository</font>
1.2 brian 153: </a></h3>
1.1 brian 154:
155: <p>
1.113 nick 156: Now that you have a local copy of the CVS repository, it is now simple
157: to check out, update, or do any of the other CVS operations you would
158: normally do against a remote repository, locally.
1.117 deraadt 159: For example:
1.7 brian 160: <pre>
1.113 nick 161: cvs -d/cvs checkout src -P
162: cvs -d/cvs up -Pd
163: cvs -d/cvs diff -u file.c
1.7 brian 164: </pre>
1.113 nick 165: More details on CVS operation can be found in
166: <a href="faq/faq5.html#BldGetSrc">FAQ5, Fetching appropriate source
167: code</a> and in the
168: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cvs&sektion=1">cvs(1)</a>
169: man page.
1.7 brian 170:
1.21 naddy 171: <h3><a name="checkout"><font color="#0000e0">Running CVSup in
1.7 brian 172: Checkout Mode</font></a></h3>
1.1 brian 173:
174: <p>
1.7 brian 175: As an alternative to getting the repository and using CVS, you can
176: run CVSup in checkout mode by adding a <tt>tag</tt> or <tt>date</tt>
177: keyword to your supfile, either as a <tt>*default</tt> or as an
178: option to a collection. In particular, you can use this to efficiently
179: update the source and ports trees shipped on the <a
180: href="orders.html">CDROMs</a>.
181: <p>
182: The following supfile could be used to update your ports tree:
183: <pre>
184: # Defaults that apply to all the collections
1.121 sthen 185: *default host=mirror.osn.de
1.7 brian 186: *default base=/var
187: *default prefix=/usr
188: *default release=cvs
189: *default delete use-rel-suffix compress
190:
191: # Ports Collection.
192: OpenBSD-ports tag=.
193: </pre>
194: <p>
195: Any CVS symbolic tag can be used. A single period "." means HEAD,
196: i.e. the newest revision of all files in the main branch. Take care
197: to specify an existing tag, as CVSup cannot distinguish valid from
198: invalid tags, and an attempt to synchronize an existing source tree
199: to an invalid tag will remove all files.
200: <p>
201: Alternatively, use the keyword <tt>date=[cc.]yy.mm.dd.hh.mm.ss</tt>
1.60 deraadt 202: to select a revision by date. All 17 or 20 characters must be
1.7 brian 203: given as shown. For the years 2000 and beyond, specify the century
204: <var>cc</var>. For earlier years, specify only the last two digits
205: <var>yy</var>. You may also combine the <tt>tag</tt> and <tt>date</tt>
206: keywords.
207:
1.1 brian 208:
1.2 brian 209: <h3>
1.21 naddy 210: <a name="CVSROOT"><font color="#0000e0">Available CVSup Servers</font></a>
1.2 brian 211: </h3>
1.1 brian 212:
1.74 xsa 213: <p>The following CVSup servers are available:
1.7 brian 214:
1.26 brian 215: <dl>
1.41 brad 216: <dt><a href="http://cvsup.no.openbsd.org/"><strong>cvsup.no.openbsd.org</strong></a></dt>
1.27 brian 217: <dd><p>
1.43 heko 218: located in Oslo, Norway;
1.106 steven 219: maintained by <a href="mailto:anders@fupp.net">Anders Nordby</a>.<br>
1.29 brian 220: Updated every 3 hours.
1.27 brian 221: <p>
222: Available collections:
223: <table>
224: <tr><td width="20"></td>
225: <td><strong>OpenBSD-src</strong></td>
1.102 steven 226: <td>- The <b>src</b> repository</td></tr>
1.27 brian 227: <tr><td></td>
228: <td><strong>OpenBSD-ports</strong></td>
229: <td>- The <b>ports</b> repository</td></tr>
230: <tr><td></td>
231: <td><strong>OpenBSD-www</strong></td>
232: <td>- The <b>www</b> repository</td></tr>
233: <tr><td></td>
234: <td><strong>OpenBSD-x11</strong></td>
235: <td>- The <b>XFree86-3</b> repository</td></tr>
236: <tr><td></td>
237: <td><strong>OpenBSD-xf4</strong></td>
238: <td>- The <b>XFree86-4</b> repository</td></tr>
239: <tr><td></td>
1.121 sthen 240: <td><strong>OpenBSD-xenocara</strong></td>
241: <td>- The <b>Xenocara</b> repository</td></tr>
242: <tr><td></td>
1.27 brian 243: <td><strong>OpenBSD-all</strong></td>
1.121 sthen 244: <td>- All OpenBSD repositories</td></tr><!-- 20090907 xenocara not in OpenBSD-all -->
1.27 brian 245: </table>
246: </dd>
247: </dl>
248:
1.47 brian 249: <dl>
1.44 brian 250: <dt><strong>skeleton.phys.spbu.ru</strong></dt>
251: <dd><p>
1.46 brian 252: located in St. Petersburg State University, St. Petersburg, Russia;
1.44 brian 253: maintained by <a href="mailto:kab00m@lich.phys.spbu.ru">Dima Veselov</a>.<br>
254: Updated every 4 hours.
255: <p>
256: Available collections:
257: <table>
1.49 jufi 258: <tr><td width="20"></td>
1.44 brian 259: <td><strong>OpenBSD-ports</strong></td>
260: <td>- The <b>ports</b> repository</td></tr>
261: </table>
262: </dd>
263: </dl>
264:
1.52 brian 265: <dl>
1.58 naddy 266: <dt><strong>cvsup.jp.OpenBSD.org</strong></dt>
1.52 brian 267: <dd><p>
268: located at Otemachi, Tokyo, Japan;
1.57 brian 269: maintained by <a href="mailto:cvsupadm@openbsd.bsdlab.org">CVSup Administrator</a>.<br>
1.52 brian 270: Updated every 3 hours.
271: <p>
272: Available collections:
273: <table>
274: <tr><td width="20"></td>
275: <td><strong>OpenBSD-src</strong></td>
1.102 steven 276: <td>- The <b>src</b> repository</td></tr>
1.52 brian 277: <tr><td></td>
278: <td><strong>OpenBSD-ports</strong></td>
279: <td>- The <b>ports</b> repository</td></tr>
280: <tr><td></td>
281: <td><strong>OpenBSD-www</strong></td>
282: <td>- The <b>www</b> repository</td></tr>
283: <tr><td></td>
284: <td><strong>OpenBSD-x11</strong></td>
285: <td>- The <b>XFree86-3</b> repository</td></tr>
286: <tr><td></td>
287: <td><strong>OpenBSD-xf4</strong></td>
288: <td>- The <b>XFree86-4</b> repository</td></tr>
289: <tr><td></td>
1.121 sthen 290: <td><strong>OpenBSD-xenocara</strong></td>
291: <td>- The <b>Xenocara</b> repository</td></tr>
292: <tr><td></td>
1.52 brian 293: <td><strong>OpenBSD-all</strong></td>
1.121 sthen 294: <td>- All OpenBSD repositories</td></tr><!-- 20090907 xenocara not in OpenBSD-all -->
1.52 brian 295: </table>
296: </dd>
297: </dl>
298:
1.54 brian 299: <dl>
1.73 kevlo 300: <dt><strong>cvsup.tw.OpenBSD.org</strong></dt>
301: <dd><p>
302: located at National Chiao-Tung University, Taiwan;
1.121 sthen 303: maintained by <a href="mailto:yzlin@FreeBSD.org">Yi-Jheng Lin</a>.<br>
1.73 kevlo 304: Updated every 2 hours.
305: <p>
306: Available collections:
307: <table>
308: <tr><td width="20"></td>
309: <td><strong>OpenBSD-src</strong></td>
1.102 steven 310: <td>- The <b>src</b> repository</td></tr>
1.73 kevlo 311: <tr><td></td>
312: <td><strong>OpenBSD-ports</strong></td>
313: <td>- The <b>ports</b> repository</td></tr>
314: <tr><td></td>
315: <td><strong>OpenBSD-www</strong></td>
316: <td>- The <b>www</b> repository</td></tr>
317: <tr><td></td>
318: <td><strong>OpenBSD-x11</strong></td>
319: <td>- The <b>XFree86-3</b> repository</td></tr>
320: <tr><td></td>
321: <td><strong>OpenBSD-xf4</strong></td>
322: <td>- The <b>XFree86-4</b> repository</td></tr>
323: <tr><td></td>
324: <td><strong>OpenBSD-all</strong></td>
325: <td>- All OpenBSD repositories</td></tr>
326: </table>
327: </dd>
328: </dl>
329:
330: <dl>
1.63 beck 331: <dt><a href="http://mirror.osn.de/"><strong>mirror.osn.de</strong></a></dt>
332: <dd><p>
333: located in Germany
334: maintained by <a href="mailto:aw@osn.de">Armin Wolfermann</a>.<br>
1.123 sthen 335: Updated every 3 hours.
1.63 beck 336: <p>
337: Available collections:
338: <table>
339: <tr><td width="20"></td>
340: <td><strong>OpenBSD-src</strong></td>
1.102 steven 341: <td>- The <b>src</b> repository</td></tr>
1.63 beck 342: <tr><td></td>
343: <td><strong>OpenBSD-ports</strong></td>
344: <td>- The <b>ports</b> repository</td></tr>
345: <tr><td></td>
346: <td><strong>OpenBSD-www</strong></td>
347: <td>- The <b>www</b> repository</td></tr>
348: <tr><td></td>
349: <td><strong>OpenBSD-x11</strong></td>
350: <td>- The <b>XFree86-3</b> repository</td></tr>
351: <tr><td></td>
352: <td><strong>OpenBSD-xf4</strong></td>
353: <td>- The <b>XFree86-4</b> repository</td></tr>
354: <tr><td></td>
1.108 grunk 355: <td><strong>OpenBSD-xenocara</strong></td>
356: <td>- The <b>Xenocara</b> repository</td></tr>
357: <tr><td></td>
1.63 beck 358: <td><strong>OpenBSD-all</strong></td>
359: <td>- All OpenBSD repositories</td></tr>
360: </table>
361: </dd>
362: </dl>
363:
1.118 sthen 364: <p>
1.1 brian 365: <p>
1.87 joel 366: <em>Note:</em> If your server is listed on here with inaccurate or
367: unknown information, please contact
368: <a href="mailto:www@openbsd.org"><tt>www@openbsd.org</tt></a>.
1.1 brian 369: <p>
1.58 naddy 370: You may want to use <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=traceroute&sektion=8">traceroute(8)</a>
1.39 horacio 371: to find out which server is nearest you.
1.1 brian 372: Problems with a server should be reported to the <b>maintainer</b> of the
373: server in question.
374: <p>
1.126 matthieu 375: As of April, 2010, the CVS repository sizes are
1.4 brian 376: <table>
1.9 naddy 377: <tr><td width="20"></td>
1.20 brian 378: <td><strong>OpenBSD-ports</strong></td>
1.126 matthieu 379: <td>- <b>425</b>MB</td></tr>
1.9 naddy 380: <tr><td></td>
1.20 brian 381: <td><strong>OpenBSD-src</strong></td>
1.126 matthieu 382: <td>- <b>1684</b>MB</td></tr>
1.9 naddy 383: <tr><td></td>
1.20 brian 384: <td><strong>OpenBSD-www</strong></td>
1.126 matthieu 385: <td>- <b>401</b>MB</td></tr>
1.116 steven 386: <tr><td></td>
387: <td><strong>OpenBSD-xenocara</strong></td>
1.126 matthieu 388: <td>- <b>723</b>MB</td></tr>
1.9 naddy 389: <tr><td></td>
1.20 brian 390: <td><strong>OpenBSD-x11</strong></td>
1.68 naddy 391: <td>- <b>200</b>MB</td></tr>
1.20 brian 392: <tr><td></td>
393: <td><strong>OpenBSD-xf4</strong></td>
1.116 steven 394: <td>- <b>564</b>MB</td></tr>
1.4 brian 395: </table>
396: <p>
1.100 steven 397: There is an additional overhead of <b>408</b>MB for the CVSROOT
1.68 naddy 398: directory. The overall repository size currently increases at a rate
1.85 nick 399: of about <b>400</b>MB per annum.
1.4 brian 400: <p>
1.1 brian 401: <strong>IMPORTANT NOTE:</strong>
402: There are a few issues relating to cryptographic software that everyone
403: should be aware of:
404: <ul>
1.9 naddy 405: <li>
406: <p>
407: The OpenBSD sources are from Canada. As
1.67 nick 408: <a href="http://www.efc.ca/pages/doc/crypto-export.html">
1.9 naddy 409: researched by a Canadian individual</a> and as
410: <a href="http://axion.physics.ubc.ca/ECL.html">
411: described in the Export Control list of Canada</a>,
412: it is legal to export crypto software from Canada to the world.
413: </li>
414: <li>
415: <p>
416: However, if you are outside the USA or Canada, you should not
1.72 naddy 417: fetch the cryptographic sections of the OpenBSD sources from a
418: CVSup server located in the USA. The files in question are...
1.9 naddy 419: <ul>
420: <li><tt>src/kerberosIV/*</tt></li>
1.56 miod 421: <li><tt>src/kerberosV/*</tt></li>
1.9 naddy 422: <li><tt>src/lib/libdes/*</tt></li>
423: <li><tt>src/lib/libc/crypt/crypt.c</tt></li>
424: <li><tt>src/lib/libc/crypt/morecrypt.c</tt></li>
1.56 miod 425: <li><tt>src/sys/crypto</tt></li>
1.9 naddy 426: <li><tt>src/sys/netinet</tt></li>
427: <li><tt>src/usr.sbin/afs/src/rxkad/*</tt></li>
1.56 miod 428: <li><tt>XF4/xc-mit/lib/Xdmcp/Wraphelp.c</tt></li>
429: <li><tt>XF4/xc-old/lib/Xdmcp/Wraphelp.c</tt></li>
430: <li><tt>XF4/xc/lib/Xdmcp/Wraphelp.c</tt></li>
1.9 naddy 431: </ul>
432: <p>
433: Because of the USA ITAR munitions list,
434: crypto software may only be exported to Canada from the USA.
435: </li>
1.1 brian 436: </ul>
437:
438: <p>
439: The OpenBSD project is looking for more CVSup servers -- if you are
1.87 joel 440: interested, please contact
441: <a href="mailto:www@openbsd.org"><tt>www@openbsd.org</tt></a>
1.1 brian 442: for configuration details.
443:
1.21 naddy 444: <hr>
445: <a href="index.html"><img height="24" width="24" src="back.gif" border="0" alt="OpenBSD"></a>
1.7 brian 446: <a href="mailto:www@openbsd.org">www@openbsd.org</a>
1.129 ! deraadt 447: <br><small>$OpenBSD: cvsup.html,v 1.128 2010/10/13 20:58:48 sthen Exp $</small>
1.1 brian 448:
449: </body>
450: </html>