System Configuration

+ +

First Time Running Configuration

+ The very first time the system is run, there are some important things to do.
+ Most important of all is changing the root password and adding users.
+ If you do not change your root password immediately, your system is vulnerable to hacks.
+ If you do not add users, then your users will not be able to use your system unless they run as the root user.
+ WARNING: Running as the root user is dangerous, do so at your own lethal risk.
+
+ Changing the root user password is simple:
+   - Login to your root user (by default this is turtle).
+   - In a command-line prompt (or a terminal), run the command passwd.
+     - NOTE: the command passwd must not contain the "or", passwd is exactly as the command should be spelled.
+   - Follow the instructions and your done.
+

+ +

Setting Up Usernames and Passwords

+ To add a user to the system, use the command line program called adduser, which requires root user access.
+ NOTE: In previous versions the gadduser program was supplied as a graphical user interface to adding users, but this has been removed for the time being. +

+ To add a user, open up a terminal and switch to root access.
+ Simply specify the username followed by the permissions group they should belong to.
+ There are 3 major permissions groups: admin, power, and desktop.
+ The admin user has the most priviledges on the system and can gain root access, there is little this user cannot do.
+ The power user is a slightly weakened version of admin and the power user cannot gain root access.
+ The desktop user has the standard permissions needed for standard desktop usage and has no heightened priviledges beyond that.
+

+ After you begin the add user process you will be prompted for a password.
+ Following this, if everything went well the user will have been added to the system.
+ If you ever need to remove a user, the deluser program can be used and functions in an almost identical fassion.
+
+ + NOTE: By default the deluser program will remove all files own by the deleted user, to prevent this from happing use the unsetup script called none.
+ For example, normally to delete the user BOB the command would be 'deluser BOB'.
+ To delete BOB without removing BOB's files, the command would be: 'deluser BOB none'.
+ +

+ +

Setting Up the Network

+ Configuration Path: /etc/network/
+
+ The Files: +

default-blacklist
default-firewall
default-device
example-device
example-device-firewall
example-device-wpa
example-wireless
example-bridge
hostname
hosts
proc_settings
resolution
protocols
services
gre0, tunl0

+
+

File 1, default-blacklist:
+ This is a list of all ip-addresses that the firewall deny access to this machine.
+ A single white space (space, tab, or new line) is all that is needed to setup the addresses.
+ A default whitelist can be created and used as well.
+
+
File 2, default-firewall:
+ Defines all of the firewall rules.
+ The firewall syntax is broken up into terms: direction, device, action, rule, ip_list.
+ All of the terms reflect iptables syntax.
+ Terms must all be lowercase.
+ When one of the terms direction, device, and action are set, their data is applied to all rules below that line until another term of the same type is set.
+ What this means is that if a direction of "input" is specified, every rule (or ip_list) following that direction command will apply the direction of "input" until the next direction command is specified.
+ This file is broken up into two different sections: first and last.
+ For each ethernet device on the system there may exist a single firewall rule for that device, such as: net0123456789ab-firewall.
+ The firewall wall rules are applied in this order: default-firewall's section called first, then all ethernet device firewall sections called main, and finally default-firewall's section called last
+
+ Terminology breakdown:
+
+ direction: +
- Valid directions are: input, output, forward, postrouting, prerouting
- Direction specifies the direction in which the connection is coming from
- The direction stays in effect until another direction is specified
+
+ device: +
- Valid devices are: all, this, and the name of any device
- all is generally used within the default-firewall and applies to all network devices on the system
- this can only be used in a device-specific firewall file and refers to the name of the device that the specified file belongs to (for the file net0123456789ab-firewall, 'this' would refer to the device called net0123456789ab)
- instead of 'all' or 'this', one can explicitly use the name of a device
- The device stays in effect until another device is specified
+
+ action: +
- Valid actions are: append, insert, and policy
- Action specifies how a particular rule gets added to the firewall, see the iptables documentation on the details.
- The action stays in effect until another action is specified
+
+ rule: +
- Rules are the raw iptable commands, minus the direction, device, and action
- The rule is applied immediately and does not carry over to any line beyond its own.
+
+ ip_list: +
- IP Lists are the rules applied to multiple ip addresses
- The ip_list is applied immediately and does not carry over to any line beyond its own.
+
+ Example comparison between raw iptables command and the default-firewall syntax:
+ Raw Iptables Syntax:
+ + /sbin/iptables -A INPUT -i eth0 -p tcp --dport 47288 -j ACCEPT + /sbin/iptables -A INPUT -i eth0 -p udp --sport 47288:47544 -j ACCEPT + /sbin/iptables -A INPUT -i eth0 -p udp --dport 47288:47544 -j ACCEPT + /sbin/iptables -A OUTPUT -o eth0 -p udp --sport 123 --dport 123 -j ACCEPT +
+ default-firewall Syntax:
+ + direction input + device eth0 + action append + + rule -p tcp --dport 47288 -j ACCEPT + rule -p udp --sport 47288:47544 -j ACCEPT + rule -p udp --dport 47288:47544 -j ACCEPT + + direction output + rule -p udp --sport 123 --dport 123 -j ACCEPT + +
+
File 3, default-device:
+ This supplies some default options for all devices.
+ The term 'default' can be used to specify whether or not to attempt to obtain a dynamic address (DHCP) on all standard network devices if settings file for that device does not exist.
+ The terms 'search', 'nameserver_1', 'nameserver_2', and 'nameserver_3' are used to enforce a search domain or nameserver.
+ The enforced search domain and nameservers will override any device specific search domain or nameserver.
+
+
File 4, example-device:
+ This file is provided as an example on how to configure a particular network device.
+ The actual device filename should be the name of the device.
+ The core terms: type, signal, and master.
+ The term 'type' has the following options: ignore, disable, static, and dynamic.
+ The term type 'ignore' means that the networking tools will not touch that network device so that a user can manually configure without having the network tools change anything.
+ The term type 'disable' means that under all circumstance that device should be disabled, if at any time the device is noticed as up it will be brought down.
+ The term type 'static' means that the connection is a static connection (manually defined).
+ The term type 'dynamic' means that the connection is a dynamic connection (DHCP/auto defined).
+ The term 'signal' specifies whether or not the signal is 'wired' or 'wireless'.
+ The term 'master' specifies whether or not this device is the master route, 'yes' or 'no'. If 'yes', then the terms 'search', 'nameserver_1', 'nameserver_2', and 'nameserver_3' will be processed and this device will be setup as the default route.
+ The common terms are: bond tunnel mac search nameserver_1 nameserver_2 nameserver_3 firewall.
+ The term 'bond' implies that this device should be bonded between multiple network devices.
+ To syntax is: bond network_device_1 network_device_2
+ Where the network_device_1 and network_device_2 are the names of the network devices to bond togethor.
+ The term 'tunnel' is a works in progress, this could be removed in the future.
+ The term 'mac' represents the devices mac address and provides the means to change the mac address to something different.
+ In particular, you can specify random instead of a valid mac address to have the mac address be randomly generated every time the device gets enabled.
+ For the terms 'search', 'nameserver_1', 'nameserver_2', 'nameserver_3', see the term 'master' above.
+ The term 'firewall' can be either 'on' or 'off' and represents whether or not the device-specific firewall rules will be processed when the device gets enabled.
+ The device-specific firewall rules are those specified in the file nameofdevice-firewall.
+ The static terms are: ip, network, prefix, broadcast, metric, gateway, gtype, gmetric, and family.
+ The gtype and gmetric represent the gateway type and gateway metric.
+ The wireless terms are: essid, mode, channel, rate, enc, power, nick, nwid, ap, txpower, sens, retry, rts, frag, modulation, and wpa
+ The term 'wpa' can be either 'yes' or 'no' and specifies whether or not the target wireless connection is using wpa.
+ File 7 contains a small example on the using wireless.
+ File 8 contains a small example on the using bridges.
+
+
File 5, example-device-firewall:
+ This is an example device-specific firewall rules file, see File 2 above for details.
+
+
File 6, example-device-wpa:
+ This is the wpa settings for a specific device, see the wpa_supplicant documentation on the web for how to configure this file (search for wpa_supplicant.conf).
+
+
File 7, example-wireless:
+ This is an example wireless device, see File 4 above for details.
+
+
File 8, example-bridge:
+ This is an example bridged device, see File 4 above for details.
+
+
File 9, hostname:
+ This file contains only the hostname, no extra syntax.
+ This file is the new location and name of the /etc/hostname file
+
+
File 10, hosts:
+ This file is the new location and name of the /etc/hosts file
+
+
File 11, proc_settings:
+ This file represents proc-specific network settings and get applied at system start.
+ To reprocess this file, run the command ngc -r net/network_proc.
+
+
File 12, resolution:
+ This file is the new location and name of the /etc/resolv.conf file
+ This file should probably not be edited directly, instead edit either the default-device or the appropriate network file and set the search, nameserver_1, nameserver_2, and nameserver_3 appropriately.
+
+
File 13, protocols:
+ This file is the new location and name of the /etc/protocols file
+
+
File 14, services:
+ This file is the new location and name of the /etc/services file
+
+
File 15, gre0, tunl0:
+ The gre0 and tunl0 are disabled by default and these files are doing the disabling.
+
+
Controlling the Network:
+ To control the firewall you will need to use the console command: firewall.
+ To control network devices you will need to use the console command: network.
+
+

