Bug#701969: unblock: live-manual/1:3.0.1-1
Package: release.debian.org
Severity: normal
User: release.debian.org@packages.debian.org
Usertags: unblock
Please unblock package live-manual
The version in wheezy was at alpha stage of development. We have, at
long last, a final release which is the only supportable version for the
lifetime of wheezy.
I have attached a cleaned up diff which lists at the top the specific
cleanups performed to make review easier.
unblock live-manual/1:3.0.1-1
--
Address: Daniel Baumann, Donnerbuehlweg 3, CH-3012 Bern
Email: daniel.baumann@progress-technologies.net
Internet: http://people.progress-technologies.net/~daniel.baumann/
This is a diff 1:3.0~a13-1..1:3.0.1-1:
* without translation changes
diff -Naurp live-manual.orig/debian/changelog live-manual/debian/changelog
--- live-manual.orig/debian/changelog 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/debian/changelog 2013-03-01 10:03:10.416752408 +0100
@@ -1,3 +1,1020 @@
+live-manual (1:3.0.1-1) unstable; urgency=low
+
+ * Using ~/.ssh/keys rather than ~/.ssh/identity.d in ssh examples to not
+ imply that the used subdirectory is an automatically used conf.d
+ directory by ssh.
+ * Renaming live-manual-all metapackage to live-manual for proper
+ squeeze-to-wheezy upgrade.
+ * Making depends of live-manual versioned.
+
+ -- Daniel Baumann <daniel@debian.org> Thu, 21 Feb 2013 23:57:09 +0100
+
+live-manual (1:3.0.0-1) unstable; urgency=low
+
+ [ Daniel Baumann ]
+ * Synchronising syslinux for the final syslinux theme handling changes
+ in live-build.
+
+ [ chals ]
+ * Updating Catalan translation in respect to bootloader configuration.
+ * Updating Spanish translation in respect to bootloader configuration.
+ * Updating French translation in respect to bootloaders.
+
+ [ skizzhg ]
+ * Updating user_customization-binary, italian translation.
+
+ [ ndangi francis ]
+ * Improving the French translation of the term 'live medium'.
+
+ [ chals ]
+ * Fixing fuzzy dates.
+
+ [ Daniel Baumann ]
+ * Removing incomplete German, Brazilian Portuguese, and Romanian
+ translations for release.
+
+ -- Daniel Baumann <daniel@debian.org> Sun, 17 Feb 2013 18:14:30 +0100
+
+live-manual (1:3.0~b3-1) unstable; urgency=low
+
+ [ skizzhg ]
+ * Updating user_customization-packages, italian translation.
+
+ [ Ben Armstrong ]
+ * Adding 'live medium' term.
+ * Correcting singular 'medium' for 'media' where necessary.
+
+ [ Thomas Vincent ]
+ * Applying patches sent to the debian-l10n-french list, thanks to Thomas
+ Vincent <thomas@vinc-net.fr>.
+
+ [ chals ]
+ * Updating files under manual.
+
+ [ skizzhg ]
+ * Updating italian translation.
+
+ [ Daniel Baumann ]
+ * Dropping dpkg compression level.
+
+ [ chals ]
+ * Updating the dates in live-manual.
+ * Translating the definition of the term 'live medium' into Spanish.
+ * Translating the definition of the term 'live medium' into Catalan.
+ * Fixing one formatting error in the French translation.
+ * Using lowercase for codenames wheezy and sid, French translation.
+ * Specifying the use of lowercase when using code names in the style
+ guide.
+ * Updating appendix_style-guide files from the original English text.
+ * Fixing fuzzy strings in several files, Spanish translation.
+
+ [ skizzhg ]
+ * Updating about_manual, italian translation.
+
+ [ chals ]
+ * Fixing fuzzy strings in the Catalan translation.
+ * Fixing one typo in about_manual.ssi.
+ * Updating about_manual files from the English text.
+ * Fixing 'fuzzy', Catalan translation.
+ * Fixing 'fuzzy', Spanish translation.
+
+ [ skizzhg ]
+ * Updating italian translation.
+ * Deleting extraneous file (poo) added by mistake.
+ * Updating project_contributing, italian translation.
+ * Improving a sentence in user_customization-packages, italian
+ translation.
+ * Updating user_basics, italian translation.
+ * Nothing to do, just removing fuzzy about s/media/medium/, italian
+ translation.
+ * Updating user_customization-runtime, italian translation.
+ * Updating examples, italian translation.
+
+ [ chals ]
+ * Updating the dates in all languages.
+ * Fixing 'fuzzy' strings in the French translation.
+ * Translating the term 'live medium' into French.
+ * Unfuzzing dates in the translations.
+
+ -- Daniel Baumann <daniel@debian.org> Sat, 09 Feb 2013 00:38:33 +0100
+
+live-manual (1:3.0~b2-1) unstable; urgency=low
+
+ [ Daniel Baumann ]
+ * Adding build-conflicts to locales-all, as locales-all provides locales
+ but woudn't work with the current locales generation in rules.
+
+ [ Ben Armstrong ]
+ * Referencing and cross-referencing prebuilt images available for
+ download with configurations used to build them.
+ * Adding new section 'Using web live image builder'.
+ * Including non-free prebuilt image instructions as an example.
+ * Clarifying web builder operational status and invalid options caveat.
+ * Mentioning prebuilt images in front matter as a topic of particular
+ interest to end-users.
+ * Fixing proper English heading.
+ * Listing only architectures that we fully support.
+
+ [ Daniel Baumann ]
+ * Using overwritable variable definitions in toplevel makefile.
+ * Dropping example for #include functionality in package lists, this
+ feature is no longer useful since there are no global package lists
+ anymore.
+
+ [ Ben Armstrong ]
+ * Reordering closing remarks to end, as it segues better with rest of
+ manual (especially for external linkage to this section).
+
+ [ Daniel Baumann ]
+ * Adding build-depends to texlive-generic-recommended for pdf output.
+ * Sorting build-depends.
+ * Correcting seperators in top-level makefile.
+ * Prefixing appendix file with appendix prefix in its filename.
+ * Removing prefix user from examples filename.
+ * Adding references to live-tools in the list of terms.
+ * Dropping pre-squeeze notes about live-initramfs in live-boot and live-
+ config entries in the terms list.
+ * Updating build-depends listed for users contributing to live-manual.
+ * Using German as an example for how to build specific languages of the
+ manual.
+ * Slightly correcting a bit of grammar in the translations section.
+ * Slightly correcting a bit of grammar in the project section.
+ * Using same spelling for 'superuser' consistently.
+ * Tiding system requirements for the kernel version.
+ * Dropping aptitude example on how to install live-build, doesn't serve
+ any purpose.
+ * Dropping -rfakeroot from dpkg-buildpackage call, not needed anymore
+ since long, long time.
+ * Using plural when refering to live-boot and live-config sources in
+ installation section.
+ * Consistently using 'manpage' instead of 'man page' through the whole
+ manual.
+ * Some tiny nitpicking in user_basics.
+ * Use xorriso to burn image in example instructions rather than wodim.
+ * Including virtualbox-qt package in the example instruction to install
+ virtualbox, otherwise users end up with no graphical frontend.
+ * Extending virtualbox section about guest additions to include the dkms
+ package as well, just the x11 driver package without the module will
+ not be enough.
+ * Correcting lb clean command when switching to build a netboot image,
+ in netboot we'll have a different initrd configuration hence the
+ chroot stage needs to be rebuild too.
+ * Correcting outdated netboot binary type specification in example lb
+ config call.
+ * Mentioning that other network filesystems than NFS are available in
+ netboot section.
+ * Dropping xz suffix from default netboot tarball names, by default the
+ tarballs are not compressed anymore as it has no advantage except
+ longer build time anyway.
+ * Don't use the term magic in connection with live-build, it's not magic
+ after all.
+ * Dropping reference to a grub floppy image in the old svn repository we
+ don't use nor have anymore.
+ * Dropping section about manually creating files for pxe-booting VMware
+ Player, not needed anymore as it's supported there out of the box.
+ * Rewording sentence about comparing live-build to debhelper a bit.
+ * Updating example lb config call for netboot.
+ * Using Swiss debian mirror as example mirror.
+ * Using 8 spaces as tab indentiation in git config example.
+ * Dropping reference to no longer existing chroot_patches command.
+ * Also enabling non-free in example about how to use multiple archive
+ areas with lb config.
+ * Reword explenation about default mode.
+ * Correcting 'superseding' spelling typo.
+ * Correcting indenting of custom mirror example code.
+ * Harmonizing custom binary mirror example.
+ * Adding note about APT preferences files in config/archives.
+ * Dropping reference to obsolete include feature within package lists.
+ * Using same package list filename for the gnome-desktop list as in
+ live-images, for consistency.
+ * Using German task packages as example.
+ * Updating kernel pinning example from experimental to 3.7 package
+ names.
+ * Dropping requirement for custom kernels to have a suffix, it's not
+ required by live-build.
+ * Using same package list filename for the lxde-desktop list as in live-
+ images, for consistency.
+ * Dropping templates directory from config tree 'ascii-art picture' when
+ illustrating local includes.
+ * Updating suffix for preseed files in config/preseed.
+ * Correcting syntax error in user-setup configuration example for live-
+ config.
+ * Using 'filename' instead of 'file name'.
+ * Using a more general example for two different persistence labels.
+ * Correcting spelling of progress-linux.
+ * Correcting sed example code to set syslinux timeout.
+ * Updating a bunch of tiny issues in the debian-installer section.
+
+ [ Ben Armstrong ]
+ * Using less tortured sentence structure.
+
+ [ Daniel Baumann ]
+ * Reverting back to 'man page', 'manpage' apparently is no proper
+ english.
+ * Adding explenation why lb clean has to be used rather than lb clean
+ --binary in user_basics when switching to build a netboot image from
+ an existing build directory.
+ * Completing list of repositories with public writable branches.
+ * Dropping kernel version as a requirement for bug reports, this dates
+ back to when we had unionfs and squashfs as out-of-tree modules.
+ * Sorting list of requested information when people report bugs.
+ * Extending note about live-boot logfiles for live-config too.
+ * Correcting codying style guidelines.
+ * Advertise https git repositories before the http ones.
+ * Correcting git instructions to clone over ssh.
+ * Making use of the sample gitignore file shipped as example in live-
+ build in the tutorial where git is used for the config tree.
+ * Avoid using ugly underscores in example project directory for a vnc-
+ kiosk-client.
+ * Switching example for pt_BR kde to de_CH gnome.
+ * Correcting punctuation mark in section where users are requested to
+ read live-boot and live-config logfiles.
+ * Updating minimal image example with current size numbers and for
+ current live-build.
+ * Correcting some typos in the appendix style guide.
+ * Correcting two occurences of 'debian' in their spelling.
+ * Updating link to Gits homepage on toplevel html page.
+ * Consistently using final slash on URLs.
+ * Updating external link to syslinux documentation.
+ * Updating various dates for 2013.
+ * Generalize virtualization methods mentioned in bug reporting
+ guidelines, no point in enumerating them.
+ * Correcting my mispelling of 'exactly'.
+ * Updating sed call for wheezy in release announcement templates.
+ * Harmonizing German po file headers.
+ * Harmonizing Catalan po file headers.
+ * Harmonizing Spanish po file headers.
+ * Harmonizing French po file headers.
+ * Harmonizing Italian po file headers.
+ * Harmonizing Brazilian Portuguese po file headers.
+ * Harmonizing Romanian po file headers.
+ * Readding translator note to ignore appendix_style-guide for
+ translation.
+ * Regenerating po files.
+ * Using more natural name for the live-gnome-ch example directory
+ (rather than live-ch-gnome).
+ * Updating some Catalan fuzzy strings.
+ * Updating some German fuzzy strings.
+ * Updating some Spanish fuzzy strings.
+ * Correcting freudian typo where live-build was ment, not lb build.
+ * Updating some French fuzzy strings.
+ * Marking accidentally unfuzzied incompletely updated string about
+ logfiles in /var/log/live/ as fuzzy again.
+ * Correcting accidentally wrong virtualbox package name in my previous
+ translation updates.
+ * Updating some Italian fuzzy strings.
+ * Adding chals to uploaders.
+ * Dropping reference to live-debconfig for now, it's 4.x/jessie stuff.
+ * Dropping old reference to live-helper and live-package.
+ * Updating German live-manual translation.
+ * Updating a few more German strings in about_manual.
+ * Updating toplevel index page for new log and trace file locations.
+ * Removing spurious Romanian left-overs in toplevel index page.
+ * Using dynamic interval inserted by cronjob into the toplevel index
+ page.
+
+ [ chals ]
+ * Fixing typo, performs.
+ * Adding formatting to xorriso, referred to as a debian package.
+ * Removing 'There are two solutions' since one of them was dropped and
+ therefore there is just one.
+ * Adding formatting to the word 'isolinux' to look exactly like its
+ counterparts, etxlinux, pxelinux and syslinux.
+ * Adding comment to unfuzzy-dates.sh script.
+ * Changing line number in unfuzzy-dates.sh script.
+ * Removing plural forms from Spanish live-manual.ssm.po.
+ * Adding plural forms to French live-manual.ssm.po.
+ * Updating name of temporarily ignored po file output.
+ * Removing 'unfuzzy' from rebuild target so that it is not executed
+ automatically.
+ * Spreading the changes in several English texts to the remaining po
+ files.
+ * Updating dates in live-manual.ssm.* files.
+ * Updating Spanish translation.
+ * Updating Catalan translation.
+ * Improving Spanish translation.
+ * Updating French translation.
+ * Updating the Catalan translation of user_customization-packages and
+ user_managing_a_configuration.
+ * Fixing typo 'prefabricadas' in the Spanish translation.
+ * Updating the Spanish translation of user_customization-packages and
+ user_managing_a_configuration.
+ * Updating the dates in live-manual.* files.
+ * Correcting several errors in the Spanish translation.
+ * Updating the French translation substituting 'au moment' for 'pendant'
+ where necessary.
+ * Fixing some fuzzy strings in the Brazilian Portuguese translation.
+ * Fixing two fuzzy strings in the Romanian translation.
+ * Adding the removal of unused links to pdf files to debian/rules.
+
+ -- Daniel Baumann <daniel@debian.org> Sun, 06 Jan 2013 20:27:46 +0100
+
+live-manual (1:3.0~b1-1) unstable; urgency=low
+
+ [ chals ]
+ * Using a default image type again instead of an hdd one in the minimal
+ example now that xorriso allows to use the space left on devices.
+ * Adding more information about a possible use of the live-images
+ repository after cloning it.
+ * Revising the use of an hdd image type in user_basics, first step.
+ * Substituting 'standard' for 'default' where necessary.
+ * Substituting 'debian' for 'live' in user_customization-installer.
+ * Correcting the error in the previous change since it refers to the
+ regular debian installer.
+ * Changing the structure of user_basics.ssi simplifying hdd section to
+ only reflect the differences with iso-hybrid images.
+ * Updating po files from original sources.
+ * Updating dates in the translated manuals.
+ * Updating Spanish translation of several files.
+ * Updating Catalan translation of several files.
+ * Updating French translation of several files.
+ * Adding live-images to :italics: in live-manual.ssm.
+ * Modifying the 'Handling multiple repositories' section in
+ project_git.ssi.
+ * Adding link for more information from project_git.ssi to
+ user_managing_a_configuration.ssi.
+ * Updating po files from original texts.
+ * Updating live-manual.* files in the translations.
+ * Updating Catalan translation of project_git and
+ user_managing_a_configuration.
+ * Updating Spanish translation of project_git and
+ user_managing_a_configuration.
+ * Updating French translation of project_git and
+ user_managing_a_configuration.
+ * Substituting 'several' for 'multiple' in project_git.
+ * Substituting 'official' for 'prebuilt' in about_project.
+ * Updating po files from original English documents.
+ * Updating the dates in the translated manuals.
+ * Updating the Spanish translation of about_project, project_git and
+ user_examples.
+ * Updating the Catalan translation of about_project, project_git and
+ user_examples.
+ * Updating the French translation of about_project, project_git and
+ user_examples.
+ * Correcting several grammar mistakes in the French translation, thanks
+ to ndangi francis <francis_ndangi@yahoo.fr>.
+ * Changing several expressions in the French translation of
+ about_manual, thanks to ndangi francis <francis_ndangi@yahoo.fr>.
+ * General revision of French translation including, among other things,
+ spelling, syntax, formatting errors, grammar....
+ * Updating the translation of one string in about_project, Spanish
+ translation.
+
+ -- Daniel Baumann <daniel@debian.org> Sun, 30 Dec 2012 16:25:18 +0100
+
+live-manual (1:3.0~a20-1) unstable; urgency=low
+
+ [ Daniel Baumann ]
+ * Using section metapackages for live-manual-all metapackage.
+
+ [ Ben Armstrong ]
+ * Clarifying further pinning priorities.
+
+ [ chals ]
+ * Removing dot at the end of email address of mailing list.
+ * Clarifying the convenience of creating a build directory as a first
+ step.
+ * Adding /lib and /lib/live to list of unsupported paths by the
+ persistence.conf file.
+ * Adding a way to achieve full persistence.
+ * Fixing formatting error caused by an incorrect use of code tags.
+ * Changing 'its' for 'their' to correct grammar.
+
+ [ Daniel Baumann ]
+ * Updating configuration management to reflect introduction of the live-
+ images package.
+ * Removing Chris from uploaders, he's been now inactive on live-manual
+ for a while.
+
+ [ chals ]
+ * Updating po files from the original English ones.
+ * Updating dates in the live-manual.ssm files of the translations.
+ * Updating the Spanish translation of several files.
+ * Updating the Catalan translation of several files.
+ * Updating the French translation of several files.
+ * General revision of the Spanish translation including, among other
+ minor things, spelling, grammar and syntax.
+ * Updating the dates in all live-manual.ssm files.
+ * Fixing chapter mismatch in the Catalan, French and Spanish
+ translations.
+ * General revision of the Catalan translation, including spelling,
+ vocabulary, grammar, syntax and two formatting errors.
+
+ -- Daniel Baumann <daniel@debian.org> Mon, 17 Dec 2012 21:30:17 +0100
+
+live-manual (1:3.0~a19-1) unstable; urgency=low
+
+ [ chals ]
+ * Reordering project_git.ssi to follow a more logical order:
+ repositories - branches.
+ * Spreading the reordering changes in project_git.ssi to the po files.
+ * Updating the Catalan translation of several files and the dates in
+ live-manual.ssm.
+ * Updating the Spanish translation of several po files.
+ * Updating the French translation of several po files.
+
+ [ Daniel Baumann ]
+ * Updating config tree references for live-build 3.0~a66-1.
+
+ [ chals ]
+ * Updating user_customization-installer/packages po files and live-
+ manual.ssm dates.
+ * Updating Catalan translation of user_customization-installer/packages
+ and dates in live-manual.ssm.
+ * Updating Spanish translation of user_customization-installer/packages.
+ * Updating French translation of user_customization-installer/packages.
+ * Introducing cdebootstrap-options and debootstrap-options to create a
+ minimal system in the examples.
+ * Removing -a from the translation chapter, it is redundant after git
+ add ..
+ * Adding count=0 to dd command to create image files.
+
+ [ Ben Armstrong ]
+ * Replacing archaism 'whilst' with 'while'.
+
+ [ chals ]
+ * Editing the 'minimal' example to add an hdd image type and change the
+ cdebootstrap options for the debootstrap ones.
+ * Adding 'Handling multiple repositories' to project_git.ssi.
+ * Adding https cloning address to project_git.ssi.
+ * Revising the 'A base image for a 128MB USB key' example.
+ * Running make commit to start updating the translations.
+ * Updating the dates in live-manual.ssm.
+ * Updating the Spanish translation of several files.
+ * Updating the French translation of several files.
+ * Updating the Catalan translation of several files.
+ * Improving the French translation of the examples.
+ * Using the two letter code of all languages instead of echoing the
+ path.
+ * Adding single quotation marks to improve readability.
+ * Adding missing colon in the heading levels of project_coding-
+ style.ssi, project_git.ssi, project_bugs.ssi, project_procedures.ssi
+ and user_customization-binary.ssi.
+ * Editing about_manual.ssi to only leave live-manual specific
+ information.
+ * Adding more information to the translation section.
+ * Adding project_contributing.ssi to the project section.
+ * Adding 'The second one' to translation intructions.
+
+ [ Daniel Baumann ]
+ * Extending project_contributing.ssi with some more information.
+
+ [ chals ]
+ * Fixing a code tag in project_contributing.ssi.
+ * Renaming progress to progress-linux in user_customization-binary.ssi.
+ * Updating po files from English sources.
+ * Updating the Spanish translation of several files.
+ * Using synonym expressions for the word fuzzy.
+ * Spreading the changes in the original about_manual to all the po
+ files.
+ * Updating the Spanish translation of about_manual.ssi.po.
+ * Updating the Catalan translation of several files.
+ * Updating the French translation of several files.
+ * Improving the Spanish translation of about_manual and
+ project_contributing.
+ * Improving the Catalan translation of about_manual and
+ project_contributing.
+ * Improving the French translation of about_manual and
+ project_contributing.
+ * Removing redundant -a from instructions.
+ * Removing 'exit 1' from commit target.
+ * Removing redundant '-a' from the script.
+ * Adding 'rm -f manual/po/*/*~' to clean target.
+ * Adding 'manual/en/*~' to the gitignore file.
+ * Adding 'manual/po/*/*~' to the gitignore file.
+ * Adding fuzzy count to makefile.
+ * Updating the dates in live-manual.ssm*
+ * Fixing several 'fuzzy' strings in the German translation.
+ * Fixing several 'fuzzy' strings in the Brazilian Portuguese
+ translation.
+ * Fixing several 'fuzzy' strings in the Romanian translation.
+ * Fixing several 'fuzzy' strings in the Italian translation.
+ * Fixing one formatting error in the Italian translation.
+ * Fixing one formatting error in the Brazilian Portuguese translation.
+
+ [ Ben Armstrong ]
+ * Clarifying sid APT pinning stanza priorities relative to default
+ priority.
+ * Giving a better reason why stripped hook is not recommended over using
+ debootstrap for minimal system.
+
+ [ chals ]
+ * Updating po files from the original English version.
+ * Updating dates in all live-manual.ssm files.
+ * Updating the Catalan translation of user_customization-packages,
+ user_examples and about_manual.
+ * Updating the Spanish translation of user_customization-packages and
+ user_examples.
+ * Updating the French translation of user_customization-packages and
+ user_examples.
+
+ [ Daniel Baumann ]
+ * Updating example on how to configure default user groups for the live
+ user.
+
+ [ chals ]
+ * Updating po files from the English text.
+ * Updating the Catalan translation of user_customization-runtime and
+ user_examples.
+ * Updating the Spanish translation of user_customization-runtime.
+ * Updating the French translation of user_customization-runtime and
+ user_examples.
+ * Adding find-untranslated.sh to ease the task of dealing with
+ untranslated strings, thanks to skizzhg <skizzhg@gmx.com>.
+ * Renaming 'translate' target to 'fuzzy' in Makefile.
+ * Adding new 'translate' target to Makefile.
+ * Editing 'commit' target in Makefile to reflect the changes in the
+ 'fuzzy' and 'translate' ones.
+ * Editing the paragraph dealing with targets in about_manual.ssi.
+ * Clarifying that the use of an specialized tool is the recommended way
+ to do translation work.
+ * Adding link in the guidelines for translators in the style guide.
+ * Adding reading more documentation about translation guidelines in
+ about_manual.ssi.
+ * Updating po files from the original English version.
+ * Updating the dates of all live-manual.ssm files.
+ * Updating the Catalan translation of about_manual.ssi.po and
+ user_examples.ssi.po.
+ * Updating the Spanish translation of about_manual.ssi.po and
+ user_examples.ssi.po.
+ * Correcting one vocabulary mistake in the Catalan translation.
+ * Updating the French translation of about_manual.ssi.po.
+ * Adding po integrity check to test target in makefile.
+ * Renaming 'fuzzy' target to 'fixfuzzy' in makefile.
+ * Renaming message 'make fuzzy' to 'make fixfuzzy' in makefile.
+ * Renaming 'make fuzzy' to 'make fixfuzzy' in about_manual.ssi.
+ * Updating po files from English sources.
+ * Updating the dates of live-manual.ssm in the translations.
+ * Updating the Catalan translation of about_manual.ssi.po.
+ * Updating the Spanish translation of about_manual.ssi.po.
+ * Updating the French translation of about_manual.ssi.po.
+
+ [ Daniel Baumann ]
+ * Adding dpkg-source local options.
+ * Updating pinning example to use pref.d file in config/archives
+ alongside the sources.list.d snippet.
+
+ [ chals ]
+ * Updating po files from the original English text.
+ * Updating the dates all in live-manual.ssm.
+ * Updating Catalan translation of user_customization-packages.ssi.
+ * Updating Spanish translation of user_customization-packages.ssi.
+ * Updating French translation of user_customization-packages.ssi.
+
+ -- Daniel Baumann <daniel@debian.org> Fri, 30 Nov 2012 15:30:53 +0100
+
+live-manual (1:3.0~a18-1) unstable; urgency=low
+
+ [ chals ]
+ * Translating into French user_customization-packages and updating
+ project_procedures, kernels and volatile.
+
+ [ skizzhg ]
+ * Updating user_customization-runtime and user_examples, italian
+ translation.
+ * Adding forgotten string in user_customization-runtime. Updating
+ user_customization-binary and project_procedures, italian
+ translation.
+ * Adding several optional strings to avoid 'X untranslated messages'
+ message when using po-integrity-check.sh, italian translation.
+
+ [ chals ]
+ * Adding a section about the project's git repositories,
+ project_git.ssi, and adding myself to the list of authors.
+ * Adding a missing 'git clone' command to project_git.
+
+ [ Daniel Baumann ]
+ * Updating to standards version 3.9.4.
+ * Updating debian repository urls to use final slash consistently.
+ * Simplifying preseeding example for live packages.
+
+ [ chals ]
+ * Substituting cdn.debian.net for http.debian.net in
+ user_customization-packages.
+ * Removing unnecessary note about wildcards in package names after
+ adding live-* to the previous example.
+
+ [ Daniel Baumann ]
+ * Using the more common 'EOF' consistently as terminater when using
+ cat in examples, rather than custom 'END'.
+
+ [ chals ]
+ * Translating project_git.ssi.po into Catalan.
+ * Translating project_git.ssi.po into Spanish.
+ * Translating project_git.ssi.po into French.
+ * Updating Catalan translation fixing fuzzy strings in four files.
+ * Fixing a typo in the Catalan translation.
+ * Updating Spanish translation fixing fuzzy strings in four files.
+ * Updating French translation fixing fuzzy strings in four files.
+ * Fixing twenty two fuzzy strings in the German, Italian, Brazilian
+ Portuguese and Romanian translations.
+ * Fixing three missing spaces in the Italian translation and one colon
+ in the Brazilian Portuguese and the Romanian translations.
+
+ [ Daniel Baumann ]
+ * Updating point-release template.
+ * Removing outdated note about udeb uploads based on svn.
+ * Running po update.
+
+ [ skizzhg ]
+ * Updating about_manual and project_git, italian translation.
+
+ [ chals ]
+ * Updating Catalan translation of project_procedures.ssi.po.
+ * Updating Spanish translation of project_procedures.ssi.po.
+ * Updating French translation of project_procedures.ssi.po.
+
+ [ Daniel Baumann ]
+ * Updating package descriptions.
+ * Updating repository names for official configurations on
+ live.debian.net.
+ * Updating bootappend-live examples for newer live-build.
+
+ -- Daniel Baumann <daniel@debian.org> Sat, 06 Oct 2012 09:05:26 +0200
+
+live-manual (1:3.0~a17-1) unstable; urgency=low
+
+ [ skizzhg ]
+ * Updating user_customization-packages, italian translation.
+
+ [ chals ]
+ * Adding reference to config/bootloaders to add local configuration
+ files for syslinux.
+ * Updating 'ca', 'es' and 'fr' translations of user_customization-
+ binary, adding config/bootloaders.
+
+ [ Ben Armstrong ]
+ * Adding section on Kernel flavour and version.
+
+ [ Daniel Baumann ]
+ * Updating and extending section on kernel flavour and version a bit.
+
+ [ chals ]
+ * Translating kernel flavour and version into Spanish.
+ * Adding a missing # and translating stub in a more appropiate way,
+ Spanish translation.
+
+ [ Ben Armstrong ]
+ * Expanding and clarifying kernel section further, splitting custom
+ kernel into its own section.
+
+ [ Daniel Baumann ]
+ * Removing references to debian-volatile since that has been merged
+ into the debian archive itself.
+
+ [ chals ]
+ * Updating Spanish translation of user_customization-packages/binary
+ and project_procedures, kernels and volatile.
+ * Translating user_customization-packages and updating
+ project_procedures into Catalan, kernels and volatile.
+
+ [ Daniel Baumann ]
+ * Updating persistence documentation for live-persistence.conf to
+ persistence.conf change in live-boot.
+ * Updating old paths to hook examples in live-build.
+
+ -- Daniel Baumann <daniel@debian.org> Thu, 27 Sep 2012 12:55:02 +0200
+
+live-manual (1:3.0~a16-1) unstable; urgency=low
+
+ [ chals ]
+ * Updating Catalan translation of user_customization-packages.ssi.po,
+ dealing with recommends.
+ * Updating Spanish translation of user_customization-packages and
+ user_examples, dealing with recommends.
+ * Changing pt-latin1 for pt to make the example work without errors.
+ * Updating French translation of user_customization-packages and
+ user_examples and fixing some typos in 'ca' and 'es'.
+ * Translating user_customization-binary.ssi.po into Catalan, reaching
+ a 75% complete translation.
+
+ [ Bogdan A. Dragoiu ]
+ * Translating Romanian About this manual
+
+ [ Ben Armstrong ]
+ * Updating: virtualbox, dropping -ose suffix; live-build install
+ example version number.
+
+ [ chals ]
+ * Updating Spanish, French and Catalan translations, virtualbox-ose.
+ * Moving 'uniq' at the end of the pipe so that the script does not
+ believe that 'fuzzy' and 'fuzzy, no-wrap' belong to two different
+ files.
+ * Translating user_customization-installer into Catalan.
+ * Cleaning comments and headers in the po files for the 'ca', 'es' and
+ 'fr' translations.
+ * Translating user_examples.ssi.po into Catalan.
+ * Adding Bogdan Alexandru Dragoiu as translator of
+ ro/about_manual.ssi.po and cleaning po files headers and comments in
+ 'pt_BR', 'ro'and 'it'.
+ * Adding a short note for translators on the 'style guide' po files,
+ based on an idea by Ben Armstrong and skizzhg.
+ * Translating project_bugs.ssi.po into Catalan.
+ * Adding 'umount' command to the live-persistence.conf section, thanks
+ to Ben Armstrong.
+ * Changing 'gitosis' user for 'git' in pt_BR and ro.
+ * Updating 'ca', 'es', and 'fr' translations, umount command.
+ * Translating project_coding-style.ssi.po into Catalan.
+ * Translating project_procedures.ssi.po into Catalan, completing the
+ translation.
+ * Proofreading Catalan translation.
+
+ [ Willer Gomes Júnior ]
+ * Committing several translated files, Brazilian Portuguese
+ translation.
+
+ [ Willer Gomes Junior ]
+ * Translating and revising several .po files, Brazilian Portuguese
+ translation.
+ * Translating and revising several .po files into Brazilian
+ Portuguese.
+
+ [ chals ]
+ * Changing sed separatorsto follow the project's coding style and
+ clarifying the echoed message.
+ * Adding a space to improve readability.
+ * Preparing to rewrite the minimal system example with --debootstrap-
+ options getting rid of firmware-linux-free which is not true anymore
+ and adding continuity to a paragraph.
+ * Fixing formatting and making some other minor clarifications.
+ * Updating 'ca', 'fr' and 'es' translations of minor formatting fixes
+ and clarifications.
+ * Fixing 'fuzzy' in the date of the 'pt_BR' live-manual.ssm and
+ removing '-x' from the script.
+ * Using 'must' instead of 'can' in respect to the live-
+ persistence.conf file, thanks to Ed Dixon.
+ * Removing reference to 'package lists' from project_procedures and
+ fixing two typos.
+ * Removing unnecessary 'that' from project_coding-style.
+ * Updating 'ca', 'fr' and 'es' translations in respect to the live-
+ persistence.conf file and several other typos and minor changes.
+ * Adapting the dates in ca/live-manual.ssm.po and it/live-
+ manual.ssm.po to work with the update-version.sh script; they didn't
+ match the regular expression because they were added later.
+
+ [ skizzhg ]
+ * Updating about_manual, italian translation.
+ * Updating project_coding-style, project_procedures, user_basics,
+ user_installation, italian translation.
+ * Adding a missing \n in user_managing_a_configuration, spanish
+ translation.
+ * Updating user_managing_a_configuration, user_overview, italian
+ translation.
+
+ [ chals ]
+ * Clarifying the use of the live-persistence.conf file and adding an
+ example of how to use an image file for persistence.
+ * Editing the changes to the persistence section, thanks to Ben
+ Armstrong.
+ * Rereading the persistence image file use example clarifying that it
+ is just an example.
+ * Updating Catalan translation, persistence.
+ * Updating Spanish translation, persistence.
+ * Updating French translation, persistence.
+
+ [ Ben Armstrong ]
+ * Expanding passing options to apt/aptitude section.
+
+ [ chals ]
+ * Updating Catalan and Spanish translations, apt/aptitude options.
+ * Updating French translation, apt/aptitude options.
+ * Fixing 'dd' code block for image files and slightly rewriting the
+ example in a step by step approach.
+ * Updating 'ca', 'es' and 'fr' translations, persistence.
+
+ [ skizzhg ]
+ * Updating project_bugs, italian translation.
+ * Updating user_customization-contents, italian translation.
+
+ -- Daniel Baumann <daniel@debian.org> Thu, 20 Sep 2012 14:24:13 +0200
+
+live-manual (1:3.0~a15-1) unstable; urgency=low
+
+ [ Ben Armstrong ]
+ * Renaming keyboard-variant to keyboard-variants, matching latest
+ live-config.
+
+ [ chals ]
+ * Updating Spanish and French translations to keyboard-variants.
+
+ [ Ben Armstrong ]
+ * Beginning change from predefined package lists to metapackages.
+
+ [ chals ]
+ * Updating Spanish translation of user_customization-packages.ssi.po.
+
+ [ Daniel Baumann ]
+ * Updating the internal list of strings that get automatically a
+ certain markup (like debian release codenames, debian packages
+ names, etc.).
+
+ [ chals ]
+ * Insisting on the fact that achieving a 100% translation is important
+ in respect to code blocks.
+ * Updating French translation of user_customization.ssi.po, after the
+ addition of metapackages.
+ * Updating Catalan translation of user_customization-packages.ssi.po,
+ after the addition of metapackages.
+
+ [ Ben Armstrong ]
+ * Updating apt pinning example to correct actual metapackage
+ dependencies.
+ * Rewriting introductory package list sections around metapackages
+ instead of predefined lists.
+
+ [ chals ]
+ * Updating translation of es/user_customization-packages.ssi (apt
+ pinning).
+ * Updating translation of fr/user_customization-packages.ssi (apt
+ pinning).
+ * Updating the translation of ca/user_customization-packages.ssi (apt
+ pinning).
+ * Fixing mismatch in the indexes of the Spanish and French manuals.
+
+ [ Ben Armstrong ]
+ * Explaining multiple lists, dropping includes and tasks, adding
+ generated lists.
+ * Fixing minor typo in Packages helper paragraph.
+
+ [ chals ]
+ * Updating Spanish translation of user_customization-packages
+ (multiple lists).
+ * Updating French translation of user_customization-packages (multiple
+ lists).
+ * Updating Catalan translation of user_customization-packages
+ (multiple lists).
+ * Translating user_customization-runtime.ssi.po into Catalan.
+ * Revising the now unsupported '-p|--package-lists' option providing
+ alternatives, thanks to Ben Armstrong for the hints.
+ * Copying minimal.chroot hook to config/hooks and thus making the
+ example work.
+ * Removing 'standard-x11 list' and explaining the lists a bit better.
+ * Removing '--includes none' from the minimal image example as it is
+ unsupported and was tested without that option.
+ * Providing a way to create a smaller image before the size
+ optimization warning in the examples.
+ * Proofreading project_bugs.
+ * Removing the binary includes section since they were dropped.
+
+ [ Ben Armstrong ]
+ * Rewriting 'Managing a configuration' for greater clarity and
+ introducing --config option.
+
+ [ chals ]
+ * Running 'make commit' to avoid conflicts and thus being able to
+ commit languages individually afterwards; there are too many changes
+ to cope with them all.
+
+ [ Ben Armstrong ]
+ * Fixing lb config --config examples: missing option.
+
+ [ chals ]
+ * Updating Catalan translation of user_managing a configuration, lb
+ config --config.
+
+ [ Ben Armstrong ]
+ * Clarifying section headings relating to auto scripts.
+
+ [ chals ]
+ * Removing 'echo' to improve readability.
+ * Updating Catalan translation of the headings of auto scritps.
+ * Starting work to complete the Spanish translation, adding missing
+ code blocks and updating user_customization-contents, project_bugs
+ and user_overview.
+ * Starting work to complete the French translation, adding missing
+ code blocks and updating user_customization-contents,
+ user_customization-packages and user_overview.
+ * Revising the French translation of project_bugs and fixing its
+ 'fuzzy' string.
+ * Completing the French translation with user_examples and
+ user_managing_a_configuration and revising po headers.
+ * Revising the headers in the Spanish po files that showed 'Catalan'
+ by an error.
+
+ [ Ben Armstrong ]
+ * Updating prerequisites: Linux 3.x included.
+ * Updating build live-boot and live-config from source to reflect best
+ practice for short-term testing.
+ * Clarifying example uses bash commands.
+
+ [ chals ]
+ * Completing the Spanish translation with
+ user_managing_a_configuration, user_installation and user_examples.
+ * Updating French translation of user_installation.
+ * Updating the Catalan translation of user_installation.ssi.po.
+ * Fixing one title in the Spanish translation and improving one string
+ in user_installation.ssi.po.
+
+ [ Ben Armstrong ]
+ * Clarifying --apt-recommends false has consequences for live-*
+ packages.
+ * Updating language tasks section and examples chapter to no longer
+ use task lists.
+
+ [ chals ]
+ * Re-adding packages left out by 'apt-recommends false' to make the
+ images work properly in the examples.
+
+ -- Daniel Baumann <daniel@debian.org> Fri, 10 Aug 2012 22:48:06 +0200
+
+live-manual (1:3.0~a14-1) unstable; urgency=low
+
+ [ chals ]
+ * Updating the passwd hook example to a four digit number.
+ * Renaming persistence-subtext to persistence-label.
+
+ [ Daniel Baumann ]
+ * Correcting my previous broken commit with an accidental cropped
+ live-manual po file for Italian and Spanish.
+ * Readding accidentally removed header in live-manual po file for
+ French.
+ * Adding Catalan to European date formats in automatic date
+ translation.
+
+ [ chals ]
+ * Updating translations of user_customization-runtime.ssi.
+ * Translating user_overview into Catalan.
+ * Fixing minor formatting error in about_manual.ssi.po, Romanian
+ translation.
+ * Translating user_managing_a_configuration.ssi.po into Catalan.
+ * Adding po integrity check and message in test target for occasional
+ use.
+ * Adding dummy info to the comments of several live-manual.ssm.po to
+ unify line numbers purposely.
+ * Adding unfuzzy target to automatically fix 'predictable' fuzzy
+ strings after building the manuals from the .po files.
+ * Revising ca/user_managing_a_configuration.ssi.po and ensuring
+ everything works as expected.
+
+ [ Ben Armstrong ]
+ * Adding missing 'lb config' step in tutorial 3 (thanks to Antz).
+
+ [ chals ]
+ * Updating French and Spanish translations of tutorial 3 in
+ user_examples.ssi.po.
+ * Adding newline to the Catalan date msgstr that prevented the update-
+ version.sh script from working correctly in that file.
+ * Fixing newlines globally to reach 100% 'good' po files, after
+ running a po integrity check.
+ * Adding 'set -e' now that all po files have been checked.
+ * Workaround for redundant test after set -e.
+ * Translating user_customization-overview.ssi.po into Catalan.
+
+ [ Ben Armstrong ]
+ * Updating and clarifying locale and keyboard configuration.
+
+ [ Daniel Baumann ]
+ * Updating name of the default netboot tarball.
+ * Correcting misformated heading in the German translation of
+ about_manual.
+ * Updating location of auto/* example scripts.
+
+ [ chals ]
+ * Translating user_customization-packages.ssi.po into Catalan.
+
+ [ Ben Armstrong ]
+ * Clarifying use of multiple keyboard-variant values, adding an
+ example.
+
+ [ chals ]
+ * Changing old 'Persistence Subtext' title to 'Using more than one
+ persistence store' thanks to Ben Armstrong.
+ * Prepending # sign to indicate that commands should be run as root
+ following the convention of live-manual.
+ * Updating Spanish translation of user_customization-runtime (locale
+ and language).
+ * Updating French translation of user_customization-runtime (locale
+ and language).
+ * Changing one left $ sign for # before 'tune2fs'.
+
+ [ Daniel Baumann ]
+ * Updating project_bugs page for wheezy.
+
+ [ chals ]
+ * Updating Spanish translation of project_bugs.
+ * Updating French translation of project_bugs.
+ * Translating user_customization-contents.ssi.po into Catalan.
+
+ [ Victor NiÈ?u ]
+ * Translated license information to Romanian
+
+ [ chals ]
+ * Adding Victor Nitu as translator of the file (ro/live-manual.ssm.po)
+ and adapting it for the unfuzzy target.
+
+ [ Victor NiÈ?u ]
+ * Replaced "licenÈ?Ä?" => "license" (and hopefully fixed the output)
+
+ [ Daniel Baumann ]
+ * Reverting German and Romanian translation of 'Debian Live Project'
+ in copyright notice, this really should be stay as-is.
+
+ [ chals ]
+ * Adding manual/po/*/*.mo to Makefile and .gitignore, suggestion to
+ add it to both places by Daniel Baumann.
+
+ -- Daniel Baumann <daniel@debian.org> Fri, 27 Jul 2012 18:53:12 +0200
+
live-manual (1:3.0~a13-1) unstable; urgency=low
[ chals ]
diff -Naurp live-manual.orig/debian/control live-manual/debian/control
--- live-manual.orig/debian/control 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/debian/control 2013-03-01 10:03:10.416752408 +0100
@@ -4,21 +4,28 @@ Priority: optional
Maintainer: Debian Live Project <debian-live@lists.debian.org>
Uploaders:
Ben Armstrong <synrg@sanctuary.nslug.ns.ca>,
- Daniel Baumann <daniel@debian.org>,
- Chris Lamb <lamby@debian.org>
+ Carlos Zuferri <chals@altorricon.com>,
+ Daniel Baumann <daniel@debian.org>
Build-Depends: debhelper (>= 9), ruby, ruby-nokogiri
-Build-Depends-Indep: locales, sisu-complete (>= 3), po4a
-Standards-Version: 3.9.3
+Build-Depends-Indep:
+ locales, po4a, sisu-complete (>= 3), texlive-generic-recommended
+Build-Conflicts: locales-all
+Standards-Version: 3.9.4
Homepage: http://live.debian.net/devel/live-manual/
Vcs-Browser: http://live.debian.net/gitweb/?p=live-manual.git
Vcs-Git: git://live.debian.net/git/live-manual.git
-Package: live-manual-all
+Package: live-manual
+Section: metapackages
Architecture: all
Depends:
- ${misc:Depends}, live-manual-epub, live-manual-html, live-manual-odf,
- live-manual-pdf, live-manual-txt
-Description: Debian Live - Documentation (metapackage)
+ ${misc:Depends}, live-manual-epub (>= ${source:Version}),
+ live-manual-html (>= ${source:Version}),
+ live-manual-odf (>= ${source:Version}), live-manual-pdf (>= ${source:Version}),
+ live-manual-txt (>= ${source:Version})
+Conflicts: live-manual-all
+Replaces: live-manual-all
+Description: Debian Live Documentation (metapackage)
live-manual contains the documentation for the Debian Live project.
.
This package is a metapackage depending on all available output formats.
@@ -27,7 +34,7 @@ Package: live-manual-epub
Architecture: all
Depends: ${misc:Depends}
Provides: live-manual
-Description: Debian Live - Documentation (epub)
+Description: Debian Live Documentation (epub)
live-manual contains the documentation for the Debian Live project.
.
This package contains the epub output.
@@ -36,7 +43,7 @@ Package: live-manual-html
Architecture: all
Depends: ${misc:Depends}
Provides: live-manual
-Description: Debian Live - Documentation (html)
+Description: Debian Live Documentation (html)
live-manual contains the documentation for the Debian Live project.
.
This package contains the html output.
@@ -45,7 +52,7 @@ Package: live-manual-odf
Architecture: all
Depends: ${misc:Depends}
Provides: live-manual
-Description: Debian Live - Documentation (odf)
+Description: Debian Live Documentation (odf)
live-manual contains the documentation for the Debian Live project.
.
This package contains the odf output.
@@ -54,7 +61,7 @@ Package: live-manual-pdf
Architecture: all
Depends: ${misc:Depends}
Provides: live-manual
-Description: Debian Live - Documentation (pdf)
+Description: Debian Live Documentation (pdf)
live-manual contains the documentation for the Debian Live project.
.
This package contains the pdf output.
@@ -63,7 +70,7 @@ Package: live-manual-txt
Architecture: all
Depends: ${misc:Depends}
Provides: live-manual
-Description: Debian Live - Documentation (txt)
+Description: Debian Live Documentation (txt)
live-manual contains the documentation for the Debian Live project.
.
This package contains the txt output.
diff -Naurp live-manual.orig/debian/copyright live-manual/debian/copyright
--- live-manual.orig/debian/copyright 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/debian/copyright 2013-02-22 00:00:49.994212707 +0100
@@ -4,7 +4,7 @@ Upstream-Contact: Debian Live Project <d
Source: http://live.debian.net/archive/packages/live-manual/
Files: *
-Copyright: 2006-2012 Debian Live Project <debian-live@lists.debian.org>
+Copyright: 2006-2013 Debian Live Project <debian-live@lists.debian.org>
License: GPL-3+
License: GPL-3+
diff -Naurp live-manual.orig/debian/live-manual-all.bug-presubj live-manual/debian/live-manual-all.bug-presubj
--- live-manual.orig/debian/live-manual-all.bug-presubj 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/debian/live-manual-all.bug-presubj 1970-01-01 01:00:00.000000000 +0100
@@ -1,14 +0,0 @@
-live-manual is under heavy construction. The offline copy is likely to
-be a bit outdated.
-
-Before submitting a bug report against live-manual, please make sure
-that you have checked with the online version:
-
- http://live.debian.net/manual/
-
-Also, please consider fixing things directly by contributing to the
-manual. The git repository is world writable, see:
-
- http://live.debian.net/manual/html/meta.html#contributing
-
-for instructions.
diff -Naurp live-manual.orig/debian/live-manual.bug-presubj live-manual/debian/live-manual.bug-presubj
--- live-manual.orig/debian/live-manual.bug-presubj 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/debian/live-manual.bug-presubj 2013-02-22 00:00:49.994212707 +0100
@@ -0,0 +1,14 @@
+live-manual is under heavy construction. The offline copy is likely to
+be a bit outdated.
+
+Before submitting a bug report against live-manual, please make sure
+that you have checked with the online version:
+
+ http://live.debian.net/manual/
+
+Also, please consider fixing things directly by contributing to the
+manual. The git repository is world writable, see:
+
+ http://live.debian.net/manual/html/meta.html#contributing
+
+for instructions.
diff -Naurp live-manual.orig/debian/rules live-manual/debian/rules
--- live-manual.orig/debian/rules 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/debian/rules 2013-02-22 00:00:49.994212707 +0100
@@ -20,9 +20,11 @@ override_dh_auto_install:
# Removing useless files
rm -f debian/tmp/usr/share/doc/live-manual/COPYING
rm -f debian/tmp/usr/share/doc/live-manual/_sisu/image/.empty
+ rm -f debian/tmp/usr/share/doc/live-manual/pdf/live-manual.landscape.pdf
+ rm -f debian/tmp/usr/share/doc/live-manual/pdf/live-manual.portrait.pdf
override_dh_builddeb:
- dh_builddeb -- -Zxz -z9
+ dh_builddeb -- -Zxz
override_dh_compress:
dh_compress -X.html -X.odt
diff -Naurp live-manual.orig/debian/source/local-options live-manual/debian/source/local-options
--- live-manual.orig/debian/source/local-options 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/debian/source/local-options 2013-02-22 00:00:49.994212707 +0100
@@ -0,0 +1 @@
+abort-on-upstream-changes
diff -Naurp live-manual.orig/debian/source/options live-manual/debian/source/options
--- live-manual.orig/debian/source/options 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/debian/source/options 2013-02-22 00:00:49.994212707 +0100
@@ -1,2 +1 @@
compression = xz
-compression-level = 9
diff -Naurp live-manual.orig/.gitignore live-manual/.gitignore
--- live-manual.orig/.gitignore 2013-03-01 10:03:32.123892224 +0100
+++ live-manual/.gitignore 2013-02-22 00:00:49.990212873 +0100
@@ -1,2 +1,5 @@
build/
+manual/en/*~
+manual/po/*/*~
+manual/po/*/*.mo
diff -Naurp live-manual.orig/Makefile live-manual/Makefile
--- live-manual.orig/Makefile 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/Makefile 2013-03-01 10:03:10.416752408 +0100
@@ -1,7 +1,7 @@
# Makefile
## live-manual(7) - Documentation
-## Copyright (C) 2006-2012 Debian Live Project <debian-live@lists.debian.org>
+## Copyright (C) 2006-2013 Debian Live Project <debian-live@lists.debian.org>
##
## live-manual comes with ABSOLUTELY NO WARRANTY; for details see COPYING.
## This is free software, and you are welcome to redistribute it
@@ -10,11 +10,11 @@
SHELL := sh -e
-LANGUAGES = en $(shell cd manual/po && ls)
+LANGUAGES := en ca es fr it
-FORMATS = epub html odf pdf txt
+FORMATS := epub html odf pdf txt
-DEBUG = 0
+DEBUG := 0
all: build
@@ -22,6 +22,12 @@ test:
@echo "Checking for syntax errors... [not implemented yet - FIXME]"
@echo "Checking for spelling errors... [not implemented yet - FIXME]"
+ @echo "Checking the integrity of po files..."
+ for POFILE in manual/po/*/*; \
+ do \
+ msgfmt --check --output-file=/dev/null $${POFILE}; \
+ done
+
tidy:
# Removing useless whitespaces at EOL
for FILE in manual/en/*.ssm manual/en/*.ssi; \
@@ -78,15 +84,16 @@ commit: tidy test
@if grep -qs fuzzy manual/po/*/*; \
then \
echo "" ; \
- echo "There are some fuzzy strings. You can run 'make translate' to fix them." ; \
- exit 1 ; \
+ echo "There are $(shell grep -w 'fuzzy' manual/po/*/* | wc -l) fuzzy strings. You can run 'make fixfuzzy' to fix them." ; \
fi
+ @echo
+ @echo "In order to find untranslated strings type 'make translate'."
@echo
@echo "You may now proceed...please do:"
@echo
@echo " * git add ."
- @echo " * git commit -a -m \"Your commit message.\""
+ @echo " * git commit -m \"Your commit message.\""
@echo " * git push "
install:
@@ -103,16 +110,24 @@ uninstall:
clean:
rm -rf build
rm -f manual/en/*~
+ rm -f manual/po/*/*~
+ rm -f manual/po/*/*.mo
distclean: clean
rm -rf build
rebuild: distclean build
-translate:
+fixfuzzy:
@if grep -qs fuzzy manual/po/*/*; \
then \
./manual/bin/find-fuzzy.sh ; \
else \
echo "There are no fuzzy strings to translate." ; \
fi
+
+check:
+ @./manual/bin/po-integrity-check.sh
+
+translate:
+ @./manual/bin/find-untranslated.sh
diff -Naurp live-manual.orig/manual/bin/find-fuzzy.sh live-manual/manual/bin/find-fuzzy.sh
--- live-manual.orig/manual/bin/find-fuzzy.sh 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/manual/bin/find-fuzzy.sh 2013-02-22 00:00:49.994212707 +0100
@@ -26,7 +26,7 @@ Find_fuzzy ()
echo "You may now proceed... please do:"
echo ""
echo " * git add ."
- echo " * git commit -a -m \"Your commit message.\""
+ echo " * git commit -m \"Your commit message.\""
echo " * git push "
echo ""
@@ -41,7 +41,7 @@ Find_fuzzy ()
case "$OPENEDITOR" in
y*|Y*)
- $EDITOR $(grep -w 'fuzzy' manual/po/$ANSWER/* | uniq | sed 's|:#, fuzzy.*||')
+ $EDITOR $(grep -w 'fuzzy' manual/po/$ANSWER/* | sed 's|:#, fuzzy.*||' | uniq)
;;
n*|N*)
@@ -81,7 +81,7 @@ case "$ANSWER" in
case "$OPENEDITOR" in
y*|Y*)
- $EDITOR $(grep -w 'fuzzy' manual/po/*/* | uniq | sed 's|:#, fuzzy.*||')
+ $EDITOR $(grep -w 'fuzzy' manual/po/*/* | sed 's|:#, fuzzy.*||' | uniq)
;;
n*|N*)
diff -Naurp live-manual.orig/manual/bin/find-untranslated.sh live-manual/manual/bin/find-untranslated.sh
--- live-manual.orig/manual/bin/find-untranslated.sh 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/manual/bin/find-untranslated.sh 2013-02-22 00:00:49.994212707 +0100
@@ -0,0 +1,197 @@
+#!/bin/sh
+
+set -e
+
+# Script to assist translators in finding and fixing untranslated strings in live-manual.
+
+# First, we prepare to count the total number of untranslated strings.
+
+Count_untranslated_strings ()
+{
+for POFILE in manual/po/*/*
+ do
+ if [ "$(sed '$!d' ${POFILE})" = 'msgstr ""' ]
+ then
+ sed '$G' ${POFILE} | grep --extended-regexp --before-context=1 '^$' | grep --count '^msgstr ""$' || continue
+ else
+ grep --extended-regexp --before-context=1 '^$' ${POFILE} | grep --count '^msgstr ""$' || continue
+ fi
+ done
+}
+
+# Then, if there is not any untranslated string the script exits.
+
+Check_untranslated_strings ()
+{
+if [ "$(Count_untranslated_strings | awk '{ sum += $1 } END { print sum }')" -eq "0" ]
+ then
+ echo "There are 0 untranslated strings."
+ exit 0
+fi
+}
+
+Check_untranslated_strings
+
+# Creating other functions.
+
+# An untranslated string is an empty 'msgstr ""' followed by a blank line. We
+# grep blank lines and ensure that the previous line only contains 'msgstr ""'.
+#
+# If the last string in a po file is not translated, there is no blank line at
+# the end so we need to add one with "sed '$G''".
+#
+# The output of the style_guide.ssi.po is suppressed for the time being since it
+# is not translated into any of the languages.
+
+IGNORED="appendix_style-guide.ssi.po"
+
+Find_untranslated ()
+{
+echo "Searching for 'untranslated strings'..."
+echo ""
+
+for POFILE in manual/po/"${LANGUAGE}"/*
+ do
+ echo "Untranslated strings in ${POFILE}"
+
+ if [ "$(sed '$!d' ${POFILE})" = 'msgstr ""' ]
+ then
+ sed '$G' ${POFILE} | grep --extended-regexp --before-context=1 '^$' | grep --count '^msgstr ""$' || continue
+ else
+ grep --extended-regexp --before-context=1 '^$' ${POFILE} | grep --count '^msgstr ""$' || continue
+ fi
+ done
+
+echo ""
+echo "NOTE: The output of ${IGNORED} will be ignored for the time being."
+echo ""
+}
+
+# Showing *only* untranslated strings:
+# pros: finer granularity, easier to read...
+# cons: Some languages with accents and other similar stuff may greatly benefit
+# from a quick glance at the translated strings, too. And then some...
+#
+# If there is not any untranslated string in the selected language, then exit.
+
+Show_strings ()
+{
+if [ "$(Find_untranslated | awk '{ sum += $1 } END { print sum }')" -eq "0" ]
+ then
+ echo ""
+ echo "There are 0 untranslated strings in your language."
+ echo ""
+
+ exit 0
+fi
+
+echo ""
+echo "Do you want to see the $(Find_untranslated | awk '{ sum += $1 } END { print sum }') strings before starting work? [yes/no] ['q' to quit]"
+
+POFILES="$(Find_untranslated | grep --invert-match ${IGNORED} | grep --extended-regexp --before-context=1 '[1-9]'| sed -e 's|Untranslated strings in ||' -e 's|--||' -e 's|[0-9]*||g')"
+
+read ANSWER
+case "${ANSWER}" in
+ y*|Y*)
+ for POFILE in ${POFILES}
+ do
+ echo ""
+ echo "Untranslated strings in $(basename ${POFILE})" | grep --color $(basename ${POFILE})
+ echo ""
+
+ msggrep --invert-match --msgstr --regexp='' ${POFILE}
+ done
+
+ Open_editor
+ ;;
+
+ n*|N*)
+ Open_editor
+ ;;
+
+ q)
+ exit 0
+ ;;
+
+ *)
+ echo "You didn't type 'yes'. Exiting..."
+ exit 0
+ ;;
+esac
+}
+
+# Searches untranslated strings and offers to open editor to fix them.
+#
+# Editor defaults to vim unless otherwise specified in the environment.
+
+EDITOR="${EDITOR:-vim}"
+
+Open_editor ()
+{
+echo ""
+echo "Do you want to launch your text editor to start fixing them? [yes/no] ['q' to quit]"
+
+POFILESTOEDIT="$(Find_untranslated | grep --invert-match ${IGNORED} | grep --extended-regexp --before-context=1 '[1-9]'| sed -e 's|Untranslated strings in ||' -e 's|--||' -e 's|[0-9]*||g')"
+
+read OPENEDITOR
+
+case "$OPENEDITOR" in
+ y*|Y*)
+ if [ -z "${POFILESTOEDIT}" ]
+ then
+ echo "No po files to edit."
+ exit 0
+ else
+ ${EDITOR} ${POFILESTOEDIT}
+ fi
+ ;;
+
+ n*|N*)
+ echo "You typed 'no'. Exiting..."
+ exit 0
+ ;;
+
+ q)
+ exit 0
+ ;;
+
+ *)
+ echo "You didn't type 'yes'. Exiting..."
+ exit 0
+ ;;
+esac
+}
+
+# Main menu.
+
+echo "Counting untranslated strings...please wait..."
+echo ""
+echo "There are $(Count_untranslated_strings | awk '{ sum += $1 } END { print sum }') untranslated strings in live-manual."
+echo "This script can help you find and fix them. What is your language?."
+echo "Type: $(ls -C manual/po) ['a' to see all]['q' to quit]"
+
+read LANGUAGE
+case "$LANGUAGE" in
+
+ ca|de|es|fr|it|pt_BR|ro)
+ Find_untranslated
+ Show_strings
+ ;;
+
+ en)
+ echo "Nothing to be done, really."
+ echo "Translation English-English not implemented yet!"
+ ;;
+
+ a)
+ echo "[Not implemented yet]"
+ # FIXME
+ ;;
+
+ q)
+ exit 0
+ ;;
+
+ *)
+ echo "No language chosen. Exiting..."
+esac
diff -Naurp live-manual.orig/manual/bin/po-integrity-check.sh live-manual/manual/bin/po-integrity-check.sh
--- live-manual.orig/manual/bin/po-integrity-check.sh 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/manual/bin/po-integrity-check.sh 2013-02-22 00:00:49.994212707 +0100
@@ -0,0 +1,71 @@
+#!/bin/sh
+
+set -e
+
+# Script to help translators to check the integrity of po files in live-manual.
+#
+# 'msgfmt' performs several checks and outputs some common errors:
+#
+# - Checks format
+# - Checks header
+# - ...
+#
+# We do not want to compile a .mo file so we use /dev/null.
+#
+
+echo ""
+echo "This script can help you check the integrity of po files."
+echo "Select: $(ls -C manual/po) ['a' to see all] ['q' to quit] "
+
+# Creating function
+
+Integrity_check()
+{
+ echo "Checking the integrity of $(ls manual/po/${LANGUAGE}/* | wc -l) po files in ${LANGUAGE}."
+ echo ""
+ for POFILE in manual/po/${LANGUAGE}/*
+ do
+ echo "-$(basename ${POFILE})"
+ msgfmt --verbose --check --output-file=/dev/null ${POFILE} || { echo "-> This .po file might be 'BAD'. Please revise it."; echo ""; exit 1; }
+ if [ "$?" -eq "0" ]
+ then
+ echo "-> This .po file is 'GOOD'."
+ echo ""
+ fi
+ done
+}
+
+# Menu.
+
+read LANGUAGE
+
+case "$LANGUAGE" in
+ en) echo "Nothing to be done, really!"
+ ;;
+
+ ca|de|es|fr|it|pt_BR|ro)
+ Integrity_check
+ ;;
+
+ a) for LANGUAGE in manual/po/*
+ do
+ for POFILE in ${LANGUAGE}/*
+ do
+ echo "-Checking the integrity of '$(basename ${POFILE})' in '$(basename ${LANGUAGE})'"
+ msgfmt --verbose --check --output-file=/dev/null ${POFILE} || { echo "-> This .po file might be 'BAD'. Please revise it."; echo ""; exit 1; }
+ if [ "$?" -eq "0" ]
+ then
+ echo "->This .po file is 'GOOD'."
+ echo ""
+ fi
+ done
+ done
+ ;;
+
+ q) exit 0
+ ;;
+
+ *) echo "No language chosen. Exiting..."
+ ;;
+
+esac
diff -Naurp live-manual.orig/manual/bin/unfuzzy-dates.sh live-manual/manual/bin/unfuzzy-dates.sh
--- live-manual.orig/manual/bin/unfuzzy-dates.sh 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/manual/bin/unfuzzy-dates.sh 2013-02-22 00:00:49.994212707 +0100
@@ -0,0 +1,25 @@
+#!/bin/sh
+
+set -e
+
+# Script to automatically fix "predictable" fuzzy strings in live-manual. keep
+# in mind that if there is more than one fuzzy string in the po file the script
+# will not do anything since manual intervention is needed anyway.
+#
+# 'XY' is the start line number of the fuzzy strings in the dates.
+
+XY="47"
+
+# Getting the unfuzzying done.
+
+echo "Fixing 'fuzzy' in date strings if necessary..."
+
+for LANGUAGE in $(ls po)
+do
+ if [ "$(grep --line-number --word-regexp 'fuzzy' po/${LANGUAGE}/live-manual.ssm.po | sed 's|[^0-9]*||g')" -eq "${XY}" ] > /dev/null 2>&1
+ then
+ sed -i -e "${XY} s|#, fuzzy, no-wrap|#, no-wrap|" \
+ -e "$((${XY} + 1)),$((${XY} + 3))d" \
+ po/${LANGUAGE}/live-manual.ssm.po
+ fi
+done
diff -Naurp live-manual.orig/manual/bin/update-version.sh live-manual/manual/bin/update-version.sh
--- live-manual.orig/manual/bin/update-version.sh 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/manual/bin/update-version.sh 2013-02-22 00:00:49.994212707 +0100
@@ -14,7 +14,7 @@ sed -i -e "s|^ :published:.*$| :publish
en/live-manual.ssm
# European date format
-for _LANGUAGE in de es fr it ro
+for _LANGUAGE in ca de es fr it ro
do
if [ -e po/${_LANGUAGE}/live-manual.ssm.po ]
then
diff -Naurp live-manual.orig/manual/en/about_manual.ssi live-manual/manual/en/about_manual.ssi
--- live-manual.orig/manual/en/about_manual.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/about_manual.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -4,7 +4,7 @@
This manual serves as a single access point to all documentation related to the Debian Live project and in particular applies to the software produced by the project for the Debian 7.0 "wheezy" release. An up-to-date version can always be found at http://live.debian.net/
-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}#the-basics covers preparing images to be booted from media or the network, and {Customizing run time behaviours}#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.
+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}#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}#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.
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.
@@ -12,7 +12,7 @@ Some of the commands mentioned in the te
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 suggest reading in the following order.
-First, read this chapter, {About this manual}#about-manual, from the beginning and ending with the {Terms}#terms section. Next, skip to the three tutorials at the front of the {Examples}#examples section designed to teach you image building and customization basics. Read {Using the examples}#using-the-examples first, followed by {Tutorial 1: A standard image}#tutorial-1, {Tutorial 2: A web browser utility}#tutorial-2 and finally {Tutorial 3: A personalized image}#tutorial-3. By the end of these tutorials, you will have a taste of what can be done with Debian Live.
+First, read this chapter, {About this manual}#about-manual, from the beginning and ending with the {Terms}#terms section. Next, skip to the three tutorials at the front of the {Examples}#examples section designed to teach you image building and customization basics. Read {Using the examples}#using-the-examples first, followed by {Tutorial 1: A default image}#tutorial-1, {Tutorial 2: A web browser utility}#tutorial-2 and finally {Tutorial 3: A personalized image}#tutorial-3. 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}#the-basics, skimming or skipping {Building a netboot image}#building-netboot-image, and finishing by reading the {Customization overview}#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.
@@ -20,7 +20,9 @@ We encourage you to return to more in-de
_* *{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.
-_* *{Debian Live}*: The Debian sub-project which maintains the live-boot, live-build, live-config, and live-manual packages.
+_* *{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.
+
+_* *{Debian Live}*: The Debian sub-project which maintains, among others, the live-boot, live-build, live-config, live-tools and live-manual packages.
_* *{Debian Live system}*: A live system that uses software from the Debian operating system that may be booted from CDs, DVDs, USB sticks, over the network (via netboot images), and over the Internet (via boot parameter #{fetch=URL}#).
@@ -28,11 +30,13 @@ _* *{Host system}*: The environment used
_* *{Target system}*: The environment used to run the live system.
-_* *{live-boot}*: A collection of scripts used to boot live systems. live-boot was formerly a part of /{live-initramfs}/.
+_* *{live-boot}*: A collection of scripts used to boot live systems.
+
+_* *{live-build}*: A collection of scripts used to build customized Debian Live systems.
-_* *{live-build}*: A collection of scripts used to build customized Debian Live systems. live-build was formerly known as /{live-helper}/, and even earlier known as /{live-package}/.
+_* *{live-config}*: A collection of scripts used to configure a live system during the boot process.
-_* *{live-config}*: A collection of scripts used to configure a live system during the boot process. live-config was formerly a part of /{live-initramfs}/.
+_* *{live-tools}*: A collection of additional scripts used to perform useful tasks within a running live system.
_* *{live-manual}*: This document is maintained in a package called live-manual.
@@ -56,6 +60,8 @@ _* Ben Armstrong
_* Brendan Sleight
+_* Carlos Zuferri
+
_* Chris Lamb
_* Daniel Baumann
@@ -78,23 +84,15 @@ _* Trent W. Buck
2~how-to-contribute Contributing to this document
-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}#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:
-
-code{
-
-$ git clone git://live.debian.net/git/live-manual.git
+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}#contributing-to-project for detailed information on how to fetch the commit key and make good commits.
-}code
+3~ Applying changes
-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:
+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:
code{
- # apt-get install make po4a sisu-complete libnokogiri-ruby
+ # apt-get install make po4a ruby ruby-nokogiri sisu-complete texlive-generic-recommended
}code
@@ -126,68 +124,11 @@ Or combine both, e.g:
code{
- $ make build LANGUAGES=it FORMATS=html
-
-}code
-
-3~ Applying changes
-
-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:
-
-_* Fetch the public commit key:
-
-code{
-
- $ mkdir -p ~/.ssh/identity.d
- $ wget http://live.debian.net/other/keys/git@live.debian.net \
- -O ~/.ssh/identity.d/git@live.debian.net
- $ wget http://live.debian.net/other/keys/git@live.debian.net.pub \
- -O ~/.ssh/identity.d/git@live.debian.net.pub
- $ chmod 0600 ~/.ssh/identity.d/git@live.debian.net*
+ $ make build LANGUAGES=de FORMATS=html
}code
-_* Add the following section to your openssh-client config:
-
-code{
-
- $ cat >> ~/.ssh/config << EOF
- Host live.debian.net
- Hostname live.debian.net
- User git
- IdentityFile ~/.ssh/identity.d/git@live.debian.net
- EOF
-
-}code
-
-_* Check out a clone of the manual through ssh:
-
-code{
-
- $ git clone git@live.debian.net:/live-manual.git
- $ cd live-manual && git checkout debian-next
-
-}code
-
-_* Note that you should commit any changes on the debian-next branch, not on the debian branch.
-
-_* Do not use #{make commit}# unless you are updating translations in this 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}#translation section for more details.
-
-_* Write commit messages that consist of complete, meaningful sentences in English, starting with a capital letter and ending with a full stop. Usually, these will start with the form 'Fixing/Adding/Removing/Correcting/Translating', e.g.
-
-code{
-
- $ git commit -a -m "Adding a section on applying patches."
-
-}code
-
-_* Push the commit to the server:
-
-code{
-
- $ git push
-
-}code
+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}#translation section for more details.
3~translation Translation
@@ -199,6 +140,12 @@ _* To enable a new language in the autob
_* Once the new language is added, you can randomly continue translating the remaining po files in #{manual/po/}#.
-_* Don't forget you need #{make commit}# to ensure the translated manuals are updated from the po files and then you can review your changes launching #{make build}# before #{git add .}#, #{git commit -a -m "Translating..."}# and #{git push}#.
+_* Don't forget that you need #{make commit}# to ensure 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}#.
+
+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}#guidelines-translators.
*{Note:}* You can use #{make clean}# to clean your git tree before pushing. This step is not compulsory thanks to the .gitignore file but it is a good practice to avoid committing files involuntarily.
diff -Naurp live-manual.orig/manual/en/about_project.ssi live-manual/manual/en/about_project.ssi
--- live-manual.orig/manual/en/about_project.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/about_project.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -56,9 +56,7 @@ In this phase we will not ship or instal
Whenever we need a different default configuration, we will do that in coordination with its package maintainer in Debian.
-A system for configuring packages is provided using debconf allowing custom configured packages to be installed in your custom produced Debian Live images, but for official live images only default configuration will be used. For more information, please see {Customization overview}#customization-overview.
-
-Exception: There are a few essential changes needed to bring a live system to life. These essential changes have to be kept as minimal as possible and should be merged within the Debian repository if possible.
+A system for configuring packages is provided using debconf allowing custom configured packages to be installed in your custom produced Debian Live images, but for the {prebuilt live images}#downloading-prebuilt-images we choose to leave packages in their default configuration, unless absolutely necessary in order to work in the live environment. Wherever possible, we prefer to adapt packages within the Debian archive to work better in a live system versus making changes to the live toolchain or {prebuilt image configurations}#clone-configuration-via-git. For more information, please see {Customization overview}#customization-overview.
2~contact Contact
diff -Naurp live-manual.orig/manual/en/appendix_style-guide.ssi live-manual/manual/en/appendix_style-guide.ssi
--- live-manual.orig/manual/en/appendix_style-guide.ssi 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/manual/en/appendix_style-guide.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -0,0 +1,239 @@
+1~style-guide Style guide
+
+2~ Guidelines for authors
+
+This section deals with some general considerations to be taken into account when writing technical documentation for live-manual. They are divided into linguistic features and recommended procedures.
+
+*{Note:}* Authors should first read {Contributing to this document}#how-to-contribute
+
+3~ Linguistic features
+
+_* /{Use plain English}/
+
+Keep in mind that a high percentage of your readers are not native speakers. So as a general rule try to use short, meaningful sentences, followed by a full stop.
+
+This does not mean that you have to use a simplistic, naive style. It is a suggestion to try to avoid, as much as possible, complex subordinate sentences that make the text difficult to understand for non-native speakers.
+
+_* /{Variety of English}/
+
+The most widely spread varieties of English are British and American so it is very likely that most authors will use either one or the other. In a collaborative environment, the ideal variety would be "International English" but it is very difficult, not to say impossible, to decide on which variety among all the existing ones, is the best to use.
+
+We expect that different varieties may mix without creating misunderstandings but in general terms you should try to be coherent and before deciding on using British, American or any other English flavour at your discretion, please take a look at how other people write and try to imitate them.
+
+_* /{Be balanced}/
+
+Do not be biased. Avoid including references to ideologies completely unrelated to live-manual. Technical writing should be as neutral as possible. It is in the very nature of scientific writing.
+
+_* /{Be politically correct}/
+
+Try to avoid sexist language as much as possible. If you need to make references to the third person singular preferably use "they" rather than "he" or "she" or awkward inventions such as "s/he", "s(he)" and the like.
+
+_* /{Be concise}/
+
+Go straight to the point and do not wander around aimlessly. Give as much information as necessary but do not give more information than necessary, this is to say, do not explain unnecessary details. Your readers are intelligent. Presume some previous knowledge on their part.
+
+_* /{Minimize translation work}/
+
+Keep in mind that whatever you write will have to be translated into several other languages. This implies that a number of people will have to do an extra work if you add useless or redundant information.
+
+_* /{Be coherent}/
+
+As suggested before, it is almost impossible to standardize a collaborative document into a perfectly unified whole. However, every effort on your side to write in a coherent way with the rest of the authors will be appreciated.
+
+_* /{Be cohesive}/
+
+Use as many text-forming devices as necessary to make your text cohesive and unambiguous. (Text-forming devices are linguistic markers such as connectors).
+
+_* /{Be descriptive}/
+
+It is preferable to describe the point in one or several paragraphs than merely using a number of sentences in a typical "changelog" style. Describe it! Your readers will appreciate it.
+
+_* /{Dictionary}/
+
+Look up the meaning of words in a dictionary or encyclopedia if you do not know how to express certain concepts in English. But keep in mind that a dictionary can either be your best friend or can turn into your worst enemy if you do not know how to use it correctly.
+
+English has the largest vocabulary that exists (with over one million words). Many of these words are borrowings from other languages. When looking up the meaning of words in a bilingual dictionary the tendency of a non-native speaker is to choose the one that sounds more similar in their mother tongue. This often turns into an excessively formal discourse which does not sound quite natural in English.
+
+As a general rule, if a concept can be expressed using different synonyms, it is a good advice to choose the first word proposed by the dictionary. If in doubt, choosing words of Germanic origin (Usually monosyllabic words) is often the right thing to do. Be warned that these two techniques might produce a rather informal discourse but at least your choice of words will be of wide use and generally accepted.
+
+Using a dictionary of collocations is recommended. They are extremely helpful when it comes to know which words usually occur together.
+
+Again it is a good practice to learn from the work of others. Using a search engine to check how other authors use certain expressions may help a lot.
+
+_* /{False friends, idioms and other idiomatic expressions}/
+
+Watch out for false friends. No matter how proficient you are in a foreign language you cannot help falling from time to time in the trap of the so called "false friends", words that look similar in two languages but whose meanings or uses might be completely different.
+
+Try to avoid idioms as much as possible. "Idioms" are expressions that may convey a completely different meaning from what their individual words seem to mean. Sometimes, idioms are difficult to understand even for native speakers!
+
+_* /{Avoid slang, abbreviations, contractions...}/
+
+Even though you are encouraged to use plain, everyday English, technical writing belongs to the formal register of the language.
+
+Try to avoid slang, unusual abbreviations that are difficult to understand and above all contractions that try to imitate the spoken language. Not to mention typical irc and family friendly expressions.
+
+3~ Procedures
+
+_* /{Test before write}/
+
+It is important that authors test their examples before adding them to live-manual to ensure that everything works as described. Testing on a clean chroot or VM can be a good starting point. Besides, it would be ideal if the tests were then carried out on different machines with different hardware to spot possible problems that may arise.
+
+_* /{Examples}/
+
+When providing an example try to be as specific as you can. An example is, after all, just an example.
+
+It is often better to use a line that only applies to a specific case than using abstractions that may confuse your readers. In this case you can provide a brief explanation of the effects of the proposed example.
+
+There may be some exceptions when the example suggests using some potentially dangerous commands that, if misused, may cause data loss or other similar undesirable effects. In this case you should provide a thorough explanation of the possible side effects.
+
+_* /{External links}/
+
+Links to external sites should only be used when the information on those sites is crucial when it comes to understanding a special point. Even so, try to use links to external sites as sparsely as possible. Internet links are likely to change from time to time resulting in broken links and leaving your arguments in an incomplete state.
+
+Besides, people who read the manual offline will not have the chance to follow those links.
+
+_* /{Avoid branding and things that violate the license under which the manual is published}/
+
+Try to avoid branding as much as possible. Keep in mind that other downstream projects might make use of the documentation you write. So you are complicating things for them if you add certain specific material.
+
+live-manual is licensed under the GNU GPL. This has a number of implications that apply to the distribution of the material (of any kind, including copyrighted graphics or logos) that is published with it.
+
+_* /{Write a first draft, revise, edit, improve, redo if necessary}/
+
+ - Brainstorm!. You need to organize your ideas first in a logical sequence of events.
+
+ - Once you have somehow organized those ideas in your mind write a first draft.
+
+ - Revise grammar, syntax and spelling. Keep in mind that the proper names of the releases, such as wheezy or sid, should not be capitalized when referred to as code names.
+
+ - Improve your statements and redo any part if necessary.
+
+_* /{Chapters}/
+
+Use the conventional numbering system for chapters and subtitles. e.g. 1, 1.1, 1.1.1, 1.1.2 ... 1.2, 1.2.1, 1.2.2 ... 2, 2.1 ... and so on. See markup below.
+
+If you have to enumerate a series of steps or stages in your description, you can also use ordinal numbers: First, second, third ... or First, Then, After that, Finally ... Alternatively you can use bulleted items.
+
+_* /{Markup}/
+
+And last but not least, live-manual uses {SiSU}http://www.sisudoc.org/ to process the text files and produce a multiple format output. It is recommended to take a look at {SiSU's manual}http://www.sisudoc.org/sisu/sisu_manual/markup.html to get familiar with its markup, or else type:
+
+code{
+
+ $ sisu --help markup
+
+}code
+
+Here are some markup examples that may prove useful:
+
+ - For emphasis/bold text:
+
+code{
+
+*{foo}* or !{foo}!
+
+}code
+
+produces: *{foo}* or !{foo}!. Use it to emphasize certain key words.
+
+ - For italics:
+
+code{
+
+/{foo}/
+
+}code
+
+produces: /{foo}/. Use them e.g. for the names of Debian packages.
+
+ - For monospace:
+
+code{
+
+#{foo}#
+
+}code
+
+produces: #{foo}#. Use it e.g. for the names of commands. And also to highlight some key words or things like paths.
+
+ - For code blocks:
+
+code{
+
+ code{
+
+ $ foo
+ # bar
+
+ }code
+
+}code
+
+produces:
+
+code{
+
+ $ foo
+ # bar
+
+}code
+
+Use #{code{}# to open and #{}code}# to close the tags. It is important to remember to leave a space at the beginning of each line of code.
+
+2~guidelines-translators Guidelines for translators
+
+This section deals with some general considerations to be taken into account when translating the contents of live-manual.
+
+As a general recommendation, translators should have read and understood the translation rules that apply to their specific languages. Usually, translation groups and mailing lists provide information on how to produce translated work that complies with Debian quality standards.
+
+*{Note:}* Translators should also read {Contributing to this document}#how-to-contribute. In particular the section {Translation}#translation
+
+3~ Translation hints
+
+_* /{Comments}/
+
+The role of the translator is to convey as faithfully as possible the meaning of words, sentences, paragraphs and texts as written by the original authors into their target language.
+
+So they should refrain from adding personal comments or extra bits of information of their own. If they want to add a comment for other translators working on the same documents, they can leave it in the space reserved for that. That is, the header of the strings in the *{po}* files preceded by a number sign *{#}*. Most graphical translation programs can automatically handle those types of comments.
+
+_* /{TN, Translator's Note}/
+
+It is perfectly acceptable however, to include a word or an expression in brackets in the translated text if, and only if, that makes the meaning of a difficult word or expression clearer to the reader. Inside the brackets the translator should make evident that the addition was theirs using the abbreviation "TN" or "Translator's Note".
+
+_* /{Impersonal sentences}/
+
+Documents written in English make an extensive use of the impersonal form "you". In some other languages that do not share this characteristic, this might give the false impression that the original texts are directly addressing the reader when they are actually not doing so. Translators must be aware of that fact and reflect it in their language as accurately as possible.
+
+_* /{False friends}/
+
+The trap of "false friends" explained before especially applies to translators. Double check the meaning of suspicious false friends if in doubt.
+
+_* /{Markup}/
+
+Translators working initially with *{pot}* files and later on with *{po}* files will find many markup features in the strings. They can translate the text anyway, as long as it is translatable, but it is extremely important that they use exactly the same markup as the original English version.
+
+_* /{Code blocks}/
+
+Even though the code blocks are usually untranslatable, including them in the translation is the only way to score a 100% complete translation. And even though it means more work at first because it requires the intervention of the translators if the code changes, it is the best way, in the long run, to identify what has already been translated and what has not when checking the integrity of the .po files.
+
+_* /{Newlines}/
+
+The translated texts need to have the exact same newlines as the original texts. Be careful to press the "Enter" key or type *{\n}* if they appear in the original files. These newlines often appear, for instance, in the code blocks.
+
+Make no mistake, this does not mean that the translated text needs to have the same length as the English version. That is nearly impossible.
+
+_* /{Untranslatable strings}/
+
+Translators should never translate:
+
+ - The code names of releases (which should be written in lowercase)
+
+ - The names of programs
+
+ - The commands given as examples
+
+ - Metadata (often between colons *{:metadata:}*)
+
+ - Links
+
+ - Paths
diff -Naurp live-manual.orig/manual/en/examples.ssi live-manual/manual/en/examples.ssi
--- live-manual.orig/manual/en/examples.ssi 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/manual/en/examples.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -0,0 +1,325 @@
+:B~ Examples
+
+1~examples Examples
+
+This chapter covers example builds for specific use cases with Debian Live. If you are new to building your own Debian Live images, we recommend you first look at the three tutorials in sequence, as each one teaches new techniques that will help you use and understand the remaining examples.
+
+2~using-the-examples Using the examples
+
+To use these examples you need a system to build them on that meets the requirements listed in {Requirements}#requirements and has live-build installed as described in {Installing live-build}#installing-live-build.
+
+Note that, for the sake of brevity, in these examples we do not specify a local mirror to use for the build. You can speed up downloads considerably if you use a local mirror. You may specify the options when you use #{lb config}#, as described in {Distribution mirrors used at build time}#distribution-mirrors-build-time, or for more convenience, set the default for your build system in #{/etc/live/build.conf}#. Simply create this file and in it, set the corresponding #{LB_MIRROR_*}# variables to your preferred mirror. All other mirrors used in the build will be defaulted from these values. For example:
+
+code{
+
+ LB_MIRROR_BOOTSTRAP="http://mirror/debian/";
+ LB_MIRROR_CHROOT_SECURITY="http://mirror/debian-security/";
+ LB_MIRROR_CHROOT_BACKPORTS="http://mirror/debian-backports/";
+
+}code
+
+2~tutorial-1 Tutorial 1: A default image
+
+*{Use case:}* Create a simple first image, learning the basics of live-build.
+
+In this tutorial, we will build a default ISO hybrid Debian Live image containing only base packages (no Xorg) and some Debian Live support packages, as a first exercise in using live-build.
+
+You can't get much simpler than this:
+
+code{
+
+ $ mkdir tutorial1 ; cd tutorial1 ; lb config
+
+}code
+
+Examine the contents of the #{config/}# directory if you wish. You will see stored here a skeletal configuration, ready to customize or, in this case, use immediately to build a default image.
+
+Now, as superuser, build the image, saving a log as you build with #{tee}#.
+
+code{
+
+ # lb build 2>&1 | tee build.log
+
+}code
+
+Assuming all goes well, after a while, the current directory will contain #{binary.hybrid.iso}#. This ISO hybrid image can be booted directly in a virtual machine as described in {Testing an ISO image with Qemu}#testing-iso-with-qemu and {Testing an ISO image with virtualbox}#testing-iso-with-virtualbox, or else imaged onto optical media or a USB flash device as described in {Burning an ISO image to a physical medium}#burning-iso-image and {Copying an ISO hybrid image to a USB stick}#copying-iso-hybrid-to-usb, respectively.
+
+2~tutorial-2 Tutorial 2: A web browser utility
+
+*{Use case:}* Create a web browser utility image, learning how to apply customizations.
+
+In this tutorial, we will create an image suitable for use as a web browser utility, serving as an introduction to customizing Debian Live images.
+
+code{
+
+ $ mkdir tutorial2
+ $ cd tutorial2
+ $ echo "task-lxde-desktop iceweasel" >> config/package-lists/my.list.chroot
+
+}code
+
+Our choice of LXDE for this example reflects our desire to provide a minimal desktop environment, since the focus of the image is the single use we have in mind, the web browser. We could go even further and provide a default configuration for the web browser in #{config/includes.chroot/etc/iceweasel/profile/}#, or additional support packages for viewing various kinds of web content, but we leave this as an exercise for the reader.
+
+Build the image, again as superuser, keeping a log as in {Tutorial 1}#tutorial-1:
+
+code{
+
+ # lb build 2>&1 | tee build.log
+
+}code
+
+Again, verify the image is OK and test, as in {Tutorial 1}#tutorial-1.
+
+2~tutorial-3 Tutorial 3: A personalized image
+
+*{Use case:}* Create a project to build a personalized image, containing your favourite software to take with you on a USB stick wherever you go, and evolving in successive revisions as your needs and preferences change.
+
+Since we will be changing our personalized image over a number of revisions, and we want to track those changes, trying things experimentally and possibly reverting them if things don't work out, we will keep our configuration in the popular #{git}# version control system. We will also use the best practice of autoconfiguration via #{auto}# scripts as described in {Managing a configuration}#managing-a-configuration.
+
+3~ First revision
+
+code{
+
+ $ mkdir -p tutorial3/auto
+ $ cp /usr/share/doc/live-build/examples/auto/* tutorial3/auto/
+ $ cd tutorial3
+
+}code
+
+Edit #{auto/config}# to read as follows:
+
+code{
+
+ #!/bin/sh
+
+ lb config noauto \
+ --architectures i386 \
+ --linux-flavours 686-pae \
+ "${@}"
+
+}code
+
+Perform #{lb config}# to generate the config tree, using the #{auto/config}# script you just created:
+
+code{
+
+ $ lb config
+
+}code
+
+Now populate your local package list:
+
+code{
+
+ $ echo "task-lxde-desktop iceweasel xchat" >> config/package-lists/my.list.chroot
+
+}code
+
+First, #{--architectures i386}# ensures that on our #{amd64}# build system, we build a 32-bit version suitable for use on most machines. Second, we use #{--linux-flavours 686-pae}# because we don't anticipate using this image on much older systems. Third, we have chosen the /{lxde}/ task metapackage to give us a minimal desktop. And finally, we have added two initial favourite packages: /{iceweasel}/ and /{xchat}/.
+
+Now, build the image:
+
+code{
+
+ # lb build
+
+}code
+
+Note that unlike in the first two tutorials, we no longer have to type #{2>&1 | tee build.log}# as that is now included in #{auto/build}#.
+
+Once you've tested the image (as in {Tutorial 1}#tutorial-1) and are satisfied it works, it's time to initialize our #{git}# repository, adding only the auto scripts we just created, and then make the first commit:
+
+code{
+
+ $ git init
+ $ cp /usr/share/doc/live-build/examples/gitignore .gitignore
+ $ git add .
+ $ git commit -a -m "Initial import."
+
+}code
+
+3~ Second revision
+
+In this revision, we're going to clean up from the first build, add the /{vlc}/ package to our configuration, rebuild, test and commit.
+
+The #{lb clean}# command will clean up all generated files from the previous build except for the cache, which saves having to re-download packages. This ensures that the subsequent #{lb build}# will re-run all stages to regenerate the files from our new configuration.
+
+code{
+
+ # lb clean
+
+}code
+
+Now append the /{vlc}/ package to our local package list in #{config/package-lists/my.list.chroot}#:
+
+code{
+
+ $ echo vlc >> config/package-lists/my.list.chroot
+
+}code
+
+Build again:
+
+code{
+
+# lb build
+
+}code
+
+Test, and when you're satisfied, commit the next revision:
+
+code{
+
+ $ git commit -a -m "Adding vlc media player."
+
+}code
+
+Of course, more complicated changes to the configuration are possible, perhaps adding files in subdirectories of #{config/}#. When you commit new revisions, just take care not to hand edit or commit the top-level files in #{config}# containing #{LB_*}# variables, as these are build products, too, and are always cleaned up by #{lb clean}# and re-created with #{lb config}# via their respective #{auto}# scripts.
+
+We've come to the end of our tutorial series. While many more kinds of customization are possible, even just using the few features explored in these simple examples, an almost infinite variety of different images can be created. The remaining examples in this section cover several other use cases drawn from the collected experiences of users of Debian Live.
+
+2~ A VNC Kiosk Client
+
+*{Use case:}* Create an image with live-build to boot directly to a VNC server.
+
+Make a build directory and create an skeletal configuration inside it, disabling recommends to make a minimal system. And then create two initial package lists: the first one generated with a script provided by live-build named #{Packages}# (see {Generated package lists}#generated-package-lists), and the second one including /{xorg}/, /{gdm3}/, /{metacity}/ and /{xvnc4viewer}/.
+
+code{
+
+ $ mkdir vnc-kiosk-client
+ $ cd vnc-kiosk-client
+ $ lb config -a i386 -k 686-pae --apt-recommends false
+ $ echo '! Packages Priority standard' > config/package-lists/standard.list.chroot
+ $ echo "xorg gdm3 metacity xvnc4viewer" > config/package-lists/my.list.chroot
+
+}code
+
+As explained in {Tweaking APT to save space}#tweaking-apt-to-save-space you may need to re-add some recommended packages to make your image work properly.
+
+An easy way to list recommends is using /{apt-cache}/. For example:
+
+code{
+
+ $ apt-cache depends live-config live-boot
+
+}code
+
+In this example we found out that we had to re-include several packages recommended by live-config and live-boot: #{user-setup}# to make autologin work and #{sudo}# as an essential program to shutdown the system. Besides, it could be handy to add #{live-tools}# to be able to copy the image to RAM and #{eject}# to eventually eject the live medium. So:
+
+code{
+
+ $ echo "live-tools user-setup sudo eject" > config/package-lists/recommends.list.chroot
+
+}code
+
+After that, create the directory #{/etc/skel}# in #{config/includes.chroot}# and put a custom #{.xsession}# in it for the default user that will launch /{metacity}/ and start /{xvncviewer}/, connecting to port #{5901}# on a server at #{192.168.1.2}#:
+
+code{
+
+ $ mkdir -p config/includes.chroot/etc/skel
+ $ cat > config/includes.chroot/etc/skel/.xsession << EOF
+ #!/bin/sh
+
+ /usr/bin/metacity &
+ /usr/bin/xvncviewer 192.168.1.2:1
+
+ exit
+ EOF
+
+}code
+
+Build the image:
+
+code{
+
+ # lb build
+
+}code
+
+Enjoy.
+
+2~ A base image for a 128MB USB key
+
+*{Use case:}* Create a default image with some components removed in order to fit on a 128MB USB key with a little space left over to use as you see fit.
+
+When optimizing an image to fit a certain media size, you need to understand the tradeoffs you are making between size and functionality. In this example, we trim only so much as to make room for additional material within a 128MB media size, but without doing anything to destroy the integrity of the packages contained within, such as the purging of locale data via the /{localepurge}/ package, or other such "intrusive" optimizations. Of particular note, we use #{--debootstrap-options}# to create a minimal system from scratch.
+
+code{
+
+ $ lb config -k 486 --apt-indices false --apt-recommends false --debootstrap-options "--variant=minbase" --firmware-chroot false --memtest none
+
+}code
+
+To make the image work properly, we must re-add, at least, two recommended packages which are left out by the #{--apt-recommends false}# option. See {Tweaking APT to save space}#tweaking-apt-to-save-space
+
+code{
+
+ $ echo "user-setup sudo" > config/package-lists/recommends.list.chroot
+
+}code
+
+Now, build the image in the usual way:
+
+code{
+
+ # lb build 2>&1 | tee build.log
+
+}code
+
+On the author's system at the time of writing this, the above configuration produced a 77MB image. This compares favourably with the 177MB image produced by the default configuration in {Tutorial 1}#tutorial-1.
+
+The biggest space-saver here, compared to building a default image on an #{i386}# architecture system, is to select only the #{486}# kernel flavour instead of the default #{-k "486 686-pae"}#. Leaving off APT's indices with #{--apt-indices false}# also saves a fair amount of space, the tradeoff being that you need to do an #{apt-get update}# before using /{apt}/ in the live system. Dropping recommended packages with #{--apt-recommends false}# saves some additional space, at the expense of omitting some packages you might otherwise expect to be there. #{--debootstrap-options "--variant=minbase"}# bootstraps a minimal system from the start. Not automatically including firmware packages with #{--firmware-chroot false}# saves some space too. And finally, #{--memtest none}# prevents the installation of a memory tester.
+
+*{Note:}* A minimal system can also be achieved using hooks, like for example the #{stripped.chroot}# hook found in #{/usr/share/doc/live-build/examples/hooks}#. It may shave off additional small amounts of space and produce an image of 62MB. However, it does so by removal of documentation and other files from packages installed on the system. This violates the integrity of those packages and that, as the comment header warns, may have unforeseen consequences. That is why using a minimal /{debootstrap}/ is the recommended way of achieving this goal.
+
+2~ A localized GNOME desktop and installer
+
+*{Use case:}* Create a GNOME desktop image, localized for Switzerland and including an installer.
+
+We want to make an iso-hybrid image for i386 architecture using our preferred desktop, in this case GNOME, containing all of the same packages that would be installed by the standard Debian installer for GNOME.
+
+Our initial problem is the discovery of the names of the appropriate language tasks. Currently, live-build cannot help with this. While we might get lucky and find this by trial-and-error, there is a tool, #{grep-dctrl}#, which can be used to dig it out of the task descriptions in tasksel-data, so to prepare, make sure you have both of those things:
+
+code{
+
+ # apt-get install dctrl-tools tasksel-data
+
+}code
+
+Now we can search for the appropriate tasks, first with:
+
+code{
+
+ $ grep-dctrl -FTest-lang de /usr/share/tasksel/descs/debian-tasks.desc -sTask
+ Task: german
+
+}code
+
+By this command, we discover the task is called, plainly enough, german. Now to find the related tasks:
+
+code{
+
+ $ grep-dctrl -FEnhances german /usr/share/tasksel/descs/debian-tasks.desc -sTask
+ Task: german-desktop
+ Task: german-kde-desktop
+
+}code
+
+At boot time we will generate the *{de_CH.UTF-8}* locale and select the *{ch}* keyboard layout. Now let's put the pieces together. Recalling from {Using metapackages}#using-metapackages that task metapackages are prefixed #{task-}#, we just specify these language boot parameters, then add standard priority packages and all our discovered task metapackages to our package list as follows:
+
+code{
+
+ $ mkdir live-gnome-ch
+ $ cd live-gnome-ch
+ $ lb config \
+ -a i386 \
+ -k 486 \
+ --bootappend-live "boot=live config locales=de_CH.UTF-8 keyboard-layouts=ch" \
+ --debian-installer live
+ $ echo '! Packages Priority standard' > config/package-lists/standard.list.chroot
+ $ echo task-gnome-desktop task-german task-german-desktop >> config/package-lists/desktop.list.chroot
+ $ echo debian-installer-launcher >> config/package-lists/installer.list.chroot
+
+}code
+
+Note that we have included the debian-installer-launcher package to launch the installer from the live desktop, and have also specified the 486 flavour kernel, as it is currently necessary to make the installer and live system kernels match for the launcher to work properly.
diff -Naurp live-manual.orig/manual/en/index.html.in live-manual/manual/en/index.html.in
--- live-manual.orig/manual/en/index.html.in 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/index.html.in 2013-02-22 00:00:49.998212541 +0100
@@ -35,7 +35,7 @@
<h3>Source</h3>
<p>
- The sources for this manual are available in a <a href="http://git.or.cz/";>Git</a> repository at live.debian.net.
+ The sources for this manual are available in a <a href="http://git-scm.com/";>Git</a> repository at live.debian.net.
</p>
<ul>
diff -Naurp live-manual.orig/manual/en/live-manual.ssm live-manual/manual/en/live-manual.ssm
--- live-manual.orig/manual/en/live-manual.ssm 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/live-manual.ssm 2013-03-01 10:03:10.416752408 +0100
@@ -5,17 +5,17 @@
@creator: Debian Live Project <debian-live@lists.debian.org>
@rights:
- :copyright: Copyright (C) 2006-2012 Debian Live Project
+ :copyright: Copyright (C) 2006-2013 Debian Live Project
:license: This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<br><br>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<br><br>You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. <br><br>The complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL-3 file.
@date:
- :published: 2012-06-27
+ :published: 2013-02-21
@publisher: Debian Live Project <debian-live@lists.debian.org>
@make:
- :bold: /squeeze|wheezy|sid/
- :italics: /live-boot|live-build|live-config|live-manual|live-installer|debian-installer-launcher/
+ :bold: /squeeze|wheezy|jessie|sid/
+ :italics: /live-boot|live-build|live-config|live-debconfig|live-manual|live-tools|live-images|live-installer|debian-installer-launcher/
:num_top: 1
:skin: skin_debian-live
@@ -51,16 +51,20 @@
:B~ Project
+<< project_contributing.ssi
+
<< project_bugs.ssi
<< project_coding-style.ssi
<< project_procedures.ssi
+<< project_git.ssi
+
:B~ Examples
-<< user_examples.ssi
+<< examples.ssi
:B~ Appendix
-<< style_guide.ssi
+<< appendix_style-guide.ssi
diff -Naurp live-manual.orig/manual/en/project_bugs.ssi live-manual/manual/en/project_bugs.ssi
--- live-manual.orig/manual/en/project_bugs.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/project_bugs.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -1,24 +1,24 @@
-B~ Reporting bugs
+:B~ Reporting bugs
1~bugs Reporting bugs
-Debian Live is far from being perfect, but we want to make it as close as possible to perfect - with your help. Do not hesitate to report a bug: it is better to fill a report twice than never. However, this chapter includes recommendations how to file good bug reports.
+Debian Live is far from being perfect, but we want to make it as close as possible to perfect - with your help. Do not hesitate to report a bug. It is better to fill a report twice than never. However, this chapter includes recommendations on how to file good bug reports.
For the impatient:
_* Always check first the image status updates on our homepage at http://live.debian.net/ for known issues.
-_* Always try to reproduce the bug with the *{most recent versions}* of live-build, live-boot, and live-config before submitting a bug report.
+_* Always try to reproduce the bug with the *{most recent versions}* of live-build, live-boot, live-config and live-tools before submitting a bug report.
-_* Try to give *{as specific information as possible}* about the bug. This includes (at least) the version of live-build, live-boot, and live-config used and the distribution of the live system you are building.
+_* Try to give *{as specific information as possible}* about the bug. This includes (at least) the version of live-build, live-boot, live-config, and live-tools used and the distribution of the live system you are building.
2~ Known issues
-Because Debian *{testing}* and Debian *{unstable}* distributions are a moving target, when you specify either as the target system distribution, a successful build may not always be possible.
+Since Debian *{testing}* and Debian *{unstable}* distributions are moving targets, when you specify either of them as the target system distribution, a successful build may not always be possible.
% FIXME:
-If this causes too much difficulty for you, do not build a system based on *{testing}* or *{unstable}*, but rather, use *{stable}*. live-build does always default to the *{stable}* release.
+If this causes too much difficulty for you, do not build a system based on *{testing}* or *{unstable}*, but rather, use *{stable}*. live-build always defaults to the *{stable}* release.
Currently known issues are listed under the section 'status' on our homepage at http://live.debian.net/.
@@ -34,7 +34,7 @@ Using outdated packages can cause signif
2~collect-information Collect information
-Please provide enough information with your report. At least include the exact version of live-build version where the bug is encountered and steps to reproduce it. Please use common sense and include other relevant information if you think that it might help in solving the problem.
+Please provide enough information with your report. Include, at least, the exact version of live-build where the bug is encountered and the steps to reproduce it. Please use your common sense and provide any other relevant information if you think that it might help in solving the problem.
To make the most out of your bug report, we require at least the following information:
@@ -42,19 +42,19 @@ _* Architecture of the host system
_* Version of live-build on the host system
-_* Version of live-boot on the live system
-
-_* Version of live-config on the live system
-
_* Version of /{debootstrap}/ and/or /{cdebootstrap}/ on the host system
_* Architecture of the live system
_* Distribution of the live system
-_* Version of the kernel on the live system
+_* Version of live-boot on the live system
-You can generate a log of the build process by using the #{tee}# command. We recommend doing this automatically with an #{auto/build}# script; (see {Managing a configuration}#managing-a-configuration for details).
+_* Version of live-config on the live system
+
+_* Version of live-tools on the live system
+
+You can generate a log of the build process by using the #{tee}# command. We recommend doing this automatically with an #{auto/build}# script (see {Managing a configuration}#managing-a-configuration for details).
code{
@@ -62,7 +62,7 @@ code{
}code
-At boot time, live-boot stores a log in #{/var/log/live.log}# (or #{/var/log/live-boot.log}#).
+At boot time, live-boot and live-config store their logfiles in #{/var/log/live/}#. Check them for error messages.
Additionally, to rule out other errors, it is always a good idea to tar up your #{config/}# directory and upload it somewhere (do *{not}* send it as an attachment to the mailing list), so that we can try to reproduce the errors you encountered. If this is difficult (e.g. due to size) you can use the output of #{lb config --dump}# which produces a summary of your config tree (i.e. lists files in subdirectories of #{config/}# but does not include them).
@@ -70,46 +70,48 @@ Remember to send in any logs that were p
2~ Isolate the failing case if possible
-If possible, isolate the failing case to the smallest possible change that breaks. It is not always easy to do this, so if you can't manage it for your report, don't worry. However, if you plan your development cycle well, using small enough change sets per iteration, you may be able to isolate the problem by constructing a simpler 'base' configuration that closely matches your actual configuration plus just the broken change set added to it. If you have a hard time sorting out which of your changes broke, it may be that you are including too much in each change set and should develop in smaller increments.
+If possible, isolate the failing case to the smallest possible change that breaks. It is not always easy to do this so if you cannot manage it for your report, do not worry. However, if you plan your development cycle well, using small enough change sets per iteration, you may be able to isolate the problem by constructing a simpler 'base' configuration that closely matches your actual configuration plus just the broken change set added to it. If you have a hard time sorting out which of your changes broke, it may be that you are including too much in each change set and should develop in smaller increments.
2~ Use the correct package to report the bug against
-Where does the bug appear?
+If you do not know what component is responsible for the bug or if the bug is a general bug concerning live systems, you can fill a bug against the debian-live pseudo-package.
+
+However, we would appreciate it if you try to narrow it down according to where the bug appears.
-3~ At build time whilst bootstrapping
+3~ At build time while bootstrapping
-live-build first bootstraps a basic Debian system with /{debootstrap}/ or /{cdebootstrap}/. Depending on the bootstrapping tool used and the Debian distribution it is bootstrapping, it may fail. If a bug appears here, check if the error is related to a specific Debian package (most likely), or if it is related to bootstrapping tool itself.
+live-build first bootstraps a basic Debian system with /{debootstrap}/ or /{cdebootstrap}/. Depending on the bootstrapping tool used and the Debian distribution it is bootstrapping, it may fail. If a bug appears here, check if the error is related to a specific Debian package (most likely), or if it is related to the bootstrapping tool itself.
-In both cases, this is not a bug in Debian Live, but rather in Debian itself which we can not fix this directly. Please report such a bug against the bootstrapping tool or the failing package.
+In both cases, this is not a bug in Debian Live, but rather in Debian itself and probably we cannot fix it directly. Please report such a bug against the bootstrapping tool or the failing package.
-3~ At build time whilst installing packages
+3~ At build time while installing packages
live-build installs additional packages from the Debian archive and depending on the Debian distribution used and the daily archive state, it can fail. If a bug appears here, check if the error is also reproducible on a normal system.
If this is the case, this is not a bug in Debian Live, but rather in Debian - please report it against the failing package. Running /{debootstrap}/ separately from the Live system build or running #{lb bootstrap --debug}# will give you more information.
-Also, if you are using a local mirror and/or any of sort of proxy and you are experiencing a problem, please always reproduce it first by bootstrapping from an official mirror.
+Also, if you are using a local mirror and/or any sort of proxy and you are experiencing a problem, please always reproduce it first by bootstrapping from an official mirror.
3~ At boot time
-If your image does not boot, please report it to the mailing list together with the information requested in {Collect information}#collect-information. Do not forget to mention, how/when the image failed, in Qemu, Virtualbox, VMWare or real hardware. If you are using a virtualization technology of any kind, please always run it on real hardware before reporting a bug. Providing a screenshot of the failure is also very helpful.
+If your image does not boot, please report it to the mailing list together with the information requested in {Collect information}#collect-information. Do not forget to mention, how/when the image failed exactly, whether using virtualization or real hardware. If you are using a virtualization technology of any kind, please always run it on real hardware before reporting a bug. Providing a screenshot of the failure is also very helpful.
3~ At run time
-If a package was successfully installed, but fails while actually running the Live system, this is probably a bug in Debian Live. However,
+If a package was successfully installed, but fails while actually running the Live system, this is probably a bug in Debian Live. However:
2~ Do the research
-Before filing the bug, please search the web for the particular error message or symptom you are getting. As it is highly unlikely that you are the only person experiencing a particular problem, there is always a chance that it has been discussed elsewhere, and a possible solution, patch, or workaround has been proposed.
+Before filing the bug, please search the web for the particular error message or symptom you are getting. As it is highly unlikely that you are the only person experiencing a particular problem. There is always a chance that it has been discussed elsewhere and a possible solution, patch, or workaround has been proposed.
You should pay particular attention to the Debian Live mailing list, as well as the homepage, as these are likely to contain the most up-to-date information. If such information exists, always include the references to it in your bug report.
-In addition, you should check the current bug lists for live-build, live-boot, and live-config to see whether something similar has been reported already.
+In addition, you should check the current bug lists for live-build, live-boot, live-config and live-tools to see whether something similar has already been reported.
2~ Where to report bugs
The Debian Live project keeps track of all bugs in the Debian Bug Tracking System (BTS). For information on how to use the system, please see http://bugs.debian.org/. You can also submit the bugs by using the #{reportbug}# command from the package with the same name.
-In general, you should report build time errors against the live-build package, boot time errors against live-boot, and run time errors against live-config. If you are unsure of which package is appropriate or need more help before submitting a bug report, please send a message to the mailing list and we will help you to figure it out.
+In general, you should report build time errors against the live-build package, boot time errors against live-boot, and run time errors against live-config. If you are unsure of which package is appropriate or need more help before submitting a bug report, please report it against the debian-live pseudo-package. We will then take care about it and reassign it where appropriate.
Please note that bugs found in distributions derived from Debian (such as Ubuntu and others) should *{not}* be reported to the Debian BTS unless they can be also reproduced on a Debian system using official Debian packages.
diff -Naurp live-manual.orig/manual/en/project_coding-style.ssi live-manual/manual/en/project_coding-style.ssi
--- live-manual.orig/manual/en/project_coding-style.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/project_coding-style.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -1,8 +1,8 @@
-B~ Coding Style
+:B~ Coding Style
1~coding-style Coding Style
-This chapter documents the coding style used in live-boot and others.
+This chapter documents the coding style used in Debian Live.
2~ Compatibility
@@ -72,7 +72,7 @@ code{
_* Variables are always in capital letters.
-_* Variables that used in #{lb config}# always start with #{LB_}# prefix.
+_* Variables used in live-build always start with #{LB_}# prefix.
_* Internal temporary variables in live-build should start with the #{\_LB_}# prefix.
diff -Naurp live-manual.orig/manual/en/project_contributing.ssi live-manual/manual/en/project_contributing.ssi
--- live-manual.orig/manual/en/project_contributing.ssi 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/manual/en/project_contributing.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -0,0 +1,89 @@
+:B~ Contributing to the project
+
+1~contributing-to-project Contributing to the project
+
+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 documents, namely, GPL version 3 or later.
+
+Contributions to the project, such as translations and patches, are greatly welcome. Anyone can directly commit to the repositories, however, we ask you to send bigger changes to the mailing list to discuss them first. See the section {Contact}#contact for more information.
+
+The Debian Live Project uses Git as version control system and source code management. As explained in {Git repositories}#git-repositories there are two main development branches: *{debian}* and *{debian-next}*. Everybody can commit to the debian-next branches of the live-boot, live-build, live-config, live-images, live-manual and live-tools repositories.
+
+However, there are certain restrictions. The server will reject:
+
+_* Non fast-forward pushes.
+
+_* Merge commits.
+
+_* Adding or removing tags or branches.
+
+Even though all commits might be revised, we ask you to use your common sense and make good commits with good commit messages.
+
+_* Write commit messages that consist of complete, meaningful sentences in English, starting with a capital letter and ending with a full stop. Usually, these will start with the form "Fixing/Adding/Removing/Correcting/Translating/...".
+
+_* Write good commit messages. The first line must be an accurate summary of the contents of the commit which will be included in the changelog. If you need to make some further explanations, write them below leaving a blank line after the first one and then another blank line after each paragraph. Lines of paragraphs should not exceed 80 characters in length.
+
+_* Commit atomically, this is to say, do not mix unrelated things in the same commit. Make one different commit for each change you make.
+
+2~ Making changes
+
+In order to push to the repositories, you must follow the following procedure. Here we use live-manual as an example so replace it with the name of the repository you want to work with. For detailed information on how to edit live-manual see {Contributing to this document}#how-to-contribute.
+
+_* Fetch the public commit key:
+
+code{
+
+ $ mkdir -p ~/.ssh/keys
+ $ wget http://live.debian.net/other/keys/git@live.debian.net -O ~/.ssh/keys/git@live.debian.net
+ $ wget http://live.debian.net/other/keys/git@live.debian.net.pub -O ~/.ssh/keys/git@live.debian.net.pub
+ $ chmod 0600 ~/.ssh/keys/git@live.debian.net*
+
+}code
+
+_* Add the following section to your openssh-client config:
+
+code{
+
+ $ cat >> ~/.ssh/config << EOF
+ Host live.debian.net
+ Hostname live.debian.net
+ User git
+ IdentityFile ~/.ssh/keys/git@live.debian.net
+ EOF
+
+}code
+
+_* Check out a clone of live-manual through ssh:
+
+code{
+
+ $ git clone git@live.debian.net:/live-manual.git
+ $ cd live-manual && git checkout debian-next
+
+}code
+
+_* Make sure you have Git author and email set:
+
+code{
+
+ $ git config user.name "John Doe"
+ $ git config user.email john@example.org
+
+}code
+
+*{Important:}* Remember that you should commit any changes on the *{debian-next}* branch.
+
+_* Make your changes. In this example you would first write a new section dealing with applying patches and then prepare to commit adding the files and writing your commit message like this:
+
+code{
+
+ $ git commit -a -m "Adding a section on applying patches."
+
+}code
+
+_* Push the commit to the server:
+
+code{
+
+ $ git push
+
+}code
diff -Naurp live-manual.orig/manual/en/project_git.ssi live-manual/manual/en/project_git.ssi
--- live-manual.orig/manual/en/project_git.ssi 1970-01-01 01:00:00.000000000 +0100
+++ live-manual/manual/en/project_git.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -0,0 +1,61 @@
+:B~ Git repositories
+
+1~git-repositories Git repositories
+
+The list of all the available repositories of the Debian Live Project can be found at http://live.debian.net/gitweb/. The project's git URLs have the form: #{protocol://live.debian.net/git/repository}#. Thus, in order to clone live-manual read-only, launch:
+
+code{
+
+ $ git clone git://live.debian.net/git/live-manual.git
+
+}code
+
+Or,
+
+code{
+
+ $ git clone https://live.debian.net/git/live-manual.git
+
+}code
+
+Or,
+
+code{
+
+ $ git clone http://live.debian.net/git/live-manual.git
+
+}code
+
+The cloning addresses with write permission have the form: #{git@live.debian.net:/repository}#.
+
+So, again, to clone live-manual over ssh you must type:
+
+code{
+
+ $ git clone git@live.debian.net:live-manual.git
+
+}code
+
+The git tree is made up of several different branches. The *{debian}* and the *{debian-next}* branches are particularly noteworthy because they contain the actual work that will eventually be included in each new release.
+
+After cloning any of the existing repositories, you will be on the *{debian}* branch. This is appropriate to take a look at the state of the project's latest release but before starting work it is crucial to switch to the *{debian-next}* branch. To do so:
+
+code{
+
+ $ git checkout debian-next
+
+}code
+
+The *{debian-next}* branch, which is not always fast-forward, is where all the changes are committed first before being merged into the *{debian}* branch. To make an analogy, it is like a testing ground. If you are working on this branch and need to pull, you will have to do a #{git pull --rebase}# so that your local modifications are staged while pulling from the server and then your changes will be put on top of it all.
+
+2~ Handling multiple repositories
+
+If you intend to clone several of the Debian Live repositories and want to switch to the *{debian-next}* branch right away to check the latest code, write a patch or contribute with a translation you ought to know that the git server provides a #{mrconfig}# file to ease the handling of multiple repositories. In order to use it you need to install the /{mr}/ package and after that, launch:
+
+code{
+
+ $ mr bootstrap http://live.debian.net/other/mr/mrconfig
+
+}code
+
+This command will automatically clone and checkout to the *{debian-next}* branch the development repositories of the Debian packages produced by the project. These include, among others, the live-images repository, which contains the configurations used for the prebuilt images that the project publishes for general use. For more information on how to use this repository, see {Clone a configuration published via Git}#clone-configuration-via-git
diff -Naurp live-manual.orig/manual/en/project_procedures.ssi live-manual/manual/en/project_procedures.ssi
--- live-manual.orig/manual/en/project_procedures.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/project_procedures.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -1,29 +1,17 @@
-B~ Procedures
+:B~ Procedures
1~procedures Procedures
This chapter documents the procedures within the Debian Live project for various tasks that need cooperation with other teams in Debian.
-2~ Udeb Uploads
-
-Before commiting releases of a udeb in d-i svn, one has to call:
-
-code{
-
- $ ../../scripts/l10n/output-l10n-changes . -d
-
-}code
-
2~ Major Releases
Releasing a new stable major version of Debian includes a lot of different teams working together to make it happen. At some point, the Live team comes in and builds live system images. The requirements to do this are:
-_* A mirror containing the released versions for the debian, debian-security and debian-volatile archive which the debian-live buildd can access.
+_* A mirror containing the released versions for the debian and debian-security archives which the debian-live buildd can access.
_* The names of the image need to be known (e.g. debian-live-VERSION-ARCH-FLAVOUR.iso).
-_* The packagelists need to have been updated.
-
_* The data from debian-cd needs to be synced (udeb exclude lists).
_* The includes from debian-cd needs to be synced (README.*, doc/*, etc.).
@@ -32,7 +20,7 @@ _* Images are built and mirrored on cdim
2~ Point Releases
-_* Again, we need updated mirrors of debian, debian-security and debian-volatile.
+_* Again, we need updated mirrors of debian and debian-security.
_* Images are built and mirrored on cdimage.debian.org.
@@ -52,10 +40,10 @@ An annoucement mail for point releases c
code{
$ sed \
- -e 's|%major%|5.0|g' \
- -e 's|%minor%|5.0.2|g' \
- -e 's|%codename%|lenny|g' \
- -e 's|%release_mail%|2009/msg00007.html|g'
+ -e 's|@MAJOR@|7.0|g' \
+ -e 's|@MINOR@|7.0.1|g' \
+ -e 's|@CODENAME@|wheezy|g' \
+ -e 's|@ANNOUNCE@|2013/msgXXXXX.html|g'
}code
@@ -63,76 +51,44 @@ Please check the mail carefully before s
code{
- Debian Live images for Debian GNU/Linux %major% updated
+ Updated Debian Live @MAJOR@: @MINOR@ released
- The Debian Live project is pleased to announce the availability of
- updated Live images for its stable distribution Debian GNU/Linux %major%
- (codename "%codename%").
+ The Debian Live project is pleased to announce the @MINOR@ update of the
+ Live images for the stable distribution Debian @MAJOR@ (codename "@CODENAME@").
The images are available for download at:
- <http://cdimage.debian.org/cdimage/release/current-live/>
-
- This update incorporates the changes made in the %minor% point release,
- which adds corrections for security problems to the stable release
- along with a few adjustments for serious problems. A full list of the
- changes may be viewed at:
-
- <http://lists.debian.org/debian-announce/%release_mail%>
-
- It also includes the following Live-specific changes:
-
- * [INSERT LIVE-SPECIFIC CHANGE HERE]
- * [INSERT LIVE-SPECIFIC CHANGE HERE]
- * [LARGER ISSUES MAY DESERVE THEIR OWN SECTION]
-
-
- URLs
- ----
+ <http://live.debian.net/cdimage/release/current/>
- Download location of updated images:
+ and later at:
<http://cdimage.debian.org/cdimage/release/current-live/>
- Debian Live project homepage:
+ This update includes the changes of the Debian @MINOR@ release:
- <http://live.debian.net/>
+ <http://lists.debian.org/debian-announce/@ANNOUNCE@>
- The current stable distribution:
+ Additionally it includes the following Live-specific changes:
- <http://ftp.debian.org/debian/dists/stable>
-
- stable distribution information (release notes, errata etc.):
-
- <http://www.debian.org/releases/stable/>
-
- Security announcements and information:
-
- <http://www.debian.org/security/>
+ * [INSERT LIVE-SPECIFIC CHANGE HERE]
+ * [INSERT LIVE-SPECIFIC CHANGE HERE]
+ * [LARGER ISSUES MAY DESERVE THEIR OWN SECTION]
+ About Debian Live
+ -----------------
+ The Debian Live project produces the tools used to build official
+ Debian Live systems and the official Debian Live images themselves.
About Debian
- -------------
-
+ ------------
The Debian Project is an association of Free Software developers who
volunteer their time and effort in order to produce the completely free
- operating system Debian GNU/Linux.
-
-
- About Debian Live
- -----------------
-
- Debian Live is an official sub-project of Debian which produces Debian
- systems that do not require a classical installer. Images are available
- for CD/DVD discs, USB sticks and PXE netbooting as well as a bare
- filesystem images for booting directly from the internet.
-
+ operating system Debian.
Contact Information
-------------------
-
For further information, please visit the Debian Live web pages at
- <http://live.debian.net/> or alternatively send mail to
+ <http://live.debian.net/>, or contact the Debian Live team at
<debian-live@lists.debian.org>.
}code
diff -Naurp live-manual.orig/manual/en/style_guide.ssi live-manual/manual/en/style_guide.ssi
--- live-manual.orig/manual/en/style_guide.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/style_guide.ssi 1970-01-01 01:00:00.000000000 +0100
@@ -1,247 +0,0 @@
-:B~ Appendix
-
-1~style-guide Style guide
-
-2~ Guidelines for authors
-
-This section deals with some general considerations to be taken into account when writing technical documentation for live-manual. They are divided into linguistic features and recommended procedures.
-
-*{Note:}* Authors should first read {Contributing to this document}#how-to-contribute
-
-3~ Linguistic features
-
-_* /{Use plain English}/
-
-Keep in mind that a high percentage of your readers are not native speakers. So as a general rule try to use short, meaningful sentences, followed by a full stop.
-
-This does not mean that you have to use a simplistic, naive style. It is a suggestion to try to avoid, as much as possible, complex subordinate sentences that make the text difficult to understand for non-native speakers.
-
-_* /{Variety of English}/
-
-The most widely spread varieties of English are British and American so it is very likely that most authors will use either one or the other. In a collaborative environment, the ideal variety would be "International English" but it is very difficult, not to say impossible, to decide on which variety among all the existing ones, is the best to use.
-
-We expect that different varieties may mix without creating misunderstandings but in general terms you should try to be coherent and before deciding on using British, American or any other English flavour at your discretion, please take a look at how other people write and try to imitate them.
-
-_* /{Be balanced}/
-
-Do not be biased. Avoid including references to ideologies completely unrelated to live-manual. Technical writing should be as neutral as possible. It is in the very nature of scientific writing.
-
-_* /{Be politically correct}/
-
-Try to avoid sexist language as much as possible. If you need to make references to the third person singular preferably use "they" rather than "he" or "she" or awkward inventions such as "s/he", "s(he)" and the like.
-
-_* /{Be concise}/
-
-Go straight to the point and do not wander around aimlessly. Give as much information as necessary but do not give more information than necessary, this is to say, do not explain unnecessary details. Your readers are intelligent. Presume some previous knowledge on their part.
-
-_* /{Minimize translation work}/
-
-Keep in mind that whatever you write will have to be translated into several other languages. This implies that a number of people will have to do an extra work if you add useless or redundant information.
-
-_* /{Be coherent}/
-
-As suggested before, it is almost impossible to standardize a collaborative document into a perfectly unified whole. However, every effort on your side to write in a coherent way with the rest of the authors will be appreciated.
-
-_* /{Be cohesive}/
-
-Use as many text-forming devices as necessary to make your text cohesive and unambiguous. (Text-forming devices are linguistic markers such as connectors).
-
-_* /{Be descriptive}/
-
-It is preferable to describe the point in one or several paragraphs than merely using a number of sentences in a typical "changelog" style. Describe it! Your readers will appreciate it.
-
-_* /{Dictionary}/
-
-Look up the meaning of words in a dictionary or encyclopedia if you do not know how to express certain concepts in English. But keep in mind that a dictionary can either be your best friend or can turn into your worst enemy if you do not know how to use it correctly.
-
-English has the largest vocabulary that exists (With over one million words). Many of these words are borrowings from other languages. When looking up the meaning of words in a bilingual dictionary the tendency of a non-native speaker is to choose the one that sounds more similar in their mother tongue. This often turns into an excessively formal discourse which does not sound quite natural in English.
-
-As a general rule, if a concept can be expressed using different synonyms, it is a good advice to choose the first word proposed by the dictionary. If in doubt, choosing words of Germanic origin (Usually monosyllabic words) is often the right thing to do. Be warned that these two techniques might produce a rather informal discourse but at least your choice of words will be of wide use and generally accepted.
-
-Using a dictionary of collocations is recommended. They are extremely helpful when it comes to know which words usually occur together.
-
-Again it is a good practice to learn from the work of others. Using a search engine to check how other authors use certain expressions may help a lot.
-
-_* /{False friends, idioms and other idiomatic expressions}/
-
-Watch out for false friends. No matter how proficient you are in a foreign language you cannot help falling from time to time in the trap of the so called "false friends", words that look similar in two languages but whose meanings or uses might be completely different.
-
-Try to avoid idioms as much as possible. "Idioms" are expressions that may convey a completely different meaning from what their individual words seem to mean. Sometimes, idioms are difficult to understand even for native speakers!
-
-_* /{Avoid slang, abbreviations, contractions...}/
-
-Even though you are encouraged to use plain, everyday English, technical writing belongs to the formal register of the language.
-
-Try to avoid slang, unusual abbreviations that are difficult to understand and above all contractions that try to imitate the spoken language. Not to mention typical irc and family friendly expressions.
-
-3~ Procedures
-
-_* /{Test before write}/
-
-It is important that authors test their examples before adding them to live-manual to ensure that everything works as described. Testing on a clean chroot or VM can be a good starting point. Besides, it would be ideal if the tests were then carried out on different machines with different hardware to spot possible problems that may arise.
-
-_* /{Examples}/
-
-When providing an example try to be as specific as you can. An example is, after all, just an example.
-
-It is often better to use a line that only applies to an specific case than using abstractions that may confuse your readers. In this case you can provide a brief explanation of the effects of the proposed example.
-
-There may be some exceptions when the example suggests using some potentially dangerous commands that, if misused, may cause data loss or other similar undesirable effects. In this case you should provide a thorough explanation of the possible side effects.
-
-_* /{External links}/
-
-Links to external sites should only be used when the information on those sites is crucial when it comes to understanding a special point. Even so, try to use links to external sites as sparsely as possible. Internet links are likely to change from time to time resulting in broken links and leaving your arguments in an incomplete state.
-
-Besides, people who read the manual offline will not have the chance to follow those links.
-
-_* /{Avoid branding and things that violate the license under which the manual is published}/
-
-Try to avoid branding as much as possible. Keep in mind that other downstream projects might make use of the documentation you write. So you are complicating things for them if you add certain specific material.
-
-live-manual is licensed under the GNU GPL. This has a number of implications that apply to the distribution of the material (of any kind, including copyrighted graphics or logos) that is published with it.
-
-_* /{Write a first draft, revise, edit, improve, redo if necessary}/
-
- - Brainstorm!. You need to organize your ideas first in a logical sequence of events.
-
- - Once you have somehow organized those ideas in your mind write a first draft.
-
- - Revise grammar, syntax and spelling.
-
- - Improve your statements and redo any part if necessary.
-
-_* /{Chapters}/
-
-Use the conventional numbering system for chapters and subtitles. e.g. 1, 1.1, 1.1.1, 1.1.2 ... 1.2, 1.2.1, 1.2.2 ... 2, 2.1 ... and so on. See markup below.
-
-If you have to enumerate a series of steps or stages in your description, you can also use ordinal numbers: First, second, third ... or First, Then, After that, Finally ... Alternatively you can use bulleted items.
-
-_* /{Markup}/
-
-And last but not least, live-manual uses {SiSU}http://www.sisudoc.org to process the text files and produce a multiple format output. It is recommended to take a look at {SiSU's manual}http://www.sisudoc.org/sisu/sisu_manual/markup.html to get familiar with its markup, or else type:
-
-code{
-
- $ sisu --help markup
-
-}code
-
-Here are some markup examples that may prove useful:
-
- - For emphasis/bold text:
-
-code{
-
-*{foo}* or !{foo}!
-
-}code
-
-produces: *{foo}* or !{foo}!. Use it to emphasize certain key words.
-
- - For italics:
-
-code{
-
-/{foo}/
-
-}code
-
-produces: /{foo}/. Use them e.g. for the names of debian packages.
-
- - For monospace:
-
-code{
-
-#{foo}#
-
-}code
-
-produces: #{foo}#. Use it e.g. for the names of commands. And also to highlight some key words or things like paths.
-
- - For code blocks:
-
-code{
-
- code{
-
- $ foo
- # bar
-
- }code
-
-}code
-
-produces:
-
-code{
-
- $ foo
- # bar
-
-}code
-
-Use #{code{}# to open and #{}code}# to close the tags. It is important to remember to leave a space at the beginning of each line of code.
-
-2~ Guidelines for translators
-
-This section deals with some general considerations to be taken into account when translating the contents of live-manual.
-
-As a general recommendation, translators should have read and understood the translation rules that apply to their specific languages. Usually, translation groups and mailing lists provide information on how to produce translated work that complies with Debian quality standards.
-
-*{Note:}* Translators should also read {Contributing to this document}#how-to-contribute. In particular the section {Translation}#translation
-
-3~ Translation hints
-
-_* /{Comments}/
-
-The role of the translator is to convey as faithfully as possible the meaning of words, sentences, paragraphs and texts as written by the original authors into their target language.
-
-So they should refrain from adding personal comments or extra bits of information of their own. If they want to add a comment for other translators working on the same documents, they can leave it in the space reserved for that. That is, the header of the strings in the *{po}* files preceded by a number sign *{#}*. Most graphical translation programs can automatically handle those types of comments.
-
-_* /{TN, Translator's Note}/
-
-It is perfectly acceptable however, to include a word or an expression in brackets in the translated text if, and only if, that makes the meaning of a difficult word or expression clearer to the reader. Inside the brackets the translator should make evident that the addition was theirs using the abbreviation "TN" or "Translator's Note".
-
-_* /{Impersonal sentences}/
-
-Documents written in English make an extensive use of the impersonal form "you". In some other languages that do not share this characteristic, this might give the false impression that the original texts are directly addressing the reader when they are actually not doing so. Translators must be aware of that fact and reflect it in their language as accurately as possible.
-
-_* /{False friends}/
-
-The trap of "false friends" explained before especially applies to translators. Double check the meaning of suspicious false friends if in doubt.
-
-_* /{Markup}/
-
-Translators working initially with *{pot}* files and later on with *{po}* files will find many markup features in the strings. They can translate the text anyway, as long as it is translatable, but it is extremely important that they use exactly the same markup as the original English version.
-
-_* /{Code blocks}/
-
-Some translators decide to include the code blocks in the translated files because it is easier for them to identify what has already been translated and what has not by looking at the percentages if they use a graphical translation program.
-
-Include the code blocks if you want to score a 100% complete translation.
-
-On the other hand some translators prefer to leave the code blocks "untranslated" (i.e. not including them). This makes the translation easier to maintain once finished because it does not require translators intervention if the code changes.
-
-Leave the code blocks empty (they will be automatically added then) if you want to make your translation easier to maintain.
-
-_* /{Newlines}/
-
-The translated texts need to have the exact same newlines as the original texts. Be careful to press the "Enter" key or type *{\n}* if they appear in the original files. These newlines often appear, for instance, in the code blocks.
-
-Make no mistake, this does not mean that the translated text needs to have the same length as the English version. That is nearly impossible.
-
-_* /{Untranslatable strings}/
-
-Translators should never translate:
-
- - The code names of releases
-
- - The names of programs
-
- - The commands given as examples
-
- - Metadata (often between colons *{:metadata:}*)
-
- - Links
-
- - Paths
diff -Naurp live-manual.orig/manual/en/user_basics.ssi live-manual/manual/en/user_basics.ssi
--- live-manual.orig/manual/en/user_basics.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_basics.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -2,15 +2,15 @@
1~the-basics The basics
-This chapter contains a brief overview of the build process and instructions for using the three most commonly used image types. The most versatile image type, #{iso-hybrid}#, may be used on a virtual machine, optical media or USB portable storage device. In certain special cases, such as the use of persistence, #{hdd}# may be more suitable for USB devices. The chapter finishes with instructions for building and using a #{net}# type image, which is a bit more involved due to the setup required on the server. This is a slightly advanced topic for anyone who is not familiar already with netbooting, but is included here because once the setup is done, it is a very convenient way to test and deploy images for booting on the local network without the hassle of dealing with image media.
+This chapter contains a brief overview of the build process and instructions for using the three most commonly used image types. The most versatile image type, #{iso-hybrid}#, may be used on a virtual machine, optical medium or USB portable storage device. In certain special cases, as explained later, the #{hdd}# type may be more suitable. The chapter finishes with instructions for building and using a #{netboot}# type image, which is a bit more involved due to the setup required on the server. This is an slightly advanced topic for anyone who is not familiar already with netbooting, but it is included here because once the setup is done, it is a very convenient way to test and deploy images for booting on the local network without the hassle of dealing with image media.
-Throughout the chapter, we will often refer to the default filenames produced by live-build. If you are downloading a prebuilt image instead, the actual filenames may vary.
+Throughout the chapter, we will often refer to the default filenames produced by live-build. If you are {downloading a prebuilt image}#downloading-prebuilt-images instead, the actual filenames may vary.
2~what-is-live What is a live system?
A live system usually means an operating system booted on a computer from a removable medium, such as a CD-ROM or USB stick, or from a network, ready to use without any installation on the usual drive(s), with auto-configuration done at run time (see {Terms}#terms).
-With Debian Live, it's a Debian GNU/Linux operating system, built for one of the supported architectures (currently amd64, i386, powerpc and sparc). It is made from the following parts:
+With Debian Live, it's a Debian GNU/Linux operating system, built for one of the supported architectures (currently amd64 and i386). It is made from the following parts:
_* *{Linux kernel image}*, usually named #{vmlinuz*}#
@@ -18,15 +18,39 @@ _* *{Initial RAM disk image (initrd)}*:
_* *{System image}*: The operating system's filesystem image. Usually, a SquashFS compressed filesystem is used to minimize the Debian Live image size. Note that it is read-only. So, during boot the Debian Live system will use a RAM disk and 'union' mechanism to enable writing files within the running system. However, all modifications will be lost upon shutdown unless optional persistence is used (see {Persistence}#persistence).
-_* *{Bootloader}*: A small piece of code crafted to boot from the chosen media, possibly presenting a prompt or menu to allow selection of options/configuration. It loads the Linux kernel and its initrd to run with an associated system filesystem. Different solutions can be used, depending on the target media and format of the filesystem containing the previously mentioned components: isolinux to boot from a CD or DVD in ISO9660 format, syslinux for HDD or USB drive booting from a VFAT partition, extlinux for ext2/3/4 and btrfs partitions, pxelinux for PXE netboot, GRUB for ext2/3/4 partitions, etc.
+_* *{Bootloader}*: A small piece of code crafted to boot from the chosen medium, possibly presenting a prompt or menu to allow selection of options/configuration. It loads the Linux kernel and its initrd to run with an associated system filesystem. Different solutions can be used, depending on the target medium and format of the filesystem containing the previously mentioned components: isolinux to boot from a CD or DVD in ISO9660 format, syslinux for HDD or USB drive booting from a VFAT partition, extlinux for ext2/3/4 and btrfs partitions, pxelinux for PXE netboot, GRUB for ext2/3/4 partitions, etc.
-You can use live-build to build the system image from your specifications, set up a Linux kernel, its initrd, and a bootloader to run them, all in one media-dependant format (ISO9660 image, disk image, etc.).
+You can use live-build to build the system image from your specifications, set up a Linux kernel, its initrd, and a bootloader to run them, all in one medium-dependant format (ISO9660 image, disk image, etc.).
+
+2~downloading-prebuilt-images Downloading prebuilt images
+
+While the focus of this manual is developing and building your own live images, you may simply wish to try one of our prebuilt images, either as an introduction to their use or instead of building your own. These images are built using our {live-images git repository}#clone-configuration-via-git and official stable releases are published at http://www.debian.org/CD/live/. In addition, older and upcoming releases, and unofficial images containing non-free firmware and drivers are available at http://live.debian.net/cdimage/release/.
+
+2~using-web-builder Using the web live image builder
+
+As a service to the community, we run a web-based live image builder service at http://live-build.debian.net/. This site is maintained on a best effort basis. That is, although we strive to keep it up-to-date and operational at all times, and do issue notices for significant operational outages, we cannot guarantee 100% availability or fast image building, and the service may occasionally have issues that take some time to resolve. If you have problems or questions about the service, please {contact us}#contact, providing us with the link to your build.
+
+3~ Web builder usage and caveats
+
+The web interface currently makes no provision to prevent the use of invalid combinations of options, and in particular, where changing an option would normally (i.e. using live-build directly) change defaults of other options listed in the web form, the web builder does not change these defaults. Most notably, if you change #{--architectures}# from the default #{i386}# to #{amd64}#, you must change the corresponding option #{--linux-flavours}# from the default #{486}# to #{amd64}#. See the #{lb_config}# man page for the version of live-build installed on the web builder for more details. The version number of live-build is listed at the bottom of the web builder page.
+
+The time estimate given by the web builder is a crude estimate only and may not reflect how long your build actually takes. Nor is the estimate updated once it is displayed. Please be patient. Do not refresh the page you land on after submitting the build, as this will resubmit a new build with the same parameters. You should {contact us}#contact if you don't receive notification of your build only once you are certain you've waited long enough and verified the notification e-mail did not get caught by your own e-mail spam filter.
+
+The web builder is limited in the kinds of images it can build. This keeps it simple and efficient to use and maintain. If you would like to make customizations that are not provided for by the web interface, the rest of this manual explains how to build your own images using live-build.
2~building-iso-hybrid First steps: building an ISO hybrid image
-Regardless of the image type, you will need to perform the same basic steps to build an image each time. As a first example, execute the following sequence of live-build commands to create a basic ISO hybrid image containing just the Debian standard system without X.org. It is suitable for burning to CD or DVD media, and also to copy onto a USB stick.
+Regardless of the image type, you will need to perform the same basic steps to build an image each time. As a first example, create a build directory, change to that directory and then execute the following sequence of live-build commands to create a basic ISO hybrid image containing a default live system without X.org. It is suitable for burning to CD or DVD media, and also to copy onto a USB stick.
+
+The name of the working directory is absolutely up to you, but if you take a look at the examples used throughout live-manual, it is a good idea to use a name that helps you identify the image you are working with in each directory, especially if you are working or experimenting with different image types. In this case you are going to build a default system so let's call it, for example, live-default.
+
+code{
+
+ $ mkdir live-default && cd live-default
-First, run the #{lb config}# command. This will create a "config/" hierarchy in the current directory for use by other commands:
+}code
+
+Then, run the #{lb config}# command. This will create a "config/" hierarchy in the current directory for use by other commands:
code{
@@ -44,27 +68,27 @@ code{
}code
-This process can take a while, depending on the speed of your network connection. When it is complete, there should be a #{binary.hybrid.iso}# image file, ready to use, in the current directory.
+This process can take a while, depending on the speed of your computer and your network connection. When it is complete, there should be a #{binary.hybrid.iso}# image file, ready to use, in the current directory.
2~using-iso-hybrid Using an ISO hybrid live image
-After either building or downloading an ISO hybrid image, which can be obtained at http://www.debian.org/CD/live/, the usual next step is to prepare your media for booting, either CD-R(W) or DVD-R(W) optical media or a USB stick.
+After either building or downloading an ISO hybrid image, which can be obtained at http://www.debian.org/CD/live/, the usual next step is to prepare your medium for booting, either CD-R(W) or DVD-R(W) optical media or a USB stick.
3~burning-iso-image Burning an ISO image to a physical medium
-Burning an ISO image is easy. Just install wodim and use it from the command-line to burn the image. For instance:
+Burning an ISO image is easy. Just install /{xorriso}/ and use it from the command-line to burn the image. For instance:
code{
- # apt-get install wodim
+ # apt-get install xorriso
- $ wodim binary.hybrid.iso
+ $ xorriso -as cdrecord -v dev=/dev/sr0 blank=as_needed binary.hybrid.iso
}code
3~copying-iso-hybrid-to-usb Copying an ISO hybrid image to a USB stick
-ISO images prepared with the #{isohybrid}# command, like the images produced by the default #{iso-hybrid}# binary image type, can be simply copied to a USB stick with the #{dd}# program or an equivalent. Plug in a USB stick with a size large enough for your image file and determine which device it is, which we hereafter refer to as #{${USBSTICK}}#. This is the device file of your key, such as #{/dev/sdb}#, not a partition, such as #{/dev/sdb1}#! You can find the right device name by looking in #{dmesg}#'s output after plugging in the stick, or better yet, #{ls -l /dev/disk/by-id}#.
+ISO images prepared with #{xorriso}#, can be simply copied to a USB stick with the #{dd}# program or an equivalent. Plug in a USB stick with a size large enough for your image file and determine which device it is, which we hereafter refer to as #{${USBSTICK}}#. This is the device file of your key, such as #{/dev/sdb}#, not a partition, such as #{/dev/sdb1}#! You can find the right device name by looking in #{dmesg}#'s output after plugging in the stick, or better yet, #{ls -l /dev/disk/by-id}#.
Once you are certain you have the correct device name, use the #{dd}# command to copy the image to the stick.
*{This will definitely overwrite any previous contents on your stick!}*
@@ -75,14 +99,35 @@ code{
}code
+3~using-usb-extra-space Using the space left on a USB stick
+
+To use the remaining free space after copying #{binary.hybrid.iso}# to a USB stick, use a partitioning tool such as /{gparted}/ or /{parted}/ to create a new partition on the stick. The first partition will be used by the Debian Live system.
+
+code{
+
+ # gparted ${USBSTICK}
+
+}code
+
+After the partition is created, where #{${PARTITION}}# is the name of the partition, such as #{/dev/sdb2}#, you have to create a filesystem on it. One possible choice would be ext4.
+
+code{
+
+ # mkfs.ext4 ${PARTITION}
+
+}code
+
+*{Note:}* If you want to use the extra space with Windows, apparently that OS cannot normally access any partitions but the first. Some solutions to this problem have been discussed on our {mailing list}#contact, but it seems there are no easy answers.
+
+*{Remember: Every time you install a new binary.hybrid.iso on the stick, all data on the stick will be lost because the partition table is overwritten by the contents of the image, so back up your extra partition first to restore again after updating the live image.}*
-3~booting-live-media Booting the live media
+3~booting-live-medium Booting the live medium
-The first time you boot your live media, whether CD, DVD, USB key, or PXE boot, some setup in your computer's BIOS may be needed first. Since BIOSes vary greatly in features and key bindings, we cannot get into the topic in depth here. Some BIOSes provide a key to bring up a menu of boot devices at boot time, which is the easiest way if it is available on your system. Otherwise, you need to enter the BIOS configuration menu and change the boot order to place the boot device for the live system before your normal boot device.
+The first time you boot your live medium, whether CD, DVD, USB key, or PXE boot, some setup in your computer's BIOS may be needed first. Since BIOSes vary greatly in features and key bindings, we cannot get into the topic in depth here. Some BIOSes provide a key to bring up a menu of boot devices at boot time, which is the easiest way if it is available on your system. Otherwise, you need to enter the BIOS configuration menu and change the boot order to place the boot device for the live system before your normal boot device.
-Once you've booted the media, you are presented with a boot menu. If you just press enter here, the system will boot using the default entry, #{Live}# and default options. For more information about boot options, see the "help" entry in the menu and also the live-boot and live-config man pages found within the live system.
+Once you've booted the medium, you are presented with a boot menu. If you just press enter here, the system will boot using the default entry, #{Live}# and default options. For more information about boot options, see the "help" entry in the menu and also the live-boot and live-config man pages found within the live system.
-Assuming you've selected #{Live}# and booted a default desktop live image, after the boot messages scroll by, you should be automatically logged into the #{user}# account and see a desktop, ready to use. If you've booted a console-only image, such as #{standard}# or #{rescue}# flavour prebuilt images, you should be automatically logged in on the console to the #{user}# account and see a shell prompt, ready to use.
+Assuming you've selected #{Live}# and booted a default desktop live image, after the boot messages scroll by, you should be automatically logged into the #{user}# account and see a desktop, ready to use. If you have booted a console-only image, such as #{standard}# or #{rescue}# flavour {prebuilt images}#downloading-prebuilt-images, you should be automatically logged in on the console to the #{user}# account and see a shell prompt, ready to use.
2~using-virtual-machine Using a virtual machine for testing
@@ -120,13 +165,13 @@ code{
See the man pages for more details.
-3~testing-iso-with-virtualbox Testing an ISO image with virtualbox-ose
+3~testing-iso-with-virtualbox Testing an ISO image with virtualbox
-In order to test the ISO with /{virtualbox-ose}/:
+In order to test the ISO with /{virtualbox}/:
code{
- # apt-get install virtualbox-ose virtualbox-ose-dkms
+ # apt-get install virtualbox virtualbox-qt virtualbox-dkms
$ virtualbox
@@ -134,17 +179,25 @@ code{
Create a new virtual machine, change the storage settings to use #{binary.hybrid.iso}# as the CD/DVD device, and start the machine.
-*{Note:}* For live systems containing X.org that you want to test with /{virtualbox-ose}/, you may wish to include the VirtualBox X.org driver package, /{virtualbox-ose-guest-x11}/, in your live-build configuration. Otherwise, the resolution is limited to 800x600.
+*{Note:}* For live systems containing X.org that you want to test with /{virtualbox}/, you may wish to include the VirtualBox X.org driver package, /{virtualbox-guest-dkms}/ and /{virtualbox-guest-x11}/, in your live-build configuration. Otherwise, the resolution is limited to 800x600.
+
+code{
+
+ $ echo "virtualbox-guest-dkms virtualbox-guest-x11" >> config/package-lists/my.list.chroot
+
+}code
+
+In order to make the dkms package work, also the kernel headers for the kernel flavour used in your image need to be installed. Instead of manually listing the correct /{linux-headers}/ package in above created package list, the selection of the right package can be done automatically by live-build.
code{
- $ echo virtualbox-ose-guest-x11 >> config/package-lists/my.list.chroot
+ $ lb config --linux-packages "linux-image linux-header"
}code
-2~building-hdd Building an HDD image
+2~using-hdd-image Building and using an HDD image
-Building an HDD image is similar to ISO hybrid in all respects except you specify #{-b hdd}# and the resulting filename is #{binary.img}# which cannot be burnt to optical media. It is suitable for booting from USB sticks, USB hard drives, and various other portable storage devices. Normally, an ISO hybrid image can be used for this purpose instead, but if you have a BIOS which does not handle hybrid images properly, or want to use the remaining space on the media for some purpose, such as a persistence partition, you need an HDD image.
+Building an HDD image is similar to an ISO hybrid one in all respects except you specify #{-b hdd}# and the resulting filename is #{binary.img}# which cannot be burnt to optical media. It is suitable for booting from USB sticks, USB hard drives, and various other portable storage devices. Normally, an ISO hybrid image can be used for this purpose instead, but if you have a BIOS which does not handle hybrid images properly, you need an HDD image.
*{Note:}* if you created an ISO hybrid image with the previous example, you will need to clean up your working directory with the #{lb clean}# command (see {The lb clean command}#lb-clean):
@@ -172,13 +225,9 @@ code{
When the build finishes, a #{binary.img}# file should be present in the current directory.
-2~using-hdd-image Using an HDD image
-
-The generated binary image contains a VFAT partition and the syslinux bootloader, ready to be directly written on a USB stick. Since using an HDD image is just like using an ISO hybrid image on USB, follow the instructions in {Using an ISO hybrid live image}#using-iso-hybrid, except use the filename #{binary.img}# instead of #{binary.hybrid.iso}#.
+The generated binary image contains a VFAT partition and the syslinux bootloader, ready to be directly written on a USB device. Once again, using an HDD image is just like using an ISO hybrid one on USB. Follow the instructions in {Using an ISO hybrid live image}#using-iso-hybrid, except use the filename #{binary.img}# instead of #{binary.hybrid.iso}#.
-3~testing-hdd-with-qemu Testing an HDD image with Qemu
-
-First, install /{qemu}/ as described above in {Testing an ISO image with QEMU}#testing-iso-with-qemu. Then run #{kvm}# or #{qemu}#, depending on which version your host system needs, specifying #{binary.img}# as the first hard drive.
+Likewise, to test an HDD image with Qemu, install /{qemu}/ as described above in {Testing an ISO image with QEMU}#testing-iso-with-qemu. Then run #{kvm}# or #{qemu}#, depending on which version your host system needs, specifying #{binary.img}# as the first hard drive.
code{
@@ -186,49 +235,29 @@ code{
}code
-3~using-usb-extra-space Using the space left on a USB stick
-
-To use the remaining free space after copying #{binary.img}# to a USB stick, use a partitioning tool such as /{gparted}/ or /{parted}/ to create a new partition on the stick. The first partition will be used by the Debian Live system.
-
-code{
-
- # gparted ${USBSTICK}
-
-}code
-
-After the partition is created, where #{${PARTITION}}# is the name of the partition, such as #{/dev/sdb2}#, you have to create a filesystem on it. One possible choice would be ext4.
-
-code{
-
- # mkfs.ext4 ${PARTITION}
-
-}code
-
-*{Note:}* If you want to use the extra space with Windows, apparently that OS cannot normally access any partitions but the first. Some solutions to this problem have been discussed on our {mailing list}#contact, but it seems there are no easy answers.
-
-*{Remember: Every time you install a new binary.img on the stick, all data on the stick will be lost because the partition table is overwritten by the contents of the image, so back up your extra partition first to restore again after updating the live image.}*
-
2~building-netboot-image Building a netboot image
-The following sequence of commands will create a basic netboot image containing the Debian standard system without X.org. It is suitable for booting over the network.
+The following sequence of commands will create a basic netboot image containing a default live system without X.org. It is suitable for booting over the network.
*{Note:}* if you performed any previous examples, you will need to clean up your working directory with the #{lb clean}# command:
code{
- # lb clean --binary
+ # lb clean
}code
+In this specific case, a #{lb clean --binary}# would be not enough to clean up the necessary stages. The cause for this is that in netboot setups, a different initramfs configuration needs to be used which live-build performs automatically when building netboot images. Since the initramfs creation belongs to the chroot stage, switching to netboot in an existing build directory means to rebuild the chroot stage too. Therefore, #{lb clean}# (which will remove the chroot stage, too) needs to be used.
+
Run the #{lb config}# command as follows to configure your image for netbooting:
code{
- $ lb config -b net --net-root-path "/srv/debian-live" --net-root-server "192.168.0.1"
+ $ lb config -b netboot --net-root-path "/srv/debian-live" --net-root-server "192.168.0.1"
}code
-In contrast with the ISO and HDD images, netbooting does not, itself, serve the filesystem image to the client, so the files must be served via NFS. The #{--net-root-path}# and #{--net-root-server}# options specify the location and server, respectively, of the NFS server where the filesytem image will be located at boot time. Make sure these are set to suitable values for your network and server.
+In contrast with the ISO and HDD images, netbooting does not, itself, serve the filesystem image to the client, so the files must be served via NFS. Different network filesystems can be chosen through lb config. The #{--net-root-path}# and #{--net-root-server}# options specify the location and server, respectively, of the NFS server where the filesytem image will be located at boot time. Make sure these are set to suitable values for your network and server.
Now build the image with the #{lb build}# command:
@@ -240,7 +269,7 @@ code{
In a network boot, the client runs a small piece of software which usually resides on the EPROM of the Ethernet card. This program sends a DHCP request to get an IP address and information about what to do next. Typically, the next step is getting a higher level bootloader via the TFTP protocol. That could be pxelinux, GRUB, or even boot directly to an operating system like Linux.
-For example, if you unpack the generated #{binary-net.tar.gz}# archive in the #{/srv/debian-live}# directory, you'll find the filesystem image in #{live/filesystem.squashfs}# and the kernel, initrd and pxelinux bootloader in #{tftpboot/debian-live/i386}#.
+For example, if you unpack the generated #{binary.netboot.tar}# archive in the #{/srv/debian-live}# directory, you'll find the filesystem image in #{live/filesystem.squashfs}# and the kernel, initrd and pxelinux bootloader in #{tftpboot/debian-live/i386}#.
We must now configure three services on the server to enable netboot: the DHCP server, the TFTP server and the NFS server.
@@ -308,13 +337,13 @@ code{
}code
-Setting up these three services can be a little tricky. You might need some patience to get all of them working together. For more information, see the syslinux wiki at http://syslinux.zytor.com/wiki/index.php/PXELINUX or the Debian Installer Manual's TFTP Net Booting section at http://d-i.alioth.debian.org/manual/en.i386/ch04s05.html. They might help, as their processes are very similar.
+Setting up these three services can be a little tricky. You might need some patience to get all of them working together. For more information, see the syslinux wiki at http://www.syslinux.org/wiki/index.php/PXELINUX or the Debian Installer Manual's TFTP Net Booting section at http://d-i.alioth.debian.org/manual/en.i386/ch04s05.html. They might help, as their processes are very similar.
3~ Netboot testing HowTo
-Netboot image creation is made easy with live-build magic, but testing the images on physical machines can be really time consuming.
+Netboot image creation is made easy with live-build, but testing the images on physical machines can be really time consuming.
-To make our life easier, we can use virtualization. There are two solutions.
+To make our life easier, we can use virtualization.
3~ Qemu
@@ -335,47 +364,6 @@ code{
}code
-Get, or build a #{grub-floppy-netboot}# (in the svn).
+Get, or build a #{grub-floppy-netboot}#.
Launch #{qemu}# with "#{-net nic,vlan=0 -net tap,vlan=0,ifname=tun0}#"
-
-3~ VMWare Player
-
-_* Install VMWare Player ("free as in beer" edition)
-
-_* Create a PXETester directory, and create a text file called #{pxe.vwx}# inside
-
-_* Paste this text inside:
-
-code{
-
- #!/usr/bin/vmware
- config.version = "8"
- virtualHW.version = "4"
- memsize = "512"
- MemAllowAutoScaleDown = "FALSE"
-
- ide0:0.present = "FALSE"
- ide1:0.present = "FALSE"
- floppy0.present = "FALSE"
- sound.present = "FALSE"
- tools.remindInstall = "FALSE"
-
- ethernet0.present = "TRUE"
- ethernet0.addressType = "generated"
-
- displayName = "Test Boot PXE"
- guestOS = "other"
-
- ethernet0.generatedAddress = "00:0c:29:8d:71:3b"
- uuid.location = "56 4d 83 72 5c c4 de 3f-ae 9e 07 91 1d 8d 71 3b"
- uuid.bios = "56 4d 83 72 5c c4 de 3f-ae 9e 07 91 1d 8d 71 3b"
- ethernet0.generatedAddressOffset = "0"
-
-}code
-
-_* You can play with this configuration file (e.g. change memory limit to 256)
-
-_* Double click on this file (or run VMWare player and select this file).
-
-_* When running just press space if that strange question comes up...
diff -Naurp live-manual.orig/manual/en/user_customization-binary.ssi live-manual/manual/en/user_customization-binary.ssi
--- live-manual.orig/manual/en/user_customization-binary.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_customization-binary.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -1,26 +1,16 @@
-B~ Customizing the binary image
+:B~ Customizing the binary image
1~customizing-binary Customizing the binary image
2~ Bootloader
-live-build uses /{syslinux}/ and some of its derivatives (depending on the image type) as bootloaders by default. You can easily customize them in a number of ways that range from providing a full theme to changing the boot timeout or simply adding a personalized splash image. Some of the following examples of customization make use of different methods, like {includes}#includes or {hooks}#hooks.
+live-build uses /{syslinux}/ and some of its derivatives (depending on the image type) as bootloaders by default. They can be easily customized in two ways.
-If you want to use a full theme you can specify the #{--syslinux-theme}# option (see man #{lb_config}#). live-build will then retrieve the theme from the mirror and install it.
-
-Imagine that you want to build a progress client but you prefer to include the server's theme because you want to have the help menu. Then you would launch #{lb config}# as follows:
-
-code{
-
- $ lb config --mode progress --syslinux-theme progress-server
-
-}code
-
-You can also create your own theme or modify an already existing one and if you do not have a mirror, you can add the package to #{config/packages.chroot}#. In this case it is not necessary to specify any option.
+In order to use a full theme, copy #{/usr/share/live/build/bootloaders}# into #{config/bootloaders}# and edit files in there. If you do not want to bother modifying all supported bootloader configurations, only providing a local customized copy of one of the bootloaders, e.g. *{isolinux}* in #{config/bootloaders/isolinux}# is enough too, depending on your use case.
There is also the possibility of making smaller changes. For instance, syslinux derivatives are configured by default with a timeout of 0 (zero) which means that they will pause indefinitely at their splash screen until you press a key.
-To modify the boot timeout of a default #{iso-hybrid}# image you can edit a default *{isolinux.cfg}* file specifying the timeout in units of seconds and add it to #{config/includes.binary/isolinux/}#
+To modify the boot timeout of a default #{iso-hybrid}# image just edit a default *{isolinux.cfg}* file specifying the timeout in units of seconds and add it to #{config/includes.binary/isolinux/}#
A modified *{isolinux.cfg}* to boot after five seconds would be similar to this:
@@ -33,17 +23,17 @@ code{
}code
-An alternative way of achieving the same goal could be writing a hook and adding it to #{config/hooks/}# Remember to add the #{.binary}# suffix to run in the binary stage. A proposed example:
+An alternative way of achieving the same goal could be writing a hook and adding it to #{config/hooks/}#. Remember to add the #{.binary}# suffix to run in the binary stage. A proposed example:
code{
#!/bin/sh
- sed -i 's|timeout 0|timeout 50|' binary/isolinux/isolinux.cfg
+ sed -i -e 's|timeout 0|timeout 50|' binary/isolinux/isolinux.cfg
}code
-Likewise, if you want to use a personalized splash.png image you can add a picture of 640x480 pixels to #{config/includes.binary/isolinux/}#
+Likewise, if you want to use a personalized splash.png image, add a picture of 640x480 pixels to #{config/includes.binary/isolinux/}#
2~ ISO metadata
diff -Naurp live-manual.orig/manual/en/user_customization-contents.ssi live-manual/manual/en/user_customization-contents.ssi
--- live-manual.orig/manual/en/user_customization-contents.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_customization-contents.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -6,14 +6,12 @@ This chapter discusses fine-tuning custo
2~includes Includes
-While ideally a Debian live system would include files entirely provided by unmodified Debian packages, it is sometimes convenient to provide or modify some content by means of files. Using includes, it is possible to add (or replace) arbitrary files in your Debian Live image. live-build provides three mechanisms for using them:
+While ideally a Debian live system would include files entirely provided by unmodified Debian packages, it is sometimes convenient to provide or modify some content by means of files. Using includes, it is possible to add (or replace) arbitrary files in your Debian Live image. live-build provides two mechanisms for using them:
_* Chroot local includes: These allow you to add or replace files to the chroot/Live filesystem. Please see {Live/chroot local includes}#live-chroot-local-includes for more information.
_* Binary local includes: These allow you to add or replace files in the binary image. Please see {Binary local includes}#binary-local-includes for more information.
-_* Binary includes: These allow you to add or replace Debian specific files in the binary image, such as the templates and tools directories. Please see {Binary includes}#binary-includes for more information.
-
Please see {Terms}#terms for more information about the distinction between the "Live" and "binary" images.
3~live-chroot-local-includes Live/chroot local includes
@@ -40,7 +38,6 @@ code{
| `-- www
| `-- index.html
[...]
- `-- templates
}code
@@ -48,7 +45,7 @@ Chroot local includes are installed afte
3~binary-local-includes Binary local includes
-To include material such as documentation or videos on the media filesystem so that it is accessible immediately upon insertion of the media without booting the Live system, you can use binary local includes. This works in a similar fashion to chroot local includes. For example, suppose the files #{~/video_demo.*}# are demo videos of the live system described by and linked to by an HTML index page. Simply copy the material to #{config/includes.binary/}# as follows:
+To include material such as documentation or videos on the medium filesystem so that it is accessible immediately upon insertion of the medium without booting the Live system, you can use binary local includes. This works in a similar fashion to chroot local includes. For example, suppose the files #{~/video_demo.*}# are demo videos of the live system described by and linked to by an HTML index page. Simply copy the material to #{config/includes.binary/}# as follows:
code{
@@ -56,19 +53,7 @@ code{
}code
-These files will now appear in the root directory of the live media.
-
-3~binary-includes Binary includes
-
-live-build has some standard files (like documentation) that gets included in the default configuration on every live media. This can be disabled with:
-
-code{
-
- $ lb config --includes none
-
-}code
-
-Otherwise, the material will be installed by live-build in #{/includes/}# by default on the media filesystem, or else you can specify an alternate path with #{--includes}#.
+These files will now appear in the root directory of the live medium.
2~hooks Hooks
@@ -76,7 +61,7 @@ Hooks allow commands to be performed in
3~live-chroot-local-hooks Live/chroot local hooks
-To run commands in the chroot stage, create a hook script with a #{.chroot}# suffix containing the commands in the #{config/hooks/}# directory. The hook will run in the chroot after the rest of your chroot configuration has been applied, so remember to ensure your configuration includes all packages and files your hook needs in order to run. See the example chroot hook scripts for various common chroot customization tasks provided in #{/usr/share/live/build/examples/hooks}# which you can copy or symlink to use them in your own configuration.
+To run commands in the chroot stage, create a hook script with a #{.chroot}# suffix containing the commands in the #{config/hooks/}# directory. The hook will run in the chroot after the rest of your chroot configuration has been applied, so remember to ensure your configuration includes all packages and files your hook needs in order to run. See the example chroot hook scripts for various common chroot customization tasks provided in #{/usr/share/doc/live-build/examples/hooks}# which you can copy or symlink to use them in your own configuration.
3~boot-time-hooks Boot-time hooks
@@ -84,10 +69,10 @@ To execute commands at boot time, you ca
3~ Binary local hooks
-To run commands in the binary stage, create a hook script with a #{.binary}# suffix containing the commands in the #{config/hooks/}# directory. The hook will run after all other binary commands are run, but before binary_checksums, the very last binary command. The commands in your hook do not run in the chroot, so take care to not modify any files outside of the build tree, or you may damage your build system! See the example binary hook scripts for various common binary customization tasks provided in #{/usr/share/live/build/examples/hooks}# which you can copy or symlink to use them in your own configuration.
+To run commands in the binary stage, create a hook script with a #{.binary}# suffix containing the commands in the #{config/hooks/}# directory. The hook will run after all other binary commands are run, but before binary_checksums, the very last binary command. The commands in your hook do not run in the chroot, so take care to not modify any files outside of the build tree, or you may damage your build system! See the example binary hook scripts for various common binary customization tasks provided in #{/usr/share/doc/live-build/examples/hooks}# which you can copy or symlink to use them in your own configuration.
2~ Preseeding Debconf questions
-Files in the #{config/preseed/}# directory suffixed with #{.preseed}# followed by the stage (#{.chroot}# or #{.binary}#) are considered to be debconf preseed files and are installed by live-build using #{debconf-set-selections}# during the corresponding stage.
+Files in the #{config/preseed/}# directory suffixed with #{.cfg}# followed by the stage (#{.chroot}# or #{.binary}#) are considered to be debconf preseed files and are installed by live-build using #{debconf-set-selections}# during the corresponding stage.
For more information about debconf, please see #{debconf(7)}# in the /{debconf}/ package.
diff -Naurp live-manual.orig/manual/en/user_customization-installer.ssi live-manual/manual/en/user_customization-installer.ssi
--- live-manual.orig/manual/en/user_customization-installer.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_customization-installer.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -10,19 +10,19 @@ Please note the careful use of capital l
The three main types of installer are:
-*{"Regular" Debian Installer}*: This is a normal Debian Live image with a separate kernel and initrd which (when selected from the appropriate bootloader) launches into a standard Debian Installer instance, just as if you had downloaded a CD image of Debian and booted it. Images containing a live system and such an otherwise independent installer are often referred to as "combined images".
+*{"Normal" Debian Installer}*: This is a normal Debian Live image with a separate kernel and initrd which (when selected from the appropriate bootloader) launches into a standard Debian Installer instance, just as if you had downloaded a CD image of Debian and booted it. Images containing a live system and such an otherwise independent installer are often referred to as "combined images".
-On such images, Debian is installed by fetching and installing .deb packages using /{debootstrap}/ or /{cdebootstrap}/, from the local media or some network-based network, resulting in a standard Debian system being installed to the hard disk.
+On such images, Debian is installed by fetching and installing .deb packages using /{debootstrap}/, from local media or some network-based network, resulting in a default Debian system being installed to the hard disk.
This whole process can be preseeded and customized in a number of ways; see the relevant pages in the Debian Installer manual for more information. Once you have a working preseeding file, live-build can automatically put it in the image and enable it for you.
*{"Live" Debian Installer}*: This is a Debian Live image with a separate kernel and initrd which (when selected from the appropriate bootloader) launches into an instance of the Debian Installer.
-Installation will proceed in an identical fashion to the "Regular" installation described above, but at the actual package installation stage, instead of using /{debootstrap}/ to fetch and install packages, the live filesystem image is copied to the target. This is achieved with a special udeb called live-installer.
+Installation will proceed in an identical fashion to the "normal" installation described above, but at the actual package installation stage, instead of using /{debootstrap}/ to fetch and install packages, the live filesystem image is copied to the target. This is achieved with a special udeb called live-installer.
After this stage, the Debian Installer continues as normal, installing and configuring items such as bootloaders and local users, etc.
-*{Note:}* to support both normal and live installer entries in the bootloader of the same live media, you must disable live-installer by preseeding #{live-installer/enable=false}#.
+*{Note:}* to support both normal and live installer entries in the bootloader of the same live medium, you must disable live-installer by preseeding #{live-installer/enable=false}#.
*{"Desktop" Debian Installer}*: Regardless of the type of Debian Installer included, #{d-i}# can be launched from the Desktop by clicking on an icon. This is user friendlier in some situations. In order to make use of this, the debian-installer-launcher package needs to be included.
@@ -31,22 +31,22 @@ Note that by default, live-build does no
code{
$ lb config --architectures i386 --linux-flavours 486 \
- --debian-installer live
+ --debian-installer live
$ echo debian-installer-launcher >> config/package-lists/my.list.chroot
}code
2~ Customizing Debian Installer by preseeding
-As described in the Debian Installer Manual, Appendix B at http://www.debian.org/releases/stable/i386/apb.html, "Preseeding provides a way to set answers to questions asked during the installation process, without having to manually enter the answers while the installation is running. This makes it possible to fully automate most types of installation and even offers some features not available during normal installations." This kind of customization is best accomplished with live-build by placing the configuration in a #{preseed.cfg}# file included in #{config/binary_debian-installer/}#. For example, to preseed setting the locale to #{en_US}#:
+As described in the Debian Installer Manual, Appendix B at http://www.debian.org/releases/stable/i386/apb.html, "Preseeding provides a way to set answers to questions asked during the installation process, without having to manually enter the answers while the installation is running. This makes it possible to fully automate most types of installation and even offers some features not available during normal installations." This kind of customization is best accomplished with live-build by placing the configuration in a #{preseed.cfg}# file included in #{config/debian-installer/}#. For example, to preseed setting the locale to #{en_US}#:
code{
$ echo "d-i debian-installer/locale string en_US" \
- >> config/binary_debian-installer/preseed.cfg
+ >> config/debian-installer/preseed.cfg
}code
2~ Customizing Debian Installer content
-For experimental or debugging purposes, you might want to include locally built #{d-i}# component udeb packages. Place these in #{config/packages.binary/}# to include them in the image. Additional or replacement files and directories may be included in the installer initrd as well, in a similar fashion to {Live/chroot local includes}#live-chroot-local-includes, by placing the material in #{config/includes.binary_debian-installer/}#.
+For experimental or debugging purposes, you might want to include locally built #{d-i}# component udeb packages. Place these in #{config/packages.binary/}# to include them in the image. Additional or replacement files and directories may be included in the installer initrd as well, in a similar fashion to {Live/chroot local includes}#live-chroot-local-includes, by placing the material in #{config/includes.debian-installer/}#.
diff -Naurp live-manual.orig/manual/en/user_customization-overview.ssi live-manual/manual/en/user_customization-overview.ssi
--- live-manual.orig/manual/en/user_customization-overview.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_customization-overview.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -12,9 +12,9 @@ Build-time configuration options are des
2~stages-of-the-build Stages of the build
-The build process is divided into stages, with various customizations applied in sequence in each. The first stage to run is the *{bootstrap}* stage. This is the initial phase of populating the chroot directory with packages to make a barebones Debian system. This is followed by the *{chroot}* stage, which completes the construction of chroot directory, populating it with all of the packages listed in the configuration, along with any other materials. Most customization of content occurs in this stage. The final stage of preparing the live image is the *{binary}* stage, which builds a bootable image, using the contents of the chroot directory to construct the root filesystem for the Live system, and including the installer and any other additional material on the target media outside of the Live system's filesystem. After the live image is built, if enabled, the source tarball is built in the *{source}* stage.
+The build process is divided into stages, with various customizations applied in sequence in each. The first stage to run is the *{bootstrap}* stage. This is the initial phase of populating the chroot directory with packages to make a barebones Debian system. This is followed by the *{chroot}* stage, which completes the construction of chroot directory, populating it with all of the packages listed in the configuration, along with any other materials. Most customization of content occurs in this stage. The final stage of preparing the live image is the *{binary}* stage, which builds a bootable image, using the contents of the chroot directory to construct the root filesystem for the Live system, and including the installer and any other additional material on the target medium outside of the Live system's filesystem. After the live image is built, if enabled, the source tarball is built in the *{source}* stage.
-Within each of these stages, there is a particular sequence in which commands are applied. These are arranged in such a way as to ensure customizations can be layered in a reasonable fashion. For example, within the *{chroot}* stage, preseeds are applied before any packages are installed, packages are installed before any locally included files or patches are applied, and hooks are run later, after all of the materials are in place.
+Within each of these stages, there is a particular sequence in which commands are applied. These are arranged in such a way as to ensure customizations can be layered in a reasonable fashion. For example, within the *{chroot}* stage, preseeds are applied before any packages are installed, packages are installed before any locally included files are copied, and hooks are run later, after all of the materials are in place.
2~ Supplement lb config with files
diff -Naurp live-manual.orig/manual/en/user_customization-packages.ssi live-manual/manual/en/user_customization-packages.ssi
--- live-manual.orig/manual/en/user_customization-packages.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_customization-packages.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -2,7 +2,7 @@
1~customizing-package-installation Customizing package installation
-Perhaps the most basic customization of a Debian live system is the selection of packages to be included in the image. This chapter guides you through the various build-time options to customize live-build's installation of packages. The broadest choices influencing which packages are available to install in the image are the distribution and archive areas. To ensure decent download speeds, you should choose a nearby distribution mirror. You can also add your own repositories for backports, experimental or custom packages, or include packages directly as files. You can define your own lists of packages to include, use live-build's predefined lists, use /{tasksel}/ tasks, or a combination of all three. Finally, a number of options give some control over /{apt}/, or if you prefer, /{aptitude}/, at build time when packages are installed. You may find these handy if you use a proxy, want to disable installation of recommended packages to save space, or need to control which versions of packages are installed via APT pinning, to name a few possibilities.
+Perhaps the most basic customization of a Debian live system is the selection of packages to be included in the image. This chapter guides you through the various build-time options to customize live-build's installation of packages. The broadest choices influencing which packages are available to install in the image are the distribution and archive areas. To ensure decent download speeds, you should choose a nearby distribution mirror. You can also add your own repositories for backports, experimental or custom packages, or include packages directly as files. You can define lists of packages, including metapackages which will install many related packages at once, such as packages for a particular desktop or language. Finally, a number of options give some control over /{apt}/, or if you prefer, /{aptitude}/, at build time when packages are installed. You may find these handy if you use a proxy, want to disable installation of recommended packages to save space, or need to control which versions of packages are installed via APT pinning, to name a few possibilities.
2~ Package sources
@@ -20,17 +20,17 @@ Within the distribution archive, archive
code{
- $ lb config --archive-areas "main contrib"
+ $ lb config --archive-areas "main contrib non-free"
}code
-Experimental support is available for some Debian derivatives through a #{--mode}# option. By default, this option is set to #{debian}#, even if you are building on a non-Debian system. If you specify #{--mode ubuntu}# or #{--mode emdebian}#, the distribution names and archive areas for the specified derivative are supported instead of the ones for Debian. The mode also modifies live-build behaviour to suit the derivatives.
+Experimental support is available for some Debian derivatives through a #{--mode}# option. By default, this option is set to #{debian}# only if you are building on a Debian or on an unknown system. If #{lb config}# is invoked on any of the supported derivatives, it will default to create an image of that derivative. If #{lb config}# is run in e.g. #{ubuntu}# mode, the distribution names and archive areas for the specified derivative are supported instead of the ones for Debian. The mode also modifies live-build behaviour to suit the derivatives.
*{Note:}* The projects for whom these modes were added are primarily responsible for supporting users of these options. The Debian live project, in turn, provides development support on a best-effort basis only, based on feedback from the derivative projects as we do not develop or support these derivatives ourselves.
3~ Distribution mirrors
-The Debian archive is replicated across a large network of mirrors around the world so that people in each region can choose a nearby mirror for best download speed. Each of the #{--mirror-*}# options governs which distribution mirror is used at various stages of the build. Recall from {Stages of the build}#stages-of-the-build that the *{bootstrap}* stage is when the chroot is initially populated by /{debootstrap}/ with a minimal system, and the *{chroot}* stage is when the chroot used to construct the live system's filesystem is built. Thus, the corresponding mirror switches are used for those stages, and later, in the *{binary}* stage, the #{--mirror-binary}# and #{--mirror-binary-security}# values are used, superceding any mirrors used in an earlier stage.
+The Debian archive is replicated across a large network of mirrors around the world so that people in each region can choose a nearby mirror for best download speed. Each of the #{--mirror-*}# options governs which distribution mirror is used at various stages of the build. Recall from {Stages of the build}#stages-of-the-build that the *{bootstrap}* stage is when the chroot is initially populated by /{debootstrap}/ with a minimal system, and the *{chroot}* stage is when the chroot used to construct the live system's filesystem is built. Thus, the corresponding mirror switches are used for those stages, and later, in the *{binary}* stage, the #{--mirror-binary}# and #{--mirror-binary-security}# values are used, superseding any mirrors used in an earlier stage.
3~distribution-mirrors-build-time Distribution mirrors used at build time
@@ -39,8 +39,8 @@ To set the distribution mirrors used at
code{
$ lb config --mirror-bootstrap http://localhost/debian/ \
- --mirror-chroot-security http://localhost/debian-security/ \
- --mirror-chroot-backports http://localhost/debian-backports/
+ --mirror-chroot-security http://localhost/debian-security/ \
+ --mirror-chroot-backports http://localhost/debian-backports/
}code
@@ -48,12 +48,13 @@ The chroot mirror, specified by #{--mirr
3~ Distribution mirrors used at run time
-The #{--mirror-binary*}# options govern the distribution mirrors placed in the binary image. These may be used to install additional packages while running the live system. The defaults employ #{cdn.debian.net}#, a service that chooses a geographically close mirror based on the user's IP number. This is a suitable choice when you cannot predict which mirror will be best for all of your users. Or you may specify your own values as shown in the example below. An image built from this configuration would only be suitable for users on a network where "#{mirror}#" is reachable.
+The #{--mirror-binary*}# options govern the distribution mirrors placed in the binary image. These may be used to install additional packages while running the live system. The defaults employ #{http.debian.net}#, a service that chooses a geographically close mirror based, among other things, on the user's IP family and the availability of the mirrors. This is a suitable choice when you cannot predict which mirror will be best for all of your users. Or you may specify your own values as shown in the example below. An image built from this configuration would only be suitable for users on a network where "#{mirror}#" is reachable.
code{
$ lb config --mirror-binary http://mirror/debian/ \
- --mirror-binary-security http://mirror/debian-security/
+ --mirror-binary-security http://mirror/debian-security/ \
+ --mirror-binary-backports http://mirror/debian-backports/
}code
@@ -61,7 +62,7 @@ code{
You may add more repositories, broadening your package choices beyond what is available in your target distribution. These may be, for example, for backports, experimental or custom packages. To configure additional repositories, create #{config/archives/your-repository.list.chroot}#, and/or #{config/archives/your-repository.list.binary}# files. As with the #{--mirror-*}# options, these govern the repositories used in the *{chroot}* stage when building the image, and in the *{binary}* stage, i.e. for use when running the live system.
-For example, #{config/archives/live.list.chroot}# allows you to install packages from the debian live snapshot repository at live system build time.
+For example, #{config/archives/live.list.chroot}# allows you to install packages from the debian-live snapshot repository at live system build time.
code{
@@ -75,6 +76,8 @@ If such files exist, they will be picked
You should also put the GPG key used to sign the repository into #{config/archives/your-repository.key.{binary,chroot}}# files.
+Should you need custom APT pinning, such APT preferences snippets can be placed in #{config/archives/your-repository.pref.{binary,chroot}}# files and will be automatically added to your live system's #{/etc/apt/preferences.d/}# directory.
+
*{Note:}* some preconfigured package repositories are available for easy selection through the #{--archives}# option, e.g. for enabling live snapshots, a simple command is enough to enable it:
code{
@@ -85,48 +88,65 @@ code{
2~choosing-packages-to-install Choosing packages to install
-There are a number of ways to choose which packages live-build will install in your image, covering a variety of different needs. You can simply name individual packages to install in a package list. You can also choose predefined lists of packages, or use APT tasks. And finally, you may place package files in your #{config/}# tree, which is well suited to testing of new or experimental packages before they are available from a repository.
+There are a number of ways to choose which packages live-build will install in your image, covering a variety of different needs. You can simply name individual packages to install in a package list. You can also use metapackages in those lists, or select them using package control file fields. And finally, you may place package files in your #{config/}# tree, which is well suited to testing of new or experimental packages before they are available from a repository.
3~package-lists Package lists
-Package lists are a powerful way of expressing which packages should be installed. The list syntax supports included files and conditional sections which makes it easy to build lists from other lists and adapt them for use in multiple configurations. You can use predefined package lists, providing in a modular fashion package selections from each of the major desktop environments and some special purpose lists, as well as standard lists the others are based upon. You can also provide your own package lists, or use a combination of both.
+Package lists are a powerful way of expressing which packages should be installed. The list syntax supports conditional sections which makes it easy to build lists and adapt them for use in multiple configurations. Package names may also be injected into the list using shell helpers at build time.
*{Note:}* The behaviour of live-build when specifying a package that does not exist is determined by your choice of APT utility. See {Choosing apt or aptitude}#choosing-apt-or-aptitude for more details.
-3~ Predefined package lists
+3~using-metapackages Using metapackages
-The simplest way to use lists is to specify one or more predefined lists with the #{--package-lists}# option. For example:
+The simplest way to populate your package list is to use a task metapackage maintained by your distribution. For example:
code{
- $ lb config --package-lists "gnome rescue"
+ $ lb config
+ $ echo task-gnome-desktop > config/package-lists/desktop.list.chroot
}code
-The default location for the list files on your system is #{/usr/share/live/build/package-lists/}#. To determine the packages in a given list, read the corresponding file, paying attention to included files and conditionals as described in the following sections.
+This supercedes the older predefined list method supported in #{live-build}# 2.x. Unlike predefined lists, task metapackages are not specific to the Debian Live project. Instead, they are maintained by specialist working groups within the distribution and therefore reflect the consensus of each group about which packages best serve the needs of the intended users. They also cover a much broader range of use cases than the predefined lists they replace.
+
+All task metapackages are prefixed #{task-}#, so a quick way to determine which are available (though it may contain a handful of false hits that match the name but aren't metapackages) is to match on the package name with:
+
+code{
+
+ $ apt-cache search --names-only ^task-
+
+}code
+
+In addition to these, you will find other metapackages with various purposes. Some are subsets of broader task packages, like #{gnome-core}#, while others are individual specialized parts of a Debian Pure Blend, such as the #{education-*}# metapackages. To list all metapackages in the archive, install the #{debtags}# package and list all packages with the #{role::metapackage}# tag as follows:
+
+code{
+
+ $ debtags search role::metapackage
+
+}code
3~ Local package lists
-You may supplement the predefined lists using local package lists stored in #{config/package-lists/}#.
+Whether you list metapackages, individual packages, or a combination of both, all local package lists are stored in #{config/package-lists/}#. Since more than one list can be used, this lends itself well to modular designs. For example, you may decide to devote one list to a particular choice of desktop, another to a collection of related packages that might as easily be used on top of a different desktop. This allows you to experiment with different combinations of sets of packages with a minimum of fuss, sharing common lists between different live image projects.
Package lists that exist in this directory need to have a #{.list}# suffix in order to be processed, and then an additional stage suffix, #{.chroot}# or #{.binary}# to indicate which stage the list is for.
-*{Note:}* If you don't specify the stage suffix, the list will be used for both stages. Normally, you want to specify #{.list.chroot}# so that the packages will only be installed in the live filesystem and not have an extra copy of the #{.deb}# placed on the media.
+*{Note:}* If you don't specify the stage suffix, the list will be used for both stages. Normally, you want to specify #{.list.chroot}# so that the packages will only be installed in the live filesystem and not have an extra copy of the #{.deb}# placed on the medium.
3~ Local binary package lists
-To make a binary stage list, place a file suffixed with #{.list.binary}# in #{config/package-lists/}#. These packages are not installed in the live filesystem, but are included on the live media under #{pool/}#. You would typically use such a list with one of the non-live installer variants. As mentioned above, if you want this list to be the same as your chroot stage list, simply use the #{.list}# suffix by itself.
+To make a binary stage list, place a file suffixed with #{.list.binary}# in #{config/package-lists/}#. These packages are not installed in the live filesystem, but are included on the live medium under #{pool/}#. You would typically use such a list with one of the non-live installer variants. As mentioned above, if you want this list to be the same as your chroot stage list, simply use the #{.list}# suffix by itself.
-3~ Extending a provided package list using includes
+3~generated-package-lists Generated package lists
-The package lists that are included with live-build make extensive use of includes. Refer to these in the #{/usr/share/live/build/package-lists/}# directory, as they serve as good examples of how to write your own lists.
+It sometimes happens that the best way to compose a list is to generate it with a script. Any line starting with an exclamation point indicates a command to be executed within the chroot when the image is built. For example, one might include the line #{! grep-aptavail -n -sPackage -FPriority standard | sort}# in a package list to produce a sorted list of available packages with #{Priority: standard}#.
-For example, to make a list that includes the predefined #{gnome}# list plus /{iceweasel}/, create #{config/package-lists/my.list.chroot}# with the following contents:
+In fact, selecting packages with the #{grep-aptavail}# command (from the #{dctrl-tools}# package) is so useful that #{live-build}# provides a #{Packages}# helper script as a convenience. This script takes two arguments: #{field}# and #{pattern}#. Thus, you can create a list with the following contents:
code{
- #include <gnome>
- iceweasel
+ $ lb config
+ $ echo '! Packages Priority standard' > config/package-lists/standard.list.chroot
}code
@@ -164,61 +184,58 @@ code{
}code
-A conditional may surround an #{#include}# directive:
-
-code{
-
- #if ARCHITECTURES amd64
- #include <gnome-full>
- #endif
+The nesting of conditionals is not supported.
-}code
+3~desktop-and-language-tasks Desktop and language tasks
-The nesting of conditionals is not supported.
+Desktop and language tasks are special cases that need some extra planning and configuration. Live images are different from Debian Installer images in this respect. In the Debian Installer, if the medium was prepared for a particular desktop environment flavour, the corresponding task will be automatically installed. Thus, there are internal #{gnome-desktop}#, #{kde-desktop}#, #{lxde-desktop}# and #{xfce-desktop}# tasks, none of which are offered in #{tasksel}#'s menu. Likewise, there are no menu entries for tasks for languages, but the user's language choice during the install influences the selection of corresponding language tasks.
-3~ Tasks
+When developing a desktop live image, the image typically boots directly to a working desktop, the choices of both desktop and default language having been made at build time, not at run time as in the case of the Debian Installer. That's not to say that a live image couldn't be built to support multiple desktops or multiple languages and offer the user a choice, but that is not live-build's default behaviour.
-The Debian Installer offers the user choices of a number of preselected lists of packages, each one focused on a particular kind of system, or task a system may be used for, such as "Graphical desktop environment", "Mail server" or "Laptop". These lists are called "tasks" and are supported by APT through the "Task:" field. You can specify one or more tasks in live-build by putting them in a list in #{config/task-lists/}#, as in the example below.
+Because there is no provision made automatically for language tasks, which include such things as language-specific fonts and input-method packages, if you want them, you need to specify them in your configuration. For example, a GNOME desktop image containing support for German might include these task metapackages:
code{
$ lb config
- $ echo "mail-server file-server" >> config/task-lists/my.list.chroot
+ $ echo "task-gnome-desktop task-laptop" >> config/package-lists/my.list.chroot
+ $ echo "task-german task-german-desktop task-german-gnome-desktop" >> config/package-lists/my.list.chroot
}code
-The primary tasks available in the Debian Installer can be listed with #{tasksel --list-tasks}# in the live system. The contents of any task, including the ones not included in this list, may be examined with #{tasksel --task-packages}#.
+3~kernel-flavour-and-version Kernel flavour and version
-3~desktop-and-language-tasks Desktop and language tasks
-
-Desktop and language tasks are special cases that need some extra planning and configuration. Live images are different from Debian Installer images in this respect. In the Debian Installer, if the medium was prepared for a particular desktop environment flavour, the corresponding task will be automatically installed. Thus, there are internal #{gnome-desktop}#, #{kde-desktop}#, #{lxde-desktop}# and #{xfce-desktop}# tasks, none of which are offered in #{tasksel}#'s menu. Likewise, there are no menu entries for tasks for languages, but the user's language choice during the install influences the selection of corresponding language tasks.
+One or more kernel flavours will be included in your image by default, depending on the architecture. You can choose different flavours via the #{--linux-flavours}# option. Each flavour is suffixed to the default stub #{linux-image}# to form each metapackage name which in turn depends on an exact kernel package to be included in your image.
-When developing a desktop live image, the image typically boots directly to a working desktop, the choices of both desktop and default language having been made at build time, not at run time as in the case of the Debian Installer. That's not to say that a live image couldn't be built to support multiple desktops or multiple languages and offer the user a choice, but that is not live-build's default behaviour.
+Thus by default, an #{amd64}# architecture image will include the #{linux-image-amd64}# flavour metapackage, and an #{i386}# architecture image will include the #{linux-image-486}# and #{linux-image-686-pae}# metapackages. At time of writing, these packages depend on #{linux-image-3.2.0-4-amd64}#, #{linux-image-3.2.0-4-486}# and #{linux-image-3.2.0-4-686-pae}#, respectively.
-Because there is no provision made automatically for language tasks, which include such things as language-specific fonts and input-method packages, if you want them, you need to specify them in your configuration. For example, a GNOME desktop image containing support for Japanese might include these tasks:
+When more than one kernel package version is available in your configured archives, you can specify a different kernel package name stub with the #{--linux-packages}# option. For example, supposing you are building an #{amd64}# architecture image and add the experimental archive for testing purposes so you can install the #{linux-image-3.7-trunk-amd64}# kernel. You would configure that image as follows:
code{
- $ lb config
- $ echo "gnome-desktop desktop standard laptop" >> config/task-lists/my.list.chroot
- $ echo "japanese japanese-desktop japanese-gnome-desktop" >> config/task-lists/my.list.chroot
+ $ lb config --linux-packages linux-image-3.7-trunk
+ $ echo "deb http://ftp.debian.org/debian/ experimental main" > config/archives/experimental.list.chroot
}code
-Since desktop tasks are "internal" tasks, for every desktop flavour task included in the image, the corresponding value, if it differs from the default, "gnome", must be preseeded in the "tasksel/desktop" debconf variable or else tasksel will not recognize and install it. Thus:
+3~custom-kernels Custom kernels
-code{
+You can build and include your own custom kernels, so long as they are integrated within the Debian package management system. The live-build system does not support kernels not built as #{.deb}# packages.
- $ lb config
- $ echo 'tasksel tasksel/desktop multiselect kde' >> config/preseed/my.preseed.chroot
+The proper and recommended way to deploy your own kernel packages is to follow the instructions in the #{kernel-handbook}#. Remember to modify the ABI and flavour suffixes appropriately, then include a complete build of the #{linux}# and matching #{linux-latest}# packages in your reposistory.
-}code
+If you opt to build the kernel packages without the matching metapackages, you need to specify an appropriate #{--linux-packages}# stub as discussed in {Kernel flavour and version}#kernel-flavour-and-version. As we explain in {Installing modified or third-party packages}#installing-modified-or-third-party-packages, it is best if you include your custom kernel packages in your own repository, though the alternatives discussed in that section work as well.
+
+It is beyond the scope of this document to give advice on how to customize your kernel. However, you must at least ensure your configuration satisfies these minimum requirements:
+
+_* Use an initial ramdisk.
-This parameter can take multiple values, e.g. "lxde xfce" instead of "kde".
+_* Include the union filesystem module (i.e. usually #{aufs}#).
+
+_* Include any other filesystem modules required by your configuration (i.e. usually #{squashfs}#).
2~installing-modified-or-third-party-packages Installing modified or third-party packages
-Whilst it is against the philosophy of Debian Live, it may sometimes be necessary to build a Live system with modified versions of packages that are in the Debian repository. This may be to modify or support additional features, languages and branding, or even to remove elements of existing packages that are undesirable. Similarly, "third-party" packages may be used to add bespoke and/or proprietary functionality.
+While it is against the philosophy of Debian Live, it may sometimes be necessary to build a Live system with modified versions of packages that are in the Debian repository. This may be to modify or support additional features, languages and branding, or even to remove elements of existing packages that are undesirable. Similarly, "third-party" packages may be used to add bespoke and/or proprietary functionality.
This section does not cover advice regarding building or maintaining modified packages. Joachim Breitner's 'How to fork privately' method from http://www.joachim-breitner.de/blog/archives/282-How-to-fork-privately.html may be of interest, however. The creation of bespoke packages is covered in the Debian New Maintainers' Guide at http://www.debian.org/doc/maint-guide/ and elsewhere.
@@ -228,7 +245,7 @@ _* #{packages.chroot}#
_* Using a custom APT repository
-Using #{packages.chroot}# is simpler to achieve and useful for "one-off" customizations but has a number of drawbacks, whilst using a custom APT repository is more time-consuming to set up.
+Using #{packages.chroot}# is simpler to achieve and useful for "one-off" customizations but has a number of drawbacks, while using a custom APT repository is more time-consuming to set up.
3~ Using #{packages.chroot}# to install custom packages
@@ -248,7 +265,7 @@ _* It does not lend itself to storing De
Unlike using #{packages.chroot}#, when using a custom APT repository you must ensure that you specify the packages elsewhere. See {Choosing packages to install}#choosing-packages-to-install for details.
-Whilst it may seem unnecessary effort to create an APT repository to install custom packages, the infrastructure can be easily re-used at a later date to offer updates of the modified packages.
+While it may seem unnecessary effort to create an APT repository to install custom packages, the infrastructure can be easily re-used at a later date to offer updates of the modified packages.
3~ Custom packages and APT
@@ -278,9 +295,9 @@ code{
}code
-3~ Tweaking APT to save space
+3~tweaking-apt-to-save-space Tweaking APT to save space
-You may find yourself needing to save some space on the image media, in which case one or the other or both of the following options may be of interest.
+You may find yourself needing to save some space on the image medium, in which case one or the other or both of the following options may be of interest.
If you don't want to include APT indices in the image, you can omit those with:
@@ -292,7 +309,7 @@ code{
This will not influence the entries in #{/etc/apt/sources.list}#, but merely whether #{/var/lib/apt}# contains the indices files or not. The tradeoff is that APT needs those indices in order to operate in the live system, so before performing #{apt-cache search}# or #{apt-get install}#, for instance, the user must #{apt-get update}# first to create those indices.
-If you find the installation of recommended packages bloats your image too much, you may disable that default option of APT with:
+If you find the installation of recommended packages bloats your image too much, provided you are prepared to deal with the consequences discussed below, you may disable that default option of APT with:
code{
@@ -300,42 +317,46 @@ code{
}code
-The tradeoff here is that if you don't install recommended packages for a given package, that is, "packages that would be found together with this one in all but unusual installations" (Debian Policy Manual, section 7.2), some packages that you actually need may be omitted. Therefore, we suggest you review the difference turning off recommends makes to your packages list (see the #{binary.packages}# file generated by #{lb build}#) and re-include in your list any missing packages that you still want installed. Alternatively, if you find you only want a small number of recommended packages left out, leave recommends enabled and set a negative APT pin priority on selected packages to prevent them from being installed, as explained in {APT pinning}#apt-pinning.
+The most important consequence of turning off recommends is that #{live-boot}# and #{live-config}# themselves recommend some packages that provide important functionality used by most Live configurations, such as #{user-setup}# which #{live-config}# recommends and is used to create the live user. In all but the most exceptional circumstances you need to add back at least some of these recommends to your package lists or else your image will not work as expected, if at all. Look at the recommended packages for each of the #{live-*}# packages included in your build and if you are not certain you can omit them, add them back into your package lists.
+
+The more general consequence is that if you don't install recommended packages for any given package, that is, "packages that would be found together with this one in all but unusual installations" (Debian Policy Manual, section 7.2), some packages that users of your Live system actually need may be omitted. Therefore, we suggest you review the difference turning off recommends makes to your packages list (see the #{binary.packages}# file generated by #{lb build}#) and re-include in your list any missing packages that you still want installed. Alternatively, if you find you only want a small number of recommended packages left out, leave recommends enabled and set a negative APT pin priority on selected packages to prevent them from being installed, as explained in {APT pinning}#apt-pinning.
3~ Passing options to apt or aptitude
-If there is not a #{lb config}# option to alter APT's behaviour in the way you need, use #{--apt-options}# or #{--aptitude-options}# to pass any options through to your configured APT tool. See the man pages for #{apt}# and #{aptitude}# for details.
+If there is not a #{lb config}# option to alter APT's behaviour in the way you need, use #{--apt-options}# or #{--aptitude-options}# to pass any options through to your configured APT tool. See the man pages for #{apt}# and #{aptitude}# for details. Note that both options have default values that you will need to retain in addition to any overrides you may provide. So, for example, suppose you have included something from #{snapshot.debian.org}# for testing purposes and want to specify #{Acquire::Check-Valid-Until=false}# to make APT happy with the stale #{Release}# file, you would do so as per the following example, appending the new option after the default value #{--yes}#:
+
+code{
+
+ $ lb config --apt-options "--yes -oAcquire::Check-Valid-Until=false"
+
+}code
+
+Please check the man pages to fully understand these options and when to use them. This is an example only and should not be construed as advice to configure your image this way. This option would not be appropriate for, say, a final release of a live image.
+
+For more complicated APT configurations involving #{apt.conf}# options you might want to create a #{config/apt/apt.conf}# file instead. See also the other #{apt-*}# options for a few convenient shortcuts for frequently needed options.
3~apt-pinning APT pinning
-For background, please first read the #{apt_preferences(5)}# man page. APT pinning can be configured either for build time, or else for run time. For the former, create #{config/chroot_apt/preferences}#. For the latter, create #{config/includes.chroot/etc/apt/preferences}#.
+For background, please first read the #{apt_preferences(5)}# man page. APT pinning can be configured either for build time, or else for run time. For the former, create #{config/archives/*.pref}#, #{config/archives/*.pref.chroot}#, and #{config/apt/preferences}#. For the latter, create #{config/includes.chroot/etc/apt/preferences}#.
-Let's say you are building a wheezy live system but need all the live packages that end up in the binary image to be installed from sid at build time. You need to add sid to your APT sources and pin it so that only the packages you want are installed from it at build time and all others are taken from the target system distribution, wheezy. The following will accomplish this:
+Let's say you are building a wheezy live system but need all the live packages that end up in the binary image to be installed from sid at build time. You need to add sid to your APT sources and pin the live packages from it higher, but all other packages from it lower, than the default priority. Thus, only the packages you want are installed from sid at build time and all others are taken from the target system distribution, wheezy. The following will accomplish this:
code{
- $ echo "deb http://mirror/debian sid main" > config/archives/sid.list.chroot
- $ cat >> config/chroot_apt/preferences << END
- Package: live-boot live-boot-initramfs-tools live-config live-config-sysvinit
+ $ echo "deb http://mirror/debian/ sid main" > config/archives/sid.list.chroot
+ $ cat >> config/archives/sid.pref.chroot << EOF
+ Package: live-*
Pin: release n=sid
Pin-Priority: 600
Package: *
Pin: release n=sid
Pin-Priority: 1
- END
-
-}code
-
-*{Note:}* Wildcards can be used in package names (e.g. *{Package: live-*}*) with Apt version 0.8.14 or higher. This means that it works with wheezy using:
-
-code{
-
-$ lb config --distribution wheezy
+ EOF
}code
-Negative pin priorities will prevent a package from being installed, as in the case where you do not want a package that is recommended by another package. Suppose you are building an LXDE image using #{--package-lists lxde}# option, but don't want the user prompted to store wifi passwords in the keyring. This list includes /{gdm}/, which depends on /{gksu}/, which in turn recommends /{gnome-keyring}/. So you want to omit the recommended /{gnome-keyring}/ package. This can be done by adding the following stanza to #{config/chroot_apt/preferences}#:
+Negative pin priorities will prevent a package from being installed, as in the case where you do not want a package that is recommended by another package. Suppose you are building an LXDE image using #{task-lxde-desktop}# in #{config/package-lists/desktop.list.chroot}#, but don't want the user prompted to store wifi passwords in the keyring. This metapackage depends on /{lxde-core}/, which recommends /{gksu}/, which in turn recommends /{gnome-keyring}/. So you want to omit the recommended /{gnome-keyring}/ package. This can be done by adding the following stanza to #{config/apt/preferences}#:
code{
diff -Naurp live-manual.orig/manual/en/user_customization-runtime.ssi live-manual/manual/en/user_customization-runtime.ssi
--- live-manual.orig/manual/en/user_customization-runtime.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_customization-runtime.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -2,87 +2,96 @@
1~customizing-run-time-behaviours Customizing run time behaviours
-All configuration that is done during run time is done by live-config. Here are some of the most common options of live-config that users are interested in. A full list of all possibilities can be found in the manpage of live-config.
+All configuration that is done during run time is done by live-config. Here are some of the most common options of live-config that users are interested in. A full list of all possibilities can be found in the man page of live-config.
2~ Customizing the live user
One important consideration is that the live user is created by live-boot at boot time, not by live-build at build time. This not only influences where materials relating to the live user are introduced in your build, as discussed in {Live/chroot local includes}#live-chroot-local-includes, but also any groups and permissions associated with the live user.
-You can specify additional groups that the live user will belong to by preseeding the #{passwd/user-default-groups}# debconf value. For example, to add the live user to the #{fuse}# group, add the following preseed under #{config/preseed/}# for the chroot stage:
+You can specify additional groups that the live user will belong to by using any of the possibilities to configure live-config. For example, to add the live user to the #{fuse}# group, you can either add the following file in #{config/includes.chroot/etc/live/config/user-setup.conf}#:
code{
- $ lb config
- $ echo user-setup passwd/user-default-groups string audio cdrom \
- dip floppy video plugdev netdev powerdev scanner bluetooth fuse \
- >> config/preseed/my.preseed.chroot
+ LIVE_USER_DEFAULT_GROUPS="audio cdrom dip floppy video plugdev netdev powerdev scanner bluetooth fuse"
}code
+or use #{live-config.user-default-groups=audio,cdrom,dip,floppy,video,plugdev,netdev,powerdev,scanner,bluetooth,fuse}# as a boot parameter.
+
It is also possible to change the default username "user" and the default password "live". If you want to do that for any reason, you can easily achieve it as follows:
To change the default username you can simply specify it in your config:
code{
- $ lb config --bootappend-live "username=live-user"
+ $ lb config --bootappend-live "boot=live config username=live-user"
}code
-One possible way of changing the default password is by means of a hook as described in {Boot-time hooks}#boot-time-hooks. In order to do that you can use the "passwd" hook from #{/usr/share/doc/live-config/examples/hooks}#, prefix it accordingly (e.g. 200-passwd) and add it to #{config/includes.chroot/lib/live/config/}#
+One possible way of changing the default password is by means of a hook as described in {Boot-time hooks}#boot-time-hooks. In order to do that you can use the "passwd" hook from #{/usr/share/doc/live-config/examples/hooks}#, prefix it accordingly (e.g. 2000-passwd) and add it to #{config/includes.chroot/lib/live/config/}#
2~customizing-locale-and-language Customizing locale and language
-When the live system boots, language is involved in three steps:
+When the live system boots, language is involved in two steps:
_* the locale generation
-_* setting the keyboard layout for the console
-
-_* setting the keyboard layout for X
+_* setting the keyboard configuration
-The default locale when building a Live system is "locales=en_US.UTF-8". To define the locale that should be generated, use the #{locales}# parameter in the #{--bootappend-live}# option of #{lb config}#, e.g.
+The default locale when building a Live system is #{locales=en_US.UTF-8}#. To define the locale that should be generated, use the #{locales}# parameter in the #{--bootappend-live}# option of #{lb config}#, e.g.
code{
- $ lb config --bootappend-live "locales=de_CH.UTF-8"
+ $ lb config --bootappend-live "boot=live config locales=de_CH.UTF-8"
}code
-This parameter can also be used at the kernel command line. You can specify a locale by a full #{language_country.encoding}# word.
+Multiple locales may be specified as a comma-delimited list.
+
+This parameter, as well as the keyboard configuration parameters indicated below, can also be used at the kernel command line. You can specify a locale by #{language_country}# (in which case the default encoding is used) or the full #{language_country.encoding}# word. A list of supported locales and the encoding for each can be found in #{/usr/share/i18n/SUPPORTED}#.
-Both the console and X keyboard configuration depend on the #{keyboard-layouts}# parameter of the #{--bootappend-live}# option. Valid options for X keyboard layouts can be found in #{/usr/share/X11/xkb/rules/base.xml}# (rather limited to two-letters country codes). To find the value (the two characters) corresponding to a language try searching for the english name of the nation where the language is spoken, e.g:
+Both the console and X keyboard configuration are performed by #{live-config}# using the #{console-setup}# package. To configure them, use the #{keyboard-layouts}#, #{keyboard-variants}#, #{keyboard-options}# and #{keyboard-model}# boot parameters via the #{--bootappend-live}# option. Valid options for these can be found in #{/usr/share/X11/xkb/rules/base.lst}#. To find layouts and variants for a given language, try searching for the English name of the language and/or the country where the language is spoken, e.g:
code{
- $ grep -i sweden -C3 /usr/share/X11/xkb/rules/base.xml | grep name
- <name>se</name>
+$ egrep -i '(^!|german.*switzerland)' /usr/share/X11/xkb/rules/base.lst
+ ! model
+ ! layout
+ ch German (Switzerland)
+ ! variant
+ legacy ch: German (Switzerland, legacy)
+ de_nodeadkeys ch: German (Switzerland, eliminate dead keys)
+ de_sundeadkeys ch: German (Switzerland, Sun dead keys)
+ de_mac ch: German (Switzerland, Macintosh)
+ ! option
}code
-To get the locale files for German and Swiss German keyboard layout in X use:
+Note that each variant lists the layout to which it applies in the description.
+
+Often, only the layout needs to be configured. For example, to get the locale files for German and Swiss German keyboard layout in X use:
code{
- $ lb config --bootappend-live "locales=de_CH.UTF-8 keyboard-layouts=ch"
+ $ lb config --bootappend-live "boot=live config locales=de_CH.UTF-8 keyboard-layouts=ch"
}code
-A list of the valid values of the keyboards for the console can be figured with the following command:
+However, for very specific use cases, you may wish to include other parameters. For example, to set up a French system with a French-Dvorak layout (called Bepo) on a TypeMatrix EZ-Reach 2030 USB keyboard, use:
code{
- $ for i in $(find /usr/share/keymaps/ -iname "*kmap.gz"); \
- do basename $i | head -c -9; echo; done | sort | less
+ $ lb config --bootappend-live \
+ "boot=live config locales=fr_FR.UTF-8 keyboard-layouts=fr keyboard-variants=bepo keyboard-model=tm2030usb"
}code
-Alternatively, you can use the #{console-setup}# package, a tool to let you configure console layout using X (XKB) definitions; you can then set your keyboard layout more precisely with #{keyboard-layouts}#, #{keyboard-variant}#, #{keyboard-options}# and #{keyboard-model}# variables; live-boot will use also these parameters for X configuration. For example, to set up a French system with a French-Dvorak layout (called Bepo) on a TypeMatrix keyboard, both in console and X11, use:
+Multiple values may be specified as comma-delimited lists for each of the #{keyboard-*}# options, with the exception of #{keyboard-model}#, which accepts only one value. Please see the #{keyboard(5)}# man page for details and examples of #{XKBMODEL}#, #{XKBLAYOUT}#, #{XKBVARIANT}# and #{XKBOPTIONS}# variables. If multiple #{keyboard-variants}# values are given, they will be matched one-to-one with #{keyboard-layouts}# values (see #{setxkbmap(1)}# #{-variant}# option). Empty values are allowed; e.g. to define two layouts, the default being US QWERTY and the other being US Dvorak, use:
code{
$ lb config --bootappend-live \
- "locales=fr_FR.UTF-8 keyboard-layouts=fr keyboard-variant=bepo keyboard-model=tm2030usb"
+ "boot=live config keyboard-layouts=us,us keyboard-variants=,dvorak"
}code
@@ -102,9 +111,9 @@ _* a partition, identified by its GPT na
_* a filesystem, identified by its filesystem label.
-_* an image file located on the root of any readable filesystem (even an NTFS partition of a foreign OS), identified by its file name. In this case the file name must also use the containing filesystem as the file extension, e.g. "persistence.ext4".
+_* an image file located on the root of any readable filesystem (even an NTFS partition of a foreign OS), identified by its filename.
-The volume label for overlays must be #{persistence}#. And in order to fully customize the volume's persistence there must be a file named #{live-persistence.conf}#. See {The live-persistence.conf file}#live-persistence-conf
+The volume label for overlays must be #{persistence}# but it will be ignored unless it contains in its root a file named #{persistence.conf}# which is used to fully customize the volume's persistence, this is to say, specifying the directories that you want to save in your persistence volume after a reboot. See {The persistence.conf file}#persistence-conf for more details.
Here are some examples of how to prepare a volume to be used for persistence. It can be, for instance, an ext4 partition on a hard disk or on a usb key created with, e.g.:
@@ -120,40 +129,59 @@ If you already have a partition on your
code{
- $ tune2fs -L persistence /dev/sdb1 # for ext2,3,4 filesystems
+ # tune2fs -L persistence /dev/sdb1 # for ext2,3,4 filesystems
}code
-Here's an example of how to create an ext4-based image file used for persistence:
+Here's an example of how to create an ext4-based image file to be used for persistence:
code{
- $ dd if=/dev/null of=persistence bs=1G seek=1 # for a 1GB sized image file
+ $ dd if=/dev/null of=persistence bs=1 count=0 seek=1G # for a 1GB sized image file
$ /sbin/mkfs.ext4 -F persistence
}code
-Then copy the #{persistence}# file to the root of a writable partition.
+Once the image file is created, as an example, to make #{/usr}# persistent but only saving the changes you make to that directory and not all the contents of #{/usr}#, you can use the "union" option. If the image file is located in your home directory, copy it to the root of your hard drive's filesystem and mount it in #{/mnt}# as follows:
+
+code{
+
+ # cp persistence /
+ # mount -t ext4 /persistence /mnt
+
+}code
+
+Then, create the #{persistence.conf}# file adding content and unmount the image file.
-3~live-persistence-conf The live-persistence.conf file
+code{
-A volume with the label #{persistence}# can be configured to make arbitrary directories persistent. The file #{live-persistence.conf}#, located on the volume's filesystem root, controls which directories it makes persistent, and in which way.
+ # echo "/usr union" >> /mnt/persistence.conf
+ # umount /mnt
+
+}code
-How custom overlay mounts are configured is described in full detail in the live-persistence.conf(5) man page, but a simple example should be sufficient for most uses. Let's say we want to make our home directory and APT cache persistent in an ext4 filesystem on the /dev/sdb1 partition:
+Now, reboot into your live medium with the boot parameter "persistence".
+
+3~persistence-conf The persistence.conf file
+
+A volume with the label #{persistence}# must be configured by means of the #{persistence.conf}# file to make arbitrary directories persistent. That file, located on the volume's filesystem root, controls which directories it makes persistent, and in which way.
+
+How custom overlay mounts are configured is described in full detail in the persistence.conf(5) man page, but a simple example should be sufficient for most uses. Let's say we want to make our home directory and APT cache persistent in an ext4 filesystem on the /dev/sdb1 partition:
code{
- $ mkfs.ext4 -L persistence /dev/sdb1
- $ mount -t ext4 /dev/sdb1 /mnt
- $ echo "/home" >> /mnt/live-persistence.conf
- $ echo "/var/cache/apt" >> /mnt/live-persistence.conf
+ # mkfs.ext4 -L persistence /dev/sdb1
+ # mount -t ext4 /dev/sdb1 /mnt
+ # echo "/home" >> /mnt/persistence.conf
+ # echo "/var/cache/apt" >> /mnt/persistence.conf
+ # umount /mnt
}code
-Then we reboot. During the first boot the contents of #{/home}# and #{/var/cache/apt}# will be copied into the persistence volume, and from then on all changes to these directories will live in the persistence volume. Please note that any paths listed in the #{live-persistence.conf}# file cannot contain white spaces or the special #{.}# and #{..}# path components. Also, neither #{/live}# (or any of its sub-directories) nor #{/}# can be made persistent using custom mounts.
+Then we reboot. During the first boot the contents of #{/home}# and #{/var/cache/apt}# will be copied into the persistence volume, and from then on all changes to these directories will live in the persistence volume. Please note that any paths listed in the #{persistence.conf}# file cannot contain white spaces or the special #{.}# and #{..}# path components. Also, neither #{/lib}#, #{/lib/live}# (or any of their sub-directories) nor #{/}# can be made persistent using custom mounts. As a workaround for this limitation you can add #{/ union}# to your #{persistence.conf}# file to achieve full persistence.
-Several different custom overlay volumes (with their own #{live-persistence.conf}# files) can be used at the same time, but if several volumes make the same directory persistent, only one of them will be used. If any two mounts are "nested" (i.e. one is a sub-directory of the other) the parent will be mounted before the child so no mount will be hidden by the other. Nested custom mounts are problematic if they are listed in the same #{live-persistence.conf}# file. See the live-persistence.conf(5) man page for how to handle that case if you really need it (hint: you usually don't).
+Several different custom overlay volumes (with their own #{persistence.conf}# files) can be used at the same time, but if several volumes make the same directory persistent, only one of them will be used. If any two mounts are "nested" (i.e. one is a sub-directory of the other) the parent will be mounted before the child so no mount will be hidden by the other. Nested custom mounts are problematic if they are listed in the same #{persistence.conf}# file. See the persistence.conf(5) man page for how to handle that case if you really need it (hint: you usually don't).
-3~ Persistence SubText
+3~ Using more than one persistence store
-If a user would need multiple persistence storage of the same type for different locations or testing, such as #{persistence-nonwork}# and #{persistence-work}#, the boot parameter #{persistence-subtext}# used in conjunction with the boot parameter #{persistence}# will allow for multiple but unique persistence media. An example would be if a user wanted to use a persistence partition labeled #{persistence-subText}# they would use the boot parameters of: #{persistence}# #{persistence-subtext=subText}#.
+If a user would need multiple persistence store of the same type for different locations or testing, such as #{persistence-private}# and #{persistence-work}#, the boot parameter #{persistence-label}# used in conjunction with the boot parameter #{persistence}# will allow for multiple but unique persistence media. An example would be if a user wanted to use a persistence partition labeled #{persistence-subText}# they would use the boot parameters of: #{persistence}# #{persistence-label=subText}#.
diff -Naurp live-manual.orig/manual/en/user_examples.ssi live-manual/manual/en/user_examples.ssi
--- live-manual.orig/manual/en/user_examples.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_examples.ssi 1970-01-01 01:00:00.000000000 +0100
@@ -1,292 +0,0 @@
-:B~ Examples
-
-1~examples Examples
-
-This chapter covers example builds for specific use cases with Debian Live. If you are new to building your own Debian Live images, we recommend you first look at the three tutorials in sequence, as each one teaches new techniques that will help you use and understand the remaining examples.
-
-2~using-the-examples Using the examples
-
-To use these examples you need a system to build them on that meets the requirements listed in {Requirements}#requirements and has live-build installed as described in {Installing live-build}#installing-live-build.
-
-Note that, for the sake of brevity, in these examples we do not specify a local mirror to use for the build. You can speed up downloads considerably if you use a local mirror. You may specify the options when you use #{lb config}#, as described in {Distribution mirrors used at build time}#distribution-mirrors-build-time, or for more convenience, set the default for your build system in #{/etc/live/build.conf}#. Simply create this file and in it, set the corresponding #{LB_MIRROR_*}# variables to your preferred mirror. All other mirrors used in the build will be defaulted from these values. For example:
-
-code{
-
- LB_MIRROR_BOOTSTRAP="http://mirror/debian";
- LB_MIRROR_CHROOT_SECURITY="http://mirror/debian-security";
- LB_MIRROR_CHROOT_BACKPORTS="http://mirror/debian-updates";
-
-}code
-
-2~tutorial-1 Tutorial 1: A standard image
-
-*{Use case:}* Create a simple first image, learning the basics of live-build.
-
-In this tutorial, we will build a default ISO hybrid Debian Live image containing only base packages (no Xorg) and some Debian Live support packages, as a first exercise in using live-build.
-
-You can't get much simpler than this:
-
-code{
-
- $ mkdir tutorial1 ; cd tutorial1 ; lb config
-
-}code
-
-Examine the contents of the #{config/}# directory if you wish. You will see stored here a skeletal configuration, ready to customize or, in this case, use immediately to build a default image.
-
-Now, as superuser, build the image, saving a log as you build with #{tee}#.
-
-code{
-
- # lb build 2>&1 | tee build.log
-
-}code
-
-Assuming all goes well, after a while, the current directory will contain #{binary.hybrid.iso}#. This ISO hybrid image can be booted directly in a virtual machine as described in {Testing an ISO image with Qemu}#testing-iso-with-qemu and {Testing an ISO image with virtualbox-ose}#testing-iso-with-virtualbox, or else imaged onto optical media or a USB flash device as described in {Burning an ISO image to a physical medium}#burning-iso-image and {Copying an ISO hybrid image to a USB stick}#copying-iso-hybrid-to-usb, respectively.
-
-2~tutorial-2 Tutorial 2: A web browser utility
-
-*{Use case:}* Create a web browser utility image, learning how to apply customizations.
-
-In this tutorial, we will create an image suitable for use as a web browser utility, serving as an introduction to customizing Debian Live images.
-
-code{
-
- $ mkdir tutorial2
- $ cd tutorial2
- $ lb config -p lxde
- $ echo iceweasel >> config/package-lists/my.list.chroot
-
-}code
-
-Our choice of LXDE for this example reflects our desire to provide a minimal desktop environment, since the focus of the image is the single use we have in mind, the web browser. We could go even further and provide a default configuration for the web browser in #{config/includes.chroot/etc/iceweasel/profile/}#, or additional support packages for viewing various kinds of web content, but we leave this as an exercise for the reader.
-
-Build the image, again as superuser, keeping a log as in {Tutorial 1}#tutorial-1:
-
-code{
-
- # lb build 2>&1 | tee build.log
-
-}code
-
-Again, verify the image is OK and test, as in {Tutorial 1}#tutorial-1.
-
-2~tutorial-3 Tutorial 3: A personalized image
-
-*{Use case:}* Create a project to build a personalized image, containing your favourite software to take with you on a USB stick wherever you go, and evolving in successive revisions as your needs and preferences change.
-
-Since we will be changing our personalized image over a number of revisions, and we want to track those changes, trying things experimentally and possibly reverting them if things don't work out, we will keep our configuration in the popular #{git}# version control system. We will also use the best practice of autoconfiguration via #{auto}# scripts as described in {Managing a configuration}#managing-a-configuration.
-
-3~ First revision
-
-code{
-
- $ mkdir -p tutorial3/auto
- $ cp /usr/share/live/build/examples/auto/* tutorial3/auto/
- $ cd tutorial3
-
-}code
-
-Edit #{auto/config}# to read as follows:
-
-code{
-
- #!/bin/sh
-
- lb config noauto \
- --architectures i386 \
- --linux-flavours 686-pae \
- --package-lists lxde \
- "${@}"
-
-}code
-
-Now populate your local package list:
-
-code{
-
- $ echo "iceweasel xchat" >> config/package-lists/my.list.chroot
-
-}code
-
-First, #{--architectures i386}# ensures that on our #{amd64}# build system, we build a 32-bit version suitable for use on most machines. Second, we use #{--linux-flavours 686-pae}# because we don't anticipate using this image on much older systems. Third, we've chosen the /{lxde}/ package list to give us a minimal desktop. And finally, we have added two initial favourite packages: /{iceweasel}/ and /{xchat}/.
-
-Now, build the image:
-
-code{
-
- # lb build
-
-}code
-
-Note that unlike in the first two tutorials, we no longer have to type #{2>&1 | tee build.log}# as that is now included in #{auto/build}#.
-
-Once you've tested the image (as in {Tutorial 1}#tutorial-1) and are satisfied it works, it's time to initialize our #{git}# repository, adding only the auto scripts we just created, and then make the first commit:
-
-code{
-
- $ git init
- $ git add auto
- $ git commit -a -m "Initial import."
-
-}code
-
-3~ Second revision
-
-In this revision, we're going to clean up from the first build, add the /{vlc}/ package to our configuration, rebuild, test and commit.
-
-The #{lb clean}# command will clean up all generated files from the previous build except for the cache, which saves having to re-download packages. This ensures that the subsequent #{lb build}# will re-run all stages to regenerate the files from our new configuration.
-
-code{
-
- # lb clean
-
-}code
-
-Now append the /{vlc}/ package to our local package list in #{config/package-lists/my.list.chroot}#:
-
-code{
-
- $ echo vlc >> config/package-lists/my.list.chroot
-
-}code
-
-Build again:
-
-code{
-
-# lb build
-
-}code
-
-Test, and when you're satisfied, commit the next revision:
-
-code{
-
- $ git commit -a -m "Adding vlc media player."
-
-}code
-
-Of course, more complicated changes to the configuration are possible, perhaps adding files in subdirectories of #{config/}#. When you commit new revisions, just take care not to hand edit or commit the top-level files in #{config}# containing #{LB_*}# variables, as these are build products, too, and are always cleaned up by #{lb clean}# and re-created with #{lb config}# via their respective #{auto}# scripts.
-
-We've come to the end of our tutorial series. While many more kinds of customization are possible, even just using the few features explored in these simple examples, an almost infinite variety of different images can be created. The remaining examples in this section cover several other use cases drawn from the collected experiences of users of Debian Live.
-
-2~ A VNC Kiosk Client
-
-*{Use case:}* Create an image with live-build to boot directly to a VNC server.
-
-Make a build directory and create a skeletal configuration in it built around the standard-x11 list, including /{gdm3}/, /{metacity}/ and /{xvnc4viewer}/, disabling recommends to make a minimal system:
-
-code{
-
- $ mkdir vnc_kiosk_client
- $ cd vnc_kiosk_client
- $ lb config -a i386 -k 686-pae -p standard-x11 \
- --apt-recommends false
- $ echo "gdm3 metacity xvnc4viewer" >> config/package-lists/my.list.chroot
-
-}code
-
-Create the directory #{/etc/skel}# and put a custom #{.xsession}# in it for the default user that will launch /{metacity}/ and start /{xvncviewer}/, connecting to port #{5901}# on a server at #{192.168.1.2}#:
-
-code{
-
- $ mkdir -p config/includes.chroot/etc/skel
- $ cat > config/includes.chroot/etc/skel/.xsession << END
- #!/bin/sh
-
- /usr/bin/metacity &
- /usr/bin/xvncviewer 192.168.1.2:1
-
- exit
- END
-
-}code
-
-Build the image:
-
-code{
-
- # lb build
-
-}code
-
-Enjoy.
-
-2~ A base image for a 128M USB key
-
-*{Use case:}* Create a standard image with some components removed in order to fit on a 128M USB key with space left over to use as you see fit.
-
-When optimizing an image to fit a certain media size, you need to understand the tradeoffs you are making between size and functionality. In this example, we trim only so much as to make room for additional material within a 128M media size, but without doing anything to destroy integrity of the packages contained within, such as the purging of locale data via the /{localepurge}/ package, or other such "intrusive" optimizations. Of particular note, you should not use #{--bootstrap-flavour minimal}# unless you really know what you're doing, as omitting priority *{important}* packages will most likely produce a broken live system.
-
-code{
-
- $ lb config -k 486 -p minimal --apt-indices false \
- --memtest none --apt-recommends false --includes none
-
-}code
-
-Now, build the image in the usual way:
-
-code{
-
- # lb build 2>&1 | tee build.log
-
-}code
-
-On the author's system at time of writing, the above configuration produced a 78Mbyte image. This compares favourably with the 166Mbyte image produced by the default configuration in {Tutorial 1}#tutorial-1.
-
-The biggest space-saver here, compared to building a standard image on an #{i386}# architecture system, is to select only the #{486}# kernel flavour instead of the default #{-k "486 686-pae"}#. Leaving off APT's indices with #{--apt-indices false}# also saves a fair amount of space, the tradeoff being that you need to #{apt-get update}# before using apt in the live system. Choosing the #{minimal}# package list leaves out the large #{locales}# package and associated utilities. Dropping recommended packages with #{--apt-recommends false}# saves some additional space, at the expense of omitting some packages you might otherwise expect to be there, such as /{firmware-linux-free}/ which may be needed to support certain hardware. The remaining options shave off additional small amounts of space. It's up to you to decide if the functionality that is sacrificed with each optimization is worth the loss in functionality.
-
-2~ A localized KDE desktop and installer
-
-*{Use case:}* Create a KDE desktop image, localized for Brazilian Portuguese and including an installer.
-
-We want to make an iso-hybrid image for i386 architecture using our preferred desktop, in this case KDE, containing all of the same packages that would be installed by the standard Debian installer for KDE.
-
-Our initial problem is the discovery of the names of the appropriate language tasks. Currently, live-build cannot help with this. While we might get lucky and find this by trial-and-error, there is a tool, #{grep-dctrl}#, which can be used to dig it out of the task descriptions in tasksel-data, so to prepare, make sure you have both of those things:
-
-code{
-
- # apt-get install dctrl-tools tasksel-data
-
-}code
-
-Now we can search for the appropriate tasks, first with:
-
-code{
-
- $ grep-dctrl -FTest-lang pt_BR /usr/share/tasksel/descs/debian-tasks.desc -sTask
- Task: brazilian-portuguese
-
-}code
-
-By this command, we discover the task is called, plainly enough, brazilian-portuguese. Now to find the related tasks:
-
-code{
-
- $ grep-dctrl -FEnhances brazilian-portuguese /usr/share/tasksel/descs/debian-tasks.desc -sTask
- Task: brazilian-portuguese-desktop
- Task: brazilian-portuguese-kde-desktop
-
-}code
-
-At boot time we will generate the pt_BR.UTF-8 locale and select the pt-latin1 keyboard layout. We will also need to preseed our desktop choice, "kde" so that tasksel will install the correct desktop task, as it differs from the default (see {Desktop and languages tasks}#desktop-and-language-tasks). Now let's put the pieces together:
-
-code{
-
- $ mkdir live-pt_BR-kde
- $ cd live-pt_BR-kde
- $ lb config \
- -a i386 \
- -k 486 \
- --bootappend-live "locales=pt_BR.UTF-8 keyboard-layouts=pt-latin1" \
- --debian-installer live
- $ echo kde-desktop brazilian-portuguese brazilian-portuguese-desktop \
- brazilian-portuguese-kde-desktop >> config/task-lists/my.list.chroot
- $ echo debian-installer-launcher >> config/package-lists/my.list.chroot
- $ echo tasksel tasksel/desktop multiselect kde >> config/preseed/my.preseed.chroot
-
-}code
-
-Note that we have included the debian-installer-launcher package to launch the installer from the live desktop, and have also specified the 486 flavour kernel, as it is currently necessary to make the installer and live system kernels match for the launcher to work properly.
diff -Naurp live-manual.orig/manual/en/user_installation.ssi live-manual/manual/en/user_installation.ssi
--- live-manual.orig/manual/en/user_installation.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_installation.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -6,15 +6,15 @@
Building Debian Live images has very few system requirements:
-_* Super user (root) access
+_* Superuser (root) access
_* An up-to-date version of live-build
-_* A POSIX-compliant shell, such as /{bash}/ or /{dash}/.
+_* A POSIX-compliant shell, such as /{bash}/ or /{dash}/
_* /{debootstrap}/ or /{cdebootstrap}/
-_* Linux 2.6.x
+_* Linux 2.6 or newer.
Note that using Debian or a Debian-derived distribution is not required - live-build will run on almost any distribution with the above requirements.
@@ -40,14 +40,6 @@ code{
}code
-or
-
-code{
-
- # aptitude install live-build
-
-}code
-
3~ From source
live-build is developed using the Git version control system. On Debian based systems, this is provided by the /{git}/ package. To check out the latest code, execute:
@@ -63,7 +55,7 @@ You can build and install your own Debia
code{
$ cd live-build
- $ dpkg-buildpackage -rfakeroot -b -uc -us
+ $ dpkg-buildpackage -b -uc -us
$ cd ..
}code
@@ -72,7 +64,7 @@ Now install whichever of the freshly bui
code{
- # dpkg -i live-build_2.0.8-1_all.deb
+ # dpkg -i live-build_3.0-1_all.deb
}code
@@ -108,7 +100,7 @@ Both live-boot and live-config are avail
To use the latest source from git, you can follow the process below. Please ensure you are familiar with the terms mentioned in {Terms}#terms.
-_* Checkout the live-boot and live-config source
+_* Checkout the live-boot and live-config sources
code{
@@ -134,9 +126,16 @@ code{
}code
-_* Use all generated .deb files
+_* Use applicable generated .deb files
+
+As live-boot and live-config are installed by live-build system, installing the packages in the host system is not sufficient: you should treat the generated .deb files like any other custom packages. Since your purpose for building from source is like to test new things over the short term before the official release, follow {Installing modified or third-party packages}#installing-modified-or-third-party-packages to temporarily include the relevant files in your configuration. In particular, notice that both packages are divided into a generic part, a documentation part and one or more back-ends. Include the generic part, only one back-end matching your configuration, and optionally the documentation. Assuming you are building a live image in the current directory and have generated all .deb files for a single version of both packages in the directory above, these bash commands would copy all of the relevant packages including default back-ends:
+
+code{
+
+ $ cp ../live-boot{_,-initramfs-tools,-doc}*.deb config/packages.chroot/
+ $ cp ../live-config{_,-sysvinit,-doc}*.deb config/packages.chroot/
-As live-boot and live-config are installed by live-build system, installing the packages in the host system is not sufficient: you should treat the generated .deb files like any other custom packages. Please see {Customizing package installation}#customizing-package-installation for more information. You should pay particular attention to {Additional repositories}#additional-repositories.
+}code
3~ From 'snapshots'
diff -Naurp live-manual.orig/manual/en/user_managing_a_configuration.ssi live-manual/manual/en/user_managing_a_configuration.ssi
--- live-manual.orig/manual/en/user_managing_a_configuration.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_managing_a_configuration.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -4,58 +4,79 @@
This chapter explains how to manage a live configuration from initial creation, through successive revisions and successive releases of both the live-build software and the live image itself.
-2~ Use auto to manage configuration changes
+2~ Dealing with configuration changes
-Live configurations rarely are perfect on the first try. You'll likely need to make a series of revisions until you are satisfied. However, inconsistencies can creep into your configuration from one revision to the next if you aren't careful. The main problem is, once a variable is given a default value, that value will not be recomputed from other variables that may change in later revisions.
+Live configurations rarely are perfect on the first try. It may be fine to pass #{lb config}# options from the command-line to perform a single build, but it is more typical to revise those options and build again until you are satisfied. To support these changes, you will need auto scripts which ensure your configuration is kept in a consistent state.
-For example, when the distribution is first set, many 'dependent' variables are given default values that suit that distribution. However, if you later decide to change the distribution, those dependent variables continue to retain old values that are no longer appropriate.
+3~ Why use auto scripts? What do they do?
-A second, related problem is that if you run #{lb config}# and then upgrade to a new version of live-build that has changed one of the variable names, you will discover this only by manual review of the variables in your #{config/*}# files, which you will then need to use to set the appropriate option again.
+The #{lb config}# command stores the options you pass to it in #{config/*}# files along with many other options set to default values. If you run #{lb config}# again, it will not reset any option that was defaulted based on your initial options. So, for example, if you run #{lb config}# again with a new value for #{--distribution}#, any dependent options that were defaulted for the old distribution may no longer work with the new. Nor are these files intended to be read or edited. They store values for over a hundred options, so nobody, let alone yourself, will be able to see in these which options you actually specified. And finally, if you run #{lb config}#, then upgrade live-build and it happens to rename an option, #{config/*}# would still contain variables named after the old option that are no longer valid.
-All of this would be a terrible nuisance if it weren't for auto/* scripts, simple wrappers to the #{lb config}#, #{lb build}# and #{lb clean}# commands that are designed to help you manage your configuration. Simply create an auto/config script containing #{lb config}# command with all desired options, and an auto/clean that removes the files containing configuration variable values, and each time you run #{lb config}# and #{lb clean}#, these files will be executed. This will ensure that your configuration is kept internally consistent from one revision to the next and from one live-build release to the next (Although you will still have to take care and read the documentation when you upgrade live-build and make adjustments as needed).
+For all these reasons, #{auto/*}# scripts will make your life easier. They are simple wrappers to the #{lb config}#, #{lb build}# and #{lb clean}# commands that are designed to help you manage your configuration. The #{auto/config}# script stores your #{lb config}# command with all desired options, the #{auto/clean}# script removes the files containing configuration variable values, and the #{auto/build}# script keeps a #{build.log}# of each build. Each of these scripts is run automatically every time you run the corresponding #{lb}# command. By using these scripts, your configuration is easier to read and is kept internally consistent from one revision to the next. Also, it will be much easier for you identify and fix options which need to change when you upgrade live-build after reading the updated documentation.
-2~ Example auto scripts
+3~ Use example auto scripts
-Use auto script examples such as the following as the starting point for your new live-build configuration. Take note that when you call the #{lb}# command that the auto script wraps, you must specify #{noauto}# as its parameter to ensure that the auto script isn't called again, recursively. Also, don't forget to ensure the scripts are executable (e.g. #{chmod 755 auto/*}#).
+For your convenience, live-build comes with example auto shell scripts to copy and edit. Start a new, default configuration, then copy the examples into it:
-#{auto/config}#
+code{
+
+ $ mkdir mylive && cd mylive && lb config
+ $ cp /usr/share/doc/live-build/examples/auto/* auto/
+
+}code
+
+Edit #{auto/config}#, adding any options as you see fit. For instance:
code{
#!/bin/sh
lb config noauto \
- --package-lists "standard" \
+ --architectures i386 \
+ --linux-flavours 686-pae \
+ --binary-images hdd \
+ --mirror-bootstrap http://ftp.ch.debian.org/debian/ \
+ --mirror-binary http://ftp.ch.debian.org/debian/ \
"${@}"
}code
-#{auto/clean}#
+Now, each time you use #{lb config}#, #{auto/config}# will reset the configuration based on these options. When you want to make changes to them, edit the options in this file instead of passing them to #{lb config}#. When you use #{lb clean}#, #{auto/clean}# will clean up the #{config/*}# files along with any other build products. And finally, when you use #{lb build}#, a log of the build will be written by #{auto/build}# in #{build.log}#.
+
+*{Note:}* A special #{noauto}# parameter is used here to suppress another call to #{auto/config}#, thereby preventing infinite recursion. Make sure you don't accidentally remove it when making edits. Also, take care to ensure when you split the #{lb config}# command across multiple lines for readability, as shown in the example above, that you don't forget the backslash (\) at the end of each line that continues to the next.
+
+2~clone-configuration-via-git Clone a configuration published via Git
+
+Use the #{lb config --config}# option to clone a Git repository that contains a Debian Live configuration. If you would like to base your configuration on one maintained by the Debian Live project, look at http://live.debian.net/gitweb/ for the repository named #{live-images}# in the category #{Packages}#. This repository contains the configurations for the Debian Live {prebuilt images}#downloading-prebuilt-images.
+
+For example, to build a rescue image, use the #{live-images}# repository as follows:
code{
- #!/bin/sh
- lb clean noauto "${@}"
- rm -f config/binary config/bootstrap \
- config/chroot config/common config/source
- rm -f build.log
+ $ mkdir live-images && cd live-images
+ $ lb config --config git://live.debian.net/git/live-images.git
+ $ cd images/rescue
}code
-#{auto/build}#
+Edit #{auto/config}# and any other things you need in the #{config}# tree to suit your needs. For example, the unofficial non-free prebuilt images are made by simply adding #{--archive-areas "main contrib non-free"}#.
+
+You may optionally define a shortcut in your Git configuration by adding the following to your #{${HOME}/.gitconfig}#:
code{
- #!/bin/sh
- lb build noauto "${@}" 2>&1 | tee build.log
+ [url "git://live.debian.net/git/"]
+ insteadOf = ldn:
}code
-We now ship example auto scripts with live-build based on the examples above. You may copy those as your starting point.
+This enables you to use #{ldn:}# anywhere you need to specify the address of a #{live.debian.net}# git repository. If you also drop the optional #{.git}# suffix, starting a new image using this configuration is as easy as:
code{
- $ cp /usr/share/live/build/examples/auto/* auto/
+ $ lb config --config ldn:live-images
}code
-Edit #{auto/config}#, changing or adding any options as you see fit. In the example above, #{--package-lists standard}# is set to the default value. Change this to an appropriate value for your image (or delete it if you want to use the default) and add any additional options in continuation lines that follow.
+Cloning the entire #{live-images}# repository pulls the configurations used for several images. If you feel like building a different image after you have finished with the first one, change to another directory and again and optionally, make any changes to suit your needs.
+
+In any case, remember that every time you will have to build the image as superuser: #{lb build}#
diff -Naurp live-manual.orig/manual/en/user_overview.ssi live-manual/manual/en/user_overview.ssi
--- live-manual.orig/manual/en/user_overview.ssi 2013-03-01 10:03:32.135891749 +0100
+++ live-manual/manual/en/user_overview.ssi 2013-02-22 00:00:49.998212541 +0100
@@ -10,7 +10,7 @@ live-build is a collection of scripts to
The idea behind live-build is to be a framework that uses a configuration directory to completely automate and customize all aspects of building a Live image.
-Many concepts are similar to those in the /{debhelper}/ Debian package tools written by Joey Hess:
+Many concepts are similar to those used to build Debian packages with /{debhelper}/:
_* The scripts have a central location for configuring their operation. In /{debhelper}/, this is the #{debian/}# subdirectory of a package tree. For example, dh_install will look, amongst others, for a file called #{debian/install}# to determine which files should exist in a particular binary package. In much the same way, live-build stores its configuration entirely under a #{config/}# subdirectory.
@@ -35,19 +35,19 @@ Issuing #{lb config}# without any argume
code{
$ lb config
- [2012-03-19 15:17:14] lb_config
+ [2013-01-01 09:14:22] lb_config
P: Considering defaults defined in /etc/live/build.conf
- P: Creating config tree for a debian system
+ P: Creating config tree for a debian/i386 system
}code
Using #{lb config}# without any arguments would be suitable for users who need a very basic image, or who intend to later provide a more complete configuration via #{auto/config}# (see {Managing a configuration}#managing-a-configuration for details).
-Normally, you will want to specify some options. For example, to include the 'gnome' package list in your configuration:
+Normally, you will want to specify some options. For example, to specify which distribution you want to build using its codename:
code{
- $ lb config -p gnome
+ $ lb config --distribution sid
}code
@@ -55,7 +55,7 @@ It is possible to specify many options,
code{
- $ lb config --binary-images net --bootappend-live "hostname=live-machine username=live-user" ...
+ $ lb config --binary-images netboot --bootappend-live "boot=live config hostname=live-host username=live-user" ...
}code
@@ -71,7 +71,7 @@ It is the job of the #{lb clean}# comman
2~live-boot The live-boot package
-live-boot is a collection of scripts providing hooks for the initramfs-tools, used to generate an initramfs capable of booting live systems, such as those created by live-build. This includes the Debian Live ISOs, netboot tarballs, and USB stick images.
+live-boot is a collection of scripts providing hooks for the /{initramfs-tools}/, used to generate an initramfs capable of booting live systems, such as those created by live-build. This includes the Debian Live ISOs, netboot tarballs, and USB stick images.
At boot time it will look for read-only media containing a #{/live/}# directory where a root filesystem (often a compressed filesystem image like squashfs) is stored. If found, it will create a writable environment, using aufs, for Debian like systems to boot from.
diff -Naurp live-manual.orig/manual/Makefile live-manual/manual/Makefile
--- live-manual.orig/manual/Makefile 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/manual/Makefile 2013-03-01 10:03:10.416752408 +0100
@@ -2,7 +2,7 @@
SHELL := sh -e
-LANGUAGES = $(shell cd po && ls)
+LANGUAGES = ca es fr it
DEBUG=0
PO4A_FLAGS=
@@ -51,3 +51,5 @@ distclean: clean
rm -rf $(LANGUAGES)
rebuild: distclean update build
+unfuzzy:
+ @./bin/unfuzzy-dates.sh
diff -Naurp live-manual.orig/manual/_sisu/home/index.html live-manual/manual/_sisu/home/index.html
--- live-manual.orig/manual/_sisu/home/index.html 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/manual/_sisu/home/index.html 2013-03-01 10:03:10.416752408 +0100
@@ -11,25 +11,21 @@
<ul>
<li><a href="index.ca.html">Català (Catalan)</a></li>
- <li><a href="index.de.html">Deutsch (German)</a></li>
<li><a href="index.en.html">English</a></li>
<li><a href="index.es.html">Español (Spanish)</a></li>
<li><a href="index.fr.html">Français (French)</a></li>
<li><a href="index.it.html">Italiano (Italian)</a></li>
- <li><a href="index.pt_BR.html">Português Brasil (Brazilian Portuguese)</a></li>
- <li><a href="index.ro.html">Româna (Romanian)</a></li>
- <!-- <li><a href="ro">Român&acaron; (Romanian)</a></li> -->
</ul>
<h3>Meta</h3>
<p>
- Builds are scheduled every 20 minutes.
+ Builds are scheduled @INTERVAL@.
</p>
<ul>
- <li><a href="../build.log">build.log</a></li>
- <li><a href="../manual-trace">manual-trace</a></li>
+ <li><a href="log">log</a></li>
+ <li><a href="trace">trace</a></li>
</ul>
<p>
diff -Naurp live-manual.orig/VERSION live-manual/VERSION
--- live-manual.orig/VERSION 2013-03-01 10:03:32.127892066 +0100
+++ live-manual/VERSION 2013-03-01 10:03:10.416752408 +0100
@@ -1 +1 @@
-3.0~a13-1
+3.0.1-1
Reply to: