]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - release/ABOUT.TXT
This commit was generated by cvs2svn to compensate for changes in r36206,
[FreeBSD/FreeBSD.git] / release / ABOUT.TXT
1 o About FreeBSD:
2
3 What is FreeBSD?  FreeBSD is an operating system based on 4.4 BSD Lite
4 for Intel, AMD, Cyrix or NexGen "x86" based PC hardware.  It works
5 with a very wide variety of PC peripherals and configurations and can
6 be used for everything from software development to Internet Service
7 Provision.
8
9 This release of FreeBSD contains everything you need to run such a
10 system, including full source code for everything.  With the source
11 distribution installed you can literally recompile the entire system
12 from scratch with one command, making it ideal for students,
13 researchers or folks who simply want to see how it all works.
14
15 A large collection of 3rd party ported software (the "ports
16 collection") is also provided to make it easier for you to obtain and
17 install all your favorite traditional UNIX utilities for FreeBSD.
18 Over 1000 ports, from editors to programming languages to graphical
19 applications, make FreeBSD a powerful and comprehensive operating
20 environment that extends far beyond what's provided by many commercial
21 versions of UNIX.
22
23 For more documentation on this system it is recommended that you
24 purchase the 4.4BSD Document Set from O'Reilly Associates and the
25 USENIX Association, ISBN 1-56592-082-1.  We have no connection with
26 O'Reilly, we're just satisfied customers!
27
28 If you're new to FreeBSD then you should also read EVERYTHING listed
29 in the Documentation menu on the boot floppy.  It may seem like a lot
30 to read, but you should at least acquaint yourself with the types of
31 information available should you later get stuck.  Once the system is
32 installed, you can also revisit this menu and use a WEB browser to
33 read the installed FAQ (Frequently Asked Questions) and Handbook HTML
34 documentation sets for FreeBSD.  You can also use the browser to visit
35 other WEB sites on the net (such as http://www.freebsd.org) if you
36 have an Internet connection.
37
38
39 DISCLAIMER: While FreeBSD does its best to safeguard against
40 accidental loss of data, it's still more than possible to WIPE OUT
41 YOUR ENTIRE DISK with this installation!  Please do not proceed to the
42 final FreeBSD installation menu unless you've adequately backed up any
43 important data first!  We really mean it!
44
45
46 o E-mail addresses and tech support info:
47
48 For general questions, please send email to :
49
50         freebsd-questions@FreeBSD.org
51
52 Please also have patience if your questions are not answered right
53 away - this mailing list is staffed purely by volunteers and they also
54 have real life schedules to contend with.  Questions which are asked
55 intelligently (e.g. not "My system doesn't work!  What's wrong!?")
56 also stand a far greater chance of being answered. If your question
57 does not contain enough information to allow the responder to generate
58 a meaningful answer, they generally won't.
59
60 Bug reports submitted with the send-pr command are also logged and
61 tracked in our bugs database, and you'll be kept informed of any
62 changes in status during the life of the bug (or feature request).
63
64 Technical comments on this release should be sent (in English!) to:
65
66         freebsd-hackers@FreeBSD.org
67
68 Bug reports should be sent using the `send-pr' command or the Web page
69 at http://www.freebsd.org/send-pr.html.  If you cannot use either of
70 these two methods, you may also send mail to:
71
72         freebsd-bugs@FreeBSD.org
73
74
75 PLEASE ALSO BE SURE TO INDICATE WHICH VERSION OF FREEBSD YOU'RE
76 RUNNING IN ANY BUG REPORTS OR QUESTIONS!
77
78 Sorry for the caps, but you'd be amazed at how many times people
79 forget this and there are many different release versions of FreeBSD
80 out there now.  It's imperative that we know what you're running so
81 that we tell if you're suffering from a bug which has already been
82 fixed.
83
84
85 o WWW Resources:
86
87 Our WEB site, http://www.freebsd.org, is also a very good source for
88 updated information and provides a number of advanced documentation
89 searching facilities.  If you wish to use Netscape as your browser,
90 you may install the BSDI version from ftp://ftp.mcom.com or simply
91 type:
92
93         # cd /usr/ports/www/netscape3
94         # make all install
95
96 If you have the Ports collection installed on your machine.
97
98
99 Several other non-commercial browsers are also available in
100 /usr/ports/net and may be compiled and installed in the same fashion.
101 Many are also available as pre-compiled packages - see the Packages
102 entry in the Configuration menu for more details.
103
104 The Handbook and FAQ are also available as on-line documents in
105 /usr/share/doc and can be read using the ``file:/usr/share/doc''
106 syntax in any HTML capable browser.
107
108
109 o Distributions:
110
111 A typical FreeBSD distribution directory looks like this:
112
113 ABOUT.TXT       bin             dict            manpages        tools
114 HARDWARE.TXT    compat1x        des             doc             packages
115 INSTALL.TXT     compat20        floppies        ports
116 README.TXT      compat21        games           proflibs
117 RELNOTES.TXT    info            src
118 XF86331
119
120 If you want to do a CDROM, FTP or NFS installation from this
121 distribution directory, all you need to do is make a 1.44Mb floppy
122 from the floppies/boot.flp image file (see floppies/README.TXT for
123 instructions on how to do this), boot it and follow the instructions.
124
125 If you're trying to do some other type of installation, or are just
126 curious about how the distribution is organized in general, what
127 follows is a more thorough description of each item in more detail:
128
129 The *.TXT files obviously contain documentation (ABOUT.TXT being what
130 you're reading now).
131
132 The XF86331 directory contains the XFree86 project's 3.3.1 release and
133 consists of a series of gzip'd tar files which contain each component
134 of the XFree86 distribution.
135
136 The bin, dict, des, doc, games, info, manpages, proflibs, and src
137 directories contain the primary distribution components of FreeBSD
138 itself and are split into smaller files for easy packing onto floppies
139 (should that be necessary).
140
141 The compat1x, compat20 and compat21 directories contain distributions
142 for compatibility with older releases and are distributed as single
143 gzip'd tar files - they can be installed during release time or later
144 by running their `install.sh' scripts.
145
146 A typical distribution (we'll use the info distribution as an example)
147 looks like this:
148
149 CHECKSUM.MD5    info.ab         info.ad         info.inf        install.sh
150 info.aa         info.ac         info.ae         info.mtree
151
152 The CHECKSUM.MD5 file contains MD5 signatures for each file, should
153 data corruption be suspected, and is purely for reference - it is not
154 used by the actual installation and does not need to be copied with
155 the rest of the distribution files.  The info.a* files are split,
156 gzip'd tar files, the contents of which can be viewed by doing:
157
158         cat info.a* | tar tvzf -
159
160 During installation, they are automatically concatenated and extracted
161 by the installation procedure.
162
163 The info.inf file is also necessary since it is read by the installation
164 program in order to figure out how many pieces to look for when fetching and
165 concatenating the distribution.  When putting distributions onto floppies,
166 the .inf file MUST occupy the first floppy of each distribution set!
167
168 The info.mtree file is another non-essential file which is provided
169 for user reference.  It contains the MD5 signatures of the *unpacked*
170 distribution files and can be later used with the mtree(1) program
171 to verify the installation permissions and checksums against any possible
172 modifications to the file.  When used with the bin distribution, this can
173 be an excellent way of detecting trojan horse attacks on your system.
174
175 Finally, the install.sh file is for use by those who want to install the
176 distribution after installation time.  To install the info distribution from
177 CDROM after a system was installed, for example, you'd do:
178
179                 cd /cdrom/info
180                 sh install.sh
181
182 And that's all there is to it!  Each distribution contains its own
183 install.sh file for this.
184
185
186 The floppies subdirectory contains the floppy installation images and
187 the floppies/README.TXT file should be read for further information
188 on them.
189
190 The packages and ports directories contain the FreeBSD packages and
191 ports collections.   Packages may be installed from the packages directory
192 by running the /stand/sysinstall utility with the argument ``configPackages''
193 or by feeding the individual filenames to the pkg_add(1) command.
194
195 The ports collection may be installed like any other distribution
196 and requires about 15MB unpacked.  More information on the ports collection
197 may be obtained from http://www.freebsd.org/ports or locally from
198 file:/usr/share/doc/handbook if you've installed the doc distribution.
199
200 Last of all, the tools directory contains various DOS tools for
201 discovering disk geometries, installing boot managers and the like.
202 It is purely optional and provided only for user convenience.