Annotation of www/cvsync.html, Revision 1.1
1.1 ! espie 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
! 2: <html>
! 3: <head>
! 4: <title>OpenBSD CVSync</title>
! 5: <link rev="made" href="mailto:www@openbsd.org">
! 6: <meta name="resource-type" content="document">
! 7: <meta name="description" content="How to get OpenBSD updates via Internet using CVSync">
! 8: <meta name="keywords" content="openbsd,cvsync,updates">
! 9: <meta name="distribution" content="global">
! 10: <meta name="copyright" content="This document copyright 2001-2002 by OpenBSD.">
! 11: </head>
! 12:
! 13: <body bgcolor="#FFFFFF" text="#000000" link="#23238E">
! 14:
! 15: <a href="index.html"><img alt="[OpenBSD]" height="30" width="141" src="images/smalltitle.gif" border="0"></a>
! 16:
! 17: <h2><font color="#e00000">CVSync</font></h2>
! 18: <hr>
! 19:
! 20: <h3>Table of Contents</h3>
! 21: <ul>
! 22: <li><a href="#CVSync">What Is CVSync?</a></li>
! 23: <li><a href="#starting">Getting Started Using CVSync</a></li>
! 24: <li><a href="#using">Using CVS to Update Your Source Tree</a></li>
! 25: <li><a href="#CVSROOT">Available CVSync Servers</a></li>
! 26: </ul>
! 27:
! 28: <hr>
! 29:
! 30:
! 31: <h3><a name="CVSync"><font color="#0000e0">What Is CVSync?</font></a></h3>
! 32:
! 33: <p>
! 34: <b>CVSync</b> is a software package for distributing and updating source
! 35: 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
! 36: sources are maintained in a CVS repository on a central development machine
! 37: in Canada. With CVSync, OpenBSD users can easily keep their own source trees
! 38: up to date.
! 39: </p>
! 40:
! 41: <p>
! 42: <b>CVSync</b> uses the so-called pull model of updating. Under the pull
! 43: model, each client asks the server for updates, if and when they are
! 44: wanted. The server waits passively for update requests from its clients.
! 45: Thus all updates are instigated by the client. The server never sends
! 46: unsolicited updates. Users must either run the <b>CVSync</b> client
! 47: 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
! 48: automatically on a regular basis.
! 49: </p>
! 50:
! 51: <p>
! 52: The term <b>CVSync</b>, capitalized just so, refers to the entire software
! 53: package. Its main components are the client <tt>cvsync</tt> which runs on
! 54: each user's machine, and the server <tt>cvsyncd</tt> which runs at each of
! 55: the OpenBSD CVSync mirror sites.
! 56: </p>
! 57:
! 58: <p>
! 59: <b>CVSync</b> is intended to be both faster and flexible than
! 60: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sup&sektion=1&format=html">sup(1)</a>, and more flexible than CVSup.
! 61: </p>
! 62:
! 63: <p>
! 64: The OpenBSD Project currently has five main source repositories:
! 65: </p>
! 66:
! 67: <ul>
! 68: <li><b>src</b> - Houses all source code for the OpenBSD Operating System.</li>
! 69: <li><b>ports</b> - Houses the <a href="./ports.html">OpenBSD Ports</a>.</li>
! 70: <li><b>www</b> - Houses all OpenBSD web pages. (Including this one).</li>
! 71: <li><b>x11</b> - Houses OpenBSD's adaptation of the
! 72: <a href="http://www.XFree86.org/">XFree86-3</a> software project.</li>
! 73: <li><b>xf4</b> - Houses OpenBSD's adaptation of the
! 74: <a href="http://www.XFree86.org/">XFree86-4</a> software project.</li>
! 75: </ul>
! 76:
! 77: <h3><a name="CVS"><font color="#0000e0">What Is CVS?</font></a></h3>
! 78:
! 79: <p>
! 80: CVS is the source code control system used to manage the OpenBSD source
! 81: tree. It is described in more detail <a href="anoncvs.html#CVS">here</a>.
! 82: Note that CVS and CVSync are entirely different programs. Although
! 83: CVS can be used for remote file access, it is not optimized for
! 84: wholesale source tree distribution over the net, and CVSync can be
! 85: easily an order of magnitude more efficient for this task.
! 86: </p>
! 87:
! 88: <h3>
! 89: <a name="starting"><font color="#0000e0">Getting Started Using CVSync</font></a>
! 90: </h3>
! 91:
! 92: <p>
! 93: If you only care about running CVSync, it is recommended that you
! 94: download the cvsync package from the <a href="ftp.html">ftp mirror
! 95: sites</a> instead of building your own from the <tt>net/cvsync</tt>
! 96: port.
! 97: </p>
! 98:
! 99: <p>
! 100: For further information about CVSync, see the
! 101: <a href="http://www.cvsync.org/">project homepage</a>.
! 102: </p>
! 103:
! 104: <p>
! 105: In order to mirror the OpenBSD repository with CVSync,
! 106: the following configuration file might be used:
! 107: </p>
! 108:
! 109: <pre>
! 110: config {
! 111: hostname anoncvs.de.openbsd.org
! 112:
! 113: # If your network link is a T1 or faster, comment out the following line.
! 114: compress
! 115: umask 002
! 116: prefix /cvs
! 117: name openbsd release rcs
! 118: }
! 119: </pre>
! 120:
! 121: <p>
! 122: This directs cvsync to refresh all OpenBSD distributions from
! 123: <b>anoncvs.de.openbsd.org</b> with a <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=umask&sektion=2">umask(2)</a> that permits group write
! 124: permission to the local repository.
! 125: </p>
! 126:
! 127: <p>
! 128: Assuming this file is saved as <tt>cvs-syncfile</tt>, the
! 129: following command would be used to invoke cvsync
! 130: </p>
! 131: <pre>
! 132: cvsync -c cvs-syncfile
! 133: </pre>
! 134:
! 135: <h3><a name="using">
! 136: <font color="#0000e0">Using CVS to Update Your Source Tree</font>
! 137: </a></h3>
! 138:
! 139: <p>
! 140: It is now simple to check out any one of the CVSync'ed repositories.
! 141: For Korn/Bourne shells:
! 142: </p>
! 143: <pre>
! 144: # cd /usr
! 145: # CVSROOT=/cvs cvs checkout src
! 146: </pre>
! 147: <p>
! 148: For csh and its derivatives:
! 149: </p>
! 150: <pre>
! 151: # cd /usr
! 152: # setenv CVSROOT /cvs
! 153: # cvs checkout src
! 154: </pre>
! 155:
! 156: <p>
! 157: The above will check out the most current sources. Many of you will only
! 158: want the release sources, especially if you are patching your system. To
! 159: checkout release sources you must specify a tag along with your command.
! 160: For example:
! 161: </p>
! 162: <pre>
! 163: # cd /usr
! 164: # cvs checkout -rOPENBSD_2_9 src
! 165: </pre>
! 166: <p>
! 167: Or <tt>OPENBSD_2_8</tt> for 2.8, etc.
! 168: </p>
! 169:
! 170: <h3>
! 171: <a name="CVSROOT"><font color="#0000e0">Available CVSync Servers</font></a>
! 172: </h3>
! 173:
! 174: <p>The following CVSync servers are available:</p>
! 175:
! 176: <dl>
! 177: <dt><a href="http://anoncvs.de.openbsd.org"><strong>anoncvs.de.openbsd.org</strong></a></dt>
! 178: <dd><p>
! 179: maintained by <a href="mailto:naddy@openbsd.org">Christian Weisgerber</a>.<br>
! 180: Updated every ?? hours.
! 181: </p>
! 182: <p>
! 183: Available collections:
! 184: </p>
! 185: <table>
! 186: <tr><td width="20"></td>
! 187: <td><strong>openbsd-src</strong></td>
! 188: <td>- The <b>src</b> repository</td></tr>
! 189: <tr><td></td>
! 190: <td><strong>openbsd-ports</strong></td>
! 191: <td>- The <b>ports</b> repository</td></tr>
! 192: <tr><td></td>
! 193: <td><strong>openbsd-www</strong></td>
! 194: <td>- The <b>www</b> repository</td></tr>
! 195: <tr><td></td>
! 196: <td><strong>openbsd-x11</strong></td>
! 197: <td>- The <b>XFree86-3</b> repository</td></tr>
! 198: <tr><td></td>
! 199: <td><strong>openbsd-xf4</strong></td>
! 200: <td>- The <b>XFree86-4</b> repository</td></tr>
! 201: <tr><td></td>
! 202: <td><strong>openbsd-cvsroot</strong></td>
! 203: <td>- The <b>cvsroot</b> repository (Changelogs)</td></tr>
! 204: <tr><td></td>
! 205: <td><strong>openbsd</strong></td>
! 206: <td>- All OpenBSD repositories</td></tr>
! 207: </table>
! 208: </dd>
! 209: </dl>
! 210:
! 211:
! 212: <p>
! 213: <em>Note:</em>, If your server is listed on here with inaccurate or
! 214: unknown information, please contact <a
! 215: href="mailto:beck@openbsd.org"><tt>beck@openbsd.org</tt></a>
! 216: or <a href="mailto:naddy@openbsd.org"><tt>naddy@openbsd.org</tt></a>
! 217: </p>
! 218: <p>
! 219: You may want to use <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=traceroute&sektion=8">traceroute(8)</a>
! 220: to find out which server is nearest you.
! 221: Problems with a server should be reported to the <b>maintainer</b> of the
! 222: server in question.
! 223: </p>
! 224: <p>
! 225: Currently (as of December 17, 2003), the CVS repository sizes are
! 226: </p>
! 227: <table>
! 228: <tr><td width="20"></td>
! 229: <td><strong>openbsd-ports</strong></td>
! 230: <td>- <b>140</b>MB</td></tr>
! 231: <tr><td></td>
! 232: <td><strong>openbsd-src</strong></td>
! 233: <td>- <b>1140</b>MB</td></tr>
! 234: <tr><td></td>
! 235: <td><strong>openbsd-www</strong></td>
! 236: <td>- <b>104</b>MB</td></tr>
! 237: <tr><td></td>
! 238: <td><strong>openbsd-x11</strong></td>
! 239: <td>- <b>200</b>MB</td></tr>
! 240: <tr><td></td>
! 241: <td><strong>openbsd-xf4</strong></td>
! 242: <td>- <b>442</b>MB</td></tr>
! 243: <tr><td></td>
! 244: <td><strong>openbsd-cvsroot</strong></td>
! 245: <td>- <b>257</b>MB</td></tr>
! 246: </table>
! 247: <p>
! 248: The overall repository size currently increases at a rate
! 249: of about <b>225</b>MB per annum.
! 250: </p>
! 251: <p>
! 252: <strong>IMPORTANT NOTE:</strong>
! 253: There are a few issues relating to cryptographic software that everyone
! 254: should be aware of:
! 255: </p>
! 256: <ul>
! 257: <li>
! 258: <p>
! 259: The OpenBSD sources are from Canada. As
! 260: <a href="http://www.efc.ca/pages/doc/crypto-export.html">
! 261: researched by a Canadian individual</a> and as
! 262: <a href="http://axion.physics.ubc.ca/ECL.html">
! 263: described in the Export Control list of Canada</a>,
! 264: it is legal to export crypto software from Canada to the world.
! 265: </p>
! 266: </li>
! 267: <li>
! 268: <p>
! 269: However, if you are outside the USA or Canada, you should not
! 270: fetch the cryptographic sections of the OpenBSD sources from an
! 271: AnonCVS server located in the USA. The files in question are...
! 272: </p>
! 273: <ul>
! 274: <li><tt>src/kerberosIV/*</tt></li>
! 275: <li><tt>src/kerberosV/*</tt></li>
! 276: <li><tt>src/lib/libdes/*</tt></li>
! 277: <li><tt>src/lib/libc/crypt/crypt.c</tt></li>
! 278: <li><tt>src/lib/libc/crypt/morecrypt.c</tt></li>
! 279: <li><tt>src/sys/crypto</tt></li>
! 280: <li><tt>src/sys/netinet</tt></li>
! 281: <li><tt>src/usr.sbin/afs/src/rxkad/*</tt></li>
! 282: <li><tt>XF4/xc-mit/lib/Xdmcp/Wraphelp.c</tt></li>
! 283: <li><tt>XF4/xc-old/lib/Xdmcp/Wraphelp.c</tt></li>
! 284: <li><tt>XF4/xc/lib/Xdmcp/Wraphelp.c</tt></li>
! 285: </ul>
! 286: <p>
! 287: Because of the USA ITAR munitions list,
! 288: crypto software may only be exported to Canada from the USA.
! 289: </p>
! 290: </li>
! 291: </ul>
! 292:
! 293: <p>
! 294: The OpenBSD project is looking for more CVSync servers -- if you are
! 295: interested, please contact <a href="mailto:naddy@openbsd.org">Christian Weisgerber</a>
! 296: for configuration details.
! 297: </p>
! 298:
! 299: <hr>
! 300: <a href="index.html"><img height="24" width="24" src="back.gif" border="0" alt="OpenBSD"></a>
! 301: <a href="mailto:www@openbsd.org">www@openbsd.org</a>
! 302: <br><small>$OpenBSD: cvsup.html,v 1.70 2003/10/23 20:45:41 naddy Exp $</small>
! 303:
! 304: </body>
! 305: </html>