+ +

Setting Up the Xorg Display

Screenshot of configuring Xorg Display step 1.

+ Configuration Path: /etc/X11/
+
+ The file to be configured is: /etc/X11/xorg.conf
+ The file /etc/X11/xorg.conf has examples and slight documentaton on how to configure the xorg display.
+ You can also visit http://www.x.org/ for details.
+ Alternatively visit http://die.net/ and search for xorg.conf.
+
+

Screenshot of configuring Xorg Display step 2.

+ If you need to use a different video driver, edit the /etc/X11/xorg.conf file.
+ Scroll to the bottom and uncomment and set the Driver to whatever you need it to be.
+
+ If you are on an OLPC, you could copy the pre-created olpc xorg configuration file:
+ + cd /etc/X11/ + cp -v xorg.conf.olpc xorg.conf + +
+

+ +

Updating the ClamAV Database

+ Configuration Path: /home/services/clamav/database/
+
+ You will need to open a terminal and switch to the clamav user.
+ Now execute the freshclam program.
+ NOTE: This requires network access, so this will fail if you have no working network active.
+

+ +

Tweaking the Boot Process

+ Configuration Path: /etc/initng/
+
+ The file to be configured is: /etc/initng/runlevel/default.runlevel
+ The default.runlevel file specifies how the system boots, but not the order.
+ The order is handled by the individual dependencies.
+
+ Most of the available boot-time software have rules already created such that all you need to do is add them to the default runlevel.
+ To add/remove anything to the boot process, the syntax of the file requires the directory and then the filename (without the extension) on a line by itself.
+
+ If you wanted to add an SSH server to your boot process, then you would simple add target/ssh on any new line in the file.
+ The directory target/ can be found in the /etc/initng/ directory.
+
+ If you wish to boot using a runlevel other than default, look into the runlevel= boot option.
+
+ Once settings are changed, you can use the ngc program to start/stop and do other initng administrative commands.
+

+ +

PCI and USB ID Updating

+ Configuration Path: /etc/
+
+ The files to be configured are: /etc/pci.ids and /etc/usb.ids
+ The /etc/pci.ids and /etc/usb.ids files specify vender-specific information on what any particular hardware device is.
+ In particular, the lspci and lsusb utilities read this information.
+
+ To update /etc/pci.ids to the latest version, download: http://pciids.sourceforge.net/v2.2/pci.ids
+ To update /etc/usb.ids to the latest version, download: http://www.linux-usb.org/usb.ids
+
+ Once this is done, make sure that the file permissions are correct:
+ + chgrp hardware_browse /etc/{pci,usb}.ids + chmod g-wx+r,o-rwx /etc/{pci,usb}.ids + +

+ +

Using Turtle Kevux on the OLPC

+ The first step is to follow the instructions on the OLPC website to obtain the developer key.
+ This may take a while, so come back a few hours later.
+
+ There are two possible ways to boot kevux without touching the original OLPC system.
+ The first is to install Turtle Kevux onto a USB-Stick, whose partition should be labelled turtle-usb-olpc
+ The second is to install Turtle Kevux onto a MMC, whose partition should be labelled turtle-sd-olpc
+ If you do not know how to label or format the USB-Stick or MMC: +

Read the partitioning tutorial
Make sure to properly select the correct USB-Stick or MMC.
Create a single partition and set the label to either turtle-usb-olpc or turtle-sd-olpc for USB-Stick and MMC respectively.

+
+ The next step is to obtain the custom compiled OLPC kernels from the kevux website.
+ Once you have the custom OLPC kernel and its appropriate kernel modules, put them on the system.
+ Lets say you downloaded the custom compiled OLPC kernel from kevux.org and it is called turtle-2.6.26.5-olpc and the maintenance kernel is called turtle-2.6.26.5-olpc-maintenance.
+ Lets say that you also dowloaded the appropriate kernel modules and it is called 2.6.26.5-olpc.tz2.
+ You will also need to extract the kernel modules to modules/
+ What you would do is:
+


+                   mv -v turtle-2.6.26.5-olpc boot/

+                   ln -vs turtle-2.6.26.5-olpc boot/turtle-olpc

+                   tar -xf 2.6.26.5-olpc.tz2 -C modules/

+                   mv -v turtle-2.6.26.5-olpc-maintenance boot/

+                   ln -vs turtle-2.6.26.5-olpc-maintenance boot/turtle-olpc-maintenance

+

+
+ Replace the default xorg.conf file with the the xorg.conf.olpc file so that you can get a working graphical display:
+


+                   cp -v etc/X11/xorg.conf.olpc etc/X11/xorg.conf

+

+
+ You are now ready to boot to the OLPC.
+ Plug your device into the OLPC and reboot the OLPC.
+ If all goes well, you should get a prompt where you can press a key to select the desired method of booting.
+ NOTE: Don't select the Squash or Squish boot methods unless you know what you are doing.
+
+ If all went well, you are sitting in a graphical environment.
+ You now have one more step at tweaking the system.
+

+ Open up the Applications->Settings->Appearance.
+

+ Select the Fonts tab.
+

+ Enable the Custom DPI Settings checkbox and set DPI to 140.
+
+ You should now be able to fully use OLPC.
+ NOTE: Use the TVCard Player called xawtv to access the camera.
+

Booting and Running

+ +

Booting Live System

+ This tutorial is assuming that you have either a live-usb or a live-cdrom.
+ In order to boot the Live system you need to have your computer boot the device by rebooting the computer.
+ While booting your machine, you may have to press a key to select boot options or something of similar meaning.
+ Note: live-usb's cannot be directly booted to on most machines that only support usb 1.1 or less.
+ To boot a live-usb on a usb 1.1 system, you will need a live cdrom that contains the appropriate grub.
+
+ Available Boot Options:
+ + Install Kevux System + Boot Live System - Run From Memory + Boot Live System - Run From CD-Rom + Maintenance Mode + Check Memory + +
+

Install Kevux System:
+ This boots to a live install system that runs either from memory or from the cdrom.
+ The installation system is called KiWI and includes documentation on how to install the system.
+
+
Boot Live System - Run From Memory:
+ This is the default boot option.
+ This boot process will copy the compressed system into ram and run itself from ram.
+ This boot process requires 384MB to 512MB of System Ram for the "everything" build.
+ To calculate how much memory your particular build will require add the files sizes of the following files:
+
- bin.sfs
- lib.sfs
- sbin.sfs
- share.sfs
- home.sfs
- etc.sfs
+ Once these file sizes are added up, add 70MB (for approximate runtime memory usage) to the results.
+ Round the results to the nearest memory size; usually one of the following: 4, 8, 16, 32, 64, 96, 128, 192, 256, 384, 512, 768, 1024, 1536, 2048
+ This boot option will take some amount of time, ~20 seconds, to copy itself into memory.
+ Once the system is booted, the cdrom or usb may be removed without causing any problems.
+ Once the system is booted, most/all programs start instantly or within the first 1 to 6 seconds of waiting.
+
+
Boot Live System - Run From CD-Rom:
+ This is the least flexible boot option.
+ This will not copy itself into memory, saving boot time by not having to copy itself into memory.
+ The downside is that much more time is lost because the system has to read the device every single time something is needed, slowing the execution process significantly.
+ This boot process requires 64MB to 128MB or System Ram for the "everything" build.
+ Once the system is booted, the cdrom or usb must NOT be removed or problems will occur.
+ Once the system is booted, most programs will start within the 5 to 30 seconds.
+
+
Maintenance Mode:
+ This will immediately drop to the initrd bash environment.
+ This allows you to manually and safely run fsck or similar commands for a particular system.
+ When any of the boot options above fail, you will always be dropped into this mode.
+ This is especially useful when the rootfs doesn't exist, the kernel will not lockup and you can still hit control+alt+delete
+
+
Check Memory:
+ This will start a dedicated memory tester.
+ Run this for a few hours to give a decently thorough memory check.
+ Reboot the machine to get out of this mode.
+
+

+
+ Advanced Kevux-Specific Boot Options
+

