The main goal of this manual is to serve as a single access point to all documentation related to the Debian Live project. It does not include end-user documentation for using a Debian Live system as far as things are live specific.
Some of the commands mentioned in the text must be executed with superuser privileges which can be obtained by becoming the root user via su or by using sudo. To distinguish between commands which may be executed by an unprivileged user and those requiring superuser privileges, commands are prepended by $ or # respectively. This symbol is not a part of the command.
While we believe that everything in this manual is important to at least some of our users, we realize it is a lot of material to cover and that you may wish to experience early success using the software before delving into the details. Therefore, we have provided three tutorials in the Examples section designed to teach you image building and customization basics. Read Using the examples first, followed by Tutorial 1: A standard image, Tutorial 2: A web browser utility and finally Tutorial 3: A personalized image. By the end of these tutorials, you will have a taste of what can be done with Debian Live. We encourage you to return to more in-depth study of the manual, perhaps next reading The basics, skimming or skipping Building a netboot image, and finishing by reading the Customization overview and the chapters that follow it. By this point, we hope you are thoroughly excited by what can be done with Debian Live and motivated to read the rest of the manual, cover-to-cover.
The stable distribution contains the latest officially released distribution of Debian. The testing distribution is the staging area for the next stable release. A major advantage of using this distribution is that it has more recent versions of software relative to the stable release. The unstable distribution is where active development of Debian occurs. Generally, this distribution is run by developers and those who like to live on the edge.
A list of authors (in alphabetical order):
This manual is intended as a community project and all proposals for improvements and contributions are extremely welcome. The preferred way to submit a contribution is to send it to the mailing list. Please see the section Contact for more information.
When submitting a contribution, please clearly identify its copyright holder and include the licensing statement. Note that to be accepted, the contribution must be licensed under the same license as the rest of the document, namely, GPL version 3 or later.
The sources for this manual are maintained using the Git version control system. You can check out the latest copy by executing:
$ git clone git://live.debian.net/git/live-manual.git
Prior to submission of your contribution, please preview your work. To preview the live-manual, ensure the packages needed for building are installed by executing:
# apt-get install make po4a sisu-complete libnokogiri-ruby
You may build the live-manual from the top level directory of your Git checkout by executing:
$ make build
Since it takes a while to build the manual in all supported languages, you may find it convenient when proofing to build for only one language, e.g. by executing:
$ make build LANGUAGES=en
Anyone can directly commit to the repository. However, we ask you to send bigger changes to the mailing list to discuss them first. To push to the repository, you must follow this procedure:
$ mkdir -p ~/.ssh/identity.d
$ wget http://email@example.com \
$ wget http://firstname.lastname@example.org \
$ chmod 0600 ~/.email@example.com*
$ cat >> ~/.ssh/config << EOF
$ git clone firstname.lastname@example.org:/live-manual.git
$ make commit
$ git commit -a -m "Adding a section on applying patches."
$ git push
To submit a translation for a new language, follow these three steps: