Information for Maintainers of GNU Software

Table of Contents

Next: , Up: (dir)   [Contents][Index]

Version

Information for maintainers of GNU software, last updated May 13, 2014.

Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 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.3 or any later version 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”.


Next: , Previous: , Up: Top   [Contents][Index]

1 About This Document

This file contains guidelines and advice for someone who is the maintainer of a GNU program on behalf of the GNU Project. Everyone is entitled to change and redistribute GNU software; you need not pay attention to this file to get permission. But if you want to maintain a version for widespread distribution, we suggest you follow these guidelines. If you are or would like to be a GNU maintainer, then it is essential to follow these guidelines.

In addition to this document, please read and follow the GNU Coding Standards (see Contents in GNU Coding Standards).

Please send corrections or suggestions for this document to bug-standards@gnu.org. If you make a suggestion, please include suggested new wording if you can. We prefer a context diff to the Texinfo source, but if that’s difficult for you, you can make a diff for some other version of this document, or propose it in any way that makes it clear. The source repository for this document can be found at http://savannah.gnu.org/projects/gnustandards.

If you want to receive diffs for every change to these GNU documents, join the mailing list gnustandards-commit@gnu.org, for instance via the web interface at http://lists.gnu.org/mailman/listinfo/gnustandards-commit. Archives are also available there.

This document uses the gender-neutral third-person pronouns “person”, “per”, “pers” and “perself” which were promoted, and perhaps invented, by Marge Piercy in Woman on the Edge of Time. They are used just like “she”, “her”, “hers” and “herself”, except that they apply equally to males and females. For example, “Person placed per new program under the GNU GPL, to let the public benefit from per work, and to enable per to feel person has done the right thing.”

This release of the GNU Maintainer Information was last updated May 13, 2014.


Next: , Previous: , Up: Top   [Contents][Index]

2 Getting Help

If you have any general questions or encounter a situation where it isn’t clear how to get something done or who to ask, you (as a GNU contributor) can always write to mentors@gnu.org, which is a list of a few experienced GNU folks who have volunteered to answer questions. Any GNU-related question is fair game for the mentors list.

The GNU Advisory Committee helps to coordinate activities in the GNU project on behalf of RMS (Richard Stallman, the Chief GNUisance). If you have any organizational questions or concerns you can contact the committee at gnu-advisory@gnu.org. See http://www.gnu.org/contact/gnu-advisory.html for the current committee members. Additional information is in /gd/gnuorg/advisory.

If you find that any GNU computer systems (fencepost.gnu.org, ftp.gnu.org, www.gnu.org, savannah.gnu.org, …) seem to be down, you can check the current status at http://pumprock.net/fsfstatus. Most likely the problem, if it can be alleviated at the FSF end, is already being worked on.

The FSF system administrators are responsible for the network and GNU hardware. You can email them at sysadmin@fsf.org, but please try not to burden them unnecessarily.


Next: , Previous: , Up: Top   [Contents][Index]

3 GNU Accounts and Resources

The directory /gd/gnuorg mentioned throughout this document is available on the general GNU server, currently fencepost.gnu.org. If you are the maintainer of a GNU package, you should have an account there. If you don’t have one already, see http://www.gnu.org/software/README.accounts.html. You can also ask for accounts for people who significantly help you in working on the package. Such GNU login accounts include email (see http://www.fsf.org/about/systems/sending-mail-via-fencepost).

Other resources available to GNU maintainers are described at http://www.gnu.org/software/devel.html, as well as throughout this document. In brief:


Next: , Previous: , Up: Top   [Contents][Index]

4 Stepping Down

With good fortune, you will continue maintaining your package for many decades. But sometimes for various reasons maintainers decide to step down.

If you’re the official maintainer of a GNU package and you decide to step down, please inform the GNU Project (maintainers@gnu.org). We need to know that the package no longer has a maintainer, so we can look for and appoint a new maintainer.

If you have an idea for who should take over, please tell maintainers@gnu.org your suggestion. The appointment of a new maintainer needs the GNU Project’s confirmation, but your judgment that a person is capable of doing the job will carry a lot of weight.

As your final act as maintainer, it would be helpful to set up or update the package under savannah.gnu.org (see Old Versions). This will make it much easier for the new maintainer to pick up where you left off and will ensure that the source tree is not misplaced if it takes us a while to find a new maintainer.


Next: , Previous: , Up: Top   [Contents][Index]

5 Recruiting Developers

Unless your package is a fairly small, you probably won’t do all the work on it yourself. Most maintainers recruit other developers to help.

Sometimes people will offer to help. Some of them will be capable, while others will not. It’s up to you to determine who provides useful help, and encourage those people to participate more.

Some of the people who offer to help will support the GNU Project, while others may be interested for other reasons. Some will support the goals of the Free Software Movement, but some may not. They are all welcome to help with the work—we don’t ask people’s views or motivations before they contribute to GNU packages.

As a consequence, you cannot expect all contributors to support the GNU Project, or to have a concern for its policies and standards. So part of your job as maintainer is to exercise your authority on these points when they arise. No matter how much of the work other people do, you are in charge of what goes in the release. When a crucial point arises, you should calmly state your decision and stick to it.

Sometimes a package has several co-maintainers who share the role of maintainer. Unlike developers who help, co-maintainers have actually been appointed jointly as the maintainers of the package, and they carry out the maintainer’s functions together. If you would like to propose some of your developers as co-maintainers, please contact maintainers@gnu.org.

We’re happy to acknowledge all major contributors to GNU packages on the http://www.gnu.org/people/people.html web page. Please send an entry for yourself to webmasters@gnu.org, and feel free to suggest it to other significant developers on your package.


Next: , Previous: , Up: Top   [Contents][Index]

6 Legal Matters

This chapter describes procedures you should follow for legal reasons as you maintain the program, to avoid legal difficulties.


Next: , Up: Legal Matters   [Contents][Index]

6.1 Copyright Papers

If you maintain an FSF-copyrighted package, certain legal procedures are required when incorporating legally significant changes written by other people. This ensures that the FSF has the legal right to distribute the package, and the standing to defend its GPL-covered status in court if necessary.

GNU packages need not be FSF-copyrighted; this is up to the author(s), generally at the time the package is dubbed GNU. When copyright is assigned to the FSF, the FSF can act to stop GPL violations about the package. Otherwise, legal actions are up to the author(s). The rest of this section is about the case when a package is FSF-copyrighted.

Before incorporating significant changes, make sure that the person who wrote the changes has signed copyright papers and that the Free Software Foundation has received and signed them. We may also need an employer’s disclaimer from the person’s employer, which confirms that the work was not part of the person’s job and the employer makes no claim on it. However, a copy of the person’s employment contract, showing that the employer can’t claim any rights to this work, is often sufficient.

If the employer does claim the work was part of the person’s job, and there is no clear basis to say that claim is invalid, then we have to consider it valid. Then the person cannot assign copyright, but the employer can. Many companies have done this. Please ask the appropriate managers to contact assign@gnu.org.

To check whether papers have been received, look in /gd/gnuorg/copyright.list. If you can’t look there directly, fsf-records@gnu.org can check for you. Our clerk can also check for papers that are waiting to be entered and inform you when expected papers arrive.

The directory /gd/gnuorg mentioned throughout this document is available on the general GNU server, currently fencepost.gnu.org. If you are the maintainer of a GNU package, you should have an account there. If you don’t have one already, see http://www.gnu.org/software/README.accounts.html. You can also ask for accounts for people who significantly help you in working on the package. Such GNU login accounts include email (see http://www.fsf.org/about/systems/sending-mail-via-fencepost).

In order for the contributor to know person should sign papers, you need to ask per for the necessary papers. If you don’t know per well, and you don’t know that person is used to our ways of handling copyright papers, then it might be a good idea to raise the subject with a message like this:

Would you be willing to assign the copyright to the Free Software Foundation, so that we could install it in package?

or

Would you be willing to sign a copyright disclaimer to put this change in the public domain, so that we can install it in package?

If the contributor then wants more information, you can send per the file /gd/gnuorg/conditions.text, which explains per options (assign vs. disclaim) and their consequences.

Once the conversation is under way and the contributor is ready for more details, you should send one of the templates that are found in the directory /gd/gnuorg/Copyright/; they are also available from the doc/Copyright/ directory of the gnulib project at http://savannah.gnu.org/projects/gnulib. This section explains which templates you should use in which circumstances. Please don’t use any of the templates except for those listed here, and please don’t change the wording.

Once the conversation is under way, you can send the contributor the precise wording and instructions by email. Before you do this, make sure to get the current version of the template you will use! We change these templates occasionally—don’t keep using an old version.

For large changes, ask the contributor for an assignment. Send per a copy of the file request-assign.changes. (Like all the ‘request-’ files, it is in /gd/gnuorg/Copyright and in gnulib.)

For medium to small changes, request a personal disclaimer by sending per the file request-disclaim.changes.

If the contributor is likely to keep making changes, person might want to sign an assignment for all per future changes to the program. So it is useful to offer per that alternative. If person wants to do it that way, send per the request-assign.future.

When you send a request- file, you don’t need to fill in anything before sending it. Just send the file verbatim to the contributor. The file gives per instructions for how to ask the FSF to mail per the papers to sign. The request- file also raises the issue of getting an employer’s disclaimer from the contributor’s employer.

When the contributor emails the form to the FSF, the FSF sends per an electronic (usually PDF) copy of the assignment. This, or whatever response is required, should happen within five business days of the initial request. If no reply from the FSF comes after that time, please send a reminder. If there is still no response after an additional week, please write to maintainers@gnu.org about it.

After receiving the necessary form, the contributor needs to sign it. Contributors residing in the USA may use GPG in order to sign their assignment. Contributors located in the USA or Germany can print, sign, and then email (or fax) a scanned copy back to the FSF. (Specific instructions for both cases are sent with the assignment form.) They may use postal mail, if they prefer. Contributors residing outside the USA or Germany must mail the signed form to the FSF via postal mail. To emphasize, the necessary distinction is between residents and non-residents of these countries; citizenship does not matter.

