1 \input texinfo.tex @c -*-texinfo-*-
3 @setfilename maintain.info
4 @settitle Information for Maintainers of GNU Software
5 @c For double-sided printing, uncomment:
6 @c @setchapternewpage odd
7 @c This date is automagically updated when you save this file:
8 @set lastupdate January 27, 2010
11 @dircategory GNU organization
13 * Maintaining: (maintain). Maintaining GNU software.
16 @setchapternewpage off
18 @c Put everything in one index (arbitrarily chosen to be the concept index).
23 Information for maintainers of GNU software, last updated @value{lastupdate}.
25 Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
26 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software
30 Permission is granted to copy, distribute and/or modify this document
31 under the terms of the GNU Free Documentation License, Version 1.3 or
32 any later version published by the Free Software Foundation; with no
33 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
34 Texts. A copy of the license is included in the section entitled
35 ``GNU Free Documentation License''.
40 @title Information for Maintainers of GNU Software
41 @author Richard Stallman
42 @author last updated @value{lastupdate}
44 @vskip 0pt plus 1filll
60 * Recruiting Developers::
68 * Ethical and Philosophical Consideration::
71 * Free Software Directory::
72 * Using the Proofreaders List::
73 * GNU Free Documentation License::
79 @chapter About This Document
81 This file contains guidelines and advice for someone who is the
82 maintainer of a GNU program on behalf of the GNU Project. Everyone is
83 entitled to change and redistribute GNU software; you need not pay
84 attention to this file to get permission. But if you want to maintain a
85 version for widespread distribution, we suggest you follow these
86 guidelines. If you would like to be a GNU maintainer, then it is
87 essential to follow these guidelines.
89 In addition to this document, please read and follow the GNU Coding
90 Standards (@pxref{Top, , Contents, standards, GNU Coding Standards}).
92 @cindex @code{gnustandards-commit@@gnu.org} mailing list
93 If you want to receive diffs for every change to these GNU documents,
94 join the mailing list @code{gnustandards-commit@@gnu.org}, via the web
96 @url{http://lists.gnu.org/mailman/listinfo/gnustandards-commit}.
97 Archives are also available there.
99 @cindex @code{maintainers@@gnu.org} email address
100 Please send corrections or suggestions for this document to
101 @email{bug-standards@@gnu.org}. If you make a suggestion, please
102 include a suggested new wording for it, to help us consider the
103 suggestion efficiently. We prefer a context diff to the
104 @file{maintain.texi} file, but if you don't have that file, you can
105 make a context diff for some other version of this document, or
106 propose it in any way that makes it clear.
108 @cindex @code{mentors@@gnu.org} mailing list
109 If you have general questions or encounter a situation where it isn't
110 clear what to do, you can ask @email{mentors@@gnu.org}, which is a
111 list of a few experienced GNU contributors who have offered to answer
112 questions for new maintainers.
114 The directory @file{/gd/gnuorg} mentioned throughout this document is
115 found on the GNU file server, currently @code{fencepost.gnu.org}; if
116 you are the maintainer of a GNU package, you should have an account
117 there. See @url{http://www.gnu.org/software/README.accounts.html} if
118 you don't have one. (You can also ask for accounts for people who
119 help you a large amount in working on the package.)
121 If on occasion you find that any GNU computer systems
122 (@code{fencepost.gnu.org}, @code{ftp.gnu.org},
123 @code{savannah.gnu.org}, or others) seem to be down, you can check the
124 current status at @url{http://identi.ca/group/fsfstatus}. Most likely
125 the problem, if it is at the FSF end, is already being worked on.
127 @cindex Piercy, Marge
128 This document uses the gender-neutral third-person pronouns ``person'',
129 ``per'', ``pers'' and ``perself'' which were promoted, and perhaps
130 invented, by Marge Piercy in @cite{Woman on the Edge of Time}. They are
131 used just like ``she'', ``her'', ``hers'' and ``herself'', except that
132 they apply equally to males and females. For example, ``Person placed
133 per new program under the GNU GPL, to let the public benefit from per
134 work, and to enable per to feel person has done the right thing.''
136 This release of the GNU Maintenance Instructions was last updated
141 @chapter Stepping Down
143 With good fortune, you will continue maintaining your package for many
144 decades. But sometimes for various reasons maintainers decide to step
147 If you're the official maintainer of a GNU package and you decide to
148 step down, please inform the GNU Project (@email{maintainers@@gnu.org}).
149 We need to know that the package no longer has a maintainer, so we can
150 look for and appoint a new maintainer.
152 If you have an idea for who should take over, please tell
153 @email{maintainers@@gnu.org} your suggestion. The appointment of a new
154 maintainer needs the GNU Project's confirmation, but your judgment that
155 a person is capable of doing the job will carry a lot of weight.
157 As your final act as maintainer, it would be helpful to set up the
158 package under @code{savannah.gnu.org} if it is not there already
159 (@pxref{Old Versions}). This will make it much easier for the new
160 maintainer to pick up where you left off and will ensure that the
161 source tree is not misplaced if it takes us a while to find a new
165 @node Recruiting Developers
166 @chapter Recruiting Developers
168 Unless your package is a fairly small, you probably won't do all the
169 work on it yourself. Most maintainers recruit other developers to help.
171 Sometimes people will offer to help. Some of them will be capable,
172 while others will not. It's up to you to determine who provides useful
173 help, and encourage those people to participate more.
175 Some of the people who offer to help will support the GNU Project, while
176 others may be interested for other reasons. Some will support the goals
177 of the Free Software Movement, but some may not. They are all welcome
178 to help with the work---we don't ask people's views or motivations
179 before they contribute to GNU packages.
181 As a consequence, you cannot expect all contributors to support the GNU
182 Project, or to have a concern for its policies and standards. So part
183 of your job as maintainer is to exercise your authority on these points
184 when they arise. No matter how much of the work other people do, you
185 are in charge of what goes in the release. When a crucial point arises,
186 you should calmly state your decision and stick to it.
188 Sometimes a package has several co-maintainers who share the role of
189 maintainer. Unlike developers who help, co-maintainers have actually
190 been appointed jointly as the maintainers of the package, and they carry
191 out the maintainer's functions together. If you would like to propose
192 some of your developers as co-maintainers, please contact
193 @email{maintainers@@gnu.org}.
195 We're happy to acknowledge all major contributors to GNU packages on
196 the @url{http://www.gnu.org/people/people.html} web page. Please send
197 an entry for yourself to @email{webmasters@@gnu.org}, and feel free to
198 suggest it to other significant developers on your package.
202 @chapter Legal Matters
203 @cindex legal matters
205 This chapter describes procedures you should follow for legal reasons
206 as you maintain the program, to avoid legal difficulties.
210 * Legally Significant::
211 * Recording Contributors::
212 * Copying from Other Packages::
213 * Copyright Notices::
215 * External Libraries::
218 @node Copyright Papers
219 @section Copyright Papers
220 @cindex copyright papers
222 If you maintain an FSF-copyrighted package
223 certain legal procedures are required when incorporating legally significant
224 changes written by other people. This ensures that the FSF has the
225 legal right to distribute the package, and the standing to defend its
226 GPL-covered status in court if necessary.
228 @strong{Before} incorporating significant changes, make sure that the
229 person who wrote the changes has signed copyright papers and that the
230 Free Software Foundation has received and signed them. We may also need
231 an employer's disclaimer from the person's employer.
233 @cindex data base of GNU copyright assignments
234 To check whether papers have been received, look in
235 @file{/gd/gnuorg/copyright.list}. If you can't look there directly,
236 @email{fsf-records@@gnu.org} can check for you. Our clerk can also
237 check for papers that are waiting to be entered and inform you when
238 expected papers arrive.
240 @cindex @file{/gd/gnuorg} directory
241 @c This paragraph intentionally duplicates information given
242 @c near the beginning of the file--to make sure people don't miss it.
243 The directory @file{/gd/gnuorg} is found on the GNU machines,
244 currently @code{fencepost.gnu.org}; if you are the maintainer of a GNU
245 package, you should have an account on them. Contact
246 @email{accounts@@gnu.org} if you don't have one. (You can also ask
247 for accounts for people who help you a large amount in working on the
250 In order for the contributor to know person should sign papers, you need
251 to ask per for the necessary papers. If you don't know per well, and you
252 don't know that person is used to our ways of handling copyright papers,
253 then it might be a good idea to raise the subject with a message like
257 Would you be willing to assign the copyright to the Free Software
258 Foundation, so that we could install it in @var{program}?
265 Would you be willing to sign a copyright disclaimer to put this change
266 in the public domain, so that we can install it in @var{program}?
269 If the contributor wants more information, you can send per
270 @file{/gd/gnuorg/conditions.text}, which explains per options (assign
271 vs.@: disclaim) and their consequences.
273 Once the conversation is under way and the contributor is ready for
274 more details, you should send one of the templates that are found in
275 the directory @file{/gd/gnuorg/Copyright/}; they are also available
276 from the @file{doc/Copyright/} directory of the @code{gnulib} project
277 at @url{http://savannah.gnu.org/projects/gnulib}. This section
278 explains which templates you should use in which circumstances.
279 @strong{Please don't use any of the templates except for those listed
280 here, and please don't change the wording.}
282 Once the conversation is under way, you can send the contributor the
283 precise wording and instructions by email. Before you do this, make
284 sure to get the current version of the template you will use! We change
285 these templates occasionally---don't keep using an old version.
287 For large changes, ask the contributor for an assignment. Send per a
288 copy of the file @file{request-assign.changes}. (Like all the
289 @samp{request-} files, it is in @file{/gd/gnuorg/Copyright} and in
292 For medium to small changes, request a personal disclaimer by sending
293 per the file @file{request-disclaim.changes}.
295 If the contributor is likely to keep making changes, person might want
296 to sign an assignment for all per future changes to the program. So it
297 is useful to offer per that alternative. If person wants to do it that
298 way, send per the @file{request-assign.future}.
300 When you send a @file{request-} file, you don't need to fill in anything
301 before sending it. Just send the file verbatim to the contributor. The
302 file gives per instructions for how to ask the FSF to mail per the
303 papers to sign. The @file{request-} file also raises the issue of
304 getting an employer's disclaimer from the contributor's employer.
306 When the contributor emails the form to the FSF, the FSF sends per
307 papers to sign. If person signs them right away, the whole process
308 takes about two weeks--mostly waiting for letters to go back and
311 For less common cases, we have template files you should send to the
312 contributor. Be sure to fill in the name of the person and the name
313 of the program in these templates, where it says @samp{NAME OF PERSON}
314 and @samp{NAME OF PROGRAM}, before sending; otherwise person might
315 sign without noticing them, and the papers would be useless. Note
316 that in some templates there is more than one place to put the name of
317 the program or the name of the person; be sure to change all of them.
318 All the templates raise the issue of an employer's disclaimer as well.
320 @cindex legal papers for changes in manuals
321 You do not need to ask for separate papers for a manual that is
322 distributed only in the software package it describes. But if we
323 sometimes distribute the manual separately (for instance, if we publish
324 it as a book), then we need separate legal papers for changes in the
325 manual. For smaller changes, use
326 @file{disclaim.changes.manual}; for larger ones, use
327 @file{assign.changes.manual}. To cover both past and future
328 changes to a manual, you can use @file{assign.future.manual}.
329 For a translation of a manual, use @file{assign.translation.manual}.
331 For translations of program strings (as used by GNU Gettext, for
332 example; @pxref{Internationalization,,,standards,GNU Coding
333 Standards}), use @file{disclaim.translation}. If you make use of the
334 Translation Project (@url{http://translationproject.org}) facilities,
335 please check with the TP coordinators that they have sent the
336 contributor the papers; if they haven't, then you should send the
337 papers. In any case, you should wait for the confirmation from the
338 FSF that the signed papers have been received and accepted before
339 integrating the new contributor's material, as usual.
341 If a contributor is reluctant to sign an assignment for a large change,
342 and is willing to sign a disclaimer instead, that is acceptable, so you
343 should offer this alternative if it helps you reach agreement. We
344 prefer an assignment for a larger change, so that we can enforce the GNU
345 GPL for the new text, but a disclaimer is enough to let us use the text.
347 If you maintain a collection of programs, occasionally someone will
348 contribute an entire separate program or manual that should be added to
349 the collection. Then you can use the files
350 @file{request-assign.program}, @file{disclaim.program},
351 @file{assign.manual}, and @file{disclaim.manual}. We very much prefer
352 an assignment for a new separate program or manual, unless it is quite
353 small, but a disclaimer is acceptable if the contributor insists on
354 handling the matter that way.
356 If a contributor wants the FSF to publish only a pseudonym, that is
357 ok. The contributor should say this, and state the desired pseudonym,
358 when answering the @file{request-} form. The actual legal papers will
359 use the real name, but the FSF will publish only the pseudonym. When
360 using one of the other forms, fill in the real name but ask the
361 contributor to discuss the use of a pseudonym with
362 @email{assign@@gnu.org} before sending back the signed form.
364 @strong{Although there are other templates besides the ones listed here,
365 they are for special circumstances; please do not use them without
366 getting advice from @email{assign@@gnu.org}.}
368 If you are not sure what to do, then please ask @email{assign@@gnu.org} for
369 advice; if the contributor asks you questions about the meaning and
370 consequences of the legal papers, and you don't know the answers, you
371 can forward them to @email{assign@@gnu.org} and we will answer.
373 @strong{Please do not try changing the wording of a template yourself.
374 If you think a change is needed, please talk with @email{assign@@gnu.org},
375 and we will work with a lawyer to decide what to do.}
377 @node Legally Significant
378 @section Legally Significant Changes
380 If a person contributes more than around 15 lines of code and/or text
381 that is legally significant for copyright purposes, we
382 need copyright papers for that contribution, as described above.
384 A change of just a few lines (less than 15 or so) is not legally
385 significant for copyright. A regular series of repeated changes, such
386 as renaming a symbol, is not legally significant even if the symbol
387 has to be renamed in many places. Keep in mind, however, that a
388 series of minor changes by the same person can add up to a significant
389 contribution. What counts is the total contribution of the person; it
390 is irrelevant which parts of it were contributed when.
392 Copyright does not cover ideas. If someone contributes ideas but no
393 text, these ideas may be morally significant as contributions, and
394 worth giving credit for, but they are not significant for copyright
395 purposes. Likewise, bug reports do not count for copyright purposes.
397 When giving credit to people whose contributions are not legally
398 significant for copyright purposes, be careful to make that fact
399 clear. The credit should clearly say they did not contribute
400 significant code or text.
402 When people's contributions are not legally significant because they
403 did not write code, do this by stating clearly what their contribution
404 was. For instance, you could write this:
409 * Richard Mlynarik <mly@@adoc.xerox.com> (1997)
410 * Masatake Yamato <masata-y@@is.aist-nara.ac.jp> (1999)
415 @code{Ideas by:} makes it clear that Mlynarik and Yamato here
416 contributed only ideas, not code. Without the @code{Ideas by:} note,
417 several years from now we would find it hard to be sure whether they
418 had contributed code, and we might have to track them down and ask
421 When you record a small patch in a change log file, first search for
422 previous changes by the same person, and see if per past
423 contributions, plus the new one, add up to something legally
424 significant. If so, you should get copyright papers for all per
425 changes before you install the new change.
427 If that is not so, you can install the small patch. Write @samp{(tiny
428 change)} after the patch author's name, like this:
431 2002-11-04 Robert Fenk <Robert.Fenk@@gmx.de> (tiny change)
434 @node Recording Contributors
435 @section Recording Contributors
436 @cindex recording contributors
438 @strong{Keep correct records of which portions were written by whom.}
439 This is very important. These records should say which files or
440 parts of files were written by each person, and which files or
441 parts of files were revised by each person. This should include
442 installation scripts as well as manuals and documentation
445 These records don't need to be as detailed as a change log. They
446 don't need to distinguish work done at different times, only different
447 people. They don't need describe changes in more detail than which
448 files or parts of a file were changed. And they don't need to say
449 anything about the function or purpose of a file or change--the
450 Register of Copyrights doesn't care what the text does, just who wrote
451 or contributed to which parts.
453 The list should also mention if certain files distributed in the same
454 package are really a separate program.
456 Only the contributions that are legally significant for copyright
457 purposes (@pxref{Legally Significant}) need to be listed. Small
458 contributions, bug reports, ideas, etc., can be omitted.
460 For example, this would describe an early version of GAS:
463 Dean Elsner first version of all files except gdb-lines.c and m68k.c.
464 Jay Fenlason entire files gdb-lines.c and m68k.c, most of app.c,
465 plus extensive changes in messages.c, input-file.c, write.c
466 and revisions elsewhere.
468 Note: GAS is distributed with the files obstack.c and obstack.h, but
469 they are considered a separate package, not part of GAS proper.
472 @cindex @file{AUTHORS} file
473 Please keep these records in a file named @file{AUTHORS} in the source
474 directory for the program itself.
476 You can use the change log as the basis for these records, if you
477 wish. Just make sure to record the correct author for each change
478 (the person who wrote the change, @emph{not} the person who installed
479 it), and add @samp{(tiny change)} for those changes that are too
480 trivial to matter for copyright purposes. Later on you can update the
481 @file{AUTHORS} file from the change log. This can even be done
482 automatically, if you are careful about the formatting of the change
485 @node Copying from Other Packages
486 @section Copying from Other Packages
488 When you copy legally significant code from another free software
489 package with a GPL-compatible license, you should look in the
490 package's records to find out the authors of the part you are copying,
491 and list them as the contributors of the code that you copied. If all
492 you did was copy it, not write it, then for copyright purposes you are
493 @emph{not} one of the contributors of @emph{this} code.
495 Especially when code has been released into the public domain, authors
496 sometimes fail to write a license statement in each file. In this
497 case, please first be sure that all the authors of the code have
498 disclaimed copyright interest. Then, when copying the new files into
499 your project, add a brief note at the beginning of the files recording
500 the authors, the public domain status, and anything else relevant.
502 On the other hand, when merging some public domain code into an
503 existing file covered by the GPL (or LGPL or other free software
504 license), there is no reason to indicate the pieces which are public
505 domain. The notice saying that the whole file is under the GPL (or
506 other license) is legally sufficient.
508 Using code that is released under a GPL-compatible free license,
509 rather than being in the public domain, may require preserving
510 copyright notices or other steps. Of course, you should do what is
513 If you are maintaining an FSF-copyrighted package, please verify we
514 have papers for the code you are copying, @emph{before} copying it.
515 If you are copying from another FSF-copyrighted package, then we
516 presumably have papers for that package's own code, but you must check
517 whether the code you are copying is part of an external library; if
518 that is the case, we don't have papers for it, so you should not copy
519 it. It can't hurt in any case to double-check with the developer of
522 When you are copying code for which we do not already have papers, you
523 need to get papers for it. It may be difficult to get the papers if
524 the code was not written as a contribution to your package, but that
525 doesn't mean it is ok to do without them. If you cannot get papers
526 for the code, you can only use it as an external library
527 (@pxref{External Libraries}).
530 @node Copyright Notices
531 @section Copyright Notices
532 @cindex copyright notices in program files
534 You should maintain a proper copyright notice and a license
535 notice in each nontrivial file in the package. (Any file more than ten
536 lines long is nontrivial for this purpose.) This includes header files
537 and interface definitions for
538 building or running the program, documentation files, and any supporting
539 files. If a file has been explicitly placed in the public domain, then
540 instead of a copyright notice, it should have a notice saying explicitly
541 that it is in the public domain.
543 Even image files and sound files should contain copyright notices and
544 license notices, if their format permits. Some formats do not have
545 room for textual annotations; for these files, state the copyright and
546 copying permissions in a @file{README} file in the same directory.
548 Change log files should have a copyright notice and license notice at
549 the end, since new material is added at the beginning but the end
552 When a file is automatically generated from some other file in the
553 distribution, it is useful for the automatic procedure to copy the
554 copyright notice and permission notice of the file it is generated
555 from, if possible. Alternatively, put a notice at the beginning saying
556 which file it is generated from.
558 A copyright notice looks like this:
561 Copyright (C) @var{year1}, @var{year2}, @var{year3} @var{copyright-holder}
564 The word @samp{Copyright} must always be in English, by international
567 The @var{copyright-holder} may be the Free Software Foundation, Inc., or
568 someone else; you should know who is the copyright holder for your
571 Replace the @samp{(C)} with a C-in-a-circle symbol if it is available.
572 For example, use @samp{@@copyright@{@}} in a Texinfo file. However,
573 stick with parenthesized @samp{C} unless you know that C-in-a-circle
574 will work. For example, a program's standard @option{--version}
575 message should use parenthesized @samp{C} by default, though message
576 translations may use C-in-a-circle in locales where that symbol is
577 known to work. Alternatively, the @samp{(C)} or C-in-a-circle can be
578 omitted entirely; the word @samp{Copyright} suffices.
580 To update the list of year numbers, add each year in which you have
581 made nontrivial changes to the package. (Here we assume you're using
582 a publicly accessible revision control server, so that every revision
583 installed is also immediately and automatically published.) When you
584 add the new year, it is not required to keep track of which files have
585 seen significant changes in the new year and which have not. It is
586 recommended and simpler to add the new year to all files in the
587 package, and be done with it for the rest of the year.
589 Don't delete old year numbers, though; they are significant since they
590 indicate when older versions might theoretically go into the public
591 domain, if the movie companies don't continue buying laws to further
592 extend copyright. If you copy a file into the package from some other
593 program, keep the copyright years that come with the file.
595 Do not abbreviate the year list using a range; for instance, do not
596 write @samp{1996--1998}; instead, write @samp{1996, 1997, 1998}.
598 For files which are regularly copied from another project (such as
599 @samp{gnulib}), leave the copyright notice as it is in the original.
601 The copyright statement may be split across multiple lines, both in
602 source files and in any generated output. This often happens for
603 files with a long history, having many different years of
606 For an FSF-copyrighted package, if you have followed the procedures to
607 obtain legal papers, each file should have just one copyright holder:
608 the Free Software Foundation, Inc. You should edit the file's
609 copyright notice to list that name and only that name.
611 But if contributors are not all assigning their copyrights to a single
612 copyright holder, it can easily happen that one file has several
613 copyright holders. Each contributor of nontrivial text is a copyright
616 In that case, you should always include a copyright notice in the name
617 of main copyright holder of the file. You can also include copyright
618 notices for other copyright holders as well, and this is a good idea
619 for those who have contributed a large amount and for those who
620 specifically ask for notices in their names. (Sometimes the license
621 on code that you copy in may require preserving certain copyright
622 notices.) But you don't have to include a notice for everyone who
623 contributed to the file (which would be rather inconvenient).
625 Sometimes a program has an overall copyright notice that refers to the
626 whole program. It might be in the @file{README} file, or it might be
627 displayed when the program starts up. This copyright notice should
628 mention the year of completion of the most recent major version; it
629 can mention years of completion of previous major versions, but that
633 @node License Notices
634 @section License Notices
635 @cindex license notices in program files
637 Every nontrivial file needs a license notice as well as the copyright
638 notice. (Without a license notice giving permission to copy and
639 change the file, the file is non-free.)
641 The package itself should contain a full copy of GPL in plain text
642 (conventionally in a file named @file{COPYING}) and the GNU Free
643 Documentation License (included within your documentation, so there is
644 no need for a separate plain text version). If the package contains
645 any files distributed under the Lesser GPL, it should contain a full
646 copy of its plain text version also (conventionally in a file named
647 @file{COPYING.LESSER}).
649 If you have questions about license issues for your GNU package,
650 please write @email{licensing@@gnu.org}.
653 * Source: Canonical License Sources.
654 * Code: License Notices for Code.
655 * Documentation: License Notices for Documentation.
656 * Other: License Notices for Other Files.
660 @node Canonical License Sources
661 @subsection Canonical License Sources
663 You can get the official versions of these files from several places.
664 You can use whichever is the most convenient for you.
668 @uref{http://www.gnu.org/licenses/}.
671 The @code{gnulib} project on @code{savannah.gnu.org}, which you
672 can access via anonymous Git or CVS. See
673 @uref{http://savannah.gnu.org/projects/gnulib}.
677 The official Texinfo sources for the licenses are also available in
678 those same places, so you can include them in your documentation. A
679 GFDL-covered manual should include the GFDL in this way. @xref{GNU
680 Sample Texts,,,texinfo,Texinfo}, for a full example in a Texinfo
684 @node License Notices for Code
685 @subsection License Notices for Code
687 Typically the license notice for program files (including build scripts,
688 configure files and makefiles) should cite the GPL, like this:
691 This file is part of GNU @var{program}.
693 GNU @var{program} is free software: you can redistribute it and/or
694 modify it under the terms of the GNU General Public License as
695 published by the Free Software Foundation, either version 3 of the
696 License, or (at your option) any later version.
698 GNU @var{program} is distributed in the hope that it will be useful,
699 but WITHOUT ANY WARRANTY; without even the implied warranty of
700 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
701 GNU General Public License for more details.
703 You should have received a copy of the GNU General Public License
704 along with this program. If not, see @url{http://www.gnu.org/licenses/}.
707 But in a small program which is just a few files, you can use
711 This program is free software: you can redistribute it and/or modify
712 it under the terms of the GNU General Public License as published by
713 the Free Software Foundation; either version 3 of the License, or
714 (at your option) any later version.
716 This program is distributed in the hope that it will be useful,
717 but WITHOUT ANY WARRANTY; without even the implied warranty of
718 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
719 GNU General Public License for more details.
721 You should have received a copy of the GNU General Public License
722 along with this program. If not, see @url{http://www.gnu.org/licenses/}.
726 @node License Notices for Documentation
727 @subsection License Notices for Documentation
729 Documentation files should have license notices also. Manuals should
730 use the GNU Free Documentation License. Following is an example of the
731 license notice to use after the copyright line(s) using all the
732 features of the GFDL.
735 Permission is granted to copy, distribute and/or modify this document
736 under the terms of the GNU Free Documentation License, Version 1.3 or
737 any later version published by the Free Software Foundation; with the
738 Invariant Sections being ``GNU General Public License'', with the
739 Front-Cover Texts being ``A GNU Manual'', and with the Back-Cover Texts
740 as in (a) below. A copy of the license is included in the section
741 entitled ``GNU Free Documentation License''.
743 (a) The FSF's Back-Cover Text is: ``You have the freedom to
744 copy and modify this GNU manual. Buying copies from the FSF
745 supports it in developing GNU and promoting software freedom.''
748 If the FSF does not publish this manual on paper, then omit the last
749 sentence in (a) that talks about copies from GNU Press. If the FSF is
750 not the copyright holder, then replace @samp{FSF} with the appropriate
753 Please adjust the list of invariant sections as appropriate for your
754 manual. If there are none, then say ``with no Invariant Sections''.
755 If your manual is not published by the FSF, and under 400 pages, you
756 can omit both cover texts.
758 @xref{GNU Sample Texts,,,texinfo,Texinfo}, for a full example in a
759 Texinfo manual, and see
760 @url{http://www.gnu.org/licenses/fdl-howto.html} for more advice about
761 how to use the GNU FDL.
763 If the manual is over 400 pages, or if the FSF thinks it might be a
764 good choice for publishing on paper, then please include the GNU GPL,
765 as in the notice above. Please also include our standard invariant
766 section which explains the importance of free documentation. Write to
767 @email{assign@@gnu.org} to get a copy of this section.
769 When you distribute several manuals together in one software package,
770 their on-line forms can share a single copy of the GFDL (see
771 section@tie{}6). However, the printed (@samp{.dvi}, @samp{.pdf},
772 @dots{}) forms should each contain a copy of the GFDL, unless they are
773 set up to be printed and published only together. Therefore, it is
774 usually simplest to include the GFDL in each manual.
777 @node License Notices for Other Files
778 @subsection License Notices for Other Files
780 Small supporting files, short manuals (under 300 lines long) and rough
781 documentation (@file{README} files, @file{INSTALL} files, etc.)@: can
782 use a simple all-permissive license like this one:
785 Copying and distribution of this file, with or without modification,
786 are permitted in any medium without royalty provided the copyright
787 notice and this notice are preserved. This file is offered as-is,
788 without any warranty.
791 Older versions of this license did not have the second sentence with
792 the express warranty disclaimer. There is no urgent need to update
793 existing files, but new files should use the new text.
795 If your package distributes Autoconf macros that are intended to be
796 used (hence distributed) by third-party packages under possibly
797 incompatible licenses, you may also use the above all-permissive
798 license for these macros.
801 @node External Libraries
802 @section External Libraries
804 When maintaining an FSF-copyrighted GNU package, you may occasionally
805 want to use a general-purpose free software module which offers a
806 useful functionality, as a ``library'' facility (though the module is
807 not always packaged technically as a library).
809 In a case like this, it would be unreasonable to ask the author of that
810 module to assign the copyright to the FSF. After all, person did not
811 write it specifically as a contribution to your package, so it would be
812 impertinent to ask per, out of the blue, ``Please give the FSF your
815 So the thing to do in this case is to make your program use the module,
816 but not consider it a part of your program. There are two reasonable
817 methods of doing this:
821 Assume the module is already installed on the system, and use it when
822 linking your program. This is only reasonable if the module really has
823 the form of a library.
826 Include the module in your package, putting the source in a separate
827 subdirectory whose @file{README} file says, ``This is not part of the
828 GNU FOO program, but is used with GNU FOO.'' Then set up your makefiles
829 to build this module and link it into the executable.
831 For this method, it is not necessary to treat the module as a library
832 and make a @samp{.a} file from it. You can link with the @samp{.o}
833 files directly in the usual manner.
836 Both of these methods create an irregularity, and our lawyers have told
837 us to minimize the amount of such irregularity. So consider using these
838 methods only for general-purpose modules that were written for other
839 programs and released separately for general use. For anything that was
840 written as a contribution to your package, please get papers signed.
844 @chapter Cleaning Up Changes
845 @cindex contributions, accepting
846 @cindex quality of changes suggested by others
848 Don't feel obligated to include every change that someone asks you to
849 include. You must judge which changes are improvements---partly based
850 on what you think the users will like, and partly based on your own
851 judgment of what is better. If you think a change is not good, you
854 If someone sends you changes which are useful, but written in an ugly
855 way or hard to understand and maintain in the future, don't hesitate to
856 ask per to clean up their changes before you merge them. Since the
857 amount of work we can do is limited, the more we convince others to help
858 us work efficiently, the faster GNU will advance.
860 If the contributor will not or can not make the changes clean enough,
861 then it is legitimate to say ``I can't install this in its present form;
862 I can only do so if you clean it up.'' Invite per to distribute per
863 changes another way, or to find other people to make them clean enough
864 for you to install and maintain.
866 The only reason to do these cleanups yourself is if (1) it is easy, less
867 work than telling the author what to clean up, or (2) the change is an
868 important one, important enough to be worth the work of cleaning it up.
870 The GNU Coding Standards are a good thing to send people when you ask
871 them to clean up changes (@pxref{Top, , Contents, standards, GNU Coding
872 Standards}). The Emacs Lisp manual contains an appendix that gives
873 coding standards for Emacs Lisp programs; it is good to urge Lisp authors to
874 read it (@pxref{Tips, , Tips and Conventions, elisp, The GNU Emacs Lisp
879 @chapter Platforms to Support
881 Most GNU packages run on a wide range of platforms. These platforms are
882 not equally important.
884 The most important platforms for a GNU package to support are GNU and
885 GNU/Linux. Developing the GNU operating system is the whole point of
886 the GNU Project; a GNU package exists to make the whole GNU system more
887 powerful. So please keep that goal in mind and let it shape your work.
888 For instance, every new feature you add should work on GNU, and
889 GNU/Linux if possible too. If a new feature only runs on GNU and
890 GNU/Linux, it could still be acceptable. However, a feature that runs
891 only on other systems and not on GNU or GNU/Linux makes no sense in a
894 You will naturally want to keep the program running on all the platforms
895 it supports. But you personally will not have access to most of these
896 platforms--so how should you do it?
898 Don't worry about trying to get access to all of these platforms. Even
899 if you did have access to all the platforms, it would be inefficient for
900 you to test the program on each platform yourself. Instead, you should
901 test the program on a few platforms, including GNU or GNU/Linux, and let
902 the users test it on the other platforms. You can do this through a
903 pretest phase before the real release; when there is no reason to expect
904 problems, in a package that is mostly portable, you can just make a
905 release and let the users tell you if anything unportable was
908 It is important to test the program personally on GNU or GNU/Linux,
909 because these are the most important platforms for a GNU package. If
910 you don't have access to one of these platforms, please ask
911 @email{maintainers@@gnu.org} to help you out.
913 Supporting other platforms is optional---we do it when that seems like
914 a good idea, but we don't consider it obligatory. If the users don't
915 take care of a certain platform, you may have to desupport it unless
916 and until users come forward to help. Conversely, if a user offers
917 changes to support an additional platform, you will probably want to
918 install them, but you don't have to. If you feel the changes are
919 complex and ugly, if you think that they will increase the burden of
920 future maintenance, you can and should reject them. This includes
921 both free or mainly-free platforms such as OpenBSD, FreeBSD, and
922 NetBSD, and non-free platforms such as Windows.
926 @chapter Dealing With Mail
929 @cindex email, for receiving bug reports
930 @cindex mailing list for bug reports
931 Once a program is in use, you will get bug reports for it. Most GNU
932 programs have their own special lists for sending bug reports. The
933 advertised bug-reporting email address should always be
934 @samp{bug-@var{program}@@gnu.org}, to help show users that the program
935 is a GNU package, but it is ok to set up that list to forward to another
936 site for further forwarding. The package distribution should state the
937 name of the bug-reporting list in a prominent place, and ask users to
938 help us by reporting bugs there.
940 We also have a catch-all list, @email{bug-gnu-utils@@gnu.org}, which is
941 used for all GNU programs that don't have their own specific lists. But
942 nowadays we want to give each program its own bug-reporting list and
943 move away from using @email{bug-gnu-utils}.
945 If you wish, you can also have mailing lists such as
946 @samp{info-@var{program}} for announcements (@pxref{Announcements}),
947 @samp{help-@var{program}} for general help and discussion (see below),
948 or any others you find useful.
950 By far the easiest way to create mailing lists is through
951 @code{savannah.gnu.org}. Once you register your program, you can do
952 this yourself through the `Mailing Lists' menu, without needing
953 intervention by anyone else. Furthermore, lists created through
954 Savannah will have a reasonable default configuration for antispam
955 purposes (see below).
957 If you are the maintainer of a GNU package, you should have an account
958 on the GNU servers; contact
959 @url{http://www.gnu.org/software/README.accounts.html} if you don't
960 have one. (You can also ask for accounts for people who help you a
961 large amount in working on the package.) With this account, you can
962 edit @file{/com/mailer/aliases} to create a new unmanaged list or add
963 yourself to an existing unmanaged list. A comment near the beginning
964 of that file explains how to create a Mailman-managed mailing list.
966 But if you don't want to learn how to do those things, you can
967 alternatively ask @email{alias-file@@gnu.org} to add you to the
968 bug-reporting list for your program. To set up a new list, contact
969 @email{new-mailing-list@@gnu.org}. You can subscribe to a list managed
970 by Mailman by sending mail to the corresponding @samp{-request} address.
972 You should moderate postings from non-subscribed addresses on your
973 mailing lists, to prevent propagation of unwanted messages (``spam'')
974 to subscribers and to the list archives. For lists controlled by
975 Mailman, you can do this by setting @code{Privacy Options - Sender
976 Filter - generic_nonmember_action} to @code{Hold}, and then
977 periodically (daily is best) reviewing the held messages, accepting
978 the real ones and discarding the junk.
980 @cindex responding to bug reports
981 When you receive bug reports, keep in mind that bug reports are crucial
982 for your work. If you don't know about problems, you cannot fix them.
983 So always thank each person who sends a bug report.
985 You don't have an obligation to give more response than that, though.
986 The main purpose of bug reports is to help you contribute to the
987 community by improving the next version of the program. Many of the
988 people who report bugs don't realize this---they think that the point is
989 for you to help them individually. Some will ask you to focus on that
990 @emph{instead of} on making the program better. If you comply with
991 their wishes, you will have been distracted from the job of maintaining
994 For example, people sometimes report a bug in a vague (and therefore
995 useless) way, and when you ask for more information, they say, ``I just
996 wanted to see if you already knew the solution'' (in which case the bug
997 report would do nothing to help improve the program). When this
998 happens, you should explain to them the real purpose of bug reports. (A
999 canned explanation will make this more efficient.)
1001 When people ask you to put your time into helping them use the program,
1002 it may seem ``helpful'' to do what they ask. But it is much @emph{less}
1003 helpful than improving the program, which is the maintainer's real job.
1005 By all means help individual users when you feel like it, if you feel
1006 you have the time available. But be careful to limit the amount of time
1007 you spend doing this---don't let it eat away the time you need to
1008 maintain the program! Know how to say no; when you are pressed for
1009 time, just ``thanks for the bug report---I will fix it'' is enough
1012 Some GNU packages, such as Emacs and GCC, come with advice about how to
1013 make bug reports useful. If you want to copy and adapt that, it could
1014 be a very useful thing to do.
1018 @chapter Recording Old Versions
1019 @cindex version control
1021 It is very important to keep backup files of all source files of GNU.
1022 You can do this using a source control system (such as RCS, CVS, Git,
1023 @dots{}) if you like. The easiest way to use RCS or CVS is via the
1024 Version Control library in Emacs (@pxref{VC Concepts,, Concepts of
1025 Version Control, emacs, The GNU Emacs Manual}).
1027 The history of previous revisions and log entries is very important for
1028 future maintainers of the package, so even if you do not make it
1029 publicly accessible, be careful not to put anything in the repository or
1030 change log that you would not want to hand over to another maintainer
1033 @cindex @code{savannah-hackers@@gnu.org}
1034 The GNU Project provides a server that GNU software packages can use
1035 for source control and other package needs: @code{savannah.gnu.org}.
1036 You don't have to use this repository, but if you plan to allow public
1037 read-only access to your development sources, it is convenient for
1038 people to be able to find various GNU packages in a central place.
1039 Savannah is managed by @email{savannah-hackers@@gnu.org}.
1041 All GNU maintainers are strongly encouraged to take advantage of
1042 Savannah, as sharing such a central point can serve to foster a sense
1043 of community among GNU developers and help in keeping up with project
1046 @cindex @code{savannah-announce@@gnu.org} mailing list
1047 If you do use Savannah, it is a good idea to subscribe to the
1048 @email{savannah-announce@@gnu.org} mailing list
1049 (@url{http://lists.gnu.org/mailman/listinfo/savannah-announce}). This
1050 is a very low-volume list to keep Savannah users informed of system
1051 upgrades, problems, and the like.
1055 @chapter Distributions
1057 It is important to follow the GNU conventions when making GNU software
1061 * Distribution tar Files::
1062 * Distribution Patches::
1063 * Distribution on ftp.gnu.org::
1065 * Automated FTP Uploads::
1069 @node Distribution tar Files
1070 @section Distribution tar Files
1071 @cindex distribution, tar files
1073 The tar file for version @var{m}.@var{n} of program @code{foo} should be
1074 named @file{foo-@var{m}.@var{n}.tar}. It should unpack into a
1075 subdirectory named @file{foo-@var{m}.@var{n}}. Tar files should not
1076 unpack into files in the current directory, because this is inconvenient
1077 if the user happens to unpack into a directory with other files in it.
1079 Here is how the @file{Makefile} for Bison creates the tar file.
1080 This method is good for other programs.
1084 echo bison-`sed -e '/version_string/!d' \
1085 -e 's/[^0-9.]*\([0-9.]*\).*/\1/' -e q version.c` > .fname
1086 -rm -rf `cat .fname`
1088 dst=`cat .fname`; for f in $(DISTFILES); do \
1089 ln $(srcdir)/$$f $$dst/$$f || @{ echo copying $$f; \
1090 cp -p $(srcdir)/$$f $$dst/$$f ; @} \
1092 tar --gzip -chf `cat .fname`.tar.gz `cat .fname`
1093 -rm -rf `cat .fname` .fname
1096 Source files that are symbolic links to other file systems cannot be
1097 installed in the temporary directory using @code{ln}, so use @code{cp}
1101 Using Automake is a good way to take care of writing the @code{dist}
1104 @node Distribution Patches
1105 @section Distribution Patches
1106 @cindex patches, against previous releases
1108 If the program is large, it is useful to make a set of diffs for each
1109 release, against the previous important release.
1111 At the front of the set of diffs, put a short explanation of which
1112 version this is for and which previous version it is relative to.
1113 Also explain what else people need to do to update the sources
1114 properly (for example, delete or rename certain files before
1115 installing the diffs).
1117 The purpose of having diffs is that they are small. To keep them
1118 small, exclude files that the user can easily update. For example,
1119 exclude info files, DVI files, tags tables, output files of Bison or
1120 Flex. In Emacs diffs, we exclude compiled Lisp files, leaving it up
1121 to the installer to recompile the patched sources.
1123 When you make the diffs, each version should be in a directory suitably
1124 named---for example, @file{gcc-2.3.2} and @file{gcc-2.3.3}. This way,
1125 it will be very clear from the diffs themselves which version is which.
1129 @cindex time stamp in diffs
1130 If you use GNU @code{diff} to make the patch, use the options
1131 @samp{-rc2P}. That will put any new files into the output as ``entirely
1132 different.'' Also, the patch's context diff headers should have dates
1133 and times in Universal Time using traditional Unix format, so that patch
1134 recipients can use GNU @code{patch}'s @samp{-Z} option. For example,
1135 you could use the following Bourne shell command to create the patch:
1138 LC_ALL=C TZ=UTC0 diff -rc2P gcc-2.3.2 gcc-2.3.3 | \
1139 gzip -9 >gcc-2.3.2-2.3.3.patch.gz
1142 If the distribution has subdirectories in it, then the diffs probably
1143 include some files in the subdirectories. To help users install such
1144 patches reliably, give them precise directions for how to run patch.
1145 For example, say this:
1148 To apply these patches, cd to the main directory of the program
1149 and then use `patch -p1'. `-p1' avoids guesswork in choosing
1150 which subdirectory to find each file in.
1153 It's wise to test your patch by applying it to a copy of the old
1154 version, and checking that the result exactly matches the new version.
1156 @node Distribution on ftp.gnu.org
1157 @section Distribution on @code{ftp.gnu.org}
1158 @cindex GNU ftp site
1159 @cindex @code{ftp.gnu.org}, the GNU ftp site
1161 GNU packages are distributed through directory @file{/gnu} on
1162 @code{ftp.gnu.org}. Each package should have a subdirectory
1163 named after the package, and all the distribution files for the package
1164 should go in that subdirectory.
1166 @c If you have an interest in seeing the monthly download logs from the FTP
1167 @c site at @code{ftp.gnu.org} for your program, that is something that
1168 @c @email{ftp-upload@@gnu.org} can set up for you. Please contact them if
1169 @c you are interested.
1171 @xref{Automated FTP Uploads}, for procedural details of putting new
1172 versions on @code{ftp.gnu.org}.
1175 @section Test Releases
1176 @cindex test releases
1177 @cindex beta releases
1178 @cindex pretest releases
1180 @cindex @code{alpha.gnu.org}, ftp site for test releases
1181 When you release a greatly changed new major version of a program, you
1182 might want to do so as a pretest. This means that you make a tar file,
1183 but send it only to a group of volunteers that you have recruited. (Use
1184 a suitable GNU mailing list/newsgroup to recruit them.)
1186 We normally use the FTP server @code{alpha.gnu.org} for pretests and
1187 prerelease versions. @xref{Automated FTP Uploads}, for procedural details
1188 of putting new versions on @code{alpha.gnu.org}.
1190 Once a program gets to be widely used and people expect it to work
1191 solidly, it is a good idea to do pretest releases before each ``real''
1194 There are two ways of handling version numbers for pretest versions.
1195 One method is to treat them as versions preceding the release you are going
1198 In this method, if you are about to release version 4.6 but you want
1199 to do a pretest first, call it 4.5.90. If you need a second pretest,
1200 call it 4.5.91, and so on. If you are really unlucky and ten pretests
1201 are not enough, after 4.5.99 you could advance to 4.5.990 and so on.
1202 (You could also use 4.5.100, but 990 has the advantage of sorting in
1205 The other method is to attach a date to the release number that is
1206 coming. For a pretest for version 4.6, made on Dec 10, 2002, this
1207 would be 4.6.20021210. A second pretest made the same day could be
1210 For development snapshots that are not formal pretests, using just
1211 the date without the version numbers is ok too.
1213 One thing that you should never do is to release a pretest with the same
1214 version number as the planned real release. Many people will look only
1215 at the version number (in the tar file name, in the directory name that
1216 it unpacks into, or wherever they can find it) to determine whether a
1217 tar file is the latest version. People might look at the test release
1218 in this way and mistake it for the real release. Therefore, always
1219 change the number when you release changed code.
1222 @node Automated FTP Uploads
1223 @section Automated FTP Uploads
1225 @cindex ftp uploads, automated
1226 In order to upload new releases to @code{ftp.gnu.org} or
1227 @code{alpha.gnu.org}, you first need to register the necessary
1228 information. Then, you can perform uploads yourself, with no
1229 intervention needed by the system administrators.
1231 The general idea is that releases should be crytographically signed
1232 before they are made publicly available.
1235 * Automated Upload Registration::
1236 * Automated Upload Procedure::
1237 * FTP Upload Directive File - v1.1::
1238 * FTP Upload Directive File - v1.0::
1242 @node Automated Upload Registration
1243 @subsection Automated Upload Registration
1245 @cindex registration for uploads
1246 @cindex uploads, registration for
1248 Here is how to register your information so you can perform uploads
1249 for your GNU package:
1254 Create an account for yourself at @url{http://savannah.gnu.org}, if
1255 you don't already have one. By the way, this is also needed to
1256 maintain the web pages at @url{www.gnu.org} for your project
1257 (@pxref{Web Pages}).
1260 In the @samp{My Account Conf} page on @code{savannah}, upload the GPG
1261 key you will use to sign your packages.
1263 You can create a key with the command @code{gpg --gen-key}. It is
1264 good to also send your key to the GPG public key server: @code{gpg
1265 --keyserver keys.gnupg.net --send-keys @var{keyid}}, where @var{keyid}
1266 is the eight hex digits reported by @code{gpg --list-public-keys} on
1267 the @code{pub} line before the date. For full information about GPG,
1268 see @url{http://www.gnu.org/software/gpg})
1271 Compose a message with the following items in some @var{msgfile}.
1272 Then GPG-sign it by running @code{gpg --clearsign @var{msgfile}}, and
1273 finally email the resulting @file{@var{msgfile}.asc}), to
1274 @email{ftp-upload@@gnu.org}.
1278 Name of package(s) that you are the maintainer for, and your
1279 preferred email address.
1282 An ASCII armored copy of your GnuPG key, as an attachment. (@samp{gpg
1283 --export -a @var{your_key_id} >mykey.asc} should give you this.)
1286 A list of names and preferred email addresses of other individuals you
1287 authorize to make releases for which packages, if any (in the case that you
1288 don't make all releases yourself).
1291 ASCII armored copies of GnuPG keys for any individuals listed in (3).
1295 The administrators will acknowledge your message when they have added
1296 the proper GPG keys as authorized to upload files for the
1297 corresponding packages.
1299 The upload system will email receipts to the given email addresses
1300 when an upload is made, either successfully or unsuccessfully.
1303 @node Automated Upload Procedure
1304 @subsection Automated Upload Procedure
1308 Once you have registered your information as described in the previous
1309 section, you will be able to do ftp uploads for yourself using the
1310 following procedure.
1312 For each upload destined for @code{ftp.gnu.org} or
1313 @code{alpha.gnu.org}, three files (a @dfn{triplet}) need to be
1314 uploaded via ftp to the host @code{ftp-upload.gnu.org}.
1318 The file to be distributed; for example, @file{foo.tar.gz}.
1321 Detached GPG binary signature file for (1); for example,
1322 @file{foo.tar.gz.sig}. Make this with @samp{gpg -b foo.tar.gz}.
1326 A clearsigned @dfn{directive file}; for example,
1327 @file{foo.tar.gz.directive.asc}. Make this by preparing the plain
1328 text file @file{foo.tar.gz.directive} and then run @samp{gpg
1329 --clearsign foo.tar.gz.directive}. @xref{FTP Upload Directive File -
1330 v1.1}, for the contents of the directive file.
1333 The names of the files are important. The signature file must have the
1334 same name as the file to be distributed, with an additional
1335 @file{.sig} extension. The directive file must have the same name as
1336 the file to be distributed, with an additional @file{.directive.asc}
1337 extension. If you do not follow this naming convention, the upload
1338 @emph{will not be processed}.
1340 Since v1.1 of the upload script, it is also possible to upload a
1341 clearsigned directive file on its own (no accompanying @file{.sig} or
1342 any other file) to perform certain operations on the server.
1343 @xref{FTP Upload Directive File - v1.1}, for more information.
1345 Upload the file(s) via anonymous ftp to @code{ftp-upload.gnu.org}. If
1346 the upload is destined for @code{ftp.gnu.org}, place the file(s) in
1347 the @file{/incoming/ftp} directory. If the upload is destined for
1348 @code{alpha.gnu.org}, place the file(s) in the @file{/incoming/alpha}
1351 Uploads are processed every five minutes. Uploads that are in
1352 progress while the upload processing script is running are handled
1353 properly, so do not worry about the timing of your upload. Uploaded
1354 files that belong to an incomplete triplet are deleted automatically
1357 Your designated upload email addresses (@pxref{Automated Upload Registration})
1358 are sent a message if there are any problems processing an upload for your
1359 package. You also receive a message when your upload has been successfully
1362 One automated way to create and transfer the necessary files is to use
1363 the @code{gnupload} script, which is available from the
1364 @file{build-aux/} directory of the @code{gnulib} project at
1365 @url{http://savannah.gnu.org/projects/gnulib}. @code{gnupload} can
1366 also remove uploaded files. Run @code{gnupload --help} for a
1367 description and examples.
1369 @code{gnupload} uses the @code{ncftpput} program to do the actual
1370 transfers; if you don't happen to have the @code{ncftp} package
1371 installed, the @code{ncftpput-ftp} script in the @file{build-aux/}
1372 directory of @code{gnulib} serves as a replacement which uses plain
1373 command line @code{ftp}.
1375 If you have difficulties with an upload, email
1376 @email{ftp-upload@@gnu.org}.
1379 @node FTP Upload Directive File - v1.1
1380 @subsection FTP Upload Directive File - v1.1
1382 The directive file name must end in @file{directive.asc}.
1384 When part of a triplet, the directive file must always contain the
1385 directives @code{version}, @code{directory} and @code{filename}, as
1386 described. In addition, a 'comment' directive is allowed.
1388 The @code{version} directive must always have the value @samp{1.1}.
1390 The @code{directory} directive specifies the final destination
1391 directory where the uploaded file and its @file{.sig} companion are to
1394 The @code{filename} directive must contain the name of the file to be
1395 distributed (item@tie{}(1) above).
1397 For example, as part of an uploaded triplet, a
1398 @file{foo.tar.gz.directive.asc} file might contain these lines (before
1399 being gpg clearsigned):
1404 filename: foo.tar.gz
1405 comment: hello world!
1408 This directory line indicates that @file{foo.tar.gz} and
1409 @file{foo.tar.gz.sig} are part of package @code{bar}. If you uploaded
1410 this triplet to @file{/incoming/ftp} and the system positively
1411 authenticates the signatures, the files @file{foo.tar.gz} and
1412 @file{foo.tar.gz.sig} will be placed in the directory
1413 @file{gnu/bar/v1} of the @code{ftp.gnu.org} site.
1415 The directive file can be used to create currently non-existent
1416 directory trees, as long as they are under the package directory for
1417 your package (in the example above, that is @code{bar}).
1419 If you upload a file that already exists in the FTP directory, the
1420 original will simply be archived and replaced with the new upload.
1422 @subheading Standalone directives
1424 When uploaded by itself, the directive file must contain one or more
1425 of the directives @code{symlink}, @code{rmsymlink} or @code{archive},
1426 in addition to the obligatory @code{directory} and @code{version}
1427 directives. A @code{filename} directive is not allowed, and a
1428 @code{comment} directive remains optional.
1430 If you use more than one directive, the directives are executed in the
1431 sequence they are specified in. If a directive results in an error,
1432 further execution of the upload is aborted.
1434 Removing a symbolic link (with @code{rmsymlink}) which does not exist
1435 results in an error. However, attempting to create a symbolic link
1436 that already exists (with @code{symlink}) is not an error. In this
1437 case @code{symlink} behaves like the command @command{ln -s -f}: any
1438 existing symlink is removed before creating the link. (But an
1439 existing regular file or directory is not removed.)
1441 Here are a few examples. The first removes a symlink:
1446 rmsymlink: foo-latest.tgz
1447 comment: remove a symlink
1451 Archive an old file, taking it offline:
1456 archive: foo-1.1.tar.gz
1457 comment: archive an old file; it will not be available through FTP anymore
1461 Archive an old directory (with all contents), taking it offline:
1467 comment: archive an old directory; it will not be available through FTP anymore
1471 Create a new symlink:
1476 symlink: foo-1.2.tar.gz foo-latest.tgz
1477 comment: create a new symlink
1481 Do everything at once:
1486 rmsymlink: foo-latest.tgz
1487 symlink: foo-1.2.tar.gz foo-latest.tgz
1488 archive: foo-1.1.tar.gz
1489 comment: now do everything at once
1493 @node FTP Upload Directive File - v1.0
1494 @subsection FTP Upload Directive File - v1.0
1496 @dfn{As of June 2006, the upload script is running in compatibility
1497 mode, allowing uploads with either version@tie{}1.1 or
1498 version@tie{}1.0 of the directive file syntax. Support for v1.0
1499 uploads will be phased out by the end of 2006, so please upgrade
1502 The directive file should contain one line, excluding the clearsigned
1503 data GPG that inserts, which specifies the final destination directory
1504 where items (1) and (2) are to be placed.
1506 For example, the @file{foo.tar.gz.directive.asc} file might contain the
1513 This directory line indicates that @file{foo.tar.gz} and
1514 @file{foo.tar.gz.sig} are part of package @code{bar}. If you were to
1515 upload the triplet to @file{/incoming/ftp}, and the system can
1516 positively authenticate the signatures, then the files
1517 @file{foo.tar.gz} and @file{foo.tar.gz.sig} will be placed in the
1518 directory @file{gnu/bar/v1} of the @code{ftp.gnu.org} site.
1520 The directive file can be used to create currently non-existent
1521 directory trees, as long as they are under the package directory for
1522 your package (in the example above, that is @code{bar}).
1526 @section Announcing Releases
1527 @cindex announcements
1529 @cindex @code{info-gnu} mailing list
1530 When you have a new release, please make an announcement. For
1531 official new releases, including those made just to fix bugs, we
1532 strongly recommend using the (moderated) general GNU announcements
1533 list, @email{info-gnu@@gnu.org}. Doing so makes it easier for users
1534 and developers to find the latest GNU releases. On the other hand,
1535 please do not announce test releases on @code{info-gnu} unless it's a
1536 highly unusual situation.
1538 @cindex @url{http://planet.gnu.org}
1539 @cindex Savannah, news area
1540 Please also post release announcements in the news section of your
1541 Savannah project site. It is fine to also write news entries for test
1542 releases and any other newsworthy events. The news feeds from all GNU
1543 projects at savannah are aggregated at @url{http://planet.gnu.org}
1544 (GNU Planet). You can also post items directly, or arrange for feeds
1545 from other locations; see contact information on the GNU Planet web
1548 @cindex announcement mailing list, project-specific
1549 You can maintain your own mailing list (typically
1550 @email{info-@var{program}@@gnu.org}) for announcements as well if you
1551 like. For your own list, of course you decide as you see fit what
1552 events are worth announcing. (@xref{Mail}, for more suggestions on
1553 handling mail for your package.)
1555 @cindex contents of announcements
1556 When writing an announcement, please include the following:
1560 A very brief description (a few sentences at most) of the general
1561 purpose of your package.
1564 Your package's web page (normally
1565 @indicateurl{http://www.gnu.org/software/@var{package}/}).
1568 Your package's download location (normally
1569 @indicateurl{http://ftp.gnu.org/gnu/@var{package}/}). It is also
1570 useful to mention the FTP mirror list at
1571 @url{http://www.gnu.org/order/ftp.html}, and that
1572 @url{http://ftpmirror.gnu.org/@var{package/}} will automatically
1573 redirect to a nearby mirror.
1576 The NEWS (@pxref{NEWS File,,, standards, GNU Coding Standards}) for
1577 the present release.
1585 Please write web pages about your package for installation on
1586 @code{www.gnu.org}. They should follow our usual standards for web
1587 pages (see @url{http://www.gnu.org/server/fsf-html-style-sheet.html}).
1588 The overall goals are to support a wide variety of browsers, to focus
1589 on information rather than flashy eye candy, and to keep the site
1592 Some GNU packages have just simple web pages, but the more information
1593 you provide, the better. So please write as much as you usefully can,
1594 and put all of it on @code{www.gnu.org}. However, pages that access
1595 databases (including mail logs and bug tracking) are an exception; set
1596 them up on whatever site is convenient for you, and make the pages on
1597 @code{www.gnu.org} link to that site.
1600 * Hosting for Web Pages::
1601 * Freedom for Web Pages::
1602 * Manuals on Web Pages::
1603 * CVS Keywords in Web Pages::
1606 @node Hosting for Web Pages
1607 @section Hosting for Web Pages
1609 The best way to maintain the web pages for your project is to register
1610 the project on @code{savannah.gnu.org}. Then you can edit the pages
1611 using CVS, using the separate ``web repository'' available on
1612 Savannah, which corresponds to
1613 @indicateurl{http://www.gnu.org/software/@var{package}/}. You can
1614 keep your source files there too (using any of a variety of version
1615 control systems), but you can use @code{savannah.gnu.org} only for
1616 your gnu.org web pages if you wish; simply register a ``web-only''
1619 If you don't want to use that method, please talk with
1620 @email{webmasters@@gnu.org} about other possible methods. For
1621 instance, you can mail them pages to install, if necessary. But that
1622 is more work for them, so please use Savannah if you can.
1624 If you use Savannah, you can use a special @file{.symlinks} file in
1625 order to create symbolic links, which are not supported in CVS. For
1627 @url{http://www.gnu.org/server/standards/README.webmastering.html#symlinks}.
1630 @node Freedom for Web Pages
1631 @section Freedom for Web Pages
1633 If you use a site other than @code{www.gnu.org}, please make sure that
1634 the site runs on free software alone. (It is ok if the site uses
1635 unreleased custom software, since that is free in a trivial sense:
1636 there's only one user and it has the four freedoms.) If the web site
1637 for a GNU package runs on non-free software, the public will see this,
1638 and it will have the effect of granting legitimacy to the non-free
1641 If you use multiple sites, they should all follow that criterion.
1642 Please don't link to a site that is about your package, which the
1643 public might perceive as connected with it and reflecting the position
1644 of its developers, unless it follows that criterion.
1646 Historically, web pages for GNU packages did not include GIF images,
1647 because of patent problems (@pxref{Ethical and Philosophical
1648 Consideration}). Although the GIF patents expired in 2006, using GIF
1649 images is still not recommended, as the PNG and JPEG formats are
1650 generally superior. See @url{http://www.gnu.org/philosophy/gif.html}.
1653 @node Manuals on Web Pages
1654 @section Manuals on Web Pages
1656 The web pages for the package should include its manuals, in HTML,
1657 DVI, Info, PostScript, PDF, plain ASCII, and Texinfo format (source).
1658 All of these can be generated automatically from the Texinfo source
1659 using Makeinfo and other programs.
1661 When there is only one manual, put it in a subdirectory called
1662 @file{manual}; the file @file{manual/index.html} should have a link to
1663 the manual in each of its forms.
1665 If the package has more than one manual, put each one in a
1666 subdirectory of @file{manual}, set up @file{index.html} in each
1667 subdirectory to link to that manual in all its forms, and make
1668 @file{manual/index.html} link to each manual through its subdirectory.
1670 See the section below for details on a script to make the job of
1671 creating all these different formats and index pages easier.
1673 We would like to include links to all GNU manuals on the page
1674 @url{http://www.gnu.org/manual}, so if yours isn't listed, please send
1675 mail to @code{webmasters@@gnu.org} telling them the name of your
1676 package and asking them to edit @url{http://www.gnu.org/manual}, and
1677 they will do so based on the contents of your @file{manual} directory.
1680 * Invoking gendocs.sh::
1684 @node Invoking gendocs.sh
1685 @subsection Invoking @command{gendocs.sh}
1687 @cindex generating documentation output
1689 The script @command{gendocs.sh} eases the task of generating the
1690 Texinfo documentation output for your web pages
1691 section above. It has a companion template file, used as the basis
1692 for the HTML index pages. Both are available from the Texinfo CVS
1696 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh}
1697 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template}
1700 There is also a minimalistic template, available from:
1703 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template_min}
1706 Invoke the script like this, in the directory containing the Texinfo
1710 gendocs.sh --email @var{yourbuglist} @var{yourmanual} "GNU @var{yourmanual} manual"
1713 @noindent where @var{yourmanual} is the short name for your package
1714 and @var{yourbuglist} is the email address for bug reports (typically
1715 @code{bug-@var{package}@@gnu.org}). The script processes the file
1716 @file{@var{yourmanual}.texinfo} (or @file{.texi} or @file{.txi}). For
1721 # download gendocs.sh and gendocs_template
1722 gendocs.sh --email bug-gnu-emacs@@gnu.org emacs "GNU Emacs manual"
1725 @command{gendocs.sh} creates a subdirectory @file{manual/} containing
1726 the manual generated in all the standard output formats: Info, HTML,
1727 DVI, and so on, as well as the Texinfo source. You then need to move
1728 all those files, retaining the subdirectories, into the web pages for
1731 You can specify the option @option{-o @var{outdir}} to override the
1732 name @file{manual}. Any previous contents of @var{outdir} will be deleted.
1734 The second argument, with the description, is included as part of the
1735 HTML @code{<title>} of the overall @file{manual/index.html} file. It
1736 should include the name of the package being documented, as shown.
1737 @file{manual/index.html} is created by substitution from the file
1738 @file{gendocs_template}. (Feel free to modify the generic template
1739 for your own purposes.)
1741 If you have several manuals, you'll need to run this script several
1742 times with different arguments, specifying a different output
1743 directory with @option{-o} each time, and moving all the output to
1744 your web page. Then write (by hand) an overall index.html with links
1745 to them all. For example:
1749 gendocs.sh --email bug-texinfo@@gnu.org -o texinfo texinfo "GNU Texinfo manual"
1750 gendocs.sh --email bug-texinfo@@gnu.org -o info info "GNU Info manual"
1751 gendocs.sh --email bug-texinfo@@gnu.org -o info-stnd info-stnd "GNU info-stnd manual"
1754 By default, the script uses @command{makeinfo} for generating
1755 @acronym{HTML} output. If you prefer to use @command{texi2html}, use
1756 the @option{--texi2html} command line option, e.g.:
1759 gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"
1762 The template files will automatically produce entries for additional
1763 HTML output generated by @command{texi2html} (i.e., split by sections
1766 You can set the environment variables @env{MAKEINFO}, @env{TEXI2DVI},
1767 @env{TEXI2HTML} and @env{DVIPS} to control the programs that get
1768 executed, and @env{GENDOCS_TEMPLATE_DIR} to control where the
1769 @file{gendocs_template} file is found.
1771 As usual, run @samp{gendocs.sh --help} for a description of all the
1772 options, environment variables, and more information.
1774 Please email bug reports, enhancement requests, or other
1775 correspondence to @email{bug-texinfo@@gnu.org}.
1778 @node CVS Keywords in Web Pages
1779 @section CVS Keywords in Web Pages
1780 @cindex CVS keywords in web pages
1781 @cindex RCS keywords in web pages
1782 @cindex $ keywords in web pages
1783 @cindex web pages, and CVS keywords
1785 Since @code{www.gnu.org} works through CVS, CVS keywords in your
1786 manual, such as @code{@w{$}Log$}, need special treatment (even if you
1787 don't happen to maintain your manual in CVS).
1789 If these keywords end up in the generated output as literal strings,
1790 they will be expanded. The most robust way to handle this is to turn
1791 off keyword expansion for such generated files. For existing files,
1795 cvs admin -ko @var{file1} @var{file2} ...
1802 cvs add -ko @var{file1} @var{file2} ...
1805 @xref{Keyword substitution,,,cvs,Version Management with CVS}.
1807 In Texinfo source, the recommended way to literally specify a
1808 ``dollar'' keyword is:
1814 The @code{@@w} prevents keyword expansion in the Texinfo source
1815 itself. Also, @code{makeinfo} notices the @code{@@w} and generates
1816 output avoiding the literal keyword string.
1819 @node Ethical and Philosophical Consideration
1820 @chapter Ethical and Philosophical Consideration
1824 The GNU project takes a strong stand for software freedom. Many
1825 times, this means you'll need to avoid certain technologies when their
1826 use would conflict with our long-term goals.
1828 Software patents threaten the advancement of free software and freedom
1829 to program. There are so many software patents in the US that any
1830 large program probably implements hundreds of patented techniques,
1831 unknown to the program's developers. It would be futile and
1832 self-defeating to try to find and avoid all these patents. But there
1833 are some patents which we know are likely to be used to threaten free
1834 software, so we make an effort to avoid the patented techniques. If
1835 you are concerned about the danger of a patent and would like advice,
1836 write to @email{maintainers@@gnu.org}, and we will try to help you get
1837 advice from a lawyer.
1839 Sometimes the GNU project takes a strong stand against a particular
1840 patented technology in order to encourage society to reject it.
1842 For example, the MP3 audio format is covered by a software patent in
1843 the USA and some other countries. A patent holder has threatened
1844 lawsuits against the developers of free programs (these are not GNU
1845 programs) to produce and play MP3, and some GNU/Linux distributors are
1846 afraid to include them. Development of the programs continues, but we
1847 campaign for the rejection of MP3 format in favor of Ogg Vorbis format.
1849 A GNU package should not recommend use of any non-free program, nor
1850 should it require a non-free program (such as a non-free compiler or
1851 IDE) to build. Thus, a GNU package cannot be written in a programming
1852 language that does not have a free software implementation. Now that
1853 GNU/Linux systems are widely available, all GNU packages should
1854 provide full functionality on a 100% free GNU/Linux system, and should
1855 not require any non-free software to build or function.
1856 The GNU Coding Standards say a lot more about this issue.
1858 A GNU package should not refer the user to any non-free documentation
1859 for free software. The need for free documentation to come with free
1860 software is now a major focus of the GNU project; to show that we are
1861 serious about the need for free documentation, we must not contradict
1862 our position by recommending use of documentation that isn't free.
1864 Finally, new issues concerning the ethics of software freedom come up
1865 frequently. We ask that GNU maintainers, at least on matters that
1866 pertain specifically to their package, stand with the rest of the GNU
1867 project when such issues come up.
1871 @chapter Terminology Issues
1874 This chapter explains a couple of issues of terminology which are
1875 important for correcting two widespread and important misunderstandings
1879 * Free Software and Open Source::
1883 @node Free Software and Open Source
1884 @section Free Software and Open Source
1885 @cindex free software
1887 @cindex movements, Free Software and Open Source
1889 The terms ``free software'' and ``open source'' are the slogans of two
1890 different movements which differ in their basic philosophy. The Free
1891 Software Movement is idealistic, and raises issues of freedom, ethics,
1892 principle and what makes for a good society. The Open Source Movement,
1893 founded in 1998, studiously avoids such questions. For more explanation,
1894 see @url{http://www.gnu.org/philosophy/open-source-misses-the-point.html}.
1896 The GNU Project is aligned with the Free Software Movement. This
1897 doesn't mean that all GNU contributors and maintainers have to agree;
1898 your views on these issues are up to you, and you're entitled to express
1899 them when speaking for yourself.
1901 However, due to the much greater publicity that the Open Source
1902 Movement receives, the GNU Project needs to overcome a widespread
1903 mistaken impression that GNU is @emph{and always was} an activity of
1904 the Open Source Movement. For this reason, please use the term ``free
1905 software'', not ``open source'', in GNU software releases, GNU
1906 documentation, and announcements and articles that you publish in your
1907 role as the maintainer of a GNU package. A reference to the URL given
1908 above, to explain the difference, is a useful thing to include as
1912 @section GNU and Linux
1916 The GNU Project was formed to develop a free Unix-like operating system,
1917 GNU. The existence of this system is our major accomplishment.
1918 However, the widely used version of the GNU system, in which Linux is
1919 used as the kernel, is often called simply ``Linux''. As a result, most
1920 users don't know about the GNU Project's major accomplishment---or more
1921 precisely, they know about it, but don't realize it is the GNU Project's
1922 accomplishment and reason for existence. Even people who believe they
1923 know the real history often believe that the goal of GNU was to develop
1924 ``tools'' or ``utilities.''
1926 To correct this confusion, we have made a years-long effort to
1927 distinguish between Linux, the kernel that Linus Torvalds wrote, and
1928 GNU/Linux, the operating system that is the combination of GNU and
1929 Linux. The resulting increased awareness of what the GNU Project has
1930 already done helps every activity of the GNU Project recruit more
1931 support and contributors.
1933 Please make this distinction consistently in GNU software releases, GNU
1934 documentation, and announcements and articles that you publish in your
1935 role as the maintainer of a GNU package. If you want to explain the
1936 terminology and its reasons, you can refer to the URL
1937 @url{http://www.gnu.org/gnu/linux-and-gnu.html}.
1939 To contrast the GNU system properly with respect to GNU/Linux, you can
1940 call it ``GNU/Hurd'' or ``the GNU/Hurd system.'' However, when that
1941 contrast is not specifically the focus, please call it just ``GNU'' or
1944 When referring to the collection of servers that is the higher level
1945 of the GNU kernel, please call it ``the Hurd'' or ``the GNU Hurd.''
1946 Note that this uses a space, not a slash.
1951 @cindex CVS repository
1953 @cindex source repository
1954 @cindex version control system
1958 We recommend using @code{savannah.gnu.org} for the source code
1959 repository for your package, and, even more so, using
1960 @code{ftp.gnu.org} as the standard distribution site. Doing so makes
1961 it easier for developers and users to find the latest GNU releases.
1962 @xref{Old Versions}, for more information about Savannah.
1964 However, it is ok to use other machines if you wish. If you use a
1965 company's machine to hold the repository for your program, or as its
1966 ftp site, please put this statement in a prominent place on the site,
1967 so as to prevent people from getting the wrong idea about the
1968 relationship between the package and the company:
1971 The programs <list of them> hosted here are free software packages
1972 of the GNU Project, not products of <company name>. We call them
1973 "free software" because you are free to copy and redistribute them,
1974 following the rules stated in the license of each package. For more
1975 information, see http://www.gnu.org/philosophy/free-sw.html.
1977 If you are looking for service or support for GNU software, see
1978 http://www.gnu.org/help/gethelp.html for suggestions of where to ask.
1980 If you would like to contribute to the development of one of these
1981 packages, contact the package maintainer or the bug-reporting address
1982 of the package (which should be listed in the package itself), or look
1983 on www.gnu.org for more information on how to contribute.
1987 @node Free Software Directory
1988 @chapter Free Software Directory
1989 @cindex Free Software Directory
1990 @cindex Directory, Free Software
1992 The Free Software Directory aims to be a complete list of free
1993 software packages, within certain criteria. Every GNU package should
1994 be listed there, so please see
1995 @url{http://www.gnu.org/help/directory.html#adding-entries} for
1996 information on how to write an entry for your package. Contact
1997 @email{bug-directory@@gnu.org} with any questions or suggestions for
1998 the Free Software Directory.
2001 @node Using the Proofreaders List
2002 @chapter Using the Proofreaders List
2003 @cindex proofreading
2005 If you want help finding errors in documentation,
2006 or help improving the quality of writing,
2007 or if you are not a native speaker of English
2008 and want help producing good English documentation,
2009 you can use the GNU proofreaders mailing list:
2010 @email{proofreaders@@gnu.org}.
2012 But be careful when you use the list,
2013 because there are over 200 people on it.
2014 If you simply ask everyone on the list to read your work,
2015 there will probably be tremendous duplication of effort
2016 by the proofreaders,
2017 and you will probably get the same errors reported 100 times.
2018 This must be avoided.
2020 Also, the people on the list do not want to get
2021 a large amount of mail from it.
2022 So do not ever ask people on the list to send mail to the list!
2024 Here are a few methods that seem reasonable to use:
2028 For something small, mail it to the list,
2029 and ask people to pick a random number from 1 to 20,
2030 and read it if the number comes out as 10.
2031 This way, assuming 50% response, some 5 people will read the piece.
2034 For a larger work, divide your work into around 20 equal-sized parts,
2035 tell people where to get it,
2036 and ask each person to pick randomly which part to read.
2038 Be sure to specify the random choice procedure;
2039 otherwise people will probably use a mental procedure
2040 that is not really random,
2041 such as ``pick a part near the middle'',
2042 and you will not get even coverage.
2044 You can either divide up the work physically, into 20 separate files,
2045 or describe a virtual division, such as by sections
2046 (if your work has approximately 20 sections).
2047 If you do the latter, be sure to be precise about it---for example,
2048 do you want the material before the first section heading
2049 to count as a section, or not?
2052 For a job needing special skills, send an explanation of it,
2053 and ask people to send you mail if they volunteer for the job.
2054 When you get enough volunteers, send another message to the list saying
2055 ``I have enough volunteers, no more please.''
2059 @node GNU Free Documentation License
2060 @appendix GNU Free Documentation License
2062 @cindex FDL, GNU Free Documentation License
2073 eval: (add-hook 'write-file-hooks 'time-stamp)
2074 time-stamp-start: "@set lastupdate "
2075 time-stamp-start: "@set lastupdate "
2077 time-stamp-format: "%:b %:d, %:y"
2078 compile-command: "make -C work.m"