Metadata-Version: 2.1
Name: iso-creator
Version: 4.2.5
Summary: Tool to build and maintain Debian isos.
Home-page: https://gitlab.com/abalfoort/iso-creator
Download-URL: https://gitlab.com/abalfoort/iso-creator/-/archive/master/iso-creator-master.tar.gz
Author: Arjen Balfoort
Author-email: arjenbalfoort@hotmail.com
Maintainer: Arjen Balfoort
Maintainer-email: arjenbalfoort@hotmail.com
License: GNU General Public License v2 or later (GPLv2+)
Platform: POSIX
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Utilities
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Programming Language :: Python :: 3

# ISO CONSTRUCTOR

iso-constructor - Tool to build and maintain custom Debian Live ISOs.

# SYNOPSIS

Usage: iso-constructor [OPTIONS] [DISTRIBUTION_PATH]

DISTRIBUTION_PATH contains the unpacked distribution with a boot and root directory.

# DESCRIPTION

Without parameters the GUI is started.

Options for terminal use (no GUI):

-b
:   Build the distribution

-e
:   Edit the distribution

-h
:   Help screen

-i
:   Test Qemu image

-t
:   Test the ISO in Qemu

-u
:   Upgrade the distribution

-U [iso_path]
:   Unpack the ISO

Options for the GUI (all other parameters will be ignored):

-v
:   Prints debug information while running the GUI.

# GUI

## Add distribution
Here you can either unpack an ISO to a new work directory or select an exsiting previously removed work directory.

## Remove distribution
When removing a distribution the work directory will NOT be removed.

## Edit distribution
Creates a chrooted environment where you can change the system.

## Upgrade distribution
Simply runs "apt-get dist-upgrade" but taking into account that some services need to be handled before and after the upgrade.

## Build ISOs
Builds the ISO and creates a sha256 file.

If you installed packages that are not in the repository but you want to keep installed you can edit the keep-packages file:

cp -v /usr/share/iso-constructor/keep-packages ~/.iso-constructor/

Note: to keep all packages you can simply write an asterisk (*) in the keep-packages file.

## Test ISOs in Qemu
If you have these (recommended) packages installed, the Qemu test button will be available:
:   qemu-utils, qemu-system-x86, qemu-system-gui, ovmf

Note: if you test ISO builds newer than your host system the ISO might not boot or there are erros. Upgrade qemu to the latest version (backports).

# REPOSITORY

You can create a pool directory structure as in the live Debian ISOs. Any .deb are updated automatically during build. Release information in the dists directory is generated during build.

Note: ISO Constructor is not able to update the .udeb packages. These need to be updated manually.

# GRUB AND ISOLINUX

To customize/translate the Grub and Isolinux boot menus you can create and edit the templates in ~/.iso-constructor/:

cp -v /usr/share/iso-constructor/grub-template ~/.iso-constructor/

cp -v /usr/share/iso-constructor/isolinux-template ~/.iso-constructor/


# FILES

~/.iso-constructor/iso-constructor.conf
:   Configuration file

~/.iso-constructor/iso-constructor.log
:   Log file.

~/.iso-constructor/qemu.qcow2 (optional)
:   When testing ISOs with Qemu, this file is generated.

~/.iso-constructor/keep-packages (optional)
:   List of packages not in repository. Use /usr/share/iso-constructor/keep-packages as base.

~/.iso-constructor/grub-template (optional)
:   Custom template for grub.cfg. Use /usr/share/iso-constructor/grub-template as base.

~/.iso-constructor/isolinux-template (optional)
:   Custom template for isolinux.cfg. Use /usr/share/iso-constructor/isolinux-template as base.

# AUTHOR

Written by Arjen Balfoort

# BUGS

https://github.com/abalfoort/iso-constructor/issues

# TRANSLATIONS

https://www.transifex.com/abalfoort/iso-constructor

# TODO

Find out how to update/customize the pool packages in Debian live ISOs.
