release/picobsd/README.luigi

   1 In this file i try to document the overall architecture of PicoBSD
   2 source tree.
   3
   4     build/
   5         directory containing main build scripts and makefiles.
   6         build:  main build script
   7         stage1: invoked by build
   8         clean:  to clean up previous compilations
   9         Makefile.conf
  10                 makefile to edit config file and build kernel
  11
  12     floppy.tree/
  13         default files to fill the floppy and mfs trees.
  14         Can be overridden by listing files to be removed in
  15         ${TYPE}/floppy.tree.exclude, and putting files to be replaced
  16         in ${TYPE}/floppy.tree/
  17
  18     doc/
  19         documentation (unchanged from original)
  20
  21     forth/
  22         load files for the boot loader (unchanged from original)
  23
  24     help/
  25         help files in various languages. The suffix is the two letter
  26         country code for the language. Currently only .en and .pl
  27         used.
  28
  29     tinyware/
  30         various small programs used instead of the corresponding
  31         full-blown utilities.
  32
  33     tools/
  34         couple of tools used during the build process.
  35
  36     dial, isp, net, router, custom ...
  37         directories containing the source and config files for the
  38         various image types.
  39
  40
  41 Structure of each image type is as follows:
  42
  43     Makefile.mfs
  44         makefile used to build/populate the MFS
  45
  46     PICOBSD
  47         kernel config file
  48
  49     crunch1/
  50         directory with crunched config etc (unchanged from original)
  51
  52     floppy.tree/
  53         local files to be put into the floppy/mfs trees.
  54
  55     floppy.tree.exclude
  56         list of files in the default floppy.tree/ not to be copied
  57         for this configuration (used by tar --exclude-from
  58         floppy.tree.exclude)
  59
  60     lang/
  61         language-dependant files (trimmed from the original one)
  62
  63     mfs.mtree
  64         mtree structure used to populate the mfs image
  65         MFS image, or on the floppy image in various phases.1G
  66
  67 ----
  68
  69 Below a partly incomplete list of files used by the various
  70 picobsd types.
  71
  72 Files for various systems
  73
  74 =  base file
  75 x  missing
  76 X  missing, not needed with oinit
  77 D  different
  78 d  minor difference, merge candidate
  79 L  copied from LANG directory
  80 G  generated in stage3
  81
  82 DIAL ISP  NET  ROUT  MY1  MY2   File in floppy.tree
  83 ------------------------------------------------------
  84  =    =    =    =               boot.config
  85  x    =    =    =               disktab
  86  x    =    x    x               etc/firewall
  87  =    =    =    =               etc/fstab
  88  =    =    =    =               etc/gettytab
  89  =    =    =    =               etc/group
  90  =    =    =    =               etc/host.conf
  91  L    L    L    L             L etc/hosts
  92  x    =    =    x               etc/inetd.conf
  93  =    =    =    =               etc/login.conf
  94  d    =    =    x               etc/master.passwd
  95  d    =    =    D               etc/mfs.rc
  96  L    L    L    L             L etc/motd
  97  D    =    =    =               etc/ppp/ppp.conf
  98  =    x    x    x               etc/ppp/ppp.conf.template
  99  =    =    =    =               etc/ppp/ppp.deny
 100  d    =    =    =               etc/ppp/ppp.linkup
 101  =    =    =    =               etc/ppp/ppp.secret.sample
 102  =    =    =    =               etc/profile
 103  =    =    =    =               etc/protocols
 104  D    =    d    D               etc/rc
 105  D    =    =    X               etc/rc.conf
 106  x    =    =    D               etc/rc.firewall
 107  =    =    =    D               etc/rc.network
 108  x    =    =    D               etc/rc.serial
 109  x    =    =    =               etc/remote
 110  L    =    =    X             L etc/resolv.conf
 111  =    =    =    =               etc/services
 112  x    =    =    =               etc/shells
 113  x    =    =    x               etc/snmpd.conf
 114  =    x    x    x             G etc/spwd.db
 115  =    x    x    x               etc/ssh_config
 116  =    =    =    =               etc/termcap
 117  D    =    =    =               etc/ttys
 118  =    =    =    =               kernel.config
 119  =    =    =    =             G kernel.gz
 120
 121 DIAL ISP  NET  ROUT  MY1  MY2   File in lang
 122                                 README.en
 123                                 README.pl
 124                                 boot.help.en
 125                                 boot.help.pl
 126                                 hosts.en
 127                                 hosts.pl
 128                                 mfs.rc.en       to floppy.tree
 129                                 mfs.rc.pl
 130                                 motd.en
 131                                 motd.pl
 132                                 rc.conf.en      to floppy.tree
 133                                 rc.conf.pl      via
 134                                 rc.en           to floppy.tree
 135                                 rc.network.en   to floppy.tree
 136                                 rc.network.pl   via
 137                                 rc.pl           via
 138                                 reboot.en
 139                                 reboot.pl
 140                                 resolv.conf.en  to floppy.tree
 141                                 resolv.conf.pl  via
 142                                 update.en
 143                                 update.pl
 144
 145
 146 DIAL ISP  NET  ROUT  MY1  MY2   File in mfs.tree
 147
 148  D    =    d    d               Makefile
 149  =    x    x    x               login.conf
 150  D    =    D    D               mfs.tree
 151