You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
... Load optional modules from /optional/ directory on the booting
media. Additional modules can be listed, separated
by semicolons, without spaces.
Exampe: 'load=gimp;inkscape' would search for and load any
modules in the /porteus/optional folder that contain the strings
'gimp' or 'inkscape'.
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=U*****************
* Official Porteus Installation Guide *
***************************************
spacebar = pagedown
q = quit
Introduction:
-----------------
*Note that changes to your system can be saved to external media when
running Porteus (from a CD or otherwise), using the 'changes='
cheatcode, and specifying the path to the desired storage location.
You can find more information on this and many other useful cheatcodes
in the file /boot/docs/cheatcodes.txt.
Downloading Porteus
-----------------------
*******************************************
* Burning an ISO file to a CD or DVD Disk *
*******************************************
In order for your computer to run Porteus from the CD, you must make
sure that your BIOS is set to boot to your CDROM device first, before
booting to your hard disk. If you are unsure how to change the boot
order in your BIOS, please see Appendix A.
*******************************************
* Installing Porteus to a USB Flash Drive *
*******************************************
As of Porteus Version 1.1, the officially supported method for
installing Porteus to a flash drive or hard drive is to burn
the ISO image to a CD following the instructions written above,
then boot Porteus from the CD and run the program 'Porteus Installer',
which can be found in the KDE, LXDE, Razor or Xfce menu under the 'System'
heading. This program detects the available devices attached
to your system and automates the installation procedure.
Note that you must have an existing, formatted partition for this
installation program to work.
~~~~~~~~~~~~~~~~~
| From Windows: |
~~~~~~~~~~~~~~~~~
Porteus can be installed to a flash drive by copying the files from the
.iso file to the flash drive and then making the drive bootable.
Please note that you must be logged in as an administrator (or run the
included 'Porteus-installer-for-Windows.exe' file with administrative
priveleges) to make your drive bootable from Windows.
(*NOTE* you can also use a program called wincdemu, which will allow
you to double click on the .iso file and then access the folders
inside it as if it were a CD mounted in your CD drive.)
If you have already created a bootable Porteus CD, you can also
insert that CD and copy the files from there.
Steps to install:
---------------------
1) Insert your flash drive and open it to view the contents. Make a
note of the Drive Letter assigned to this drive (e.g. E:\)
2) Copy the folders 'boot' and 'porteus' from the .iso file to the
top-level directory of your flash drive (meaning the files should not
be placed inside any other folders on the drive. For example, they
should be located at E:\boot and E:\porteus, assuming your flash drive
is device E:\).
3) Navigate into the boot folder that you just copied to your flash
drive. You should see a file there called Porteus-installer-for-Windows.exe.
Right click on this file (make sure it is Porteus-installer-for-Windows.exe
and not Porteus-installer-for-Linux.com) and choose to run it as an
administrator. A window will appear asking you to confirm that the correct
drive or partition is being selected for installation. Double check that
the information shown is correct, and press Enter to complete the
installation.
*NOTE* If you are having problems making your drive bootable from
within Windows or if you do not have administrative priveleges, try
burning Porteus to a CD or DVD using the instructions above, and then
either run the 'Porteus Installer' program (which can be found in the
KDE, LXDE, Razor or Xfce menu under the 'System' heading) or follow the
instructions below to install Porteus to a USB flash drive from within
Linux.
~~~~~~~~~~~~~~~
| From Linux: |
~~~~~~~~~~~~~~~
Before installing, you must extract or mount the .iso file in order
to copy the /boot and /porteus directories to your target device. Some
archiving programs are capable of extracting the .iso, or you can
simply mount it with the following commands:
mkdir /mnt/loop
mount -o loop /path/to/file.iso /mnt/loop
If you are using Porteus for this installation, you can simply enter:
mloop /path/to/file.iso
And you can then navigate to /mnt/loop to access the necessary files.
If you are running from a Porteus CD, you can navigate to /mnt/sr0/
and copy the files from there.
Steps to Install:
---------------------
mount
fdisk -l
to get the path of your flash drive (e.g., /dev/sdb1), and then:
mkdir /mnt/sdb1
mount /dev/sdb1 /mnt/sdb1
Make note of the device's name, as this is the device which will need
to be modified by a script later in the process.
2) Copy the /boot and /porteus folders from the Porteus .iso file (or
from a Porteus CD) to your flash drive. These folders can be placed in
the top level directory on your drive, but as of Porteus version 2.0,
you can place these folders inside a subdirectory and your bootloader
configuration file will be adjusted automatically to boot from that
location.
3) Open a console and change directories to the boot folder that you
just copied into the flash drive, e.g.
cd /mnt/sdb1/boot
sh Porteus.installer-for-Linux.com
*NOTE* If you are not running as root already, you must use the su or
sudo command and enter your root password before starting this script,
or it will not be able to configure your device properly.
This script will ask you to confirm the drive or partition on which you are
installing Porteus. Make sure the information displayed is correct, and
then press Enter to complete the installation. The extlinux bootloader
will be installed on devices that are formatted with ext2/3/4, FAT16/32,
ntfs and btrfs filesystems. LILO will be installed on partitions formatted
with any other filesystem.
*****************************************************
* Installations to Internal or External Hard Drives *
*****************************************************
You can also follow the instructions to manually unpack the ISO to your
target drive and run the installers as described in the "Install to USB"
section.
$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
$ APPENDIX A: Configuring your boot settings in BIOS $
$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
To enter the BIOS of your machine, you will need to press a particular
key during your computer's startup procedure. The exact key varies
from computer to computer, but is typically shown briefly during
startup, and it is usually one of the following keys:
F1, F2, F12, Esc, Tab, etc.
Once you press the specified key, you will be shown the BIOS menu.
While in BIOS, the legend for using the keyboard is at the bottom of
the screen. Inside the BIOS menu, you should look for your 'boot
order' option, and set your desired device (CDROM or USB device) to
the top of the list. Once you have changed your boot order, press F10
to save your changes and exit. If you are planning to boot to a USB
device, make sure it is plugged in when you enter your BIOS, as some
systems will only show the USB option when a USB device is present.
Many machines also have another key to press during startup that
allows you to choose which device to boot from, without entering
the BIOS. While this is very handy, at some stage you will probably
want to change the BIOS setting so you don't have to keep pressing
this button at every boot. Be aware if your machine contains sensitive
data and is used by other people that leaving the setting to 'boot
from USB' presents a security risk. Others could also plug in a device
and boot to their own OS and access the information on your hard drive.
Don't panic just yet, you may still be able to boot from your USB
device. Porteus contains a boot loader called Plop. Using this boot
loader, you can plug in your USB device as well as a Porteus CD. Boot
to the CD and when the Porteus menu comes up, highlight the Plop Boot
Manager and press enter to start up Plop. Within Plop, you can select
'USB', and press enter to boot from the USB device.
$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
$ Appendix B - Saving changes to a Windows Filesystem $
$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
While starting up, Porteus will run a check to see if you are asking
it to save changes directly to a device with a Windows filesystem.
If you are, then Porteus will boot without saved changes enabled. To
create a '.dat' container file and start saving your changes, boot
Porteus into GUI, then open up the menu and navigate to
"System -> Porteus save file manager" (NOTE: You can also access this
program through "Porteus Settings Centre", which will help you to
customize various settings, including creation of a save.dat).
Click on this application to open it, and click on the "Create" button.
It will ask you for the name, size and location where you want to
create it . You can choose any name you like, for example, porteussave,
save, mychanges, etc (upon creation, the .dat suffix will be added).
You must then enter the size of the container in megabytes and a the
location on disk (e.g. /mnt/sdb1/porteus/, if sdb1 is your
desired storage device), then click 'OK' and it will be created
and placed on your storage device. In order to start saving your changes,
you will need to make a simple modification to the file that configures
your bootup procedure. The save.dat manager will walk you through
these changes, but just in case, here are the necessary steps to
peform this manually:
/**************************************************************/
LABEL kde
MENU LABEL Graphics mode (KDE).
KERNEL /boot/vmlinuz
APPEND initrd=/boot/initrd.xz changes=/porteus
TEXT HELP
Run Porteus the best way we can.
Try to autoconfigure graphics
card and use the maximum
allowed resolution
ENDTEXT
LABEL copy2ram
MENU LABEL Copy To RAM
KERNEL vmlinuz
APPEND initrd=initrd.xz copy2ram
TEXT HELP
Run Porteus the same as above,
but first copy all data to RAM
to get a huge speed increase
(needs >768MB)
ENDTEXT
/**************************************************************/
You will need to edit the end of the APPEND line, to make it read
'changes=/porteus/save.dat' (without the quotes, using the name you
specified earlier). Save this file and upon reboot your changes
will be saved to this container.
mkdir /mnt/loop
mount -o loop /mnt/live/mnt/sdXN/save.dat /mnt/loop
~~~~~~~~~~~~~~~
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
... Specifies the preferred keyboard layout for KDE/LXDE/XFCE or
other desktop. A full list of supported layouts can be found in
the /etc/X11/xkb/symbols folder. Up to 3 layouts are supported.
Example: 'kmap=ara,us' will set the arabic keyboard layout at
startup. 'kmap=ara,us' will keep arabic layout as default
with possibility of switching to 'us' by 'alt+shift' key
combination.
Keyboard layout variants are also supported.
Example: 'kmap=pl:qwertz' will set the polish keyboard layout
with 'qwertz' as a variant.
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
... Do not discover any hard drives during startup.
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
... Disable specified hardware autodetection in the case of
hangups. None of your hardware will be detected, and you'll
have to use the "modprobe" command after logging in to
text mode and load all needed drivers manually.
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
List of available cheatcodes in alphabetical order:
NOTE: Example cheatcodes are sometimes listed below inside single
quotes (e.g. 'example=somevalue') for clarity in the documentation.
When you enter these cheatcodes during boot time or in your
porteus.cfg, you should not use these quote marks.
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
... Execute specified command(s) in runlevel 3 (before logging
in to a graphical interface).
Use semicolons (;) as command separators with no spaces.
... If you need to use spaces in the command line, replace them
with '~'. For example, 'cliexec=echo~Shutting~power;poweroff'
will echo your text with spaces instead of '~'.
NOTE: to start graphical applications please use 'guiexec='
cheatcode instead.
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
... This cheatcode will allow you to customize your filesystem
mount options. By default, the mount options for all
filesystems in Porteus are: "noatime,nodiratime,suid,dev,exec,async".
Each option must be separated wtih a comma "," with no spaces
between any characters.
Example: 'mopt=realtime,sync,users,nosuid,noexec'
See 'man mount' for more information on specific mount options.
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
... This boot parameter will prevent Porteus from automatically
establishing a network connection on start-up.
Note that this cheatcode makes some modifications to
your system which must be manually restored, so it is
recommended that you only use this cheatcode in "Always
Fresh" mode. If you've ignored this advice and need to
recover your network connection, please run the following:
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
SPECIAL NOTE FOR USING CHANGES CHEATCODE WITH 'EXIT:' extension:
The 'EXIT:' extension tells the 'changes=' cheatcode to keep all
of the files that have been added/deleted/modified during the
live session stored in memory until you reboot/shutdown. Your
RAM works as a buffor which gets dumped on the drive only once,
when the session is finished.
'changes=EXIT:' cheatcode has following advantages:
- Porteus works as fast as in 'Always Fresh' mode as all modifications
to files and folders are performed in RAM.
- reduced number of read/write cycles should extend the life of SSD
drives and usb sticks.
The only disadvantage of the 'EXIT:' extension is that the session
does not get saved in cases where you experience a hang (kernel crash)
or power interrupt.
Please use with caution!
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
... Keep saved changes in a read-only state. This is useful when
you have your system set up exactly how you like it and do not
want to save any other changes you might make during a live
session. This cheatcode should be used in conjunction with the
'changes=' or 'changes=EXIT:' cheatcodes.
Example: 'changes=/path/file.dat changes-ro'
NOTE: remove the 'changes-ro' cheatcode from the bootloader config
to start saving changes as normal (effective after a reboot).
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
... Specify module(s) or folder(s) containing modules which should
be copied to RAM when using the 'copy2ram' cheatcode. This
allows you to have the speed benefit of 'copy2ram' for the
modules you use the most, without occupying your RAM with those
modules that you make use of less often. Any modules that are
not specified will be mounted in place on the block device, so
your device will remain mounted while Porteus is running.
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
guiexec=my_script
guiexec=firefox;pidgin
... Execute specified command(s) in runlevel 4, when the graphical
interface is loaded; unlike 'cliexec' this cheatcode can be
used to start graphical applications.
Use semicolons (;) as command separators with no spaces.
... If you need to use spaces in the command line, replace them
with '~'.
Example: 'guiexec=firefox~kernel.org' will open the firefox
browser on the 'kernel.org' website.
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
... Do not discover any optical devices during startup.
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
... Copy files from specified directory directly to the live
filesystem. This directory will be used instead of the
traditional /porteus/rootcopy.
Example: 'rootcopy=/mnt/sda5/porteus-files'
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
This cheatcode allows users to easily switch back and forth
bewteen different hardware configurations while using the
proprietary drivers because both driver modules can sit side
by side in /porteus/optional/ without interfering with one
another. They are only activated when needed.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt
Reboot your computer and wait several seconds until the graphical
Porteus logo appears with a boot menu. Choose your desired menu
entry and hit Tab, which will allow you to edit the command line.
Add your desired boot argument from the list below to affect booting
the way you like.
Here's an example of what the boot line would look like, adding the
noauto and copy2ram cheatcodes to a standard Porteus boot option
(which already has some other cheatcodes by default):
---------------------------------------
base_only
... This cheatcode will prevent the system from loading any
modules at startup other than the 'base' modules included
with the default ISO (000-kernel.xzm, 001-core.xzm, etc).
This is useful in debugging to see if problems you are
having are associated with some module you've added to the
system.
changes=/dev/device
changes=/path/
changes=/path/file.dat
... All changes made in Porteus are kept in memory until you reboot.
With this boot parameter, you tell Porteus to use a device
(or a file or directory) other than your memory for storing
changes. You can, for example, format your disk partition
/dev/sdb2 with some Linux filesystem (eg. xfs) and then use
'changes=/dev/sdb2' to store all changes to that partition.
This way you won't loose your changes after reboot.
... If you use a file image instead of a device, and the image
contains a valid filesystem, Porteus will mount it on a loop
device and will store changes to it.
... If you use a directory, Porteus will save changes to it (it
will make a 'changes' subdirectory there). This should only
be used for linux filesystems, if changes need to be saved to a
FAT or NTFS partition, a savefile container has to be used.
changes-ro
cliexec=my_script
cliexec=my_script;reboot
copy2ram
... Copy all modules to RAM. You'll need at least 256MB of RAM
to boot Porteus properly. 64-bit Porteus with KDE-4 requires
at least 768MB of RAM for this.
Copy2ram slows down the boot phase but speeds up Porteus!
debug
... Start the shell several times during the boot to perform
debugging actions.
delay=some_value
... To be used for devices which need extra time to settle up.
Example: 'delay=5' will cause a 5 second delay before Porteus
starts booting.
extramod=/path/folder_with_modules
extramod=/path/folder_with_modules;/path2/folder_with_modules
... This cheatcode lets you load modules from one or more external
folders that are located outside of the /porteus directory.
Multiple folders can be specified, with full paths separated by
a semicolon without any spaces.
Examples:
'extramod=/mnt/sdb3/porteus-modules'
'extramod=/mnt/sdb3/porteus-modules;/mnt/sdc4/inkscape_modules'
from=/dev/device
from=/path/folder
from=/path/porteus.iso
... Loads Porteus from the specified device, folder or ISO file.
Examples:
'from=/dev/sdb2' will attempt to load unpacked Porteus ISO from
the second partition on your second drive.
'from=/mnt/sda2/linux-testing' will attempt to load unpacked ISO
from the 'linux-testing' folder placed on the second partition.
'from=/linux-ISO/porteus.iso' will attempt to load the Porteus
data from an ISO file placed inside the 'linux-ISO' folder.
fsck
... Enables a filesystem check for ext(2,3,4) and reiserfs
partitions during boot time before anything is mounted by
Porteus. XFS does not need fsck as a check is performed
automatically during the mount operation.
NOTE: On some systems, you will need to use the 'delay='
cheatcode in order to allow your devices to settle up.
This should only be needed to fsck usb flash drives.
guiexec=my_script
guiexec=firefox;pidgin
kmap=keyboardmap
kmap=keyboardmap1,keyboardmap2,keyboardmap3
kmap=keyboardmap:variant
load=module
load=module[1];module[n]
login=user_name
... Lets you specify the name of the user (could be also 'root')
which will be autologged into GUI session.
If username is not provided then booting stops on the lxdm/kdm
login screen.
mopt
noauto
nocd
noeject
... Do not eject CD/DVD disc during boot time and shutdown.
nohd
nohotplug
noload=module
noload=module[1];module[n]
... Disable loading of any modules specified. This affects all the
modules on the Porteus booting mendia, including /base and /modules
folders, so using noload=kde will disable loading of all modules
with 'kde' in the name. It is useful with the copy2ram cheatcode,
because any un-used module is not copied to ram. Multiple modules
can be listed, but they must be separated by semicolons, with no
spaces.
Example: 'noload=lxde;devel' will prevent the loading of any
modules with a name containing the strings 'lxde' or 'devel'
nomagic
... Do not bind "magic folders" during boot time. Useful when
something went wrong with your Porteus configuration and you
want to boot into true 'Always Fresh' mode.
nonetwork
norootcopy
noswap
pxe
... Initialize PXE services (tftpd, dhcpcd, nfs server) which will
allow you to boot Porteus on other computers over a network.
This cheatcode should be used on the server side.
ramsize=some_value%
... Will let you set a custom size for the tmpfs partition
which is used as the root (/) of your live filesystem
when changes are not saved on a real filesystem
(i.e., Always Fresh mode). The default value is 60% of
available RAM memory.
Example: 'ramsize=40%'
rammod=module
rammod=folder
rammod=module[1];module[n];folder[1];folder[2]
You can use a full or partial names for your search string,
but keep in mind that all modules and folders that match your
string will be loaded into RAM; if you have extra modules in a
folder named 'lxde' and you use 'rammod=lxde', then the module
003-lxde.xzm from /porteus/base will be loaded in addition to
all modules in the 'lxde' folder.
NOTE: 'rammod' cannot be used without 'copy2ram', and it also
will not load modules from /porteus/optional or external
locations unless you also specify these modules with the
'load=' or 'extramod=' cheatcodes.
Examples:
'rammod=001;002;004;firefox'
'extramod=/mnt/sdb3/porteus/gimp rammod=001;002;gimp'
rootcopy=/path/to_folder/with_files
sgnfile=some_name.sgn
... This cheatcode specifies the *.sgn file which Porteus will
search for. This is useful when you want to store several
Porteus editions on one disk/disc.
Example: 'sgnfile=porteus-usb.sgn'
storage=/path/folder
storage=/path/file.dat
... This cheatcode takes action only when used together with the
'pxe' cheatcode. It tells the server to store persistent
changes from the clients in a specified folder. Changes must
be saved on a real and writable filesystem (wont work with
aufs).
Separate folders for each client will be created with the name
'/path/folder/client-xxxx' where xxxx is the last 4 characters
of the clients' NIC MAC address.
This cheatcode should be used on the server side.
Example: 'storage=/mnt/sda3/pxe-clients'
timezone=region/zone
... Tell Porteus the correct timezone for your location. By default,
this assumes that your hardware clock is set to localtime. To use
a timezone with a hardware clock set to UTC time instead, also
add the 'utc' cheatcode.
A full listing of available timezones can be found in the file
/usr/sbin/timeconfig.
Example: 'timezone=Europe/Warsaw'
Example: 'timezone=Factory'
utc
... Tell Porteus that your hardware clock is set to UTC time and
not to localtime. Most computers that have Windows installed on
them use localtime instead of UTC time, but many UNIX machines
use UTC instead. This cheatcode is normally used together with
the 'timezone' cheatcode.
Example: 'timezone=Europe/Warsaw utc'
vga_detect
... Automatically detects AMD or nVidia video cards and loads the
proprietary drivers at startup. You must have a module
containing the appropriate graphics driver (nVidia or amd-catalyst)
stored in your /porteus/optional/ directory. These modules
are available in the download section of the Porteus website
(www.porteus.org/download) for each edition and version of
Porteus. If you compile your own driver, please note that
the module's name must begin with the string 'nVidia-' or
'amd-catalyst' because the startup script searches for the driver
modules by name.
volume=some_value%
zram=some_value%
Examples:
changes=UUID:STrING-0F-ChARACtERS/path/file.dat
extramod=LABEL:YourLabelName/path/to_folder/with_modules
from=UUID:STrING-0F-ChARACtERS/path/folder
rootcopy=LABEL:YourLabelName/path/to_folder/with_files
While you are running a session with changes=EXIT, you can use the
'dump-session' command (run as root from the command line) to move all
of your changes from RAM to your storage media. This will reduce the
risk of data loss and free up your RAM.
Examples:
changes=EXIT:/dev/device
changes=EXIT:/path/
changes=EXIT:UUID:STrING-0F-ChARACtERS/path/file.dat
would boot into KDE with all of the standard codes used for KDE, plus
debug and noauto. If you want to use LILO with custom cheatcodes at
every boot without manually entering them each time, you must modify
the /boot/syslinux/lilo.conf and then repeat installation by running
/boot/Porteus-installer-for-Linux.com utility as LILO must reload it's
configuration.
FINAL NOTE:
The cheatcodes listed above are those that are unique to Porteus.
There are literally hundreds of other kernel boot parameters
that can be used. For more information on these parameters visit:
http://www.kernel.org/doc/Documentation/kernel-parameters.txt