The glucopy-glurestore system deployment scripts
Copyright (c) 2006, 2008 Dimitri Marinakis, John Poulakis
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
Distribution-specific considerations
GNU Free Documentation License
When you need to make more than one copy of your installed and fine-tuned system in less than a lifetime, these scripts are for you. We have used it to back-up and clone slightly complex working systems. Restoration from data taking up a 700Mb CD takes about ten minutes (current era computers).
20061203 – First release: tlgu.carmen.gr
20061223 – EOF correction
20080102 – GRUB syntax correction, distribution-specific considerations
Spiros Georgaras (sngeorgaras, otenet gr) for reviewing the scripts and for providing useful checks.
All authors and contributors to the utilities listed below.
(use man command or info command to find out more)
dd
History has
it that dd was originally cc (convert and copy) and was renamed to dd
as cc stood for c compiler.
It has always been device dump or disk
dump for me...
grub
The modularized GRand Unified Bootloader is used in the systems supported by the copy/restore scripts.
An interactive mode allows you options like finding the partitions where the boot loader files reside:
find /boot/grub/stage1
This will return something like root(hd0,1) which means that grub's root directory was found in the first hdd, second partition.
As long as you have it running, you may then set up the system to boot:
setup(hd0) quit
The setup line indicates where the boot loader will reside (here in the first disk's Master Boot Record - MBR) and the quit command will flush the information to disk.
To boot from interactive mode you must indicate the location of the GNU/Linux system (relative to the hard disk drive used for booting) and the root directory using real device names. For example:
kernel /vmlinuz root=/dev/sda2 [additional kernel parameters] initrd /initrd boot
tar
The venerable tape archive command can be used to easily create compressed or uncompressed archives in forms too numerous to mention here. For added peace of mind compute the md5sum of the resulting “tarballs” and compare them to the respective files stored on the backup medium (CD/DVD).
md5sum
Computes a file's checksum or "fingerprint".
sfdisk
A very comprehensive disk partitioner with sector save (-O), dump (-d) and restore options.
mkisofs
cdrecord (now
wodim - write data to
optical disk media)
These utilities can be used to make and burn an ISO CD, optionally including bootable images (-b).
growisofs
Used as a front end to mkisofs to make and burn DVD-RW and DVD-RAM images.
BE CAREFUL! THESE ARE EXAMPLE SCRIPTS AND WILL DEFINITELY NEED ADAPTATION!
TEST USING SAMPLE DATA/HARDWARE BEFORE ACTUAL DEPLOYMENT!
The usual disclaimer about misconfiguring your system beyond repair or oblueterating your work applies: Don't blame it on us. Do one thing at a time. Make sure you understand the steps involved by reading the respective command manuals. Write to tlgu, carmen gr, in case this document contains inaccuracies, errors or if you have some information that others can benefit from.
The need arose (a rose... a rose!) to install a specific GNU/Linux configuration on a number of identical computer boxes with (almost) blank, unformatted, disks. One option was to blindly clone the disks using dd but this would need a significant amount of time, even with a large block size, indeed unjustified, as the sub-Tb disks were mostly empty. Another drawback is that disks should be removed and re-installed. Even with “no-tools” boxes this is an added inconvenience and involves a risk of damaging the hardware.
We eventually settled on backing-up directories from the GNU/Linux tree by making a compressed tar ball (tape archive), copying it onto a CD/DVD and then expanding it onto freshly-formatted partitions. Which means: boot a compact working system on the target machine, clone partitioning information, format selected partitions, untar-uncompress backed-up information, make system bootable and, optionally, run any required customization scripts.
The back-up should (ideally) be made while the system is not running, which usually means that you need to boot with a rescue system disk. A number of suitable floppy, USB or CD-based system images can be downloaded from the net or, better, included in your distribution's boot options. Make sure that this rescue system supports the type of disks in your target system (SATA/SCSI or IDE).
The following script will get partition information in a form that can be used to restore the system on new disks and will then collect the working system files in one (or more) compressed tar balls.
The sfdisk program is used for getting partition information (-d option). Take a look at sys_partitions.txt after the glucopy.sh script has finished.
In this application it is considered that all Master Boot Record (MBR) information will be overwritten by the partitioning and boot loader programs. If you need a copy of all or parts of the MBR, however, dd is your friend.
The script must be run by the root user, so that all system files can be copied and file attributes preserved. tar's preserve permissions option (-p) is used to that effect.
System directories that contain transient information (e.g. /proc, /sys) are not copied. Directories or individual files containing unwanted information can be excluded using tar's –exclude=/directory/file option.
#!/bin/sh ############################################################## # glucopy.sh # # Creates the /glucopy directory # Copies partition information in sys_partitions.txt # Optionally makes a copy of the MBR in mbr.bin # Copies working GNU/Linux system to .tgz files # # USAGE: # Boot system with a rescue CD or any bootable CD # that supports your type of disks (SATA/SCSI or IDE). # run the back-up script: ./glucopy.sh # # In this example the system is on /dev/sda # /dev/sda1 is a small partition with HW manufacturer utilities # /dev/sda2 has system root (/) -> mounted to /mnt # /dev/sda3 is a spare (blank) partition # /dev/sda4 has home (/home) and space to hold # the information to be copied -> mounted to /mnt2 # # 061116 jp/dm ############################################################## # Change the following to reflect the place where your system root (/) # and the home directories (/home/*) are mounted mkdir /tmp/mnt1 mkdir /tmp/mnt2 mount /dev/sda2 /tmp/mnt1 mount /dev/sda4 /tmp/mnt2 # The directory to hold the system copy is placed on the larger partition mkdir /tmp/mnt2/glucopy # Change to the working directory cd /tmp/mnt2/glucopy # Optionally copy MBR information #dd if=/dev/sda of=mbr.bin bs=512 count=1 # Copy partition information /sbin/sfdisk -d /dev/sda > sys_partitions.txt # Make tarballs, preserving file permissions (default if run as root) tar -C /tmp/mnt1 -cpvzf syscopy.tgz boot bin etc lib media opt root sbin usr var dev # Move up a level cd .. # here we are under the /home directory level # notice that --exclude will exclude anything that matches a _pattern_ # the glucopy directory will still be created in the tarball tar -cpvzf ./glucopy/homecopy.tgz * --exclude=glucopy/* # Copy the backup/restore scripts (here under root /), and the sfdisk program, as well cp /glucopy.sh ./glucopy cp /glurestore.sh ./glucopy cp /sbin/sfdisk ./glucopy # Notify user echo -e “glucopy: finished \a”
The information in the glucopy directory can be burned onto a CD or DVD using the mkisofs and cdrecord (wodim) or growisofs or by using a GUI front end such as k3b. You can make the medium bootable by including a suitable system image.
The two example scripts below (cdmake, cdburn) will make a CD ISO image in the /tmp directory and burn it to a CD. Or you can use the growisofs command: to burn CD/DVDs e.g. growisofs /dev/hdc <mkisofs options>
Needless to say, the scripts need to be customized for your own equipment.
#########################################################
# Usage: cdmake VOLUME_LABEL DIRECTORY
# Will output /tmp/cdimage.iso
#
if (test -z $1 -o -z $2); then
echo Usage: cdmake VOLUME_LABEL TOP_LEVEL_DIRECTORY
else
mkisofs -V $1 -rational-rock -full-iso9660-filenames \
-iso-level 2 -o /tmp/cdimage.iso $2
fi
#########################################################
Example: ./cdmake BACK061203 /home/glucopy
#########################################################
# cdburn
cdrecord gracetime=2 -v dev=/dev/hdc -speed=48 -multi -eject driveropts=burnfree /tmp/cdimage.iso
#########################################################
Example: ./cdburnA minimal (or not-so-minimal) system is loaded using a rescue CD/USB/floppy, at which point the restore script is run.
The glurestore script will partition the target disk using information obtained from the original system, will format the desired partitions and will then mount the partitions, restore the data, and make the target disk bootable.
Note that /proc and /sys directories (which were not backed up) need to be created. The /mnt directory is created, as well.
System restoration may be followed by any individualization process such as system serialization.
#!/bin/sh ############################################################## # glurestore.sh # # USAGE: # Boot system with a rescue CD or any bootable medium # that supports your type of disks (SATA/SCSI or IDE). # # Mount the medium containing the backed-up files and # run the restore script: # e.g. mount /dev/hda /mnt # /mnt/glurestore.sh # # In this example the system is on /dev/sda # and the CD/DVD ROM drive is on /dev/hda # There are four primary partitions: # /dev/sda1 contains HW manufacturer utilities and will not be formatted # /dev/sda2 will be formatted using ext3 and will hold the system root (/) # /dev/sda3 will be formatted using ext3 (but will not be used) # /dev/sda4 will be formatted using ext3 and will hold /home # # 061116 jp/dm # 080102 dm - note that a space is needed after the GRUB commands ############################################################## # Change to the CD direcory cd /mnt # Optionally install Master Boot Record # (uncomment the following two lines) #echo "Installing MBR" #dd if=mbr.bin of=/dev/sda bs=512 count=1 # Create Partitions # The sfdisk program used has been copied # on the backup medium. echo "Creating Partition Table" ./sfdisk /dev/sda < sys_partitions.txt # Format partitions # Change to reflect the number of partitions that need # to be formatted and the type of formatting echo "Formating Partitions" mkfs.ext3 /dev/sda2 mkfs.ext3 /dev/sda3 mkfs.ext3 /dev/sda4 # Create directory to mount "/" partition echo "Creating directory to mount / partition " mkdir /mnt2 mount /dev/sda2 /mnt2 # Create /proc /sys and /mnt directories echo "Creating proc, sys and mnt directories " mkdir /mnt2/proc mkdir /mnt2/sys mkdir /mnt2/mnt # Create directory and mount "home" partition echo "Creating directory and mounting home partition " mkdir /mnt2/home mount /dev/sda4 /mnt2/home # Extract files tar -C /mnt2 -xpvzf syscopy.tgz tar -C /mnt2 -xpvzf homecopy.tgz ##################################### # Optional scripts may be placed here # If you are restoring libraries, chroot/ldconfig may prove useful. ##################################### # Now make sure that correct boot information # is present in the hard disk's MBR # grub is run in batch mode # hd0,1 is hard disk 0 (first hard disk of any kind), second partition – for this example /sbin/grub --batch <<EOF root (hd0,1) setup (hd0) quit EOF # Notify user echo -e “glurestore: finished! \a” # Reboot and check your new system reboot
SuSE disks include a RAM-based rescue system. So does the Trinity Rescue Kit, which is completely RAM-based.
Ubuntu, for security reasons, does not have a user named root. Login and execute the command sudo su, providing the default user's password.
PCLinuxOS has a copy2ram boot option that can be used to free the LiveCD drive.
PCLinuxOS employs the udev/iftab (dynamic device management / interface table) mechanisms to identify and assign persistent names to network interfaces. Of course this is not desirable in the cloning process and the relevant files need to be excluded. This can be done either during back-up (e.g. add a pertinent tar --exclude= xxx in glucopy) or the unwanted files can be deleted following restoration. The latter method is used in the glucopy/glurestore variants below, used to backup and restore a default PCLinuxOS system. Note that, as an afterthought, the root and user .bash_history files are also purged. These examples include checks for the root user and the existence of the required utilities:
#!/bin/sh
##############################################################
# glucopy.sh
#
# Creates the /glucopy directory
# Copies partition information in sys_partitions.txt
# Optionally makes a copy of the MBR in mbr.bin
# Copies working GNU/Linux system to .tgz files
#
# USAGE:
# Boot system with a rescue CD or any bootable CD
# that supports your type of disks (SATA/SCSI or IDE).
# run the back-up script: ./glucopy.sh
#
# In this example the system is on /dev/sda
# /dev/sda1 has system root (/) -> mounted to /mnt1
# /dev/sda5 is a spare (blank) partition
# /dev/sda6 has home (/home) and space to hold
# the information to be copied -> mounted to /mnt2
#
# 061116 jp/dm
# 070503 sg - root user and program availability checks
# 071220 dm - pclinuxos default disk layout
##############################################################
# Change the following to reflect the place where your system root (/)
# and the home directories (/home/*) are mounted
# Check that user is root
USER=`id -un`
if (test $USER != "root");then
echo "Error: This script must be executed by root"
exit
fi
# Check availability of programs
TAR=`which tar 2>/dev/null`
if (test -z "$TAR");then
echo "Error: The program \"tar\" was not found"
echo " The live CD you are using does not contain the program \"tar\"."
echo " The backup procedure cannot be executed without it."
echo " Please use another live CD."
exit
fi
SFDISK=`which sfdisk 2>/dev/null`
if (test -z "$SFDISK");then
echo "Error: The program \"sfdisk\" was not found"
echo " The live CD you are using does not contain the program \"sfdisk\"."
echo " The backup procedure cannot be executed without it."
echo " Please use another live CD."
exit
fi
THIS_DIR=`pwd`
# Checkpoint
#exit
mkdir /tmp/mnt1
mkdir /tmp/mnt2
mount /dev/sda1 /tmp/mnt1
mount /dev/sda6 /tmp/mnt2
# The directory to hold the system copy is placed on the larger partition
mkdir /tmp/mnt2/glucopy
# Change to the working directory
cd /tmp/mnt2/glucopy
# Optionally copy MBR information
#dd if=/dev/sda of=mbr.bin bs=512 count=1
# Copy partition information
"$SFDISK" -d /dev/sda > sys_partitions.txt
# Make tarballs
"$TAR" -C /tmp/mnt1 -cpvzf syscopy.tgz boot bin etc lib media opt root sbin usr var dev
# Move up a level
cd ..
# here we are under the /home directory level
# notice that --exclude will exclude anything that matches a _pattern_
# the glucopy directory will still be created in the tarball
"$TAR" --exclude=glucopy/* -cpvzf ./glucopy/homecopy.tgz *
# Copy the backup/restore scripts (here under root /), and the sfdisk program, as well
cp "$THIS_DIR"/* ./glucopy
#cp /glucopy.sh ./glucopy
#cp /glurestore.sh ./glucopy
cp "$SFDISK" ./glucopy
# Notify user
echo glucopy: finished
/////////////////////////////////////////////////////////////////////////////////////////
#!/bin/sh
##############################################################
# glurestore.sh
#
# USAGE:
# Boot system with a rescue CD or any bootable medium
# that supports your type of disks (SATA/SCSI or IDE).
#
# Mount the medium containing the backed-up files and
# run the restore script:
# e.g. mount /dev/hda /mnt
# /mnt/glurestore.sh
#
# In this example the system is on /dev/sda
# and the CD/DVD ROM drive is on /dev/hda
# There are four primary partitions:
# /dev/sda1 contains HW manufacturer utilities and will not be formatted
# /dev/sda2 will be formatted using ext3 and will hold the system root (/)
# /dev/sda3 will be formatted using ext3 (but will not be used)
# /dev/sda4 will be formatted using ext3 and will hold /home
#
# 061116 jp/dm
# 061223 dm -- EOF correction
# 070503 sg -- root user and program availability checks
# 071220 dm -- remove hard-coded MAC address files (PCLinuxOS)
##############################################################
# Check that user is root
USER=`id -un`
if (test $USER != "root");then
echo "Error: This script must be executed by root"
exit
fi
# Check availability of programs
TAR=`which tar 2>/dev/null`
if (test -z "$TAR");then
echo "Error: The program \"tar\" was not found"
echo " The live CD you are using does not contain the program \"tar\"."
echo " The backup procedure cannot be executed without it."
echo " Please use another live CD."
exit
fi
SFDISK=`which sfdisk 2>/dev/null`
if (test -z "$SFDISK");then
echo "Error: The program \"sfdisk\" was not found"
echo " The live CD you are using does not contain the program \"sfdisk\"."
echo " The backup procedure cannot be executed without it."
echo " Please use another live CD."
exit
fi
GRUB=`which grub 2>/dev/null`
if (test -z "$GRUB");then
echo "Error: The program \"grub\" was not found"
echo " The live CD you are using does not contain the program \"sfdisk\"."
echo " The backup procedure cannot be executed without it."
echo " Please use another live CD."
exit
fi
MKEXT3=`which mkfs.ext3 2>/dev/null`
if (test -z "$MKEXT3");then
echo "Error: The program \"mkfs.ext3\" was not found"
echo " The live CD you are using does not contain the program \"sfdisk\"."
echo " The backup procedure cannot be executed without it."
echo " Please use another live CD."
exit
fi
THIS_DIR=`pwd`
# Checkpoint
#exit
# Change to the CD direcory
cd /mnt/cdrom
# Optionally install Master Boot Record
# (uncomment the following two lines)
#echo "Installing MBR"
#dd if=mbr.bin of=/dev/sda bs=512 count=1
# Create Partitions
# The sfdisk program used has been copied
# on the backup medium.
echo "Creating Partition Table"
"$SFDISK" /dev/sda < sys_partitions.txt
# Format partitions
# Change to reflect the number of partitions that need
# to be formatted and the type of formatting
echo "Formating Partitions"
"$MKEXT3" /dev/sda1
"$MKEXT3" /dev/sda5
"$MKEXT3" /dev/sda6
# Create directory to mount "/" partition
echo "Creating directory to mount / partition "
mkdir /mnt2
mount /dev/sda1 /mnt2
# Create /proc /sys and /mnt directories
echo "Creating proc, sys and mnt directories "
mkdir /mnt2/proc
mkdir /mnt2/sys
mkdir /mnt2/mnt
# Create directory and mount "home" partition
echo "Creating directory and mounting home partition "
mkdir /mnt2/home
mount /dev/sda6 /mnt2/home
# Extract files
"$TAR" -C /mnt2 -xpvzf syscopy.tgz
"$TAR" -C /mnt2/home -xpvzf homecopy.tgz
#####################################
# Optional scripts may be placed here
# If you are restoring libraries, chroot/ldconfig may prove useful.
#####################################
rm /mnt2/etc/iftab
rm /mnt2/etc/udev/rules.d/61-net_config.rules
rm /mnt2/root/.bash_history
rm /mnt2/home/_user_/.bash_history
# Now make sure that correct boot information
# is present in the hard disk's MBR
# grub is run in batch mode
# hd0,0 is hard disk 0 (first hard disk of any kind), first partition – for this example
"$GRUB" --batch <<EOF
root (hd0,0)
setup (hd0)
quit
EOF
# Notify user
echo glurestore: finished!
rebootVersion 1.2, November 2002
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements."
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 2 of the License, or
(at your option) any later version.
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.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USAAlso add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice
This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.