finalroot=
+ Specifies the what root device partition is to be used before starting the system.
+ Unlike the standard root=, finalroot= allows for any device naming system that the mount command can use.
+ The primary use of finalroot= is to boot to a device by name and not by the device's physical number.
+ This is especially useful for livecd's, liveusb's, and other dynamic systems.
+ Do not use root= to boot a root filesystem, if you are using a kevux initrd.
+ The root= option tells the kernel to load the initrd as the first rootfs.
+
+
finalinit=
+ Specifies what the init program is to be called after switching to the finalroot.
+ Do not use init= to specify the init program, if you are using a kevux initrd.
+ The init= option tells the kernel to load the initrd specific init program.
+
+
subroot=
+ Allows one to load a rootfs from a specific folder inside of the finalroot device.
+ This should allow one to have multiple rootfs's on a single partition.
+ This can be useful for having different versions of the same system on a single partition without having any conflicts.
+ Because the system will be running from withing the subroot, the final system will not be able to directly see any of the other subroots or the / of the actual partition.
+
+
maintenance
+ This tells the initrd to immediately drop to the initrd's /bin/bash.
+ This normally loads the maintenance initrd.
+
+
settings=
+ This specifies a device that contains additional settings information in the same way finalroot= specifies a device.
+ The additional settings information currently only supports encrypted boot settings.
+ In the future, this is expected to be expanded and will also be used to perform network booting.
+ All settings data is expected to be stored in the /boot/settings/ directory within the settings device.
+
+
settingsname=
+ The settings name represent a sub-directory within the /boot/settings/ directory.
+ This allows for having multiple different settings data on a single settings device without conflicts.
+ For example, lets say you have two sub-directories called: encrypted and network.
+ By specifying the settingsname=network would mean that the network boot settings would be processed.
+ By specifying the settingsname=encrypted would mean that the encrypted boot settings would be processed.
+ If not settings name is passed, then the default is to use the files found within the /boot/settings/ directory and not some sub-directory.
+
+
settingscdromsearch=
+ This is identical to the cdromsearch= option explained below but only for finding the settings device.
+
+
settingsmmcsearch=
+ This is identical to the mmcsearch= option explained below but only for finding the settings device.
+
+
runlevel=
+ Use this to execute a specific set of init instructions during system boot.
+ These instructions are defined in /etc/initng/runlevel/.
+ The default runlevel is called: /etc/initng/runlevel/default.runlevel.
+ The KiWI installer uses the runlevel called: /etc/initng/runlevel/kiwi.runlevel.
+
+ Example:
+ If you wish to boot to a runlevel called single (/etc/initng/runlevel/single.runlevel), you would use the boot command: runlevel=single.
+
+
squashboot=
+ This tells the initrd to execute the live_init script using the squash compressed files.
+ When this is specified, the finalroot= option is expected to be the partition, cdrom, or some device where the squash files are located.
+ The squash files are expected to be in the directory /boot/live/ of the finalroot device.
+ There are the following parameters available:
+
- device - this means run the squash files directly from the finalroot device
- memory - this means copy the squash files into memory and run from memory
- extract - this means extract the squash files into memory and run from memory
+ The live_init defines an entirely new set of options explicitly useful for booting a livecdrom, a liveusb, or any system compressed into squash files
+
+ Squash Specific Boot Options
+
- squashpath=
  + Specify a subdirectory or path on the finalroot= device that contains the squash files.
  + This applies to both squashboot and squishboot boot modes.
  +
  +
- filesystemlimit=
  + Specify a hard limit on how large the memory filesystem will be.
  + By default, no limit is set.
  + The Boot Live System - Run From Memory (uncompressed) boot option does set a size limit that is over a 1GB
  +
  +
- etcdevice=
  + Specify the physical partition that contains the etc directory.
  + This will be mounted to the /etc directory of the finalroot system.
  + For using an ecrypted partition, this should be set to something like: etcdevice=/dev/mapper/etc
  +
  +
- homedevice=
  + Specify the physical partition that contains the home directory.
  + This will be mounted to the /home directory of the finalroot system.
  + For using an ecrypted partition, this should be set to something like: homedevice=/dev/mapper/home
  +
  +
- vardevice=
  + Specify the physical partition that contains the var directory.
  + This will be mounted to the /var directory of the finalroot system.
  + For using an ecrypted partition, this should be set to something like: vardevice=/dev/mapper/var
  +
  +
- tmpdevice=
  + Specify the physical partition that contains the tmp directory.
  + This will be mounted to the /tmp directory of the finalroot system.
  + For using an ecrypted partition, this should be set to something like: tmpdevice=/dev/mapper/tmp
  +
  +
- xorg=
  + Manually specify whether or not xorg should be started on boot.
  + Whether or not this works is explicitly dependent on whether or not any of the boot terminals are set to auto-start.
  + The default action is to auto-start a terminal on tty1 and that terminal will start xorg.
  + There are the following parameters available:
  +
  - yes - this means to start xorg if terminal auto-start is enabled on the system. (this is the default)
  - no - this means do not start xorg if terminal auto-start is enabled on the system and therefore only a terminal is started.
  +
  +
- share=
  + Specify whether or not to make the share available on a live system.
  + For the squashinit=extract and squashinit=memory commands, more memory than normal is needed to cope with the additional space needed for the share.
  + There are the following parameters available:
  +
  - yes - this means to include the share.sfs file when booting the live system. (this is the default)
  - no - this means to not include the share.sfs file when booting the live system, saving memory.
  +
  +
- toolchain=
  + Specify whether or not to make the toolchain available on a live system.
  + For the squashinit=extract and squashinit=memory commands, more memory than normal is needed to cope with the additional space needed for the toolchain.
  + Use this for compilation software such as gcc.
  + There are the following parameters available:
  +
  - yes - this means to include the toolchain.sfs file when booting the live system.
  - no - this means to not include the toolchain.sfs file when booting the live system, saving memory. (this is the default)
  +
  +