For less common cases, we have template files you should send to the contributor. Be sure to fill in the name of the person and the name of the program in these templates, where it says ‘NAME OF PERSON’ and ‘NAME OF PROGRAM’, before sending; otherwise person might sign without noticing them, and the papers would be useless. Note that in some templates there is more than one place to put the name of the program or the name of the person; be sure to change all of them. All the templates raise the issue of an employer’s disclaimer as well.

You do not need to ask for separate papers for a manual that is distributed only in the software package it describes. But if we sometimes distribute the manual separately (for instance, if we publish it as a book), then we need separate legal papers for changes in the manual. For smaller changes, use disclaim.changes.manual; for larger ones, use assign.changes.manual. To cover both past and future changes to a manual, you can use assign.future.manual. For a translation of a manual, use assign.translation.manual.

For translations of program strings (as used by GNU Gettext, for example; see Internationalization in GNU Coding Standards), use disclaim.translation. If you make use of the Translation Project (http://translationproject.org) facilities, please check with the TP coordinators that they have sent the contributor the papers; if they haven’t, then you should send the papers. In any case, you should wait for the confirmation from the FSF that the signed papers have been received and accepted before integrating the new contributor’s material, as usual.

If a contributor is reluctant to sign an assignment for a large change, and is willing to sign a disclaimer instead, that is acceptable, so you should offer this alternative if it helps you reach agreement. We prefer an assignment for a larger change, so that we can enforce the GNU GPL for the new text, but a disclaimer is enough to let us use the text.

If you maintain a collection of programs, occasionally someone will contribute an entire separate program or manual that should be added to the collection. Then you can use the files request-assign.program, disclaim.program, assign.manual, and disclaim.manual. We very much prefer an assignment for a new separate program or manual, unless it is quite small, but a disclaimer is acceptable if the contributor insists on handling the matter that way.

If a contributor wants the FSF to publish only a pseudonym, that is ok. The contributor should say this, and state the desired pseudonym, when answering the request- form. The actual legal papers will use the real name, but the FSF will publish only the pseudonym. When using one of the other forms, fill in the real name but ask the contributor to discuss the use of a pseudonym with assign@gnu.org before sending back the signed form.

Although there are other templates besides the ones listed here, they are for special circumstances; please do not use them without getting advice from assign@gnu.org.

If you are not sure what to do, then please ask assign@gnu.org for advice; if the contributor asks you questions about the meaning and consequences of the legal papers, and you don’t know the answers, you can forward them to assign@gnu.org and we will answer.

Please do not try changing the wording of a template yourself. If you think a change is needed, please talk with assign@gnu.org, and we will work with a lawyer to decide what to do.


Next: , Previous: , Up: Legal Matters   [Contents][Index]

6.2 Legally Significant Changes

If a person contributes more than around 15 lines of code and/or text that is legally significant for copyright purposes, we need copyright papers for that contribution, as described above.

A change of just a few lines (less than 15 or so) is not legally significant for copyright. A regular series of repeated changes, such as renaming a symbol, is not legally significant even if the symbol has to be renamed in many places. Keep in mind, however, that a series of minor changes by the same person can add up to a significant contribution. What counts is the total contribution of the person; it is irrelevant which parts of it were contributed when.

Copyright does not cover ideas. If someone contributes ideas but no text, these ideas may be morally significant as contributions, and worth giving credit for, but they are not significant for copyright purposes. Likewise, bug reports do not count for copyright purposes.

When giving credit to people whose contributions are not legally significant for copyright purposes, be careful to make that fact clear. The credit should clearly say they did not contribute significant code or text.

When people’s contributions are not legally significant because they did not write code, do this by stating clearly what their contribution was. For instance, you could write this:

/*
 * Ideas by:
 *   Richard Mlynarik <mly@adoc.xerox.com> (1997)
 *   Masatake Yamato <masata-y@is.aist-nara.ac.jp> (1999)
 */

Ideas by: makes it clear that Mlynarik and Yamato here contributed only ideas, not code. Without the Ideas by: note, several years from now we would find it hard to be sure whether they had contributed code, and we might have to track them down and ask them.

When you record a small patch in a change log file, first search for previous changes by the same person, and see if per past contributions, plus the new one, add up to something legally significant. If so, you should get copyright papers for all per changes before you install the new change.

If that is not so, you can install the small patch. Write ‘(tiny change)’ after the patch author’s name, like this:

2002-11-04  Robert Fenk  <Robert.Fenk@gmx.de>  (tiny change)

Next: , Previous: , Up: Legal Matters   [Contents][Index]

6.3 Recording Contributors

Keep correct records of which portions were written by whom. This is very important. These records should say which files or parts of files were written by each person, and which files or parts of files were revised by each person. This should include installation scripts as well as manuals and documentation files—everything.

These records don’t need to be as detailed as a change log. They don’t need to distinguish work done at different times, only different people. They don’t need describe changes in more detail than which files or parts of a file were changed. And they don’t need to say anything about the function or purpose of a file or change—the Register of Copyrights doesn’t care what the text does, just who wrote or contributed to which parts.

The list should also mention if certain files distributed in the same package are really a separate program.

Only the contributions that are legally significant for copyright purposes (see Legally Significant) need to be listed. Small contributions, bug reports, ideas, etc., can be omitted.

For example, this would describe an early version of GAS:

Dean Elsner   first version of all files except gdb-lines.c and m68k.c.
Jay Fenlason  entire files gdb-lines.c and m68k.c, most of app.c,
              plus extensive changes in messages.c, input-file.c, write.c
              and revisions elsewhere.

Note: GAS is distributed with the files obstack.c and obstack.h, but
they are considered a separate package, not part of GAS proper.

Please keep these records in a file named AUTHORS in the source directory for the program itself.

You can use the change log as the basis for these records, if you wish. Just make sure to record the correct author for each change (the person who wrote the change, not the person who installed it), and add ‘(tiny change)’ for those changes that are too trivial to matter for copyright purposes. Later on you can update the AUTHORS file from the change log. This can even be done automatically, if you are careful about the formatting of the change log entries.

It is ok to include other email addresses, names, and program information in AUTHORS, such as bug-reporting information. See Standard Mailing Lists.


Next: , Previous: , Up: Legal Matters   [Contents][Index]

6.4 Copying from Other Packages

This section explains legal considerations when merging code from other packages into your package. Using an entire module as a whole, and maintaining its separate identity, is a different issue; see External Libraries.


Next: , Up: Copying from Other Packages   [Contents][Index]

6.4.1 Non-FSF-Copyrighted Package

Here we suppose that your package is not FSF-copyrighted.

When you copy legally significant code from another free software package with a GPL-compatible license, you should look in the package’s records to find out the authors of the part you are copying, and list them as the contributors of the code that you copied. If all you did was copy it, not write it, then for copyright purposes you are not one of the contributors of this code.

If the code is supposed to be in the public domain, make sure that is really true: that all the authors of the code have disclaimed copyright interest. Then, when copying the new files into your project, add a brief note at the beginning of the files recording the authors, the public domain status, and anything else relevant.

On the other hand, when merging some public domain code into an existing file covered by the GPL (or LGPL or other free software license), there is no reason to indicate the pieces which are public domain. The notice saying that the whole file is under the GPL (or other license) is legally sufficient.

Using code that is not in the public domain, but rather released under a GPL-compatible free license, may require preserving copyright notices or other steps. Of course, you should follow the requirements stated.


Previous: , Up: Copying from Other Packages   [Contents][Index]

6.4.2 FSF-Copyrighted Package

If you are maintaining an FSF-copyrighted package, please don’t copy in any code without verifying first that we have suitable legal papers for that code.

If you are copying from another FSF-copyrighted package, then we presumably have papers for that package’s own code, but you must check whether the code you are copying is part of an external library; if that is the case, we don’t have papers for it, so you should not copy it. It can’t hurt in any case to double-check with the developer of that package.

When you are copying code for which we do not already have papers, you need to get papers for it. It may be difficult to get the papers if the code was not written as a contribution to your package, but that doesn’t mean it is ok to do without them. If you cannot get papers for the code, you can only use it as an external library (see External Libraries).


Next: , Previous: , Up: Legal Matters   [Contents][Index]

6.5 Copyright Notices

You should maintain a proper copyright notice and a license notice in each nontrivial file in the package. (Any file more than ten lines long is nontrivial for this purpose.) This includes header files and interface definitions for building or running the program, documentation files, and any supporting files. If a file has been explicitly placed in the public domain, then instead of a copyright notice, it should have a notice saying explicitly that it is in the public domain.

Even image files and sound files should contain copyright notices and license notices, if their format permits. Some formats do not have room for textual annotations; for these files, state the copyright and copying permissions in a README file in the same directory.

Change log files should have a copyright notice and license notice at the end, since new material is added at the beginning but the end remains the end.

When a file is automatically generated from some other file in the distribution, it is useful for the automatic procedure to copy the copyright notice and permission notice of the file it is generated from, if possible. Alternatively, put a notice at the beginning saying which file it is generated from.

A copyright notice looks like this:

Copyright (C) year1, year2, year3 copyright-holder

The word ‘Copyright’ must always be in English, by international convention.

The copyright-holder may be the Free Software Foundation, Inc., or someone else; you should know who is the copyright holder for your package.

Replace the ‘(C)’ with a C-in-a-circle symbol if it is available. For example, use ‘@copyright{}’ in a Texinfo file. However, stick with parenthesized ‘C’ unless you know that C-in-a-circle will work. For example, a program’s standard --version message should use parenthesized ‘C’ by default, though message translations may use C-in-a-circle in locales where that symbol is known to work. Alternatively, the ‘(C)’ or C-in-a-circle can be omitted entirely; the word ‘Copyright’ suffices.

To update the list of year numbers, add each year in which you have made nontrivial changes to the package. (Here we assume you’re using a publicly accessible revision control server, so that every revision installed is also immediately and automatically published.) When you add the new year, it is not required to keep track of which files have seen significant changes in the new year and which have not. It is recommended and simpler to add the new year to all files in the package, and be done with it for the rest of the year.

Don’t delete old year numbers, though; they are significant since they indicate when older versions might theoretically go into the public domain, if the movie companies don’t continue buying laws to further extend copyright. If you copy a file into the package from some other program, keep the copyright years that come with the file.

You can use a range (‘2008-2010’) instead of listing individual years (‘2008, 2009, 2010’) if and only if: 1) every year in the range, inclusive, really is a “copyrightable” year that would be listed individually; and 2) you make an explicit statement in a README file about this usage.

For files which are regularly copied from another project (such as ‘gnulib’), leave the copyright notice as it is in the original.

The copyright statement may be split across multiple lines, both in source files and in any generated output. This often happens for files with a long history, having many different years of publication.

For an FSF-copyrighted package, if you have followed the procedures to obtain legal papers, each file should have just one copyright holder: the Free Software Foundation, Inc. You should edit the file’s copyright notice to list that name and only that name.

But if contributors are not all assigning their copyrights to a single copyright holder, it can easily happen that one file has several copyright holders. Each contributor of nontrivial text is a copyright holder.

In that case, you should always include a copyright notice in the name of main copyright holder of the file. You can also include copyright notices for other copyright holders as well, and this is a good idea for those who have contributed a large amount and for those who specifically ask for notices in their names. (Sometimes the license on code that you copy in may require preserving certain copyright notices.) But you don’t have to include a notice for everyone who contributed to the file (which would be rather inconvenient).

Sometimes a program has an overall copyright notice that refers to the whole program. It might be in the README file, or it might be displayed when the program starts up. This copyright notice should mention the year of completion of the most recent major version; it can mention years of completion of previous major versions, but that is optional.


Next: , Previous: , Up: Legal Matters   [Contents][Index]

6.6 License Notices

Every nontrivial file needs a license notice as well as the copyright notice. (Without a license notice giving permission to copy and change the file, the file is non-free.)

The package itself should contain a full copy of GPL in plain text (conventionally in a file named COPYING) and the GNU Free Documentation License (included within your documentation, so there is no need for a separate plain text version). If the package contains any files distributed under the Lesser GPL, it should contain a full copy of its plain text version also (conventionally in a file named COPYING.LESSER).

If you have questions about licensing issues for your GNU package, please write licensing@gnu.org.


Next: , Up: License Notices   [Contents][Index]

6.6.1 Licensing of GNU Packages

Normally, GNU packages should use the latest version of the GNU GPL, with the “or any later version” formulation. See License Notices for Code, for the exact wording of the license notice.

Occasionally, a GNU library may provide functionality which is already widely available to proprietary programs through alternative implementations; for example, the GNU C Library. In such cases, the Lesser GPL should be used (again, for the notice wording, see License Notices for Code). If a GNU library provides unique functionality, however, the GNU GPL should be used. http://www.gnu.org/licenses/why-not-lgpl.html discusses this strategic choice.

Some of these libraries need to work with programs released under GPLv2-only; that is, which allow the GNU GPL version 2 but not later versions. In this case, the GNU package should be released under a dual license: GNU GPL version 2 (or any later version) and the GNU Lesser GPL version 3 (or any later version). Here is the notice for that case:

This file is part of GNU package.

GNU package is free software: you can redistribute it and/or
modify it under the terms of either:

  * the GNU Lesser General Public License as published by the Free
    Software Foundation; either version 3 of the License, or (at your
    option) any later version.

or

  * 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.

or both in parallel, as here.

GNU package 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 copies of the GNU General Public License and
the GNU Lesser General Public License along with this program.  If
not, see http://www.gnu.org/licenses/.

For small packages, you can use “This program” instead of “GNU package”.


Next: , Previous: , Up: License Notices   [Contents][Index]

6.6.2 Canonical License Sources

You can get the official versions of these files from several places. You can use whichever is the most convenient for you.

The official Texinfo sources for the licenses are also available in those same places, so you can include them in your documentation. A GFDL-covered manual should include the GFDL in this way. See GNU Sample Texts in Texinfo, for a full example in a Texinfo manual.


Next: , Previous: , Up: License Notices   [Contents][Index]

6.6.3 License Notices for Code

Typically the license notice for program files (including build scripts, configure files and makefiles) should cite the GPL, like this:

This file is part of GNU package.

GNU package 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.

GNU package 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, see http://www.gnu.org/licenses/.

But in a small program which is just a few files, you can use this instead:

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.

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, see http://www.gnu.org/licenses/.

In either case, for those few packages which use the Lesser GPL (see Licensing of GNU Packages), insert the word “Lesser” before “General” in all three places. http://www.gnu.org/licenses/gpl-howto.html discusses application the GPL in more detail.


Next: , Previous: , Up: License Notices   [Contents][Index]

6.6.4 License Notices for Documentation

Documentation files should have license notices also. Manuals should use the GNU Free Documentation License. Following is an example of the license notice to use after the copyright line(s) using all the features of the GFDL.

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 the
Invariant Sections being ``GNU General Public License'', with the
Front-Cover Texts being ``A GNU Manual'', and with the Back-Cover Texts
as in (a) below.  A copy of the license is included in the section
entitled ``GNU Free Documentation License''.

(a) The FSF's Back-Cover Text is: ``You have the freedom to
copy and modify this GNU manual.  Buying copies from the FSF
supports it in developing GNU and promoting software freedom.''

If the FSF does not publish this manual on paper, then omit the last sentence in (a) that talks about copies from GNU Press. If the FSF is not the copyright holder, then replace ‘FSF’ with the appropriate name.

Please adjust the list of invariant sections as appropriate for your manual. If there are none, then say “with no Invariant Sections”. If your manual is not published by the FSF, and under 400 pages, you can omit both cover texts. However, if it is copyright FSF, always ask the FSF what to do.

See GNU Sample Texts in Texinfo, for a full example in a Texinfo manual, and see http://www.gnu.org/licenses/fdl-howto.html for more advice about how to use the GNU FDL.

If you write a manual that people might want to buy on paper, please write to maintainers@gnu.org to tell the FSF about it. We might want to publish it.

If the manual is over 400 pages, or if the FSF thinks it might be a good choice for publishing on paper, then please include the GNU GPL, as in the notice above. Please also include our standard invariant section which explains the importance of free documentation. Write to assign@gnu.org to get a copy of this section.

When you distribute several manuals together in one software package, their on-line forms can share a single copy of the GFDL (see section 6). However, the printed (‘.dvi’, ‘.pdf’, …) forms should each contain a copy of the GFDL, unless they are set up to be printed and published only together. Therefore, it is usually simplest to include the GFDL in each manual.


Previous: , Up: License Notices   [Contents][Index]

6.6.5 License Notices for Other Files

Small supporting files, short manuals (under 300 lines long) and rough documentation (README files, INSTALL files, etc.) can use a simple all-permissive license like this one:

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.

Older versions of this license did not have the second sentence with the express warranty disclaimer. There is no urgent need to update existing files, but new files should use the new text.

If your package distributes Autoconf macros that are intended to be used (hence distributed) by third-party packages under possibly incompatible licenses, you may also use the above all-permissive license for these macros.


Next: , Previous: , Up: Legal Matters   [Contents][Index]

6.7 External Libraries

When maintaining an FSF-copyrighted GNU package, you may occasionally want to use a general-purpose free software module which offers a useful functionality, as a “library” facility (though the module is not always packaged technically as a library).

Make sure the license of the module is compatible with current and future GPL versions. “GNU GPL version 3 or later” is good, and so is anything which includes permission for use under those GPL versions (including “GNU GPL version 2 or later”, “LGPL version n or later”, “LGPL version 2.1”, “GNU Affero GPL version 3 or later”). Lax permissive licenses are ok too, since they are compatible with all GPL versions.

“GPL version 2 only” is obviously unacceptable because it is incompatible with GPL version 3. “GPL version 3 only” and “GPL version 2 or 3 only” have a subtler problem: they would be incompatible with GPL version 4, if we ever make one, so the module would become an obstacle to upgrading your package’s license to “GPL version 4 or later”.

One package you need to avoid is goffice, since it allows only GPL versions 2 and 3.

It would be unreasonable to ask the author of the external module to assign its copyright to the FSF. After all, person did not write it specifically as a contribution to your package, so it would be impertinent to ask, out of the blue, “Please give the FSF your copyright.”

So make your program use the module but without treating the module as a part of your program. There are two reasonable methods of doing this:

  1. Assume the module is already installed on the system, and use it when linking your program. This is only reasonable if the module really has the form of a library.
  2. Include the module in your package, putting the source in a separate subdirectory whose README file says, “This is not part of the GNU FOO program, but is used with GNU FOO.” Then set up your makefiles to build this module and link it into the executable.

    For this method, it is not necessary to treat the module as a library and make a ‘.a’ file from it. You can link with the ‘.o’ files directly in the usual manner.

Both of these methods create an irregularity, and our lawyers have told us to minimize the amount of such irregularity. So consider using these methods only for general-purpose modules that were written for other programs and released separately for general use. For anything that was written as a contribution to your package, please get papers signed.


Previous: , Up: Legal Matters   [Contents][Index]

6.8 Crediting Authors

Strictly speaking, this is not a legal issue, but it seems to belong with copyright notices.

In any FSF-copyrighted GNU package, the authors of a file are not named in the copyright notice. Therefore, it is nice to include a comment line ‘Authors: authors of this file’ at the top near the copyright notice, to give them credit in close association with their contribution.


Next: , Previous: , Up: Top   [Contents][Index]

7 Cleaning Up Changes

Don’t feel obligated to include every change that someone asks you to include. You must judge which changes are improvements—partly based on what you think the users will like, and partly based on your own judgment of what is better. If you think a change is not good, you should reject it.

If someone sends you changes which are useful, but written in an ugly way or hard to understand and maintain in the future, don’t hesitate to ask per to clean up their changes before you merge them. Since the amount of work we can do is limited, the more we convince others to help us work efficiently, the faster GNU will advance.

If the contributor will not or can not make the changes clean enough, then it is legitimate to say “I can’t install this in its present form; I can only do so if you clean it up.” Invite per to distribute per changes another way, or to find other people to make them clean enough for you to install and maintain.

The only reason to do these cleanups yourself is if (1) it is easy, less work than telling the author what to clean up, or (2) the change is an important one, important enough to be worth the work of cleaning it up.

The GNU Coding Standards are a good thing to send people when you ask them to clean up changes (see Contents in GNU Coding Standards). The Emacs Lisp manual contains an appendix that gives coding standards for Emacs Lisp programs; it is good to urge Lisp authors to read it (see Tips and Conventions in The GNU Emacs Lisp Reference Manual).


Next: , Previous: , Up: Top   [Contents][Index]

8 Platforms to Support

Most GNU packages run on a wide range of platforms. These platforms are not equally important.

The most important platforms for a GNU package to support are GNU and GNU/Linux. Developing the GNU operating system is the whole point of the GNU Project; a GNU package exists to make the whole GNU system more powerful. So please keep that goal in mind and let it shape your work. For instance, every new feature you add should work on GNU, and GNU/Linux if possible too. If a new feature only runs on GNU and GNU/Linux, it could still be acceptable. However, a feature that runs only on other systems and not on GNU or GNU/Linux makes no sense in a GNU package.

You will naturally want to keep the program running on all the platforms it supports. But you personally will not have access to most of these platforms—so how should you do it?

Don’t worry about trying to get access to all of these platforms. Even if you did have access to all the platforms, it would be inefficient for you to test the program on each platform yourself. Instead, you should test the program on a few platforms, including GNU or GNU/Linux, and let the users test it on the other platforms. You can do this through a pretest phase before the real release; when there is no reason to expect problems, in a package that is mostly portable, you can just make a release and let the users tell you if anything unportable was introduced.

It is important to test the program personally on GNU or GNU/Linux, because these are the most important platforms for a GNU package. If you don’t have access to one of these platforms, as a GNU maintainer you can get access to the general GNU login machine; see http://www.gnu.org/software/README.accounts.html.

Supporting other platforms is optional—we do it when that seems like a good idea, but we don’t consider it obligatory. If the users don’t take care of a certain platform, you may have to desupport it unless and until users come forward to help. Conversely, if a user offers changes to support an additional platform, you will probably want to install them, but you don’t have to. If you feel the changes are complex and ugly, if you think that they will increase the burden of future maintenance, you can and should reject them. This includes both free or mainly-free platforms such as OpenBSD, FreeBSD, and NetBSD, and non-free platforms such as Windows.


Next: , Previous: , Up: Top   [Contents][Index]

9 Dealing With Mail

This chapter describes setting up mailing lists for your package, and gives advice on how to handle bug reports and random requests once you have them.


Next: , Up: Mail   [Contents][Index]

9.1 Standard Mailing Lists

Once a program is in use, you will get bug reports for it. Most GNU programs have their own special lists for sending bug reports. The advertised bug-reporting email address should always be ‘bug-package@gnu.org’, to help show users that the program is a GNU package, but it is ok to set up that list to forward to another site if you prefer.

We also have a catch-all list, bug-gnu-utils@gnu.org, which is used for all GNU programs that don’t have their own specific lists. But nowadays we want to give each program its own bug-reporting list and move away from using bug-gnu-utils.

See Replying to Mail, for more about handling and tracking bug reports.

Some GNU programs with many users have another mailing list, ‘help-package.org’, for people to ask other users for help. If your program has many users, you should create such a list for it. For a fairly new program, which doesn’t have a large user base yet, it is better not to bother with this.

If you wish, you can also have a mailing list ‘info-package’ for announcements (see Announcements). Any other mailing lists you find useful can also be created.

The package distribution should state the name of all the package’s mailing lists in a prominent place, and ask users to help us by reporting bugs appropriately. The top-level README file and/or AUTHORS file are good places. Mailing list information should also be included in the manual and the package web pages (see Web Pages).


Next: , Previous: , Up: Mail   [Contents][Index]

9.2 Creating Mailing Lists

Using the web interface on savannah.gnu.org is by far the easiest way to create normal mailing lists, managed through Mailman on the GNU mail server. Once you register your package on Savannah, you can create (and remove) lists yourself through the ‘Mailing Lists’ menu, without needing to wait for intervention by anyone else. Furthermore, lists created through Savannah will have a reasonable default configuration for antispam purposes (see below).

To create and maintain simple aliases and unmanaged lists, you can edit /com/mailer/aliases on the main GNU server. If you don’t have an account there, please read http://www.gnu.org/software/README.accounts.html (see GNU Accounts and Resources).

But if you don’t want to learn how to do those things, you can ask new-mailing-list@gnu.org to help you.

You should moderate postings from non-subscribed addresses on your mailing lists, to prevent propagation of unwanted messages (“spam”) to subscribers and to the list archives. For lists controlled by Mailman, you can do this by setting Privacy Options - Sender Filter - generic_nonmember_action to Hold, and then periodically (daily is best) reviewing the held messages, accepting the real ones and discarding the junk.

Lists created through Savannah will have this setting, and a number of others, such that spam will be automatically deleted (after a short delay). The Savannah mailing list page describes all the details. You should still review the held messages in order to approve any that are real.


Previous: , Up: Mail   [Contents][Index]

9.3 Replying to Mail

When you receive bug reports, keep in mind that bug reports are crucial for your work. If you don’t know about problems, you cannot fix them. So always thank each person who sends a bug report.

You don’t have an obligation to give more response than that, though. The main purpose of bug reports is to help you contribute to the community by improving the next version of the program. Many of the people who report bugs don’t realize this—they think that the point is for you to help them individually. Some will ask you to focus on that instead of on making the program better. If you comply with their wishes, you will have been distracted from the job of maintaining the program.

For example, people sometimes report a bug in a vague (and therefore useless) way, and when you ask for more information, they say, “I just wanted to see if you already knew the solution” (in which case the bug report would do nothing to help improve the program). When this happens, you should explain to them the real purpose of bug reports. (A canned explanation will make this more efficient.)

When people ask you to put your time into helping them use the program, it may seem “helpful” to do what they ask. But it is much less helpful than improving the program, which is the maintainer’s real job.

By all means help individual users when you feel like it, if you feel you have the time available. But be careful to limit the amount of time you spend doing this—don’t let it eat away the time you need to maintain the program! Know how to say no; when you are pressed for time, just “thanks for the bug report—I will fix it” is enough response.

Some GNU packages, such as Emacs and GCC, come with advice about how to make bug reports useful. Copying and adapting that could be very useful for your package.

If you would like to use an email-based bug tracking system, see http://bugs.gnu.org; this can be connected with the regular bug-reporting address. Alternatively, if you would like to use a web-based bug tracking system, Savannah supports this (see Old Versions), but please don’t fail to accept bugs by regular email as well—we don’t want to put up unnecessary barriers against users submitting reports.


Next: , Previous: , Up: Top   [Contents][Index]

10 Recording Old Versions

It is very important to keep backup files of all source files of GNU. You can do this using a source control system (such as Bazaar, RCS, CVS, Git, Subversion, …) if you like. An easy way to use many such systems is via the Version Control library in Emacs (see Introduction to Version Control in The GNU Emacs Manual).

The history of previous revisions and log entries is very important for future maintainers of the package, so even if you do not make it publicly accessible, be careful not to put anything in the repository or change log that you would not want to hand over to another maintainer some day.

The GNU Project provides a server that GNU packages can use for source control and other package needs: savannah.gnu.org. Savannah is managed by savannah-hackers@gnu.org. For more details on using and contributing to Savannah, see http://savannah.gnu.org/maintenance.

It’s not an absolute requirement, but all GNU maintainers are strongly encouraged to take advantage of Savannah, as sharing such a central point can serve to foster a sense of community among GNU developers as well as help in keeping up with project management. Please don’t mark Savannah projects for GNU packages as private; that defeats a large part of the purpose of using Savannah in the first place.

If you do use Savannah, please subscribe to the savannah-announce@gnu.org mailing list (http://lists.gnu.org/mailman/listinfo/savannah-announce). This is a very low-volume list to keep Savannah users informed of system upgrades, problems, and the like.


Next: , Previous: , Up: Top   [Contents][Index]

11 Distributions

Please follow the GNU conventions when making GNU software distributions.


Next: , Up: Distributions   [Contents][Index]

11.1 Distribution tar Files

The tar file for version m.n of program foo should be named foo-m.n.tar. It should unpack into a subdirectory named foo-m.n. Tar files should not unpack into files in the current directory, because this is inconvenient if the user happens to unpack into a directory with other files in it.

Here is how the Makefile for Bison creates the tar file. This method is good for other programs.

dist: bison.info
        echo bison-`sed -e '/version_string/!d' \
          -e 's/[^0-9.]*\([0-9.]*\).*/\1/' -e q version.c` > .fname
        -rm -rf `cat .fname`
        mkdir `cat .fname`
        dst=`cat .fname`; for f in $(DISTFILES); do \
           ln $(srcdir)/$$f $$dst/$$f || { echo copying $$f; \
             cp -p $(srcdir)/$$f $$dst/$$f ; } \
        done
        tar --gzip -chf `cat .fname`.tar.gz `cat .fname`
        -rm -rf `cat .fname` .fname

Source files that are symbolic links to other file systems cannot be installed in the temporary directory using ln, so use cp if ln fails.

Using Automake is a good way to take care of writing the dist target.


Next: , Previous: , Up: Distributions   [Contents][Index]

11.2 Distribution Patches

If the program is large, it is useful to make a set of diffs for each release, against the previous important release.

At the front of the set of diffs, put a short explanation of which version this is for and which previous version it is relative to. Also explain what else people need to do to update the sources properly (for example, delete or rename certain files before installing the diffs).

The purpose of having diffs is that they are small. To keep them small, exclude files that the user can easily update. For example, exclude info files, DVI files, tags tables, output files of Bison or Flex. In Emacs diffs, we exclude compiled Lisp files, leaving it up to the installer to recompile the patched sources.

When you make the diffs, each version should be in a directory suitably named—for example, gcc-2.3.2 and gcc-2.3.3. This way, it will be very clear from the diffs themselves which version is which.

If you use GNU diff to make the patch, use the options ‘-rc2P’. That will put any new files into the output as “entirely different”. Also, the patch’s context diff headers should have dates and times in Universal Time using traditional Unix format, so that patch recipients can use GNU patch’s ‘-Z’ option. For example, you could use the following Bourne shell command to create the patch:

LC_ALL=C TZ=UTC0 diff -rc2P gcc-2.3.2 gcc-2.3.3 | \
gzip -9 >gcc-2.3.2-2.3.3.patch.gz

If the distribution has subdirectories in it, then the diffs probably include some files in the subdirectories. To help users install such patches reliably, give them precise directions for how to run patch. For example, say this:

To apply these patches, cd to the main directory of the program
and then use ‘patch -p1’.   ‘-p1’ avoids guesswork in choosing
which subdirectory to find each file in.

It’s wise to test your patch by applying it to a copy of the old version, and checking that the result exactly matches the new version.


Next: , Previous: , Up: Distributions   [Contents][Index]

11.3 Binary Distribution for Nonfree Platforms

Some package maintainers release pre-compiled binaries proprietary for systems such as Microsoft Windows or MacOS. It’s entirely up to you whether to do that; we don’t ask you to do it, but we don’t object. Please do not let anyone make you feel you have an obligation to do this.

If you distribute them, please inform their users prominently that those non-free platforms trample their freedom. It is useful to refer them to http://www.gnu.org/philosophy/free-software-even-more-important.html. You can say, “This program respects your freedom, but Windows does not. To have freedom, you need to stop using Windows and other software that denies your freedom.”


Next: , Previous: , Up: Distributions   [Contents][Index]

11.4 Distribution on ftp.gnu.org

We strongly recommend using ftp.gnu.org to distribute official releases. If you want to also distribute the package from a site of your own, that is fine. To use some other site instead of ftp.gnu.org is acceptable, provided it allows connections from anyone anywhere.

See Automated FTP Uploads, for the procedural details of putting new versions on ftp.gnu.org.


Next: , Previous: , Up: Distributions   [Contents][Index]

11.5 Test Releases

When you release a greatly changed new major version of a program, you might want to do so as a pretest. This means that you make a tar file, but send it only to a group of volunteers that you have recruited. (Use a suitable GNU mailing list/newsgroup to recruit them.)

We normally use the server alpha.gnu.org for pretests and prerelease versions. See Automated FTP Uploads, for the procedural details of putting new versions on alpha.gnu.org.

Once a program gets to be widely used and people expect it to work solidly, it is a good idea to do pretest releases before each “real” release.

There are two ways of handling version numbers for pretest versions. One method is to treat them as versions preceding the release you are going to make.

In this method, if you are about to release version 4.6 but you want to do a pretest first, call it 4.5.90. If you need a second pretest, call it 4.5.91, and so on. If you are really unlucky and ten pretests are not enough, after 4.5.99 you could advance to 4.5.990 and so on. (You could also use 4.5.100, but 990 has the advantage of sorting in the right order.)

The other method is to attach a date to the release number that is coming. For a pretest for version 4.6, made on Dec 10, 2002, this would be 4.6.20021210. A second pretest made the same day could be 4.6.20021210.1.

For development snapshots that are not formal pretests, using just the date without the version numbers is ok too.

One thing that you should never do is to release a pretest with the same version number as the planned real release. Many people will look only at the version number (in the tar file name, in the directory name that it unpacks into, or wherever they can find it) to determine whether a tar file is the latest version. People might look at the test release in this way and mistake it for the real release. Therefore, always change the number when you release changed code.


Next: , Previous: , Up: Distributions   [Contents][Index]

11.6 Automated FTP Uploads

In order to upload new releases to ftp.gnu.org or alpha.gnu.org, you first need to register the necessary information. Then, you can perform uploads yourself, with no intervention needed by the system administrators.

The general idea is that releases should be cryptographically signed before they are made publicly available.


Next: , Up: Automated FTP Uploads   [Contents][Index]

11.6.1 Automated Upload Registration

Here is how to register your information so you can perform uploads for your GNU package:

  1. Create an account for yourself at http://savannah.gnu.org, if you don’t already have one. By the way, this is also needed to maintain the web pages at http://www.gnu.org for your project (see Web Pages).
  2. In the ‘My Account Conf’ page on savannah, upload the GPG key (in ASCII-armored format) that you will use to sign your packages. If you haven’t created one before, you can do so with the command gpg --gen-key (you can accept and/or confirm the default answers to its questions). Then, to get the ASCII-armored version, run ‘gpg --export --armor your_key_id’.

    Optional but recommended: Send your key to a GPG public key server: gpg --keyserver keys.gnupg.net --send-keys keyid, where keyid is the eight hex digits reported by gpg --list-public-keys on the pub line before the date. For full information about GPG, see http://www.gnu.org/software/gpg.

  3. Compose a message with the following items in some msgfile. Then GPG-sign it by running gpg --clearsign msgfile, and finally email the resulting msgfile.asc to ftp-upload@gnu.org.
    1. Name of package(s) that you are the maintainer for, your preferred email address, and your Savannah username.
    2. The ASCII armored copy of your GPG key, as an attachment.
    3. A list of names and preferred email addresses of other individuals you authorize to make releases for which packages, if any (in the case that you don’t make all releases yourself).
    4. ASCII armored copies of GPG keys for any individuals listed in (3).

The administrators will acknowledge your message when they have added the proper GPG keys as authorized to upload files for the corresponding packages.

The upload system will email receipts to the given email addresses when an upload is made, either successfully or unsuccessfully.

Should you later have to update your GPG key, you’ll have to re-submit it to both Savannah and ftp-upload@gnu.org, as these systems are not connected.


Next: , Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.2 Automated Upload Procedure

Once you have registered your information as described in the previous section, you can and should do ftp uploads for your package. There are two basic kinds of uploads (details in the following sections):

  1. Three related files (a “triplet”) to upload a file destined for ftp.gnu.org or alpha.gnu.org: see FTP Upload Release File Triplet.
  2. A single (signed) standalone “directive file” to perform operations on the server: see FTP Upload Standalone Directives.

In either case, you upload the file(s) via anonymous ftp to the host ftp-upload.gnu.org. If the upload is destined for ftp.gnu.org, place the file(s) in the directory /incoming/ftp. If the upload is destined for alpha.gnu.org, place the file(s) in the directory /incoming/alpha.

Uploads are processed every five minutes. Uploads that are in progress while the upload processing script is running are handled properly, so do not worry about the timing of your upload. Spurious and stale uploaded files are deleted automatically after 24 hours.

Your designated upload email addresses (see Automated Upload Registration) are sent a message if there are problems processing an upload for your package. You also receive a message when an upload has been successfully processed.

One programmatic way to create and transfer the necessary files is to use the gnupload script, which is available from the build-aux/ directory of the gnulib project at http://savannah.gnu.org/projects/gnulib. Run gnupload --help for a description and examples. (With gnupload, you specify a destination such as ‘ftp.gnu.org:pkgname rather than using the ‘ftp-upload’ hostname.)

gnupload invokes the program ncftpput to do the actual transfers; if you don’t happen to have the ncftp package installed, the ncftpput-ftp script in the build-aux/ directory of gnulib can serve as a replacement. It uses the plain command line ftp program.

If you have difficulties with an upload, email ftp-upload@gnu.org. You can check the archive of uploads processed at https://lists.gnu.org/archive/html/ftp-upload-report.


Next: , Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.3 FTP Upload Release File Triplet

Ordinarily, the goal is to upload a new release of your package, let’s say, the source archive foo-1.0.tar.gz. To do this, you simultaneously upload three files:

  1. The file to be distributed; in our example, foo-1.0.tar.gz.
  2. Detached GPG binary signature file for (1); for example, foo-1.0.tar.gz.sig. Make this with ‘gpg -b foo-1.0.tar.gz’.
  3. A clearsigned directive file; for example, foo-1.0.tar.gz.directive.asc, created with ‘gpg --clearsign foo-1.0.tar.gz.directive’. Its contents are described in the next section.

The names of the files are important. The signature file must have the same name as the file to be distributed, with an additional .sig extension. The directive file must have the same name as the file to be distributed, with an additional .directive.asc extension. If you do not follow this naming convention, the upload will not be processed.


Next: , Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.4 FTP Upload Directive File

To repeat, a (signed) directive file must be part of every upload. The unsigned original is just a plain text file you can create with any text editor. Its name must be, e.g., foo-1.0.tar.gz.directive for accompanying an upload of foo-1.0.tar.gz.

After creating the file, run ‘gpg --clearsign foo-1.0.tar.gz.directive’, which will create foo-1.0.tar.gz.directive.asc; this is the file to be uploaded.

When part of a triplet for uploading a release file, the directive file must always contain the directives version, filename and directory. In addition, a comment directive is optional. These directives can be given in any order.

Continuing our example of uploading foo-1.0.tar.gz for a package named foo to ftp.gnu.org, the values would be as follows:

version

must be the value ‘1.2’ (the current version, as of May 2012):
version: 1.2

filename

must be the name of the file to be distributed:
filename: foo-1.0.tar.gz

directory

specifies the final destination directory where the uploaded file and its .sig companion are to be placed. Here we will put our file in the top level directory of the package, as is the most common practice:
directory: foo

comment

is optional, and ignored if present:
comment: let's hope this works!

Putting all of the above together, the complete contents of the directive file foo-1.0.tar.gz.directive for our example would be:

version: 1.2
directory: foo
filename: foo-1.0.tar.gz
comment: let's hope this works!

Then you ‘gpg --clearsign’ the file as given above, and upload (using anonymous ftp) the three files:

foo-1.0.tar.gz
foo-1.0.tar.gz.sig
foo-1.0.tar.gz.directive.asc

to the host ftp-upload.gnu.org, directory /incoming/ftp (for official releases), or the directory /incoming/alpha (for test releases).

After the system authenticates the signatures, the files foo-1.0.tar.gz and foo-1.0.tar.gz.sig are placed in the directory gnu/foo/ on ftp.gnu.org. That is, we’ll have made our release available at ‘http://ftp.gnu.org/gnu/foo/foo-1.0.tar.gz’ (and then from our many mirrors via ‘http://ftpmirror.gnu.org/foo/foo-1.0.tar.gz’). Whew.

A common reason for the upload not succeeding is your GPG signature not being registered with the upload system. There is nothing that makes this happen automatically. You must email the system administrators as described above (see Automated Upload Registration).


Next: , Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.5 FTP Upload Directory Trees

You can make any directory hierarchy you like under your package directory. The system automatically creates any intermediate directories you specify in the directory directive.

Slightly modifying the example above, the following directive file:

version: 1.2
directory: foo/foo-1.0
filename: foo-1.0.tar.gz
comment: creates per-version subdirectory as needed

would put the tar file in the foo-1.0/ subdirectory of the package foo, thus ending up at ‘ftp.gnu.org:gnu/foo/foo-1.0/foo-1.0.tar.gz’.

However, to keep things simpler for users, we recommend not using subdirectories, unless perhaps each release of your package consists of many separate files.


Next: , Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.6 FTP Upload File Replacement

You can replace existing files that have already been uploaded by including a directive line replace: true. For example, you might like to provide a README file in the release directory and update it from time to time. The full directive file for that would look like this:

replace: true
version: 1.2
directory: foo
filename: README
comment: replaces an existing README

It is ok if the file to be replaced doesn’t already exist; then the new file is simply added, i.e., the replace directive has no effect.

When an existing file is replaced, the original is archived to a private location. There is no automated or public access to such archived files; if you want to retrieve or view them, please email sysadmin@fsf.org.

We very strongly discourage replacing an actual software release file, such as foo-1.0.tar.gz. Releases should be unique, and forever. If you need to make fixes, make another release. If you have an exigent reason for a particular release file to no longer be available, it can be explicitly archived, as described in the next section.

If you want to make the current release available under a generic name, such as foo-latest.tar.gz, that is better done with symlinks, also as described in the next section.


Next: , Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.7 FTP Upload Standalone Directives

The previous sections describe how to upload a file to be publicly released. It’s also possible to upload a directive file by itself to perform a few operations on the upload directory. The supported directives are:

symlink

creates a symlink.

rmsymlink

removes a symlink.

archive

takes a file or directory offline.

As for the directives described above, the directory and version directives are still required, the comment directive remains optional, and the filename directive is not allowed.

When uploaded by itself, the name of the directive file is not important. But it must be still be signed, using ‘gpg --clearsign’; the resulting .asc file is what should be uploaded.

Here’s an example of the full directive file to create a foo-latest.tar.gz symlink:

version: 1.2
directory: foo
symlink: foo-1.1.tar.gz foo-latest.tar.gz
comment: create a symlink

If you include more than one directive in a standalone upload, the directives are executed in the sequence they are specified in. If a directive results in an error, further execution of the upload is aborted.

Removing a symbolic link (with rmsymlink) which does not exist results in an error. On the other hand, attempting to create a symbolic link that already exists (with symlink) is not an error. In this case symlink behaves like the command ln -s -f: any existing symlink is removed before creating the link. (But an existing regular file or directory is not replaced.)

Here’s an example of removing a symlink, e.g., if you decide not to maintain a foo-latest link any more:

version: 1.2
directory: foo
rmsymlink: foo-latest.tar.gz
comment: remove a symlink

And here’s an example of archiving a file, e.g., an unintended upload:

version: 1.2
directory: foo
archive: foo-1.1x.tar.gz
comment: archive an old file; it will not be
comment: publicly available any more.

The archive directive causes the specified items to become inaccessible. This should only be used when it is actively bad for them to be available, e.g., you uploaded something by mistake.

If all you want to do is reduce how much stuff is in your release directory, an alternative is to email sysadmin@fsf.org and ask them to move old items to the http://ftp.gnu.org/old-gnu/ directory; then they will still be available. In general, however, we recommend leaving all official releases in the main release directory.


Next: , Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.8 FTP Upload Directive File - v1.1

The v1.1 protocol for uploads lacked the replace directive; instead, file replacements were done automatically and silently (clearly undesirable). This is the only difference between v1.2 and v1.1.


Previous: , Up: Automated FTP Uploads   [Contents][Index]

11.6.9 FTP Upload Directive File - v1.0

Support for v1.0 uploads was discontinued in May 2012; please upgrade to v1.2.

In v1.0, the directive file contained one line, excluding the clearsigned data GPG that inserts, which specifies the final destination directory where items (1) and (2) are to be placed.

For example, the foo-1.0.tar.gz.directive.asc file might contain the single line:

directory: bar/v1

This directory line indicates that foo-1.0.tar.gz and foo-1.0.tar.gz.sig are part of package bar. If you were to upload the triplet to /incoming/ftp, and the system can positively authenticate the signatures, then the files foo-1.0.tar.gz and foo-1.0.tar.gz.sig will be placed in the directory gnu/bar/v1 of the ftp.gnu.org site.

The directive file can be used to create currently non-existent directory trees, as long as they are under the package directory for your package (in the example above, that is bar).


Previous: , Up: Distributions   [Contents][Index]

11.7 Announcing Releases

When you have a new release, please make an announcement. For official new releases, including those made just to fix bugs, we strongly recommend using the (moderated) general GNU announcements list, info-gnu@gnu.org. Doing so makes it easier for users and developers to find the latest GNU releases. On the other hand, please do not announce test releases on info-gnu unless it’s a highly unusual situation.

Please also post release announcements in the news section of your Savannah project site. Here, it is fine to also write news entries for test releases and any other newsworthy events. The news feeds from all GNU projects at savannah are aggregated at http://planet.gnu.org (GNU Planet), unless the text of the entry contains the string ‘::noplanet::’. You can also post items directly, or arrange for feeds from other locations; see information on the GNU Planet web page.

You can maintain your own mailing list (typically ‘info-package@gnu.org’) for announcements as well if you like. For your own list, of course you decide as you see fit what events are worth announcing. (See Mail, for setting this up, and more suggestions on handling mail for your package.)

When writing an announcement, please include the following:

You may find the announce-gen script useful for creating announcements, which is available from the build-aux/ directory of the gnulib project at http://savannah.gnu.org/projects/gnulib.


Next: , Previous: , Up: Top   [Contents][Index]

12 Web Pages

Please write web pages about your package, and install them on www.gnu.org. They should follow our usual standards for web pages (see http://www.gnu.org/server/fsf-html-style-sheet.html). The overall goals are to support a wide variety of browsers, to focus on information rather than flashy eye candy, and to keep the site simple and uniform.

We encourage you to use the standard www.gnu.org template as the basis for your pages: http://www.gnu.org/server/standards/boilerplate-source.html.

Some GNU packages have just simple web pages, but the more information you provide, the better. So please write as much as you usefully can, and put all of it on www.gnu.org. However, pages that access databases (including mail archives and bug tracking) are an exception; set them up on whatever site is convenient for you, and make the pages on www.gnu.org link to that site.

Please follow the best practices of accessibility in your web pages (see http://www.gnu.org/accessibility/accessibility.html).


Next: , Up: Web Pages   [Contents][Index]

12.1 Hosting for Web Pages

The best way to maintain the web pages for your project is to register the project on savannah.gnu.org. Then you can edit the pages using CVS, using the separate “web pages repository” available on Savannah, which corresponds to ‘http://www.gnu.org/software/package/’. You can keep your source files there too (using any of a variety of version control systems), but you can use savannah.gnu.org only for your gnu.org web pages if you wish; simply register a “web-only” project.

If you don’t want to use that method, please talk with webmasters@gnu.org about other possible methods. For instance, you can mail them pages to install, if necessary. But that is more work for them, so please use Savannah if you can.

If you use Savannah, you can use a special file named .symlinks in order to create symbolic links, which are not supported in CVS. For details, see http://www.gnu.org/server/standards/README.webmastering.html#symlinks.


Next: , Previous: , Up: Web Pages   [Contents][Index]

12.2 Freedom for Web Pages

If you use a site other than www.gnu.org, please make sure that the site runs on free software alone. (It is ok if the site uses unreleased custom software, since that is free in a trivial sense: there’s only one user and it has the four freedoms.) If the web site for a GNU package runs on non-free software, the public will see this, and it will have the effect of granting legitimacy to the non-free program.

If you use multiple sites, they should all follow that criterion. Please don’t link to a site that is about your package, which the public might perceive as connected with it and reflecting the position of its developers, unless it follows that criterion.

Historically, web pages for GNU packages did not include GIF images, because of patent problems (see Ethical and Philosophical Consideration). Although the GIF patents expired in 2006, using GIF images is still not recommended, as the PNG and JPEG formats are generally superior. See http://www.gnu.org/philosophy/gif.html.


Next: , Previous: , Up: Web Pages   [Contents][Index]

12.3 Manuals on Web Pages

The web pages for the package should include its manuals, in HTML, DVI, Info, PDF, plain ASCII, and the source Texinfo. All of these can be generated automatically from Texinfo using Makeinfo and other programs. If the Texinfo itself is generated from some other source format, include that too.

When there is only one manual, put it in a subdirectory called manual; the file manual/index.html should have a link to the manual in each of its forms.

If the package has more than one manual, put each one in a subdirectory of manual, set up index.html in each subdirectory to link to that manual in all its forms, and make manual/index.html link to each manual through its subdirectory.

See the section below for details on a script to make the job of creating all these different formats and index pages easier.

We would like to list all GNU manuals on the page http://www.gnu.org/manual, so if yours isn’t there, please send mail to webmasters@gnu.org, asking them to add yours, and they will do so based on the contents of your manual directory.


Up: Manuals on Web Pages   [Contents][Index]

12.3.1 Invoking gendocs.sh

The script gendocs.sh eases the task of generating the Texinfo documentation output for your web pages section above. It has a companion template file, used as the basis for the HTML index pages. Both are available from the Texinfo CVS sources:

http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh
http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template

There is also a minimalistic template, available from:

http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template_min

Invoke the script like this, in the directory containing the Texinfo source:

gendocs.sh --email yourbuglist yourmanual "GNU yourmanual manual"

where yourmanual is the short name for your package and yourbuglist is the email address for bug reports (which should be bug-package@gnu.org). The script processes the file yourmanual.texinfo (or .texi or .txi). For example:

cd .../texinfo/doc
# download gendocs.sh and gendocs_template
gendocs.sh --email bug-texinfo@gnu.org texinfo "GNU Texinfo manual"

gendocs.sh creates a subdirectory manual/ containing the manual generated in all the standard output formats: Info, HTML, DVI, and so on, as well as the Texinfo source. You then need to move all those files, retaining the subdirectories, into the web pages for your package.

You can specify the option -o outdir to override the name manual. Any previous contents of outdir will be deleted.

The second argument, with the description, is included as part of the HTML <title> of the overall manual/index.html file. It should include the name of the package being documented, as shown. manual/index.html is created by substitution from the file gendocs_template. (Feel free to modify the generic template for your own purposes.)

If you have several manuals, you’ll need to run this script several times with different arguments, specifying a different output directory with -o each time, and moving all the output to your web page. Then write (by hand) an overall index.html with links to them all. For example:

cd .../texinfo/doc
gendocs.sh --email bug-texinfo@gnu.org -o texinfo texinfo "GNU Texinfo manual"
gendocs.sh --email bug-texinfo@gnu.org -o info info "GNU Info manual"
gendocs.sh --email bug-texinfo@gnu.org -o info-stnd info-stnd "GNU info-stnd manual"

By default, the script uses makeinfo for generating HTML output. If you prefer to use texi2html, use the --texi2html command line option, e.g.:

gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"

The template files will automatically produce entries for additional HTML output generated by texi2html (i.e., split by sections and chapters).

You can set the environment variables MAKEINFO, TEXI2DVI, etc., to control the programs that get executed, and GENDOCS_TEMPLATE_DIR to control where the gendocs_template file is found.

As usual, run ‘gendocs.sh --help’ for a description of all the options, environment variables, and more information.

Please email bug reports, enhancement requests, or other correspondence about gendocs to bug-texinfo@gnu.org.


Previous: , Up: Web Pages   [Contents][Index]

12.4 CVS Keywords in Web Pages

Since www.gnu.org works through CVS, CVS keywords in your manual, such as $Log$, need special treatment (even if you don’t happen to maintain your manual in CVS).

If these keywords end up in the generated output as literal strings, they will be expanded. The most robust way to handle this is to turn off keyword expansion for such generated files. For existing files, this is done with:

cvs admin -ko file1 file2 ...

For new files:

cvs add -ko file1 file2 ...

See the “Keyword Substitution” section in the CVS manual, available at http://ximbiot.com/cvs/manual.

In Texinfo source, the recommended way to literally specify a “dollar” keyword is:

@w{$}Log$

The @w prevents keyword expansion in the Texinfo source itself. Also, makeinfo notices the @w and generates output avoiding the literal keyword string.


Next: , Previous: , Up: Top   [Contents][Index]

13 Ethical and Philosophical Consideration

The GNU project takes a strong stand for software freedom. Many times, this means you’ll need to avoid certain technologies when their use would conflict with our long-term goals.

Software patents threaten the advancement of free software and freedom to program. There are so many software patents in the US that any large program probably implements hundreds of patented techniques, unknown to the program’s developers. It would be futile and self-defeating to try to find and avoid all these patents. But there are some patents which we know are likely to be used to threaten free software, so we make an effort to avoid the patented techniques. If you are concerned about the danger of a patent and would like advice, write to licensing@gnu.org, and we will try to help you get advice from a lawyer.

Sometimes the GNU project takes a strong stand against a particular patented technology in order to encourage society to reject it.

For example, the MP3 audio format is covered by a software patent in the USA and some other countries. A patent holder has threatened lawsuits against the developers of free programs (these are not GNU programs) to produce and play MP3, and some GNU/Linux distributors are afraid to include them. Development of the programs continues, but we campaign for the rejection of MP3 format in favor of Ogg Vorbis format.

A GNU package should not recommend use of any non-free program, nor should it require a non-free program (such as a non-free compiler or IDE) to build. Thus, a GNU package cannot be written in a programming language that does not have a free software implementation. Now that GNU/Linux systems are widely available, all GNU packages should provide full functionality on a 100% free GNU/Linux system, and should not require any non-free software to build or function. The GNU Coding Standards say a lot more about this issue.

A GNU package should not refer the user to any non-free documentation for free software. The need for free documentation to come with free software is now a major focus of the GNU project; to show that we are serious about the need for free documentation, we must not contradict our position by recommending use of documentation that isn’t free.

Please don’t host discussions about your package in a service that requires nonfree software. For instance, Google+ “communities” require running a nonfree JavaScript program to post a message, so they can’t be used in the Free World. To host discussions there would be excluding people who live by free software principles.

Of course, you can’t order people not to use such services to talk with each other. What you can do is not legitimize them, and use your influence to lead people away from them. For instance, where you say where to have discussions related to the program, don’t list such a place.

Finally, new issues concerning the ethics of software freedom come up frequently. We ask that GNU maintainers, at least on matters that pertain specifically to their package, stand with the rest of the GNU project when such issues come up.


Next: , Previous: , Up: Top   [Contents][Index]

14 Terminology Issues

This chapter explains a couple of issues of terminology which are important for correcting two widespread and important misunderstandings about GNU.


Next: , Up: Terminology   [Contents][Index]

14.1 Free Software and Open Source

The terms “free software” and “open source”, while describing almost the same category of software, stand for views based on fundamentally different values. The free software movement is idealistic, and raises issues of freedom, ethics, principle and what makes for a good society. The term open source, initiated in 1998, is associated with a philosophy which studiously avoids such questions. For a detailed explanation, see http://www.gnu.org/philosophy/open-source-misses-the-point.html.

The GNU Project is aligned with the free software movement. This doesn’t mean that all GNU contributors and maintainers have to agree; your views on these issues are up to you, and you’re entitled to express them when speaking for yourself.

However, due to the much greater publicity that the term “open source” receives, the GNU Project needs to overcome a widespread mistaken impression that GNU is and always was an “open source” activity. For this reason, please use the term “free software”, not “open source” or “FOSS”, in GNU software releases, GNU documentation, and announcements and articles that you publish in your role as the maintainer of a GNU package. A reference to the URL given above, to explain the difference, is a useful thing to include as well.


Previous: , Up: Terminology   [Contents][Index]

14.2 GNU and Linux

The GNU Project was formed to develop a free Unix-like operating system, GNU. The existence of this system is our major accomplishment. However, the widely used version of the GNU system, in which Linux is used as the kernel, is often called simply “Linux”. As a result, most users don’t know about the GNU Project’s major accomplishment—or more precisely, they know about it, but don’t realize it is the GNU Project’s accomplishment and reason for existence. Even people who believe they know the real history often believe that the goal of GNU was to develop “tools” or “utilities”.

To correct this confusion, we have made a years-long effort to distinguish between Linux, the kernel that Linus Torvalds wrote, and GNU/Linux, the operating system that is the combination of GNU and Linux. The resulting increased awareness of what the GNU Project has already done helps every activity of the GNU Project recruit more support and contributors.

Please make this distinction consistently in GNU software releases, GNU documentation, and announcements and articles that you publish in your role as the maintainer of a GNU package. If you want to explain the terminology and its reasons, you can refer to the URL http://www.gnu.org/gnu/linux-and-gnu.html.

To make it clear that Linux is a kernel, not an operating system, please take care to avoid using the term “Linux system” in those materials. If you want to have occasion to make a statement about systems in which the kernel is Linux, write “systems in which the kernel is Linux” or “systems with Linux as the kernel.” That explicitly contrasts the system and the kernel, and will help readers understand the difference between the two. Please avoid simplified forms such as “Linux-based systems” because those fail to highlight the difference between the kernel and the system, and could encourage readers to overlook the distinction.

To contrast the GNU system proper with GNU/Linux, you can call it “GNU/Hurd” or “the GNU/Hurd system”. However, when that contrast is not specifically the focus, please call it just “GNU” or “the GNU system”.

When referring to the collection of servers that is the higher level of the GNU kernel, please call it “the Hurd” or “the GNU Hurd”. Note that this uses a space, not a slash.

For more about this point, see http://www.gnu.org/gnu/gnu-linux-faq.html.


Next: , Previous: , Up: Top   [Contents][Index]

15 Interviews and Speeches

Interviews and speeches about your package are an important channel for informing the public about the GNU system and the ideas of the free software movement. Please avoid saying “open source” and avoid calling the GNU system “Linux”, just as you would in the package itself (see Terminology). Likewise, avoid promoting nonfree programs (see References in GNU Coding Standards) as you would in the package itself.

Many GNU users have erroneous ideas about GNU. Outside of our community, most people think it is Linux. Please use your opportunity to set them straight. Start the presentation with the answers to these basic questions:

If you feel a social pressure not to say these things, you may be coming in contact with some who would prefer that these things not be said. That’s precisely when we need your support most.

Please don’t include advertisements or plugs for any company, product or service. Even if the product would meet the standards for the FSF to endorse it, an ad for it is out of place in a presentation about a GNU package. Likewise, please don’t include company slogans. Mention a company only when called for by the subject matter.

A few GNU packages are actually business activities of a particular company. In that case, it is ok to say so at the start. Otherwise, please show that this is a project of the GNU Project, and avoid suggesting it is any company’s project.

If you are paid by a company to work on the GNU package, it is appropriate to thank the company in a discreet way, but please don’t go beyond that.

Before you do a speech or interview, please contact the GNU Project leadership. We can give you advice on how to deal with various eventualities.

When your interviews and speech recordings or transcript are posted, please tell us about them. Then we can publicize them.

Please post them in formats that are friendly to free software: not in Doc or Docx format, not with Flash, not with QuickTime, not with MP3, MPEG2 or MPEG4. Plain text, HTML and PDF are good.


Next: , Previous: , Up: Top   [Contents][Index]

16 Hosting

We recommend using savannah.gnu.org for the source code repository for your package, but that’s not required. See Old Versions, for more information about Savannah.

We strongly urge you to use ftp.gnu.org as the standard distribution site for releases. Doing so makes it easier for developers and users to find the latest GNU releases. However, it is ok to use another server if you wish, provided it allows access from the general public without limitation (for instance, without excluding any country).

If you use a company’s machine to hold the repository for your program, or as its release distribution site, please put this statement in a prominent place on the site, so as to prevent people from getting the wrong idea about the relationship between the package and the company:

The programs <list of them> hosted here are free software packages
of the GNU Project, not products of <company name>.  We call them
"free software" because you are free to copy and redistribute them,
following the rules stated in the license of each package.  For more
information, see http://www.gnu.org/philosophy/free-sw.html.

If you are looking for service or support for GNU software, see
http://www.gnu.org/gethelp/ for suggestions of where to ask.

If you would like to contribute to the development of one of these
packages, contact the package maintainer or the bug-reporting address
of the package (which should be listed in the package itself), or look
on www.gnu.org for more information on how to contribute.

Next: , Previous: , Up: Top   [Contents][Index]

17 Donations

As a maintainer, you might want to accept donations for your work, especially if you pay for any of your own hosting/development infrastructure. Following is some text you can adapt to your own situation, and use on your package’s web site, README, or in wherever way you find it useful:

We appreciate contributions of any size -- donations enable us to spend
more time working on the project, and help cover our infrastructure
expenses.

If you'd like to make a small donation, please visit url1 and do
it through payment-service.  Since our project isn't a
tax-exempt organization, we can't offer you a tax deduction, but for
all donations over amount1, we'd be happy to recognize your
contribution on url2.

We are also happy to consider making particular improvements or
changes, or giving specific technical assistance, in return for a
substantial donation over amount2.  If you would like to discuss
this possibility, write to us at address.

Another possibility is to pay a software maintenance fee.  Again,
write to us about this at address to discuss how much you want
to pay and how much maintenance we can offer in return.  If you pay
more than amount1, we can give you a document for your records.

Thanks for your support!

We don’t recommend any specific payment service. However, GNU developers should not use a service that requires them to sign a proprietary software license, such as Google’s payment service. Please also avoid sites that requires users to run nonfree software in order to donate. (This includes JavaScript software, so try it with LibreJS or with JavaScript disabled.)

In the text you post on the site, please pay attention to the terminological issues we care about (see Terminology).

We have no objections to using Bitcoin to receive donations.

The FSF can collect donations for a limited number of projects; if you want to propose that for your project, write to maintainers@gnu.org. The FSF is required to supervise the spending of these funds.

Of course, it is also good to encourage people to join the FSF (http://www.fsf.org) or make a general donation, either instead of or as well as package-specific donations.


Next: , Previous: , Up: Top   [Contents][Index]

18 Free Software Directory

The Free Software Directory aims to be a complete list of free software packages, within certain criteria. Every GNU package should be listed there, so please see http://www.gnu.org/help/directory.html#adding-entries for information on how to write an entry for your package. Contact bug-directory@gnu.org with any questions or suggestions for the Free Software Directory.


Next: , Previous: , Up: Top   [Contents][Index]

19 Using the Proofreaders List

If you want help finding errors in documentation, or help improving the quality of writing, or if you are not a native speaker of English and want help producing good English documentation, you can use the GNU proofreaders mailing list: proofreaders@gnu.org.

But be careful when you use the list, because there are over 200 people on it. If you simply ask everyone on the list to read your work, there will probably be tremendous duplication of effort by the proofreaders, and you will probably get the same errors reported 100 times. This must be avoided.

Also, the people on the list do not want to get a large amount of mail from it. So do not ever ask people on the list to send mail to the list!

Here are a few methods that seem reasonable to use:


Next: , Previous: , Up: Top   [Contents][Index]

Appendix A GNU Free Documentation License

Version 1.3, 3 November 2008
Copyright © 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.
  1. 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.

  2. 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.

  3. 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.

  4. 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.

  5. 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:

    1. 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.
    2. 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.
    3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
    4. Preserve all the copyright notices of the Document.
    5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
    6. 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.
    7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
    8. Include an unaltered copy of this License.
    9. 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.
    10. 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.
    11. 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.
    12. 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.
    13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
    14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
    15. 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.

  6. 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.”

  7. 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.

  8. 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.

  9. 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.

  10. 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.

  11. 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.

  12. 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.


Previous: , Up: Top   [Contents][Index]

Index

Jump to:   $   /  
A   B   C   D   E   F   G   H   I   L   M   O   P   Q   R   S   T   U   V   W  
Index Entry  Section

$
$ keywords in web pages: CVS Keywords in Web Pages

/
/gd/gnuorg directory: Copyright Papers

A
advisory committee: Getting Help
alpha.gnu.org, test release site: Test Releases
announcement mailing list, project-specific: Announcements
announcements: Announcements
announcements, mailing list for: Standard Mailing Lists
assignments, copyright: Copyright Papers
AUTHORS file: Recording Contributors
automake: Distribution tar Files

B
beta releases: Test Releases
bug reports, email tracker for: Replying to Mail
bug reports, handling: Replying to Mail
bug reports, web tracker for: Replying to Mail
bug-gnu-utils@gnu.org: Standard Mailing Lists
bug-standards@gnu.org email address: Preface

C
contents of announcements: Announcements
contributions, accepting: Clean Ups
copyright notices in program files: Copyright Notices
copyright papers: Copyright Papers
creating mailing lists: Creating Mailing Lists
crediting authors: Crediting Authors
CVS keywords in web pages: CVS Keywords in Web Pages
CVS repository: Hosting

D
data base of GNU copyright assignments: Copyright Papers
development method, open source: Free Software and Open Source
development resources: GNU Accounts and Resources
diff: Distribution Patches
directive file, for FTP uploads: FTP Upload Directive File
directives for ftp uploads, standalone: FTP Upload Standalone Directives
directory trees, in ftp uploads: FTP Upload Directory Trees
Directory, Free Software: Free Software Directory
disclaimers: Copyright Papers
distribution, tar files: Distribution tar Files
documentation output, generating: Invoking gendocs.sh
Donations, for packages: Donations
down, when GNU machines are: Getting Help

E
email: Mail
ethics: Ethical and Philosophical Consideration

F
FDL, GNU Free Documentation License: GNU Free Documentation License
fencepost.gnu.org GNU login host: GNU Accounts and Resources
formats for documentation, desired: Manuals on Web Pages
Free Software Directory: Free Software Directory
free software movement: Free Software and Open Source
FSF system administrators: Getting Help
FTP site: Hosting
ftp uploads, automated: Automated FTP Uploads
FTP uploads, of release files: FTP Upload Release File Triplet
ftp.gnu.org, the GNU release site: Distribution on ftp.gnu.org

G
gendocs.sh: Invoking gendocs.sh
generating documentation output: Invoking gendocs.sh
GNU ftp site: Distribution on ftp.gnu.org
GNU system administrators: Getting Help
GNU/Linux: GNU and Linux
gnustandards project repository: Preface
gnustandards-commit@gnu.org mailing list: Preface

H
help for users, mailing list for: Standard Mailing Lists
help requests, handling: Replying to Mail
help, getting: Getting Help
hierarchy, under ftp upload directory: FTP Upload Directory Trees
hosting: Hosting
http://bugs.gnu.org: Replying to Mail
http://planet.gnu.org: Announcements
https://pumprock.net/fsfstatus: Getting Help
Hydra: GNU Accounts and Resources

I
info-gnu mailing list: Announcements

L
legal matters: Legal Matters
legal papers for changes in manuals: Copyright Papers
license notices in program files: License Notices
Linux: GNU and Linux

M
mailing list for bug reports: Standard Mailing Lists
mailing lists, creating: Creating Mailing Lists
mailing lists, standard names of: Standard Mailing Lists
maintainers@gnu.org: Stepping Down
mentors@gnu.org mailing list: Getting Help
Money, donated to packages: Donations
movement, free software: Free Software and Open Source

O
open source: Free Software and Open Source
outage, of GNU machines: Getting Help

P
patch: Distribution Patches
patches, against previous releases: Distribution Patches
philosophy: Ethical and Philosophical Consideration
Piercy, Marge: Preface
platform-testers mailing list: GNU Accounts and Resources
pretest releases: Test Releases
proofreading: Using the Proofreaders List

Q
quality of changes suggested by others: Clean Ups

R
RCS keywords in web pages: CVS Keywords in Web Pages
recording contributors: Recording Contributors
registration for uploads: Automated Upload Registration
release site: Hosting
replacing uploaded files: FTP Upload File Replacement
repository: Hosting
resigning as maintainer: Stepping Down
resources for GNU developers: GNU Accounts and Resources
responding to bug reports: Replying to Mail

S
Savannah repository for gnustandards: Preface
Savannah, news area: Announcements
savannah-announce@gnu.org mailing list: Old Versions
savannah-hackers@gnu.org: Old Versions
shell account, on fencepost: GNU Accounts and Resources
source repository: Hosting
spam prevention: Creating Mailing Lists
standalone directives, for ftp uploads: FTP Upload Standalone Directives
standard mailing lists: Standard Mailing Lists
stepping down as maintainer: Stepping Down
sysadmin, FSF: Getting Help

T
terminology: Terminology
test releases: Test Releases
time stamp in diffs: Distribution Patches

U
uploads: Automated Upload Procedure
uploads, directory trees in: FTP Upload Directory Trees
uploads, registration for: Automated Upload Registration
uploads, replacing: FTP Upload File Replacement

V
version control: Old Versions
version control system: Hosting

W
web pages: Web Pages
web pages, and CVS keywords: CVS Keywords in Web Pages
web pages, freedom for: Freedom for Web Pages
web pages, hosting for: Hosting for Web Pages
web pages, including manuals on: Manuals on Web Pages

Jump to:   $   /  
A   B   C   D   E   F   G   H   I   L   M   O   P   Q   R   S   T   U   V   W