<!-- $Id: sup.sgml,v 1.7 1995/09/27 00:46:30 jmz Exp $ -->
<!-- The FreeBSD Documentation Project -->


<sect><heading>SUP<label id="sup"></heading>

<p><em>Contributed by &a.jkh; and &a.gclarkii;.</em> 

SUP is a network based software update tool developed at CMU.  The
purpose of this document is get the beginner up and running with sup.

<sect1><heading>Getting setup</heading>

<p>First off you will need to pick up the sup binaries.  The easiest
way of doing this is to grab the sup.tgz package from:
<verb>
        ftp://ftp.FreeBSD.ORG:/pub/FreeBSD/packages/sup.tgz
</verb>
Install the sup package using pkg_add and add the following line to
your /etc/services file (if it doesn't already exist):
<verb>
        supfilesrv          871/tcp        # for SUP
</verb>

SUP gets the information it needs to run from a configuration file 
called a supfile.  This file tells sup what collections it will be updating
and/or installing and where they go.  The supfile in this directory will
sup both the source and ports collection - look for the blank line separating
the two collections; if you don't want ports, you can simply delete all the
ports entries.  If you're inside the United States, you may also uncomment
the `secure' collection line to grab the DES code.  If you're outside the
U.S., you should NOT sup this code from FreeBSD.ORG as this will
violate U.S. export restrictions.  Simply sup everything <em>but</em> the secure
collection and then go look on braae.ru.ac.za, where it's available for
anonymous ftp for those outside the U.S.

Any other distributions you do not wish to receive can be commented out
with a &num; at the beginning of the distribution line.

Once this is setup, you're ready to go.  To start sup type:
<verb>
	sup supfile
</verb>
If you wish to see what sup is doing "verbosely", give it the -v option,
like so:
<verb>
	sup -v supfile
</verb>
Thats all there is to it!  Remember that if you're running current,
which is what you will have if you sup, please join the freebsd-current
mailing list.  You should also be sure to read <ref id="current" 
name="Staying current with FreeBSD">
for important information on just what we can and cannot do for you as
a -current user.  

<sect1><heading>Description of FreeBSD SUP distributions</heading>

<p>For the main FreeBSD distribution:
<verb>
base:		/usr/src/...		misc files at the top of /usr/src
bin:		/usr/src/bin		system binaries
secure:		/usr/src/secure		DES Sources.  U.S./Canada only!
etc:		/usr/src/etc		system files
games:		/usr/src/games		games
gnu:		/usr/src/gnu		sources under the GNU Public License
include:	/usr/src/include	include files
sys:		/usr/src/sys		kernel sources
lib:		/usr/src/lib		libraries
libexec:	/usr/src/libexec	more system binaries
share:		/usr/src/share		various shared resources
sbin:		/usr/src/sbin		even more system binaries
usrbin:		/usr/src/usr.bin	user binaries
usrsbin:	/usr/src/usr.sbin	that's it for the system binaries
</verb>

And for the ports collection:
<verb>
ports-base:	/usr/ports/...		misc files at the top of /usr/ports
ports-editors:  /usr/ports/editors	text editors
ports-game:	/usr/ports/games	games
ports-lang:	/usr/ports/lang		programming languages
ports-mail:	/usr/ports/mail		mail software
ports-math:	/usr/ports/math		math software
ports-net:	/usr/ports/net		networking software
ports-news:	/usr/ports/news		USENET news software
ports-print:	/usr/ports/print	printing software
ports-russian:  /usr/ports/russian      russian software
ports-shells:	/usr/ports/shells	various UN*X shells
ports-utils:	/usr/ports/utils	miscellaneous utilities
ports-x11:	/usr/ports/x11		X11 software
</verb>