* emultempl/elf32.em: For SEC_EXCLUDE sections, ensure that
[binutils.git] / etc / standards.texi
blob910bf8b0479e3d858d188c0a227c78a84933f266
1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename standards.info
4 @settitle GNU Coding Standards
5 @c This date is automagically updated when you save this file:
6 @set lastupdate March 13, 1998
7 @c %**end of header
9 @ifinfo
10 @format
11 START-INFO-DIR-ENTRY
12 * Standards: (standards).        GNU coding standards.
13 END-INFO-DIR-ENTRY
14 @end format
15 @end ifinfo
17 @c @setchapternewpage odd
18 @setchapternewpage off
20 @c This is used by a cross ref in make-stds.texi
21 @set CODESTD  1
22 @iftex
23 @set CHAPTER chapter
24 @end iftex
25 @ifinfo
26 @set CHAPTER node
27 @end ifinfo
29 @ifinfo
30 GNU Coding Standards
31 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
33 Permission is granted to make and distribute verbatim copies of
34 this manual provided the copyright notice and this permission notice
35 are preserved on all copies.
37 @ignore
38 Permission is granted to process this file through TeX and print the
39 results, provided the printed document carries copying permission
40 notice identical to this one except for the removal of this paragraph
41 (this paragraph not being relevant to the printed manual).
42 @end ignore
44 Permission is granted to copy and distribute modified versions of this
45 manual under the conditions for verbatim copying, provided that the entire
46 resulting derived work is distributed under the terms of a permission
47 notice identical to this one.
49 Permission is granted to copy and distribute translations of this manual
50 into another language, under the above conditions for modified versions,
51 except that this permission notice may be stated in a translation approved
52 by the Free Software Foundation.
53 @end ifinfo
55 @titlepage
56 @title GNU Coding Standards
57 @author Richard Stallman
58 @author last updated @value{lastupdate}
59 @page
61 @vskip 0pt plus 1filll
62 Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
64 Permission is granted to make and distribute verbatim copies of
65 this manual provided the copyright notice and this permission notice
66 are preserved on all copies.
68 Permission is granted to copy and distribute modified versions of this
69 manual under the conditions for verbatim copying, provided that the entire
70 resulting derived work is distributed under the terms of a permission
71 notice identical to this one.
73 Permission is granted to copy and distribute translations of this manual
74 into another language, under the above conditions for modified versions,
75 except that this permission notice may be stated in a translation approved
76 by the Free Software Foundation.
77 @end titlepage
79 @ifinfo
80 @node Top, Preface, (dir), (dir)
81 @top Version
83 Last updated @value{lastupdate}.
84 @end ifinfo
86 @menu
87 * Preface::                     About the GNU Coding Standards
88 * Intellectual Property::       Keeping Free Software Free
89 * Design Advice::               General Program Design
90 * Program Behavior::            Program Behavior for All Programs
91 * Writing C::                   Making The Best Use of C
92 * Documentation::               Documenting Programs
93 * Managing Releases::           The Release Process
94 @end menu
96 @node Preface
97 @chapter About the GNU Coding Standards
99 The GNU Coding Standards were written by Richard Stallman and other GNU
100 Project volunteers.  Their purpose is to make the GNU system clean,
101 consistent, and easy to install.  This document can also be read as a
102 guide to writing portable, robust and reliable programs.  It focuses on
103 programs written in C, but many of the rules and principles are useful
104 even if you write in another programming language.  The rules often
105 state reasons for writing in a certain way.
107 Corrections or suggestions for this document should be sent to
108 @email{gnu@@gnu.org}.  If you make a suggestion, please include a
109 suggested new wording for it; our time is limited.  We prefer a context
110 diff to the @file{standards.texi} or @file{make-stds.texi} files, but if
111 you don't have those files, please mail your suggestion anyway.
113 This release of the GNU Coding Standards was last updated
114 @value{lastupdate}.
116 @node Intellectual Property
117 @chapter Keeping Free Software Free
119 This @value{CHAPTER} discusses how you can make sure that GNU software
120 remains unencumbered.
122 @menu
123 * Reading Non-Free Code::       Referring to Proprietary Programs
124 * Contributions::               Accepting Contributions
125 @end menu
127 @node Reading Non-Free Code
128 @section Referring to Proprietary Programs
130 Don't in any circumstances refer to Unix source code for or during
131 your work on GNU!  (Or to any other proprietary programs.)
133 If you have a vague recollection of the internals of a Unix program,
134 this does not absolutely mean you can't write an imitation of it, but
135 do try to organize the imitation internally along different lines,
136 because this is likely to make the details of the Unix version
137 irrelevant and dissimilar to your results.
139 For example, Unix utilities were generally optimized to minimize
140 memory use; if you go for speed instead, your program will be very
141 different.  You could keep the entire input file in core and scan it
142 there instead of using stdio.  Use a smarter algorithm discovered more
143 recently than the Unix program.  Eliminate use of temporary files.  Do
144 it in one pass instead of two (we did this in the assembler).
146 Or, on the contrary, emphasize simplicity instead of speed.  For some
147 applications, the speed of today's computers makes simpler algorithms
148 adequate.
150 Or go for generality.  For example, Unix programs often have static
151 tables or fixed-size strings, which make for arbitrary limits; use
152 dynamic allocation instead.  Make sure your program handles NULs and
153 other funny characters in the input files.  Add a programming language
154 for extensibility and write part of the program in that language.
156 Or turn some parts of the program into independently usable libraries.
157 Or use a simple garbage collector instead of tracking precisely when
158 to free memory, or use a new GNU facility such as obstacks.
161 @node Contributions
162 @section Accepting Contributions
164 If someone else sends you a piece of code to add to the program you are
165 working on, we need legal papers to use it---the same sort of legal
166 papers we will need to get from you.  @emph{Each} significant
167 contributor to a program must sign some sort of legal papers in order
168 for us to have clear title to the program.  The main author alone is not
169 enough.
171 So, before adding in any contributions from other people, please tell
172 us, so we can arrange to get the papers.  Then wait until we tell you
173 that we have received the signed papers, before you actually use the
174 contribution.
176 This applies both before you release the program and afterward.  If
177 you receive diffs to fix a bug, and they make significant changes, we
178 need legal papers for that change.
180 This also applies to comments and documentation files.  For copyright
181 law, comments and code are just text.  Copyright applies to all kinds of
182 text, so we need legal papers for all kinds.
184 You don't need papers for changes of a few lines here or there, since
185 they are not significant for copyright purposes.  Also, you don't need
186 papers if all you get from the suggestion is some ideas, not actual code
187 which you use.  For example, if you write a different solution to the
188 problem, you don't need to get papers.
190 We know this is frustrating; it's frustrating for us as well.  But if
191 you don't wait, you are going out on a limb---for example, what if the
192 contributor's employer won't sign a disclaimer?  You might have to take
193 that code out again!
195 The very worst thing is if you forget to tell us about the other
196 contributor.  We could be very embarrassed in court some day as a
197 result.
199 We have more detailed advice for maintainers of programs; if you have
200 reached the stage of actually maintaining a program for GNU (whether
201 released or not), please ask us for a copy.
203 @node Design Advice
204 @chapter General Program Design
206 This @value{CHAPTER} discusses some of the issues you should take into
207 account when designing your program.
209 @menu
210 * Compatibility::               Compatibility with other implementations
211 * Using Extensions::            Using non-standard features
212 * ANSI C::                      Using ANSI C features
213 * Source Language::             Using languages other than C
214 @end menu
216 @node Compatibility
217 @section Compatibility with Other Implementations
219 With occasional exceptions, utility programs and libraries for GNU
220 should be upward compatible with those in Berkeley Unix, and upward
221 compatible with @sc{ansi} C if @sc{ansi} C specifies their behavior, and
222 upward compatible with @sc{POSIX} if @sc{POSIX} specifies their
223 behavior.
225 When these standards conflict, it is useful to offer compatibility
226 modes for each of them.
228 @sc{ansi} C and @sc{POSIX} prohibit many kinds of extensions.  Feel free
229 to make the extensions anyway, and include a @samp{--ansi},
230 @samp{--posix}, or @samp{--compatible} option to turn them off.
231 However, if the extension has a significant chance of breaking any real
232 programs or scripts, then it is not really upward compatible.  Try to
233 redesign its interface.
235 Many GNU programs suppress extensions that conflict with POSIX if the
236 environment variable @code{POSIXLY_CORRECT} is defined (even if it is
237 defined with a null value).  Please make your program recognize this
238 variable if appropriate.
240 When a feature is used only by users (not by programs or command
241 files), and it is done poorly in Unix, feel free to replace it
242 completely with something totally different and better.  (For example,
243 @code{vi} is replaced with Emacs.)  But it is nice to offer a compatible
244 feature as well.  (There is a free @code{vi} clone, so we offer it.)
246 Additional useful features not in Berkeley Unix are welcome.
248 @node Using Extensions
249 @section Using Non-standard Features
251 Many GNU facilities that already exist support a number of convenient
252 extensions over the comparable Unix facilities.  Whether to use these
253 extensions in implementing your program is a difficult question.
255 On the one hand, using the extensions can make a cleaner program.
256 On the other hand, people will not be able to build the program
257 unless the other GNU tools are available.  This might cause the
258 program to work on fewer kinds of machines.
260 With some extensions, it might be easy to provide both alternatives.
261 For example, you can define functions with a ``keyword'' @code{INLINE}
262 and define that as a macro to expand into either @code{inline} or
263 nothing, depending on the compiler.
265 In general, perhaps it is best not to use the extensions if you can
266 straightforwardly do without them, but to use the extensions if they
267 are a big improvement.
269 An exception to this rule are the large, established programs (such as
270 Emacs) which run on a great variety of systems.  Such programs would
271 be broken by use of GNU extensions.
273 Another exception is for programs that are used as part of
274 compilation: anything that must be compiled with other compilers in
275 order to bootstrap the GNU compilation facilities.  If these require
276 the GNU compiler, then no one can compile them without having them
277 installed already.  That would be no good.
279 @node ANSI C
280 @section @sc{ansi} C and pre-@sc{ansi} C
282 Do not ever use the ``trigraph'' feature of @sc{ansi} C.
284 @sc{ansi} C is widespread enough now that it is ok to write new programs
285 that use @sc{ansi} C features (and therefore will not work in
286 non-@sc{ansi} compilers).  And if a program is already written in
287 @sc{ansi} C, there's no need to convert it to support non-@sc{ansi}
288 compilers.
290 However, it is easy to support non-@sc{ansi} compilers in most programs,
291 so you might still consider doing so when you write a program.  Instead
292 of writing function definitions in @sc{ansi} prototype form,
294 @example
296 foo (int x, int y)
297 @dots{}
298 @end example
300 @noindent
301 write the definition in pre-@sc{ansi} style like this,
303 @example
305 foo (x, y)
306      int x, y;
307 @dots{}
308 @end example
310 @noindent
311 and use a separate declaration to specify the argument prototype:
313 @example
314 int foo (int, int);
315 @end example
317 You need such a declaration anyway, in a header file, to get the benefit
318 of @sc{ansi} C prototypes in all the files where the function is called.
319 And once you have it, you lose nothing by writing the function
320 definition in the pre-@sc{ansi} style.
322 If you don't know non-@sc{ansi} C, there's no need to learn it; just
323 write in @sc{ansi} C.
325 @node Source Language
326 @section Using Languages Other Than C
328 Using a language other than C is like using a non-standard feature: it
329 will cause trouble for users.  Even if GCC supports the other language,
330 users may find it inconvenient to have to install the compiler for that
331 other language in order to build your program.  For example, if you
332 write your program in C++, people will have to install the C++ compiler
333 in order to compile your program.  Thus, it is better if you write in C.
335 But there are three situations when there is no disadvantage in using
336 some other language:
338 @itemize @bullet
339 @item
340 It is okay to use another language if your program contains an
341 interpreter for that language.
343 For example, if your program links with GUILE, it is ok to write part of
344 the program in Scheme or another language supported by GUILE.
346 @item
347 It is okay to use another language in a tool specifically intended for
348 use with that language.
350 This is okay because the only people who want to build the tool will be
351 those who have installed the other language anyway.
353 @item
354 If an application is of interest to a narrow community, then perhaps
355 it's not important if the application is inconvenient to install.
356 @end itemize
358 C has one other advantage over C++ and other compiled languages: more
359 people know C, so more people will find it easy to read and modify the
360 program if it is written in C.
362 @node Program Behavior
363 @chapter Program Behavior for All Programs
365 This @value{CHAPTER} describes how to write robust software. It also
366 describes general standards for error messages, the command line interface,
367 and how libraries should behave.
369 @menu
370 * Semantics::                   Writing robust programs
371 * Libraries::                   Library behavior
372 * Errors::                      Formatting error messages
373 * User Interfaces::             Standards for command line interfaces
374 * Option Table::                Table of long options.
375 * Memory Usage::                When and how to care about memory needs
376 @end menu
378 @node Semantics
379 @section Writing Robust Programs
381 Avoid arbitrary limits on the length or number of @emph{any} data
382 structure, including file names, lines, files, and symbols, by allocating
383 all data structures dynamically.  In most Unix utilities, ``long lines
384 are silently truncated''.  This is not acceptable in a GNU utility.
386 Utilities reading files should not drop NUL characters, or any other
387 nonprinting characters @emph{including those with codes above 0177}.  The
388 only sensible exceptions would be utilities specifically intended for
389 interface to certain types of printers that can't handle those characters.
391 Check every system call for an error return, unless you know you wish to
392 ignore errors.  Include the system error text (from @code{perror} or
393 equivalent) in @emph{every} error message resulting from a failing
394 system call, as well as the name of the file if any and the name of the
395 utility.  Just ``cannot open foo.c'' or ``stat failed'' is not
396 sufficient.
398 Check every call to @code{malloc} or @code{realloc} to see if it
399 returned zero.  Check @code{realloc} even if you are making the block
400 smaller; in a system that rounds block sizes to a power of 2,
401 @code{realloc} may get a different block if you ask for less space.
403 In Unix, @code{realloc} can destroy the storage block if it returns
404 zero.  GNU @code{realloc} does not have this bug: if it fails, the
405 original block is unchanged.  Feel free to assume the bug is fixed.  If
406 you wish to run your program on Unix, and wish to avoid lossage in this
407 case, you can use the GNU @code{malloc}.
409 You must expect @code{free} to alter the contents of the block that was
410 freed.  Anything you want to fetch from the block, you must fetch before
411 calling @code{free}.
413 If @code{malloc} fails in a noninteractive program, make that a fatal
414 error.  In an interactive program (one that reads commands from the
415 user), it is better to abort the command and return to the command
416 reader loop.  This allows the user to kill other processes to free up
417 virtual memory, and then try the command again.
419 Use @code{getopt_long} to decode arguments, unless the argument syntax
420 makes this unreasonable.
422 When static storage is to be written in during program execution, use
423 explicit C code to initialize it.  Reserve C initialized declarations
424 for data that will not be changed.
425 @c ADR: why?
427 Try to avoid low-level interfaces to obscure Unix data structures (such
428 as file directories, utmp, or the layout of kernel memory), since these
429 are less likely to work compatibly.  If you need to find all the files
430 in a directory, use @code{readdir} or some other high-level interface.
431 These will be supported compatibly by GNU.
433 By default, the GNU system will provide the signal handling functions of
434 @sc{BSD} and of @sc{POSIX}.  So GNU software should be written to use
435 these.
437 In error checks that detect ``impossible'' conditions, just abort.
438 There is usually no point in printing any message.  These checks
439 indicate the existence of bugs.  Whoever wants to fix the bugs will have
440 to read the source code and run a debugger.  So explain the problem with
441 comments in the source.  The relevant data will be in variables, which
442 are easy to examine with the debugger, so there is no point moving them
443 elsewhere.
445 Do not use a count of errors as the exit status for a program.
446 @emph{That does not work}, because exit status values are limited to 8
447 bits (0 through 255).  A single run of the program might have 256
448 errors; if you try to return 256 as the exit status, the parent process
449 will see 0 as the status, and it will appear that the program succeeded.
451 If you make temporary files, check the @code{TMPDIR} environment
452 variable; if that variable is defined, use the specified directory
453 instead of @file{/tmp}.
455 @node Libraries
456 @section Library Behavior
458 Try to make library functions reentrant.  If they need to do dynamic
459 storage allocation, at least try to avoid any nonreentrancy aside from
460 that of @code{malloc} itself.
462 Here are certain name conventions for libraries, to avoid name
463 conflicts.
465 Choose a name prefix for the library, more than two characters long.
466 All external function and variable names should start with this
467 prefix.  In addition, there should only be one of these in any given
468 library member.  This usually means putting each one in a separate
469 source file.
471 An exception can be made when two external symbols are always used
472 together, so that no reasonable program could use one without the
473 other; then they can both go in the same file.
475 External symbols that are not documented entry points for the user
476 should have names beginning with @samp{_}.  They should also contain
477 the chosen name prefix for the library, to prevent collisions with
478 other libraries.  These can go in the same files with user entry
479 points if you like.
481 Static functions and variables can be used as you like and need not
482 fit any naming convention.
484 @node Errors
485 @section Formatting Error Messages
487 Error messages from compilers should look like this:
489 @example
490 @var{source-file-name}:@var{lineno}: @var{message}
491 @end example
493 Error messages from other noninteractive programs should look like this:
495 @example
496 @var{program}:@var{source-file-name}:@var{lineno}: @var{message}
497 @end example
499 @noindent
500 when there is an appropriate source file, or like this:
502 @example
503 @var{program}: @var{message}
504 @end example
506 @noindent
507 when there is no relevant source file.
509 In an interactive program (one that is reading commands from a
510 terminal), it is better not to include the program name in an error
511 message.  The place to indicate which program is running is in the
512 prompt or with the screen layout.  (When the same program runs with
513 input from a source other than a terminal, it is not interactive and
514 would do best to print error messages using the noninteractive style.)
516 The string @var{message} should not begin with a capital letter when
517 it follows a program name and/or file name.  Also, it should not end
518 with a period.
520 Error messages from interactive programs, and other messages such as
521 usage messages, should start with a capital letter.  But they should not
522 end with a period.
524 @node User Interfaces
525 @section Standards for Command Line Interfaces
527 Please don't make the behavior of a utility depend on the name used
528 to invoke it.  It is useful sometimes to make a link to a utility
529 with a different name, and that should not change what it does.
531 Instead, use a run time option or a compilation switch or both
532 to select among the alternate behaviors.
534 Likewise, please don't make the behavior of the program depend on the
535 type of output device it is used with.  Device independence is an
536 important principle of the system's design; do not compromise it
537 merely to save someone from typing an option now and then.
539 If you think one behavior is most useful when the output is to a
540 terminal, and another is most useful when the output is a file or a
541 pipe, then it is usually best to make the default behavior the one that
542 is useful with output to a terminal, and have an option for the other
543 behavior.
545 Compatibility requires certain programs to depend on the type of output
546 device.  It would be disastrous if @code{ls} or @code{sh} did not do so
547 in the way all users expect.  In some of these cases, we supplement the
548 program with a preferred alternate version that does not depend on the
549 output device type.  For example, we provide a @code{dir} program much
550 like @code{ls} except that its default output format is always
551 multi-column format.
553 It is a good idea to follow the @sc{POSIX} guidelines for the
554 command-line options of a program.  The easiest way to do this is to use
555 @code{getopt} to parse them.  Note that the GNU version of @code{getopt}
556 will normally permit options anywhere among the arguments unless the
557 special argument @samp{--} is used.  This is not what @sc{POSIX}
558 specifies; it is a GNU extension.
560 Please define long-named options that are equivalent to the
561 single-letter Unix-style options.  We hope to make GNU more user
562 friendly this way.  This is easy to do with the GNU function
563 @code{getopt_long}.
565 One of the advantages of long-named options is that they can be
566 consistent from program to program.  For example, users should be able
567 to expect the ``verbose'' option of any GNU program which has one, to be
568 spelled precisely @samp{--verbose}.  To achieve this uniformity, look at
569 the table of common long-option names when you choose the option names
570 for your program (@pxref{Option Table}).
572 It is usually a good idea for file names given as ordinary arguments to
573 be input files only; any output files would be specified using options
574 (preferably @samp{-o} or @samp{--output}).  Even if you allow an output
575 file name as an ordinary argument for compatibility, try to provide an
576 option as another way to specify it.  This will lead to more consistency
577 among GNU utilities, and fewer idiosyncracies for users to remember.
579 All programs should support two standard options: @samp{--version}
580 and @samp{--help}.
582 @table @code
583 @item --version
584 This option should direct the program to information about its name,
585 version, origin and legal status, all on standard output, and then exit
586 successfully.  Other options and arguments should be ignored once this
587 is seen, and the program should not perform its normal function.
589 The first line is meant to be easy for a program to parse; the version
590 number proper starts after the last space.  In addition, it contains
591 the canonical name for this program, in this format:
593 @example
594 GNU Emacs 19.30
595 @end example
597 @noindent
598 The program's name should be a constant string; @emph{don't} compute it
599 from @code{argv[0]}.  The idea is to state the standard or canonical
600 name for the program, not its file name.  There are other ways to find
601 out the precise file name where a command is found in @code{PATH}.
603 If the program is a subsidiary part of a larger package, mention the
604 package name in parentheses, like this:
606 @example
607 emacsserver (GNU Emacs) 19.30
608 @end example
610 @noindent
611 If the package has a version number which is different from this
612 program's version number, you can mention the package version number
613 just before the close-parenthesis.
615 If you @strong{need} to mention the version numbers of libraries which
616 are distributed separately from the package which contains this program,
617 you can do so by printing an additional line of version info for each
618 library you want to mention.  Use the same format for these lines as for
619 the first line.
621 Please do not mention all of the libraries that the program uses ``just
622 for completeness''---that would produce a lot of unhelpful clutter.
623 Please mention library version numbers only if you find in practice that
624 they are very important to you in debugging.
626 The following line, after the version number line or lines, should be a
627 copyright notice.  If more than one copyright notice is called for, put
628 each on a separate line.
630 Next should follow a brief statement that the program is free software,
631 and that users are free to copy and change it on certain conditions.  If
632 the program is covered by the GNU GPL, say so here.  Also mention that
633 there is no warranty, to the extent permitted by law.
635 It is ok to finish the output with a list of the major authors of the
636 program, as a way of giving credit.
638 Here's an example of output that follows these rules:
640 @smallexample
641 GNU Emacs 19.34.5
642 Copyright (C) 1996 Free Software Foundation, Inc.
643 GNU Emacs comes with NO WARRANTY,
644 to the extent permitted by law.
645 You may redistribute copies of GNU Emacs
646 under the terms of the GNU General Public License.
647 For more information about these matters,
648 see the files named COPYING.
649 @end smallexample
651 You should adapt this to your program, of course, filling in the proper
652 year, copyright holder, name of program, and the references to
653 distribution terms, and changing the rest of the wording as necessary.
655 This copyright notice only needs to mention the most recent year in
656 which changes were made---there's no need to list the years for previous
657 versions' changes.  You don't have to mention the name of the program in
658 these notices, if that is inconvenient, since it appeared in the first
659 line.
661 @item --help
662 This option should output brief documentation for how to invoke the
663 program, on standard output, then exit successfully.  Other options and
664 arguments should be ignored once this is seen, and the program should
665 not perform its normal function.
667 Near the end of the @samp{--help} option's output there should be a line
668 that says where to mail bug reports.  It should have this format:
670 @example
671 Report bugs to @var{mailing-address}.
672 @end example
673 @end table
675 @node Option Table
676 @section Table of Long Options
678 Here is a table of long options used by GNU programs.  It is surely
679 incomplete, but we aim to list all the options that a new program might
680 want to be compatible with.  If you use names not already in the table,
681 please send @email{gnu@@gnu.org} a list of them, with their
682 meanings, so we can update the table.
684 @c Please leave newlines between items in this table; it's much easier
685 @c to update when it isn't completely squashed together and unreadable.
686 @c When there is more than one short option for a long option name, put
687 @c a semicolon between the lists of the programs that use them, not a
688 @c period.   --friedman
690 @table @samp
691 @item after-date
692 @samp{-N} in @code{tar}.
694 @item all
695 @samp{-a} in @code{du}, @code{ls}, @code{nm}, @code{stty}, @code{uname},
696 and @code{unexpand}.
698 @item all-text
699 @samp{-a} in @code{diff}.
701 @item almost-all
702 @samp{-A} in @code{ls}.
704 @item append
705 @samp{-a} in @code{etags}, @code{tee}, @code{time};
706 @samp{-r} in @code{tar}.
708 @item archive
709 @samp{-a} in @code{cp}.
711 @item archive-name
712 @samp{-n} in @code{shar}.
714 @item arglength
715 @samp{-l} in @code{m4}.
717 @item ascii
718 @samp{-a} in @code{diff}.
720 @item assign
721 @samp{-v} in @code{gawk}.
723 @item assume-new
724 @samp{-W} in Make.
726 @item assume-old
727 @samp{-o} in Make.
729 @item auto-check
730 @samp{-a} in @code{recode}.
732 @item auto-pager
733 @samp{-a} in @code{wdiff}.
735 @item auto-reference
736 @samp{-A} in @code{ptx}.
738 @item avoid-wraps
739 @samp{-n} in @code{wdiff}.
741 @item backward-search
742 @samp{-B} in @code{ctags}.
744 @item basename
745 @samp{-f} in @code{shar}.
747 @item batch
748 Used in GDB.
750 @item baud
751 Used in GDB.
753 @item before
754 @samp{-b} in @code{tac}.
756 @item binary
757 @samp{-b} in @code{cpio} and @code{diff}.
759 @item bits-per-code
760 @samp{-b} in @code{shar}.
762 @item block-size
763 Used in @code{cpio} and @code{tar}.
765 @item blocks
766 @samp{-b} in @code{head} and @code{tail}.
768 @item break-file
769 @samp{-b} in @code{ptx}.
771 @item brief
772 Used in various programs to make output shorter.
774 @item bytes
775 @samp{-c} in @code{head}, @code{split}, and @code{tail}.
777 @item c@t{++}
778 @samp{-C} in @code{etags}.
780 @item catenate
781 @samp{-A} in @code{tar}.
783 @item cd
784 Used in various programs to specify the directory to use.
786 @item changes
787 @samp{-c} in @code{chgrp} and @code{chown}.
789 @item classify
790 @samp{-F} in @code{ls}.
792 @item colons
793 @samp{-c} in @code{recode}.
795 @item command
796 @samp{-c} in @code{su};
797 @samp{-x} in GDB.
799 @item compare
800 @samp{-d} in @code{tar}.
802 @item compat
803 Used in @code{gawk}.
805 @item compress
806 @samp{-Z} in @code{tar} and @code{shar}.
808 @item concatenate
809 @samp{-A} in @code{tar}.
811 @item confirmation
812 @samp{-w} in @code{tar}.
814 @item context
815 Used in @code{diff}.
817 @item copyleft
818 @samp{-W copyleft} in @code{gawk}.
820 @item copyright
821 @samp{-C} in @code{ptx}, @code{recode}, and @code{wdiff};
822 @samp{-W copyright} in @code{gawk}.
824 @item core
825 Used in GDB.
827 @item count
828 @samp{-q} in @code{who}.
830 @item count-links
831 @samp{-l} in @code{du}.
833 @item create
834 Used in @code{tar} and @code{cpio}.
836 @item cut-mark
837 @samp{-c} in @code{shar}.
839 @item cxref
840 @samp{-x} in @code{ctags}.
842 @item date
843 @samp{-d} in @code{touch}.
845 @item debug
846 @samp{-d} in Make and @code{m4};
847 @samp{-t} in Bison.
849 @item define
850 @samp{-D} in @code{m4}.
852 @item defines
853 @samp{-d} in Bison and @code{ctags}.
855 @item delete
856 @samp{-D} in @code{tar}.
858 @item dereference
859 @samp{-L} in @code{chgrp}, @code{chown}, @code{cpio}, @code{du},
860 @code{ls}, and @code{tar}.
862 @item dereference-args
863 @samp{-D} in @code{du}.
865 @item diacritics
866 @samp{-d} in @code{recode}.
868 @item dictionary-order
869 @samp{-d} in @code{look}.
871 @item diff
872 @samp{-d} in @code{tar}.
874 @item digits
875 @samp{-n} in @code{csplit}.
877 @item directory
878 Specify the directory to use, in various programs.  In @code{ls}, it
879 means to show directories themselves rather than their contents.  In
880 @code{rm} and @code{ln}, it means to not treat links to directories
881 specially.
883 @item discard-all
884 @samp{-x} in @code{strip}.
886 @item discard-locals
887 @samp{-X} in @code{strip}.
889 @item dry-run
890 @samp{-n} in Make.
892 @item ed
893 @samp{-e} in @code{diff}.
895 @item elide-empty-files
896 @samp{-z} in @code{csplit}.
898 @item end-delete
899 @samp{-x} in @code{wdiff}.
901 @item end-insert
902 @samp{-z} in @code{wdiff}.
904 @item entire-new-file
905 @samp{-N} in @code{diff}.
907 @item environment-overrides
908 @samp{-e} in Make.
910 @item eof
911 @samp{-e} in @code{xargs}.
913 @item epoch
914 Used in GDB.
916 @item error-limit
917 Used in @code{makeinfo}.
919 @item error-output
920 @samp{-o} in @code{m4}.
922 @item escape
923 @samp{-b} in @code{ls}.
925 @item exclude-from
926 @samp{-X} in @code{tar}.
928 @item exec
929 Used in GDB.
931 @item exit
932 @samp{-x} in @code{xargs}.
934 @item exit-0
935 @samp{-e} in @code{unshar}.
937 @item expand-tabs
938 @samp{-t} in @code{diff}.
940 @item expression
941 @samp{-e} in @code{sed}.
943 @item extern-only
944 @samp{-g} in @code{nm}.
946 @item extract
947 @samp{-i} in @code{cpio};
948 @samp{-x} in @code{tar}.
950 @item faces
951 @samp{-f} in @code{finger}.
953 @item fast
954 @samp{-f} in @code{su}.
956 @item fatal-warnings
957 @samp{-E} in @code{m4}.
959 @item file
960 @samp{-f} in @code{info}, @code{gawk}, Make, @code{mt}, and @code{tar};
961 @samp{-n} in @code{sed};
962 @samp{-r} in @code{touch}.
964 @item field-separator
965 @samp{-F} in @code{gawk}.
967 @item file-prefix
968 @samp{-b} in Bison.
970 @item file-type
971 @samp{-F} in @code{ls}.
973 @item files-from
974 @samp{-T} in @code{tar}.
976 @item fill-column
977 Used in @code{makeinfo}.
979 @item flag-truncation
980 @samp{-F} in @code{ptx}.
982 @item fixed-output-files
983 @samp{-y} in Bison.
985 @item follow
986 @samp{-f} in @code{tail}.
988 @item footnote-style
989 Used in @code{makeinfo}.
991 @item force
992 @samp{-f} in @code{cp}, @code{ln}, @code{mv}, and @code{rm}.
994 @item force-prefix
995 @samp{-F} in @code{shar}.
997 @item format
998 Used in @code{ls}, @code{time}, and @code{ptx}.
1000 @item freeze-state
1001 @samp{-F} in @code{m4}.
1003 @item fullname
1004 Used in GDB.
1006 @item gap-size
1007 @samp{-g} in @code{ptx}.
1009 @item get
1010 @samp{-x} in @code{tar}.
1012 @item graphic
1013 @samp{-i} in @code{ul}.
1015 @item graphics
1016 @samp{-g} in @code{recode}.
1018 @item group
1019 @samp{-g} in @code{install}.
1021 @item gzip
1022 @samp{-z} in @code{tar} and @code{shar}.
1024 @item hashsize
1025 @samp{-H} in @code{m4}.
1027 @item header
1028 @samp{-h} in @code{objdump} and @code{recode}
1030 @item heading
1031 @samp{-H} in @code{who}.
1033 @item help
1034 Used to ask for brief usage information.
1036 @item here-delimiter
1037 @samp{-d} in @code{shar}.
1039 @item hide-control-chars
1040 @samp{-q} in @code{ls}.
1042 @item idle
1043 @samp{-u} in @code{who}.
1045 @item ifdef
1046 @samp{-D} in @code{diff}.
1048 @item ignore
1049 @samp{-I} in @code{ls};
1050 @samp{-x} in @code{recode}.
1052 @item ignore-all-space
1053 @samp{-w} in @code{diff}.
1055 @item ignore-backups
1056 @samp{-B} in @code{ls}.
1058 @item ignore-blank-lines
1059 @samp{-B} in @code{diff}.
1061 @item ignore-case
1062 @samp{-f} in @code{look} and @code{ptx};
1063 @samp{-i} in @code{diff} and @code{wdiff}.
1065 @item ignore-errors
1066 @samp{-i} in Make.
1068 @item ignore-file
1069 @samp{-i} in @code{ptx}.
1071 @item ignore-indentation
1072 @samp{-I} in @code{etags}.
1074 @item ignore-init-file
1075 @samp{-f} in Oleo.
1077 @item ignore-interrupts
1078 @samp{-i} in @code{tee}.
1080 @item ignore-matching-lines
1081 @samp{-I} in @code{diff}.
1083 @item ignore-space-change
1084 @samp{-b} in @code{diff}.
1086 @item ignore-zeros
1087 @samp{-i} in @code{tar}.
1089 @item include
1090 @samp{-i} in @code{etags};
1091 @samp{-I} in @code{m4}.
1093 @item include-dir
1094 @samp{-I} in Make.
1096 @item incremental
1097 @samp{-G} in @code{tar}.
1099 @item info
1100 @samp{-i}, @samp{-l}, and @samp{-m} in Finger.
1102 @item initial
1103 @samp{-i} in @code{expand}.
1105 @item initial-tab
1106 @samp{-T} in @code{diff}.
1108 @item inode
1109 @samp{-i} in @code{ls}.
1111 @item interactive
1112 @samp{-i} in @code{cp}, @code{ln}, @code{mv}, @code{rm};
1113 @samp{-e} in @code{m4};
1114 @samp{-p} in @code{xargs};
1115 @samp{-w} in @code{tar}.
1117 @item intermix-type
1118 @samp{-p} in @code{shar}.
1120 @item jobs
1121 @samp{-j} in Make.
1123 @item just-print
1124 @samp{-n} in Make.
1126 @item keep-going
1127 @samp{-k} in Make.
1129 @item keep-files
1130 @samp{-k} in @code{csplit}.
1132 @item kilobytes
1133 @samp{-k} in @code{du} and @code{ls}.
1135 @item language
1136 @samp{-l} in @code{etags}.
1138 @item less-mode
1139 @samp{-l} in @code{wdiff}.
1141 @item level-for-gzip
1142 @samp{-g} in @code{shar}.
1144 @item line-bytes
1145 @samp{-C} in @code{split}.
1147 @item lines
1148 Used in @code{split}, @code{head}, and @code{tail}.
1150 @item link
1151 @samp{-l} in @code{cpio}.
1153 @item lint
1154 @itemx lint-old
1155 Used in @code{gawk}.
1157 @item list
1158 @samp{-t} in @code{cpio};
1159 @samp{-l} in @code{recode}.
1161 @item list
1162 @samp{-t} in @code{tar}.
1164 @item literal
1165 @samp{-N} in @code{ls}.
1167 @item load-average
1168 @samp{-l} in Make.
1170 @item login
1171 Used in @code{su}.
1173 @item machine
1174 No listing of which programs already use this;
1175 someone should check to
1176 see if any actually do, and tell @email{gnu@@gnu.org}.
1178 @item macro-name
1179 @samp{-M} in @code{ptx}.
1181 @item mail
1182 @samp{-m} in @code{hello} and @code{uname}.
1184 @item make-directories
1185 @samp{-d} in @code{cpio}.
1187 @item makefile
1188 @samp{-f} in Make.
1190 @item mapped
1191 Used in GDB.
1193 @item max-args
1194 @samp{-n} in @code{xargs}.
1196 @item max-chars
1197 @samp{-n} in @code{xargs}.
1199 @item max-lines
1200 @samp{-l} in @code{xargs}.
1202 @item max-load
1203 @samp{-l} in Make.
1205 @item max-procs
1206 @samp{-P} in @code{xargs}.
1208 @item mesg
1209 @samp{-T} in @code{who}.
1211 @item message
1212 @samp{-T} in @code{who}.
1214 @item minimal
1215 @samp{-d} in @code{diff}.
1217 @item mixed-uuencode
1218 @samp{-M} in @code{shar}.
1220 @item mode
1221 @samp{-m} in @code{install}, @code{mkdir}, and @code{mkfifo}.
1223 @item modification-time
1224 @samp{-m} in @code{tar}.
1226 @item multi-volume
1227 @samp{-M} in @code{tar}.
1229 @item name-prefix
1230 @samp{-a} in Bison.
1232 @item nesting-limit
1233 @samp{-L} in @code{m4}.
1235 @item net-headers
1236 @samp{-a} in @code{shar}.
1238 @item new-file
1239 @samp{-W} in Make.
1241 @item no-builtin-rules
1242 @samp{-r} in Make.
1244 @item no-character-count
1245 @samp{-w} in @code{shar}.
1247 @item no-check-existing
1248 @samp{-x} in @code{shar}.
1250 @item no-common
1251 @samp{-3} in @code{wdiff}.
1253 @item no-create
1254 @samp{-c} in @code{touch}.
1256 @item no-defines
1257 @samp{-D} in @code{etags}.
1259 @item no-deleted
1260 @samp{-1} in @code{wdiff}.
1262 @item no-dereference
1263 @samp{-d} in @code{cp}.
1265 @item no-inserted
1266 @samp{-2} in @code{wdiff}.
1268 @item no-keep-going
1269 @samp{-S} in Make.
1271 @item no-lines
1272 @samp{-l} in Bison.
1274 @item no-piping
1275 @samp{-P} in @code{shar}.
1277 @item no-prof
1278 @samp{-e} in @code{gprof}.
1280 @item no-regex
1281 @samp{-R} in @code{etags}.
1283 @item no-sort
1284 @samp{-p} in @code{nm}.
1286 @item no-split
1287 Used in @code{makeinfo}.
1289 @item no-static
1290 @samp{-a} in @code{gprof}.
1292 @item no-time
1293 @samp{-E} in @code{gprof}.
1295 @item no-timestamp
1296 @samp{-m} in @code{shar}.
1298 @item no-validate
1299 Used in @code{makeinfo}.
1301 @item no-wait
1302 Used in @code{emacsclient}.
1304 @item no-warn
1305 Used in various programs to inhibit warnings.
1307 @item node
1308 @samp{-n} in @code{info}.
1310 @item nodename
1311 @samp{-n} in @code{uname}.
1313 @item nonmatching
1314 @samp{-f} in @code{cpio}.
1316 @item nstuff
1317 @samp{-n} in @code{objdump}.
1319 @item null
1320 @samp{-0} in @code{xargs}.
1322 @item number
1323 @samp{-n} in @code{cat}.
1325 @item number-nonblank
1326 @samp{-b} in @code{cat}.
1328 @item numeric-sort
1329 @samp{-n} in @code{nm}.
1331 @item numeric-uid-gid
1332 @samp{-n} in @code{cpio} and @code{ls}.
1334 @item nx
1335 Used in GDB.
1337 @item old-archive
1338 @samp{-o} in @code{tar}.
1340 @item old-file
1341 @samp{-o} in Make.
1343 @item one-file-system
1344 @samp{-l} in @code{tar}, @code{cp}, and @code{du}.
1346 @item only-file
1347 @samp{-o} in @code{ptx}.
1349 @item only-prof
1350 @samp{-f} in @code{gprof}.
1352 @item only-time
1353 @samp{-F} in @code{gprof}.
1355 @item output
1356 In various programs, specify the output file name.
1358 @item output-prefix
1359 @samp{-o} in @code{shar}.
1361 @item override
1362 @samp{-o} in @code{rm}.
1364 @item overwrite
1365 @samp{-c} in @code{unshar}.
1367 @item owner
1368 @samp{-o} in @code{install}.
1370 @item paginate
1371 @samp{-l} in @code{diff}.
1373 @item paragraph-indent
1374 Used in @code{makeinfo}.
1376 @item parents
1377 @samp{-p} in @code{mkdir} and @code{rmdir}.
1379 @item pass-all
1380 @samp{-p} in @code{ul}.
1382 @item pass-through
1383 @samp{-p} in @code{cpio}.
1385 @item port
1386 @samp{-P} in @code{finger}.
1388 @item portability
1389 @samp{-c} in @code{cpio} and @code{tar}.
1391 @item posix
1392 Used in @code{gawk}.
1394 @item prefix-builtins
1395 @samp{-P} in @code{m4}.
1397 @item prefix
1398 @samp{-f} in @code{csplit}.
1400 @item preserve
1401 Used in @code{tar} and @code{cp}.
1403 @item preserve-environment
1404 @samp{-p} in @code{su}.
1406 @item preserve-modification-time
1407 @samp{-m} in @code{cpio}.
1409 @item preserve-order
1410 @samp{-s} in @code{tar}.
1412 @item preserve-permissions
1413 @samp{-p} in @code{tar}.
1415 @item print
1416 @samp{-l} in @code{diff}.
1418 @item print-chars
1419 @samp{-L} in @code{cmp}.
1421 @item print-data-base
1422 @samp{-p} in Make.
1424 @item print-directory
1425 @samp{-w} in Make.
1427 @item print-file-name
1428 @samp{-o} in @code{nm}.
1430 @item print-symdefs
1431 @samp{-s} in @code{nm}.
1433 @item printer
1434 @samp{-p} in @code{wdiff}.
1436 @item prompt
1437 @samp{-p} in @code{ed}.
1439 @item query-user
1440 @samp{-X} in @code{shar}.
1442 @item question
1443 @samp{-q} in Make.
1445 @item quiet
1446 Used in many programs to inhibit the usual output.  @strong{Note:} every
1447 program accepting @samp{--quiet} should accept @samp{--silent} as a
1448 synonym.
1450 @item quiet-unshar
1451 @samp{-Q} in @code{shar}
1453 @item quote-name
1454 @samp{-Q} in @code{ls}.
1456 @item rcs
1457 @samp{-n} in @code{diff}.
1459 @item re-interval
1460 Used in @code{gawk}.
1462 @item read-full-blocks
1463 @samp{-B} in @code{tar}.
1465 @item readnow
1466 Used in GDB.
1468 @item recon
1469 @samp{-n} in Make.
1471 @item record-number
1472 @samp{-R} in @code{tar}.
1474 @item recursive
1475 Used in @code{chgrp}, @code{chown}, @code{cp}, @code{ls}, @code{diff},
1476 and @code{rm}.
1478 @item reference-limit
1479 Used in @code{makeinfo}.
1481 @item references
1482 @samp{-r} in @code{ptx}.
1484 @item regex
1485 @samp{-r} in @code{tac} and @code{etags}.
1487 @item release
1488 @samp{-r} in @code{uname}.
1490 @item reload-state
1491 @samp{-R} in @code{m4}.
1493 @item relocation
1494 @samp{-r} in @code{objdump}.
1496 @item rename
1497 @samp{-r} in @code{cpio}.
1499 @item replace
1500 @samp{-i} in @code{xargs}.
1502 @item report-identical-files
1503 @samp{-s} in @code{diff}.
1505 @item reset-access-time
1506 @samp{-a} in @code{cpio}.
1508 @item reverse
1509 @samp{-r} in @code{ls} and @code{nm}.
1511 @item reversed-ed
1512 @samp{-f} in @code{diff}.
1514 @item right-side-defs
1515 @samp{-R} in @code{ptx}.
1517 @item same-order
1518 @samp{-s} in @code{tar}.
1520 @item same-permissions
1521 @samp{-p} in @code{tar}.
1523 @item save
1524 @samp{-g} in @code{stty}.
1526 @item se
1527 Used in GDB.
1529 @item sentence-regexp
1530 @samp{-S} in @code{ptx}.
1532 @item separate-dirs
1533 @samp{-S} in @code{du}.
1535 @item separator
1536 @samp{-s} in @code{tac}.
1538 @item sequence
1539 Used by @code{recode} to chose files or pipes for sequencing passes.
1541 @item shell
1542 @samp{-s} in @code{su}.
1544 @item show-all
1545 @samp{-A} in @code{cat}.
1547 @item show-c-function
1548 @samp{-p} in @code{diff}.
1550 @item show-ends
1551 @samp{-E} in @code{cat}.
1553 @item show-function-line
1554 @samp{-F} in @code{diff}.
1556 @item show-tabs
1557 @samp{-T} in @code{cat}.
1559 @item silent
1560 Used in many programs to inhibit the usual output.
1561 @strong{Note:} every program accepting
1562 @samp{--silent} should accept @samp{--quiet} as a synonym.
1564 @item size
1565 @samp{-s} in @code{ls}.
1567 @item sort
1568 Used in @code{ls}.
1570 @item source
1571 @samp{-W source} in @code{gawk}.
1573 @item sparse
1574 @samp{-S} in @code{tar}.
1576 @item speed-large-files
1577 @samp{-H} in @code{diff}.
1579 @item split-at
1580 @samp{-E} in @code{unshar}.
1582 @item split-size-limit
1583 @samp{-L} in @code{shar}.
1585 @item squeeze-blank
1586 @samp{-s} in @code{cat}.
1588 @item start-delete
1589 @samp{-w} in @code{wdiff}.
1591 @item start-insert
1592 @samp{-y} in @code{wdiff}.
1594 @item starting-file
1595 Used in @code{tar} and @code{diff} to specify which file within
1596 a directory to start processing with.
1598 @item statistics
1599 @samp{-s} in @code{wdiff}.
1601 @item stdin-file-list
1602 @samp{-S} in @code{shar}.
1604 @item stop
1605 @samp{-S} in Make.
1607 @item strict
1608 @samp{-s} in @code{recode}.
1610 @item strip
1611 @samp{-s} in @code{install}.
1613 @item strip-all
1614 @samp{-s} in @code{strip}.
1616 @item strip-debug
1617 @samp{-S} in @code{strip}.
1619 @item submitter
1620 @samp{-s} in @code{shar}.
1622 @item suffix
1623 @samp{-S} in @code{cp}, @code{ln}, @code{mv}.
1625 @item suffix-format
1626 @samp{-b} in @code{csplit}.
1628 @item sum
1629 @samp{-s} in @code{gprof}.
1631 @item summarize
1632 @samp{-s} in @code{du}.
1634 @item symbolic
1635 @samp{-s} in @code{ln}.
1637 @item symbols
1638 Used in GDB and @code{objdump}.
1640 @item synclines
1641 @samp{-s} in @code{m4}.
1643 @item sysname
1644 @samp{-s} in @code{uname}.
1646 @item tabs
1647 @samp{-t} in @code{expand} and @code{unexpand}.
1649 @item tabsize
1650 @samp{-T} in @code{ls}.
1652 @item terminal
1653 @samp{-T} in @code{tput} and @code{ul}.
1654 @samp{-t} in @code{wdiff}.
1656 @item text
1657 @samp{-a} in @code{diff}.
1659 @item text-files
1660 @samp{-T} in @code{shar}.
1662 @item time
1663 Used in @code{ls} and @code{touch}.
1665 @item to-stdout
1666 @samp{-O} in @code{tar}.
1668 @item total
1669 @samp{-c} in @code{du}.
1671 @item touch
1672 @samp{-t} in Make, @code{ranlib}, and @code{recode}.
1674 @item trace
1675 @samp{-t} in @code{m4}.
1677 @item traditional
1678 @samp{-t} in @code{hello};
1679 @samp{-W traditional} in @code{gawk};
1680 @samp{-G} in @code{ed}, @code{m4}, and @code{ptx}.
1682 @item tty
1683 Used in GDB.
1685 @item typedefs
1686 @samp{-t} in @code{ctags}.
1688 @item typedefs-and-c++
1689 @samp{-T} in @code{ctags}.
1691 @item typeset-mode
1692 @samp{-t} in @code{ptx}.
1694 @item uncompress
1695 @samp{-z} in @code{tar}.
1697 @item unconditional
1698 @samp{-u} in @code{cpio}.
1700 @item undefine
1701 @samp{-U} in @code{m4}.
1703 @item undefined-only
1704 @samp{-u} in @code{nm}.
1706 @item update
1707 @samp{-u} in @code{cp}, @code{ctags}, @code{mv}, @code{tar}.
1709 @item usage
1710 Used in @code{gawk}; same as @samp{--help}.
1712 @item uuencode
1713 @samp{-B} in @code{shar}.
1715 @item vanilla-operation
1716 @samp{-V} in @code{shar}.
1718 @item verbose
1719 Print more information about progress.  Many programs support this.
1721 @item verify
1722 @samp{-W} in @code{tar}.
1724 @item version
1725 Print the version number.
1727 @item version-control
1728 @samp{-V} in @code{cp}, @code{ln}, @code{mv}.
1730 @item vgrind
1731 @samp{-v} in @code{ctags}.
1733 @item volume
1734 @samp{-V} in @code{tar}.
1736 @item what-if
1737 @samp{-W} in Make.
1739 @item whole-size-limit
1740 @samp{-l} in @code{shar}.
1742 @item width
1743 @samp{-w} in @code{ls} and @code{ptx}.
1745 @item word-regexp
1746 @samp{-W} in @code{ptx}.
1748 @item writable
1749 @samp{-T} in @code{who}.
1751 @item zeros
1752 @samp{-z} in @code{gprof}.
1753 @end table
1755 @node Memory Usage
1756 @section Memory Usage
1758 If it typically uses just a few meg of memory, don't bother making any
1759 effort to reduce memory usage.  For example, if it is impractical for
1760 other reasons to operate on files more than a few meg long, it is
1761 reasonable to read entire input files into core to operate on them.
1763 However, for programs such as @code{cat} or @code{tail}, that can
1764 usefully operate on very large files, it is important to avoid using a
1765 technique that would artificially limit the size of files it can handle.
1766 If a program works by lines and could be applied to arbitrary
1767 user-supplied input files, it should keep only a line in memory, because
1768 this is not very hard and users will want to be able to operate on input
1769 files that are bigger than will fit in core all at once.
1771 If your program creates complicated data structures, just make them in
1772 core and give a fatal error if @code{malloc} returns zero.
1774 @node Writing C
1775 @chapter Making The Best Use of C
1777 This @value{CHAPTER} provides advice on how best to use the C language
1778 when writing GNU software.
1780 @menu
1781 * Formatting::                  Formatting Your Source Code
1782 * Comments::                    Commenting Your Work
1783 * Syntactic Conventions::       Clean Use of C Constructs
1784 * Names::                       Naming Variables and Functions
1785 * System Portability::          Portability between different operating systems
1786 * CPU Portability::             Supporting the range of CPU types
1787 * System Functions::            Portability and ``standard'' library functions
1788 * Internationalization::        Techniques for internationalization
1789 * Mmap::                        How you can safely use @code{mmap}.
1790 @end menu
1792 @node Formatting
1793 @section Formatting Your Source Code
1795 It is important to put the open-brace that starts the body of a C
1796 function in column zero, and avoid putting any other open-brace or
1797 open-parenthesis or open-bracket in column zero.  Several tools look
1798 for open-braces in column zero to find the beginnings of C functions.
1799 These tools will not work on code not formatted that way.
1801 It is also important for function definitions to start the name of the
1802 function in column zero.  This helps people to search for function
1803 definitions, and may also help certain tools recognize them.  Thus,
1804 the proper format is this:
1806 @example
1807 static char *
1808 concat (s1, s2)        /* Name starts in column zero here */
1809      char *s1, *s2;
1810 @{                     /* Open brace in column zero here */
1811   @dots{}
1813 @end example
1815 @noindent
1816 or, if you want to use @sc{ansi} C, format the definition like this:
1818 @example
1819 static char *
1820 concat (char *s1, char *s2)
1822   @dots{}
1824 @end example
1826 In @sc{ansi} C, if the arguments don't fit nicely on one line,
1827 split it like this:
1829 @example
1831 lots_of_args (int an_integer, long a_long, short a_short,
1832               double a_double, float a_float)
1833 @dots{}
1834 @end example
1836 For the body of the function, we prefer code formatted like this:
1838 @example
1839 if (x < foo (y, z))
1840   haha = bar[4] + 5;
1841 else
1842   @{
1843     while (z)
1844       @{
1845         haha += foo (z, z);
1846         z--;
1847       @}
1848     return ++x + bar ();
1849   @}
1850 @end example
1852 We find it easier to read a program when it has spaces before the
1853 open-parentheses and after the commas.  Especially after the commas.
1855 When you split an expression into multiple lines, split it
1856 before an operator, not after one.  Here is the right way:
1858 @example
1859 if (foo_this_is_long && bar > win (x, y, z)
1860     && remaining_condition)
1861 @end example
1863 Try to avoid having two operators of different precedence at the same
1864 level of indentation.  For example, don't write this:
1866 @example
1867 mode = (inmode[j] == VOIDmode
1868         || GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])
1869         ? outmode[j] : inmode[j]);
1870 @end example
1872 Instead, use extra parentheses so that the indentation shows the nesting:
1874 @example
1875 mode = ((inmode[j] == VOIDmode
1876          || (GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])))
1877         ? outmode[j] : inmode[j]);
1878 @end example
1880 Insert extra parentheses so that Emacs will indent the code properly.
1881 For example, the following indentation looks nice if you do it by hand,
1882 but Emacs would mess it up:
1884 @example
1885 v = rup->ru_utime.tv_sec*1000 + rup->ru_utime.tv_usec/1000
1886     + rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000;
1887 @end example
1889 But adding a set of parentheses solves the problem:
1891 @example
1892 v = (rup->ru_utime.tv_sec*1000 + rup->ru_utime.tv_usec/1000
1893      + rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000);
1894 @end example
1896 Format do-while statements like this:
1898 @example
1900   @{
1901     a = foo (a);
1902   @}
1903 while (a > 0);
1904 @end example
1906 Please use formfeed characters (control-L) to divide the program into
1907 pages at logical places (but not within a function).  It does not matter
1908 just how long the pages are, since they do not have to fit on a printed
1909 page.  The formfeeds should appear alone on lines by themselves.
1912 @node Comments
1913 @section Commenting Your Work
1915 Every program should start with a comment saying briefly what it is for.
1916 Example: @samp{fmt - filter for simple filling of text}.
1918 Please write the comments in a GNU program in English, because English
1919 is the one language that nearly all programmers in all countries can
1920 read.  If you do not write English well, please write comments in
1921 English as well as you can, then ask other people to help rewrite them.
1922 If you can't write comments in English, please find someone to work with
1923 you and translate your comments into English.
1925 Please put a comment on each function saying what the function does,
1926 what sorts of arguments it gets, and what the possible values of
1927 arguments mean and are used for.  It is not necessary to duplicate in
1928 words the meaning of the C argument declarations, if a C type is being
1929 used in its customary fashion.  If there is anything nonstandard about
1930 its use (such as an argument of type @code{char *} which is really the
1931 address of the second character of a string, not the first), or any
1932 possible values that would not work the way one would expect (such as,
1933 that strings containing newlines are not guaranteed to work), be sure
1934 to say so.
1936 Also explain the significance of the return value, if there is one.
1938 Please put two spaces after the end of a sentence in your comments, so
1939 that the Emacs sentence commands will work.  Also, please write
1940 complete sentences and capitalize the first word.  If a lower-case
1941 identifier comes at the beginning of a sentence, don't capitalize it!
1942 Changing the spelling makes it a different identifier.  If you don't
1943 like starting a sentence with a lower case letter, write the sentence
1944 differently (e.g., ``The identifier lower-case is @dots{}'').
1946 The comment on a function is much clearer if you use the argument
1947 names to speak about the argument values.  The variable name itself
1948 should be lower case, but write it in upper case when you are speaking
1949 about the value rather than the variable itself.  Thus, ``the inode
1950 number NODE_NUM'' rather than ``an inode''.
1952 There is usually no purpose in restating the name of the function in
1953 the comment before it, because the reader can see that for himself.
1954 There might be an exception when the comment is so long that the function
1955 itself would be off the bottom of the screen.
1957 There should be a comment on each static variable as well, like this:
1959 @example
1960 /* Nonzero means truncate lines in the display;
1961    zero means continue them.  */
1962 int truncate_lines;
1963 @end example
1965 Every @samp{#endif} should have a comment, except in the case of short
1966 conditionals (just a few lines) that are not nested.  The comment should
1967 state the condition of the conditional that is ending, @emph{including
1968 its sense}.  @samp{#else} should have a comment describing the condition
1969 @emph{and sense} of the code that follows.  For example:
1971 @example
1972 @group
1973 #ifdef foo
1974   @dots{}
1975 #else /* not foo */
1976   @dots{}
1977 #endif /* not foo */
1978 @end group
1979 @group
1980 #ifdef foo
1981   @dots{}
1982 #endif /* foo */
1983 @end group
1984 @end example
1986 @noindent
1987 but, by contrast, write the comments this way for a @samp{#ifndef}:
1989 @example
1990 @group
1991 #ifndef foo
1992   @dots{}
1993 #else /* foo */
1994   @dots{}
1995 #endif /* foo */
1996 @end group
1997 @group
1998 #ifndef foo
1999   @dots{}
2000 #endif /* not foo */
2001 @end group
2002 @end example
2004 @node Syntactic Conventions
2005 @section Clean Use of C Constructs
2007 Please explicitly declare all arguments to functions.
2008 Don't omit them just because they are @code{int}s.
2010 Declarations of external functions and functions to appear later in the
2011 source file should all go in one place near the beginning of the file
2012 (somewhere before the first function definition in the file), or else
2013 should go in a header file.  Don't put @code{extern} declarations inside
2014 functions.
2016 It used to be common practice to use the same local variables (with
2017 names like @code{tem}) over and over for different values within one
2018 function.  Instead of doing this, it is better declare a separate local
2019 variable for each distinct purpose, and give it a name which is
2020 meaningful.  This not only makes programs easier to understand, it also
2021 facilitates optimization by good compilers.  You can also move the
2022 declaration of each local variable into the smallest scope that includes
2023 all its uses.  This makes the program even cleaner.
2025 Don't use local variables or parameters that shadow global identifiers.
2027 Don't declare multiple variables in one declaration that spans lines.
2028 Start a new declaration on each line, instead.  For example, instead
2029 of this:
2031 @example
2032 @group
2033 int    foo,
2034        bar;
2035 @end group
2036 @end example
2038 @noindent
2039 write either this:
2041 @example
2042 int foo, bar;
2043 @end example
2045 @noindent
2046 or this:
2048 @example
2049 int foo;
2050 int bar;
2051 @end example
2053 @noindent
2054 (If they are global variables, each should have a comment preceding it
2055 anyway.)
2057 When you have an @code{if}-@code{else} statement nested in another
2058 @code{if} statement, always put braces around the @code{if}-@code{else}.
2059 Thus, never write like this:
2061 @example
2062 if (foo)
2063   if (bar)
2064     win ();
2065   else
2066     lose ();
2067 @end example
2069 @noindent
2070 always like this:
2072 @example
2073 if (foo)
2074   @{
2075     if (bar)
2076       win ();
2077     else
2078       lose ();
2079   @}
2080 @end example
2082 If you have an @code{if} statement nested inside of an @code{else}
2083 statement, either write @code{else if} on one line, like this,
2085 @example
2086 if (foo)
2087   @dots{}
2088 else if (bar)
2089   @dots{}
2090 @end example
2092 @noindent
2093 with its @code{then}-part indented like the preceding @code{then}-part,
2094 or write the nested @code{if} within braces like this:
2096 @example
2097 if (foo)
2098   @dots{}
2099 else
2100   @{
2101     if (bar)
2102       @dots{}
2103   @}
2104 @end example
2106 Don't declare both a structure tag and variables or typedefs in the
2107 same declaration.  Instead, declare the structure tag separately
2108 and then use it to declare the variables or typedefs.
2110 Try to avoid assignments inside @code{if}-conditions.  For example,
2111 don't write this:
2113 @example
2114 if ((foo = (char *) malloc (sizeof *foo)) == 0)
2115   fatal ("virtual memory exhausted");
2116 @end example
2118 @noindent
2119 instead, write this:
2121 @example
2122 foo = (char *) malloc (sizeof *foo);
2123 if (foo == 0)
2124   fatal ("virtual memory exhausted");
2125 @end example
2127 Don't make the program ugly to placate @code{lint}.  Please don't insert any
2128 casts to @code{void}.  Zero without a cast is perfectly fine as a null
2129 pointer constant, except when calling a varargs function.
2131 @node  Names
2132 @section Naming Variables and Functions
2134 The names of global variables and functions in a program serve as
2135 comments of a sort.  So don't choose terse names---instead, look for
2136 names that give useful information about the meaning of the variable or
2137 function.  In a GNU program, names should be English, like other
2138 comments.
2140 Local variable names can be shorter, because they are used only within
2141 one context, where (presumably) comments explain their purpose.
2143 Please use underscores to separate words in a name, so that the Emacs
2144 word commands can be useful within them.  Stick to lower case; reserve
2145 upper case for macros and @code{enum} constants, and for name-prefixes
2146 that follow a uniform convention.
2148 For example, you should use names like @code{ignore_space_change_flag};
2149 don't use names like @code{iCantReadThis}.
2151 Variables that indicate whether command-line options have been
2152 specified should be named after the meaning of the option, not after
2153 the option-letter.  A comment should state both the exact meaning of
2154 the option and its letter.  For example,
2156 @example
2157 @group
2158 /* Ignore changes in horizontal whitespace (-b).  */
2159 int ignore_space_change_flag;
2160 @end group
2161 @end example
2163 When you want to define names with constant integer values, use
2164 @code{enum} rather than @samp{#define}.  GDB knows about enumeration
2165 constants.
2167 Use file names of 14 characters or less, to avoid creating gratuitous
2168 problems on older System V systems.  You can use the program
2169 @code{doschk} to test for this.  @code{doschk} also tests for potential
2170 name conflicts if the files were loaded onto an MS-DOS file
2171 system---something you may or may not care about.
2173 @node System Portability
2174 @section Portability between System Types
2176 In the Unix world, ``portability'' refers to porting to different Unix
2177 versions.  For a GNU program, this kind of portability is desirable, but
2178 not paramount.
2180 The primary purpose of GNU software is to run on top of the GNU kernel,
2181 compiled with the GNU C compiler, on various types of @sc{cpu}.  The
2182 amount and kinds of variation among GNU systems on different @sc{cpu}s
2183 will be comparable to the variation among Linux-based GNU systems or
2184 among BSD systems today.  So the kinds of portability that are absolutely
2185 necessary are quite limited.
2187 But many users do run GNU software on non-GNU Unix or Unix-like systems.
2188 So supporting a variety of Unix-like systems is desirable, although not
2189 paramount.
2191 The easiest way to achieve portability to most Unix-like systems is to
2192 use Autoconf.  It's unlikely that your program needs to know more
2193 information about the host platform than Autoconf can provide, simply
2194 because most of the programs that need such knowledge have already been
2195 written.
2197 Avoid using the format of semi-internal data bases (e.g., directories)
2198 when there is a higher-level alternative (@code{readdir}).
2200 As for systems that are not like Unix, such as MSDOS, Windows, the
2201 Macintosh, VMS, and MVS, supporting them is usually so much work that it
2202 is better if you don't.
2204 The planned GNU kernel is not finished yet, but you can tell which
2205 facilities it will provide by looking at the GNU C Library Manual.  The
2206 GNU kernel is based on Mach, so the features of Mach will also be
2207 available.  However, if you use Mach features, you'll probably have
2208 trouble debugging your program today.
2210 @node CPU Portability
2211 @section Portability between @sc{cpu}s
2213 Even GNU systems will differ because of differences among @sc{cpu}
2214 types---for example, difference in byte ordering and alignment
2215 requirements.  It is absolutely essential to handle these differences.
2216 However, don't make any effort to cater to the possibility that an
2217 @code{int} will be less than 32 bits.  We don't support 16-bit machines
2218 in GNU.
2220 Don't assume that the address of an @code{int} object is also the
2221 address of its least-significant byte.  This is false on big-endian
2222 machines.  Thus, don't make the following mistake:
2224 @example
2225 int c;
2226 @dots{}
2227 while ((c = getchar()) != EOF)
2228   write(file_descriptor, &c, 1);
2229 @end example
2231 When calling functions, you need not worry about the difference between
2232 pointers of various types, or between pointers and integers.  On most
2233 machines, there's no difference anyway.  As for the few machines where
2234 there is a difference, all of them support @sc{ansi} C, so you can use
2235 prototypes (conditionalized to be active only in @sc{ansi} C) to make
2236 the code work on those systems.
2238 In certain cases, it is ok to pass integer and pointer arguments
2239 indiscriminately to the same function, and use no prototype on any
2240 system.  For example, many GNU programs have error-reporting functions
2241 that pass their arguments along to @code{printf} and friends:
2243 @example
2244 error (s, a1, a2, a3)
2245      char *s;
2246      int a1, a2, a3;
2248   fprintf (stderr, "error: ");
2249   fprintf (stderr, s, a1, a2, a3);
2251 @end example
2253 @noindent
2254 In practice, this works on all machines, and it is much simpler than any
2255 ``correct'' alternative.  Be sure @emph{not} to use a prototype
2256 for such functions.
2258 However, avoid casting pointers to integers unless you really need to.
2259 These assumptions really reduce portability, and in most programs they
2260 are easy to avoid.  In the cases where casting pointers to integers is
2261 essential---such as, a Lisp interpreter which stores type information as
2262 well as an address in one word---it is ok to do so, but you'll have to
2263 make explicit provisions to handle different word sizes.
2265 @node System Functions
2266 @section Calling System Functions
2268 C implementations differ substantially.  @sc{ansi} C reduces but does not
2269 eliminate the incompatibilities; meanwhile, many users wish to compile
2270 GNU software with pre-@sc{ansi} compilers.  This chapter gives
2271 recommendations for how to use the more or less standard C library
2272 functions to avoid unnecessary loss of portability.
2274 @itemize @bullet
2275 @item
2276 Don't use the value of @code{sprintf}.  It returns the number of
2277 characters written on some systems, but not on all systems.
2279 @item
2280 @code{main} should be declared to return type @code{int}.  It should
2281 terminate either by calling @code{exit} or by returning the integer
2282 status code; make sure it cannot ever return an undefined value.
2284 @item
2285 Don't declare system functions explicitly.
2287 Almost any declaration for a system function is wrong on some system.
2288 To minimize conflicts, leave it to the system header files to declare
2289 system functions.  If the headers don't declare a function, let it
2290 remain undeclared.
2292 While it may seem unclean to use a function without declaring it, in
2293 practice this works fine for most system library functions on the
2294 systems where this really happens; thus, the disadvantage is only
2295 theoretical.  By contrast, actual declarations have frequently caused
2296 actual conflicts.
2298 @item
2299 If you must declare a system function, don't specify the argument types.
2300 Use an old-style declaration, not an @sc{ansi} prototype.  The more you
2301 specify about the function, the more likely a conflict.
2303 @item
2304 In particular, don't unconditionally declare @code{malloc} or
2305 @code{realloc}.
2307 Most GNU programs use those functions just once, in functions
2308 conventionally named @code{xmalloc} and @code{xrealloc}.  These
2309 functions call @code{malloc} and @code{realloc}, respectively, and
2310 check the results.
2312 Because @code{xmalloc} and @code{xrealloc} are defined in your program,
2313 you can declare them in other files without any risk of type conflict.
2315 On most systems, @code{int} is the same length as a pointer; thus, the
2316 calls to @code{malloc} and @code{realloc} work fine.  For the few
2317 exceptional systems (mostly 64-bit machines), you can use
2318 @strong{conditionalized} declarations of @code{malloc} and
2319 @code{realloc}---or put these declarations in configuration files
2320 specific to those systems.
2322 @item
2323 The string functions require special treatment.  Some Unix systems have
2324 a header file @file{string.h}; others have @file{strings.h}.  Neither
2325 file name is portable.  There are two things you can do: use Autoconf to
2326 figure out which file to include, or don't include either file.
2328 @item
2329 If you don't include either strings file, you can't get declarations for
2330 the string functions from the header file in the usual way.
2332 That causes less of a problem than you might think.  The newer @sc{ansi}
2333 string functions should be avoided anyway because many systems still
2334 don't support them.  The string functions you can use are these:
2336 @example
2337 strcpy   strncpy   strcat   strncat
2338 strlen   strcmp    strncmp
2339 strchr   strrchr
2340 @end example
2342 The copy and concatenate functions work fine without a declaration as
2343 long as you don't use their values.  Using their values without a
2344 declaration fails on systems where the width of a pointer differs from
2345 the width of @code{int}, and perhaps in other cases.  It is trivial to
2346 avoid using their values, so do that.
2348 The compare functions and @code{strlen} work fine without a declaration
2349 on most systems, possibly all the ones that GNU software runs on.
2350 You may find it necessary to declare them @strong{conditionally} on a
2351 few systems.
2353 The search functions must be declared to return @code{char *}.  Luckily,
2354 there is no variation in the data type they return.  But there is
2355 variation in their names.  Some systems give these functions the names
2356 @code{index} and @code{rindex}; other systems use the names
2357 @code{strchr} and @code{strrchr}.  Some systems support both pairs of
2358 names, but neither pair works on all systems.
2360 You should pick a single pair of names and use it throughout your
2361 program.  (Nowadays, it is better to choose @code{strchr} and
2362 @code{strrchr} for new programs, since those are the standard @sc{ansi}
2363 names.)  Declare both of those names as functions returning @code{char
2364 *}.  On systems which don't support those names, define them as macros
2365 in terms of the other pair.  For example, here is what to put at the
2366 beginning of your file (or in a header) if you want to use the names
2367 @code{strchr} and @code{strrchr} throughout:
2369 @example
2370 #ifndef HAVE_STRCHR
2371 #define strchr index
2372 #endif
2373 #ifndef HAVE_STRRCHR
2374 #define strrchr rindex
2375 #endif
2377 char *strchr ();
2378 char *strrchr ();
2379 @end example
2380 @end itemize
2382 Here we assume that @code{HAVE_STRCHR} and @code{HAVE_STRRCHR} are
2383 macros defined in systems where the corresponding functions exist.
2384 One way to get them properly defined is to use Autoconf.
2386 @node Internationalization
2387 @section Internationalization
2389 GNU has a library called GNU gettext that makes it easy to translate the
2390 messages in a program into various languages.  You should use this
2391 library in every program.  Use English for the messages as they appear
2392 in the program, and let gettext provide the way to translate them into
2393 other languages.
2395 Using GNU gettext involves putting a call to the @code{gettext} macro
2396 around each string that might need translation---like this:
2398 @example
2399 printf (gettext ("Processing file `%s'..."));
2400 @end example
2402 @noindent
2403 This permits GNU gettext to replace the string @code{"Processing file
2404 `%s'..."} with a translated version.
2406 Once a program uses gettext, please make a point of writing calls to
2407 @code{gettext} when you add new strings that call for translation.
2409 Using GNU gettext in a package involves specifying a @dfn{text domain
2410 name} for the package.  The text domain name is used to separate the
2411 translations for this package from the translations for other packages.
2412 Normally, the text domain name should be the same as the name of the
2413 package---for example, @samp{fileutils} for the GNU file utilities.
2415 To enable gettext to work well, avoid writing code that makes
2416 assumptions about the structure of words or sentences.  When you want
2417 the precise text of a sentence to vary depending on the data, use two or
2418 more alternative string constants each containing a complete sentences,
2419 rather than inserting conditionalized words or phrases into a single
2420 sentence framework.
2422 Here is an example of what not to do:
2424 @example
2425 printf ("%d file%s processed", nfiles,
2426         nfiles != 1 ? "s" : "");
2427 @end example
2429 @noindent
2430 The problem with that example is that it assumes that plurals are made
2431 by adding `s'.  If you apply gettext to the format string, like this,
2433 @example
2434 printf (gettext ("%d file%s processed"), nfiles,
2435         nfiles != 1 ? "s" : "");
2436 @end example
2438 @noindent
2439 the message can use different words, but it will still be forced to use
2440 `s' for the plural.  Here is a better way:
2442 @example
2443 printf ((nfiles != 1 ? "%d files processed"
2444          : "%d file processed"),
2445         nfiles);
2446 @end example
2448 @noindent
2449 This way, you can apply gettext to each of the two strings
2450 independently:
2452 @example
2453 printf ((nfiles != 1 ? gettext ("%d files processed")
2454          : gettext ("%d file processed")),
2455         nfiles);
2456 @end example
2458 @noindent
2459 This can be any method of forming the plural of the word for ``file'', and
2460 also handles languages that require agreement in the word for
2461 ``processed''.
2463 A similar problem appears at the level of sentence structure with this
2464 code:
2466 @example
2467 printf ("#  Implicit rule search has%s been done.\n",
2468         f->tried_implicit ? "" : " not");
2469 @end example
2471 @noindent
2472 Adding @code{gettext} calls to this code cannot give correct results for
2473 all languages, because negation in some languages requires adding words
2474 at more than one place in the sentence.  By contrast, adding
2475 @code{gettext} calls does the job straightfowardly if the code starts
2476 out like this:
2478 @example
2479 printf (f->tried_implicit
2480         ? "#  Implicit rule search has been done.\n",
2481         : "#  Implicit rule search has not been done.\n");
2482 @end example
2484 @node Mmap
2485 @section Mmap
2487 Don't assume that @code{mmap} either works on all files or fails
2488 for all files.  It may work on some files and fail on others.
2490 The proper way to use @code{mmap} is to try it on the specific file for
2491 which you want to use it---and if @code{mmap} doesn't work, fall back on
2492 doing the job in another way using @code{read} and @code{write}.
2494 The reason this precaution is needed is that the GNU kernel (the HURD)
2495 provides a user-extensible file system, in which there can be many
2496 different kinds of ``ordinary files.''  Many of them support
2497 @code{mmap}, but some do not.  It is important to make programs handle
2498 all these kinds of files.
2500 @node Documentation
2501 @chapter Documenting Programs
2503 @menu
2504 * GNU Manuals::                 Writing proper manuals.
2505 * Manual Structure Details::    Specific structure conventions.
2506 * NEWS File::                   NEWS files supplement manuals.
2507 * Change Logs::                 Recording Changes
2508 * Man Pages::                   Man pages are secondary.
2509 * Reading other Manuals::       How far you can go in learning
2510                                 from other manuals.
2511 @end menu
2513 @node GNU Manuals
2514 @section GNU Manuals
2516 The preferred way to document part of the GNU system is to write a
2517 manual in the Texinfo formatting language.  See the Texinfo manual,
2518 either the hardcopy, or the on-line version available through
2519 @code{info} or the Emacs Info subsystem (@kbd{C-h i}).
2521 Programmers often find it most natural to structure the documentation
2522 following the structure of the implementation, which they know.  But
2523 this structure is not necessarily good for explaining how to use the
2524 program; it may be irrelevant and confusing for a user.
2526 At every level, from the sentences in a paragraph to the grouping of
2527 topics into separate manuals, the right way to structure documentation
2528 is according to the concepts and questions that a user will have in mind
2529 when reading it.  Sometimes this structure of ideas matches the
2530 structure of the implementation of the software being documented---but
2531 often they are different.  Often the most important part of learning to
2532 write good documentation is learning to notice when you are structuring
2533 the documentation like the implementation, and think about better
2534 alternatives.
2536 For example, each program in the GNU system probably ought to be
2537 documented in one manual; but this does not mean each program should
2538 have its own manual.  That would be following the structure of the
2539 implementation, rather than the structure that helps the user
2540 understand.
2542 Instead, each manual should cover a coherent @emph{topic}.  For example,
2543 instead of a manual for @code{diff} and a manual for @code{diff3}, we
2544 have one manual for ``comparison of files'' which covers both of those
2545 programs, as well as @code{cmp}.  By documenting these programs
2546 together, we can make the whole subject clearer.
2548 The manual which discusses a program should document all of the
2549 program's command-line options and all of its commands.  It should give
2550 examples of their use.  But don't organize the manual as a list of
2551 features.  Instead, organize it logically, by subtopics.  Address the
2552 questions that a user will ask when thinking about the job that the
2553 program does.
2555 In general, a GNU manual should serve both as tutorial and reference.
2556 It should be set up for convenient access to each topic through Info,
2557 and for reading straight through (appendixes aside).  A GNU manual
2558 should give a good introduction to a beginner reading through from the
2559 start, and should also provide all the details that hackers want.
2561 That is not as hard as it first sounds.  Arrange each chapter as a
2562 logical breakdown of its topic, but order the sections, and write their
2563 text, so that reading the chapter straight through makes sense.  Do
2564 likewise when structuring the book into chapters, and when structuring a
2565 section into paragraphs.  The watchword is, @emph{at each point, address
2566 the most fundamental and important issue raised by the preceding text.}
2568 If necessary, add extra chapters at the beginning of the manual which
2569 are purely tutorial and cover the basics of the subject.  These provide
2570 the framework for a beginner to understand the rest of the manual.  The
2571 Bison manual provides a good example of how to do this.
2573 Don't use Unix man pages as a model for how to write GNU documentation;
2574 most of them are terse, badly structured, and give inadequate
2575 explanation of the underlying concepts.  (There are, of course
2576 exceptions.)  Also Unix man pages use a particular format which is
2577 different from what we use in GNU manuals.
2579 Please do not use the term ``pathname'' that is used in Unix
2580 documentation; use ``file name'' (two words) instead.  We use the term
2581 ``path'' only for search paths, which are lists of file names.
2583 Please do not use the term ``illegal'' to refer to erroneous input to a
2584 computer program.  Please use ``invalid'' for this, and reserve the term
2585 ``illegal'' for violations of law.
2587 @node Manual Structure Details
2588 @section Manual Structure Details
2590 The title page of the manual should state the version of the programs or
2591 packages documented in the manual.  The Top node of the manual should
2592 also contain this information.  If the manual is changing more
2593 frequently than or independent of the program, also state a version
2594 number for the manual in both of these places.
2596 Each program documented in the manual should should have a node named
2597 @samp{@var{program} Invocation} or @samp{Invoking @var{program}}.  This
2598 node (together with its subnodes, if any) should describe the program's
2599 command line arguments and how to run it (the sort of information people
2600 would look in a man page for).  Start with an @samp{@@example}
2601 containing a template for all the options and arguments that the program
2602 uses.
2604 Alternatively, put a menu item in some menu whose item name fits one of
2605 the above patterns.  This identifies the node which that item points to
2606 as the node for this purpose, regardless of the node's actual name.
2608 There will be automatic features for specifying a program name and
2609 quickly reading just this part of its manual.
2611 If one manual describes several programs, it should have such a node for
2612 each program described.
2614 @node NEWS File
2615 @section The NEWS File
2617 In addition to its manual, the package should have a file named
2618 @file{NEWS} which contains a list of user-visible changes worth
2619 mentioning.  In each new release, add items to the front of the file and
2620 identify the version they pertain to.  Don't discard old items; leave
2621 them in the file after the newer items.  This way, a user upgrading from
2622 any previous version can see what is new.
2624 If the @file{NEWS} file gets very long, move some of the older items
2625 into a file named @file{ONEWS} and put a note at the end referring the
2626 user to that file.
2628 @node Change Logs
2629 @section Change Logs
2631 Keep a change log to describe all the changes made to program source
2632 files.  The purpose of this is so that people investigating bugs in the
2633 future will know about the changes that might have introduced the bug.
2634 Often a new bug can be found by looking at what was recently changed.
2635 More importantly, change logs can help you eliminate conceptual
2636 inconsistencies between different parts of a program, by giving you a
2637 history of how the conflicting concepts arose and who they came from.
2639 @menu
2640 * Change Log Concepts::         
2641 * Style of Change Logs::        
2642 * Simple Changes::              
2643 * Conditional Changes::         
2644 @end menu
2646 @node Change Log Concepts
2647 @subsection Change Log Concepts
2649 You can think of the change log as a conceptual ``undo list'' which
2650 explains how earlier versions were different from the current version.
2651 People can see the current version; they don't need the change log
2652 to tell them what is in it.  What they want from a change log is a
2653 clear explanation of how the earlier version differed.
2655 The change log file is normally called @file{ChangeLog} and covers an
2656 entire directory.  Each directory can have its own change log, or a
2657 directory can use the change log of its parent directory--it's up to
2658 you.
2660 Another alternative is to record change log information with a version
2661 control system such as RCS or CVS.  This can be converted automatically
2662 to a @file{ChangeLog} file.
2664 There's no need to describe the full purpose of the changes or how they
2665 work together.  If you think that a change calls for explanation, you're
2666 probably right.  Please do explain it---but please put the explanation
2667 in comments in the code, where people will see it whenever they see the
2668 code.  For example, ``New function'' is enough for the change log when
2669 you add a function, because there should be a comment before the
2670 function definition to explain what it does.
2672 However, sometimes it is useful to write one line to describe the
2673 overall purpose of a batch of changes.
2675 The easiest way to add an entry to @file{ChangeLog} is with the Emacs
2676 command @kbd{M-x add-change-log-entry}.  An entry should have an
2677 asterisk, the name of the changed file, and then in parentheses the name
2678 of the changed functions, variables or whatever, followed by a colon.
2679 Then describe the changes you made to that function or variable.
2681 @node Style of Change Logs
2682 @subsection Style of Change Logs
2684 Here are some examples of change log entries:
2686 @example
2687 * register.el (insert-register): Return nil.
2688 (jump-to-register): Likewise.
2690 * sort.el (sort-subr): Return nil.
2692 * tex-mode.el (tex-bibtex-file, tex-file, tex-region):
2693 Restart the tex shell if process is gone or stopped.
2694 (tex-shell-running): New function.
2696 * expr.c (store_one_arg): Round size up for move_block_to_reg.
2697 (expand_call): Round up when emitting USE insns.
2698 * stmt.c (assign_parms): Round size up for move_block_from_reg.
2699 @end example
2701 It's important to name the changed function or variable in full.  Don't
2702 abbreviate function or variable names, and don't combine them.
2703 Subsequent maintainers will often search for a function name to find all
2704 the change log entries that pertain to it; if you abbreviate the name,
2705 they won't find it when they search.
2707 For example, some people are tempted to abbreviate groups of function
2708 names by writing @samp{* register.el (@{insert,jump-to@}-register)};
2709 this is not a good idea, since searching for @code{jump-to-register} or
2710 @code{insert-register} would not find that entry.
2712 Separate unrelated change log entries with blank lines.  When two
2713 entries represent parts of the same change, so that they work together,
2714 then don't put blank lines between them.  Then you can omit the file
2715 name and the asterisk when successive entries are in the same file.
2717 @node Simple Changes
2718 @subsection Simple Changes
2720 Certain simple kinds of changes don't need much detail in the change
2721 log.
2723 When you change the calling sequence of a function in a simple fashion,
2724 and you change all the callers of the function, there is no need to make
2725 individual entries for all the callers that you changed.  Just write in
2726 the entry for the function being called, ``All callers changed.''
2728 @example
2729 * keyboard.c (Fcommand_execute): New arg SPECIAL.
2730 All callers changed.
2731 @end example
2733 When you change just comments or doc strings, it is enough to write an
2734 entry for the file, without mentioning the functions.  Just ``Doc
2735 fixes'' is enough for the change log.
2737 There's no need to make change log entries for documentation files.
2738 This is because documentation is not susceptible to bugs that are hard
2739 to fix.  Documentation does not consist of parts that must interact in a
2740 precisely engineered fashion.  To correct an error, you need not know
2741 the history of the erroneous passage; it is enough to compare what the
2742 documentation says with the way the program actually works.
2744 @node Conditional Changes
2745 @subsection Conditional Changes
2747 C programs often contain compile-time @code{#if} conditionals.  Many
2748 changes are conditional; sometimes you add a new definition which is
2749 entirely contained in a conditional.  It is very useful to indicate in
2750 the change log the conditions for which the change applies.
2752 Our convention for indicating conditional changes is to use square
2753 brackets around the name of the condition.
2755 Here is a simple example, describing a change which is conditional but
2756 does not have a function or entity name associated with it:
2758 @example
2759 * xterm.c [SOLARIS2]: Include string.h.
2760 @end example
2762 Here is an entry describing a new definition which is entirely
2763 conditional.  This new definition for the macro @code{FRAME_WINDOW_P} is
2764 used only when @code{HAVE_X_WINDOWS} is defined:
2766 @example
2767 * frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P): Macro defined.
2768 @end example
2770 Here is an entry for a change within the function @code{init_display},
2771 whose definition as a whole is unconditional, but the changes themselves
2772 are contained in a @samp{#ifdef HAVE_LIBNCURSES} conditional:
2774 @example
2775 * dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call tgetent.
2776 @end example
2778 Here is an entry for a change that takes affect only when
2779 a certain macro is @emph{not} defined:
2781 @example
2782 (gethostname) [!HAVE_SOCKETS]: Replace with winsock version.
2783 @end example
2785 @node Man Pages
2786 @section Man Pages
2788 In the GNU project, man pages are secondary.  It is not necessary or
2789 expected for every GNU program to have a man page, but some of them do.
2790 It's your choice whether to include a man page in your program.
2792 When you make this decision, consider that supporting a man page
2793 requires continual effort each time the program is changed.  The time
2794 you spend on the man page is time taken away from more useful work.
2796 For a simple program which changes little, updating the man page may be
2797 a small job.  Then there is little reason not to include a man page, if
2798 you have one.
2800 For a large program that changes a great deal, updating a man page may
2801 be a substantial burden.  If a user offers to donate a man page, you may
2802 find this gift costly to accept.  It may be better to refuse the man
2803 page unless the same person agrees to take full responsibility for
2804 maintaining it---so that you can wash your hands of it entirely.  If
2805 this volunteer later ceases to do the job, then don't feel obliged to
2806 pick it up yourself; it may be better to withdraw the man page from the
2807 distribution until someone else agrees to update it.
2809 When a program changes only a little, you may feel that the
2810 discrepancies are small enough that the man page remains useful without
2811 updating.  If so, put a prominent note near the beginning of the man
2812 page explaining that you don't maintain it and that the Texinfo manual
2813 is more authoritative.  The note should say how to access the Texinfo
2814 documentation.
2816 @node Reading other Manuals
2817 @section Reading other Manuals
2819 There may be non-free books or documentation files that describe the
2820 program you are documenting.
2822 It is ok to use these documents for reference, just as the author of a
2823 new algebra textbook can read other books on algebra.  A large portion
2824 of any non-fiction book consists of facts, in this case facts about how
2825 a certain program works, and these facts are necessarily the same for
2826 everyone who writes about the subject.  But be careful not to copy your
2827 outline structure, wording, tables or examples from preexisting non-free
2828 documentation.  Copying from free documentation may be ok; please check
2829 with the FSF about the individual case.
2831 @node Managing Releases
2832 @chapter The Release Process
2834 Making a release is more than just bundling up your source files in a
2835 tar file and putting it up for FTP.  You should set up your software so
2836 that it can be configured to run on a variety of systems.  Your Makefile
2837 should conform to the GNU standards described below, and your directory
2838 layout should also conform to the standards discussed below.  Doing so
2839 makes it easy to include your package into the larger framework of
2840 all GNU software.
2842 @menu
2843 * Configuration::               How Configuration Should Work
2844 * Makefile Conventions::        Makefile Conventions
2845 * Releases::                    Making Releases
2846 @end menu
2848 @node Configuration
2849 @section How Configuration Should Work
2851 Each GNU distribution should come with a shell script named
2852 @code{configure}.  This script is given arguments which describe the
2853 kind of machine and system you want to compile the program for.
2855 The @code{configure} script must record the configuration options so
2856 that they affect compilation.
2858 One way to do this is to make a link from a standard name such as
2859 @file{config.h} to the proper configuration file for the chosen system.
2860 If you use this technique, the distribution should @emph{not} contain a
2861 file named @file{config.h}.  This is so that people won't be able to
2862 build the program without configuring it first.
2864 Another thing that @code{configure} can do is to edit the Makefile.  If
2865 you do this, the distribution should @emph{not} contain a file named
2866 @file{Makefile}.  Instead, it should include a file @file{Makefile.in} which
2867 contains the input used for editing.  Once again, this is so that people
2868 won't be able to build the program without configuring it first.
2870 If @code{configure} does write the @file{Makefile}, then @file{Makefile}
2871 should have a target named @file{Makefile} which causes @code{configure}
2872 to be rerun, setting up the same configuration that was set up last
2873 time.  The files that @code{configure} reads should be listed as
2874 dependencies of @file{Makefile}.
2876 All the files which are output from the @code{configure} script should
2877 have comments at the beginning explaining that they were generated
2878 automatically using @code{configure}.  This is so that users won't think
2879 of trying to edit them by hand.
2881 The @code{configure} script should write a file named @file{config.status}
2882 which describes which configuration options were specified when the
2883 program was last configured.  This file should be a shell script which,
2884 if run, will recreate the same configuration.
2886 The @code{configure} script should accept an option of the form
2887 @samp{--srcdir=@var{dirname}} to specify the directory where sources are found
2888 (if it is not the current directory).  This makes it possible to build
2889 the program in a separate directory, so that the actual source directory
2890 is not modified.
2892 If the user does not specify @samp{--srcdir}, then @code{configure} should
2893 check both @file{.} and @file{..} to see if it can find the sources.  If
2894 it finds the sources in one of these places, it should use them from
2895 there.  Otherwise, it should report that it cannot find the sources, and
2896 should exit with nonzero status.
2898 Usually the easy way to support @samp{--srcdir} is by editing a
2899 definition of @code{VPATH} into the Makefile.  Some rules may need to
2900 refer explicitly to the specified source directory.  To make this
2901 possible, @code{configure} can add to the Makefile a variable named
2902 @code{srcdir} whose value is precisely the specified directory.
2904 The @code{configure} script should also take an argument which specifies the
2905 type of system to build the program for.  This argument should look like
2906 this:
2908 @example
2909 @var{cpu}-@var{company}-@var{system}
2910 @end example
2912 For example, a Sun 3 might be @samp{m68k-sun-sunos4.1}.
2914 The @code{configure} script needs to be able to decode all plausible
2915 alternatives for how to describe a machine.  Thus, @samp{sun3-sunos4.1}
2916 would be a valid alias.  For many programs, @samp{vax-dec-ultrix} would
2917 be an alias for @samp{vax-dec-bsd}, simply because the differences
2918 between Ultrix and @sc{BSD} are rarely noticeable, but a few programs
2919 might need to distinguish them.
2920 @c Real 4.4BSD now runs on some Suns.
2922 There is a shell script called @file{config.sub} that you can use
2923 as a subroutine to validate system types and canonicalize aliases.
2925 Other options are permitted to specify in more detail the software
2926 or hardware present on the machine, and include or exclude optional
2927 parts of the package:
2929 @table @samp
2930 @item --enable-@var{feature}@r{[}=@var{parameter}@r{]}
2931 Configure the package to build and install an optional user-level
2932 facility called @var{feature}.  This allows users to choose which
2933 optional features to include.  Giving an optional @var{parameter} of
2934 @samp{no} should omit @var{feature}, if it is built by default.
2936 No @samp{--enable} option should @strong{ever} cause one feature to
2937 replace another.  No @samp{--enable} option should ever substitute one
2938 useful behavior for another useful behavior.  The only proper use for
2939 @samp{--enable} is for questions of whether to build part of the program
2940 or exclude it.
2942 @item --with-@var{package}
2943 @c @r{[}=@var{parameter}@r{]}
2944 The package @var{package} will be installed, so configure this package
2945 to work with @var{package}.
2947 @c  Giving an optional @var{parameter} of
2948 @c @samp{no} should omit @var{package}, if it is used by default.
2950 Possible values of @var{package} include 
2951 @samp{gnu-as} (or @samp{gas}), @samp{gnu-ld}, @samp{gnu-libc},
2952 @samp{gdb},
2953 @samp{x}, 
2955 @samp{x-toolkit}.
2957 Do not use a @samp{--with} option to specify the file name to use to
2958 find certain files.  That is outside the scope of what @samp{--with}
2959 options are for.
2961 @item --nfp
2962 The target machine has no floating point processor.
2964 @item --gas
2965 The target machine assembler is GAS, the GNU assembler.
2966 This is obsolete; users should use @samp{--with-gnu-as} instead.
2968 @item --x
2969 The target machine has the X Window System installed.
2970 This is obsolete; users should use @samp{--with-x} instead.
2971 @end table
2973 All @code{configure} scripts should accept all of these ``detail''
2974 options, whether or not they make any difference to the particular
2975 package at hand.  In particular, they should accept any option that
2976 starts with @samp{--with-} or @samp{--enable-}.  This is so users will
2977 be able to configure an entire GNU source tree at once with a single set
2978 of options.
2980 You will note that the categories @samp{--with-} and @samp{--enable-}
2981 are narrow: they @strong{do not} provide a place for any sort of option
2982 you might think of.  That is deliberate.  We want to limit the possible
2983 configuration options in GNU software.  We do not want GNU programs to
2984 have idiosyncratic configuration options.
2986 Packages that perform part of the compilation process may support cross-compilation.
2987 In such a case, the host and target machines for the program may be
2988 different.  The @code{configure} script should normally treat the
2989 specified type of system as both the host and the target, thus producing
2990 a program which works for the same type of machine that it runs on.
2992 The way to build a cross-compiler, cross-assembler, or what have you, is
2993 to specify the option @samp{--host=@var{hosttype}} when running
2994 @code{configure}.  This specifies the host system without changing the
2995 type of target system.  The syntax for @var{hosttype} is the same as
2996 described above.
2998 Bootstrapping a cross-compiler requires compiling it on a machine other
2999 than the host it will run on.  Compilation packages accept a
3000 configuration option @samp{--build=@var{hosttype}} for specifying the
3001 configuration on which you will compile them, in case that is different
3002 from the host.
3004 Programs for which cross-operation is not meaningful need not accept the
3005 @samp{--host} option, because configuring an entire operating system for
3006 cross-operation is not a meaningful thing.
3008 Some programs have ways of configuring themselves automatically.  If
3009 your program is set up to do this, your @code{configure} script can simply
3010 ignore most of its arguments.
3012 @comment The makefile standards are in a separate file that is also
3013 @comment included by make.texinfo.  Done by roland@gnu.ai.mit.edu on 1/6/93.
3014 @comment For this document, turn chapters into sections, etc.
3015 @lowersections
3016 @include make-stds.texi
3017 @raisesections
3019 @node Releases
3020 @section Making Releases
3022 Package the distribution of @code{Foo version 69.96} up in a gzipped tar
3023 file with the name @file{foo-69.96.tar.gz}.  It should unpack into a
3024 subdirectory named @file{foo-69.96}.
3026 Building and installing the program should never modify any of the files
3027 contained in the distribution.  This means that all the files that form
3028 part of the program in any way must be classified into @dfn{source
3029 files} and @dfn{non-source files}.  Source files are written by humans
3030 and never changed automatically; non-source files are produced from
3031 source files by programs under the control of the Makefile.
3033 Naturally, all the source files must be in the distribution.  It is okay
3034 to include non-source files in the distribution, provided they are
3035 up-to-date and machine-independent, so that building the distribution
3036 normally will never modify them.  We commonly include non-source files
3037 produced by Bison, @code{lex}, @TeX{}, and @code{makeinfo}; this helps avoid
3038 unnecessary dependencies between our distributions, so that users can
3039 install whichever packages they want to install.
3041 Non-source files that might actually be modified by building and
3042 installing the program should @strong{never} be included in the
3043 distribution.  So if you do distribute non-source files, always make
3044 sure they are up to date when you make a new distribution.
3046 Make sure that the directory into which the distribution unpacks (as
3047 well as any subdirectories) are all world-writable (octal mode 777).
3048 This is so that old versions of @code{tar} which preserve the
3049 ownership and permissions of the files from the tar archive will be
3050 able to extract all the files even if the user is unprivileged.
3052 Make sure that all the files in the distribution are world-readable.
3054 Make sure that no file name in the distribution is more than 14
3055 characters long.  Likewise, no file created by building the program
3056 should have a name longer than 14 characters.  The reason for this is
3057 that some systems adhere to a foolish interpretation of the POSIX
3058 standard, and refuse to open a longer name, rather than truncating as
3059 they did in the past.
3061 Don't include any symbolic links in the distribution itself.  If the tar
3062 file contains symbolic links, then people cannot even unpack it on
3063 systems that don't support symbolic links.  Also, don't use multiple
3064 names for one file in different directories, because certain file
3065 systems cannot handle this and that prevents unpacking the
3066 distribution.
3068 Try to make sure that all the file names will be unique on MS-DOS.  A
3069 name on MS-DOS consists of up to 8 characters, optionally followed by a
3070 period and up to three characters.  MS-DOS will truncate extra
3071 characters both before and after the period.  Thus,
3072 @file{foobarhacker.c} and @file{foobarhacker.o} are not ambiguous; they
3073 are truncated to @file{foobarha.c} and @file{foobarha.o}, which are
3074 distinct.
3076 Include in your distribution a copy of the @file{texinfo.tex} you used
3077 to test print any @file{*.texinfo} or @file{*.texi} files.
3079 Likewise, if your program uses small GNU software packages like regex,
3080 getopt, obstack, or termcap, include them in the distribution file.
3081 Leaving them out would make the distribution file a little smaller at
3082 the expense of possible inconvenience to a user who doesn't know what
3083 other files to get.
3085 @contents
3087 @bye
3088 Local variables:
3089 update-date-leading-regexp: "@c This date is automagically updated when you save this file:\n@set lastupdate "
3090 update-date-trailing-regexp: ""
3091 eval: (load "/gd/gnuorg/update-date.el")
3092 eval: (add-hook 'write-file-hooks 'update-date)
3093 End: