clean up doc/ and add doc Makefile
diff --git a/doc/gsrc.info b/doc/gsrc.info deleted file mode 100644 --- a/doc/gsrc.info +++ /dev/null @@ -1,1125 +0,0 @@ -This is gsrc.info, produced by makeinfo version 4.13 from -/home/brandon/Projects/gsrc/gsrc/trunk/doc/gsrc.texi. - -This manual is for the GNU Source Release Collection (version -2012.09.06, updated 22 September 2012). - - Copyright (C) 2011, 2012 Free Software Foundation, Inc. - - Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Documentation License, - Version 1.2 or any later version published by the Free Software - Foundation; with no Invariant Sections, no Front-Cover Texts and - no Back-Cover Texts. A copy of the license is included in the - section entitled "GNU Free Documentation License." - -INFO-DIR-SECTION System administration -START-INFO-DIR-ENTRY -* gsrc: (gsrc)Building the GNU Source Release Collection. -END-INFO-DIR-ENTRY - - -File: gsrc.info, Node: Top, Next: Introduction, Prev: (dir), Up: (dir) - -GNU Source Release Collection -***************************** - -This manual is for GNU Source Release Collection (version 2012.09.06, -22 September 2012). - -* Menu: - -* Introduction:: -* Getting started:: -* Advanced configuration:: -* Appendix:: -* GNU Free Documentation License:: - - --- The Detailed Node Listing --- - -Introduction - -* Building GNU packages:: - -Getting Started - -* Building a simple package:: -* Installing a package:: -* Setting your environment to use installed packages:: -* Cleaning up and other useful targets:: -* Building a more complex package:: - -Advanced configuration - -* Global configuration:: -* Package configuration:: -* Maintaining multiple versions of a package:: - -Appendix - -* Configuring Python packages - - -File: gsrc.info, Node: Introduction, Next: Getting started, Prev: Top, Up: Top - -1 Introduction -************** - -The GNU Source Release Collection (GSRC) provides a simple way to -install the latest GNU packages on an existing distribution. By using -GSRC, the GNU source packages from `ftp.gnu.org' are automatically -downloaded, compiled and installed, either in your home directory or a -system-wide directory such as `/opt'. - - It allows you, for example, to easily install GNU software for -yourself on a system on which you do not have permission to install -software system-wide; or to install the latest, unpatched packages when -those distributed with your operating system are outdated or not -configured to your liking. - - GSRC is based on the GAR build system by Nick Moffitt and the GARstow -enhancements by Adam Sampson. GAR was inspired by BSD Ports, a -Makefile-based build system, and is written in GNU Make. The GARNOME -build system for GNOME is another example of a system using GAR. - - Note that GSRC is not intended to be a full package management system -or source distribution. It is just a more convenient way to compile -GNU packages from source on an existing system. - - Because GSRC is not a full distribution you will sometimes need to -install other packages from your distribution to build and run GNU -programs. For example, GSRC itself does not include Perl or Python, so -you will need to make sure these are already installed for GNU programs -which use them. - -* Menu: - -* Building GNU packages:: - - -File: gsrc.info, Node: Building GNU packages, Prev: Introduction, Up: Introduction - -1.1 Building GNU packages -========================= - -If you have never built a GNU package by hand, this section will -briefly show the process so you will have an idea of what GSRC is doing. - - * Download the package and unpack it - $ wget http://ftpmirror.gnu.org/gnu/hello/hello-2.6.tar.gz - $ tar xvfz hello-2.6.tar.gz - - * Run the configure script - $ cd hello-2.6; ./configure - - * Compile the source code - $ make - - * Install it - $ make install - - - -File: gsrc.info, Node: Getting started, Next: Advanced configuration, Prev: Introduction, Up: Top - -2 Getting started -***************** - -GSRC is distributed directly using the Bazaar version control system or -via a tarball. You can check out the latest version from the Bazaar -repository using - - $ bzr checkout bzr://bzr.savannah.gnu.org/gsrc/trunk/ gsrc - This will create a directory `gsrc'. The build definitions for GNU -packages are in the `gnu/' subdirectory. Each package has its own -subdirectory within `gnu/', for example `gnu/emacs/' or `gnu/gcc/', -containing a Makefile for building it. This makefile will execute the -usual `./configure' and `make' commands needed to build a GNU package. - - The `deps/' subdirectory contains GARfiles for a few external -packages, - - To stay up-to-date with the latest releases of GNU software, you can -pull in recent changes to your local copy of GSRC: - - $ bzr update - -2.1 Initial setup -================= - -If you have checked out the source tree from the Bazaar repository you -will need to create the build files with the following command, - - $ ./bootstrap - - Before building any packages you will need to run the top-level -configure script. There is only one configuration parameter, the -installation prefix, specified with `--prefix'. For example, to -install all the compiled packages under `/gnu' use: - - $ ./configure --prefix=/gnu - checking for a BSD-compatible install... /usr/bin/install -c - checking whether build environment is sane... yes - checking for a thread-safe mkdir -p... /bin/mkdir -p - checking for gawk... no - checking for mawk... mawk - checking whether make sets $(MAKE)... yes - configure: creating ./config.status - config.status: creating config.mk - config.status: creating setup.sh - config.status: creating GNUmakefile - config.status: creating doc/Makefile - $ - -* Menu: - -* Building a simple package:: -* Installing a package:: -* Setting your environment to use installed packages:: -* Cleaning up and other useful targets:: -* Building a more complex package:: - - -File: gsrc.info, Node: Building a simple package, Next: Installing a package, Prev: Getting started, Up: Getting started - -2.2 Building a simple package -============================= - -To build any package, simply type `make' in the package's subdirectory. -You can change to the directory with the `cd' command in the shell, or -with the `-C' option of `make'. For example, to build the `hello' -package in the `gnu/hello' subdirectory use: - - $ make -C gnu/hello - - This will download, unpack, configure and build the `hello' package. -The package will be built in the subdirectory `gnu/hello/work'. - - $ ./gnu/hello/work/hello-2.7/src/hello - Hello, world! - - -File: gsrc.info, Node: Installing a package, Next: Setting your environment to use installed packages, Prev: Building a simple package, Up: Getting started - -2.3 Installing a package -======================== - -You are now ready to install the package. If you are installing to a -new directory tree, first create the directory specified in the -top-level configure `--prefix' option if necessary, - - $ mkdir /gnu - - Then to install the package use the `install' target, - - $ make -C gnu/hello install - - The package should be automatically installed under `/gnu/', with -any executable programs under `/gnu/bin/'. - - $ /gnu/bin/hello --version - hello (GNU hello) 2.7 - - -File: gsrc.info, Node: Setting your environment to use installed packages, Next: Cleaning up and other useful targets, Prev: Installing a package, Up: Getting started - -2.4 Setting your environment to use installed packages -====================================================== - -If you want to use the newly installed package by default you will need -to modify the relevant variables in your environment, such as `PATH', -`LD_LIBRARY_PATH', `INFOPATH', etc. - - There is a sample script `setup.sh' in the top-level source -directory which can be used to set the main environment variables. - - $ source setup.sh - - Note that you need to load this file into the current shell with the -`source' command, instead of executing it (which would only apply the -definitions temporarily in a subshell). - - After loading this file, your environment variables should include -the target directory so you can run the new packages directly: - - $ echo $PATH - /gnu/bin:/usr/local/bin:/usr/bin:/bin - $ which hello - /gnu/bin/hello - - If you want to restore your original environment variables they are -saved in the variables `ORIG_PATH', `ORIG_LD_LIBRARY_PATH', etc. - - $ PATH=$ORIG_PATH - $ LD_LIBRARY_PATH=$ORIG_LD_LIBRARY_PATH - - -File: gsrc.info, Node: Cleaning up and other useful targets, Next: Building a more complex package, Prev: Setting your environment to use installed packages, Up: Getting started - -2.5 Cleaning up and other useful targets -======================================== - -To clean up the build directory and delete any downloaded files, use -the `clean' target: - - $ make -C gnu/hello clean - - There are other useful targets. For example, the whole build -sequence can be broken down into stages as follows: - - $ make -C gnu/hello fetch checksum extract configure build install - - Each target depends on the previous one, so typing `make -C -gnu/hello install' builds all the earlier targets first. - - To see some information about the package before downloading it, use -the target `fetch-list'. - - $ make -C gnu/hello fetch-list - make: Entering directory `/home/gnu/gsrc/gnu/hello' - Name: hello - Version: 2.7 - Location: http://ftpmirror.gnu.org/hello/ - Distribution files: - hello-2.7.tar.gz - Patch files: - Signature files: - hello-2.7.tar.gz.sig - Dependencies: - make: Leaving directory `/home/gnu/gsrc/gnu/hello' - - -File: gsrc.info, Node: Building a more complex package, Prev: Cleaning up and other useful targets, Up: Getting started - -2.6 Building a more complex package -=================================== - -If a package depends on other packages these will be built -automatically in the correct order. To see the dependencies of any -package use the `dep-list' target. - - $ make -C gnu/gnupg dep-list - make: Entering directory `/home/gnu/gsrc/gnu/gnupg' - libgpg-error libgcrypt libassuan libksba pth zlib readline - make: Leaving directory `/home/gnu/gsrc/gnu/gnupg' - - The dependencies are searched for in the `gnu/' subdirectory by -default, with some additional external packages such as `zlib' in the -`deps/' subdirectory. - - Note that the dependencies can be more than one level deep, - - $ make -C gnu/readline dep-list - make: Entering directory `/home/gnu/gsrc/gnu/readline' - ncurses - make: Leaving directory `/home/gnu/gsrc/gnu/readline' - - So, to install a complex package like `gnupg' use the same commands -as for a simple package, - - $ make -C gnu/gnupg - $ make -C gnu/gnupg install - - -File: gsrc.info, Node: Advanced configuration, Next: Appendix, Prev: Getting started, Up: Top - -3 Advanced configuration -************************ - -The default behavior of GSRC may be configured, both globally and for -individual packages. All configuration is done in simple Makefiles, so -some familiarity with GNU Make, while not required, is recommended for -more advanced changes. - -* Menu: - -* Global configuration:: -* Package configuration:: -* Maintaining multiple versions of a package:: - - -File: gsrc.info, Node: Global configuration, Next: Package configuration, Up: Advanced configuration - -3.1 Global configuration -======================== - -The build loads the following configuration files: - -`config.mk' - Specifies the installation directory prefix. Created by the - configure script from `config.mk.in' - -`gar.conf.mk' - Specifies general configuration variables - -`gar.env.mk' - Defines the environment variables that are set during each build - step. - -`gar.master.mk' - Defines the list of mirror sites used to download the source - tarballs. It is recommended to modify this to use local mirrors. - - The local file `gar.site.mk' is loaded last and can be used to -override any configuration variables. - - Some of the more important configuration variables are: - -`BOOTSTRAP' - If defined (the default), the environment variables - `C_INCLUDE_PATH', `CPLUS_INCLUDE_PATH' and `LDFLAGS' point to the - `include/' and `lib/' subdirectories of the installation - directory. This forces the use of any previously installed - libraries in preference to the normal system libraries. To - disable this feature, remove the definition `BOOTSTRAP=1' in - `config.mk.in' and rerun configure, or build with `BOOTSTRAP' - undefined on the command-line: - - $ make -C gnu/gnupg BOOTSTRAP= - -`IGNORE_DEPS' - Specifies any packages that should be skipped as dependencies (for - example, if you prefer to use existing system packages instead). A - space separated list. - -`GARCHIVEDIR' - -`GARBALLDIR' - Specifies the directories used to cache downloaded tarballs - (`GARCHIVEDIR') and the tarballs of the installed packages - (`GARBALLDIR'). Set in `gar.conf.mk'. - -`MAKE_ARGS_PARALLEL' - Set this to `-j N' to allow N parallel processes in the build. - Note that multiple dependencies are built one-by-one, only the - commands within each build are performed in parallel. - - - -File: gsrc.info, Node: Package configuration, Next: Maintaining multiple versions of a package, Prev: Global configuration, Up: Advanced configuration - -3.2 Package configuration -========================= - -Each package can be highly customized within its own Makefile. Because -GNU packages follow a standardized build process, customizing the GSRC -Makefile for one is straightforward. - - GNU packages take most of their configuration in the form of options -passed to the `configure' script. One may easily customize these -options in a GSRC Makefile by setting the CONFIGURE_OPTS variable. Any -options added to this variable will be appended to the options set by -default by GSRC. Thus, since GSRC already sets the `--prefix' option, -you need not specify it here. - - CONFIGURE_OPTS = --disable-gtk --without-png - - If you have a patch which you would like to apply to the package, the -process may be automated by GSRC. First, in the package's directory, -make a subdirectory called `files/' and move the patch file(s) there. -Next, create two variables in the package's Makefile: - - PATCHFILES = my-patch.diff my-patch2.diff - PATCHOPTS = -p0 - - `PATCHFILES' holds a list of all the patch files in the `files/' -subdirectory. `PATCHOPTS' contains the option switches to pass to the -`patch' program. Next, the patch file's checksum is added to the -checksums file for the package. Finally, you may build the package as -normal, with the patch being applied automatically in the process. - - $ make makesums install - - Note that if the `make makesums' command fails due to GPG -verification and you trust the source from which the package was -downloaded, you may instead use `make makesums GPGV=true' to skip this -key verification step. - - If the package requires a patch to even build properly, then this is -a bug in GSRC. Please report such build problems to <bug-gsrc@gnu.org>. - - -File: gsrc.info, Node: Maintaining multiple versions of a package, Prev: Package configuration, Up: Advanced configuration - -3.3 Maintaining multiple versions of a package -============================================== - -What is actually happening "under the hood" when GSRC installs a -package is slightly more complicated than what has been described so -far. - - When you install a package, it is first actually installed to the -`/gnu/packages/' directory in a sub-directory with the name -<package>-<version> (i.e. `/gnu/packages/hello-2.7/'). In the example -of the package `hello', when the executable `hello' is installed, it is -installed to `/gnu/packages/hello-2.7/bin/hello'. All other files -installed by the package are installed in a similar manner. Next, GSRC -makes symbolic links to those files inside the parent `/gnu/' -directory. Thus, `/gnu/bin/hello' is actually a symlink to -`/gnu/packages/hello-2.7/bin/hello'. - - When a new version of a package is released, you do not have to -uninstall the previous version first. When `hello 2.8' is built and -installed, it is put into its own package directory, -`/gnu/packages/hello-2.8/' and the directory of `hello 2.7' is left -untouched. When GSRC finalizes the installation, the old symlinks are -removed and new ones are created to the latest version. Thus, there -would then actually be two versions of the package installed, but only -one would be in use via the symlinks. - - If you want to use a particular version of the package, you may pass -the `GARVERSION' variable to `make install'. Be sure to update the -checksums when you do so, otherwise the process will fail! - - $ make -C gnu/hello makesums install GARVERSION=2.7 - - If you had previously built version 2.7, then GSRC will merely -re-link to those files. Of course, if you have not previously built it, -or if you have run `make clean', the process will start from the -beginning. - - Note: this will fail if the package naming format or compression -algorithm has changed between versions (i.e. a change from tar.gz to -tar.xz); in this case you must also modify `DISTFILES'. - - Users wishing to maintain different configurations of a package may -take advantage of the `GARPROFILE' variable. Its value is appended to -the package directory name, allowing you to have multiple -configurations of the same package version installed. For example: - - $ make -C gnu/hello install CONFIGURE_OPTS="--disable-nls" GARPROFILE="-no-nls" - - This would install the newly configured package to -`/gnu/packages/hello-2.8-no-nls/'. - - -File: gsrc.info, Node: Appendix, Next: GNU Free Documentation License, Prev: Advanced configuration, Up: Top - -4 Appendix -********** - -* Menu: - -* Configuring Python packages:: - - -File: gsrc.info, Node: Configuring Python packages, Up: Appendix - -4.1 Configuring Python packages -=============================== - -Python packages are typically built using Python's distutils module or -other similar methods. The result is a file called `setup.py', which -the user runs, passing it directives similar to those passed to a -standard Makefile. Creating a GSRC Makefile for a Python package is -relatively uncomplicated, however it lacks the power of the traditional -`configure'/`Makefile' paradigm. Furthermore, the GNU coding standards -require a `configure' script when packaging a software release. - - In the interest of standardizing GSRC Makefiles for GNU packages as -well as to provide maintainers of Python-based GNU packages an easy -means of including standards-conforming `configure' and `Makefile' -files, several files are included in GSRC for configuring Python -projects. These files are located in the `util/python-configure/' -directory in the GSRC package. - - The files may be included without modification in a Python project's -directory. As such, they will provide a thin wrapper around the -project's `setup.py' script. This configure script primarily allows the -user to set the `--prefix' flag, as well as to define the `PYTHON' -variable declaring the location of the Python interpreter. - - These template files may, however, be greatly expanded and customized -to fit the needs of a given software package. To this end, several -Autoconf macros are included in the `m4/python.m4' file. This file -defines Python as a language in Autoconf, meaning that, for example, -you can include arbitrary Python code with `AC_LANG_PROGRAM'. -Furthermore, several useful macros are defined: - -Macro Name & Arguments Description Variables exported ---------------------------------------------------------------------------- -`AC_PROG_PYTHON([NAME-TO-CHECK])'Find a Python `PYTHON' - interpreter -`PC_PROG_PYTHON_CONFIG([NAME-TO-CHECK])'Find a python-config `PYTHON_CONFIG' - program -`PC_PYTHON_VERIFY_VERSION(VERSION,Verify that the Python -[ACTION-IF-TRUE], interpreter is of a -[ACTION-IF-NOT-TRUE])' sufficient version - number -`PC_PYTHON_CHECK_VERSION'Get the version of the `PYTHON_VERSION' - Python interpreter -`PC_PYTHON_CHECK_PREFIX' Check what Python `PYTHON_PREFIX' - thinks is the prefix -`PC_PYTHON_CHECK_EXEC_PREFIX'Check what Python `PYTHON_EXEC_PREFIX' - thinks is the - exec_prefix -`PC_PYTHON_CHECK_INCLUDES'Check the include flags `PYTHON_INCLUDES' - ('-I[header]...') for - including the Python - header files -`PC_PYTHON_CHECK_HEADERS'Check for the Python `HAVE_PYTHON_H' - header files (i.e. - `Python.h') -`PC_PYTHON_CHECK_LIBS' Check for the proper `PYTHON_LIBS' - LIBS flags to load the - Python shared libraries -`PC_PYTHON_TEST_LIBS' Test for the presence `HAVE_LIBPYTHON' - of the Python shared - libraries -`PC_PYTHON_CHECK_CFLAGS' Find the CFLAGS that `PYTHON_CFLAGS' - Python expects -`PC_PYTHON_CHECK_LDFLAGS'Find the LDFLAGS that `PYTHON_LDFLAGS' - Python expects -`PC_PYTHON_CHECK_EXTENSION_SUFFIX'Check the extension `PYTHON_EXTENSION_SUFFIX' - suffix given to Python - extension modules - (Python 3 only) -`PC_PYTHON_CHECK_ABI_FLAGS'Check the ABI flags `PC_PYTHON_ABI_FLAGS' - used by Python (Python - 3 only) -`PC_PYTHON_CHECK_PLATFORM'Check what platform - Python thinks this is - `PYTHON_PLATFORM' -`PC_PYTHON_CHECK_SITE_DIR'Check the appropriate `pythondir' - place to install Python - packages (i.e. - `$(prefix)/lib/python2.7/site-packages') -`PC_PYTHON_SITE_PACKAGE_DIR'A convenience macro; `pkgpythondir' - adds the package's name - to `pythondir' -`PC_PYTHON_CHECK_EXEC_DIR'Check directory for `pyexecdir' - installing Python - extension modules -`PC_PYTHON_EXEC_PACKAGE_DIR'A convenience macro; `pkgpyexecdir' - adds the package's name - to `pyexecdir' -`PC_PYTHON_CHECK_MODULE' Test if a given Python - module can be - successfully loaded -`PC_PYTHON_CHECK_FUNC' Test if a given Python - function can be called - successfully. - - Once these macros are integrated into your `configure.ac' file as -necessary, simply run `autoconf' to generate a new `configure' script. -The variables exported by this `configure' script may then be used in -`Makefile.in' to influence the build process. - - To include these scripts in a GSRC Makefile, simply create a .tar.gz -archive including at least `configure', `Makefile.in' and `m4/', such -that the contents will extract into a directory called `$(DISTNAME)' -(i.e. the contents should extract into a directory called -"mypackage-0.1/"). Put the archive into the `files/' sub-directory of -the package's GSRC directory. Finally, simply add the archive's name to -the `DISTFILES' list in the GSRC Makefile for the package and update -the checksums file with `make makesums'. Now your GSRC Makefile can -simply include `gar.lib/auto.mk' to automate the configuration and -installation of the software. - - -File: gsrc.info, Node: GNU Free Documentation License, Prev: Appendix, Up: Top - -Appendix A GNU Free Documentation License -***************************************** - - Version 1.3, 3 November 2008 - - Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. - `http://fsf.org/' - - 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. - - The "publisher" means any person or entity that distributes copies - of the Document to the public. - - 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 under this License. Any attempt - otherwise to copy, modify, sublicense, or distribute it is void, - and will automatically terminate your rights under this License. - - However, if you cease all violation of this License, then your - license from a particular copyright holder is reinstated (a) - provisionally, unless and until the copyright holder explicitly - and finally terminates your license, and (b) permanently, if the - copyright holder fails to notify you of the violation by some - reasonable means prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is - reinstated permanently if the copyright holder notifies you of the - violation by some reasonable means, this is the first time you have - received notice of violation of this License (for any work) from - that copyright holder, and you cure the violation prior to 30 days - after your receipt of the notice. - - Termination of your rights under this section does not terminate - the licenses of parties who have received copies or rights from - you under this License. If your rights have been terminated and - not permanently reinstated, receipt of a copy of some or all of - the same material does not give you any rights to use it. - - 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. If the Document specifies that a proxy - can decide which future versions of this License can be used, that - proxy's public statement of acceptance of a version permanently - authorizes you to choose that version for the Document. - - 11. RELICENSING - - "Massive Multiauthor Collaboration Site" (or "MMC Site") means any - World Wide Web server that publishes copyrightable works and also - provides prominent facilities for anybody to edit those works. A - public wiki that anybody can edit is an example of such a server. - A "Massive Multiauthor Collaboration" (or "MMC") contained in the - site means any set of copyrightable works thus published on the MMC - site. - - "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 - license published by Creative Commons Corporation, a not-for-profit - corporation with a principal place of business in San Francisco, - California, as well as future copyleft versions of that license - published by that same organization. - - "Incorporate" means to publish or republish a Document, in whole or - in part, as part of another Document. - - An MMC is "eligible for relicensing" if it is licensed under this - License, and if all works that were first published under this - License somewhere other than this MMC, and subsequently - incorporated in whole or in part into the MMC, (1) had no cover - texts or invariant sections, and (2) were thus incorporated prior - to November 1, 2008. - - The operator of an MMC Site may republish an MMC contained in the - site under CC-BY-SA on the same site at any time before August 1, - 2009, provided the MMC is eligible for relicensing. - - -ADDENDUM: How to use this License for your documents -==================================================== - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and license -notices just after the title page: - - Copyright (C) YEAR YOUR NAME. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. A copy of the license is included in the section entitled ``GNU - Free Documentation License''. - - If you have Invariant Sections, Front-Cover Texts and Back-Cover -Texts, replace the "with...Texts." line with this: - - with the Invariant Sections being LIST THEIR TITLES, with - the Front-Cover Texts being LIST, and with the Back-Cover Texts - being LIST. - - If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - - If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, to -permit their use in free software. - - - -Tag Table: -Node: Top813 -Node: Introduction1611 -Node: Building GNU packages3138 -Node: Getting started3726 -Node: Building a simple package5828 -Node: Installing a package6500 -Node: Setting your environment to use installed packages7185 -Node: Cleaning up and other useful targets8428 -Node: Building a more complex package9594 -Node: Advanced configuration10718 -Node: Global configuration11214 -Node: Package configuration13171 -Node: Maintaining multiple versions of a package15065 -Node: Appendix17609 -Node: Configuring Python packages17790 -Node: GNU Free Documentation License23993 - -End Tag Table diff --git a/doc/stamp-vti b/doc/stamp-vti deleted file mode 100644 --- a/doc/stamp-vti +++ /dev/null @@ -1,4 +0,0 @@ -@set UPDATED 22 September 2012 -@set UPDATED-MONTH September 2012 -@set EDITION 2012.09.06 -@set VERSION 2012.09.06