- documentation=
  + Specify whether or not to make the documentation available on a live system.
  + For the squashinit=extract and squashinit=memory commands, more memory than normal is needed to cope with the additional space needed for the documentation.
  + There are the following parameters available:
  +
  - yes - this means to include the documentation.sfs file when booting the live system.
  - no - this means to not include the documentation.sfs file when booting the live system, saving memory. (this is the default)
  +
  +
- package=
  + Specify whether or not to make the package available on a live system.
  + For the squashinit=extract and squashinit=memory commands, more memory than normal is needed to cope with the additional space needed for the package.
  + Use this for package management (installing and uninstalling software).
  + There are the following parameters available:
  +
  - yes - this means to include the package.sfs file when booting the live system.
  - no - this means to not include the package.sfs file when booting the live system, saving memory. (this is the default)
  +
  +
- python=
  + Specify whether or not to make the python available on a live system.
  + For the squashinit=extract and squashinit=memory commands, more memory than normal is needed to cope with the additional space needed for the python.
  + There are the following parameters available:
  +
  - yes - this means to include the python.sfs file when booting the live system.
  - no - this means to not include the python.sfs file when booting the live system, saving memory. (this is the default)
  +
  +
- perl=
  + Specify whether or not to make the perl available on a live system.
  + For the squashinit=extract and squashinit=memory commands, more memory than normal is needed to cope with the additional space needed for the perl.
  + There are the following parameters available:
  +
  - yes - this means to include the perl.sfs file when booting the live system.
  - no - this means to not include the perl.sfs file when booting the live system, saving memory. (this is the default)
  +
  +
- install=
  + Specify whether or not to make the installation files available on a live system so that installation may properly function.
  + You should also specify runlevel=kiwi to boot to the installation program.
  + There are the following parameters available:
  +
  - kiwi - this means that the squash installation files are at the /boot/live directory of the final root device. (this is the default)
  - /path/to/installation/directory - this means that the installation squash files are the specified path of the final root device. (this must begin with a leading slash)
  +
  +
+ + NOTE: Nothing can be written to the primary system files when squashinit=device and squashboot=memory are used.
+ NOTE: When squashboot=extract is used, these files can be written to, but will be lost during reboots.
+ +
+
squishboot=
+ This is a hybrid between booting with squashboot and normal boot.
+ Instead of running the entire system from squash files, only the primary binaries /bin, /sbin, /lib, and /toolchain are mounted via squash.
+ Everything else is expected to be on the final root fs, already extracted.
+ This allows for having compressed binaries on a small device while maintaining normal write behavior for most things.
+ This method requires much less ram than squashboot.
+ The squash files are expected to be in /live/boot/ of the final root system by default.
+ Most of the additionaly squashboot options are supported and are renamed from squash to squish accordingly.
+ For parameter conflict resolution, squishboot will override squashboot.
+ This is particularly useful for embedded devices and the OLPC-XO.
+
+

+ +

What Should Happen

+ When all things work correctly, you should end up sitting on an XFCE desktop screen with a backgroup picture of a stream in a forest.
+ This is the default desktop environment and the default layout.
+ Enjoy.
+
+ If you do not want a graphical display to appear on system startup, then you can append xorg=no as a kernel boot parameter.
+

+ +

Something Went Wrong

+ Unfortunately, not all things work all of the time.
+ Whenever something goes wrong with the boot process, you will get stuck with a login prompt.
+ In order to Login, see Logging In Below.
+
+ Okay, so the system started up but you are not sitting in a graphical XFCE desktop with the kevux logo in the background.
+ In this situation, the most probably cause is that the Xorg (and therefore XFCE) failed to start.
+ The most common cause of this is a video card problem.
+ To fix this problem, you will need to manually tell xorg to use your particular video card or use vesa.
+
+ WARNING: This may require some moderate to advanced knowledge of the linux command line and understanding of what your video card specifically is.
+
+ If the system is not responding then you may need to be able to boot the system without xorg, so add the xorg=no boot parameter in the grub config at boot time.
+ Once you find a way to login you need to edit the /etc/X11/xorg.conf file to work with your appropriate video card.
+ To add your video card to the xorg.conf file, scroll to the bottom of that file looking for the part that begins with Section "Device"
+ Inside of this section, look for the part that begins with #Driver
+ Uncomment this line by removing the leading #.
+ On the same line, to the immediate right, you should see something text surrounded in double quotes.
+ Replace that text with the appropriate video card driver name.
+ If you do not know the proper driver then you will have to do some researching or asking for assistance as determining this is advanced and may be complex.
+ You may be able to identify your video card by running the command lspci and looking for a line that has VGA Compatible controller or Display controller.
+
+ For the actual login process, see the Logging In below.
+
+ If all else fails and you still cannot get into the system, try booting into maintenance mode by passing the grub command line option: maintenance.
+ However, using maintenance mode almost definitely requires advanced to expert knowledge.
+

+ +

Logging In

+ The login screen is pretty straight-forward.
+ Just type in your username and you will be prompted for a password.
+ The default username is turtle
+ The default password is kevux\
+ Do not forget the trailing slash: \
+

+
+

+ Immediately following a successful login, you will be prompted for the particular type of login.
+
+ Login Types:
+   Terminal - Drop to a Terminal (Console).
+   Webbrowser - Drop to a command-line webbrowser (Console).
+   Xorg - Start Xorg (Graphical Display) using the manager defined in ~/.xinitrc (This is the default).
+

+
+

+ If you selected Terminal, then you will see a login prompt where you can type in any console commands you desire.
+ This console environment uses the bash shell.
+

+ +

Virtual Machines

+ Running Kevux on a virtual machine is pretty straight-foward and therefore only known issues will be listed here.
+
+ Physical Address Extension, aka PAE, is used by this system.
+ If the virtual machine does not have PAE, support enabled, then the system will not boot.
+
+ Hardware Virtualization features such as VT-z/AMD-V, are know to prevent GRUB from booting properly.
+ If for any reason your system does not boot, try disabling VT-z/AMD-V, support.
+

Short	Long	Description
`-h`	`--help`	Print the help message.
`+d`	`++dark`	Output using colors that show up better on dark backgrounds.
`+l`	`++light`	Output using colors that show up better on light backgrounds.
`+n`	`++no_color`	Do not print using color.
`+q`	`++quiet`	Decrease verbosity, silencing most output.
`+n`	`++normal`	Set verbosity to normal.
`+V`	`++verbose`	Increase verbosity beyond normal output.
`+D`	`++debug`	Enable debugging, significantly increasing verbosity beyond normal output.
`+v`	`++version`	Print only the version number.

Short	Long	Description
`-b`	`--binary`	Display binary representation.
`-d`	`--decimal`	Display decimal representation.
`-D`	`--duodecimal`	Display duodecimal representation.
`-x`	`--hexidecimal`	Display hexadecimal representation.
`-o`	`--octal`	Display octal representation.
`-U`	`--unicode`	Display using Unicode representation for valid Unicode (like: U+0000).
`-f`	`--first`	Start reading at this byte offset.
`-l`	`--last`	Stop reading at this (inclusive) byte offset.
`-N`	`--narrow`	Use narrow display, resulting in 1*width reducing size of the text columns.
`-p`	`--placeholder`	Use a placeholder character instead of a space for placeholders.
`-t`	`--text`	Include a column of text when displaying the bytes.
`-W`	`--wide`	Use wide display, resulting in 2*width allowing for space for wide characters in the text columns.
`-w`	`--width`	Set number of columns of Bytes to display.

Short	Long	Description
`-h`	`--help`	Print the help message.
`+d`	`++dark`	Output using colors that show up better on dark backgrounds.
`+l`	`++light`	Output using colors that show up better on light backgrounds.
`+n`	`++no_color`	Do not print using color.
`+q`	`++quiet`	Decrease verbosity, silencing most output.
`+n`	`++normal`	Set verbosity to normal.
`+V`	`++verbose`	Increase verbosity beyond normal output.
`+D`	`++debug`	Enable debugging, significantly increasing verbosity beyond normal output.
`+v`	`++version`	Print only the version number.

Short	Long	Description
`-n`	`--name`	Specify the name of the controller socket file.
`-R`	`--return`	Print a message about the response packet.
`-s`	`--settings`	Specify a directory path or a full path to the control settings file.
`-k`	`--socket`	Specify a directory path or a full path to the controller socket file.

Short	Long	Description
`-h`	`--help`	Print the help message.
`+d`	`++dark`	Output using colors that show up better on dark backgrounds.
`+l`	`++light`	Output using colors that show up better on light backgrounds.
`+n`	`++no_color`	Do not print using color.
`+q`	`++quiet`	Decrease verbosity, silencing most output.
`+n`	`++normal`	Set verbosity to normal.
`+V`	`++verbose`	Increase verbosity beyond normal output.
`+D`	`++debug`	Enable debugging, significantly increasing verbosity beyond normal output.
`+v`	`++version`	Print only the version number.

Short	Long	Description
`-c`	`--cgroup`	Specify a custom control group file path, such as '/sys/fs/cgroup/'.
`-d`	`--daemon`	Run in daemon only mode (do not process the entry).
`-I`	`--init`	The program will run as an init replacement.
`-i`	`--interruptible`	Designate that this program can be interrupted by a signal.
`-p`	`--pid`	Specify a custom pid file path, such as 'controller/run/default.pid'.
`-s`	`--settings`	Specify a custom settings path, such as 'controller/'.
`-S`	`--simulate`	Run as a simulation.
`-k`	`--socket`	Specify a custom socket file path, such as 'controller/run/default.socket'.
`-U`	`--uninterruptible`	Designate that this program cannot be interrupted by a signal.
`-v`	`--validate`	Validate the settings (entry and rules) without running (does not simulate).

