Initial import from FreeBSD RELENG_4:
[dragonfly.git] / release / picobsd / doc / src / intro.html
1 <HTML>
2 <! $FreeBSD: src/release/picobsd/doc/src/intro.html,v 1.7 1999/08/28 01:33:25 peter Exp $ >
3 <HEAD>
4    <TITLE>PicoBSD</TITLE>
5 </HEAD>
6 <BODY>
7
8 <CENTER><h1><B>PicoBSD</B></h1>
9 <HR shade align="center" size="8" width="25%"></CENTER>
10
11
12 <p><b>Contents:</b></p>
13 <ul>
14 <li>
15 <A HREF="#what">What is it</a>, and
16 <A HREF="#hardware">what hardware is supported?</a>
17 </li>
18 <li>
19 <A HREF="#where"><b>Where can I get it?</b></a>
20 </li>
21 <li>
22 <A HREF="#how">How can I use it?</a>
23 </li>
24 <li>
25 <A HREF="#create">Create your own, custom version of PicoBSD!</a>
26 <p>Get the full PicoBSD Development Kit as well as full CVS repository of
27 the project.</p>
28 </li>
29 <li>
30 <A HREF="#info">Where can I get more info?</a>
31 </li>
32 <li>
33 <A HREF="bugs.html">Release history and bugs parade...</a>
34 <li>
35 <A HREF="#future">Plans for the future.</a>
36 </li>
37 <li>
38 <A HREF="#credits">Credits</a>
39 </li>
40 <li>
41 <A HREF="#license">Licensing issues</a>
42 </li>
43 <li>
44 <A HREF="faq.html">FAQ</a>
45 </li>
46 </ul>
47
48 <HR shade align="center">
49 <HR shade align="center">
50
51 <A NAME="what"><h3>What is it?</h3>
52 <p>If you ever dreamed about having really small, tiny, minimal system that
53 would offer you benefits of Unix, while still fitting in reasonable space -
54 here it is!</p>
55
56 <p>PicoBSD is a one floppy version of 
57 <A HREF="http://www.freebsd.org/">FreeBSD</a> 3.0-current, which in its
58 different variations allows you to have secure dialup access, small diskless
59 router or even a dial-in server. And all this on only one standard 1.44MB
60 floppy - no need to sacrifice over 100MB of your precious HDD space.</p>
61
62 <p>PicoBSD is... well, pico-sized :-) , and the minimal hardware that
63 is required to run it is 386SX CPU with 8MB of RAM (no HDD!).
64 </p>
65
66 <A NAME="hardware">
67 <p>Here you can find detailed <A HREF="hardware.html">list of supported
68 hardware and features</a>.
69
70 <p>Current version of PicoBSD is @VER@, and this means that I consider it
71 still immature, while on the other hand being somewhat tested and improved
72 over previous versions. Does it tell you something? Well, at least you can
73 try it - I cannot guarantee that it doesn't burn your house or blow up your
74 machine, though the former is unlikely... :-)</p>
75
76 <HR shade align="center">
77 <A NAME="where"><h3>Where can I get it?</h3>
78
79 <p>There are two language editions of PicoBSD - English and Polish one. You'll
80 be probably more interested in the former :-) The only difference is in
81 the set of fonts included, C locale, and the language of messages.</p>
82 <p>You can download them from www.freebsd.org or one of its mirrors:</p>
83 <ul>
84 <li>Dialup version: <A HREF="http://www.freebsd.org/~picobsd/picobsd/pb_en-D.bin">English</a>
85 (<A HREF="http://www.freebsd.org/~picobsd/picobsd/doc_dial/README.en">README</a>) or 
86 <A HREF="http://www.freebsd.org/~picobsd/picobsd/pb_pl-D.bin">Polish</a>
87 (<A HREF="http://www.freebsd.org/~picobsd/picobsd/doc_dial/README.pl">README</a>)
88 </li>
89 <li>Networking (formerly known as 'router-like') version: <A HREF="http://www.freebsd.org/~picobsd/picobsd/pb_en-N.bin">English</a>
90 (<A HREF="http://www.freebsd.org/~picobsd/picobsd/doc_net/README.en">README</a>)
91  or <A HREF="http://www.freebsd.org/~picobsd/picobsd/pb_pl-N.bin">Polish</a>
92 (<A HREF="http://www.freebsd.org/~picobsd/picobsd/doc_net/README.pl">README</a>)
93 </li>
94 <li>Router version: <A HREF="http://www.freebsd.org/~picobsd/picobsd/pb_en-R.bin">English</a>
95 (<A HREF="http://www.freebsd.org/~picobsd/picobsd/doc_router/README.en">README</a>)
96  or <A HREF="http://www.freebsd.org/~picobsd/picobsd/pb_pl-R.bin">Polish</a>
97 (<A HREF="http://www.freebsd.org/~picobsd/picobsd/doc_router/README.pl">README</a>)
98 </li>
99 <li>Dial-in server version: waiting for 
100 <A HREF="http://www.freebsd.org/~picobsd/beta.html">beta testers</a> ... :-)
101 </ul>
102
103 <p><i>(See the <A HREF="hardware.html">feature list</a> for more
104 details)</i></p>
105
106 <p>The above floppies were built from 3.0-current sources. Though they
107 provide more features, they tend to be less stable than the latest
108 RELEASE of FreeBSD. Dinesh Nair back-ported these scripts to the
109 latest release (2.2.5), and continues development of PicoBSD using sources
110 from that branch. You can find floppies built from 2.2.5 sources 
111 <A HREF="http://www.freebsd.org/~picobsd/picobsd225/">here</a> or at 
112 <A HREF="http://info.net-gw.com/picoBSD/">his server</a>.</p>
113
114 <HR shade align="center">
115 <A NAME="how"><h3>How can I use it?</h3>
116 <p>Previous versions were packed with PKZIP(tm) compatible program - now they
117 are simply the raw binary floppy images, so you just need to grab the
118 appropriate version of the file.</p>
119
120 <p>I assume you will use 1.44MB floppy to boot the system - other sizes
121 (bigger) are not tested.</p>
122
123 <p>The file 'pb_xx-X.bin' must be written onto a blank floppy. It does NOT
124 mean that it can be copied using e.g. DOS 'copy' command. You must use a 
125 program like 
126 <A HREF="ftp://ftp.freebsd.org/pub/FreeBSD/tools/rawrite.exe">rawrite.exe</a>
127 or
128 <A HREF="ftp://ftp.freebsd.org/pub/FreeBSD/tools/fdimage.exe">fdimage.exe</a>
129  to write this file directly on the raw floppy.</p>
130
131 <p>Under DOS you would do something like this:</p>
132 <pre>
133         C:\> fdimage.exe pb_xx-X.bin a:
134 </pre>
135
136 <p>while under Unix you would use something like:</p>
137 <pre>
138         dd if=pb_xx-X.bin of=/dev/rfd0
139 </pre>
140
141 <p>Then boot off this floppy and enjoy!</p>
142
143 <p>If you feel lost, try the 'help' command (it's available only on "dialup"
144 floppies)</p>
145
146 <HR shade align="center">
147 <A NAME="create">
148 <h3>Create your own, custom version of PicoBSD!</h3>
149
150 <p>I made available also the set of tools
151 (a.k.a the PicoBSD Development Kit) I used to create the floppies (see also the 
152  <A HREF="how2build.html">detailed instructions</a>)</p>
153
154 <p>You can also access the full CVS repository of PicoBSD - beginning with
155 version 0.4 it's a part of official FreeBSD CVS and lives in
156 <code>src/release/picobsd</code>. I also create the snapshots of this source
157 tree - keep in mind that they are not so up-to-date as the tree
158 in FreeBSD CVS. You can get the snapshot I made on 
159 Sun Nov  1 11:48:32 PST 1998
160 <A HREF="http://www.freebsd.org/~picobsd/picobsd/picobsd.tgz">here</a>.</p>
161
162 <p> Now, if you don't like the setup of PicoBSD, or you miss
163 some program, or (better yet) you want to improve PicoBSD - you can grab the
164 copy of exactly the same tools I used and build your own, customized
165  version! </p>
166
167 <p>Think of it: if your're an ISP, you can build the dialup version for
168  your customers, including some scripts to automatically connect them to 
169 your site. You can also create a demo disk for your friend (or your boss! :-)).
170 You can also build a firewall/router for your office, etc, etc...
171  possibilities are really endless and limited only by your imagination.</p>
172
173 <p>You will need at least 10MB of free disk space for building, and of course
174 the full system sources installed. I also assume that the sources are
175 quite -current. There is also a back-ported version of the scripts prepared by
176 <A HREF="mailto:dinesh@alphaque.com">Dinesh Nair</a> which builds ok on
177 2.2.6-R systems.</p>
178
179 <p>Version 0.31 was packed with pax(1) - newer versions are packed again
180 with tar and gzip to avoid confusion... :-)</p>
181
182 <p>I'm very interested in hearing from you about your experiences - if you
183 come up with a setup you think is interesting, please let me know!</p>
184
185 <HR shade align="center">
186 <A NAME="info"><h3>Where can I get more info?</h3>
187
188 <p>Almost all of the programs included on the floppies are exactly the
189 same versions as in normal FreeBSD installation, so that the normal
190 manual pages apply. However, I didn't include the manpages themselves - 
191 they would take over 200kB!</p>
192
193 <p> For the total newbies, which would use (I assume)
194 the 'dialup' version, there is a short README on the floppy which gives
195 step by step instructions on how to get a dialup connection. There is also
196 a script called 'dialup' which attempts to configure PPP to allow for automatic
197 log in to your provider, and for background operation.
198 There is also a small help system ('help' command)</p>
199
200 <p> There are some system utilities which are unique to PicoBSD, and at this
201  moment they are documented in detail only in source and READMEs :-(.</p>
202
203
204 <p>As for the new releases which will (hopefully) be prepared in the future:
205 just keep an eye on this page. I'll also send announcements to FreeBSD mailing
206 lists.</p>
207
208 <HR shade align="center">
209 <A NAME="future"><h3>Plans for the future</h3>
210
211 <p>Well, I hope that thanks to your comments I'll be able to continuously
212 improve the setup and contents of PicoBSD. I also have specific dreams (if
213 dreams can be specific..) - here they are, as an incentive to your
214 imagination and coding skills:</p>
215 <ul>
216 <li>
217 To write a command line tool patterned after Cisco IOS, which could configure
218 various aspects of router-like version of PicoBSD.
219 <p>Well, currently you can read very preliminary draft of proposed
220 architecture, called the <A HREF="UCI.html">Unified Configuration Interface.</a></p>
221 </li>
222 <li>
223 To put an XWindow-like GUI on the 'dialup' floppy. (Update: you can look at
224 <A HREF="http://www.freebsd.org/~picobsd/preview/preview2.tgz">preview
225 version</a> and send me your comments. <b>I need some help in porting newer
226 version of W</b>).
227 </li>
228 <li>
229 To gain some experience with solid state disks, and prepare standard images
230 for e.g. 4MB versions of SSD, with Cisco 25xx-like contents... I also hope
231  to achieve this goal in the nearest
232 future, thanks to involvement of some PicoBSD enthusiast :-)</p>
233 (Update: I'm experimenting with an M-System's 16MB flash right now, and
234 there is also ongoing development for a driver for their DiskOnChip)
235 </li>
236 <li>
237 To be able to boot from more primitive filesystem than FFS - DOS or Minix
238 would be just fine, as they don't waste so much space for their internals.
239 </li>
240 <li>
241 To have an alternative to current MFS - it wastes a lot of space just
242 because it mimicks the normal FFS on top of memory blocks...
243 </li>
244 <li>
245 To further minimize the memory footprint of router-like setup. I'd like it
246 to be able to run truely effortlessly on 4MB machines... This would
247 probably include rewriting oinit(8) to run multithreaded.
248 </li>
249 <li>
250 And many others... You can find a complete list
251 <A HREF="TODO.html">here</a>.
252 </li>
253 </ul>
254
255 <A NAME="credits"><h3>Credits</h3>
256
257 <p>The following people are either responsible for the very existence of this
258 project, or significantly eased my pains in gaining necessary knowledge:</p>
259 <ul>
260 <li>
261 the whole FreeBSD team for this magnificent OS, and their hard work of
262 continuous development,
263 </li>
264 <li>
265 Dinesh Nair, for co-development and preparing of the version which compiled
266 on 2.2.5-RELEASE,
267 </li>
268 <li>
269 Joe Greco, for his encouraging example of XKERNEL (some parts of the scripts
270 still bear his fingerprints :-) (you can get it
271  <A HREF="../../../xkernel.tgz">here</a>).
272 </li>
273 <li>Goran Hasse of <A HREF="http://www.raditex.se">Raditex AB, Sweden</a>, for
274 sending me M-Systems' and SanDisk flash disks to experiment with.
275 </li>
276 <li>
277 Mike Smith for various tips and encouragement.
278 </li>
279 <li>
280 freebsd-* mailing lists participants, which helped me with some other
281 pieces.
282 </li>
283 <li>
284 and many other people who keep encouraging me to continue this work. Thanks,
285 guys!
286 </li>
287 </ul>
288
289 <A NAME="license"><h3>Licensing issues</h3>
290
291 <p>PicoBSD is distributed under BSD copyright,
292 which allows you to use it in various ways, including commercial
293 applications. So grab it and enjoy! And if you feel that you want to help
294 with this project, either by donating some time to write code, or by
295 some other donation, just <A HREF="mailto:abial@freebsd.org">contact me</a>.</p>
296
297 <h5>Last modified: 
298 @DATE@
299 </h5>
300
301 <HR shade align="left" size="2" width="100%">
302 <CENTER><h5>Any comments? Send them to
303 <A HREF="mailto:abial@freebsd.org">the author</A> </h5></CENTER>
304
305 </BODY>
306 </HTML>