AROS
The Amiga Replacement OS
(C) 1996 AROS - The Amiga Replacement OS
Table of Contents
There are a couple of files and directories below AROS and here is a short overview of what they are and what you can do with them.
AROS - The Amiga Replacement OS -
AROS
The Amiga Replacement OS
(C) 1996 AROS - The Amiga Replacement OS
The root directory of AROS contains this:
- AFD-COPYRIGHT
- AROS' copyright message
- BUGS
- Known bugs of AROS
- README
- A readme with a short introduction about AROS
- amiga/
- This is the directory where you can (and should) put things which are copyrighted by someone and thus now part of the archive; right now this means only the amiga header files which you get along with your C-Compiler (eg. DICE, SAS/C, StormC++, Maxon C++) or from the Amiga Developer CD 1.1 (recommended since it's the most simple and inexpensive way to get them). The CD is available at your local dealer or by mail order. Just put the includes into a subdir include/ below this directory and AROS will find them there.
- apps/
- This directory contains the source for applications for AROS. Applications are programs and packages which are not in the basic installation which is in workbench/.
- compiler/
- The C compiler for AROS. It contains include files, the source for amiga.lib and c.lib and the source for the compiler and all compiler specific utilities.
- arosshell.c
- The main code for the shell which allows you to execute AROS commands as you are used to it on your beloved Amiga. Also a very small demo of how it works and also probably the smallest demo that does something useful.
- bin/
- This directory contains all generated files under the name of your OS (eg. AROS/bin/linux/). This directory is called $(ARCHDIR). Below this are two more directories: $(BINDIR) where the files should be put which the end user should see and $(GENDIR) where you can create a directory to put all files one part of AROS needs (eg. libs/ or os/). The directory $(OSGENDIR) is below $(GENDIR) and all *.o files in this directory are collected to the AmigaOS.lib.
- compiler/
- The C compiler for AROS. It contains include files, the source for amiga.lib and c.lib and the source for the compiler and all compiler specific utilities.
- alib/
- The source for the amiga.lib. This link library contains small utility functions which didn't made it into a shared library.
- aros/
- The source for aros.lib. This link library contains special functions which allow to write portable code.
- clib/
- The source for AROS' c.lib. This link library contains the standard ANSI C (and some more) library functions like printf(), strcpy(), etc. The directory also contains the includes for ANSI C.
- include/
- This directory contains all AROS specific includes as well as all Amiga includes which have been modified for AROS. Note that these files are searched *before* the files in amiga/include/. Most people will notice this when they compile some program which uses a function which has not yet been implemented in AROS. The compiler will complain about a function without a prototype despite the fact that it is in amiga/include/clib/*_protos.h. That's because it doesn't look there and if you ever get an error like this, have a look into include first.
- vbcc/
- The source for AROS' own C compiler (not that we own it, but this compiler is used inside the AROS shell to compile programs).
- vcpp/
- The source for the C preprocessor for AROS' C compiler.
- config/
- This directory contains the dirty stuff. Code which makes AROS live (mostly hacked up assembler code which you don't want to see). Anything is allowed inside this directory in order to make AROS work on as many hardwares as possible.
- amiga/
- Code to make AROS work on the Amiga itself. Currently the emulation is nonexistent, but we work on boot code (found in boot/).
- config.h
- This is a generated include file. It's generated by AROS/configure and will appear in the include tree as aros/config.h. The following information can be found in this file:
- AROS_FLAVOUR
- What version of AROS should be generated ? A native (binary compatible) one (AROS_FLAVOUR_NATIVE) ? A standalone OS (AROS_FLAVOUR_STANDALONE) ? An emulation which runs under another OS (AROS_FLAVOUR_EMULATION) ? A link library which allows to link native applications (ie. ones which behave like any other app on another OS) (AROS_FLAVOUR_LINKLIB) ? Note that not all flavours are available on all hardwares/OS combinations. To use this #define, write something like #if AROS_FLAVOUR==AROS_FLAVOUR_NATIVE.
- dummy/
- C source for kernel functions. These will not produce correct code to compile the kernel but when you compile and disassemble these, you will have a good starting point to write the assembler functions for the kernel.
- freebsd/
- Code to make AROS work as an emulation under FreeBSD.
- host.cfg
- This file is included by all makefiles and generated by AROS/configure. It defines the following Make variables:
- $(APP_CFLAGS)
- Flags which replace $(COMMON_CFLAGS) when code for inside the AROS shell is to be compiled (not linked).
- $(ARCH)
- What kind of OS is this ? Values are for example linux, freebsd, hpux, netbsd, amiga, etc.
- $(COMMON_AFLAGS)
- Flags which must always be passed to $(AS).
- $(COMMON_CFLAGS)
- Flags, which must always appear in $(CFLAGS) for $(CC).
- $(FLAVOUR)
- What flavour of AROS should be generated ? The possible values are native, standalone, emulation or linklib.
- $(GUI_CCFLAGS)
- Flags, which must be passed to $(CC) when code is to be compiled which uses the native GUI (eg. -I/usr/X11R6/include).
- $(GUI_INCDIR)
- Directory where the include files for the native GUI can be found.
- $(GUI_LIBDIR)
- Directory where link libraries for the GUI of the native OS can be found (eg. /usr/X11R6/lib).
- $(GUI_LIBFLAGS)
- Libraries against which to link if you need the native GUI (eg. -lX11).
- $(GUI_LDFLAGS)
- Flags, which must be passed to the linker when linking code which requires the native GUI (eg. the kernel or applications for flavour linklib).
- $(ILDFLAGS)
- Flags which must be passed to $(CC) when code is to be linked for use in the AROS shell.
- $(KERNEL)
- What kind of CPU is this ? Possible values are for example m68k-native, m68k-emul, i386, hppa9, etc.
- $(MKDEPEND)
- Program to be called when Make wants to find out which include files should be taken into account when it's time to decide if a file must be updated or not (eg. makedepend).
- $(RANLIB)
- Program to run on link libraries created with $(AR). Most of the time this will either be ranlib or true.
- $(SYS_AS)
- The name of the systems' assembler. You should not use this value but the context sensitive $(AS) which contains the assembler to use in the current context.
- $(SYS_CC)
- The name of the systems' C compiler. This may be different from $(CC), because $(CC) is context dependent (eg. if you compile code in the AROS shell, it's value is different from when you compile AROS kernel code).
- i386/
- Version of the kernel for i386 CPUs. It consists mainly of a bunch of assembler files which implement functions that can't be done in C (eg. semaphores, stack handling or task switching). Note that this is the only directory which may contain assembler files and which is different for every architecture. If you begin your work on some new architecture, make such a directory for your hardware and put all hardware dependent files in there. It is a rule that you can do anything inside this directory as long as it has no influence on the other files and directories. The directory must support the standard rules all and clean and read AROS/config/make.cfg. All files generated by the makefile should go into $(OSGENDIR).
- init.c
- This file contains the real main() and sets up all libraries, devices and all other stuff which must be known before the first user process can begin to work.
- machine.h
- Constants which allow Exec to adjust to the local hardware.
- makefile
- This is a good example of how sub-makefiles for AROS should look like.
- linux/
-
- m68k-emul/
- Untested assembler code for machines which have an 680x0 CPU but which are not Amigas (Mac, for example).
- m68k-native/
- Assembler code for Amiga hardware.
- initcore.c
- Non-functional initialisation of exec signal handling core This will be replaced with true trap and interrupt handlers.
- machine.h
- Constants which allow Exec to adjust to the local hardware.
- machine.c
-
- make.cfg
- Global settings for the Makefiles. Each makefile reads this file before it does anything else (well, almost... most makefiles set a path to this file first :-) ) It sets up some interesting paths:
- $(OSGENDIR)
- Use this path for all files which should go into the OS itself.
- configure
- This is a small script which examines your system and creates a file named AROS/config/host.cfg which is used by the makefiles.
- crypt.c
- This is a small program which allows you to create a password if you want to use the CVS server (prefered). See the section about CVS for how it works.
- dist/
- make dist will put an archive with all files for developers and users in this directory. Make sure the version in make.cfg is set to the correct value because it will be used to determine the name of the archive.
- docs/
- The source and the formatted docs (currently only in HTML format).
- makefile
- This is the magic file which holds the whole thing together. It has the following rules:
AROS - The Amiga Replacement OS -
AROS
The Amiga Replacement OS
(C) 1996 AROS - The Amiga Replacement OS
This is the toplevel makefile. Use it if you want to compile the whole distribution.
This makefile defines the following targets:
- all
- Compile the whole project (except the documentation).
- crypt
- Create the file crypt to create a password for CVS access
- dist
- Create the distribution archives
- check
- Run tests to check if AROS runs ok on your system.
- clean
- Remove all generated files
- cleandep
- Remove all generated dependency files.
- docs
- Compile the documentation for AROS.
up
If you have comments or suggestions, email me at
digulla@aros.fh-konstanz.de
. 03 Feb 1997
- rom/
- Things which are internal parts of the OS.
- devs/
- ROM devices, ie. devices which are not loaded from disk during runtime (eg. console.device).
- filesys/
- A starting filesystem which uses the Linux filesystem to emulate a SYS:.
- dos/
- The first library which is added to the OS by standard operations. Use this one as a starting point if you want to develop own libraries. Below is a list of interesting files. All other files are functions of the library with one function per file. Each file contains an AutoDoc-like header and some extra infos which are needed by the scripts. If possible each file should also contain a test which can be enabled with -DTEST. See AROS/dos/filepart.c for a good example.
- dos_functable.c
- An array with all functions of the library. It is generated by a script from the headers of all *.c-files in this directory.
- dos_init.c
- The init-code (lib_init(), lib_open(), lib_close(), lib_expunge()).
- dos_intern.h
- A common include-file for all *.c-files in this directory. It must not contain anything which is necessary outside this directory.
- dos_debug.h
- Enable and disable debugging for a function of the library.
- makefile
- This is a good example of how a makefile for a library, which is linked into the system, should look like
- exec/
- The source for the exec.library. This is no good starting point for own libraries since Exec is not initialized like other libraries and so some things are handled differently here. Exec relies on some files which are in $(KERNEL)/.
- graphics/
- Sourcecode for the graphics.library. See !!!! Unknown label dos !!!! for more information.
- intuition/
- Sourcecode for the intuition.library. See !!!! Unknown label dos !!!! for more information.
- utility/
- Sourcecode for the utility.library. See !!!! Unknown label dos !!!! for more information.
- scripts/
- Scripts which are used to generate code.
- purify
- A small script which can be put in front of the C compiler like this:
purify cc ...
It will modify some options to purify the code.
- test/
- Testcode, which is more complex.
- tpl.c
- Template file for AROS system library functions. Each function gets it's own file.
- workbench/
- The disk-based part of AROS.
- c/
- This directory contains a couple of applications for AROS and some demos.
- demos/
- Some demos for AROS (former tests).
- devs/
- Disk-based devices, eg. RAM: and NIL:.
- libs/
- Disk-based shared libraries.
- s/
- This directory contains the Startup-Sequence.
up
If you have comments or suggestions, email me at
digulla@aros.fh-konstanz.de
. 03 Feb 1997
previous up next
If you have comments or suggestions, email me at
digulla@aros.fh-konstanz.de
. 03 Feb 1997