Short	Long	Description
`-d`	`--define`	Append an additional define after defines from settings file.
`-f`	`--fakefile`	Use this fakefile.
`-m`	`--mode`	Use this mode when processing the build settings.
`-p`	`--process`	Process name for storing build states.
`-s`	`--settings`	Use this settings file.
`-b`	`--build`	Specify a custom build directory.
`-D`	`--data`	Specify a custom path to the data files.
`-S`	`--sources`	Specify a custom path to the source files.
`-w`	`--work`	Use includes/libraries/programs from this directory instead of system.

Operation	Description
`build`	Build or compile the code based on build settings file.
`clean`	Delete all build files.
`make`	Build or compile the code based on fakefile.
`skeleton`	Build a skeleton directory structure.

Command	Description
`start`	Turn on the firewall.
`stop`	Turn off the firewall.
`restart`	Turn off and then turn on the firewall.
`lock`	Prevent all communication.
`show`	Show active firewall settings.

Short	Long	Description
`-a`	`--at`	Select Object at this numeric index.
`-c`	`--content`	Print the Content (default).
`-C`	`--columns`	Print the total number of columns.
`-D`	`--delimit`	Designate how to handle applying delimits.
`-d`	`--depth`	Select Object at this numeric depth.
`-e`	`--empty`	Include empty Content when processing.
`-l`	`--line`	Print only the Content at the given line.
`-n`	`--name`	Select Object with this name.
`-o`	`--object`	Print the Object.
`-p`	`--pipe`	Print using the special pipe format.
`-R`	`--raw`	Print with the original quotes and escapes.
`-s`	`--select`	Select sub-Content at this index.
`-t`	`--total`	Print the total number of lines.
`-T`	`--trim`	Trim Object names on select or print.

Short	Long	Description
`-f`	`--file`	Specify a file to send data to.
`-c`	`--content`	The Content to write.
`-I`	`--ignore`	Ignore a given range within a Content.
`-d`	`--double`	Use double quotes (default).
`-o`	`--object`	The Object to write.
`-p`	`--partial`	Do not file end of Object/Content character.
`-P`	`--prepend`	Prepend the given white space characters to the start of each multi-line Content.
`-s`	`--single`	Use single quotes.
`-T`	`--trim`	Trim Object names.

Short	Long	Description
`-c`	`--content`	Print the Identifier content (the 4-digit hexidecimal type code).
`-o`	`--object`	Print the Identifier object (the name).
`-l`	`--line`	Print only the Identifier at the given line.
`-n`	`--name`	Select FSS using this full or partial type name or code.
`-t`	`--total`	Print the total Identifiers found.

Short	Long	Description
`-f`	`--fine`	Print `F_true` or `F_false` if status code is neither an error nor a warning or print number with neither the error code nor the warning code bits set.
`-w`	`--warning`	Print `F_true` or `F_false` if status code is a warning or print number with warning code bit set.
`-e`	`--error`	Print `F_true` or `F_false` if status code is an error or print number with error code bit set.
`-n`	`--number`	Convert status code name to number.

Short	Long	Description
`-a`	`--at`	Select variable at this numeric index.
`-l`	`--line`	Print only the variables at the given line within the file.
`-n`	`--name`	Select variables with this name.
`-w`	`--whole`	Print all of the data instead of just the IKI variable data.
`-c`	`--content`	Print the variable content (default).
`-L`	`--literal`	Print the entire variable (aka: object, content, and syntax).
`-o`	`--object`	Print the variable name (aka: object).
`-t`	`--total`	Print the total number of variables.
`-s`	`--substitute`	Substitute the entire variable for the given name and content value with the given string.

Short	Long	Description
`-b`	`--from_bytecode`	The expected input format is byte code (character data).
`-c`	`--from_codepoint`	The expected input format is code point (such as U+0000).
`-f`	`--from_file`	Use the given file as the input source.
`-B`	`--to_bytecode`	The output format is bytecode (character data).
`-C`	`--to_codepoint`	The output format is codepoint (such as U+0000).
`-O`	`--to_combining`	The output format is to print whether or not character is combining or not.
`-F`	`--to_file`	Use the given file as the output destination.
`-W`	`--to_width`	The output format is to print the width of a character (either 0, 1, or 2).
`-H`	`--headers`	Print headers for each section (pipe, file, or parameter).
`-S`	`--separate`	Separate characters by new lines (implied when printing headers).
`-s`	`--strip_invalid`	Strip invalid Unicode characters (do not print invalid sequences).
`-v`	`--verify`	Only perform verification of valid sequences.