Manual Live Systems

Sobre esse manual

1. Sobre esse manual

This manual serves as a single access point to all documentation related to the Live Systems Project and in particular applies to the software produced by the project for the Debian 8.0 "jessie" release. An up-to-date version can always be found at ‹http://live-systems.org/›

While live-manual is primarily focused on helping you build a live system and not on end-user topics, an end-user may find some useful information in these sections: The Basics covers downloading prebuilt images and preparing images to be booted from media or the network, either using the web builder or running live-build directly on your system. Customizing run time behaviours describes some options that may be specified at the boot prompt, such as selecting a keyboard layout and locale, and using persistence.

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 live systems and motivated to read the rest of the manual, cover-to-cover.

Live system: An operating system that can boot without installation to a hard drive. Live systems do not alter local operating system(s) or file(s) already installed on the computer hard drive unless instructed to do so. Live systems are typically booted from media such as CDs, DVDs or USB sticks. Some may also boot over the network (via netboot images, see Building a netboot image), and over the Internet (via the boot parameter fetch=URL, see Webbooting).

Live medium: As distinct from live system, the live medium refers to the CD, DVD or USB stick where the binary produced by live-build and used to boot the live system is written. More broadly, the term also refers to any place where this binary resides for the purposes of booting the live system, such as the location for the network boot files.

stable/testing/unstable: The stable distribution, currently codenamed wheezy, contains the latest officially released distribution of Debian. The testing distribution, temporarily codenamed jessie, 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, permanently codenamed sid, is where active development of Debian occurs. Generally, this distribution is run by developers and those who like to live on the edge. Throughout the manual, we tend to use codenames for the releases, such as jessie or sid, as that is what is supported by the tools themselves.

This manual is intended as a community project and all proposals for improvements and contributions are extremely welcome. Please see the section Contributing to the project for detailed information on how to fetch the commit key and make good commits.

In order to make changes to the English manual you have to edit the right files in manual/en/ but prior to the submission of your contribution, please preview your work. To preview the live-manual, ensure the packages needed for building it are installed by executing:

Since it takes a while to build the manual in all supported languages, authors may find it convenient to use one of the fast proofing shortcuts when reviewing the new documentation they have added to the English manual. Using PROOF=1 builds live-manual in html format, but without the segmented html files, and using PROOF=2 builds live-manual in pdf format, but only the A4 and letter portraits. That is why using either of the PROOF= possibilities can save up a considerable amount of time, e.g:

After revising your work and making sure that everything is fine, do not use make commit unless you are updating translations in the commit, and in that case, do not mix changes to the English manual and translations in the same commit, but use separate commits for each. See the Translation section for more details.

Translate the about_manual.ssi.pot, about_project.ssi.pot and index.html.in.pot files in manual/pot/ to your language with your favourite editor (such as poedit) and send the translated .po files to the mailing list to check their integrity. live-manual' s integrity check not only ensures that the .po files are 100% translated but it also detects possible errors.

Once checked, to enable a new language in the autobuild it is enough to add the initial translated files to manual/po/${LANGUAGE}/ and run make commit. And then, edit manual/_sisu/home/index.html adding the name of the language and its name in English between brackets.

Do not forget that you need to run make commit to ensure that the translated manuals are updated from the .po files and then you can review your changes launching make build before git add ., git commit -m "Translating..." and git push. Remember that since make build can take a considerable amount of time, you can proofread languages individually as explained in Applying changes

After running make commit you will see some text scroll by. These are basically informative messages about the processing status and also some hints about what can be done in order to improve live-manual. Unless you see a fatal error, you usually can proceed and submit your contribution.

live-manual comes with two utilities that can greatly help translators to find untranslated and changed strings. The first one is "make translate". It launches an script that tells you in detail how many untranslated strings there are in each .po file. The second one, the "make fixfuzzy" target, only acts upon changed strings but it helps you to find and fix them one by one.

Keep in mind that even though these utilities might be really helpful to do translation work on the command line, the use of an specialized tool like poedit is the recommended way to do the task. It is also a good idea to read the Debian localization (l10n) documentation and, specifically to live-manual, the Guidelines for translators.