autoupdate
[gnulib.git] / doc / maintain.texi
1 \input texinfo.tex    @c -*-texinfo-*-
2 @c %**start of header
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 November 12, 2010
9 @c %**end of header
10
11 @dircategory GNU organization
12 @direntry
13 * Maintaining: (maintain).        Maintaining GNU software.
14 @end direntry
15
16 @setchapternewpage off
17
18 @c Put everything in one index (arbitrarily chosen to be the concept index).
19 @syncodeindex fn cp
20 @syncodeindex pg cp
21
22 @copying
23 Information for maintainers of GNU software, last updated @value{lastupdate}.
24
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
27 Foundation, Inc.
28
29 @quotation
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''.
36 @end quotation
37 @end copying
38
39 @titlepage
40 @title Information for Maintainers of GNU Software
41 @author Richard Stallman
42 @author last updated @value{lastupdate}
43 @page
44 @vskip 0pt plus 1filll
45 @insertcopying
46 @end titlepage
47
48 @contents
49
50 @ifnottex
51 @node Top
52 @top Version
53
54 @insertcopying
55 @end ifnottex
56
57 @menu
58 * Preface::
59 * Getting Help::
60 * Getting a GNU Account::
61 * Stepping Down::
62 * Recruiting Developers::
63 * Legal Matters::
64 * Clean Ups::
65 * Platforms::
66 * Mail::
67 * Old Versions::
68 * Distributions::
69 * Web Pages::
70 * Ethical and Philosophical Consideration::
71 * Terminology::
72 * Hosting::
73 * Donations::
74 * Free Software Directory::
75 * Using the Proofreaders List::
76 * GNU Free Documentation License::
77 * Index::
78 @end menu
79
80
81 @node Preface
82 @chapter About This Document
83
84 This file contains guidelines and advice for someone who is the
85 maintainer of a GNU program on behalf of the GNU Project.  Everyone is
86 entitled to change and redistribute GNU software; you need not pay
87 attention to this file to get permission.  But if you want to maintain
88 a version for widespread distribution, we suggest you follow these
89 guidelines.  If you are or would like to be a GNU maintainer, then it
90 is essential to follow these guidelines.
91
92 In addition to this document, please read and follow the GNU Coding
93 Standards (@pxref{Top, , Contents, standards, GNU Coding Standards}).
94
95 @cindex @code{bug-standards@@gnu.org} email address
96 @cindex Savannah repository for gnustandards
97 @cindex gnustandards project repository
98 Please send corrections or suggestions for this document to
99 @email{bug-standards@@gnu.org}.  If you make a suggestion, please
100 include suggested new wording if you can.  We prefer a context diff to
101 the Texinfo source, but if that's difficult for you, you can make a
102 diff for some other version of this document, or propose it in any way
103 that makes it clear.  The source repository for this document can be
104 found at @url{http://savannah.gnu.org/projects/gnustandards}.
105
106 @cindex @code{gnustandards-commit@@gnu.org} mailing list
107 If you want to receive diffs for every change to these GNU documents,
108 join the mailing list @code{gnustandards-commit@@gnu.org}, for
109 instance via the web interface at
110 @url{http://lists.gnu.org/mailman/listinfo/gnustandards-commit}.
111 Archives are also available there.
112
113 @cindex Piercy, Marge
114 This document uses the gender-neutral third-person pronouns ``person'',
115 ``per'', ``pers'' and ``perself'' which were promoted, and perhaps
116 invented, by Marge Piercy in @cite{Woman on the Edge of Time}.  They are
117 used just like ``she'', ``her'', ``hers'' and ``herself'', except that
118 they apply equally to males and females.  For example, ``Person placed
119 per new program under the GNU GPL, to let the public benefit from per
120 work, and to enable per to feel person has done the right thing.''
121
122 This release of the GNU Maintainer Information was last updated
123 @value{lastupdate}.
124
125
126 @node Getting Help
127 @chapter Getting Help
128 @cindex help, getting
129
130 @cindex @code{mentors@@gnu.org} mailing list
131 If you have general questions or encounter a situation where it isn't
132 clear what to do, you can ask @email{mentors@@gnu.org}, which is a
133 list of a few experienced GNU contributors who have offered to answer
134 questions for new maintainers.
135
136 @cindex advisory committee
137 The GNU Advisory Committee helps to coordinate activities in the GNU
138 project on behalf of RMS (Richard Stallman, the Chief GNUisance).  If
139 you have any organizational questions or concerns you can contact the
140 committee at @email{gnu-advisory@@gnu.org}.  See
141 @url{http://www.gnu.org/contact/gnu-advisory.html} for the current
142 committee members.  Additional information is in
143 @file{/gd/gnuorg/advisory}.
144
145
146
147 @node Getting a GNU Account
148 @chapter Getting a GNU Account
149 @cindex shell account, on fencepost
150 @cindex @code{fencepost.gnu.org} GNU machine
151
152 @c We want to repeat this text later, so define a macro.
153 @macro gdgnuorgtext
154 The directory @file{/gd/gnuorg} mentioned throughout this document is
155 available on the general GNU server, currently
156 @code{fencepost.gnu.org}.  If you are the maintainer of a GNU package,
157 you should have an account there.  If you don't have one already,
158 @url{http://www.gnu.org/software/README.accounts.html}.  You can also
159 ask for accounts for people who significantly help you in working on
160 the package.
161 @end macro
162
163 @gdgnuorgtext{}
164
165 @cindex down, when GNU machines are
166 @cindex outage, of GNU machines
167 @cindex @url{http://identi.ca/group/fsfstatus}
168 If you find that any GNU computer systems (@code{fencepost.gnu.org},
169 @code{ftp.gnu.org}, @code{www.gnu.org}, @code{savannah.gnu.org},
170 @dots{}) seem to be down, you can check the current status at
171 @url{http://identi.ca/group/fsfstatus}.  Most likely the problem, if
172 it can be alleviated at the FSF end, is already being worked on.
173
174
175 @node Stepping Down
176 @chapter Stepping Down
177 @cindex stepping down as maintainer
178 @cindex resigning as maintainer
179
180 With good fortune, you will continue maintaining your package for many
181 decades.  But sometimes for various reasons maintainers decide to step
182 down.
183
184 If you're the official maintainer of a GNU package and you decide to
185 step down, please inform the GNU Project (@email{maintainers@@gnu.org}).
186 We need to know that the package no longer has a maintainer, so we can
187 look for and appoint a new maintainer.
188
189 @cindex @email{maintainers@@gnu.org}
190 If you have an idea for who should take over, please tell
191 @email{maintainers@@gnu.org} your suggestion.  The appointment of a new
192 maintainer needs the GNU Project's confirmation, but your judgment that
193 a person is capable of doing the job will carry a lot of weight.
194
195 As your final act as maintainer, it would be helpful to set up the
196 package under @code{savannah.gnu.org} if it is not there already
197 (@pxref{Old Versions}).  This will make it much easier for the new
198 maintainer to pick up where you left off and will ensure that the
199 source tree is not misplaced if it takes us a while to find a new
200 maintainer.
201
202
203 @node Recruiting Developers
204 @chapter Recruiting Developers
205
206 Unless your package is a fairly small, you probably won't do all the
207 work on it yourself.  Most maintainers recruit other developers to help.
208
209 Sometimes people will offer to help.  Some of them will be capable,
210 while others will not.  It's up to you to determine who provides useful
211 help, and encourage those people to participate more.
212
213 Some of the people who offer to help will support the GNU Project, while
214 others may be interested for other reasons.  Some will support the goals
215 of the Free Software Movement, but some may not.  They are all welcome
216 to help with the work---we don't ask people's views or motivations
217 before they contribute to GNU packages.
218
219 As a consequence, you cannot expect all contributors to support the GNU
220 Project, or to have a concern for its policies and standards.  So part
221 of your job as maintainer is to exercise your authority on these points
222 when they arise.  No matter how much of the work other people do, you
223 are in charge of what goes in the release.  When a crucial point arises,
224 you should calmly state your decision and stick to it.
225
226 Sometimes a package has several co-maintainers who share the role of
227 maintainer.  Unlike developers who help, co-maintainers have actually
228 been appointed jointly as the maintainers of the package, and they carry
229 out the maintainer's functions together.  If you would like to propose
230 some of your developers as co-maintainers, please contact
231 @email{maintainers@@gnu.org}.
232
233 We're happy to acknowledge all major contributors to GNU packages on
234 the @url{http://www.gnu.org/people/people.html} web page.  Please send
235 an entry for yourself to @email{webmasters@@gnu.org}, and feel free to
236 suggest it to other significant developers on your package.
237
238
239 @node Legal Matters
240 @chapter Legal Matters
241 @cindex legal matters
242
243 This chapter describes procedures you should follow for legal reasons
244 as you maintain the program, to avoid legal difficulties.
245
246 @menu
247 * Copyright Papers::
248 * Legally Significant::
249 * Recording Contributors::
250 * Copying from Other Packages::
251 * Copyright Notices::
252 * License Notices::
253 * External Libraries::
254 @end menu
255
256 @node Copyright Papers
257 @section Copyright Papers
258 @cindex copyright papers
259
260 If you maintain an FSF-copyrighted package
261 certain legal procedures are required when incorporating legally significant
262 changes written by other people.  This ensures that the FSF has the
263 legal right to distribute the package, and the standing to defend its
264 GPL-covered status in court if necessary.
265
266 @strong{Before} incorporating significant changes, make sure that the
267 person who wrote the changes has signed copyright papers and that the
268 Free Software Foundation has received and signed them.  We may also need
269 an employer's disclaimer from the person's employer.
270
271 @cindex data base of GNU copyright assignments
272 To check whether papers have been received, look in
273 @file{/gd/gnuorg/copyright.list}.  If you can't look there directly,
274 @email{fsf-records@@gnu.org} can check for you.  Our clerk can also
275 check for papers that are waiting to be entered and inform you when
276 expected papers arrive.
277
278 @cindex @file{/gd/gnuorg} directory
279 @c This paragraph intentionally duplicates information given
280 @c near the beginning of the file--to make sure people don't miss it.
281 @gdgnuorgtext{}
282
283 In order for the contributor to know person should sign papers, you need
284 to ask per for the necessary papers.  If you don't know per well, and you
285 don't know that person is used to our ways of handling copyright papers,
286 then it might be a good idea to raise the subject with a message like
287 this:
288
289 @quotation
290 Would you be willing to assign the copyright to the Free Software
291 Foundation, so that we could install it in @var{program}?
292 @end quotation
293
294 @noindent
295 or
296
297 @quotation
298 Would you be willing to sign a copyright disclaimer to put this change
299 in the public domain, so that we can install it in @var{program}?
300 @end quotation
301
302 If the contributor then wants more information, you can send per the file
303 @file{/gd/gnuorg/conditions.text}, which explains per options (assign
304 vs.@: disclaim) and their consequences.
305
306 Once the conversation is under way and the contributor is ready for
307 more details, you should send one of the templates that are found in
308 the directory @file{/gd/gnuorg/Copyright/}; they are also available
309 from the @file{doc/Copyright/} directory of the @code{gnulib} project
310 at @url{http://savannah.gnu.org/projects/gnulib}.  This section
311 explains which templates you should use in which circumstances.
312 @strong{Please don't use any of the templates except for those listed
313 here, and please don't change the wording.}
314
315 Once the conversation is under way, you can send the contributor the
316 precise wording and instructions by email.  Before you do this, make
317 sure to get the current version of the template you will use!  We change
318 these templates occasionally---don't keep using an old version.
319
320 For large changes, ask the contributor for an assignment.  Send per a
321 copy of the file @file{request-assign.changes}.  (Like all the
322 @samp{request-} files, it is in @file{/gd/gnuorg/Copyright} and in
323 @code{gnulib}.)
324
325 For medium to small changes, request a personal disclaimer by sending
326 per the file @file{request-disclaim.changes}.
327
328 If the contributor is likely to keep making changes, person might want
329 to sign an assignment for all per future changes to the program.  So it
330 is useful to offer per that alternative.  If person wants to do it that
331 way, send per the @file{request-assign.future}.
332
333 When you send a @file{request-} file, you don't need to fill in anything
334 before sending it.  Just send the file verbatim to the contributor.  The
335 file gives per instructions for how to ask the FSF to mail per the
336 papers to sign.  The @file{request-} file also raises the issue of
337 getting an employer's disclaimer from the contributor's employer.
338
339 When the contributor emails the form to the FSF, the FSF sends per
340 papers to sign.  If person signs them right away, the whole process
341 takes a couple of weeks---mostly waiting for letters to go back and
342 forth.
343
344 For less common cases, we have template files you should send to the
345 contributor.  Be sure to fill in the name of the person and the name
346 of the program in these templates, where it says @samp{NAME OF PERSON}
347 and @samp{NAME OF PROGRAM}, before sending; otherwise person might
348 sign without noticing them, and the papers would be useless.  Note
349 that in some templates there is more than one place to put the name of
350 the program or the name of the person; be sure to change all of them.
351 All the templates raise the issue of an employer's disclaimer as well.
352
353 @cindex legal papers for changes in manuals
354 You do not need to ask for separate papers for a manual that is
355 distributed only in the software package it describes.  But if we
356 sometimes distribute the manual separately (for instance, if we publish
357 it as a book), then we need separate legal papers for changes in the
358 manual.  For smaller changes, use
359 @file{disclaim.changes.manual}; for larger ones, use
360 @file{assign.changes.manual}.  To cover both past and future
361 changes to a manual, you can use @file{assign.future.manual}.
362 For a translation of a manual, use @file{assign.translation.manual}.
363
364 For translations of program strings (as used by GNU Gettext, for
365 example; @pxref{Internationalization,,,standards,GNU Coding
366 Standards}), use @file{disclaim.translation}.  If you make use of the
367 Translation Project (@url{http://translationproject.org}) facilities,
368 please check with the TP coordinators that they have sent the
369 contributor the papers; if they haven't, then you should send the
370 papers.  In any case, you should wait for the confirmation from the
371 FSF that the signed papers have been received and accepted before
372 integrating the new contributor's material, as usual.
373
374 If a contributor is reluctant to sign an assignment for a large change,
375 and is willing to sign a disclaimer instead, that is acceptable, so you
376 should offer this alternative if it helps you reach agreement.  We
377 prefer an assignment for a larger change, so that we can enforce the GNU
378 GPL for the new text, but a disclaimer is enough to let us use the text.
379
380 If you maintain a collection of programs, occasionally someone will
381 contribute an entire separate program or manual that should be added to
382 the collection.  Then you can use the files
383 @file{request-assign.program}, @file{disclaim.program},
384 @file{assign.manual}, and @file{disclaim.manual}.  We very much prefer
385 an assignment for a new separate program or manual, unless it is quite
386 small, but a disclaimer is acceptable if the contributor insists on
387 handling the matter that way.
388
389 If a contributor wants the FSF to publish only a pseudonym, that is
390 ok.  The contributor should say this, and state the desired pseudonym,
391 when answering the @file{request-} form.  The actual legal papers will
392 use the real name, but the FSF will publish only the pseudonym.  When
393 using one of the other forms, fill in the real name but ask the
394 contributor to discuss the use of a pseudonym with
395 @email{assign@@gnu.org} before sending back the signed form.
396
397 @strong{Although there are other templates besides the ones listed here,
398 they are for special circumstances; please do not use them without
399 getting advice from @email{assign@@gnu.org}.}
400
401 If you are not sure what to do, then please ask @email{assign@@gnu.org} for
402 advice; if the contributor asks you questions about the meaning and
403 consequences of the legal papers, and you don't know the answers, you
404 can forward them to @email{assign@@gnu.org} and we will answer.
405
406 @strong{Please do not try changing the wording of a template yourself.
407 If you think a change is needed, please talk with @email{assign@@gnu.org},
408 and we will work with a lawyer to decide what to do.}
409
410 @node Legally Significant
411 @section Legally Significant Changes
412
413 If a person contributes more than around 15 lines of code and/or text
414 that is legally significant for copyright purposes, we
415 need copyright papers for that contribution, as described above.
416
417 A change of just a few lines (less than 15 or so) is not legally
418 significant for copyright.  A regular series of repeated changes, such
419 as renaming a symbol, is not legally significant even if the symbol
420 has to be renamed in many places.  Keep in mind, however, that a
421 series of minor changes by the same person can add up to a significant
422 contribution.  What counts is the total contribution of the person; it
423 is irrelevant which parts of it were contributed when.
424
425 Copyright does not cover ideas.  If someone contributes ideas but no
426 text, these ideas may be morally significant as contributions, and
427 worth giving credit for, but they are not significant for copyright
428 purposes.  Likewise, bug reports do not count for copyright purposes.
429
430 When giving credit to people whose contributions are not legally
431 significant for copyright purposes, be careful to make that fact
432 clear.  The credit should clearly say they did not contribute
433 significant code or text.
434
435 When people's contributions are not legally significant because they
436 did not write code, do this by stating clearly what their contribution
437 was.  For instance, you could write this:
438
439 @example
440 /*
441  * Ideas by:
442  *   Richard Mlynarik <mly@@adoc.xerox.com> (1997)
443  *   Masatake Yamato <masata-y@@is.aist-nara.ac.jp> (1999)
444  */
445 @end example
446
447 @noindent
448 @code{Ideas by:} makes it clear that Mlynarik and Yamato here
449 contributed only ideas, not code.  Without the @code{Ideas by:} note,
450 several years from now we would find it hard to be sure whether they
451 had contributed code, and we might have to track them down and ask
452 them.
453
454 When you record a small patch in a change log file, first search for
455 previous changes by the same person, and see if per past
456 contributions, plus the new one, add up to something legally
457 significant.  If so, you should get copyright papers for all per
458 changes before you install the new change.
459
460 If that is not so, you can install the small patch.  Write @samp{(tiny
461 change)} after the patch author's name, like this:
462
463 @example
464 2002-11-04  Robert Fenk  <Robert.Fenk@@gmx.de>  (tiny change)
465 @end example
466
467 @node Recording Contributors
468 @section Recording Contributors
469 @cindex recording contributors
470
471 @strong{Keep correct records of which portions were written by whom.}
472 This is very important.  These records should say which files or
473 parts of files were written by each person, and which files or
474 parts of files were revised by each person.  This should include
475 installation scripts as well as manuals and documentation
476 files---everything.
477
478 These records don't need to be as detailed as a change log.  They
479 don't need to distinguish work done at different times, only different
480 people.  They don't need describe changes in more detail than which
481 files or parts of a file were changed.  And they don't need to say
482 anything about the function or purpose of a file or change---the
483 Register of Copyrights doesn't care what the text does, just who wrote
484 or contributed to which parts.
485
486 The list should also mention if certain files distributed in the same
487 package are really a separate program.
488
489 Only the contributions that are legally significant for copyright
490 purposes (@pxref{Legally Significant}) need to be listed.  Small
491 contributions, bug reports, ideas, etc., can be omitted.
492
493 For example, this would describe an early version of GAS:
494
495 @display
496 Dean Elsner   first version of all files except gdb-lines.c and m68k.c.
497 Jay Fenlason  entire files gdb-lines.c and m68k.c, most of app.c,
498               plus extensive changes in messages.c, input-file.c, write.c
499               and revisions elsewhere.
500
501 Note: GAS is distributed with the files obstack.c and obstack.h, but
502 they are considered a separate package, not part of GAS proper.
503 @end display
504
505 @cindex @file{AUTHORS} file
506 Please keep these records in a file named @file{AUTHORS} in the source
507 directory for the program itself.
508
509 You can use the change log as the basis for these records, if you
510 wish.  Just make sure to record the correct author for each change
511 (the person who wrote the change, @emph{not} the person who installed
512 it), and add @samp{(tiny change)} for those changes that are too
513 trivial to matter for copyright purposes.  Later on you can update the
514 @file{AUTHORS} file from the change log.  This can even be done
515 automatically, if you are careful about the formatting of the change
516 log entries.
517
518 @node Copying from Other Packages
519 @section Copying from Other Packages
520
521 When you copy legally significant code from another free software
522 package with a GPL-compatible license, you should look in the
523 package's records to find out the authors of the part you are copying,
524 and list them as the contributors of the code that you copied.  If all
525 you did was copy it, not write it, then for copyright purposes you are
526 @emph{not} one of the contributors of @emph{this} code.
527
528 Especially when code has been released into the public domain, authors
529 sometimes fail to write a license statement in each file.  In this
530 case, please first be sure that all the authors of the code have
531 disclaimed copyright interest.  Then, when copying the new files into
532 your project, add a brief note at the beginning of the files recording
533 the authors, the public domain status, and anything else relevant.
534
535 On the other hand, when merging some public domain code into an
536 existing file covered by the GPL (or LGPL or other free software
537 license), there is no reason to indicate the pieces which are public
538 domain.  The notice saying that the whole file is under the GPL (or
539 other license) is legally sufficient.
540
541 Using code that is released under a GPL-compatible free license,
542 rather than being in the public domain, may require preserving
543 copyright notices or other steps.  Of course, you should do what is
544 needed.
545
546 If you are maintaining an FSF-copyrighted package, please verify we
547 have papers for the code you are copying, @emph{before} copying it.
548 If you are copying from another FSF-copyrighted package, then we
549 presumably have papers for that package's own code, but you must check
550 whether the code you are copying is part of an external library; if
551 that is the case, we don't have papers for it, so you should not copy
552 it.  It can't hurt in any case to double-check with the developer of
553 that package.
554
555 When you are copying code for which we do not already have papers, you
556 need to get papers for it.  It may be difficult to get the papers if
557 the code was not written as a contribution to your package, but that
558 doesn't mean it is ok to do without them.  If you cannot get papers
559 for the code, you can only use it as an external library
560 (@pxref{External Libraries}).
561
562
563 @node Copyright Notices
564 @section Copyright Notices
565 @cindex copyright notices in program files
566
567 You should maintain a proper copyright notice and a license
568 notice in each nontrivial file in the package.  (Any file more than ten
569 lines long is nontrivial for this purpose.)  This includes header files
570 and interface definitions for
571 building or running the program, documentation files, and any supporting
572 files.  If a file has been explicitly placed in the public domain, then
573 instead of a copyright notice, it should have a notice saying explicitly
574 that it is in the public domain.
575
576 Even image files and sound files should contain copyright notices and
577 license notices, if their format permits.  Some formats do not have
578 room for textual annotations; for these files, state the copyright and
579 copying permissions in a @file{README} file in the same directory.
580
581 Change log files should have a copyright notice and license notice at
582 the end, since new material is added at the beginning but the end
583 remains the end.
584
585 When a file is automatically generated from some other file in the
586 distribution, it is useful for the automatic procedure to copy the
587 copyright notice and permission notice of the file it is generated
588 from, if possible.  Alternatively, put a notice at the beginning saying
589 which file it is generated from.
590
591 A copyright notice looks like this:
592
593 @example
594 Copyright (C) @var{year1}, @var{year2}, @var{year3} @var{copyright-holder}
595 @end example
596
597 The word @samp{Copyright} must always be in English, by international
598 convention.
599
600 The @var{copyright-holder} may be the Free Software Foundation, Inc., or
601 someone else; you should know who is the copyright holder for your
602 package.
603
604 Replace the @samp{(C)} with a C-in-a-circle symbol if it is available.
605 For example, use @samp{@@copyright@{@}} in a Texinfo file.  However,
606 stick with parenthesized @samp{C} unless you know that C-in-a-circle
607 will work.  For example, a program's standard @option{--version}
608 message should use parenthesized @samp{C} by default, though message
609 translations may use C-in-a-circle in locales where that symbol is
610 known to work.  Alternatively, the @samp{(C)} or C-in-a-circle can be
611 omitted entirely; the word @samp{Copyright} suffices.
612
613 To update the list of year numbers, add each year in which you have
614 made nontrivial changes to the package.  (Here we assume you're using
615 a publicly accessible revision control server, so that every revision
616 installed is also immediately and automatically published.)  When you
617 add the new year, it is not required to keep track of which files have
618 seen significant changes in the new year and which have not.  It is
619 recommended and simpler to add the new year to all files in the
620 package, and be done with it for the rest of the year.
621
622 Don't delete old year numbers, though; they are significant since they
623 indicate when older versions might theoretically go into the public
624 domain, if the movie companies don't continue buying laws to further
625 extend copyright.  If you copy a file into the package from some other
626 program, keep the copyright years that come with the file.
627
628 You can use a range (@samp{2008-2010}) instead of listing individual
629 years (@samp{2008, 2009, 2010}) if and only if: 1)@tie{}every year in
630 the range, inclusive, really is a ``copyrightable'' year that would be
631 listed individually; @emph{and} 2)@tie{}you make an explicit statement
632 in a @file{README} file about this usage.
633
634 For files which are regularly copied from another project (such as
635 @samp{gnulib}), leave the copyright notice as it is in the original.
636
637 The copyright statement may be split across multiple lines, both in
638 source files and in any generated output.  This often happens for
639 files with a long history, having many different years of
640 publication.
641
642 For an FSF-copyrighted package, if you have followed the procedures to
643 obtain legal papers, each file should have just one copyright holder:
644 the Free Software Foundation, Inc.  You should edit the file's
645 copyright notice to list that name and only that name.
646
647 But if contributors are not all assigning their copyrights to a single
648 copyright holder, it can easily happen that one file has several
649 copyright holders.  Each contributor of nontrivial text is a copyright
650 holder.
651
652 In that case, you should always include a copyright notice in the name
653 of main copyright holder of the file.  You can also include copyright
654 notices for other copyright holders as well, and this is a good idea
655 for those who have contributed a large amount and for those who
656 specifically ask for notices in their names.  (Sometimes the license
657 on code that you copy in may require preserving certain copyright
658 notices.)  But you don't have to include a notice for everyone who
659 contributed to the file (which would be rather inconvenient).
660
661 Sometimes a program has an overall copyright notice that refers to the
662 whole program.  It might be in the @file{README} file, or it might be
663 displayed when the program starts up.  This copyright notice should
664 mention the year of completion of the most recent major version; it
665 can mention years of completion of previous major versions, but that
666 is optional.
667
668
669 @node License Notices
670 @section License Notices
671 @cindex license notices in program files
672
673 Every nontrivial file needs a license notice as well as the copyright
674 notice.  (Without a license notice giving permission to copy and
675 change the file, the file is non-free.)
676
677 The package itself should contain a full copy of GPL in plain text
678 (conventionally in a file named @file{COPYING}) and the GNU Free
679 Documentation License (included within your documentation, so there is
680 no need for a separate plain text version).  If the package contains
681 any files distributed under the Lesser GPL, it should contain a full
682 copy of its plain text version also (conventionally in a file named
683 @file{COPYING.LESSER}).
684
685 If you have questions about license issues for your GNU package,
686 please write @email{licensing@@gnu.org}.
687
688 @menu
689 * Source: Canonical License Sources.
690 * Code: License Notices for Code.
691 * Documentation: License Notices for Documentation.
692 * Other: License Notices for Other Files.
693 @end menu
694
695
696 @node Canonical License Sources
697 @subsection Canonical License Sources
698
699 You can get the official versions of these files from several places.
700 You can use whichever is the most convenient for you.
701
702 @itemize @bullet
703 @item
704 @uref{http://www.gnu.org/licenses/}.
705
706 @item
707 The @code{gnulib} project on @code{savannah.gnu.org}, which you
708 can access via anonymous Git or CVS.  See
709 @uref{http://savannah.gnu.org/projects/gnulib}.
710
711 @end itemize
712
713 The official Texinfo sources for the licenses are also available in
714 those same places, so you can include them in your documentation.  A
715 GFDL-covered manual should include the GFDL in this way.  @xref{GNU
716 Sample Texts,,,texinfo,Texinfo}, for a full example in a Texinfo
717 manual.
718
719
720 @node License Notices for Code
721 @subsection License Notices for Code
722
723 Typically the license notice for program files (including build scripts,
724 configure files and makefiles) should cite the GPL, like this:
725
726 @quotation
727 This file is part of GNU @var{program}.
728
729 GNU @var{program} is free software: you can redistribute it and/or
730 modify it under the terms of the GNU General Public License as
731 published by the Free Software Foundation, either version 3 of the
732 License, or (at your option) any later version.
733
734 GNU @var{program} is distributed in the hope that it will be useful,
735 but WITHOUT ANY WARRANTY; without even the implied warranty of
736 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
737 GNU General Public License for more details.
738
739 You should have received a copy of the GNU General Public License
740 along with this program.  If not, see @url{http://www.gnu.org/licenses/}.
741 @end quotation
742
743 But in a small program which is just a few files, you can use
744 this instead:
745
746 @quotation
747 This program is free software: you can redistribute it and/or modify
748 it under the terms of the GNU General Public License as published by
749 the Free Software Foundation; either version 3 of the License, or
750 (at your option) any later version.
751
752 This program is distributed in the hope that it will be useful,
753 but WITHOUT ANY WARRANTY; without even the implied warranty of
754 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
755 GNU General Public License for more details.
756
757 You should have received a copy of the GNU General Public License
758 along with this program.  If not, see @url{http://www.gnu.org/licenses/}.
759 @end quotation
760
761
762 @node License Notices for Documentation
763 @subsection License Notices for Documentation
764
765 Documentation files should have license notices also.  Manuals should
766 use the GNU Free Documentation License.  Following is an example of the
767 license notice to use after the copyright line(s) using all the
768 features of the GFDL.
769
770 @smallexample
771 Permission is granted to copy, distribute and/or modify this document
772 under the terms of the GNU Free Documentation License, Version 1.3 or
773 any later version published by the Free Software Foundation; with the
774 Invariant Sections being ``GNU General Public License'', with the
775 Front-Cover Texts being ``A GNU Manual'', and with the Back-Cover Texts
776 as in (a) below.  A copy of the license is included in the section
777 entitled ``GNU Free Documentation License''.
778
779 (a) The FSF's Back-Cover Text is: ``You have the freedom to
780 copy and modify this GNU manual.  Buying copies from the FSF
781 supports it in developing GNU and promoting software freedom.''
782 @end smallexample
783
784 If the FSF does not publish this manual on paper, then omit the last
785 sentence in (a) that talks about copies from GNU Press.  If the FSF is
786 not the copyright holder, then replace @samp{FSF} with the appropriate
787 name.
788
789 Please adjust the list of invariant sections as appropriate for your
790 manual.  If there are none, then say ``with no Invariant Sections''.
791 If your manual is not published by the FSF, and under 400 pages, you
792 can omit both cover texts.
793
794 @xref{GNU Sample Texts,,,texinfo,Texinfo}, for a full example in a
795 Texinfo manual, and see
796 @url{http://www.gnu.org/licenses/fdl-howto.html} for more advice about
797 how to use the GNU FDL.
798
799 If the manual is over 400 pages, or if the FSF thinks it might be a
800 good choice for publishing on paper, then please include the GNU GPL,
801 as in the notice above.  Please also include our standard invariant
802 section which explains the importance of free documentation.  Write to
803 @email{assign@@gnu.org} to get a copy of this section.
804
805 When you distribute several manuals together in one software package,
806 their on-line forms can share a single copy of the GFDL (see
807 section@tie{}6).  However, the printed (@samp{.dvi}, @samp{.pdf},
808 @dots{}) forms should each contain a copy of the GFDL, unless they are
809 set up to be printed and published only together.  Therefore, it is
810 usually simplest to include the GFDL in each manual.
811
812
813 @node License Notices for Other Files
814 @subsection License Notices for Other Files
815
816 Small supporting files, short manuals (under 300 lines long) and rough
817 documentation (@file{README} files, @file{INSTALL} files, etc.)@: can
818 use a simple all-permissive license like this one:
819
820 @smallexample
821 Copying and distribution of this file, with or without modification,
822 are permitted in any medium without royalty provided the copyright
823 notice and this notice are preserved.  This file is offered as-is,
824 without any warranty.
825 @end smallexample
826
827 Older versions of this license did not have the second sentence with
828 the express warranty disclaimer.  There is no urgent need to update
829 existing files, but new files should use the new text.
830
831 If your package distributes Autoconf macros that are intended to be
832 used (hence distributed) by third-party packages under possibly
833 incompatible licenses, you may also use the above all-permissive
834 license for these macros.
835
836
837 @node External Libraries
838 @section External Libraries
839
840 When maintaining an FSF-copyrighted GNU package, you may occasionally
841 want to use a general-purpose free software module which offers a
842 useful functionality, as a ``library'' facility (though the module is
843 not always packaged technically as a library).
844
845 In a case like this, it would be unreasonable to ask the author of that
846 module to assign the copyright to the FSF.  After all, person did not
847 write it specifically as a contribution to your package, so it would be
848 impertinent to ask per, out of the blue, ``Please give the FSF your
849 copyright.''
850
851 So the thing to do in this case is to make your program use the module,
852 but not consider it a part of your program.  There are two reasonable
853 methods of doing this:
854
855 @enumerate
856 @item
857 Assume the module is already installed on the system, and use it when
858 linking your program.  This is only reasonable if the module really has
859 the form of a library.
860
861 @item
862 Include the module in your package, putting the source in a separate
863 subdirectory whose @file{README} file says, ``This is not part of the
864 GNU FOO program, but is used with GNU FOO.''  Then set up your makefiles
865 to build this module and link it into the executable.
866
867 For this method, it is not necessary to treat the module as a library
868 and make a @samp{.a} file from it.  You can link with the @samp{.o}
869 files directly in the usual manner.
870 @end enumerate
871
872 Both of these methods create an irregularity, and our lawyers have told
873 us to minimize the amount of such irregularity.  So consider using these
874 methods only for general-purpose modules that were written for other
875 programs and released separately for general use.  For anything that was
876 written as a contribution to your package, please get papers signed.
877
878
879 @node Clean Ups
880 @chapter Cleaning Up Changes
881 @cindex contributions, accepting
882 @cindex quality of changes suggested by others
883
884 Don't feel obligated to include every change that someone asks you to
885 include.  You must judge which changes are improvements---partly based
886 on what you think the users will like, and partly based on your own
887 judgment of what is better.  If you think a change is not good, you
888 should reject it.
889
890 If someone sends you changes which are useful, but written in an ugly
891 way or hard to understand and maintain in the future, don't hesitate to
892 ask per to clean up their changes before you merge them.  Since the
893 amount of work we can do is limited, the more we convince others to help
894 us work efficiently, the faster GNU will advance.
895
896 If the contributor will not or can not make the changes clean enough,
897 then it is legitimate to say ``I can't install this in its present form;
898 I can only do so if you clean it up.''  Invite per to distribute per
899 changes another way, or to find other people to make them clean enough
900 for you to install and maintain.
901
902 The only reason to do these cleanups yourself is if (1) it is easy, less
903 work than telling the author what to clean up, or (2) the change is an
904 important one, important enough to be worth the work of cleaning it up.
905
906 The GNU Coding Standards are a good thing to send people when you ask
907 them to clean up changes (@pxref{Top, , Contents, standards, GNU Coding
908 Standards}).  The Emacs Lisp manual contains an appendix that gives
909 coding standards for Emacs Lisp programs; it is good to urge Lisp authors to
910 read it (@pxref{Tips, , Tips and Conventions, elisp, The GNU Emacs Lisp
911 Reference Manual}).
912
913
914 @node Platforms
915 @chapter Platforms to Support
916
917 Most GNU packages run on a wide range of platforms.  These platforms are
918 not equally important.
919
920 The most important platforms for a GNU package to support are GNU and
921 GNU/Linux.  Developing the GNU operating system is the whole point of
922 the GNU Project; a GNU package exists to make the whole GNU system more
923 powerful.  So please keep that goal in mind and let it shape your work.
924 For instance, every new feature you add should work on GNU, and
925 GNU/Linux if possible too.  If a new feature only runs on GNU and
926 GNU/Linux, it could still be acceptable.  However, a feature that runs
927 only on other systems and not on GNU or GNU/Linux makes no sense in a
928 GNU package.
929
930 You will naturally want to keep the program running on all the platforms
931 it supports.  But you personally will not have access to most of these
932 platforms---so how should you do it?
933
934 Don't worry about trying to get access to all of these platforms.  Even
935 if you did have access to all the platforms, it would be inefficient for
936 you to test the program on each platform yourself.  Instead, you should
937 test the program on a few platforms, including GNU or GNU/Linux, and let
938 the users test it on the other platforms.  You can do this through a
939 pretest phase before the real release; when there is no reason to expect
940 problems, in a package that is mostly portable, you can just make a
941 release and let the users tell you if anything unportable was
942 introduced.
943
944 It is important to test the program personally on GNU or GNU/Linux,
945 because these are the most important platforms for a GNU package.  If
946 you don't have access to one of these platforms, as a GNU maintainer
947 you can get access to the general GNU login machine; see
948 @url{http://www.gnu.org/software/README.accounts.html}.
949
950 Supporting other platforms is optional---we do it when that seems like
951 a good idea, but we don't consider it obligatory.  If the users don't
952 take care of a certain platform, you may have to desupport it unless
953 and until users come forward to help.  Conversely, if a user offers
954 changes to support an additional platform, you will probably want to
955 install them, but you don't have to.  If you feel the changes are
956 complex and ugly, if you think that they will increase the burden of
957 future maintenance, you can and should reject them.  This includes
958 both free or mainly-free platforms such as OpenBSD, FreeBSD, and
959 NetBSD, and non-free platforms such as Windows.
960
961
962 @node Mail
963 @chapter Dealing With Mail
964 @cindex email
965
966 This chapter describes setting up mailing lists for your package, and
967 gives advice on how to handle bug reports and random requests once you
968 have them.
969
970 @menu
971 * Standard Mailing Lists::  @samp{bug-pkg@@gnu.org} and other standard names.
972 * Creating Mailing Lists::  The best way is to use Savannah.
973 * Replying to Mail::        Advice on replying to incoming mail.
974 @end menu
975
976
977 @node Standard Mailing Lists
978 @section Standard Mailing Lists
979
980 @cindex standard mailing lists
981 @cindex mailing lists, standard names of
982
983 @cindex mailing list for bug reports
984 Once a program is in use, you will get bug reports for it.  Most GNU
985 programs have their own special lists for sending bug reports.  The
986 advertised bug-reporting email address should always be
987 @samp{bug-@var{program}@@gnu.org}, to help show users that the program
988 is a GNU package, but it is ok to set up that list to forward to another
989 site if you prefer.  The package distribution should state the
990 name of the bug-reporting list in a prominent place, and ask users to
991 help us by reporting bugs there.
992
993 @cindex @email{bug-gnu-utils@@gnu.org}
994 We also have a catch-all list, @email{bug-gnu-utils@@gnu.org}, which is
995 used for all GNU programs that don't have their own specific lists.  But
996 nowadays we want to give each program its own bug-reporting list and
997 move away from using @email{bug-gnu-utils}.
998
999 @cindex help for users, mailing list for
1000 Some GNU programs with many users have another mailing list,
1001 @samp{help-@var{program}.org}, for people to ask other users for help.
1002 If your program has many users, you should create such a list for it.
1003 For a fairly new program, which doesn't have a large user base yet, it
1004 is better not to bother with this.
1005
1006 @cindex announcements, mailing list for
1007 If you wish, you can also have a mailing list
1008 @samp{info-@var{program}} for announcements (@pxref{Announcements}),
1009 and any others you find useful.
1010
1011
1012 @node Creating Mailing Lists
1013 @section Creating Mailing Lists
1014
1015 @cindex creating mailing lists
1016 @cindex mailing lists, creating
1017
1018 Using the web interface on @code{savannah.gnu.org} is by far the
1019 easiest way to create normal mailing lists, managed through Mailman on
1020 the GNU mail server.  Once you register your package on Savannah, you
1021 can create (and remove) lists yourself through the `Mailing Lists'
1022 menu, without needing to wait for intervention by anyone else.
1023 Furthermore, lists created through Savannah will have a reasonable
1024 default configuration for antispam purposes (see below).
1025
1026 To create and maintain simple aliases and unmanaged lists, you can
1027 edit @file{/com/mailer/aliases} on the main GNU server.  If you don't
1028 have an account there, please read
1029 @url{http://www.gnu.org/software/README.accounts.html} (@pxref{Getting
1030 a GNU Account}).
1031
1032 But if you don't want to learn how to do those things, you can
1033 alternatively ask @email{alias-file@@gnu.org} to add you to the
1034 bug-reporting list for your program.  To set up a new list, contact
1035 @email{new-mailing-list@@gnu.org}.  You can subscribe to a list managed
1036 by Mailman by sending mail to the corresponding @samp{-request} address.
1037
1038 @cindex spam prevention
1039 You should moderate postings from non-subscribed addresses on your
1040 mailing lists, to prevent propagation of unwanted messages (``spam'')
1041 to subscribers and to the list archives.  For lists controlled by
1042 Mailman, you can do this by setting @code{Privacy Options - Sender
1043 Filter - generic_nonmember_action} to @code{Hold}, and then
1044 periodically (daily is best) reviewing the held messages, accepting
1045 the real ones and discarding the junk.
1046
1047 Lists created through Savannah will have this setting, and a number of
1048 others, such that spam will be automatically deleted (after a short
1049 delay).  The Savannah mailing list page describes all the details.
1050 You should still review the held messages in order to approve any that
1051 are real.
1052
1053
1054 @node Replying to Mail
1055 @section Replying to Mail
1056
1057 @cindex responding to bug reports
1058 @cindex bug reports, handling
1059 @cindex help requests, handling
1060
1061 When you receive bug reports, keep in mind that bug reports are crucial
1062 for your work.  If you don't know about problems, you cannot fix them.
1063 So always thank each person who sends a bug report.
1064
1065 You don't have an obligation to give more response than that, though.
1066 The main purpose of bug reports is to help you contribute to the
1067 community by improving the next version of the program.  Many of the
1068 people who report bugs don't realize this---they think that the point is
1069 for you to help them individually.  Some will ask you to focus on that
1070 @emph{instead of} on making the program better.  If you comply with
1071 their wishes, you will have been distracted from the job of maintaining
1072 the program.
1073
1074 For example, people sometimes report a bug in a vague (and therefore
1075 useless) way, and when you ask for more information, they say, ``I just
1076 wanted to see if you already knew the solution'' (in which case the bug
1077 report would do nothing to help improve the program).  When this
1078 happens, you should explain to them the real purpose of bug reports.  (A
1079 canned explanation will make this more efficient.)
1080
1081 When people ask you to put your time into helping them use the program,
1082 it may seem ``helpful'' to do what they ask.  But it is much @emph{less}
1083 helpful than improving the program, which is the maintainer's real job.
1084
1085 By all means help individual users when you feel like it, if you feel
1086 you have the time available.  But be careful to limit the amount of time
1087 you spend doing this---don't let it eat away the time you need to
1088 maintain the program!  Know how to say no; when you are pressed for
1089 time, just ``thanks for the bug report---I will fix it'' is enough
1090 response.
1091
1092 Some GNU packages, such as Emacs and GCC, come with advice about how
1093 to make bug reports useful.  Copying and adapting that could be very
1094 useful for your package.
1095
1096
1097 @node Old Versions
1098 @chapter Recording Old Versions
1099 @cindex version control
1100
1101 It is very important to keep backup files of all source files of GNU.
1102 You can do this using a source control system (such as RCS, CVS, Git,
1103 @dots{}) if you like.  The easiest way to use RCS or CVS is via the
1104 Version Control library in Emacs (@pxref{VC Concepts,, Concepts of
1105 Version Control, emacs, The GNU Emacs Manual}).
1106
1107 The history of previous revisions and log entries is very important for
1108 future maintainers of the package, so even if you do not make it
1109 publicly accessible, be careful not to put anything in the repository or
1110 change log that you would not want to hand over to another maintainer
1111 some day.
1112
1113 @cindex @code{savannah-hackers@@gnu.org}
1114 The GNU Project provides a server that GNU software packages can use
1115 for source control and other package needs: @code{savannah.gnu.org}.
1116 You don't have to use this repository, but if you plan to allow public
1117 read-only access to your development sources, it is convenient for
1118 people to be able to find various GNU packages in a central place.
1119 Savannah is managed by @email{savannah-hackers@@gnu.org}.
1120
1121 All GNU maintainers are strongly encouraged to take advantage of
1122 Savannah, as sharing such a central point can serve to foster a sense
1123 of community among GNU developers and help in keeping up with project
1124 management.
1125
1126 @cindex @code{savannah-announce@@gnu.org} mailing list
1127 If you do use Savannah, please subscribe to the
1128 @email{savannah-announce@@gnu.org} mailing list
1129 (@url{http://lists.gnu.org/mailman/listinfo/savannah-announce}).  This
1130 is a very low-volume list to keep Savannah users informed of system
1131 upgrades, problems, and the like.
1132
1133
1134 @node Distributions
1135 @chapter Distributions
1136
1137 It is important to follow the GNU conventions when making GNU software
1138 distributions.
1139
1140 @menu
1141 * Distribution tar Files::
1142 * Distribution Patches::
1143 * Distribution on ftp.gnu.org::
1144 * Test Releases::
1145 * Automated FTP Uploads::
1146 * Announcements::
1147 @end menu
1148
1149 @node Distribution tar Files
1150 @section Distribution tar Files
1151 @cindex distribution, tar files
1152
1153 The tar file for version @var{m}.@var{n} of program @code{foo} should be
1154 named @file{foo-@var{m}.@var{n}.tar}.  It should unpack into a
1155 subdirectory named @file{foo-@var{m}.@var{n}}.  Tar files should not
1156 unpack into files in the current directory, because this is inconvenient
1157 if the user happens to unpack into a directory with other files in it.
1158
1159 Here is how the @file{Makefile} for Bison creates the tar file.
1160 This method is good for other programs.
1161
1162 @example
1163 dist: bison.info
1164         echo bison-`sed -e '/version_string/!d' \
1165           -e 's/[^0-9.]*\([0-9.]*\).*/\1/' -e q version.c` > .fname
1166         -rm -rf `cat .fname`
1167         mkdir `cat .fname`
1168         dst=`cat .fname`; for f in $(DISTFILES); do \
1169            ln $(srcdir)/$$f $$dst/$$f || @{ echo copying $$f; \
1170              cp -p $(srcdir)/$$f $$dst/$$f ; @} \
1171         done
1172         tar --gzip -chf `cat .fname`.tar.gz `cat .fname`
1173         -rm -rf `cat .fname` .fname
1174 @end example
1175
1176 Source files that are symbolic links to other file systems cannot be
1177 installed in the temporary directory using @code{ln}, so use @code{cp}
1178 if @code{ln} fails.
1179
1180 @pindex automake
1181 Using Automake is a good way to take care of writing the @code{dist}
1182 target.
1183
1184 @node Distribution Patches
1185 @section Distribution Patches
1186 @cindex patches, against previous releases
1187
1188 If the program is large, it is useful to make a set of diffs for each
1189 release, against the previous important release.
1190
1191 At the front of the set of diffs, put a short explanation of which
1192 version this is for and which previous version it is relative to.
1193 Also explain what else people need to do to update the sources
1194 properly (for example, delete or rename certain files before
1195 installing the diffs).
1196
1197 The purpose of having diffs is that they are small.  To keep them
1198 small, exclude files that the user can easily update.  For example,
1199 exclude info files, DVI files, tags tables, output files of Bison or
1200 Flex.  In Emacs diffs, we exclude compiled Lisp files, leaving it up
1201 to the installer to recompile the patched sources.
1202
1203 When you make the diffs, each version should be in a directory suitably
1204 named---for example, @file{gcc-2.3.2} and @file{gcc-2.3.3}.  This way,
1205 it will be very clear from the diffs themselves which version is which.
1206
1207 @pindex diff
1208 @pindex patch
1209 @cindex time stamp in diffs
1210 If you use GNU @code{diff} to make the patch, use the options
1211 @samp{-rc2P}.  That will put any new files into the output as ``entirely
1212 different.''  Also, the patch's context diff headers should have dates
1213 and times in Universal Time using traditional Unix format, so that patch
1214 recipients can use GNU @code{patch}'s @samp{-Z} option.  For example,
1215 you could use the following Bourne shell command to create the patch:
1216
1217 @example
1218 LC_ALL=C TZ=UTC0 diff -rc2P gcc-2.3.2 gcc-2.3.3 | \
1219 gzip -9 >gcc-2.3.2-2.3.3.patch.gz
1220 @end example
1221
1222 If the distribution has subdirectories in it, then the diffs probably
1223 include some files in the subdirectories.  To help users install such
1224 patches reliably, give them precise directions for how to run patch.
1225 For example, say this:
1226
1227 @display
1228 To apply these patches, cd to the main directory of the program
1229 and then use `patch -p1'.   `-p1' avoids guesswork in choosing
1230 which subdirectory to find each file in.
1231 @end display
1232
1233 It's wise to test your patch by applying it to a copy of the old
1234 version, and checking that the result exactly matches the new version.
1235
1236 @node Distribution on ftp.gnu.org
1237 @section Distribution on @code{ftp.gnu.org}
1238 @cindex GNU ftp site
1239 @cindex @code{ftp.gnu.org}, the GNU release site
1240
1241 GNU packages are distributed through the directory @file{/gnu} on
1242 @code{ftp.gnu.org}, via both HTTP and FTP.  Each package should have a
1243 subdirectory named after the package, and all the distribution files
1244 for the package should go in that subdirectory.
1245
1246 @c If you have an interest in seeing the monthly download logs from the FTP
1247 @c site at @code{ftp.gnu.org} for your program, that is something that
1248 @c @email{ftp-upload@@gnu.org} can set up for you.  Please contact them if
1249 @c you are interested.
1250
1251 @xref{Automated FTP Uploads}, for procedural details of putting new
1252 versions on @code{ftp.gnu.org}.
1253
1254 @node Test Releases
1255 @section Test Releases
1256 @cindex test releases
1257 @cindex beta releases
1258 @cindex pretest releases
1259
1260 @cindex @code{alpha.gnu.org}, test release site
1261 When you release a greatly changed new major version of a program, you
1262 might want to do so as a pretest.  This means that you make a tar file,
1263 but send it only to a group of volunteers that you have recruited.  (Use
1264 a suitable GNU mailing list/newsgroup to recruit them.)
1265
1266 We normally use the server @code{alpha.gnu.org} for pretests and
1267 prerelease versions.  @xref{Automated FTP Uploads}, for procedural details
1268 of putting new versions on @code{alpha.gnu.org}.
1269
1270 Once a program gets to be widely used and people expect it to work
1271 solidly, it is a good idea to do pretest releases before each ``real''
1272 release.
1273
1274 There are two ways of handling version numbers for pretest versions.
1275 One method is to treat them as versions preceding the release you are going
1276 to make.
1277
1278 In this method, if you are about to release version 4.6 but you want
1279 to do a pretest first, call it 4.5.90.  If you need a second pretest,
1280 call it 4.5.91, and so on.  If you are really unlucky and ten pretests
1281 are not enough, after 4.5.99 you could advance to 4.5.990 and so on.
1282 (You could also use 4.5.100, but 990 has the advantage of sorting in
1283 the right order.)
1284
1285 The other method is to attach a date to the release number that is
1286 coming.  For a pretest for version 4.6, made on Dec 10, 2002, this
1287 would be 4.6.20021210.  A second pretest made the same day could be
1288 4.6.20021210.1.
1289
1290 For development snapshots that are not formal pretests, using just
1291 the date without the version numbers is ok too.
1292
1293 One thing that you should never do is to release a pretest with the same
1294 version number as the planned real release.  Many people will look only
1295 at the version number (in the tar file name, in the directory name that
1296 it unpacks into, or wherever they can find it) to determine whether a
1297 tar file is the latest version.  People might look at the test release
1298 in this way and mistake it for the real release.  Therefore, always
1299 change the number when you release changed code.
1300
1301
1302 @node Automated FTP Uploads
1303 @section Automated FTP Uploads
1304
1305 @cindex ftp uploads, automated
1306 In order to upload new releases to @code{ftp.gnu.org} or
1307 @code{alpha.gnu.org}, you first need to register the necessary
1308 information.  Then, you can perform uploads yourself, with no
1309 intervention needed by the system administrators.
1310
1311 The general idea is that releases should be crytographically signed
1312 before they are made publicly available.
1313
1314 @menu
1315 * Automated Upload Registration::
1316 * Automated Upload Procedure::
1317 * FTP Upload Directive File - v1.1::
1318 * FTP Upload Directive File - v1.0::
1319 @end menu
1320
1321
1322 @node Automated Upload Registration
1323 @subsection Automated Upload Registration
1324
1325 @cindex registration for uploads
1326 @cindex uploads, registration for
1327
1328 Here is how to register your information so you can perform uploads
1329 for your GNU package:
1330
1331 @enumerate
1332
1333 @item
1334 Create an account for yourself at @url{http://savannah.gnu.org}, if
1335 you don't already have one.  By the way, this is also needed to
1336 maintain the web pages at @url{http://www.gnu.org} for your project
1337 (@pxref{Web Pages}).
1338
1339 @item
1340 In the @samp{My Account Conf} page on @code{savannah}, upload the GPG
1341 key you will use to sign your packages.
1342
1343 You can create a key with the command @code{gpg --gen-key}.  It is
1344 good to also send your key to the GPG public key server: @code{gpg
1345 --keyserver keys.gnupg.net --send-keys @var{keyid}}, where @var{keyid}
1346 is the eight hex digits reported by @code{gpg --list-public-keys} on
1347 the @code{pub} line before the date.  For full information about GPG,
1348 see @url{http://www.gnu.org/software/gpg})
1349
1350 @item
1351 Compose a message with the following items in some @var{msgfile}.
1352 Then GPG-sign it by running @code{gpg --clearsign @var{msgfile}}, and
1353 finally email the resulting @file{@var{msgfile}.asc}), to
1354 @email{ftp-upload@@gnu.org}.
1355
1356 @enumerate
1357 @item
1358 Name of package(s) that you are the maintainer for, and your
1359 preferred email address.
1360
1361 @item
1362 An ASCII armored copy of your GnuPG key, as an attachment.  (@samp{gpg
1363 --export -a @var{your_key_id} >mykey.asc} should give you this.)
1364
1365 @item
1366 A list of names and preferred email addresses of other individuals you
1367 authorize to make releases for which packages, if any (in the case that you
1368 don't make all releases yourself).
1369
1370 @item
1371 ASCII armored copies of GnuPG keys for any individuals listed in (3).
1372 @end enumerate
1373 @end enumerate
1374
1375 The administrators will acknowledge your message when they have added
1376 the proper GPG keys as authorized to upload files for the
1377 corresponding packages.
1378
1379 The upload system will email receipts to the given email addresses
1380 when an upload is made, either successfully or unsuccessfully.
1381
1382
1383 @node Automated Upload Procedure
1384 @subsection Automated Upload Procedure
1385
1386 @cindex uploads
1387
1388 Once you have registered your information as described in the previous
1389 section, you will be able to do ftp uploads for yourself using the
1390 following procedure.
1391
1392 For each upload destined for @code{ftp.gnu.org} or
1393 @code{alpha.gnu.org}, three files (a @dfn{triplet}) need to be
1394 uploaded via ftp to the host @code{ftp-upload.gnu.org}.
1395
1396 @enumerate
1397 @item
1398 The file to be distributed; for example, @file{foo.tar.gz}.
1399
1400 @item
1401 Detached GPG binary signature file for (1); for example,
1402 @file{foo.tar.gz.sig}.  Make this with @samp{gpg -b foo.tar.gz}.
1403
1404 @item
1405 A clearsigned @dfn{directive file}; for example,
1406 @file{foo.tar.gz.directive.asc}.  Make this by preparing the plain
1407 text file @file{foo.tar.gz.directive} and then run @samp{gpg
1408 --clearsign foo.tar.gz.directive}.  @xref{FTP Upload Directive File -
1409 v1.1}, for the contents of the directive file.
1410 @end enumerate
1411
1412 The names of the files are important. The signature file must have the
1413 same name as the file to be distributed, with an additional
1414 @file{.sig} extension. The directive file must have the same name as
1415 the file to be distributed, with an additional @file{.directive.asc}
1416 extension. If you do not follow this naming convention, the upload
1417 @emph{will not be processed}.
1418
1419 Since v1.1 of the upload script, it is also possible to upload a
1420 clearsigned directive file on its own (no accompanying @file{.sig} or
1421 any other file) to perform certain operations on the server.
1422 @xref{FTP Upload Directive File - v1.1}, for more information.
1423
1424 Upload the file(s) via anonymous ftp to @code{ftp-upload.gnu.org}. If
1425 the upload is destined for @code{ftp.gnu.org}, place the file(s) in
1426 the @file{/incoming/ftp} directory. If the upload is destined for
1427 @code{alpha.gnu.org}, place the file(s) in the @file{/incoming/alpha}
1428 directory.
1429
1430 Uploads are processed every five minutes.  Uploads that are in
1431 progress while the upload processing script is running are handled
1432 properly, so do not worry about the timing of your upload.  Uploaded
1433 files that belong to an incomplete triplet are deleted automatically
1434 after 24 hours.
1435
1436 Your designated upload email addresses (@pxref{Automated Upload Registration})
1437 are sent a message if there are any problems processing an upload for your
1438 package. You also receive a message when your upload has been successfully
1439 processed.
1440
1441 One automated way to create and transfer the necessary files is to use
1442 the @code{gnupload} script, which is available from the
1443 @file{build-aux/} directory of the @code{gnulib} project at
1444 @url{http://savannah.gnu.org/projects/gnulib}.  @code{gnupload} can
1445 also remove uploaded files.  Run @code{gnupload --help} for a
1446 description and examples.
1447
1448 @code{gnupload} uses the @code{ncftpput} program to do the actual
1449 transfers; if you don't happen to have the @code{ncftp} package
1450 installed, the @code{ncftpput-ftp} script in the @file{build-aux/}
1451 directory of @code{gnulib} serves as a replacement which uses plain
1452 command line @code{ftp}.
1453
1454 If you have difficulties with an upload, email
1455 @email{ftp-upload@@gnu.org}.
1456
1457
1458 @node FTP Upload Directive File - v1.1
1459 @subsection FTP Upload Directive File - v1.1
1460
1461 The directive file name must end in @file{directive.asc}.
1462
1463 When part of a triplet, the directive file must always contain the
1464 directives @code{version}, @code{directory} and @code{filename}, as
1465 described. In addition, a 'comment' directive is allowed.
1466
1467 The @code{version} directive must always have the value @samp{1.1}.
1468
1469 The @code{directory} directive specifies the final destination
1470 directory where the uploaded file and its @file{.sig} companion are to
1471 be placed.
1472
1473 The @code{filename} directive must contain the name of the file to be
1474 distributed (item@tie{}(1) above).
1475
1476 For example, as part of an uploaded triplet, a
1477 @file{foo.tar.gz.directive.asc} file might contain these lines (before
1478 being gpg clearsigned):
1479
1480 @example
1481 version: 1.1
1482 directory: bar/v1
1483 filename: foo.tar.gz
1484 comment: hello world!
1485 @end example
1486
1487 This directory line indicates that @file{foo.tar.gz} and
1488 @file{foo.tar.gz.sig} are part of package @code{bar}.  If you uploaded
1489 this triplet to @file{/incoming/ftp} and the system positively
1490 authenticates the signatures, the files @file{foo.tar.gz} and
1491 @file{foo.tar.gz.sig} will be placed in the directory
1492 @file{gnu/bar/v1} of the @code{ftp.gnu.org} site.
1493
1494 The directive file can be used to create currently non-existent
1495 directory trees, as long as they are under the package directory for
1496 your package (in the example above, that is @code{bar}).
1497
1498 If you upload a file that already exists in the FTP directory, the
1499 original will simply be archived and replaced with the new upload.
1500
1501 @subheading Standalone directives
1502
1503 When uploaded by itself, the directive file must contain one or more
1504 of the directives @code{symlink}, @code{rmsymlink} or @code{archive},
1505 in addition to the obligatory @code{directory} and @code{version}
1506 directives.  A @code{filename} directive is not allowed, and a
1507 @code{comment} directive remains optional.
1508
1509 If you use more than one directive, the directives are executed in the
1510 sequence they are specified in.  If a directive results in an error,
1511 further execution of the upload is aborted.
1512
1513 Removing a symbolic link (with @code{rmsymlink}) which does not exist
1514 results in an error.  However, attempting to create a symbolic link
1515 that already exists (with @code{symlink}) is not an error.  In this
1516 case @code{symlink} behaves like the command @command{ln -s -f}: any
1517 existing symlink is removed before creating the link.  (But an
1518 existing regular file or directory is not removed.)
1519
1520 Here are a few examples.  The first removes a symlink:
1521
1522 @example
1523 version: 1.1
1524 directory: bar/v1
1525 rmsymlink: foo-latest.tgz
1526 comment: remove a symlink
1527 @end example
1528
1529 @noindent
1530 Archive an old file, taking it offline:
1531
1532 @example
1533 version: 1.1
1534 directory: bar/v1
1535 archive: foo-1.1.tar.gz
1536 comment: archive an old file; it will not be
1537 comment: available through FTP any more.
1538 @end example
1539
1540 @noindent
1541 Archive an old directory (with all contents), taking it offline:
1542
1543 @example
1544 version: 1.1
1545 directory: bar/v1
1546 archive: foo
1547 comment: archive an old directory; it and its entire
1548 comment: contents will not be available through FTP anymore
1549 @end example
1550
1551 @noindent
1552 Create a new symlink:
1553
1554 @example
1555 version: 1.1
1556 directory: bar/v1
1557 symlink: foo-1.2.tar.gz foo-latest.tgz
1558 comment: create a new symlink
1559 @end example
1560
1561 @noindent
1562 Do everything at once:
1563
1564 @example
1565 version: 1.1
1566 directory: bar/v1
1567 rmsymlink: foo-latest.tgz
1568 symlink: foo-1.2.tar.gz foo-latest.tgz
1569 archive: foo-1.1.tar.gz
1570 comment: now do everything at once
1571 @end example
1572
1573
1574 @node FTP Upload Directive File - v1.0
1575 @subsection FTP Upload Directive File - v1.0
1576
1577 @dfn{As of June 2006, the upload script is running in compatibility
1578 mode, allowing uploads with either version@tie{}1.1 or
1579 version@tie{}1.0 of the directive file syntax.  Support for v1.0
1580 uploads will be phased out by the end of 2006, so please upgrade
1581 to@tie{}v1.1.}
1582
1583 The directive file should contain one line, excluding the clearsigned
1584 data GPG that inserts, which specifies the final destination directory
1585 where items (1) and (2) are to be placed.
1586
1587 For example, the @file{foo.tar.gz.directive.asc} file might contain the
1588 single line:
1589
1590 @example
1591 directory: bar/v1
1592 @end example
1593
1594 This directory line indicates that @file{foo.tar.gz} and
1595 @file{foo.tar.gz.sig} are part of package @code{bar}.  If you were to
1596 upload the triplet to @file{/incoming/ftp}, and the system can
1597 positively authenticate the signatures, then the files
1598 @file{foo.tar.gz} and @file{foo.tar.gz.sig} will be placed in the
1599 directory @file{gnu/bar/v1} of the @code{ftp.gnu.org} site.
1600
1601 The directive file can be used to create currently non-existent
1602 directory trees, as long as they are under the package directory for
1603 your package (in the example above, that is @code{bar}).
1604
1605
1606 @node Announcements
1607 @section Announcing Releases
1608 @cindex announcements
1609
1610 @cindex @code{info-gnu} mailing list
1611 When you have a new release, please make an announcement.  For
1612 official new releases, including those made just to fix bugs, we
1613 strongly recommend using the (moderated) general GNU announcements
1614 list, @email{info-gnu@@gnu.org}.  Doing so makes it easier for users
1615 and developers to find the latest GNU releases.  On the other hand,
1616 please do not announce test releases on @code{info-gnu} unless it's a
1617 highly unusual situation.
1618
1619 @cindex @url{http://planet.gnu.org}
1620 @cindex Savannah, news area
1621 Please also post release announcements in the news section of your
1622 Savannah project site.  Here, it is fine to also write news entries
1623 for test releases and any other newsworthy events.  The news feeds
1624 from all GNU projects at savannah are aggregated at
1625 @url{http://planet.gnu.org} (GNU Planet).  You can also post items
1626 directly, or arrange for feeds from other locations; see information
1627 on the GNU Planet web page.
1628
1629 @cindex announcement mailing list, project-specific
1630 You can maintain your own mailing list (typically
1631 @email{info-@var{program}@@gnu.org}) for announcements as well if you
1632 like.  For your own list, of course you decide as you see fit what
1633 events are worth announcing.  (@xref{Mail}, for setting this up, and
1634 more suggestions on handling mail for your package.)
1635
1636 @cindex contents of announcements
1637 When writing an announcement, please include the following:
1638
1639 @itemize @bullet
1640 @item
1641 A very brief description (a few sentences at most) of the general
1642 purpose of your package.
1643
1644 @item
1645 Your package's web page (normally
1646 @indicateurl{http://www.gnu.org/software/@var{package}/}).
1647
1648 @item
1649 Your package's download location (normally
1650 @indicateurl{http://ftp.gnu.org/gnu/@var{package}/}).  It is also
1651 useful to mention the mirror list at
1652 @url{http://www.gnu.org/order/ftp.html}, and that
1653 @url{http://ftpmirror.gnu.org/@var{package/}} will automatically
1654 redirect to a nearby mirror.
1655
1656 @item
1657 The NEWS (@pxref{NEWS File,,, standards, GNU Coding Standards}) for
1658 the present release.
1659 @end itemize
1660
1661
1662 @node Web Pages
1663 @chapter Web Pages
1664 @cindex web pages
1665
1666 Please write web pages about your package, and install them on
1667 @code{www.gnu.org}.  They should follow our usual standards for web
1668 pages (see @url{http://www.gnu.org/server/@/fsf-html-style-sheet.html}).
1669 The overall goals are to support a wide variety of browsers, to focus
1670 on information rather than flashy eye candy, and to keep the site
1671 simple and uniform.
1672
1673 We encourage you to use the standard @code{www.gnu.org} template as
1674 the basis for your pages:
1675 @url{http://www.gnu.org/server/@/standards/@/boilerplate-source.html}.
1676
1677 Some GNU packages have just simple web pages, but the more information
1678 you provide, the better.  So please write as much as you usefully can,
1679 and put all of it on @code{www.gnu.org}.  However, pages that access
1680 databases (including mail archives and bug tracking) are an exception;
1681 set them up on whatever site is convenient for you, and make the pages
1682 on @code{www.gnu.org} link to that site.
1683
1684 @menu
1685 * Hosting for Web Pages::
1686 * Freedom for Web Pages::
1687 * Manuals on Web Pages::
1688 * CVS Keywords in Web Pages::
1689 @end menu
1690
1691
1692 @node Hosting for Web Pages
1693 @section Hosting for Web Pages
1694
1695 The best way to maintain the web pages for your project is to register
1696 the project on @code{savannah.gnu.org}.  Then you can edit the pages
1697 using CVS, using the separate ``web repository'' available on
1698 Savannah, which corresponds to
1699 @indicateurl{http://www.gnu.org/software/@var{package}/}.  You can
1700 keep your source files there too (using any of a variety of version
1701 control systems), but you can use @code{savannah.gnu.org} only for
1702 your gnu.org web pages if you wish; simply register a ``web-only''
1703 project.
1704
1705 If you don't want to use that method, please talk with
1706 @email{webmasters@@gnu.org} about other possible methods.  For
1707 instance, you can mail them pages to install, if necessary.  But that
1708 is more work for them, so please use Savannah if you can.
1709
1710 If you use Savannah, you can use a special file named @file{.symlinks}
1711 in order to create symbolic links, which are not supported in CVS.
1712 For details, see
1713 @url{http://www.gnu.org/server/standards/README.webmastering.html#symlinks}.
1714
1715
1716 @node Freedom for Web Pages
1717 @section Freedom for Web Pages
1718
1719 If you use a site other than @code{www.gnu.org}, please make sure that
1720 the site runs on free software alone.  (It is ok if the site uses
1721 unreleased custom software, since that is free in a trivial sense:
1722 there's only one user and it has the four freedoms.)  If the web site
1723 for a GNU package runs on non-free software, the public will see this,
1724 and it will have the effect of granting legitimacy to the non-free
1725 program.
1726
1727 If you use multiple sites, they should all follow that criterion.
1728 Please don't link to a site that is about your package, which the
1729 public might perceive as connected with it and reflecting the position
1730 of its developers, unless it follows that criterion.
1731
1732 Historically, web pages for GNU packages did not include GIF images,
1733 because of patent problems (@pxref{Ethical and Philosophical
1734 Consideration}).  Although the GIF patents expired in 2006, using GIF
1735 images is still not recommended, as the PNG and JPEG formats are
1736 generally superior.  See @url{http://www.gnu.org/philosophy/gif.html}.
1737
1738
1739 @node Manuals on Web Pages
1740 @section Manuals on Web Pages
1741
1742 The web pages for the package should include its manuals, in HTML,
1743 DVI, Info, PostScript, PDF, plain ASCII, and Texinfo format (source).
1744 All of these can be generated automatically from the Texinfo source
1745 using Makeinfo and other programs.
1746
1747 When there is only one manual, put it in a subdirectory called
1748 @file{manual}; the file @file{manual/index.html} should have a link to
1749 the manual in each of its forms.
1750
1751 If the package has more than one manual, put each one in a
1752 subdirectory of @file{manual}, set up @file{index.html} in each
1753 subdirectory to link to that manual in all its forms, and make
1754 @file{manual/index.html} link to each manual through its subdirectory.
1755
1756 See the section below for details on a script to make the job of
1757 creating all these different formats and index pages easier.
1758
1759 We would like to list all GNU manuals on the page
1760 @url{http://www.gnu.org/manual}, so if yours isn't there, please send
1761 mail to @code{webmasters@@gnu.org}, asking them to add yours, and they
1762 will do so based on the contents of your @file{manual} directory.
1763
1764 @menu
1765 * Invoking gendocs.sh::
1766 @end menu
1767
1768
1769 @node Invoking gendocs.sh
1770 @subsection Invoking @command{gendocs.sh}
1771 @pindex gendocs.sh
1772 @cindex generating documentation output
1773
1774 The script @command{gendocs.sh} eases the task of generating the
1775 Texinfo documentation output for your web pages
1776 section above.  It has a companion template file, used as the basis
1777 for the HTML index pages.  Both are available from the Texinfo CVS
1778 sources:
1779
1780 @smallformat
1781 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh}
1782 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template}
1783 @end smallformat
1784
1785 There is also a minimalistic template, available from:
1786
1787 @smallformat
1788 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template_min}
1789 @end smallformat
1790
1791 Invoke the script like this, in the directory containing the Texinfo
1792 source:
1793
1794 @smallexample
1795 gendocs.sh --email @var{yourbuglist} @var{yourmanual} "GNU @var{yourmanual} manual"
1796 @end smallexample
1797
1798 @noindent where @var{yourmanual} is the short name for your package
1799 and @var{yourbuglist} is the email address for bug reports (typically
1800 @code{bug-@var{package}@@gnu.org}).  The script processes the file
1801 @file{@var{yourmanual}.texinfo} (or @file{.texi} or @file{.txi}).  For
1802 example:
1803
1804 @smallexample
1805 cd .../emacs/man
1806 # download gendocs.sh and gendocs_template
1807 gendocs.sh --email bug-gnu-emacs@@gnu.org emacs "GNU Emacs manual"
1808 @end smallexample
1809
1810 @command{gendocs.sh} creates a subdirectory @file{manual/} containing
1811 the manual generated in all the standard output formats: Info, HTML,
1812 DVI, and so on, as well as the Texinfo source.  You then need to move
1813 all those files, retaining the subdirectories, into the web pages for
1814 your package.
1815
1816 You can specify the option @option{-o @var{outdir}} to override the
1817 name @file{manual}.  Any previous contents of @var{outdir} will be deleted.
1818
1819 The second argument, with the description, is included as part of the
1820 HTML @code{<title>} of the overall @file{manual/index.html} file.  It
1821 should include the name of the package being documented, as shown.
1822 @file{manual/index.html} is created by substitution from the file
1823 @file{gendocs_template}.  (Feel free to modify the generic template
1824 for your own purposes.)
1825
1826 If you have several manuals, you'll need to run this script several
1827 times with different arguments, specifying a different output
1828 directory with @option{-o} each time, and moving all the output to
1829 your web page.  Then write (by hand) an overall index.html with links
1830 to them all.  For example:
1831
1832 @smallexample
1833 cd .../texinfo/doc
1834 gendocs.sh --email bug-texinfo@@gnu.org -o texinfo texinfo "GNU Texinfo manual"
1835 gendocs.sh --email bug-texinfo@@gnu.org -o info info "GNU Info manual"
1836 gendocs.sh --email bug-texinfo@@gnu.org -o info-stnd info-stnd "GNU info-stnd manual"
1837 @end smallexample
1838
1839 By default, the script uses @command{makeinfo} for generating
1840 @acronym{HTML} output.  If you prefer to use @command{texi2html}, use
1841 the @option{--texi2html} command line option, e.g.:
1842
1843 @smallexample
1844 gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"
1845 @end smallexample
1846
1847 The template files will automatically produce entries for additional
1848 HTML output generated by @command{texi2html} (i.e., split by sections
1849 and chapters).
1850
1851 You can set the environment variables @env{MAKEINFO}, @env{TEXI2DVI},
1852 @env{TEXI2HTML} and @env{DVIPS} to control the programs that get
1853 executed, and @env{GENDOCS_TEMPLATE_DIR} to control where the
1854 @file{gendocs_template} file is found.
1855
1856 As usual, run @samp{gendocs.sh --help} for a description of all the
1857 options, environment variables, and more information.
1858
1859 Please email bug reports, enhancement requests, or other
1860 correspondence to @email{bug-texinfo@@gnu.org}.
1861
1862
1863 @node CVS Keywords in Web Pages
1864 @section CVS Keywords in Web Pages
1865 @cindex CVS keywords in web pages
1866 @cindex RCS keywords in web pages
1867 @cindex $ keywords in web pages
1868 @cindex web pages, and CVS keywords
1869
1870 Since @code{www.gnu.org} works through CVS, CVS keywords in your
1871 manual, such as @code{@w{$}Log$}, need special treatment (even if you
1872 don't happen to maintain your manual in CVS).
1873
1874 If these keywords end up in the generated output as literal strings,
1875 they will be expanded.  The most robust way to handle this is to turn
1876 off keyword expansion for such generated files.  For existing files,
1877 this is done with:
1878
1879 @example
1880 cvs admin -ko @var{file1} @var{file2} ...
1881 @end example
1882
1883 @noindent
1884 For new files:
1885
1886 @example
1887 cvs add -ko @var{file1} @var{file2} ...
1888 @end example
1889
1890 @c The CVS manual is now built with numeric references and no nonsplit
1891 @c form, so it's not worth trying to give a direct link.
1892 See the ``Keyword Substitution'' section in the CVS manual, available
1893 at @url{http://ximbiot.com/cvs/manual}.
1894
1895 In Texinfo source, the recommended way to literally specify a
1896 ``dollar'' keyword is:
1897
1898 @example
1899 @@w@{$@}Log$
1900 @end example
1901
1902 The @code{@@w} prevents keyword expansion in the Texinfo source
1903 itself.  Also, @code{makeinfo} notices the @code{@@w} and generates
1904 output avoiding the literal keyword string.
1905
1906
1907 @node Ethical and Philosophical Consideration
1908 @chapter Ethical and Philosophical Consideration
1909 @cindex ethics
1910 @cindex philosophy
1911
1912 The GNU project takes a strong stand for software freedom.  Many
1913 times, this means you'll need to avoid certain technologies when their
1914 use would conflict with our long-term goals.
1915
1916 Software patents threaten the advancement of free software and freedom
1917 to program.  There are so many software patents in the US that any
1918 large program probably implements hundreds of patented techniques,
1919 unknown to the program's developers.  It would be futile and
1920 self-defeating to try to find and avoid all these patents.  But there
1921 are some patents which we know are likely to be used to threaten free
1922 software, so we make an effort to avoid the patented techniques.  If
1923 you are concerned about the danger of a patent and would like advice,
1924 write to @email{licensing@@gnu.org}, and we will try to help you get
1925 advice from a lawyer.
1926
1927 Sometimes the GNU project takes a strong stand against a particular
1928 patented technology in order to encourage society to reject it.
1929
1930 For example, the MP3 audio format is covered by a software patent in
1931 the USA and some other countries.  A patent holder has threatened
1932 lawsuits against the developers of free programs (these are not GNU
1933 programs) to produce and play MP3, and some GNU/Linux distributors are
1934 afraid to include them.  Development of the programs continues, but we
1935 campaign for the rejection of MP3 format in favor of Ogg Vorbis format.
1936
1937 A GNU package should not recommend use of any non-free program, nor
1938 should it require a non-free program (such as a non-free compiler or
1939 IDE) to build.  Thus, a GNU package cannot be written in a programming
1940 language that does not have a free software implementation.  Now that
1941 GNU/Linux systems are widely available, all GNU packages should
1942 provide full functionality on a 100% free GNU/Linux system, and should
1943 not require any non-free software to build or function.
1944 The GNU Coding Standards say a lot more about this issue.
1945
1946 A GNU package should not refer the user to any non-free documentation
1947 for free software.  The need for free documentation to come with free
1948 software is now a major focus of the GNU project; to show that we are
1949 serious about the need for free documentation, we must not contradict
1950 our position by recommending use of documentation that isn't free.
1951
1952 Finally, new issues concerning the ethics of software freedom come up
1953 frequently.  We ask that GNU maintainers, at least on matters that
1954 pertain specifically to their package, stand with the rest of the GNU
1955 project when such issues come up.
1956
1957
1958 @node Terminology
1959 @chapter Terminology Issues
1960 @cindex terminology
1961
1962 This chapter explains a couple of issues of terminology which are
1963 important for correcting two widespread and important misunderstandings
1964 about GNU.
1965
1966 @menu
1967 * Free Software and Open Source::
1968 * GNU and Linux::
1969 @end menu
1970
1971 @node Free Software and Open Source
1972 @section Free Software and Open Source
1973 @cindex free software
1974 @cindex open source
1975 @cindex movements, Free Software and Open Source
1976
1977 The terms ``free software'' and ``open source'' are the slogans of two
1978 different movements which differ in their basic philosophy.  The Free
1979 Software Movement is idealistic, and raises issues of freedom, ethics,
1980 principle and what makes for a good society.  The Open Source Movement,
1981 founded in 1998, studiously avoids such questions.  For more explanation,
1982 see @url{http://www.gnu.org/philosophy/open-source-misses-the-point.html}.
1983
1984 The GNU Project is aligned with the Free Software Movement.  This
1985 doesn't mean that all GNU contributors and maintainers have to agree;
1986 your views on these issues are up to you, and you're entitled to express
1987 them when speaking for yourself.
1988
1989 However, due to the much greater publicity that the Open Source
1990 Movement receives, the GNU Project needs to overcome a widespread
1991 mistaken impression that GNU is @emph{and always was} an activity of
1992 the Open Source Movement.  For this reason, please use the term ``free
1993 software'', not ``open source'', in GNU software releases, GNU
1994 documentation, and announcements and articles that you publish in your
1995 role as the maintainer of a GNU package.  A reference to the URL given
1996 above, to explain the difference, is a useful thing to include as
1997 well.
1998
1999 @node GNU and Linux
2000 @section GNU and Linux
2001 @cindex Linux
2002 @cindex GNU/Linux
2003
2004 The GNU Project was formed to develop a free Unix-like operating system,
2005 GNU.  The existence of this system is our major accomplishment.
2006 However, the widely used version of the GNU system, in which Linux is
2007 used as the kernel, is often called simply ``Linux''.  As a result, most
2008 users don't know about the GNU Project's major accomplishment---or more
2009 precisely, they know about it, but don't realize it is the GNU Project's
2010 accomplishment and reason for existence.  Even people who believe they
2011 know the real history often believe that the goal of GNU was to develop
2012 ``tools'' or ``utilities.''
2013
2014 To correct this confusion, we have made a years-long effort to
2015 distinguish between Linux, the kernel that Linus Torvalds wrote, and
2016 GNU/Linux, the operating system that is the combination of GNU and
2017 Linux.  The resulting increased awareness of what the GNU Project has
2018 already done helps every activity of the GNU Project recruit more
2019 support and contributors.
2020
2021 Please make this distinction consistently in GNU software releases, GNU
2022 documentation, and announcements and articles that you publish in your
2023 role as the maintainer of a GNU package.  If you want to explain the
2024 terminology and its reasons, you can refer to the URL
2025 @url{http://www.gnu.org/gnu/linux-and-gnu.html}.
2026
2027 To contrast the GNU system properly with respect to GNU/Linux, you can
2028 call it ``GNU/Hurd'' or ``the GNU/Hurd system.''  However, when that
2029 contrast is not specifically the focus, please call it just ``GNU'' or
2030 ``the GNU system.''
2031
2032 When referring to the collection of servers that is the higher level
2033 of the GNU kernel, please call it ``the Hurd'' or ``the GNU Hurd.''
2034 Note that this uses a space, not a slash.
2035
2036
2037 @node Hosting
2038 @chapter Hosting
2039 @cindex CVS repository
2040 @cindex repository
2041 @cindex source repository
2042 @cindex version control system
2043 @cindex FTP site
2044 @cindex release site
2045 @cindex hosting
2046
2047 We recommend using @code{savannah.gnu.org} for the source code
2048 repository for your package, but that's not required.  @xref{Old
2049 Versions}, for more information about Savannah.
2050
2051 We strongly urge you to use @code{ftp.gnu.org} as the standard
2052 distribution site.  Doing so makes it easier for developers and users
2053 to find the latest GNU releases.  However, it is ok to use another
2054 server if you wish, provided it allows access from the general public
2055 without limitation (for instance, without excluding any country).
2056
2057 If you use a company's machine to hold the repository for your
2058 program, or as its ftp site, please put this statement in a prominent
2059 place on the site, so as to prevent people from getting the wrong idea
2060 about the relationship between the package and the company:
2061
2062 @smallexample
2063 The programs <list of them> hosted here are free software packages
2064 of the GNU Project, not products of <company name>.  We call them
2065 "free software" because you are free to copy and redistribute them,
2066 following the rules stated in the license of each package.  For more
2067 information, see http://www.gnu.org/philosophy/free-sw.html.
2068
2069 If you are looking for service or support for GNU software, see
2070 http://www.gnu.org/gethelp/ for suggestions of where to ask.
2071
2072 If you would like to contribute to the development of one of these
2073 packages, contact the package maintainer or the bug-reporting address
2074 of the package (which should be listed in the package itself), or look
2075 on www.gnu.org for more information on how to contribute.
2076 @end smallexample
2077
2078
2079 @node Donations
2080 @chapter Donations
2081 @cindex Donations, for packages
2082 @cindex Money, donated to packages
2083
2084 As a maintainer, you might want to accept donations for your work,
2085 especially if you pay for any of your own hosting/development
2086 infrastructure.  Following is some text you can adapt for your
2087 package's web site, @file{README}, or wherever you find it useful:
2088
2089 @smallexample
2090 We appreciate contributions of any size -- donations enable us to spend
2091 more time working on the project, and help cover our infrastructure
2092 expenses.
2093
2094 If you'd like to make a small donation, please visit @var{url} and do
2095 it through PayPal.  Since our project isn't a tax-exempt organization,
2096 we can't offer you a tax deduction, but for all donations over
2097 @var{amount}, we'd be happy to recognize your contribution on
2098 @var{another-url}.
2099
2100 If you can make a donation large enough to entirely fund a substantial
2101 change, such as $1000, then we could discuss with you what change we
2102 should do with your funds, and we could give you a certain amount of
2103 specific help in exchange.  Write to us about this at @var{address}.
2104
2105 Thanks for your support!
2106 @end smallexample
2107
2108
2109 @node Free Software Directory
2110 @chapter Free Software Directory
2111 @cindex Free Software Directory
2112 @cindex Directory, Free Software
2113
2114 The Free Software Directory aims to be a complete list of free
2115 software packages, within certain criteria.  Every GNU package should
2116 be listed there, so please see
2117 @url{http://www.gnu.org/help/directory.html#adding-entries} for
2118 information on how to write an entry for your package.  Contact
2119 @email{bug-directory@@gnu.org} with any questions or suggestions for
2120 the Free Software Directory.
2121
2122
2123 @node Using the Proofreaders List
2124 @chapter Using the Proofreaders List
2125 @cindex proofreading
2126
2127 If you want help finding errors in documentation,
2128 or help improving the quality of writing,
2129 or if you are not a native speaker of English
2130 and want help producing good English documentation,
2131 you can use the GNU proofreaders mailing list:
2132 @email{proofreaders@@gnu.org}.
2133
2134 But be careful when you use the list,
2135 because there are over 200 people on it.
2136 If you simply ask everyone on the list to read your work,
2137 there will probably be tremendous duplication of effort
2138 by the proofreaders,
2139 and you will probably get the same errors reported 100 times.
2140 This must be avoided.
2141
2142 Also, the people on the list do not want to get
2143 a large amount of mail from it.
2144 So do not ever ask people on the list to send mail to the list!
2145
2146 Here are a few methods that seem reasonable to use:
2147
2148 @itemize @bullet
2149 @item
2150 For something small, mail it to the list,
2151 and ask people to pick a random number from 1 to 20,
2152 and read it if the number comes out as 10.
2153 This way, assuming 50% response, some 5 people will read the piece.
2154
2155 @item
2156 For a larger work, divide your work into around 20 equal-sized parts,
2157 tell people where to get it,
2158 and ask each person to pick randomly which part to read.
2159
2160 Be sure to specify the random choice procedure;
2161 otherwise people will probably use a mental procedure
2162 that is not really random,
2163 such as ``pick a part near the middle'',
2164 and you will not get even coverage.
2165
2166 You can either divide up the work physically, into 20 separate files,
2167 or describe a virtual division, such as by sections
2168 (if your work has approximately 20 sections).
2169 If you do the latter, be sure to be precise about it---for example,
2170 do you want the material before the first section heading
2171 to count as a section, or not?
2172
2173 @item
2174 For a job needing special skills, send an explanation of it,
2175 and ask people to send you mail if they volunteer for the job.
2176 When you get enough volunteers, send another message to the list saying
2177 ``I have enough volunteers, no more please.''
2178 @end itemize
2179
2180
2181 @node GNU Free Documentation License
2182 @appendix GNU Free Documentation License
2183
2184 @cindex FDL, GNU Free Documentation License
2185 @include fdl.texi
2186
2187
2188 @node Index
2189 @unnumbered Index
2190 @printindex cp
2191
2192 @bye
2193
2194 Local variables:
2195 eval: (add-hook 'write-file-hooks 'time-stamp)
2196 time-stamp-start: "@set lastupdate "
2197 time-stamp-start: "@set lastupdate "
2198 time-stamp-end: "$"
2199 time-stamp-format: "%:b %:d, %:y"
2200 compile-command: "make -C work.m"
2201 End: