| 0 | 0 |
Funicular
|
| 1 | 1 |
=========
|
| 2 | 2 |
|
| 3 | |
**Funicular** is a system to semi-automate the creation of development
|
| 4 | |
environments on eclectic architectures. It is currently vapourware.
|
|
3 |
**Funicular** is a system that semi-automates the creation of development
|
|
4 |
environments on eclectic architectures. It is currently a work in progress.
|
| 5 | 5 |
|
| 6 | |
Here, "eclectic architectures" is not terribly-well defined, but it includes
|
|
6 |
"Semi-automate" means it automates what it can, and provides repeatable
|
|
7 |
instructions for you to follow for what it can't.
|
|
8 |
|
|
9 |
"Eclectic architectures" is not terribly-well defined, but it includes
|
| 7 | 10 |
retrocomputing and esoteric architectures. Basically, if you've got an
|
| 8 | |
emulator for it, you might be able to build and run a system for it, using
|
| 9 | |
Funicular.
|
|
11 |
emulator for it and install and support images for it, you might be able
|
|
12 |
to install and outfit and and run a system for it, using Funicular.
|
| 10 | 13 |
|
| 11 | 14 |
It's kind of like a Vagrant for the lunatic fringe, eh?
|
| 12 | 15 |
|
| 13 | |
Each funicular is defined by a `Funicularfile`. This file is written in
|
| 14 | |
the configuration subset of Lua, and gives the configuration for the funicular;
|
| 15 | |
it looks something like
|
|
16 |
It currently supports:
|
| 16 | 17 |
|
| 17 | |
return {
|
| 18 | |
platform = NetBSD_6,
|
| 19 | |
system_image = 'wd0.img',
|
| 20 | |
setup_image = 'setup-netbsd.iso',
|
| 21 | |
}
|
|
18 |
* NetBSD under QEMU
|
|
19 |
* FreeDOS under QEMU (to a certain degree)
|
| 22 | 20 |
|
| 23 | |
A funicular is generally based around a particular Platform
|
| 24 | |
(Amiga[DOS]-Gondola, NetBSD-Gondola, FreeDOS-Gondola).
|
|
21 |
We hope that it will soon support:
|
| 25 | 22 |
|
| 26 | |
The Platform defines a default Architecture, which in turn defines a
|
| 27 | |
default Emulator.
|
|
23 |
* AmigaDOS under E-UAE
|
| 28 | 24 |
|
| 29 | |
In truth, Architectures are many-to-many with Platforms, which are
|
| 30 | |
many-to-many with Emulators — so there are lots of possibilities, and the
|
| 31 | |
Architecture may vary (NetBSD on i386 vs mips or whatnot) and the
|
| 32 | |
emulator may vary (UAE or E-UAE, QEMU or Bochs, etc.)
|
|
25 |
And one day:
|
| 33 | 26 |
|
| 34 | |
Images
|
| 35 | |
------
|
|
27 |
* Commodore 64 KERNAL under VICE
|
|
28 |
* VIC-20 KERNAL under VICE
|
|
29 |
* AppleDOS under an Apple 2 emulator
|
| 36 | 30 |
|
| 37 | |
Image {
|
| 38 | |
filename: string
|
| 39 | |
type: disk-image | cdrom-image | host-file-mapped
|
| 40 | |
}
|
|
31 |
It is hoped that Funicular will eventually replace the discrete, ad-hoc
|
|
32 |
projects [NetBSD-Gondola](https://github.com/catseye/NetBSD-Gondola),
|
|
33 |
[FreeDOS-Gondola](https://github.com/catseye/FreeDOS-Gondola), and
|
|
34 |
[Amiga-Gondola](https://github.com/catseye/Amiga-Gondola).
|
| 41 | 35 |
|
| 42 | |
An Image has one of three distinct roles:
|
|
36 |
Concepts
|
|
37 |
--------
|
| 43 | 38 |
|
| 44 | |
* `system_image`: contains one operating system; boots into that operating
|
|
39 |
### Funiculars, Platforms, Architectures, Emulators ###
|
|
40 |
|
|
41 |
Each funicular is defined by a `Funicularfile` in a particular directory
|
|
42 |
dedicated to that funicular (in analogy with `Makefile`, `Vagrantfile`, etc.)
|
|
43 |
|
|
44 |
A funicular is generally based around a particular Platform. The Platform
|
|
45 |
defines a default Architecture, which in turn defines a default Emulator.
|
|
46 |
|
|
47 |
In truth, it is more complicated than that. Architectures have a many-to-many
|
|
48 |
relationship with Platforms, which themselves have a many-to-many relationship
|
|
49 |
with Emulators.
|
|
50 |
|
|
51 |
For example, the NetBSD Platform could be on i386 or MIPS Architecture, and the
|
|
52 |
QEMU emulator can emulate both i386 and SPARC, while the i386 architecture can
|
|
53 |
be emulated by both QEMU and Bochs.
|
|
54 |
|
|
55 |
So, there are lots of possibilities. But, we can stick to certain "defaults"
|
|
56 |
for now; not only because they are "opinionated" (I'd rather use QEMU than
|
|
57 |
Bochs) but also because it makes it a lot simpler. Hopefully we'll come up
|
|
58 |
with a sane way to customize all the relationships at some point.
|
|
59 |
|
|
60 |
### Images ###
|
|
61 |
|
|
62 |
An Image has one of several roles:
|
|
63 |
|
|
64 |
* **System Image**: contains one operating system; boots into that operating
|
| 45 | 65 |
system, if applicable; persistent and mutable; often contains utilities;
|
| 46 | 66 |
also generally contains a work area for installing and building STUFF
|
| 47 | |
* `install_image`: CDROM (or other readonly) image which installs the operating
|
|
67 |
|
|
68 |
* **Support Image**: like a system image, but read-only, but required for
|
|
69 |
the Platform or Architecture to operate. Often in the form of ROM images.
|
|
70 |
May or may not be supplied with an Emulator, depending on licensing
|
|
71 |
requirements.
|
|
72 |
|
|
73 |
* **Install Image**: CDROM (or other readonly) image which installs the operating
|
| 48 | 74 |
system to the system-image; generally not needed after that point
|
| 49 | |
* `setup_image`: CDROM (or other readonly) image which contains STUFF
|
|
75 |
|
|
76 |
* **Setup Image**: CDROM (or other readonly) image which contains STUFF
|
| 50 | 77 |
to install and build in the work area; ephemeral (recreated by funicular
|
| 51 | |
as needed from toolshelf sources)
|
|
78 |
as needed from acquired sources)
|
| 52 | 79 |
|
| 53 | |
There is a fourth role; from a system-image, a funicular may be able to
|
| 54 | |
create a
|
| 55 | |
|
| 56 | |
* `work_image`: contains a skeletal operating system and a subset of the
|
|
80 |
* **Distribution Image**: contains a skeletal operating system and a subset of the
|
| 57 | 81 |
STUFF so built. intended to be used as a "distributed product" —
|
| 58 | 82 |
for other (web) emulators, bootable USB sticks, or whatnot
|
|
83 |
|
|
84 |
Usage
|
|
85 |
-----
|
|
86 |
|
|
87 |
To bring up a funicular, you generally follow these steps:
|
|
88 |
|
|
89 |
* Acquire an install image for the Platform (e.g. a NetBSD install ISO.)
|
|
90 |
* Acquire an appropriate Emulator (e.g. `toolshelf dock @@qemu`.)
|
|
91 |
* Run `funicular init 4000` to create a 4G (or whatever) system image.
|
|
92 |
* Run `funicular install` to install the platform onto the system image.
|
|
93 |
* Run `funicular setup` to fetch various pieces of software and install
|
|
94 |
them too on the system image.
|
|
95 |
* Run `funicular start` to use your funicular for whatever you want.
|