Check for SYS/GL during library init. Reason is that
[AROS.git] / workbench / locale / help / English / using.txt
blob79965e6bcc2f537bf5d1b2f68484d636f34a6345
1 ================
2 AROS Users Guide
3 ================
5 :Authors:   Stefan Rieken, Matt Parsons, Adam Chodorowski, Sergey Mineychev
6 :Copyright: Copyright 1995-2006, The AROS Development Team
7 :Version:   $Revision: 24924 $
8 :Date:      $Date: 2006-10-23 21:29:58 +0500 (à†àÍ, 23 àÎàÊá™ 2006) $
9 :Status:    Unfinished; only converted to reST. Needs heavy updating. In works!
11 .. Warning::
13    This document is in progress! It is highly likely that some parts 
14    contain incorrect information or are simply missing altogether. 
15    If you want to help rectify this, please contact us.
16    
17    TO DO: Convert to Guide
19 .. Contents::
22 Introduction
23 ============
25 This is the AROS Research Operating System User's Guide. It is meant to
26 get people used to AROS. It is for *everybody* interested in AROS, as it
27 tries to provide information on AROS in different levels of
28 advancedness. I try to cover everything in depth, but in such a way that
29 you don't need to learn what you don't *want* to learn.
32 Who should read this guide
33 --------------------------
35 This guide will help you getting used with AROS. It is written for
36 everybody who is interested in AROS. Keep in mind that you are actually
37 using software that is BETA and in research. It is currently mostly fun
38 to play with and cool to program for and program in. So I expect that
39 your interest in AROS is explained by one of these reasons. If you came
40 until here because you thought AROS was a Multimedia Internet-Ready Etc.
41 OS, well, you might be right, but it is *not finished*, so you need to
42 be patient, boy. If you thought AROS was a Grapefruit-Machine or a Free
43 Money Project, you are entirely in the wrong place.
46 How you should read this guide
47 ------------------------------
49 This guide is ordered from "simple" to "advanced". You can start reading
50 at any chapter that contains information that is new to you. But maybe
51 even more important, you should stop reading at any chapter that
52 contains information going beyond your interest. In this way you can
53 learn yourself the advanced topics starting from scratch, or you can
54 stop earlier if you think you only want to use AROS, and not program it.
55 People with an Amiga background can skip the introduction, and start at
56 "Developing for the AROS platform" if they never programmed an Amiga
57 before, or go directly to "Developing inside AROS" if they already did.
58 So there is a starting point and a stop point for everyone.
60 It is important to realize that this guide is meant for AROS, not Amiga.
61 So even if you owned an Amiga for years, you might need to read "Using
62 AROS" too.  This is not an embarrassment: you will notice that using
63 AROS is very slightly different from using AmigaOS. This is because our
64 Workbench is not finished. At the moment the system mostly works through
65 a AmigaDos shell - replacement (or Cli to older users), although we do
66 have a Workbench and you can navigate disks and launch the applications
67 with it, but file operations is not yet complete. Old Amiga programmers
68 should read "differences with Amiga programming" from chapter 4 to get
69 an overview of the differences. 
71 Using AROS
72 ==========
74 AROS-hosted: An Operating System in an Operating System?
75 -----------------------------------------------------------
77 AROS is originally developed on Linux_ running on an Intel-based
78 computer. It runs on many more machines and Operating Systems, though.
79 This may sound strange: an OS running on top of an other OS, that's
80 emulation, right?
82 A nice term for what AROS-hosted does is "API emulation". API is a
83 three-letter acronym for Application Programmer's Interface. In plain
84 English: an API provides (C Language) functions that a programmer can
85 use. The AmigaOS API consists of a load of library calls that an Amiga
86 programmer can use to make an Amiga program. AROS emulates the AmigaOS
87 API: it tries to provide the same library calls as AmigaOS. An Amiga
88 emulator, such as UAE_; emulates the Amiga *computer*: the processor,
89 the connected hardware, everything. This has its advantages, like being
90 able to play binary Amiga games on different hardware, and its
91 disadvantages, like not being able to use the emulator as a "real" OS,
92 on a "real" processor. AROS-hosted runs on the "real" processor. But it
93 isn't a "real" OS, *unless* you run in such a way that it doesn't
94 require Linux. This is called "native" AROS.
96 AROS can run natively on the Intel and Amiga computers, but not quite as
97 good as it runs on Linux. AROS library functions are made to run under
98 Linux first, internally using Linux kernel and library calls. This way a
99 programmer has got the opportunity to bother about the implementation of
100 the whole system first, and to bother about the technical details in a
101 later stadium. People are currently working on making the "native" AROS
102 more usable. The results are very impressive and it is perfectly
103 possible to use AROS-native as a real (and only) Operating system on an
104 IBM PC compatible machine.
106 Of course, AROS is not *only* an API emulator. It also tries to provide
107 replacements to all the AmigaOS3.1 system software, and you will also
108 find a few demos and games being shipped with AROS, just to show that
109 they work - we might just be at 77% of the whole system, but we already
110 have Quake running!
113 Using "native" AROS on i386 
114 ---------------------------
116 Native AROS is currently under heavy development. If you want to see
117 cool tricks, try AROS on Linux. But if you're (also) interested in what
118 a great job the programmers have done, you can try "native" too.
120 The instructions for installing native AROS are varying depending on
121 which platform you use. Because "native" is still in great development,
122 the *results* from installing native AROS can also vary depending on the
123 age of the code that you use.
125 On i386 there`s a different booting media available. First and most
126 useful binaries set is an AROS LiveCD which you can get in the Downloads
127 section. It is can be either a snapshot or a nightly build (first is
128 more stable but outdated, last has latest changes made but can be
129 unstable in rare cases). Second is the AROS boot floppy, which is
130 intended to boot systems that unable to boot from CD. It`s have a
131 minimal set of features but thus have small size also. If you have no CD
132 drive it still can show some part of an AROS to you.
134 So, after you download the AROS LiveCD archive unpack it and write ISO
135 image to the CD-R(W). If you intent to use AROS in virtual machine, you
136 can use ISO as-is. Once the disc is ready, you can reboot your PC with
137 the LiveCD. If your system does not support booting from CD, also
138 download and write an AROS boot floppy to disk (with Rawrite or Winimage
139 program, for example) and boot from it, leaving CD in drive. After the
140 CD is booted you will find yourself in AROS (it is looks stunningly
141 close to AmigaOS). You can fool around LiveCD with the Wanderer (or with
142 Shell), play some games/demos included in contributed programs on the
143 CD, look at system basics until you get bored. Also it`s possible to add
144 files to ISO image and get some extra software written for AROS, and
145 rewrite the LiveCD. For now here end simple part of using an
146 AROS-native. To test all other features it`s required to install_ the
147 system to the hard disk (real or virtual). This process can`t be called
148 easy, and must be treated as experimental. It has beed desribed in
149 Installation Doc. Anyway, remeber that work continues and soon you can
150 get more from native AROS - keep in touch! 
152 Using "native" AROS i386 in Virtual Machines
153 --------------------------------------------
155 Currently the *Virtualization* technologies is developed to a almost complete
156 real machine replacement, have been burned-on by the increasing CPU speeds.
157 You can make a "virtual" machine inside of your system ("host") and launch AROS on it,
158 without being worried about any failures and relaunching the "guest" system quickly 
159 if something has happened. There`s a number of free virtual machine packages,
160 most knowingly is QEMU (Free, Open Source), VMWare Player (Free. There`s also
161 a full VMWare server for free that require a free serial) and Microsoft VPC (Free).
162 You can get a version for your "host" system that suits your needs. We will
163 describe some tips on launching AROS for different VM`s. 
165 Instead of having almost the same AROS setup inside the VM`s, there`s a 
166 difference in setting the VM itself. 
168 QEMU on Linux is quite easy to setup. All you need is to apt-get the package
169 on Debian/Ubuntu/Knoppix/DSL or use any other package manager for other 
170 distributions or download and unpack the archive manually. You can get the
171 archive from the `QEMU Website <http://fabrice.bellard.free.fr/qemu/>`__. 
173 QEMU on Windows is almost the same thing. The difference is in networking
174 and some other issues. You can find useful information and packages on 
175 `QEMU On Windows page <http://www.h7.dion.ne.jp/~qemu-win/>`__ . 
176 Also there`s nice GUI for QEMU called QEMU Manager, including the QEMU package.
177 There`s also some GUI`s for QEMU for some systems can be found in links.
179 QEMU must be launched as a console application with some parameters given. 
180 We will review some options in other sections, meaning you must append
181 these to your launch string (or a script). 
183 QEMU is fast virtualiser, but it`s speed can be increased by installing 
184 the KQEMU kernel module (and appending the -kernel-kqemu option if in Windows).
185 But remember that KQEMU can make guest system unstable.
187 Also if you considered to try installing AROS to HD, you can create the 
188 virtual HDD for QUMU using the qemu-img program (replace <size> 
189 with needed size in bytes, M or G for mega- or giga-) with a command like::
190     
191     qemu-img create -f qcow aros.img <size>
193 Applying to `VMWare <http://vmware.com>`__ or VPC it`s even easier to setup. 
194 All you need is to install some virtual hardware like network and sound card 
195 and create an virtual HDD. Everything managed by a simple GUI.
197 Using the AfA on m68k
198 ---------------------
200 On an Amiga (m68k), you can place the native code somewhere on your
201 harddisk, double-click the "boot" icon, do a reset and enjoy a complete
202 Amiga system.  This is because it is not *really* native. The boot
203 program just temporarily replaces a few AmigaOS libraries with AROS
204 libraries. For testing purposes this is of course good, but in the end
205 you still run good ol' AmigaOS and not plain native AROS. This will
206 change as we build a more complete 68k AROS system. This system is often
207 called AfA (AROS for Amigas).
210 Using AROS hosted on Linux or FreeBSD
211 -------------------------------------
213 Once you got the binaries for your system, either by compiling or by
214 downloading pre-compiled binaries, you should go down into the
215 "bin/$TARGET/AROS" directory, where $TARGET is your system target
216 (something like "linux-i386"). Run the file "aros" ("./aros"). The
217 Workbench replacement "Wanderer" will be started.
219 There`s some command line options for aros executable that could be used.
220 You can get this list with ./aros -h option given.
222 To be appended ...
224 Because "Wanderer" is very limited you'll prefer to work with the Shell.
225 You can start it from the menu "Wanderer/Shell". Now you should type in
226 commands, and the most important command is "dir": it will show you a
227 directory's contents. The directory named "C" contains all the commands,
228 so it might be useful to display its contents with "dir c:". The shell
229 behaves like an AmigaDOS shell, and the commands in "C" behave like
230 their AmigaDOS equivalents. (Note to UNIX folks: to address the parent
231 directory, use "/" and not "..": this will look ugly because AROS thinks
232 that Linux's ".." is a normal directory. You shouldn't use "./" as a
233 prefix to address a command within the current directory either, but
234 leave this away instead.) Once you are used to it, try to execute a few
235 programs (especially the "Demos" and "Games") to get an impression of
236 AROS capabilities. 
238 Using AROS-hosted on PPC
239 ------------------------
241 To be filled by someone... 
244 AROS Basics
245 ===========
247 AROS Zune GUI Basics
248 --------------------
250 GUI abbreviation stands for Graphical User Interface, and is applied to
251 all the means used by OS to interact with user other than plain
252 command-line interface (CLI). For those who never have used any OS from
253 Amiga branch, it will be useful to give some GUI basics to help them in
254 use of our system. Some of it, however, will be AROS-specific. 
256 An Amiga systems use definitely and common principles, as you can
257 already note. First, any menu options of any application`s window isn`t
258 attached to that window - it moved to upper strip, where it can be
259 easily acessed. To do this, select window you`re need, and move mouse
260 pointer to upper side of a screen. Then, if you press right mouse button
261 there, you can see the pull-down menu, representing our application`s
262 options. Yes, it looks like MacOS somehow. Also you can enable the menu
263 to appear on any place of the screen, where you press left mouse button.
264 To do so ... For example, if no application window is selected, you can
265 see the Wanderer`s menu then. 
267 Now, let`s consider our desktop - as you probably already know, it`s
268 called Wanderer. What is this ? Well, Wanderer is an application, just
269 like all others. In fact, it is an AROS file manager, allowing you to
270 choose and operate files (the functionality isn`t complete yet), launch
271 programs, get some system information, launch CLI (shell window) and
272 other functions. Usually it opens on wide screen and acts like your
273 desktop (icons on this desktiop represents the volumes and disks you can
274 work with). It can be set aside by unselecting Backdrop option, which
275 can be found in Wanderer`s menu (remember paragraph above?). After that
276 a Wanderer becomes just another window you can move, resize etc. So, you
277 can see it isn`t like a Windows or another system`s desktop, fixed to
278 it`s place. Of course, you can even not use the Wanderer at all and use
279 your preferred file manager (e.g. Directory Opus).
281 But how do the applications behave then, where will the windows be open?
282 There`s a `screen` term - screen is the place where your window is meant
283 to be open. If it`s said that application going to open on Wanderer
284 screen, it will look like it`s usually happens in other OS - your app
285 will appear as window on desktop. Also window usually can be open on
286 it`s own screen - it looks like it captures the whole screen. But you
287 can switch the screens with a gadget in top right corner fo the screen
288 (this is also applicable to the windows). So you can switch between
289 Wanderer, Directory Opus and any other apps opening on it`s own screen.
290 This behaviour also comes from Amiga`s history.
291                                                   
292 Well, the time has come to say something about windows itself. Aros
293 window usually has controls to manupalte with it. This control buttons
294 are called gadgets (which can be translated as interactive kind of
295 graphical element). First one in the top left corner of a window allows
296 to close it. Next, in the right part allows to minimise/maximise window.
297 And the last used to put window to front or to back just like we switch
298 sreens. Windows can have no gadgets at all (look at the Kitty demo -
299 it`s doesn`t even have a borders and yet has well-curved shape) or have
300 a different set of them. 
302 The window`s contents consists from some usual elements could be seen in
303 any GUI - buttons, lists, strings of text, any other kind of gadgets. If
304 application is intended to change any preferences of a system or an
305 application it`s usual shortly called *Pref* and has a set of buttons to
306 operate. Usually this buttons are: TEST (applies all the changes made by
307 Pref but doesn`t save and do not the changes but close the window), SAVE
308 (saves the changes and close the window), USE (applies the changes and
309 close the window, but do not saves them), CANCEL (discard all the
310 changes and close the window).
312 Also, from Amiga`s history the file placement unit is often called a
313 drawer instead of a folder/directory in other systems, but it`s meaning
314 remains the same. Translate it as a directory if you`re unsure.
316 There`s a special keys in AROS, just like on original Amiga, used to make
317 quick commands with it. Left and Right WinKey (on PC keyboard) replaces the 
318 original Amiga Keys and is used in different combinations to launch commands.
320 Another unknown name you can encounter in AROS is Zune. What`s that ?
321 Zune is GUI toolkit developed in replacement and best traditions of MUI
322 (Magic User Interface), widely used on Amiga`s. But is there an
323 application called Zune?  You can find Zune Pref and it allows you to
324 set settings for Zune-based applications altogether or in particular.
325 For example, to set Zune prefs for Wanderer you can select GUI prefs
326 from it`s menu, or to set Zune prefs for other apps you can use it as
327 the CLI command Zune <app filename>.
329 To be finished...
332 AROS CLI (Command Line Interface)
333 ---------------------------------
335 ToDO - CLI commands abstract and comparision ...
337 AROS has it`s CLI, the Command Line Interface, greatly expanding the 
338 capabilities of OS. Those who had used the AmigaOS can note that it looks
339 pretty close to the AmigaDOS. There`s some CLI basics described in 
340 `introduction </users/introduction>`__ to CLI commands. 
342 Currently you don`t need to type all the commands to the end - now there`s
343 a neat Tab completion similar to that on Linux consoles. This allows you 
344 also to append the filenames or choose them from the list.
346 To be finished...
348 AROS System programs
349 --------------------
351 We have mentioned the applications, it`s good to give a description of
352 their functions. So, there`s a groups of the AROS system applications
353 collected in the separate directories:
355     + C - the place for all the system commands used in CLI
356     + Classes - the place for datatypes, gadget`s images and Zune classes
357     + Devs - where the device-related files (drivers, keymaps) and 
358       datatypes are placed  
359     + Extras - where all the contributed programs reside
360     + Fonts - here you can find all of the system fonts. Any additional fonts 
361       must be appended (assigned) to this dir.
362     + Libs - where the system libraries are located.
363     + Locale - holds catalog files of various AROS apps translations
364     + Prefs - has a number of preferences-editing programs
365     + S - contains some system launch-time scripts
366     + System - the place for some system controls
367     + Tools -  the place for some commonly used system apps
368     + Utilities - the place for some not-so-commonly used but yet useful apps
370 Instead of applications, there`s more permanent running programs called
371 *tasks*. 
373 Another kind of AROS applications is the *Commodities*. This is applications 
374 which can help you make your system more comfortable. For example, AROS windows
375 doesn`t set to the top of others when you click on it, and you can find it 
376 uncommodable. You can use the AROS commodity ClickToFront to fix it. It can be 
377 found beneath other commodities in SYS:Tools/Commodities directory. When you 
378 double click on it, window will become to the top of others if double clicked.
379 Another example is Opaque commodity - it allows you to move windows with their
380 contents. There`s also an Exchange commodity which allows you to manipulate 
381 launched commodities and get information about them. Usually commodities do not 
382 open any windows.  
384 To operate with files of different types Amiga-like systems is using the 
385 *datatypes*. Datatype is the kind of system library allows the programs 
386 to read or/and write to such files without taking care of the implementing
387 such a format in that program.   
389 And if we dig a little deeper there`s some system terms that can be explained.
390 AROS uses *handlers* to communicate with the filesystems and *HIDD`s* to 
391 communicate with the hardware.
393 To be finished...
395 Customising the installed AROS
396 ==============================
398 Setting up the Locale
399 ---------------------
401 AROS is becoming a really international system this days, being
402 translated to many languages. Translating isn`t very difficult, and
403 number of the AROS translators is still increasing. If unicode support
404 will be implemented it can be translated in every language people use.
405 If you feel you can give AROS to your country, both OS and
406 documentation, do not hesitate to contact us and offer your help.
408 So about the language. First, depending on fonts used you must set fonts
409 by launching SYS:Prefs/Fonts and designating Fonts to different system
410 text: Icons (used for icons labels), Screen (used on common screen) and
411 System (used in CLI window). If your language uses different set than
412 ISO (for example, cyrillyc CP-1251) there`s *must* be the fonts in
413 correct codepage. Aros currently can use two kinds of fonts - the Amiga
414 bitmap fonts (which can be used directly) and TrueType (via FreeType 2
415 manager, which still has some issues with non-ISO codepages). Bitmap
416 fonts are in any particular codepage, and TTF can be unicode.
418 How can you change the AROS locale ? To do this you need to launch a
419 Locale pref in SYS:Prefs. You can see a list of supported locales there
420 and select your preferred ones. On the second page of this Pref you can
421 select the country used (it gives correct currency and date/time
422 format). And the last tab allows you to change timezone to that used in
423 your location.
425 After you`ve made changes to fonts reboot the system, and you must be
426 able to see all the translated content.
428 So now we can read, but can we write also in our language? To do this,
429 you must change the keyboard layout.
431 Keyboard and mouse settings are managed by the Input pref. You can change 
432 the layout and click *Use* but we can do even better. This tool
433 allows you also to save presets - just like any application it`s got a menu, 
434 allows you to save your preferences to the file with the given name and keep 
435 different settings of locales. We will use it later to switch our keyboard 
436 layouts. Choose your locale`s keyboard layout 
437 from the list and make a left click to open the context menu. Then enter 
438 the name of your preset to File string, say, *locale1* and click Ok to save it to 
439 SYS:Prefs/Presets directory. Now choose an American (PC) layout and repeat 
440 the saving presets, say, with name *english*. This presets can be used later
441 to switch the layouts. Click *Cancel* to exit.
443 There`s an FKey commodity which allows you to make actions assigned to
444 some combinations of keys. Now let`s launch it and assign the locale switching. 
445 After you double-click on FKey icon, launch the Exchange, choose the
446 FKey from list and click the *Show* button. This will invoke the FKey window.
447 You can see the ALT TAB in list assigned to window switching. Now enter the 
448 first key comination, say, *ALT Z* and go to the right panel. Choose *Launch the
449 program* from pulldown menu and enter SYS:Prefs/Input as an argument. Append the 
450 USE switch and *english* preset name to the string as shown::
452     SYS:Prefs/Input USE SYS:Prefs/Presets/english
454 Click on the *New* Button to add the another combination. Now set the combination
455 for your locale as shown above, replacing *english* name with your preset name.
456 Click *New* button again and then *Save Settings*. Now you can use defined 
457 combinations to switch the layouts.  
459 Installing the software
460 -----------------------    
462 Actually there`s no installer system in AROS. Installing an application
463 usually means you have to extract it to some directory on a harddrive or
464 ramdisk. Then some programs require you to make assignments which
465 is done in CLI with the Assign command and some start script additions. 
466 For example, Lunapaint needs the Lunapaint: to be assigned to the directory
467 it was extracted to to work properly. You can do this with the command 
469     Assign Lunapaint: Disk:Path/Lunapaint
471 But if you don`t want to type this command after reboot to launch it again, 
472 you must put it to S:User-Startup script. 
473 To do this, type this command in CLI prompt::
475     :> edit SYS:S/User-Startup
476     
477 Then insert the Lunapaint (or other program) assign at the end of file.
478 Save the changes and you`ll have that fixed.
479 Such a procedure can be used for any program that needs it.
481 Another way is using the ENVARC:SYS/Packages directory. All you need here
482 is create a text file with the name of your application and put
483 a path to application in that file. Then create a directory named S in the
484 program`s directory and put the package-startup file there. This way is more
485 safer, but can be not so Amiga-styled to you.
488 Setting up the Network
489 ----------------------
491 To communicate with other computers on network, AROS uses a TCP Stack, AROSTCP, 
492 which is a port of AmiTCP. This software is located in Sys:System/Network/AROSTCP
493 directory. Setting up is not easy but some kind of GUI tool is in development. 
494 Also please note that actually there`s a very little amount of networking
495 program on AROS yet (but some interesting tools is in development to be 
496 soon released).
498 First you need is to setup your machine side of network. This part can differ 
499 depending on your hardware. On a real machine you need to install the supported
500 network interface card (NIC) and plug the cable to it. On a virtual machine
501 you must set up it`s NIC implementation and check if it`s supported by AROS
502 (at least, QEMU and VMWare ones is supported). 
504 Net on QEMU/Linux
505 """""""""""""""""
507 Read tips for launching AROS on Linux QEMU above.
509 After this is enabled we can go to the next point.
511 Second part is setting AROSTCP in AROS to work. 
513 On linux system some steps needs to be done to make the network in VM working.
515 The tun (tunnel) module must be loaded::
517     #> modprobe tun
519 Then, the kernel must become a router::
521     #> echo 1 > /proc/sys/net/ipv4/ip_forward
523 Then, a rule must be added to the firewall::
525     #> iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE
527 Finally, still being root, start Qemu with::
529     #> qemu -cdrom aros.iso -m 48
531 The Linux tun module, by default, creates a gateway for the fake network at 
532 172.20.0.0/16 with a gateway at 172.20.0.1.
533 Say our Qemu hosted machine is at 172.20.0.10.
534 Say your usual LAN is 192.168.0.0/24 with a DNS at 192.168.0.1 
535 (or anywhere on the Internet, for that matter).
537 *For QEMU on Windows in user mode networking you must replace it with 10.0.2.16 
538 for host and 10.0.2.2 for gateway, or use TAP adapter, which is better.
539 Remember to set up your firewall in way it can pass the QEMU packets.*
541 You have to edit 3 files in the AROSTCP/db: hosts, interfaces, netdb-myhost
542 In hosts remove any entries. Hosts will be in netdb-myhost for now.
543 In interfaces Uncomment the prm-rtl8129.device line, because Qemu is emulating 
544 this NIC, edit it::
546     eth0 DEV=DEVS:networks/prm-rtl8029.device UNIT=0 NOTRACKING IP=172.20.0.10 UP
548 In netdb-myhost, add the various local known hosts, 
549 your local domain name, the gateway::
551     HOST 172.20.0.10 arosbox.lan arosbox
552     HOST 172.20.0.1 gateway
553     DOMAIN lan
554     NAMESERVER 192.168.0.1
556 The db directory can itself reside anywhere, you set its path in the 
557 ENVARC:AROSTCP/Config file, I advice you to copy the db files in the (created) 
558 ENVARC:AROSTCP/db directory, that way the Config file could be::
560     ENV:AROSTCP/db
562 Now make AROSTCP start at boot with the word "True" in ENVARC:AROSTCP/Autorun
563 Edit the Sys:System/Network/AROSTCP/S/Package-Startup::
565     ; $VER: AROSTCP-PackageStartup 1.0 (01/08/06)
566     ; AROSTCP-PackageStartup (c) The AROS Dev Team.
567     ;
568     Path "C" "S" ADD QUIET
570     If not exists T:Syslog
571         makedir T:Syslog
572     Endif
574     If not exists EMU:
575         if $AROSTCP/AutoRun eq "True"
576         C:execute S/startnet
577         EndIf
578     EndIf
580 The Sys:System/Network/AROSTCP/S/Startnet file should be
581 something like::
583     ; $VER: AROSTCP-startnet 1.0 (01/08/06)
584     ; AROSTCP-startnet (c) The AROS Dev Team.
585     ;
586     Run <NIL: >NIL: AROSTCP
587     WaitForPort AROSTCP
588     If NOT Warn
589         run >NIL: route add default gateway
590     Else
591     ; echo "Wait for Stack Failed"
592     EndIf
594 Next boot, test it with::
596     ifconfig -a
598 You must see the output something like this::
599     
600     lo0: flags=8<LOOPBACK> mtu 1536
601             inet 0.0.0.0 netmask 0x0
602     eth0: flags=863<UP,BROADCAST,NOTRAILERS,RUNNING,SIMPLEX> mtu 1500
603             address: 52:54:00:12:34:56
604             inet 172.20.0.10 netmask 0xff000000 broadcast 172.255.255.255
606 If you can see that eth0 string then your interface is up. You can test it by 
607 launching those commands::
609     AROS:>ping 172.20.0.1
610     PING 172.20.0.1 (172.20.0.1): 56 data bytes
611     64 bytes from 172.20.0.1: icmp_seq=0 ttl=255 time=xx ms
612     64 bytes from 172.20.0.1: icmp_seq=1 ttl=255 time=xx ms
613     64 bytes from 172.20.0.1: icmp_seq=2 ttl=255 time=xx ms
614     
615     --- 172.20.0.1 ping statistics ---
616     3 packets transmitted, 3 packets received, 0% packets loss
617     round trip min/avg/max = x/xx/xx ms
619 Output like this means that our interface packet`s reached the gateway with
620 172.20.0.1 address. If you got Host unreachable earrors check your AROSTcp
621 settings and VM options.
623 You can test it even further by pinging other hosts and try using some 
624 networking applications which you can find on Archives.aros-exec.org, like
625 ftp and AIRCos. If you use an FTP program with your FTP server, remember 
626 it can work only with passive ftp servers, and set up your server to this mode.
629 Net on QEMU/Windows
630 """""""""""""""""""
632 Setting QEMU to run on Windows is relatively harder to that of Linux. First,
633 make sure you have turn your Firewall to learning mode (or prepare it to
634 receive new rules) or completely disable it. Firewall can block transfers to VM.
636 There`s two ways to use network with QEMU on Windows. First is to use
637 a user-mode networking stack which is launched by default (or using the 
638 "-net nic -net user" switches, which is default now). Options given is
639 for 0.8 or newer QEMU version. Setting the AROS side is similar to that
640 of Linux use, but you will need to use
641 the following IP addresses to setup and test: 10.0.2.16 for AROS machine IP 
642 (instead of 172.20.0.10), 10.0.2.2 for gateway (instead of 172.20.0.1). 
643 This mode can work even without administrating privileges given to user, but
644 can *make some applications on AROS refuse to work properly (such as FTP-client)*.
646 The second option is to use the tap interface. To use it you must download
647 the `OpenVPN <http://openvpn.net>`__ 2.0 package for Windows (Windows 2k/XP only). 
648 After you install it, you will get an extra network connection in disconnected
649 state. Rename it to, say, eth0. Then go to the eth0 connection properties and 
650 set an IP address in the properties of TCP-IP protocol. You must set:
651 IP address *in other* subnet than your base IP (If you have 192.168.0.x one,
652 then set, say, the same 10.0.2.2) and 255.255.255.0 netmask. *Reboot*. Then replace 
653 starting line options in QEMU (or add if there`s were not) -net nic -net tap,ifname=eth0.
654 Then set an AROS side as it was described above for user mode networking.
655 Note that you will need the administrator privileges to install OpenVPN TAP adaptor.
657 There`s some guides available on how to setup the QEMU networking in Windows:
659     + For `VLan <http://www.h7.dion.ne.jp/~qemu-win/HowToNetwork-en.html>`__
660     + For `Tap <http://www.h7.dion.ne.jp/~qemu-win/TapWin32-en.html>`__
662 Net on VMWare
663 """"""""""""" 
665 VMWare`s side network is relatively easy to set up. All you need is to add
666 the NIC to configuration of your VM and assign the IP to new network connection,
667 associated with that card. Other using notes is the same as with QEMU above, 
668 except for the adapter type in Sys:System/Network/AROSTCP/db/interfaces 
669 file ::
671     eth0 DEV=DEVS:networks/pcnet.device UNIT=0 IP=10.0.2.2 UP
673 Net on the real PC
674 """"""""""""""""""
676 On a real PC you will need to do all you can do for any OS - prepare the
677 hardware to connect to AROS box - cables, hub and other. Then you must setup the 
678 AROS side similar to shown above, replacing the IP addresses to those
679 acceptable in your LAN for AROS-box IP, gateway and DNS.
681 To be finished...  
683 Setting Up The Sound
684 --------------------
686 Currently there`s not much to sound in AROS. First, at the moment there`s no 
687 working drivers for virtual machine`s implemented sound cards (usually sb16/es)
688 so the only way to try to get sound is use AROS-native on pc with a real 
689 SB Live/Audigy card. Also the AC97-compliant codecs are supported. 
691 AHI sound in AROS supports also no sound (VOID) and disk writing options.
693 To be written by someone...
695 Is that all the User's Information in this guide?
696 =================================================
698 This chapter should have told you how to get, install and use AROS.
699 After having tried running every program in the directories C, Demos,
700 Utilities, Tools, Games, etc., you might wonder if that is all. Yes,
701 currently that is all a "User" can do with AROS! But when any new
702 important user code will be ready, it will be added to this guide, of
703 course.
705 If you think that I have not provided enough information here about
706 compiling, installing, Subversion, the shell, etc., it might be good to
707 know that I have reasons for it. First, there is already much
708 information available, and it would be unnecessary as well as unfair
709 just to copy that information in this document.  Second, we are talking
710 about very particular information. Some of the readers might be
711 interested in compiling the source code, others might want to know all
712 about the Amiga shell. So to keep this guide readable, I only point to
713 places where you can find such information, instead of providing it
714 here. You, the reader, can then decide if this is of interest to you.
717 .. _Linux: http://www.linux.org/
718 .. _UAE:   http://www.freiburg.linux.de/~uae/
719 .. _install: installation