Mercurial > hg > octave-kai > gnulib-hg
annotate doc/standards.texi @ 17476:6057744acd2c default tip master
autoupdate
| author | Karl Berry <karl@freefriends.org> |
|---|---|
| date | Fri, 16 Aug 2013 06:32:22 -0700 |
| parents | 09c1c72dfe80 |
| children |
| rev | line source |
|---|---|
|
7140
4f8c667d9e9d
Remove stray "x" before \input.
Jim Meyering <jim@meyering.net>
parents:
7137
diff
changeset
|
1 \input texinfo @c -*-texinfo-*- |
| 4958 | 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: | |
| 17476 | 6 @set lastupdate August 15, 2013 |
| 4958 | 7 @c %**end of header |
| 8 | |
| 9 @dircategory GNU organization | |
| 10 @direntry | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
11 * Standards: (standards). GNU coding standards. |
| 4958 | 12 @end direntry |
| 13 | |
| 14 @c @setchapternewpage odd | |
| 15 @setchapternewpage off | |
| 16 | |
| 17 @c Put everything in one index (arbitrarily chosen to be the concept index). | |
| 18 @syncodeindex fn cp | |
| 19 @syncodeindex ky cp | |
| 20 @syncodeindex pg cp | |
| 21 @syncodeindex vr cp | |
| 22 | |
| 23 @c This is used by a cross ref in make-stds.texi | |
| 24 @set CODESTD 1 | |
| 25 | |
| 26 @copying | |
| 27 The GNU coding standards, last updated @value{lastupdate}. | |
| 28 | |
| 7910 | 29 Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, |
| 16279 | 30 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, |
| 17256 | 31 2011, 2012, 2013 Free Software Foundation, Inc. |
| 4958 | 32 |
| 33 Permission is granted to copy, distribute and/or modify this document | |
| 10774 | 34 under the terms of the GNU Free Documentation License, Version 1.3 or |
| 35 any later version published by the Free Software Foundation; with no | |
| 36 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover | |
| 37 Texts. A copy of the license is included in the section entitled | |
| 38 ``GNU Free Documentation License''. | |
| 4958 | 39 @end copying |
| 40 | |
| 41 @titlepage | |
| 42 @title GNU Coding Standards | |
| 43 @author Richard Stallman, et al. | |
| 44 @author last updated @value{lastupdate} | |
| 45 @page | |
| 46 @vskip 0pt plus 1filll | |
| 47 @insertcopying | |
| 48 @end titlepage | |
| 49 | |
| 50 @contents | |
| 51 | |
| 52 @ifnottex | |
| 14502 | 53 @node Top |
| 54 @top GNU Coding Standards | |
| 4958 | 55 |
| 56 @insertcopying | |
| 57 @end ifnottex | |
| 58 | |
| 59 @menu | |
| 9115 | 60 * Preface:: About the GNU Coding Standards. |
| 61 * Legal Issues:: Keeping free software free. | |
| 62 * Design Advice:: General program design. | |
| 63 * Program Behavior:: Program behavior for all programs | |
| 64 * Writing C:: Making the best use of C. | |
| 65 * Documentation:: Documenting programs. | |
| 66 * Managing Releases:: The release process. | |
| 67 * References:: Mentioning non-free software or documentation. | |
| 68 * GNU Free Documentation License:: Copying and sharing this manual. | |
| 6725 | 69 * Index:: |
| 4958 | 70 |
| 71 @end menu | |
| 72 | |
| 73 @node Preface | |
| 74 @chapter About the GNU Coding Standards | |
| 75 | |
| 76 The GNU Coding Standards were written by Richard Stallman and other GNU | |
| 77 Project volunteers. Their purpose is to make the GNU system clean, | |
| 78 consistent, and easy to install. This document can also be read as a | |
| 79 guide to writing portable, robust and reliable programs. It focuses on | |
| 80 programs written in C, but many of the rules and principles are useful | |
| 81 even if you write in another programming language. The rules often | |
| 82 state reasons for writing in a certain way. | |
| 83 | |
| 84 @cindex where to obtain @code{standards.texi} | |
| 85 @cindex downloading this manual | |
| 86 If you did not obtain this file directly from the GNU project and | |
| 87 recently, please check for a newer version. You can get the GNU | |
| 5301 | 88 Coding Standards from the GNU web server in many |
| 89 different formats, including the Texinfo source, PDF, HTML, DVI, plain | |
| 90 text, and more, at: @uref{http://www.gnu.org/prep/standards/}. | |
| 4958 | 91 |
| 12332 | 92 If you are maintaining an official GNU package, in addition to this |
| 93 document, please read and follow the GNU maintainer information | |
| 94 (@pxref{Top, , Contents, maintain, Information for Maintainers of GNU | |
| 95 Software}). | |
| 96 | |
| 97 @cindex @code{gnustandards-commit@@gnu.org} mailing list | |
| 98 If you want to receive diffs for every change to these GNU documents, | |
| 99 join the mailing list @code{gnustandards-commit@@gnu.org}, via the web | |
| 100 interface at | |
| 101 @url{http://lists.gnu.org/mailman/listinfo/gnustandards-commit}. | |
| 102 Archives are also available there. | |
| 103 | |
| 13056 | 104 @cindex @code{bug-standards@@gnu.org} email address |
| 105 @cindex Savannah repository for gnustandards | |
| 13057 | 106 @cindex gnustandards project repository |
| 13049 | 107 Please send corrections or suggestions for this document to |
| 108 @email{bug-standards@@gnu.org}. If you make a suggestion, please | |
| 109 include a suggested new wording for it, to help us consider the | |
| 110 suggestion efficiently. We prefer a context diff to the Texinfo | |
| 111 source, but if that's difficult for you, you can make a context diff | |
| 112 for some other version of this document, or propose it in any way that | |
| 113 makes it clear. The source repository for this document can be found | |
| 114 at @url{http://savannah.gnu.org/projects/gnustandards}. | |
| 4958 | 115 |
| 116 These standards cover the minimum of what is important when writing a | |
| 8453 | 117 GNU package. Likely, the need for additional standards will come up. |
| 4958 | 118 Sometimes, you might suggest that such standards be added to this |
| 119 document. If you think your standards would be generally useful, please | |
| 120 do suggest them. | |
| 121 | |
| 122 You should also set standards for your package on many questions not | |
| 123 addressed or not firmly specified here. The most important point is to | |
| 124 be self-consistent---try to stick to the conventions you pick, and try | |
| 125 to document them as much as possible. That way, your program will be | |
| 126 more maintainable by others. | |
| 127 | |
| 128 The GNU Hello program serves as an example of how to follow the GNU | |
| 6725 | 129 coding standards for a trivial program. |
| 130 @uref{http://www.gnu.org/software/hello/hello.html}. | |
| 4958 | 131 |
| 12332 | 132 This release of the GNU Coding Standards was last updated |
| 133 @value{lastupdate}. | |
| 134 | |
| 135 | |
| 4958 | 136 @node Legal Issues |
| 137 @chapter Keeping Free Software Free | |
| 138 @cindex legal aspects | |
| 139 | |
| 5301 | 140 This chapter discusses how you can make sure that GNU software |
| 4958 | 141 avoids legal difficulties, and other related issues. |
| 142 | |
| 143 @menu | |
| 9115 | 144 * Reading Non-Free Code:: Referring to proprietary programs. |
| 145 * Contributions:: Accepting contributions. | |
| 146 * Trademarks:: How we deal with trademark issues. | |
| 4958 | 147 @end menu |
| 148 | |
| 149 @node Reading Non-Free Code | |
| 150 @section Referring to Proprietary Programs | |
| 151 @cindex proprietary programs | |
| 152 @cindex avoiding proprietary code | |
| 153 | |
| 154 Don't in any circumstances refer to Unix source code for or during | |
| 155 your work on GNU! (Or to any other proprietary programs.) | |
| 156 | |
| 157 If you have a vague recollection of the internals of a Unix program, | |
| 158 this does not absolutely mean you can't write an imitation of it, but | |
| 159 do try to organize the imitation internally along different lines, | |
| 160 because this is likely to make the details of the Unix version | |
| 161 irrelevant and dissimilar to your results. | |
| 162 | |
| 163 For example, Unix utilities were generally optimized to minimize | |
| 164 memory use; if you go for speed instead, your program will be very | |
| 7663 | 165 different. You could keep the entire input file in memory and scan it |
| 4958 | 166 there instead of using stdio. Use a smarter algorithm discovered more |
| 167 recently than the Unix program. Eliminate use of temporary files. Do | |
| 168 it in one pass instead of two (we did this in the assembler). | |
| 169 | |
| 170 Or, on the contrary, emphasize simplicity instead of speed. For some | |
| 171 applications, the speed of today's computers makes simpler algorithms | |
| 172 adequate. | |
| 173 | |
| 174 Or go for generality. For example, Unix programs often have static | |
| 175 tables or fixed-size strings, which make for arbitrary limits; use | |
| 176 dynamic allocation instead. Make sure your program handles NULs and | |
| 177 other funny characters in the input files. Add a programming language | |
| 178 for extensibility and write part of the program in that language. | |
| 179 | |
| 180 Or turn some parts of the program into independently usable libraries. | |
| 181 Or use a simple garbage collector instead of tracking precisely when | |
| 182 to free memory, or use a new GNU facility such as obstacks. | |
| 183 | |
| 14719 | 184 |
| 4958 | 185 @node Contributions |
| 186 @section Accepting Contributions | |
| 187 @cindex legal papers | |
| 188 @cindex accepting contributions | |
| 189 | |
| 190 If the program you are working on is copyrighted by the Free Software | |
| 191 Foundation, then when someone else sends you a piece of code to add to | |
| 192 the program, we need legal papers to use it---just as we asked you to | |
| 193 sign papers initially. @emph{Each} person who makes a nontrivial | |
| 194 contribution to a program must sign some sort of legal papers in order | |
| 195 for us to have clear title to the program; the main author alone is not | |
| 196 enough. | |
| 197 | |
| 198 So, before adding in any contributions from other people, please tell | |
| 199 us, so we can arrange to get the papers. Then wait until we tell you | |
| 200 that we have received the signed papers, before you actually use the | |
| 201 contribution. | |
| 202 | |
| 203 This applies both before you release the program and afterward. If | |
| 204 you receive diffs to fix a bug, and they make significant changes, we | |
| 205 need legal papers for that change. | |
| 206 | |
| 207 This also applies to comments and documentation files. For copyright | |
| 208 law, comments and code are just text. Copyright applies to all kinds of | |
| 209 text, so we need legal papers for all kinds. | |
| 210 | |
| 211 We know it is frustrating to ask for legal papers; it's frustrating for | |
| 212 us as well. But if you don't wait, you are going out on a limb---for | |
| 213 example, what if the contributor's employer won't sign a disclaimer? | |
| 214 You might have to take that code out again! | |
| 215 | |
| 216 You don't need papers for changes of a few lines here or there, since | |
| 217 they are not significant for copyright purposes. Also, you don't need | |
| 218 papers if all you get from the suggestion is some ideas, not actual code | |
| 5301 | 219 which you use. For example, if someone sent you one implementation, but |
| 4958 | 220 you write a different implementation of the same idea, you don't need to |
| 221 get papers. | |
| 222 | |
| 223 The very worst thing is if you forget to tell us about the other | |
| 224 contributor. We could be very embarrassed in court some day as a | |
| 225 result. | |
| 226 | |
| 14719 | 227 We have more detailed advice for maintainers of GNU packages. If you |
| 228 have reached the stage of maintaining a GNU program (whether released | |
| 229 or not), please take a look: @pxref{Legal Matters,,, maintain, | |
| 230 Information for GNU Maintainers}. | |
| 231 | |
| 4958 | 232 |
| 233 @node Trademarks | |
| 234 @section Trademarks | |
| 235 @cindex trademarks | |
| 236 | |
| 237 Please do not include any trademark acknowledgements in GNU software | |
| 238 packages or documentation. | |
| 239 | |
| 240 Trademark acknowledgements are the statements that such-and-such is a | |
| 241 trademark of so-and-so. The GNU Project has no objection to the basic | |
| 6725 | 242 idea of trademarks, but these acknowledgements feel like kowtowing, |
| 4958 | 243 and there is no legal requirement for them, so we don't use them. |
| 244 | |
| 245 What is legally required, as regards other people's trademarks, is to | |
| 246 avoid using them in ways which a reader might reasonably understand as | |
| 247 naming or labeling our own programs or activities. For example, since | |
| 248 ``Objective C'' is (or at least was) a trademark, we made sure to say | |
| 249 that we provide a ``compiler for the Objective C language'' rather | |
| 250 than an ``Objective C compiler''. The latter would have been meant as | |
| 251 a shorter way of saying the former, but it does not explicitly state | |
| 252 the relationship, so it could be misinterpreted as using ``Objective | |
| 253 C'' as a label for the compiler rather than for the language. | |
| 254 | |
| 255 Please don't use ``win'' as an abbreviation for Microsoft Windows in | |
| 256 GNU software or documentation. In hacker terminology, calling | |
| 5909 | 257 something a ``win'' is a form of praise. If you wish to praise |
| 4958 | 258 Microsoft Windows when speaking on your own, by all means do so, but |
| 5909 | 259 not in GNU software. Usually we write the name ``Windows'' in full, |
| 4958 | 260 but when brevity is very important (as in file names and sometimes |
| 261 symbol names), we abbreviate it to ``w''. For instance, the files and | |
| 262 functions in Emacs that deal with Windows start with @samp{w32}. | |
| 263 | |
| 264 @node Design Advice | |
| 265 @chapter General Program Design | |
| 266 @cindex program design | |
| 267 | |
| 5301 | 268 This chapter discusses some of the issues you should take into |
| 4958 | 269 account when designing your program. |
| 270 | |
| 271 @c Standard or ANSI C | |
| 272 @c | |
| 273 @c In 1989 the American National Standards Institute (ANSI) standardized | |
| 274 @c C as standard X3.159-1989. In December of that year the | |
| 275 @c International Standards Organization ISO adopted the ANSI C standard | |
| 276 @c making minor changes. In 1990 ANSI then re-adopted ISO standard | |
| 277 @c C. This version of C is known as either ANSI C or Standard C. | |
| 278 | |
| 279 @c A major revision of the C Standard appeared in 1999. | |
| 280 | |
| 281 @menu | |
|
5495
5fe0551f4ec2
update from gnustandards
Karl Berry <karl@freefriends.org>
parents:
5301
diff
changeset
|
282 * Source Language:: Which languages to use. |
| 9115 | 283 * Compatibility:: Compatibility with other implementations. |
| 284 * Using Extensions:: Using non-standard features. | |
| 285 * Standard C:: Using standard C features. | |
| 286 * Conditional Compilation:: Compiling code only if a conditional is true. | |
| 4958 | 287 @end menu |
| 288 | |
| 289 @node Source Language | |
| 290 @section Which Languages to Use | |
|
5495
5fe0551f4ec2
update from gnustandards
Karl Berry <karl@freefriends.org>
parents:
5301
diff
changeset
|
291 @cindex programming languages |
| 4958 | 292 |
| 293 When you want to use a language that gets compiled and runs at high | |
| 17454 | 294 speed, the best language to use is C. C++ is ok too, but please don't |
| 17457 | 295 make heavy use of templates. So is Java, if you compile it. |
| 296 | |
| 297 When highest efficiency is not required, other languages commonly used | |
| 17476 | 298 in the free software community, such as Scheme, Python, Ruby, and |
| 299 Java, are OK too. Scheme, as implemented by GNU@tie{}Guile, plays a | |
| 300 particular role in the GNU System: it is the preferred language to | |
| 301 extend programs written in C/C++, and also a fine language for a wide | |
| 302 range of applications. The more GNU components use Guile and Scheme, | |
| 303 the more users are able to extend and combine them (@pxref{The Emacs | |
| 304 Thesis,,, guile, GNU Guile Reference Manual}). | |
| 4958 | 305 |
| 306 Many programs are designed to be extensible: they include an interpreter | |
| 307 for a language that is higher level than C. Often much of the program | |
| 308 is written in that language, too. The Emacs editor pioneered this | |
| 309 technique. | |
| 310 | |
| 10037 | 311 @cindex Guile |
| 312 @cindex GNOME and Guile | |
| 313 The standard extensibility interpreter for GNU software is Guile | |
| 9823 | 314 (@uref{http://www.gnu.org/@/software/@/guile/}), which implements the |
| 10037 | 315 language Scheme (an especially clean and simple dialect of Lisp). |
| 316 Guile also includes bindings for GTK+/GNOME, making it practical to | |
| 317 write modern GUI functionality within Guile. We don't reject programs | |
| 318 written in other ``scripting languages'' such as Perl and Python, but | |
| 17454 | 319 using Guile is the path that will lead to overall consistency of the |
| 320 GNU system. | |
| 10037 | 321 |
| 4958 | 322 |
| 323 @node Compatibility | |
| 324 @section Compatibility with Other Implementations | |
| 17256 | 325 @cindex compatibility with C and POSIX standards |
| 326 @cindex C compatibility | |
| 327 @cindex POSIX compatibility | |
| 4958 | 328 |
| 329 With occasional exceptions, utility programs and libraries for GNU | |
| 330 should be upward compatible with those in Berkeley Unix, and upward | |
| 331 compatible with Standard C if Standard C specifies their | |
| 17256 | 332 behavior, and upward compatible with POSIX if POSIX specifies |
| 4958 | 333 their behavior. |
| 334 | |
| 335 When these standards conflict, it is useful to offer compatibility | |
| 336 modes for each of them. | |
| 337 | |
| 338 @cindex options for compatibility | |
| 17256 | 339 Standard C and POSIX prohibit many kinds of extensions. Feel |
| 4958 | 340 free to make the extensions anyway, and include a @samp{--ansi}, |
| 341 @samp{--posix}, or @samp{--compatible} option to turn them off. | |
| 342 However, if the extension has a significant chance of breaking any real | |
| 343 programs or scripts, then it is not really upward compatible. So you | |
| 344 should try to redesign its interface to make it upward compatible. | |
| 345 | |
| 346 @cindex @code{POSIXLY_CORRECT}, environment variable | |
| 17256 | 347 Many GNU programs suppress extensions that conflict with POSIX if the |
| 4958 | 348 environment variable @code{POSIXLY_CORRECT} is defined (even if it is |
| 349 defined with a null value). Please make your program recognize this | |
| 350 variable if appropriate. | |
| 351 | |
| 352 When a feature is used only by users (not by programs or command | |
| 353 files), and it is done poorly in Unix, feel free to replace it | |
| 354 completely with something totally different and better. (For example, | |
| 355 @code{vi} is replaced with Emacs.) But it is nice to offer a compatible | |
| 356 feature as well. (There is a free @code{vi} clone, so we offer it.) | |
| 357 | |
| 358 Additional useful features are welcome regardless of whether | |
| 359 there is any precedent for them. | |
| 360 | |
| 361 @node Using Extensions | |
| 362 @section Using Non-standard Features | |
| 363 @cindex non-standard extensions | |
| 364 | |
| 365 Many GNU facilities that already exist support a number of convenient | |
| 366 extensions over the comparable Unix facilities. Whether to use these | |
| 367 extensions in implementing your program is a difficult question. | |
| 368 | |
| 369 On the one hand, using the extensions can make a cleaner program. | |
| 370 On the other hand, people will not be able to build the program | |
| 371 unless the other GNU tools are available. This might cause the | |
| 372 program to work on fewer kinds of machines. | |
| 373 | |
| 374 With some extensions, it might be easy to provide both alternatives. | |
| 375 For example, you can define functions with a ``keyword'' @code{INLINE} | |
| 376 and define that as a macro to expand into either @code{inline} or | |
| 377 nothing, depending on the compiler. | |
| 378 | |
| 379 In general, perhaps it is best not to use the extensions if you can | |
| 380 straightforwardly do without them, but to use the extensions if they | |
| 381 are a big improvement. | |
| 382 | |
| 383 An exception to this rule are the large, established programs (such as | |
| 384 Emacs) which run on a great variety of systems. Using GNU extensions in | |
| 385 such programs would make many users unhappy, so we don't do that. | |
| 386 | |
| 387 Another exception is for programs that are used as part of compilation: | |
| 388 anything that must be compiled with other compilers in order to | |
| 389 bootstrap the GNU compilation facilities. If these require the GNU | |
| 390 compiler, then no one can compile them without having them installed | |
| 391 already. That would be extremely troublesome in certain cases. | |
| 392 | |
| 393 @node Standard C | |
| 394 @section Standard C and Pre-Standard C | |
| 17256 | 395 @cindex ANSI C standard |
| 4958 | 396 |
| 397 1989 Standard C is widespread enough now that it is ok to use its | |
| 17256 | 398 features in programs. There is one exception: do not ever use the |
| 4958 | 399 ``trigraph'' feature of Standard C. |
| 400 | |
| 17256 | 401 The 1999 and 2011 editions of Standard C are not fully supported |
| 402 on all platforms. If you aim to support compilation by | |
| 403 compilers other than GCC, you should not require these C | |
| 404 features in your programs. It is ok to use these features | |
| 405 conditionally when the compiler supports them. | |
| 406 | |
| 407 If your program is only meant to compile with GCC, then you can | |
| 408 use these features if GCC supports them, when they give substantial | |
| 409 benefit. | |
| 4958 | 410 |
| 411 However, it is easy to support pre-standard compilers in most programs, | |
| 17256 | 412 so if you know how to do that, feel free. |
| 4958 | 413 |
| 414 @cindex function prototypes | |
| 415 To support pre-standard C, instead of writing function definitions in | |
| 416 standard prototype form, | |
| 417 | |
| 418 @example | |
| 419 int | |
| 420 foo (int x, int y) | |
| 421 @dots{} | |
| 422 @end example | |
| 423 | |
| 424 @noindent | |
| 425 write the definition in pre-standard style like this, | |
| 426 | |
| 427 @example | |
| 428 int | |
| 429 foo (x, y) | |
| 430 int x, y; | |
| 431 @dots{} | |
| 432 @end example | |
| 433 | |
| 434 @noindent | |
| 435 and use a separate declaration to specify the argument prototype: | |
| 436 | |
| 437 @example | |
| 438 int foo (int, int); | |
| 439 @end example | |
| 440 | |
| 441 You need such a declaration anyway, in a header file, to get the benefit | |
| 442 of prototypes in all the files where the function is called. And once | |
| 443 you have the declaration, you normally lose nothing by writing the | |
| 444 function definition in the pre-standard style. | |
| 445 | |
| 446 This technique does not work for integer types narrower than @code{int}. | |
| 447 If you think of an argument as being of a type narrower than @code{int}, | |
| 448 declare it as @code{int} instead. | |
| 449 | |
| 450 There are a few special cases where this technique is hard to use. For | |
| 451 example, if a function argument needs to hold the system type | |
| 452 @code{dev_t}, you run into trouble, because @code{dev_t} is shorter than | |
| 453 @code{int} on some machines; but you cannot use @code{int} instead, | |
| 454 because @code{dev_t} is wider than @code{int} on some machines. There | |
| 455 is no type you can safely use on all machines in a non-standard | |
| 456 definition. The only way to support non-standard C and pass such an | |
| 457 argument is to check the width of @code{dev_t} using Autoconf and choose | |
| 458 the argument type accordingly. This may not be worth the trouble. | |
| 459 | |
| 460 In order to support pre-standard compilers that do not recognize | |
| 461 prototypes, you may want to use a preprocessor macro like this: | |
| 462 | |
| 463 @example | |
| 464 /* Declare the prototype for a general external function. */ | |
| 465 #if defined (__STDC__) || defined (WINDOWSNT) | |
| 466 #define P_(proto) proto | |
| 467 #else | |
| 468 #define P_(proto) () | |
| 469 #endif | |
| 470 @end example | |
| 471 | |
| 472 @node Conditional Compilation | |
| 473 @section Conditional Compilation | |
| 474 | |
| 475 When supporting configuration options already known when building your | |
| 476 program we prefer using @code{if (... )} over conditional compilation, | |
| 477 as in the former case the compiler is able to perform more extensive | |
| 478 checking of all possible code paths. | |
| 479 | |
| 480 For example, please write | |
| 481 | |
| 482 @smallexample | |
| 483 if (HAS_FOO) | |
| 484 ... | |
| 485 else | |
| 486 ... | |
| 487 @end smallexample | |
| 488 | |
| 489 @noindent | |
| 490 instead of: | |
| 491 | |
| 492 @smallexample | |
| 493 #ifdef HAS_FOO | |
| 494 ... | |
| 495 #else | |
| 496 ... | |
| 497 #endif | |
| 498 @end smallexample | |
| 499 | |
| 500 A modern compiler such as GCC will generate exactly the same code in | |
| 501 both cases, and we have been using similar techniques with good success | |
| 502 in several projects. Of course, the former method assumes that | |
| 503 @code{HAS_FOO} is defined as either 0 or 1. | |
| 504 | |
| 505 While this is not a silver bullet solving all portability problems, | |
| 506 and is not always appropriate, following this policy would have saved | |
| 507 GCC developers many hours, or even days, per year. | |
| 508 | |
| 509 In the case of function-like macros like @code{REVERSIBLE_CC_MODE} in | |
| 12897 | 510 GCC which cannot be simply used in @code{if (...)} statements, there is |
| 4958 | 511 an easy workaround. Simply introduce another macro |
| 512 @code{HAS_REVERSIBLE_CC_MODE} as in the following example: | |
| 513 | |
| 514 @smallexample | |
| 515 #ifdef REVERSIBLE_CC_MODE | |
| 516 #define HAS_REVERSIBLE_CC_MODE 1 | |
| 517 #else | |
| 518 #define HAS_REVERSIBLE_CC_MODE 0 | |
| 519 #endif | |
| 520 @end smallexample | |
| 521 | |
| 522 @node Program Behavior | |
| 523 @chapter Program Behavior for All Programs | |
| 524 | |
| 5301 | 525 This chapter describes conventions for writing robust |
| 4958 | 526 software. It also describes general standards for error messages, the |
| 527 command line interface, and how libraries should behave. | |
| 528 | |
| 529 @menu | |
| 6629 | 530 * Non-GNU Standards:: We consider standards such as POSIX; |
| 531 we don't "obey" them. | |
| 9115 | 532 * Semantics:: Writing robust programs. |
| 533 * Libraries:: Library behavior. | |
| 534 * Errors:: Formatting error messages. | |
| 535 * User Interfaces:: Standards about interfaces generally. | |
| 536 * Graphical Interfaces:: Standards for graphical interfaces. | |
| 537 * Command-Line Interfaces:: Standards for command line interfaces. | |
| 13575 | 538 * Dynamic Plug-In Interfaces:: Standards for dynamic plug-in interfaces. |
| 9115 | 539 * Option Table:: Table of long options. |
| 10742 | 540 * OID Allocations:: Table of OID slots for GNU. |
| 9115 | 541 * Memory Usage:: When and how to care about memory needs. |
| 542 * File Usage:: Which files to use, and where. | |
| 4958 | 543 @end menu |
| 544 | |
| 6629 | 545 @node Non-GNU Standards |
| 546 @section Non-GNU Standards | |
| 547 | |
| 548 The GNU Project regards standards published by other organizations as | |
| 549 suggestions, not orders. We consider those standards, but we do not | |
| 550 ``obey'' them. In developing a GNU program, you should implement | |
| 551 an outside standard's specifications when that makes the GNU system | |
| 552 better overall in an objective sense. When it doesn't, you shouldn't. | |
| 553 | |
| 554 In most cases, following published standards is convenient for | |
| 555 users---it means that their programs or scripts will work more | |
| 556 portably. For instance, GCC implements nearly all the features of | |
| 557 Standard C as specified by that standard. C program developers would | |
| 558 be unhappy if it did not. And GNU utilities mostly follow | |
| 559 specifications of POSIX.2; shell script writers and users would be | |
| 560 unhappy if our programs were incompatible. | |
| 561 | |
| 562 But we do not follow either of these specifications rigidly, and there | |
| 563 are specific points on which we decided not to follow them, so as to | |
| 564 make the GNU system better for users. | |
| 565 | |
| 566 For instance, Standard C says that nearly all extensions to C are | |
| 567 prohibited. How silly! GCC implements many extensions, some of which | |
| 568 were later adopted as part of the standard. If you want these | |
| 569 constructs to give an error message as ``required'' by the standard, | |
| 570 you must specify @samp{--pedantic}, which was implemented only so that | |
| 15793 | 571 we can say ``GCC is a 100% implementation of the standard'', not |
| 6629 | 572 because there is any reason to actually use it. |
| 573 | |
| 574 POSIX.2 specifies that @samp{df} and @samp{du} must output sizes by | |
| 575 default in units of 512 bytes. What users want is units of 1k, so | |
| 576 that is what we do by default. If you want the ridiculous behavior | |
| 577 ``required'' by POSIX, you must set the environment variable | |
| 578 @samp{POSIXLY_CORRECT} (which was originally going to be named | |
| 579 @samp{POSIX_ME_HARDER}). | |
| 580 | |
| 581 GNU utilities also depart from the letter of the POSIX.2 specification | |
| 582 when they support long-named command-line options, and intermixing | |
| 583 options with ordinary arguments. This minor incompatibility with | |
| 584 POSIX is never a problem in practice, and it is very useful. | |
| 585 | |
| 586 In particular, don't reject a new feature, or remove an old one, | |
| 15793 | 587 merely because a standard says it is ``forbidden'' or ``deprecated''. |
| 6629 | 588 |
| 14719 | 589 |
| 4958 | 590 @node Semantics |
| 591 @section Writing Robust Programs | |
| 592 | |
| 593 @cindex arbitrary limits on data | |
| 594 Avoid arbitrary limits on the length or number of @emph{any} data | |
| 595 structure, including file names, lines, files, and symbols, by allocating | |
| 596 all data structures dynamically. In most Unix utilities, ``long lines | |
| 597 are silently truncated''. This is not acceptable in a GNU utility. | |
| 598 | |
| 599 @cindex @code{NUL} characters | |
| 14719 | 600 @findex libiconv |
| 4958 | 601 Utilities reading files should not drop NUL characters, or any other |
| 602 nonprinting characters @emph{including those with codes above 0177}. | |
| 603 The only sensible exceptions would be utilities specifically intended | |
| 16159 | 604 for interface to certain types of terminals or printers that can't |
| 605 handle those characters. Whenever possible, try to make programs work | |
| 606 properly with sequences of bytes that represent multibyte characters; | |
| 16158 | 607 UTF-8 is the most important. |
| 4958 | 608 |
| 609 @cindex error messages | |
| 14719 | 610 Check every system call for an error return, unless you know you wish |
| 611 to ignore errors. Include the system error text (from @code{perror}, | |
| 612 @code{strerror}, or equivalent) in @emph{every} error message | |
| 613 resulting from a failing system call, as well as the name of the file | |
| 614 if any and the name of the utility. Just ``cannot open foo.c'' or | |
| 615 ``stat failed'' is not sufficient. | |
| 4958 | 616 |
| 617 @cindex @code{malloc} return value | |
| 618 @cindex memory allocation failure | |
| 619 Check every call to @code{malloc} or @code{realloc} to see if it | |
| 620 returned zero. Check @code{realloc} even if you are making the block | |
| 621 smaller; in a system that rounds block sizes to a power of 2, | |
| 622 @code{realloc} may get a different block if you ask for less space. | |
| 623 | |
| 624 In Unix, @code{realloc} can destroy the storage block if it returns | |
| 625 zero. GNU @code{realloc} does not have this bug: if it fails, the | |
| 626 original block is unchanged. Feel free to assume the bug is fixed. If | |
| 627 you wish to run your program on Unix, and wish to avoid lossage in this | |
| 628 case, you can use the GNU @code{malloc}. | |
| 629 | |
| 630 You must expect @code{free} to alter the contents of the block that was | |
| 631 freed. Anything you want to fetch from the block, you must fetch before | |
| 632 calling @code{free}. | |
| 633 | |
| 634 If @code{malloc} fails in a noninteractive program, make that a fatal | |
| 635 error. In an interactive program (one that reads commands from the | |
| 636 user), it is better to abort the command and return to the command | |
| 637 reader loop. This allows the user to kill other processes to free up | |
| 638 virtual memory, and then try the command again. | |
| 639 | |
| 640 @cindex command-line arguments, decoding | |
| 641 Use @code{getopt_long} to decode arguments, unless the argument syntax | |
| 642 makes this unreasonable. | |
| 643 | |
| 644 When static storage is to be written in during program execution, use | |
| 645 explicit C code to initialize it. Reserve C initialized declarations | |
| 646 for data that will not be changed. | |
| 647 @c ADR: why? | |
| 648 | |
| 649 Try to avoid low-level interfaces to obscure Unix data structures (such | |
| 650 as file directories, utmp, or the layout of kernel memory), since these | |
| 651 are less likely to work compatibly. If you need to find all the files | |
| 652 in a directory, use @code{readdir} or some other high-level interface. | |
| 653 These are supported compatibly by GNU. | |
| 654 | |
| 655 @cindex signal handling | |
| 656 The preferred signal handling facilities are the BSD variant of | |
| 17256 | 657 @code{signal}, and the POSIX @code{sigaction} function; the |
| 4958 | 658 alternative USG @code{signal} interface is an inferior design. |
| 659 | |
| 17256 | 660 Nowadays, using the POSIX signal functions may be the easiest way |
| 4958 | 661 to make a program portable. If you use @code{signal}, then on GNU/Linux |
| 662 systems running GNU libc version 1, you should include | |
| 663 @file{bsd/signal.h} instead of @file{signal.h}, so as to get BSD | |
| 664 behavior. It is up to you whether to support systems where | |
| 665 @code{signal} has only the USG behavior, or give up on them. | |
| 666 | |
| 667 @cindex impossible conditions | |
| 668 In error checks that detect ``impossible'' conditions, just abort. | |
| 669 There is usually no point in printing any message. These checks | |
| 670 indicate the existence of bugs. Whoever wants to fix the bugs will have | |
| 671 to read the source code and run a debugger. So explain the problem with | |
| 672 comments in the source. The relevant data will be in variables, which | |
| 673 are easy to examine with the debugger, so there is no point moving them | |
| 674 elsewhere. | |
| 675 | |
| 676 Do not use a count of errors as the exit status for a program. | |
| 677 @emph{That does not work}, because exit status values are limited to 8 | |
| 678 bits (0 through 255). A single run of the program might have 256 | |
| 679 errors; if you try to return 256 as the exit status, the parent process | |
| 680 will see 0 as the status, and it will appear that the program succeeded. | |
| 681 | |
| 682 @cindex temporary files | |
| 683 @cindex @code{TMPDIR} environment variable | |
| 684 If you make temporary files, check the @code{TMPDIR} environment | |
| 685 variable; if that variable is defined, use the specified directory | |
| 686 instead of @file{/tmp}. | |
| 687 | |
| 688 In addition, be aware that there is a possible security problem when | |
| 689 creating temporary files in world-writable directories. In C, you can | |
| 690 avoid this problem by creating temporary files in this manner: | |
| 691 | |
| 692 @example | |
| 12897 | 693 fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600); |
| 4958 | 694 @end example |
| 695 | |
| 696 @noindent | |
| 14502 | 697 or by using the @code{mkstemps} function from Gnulib |
| 698 (@pxref{mkstemps,,, gnulib, Gnulib}). | |
| 4958 | 699 |
| 14242 | 700 In bash, use @code{set -C} (long name @code{noclobber}) to avoid this |
| 701 problem. In addition, the @code{mktemp} utility is a more general | |
| 702 solution for creating temporary files from shell scripts | |
| 703 (@pxref{mktemp invocation,,, coreutils, GNU Coreutils}). | |
| 704 | |
| 4958 | 705 |
| 706 @node Libraries | |
| 707 @section Library Behavior | |
| 708 @cindex libraries | |
| 709 | |
| 710 Try to make library functions reentrant. If they need to do dynamic | |
| 711 storage allocation, at least try to avoid any nonreentrancy aside from | |
| 712 that of @code{malloc} itself. | |
| 713 | |
| 714 Here are certain name conventions for libraries, to avoid name | |
| 715 conflicts. | |
| 716 | |
| 717 Choose a name prefix for the library, more than two characters long. | |
| 718 All external function and variable names should start with this | |
| 719 prefix. In addition, there should only be one of these in any given | |
| 720 library member. This usually means putting each one in a separate | |
| 721 source file. | |
| 722 | |
| 723 An exception can be made when two external symbols are always used | |
| 724 together, so that no reasonable program could use one without the | |
| 725 other; then they can both go in the same file. | |
| 726 | |
| 727 External symbols that are not documented entry points for the user | |
| 728 should have names beginning with @samp{_}. The @samp{_} should be | |
| 729 followed by the chosen name prefix for the library, to prevent | |
| 730 collisions with other libraries. These can go in the same files with | |
| 731 user entry points if you like. | |
| 732 | |
| 733 Static functions and variables can be used as you like and need not | |
| 734 fit any naming convention. | |
| 735 | |
| 736 @node Errors | |
| 737 @section Formatting Error Messages | |
| 738 @cindex formatting error messages | |
| 739 @cindex error messages, formatting | |
| 740 | |
| 741 Error messages from compilers should look like this: | |
| 742 | |
| 743 @example | |
| 16279 | 744 @var{sourcefile}:@var{lineno}: @var{message} |
| 4958 | 745 @end example |
| 746 | |
| 747 @noindent | |
| 748 If you want to mention the column number, use one of these formats: | |
| 749 | |
| 750 @example | |
| 16279 | 751 @var{sourcefile}:@var{lineno}:@var{column}: @var{message} |
| 752 @var{sourcefile}:@var{lineno}.@var{column}: @var{message} | |
| 4958 | 753 |
| 754 @end example | |
| 755 | |
| 756 @noindent | |
| 757 Line numbers should start from 1 at the beginning of the file, and | |
| 16159 | 758 column numbers should start from 1 at the beginning of the line. |
| 759 (Both of these conventions are chosen for compatibility.) Calculate | |
| 760 column numbers assuming that space and all ASCII printing characters | |
| 761 have equal width, and assuming tab stops every 8 columns. For | |
| 762 non-ASCII characters, Unicode character widths should be used when in | |
| 763 a UTF-8 locale; GNU libc and GNU gnulib provide suitable | |
| 764 @code{wcwidth} functions. | |
| 4958 | 765 |
| 766 The error message can also give both the starting and ending positions | |
| 767 of the erroneous text. There are several formats so that you can | |
| 768 avoid redundant information such as a duplicate line number. | |
| 769 Here are the possible formats: | |
| 770 | |
| 771 @example | |
| 16279 | 772 @var{sourcefile}:@var{line1}.@var{column1}-@var{line2}.@var{column2}: @var{message} |
| 773 @var{sourcefile}:@var{line1}.@var{column1}-@var{column2}: @var{message} | |
| 774 @var{sourcefile}:@var{line1}-@var{line2}: @var{message} | |
| 4958 | 775 @end example |
| 776 | |
| 777 @noindent | |
| 778 When an error is spread over several files, you can use this format: | |
| 779 | |
| 780 @example | |
| 16279 | 781 @var{file1}:@var{line1}.@var{column1}-@var{file2}:@var{line2}.@var{column2}: @var{message} |
| 4958 | 782 @end example |
| 783 | |
| 784 Error messages from other noninteractive programs should look like this: | |
| 785 | |
| 786 @example | |
| 16279 | 787 @var{program}:@var{sourcefile}:@var{lineno}: @var{message} |
| 4958 | 788 @end example |
| 789 | |
| 790 @noindent | |
| 791 when there is an appropriate source file, or like this: | |
| 792 | |
| 793 @example | |
| 794 @var{program}: @var{message} | |
| 795 @end example | |
| 796 | |
| 797 @noindent | |
| 798 when there is no relevant source file. | |
| 799 | |
| 800 If you want to mention the column number, use this format: | |
| 801 | |
| 802 @example | |
| 16279 | 803 @var{program}:@var{sourcefile}:@var{lineno}:@var{column}: @var{message} |
| 4958 | 804 @end example |
| 805 | |
| 806 In an interactive program (one that is reading commands from a | |
| 807 terminal), it is better not to include the program name in an error | |
| 808 message. The place to indicate which program is running is in the | |
| 809 prompt or with the screen layout. (When the same program runs with | |
| 810 input from a source other than a terminal, it is not interactive and | |
| 811 would do best to print error messages using the noninteractive style.) | |
| 812 | |
| 813 The string @var{message} should not begin with a capital letter when | |
| 814 it follows a program name and/or file name, because that isn't the | |
| 815 beginning of a sentence. (The sentence conceptually starts at the | |
| 816 beginning of the line.) Also, it should not end with a period. | |
| 817 | |
| 818 Error messages from interactive programs, and other messages such as | |
| 819 usage messages, should start with a capital letter. But they should not | |
| 820 end with a period. | |
| 821 | |
| 822 @node User Interfaces | |
| 823 @section Standards for Interfaces Generally | |
| 824 | |
| 825 @cindex program name and its behavior | |
| 826 @cindex behavior, dependent on program's name | |
| 827 Please don't make the behavior of a utility depend on the name used | |
| 828 to invoke it. It is useful sometimes to make a link to a utility | |
| 829 with a different name, and that should not change what it does. | |
| 830 | |
| 831 Instead, use a run time option or a compilation switch or both | |
| 832 to select among the alternate behaviors. | |
| 833 | |
| 834 @cindex output device and program's behavior | |
| 835 Likewise, please don't make the behavior of the program depend on the | |
| 836 type of output device it is used with. Device independence is an | |
| 837 important principle of the system's design; do not compromise it merely | |
| 838 to save someone from typing an option now and then. (Variation in error | |
| 839 message syntax when using a terminal is ok, because that is a side issue | |
| 840 that people do not depend on.) | |
| 841 | |
| 842 If you think one behavior is most useful when the output is to a | |
| 843 terminal, and another is most useful when the output is a file or a | |
| 844 pipe, then it is usually best to make the default behavior the one that | |
| 845 is useful with output to a terminal, and have an option for the other | |
| 846 behavior. | |
| 847 | |
| 848 Compatibility requires certain programs to depend on the type of output | |
| 849 device. It would be disastrous if @code{ls} or @code{sh} did not do so | |
| 850 in the way all users expect. In some of these cases, we supplement the | |
| 851 program with a preferred alternate version that does not depend on the | |
| 852 output device type. For example, we provide a @code{dir} program much | |
| 853 like @code{ls} except that its default output format is always | |
| 854 multi-column format. | |
| 855 | |
| 9019 | 856 |
| 4958 | 857 @node Graphical Interfaces |
| 858 @section Standards for Graphical Interfaces | |
| 859 @cindex graphical user interface | |
| 13072 | 860 @cindex interface styles |
| 861 @cindex user interface styles | |
| 862 | |
| 863 @cindex GTK+ | |
| 4958 | 864 When you write a program that provides a graphical user interface, |
| 13049 | 865 please make it work with the X Window System and the GTK+ toolkit |
| 866 unless the functionality specifically requires some alternative (for | |
| 867 example, ``displaying jpeg images while in console mode''). | |
| 4958 | 868 |
| 869 In addition, please provide a command-line interface to control the | |
| 870 functionality. (In many cases, the graphical user interface can be a | |
| 871 separate program which invokes the command-line program.) This is | |
| 872 so that the same jobs can be done from scripts. | |
| 873 | |
| 13072 | 874 @cindex CORBA |
| 875 @cindex GNOME | |
| 876 @cindex D-bus | |
| 877 @cindex keyboard interface | |
| 878 @cindex library interface | |
| 879 Please also consider providing a D-bus interface for use from other | |
| 880 running programs, such as within GNOME. (GNOME used to use CORBA | |
| 881 for this, but that is being phased out.) In addition, consider | |
| 882 providing a library interface (for use from C), and perhaps a | |
| 883 keyboard-driven console interface (for use by users from console | |
| 884 mode). Once you are doing the work to provide the functionality and | |
| 885 the graphical interface, these won't be much extra work. | |
| 4958 | 886 |
| 887 @node Command-Line Interfaces | |
| 888 @section Standards for Command Line Interfaces | |
| 889 @cindex command-line interface | |
| 890 | |
| 891 @findex getopt | |
| 17256 | 892 It is a good idea to follow the POSIX guidelines for the |
| 4958 | 893 command-line options of a program. The easiest way to do this is to use |
| 894 @code{getopt} to parse them. Note that the GNU version of @code{getopt} | |
| 895 will normally permit options anywhere among the arguments unless the | |
| 17256 | 896 special argument @samp{--} is used. This is not what POSIX |
| 4958 | 897 specifies; it is a GNU extension. |
| 898 | |
| 899 @cindex long-named options | |
| 900 Please define long-named options that are equivalent to the | |
| 901 single-letter Unix-style options. We hope to make GNU more user | |
| 902 friendly this way. This is easy to do with the GNU function | |
| 903 @code{getopt_long}. | |
| 904 | |
| 905 One of the advantages of long-named options is that they can be | |
| 906 consistent from program to program. For example, users should be able | |
| 907 to expect the ``verbose'' option of any GNU program which has one, to be | |
| 908 spelled precisely @samp{--verbose}. To achieve this uniformity, look at | |
| 909 the table of common long-option names when you choose the option names | |
| 910 for your program (@pxref{Option Table}). | |
| 911 | |
| 912 It is usually a good idea for file names given as ordinary arguments to | |
| 913 be input files only; any output files would be specified using options | |
| 914 (preferably @samp{-o} or @samp{--output}). Even if you allow an output | |
| 915 file name as an ordinary argument for compatibility, try to provide an | |
| 916 option as another way to specify it. This will lead to more consistency | |
| 6946 | 917 among GNU utilities, and fewer idiosyncrasies for users to remember. |
| 4958 | 918 |
| 919 @cindex standard command-line options | |
| 920 @cindex options, standard command-line | |
| 921 @cindex CGI programs, standard options for | |
| 922 @cindex PATH_INFO, specifying standard options as | |
| 923 All programs should support two standard options: @samp{--version} | |
| 924 and @samp{--help}. CGI programs should accept these as command-line | |
| 925 options, and also if given as the @env{PATH_INFO}; for instance, | |
| 926 visiting @url{http://example.org/p.cgi/--help} in a browser should | |
| 5909 | 927 output the same information as invoking @samp{p.cgi --help} from the |
| 4958 | 928 command line. |
| 929 | |
| 9019 | 930 @menu |
| 931 * --version:: The standard output for --version. | |
| 932 * --help:: The standard output for --help. | |
| 933 @end menu | |
| 934 | |
| 935 @node --version | |
| 936 @subsection @option{--version} | |
| 937 | |
| 938 @cindex @samp{--version} output | |
| 939 | |
| 940 The standard @code{--version} option should direct the program to | |
| 941 print information about its name, version, origin and legal status, | |
| 942 all on standard output, and then exit successfully. Other options and | |
| 943 arguments should be ignored once this is seen, and the program should | |
| 944 not perform its normal function. | |
| 4958 | 945 |
| 946 @cindex canonical name of a program | |
| 947 @cindex program's canonical name | |
| 948 The first line is meant to be easy for a program to parse; the version | |
| 949 number proper starts after the last space. In addition, it contains | |
| 950 the canonical name for this program, in this format: | |
| 951 | |
| 952 @example | |
| 953 GNU Emacs 19.30 | |
| 954 @end example | |
| 955 | |
| 956 @noindent | |
| 957 The program's name should be a constant string; @emph{don't} compute it | |
| 958 from @code{argv[0]}. The idea is to state the standard or canonical | |
| 959 name for the program, not its file name. There are other ways to find | |
| 960 out the precise file name where a command is found in @code{PATH}. | |
| 961 | |
| 962 If the program is a subsidiary part of a larger package, mention the | |
| 963 package name in parentheses, like this: | |
| 964 | |
| 965 @example | |
| 966 emacsserver (GNU Emacs) 19.30 | |
| 967 @end example | |
| 968 | |
| 969 @noindent | |
| 970 If the package has a version number which is different from this | |
| 971 program's version number, you can mention the package version number | |
| 972 just before the close-parenthesis. | |
| 973 | |
| 9019 | 974 If you @emph{need} to mention the version numbers of libraries which |
| 4958 | 975 are distributed separately from the package which contains this program, |
| 976 you can do so by printing an additional line of version info for each | |
| 977 library you want to mention. Use the same format for these lines as for | |
| 978 the first line. | |
| 979 | |
| 980 Please do not mention all of the libraries that the program uses ``just | |
| 981 for completeness''---that would produce a lot of unhelpful clutter. | |
| 982 Please mention library version numbers only if you find in practice that | |
| 983 they are very important to you in debugging. | |
| 984 | |
| 985 The following line, after the version number line or lines, should be a | |
| 986 copyright notice. If more than one copyright notice is called for, put | |
| 987 each on a separate line. | |
| 988 | |
| 9019 | 989 Next should follow a line stating the license, preferably using one of |
| 16359 | 990 abbreviations below, and a brief statement that the program is free |
| 9019 | 991 software, and that users are free to copy and change it. Also mention |
| 992 that there is no warranty, to the extent permitted by law. See | |
| 993 recommended wording below. | |
| 4958 | 994 |
| 995 It is ok to finish the output with a list of the major authors of the | |
| 996 program, as a way of giving credit. | |
| 997 | |
| 998 Here's an example of output that follows these rules: | |
| 999 | |
| 1000 @smallexample | |
| 9019 | 1001 GNU hello 2.3 |
| 1002 Copyright (C) 2007 Free Software Foundation, Inc. | |
| 1003 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> | |
| 1004 This is free software: you are free to change and redistribute it. | |
| 1005 There is NO WARRANTY, to the extent permitted by law. | |
| 4958 | 1006 @end smallexample |
| 1007 | |
| 1008 You should adapt this to your program, of course, filling in the proper | |
| 1009 year, copyright holder, name of program, and the references to | |
| 1010 distribution terms, and changing the rest of the wording as necessary. | |
| 1011 | |
| 1012 This copyright notice only needs to mention the most recent year in | |
| 1013 which changes were made---there's no need to list the years for previous | |
| 1014 versions' changes. You don't have to mention the name of the program in | |
| 1015 these notices, if that is inconvenient, since it appeared in the first | |
| 6640 | 1016 line. (The rules are different for copyright notices in source files; |
| 9019 | 1017 @pxref{Copyright Notices,,,maintain,Information for GNU Maintainers}.) |
| 4958 | 1018 |
| 1019 Translations of the above lines must preserve the validity of the | |
| 1020 copyright notices (@pxref{Internationalization}). If the translation's | |
| 1021 character set supports it, the @samp{(C)} should be replaced with the | |
| 1022 copyright symbol, as follows: | |
| 1023 | |
| 6725 | 1024 @ifinfo |
| 1025 (the official copyright symbol, which is the letter C in a circle); | |
| 1026 @end ifinfo | |
| 1027 @ifnotinfo | |
| 4958 | 1028 @copyright{} |
| 6725 | 1029 @end ifnotinfo |
| 4958 | 1030 |
| 1031 Write the word ``Copyright'' exactly like that, in English. Do not | |
| 1032 translate it into another language. International treaties recognize | |
| 1033 the English word ``Copyright''; translations into other languages do not | |
| 1034 have legal significance. | |
| 1035 | |
| 9019 | 1036 Finally, here is the table of our suggested license abbreviations. |
| 1037 Any abbreviation can be followed by @samp{v@var{version}[+]}, meaning | |
| 1038 that particular version, or later versions with the @samp{+}, as shown | |
| 17163 | 1039 above. In the case of a GNU license, @emph{always} indicate the permitted |
| 1040 versions in this way. | |
| 9019 | 1041 |
| 1042 In the case of exceptions for extra permissions with the GPL, we use | |
| 1043 @samp{/} for a separator; the version number can follow the license | |
| 1044 abbreviation as usual, as in the examples below. | |
| 1045 | |
| 1046 @table @asis | |
| 1047 @item GPL | |
| 9823 | 1048 GNU General Public License, @url{http://www.gnu.org/@/licenses/@/gpl.html}. |
| 9019 | 1049 |
| 1050 @item LGPL | |
| 9823 | 1051 GNU Lesser General Public License, @url{http://www.gnu.org/@/licenses/@/lgpl.html}. |
| 9019 | 1052 |
| 10037 | 1053 @item GPL/Ada |
| 9019 | 1054 GNU GPL with the exception for Ada. |
| 1055 | |
| 1056 @item Apache | |
| 1057 The Apache Software Foundation license, | |
| 9823 | 1058 @url{http://www.apache.org/@/licenses}. |
| 9019 | 1059 |
| 1060 @item Artistic | |
| 17382 | 1061 The Artistic license used for Perl, @url{http://dev.perl.org/licenses/artistic.html}. |
| 9019 | 1062 |
| 1063 @item Expat | |
| 9823 | 1064 The Expat license, @url{http://www.jclark.com/@/xml/@/copying.txt}. |
| 9019 | 1065 |
| 1066 @item MPL | |
| 9823 | 1067 The Mozilla Public License, @url{http://www.mozilla.org/@/MPL/}. |
| 9019 | 1068 |
| 1069 @item OBSD | |
| 1070 The original (4-clause) BSD license, incompatible with the GNU GPL | |
| 9823 | 1071 @url{http://www.xfree86.org/@/3.3.6/@/COPYRIGHT2.html#6}. |
| 9019 | 1072 |
| 1073 @item PHP | |
| 9823 | 1074 The license used for PHP, @url{http://www.php.net/@/license/}. |
| 9019 | 1075 |
| 1076 @item public domain | |
| 1077 The non-license that is being in the public domain, | |
| 9823 | 1078 @url{http://www.gnu.org/@/licenses/@/license-list.html#PublicDomain}. |
| 9019 | 1079 |
| 1080 @item Python | |
| 9823 | 1081 The license for Python, @url{http://www.python.org/@/2.0.1/@/license.html}. |
| 9019 | 1082 |
| 1083 @item RBSD | |
| 13219 | 1084 The revised (3-clause) BSD, compatible with the GNU GPL,@* |
| 9823 | 1085 @url{http://www.xfree86.org/@/3.3.6/@/COPYRIGHT2.html#5}. |
| 9019 | 1086 |
| 1087 @item X11 | |
| 1088 The simple non-copyleft license used for most versions of the X Window | |
| 13049 | 1089 System, @url{http://www.xfree86.org/@/3.3.6/@/COPYRIGHT2.html#3}. |
| 9019 | 1090 |
| 1091 @item Zlib | |
| 9823 | 1092 The license for Zlib, @url{http://www.gzip.org/@/zlib/@/zlib_license.html}. |
| 9019 | 1093 |
| 1094 @end table | |
| 1095 | |
| 1096 More information about these licenses and many more are on the GNU | |
| 1097 licensing web pages, | |
| 9823 | 1098 @url{http://www.gnu.org/@/licenses/@/license-list.html}. |
| 9019 | 1099 |
| 1100 | |
| 1101 @node --help | |
| 1102 @subsection @option{--help} | |
| 1103 | |
| 1104 @cindex @samp{--help} output | |
| 1105 | |
| 1106 The standard @code{--help} option should output brief documentation | |
| 1107 for how to invoke the program, on standard output, then exit | |
| 1108 successfully. Other options and arguments should be ignored once this | |
| 1109 is seen, and the program should not perform its normal function. | |
| 4958 | 1110 |
| 1111 @cindex address for bug reports | |
| 1112 @cindex bug reports | |
| 11097 | 1113 Near the end of the @samp{--help} option's output, please place lines |
| 1114 giving the email address for bug reports, the package's home page | |
| 1115 (normally @indicateurl{http://www.gnu.org/software/@var{pkg}}, and the | |
| 1116 general page for help using GNU programs. The format should be like this: | |
| 4958 | 1117 |
| 1118 @example | |
| 11116 | 1119 Report bugs to: @var{mailing-address} |
| 1120 @var{pkg} home page: <http://www.gnu.org/software/@var{pkg}/> | |
| 1121 General help using GNU software: <http://www.gnu.org/gethelp/> | |
| 4958 | 1122 @end example |
| 9019 | 1123 |
| 11097 | 1124 It is ok to mention other appropriate mailing lists and web pages. |
| 1125 | |
| 4958 | 1126 |
| 13575 | 1127 @node Dynamic Plug-In Interfaces |
| 1128 @section Standards for Dynamic Plug-in Interfaces | |
| 1129 @cindex plug-ins | |
| 1130 @cindex dynamic plug-ins | |
| 1131 | |
| 1132 Another aspect of keeping free programs free is encouraging | |
| 1133 development of free plug-ins, and discouraging development of | |
| 1134 proprietary plug-ins. Many GNU programs will not have anything like | |
| 1135 plug-ins at all, but those that do should follow these | |
| 1136 practices. | |
| 1137 | |
| 1138 First, the general plug-in architecture design should closely tie the | |
| 1139 plug-in to the original code, such that the plug-in and the base | |
| 1140 program are parts of one extended program. For GCC, for example, | |
| 1141 plug-ins receive and modify GCC's internal data structures, and so | |
| 1142 clearly form an extended program with the base GCC. | |
| 1143 | |
| 1144 @vindex plugin_is_GPL_compatible | |
| 1145 Second, you should require plug-in developers to affirm that their | |
| 1146 plug-ins are released under an appropriate license. This should be | |
| 1147 enforced with a simple programmatic check. For GCC, again for | |
| 1148 example, a plug-in must define the global symbol | |
| 1149 @code{plugin_is_GPL_compatible}, thus asserting that the plug-in is | |
| 1150 released under a GPL-compatible license (@pxref{Plugins,, Plugins, | |
| 1151 gccint, GCC Internals}). | |
| 1152 | |
| 1153 By adding this check to your program you are not creating a new legal | |
| 1154 requirement. The GPL itself requires plug-ins to be free software, | |
| 1155 licensed compatibly. As long as you have followed the first rule above | |
| 1156 to keep plug-ins closely tied to your original program, the GPL and AGPL | |
| 1157 already require those plug-ins to be released under a compatible | |
| 1158 license. The symbol definition in the plug-in---or whatever equivalent | |
| 1159 works best in your program---makes it harder for anyone who might | |
| 1160 distribute proprietary plug-ins to legally defend themselves. If a case | |
| 1161 about this got to court, we can point to that symbol as evidence that | |
| 1162 the plug-in developer understood that the license had this requirement. | |
| 1163 | |
| 1164 | |
| 4958 | 1165 @node Option Table |
| 1166 @section Table of Long Options | |
| 1167 @cindex long option names | |
| 1168 @cindex table of long options | |
| 1169 | |
| 1170 Here is a table of long options used by GNU programs. It is surely | |
| 1171 incomplete, but we aim to list all the options that a new program might | |
| 1172 want to be compatible with. If you use names not already in the table, | |
| 1173 please send @email{bug-standards@@gnu.org} a list of them, with their | |
| 1174 meanings, so we can update the table. | |
| 1175 | |
| 1176 @c Please leave newlines between items in this table; it's much easier | |
| 1177 @c to update when it isn't completely squashed together and unreadable. | |
| 1178 @c When there is more than one short option for a long option name, put | |
| 1179 @c a semicolon between the lists of the programs that use them, not a | |
| 1180 @c period. --friedman | |
| 1181 | |
| 1182 @table @samp | |
| 1183 @item after-date | |
| 1184 @samp{-N} in @code{tar}. | |
| 1185 | |
| 1186 @item all | |
| 1187 @samp{-a} in @code{du}, @code{ls}, @code{nm}, @code{stty}, @code{uname}, | |
| 1188 and @code{unexpand}. | |
| 1189 | |
| 1190 @item all-text | |
| 1191 @samp{-a} in @code{diff}. | |
| 1192 | |
| 1193 @item almost-all | |
| 1194 @samp{-A} in @code{ls}. | |
| 1195 | |
| 1196 @item append | |
| 1197 @samp{-a} in @code{etags}, @code{tee}, @code{time}; | |
| 1198 @samp{-r} in @code{tar}. | |
| 1199 | |
| 1200 @item archive | |
| 1201 @samp{-a} in @code{cp}. | |
| 1202 | |
| 1203 @item archive-name | |
| 1204 @samp{-n} in @code{shar}. | |
| 1205 | |
| 1206 @item arglength | |
| 1207 @samp{-l} in @code{m4}. | |
| 1208 | |
| 1209 @item ascii | |
| 1210 @samp{-a} in @code{diff}. | |
| 1211 | |
| 1212 @item assign | |
| 1213 @samp{-v} in @code{gawk}. | |
| 1214 | |
| 1215 @item assume-new | |
| 10199 | 1216 @samp{-W} in @code{make}. |
| 4958 | 1217 |
| 1218 @item assume-old | |
| 10199 | 1219 @samp{-o} in @code{make}. |
| 4958 | 1220 |
| 1221 @item auto-check | |
| 1222 @samp{-a} in @code{recode}. | |
| 1223 | |
| 1224 @item auto-pager | |
| 1225 @samp{-a} in @code{wdiff}. | |
| 1226 | |
| 1227 @item auto-reference | |
| 1228 @samp{-A} in @code{ptx}. | |
| 1229 | |
| 1230 @item avoid-wraps | |
| 1231 @samp{-n} in @code{wdiff}. | |
| 1232 | |
| 1233 @item background | |
| 1234 For server programs, run in the background. | |
| 1235 | |
| 1236 @item backward-search | |
| 1237 @samp{-B} in @code{ctags}. | |
| 1238 | |
| 1239 @item basename | |
| 1240 @samp{-f} in @code{shar}. | |
| 1241 | |
| 1242 @item batch | |
| 1243 Used in GDB. | |
| 1244 | |
| 1245 @item baud | |
| 1246 Used in GDB. | |
| 1247 | |
| 1248 @item before | |
| 1249 @samp{-b} in @code{tac}. | |
| 1250 | |
| 1251 @item binary | |
| 1252 @samp{-b} in @code{cpio} and @code{diff}. | |
| 1253 | |
| 1254 @item bits-per-code | |
| 1255 @samp{-b} in @code{shar}. | |
| 1256 | |
| 1257 @item block-size | |
| 1258 Used in @code{cpio} and @code{tar}. | |
| 1259 | |
| 1260 @item blocks | |
| 1261 @samp{-b} in @code{head} and @code{tail}. | |
| 1262 | |
| 1263 @item break-file | |
| 1264 @samp{-b} in @code{ptx}. | |
| 1265 | |
| 1266 @item brief | |
| 1267 Used in various programs to make output shorter. | |
| 1268 | |
| 1269 @item bytes | |
| 1270 @samp{-c} in @code{head}, @code{split}, and @code{tail}. | |
| 1271 | |
| 1272 @item c@t{++} | |
| 1273 @samp{-C} in @code{etags}. | |
| 1274 | |
| 1275 @item catenate | |
| 1276 @samp{-A} in @code{tar}. | |
| 1277 | |
| 1278 @item cd | |
| 1279 Used in various programs to specify the directory to use. | |
| 1280 | |
| 1281 @item changes | |
| 1282 @samp{-c} in @code{chgrp} and @code{chown}. | |
| 1283 | |
| 1284 @item classify | |
| 1285 @samp{-F} in @code{ls}. | |
| 1286 | |
| 1287 @item colons | |
| 1288 @samp{-c} in @code{recode}. | |
| 1289 | |
| 1290 @item command | |
| 1291 @samp{-c} in @code{su}; | |
| 1292 @samp{-x} in GDB. | |
| 1293 | |
| 1294 @item compare | |
| 1295 @samp{-d} in @code{tar}. | |
| 1296 | |
| 1297 @item compat | |
| 1298 Used in @code{gawk}. | |
| 1299 | |
| 1300 @item compress | |
| 1301 @samp{-Z} in @code{tar} and @code{shar}. | |
| 1302 | |
| 1303 @item concatenate | |
| 1304 @samp{-A} in @code{tar}. | |
| 1305 | |
| 1306 @item confirmation | |
| 1307 @samp{-w} in @code{tar}. | |
| 1308 | |
| 1309 @item context | |
| 1310 Used in @code{diff}. | |
| 1311 | |
| 1312 @item copyleft | |
| 1313 @samp{-W copyleft} in @code{gawk}. | |
| 1314 | |
| 1315 @item copyright | |
| 1316 @samp{-C} in @code{ptx}, @code{recode}, and @code{wdiff}; | |
| 1317 @samp{-W copyright} in @code{gawk}. | |
| 1318 | |
| 1319 @item core | |
| 1320 Used in GDB. | |
| 1321 | |
| 1322 @item count | |
| 1323 @samp{-q} in @code{who}. | |
| 1324 | |
| 1325 @item count-links | |
| 1326 @samp{-l} in @code{du}. | |
| 1327 | |
| 1328 @item create | |
| 1329 Used in @code{tar} and @code{cpio}. | |
| 1330 | |
| 1331 @item cut-mark | |
| 1332 @samp{-c} in @code{shar}. | |
| 1333 | |
| 1334 @item cxref | |
| 1335 @samp{-x} in @code{ctags}. | |
| 1336 | |
| 1337 @item date | |
| 1338 @samp{-d} in @code{touch}. | |
| 1339 | |
| 1340 @item debug | |
| 10199 | 1341 @samp{-d} in @code{make} and @code{m4}; |
| 4958 | 1342 @samp{-t} in Bison. |
| 1343 | |
| 1344 @item define | |
| 1345 @samp{-D} in @code{m4}. | |
| 1346 | |
| 1347 @item defines | |
| 1348 @samp{-d} in Bison and @code{ctags}. | |
| 1349 | |
| 1350 @item delete | |
| 1351 @samp{-D} in @code{tar}. | |
| 1352 | |
| 1353 @item dereference | |
| 1354 @samp{-L} in @code{chgrp}, @code{chown}, @code{cpio}, @code{du}, | |
| 1355 @code{ls}, and @code{tar}. | |
| 1356 | |
| 1357 @item dereference-args | |
| 1358 @samp{-D} in @code{du}. | |
| 1359 | |
| 1360 @item device | |
| 1361 Specify an I/O device (special file name). | |
| 1362 | |
| 1363 @item diacritics | |
| 1364 @samp{-d} in @code{recode}. | |
| 1365 | |
| 1366 @item dictionary-order | |
| 1367 @samp{-d} in @code{look}. | |
| 1368 | |
| 1369 @item diff | |
| 1370 @samp{-d} in @code{tar}. | |
| 1371 | |
| 1372 @item digits | |
| 1373 @samp{-n} in @code{csplit}. | |
| 1374 | |
| 1375 @item directory | |
| 1376 Specify the directory to use, in various programs. In @code{ls}, it | |
| 1377 means to show directories themselves rather than their contents. In | |
| 1378 @code{rm} and @code{ln}, it means to not treat links to directories | |
| 1379 specially. | |
| 1380 | |
| 1381 @item discard-all | |
| 1382 @samp{-x} in @code{strip}. | |
| 1383 | |
| 1384 @item discard-locals | |
| 1385 @samp{-X} in @code{strip}. | |
| 1386 | |
| 1387 @item dry-run | |
| 10199 | 1388 @samp{-n} in @code{make}. |
| 4958 | 1389 |
| 1390 @item ed | |
| 1391 @samp{-e} in @code{diff}. | |
| 1392 | |
| 1393 @item elide-empty-files | |
| 1394 @samp{-z} in @code{csplit}. | |
| 1395 | |
| 1396 @item end-delete | |
| 1397 @samp{-x} in @code{wdiff}. | |
| 1398 | |
| 1399 @item end-insert | |
| 1400 @samp{-z} in @code{wdiff}. | |
| 1401 | |
| 1402 @item entire-new-file | |
| 1403 @samp{-N} in @code{diff}. | |
| 1404 | |
| 1405 @item environment-overrides | |
| 10199 | 1406 @samp{-e} in @code{make}. |
| 4958 | 1407 |
| 1408 @item eof | |
| 1409 @samp{-e} in @code{xargs}. | |
| 1410 | |
| 1411 @item epoch | |
| 1412 Used in GDB. | |
| 1413 | |
| 1414 @item error-limit | |
| 1415 Used in @code{makeinfo}. | |
| 1416 | |
| 1417 @item error-output | |
| 1418 @samp{-o} in @code{m4}. | |
| 1419 | |
| 1420 @item escape | |
| 1421 @samp{-b} in @code{ls}. | |
| 1422 | |
| 1423 @item exclude-from | |
| 1424 @samp{-X} in @code{tar}. | |
| 1425 | |
| 1426 @item exec | |
| 1427 Used in GDB. | |
| 1428 | |
| 1429 @item exit | |
| 1430 @samp{-x} in @code{xargs}. | |
| 1431 | |
| 1432 @item exit-0 | |
| 1433 @samp{-e} in @code{unshar}. | |
| 1434 | |
| 1435 @item expand-tabs | |
| 1436 @samp{-t} in @code{diff}. | |
| 1437 | |
| 1438 @item expression | |
| 1439 @samp{-e} in @code{sed}. | |
| 1440 | |
| 1441 @item extern-only | |
| 1442 @samp{-g} in @code{nm}. | |
| 1443 | |
| 1444 @item extract | |
| 1445 @samp{-i} in @code{cpio}; | |
| 1446 @samp{-x} in @code{tar}. | |
| 1447 | |
| 1448 @item faces | |
| 1449 @samp{-f} in @code{finger}. | |
| 1450 | |
| 1451 @item fast | |
| 1452 @samp{-f} in @code{su}. | |
| 1453 | |
| 1454 @item fatal-warnings | |
| 1455 @samp{-E} in @code{m4}. | |
| 1456 | |
| 1457 @item file | |
| 10199 | 1458 @samp{-f} in @code{gawk}, @code{info}, @code{make}, @code{mt}, |
| 1459 @code{sed}, and @code{tar}. | |
| 4958 | 1460 |
| 1461 @item field-separator | |
| 1462 @samp{-F} in @code{gawk}. | |
| 1463 | |
| 1464 @item file-prefix | |
| 1465 @samp{-b} in Bison. | |
| 1466 | |
| 1467 @item file-type | |
| 1468 @samp{-F} in @code{ls}. | |
| 1469 | |
| 1470 @item files-from | |
| 1471 @samp{-T} in @code{tar}. | |
| 1472 | |
| 1473 @item fill-column | |
| 1474 Used in @code{makeinfo}. | |
| 1475 | |
| 1476 @item flag-truncation | |
| 1477 @samp{-F} in @code{ptx}. | |
| 1478 | |
| 1479 @item fixed-output-files | |
| 1480 @samp{-y} in Bison. | |
| 1481 | |
| 1482 @item follow | |
| 1483 @samp{-f} in @code{tail}. | |
| 1484 | |
| 1485 @item footnote-style | |
| 1486 Used in @code{makeinfo}. | |
| 1487 | |
| 1488 @item force | |
| 1489 @samp{-f} in @code{cp}, @code{ln}, @code{mv}, and @code{rm}. | |
| 1490 | |
| 1491 @item force-prefix | |
| 1492 @samp{-F} in @code{shar}. | |
| 1493 | |
| 1494 @item foreground | |
| 1495 For server programs, run in the foreground; | |
| 1496 in other words, don't do anything special to run the server | |
| 1497 in the background. | |
| 1498 | |
| 1499 @item format | |
| 1500 Used in @code{ls}, @code{time}, and @code{ptx}. | |
| 1501 | |
| 1502 @item freeze-state | |
| 1503 @samp{-F} in @code{m4}. | |
| 1504 | |
| 1505 @item fullname | |
| 1506 Used in GDB. | |
| 1507 | |
| 1508 @item gap-size | |
| 1509 @samp{-g} in @code{ptx}. | |
| 1510 | |
| 1511 @item get | |
| 1512 @samp{-x} in @code{tar}. | |
| 1513 | |
| 1514 @item graphic | |
| 1515 @samp{-i} in @code{ul}. | |
| 1516 | |
| 1517 @item graphics | |
| 1518 @samp{-g} in @code{recode}. | |
| 1519 | |
| 1520 @item group | |
| 1521 @samp{-g} in @code{install}. | |
| 1522 | |
| 1523 @item gzip | |
| 1524 @samp{-z} in @code{tar} and @code{shar}. | |
| 1525 | |
| 1526 @item hashsize | |
| 1527 @samp{-H} in @code{m4}. | |
| 1528 | |
| 1529 @item header | |
| 1530 @samp{-h} in @code{objdump} and @code{recode} | |
| 1531 | |
| 1532 @item heading | |
| 1533 @samp{-H} in @code{who}. | |
| 1534 | |
| 1535 @item help | |
| 1536 Used to ask for brief usage information. | |
| 1537 | |
| 1538 @item here-delimiter | |
| 1539 @samp{-d} in @code{shar}. | |
| 1540 | |
| 1541 @item hide-control-chars | |
| 1542 @samp{-q} in @code{ls}. | |
| 1543 | |
| 1544 @item html | |
| 1545 In @code{makeinfo}, output HTML. | |
| 1546 | |
| 1547 @item idle | |
| 1548 @samp{-u} in @code{who}. | |
| 1549 | |
| 1550 @item ifdef | |
| 1551 @samp{-D} in @code{diff}. | |
| 1552 | |
| 1553 @item ignore | |
| 1554 @samp{-I} in @code{ls}; | |
| 1555 @samp{-x} in @code{recode}. | |
| 1556 | |
| 1557 @item ignore-all-space | |
| 1558 @samp{-w} in @code{diff}. | |
| 1559 | |
| 1560 @item ignore-backups | |
| 1561 @samp{-B} in @code{ls}. | |
| 1562 | |
| 1563 @item ignore-blank-lines | |
| 1564 @samp{-B} in @code{diff}. | |
| 1565 | |
| 1566 @item ignore-case | |
| 1567 @samp{-f} in @code{look} and @code{ptx}; | |
| 1568 @samp{-i} in @code{diff} and @code{wdiff}. | |
| 1569 | |
| 1570 @item ignore-errors | |
| 10199 | 1571 @samp{-i} in @code{make}. |
| 4958 | 1572 |
| 1573 @item ignore-file | |
| 1574 @samp{-i} in @code{ptx}. | |
| 1575 | |
| 1576 @item ignore-indentation | |
| 1577 @samp{-I} in @code{etags}. | |
| 1578 | |
| 1579 @item ignore-init-file | |
| 1580 @samp{-f} in Oleo. | |
| 1581 | |
| 1582 @item ignore-interrupts | |
| 1583 @samp{-i} in @code{tee}. | |
| 1584 | |
| 1585 @item ignore-matching-lines | |
| 1586 @samp{-I} in @code{diff}. | |
| 1587 | |
| 1588 @item ignore-space-change | |
| 1589 @samp{-b} in @code{diff}. | |
| 1590 | |
| 1591 @item ignore-zeros | |
| 1592 @samp{-i} in @code{tar}. | |
| 1593 | |
| 1594 @item include | |
| 1595 @samp{-i} in @code{etags}; | |
| 1596 @samp{-I} in @code{m4}. | |
| 1597 | |
| 1598 @item include-dir | |
| 10199 | 1599 @samp{-I} in @code{make}. |
| 4958 | 1600 |
| 1601 @item incremental | |
| 1602 @samp{-G} in @code{tar}. | |
| 1603 | |
| 1604 @item info | |
| 1605 @samp{-i}, @samp{-l}, and @samp{-m} in Finger. | |
| 1606 | |
| 1607 @item init-file | |
| 1608 In some programs, specify the name of the file to read as the user's | |
| 1609 init file. | |
| 1610 | |
| 1611 @item initial | |
| 1612 @samp{-i} in @code{expand}. | |
| 1613 | |
| 1614 @item initial-tab | |
| 1615 @samp{-T} in @code{diff}. | |
| 1616 | |
| 1617 @item inode | |
| 1618 @samp{-i} in @code{ls}. | |
| 1619 | |
| 1620 @item interactive | |
| 1621 @samp{-i} in @code{cp}, @code{ln}, @code{mv}, @code{rm}; | |
| 1622 @samp{-e} in @code{m4}; | |
| 1623 @samp{-p} in @code{xargs}; | |
| 1624 @samp{-w} in @code{tar}. | |
| 1625 | |
| 1626 @item intermix-type | |
| 1627 @samp{-p} in @code{shar}. | |
| 1628 | |
| 1629 @item iso-8601 | |
| 1630 Used in @code{date} | |
| 1631 | |
| 1632 @item jobs | |
| 10199 | 1633 @samp{-j} in @code{make}. |
| 4958 | 1634 |
| 1635 @item just-print | |
| 10199 | 1636 @samp{-n} in @code{make}. |
| 4958 | 1637 |
| 1638 @item keep-going | |
| 10199 | 1639 @samp{-k} in @code{make}. |
| 4958 | 1640 |
| 1641 @item keep-files | |
| 1642 @samp{-k} in @code{csplit}. | |
| 1643 | |
| 1644 @item kilobytes | |
| 1645 @samp{-k} in @code{du} and @code{ls}. | |
| 1646 | |
| 1647 @item language | |
| 1648 @samp{-l} in @code{etags}. | |
| 1649 | |
| 1650 @item less-mode | |
| 1651 @samp{-l} in @code{wdiff}. | |
| 1652 | |
| 1653 @item level-for-gzip | |
| 1654 @samp{-g} in @code{shar}. | |
| 1655 | |
| 1656 @item line-bytes | |
| 1657 @samp{-C} in @code{split}. | |
| 1658 | |
| 1659 @item lines | |
| 1660 Used in @code{split}, @code{head}, and @code{tail}. | |
| 1661 | |
| 1662 @item link | |
| 1663 @samp{-l} in @code{cpio}. | |
| 1664 | |
| 1665 @item lint | |
| 1666 @itemx lint-old | |
| 1667 Used in @code{gawk}. | |
| 1668 | |
| 1669 @item list | |
| 1670 @samp{-t} in @code{cpio}; | |
| 1671 @samp{-l} in @code{recode}. | |
| 1672 | |
| 1673 @item list | |
| 1674 @samp{-t} in @code{tar}. | |
| 1675 | |
| 1676 @item literal | |
| 1677 @samp{-N} in @code{ls}. | |
| 1678 | |
| 1679 @item load-average | |
| 10199 | 1680 @samp{-l} in @code{make}. |
| 4958 | 1681 |
| 1682 @item login | |
| 1683 Used in @code{su}. | |
| 1684 | |
| 1685 @item machine | |
| 5560 | 1686 Used in @code{uname}. |
| 4958 | 1687 |
| 1688 @item macro-name | |
| 1689 @samp{-M} in @code{ptx}. | |
| 1690 | |
| 1691 @item mail | |
| 1692 @samp{-m} in @code{hello} and @code{uname}. | |
| 1693 | |
| 1694 @item make-directories | |
| 1695 @samp{-d} in @code{cpio}. | |
| 1696 | |
| 1697 @item makefile | |
| 10199 | 1698 @samp{-f} in @code{make}. |
| 4958 | 1699 |
| 1700 @item mapped | |
| 1701 Used in GDB. | |
| 1702 | |
| 1703 @item max-args | |
| 1704 @samp{-n} in @code{xargs}. | |
| 1705 | |
| 1706 @item max-chars | |
| 1707 @samp{-n} in @code{xargs}. | |
| 1708 | |
| 1709 @item max-lines | |
| 1710 @samp{-l} in @code{xargs}. | |
| 1711 | |
| 1712 @item max-load | |
| 10199 | 1713 @samp{-l} in @code{make}. |
| 4958 | 1714 |
| 1715 @item max-procs | |
| 1716 @samp{-P} in @code{xargs}. | |
| 1717 | |
| 1718 @item mesg | |
| 1719 @samp{-T} in @code{who}. | |
| 1720 | |
| 1721 @item message | |
| 1722 @samp{-T} in @code{who}. | |
| 1723 | |
| 1724 @item minimal | |
| 1725 @samp{-d} in @code{diff}. | |
| 1726 | |
| 1727 @item mixed-uuencode | |
| 1728 @samp{-M} in @code{shar}. | |
| 1729 | |
| 1730 @item mode | |
| 1731 @samp{-m} in @code{install}, @code{mkdir}, and @code{mkfifo}. | |
| 1732 | |
| 1733 @item modification-time | |
| 1734 @samp{-m} in @code{tar}. | |
| 1735 | |
| 1736 @item multi-volume | |
| 1737 @samp{-M} in @code{tar}. | |
| 1738 | |
| 1739 @item name-prefix | |
| 1740 @samp{-a} in Bison. | |
| 1741 | |
| 1742 @item nesting-limit | |
| 1743 @samp{-L} in @code{m4}. | |
| 1744 | |
| 1745 @item net-headers | |
| 1746 @samp{-a} in @code{shar}. | |
| 1747 | |
| 1748 @item new-file | |
| 10199 | 1749 @samp{-W} in @code{make}. |
| 4958 | 1750 |
| 1751 @item no-builtin-rules | |
| 10199 | 1752 @samp{-r} in @code{make}. |
| 4958 | 1753 |
| 1754 @item no-character-count | |
| 1755 @samp{-w} in @code{shar}. | |
| 1756 | |
| 1757 @item no-check-existing | |
| 1758 @samp{-x} in @code{shar}. | |
| 1759 | |
| 1760 @item no-common | |
| 1761 @samp{-3} in @code{wdiff}. | |
| 1762 | |
| 1763 @item no-create | |
| 1764 @samp{-c} in @code{touch}. | |
| 1765 | |
| 1766 @item no-defines | |
| 1767 @samp{-D} in @code{etags}. | |
| 1768 | |
| 1769 @item no-deleted | |
| 1770 @samp{-1} in @code{wdiff}. | |
| 1771 | |
| 1772 @item no-dereference | |
| 1773 @samp{-d} in @code{cp}. | |
| 1774 | |
| 1775 @item no-inserted | |
| 1776 @samp{-2} in @code{wdiff}. | |
| 1777 | |
| 1778 @item no-keep-going | |
| 10199 | 1779 @samp{-S} in @code{make}. |
| 4958 | 1780 |
| 1781 @item no-lines | |
| 1782 @samp{-l} in Bison. | |
| 1783 | |
| 1784 @item no-piping | |
| 1785 @samp{-P} in @code{shar}. | |
| 1786 | |
| 1787 @item no-prof | |
| 1788 @samp{-e} in @code{gprof}. | |
| 1789 | |
| 1790 @item no-regex | |
| 1791 @samp{-R} in @code{etags}. | |
| 1792 | |
| 1793 @item no-sort | |
| 1794 @samp{-p} in @code{nm}. | |
| 1795 | |
| 1796 @item no-splash | |
| 1797 Don't print a startup splash screen. | |
| 1798 | |
| 1799 @item no-split | |
| 1800 Used in @code{makeinfo}. | |
| 1801 | |
| 1802 @item no-static | |
| 1803 @samp{-a} in @code{gprof}. | |
| 1804 | |
| 1805 @item no-time | |
| 1806 @samp{-E} in @code{gprof}. | |
| 1807 | |
| 1808 @item no-timestamp | |
| 1809 @samp{-m} in @code{shar}. | |
| 1810 | |
| 1811 @item no-validate | |
| 1812 Used in @code{makeinfo}. | |
| 1813 | |
| 1814 @item no-wait | |
| 1815 Used in @code{emacsclient}. | |
| 1816 | |
| 1817 @item no-warn | |
| 1818 Used in various programs to inhibit warnings. | |
| 1819 | |
| 1820 @item node | |
| 1821 @samp{-n} in @code{info}. | |
| 1822 | |
| 1823 @item nodename | |
| 1824 @samp{-n} in @code{uname}. | |
| 1825 | |
| 1826 @item nonmatching | |
| 1827 @samp{-f} in @code{cpio}. | |
| 1828 | |
| 1829 @item nstuff | |
| 1830 @samp{-n} in @code{objdump}. | |
| 1831 | |
| 1832 @item null | |
| 1833 @samp{-0} in @code{xargs}. | |
| 1834 | |
| 1835 @item number | |
| 1836 @samp{-n} in @code{cat}. | |
| 1837 | |
| 1838 @item number-nonblank | |
| 1839 @samp{-b} in @code{cat}. | |
| 1840 | |
| 1841 @item numeric-sort | |
| 1842 @samp{-n} in @code{nm}. | |
| 1843 | |
| 1844 @item numeric-uid-gid | |
| 1845 @samp{-n} in @code{cpio} and @code{ls}. | |
| 1846 | |
| 1847 @item nx | |
| 1848 Used in GDB. | |
| 1849 | |
| 1850 @item old-archive | |
| 1851 @samp{-o} in @code{tar}. | |
| 1852 | |
| 1853 @item old-file | |
| 10199 | 1854 @samp{-o} in @code{make}. |
| 4958 | 1855 |
| 1856 @item one-file-system | |
| 1857 @samp{-l} in @code{tar}, @code{cp}, and @code{du}. | |
| 1858 | |
| 1859 @item only-file | |
| 1860 @samp{-o} in @code{ptx}. | |
| 1861 | |
| 1862 @item only-prof | |
| 1863 @samp{-f} in @code{gprof}. | |
| 1864 | |
| 1865 @item only-time | |
| 1866 @samp{-F} in @code{gprof}. | |
| 1867 | |
| 1868 @item options | |
| 1869 @samp{-o} in @code{getopt}, @code{fdlist}, @code{fdmount}, | |
| 1870 @code{fdmountd}, and @code{fdumount}. | |
| 1871 | |
| 1872 @item output | |
| 1873 In various programs, specify the output file name. | |
| 1874 | |
| 1875 @item output-prefix | |
| 1876 @samp{-o} in @code{shar}. | |
| 1877 | |
| 1878 @item override | |
| 1879 @samp{-o} in @code{rm}. | |
| 1880 | |
| 1881 @item overwrite | |
| 1882 @samp{-c} in @code{unshar}. | |
| 1883 | |
| 1884 @item owner | |
| 1885 @samp{-o} in @code{install}. | |
| 1886 | |
| 1887 @item paginate | |
| 1888 @samp{-l} in @code{diff}. | |
| 1889 | |
| 1890 @item paragraph-indent | |
| 1891 Used in @code{makeinfo}. | |
| 1892 | |
| 1893 @item parents | |
| 1894 @samp{-p} in @code{mkdir} and @code{rmdir}. | |
| 1895 | |
| 1896 @item pass-all | |
| 1897 @samp{-p} in @code{ul}. | |
| 1898 | |
| 1899 @item pass-through | |
| 1900 @samp{-p} in @code{cpio}. | |
| 1901 | |
| 1902 @item port | |
| 1903 @samp{-P} in @code{finger}. | |
| 1904 | |
| 1905 @item portability | |
| 1906 @samp{-c} in @code{cpio} and @code{tar}. | |
| 1907 | |
| 1908 @item posix | |
| 1909 Used in @code{gawk}. | |
| 1910 | |
| 1911 @item prefix-builtins | |
| 1912 @samp{-P} in @code{m4}. | |
| 1913 | |
| 1914 @item prefix | |
| 1915 @samp{-f} in @code{csplit}. | |
| 1916 | |
| 1917 @item preserve | |
| 1918 Used in @code{tar} and @code{cp}. | |
| 1919 | |
| 1920 @item preserve-environment | |
| 1921 @samp{-p} in @code{su}. | |
| 1922 | |
| 1923 @item preserve-modification-time | |
| 1924 @samp{-m} in @code{cpio}. | |
| 1925 | |
| 1926 @item preserve-order | |
| 1927 @samp{-s} in @code{tar}. | |
| 1928 | |
| 1929 @item preserve-permissions | |
| 1930 @samp{-p} in @code{tar}. | |
| 1931 | |
| 1932 @item print | |
| 1933 @samp{-l} in @code{diff}. | |
| 1934 | |
| 1935 @item print-chars | |
| 1936 @samp{-L} in @code{cmp}. | |
| 1937 | |
| 1938 @item print-data-base | |
| 10199 | 1939 @samp{-p} in @code{make}. |
| 4958 | 1940 |
| 1941 @item print-directory | |
| 10199 | 1942 @samp{-w} in @code{make}. |
| 4958 | 1943 |
| 1944 @item print-file-name | |
| 1945 @samp{-o} in @code{nm}. | |
| 1946 | |
| 1947 @item print-symdefs | |
| 1948 @samp{-s} in @code{nm}. | |
| 1949 | |
| 1950 @item printer | |
| 1951 @samp{-p} in @code{wdiff}. | |
| 1952 | |
| 1953 @item prompt | |
| 1954 @samp{-p} in @code{ed}. | |
| 1955 | |
| 1956 @item proxy | |
| 1957 Specify an HTTP proxy. | |
| 1958 | |
| 1959 @item query-user | |
| 1960 @samp{-X} in @code{shar}. | |
| 1961 | |
| 1962 @item question | |
| 10199 | 1963 @samp{-q} in @code{make}. |
| 4958 | 1964 |
| 1965 @item quiet | |
| 1966 Used in many programs to inhibit the usual output. Every | |
| 1967 program accepting @samp{--quiet} should accept @samp{--silent} as a | |
| 1968 synonym. | |
| 1969 | |
| 1970 @item quiet-unshar | |
| 1971 @samp{-Q} in @code{shar} | |
| 1972 | |
| 1973 @item quote-name | |
| 1974 @samp{-Q} in @code{ls}. | |
| 1975 | |
| 1976 @item rcs | |
| 1977 @samp{-n} in @code{diff}. | |
| 1978 | |
| 1979 @item re-interval | |
| 1980 Used in @code{gawk}. | |
| 1981 | |
| 1982 @item read-full-blocks | |
| 1983 @samp{-B} in @code{tar}. | |
| 1984 | |
| 1985 @item readnow | |
| 1986 Used in GDB. | |
| 1987 | |
| 1988 @item recon | |
| 10199 | 1989 @samp{-n} in @code{make}. |
| 4958 | 1990 |
| 1991 @item record-number | |
| 1992 @samp{-R} in @code{tar}. | |
| 1993 | |
| 1994 @item recursive | |
| 1995 Used in @code{chgrp}, @code{chown}, @code{cp}, @code{ls}, @code{diff}, | |
| 1996 and @code{rm}. | |
| 1997 | |
| 10199 | 1998 @item reference |
| 1999 @samp{-r} in @code{touch}. | |
| 4958 | 2000 |
| 2001 @item references | |
| 2002 @samp{-r} in @code{ptx}. | |
| 2003 | |
| 2004 @item regex | |
| 2005 @samp{-r} in @code{tac} and @code{etags}. | |
| 2006 | |
| 2007 @item release | |
| 2008 @samp{-r} in @code{uname}. | |
| 2009 | |
| 2010 @item reload-state | |
| 2011 @samp{-R} in @code{m4}. | |
| 2012 | |
| 2013 @item relocation | |
| 2014 @samp{-r} in @code{objdump}. | |
| 2015 | |
| 2016 @item rename | |
| 2017 @samp{-r} in @code{cpio}. | |
| 2018 | |
| 2019 @item replace | |
| 2020 @samp{-i} in @code{xargs}. | |
| 2021 | |
| 2022 @item report-identical-files | |
| 2023 @samp{-s} in @code{diff}. | |
| 2024 | |
| 2025 @item reset-access-time | |
| 2026 @samp{-a} in @code{cpio}. | |
| 2027 | |
| 2028 @item reverse | |
| 2029 @samp{-r} in @code{ls} and @code{nm}. | |
| 2030 | |
| 2031 @item reversed-ed | |
| 2032 @samp{-f} in @code{diff}. | |
| 2033 | |
| 2034 @item right-side-defs | |
| 2035 @samp{-R} in @code{ptx}. | |
| 2036 | |
| 2037 @item same-order | |
| 2038 @samp{-s} in @code{tar}. | |
| 2039 | |
| 2040 @item same-permissions | |
| 2041 @samp{-p} in @code{tar}. | |
| 2042 | |
| 2043 @item save | |
| 2044 @samp{-g} in @code{stty}. | |
| 2045 | |
| 2046 @item se | |
| 2047 Used in GDB. | |
| 2048 | |
| 2049 @item sentence-regexp | |
| 2050 @samp{-S} in @code{ptx}. | |
| 2051 | |
| 2052 @item separate-dirs | |
| 2053 @samp{-S} in @code{du}. | |
| 2054 | |
| 2055 @item separator | |
| 2056 @samp{-s} in @code{tac}. | |
| 2057 | |
| 2058 @item sequence | |
| 2059 Used by @code{recode} to chose files or pipes for sequencing passes. | |
| 2060 | |
| 2061 @item shell | |
| 2062 @samp{-s} in @code{su}. | |
| 2063 | |
| 2064 @item show-all | |
| 2065 @samp{-A} in @code{cat}. | |
| 2066 | |
| 2067 @item show-c-function | |
| 2068 @samp{-p} in @code{diff}. | |
| 2069 | |
| 2070 @item show-ends | |
| 2071 @samp{-E} in @code{cat}. | |
| 2072 | |
| 2073 @item show-function-line | |
| 2074 @samp{-F} in @code{diff}. | |
| 2075 | |
| 2076 @item show-tabs | |
| 2077 @samp{-T} in @code{cat}. | |
| 2078 | |
| 2079 @item silent | |
| 2080 Used in many programs to inhibit the usual output. | |
| 2081 Every program accepting | |
| 2082 @samp{--silent} should accept @samp{--quiet} as a synonym. | |
| 2083 | |
| 2084 @item size | |
| 2085 @samp{-s} in @code{ls}. | |
| 2086 | |
| 2087 @item socket | |
| 2088 Specify a file descriptor for a network server to use for its socket, | |
| 2089 instead of opening and binding a new socket. This provides a way to | |
| 6946 | 2090 run, in a non-privileged process, a server that normally needs a |
| 4958 | 2091 reserved port number. |
| 2092 | |
| 2093 @item sort | |
| 2094 Used in @code{ls}. | |
| 2095 | |
| 2096 @item source | |
| 2097 @samp{-W source} in @code{gawk}. | |
| 2098 | |
| 2099 @item sparse | |
| 2100 @samp{-S} in @code{tar}. | |
| 2101 | |
| 2102 @item speed-large-files | |
| 2103 @samp{-H} in @code{diff}. | |
| 2104 | |
| 2105 @item split-at | |
| 2106 @samp{-E} in @code{unshar}. | |
| 2107 | |
| 2108 @item split-size-limit | |
| 2109 @samp{-L} in @code{shar}. | |
| 2110 | |
| 2111 @item squeeze-blank | |
| 2112 @samp{-s} in @code{cat}. | |
| 2113 | |
| 2114 @item start-delete | |
| 2115 @samp{-w} in @code{wdiff}. | |
| 2116 | |
| 2117 @item start-insert | |
| 2118 @samp{-y} in @code{wdiff}. | |
| 2119 | |
| 2120 @item starting-file | |
| 2121 Used in @code{tar} and @code{diff} to specify which file within | |
| 2122 a directory to start processing with. | |
| 2123 | |
| 2124 @item statistics | |
| 2125 @samp{-s} in @code{wdiff}. | |
| 2126 | |
| 2127 @item stdin-file-list | |
| 2128 @samp{-S} in @code{shar}. | |
| 2129 | |
| 2130 @item stop | |
| 10199 | 2131 @samp{-S} in @code{make}. |
| 4958 | 2132 |
| 2133 @item strict | |
| 2134 @samp{-s} in @code{recode}. | |
| 2135 | |
| 2136 @item strip | |
| 2137 @samp{-s} in @code{install}. | |
| 2138 | |
| 2139 @item strip-all | |
| 2140 @samp{-s} in @code{strip}. | |
| 2141 | |
| 2142 @item strip-debug | |
| 2143 @samp{-S} in @code{strip}. | |
| 2144 | |
| 2145 @item submitter | |
| 2146 @samp{-s} in @code{shar}. | |
| 2147 | |
| 2148 @item suffix | |
| 2149 @samp{-S} in @code{cp}, @code{ln}, @code{mv}. | |
| 2150 | |
| 2151 @item suffix-format | |
| 2152 @samp{-b} in @code{csplit}. | |
| 2153 | |
| 2154 @item sum | |
| 2155 @samp{-s} in @code{gprof}. | |
| 2156 | |
| 2157 @item summarize | |
| 2158 @samp{-s} in @code{du}. | |
| 2159 | |
| 2160 @item symbolic | |
| 2161 @samp{-s} in @code{ln}. | |
| 2162 | |
| 2163 @item symbols | |
| 2164 Used in GDB and @code{objdump}. | |
| 2165 | |
| 2166 @item synclines | |
| 2167 @samp{-s} in @code{m4}. | |
| 2168 | |
| 2169 @item sysname | |
| 2170 @samp{-s} in @code{uname}. | |
| 2171 | |
| 2172 @item tabs | |
| 2173 @samp{-t} in @code{expand} and @code{unexpand}. | |
| 2174 | |
| 2175 @item tabsize | |
| 2176 @samp{-T} in @code{ls}. | |
| 2177 | |
| 2178 @item terminal | |
| 2179 @samp{-T} in @code{tput} and @code{ul}. | |
| 2180 @samp{-t} in @code{wdiff}. | |
| 2181 | |
| 2182 @item text | |
| 2183 @samp{-a} in @code{diff}. | |
| 2184 | |
| 2185 @item text-files | |
| 2186 @samp{-T} in @code{shar}. | |
| 2187 | |
| 2188 @item time | |
| 2189 Used in @code{ls} and @code{touch}. | |
| 2190 | |
| 2191 @item timeout | |
| 2192 Specify how long to wait before giving up on some operation. | |
| 2193 | |
| 2194 @item to-stdout | |
| 2195 @samp{-O} in @code{tar}. | |
| 2196 | |
| 2197 @item total | |
| 2198 @samp{-c} in @code{du}. | |
| 2199 | |
| 2200 @item touch | |
| 10199 | 2201 @samp{-t} in @code{make}, @code{ranlib}, and @code{recode}. |
| 4958 | 2202 |
| 2203 @item trace | |
| 2204 @samp{-t} in @code{m4}. | |
| 2205 | |
| 2206 @item traditional | |
| 2207 @samp{-t} in @code{hello}; | |
| 2208 @samp{-W traditional} in @code{gawk}; | |
| 2209 @samp{-G} in @code{ed}, @code{m4}, and @code{ptx}. | |
| 2210 | |
| 2211 @item tty | |
| 2212 Used in GDB. | |
| 2213 | |
| 2214 @item typedefs | |
| 2215 @samp{-t} in @code{ctags}. | |
| 2216 | |
| 2217 @item typedefs-and-c++ | |
| 2218 @samp{-T} in @code{ctags}. | |
| 2219 | |
| 2220 @item typeset-mode | |
| 2221 @samp{-t} in @code{ptx}. | |
| 2222 | |
| 2223 @item uncompress | |
| 2224 @samp{-z} in @code{tar}. | |
| 2225 | |
| 2226 @item unconditional | |
| 2227 @samp{-u} in @code{cpio}. | |
| 2228 | |
| 2229 @item undefine | |
| 2230 @samp{-U} in @code{m4}. | |
| 2231 | |
| 2232 @item undefined-only | |
| 2233 @samp{-u} in @code{nm}. | |
| 2234 | |
| 2235 @item update | |
| 2236 @samp{-u} in @code{cp}, @code{ctags}, @code{mv}, @code{tar}. | |
| 2237 | |
| 2238 @item usage | |
| 2239 Used in @code{gawk}; same as @samp{--help}. | |
| 2240 | |
| 2241 @item uuencode | |
| 2242 @samp{-B} in @code{shar}. | |
| 2243 | |
| 2244 @item vanilla-operation | |
| 2245 @samp{-V} in @code{shar}. | |
| 2246 | |
| 2247 @item verbose | |
| 2248 Print more information about progress. Many programs support this. | |
| 2249 | |
| 2250 @item verify | |
| 2251 @samp{-W} in @code{tar}. | |
| 2252 | |
| 2253 @item version | |
| 2254 Print the version number. | |
| 2255 | |
| 2256 @item version-control | |
| 2257 @samp{-V} in @code{cp}, @code{ln}, @code{mv}. | |
| 2258 | |
| 2259 @item vgrind | |
| 2260 @samp{-v} in @code{ctags}. | |
| 2261 | |
| 2262 @item volume | |
| 2263 @samp{-V} in @code{tar}. | |
| 2264 | |
| 2265 @item what-if | |
| 10199 | 2266 @samp{-W} in @code{make}. |
| 4958 | 2267 |
| 2268 @item whole-size-limit | |
| 2269 @samp{-l} in @code{shar}. | |
| 2270 | |
| 2271 @item width | |
| 2272 @samp{-w} in @code{ls} and @code{ptx}. | |
| 2273 | |
| 2274 @item word-regexp | |
| 2275 @samp{-W} in @code{ptx}. | |
| 2276 | |
| 2277 @item writable | |
| 2278 @samp{-T} in @code{who}. | |
| 2279 | |
| 2280 @item zeros | |
| 2281 @samp{-z} in @code{gprof}. | |
| 2282 @end table | |
| 2283 | |
| 10742 | 2284 @node OID Allocations |
| 2285 @section OID Allocations | |
| 2286 @cindex OID allocations for GNU | |
| 2287 @cindex SNMP | |
| 2288 @cindex LDAP | |
| 2289 @cindex X.509 | |
| 2290 | |
| 2291 The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the | |
| 2292 GNU Project (thanks to Werner Koch). These are used for SNMP, LDAP, | |
| 2293 X.509 certificates, and so on. The web site | |
| 2294 @url{http://www.alvestrand.no/objectid} has a (voluntary) listing of | |
| 2295 many OID assignments. | |
| 2296 | |
| 2297 If you need a new slot for your GNU package, write | |
| 2298 @email{maintainers@@gnu.org}. Here is a list of arcs currently | |
| 2299 assigned: | |
| 2300 | |
| 2301 @example | |
| 2302 @include gnu-oids.texi | |
| 2303 @end example | |
| 2304 | |
| 2305 | |
| 4958 | 2306 @node Memory Usage |
| 2307 @section Memory Usage | |
| 2308 @cindex memory usage | |
| 2309 | |
| 2310 If a program typically uses just a few meg of memory, don't bother making any | |
| 2311 effort to reduce memory usage. For example, if it is impractical for | |
| 2312 other reasons to operate on files more than a few meg long, it is | |
| 7663 | 2313 reasonable to read entire input files into memory to operate on them. |
| 4958 | 2314 |
| 2315 However, for programs such as @code{cat} or @code{tail}, that can | |
| 2316 usefully operate on very large files, it is important to avoid using a | |
| 2317 technique that would artificially limit the size of files it can handle. | |
| 2318 If a program works by lines and could be applied to arbitrary | |
| 2319 user-supplied input files, it should keep only a line in memory, because | |
| 2320 this is not very hard and users will want to be able to operate on input | |
| 7663 | 2321 files that are bigger than will fit in memory all at once. |
| 4958 | 2322 |
| 2323 If your program creates complicated data structures, just make them in | |
| 7663 | 2324 memory and give a fatal error if @code{malloc} returns zero. |
| 4958 | 2325 |
| 13659 | 2326 @pindex valgrind |
| 2327 @cindex memory leak | |
| 14719 | 2328 Memory analysis tools such as @command{valgrind} can be useful, but |
| 13659 | 2329 don't complicate a program merely to avoid their false alarms. For |
| 2330 example, if memory is used until just before a process exits, don't | |
| 14719 | 2331 free it simply to silence such a tool. |
| 2332 | |
| 13659 | 2333 |
| 4958 | 2334 @node File Usage |
| 2335 @section File Usage | |
| 2336 @cindex file usage | |
| 2337 | |
| 2338 Programs should be prepared to operate when @file{/usr} and @file{/etc} | |
| 2339 are read-only file systems. Thus, if the program manages log files, | |
| 2340 lock files, backup files, score files, or any other files which are | |
| 2341 modified for internal purposes, these files should not be stored in | |
| 2342 @file{/usr} or @file{/etc}. | |
| 2343 | |
| 2344 There are two exceptions. @file{/etc} is used to store system | |
| 2345 configuration information; it is reasonable for a program to modify | |
| 2346 files in @file{/etc} when its job is to update the system configuration. | |
| 2347 Also, if the user explicitly asks to modify one file in a directory, it | |
| 2348 is reasonable for the program to store other files in the same | |
| 2349 directory. | |
| 2350 | |
| 2351 @node Writing C | |
| 2352 @chapter Making The Best Use of C | |
| 2353 | |
| 5301 | 2354 This chapter provides advice on how best to use the C language |
| 4958 | 2355 when writing GNU software. |
| 2356 | |
| 2357 @menu | |
| 9115 | 2358 * Formatting:: Formatting your source code. |
| 2359 * Comments:: Commenting your work. | |
| 2360 * Syntactic Conventions:: Clean use of C constructs. | |
| 2361 * Names:: Naming variables, functions, and files. | |
| 2362 * System Portability:: Portability among different operating systems. | |
| 2363 * CPU Portability:: Supporting the range of CPU types. | |
| 2364 * System Functions:: Portability and ``standard'' library functions. | |
| 2365 * Internationalization:: Techniques for internationalization. | |
| 6066 | 2366 * Character Set:: Use ASCII by default. |
| 16202 | 2367 * Quote Characters:: Use "..." or '...' in the C locale. |
| 4958 | 2368 * Mmap:: How you can safely use @code{mmap}. |
| 2369 @end menu | |
| 2370 | |
| 2371 @node Formatting | |
| 2372 @section Formatting Your Source Code | |
| 2373 @cindex formatting source code | |
| 2374 | |
| 2375 @cindex open brace | |
| 2376 @cindex braces, in C source | |
| 16773 | 2377 @cindex function definitions, formatting |
| 4958 | 2378 It is important to put the open-brace that starts the body of a C |
| 7703 | 2379 function in column one, so that they will start a defun. Several |
| 2380 tools look for open-braces in column one to find the beginnings of C | |
| 2381 functions. These tools will not work on code not formatted that way. | |
| 2382 | |
| 2383 Avoid putting open-brace, open-parenthesis or open-bracket in column | |
| 2384 one when they are inside a function, so that they won't start a defun. | |
| 2385 The open-brace that starts a @code{struct} body can go in column one | |
| 2386 if you find it useful to treat that definition as a defun. | |
| 4958 | 2387 |
| 2388 It is also important for function definitions to start the name of the | |
| 6498 | 2389 function in column one. This helps people to search for function |
| 4958 | 2390 definitions, and may also help certain tools recognize them. Thus, |
| 5909 | 2391 using Standard C syntax, the format is this: |
| 4958 | 2392 |
| 2393 @example | |
| 2394 static char * | |
| 5909 | 2395 concat (char *s1, char *s2) |
| 2396 @{ | |
| 4958 | 2397 @dots{} |
| 2398 @} | |
| 2399 @end example | |
| 2400 | |
| 2401 @noindent | |
| 6725 | 2402 or, if you want to use traditional C syntax, format the definition like |
| 4958 | 2403 this: |
| 2404 | |
| 2405 @example | |
| 2406 static char * | |
| 6498 | 2407 concat (s1, s2) /* Name starts in column one here */ |
| 5909 | 2408 char *s1, *s2; |
| 6498 | 2409 @{ /* Open brace in column one here */ |
| 4958 | 2410 @dots{} |
| 2411 @} | |
| 2412 @end example | |
| 2413 | |
| 2414 In Standard C, if the arguments don't fit nicely on one line, | |
| 2415 split it like this: | |
| 2416 | |
| 2417 @example | |
| 2418 int | |
| 2419 lots_of_args (int an_integer, long a_long, short a_short, | |
| 2420 double a_double, float a_float) | |
| 2421 @dots{} | |
| 2422 @end example | |
| 2423 | |
| 16773 | 2424 @cindex @code{struct} types, formatting |
| 2425 @cindex @code{enum} types, formatting | |
| 2426 For @code{struct} and @code{enum} types, likewise put the braces in | |
| 2427 column one, unless the whole contents fits on one line: | |
| 2428 | |
| 2429 @example | |
| 2430 struct foo | |
| 2431 @{ | |
| 2432 int a, b; | |
| 2433 @} | |
| 2434 @exdent @r{or} | |
| 2435 struct foo @{ int a, b; @} | |
| 2436 @end example | |
| 2437 | |
| 4958 | 2438 The rest of this section gives our recommendations for other aspects of |
| 2439 C formatting style, which is also the default style of the @code{indent} | |
| 2440 program in version 1.2 and newer. It corresponds to the options | |
| 2441 | |
| 2442 @smallexample | |
| 2443 -nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce -cp1 -cs -di2 | |
| 2444 -ndj -nfc1 -nfca -hnl -i2 -ip5 -lp -pcs -psl -nsc -nsob | |
| 2445 @end smallexample | |
| 2446 | |
| 2447 We don't think of these recommendations as requirements, because it | |
| 2448 causes no problems for users if two different programs have different | |
| 2449 formatting styles. | |
| 2450 | |
| 2451 But whatever style you use, please use it consistently, since a mixture | |
| 2452 of styles within one program tends to look ugly. If you are | |
| 2453 contributing changes to an existing program, please follow the style of | |
| 2454 that program. | |
| 2455 | |
| 2456 For the body of the function, our recommended style looks like this: | |
| 2457 | |
| 2458 @example | |
| 2459 if (x < foo (y, z)) | |
| 2460 haha = bar[4] + 5; | |
| 2461 else | |
| 2462 @{ | |
| 2463 while (z) | |
| 2464 @{ | |
| 2465 haha += foo (z, z); | |
| 2466 z--; | |
| 2467 @} | |
| 2468 return ++x + bar (); | |
| 2469 @} | |
| 2470 @end example | |
| 2471 | |
| 2472 @cindex spaces before open-paren | |
| 2473 We find it easier to read a program when it has spaces before the | |
| 2474 open-parentheses and after the commas. Especially after the commas. | |
| 2475 | |
| 2476 When you split an expression into multiple lines, split it | |
| 2477 before an operator, not after one. Here is the right way: | |
| 2478 | |
| 2479 @cindex expressions, splitting | |
| 2480 @example | |
| 2481 if (foo_this_is_long && bar > win (x, y, z) | |
| 2482 && remaining_condition) | |
| 2483 @end example | |
| 2484 | |
| 2485 Try to avoid having two operators of different precedence at the same | |
| 2486 level of indentation. For example, don't write this: | |
| 2487 | |
| 2488 @example | |
| 2489 mode = (inmode[j] == VOIDmode | |
| 2490 || GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j]) | |
| 2491 ? outmode[j] : inmode[j]); | |
| 2492 @end example | |
| 2493 | |
| 2494 Instead, use extra parentheses so that the indentation shows the nesting: | |
| 2495 | |
| 2496 @example | |
| 2497 mode = ((inmode[j] == VOIDmode | |
| 2498 || (GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j]))) | |
| 2499 ? outmode[j] : inmode[j]); | |
| 2500 @end example | |
| 2501 | |
| 2502 Insert extra parentheses so that Emacs will indent the code properly. | |
| 2503 For example, the following indentation looks nice if you do it by hand, | |
| 2504 | |
| 2505 @example | |
| 2506 v = rup->ru_utime.tv_sec*1000 + rup->ru_utime.tv_usec/1000 | |
| 2507 + rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000; | |
| 2508 @end example | |
| 2509 | |
| 2510 @noindent | |
| 2511 but Emacs would alter it. Adding a set of parentheses produces | |
| 2512 something that looks equally nice, and which Emacs will preserve: | |
| 2513 | |
| 2514 @example | |
| 2515 v = (rup->ru_utime.tv_sec*1000 + rup->ru_utime.tv_usec/1000 | |
| 2516 + rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000); | |
| 2517 @end example | |
| 2518 | |
| 2519 Format do-while statements like this: | |
| 2520 | |
| 2521 @example | |
| 2522 do | |
| 2523 @{ | |
| 2524 a = foo (a); | |
| 2525 @} | |
| 2526 while (a > 0); | |
| 2527 @end example | |
| 2528 | |
| 2529 @cindex formfeed | |
| 2530 @cindex control-L | |
| 2531 Please use formfeed characters (control-L) to divide the program into | |
| 2532 pages at logical places (but not within a function). It does not matter | |
| 2533 just how long the pages are, since they do not have to fit on a printed | |
| 2534 page. The formfeeds should appear alone on lines by themselves. | |
| 2535 | |
| 2536 @node Comments | |
| 2537 @section Commenting Your Work | |
| 2538 @cindex commenting | |
| 2539 | |
| 2540 Every program should start with a comment saying briefly what it is for. | |
| 6066 | 2541 Example: @samp{fmt - filter for simple filling of text}. This comment |
| 2542 should be at the top of the source file containing the @samp{main} | |
| 2543 function of the program. | |
| 2544 | |
| 2545 Also, please write a brief comment at the start of each source file, | |
| 2546 with the file name and a line or two about the overall purpose of the | |
| 2547 file. | |
| 4958 | 2548 |
| 2549 Please write the comments in a GNU program in English, because English | |
| 2550 is the one language that nearly all programmers in all countries can | |
| 2551 read. If you do not write English well, please write comments in | |
| 2552 English as well as you can, then ask other people to help rewrite them. | |
| 2553 If you can't write comments in English, please find someone to work with | |
| 2554 you and translate your comments into English. | |
| 2555 | |
| 2556 Please put a comment on each function saying what the function does, | |
| 2557 what sorts of arguments it gets, and what the possible values of | |
| 2558 arguments mean and are used for. It is not necessary to duplicate in | |
| 2559 words the meaning of the C argument declarations, if a C type is being | |
| 2560 used in its customary fashion. If there is anything nonstandard about | |
| 2561 its use (such as an argument of type @code{char *} which is really the | |
| 2562 address of the second character of a string, not the first), or any | |
| 2563 possible values that would not work the way one would expect (such as, | |
| 2564 that strings containing newlines are not guaranteed to work), be sure | |
| 2565 to say so. | |
| 2566 | |
| 2567 Also explain the significance of the return value, if there is one. | |
| 2568 | |
| 2569 Please put two spaces after the end of a sentence in your comments, so | |
| 2570 that the Emacs sentence commands will work. Also, please write | |
| 2571 complete sentences and capitalize the first word. If a lower-case | |
| 2572 identifier comes at the beginning of a sentence, don't capitalize it! | |
| 2573 Changing the spelling makes it a different identifier. If you don't | |
| 2574 like starting a sentence with a lower case letter, write the sentence | |
| 2575 differently (e.g., ``The identifier lower-case is @dots{}''). | |
| 2576 | |
| 2577 The comment on a function is much clearer if you use the argument | |
| 2578 names to speak about the argument values. The variable name itself | |
| 2579 should be lower case, but write it in upper case when you are speaking | |
| 2580 about the value rather than the variable itself. Thus, ``the inode | |
| 2581 number NODE_NUM'' rather than ``an inode''. | |
| 2582 | |
| 2583 There is usually no purpose in restating the name of the function in | |
| 16773 | 2584 the comment before it, because readers can see that for themselves. |
| 4958 | 2585 There might be an exception when the comment is so long that the function |
| 2586 itself would be off the bottom of the screen. | |
| 2587 | |
| 2588 There should be a comment on each static variable as well, like this: | |
| 2589 | |
| 2590 @example | |
| 2591 /* Nonzero means truncate lines in the display; | |
| 2592 zero means continue them. */ | |
| 2593 int truncate_lines; | |
| 2594 @end example | |
| 2595 | |
| 2596 @cindex conditionals, comments for | |
| 2597 @cindex @code{#endif}, commenting | |
| 2598 Every @samp{#endif} should have a comment, except in the case of short | |
| 2599 conditionals (just a few lines) that are not nested. The comment should | |
| 2600 state the condition of the conditional that is ending, @emph{including | |
| 2601 its sense}. @samp{#else} should have a comment describing the condition | |
| 2602 @emph{and sense} of the code that follows. For example: | |
| 2603 | |
| 2604 @example | |
| 2605 @group | |
| 2606 #ifdef foo | |
| 2607 @dots{} | |
| 2608 #else /* not foo */ | |
| 2609 @dots{} | |
| 2610 #endif /* not foo */ | |
| 2611 @end group | |
| 2612 @group | |
| 2613 #ifdef foo | |
| 2614 @dots{} | |
| 2615 #endif /* foo */ | |
| 2616 @end group | |
| 2617 @end example | |
| 2618 | |
| 2619 @noindent | |
| 2620 but, by contrast, write the comments this way for a @samp{#ifndef}: | |
| 2621 | |
| 2622 @example | |
| 2623 @group | |
| 2624 #ifndef foo | |
| 2625 @dots{} | |
| 2626 #else /* foo */ | |
| 2627 @dots{} | |
| 2628 #endif /* foo */ | |
| 2629 @end group | |
| 2630 @group | |
| 2631 #ifndef foo | |
| 2632 @dots{} | |
| 2633 #endif /* not foo */ | |
| 2634 @end group | |
| 2635 @end example | |
| 2636 | |
| 2637 @node Syntactic Conventions | |
| 2638 @section Clean Use of C Constructs | |
| 2639 @cindex syntactic conventions | |
| 2640 | |
| 2641 @cindex implicit @code{int} | |
| 2642 @cindex function argument, declaring | |
| 2643 Please explicitly declare the types of all objects. For example, you | |
| 2644 should explicitly declare all arguments to functions, and you should | |
| 2645 declare functions to return @code{int} rather than omitting the | |
| 2646 @code{int}. | |
| 2647 | |
| 2648 @cindex compiler warnings | |
| 2649 @cindex @samp{-Wall} compiler option | |
| 2650 Some programmers like to use the GCC @samp{-Wall} option, and change the | |
| 2651 code whenever it issues a warning. If you want to do this, then do. | |
| 2652 Other programmers prefer not to use @samp{-Wall}, because it gives | |
| 2653 warnings for valid and legitimate code which they do not want to change. | |
| 2654 If you want to do this, then do. The compiler should be your servant, | |
| 2655 not your master. | |
| 2656 | |
| 13659 | 2657 @pindex clang |
| 2658 @pindex lint | |
| 2659 Don't make the program ugly just to placate static analysis tools such | |
| 2660 as @command{lint}, @command{clang}, and GCC with extra warnings | |
| 2661 options such as @option{-Wconversion} and @option{-Wundef}. These | |
| 2662 tools can help find bugs and unclear code, but they can also generate | |
| 16673 | 2663 so many false alarms that it hurts readability to silence them with |
| 2664 unnecessary casts, wrappers, and other complications. For example, | |
| 2665 please don't insert casts to @code{void} or calls to do-nothing | |
| 2666 functions merely to pacify a lint checker. | |
| 13659 | 2667 |
| 4958 | 2668 Declarations of external functions and functions to appear later in the |
| 2669 source file should all go in one place near the beginning of the file | |
| 2670 (somewhere before the first function definition in the file), or else | |
| 2671 should go in a header file. Don't put @code{extern} declarations inside | |
| 2672 functions. | |
| 2673 | |
| 2674 @cindex temporary variables | |
| 2675 It used to be common practice to use the same local variables (with | |
| 2676 names like @code{tem}) over and over for different values within one | |
| 2677 function. Instead of doing this, it is better to declare a separate local | |
| 2678 variable for each distinct purpose, and give it a name which is | |
| 2679 meaningful. This not only makes programs easier to understand, it also | |
| 2680 facilitates optimization by good compilers. You can also move the | |
| 2681 declaration of each local variable into the smallest scope that includes | |
| 2682 all its uses. This makes the program even cleaner. | |
| 2683 | |
| 2684 Don't use local variables or parameters that shadow global identifiers. | |
| 13659 | 2685 GCC's @samp{-Wshadow} option can detect this problem. |
| 4958 | 2686 |
| 2687 @cindex multiple variables in a line | |
| 2688 Don't declare multiple variables in one declaration that spans lines. | |
| 2689 Start a new declaration on each line, instead. For example, instead | |
| 2690 of this: | |
| 2691 | |
| 2692 @example | |
| 2693 @group | |
| 2694 int foo, | |
| 2695 bar; | |
| 2696 @end group | |
| 2697 @end example | |
| 2698 | |
| 2699 @noindent | |
| 2700 write either this: | |
| 2701 | |
| 2702 @example | |
| 2703 int foo, bar; | |
| 2704 @end example | |
| 2705 | |
| 2706 @noindent | |
| 2707 or this: | |
| 2708 | |
| 2709 @example | |
| 2710 int foo; | |
| 2711 int bar; | |
| 2712 @end example | |
| 2713 | |
| 2714 @noindent | |
| 2715 (If they are global variables, each should have a comment preceding it | |
| 2716 anyway.) | |
| 2717 | |
| 2718 When you have an @code{if}-@code{else} statement nested in another | |
| 2719 @code{if} statement, always put braces around the @code{if}-@code{else}. | |
| 2720 Thus, never write like this: | |
| 2721 | |
| 2722 @example | |
| 2723 if (foo) | |
| 2724 if (bar) | |
| 2725 win (); | |
| 2726 else | |
| 2727 lose (); | |
| 2728 @end example | |
| 2729 | |
| 2730 @noindent | |
| 2731 always like this: | |
| 2732 | |
| 2733 @example | |
| 2734 if (foo) | |
| 2735 @{ | |
| 2736 if (bar) | |
| 2737 win (); | |
| 2738 else | |
| 2739 lose (); | |
| 2740 @} | |
| 2741 @end example | |
| 2742 | |
| 2743 If you have an @code{if} statement nested inside of an @code{else} | |
| 2744 statement, either write @code{else if} on one line, like this, | |
| 2745 | |
| 2746 @example | |
| 2747 if (foo) | |
| 2748 @dots{} | |
| 2749 else if (bar) | |
| 2750 @dots{} | |
| 2751 @end example | |
| 2752 | |
| 2753 @noindent | |
| 2754 with its @code{then}-part indented like the preceding @code{then}-part, | |
| 2755 or write the nested @code{if} within braces like this: | |
| 2756 | |
| 2757 @example | |
| 2758 if (foo) | |
| 2759 @dots{} | |
| 2760 else | |
| 2761 @{ | |
| 2762 if (bar) | |
| 2763 @dots{} | |
| 2764 @} | |
| 2765 @end example | |
| 2766 | |
| 2767 Don't declare both a structure tag and variables or typedefs in the | |
| 2768 same declaration. Instead, declare the structure tag separately | |
| 2769 and then use it to declare the variables or typedefs. | |
| 2770 | |
| 7663 | 2771 Try to avoid assignments inside @code{if}-conditions (assignments |
| 2772 inside @code{while}-conditions are ok). For example, don't write | |
| 2773 this: | |
| 4958 | 2774 |
| 2775 @example | |
| 2776 if ((foo = (char *) malloc (sizeof *foo)) == 0) | |
| 2777 fatal ("virtual memory exhausted"); | |
| 2778 @end example | |
| 2779 | |
| 2780 @noindent | |
| 2781 instead, write this: | |
| 2782 | |
| 2783 @example | |
| 2784 foo = (char *) malloc (sizeof *foo); | |
| 2785 if (foo == 0) | |
| 2786 fatal ("virtual memory exhausted"); | |
| 2787 @end example | |
| 2788 | |
| 13659 | 2789 This example uses zero without a cast as a null pointer constant. |
| 2790 This is perfectly fine, except that a cast is needed when calling a | |
| 2791 varargs function or when using @code{sizeof}. | |
| 4958 | 2792 |
| 2793 @node Names | |
| 2794 @section Naming Variables, Functions, and Files | |
| 2795 | |
| 2796 @cindex names of variables, functions, and files | |
| 2797 The names of global variables and functions in a program serve as | |
| 2798 comments of a sort. So don't choose terse names---instead, look for | |
| 2799 names that give useful information about the meaning of the variable or | |
| 2800 function. In a GNU program, names should be English, like other | |
| 2801 comments. | |
| 2802 | |
| 2803 Local variable names can be shorter, because they are used only within | |
| 2804 one context, where (presumably) comments explain their purpose. | |
| 2805 | |
| 2806 Try to limit your use of abbreviations in symbol names. It is ok to | |
| 2807 make a few abbreviations, explain what they mean, and then use them | |
| 2808 frequently, but don't use lots of obscure abbreviations. | |
| 2809 | |
| 2810 Please use underscores to separate words in a name, so that the Emacs | |
| 2811 word commands can be useful within them. Stick to lower case; reserve | |
| 2812 upper case for macros and @code{enum} constants, and for name-prefixes | |
| 2813 that follow a uniform convention. | |
| 2814 | |
| 2815 For example, you should use names like @code{ignore_space_change_flag}; | |
| 2816 don't use names like @code{iCantReadThis}. | |
| 2817 | |
| 2818 Variables that indicate whether command-line options have been | |
| 2819 specified should be named after the meaning of the option, not after | |
| 2820 the option-letter. A comment should state both the exact meaning of | |
| 2821 the option and its letter. For example, | |
| 2822 | |
| 2823 @example | |
| 2824 @group | |
| 2825 /* Ignore changes in horizontal whitespace (-b). */ | |
| 2826 int ignore_space_change_flag; | |
| 2827 @end group | |
| 2828 @end example | |
| 2829 | |
| 2830 When you want to define names with constant integer values, use | |
| 2831 @code{enum} rather than @samp{#define}. GDB knows about enumeration | |
| 2832 constants. | |
| 2833 | |
| 2834 @cindex file-name limitations | |
| 2835 @pindex doschk | |
| 2836 You might want to make sure that none of the file names would conflict | |
| 6498 | 2837 if the files were loaded onto an MS-DOS file system which shortens the |
| 4958 | 2838 names. You can use the program @code{doschk} to test for this. |
| 2839 | |
| 2840 Some GNU programs were designed to limit themselves to file names of 14 | |
| 2841 characters or less, to avoid file name conflicts if they are read into | |
| 2842 older System V systems. Please preserve this feature in the existing | |
| 2843 GNU programs that have it, but there is no need to do this in new GNU | |
| 2844 programs. @code{doschk} also reports file names longer than 14 | |
| 2845 characters. | |
| 2846 | |
| 14502 | 2847 |
| 4958 | 2848 @node System Portability |
| 2849 @section Portability between System Types | |
| 2850 @cindex portability, between system types | |
| 2851 | |
| 2852 In the Unix world, ``portability'' refers to porting to different Unix | |
| 2853 versions. For a GNU program, this kind of portability is desirable, but | |
| 2854 not paramount. | |
| 2855 | |
| 2856 The primary purpose of GNU software is to run on top of the GNU kernel, | |
| 17256 | 2857 compiled with the GNU C compiler, on various types of CPU. So the |
| 4958 | 2858 kinds of portability that are absolutely necessary are quite limited. |
| 2859 But it is important to support Linux-based GNU systems, since they | |
| 2860 are the form of GNU that is popular. | |
| 2861 | |
| 2862 Beyond that, it is good to support the other free operating systems | |
| 2863 (*BSD), and it is nice to support other Unix-like systems if you want | |
| 2864 to. Supporting a variety of Unix-like systems is desirable, although | |
| 2865 not paramount. It is usually not too hard, so you may as well do it. | |
| 2866 But you don't have to consider it an obligation, if it does turn out to | |
| 2867 be hard. | |
| 2868 | |
| 2869 @pindex autoconf | |
| 2870 The easiest way to achieve portability to most Unix-like systems is to | |
| 2871 use Autoconf. It's unlikely that your program needs to know more | |
| 2872 information about the host platform than Autoconf can provide, simply | |
| 2873 because most of the programs that need such knowledge have already been | |
| 2874 written. | |
| 2875 | |
| 2876 Avoid using the format of semi-internal data bases (e.g., directories) | |
| 2877 when there is a higher-level alternative (@code{readdir}). | |
| 2878 | |
| 17256 | 2879 @cindex non-POSIX systems, and portability |
| 6066 | 2880 As for systems that are not like Unix, such as MSDOS, Windows, VMS, MVS, |
| 2881 and older Macintosh systems, supporting them is often a lot of work. | |
| 2882 When that is the case, it is better to spend your time adding features | |
| 2883 that will be useful on GNU and GNU/Linux, rather than on supporting | |
| 2884 other incompatible systems. | |
| 4958 | 2885 |
| 2886 If you do support Windows, please do not abbreviate it as ``win''. In | |
| 2887 hacker terminology, calling something a ``win'' is a form of praise. | |
| 2888 You're free to praise Microsoft Windows on your own if you want, but | |
| 2889 please don't do this in GNU packages. Instead of abbreviating | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
2890 ``Windows'' to ``win'', you can write it in full or abbreviate it to |
| 4958 | 2891 ``woe'' or ``w''. In GNU Emacs, for instance, we use @samp{w32} in |
| 2892 file names of Windows-specific files, but the macro for Windows | |
| 2893 conditionals is called @code{WINDOWSNT}. | |
| 2894 | |
| 2895 It is a good idea to define the ``feature test macro'' | |
| 2896 @code{_GNU_SOURCE} when compiling your C files. When you compile on GNU | |
| 2897 or GNU/Linux, this will enable the declarations of GNU library extension | |
| 2898 functions, and that will usually give you a compiler error message if | |
| 2899 you define the same function names in some other way in your program. | |
| 2900 (You don't have to actually @emph{use} these functions, if you prefer | |
| 2901 to make the program more portable to other systems.) | |
| 2902 | |
| 2903 But whether or not you use these GNU extensions, you should avoid | |
| 2904 using their names for any other meanings. Doing so would make it hard | |
| 2905 to move your code into other GNU programs. | |
| 2906 | |
| 2907 @node CPU Portability | |
| 17256 | 2908 @section Portability between CPUs |
| 4958 | 2909 |
| 2910 @cindex data types, and portability | |
| 2911 @cindex portability, and data types | |
| 17256 | 2912 Even GNU systems will differ because of differences among CPU |
| 4958 | 2913 types---for example, difference in byte ordering and alignment |
| 2914 requirements. It is absolutely essential to handle these differences. | |
| 2915 However, don't make any effort to cater to the possibility that an | |
| 2916 @code{int} will be less than 32 bits. We don't support 16-bit machines | |
| 2917 in GNU. | |
| 2918 | |
| 2919 Similarly, don't make any effort to cater to the possibility that | |
| 2920 @code{long} will be smaller than predefined types like @code{size_t}. | |
| 2921 For example, the following code is ok: | |
| 2922 | |
| 2923 @example | |
| 2924 printf ("size = %lu\n", (unsigned long) sizeof array); | |
| 2925 printf ("diff = %ld\n", (long) (pointer2 - pointer1)); | |
| 2926 @end example | |
| 2927 | |
| 2928 1989 Standard C requires this to work, and we know of only one | |
| 14502 | 2929 counterexample: 64-bit programs on Microsoft Windows. We will leave |
| 2930 it to those who want to port GNU programs to that environment to | |
| 2931 figure out how to do it. | |
| 4958 | 2932 |
| 2933 Predefined file-size types like @code{off_t} are an exception: they are | |
| 2934 longer than @code{long} on many platforms, so code like the above won't | |
| 2935 work with them. One way to print an @code{off_t} value portably is to | |
| 2936 print its digits yourself, one by one. | |
| 2937 | |
| 2938 Don't assume that the address of an @code{int} object is also the | |
| 2939 address of its least-significant byte. This is false on big-endian | |
| 2940 machines. Thus, don't make the following mistake: | |
| 2941 | |
| 2942 @example | |
| 2943 int c; | |
| 2944 @dots{} | |
| 7663 | 2945 while ((c = getchar ()) != EOF) |
| 2946 write (file_descriptor, &c, 1); | |
| 2947 @end example | |
| 2948 | |
| 2949 @noindent Instead, use @code{unsigned char} as follows. (The @code{unsigned} | |
| 2950 is for portability to unusual systems where @code{char} is signed and | |
| 2951 where there is integer overflow checking.) | |
| 2952 | |
| 2953 @example | |
| 2954 int c; | |
| 2955 while ((c = getchar ()) != EOF) | |
| 2956 @{ | |
| 2957 unsigned char u = c; | |
| 2958 write (file_descriptor, &u, 1); | |
| 2959 @} | |
| 4958 | 2960 @end example |
| 2961 | |
| 2962 @cindex casting pointers to integers | |
| 2963 Avoid casting pointers to integers if you can. Such casts greatly | |
| 2964 reduce portability, and in most programs they are easy to avoid. In the | |
| 2965 cases where casting pointers to integers is essential---such as, a Lisp | |
| 2966 interpreter which stores type information as well as an address in one | |
| 2967 word---you'll have to make explicit provisions to handle different word | |
| 2968 sizes. You will also need to make provision for systems in which the | |
| 2969 normal range of addresses you can get from @code{malloc} starts far away | |
| 2970 from zero. | |
| 2971 | |
| 14502 | 2972 |
| 4958 | 2973 @node System Functions |
| 2974 @section Calling System Functions | |
| 14502 | 2975 |
| 2976 @cindex C library functions, and portability | |
| 2977 @cindex POSIX functions, and portability | |
| 4958 | 2978 @cindex library functions, and portability |
| 2979 @cindex portability, and library functions | |
| 2980 | |
| 14502 | 2981 Historically, C implementations differed substantially, and many |
| 2982 systems lacked a full implementation of ANSI/ISO C89. Nowadays, | |
| 17256 | 2983 however, all practical systems have a C89 compiler and GNU C supports |
| 2984 almost all of C99 and some of C11. Similarly, most systems implement | |
| 2985 POSIX.1-2001 libraries and tools, and many have POSIX.1-2008. | |
| 14502 | 2986 |
| 2987 Hence, there is little reason to support old C or non-POSIX systems, | |
| 17256 | 2988 and you may want to take advantage of standard C and POSIX to write |
| 14502 | 2989 clearer, more portable, or faster code. You should use standard |
| 2990 interfaces where possible; but if GNU extensions make your program | |
| 2991 more maintainable, powerful, or otherwise better, don't hesitate to | |
| 2992 use them. In any case, don't make your own declaration of system | |
| 2993 functions; that's a recipe for conflict. | |
| 2994 | |
| 2995 Despite the standards, nearly every library function has some sort of | |
| 2996 portability issue on some system or another. Here are some examples: | |
| 2997 | |
| 2998 @table @code | |
| 2999 @item open | |
| 3000 Names with trailing @code{/}'s are mishandled on many platforms. | |
| 3001 | |
| 3002 @item printf | |
| 3003 @code{long double} may be unimplemented; floating values Infinity and | |
| 3004 NaN are often mishandled; output for large precisions may be | |
| 3005 incorrect. | |
| 3006 | |
| 3007 @item readlink | |
| 3008 May return @code{int} instead of @code{ssize_t}. | |
| 3009 | |
| 3010 @item scanf | |
| 3011 On Windows, @code{errno} is not set on failure. | |
| 3012 @end table | |
| 3013 | |
| 3014 @cindex Gnulib | |
| 3015 @uref{http://www.gnu.org/software/gnulib/, Gnulib} is a big help in | |
| 3016 this regard. Gnulib provides implementations of standard interfaces | |
| 3017 on many of the systems that lack them, including portable | |
| 3018 implementations of enhanced GNU interfaces, thereby making their use | |
| 3019 portable, and of POSIX-1.2008 interfaces, some of which are missing | |
| 3020 even on up-to-date GNU systems. | |
| 3021 | |
| 3022 @findex xmalloc, in Gnulib | |
| 3023 @findex error messages, in Gnulib | |
| 3024 @findex data structures, in Gnulib | |
| 3025 Gnulib also provides many useful non-standard interfaces; for example, | |
| 3026 C implementations of standard data structures (hash tables, binary | |
| 3027 trees), error-checking type-safe wrappers for memory allocation | |
| 3028 functions (@code{xmalloc}, @code{xrealloc}), and output of error | |
| 3029 messages. | |
| 3030 | |
| 3031 Gnulib integrates with GNU Autoconf and Automake to remove much of the | |
| 3032 burden of writing portable code from the programmer: Gnulib makes your | |
| 3033 configure script automatically determine what features are missing and | |
| 3034 use the Gnulib code to supply the missing pieces. | |
| 3035 | |
| 3036 The Gnulib and Autoconf manuals have extensive sections on | |
| 3037 portability: @ref{Top,, Introduction, gnulib, Gnulib} and | |
| 3038 @pxref{Portable C and C++,,, autoconf, Autoconf}. Please consult them | |
| 3039 for many more details. | |
| 3040 | |
| 4958 | 3041 |
| 3042 @node Internationalization | |
| 3043 @section Internationalization | |
| 3044 @cindex internationalization | |
| 3045 | |
| 3046 @pindex gettext | |
| 3047 GNU has a library called GNU gettext that makes it easy to translate the | |
| 3048 messages in a program into various languages. You should use this | |
| 3049 library in every program. Use English for the messages as they appear | |
| 3050 in the program, and let gettext provide the way to translate them into | |
| 3051 other languages. | |
| 3052 | |
| 3053 Using GNU gettext involves putting a call to the @code{gettext} macro | |
| 3054 around each string that might need translation---like this: | |
| 3055 | |
| 3056 @example | |
| 16202 | 3057 printf (gettext ("Processing file '%s'..."), file); |
| 4958 | 3058 @end example |
| 3059 | |
| 3060 @noindent | |
| 3061 This permits GNU gettext to replace the string @code{"Processing file | |
| 16202 | 3062 '%s'..."} with a translated version. |
| 4958 | 3063 |
| 3064 Once a program uses gettext, please make a point of writing calls to | |
| 3065 @code{gettext} when you add new strings that call for translation. | |
| 3066 | |
| 3067 Using GNU gettext in a package involves specifying a @dfn{text domain | |
| 3068 name} for the package. The text domain name is used to separate the | |
| 3069 translations for this package from the translations for other packages. | |
| 3070 Normally, the text domain name should be the same as the name of the | |
| 6801 | 3071 package---for example, @samp{coreutils} for the GNU core utilities. |
| 4958 | 3072 |
| 3073 @cindex message text, and internationalization | |
| 3074 To enable gettext to work well, avoid writing code that makes | |
| 3075 assumptions about the structure of words or sentences. When you want | |
| 3076 the precise text of a sentence to vary depending on the data, use two or | |
| 3077 more alternative string constants each containing a complete sentences, | |
| 3078 rather than inserting conditionalized words or phrases into a single | |
| 3079 sentence framework. | |
| 3080 | |
| 3081 Here is an example of what not to do: | |
| 3082 | |
| 7159 | 3083 @smallexample |
| 6801 | 3084 printf ("%s is full", capacity > 5000000 ? "disk" : "floppy disk"); |
| 7159 | 3085 @end smallexample |
| 4958 | 3086 |
| 6801 | 3087 If you apply gettext to all strings, like this, |
| 4958 | 3088 |
| 7159 | 3089 @smallexample |
| 6801 | 3090 printf (gettext ("%s is full"), |
| 3091 capacity > 5000000 ? gettext ("disk") : gettext ("floppy disk")); | |
| 7159 | 3092 @end smallexample |
| 4958 | 3093 |
| 3094 @noindent | |
| 6801 | 3095 the translator will hardly know that "disk" and "floppy disk" are meant to |
| 3096 be substituted in the other string. Worse, in some languages (like French) | |
| 3097 the construction will not work: the translation of the word "full" depends | |
| 3098 on the gender of the first part of the sentence; it happens to be not the | |
| 3099 same for "disk" as for "floppy disk". | |
| 3100 | |
| 3101 Complete sentences can be translated without problems: | |
| 4958 | 3102 |
| 3103 @example | |
| 6801 | 3104 printf (capacity > 5000000 ? gettext ("disk is full") |
| 3105 : gettext ("floppy disk is full")); | |
| 4958 | 3106 @end example |
| 3107 | |
| 3108 A similar problem appears at the level of sentence structure with this | |
| 3109 code: | |
| 3110 | |
| 3111 @example | |
| 3112 printf ("# Implicit rule search has%s been done.\n", | |
| 3113 f->tried_implicit ? "" : " not"); | |
| 3114 @end example | |
| 3115 | |
| 3116 @noindent | |
| 3117 Adding @code{gettext} calls to this code cannot give correct results for | |
| 3118 all languages, because negation in some languages requires adding words | |
| 3119 at more than one place in the sentence. By contrast, adding | |
| 6946 | 3120 @code{gettext} calls does the job straightforwardly if the code starts |
| 4958 | 3121 out like this: |
| 3122 | |
| 3123 @example | |
| 3124 printf (f->tried_implicit | |
| 3125 ? "# Implicit rule search has been done.\n", | |
| 3126 : "# Implicit rule search has not been done.\n"); | |
| 3127 @end example | |
| 3128 | |
| 6801 | 3129 Another example is this one: |
| 3130 | |
| 3131 @example | |
| 3132 printf ("%d file%s processed", nfiles, | |
| 3133 nfiles != 1 ? "s" : ""); | |
| 3134 @end example | |
| 3135 | |
| 3136 @noindent | |
| 3137 The problem with this example is that it assumes that plurals are made | |
| 3138 by adding `s'. If you apply gettext to the format string, like this, | |
| 3139 | |
| 3140 @example | |
| 3141 printf (gettext ("%d file%s processed"), nfiles, | |
| 3142 nfiles != 1 ? "s" : ""); | |
| 3143 @end example | |
| 3144 | |
| 3145 @noindent | |
| 3146 the message can use different words, but it will still be forced to use | |
| 3147 `s' for the plural. Here is a better way, with gettext being applied to | |
| 3148 the two strings independently: | |
| 3149 | |
| 3150 @example | |
| 3151 printf ((nfiles != 1 ? gettext ("%d files processed") | |
| 3152 : gettext ("%d file processed")), | |
| 3153 nfiles); | |
| 3154 @end example | |
| 3155 | |
| 3156 @noindent | |
| 3157 But this still doesn't work for languages like Polish, which has three | |
| 3158 plural forms: one for nfiles == 1, one for nfiles == 2, 3, 4, 22, 23, 24, ... | |
| 3159 and one for the rest. The GNU @code{ngettext} function solves this problem: | |
| 3160 | |
| 3161 @example | |
| 3162 printf (ngettext ("%d files processed", "%d file processed", nfiles), | |
| 3163 nfiles); | |
| 3164 @end example | |
| 3165 | |
| 6066 | 3166 |
| 3167 @node Character Set | |
| 3168 @section Character Set | |
| 3169 @cindex character set | |
| 3170 @cindex encodings | |
| 3171 @cindex ASCII characters | |
| 3172 @cindex non-ASCII characters | |
| 3173 | |
| 3174 Sticking to the ASCII character set (plain text, 7-bit characters) is | |
| 3175 preferred in GNU source code comments, text documents, and other | |
| 3176 contexts, unless there is good reason to do something else because of | |
| 3177 the application domain. For example, if source code deals with the | |
| 3178 French Revolutionary calendar, it is OK if its literal strings contain | |
| 3179 accented characters in month names like ``Flor@'eal''. Also, it is OK | |
| 16158 | 3180 (but not required) to use non-ASCII characters to represent proper |
| 3181 names of contributors in change logs (@pxref{Change Logs}). | |
| 6066 | 3182 |
| 16159 | 3183 If you need to use non-ASCII characters, you should normally stick |
| 3184 with one encoding, certainly within a single file. UTF-8 is likely to | |
| 3185 be the best choice. | |
| 6066 | 3186 |
| 3187 | |
| 3188 @node Quote Characters | |
| 3189 @section Quote Characters | |
| 3190 @cindex quote characters | |
| 3191 @cindex locale-specific quote characters | |
| 3192 @cindex left quote | |
| 16202 | 3193 @cindex right quote |
| 3194 @cindex opening quote | |
| 3195 @cindex single quote | |
| 3196 @cindex double quote | |
| 6066 | 3197 @cindex grave accent |
| 16202 | 3198 @set txicodequoteundirected |
| 3199 @set txicodequotebacktick | |
| 3200 | |
| 3201 In the C locale, the output of GNU programs should stick to plain | |
| 3202 ASCII for quotation characters in messages to users: preferably 0x22 | |
| 3203 (@samp{"}) or 0x27 (@samp{'}) for both opening and closing quotes. | |
| 3204 Although GNU programs traditionally used 0x60 (@samp{`}) for opening | |
| 3205 and 0x27 (@samp{'}) for closing quotes, nowadays quotes @samp{`like | |
| 3206 this'} are typically rendered asymmetrically, so quoting @samp{"like | |
| 3207 this"} or @samp{'like this'} typically looks better. | |
| 3208 | |
| 3209 It is ok, but not required, for GNU programs to generate | |
| 3210 locale-specific quotes in non-C locales. For example: | |
| 3211 | |
| 3212 @example | |
| 3213 printf (gettext ("Processing file '%s'..."), file); | |
| 3214 @end example | |
| 3215 | |
| 3216 @noindent | |
| 3217 Here, a French translation might cause @code{gettext} to return the | |
| 3218 string @code{"Traitement de fichier | |
| 3219 @guilsinglleft{}@tie{}%s@tie{}@guilsinglright{}..."}, yielding quotes | |
| 3220 more appropriate for a French locale. | |
| 3221 | |
| 3222 Sometimes a program may need to use opening and closing quotes | |
| 3223 directly. By convention, @code{gettext} translates the string | |
| 3224 @samp{"`"} to the opening quote and the string @samp{"'"} to the | |
| 3225 closing quote, and a program can use these translations. Generally, | |
| 3226 though, it is better to translate quote characters in the context of | |
| 3227 longer strings. | |
| 3228 | |
| 3229 If the output of your program is ever likely to be parsed by another | |
| 3230 program, it is good to provide an option that makes this parsing | |
| 3231 reliable. For example, you could escape special characters using | |
| 3232 conventions from the C language or the Bourne shell. See for example | |
| 3233 the option @option{--quoting-style} of GNU @code{ls}. | |
| 3234 | |
| 3235 @clear txicodequoteundirected | |
| 3236 @clear txicodequotebacktick | |
| 6066 | 3237 |
| 3238 | |
| 4958 | 3239 @node Mmap |
| 3240 @section Mmap | |
| 3241 @findex mmap | |
| 3242 | |
| 17476 | 3243 If you use @code{mmap} to read or write files, don't assume it either |
| 3244 works on all files or fails for all files. It may work on some files | |
| 3245 and fail on others. | |
| 4958 | 3246 |
| 3247 The proper way to use @code{mmap} is to try it on the specific file for | |
| 3248 which you want to use it---and if @code{mmap} doesn't work, fall back on | |
| 3249 doing the job in another way using @code{read} and @code{write}. | |
| 3250 | |
| 3251 The reason this precaution is needed is that the GNU kernel (the HURD) | |
| 3252 provides a user-extensible file system, in which there can be many | |
| 15793 | 3253 different kinds of ``ordinary files''. Many of them support |
| 4958 | 3254 @code{mmap}, but some do not. It is important to make programs handle |
| 3255 all these kinds of files. | |
| 3256 | |
| 15793 | 3257 |
| 4958 | 3258 @node Documentation |
| 3259 @chapter Documenting Programs | |
| 3260 @cindex documentation | |
| 3261 | |
| 3262 A GNU program should ideally come with full free documentation, adequate | |
| 3263 for both reference and tutorial purposes. If the package can be | |
| 3264 programmed or extended, the documentation should cover programming or | |
| 3265 extending it, as well as just using it. | |
| 3266 | |
| 3267 @menu | |
| 3268 * GNU Manuals:: Writing proper manuals. | |
| 3269 * Doc Strings and Manuals:: Compiling doc strings doesn't make a manual. | |
| 3270 * Manual Structure Details:: Specific structure conventions. | |
| 3271 * License for Manuals:: Writing the distribution terms for a manual. | |
| 3272 * Manual Credits:: Giving credit to documentation contributors. | |
| 3273 * Printed Manuals:: Mentioning the printed manual. | |
| 3274 * NEWS File:: NEWS files supplement manuals. | |
| 9115 | 3275 * Change Logs:: Recording changes. |
| 4958 | 3276 * Man Pages:: Man pages are secondary. |
| 3277 * Reading other Manuals:: How far you can go in learning | |
| 3278 from other manuals. | |
| 3279 @end menu | |
| 3280 | |
| 3281 @node GNU Manuals | |
| 3282 @section GNU Manuals | |
| 3283 | |
| 3284 The preferred document format for the GNU system is the Texinfo | |
| 3285 formatting language. Every GNU package should (ideally) have | |
| 3286 documentation in Texinfo both for reference and for learners. Texinfo | |
| 3287 makes it possible to produce a good quality formatted book, using | |
| 3288 @TeX{}, and to generate an Info file. It is also possible to generate | |
| 3289 HTML output from Texinfo source. See the Texinfo manual, either the | |
| 3290 hardcopy, or the on-line version available through @code{info} or the | |
| 3291 Emacs Info subsystem (@kbd{C-h i}). | |
| 3292 | |
| 3293 Nowadays some other formats such as Docbook and Sgmltexi can be | |
| 3294 converted automatically into Texinfo. It is ok to produce the Texinfo | |
| 3295 documentation by conversion this way, as long as it gives good results. | |
| 3296 | |
| 6775 | 3297 Make sure your manual is clear to a reader who knows nothing about the |
| 3298 topic and reads it straight through. This means covering basic topics | |
| 3299 at the beginning, and advanced topics only later. This also means | |
| 3300 defining every specialized term when it is first used. | |
| 3301 | |
| 3302 Programmers tend to carry over the structure of the program as the | |
| 3303 structure for its documentation. But this structure is not | |
| 3304 necessarily good for explaining how to use the program; it may be | |
| 3305 irrelevant and confusing for a user. | |
| 3306 | |
| 3307 Instead, the right way to structure documentation is according to the | |
| 3308 concepts and questions that a user will have in mind when reading it. | |
| 3309 This principle applies at every level, from the lowest (ordering | |
| 3310 sentences in a paragraph) to the highest (ordering of chapter topics | |
| 3311 within the manual). Sometimes this structure of ideas matches the | |
| 4958 | 3312 structure of the implementation of the software being documented---but |
| 6775 | 3313 often they are different. An important part of learning to write good |
| 3314 documentation is to learn to notice when you have unthinkingly | |
| 3315 structured the documentation like the implementation, stop yourself, | |
| 3316 and look for better alternatives. | |
| 4958 | 3317 |
| 3318 For example, each program in the GNU system probably ought to be | |
| 3319 documented in one manual; but this does not mean each program should | |
| 3320 have its own manual. That would be following the structure of the | |
| 3321 implementation, rather than the structure that helps the user | |
| 3322 understand. | |
| 3323 | |
| 3324 Instead, each manual should cover a coherent @emph{topic}. For example, | |
| 3325 instead of a manual for @code{diff} and a manual for @code{diff3}, we | |
| 3326 have one manual for ``comparison of files'' which covers both of those | |
| 3327 programs, as well as @code{cmp}. By documenting these programs | |
| 3328 together, we can make the whole subject clearer. | |
| 3329 | |
| 3330 The manual which discusses a program should certainly document all of | |
| 3331 the program's command-line options and all of its commands. It should | |
| 3332 give examples of their use. But don't organize the manual as a list | |
| 3333 of features. Instead, organize it logically, by subtopics. Address | |
| 3334 the questions that a user will ask when thinking about the job that | |
| 3335 the program does. Don't just tell the reader what each feature can | |
| 3336 do---say what jobs it is good for, and show how to use it for those | |
| 3337 jobs. Explain what is recommended usage, and what kinds of usage | |
| 3338 users should avoid. | |
| 3339 | |
| 3340 In general, a GNU manual should serve both as tutorial and reference. | |
| 3341 It should be set up for convenient access to each topic through Info, | |
| 3342 and for reading straight through (appendixes aside). A GNU manual | |
| 3343 should give a good introduction to a beginner reading through from the | |
| 3344 start, and should also provide all the details that hackers want. | |
| 3345 The Bison manual is a good example of this---please take a look at it | |
| 3346 to see what we mean. | |
| 3347 | |
| 3348 That is not as hard as it first sounds. Arrange each chapter as a | |
| 3349 logical breakdown of its topic, but order the sections, and write their | |
| 3350 text, so that reading the chapter straight through makes sense. Do | |
| 3351 likewise when structuring the book into chapters, and when structuring a | |
| 3352 section into paragraphs. The watchword is, @emph{at each point, address | |
| 3353 the most fundamental and important issue raised by the preceding text.} | |
| 3354 | |
| 3355 If necessary, add extra chapters at the beginning of the manual which | |
| 3356 are purely tutorial and cover the basics of the subject. These provide | |
| 3357 the framework for a beginner to understand the rest of the manual. The | |
| 3358 Bison manual provides a good example of how to do this. | |
| 3359 | |
| 17362 | 3360 To serve as a reference, a manual should have an Index that lists all |
| 3361 the functions, variables, options, and important concepts that are | |
| 3362 part of the program. One combined Index should do for a short manual, | |
| 3363 but sometimes for a complex package it is better to use multiple | |
| 3364 indices. The Texinfo manual includes advice on preparing good index | |
| 3365 entries, see @ref{Index Entries, , Making Index Entries, texinfo, GNU | |
| 3366 Texinfo}, and see @ref{Indexing Commands, , Defining the Entries of an | |
| 5909 | 3367 Index, texinfo, GNU Texinfo}. |
| 4958 | 3368 |
| 3369 Don't use Unix man pages as a model for how to write GNU documentation; | |
| 3370 most of them are terse, badly structured, and give inadequate | |
| 3371 explanation of the underlying concepts. (There are, of course, some | |
| 3372 exceptions.) Also, Unix man pages use a particular format which is | |
| 3373 different from what we use in GNU manuals. | |
| 3374 | |
| 3375 Please include an email address in the manual for where to report | |
| 3376 bugs @emph{in the text of the manual}. | |
| 3377 | |
| 3378 Please do not use the term ``pathname'' that is used in Unix | |
| 3379 documentation; use ``file name'' (two words) instead. We use the term | |
| 3380 ``path'' only for search paths, which are lists of directory names. | |
| 3381 | |
| 3382 Please do not use the term ``illegal'' to refer to erroneous input to | |
| 3383 a computer program. Please use ``invalid'' for this, and reserve the | |
| 3384 term ``illegal'' for activities prohibited by law. | |
| 3385 | |
| 6775 | 3386 Please do not write @samp{()} after a function name just to indicate |
| 3387 it is a function. @code{foo ()} is not a function, it is a function | |
| 3388 call with no arguments. | |
| 3389 | |
| 4958 | 3390 @node Doc Strings and Manuals |
| 3391 @section Doc Strings and Manuals | |
| 3392 | |
| 3393 Some programming systems, such as Emacs, provide a documentation string | |
| 3394 for each function, command or variable. You may be tempted to write a | |
| 3395 reference manual by compiling the documentation strings and writing a | |
| 3396 little additional text to go around them---but you must not do it. That | |
| 3397 approach is a fundamental mistake. The text of well-written | |
| 3398 documentation strings will be entirely wrong for a manual. | |
| 3399 | |
| 3400 A documentation string needs to stand alone---when it appears on the | |
| 3401 screen, there will be no other text to introduce or explain it. | |
| 3402 Meanwhile, it can be rather informal in style. | |
| 3403 | |
| 3404 The text describing a function or variable in a manual must not stand | |
| 3405 alone; it appears in the context of a section or subsection. Other text | |
| 3406 at the beginning of the section should explain some of the concepts, and | |
| 3407 should often make some general points that apply to several functions or | |
| 3408 variables. The previous descriptions of functions and variables in the | |
| 3409 section will also have given information about the topic. A description | |
| 3410 written to stand alone would repeat some of that information; this | |
| 6946 | 3411 redundancy looks bad. Meanwhile, the informality that is acceptable in |
| 4958 | 3412 a documentation string is totally unacceptable in a manual. |
| 3413 | |
| 3414 The only good way to use documentation strings in writing a good manual | |
| 3415 is to use them as a source of information for writing good text. | |
| 3416 | |
| 3417 @node Manual Structure Details | |
| 3418 @section Manual Structure Details | |
| 3419 @cindex manual structure | |
| 3420 | |
| 3421 The title page of the manual should state the version of the programs or | |
| 3422 packages documented in the manual. The Top node of the manual should | |
| 3423 also contain this information. If the manual is changing more | |
| 3424 frequently than or independent of the program, also state a version | |
| 3425 number for the manual in both of these places. | |
| 3426 | |
| 3427 Each program documented in the manual should have a node named | |
| 3428 @samp{@var{program} Invocation} or @samp{Invoking @var{program}}. This | |
| 3429 node (together with its subnodes, if any) should describe the program's | |
| 3430 command line arguments and how to run it (the sort of information people | |
| 5301 | 3431 would look for in a man page). Start with an @samp{@@example} |
| 4958 | 3432 containing a template for all the options and arguments that the program |
| 3433 uses. | |
| 3434 | |
| 3435 Alternatively, put a menu item in some menu whose item name fits one of | |
| 3436 the above patterns. This identifies the node which that item points to | |
| 3437 as the node for this purpose, regardless of the node's actual name. | |
| 3438 | |
| 3439 The @samp{--usage} feature of the Info reader looks for such a node | |
| 3440 or menu item in order to find the relevant text, so it is essential | |
| 3441 for every Texinfo file to have one. | |
| 3442 | |
| 3443 If one manual describes several programs, it should have such a node for | |
| 3444 each program described in the manual. | |
| 3445 | |
| 3446 @node License for Manuals | |
| 3447 @section License for Manuals | |
| 3448 @cindex license for manuals | |
| 3449 | |
| 3450 Please use the GNU Free Documentation License for all GNU manuals that | |
| 3451 are more than a few pages long. Likewise for a collection of short | |
| 3452 documents---you only need one copy of the GNU FDL for the whole | |
| 3453 collection. For a single short document, you can use a very permissive | |
| 3454 non-copyleft license, to avoid taking up space with a long license. | |
| 3455 | |
| 3456 See @uref{http://www.gnu.org/copyleft/fdl-howto.html} for more explanation | |
| 3457 of how to employ the GFDL. | |
| 3458 | |
| 3459 Note that it is not obligatory to include a copy of the GNU GPL or GNU | |
| 3460 LGPL in a manual whose license is neither the GPL nor the LGPL. It can | |
| 3461 be a good idea to include the program's license in a large manual; in a | |
| 3462 short manual, whose size would be increased considerably by including | |
| 3463 the program's license, it is probably better not to include it. | |
| 3464 | |
| 3465 @node Manual Credits | |
| 3466 @section Manual Credits | |
| 3467 @cindex credits for manuals | |
| 3468 | |
| 3469 Please credit the principal human writers of the manual as the authors, | |
| 3470 on the title page of the manual. If a company sponsored the work, thank | |
| 3471 the company in a suitable place in the manual, but do not cite the | |
| 3472 company as an author. | |
| 3473 | |
| 3474 @node Printed Manuals | |
| 3475 @section Printed Manuals | |
| 3476 | |
| 3477 The FSF publishes some GNU manuals in printed form. To encourage sales | |
| 3478 of these manuals, the on-line versions of the manual should mention at | |
| 3479 the very start that the printed manual is available and should point at | |
| 3480 information for getting it---for instance, with a link to the page | |
| 3481 @url{http://www.gnu.org/order/order.html}. This should not be included | |
| 3482 in the printed manual, though, because there it is redundant. | |
| 3483 | |
| 3484 It is also useful to explain in the on-line forms of the manual how the | |
| 3485 user can print out the manual from the sources. | |
| 3486 | |
| 3487 @node NEWS File | |
| 3488 @section The NEWS File | |
| 3489 @cindex @file{NEWS} file | |
| 3490 | |
| 3491 In addition to its manual, the package should have a file named | |
| 3492 @file{NEWS} which contains a list of user-visible changes worth | |
| 3493 mentioning. In each new release, add items to the front of the file and | |
| 3494 identify the version they pertain to. Don't discard old items; leave | |
| 3495 them in the file after the newer items. This way, a user upgrading from | |
| 3496 any previous version can see what is new. | |
| 3497 | |
| 3498 If the @file{NEWS} file gets very long, move some of the older items | |
| 3499 into a file named @file{ONEWS} and put a note at the end referring the | |
| 3500 user to that file. | |
| 3501 | |
| 3502 @node Change Logs | |
| 3503 @section Change Logs | |
| 3504 @cindex change logs | |
| 3505 | |
| 3506 Keep a change log to describe all the changes made to program source | |
| 3507 files. The purpose of this is so that people investigating bugs in the | |
| 3508 future will know about the changes that might have introduced the bug. | |
| 3509 Often a new bug can be found by looking at what was recently changed. | |
| 3510 More importantly, change logs can help you eliminate conceptual | |
| 3511 inconsistencies between different parts of a program, by giving you a | |
| 3512 history of how the conflicting concepts arose and who they came from. | |
| 3513 | |
| 3514 @menu | |
| 6725 | 3515 * Change Log Concepts:: |
| 3516 * Style of Change Logs:: | |
| 3517 * Simple Changes:: | |
| 3518 * Conditional Changes:: | |
| 4958 | 3519 * Indicating the Part Changed:: |
| 3520 @end menu | |
| 3521 | |
| 3522 @node Change Log Concepts | |
| 3523 @subsection Change Log Concepts | |
| 3524 | |
| 16890 | 3525 @cindex change set |
| 3526 @cindex batch of changes | |
| 4958 | 3527 You can think of the change log as a conceptual ``undo list'' which |
| 3528 explains how earlier versions were different from the current version. | |
| 16890 | 3529 People can see the current version; they don't need the change log to |
| 3530 tell them what is in it. What they want from a change log is a clear | |
| 3531 explanation of how the earlier version differed. Each @dfn{entry} in | |
| 3532 a change log describes either an individual change or the smallest | |
| 3533 batch of changes that belong together, also known as a @dfn{change | |
| 3534 set}. | |
| 16957 | 3535 @cindex title, change log entry |
| 3536 @cindex description, change log entry | |
| 3537 For later reference or for summarizing, sometimes it is useful to | |
| 3538 start the entry with a one-line description (sometimes called a | |
| 3539 @dfn{title}) to describe its overall purpose. | |
| 3540 | |
| 3541 In the past, we recommended not mentioning changes in non-software | |
| 3542 files (manuals, help files, media files, etc.)@: in change logs. | |
| 3543 However, we've been advised that it is a good idea to include them, | |
| 3544 for the sake of copyright records. | |
| 4958 | 3545 |
| 3546 The change log file is normally called @file{ChangeLog} and covers an | |
| 3547 entire directory. Each directory can have its own change log, or a | |
| 12897 | 3548 directory can use the change log of its parent directory---it's up to |
| 4958 | 3549 you. |
| 3550 | |
| 3551 Another alternative is to record change log information with a version | |
| 3552 control system such as RCS or CVS. This can be converted automatically | |
| 3553 to a @file{ChangeLog} file using @code{rcs2log}; in Emacs, the command | |
| 3554 @kbd{C-x v a} (@code{vc-update-change-log}) does the job. | |
| 3555 | |
| 16957 | 3556 For changes to code, there's no need to describe the full purpose of |
| 3557 the changes or how they work together. If you think that a change | |
| 3558 calls for explanation, you're probably right. Please do explain | |
| 3559 it---but please put the full explanation in comments in the code, | |
| 3560 where people will see it whenever they see the code. For example, | |
| 3561 ``New function'' is enough for the change log when you add a function, | |
| 3562 because there should be a comment before the function definition to | |
| 3563 explain what it does. | |
| 3564 | |
| 3565 For changes to files that do not support a comment syntax (e.g., media | |
| 3566 files), it is ok to include the full explanation in the change log file, | |
| 3567 after the title and before the list of individual changes. | |
| 4958 | 3568 |
| 3569 The easiest way to add an entry to @file{ChangeLog} is with the Emacs | |
| 16890 | 3570 command @kbd{M-x add-change-log-entry}. An individual change should |
| 3571 have an asterisk, the name of the changed file, and then in | |
| 3572 parentheses the name of the changed functions, variables or whatever, | |
| 3573 followed by a colon. Then describe the changes you made to that | |
| 3574 function or variable. | |
| 3575 | |
| 4958 | 3576 |
| 3577 @node Style of Change Logs | |
| 3578 @subsection Style of Change Logs | |
| 3579 @cindex change logs, style | |
| 3580 | |
| 3581 Here are some simple examples of change log entries, starting with the | |
| 3582 header line that says who made the change and when it was installed, | |
| 3583 followed by descriptions of specific changes. (These examples are | |
| 3584 drawn from Emacs and GCC.) | |
| 3585 | |
| 3586 @example | |
| 3587 1998-08-17 Richard Stallman <rms@@gnu.org> | |
| 3588 | |
| 3589 * register.el (insert-register): Return nil. | |
| 3590 (jump-to-register): Likewise. | |
| 3591 | |
| 3592 * sort.el (sort-subr): Return nil. | |
| 3593 | |
| 3594 * tex-mode.el (tex-bibtex-file, tex-file, tex-region): | |
| 3595 Restart the tex shell if process is gone or stopped. | |
| 3596 (tex-shell-running): New function. | |
| 3597 | |
| 3598 * expr.c (store_one_arg): Round size up for move_block_to_reg. | |
| 3599 (expand_call): Round up when emitting USE insns. | |
| 3600 * stmt.c (assign_parms): Round size up for move_block_from_reg. | |
| 3601 @end example | |
| 3602 | |
| 3603 It's important to name the changed function or variable in full. Don't | |
| 3604 abbreviate function or variable names, and don't combine them. | |
| 3605 Subsequent maintainers will often search for a function name to find all | |
| 3606 the change log entries that pertain to it; if you abbreviate the name, | |
| 3607 they won't find it when they search. | |
| 3608 | |
| 3609 For example, some people are tempted to abbreviate groups of function | |
| 3610 names by writing @samp{* register.el (@{insert,jump-to@}-register)}; | |
| 3611 this is not a good idea, since searching for @code{jump-to-register} or | |
| 3612 @code{insert-register} would not find that entry. | |
| 3613 | |
| 16890 | 3614 Separate unrelated change log entries with blank lines. Don't put |
| 3615 blank lines between individual changes of an entry. You can omit the | |
| 3616 file name and the asterisk when successive individual changes are in | |
| 3617 the same file. | |
| 4958 | 3618 |
| 3619 Break long lists of function names by closing continued lines with | |
| 3620 @samp{)}, rather than @samp{,}, and opening the continuation with | |
| 3621 @samp{(} as in this example: | |
| 3622 | |
| 3623 @example | |
| 3624 * keyboard.c (menu_bar_items, tool_bar_items) | |
| 16202 | 3625 (Fexecute_extended_command): Deal with 'keymap' property. |
| 4958 | 3626 @end example |
| 3627 | |
| 3628 When you install someone else's changes, put the contributor's name in | |
| 3629 the change log entry rather than in the text of the entry. In other | |
| 3630 words, write this: | |
| 3631 | |
| 3632 @example | |
| 3633 2002-07-14 John Doe <jdoe@@gnu.org> | |
| 3634 | |
| 3635 * sewing.c: Make it sew. | |
| 3636 @end example | |
| 3637 | |
| 3638 @noindent | |
| 3639 rather than this: | |
| 3640 | |
| 3641 @example | |
| 3642 2002-07-14 Usual Maintainer <usual@@gnu.org> | |
| 3643 | |
| 3644 * sewing.c: Make it sew. Patch by jdoe@@gnu.org. | |
| 3645 @end example | |
| 3646 | |
| 3647 As for the date, that should be the date you applied the change. | |
| 3648 | |
| 3649 @node Simple Changes | |
| 3650 @subsection Simple Changes | |
| 3651 | |
| 3652 Certain simple kinds of changes don't need much detail in the change | |
| 3653 log. | |
| 3654 | |
| 3655 When you change the calling sequence of a function in a simple fashion, | |
| 3656 and you change all the callers of the function to use the new calling | |
| 3657 sequence, there is no need to make individual entries for all the | |
| 3658 callers that you changed. Just write in the entry for the function | |
| 3659 being called, ``All callers changed''---like this: | |
| 3660 | |
| 3661 @example | |
| 3662 * keyboard.c (Fcommand_execute): New arg SPECIAL. | |
| 3663 All callers changed. | |
| 3664 @end example | |
| 3665 | |
| 3666 When you change just comments or doc strings, it is enough to write an | |
| 3667 entry for the file, without mentioning the functions. Just ``Doc | |
| 3668 fixes'' is enough for the change log. | |
| 3669 | |
| 3670 There's no technical need to make change log entries for documentation | |
| 3671 files. This is because documentation is not susceptible to bugs that | |
| 3672 are hard to fix. Documentation does not consist of parts that must | |
| 3673 interact in a precisely engineered fashion. To correct an error, you | |
| 3674 need not know the history of the erroneous passage; it is enough to | |
| 3675 compare what the documentation says with the way the program actually | |
| 3676 works. | |
| 3677 | |
| 3678 However, you should keep change logs for documentation files when the | |
| 3679 project gets copyright assignments from its contributors, so as to | |
| 3680 make the records of authorship more accurate. | |
| 3681 | |
| 3682 @node Conditional Changes | |
| 3683 @subsection Conditional Changes | |
| 3684 @cindex conditional changes, and change logs | |
| 3685 @cindex change logs, conditional changes | |
| 3686 | |
| 16186 | 3687 Source files can often contain code that is conditional to build-time |
| 3688 or static conditions. For example, C programs can contain | |
| 3689 compile-time @code{#if} conditionals; programs implemented in | |
| 3690 interpreted languages can contain module imports of function | |
| 3691 definitions that are only performed for certain versions of the | |
| 3692 interpreter; and Automake @file{Makefile.am} files can contain | |
| 3693 variable definitions or target declarations that are only to be | |
| 3694 considered if a configure-time Automake conditional is true. | |
| 3695 | |
| 3696 Many changes are conditional as well: sometimes you add a new variable, | |
| 3697 or function, or even a new program or library, which is entirely | |
| 3698 dependent on a build-time condition. It is useful to indicate | |
| 3699 in the change log the conditions for which a change applies. | |
| 3700 | |
| 3701 Our convention for indicating conditional changes is to use | |
| 3702 @emph{square brackets around the name of the condition}. | |
| 3703 | |
| 3704 Conditional changes can happen in numerous scenarios and with many | |
| 3705 variations, so here are some examples to help clarify. This first | |
| 3706 example describes changes in C, Perl, and Python files which are | |
| 3707 conditional but do not have an associated function or entity name: | |
| 4958 | 3708 |
| 3709 @example | |
| 16186 | 3710 * xterm.c [SOLARIS2]: Include <string.h>. |
| 3711 * FilePath.pm [$^O eq 'VMS']: Import the VMS::Feature module. | |
| 3712 * framework.py [sys.version_info < (2, 6)]: Make "with" statement | |
| 3713 available by importing it from __future__, | |
| 3714 to support also python 2.5. | |
| 4958 | 3715 @end example |
| 3716 | |
| 16186 | 3717 Our other examples will for simplicity be limited to C, as the minor |
| 3718 changes necessary to adapt them to other languages should be | |
| 3719 self-evident. | |
| 3720 | |
| 3721 Next, here is an entry describing a new definition which is entirely | |
| 3722 conditional: the C macro @code{FRAME_WINDOW_P} is defined (and used) | |
| 3723 only when the macro @code{HAVE_X_WINDOWS} is defined: | |
| 4958 | 3724 |
| 3725 @example | |
| 3726 * frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P): Macro defined. | |
| 3727 @end example | |
| 3728 | |
| 16186 | 3729 Next, an entry for a change within the function @code{init_display}, |
| 3730 whose definition as a whole is unconditional, but the changes | |
| 3731 themselves are contained in a @samp{#ifdef HAVE_LIBNCURSES} | |
| 3732 conditional: | |
| 4958 | 3733 |
| 3734 @example | |
| 3735 * dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call tgetent. | |
| 3736 @end example | |
| 3737 | |
| 16186 | 3738 Finally, here is an entry for a change that takes effect only when |
| 4958 | 3739 a certain macro is @emph{not} defined: |
| 3740 | |
| 3741 @example | |
| 16890 | 3742 * host.c (gethostname) [!HAVE_SOCKETS]: Replace with winsock version. |
| 4958 | 3743 @end example |
| 3744 | |
| 16890 | 3745 |
| 4958 | 3746 @node Indicating the Part Changed |
| 3747 @subsection Indicating the Part Changed | |
| 3748 | |
| 3749 Indicate the part of a function which changed by using angle brackets | |
| 3750 enclosing an indication of what the changed part does. Here is an entry | |
| 3751 for a change in the part of the function @code{sh-while-getopts} that | |
| 3752 deals with @code{sh} commands: | |
| 3753 | |
| 3754 @example | |
| 3755 * progmodes/sh-script.el (sh-while-getopts) <sh>: Handle case that | |
| 3756 user-specified option string is empty. | |
| 3757 @end example | |
| 3758 | |
| 3759 | |
| 3760 @node Man Pages | |
| 3761 @section Man Pages | |
| 3762 @cindex man pages | |
| 3763 | |
| 3764 In the GNU project, man pages are secondary. It is not necessary or | |
| 3765 expected for every GNU program to have a man page, but some of them do. | |
| 3766 It's your choice whether to include a man page in your program. | |
| 3767 | |
| 3768 When you make this decision, consider that supporting a man page | |
| 3769 requires continual effort each time the program is changed. The time | |
| 3770 you spend on the man page is time taken away from more useful work. | |
| 3771 | |
| 3772 For a simple program which changes little, updating the man page may be | |
| 3773 a small job. Then there is little reason not to include a man page, if | |
| 3774 you have one. | |
| 3775 | |
| 3776 For a large program that changes a great deal, updating a man page may | |
| 3777 be a substantial burden. If a user offers to donate a man page, you may | |
| 3778 find this gift costly to accept. It may be better to refuse the man | |
| 3779 page unless the same person agrees to take full responsibility for | |
| 3780 maintaining it---so that you can wash your hands of it entirely. If | |
| 3781 this volunteer later ceases to do the job, then don't feel obliged to | |
| 3782 pick it up yourself; it may be better to withdraw the man page from the | |
| 3783 distribution until someone else agrees to update it. | |
| 3784 | |
| 3785 When a program changes only a little, you may feel that the | |
| 3786 discrepancies are small enough that the man page remains useful without | |
| 3787 updating. If so, put a prominent note near the beginning of the man | |
| 3788 page explaining that you don't maintain it and that the Texinfo manual | |
| 3789 is more authoritative. The note should say how to access the Texinfo | |
| 3790 documentation. | |
| 3791 | |
| 11617 | 3792 Be sure that man pages include a copyright statement and free license. |
| 3793 The simple all-permissive license is appropriate for simple man pages | |
| 3794 (@pxref{License Notices for Other Files,,,maintain,Information for GNU | |
| 3795 Maintainers}). | |
|
5495
5fe0551f4ec2
update from gnustandards
Karl Berry <karl@freefriends.org>
parents:
5301
diff
changeset
|
3796 |
|
5fe0551f4ec2
update from gnustandards
Karl Berry <karl@freefriends.org>
parents:
5301
diff
changeset
|
3797 For long man pages, with enough explanation and documentation that |
|
5fe0551f4ec2
update from gnustandards
Karl Berry <karl@freefriends.org>
parents:
5301
diff
changeset
|
3798 they can be considered true manuals, use the GFDL (@pxref{License for |
|
5fe0551f4ec2
update from gnustandards
Karl Berry <karl@freefriends.org>
parents:
5301
diff
changeset
|
3799 Manuals}). |
|
5fe0551f4ec2
update from gnustandards
Karl Berry <karl@freefriends.org>
parents:
5301
diff
changeset
|
3800 |
| 5301 | 3801 Finally, the GNU help2man program |
| 3802 (@uref{http://www.gnu.org/software/help2man/}) is one way to automate | |
| 3803 generation of a man page, in this case from @option{--help} output. | |
| 3804 This is sufficient in many cases. | |
| 3805 | |
| 4958 | 3806 @node Reading other Manuals |
| 3807 @section Reading other Manuals | |
| 3808 | |
| 3809 There may be non-free books or documentation files that describe the | |
| 3810 program you are documenting. | |
| 3811 | |
| 3812 It is ok to use these documents for reference, just as the author of a | |
| 3813 new algebra textbook can read other books on algebra. A large portion | |
| 3814 of any non-fiction book consists of facts, in this case facts about how | |
| 3815 a certain program works, and these facts are necessarily the same for | |
| 3816 everyone who writes about the subject. But be careful not to copy your | |
| 3817 outline structure, wording, tables or examples from preexisting non-free | |
| 3818 documentation. Copying from free documentation may be ok; please check | |
| 3819 with the FSF about the individual case. | |
| 3820 | |
| 3821 @node Managing Releases | |
| 3822 @chapter The Release Process | |
| 3823 @cindex releasing | |
| 3824 | |
| 3825 Making a release is more than just bundling up your source files in a | |
| 3826 tar file and putting it up for FTP. You should set up your software so | |
| 3827 that it can be configured to run on a variety of systems. Your Makefile | |
| 3828 should conform to the GNU standards described below, and your directory | |
| 3829 layout should also conform to the standards discussed below. Doing so | |
| 3830 makes it easy to include your package into the larger framework of | |
| 3831 all GNU software. | |
| 3832 | |
| 3833 @menu | |
| 9115 | 3834 * Configuration:: How configuration of GNU packages should work. |
| 3835 * Makefile Conventions:: Makefile conventions. | |
| 3836 * Releases:: Making releases | |
| 4958 | 3837 @end menu |
| 3838 | |
| 3839 @node Configuration | |
| 3840 @section How Configuration Should Work | |
| 3841 @cindex program configuration | |
| 3842 | |
| 3843 @pindex configure | |
| 3844 Each GNU distribution should come with a shell script named | |
| 3845 @code{configure}. This script is given arguments which describe the | |
| 3846 kind of machine and system you want to compile the program for. | |
| 3847 The @code{configure} script must record the configuration options so | |
| 3848 that they affect compilation. | |
| 3849 | |
| 10290 | 3850 The description here is the specification of the interface for the |
| 3851 @code{configure} script in GNU packages. Many packages implement it | |
| 3852 using GNU Autoconf (@pxref{Top,, Introduction, autoconf, Autoconf}) | |
| 3853 and/or GNU Automake (@pxref{Top,, Introduction, automake, Automake}), | |
| 3854 but you do not have to use these tools. You can implement it any way | |
| 3855 you like; for instance, by making @code{configure} be a wrapper around | |
| 3856 a completely different configuration system. | |
| 3857 | |
| 3858 Another way for the @code{configure} script to operate is to make a | |
| 3859 link from a standard name such as @file{config.h} to the proper | |
| 3860 configuration file for the chosen system. If you use this technique, | |
| 3861 the distribution should @emph{not} contain a file named | |
| 3862 @file{config.h}. This is so that people won't be able to build the | |
| 3863 program without configuring it first. | |
| 4958 | 3864 |
| 3865 Another thing that @code{configure} can do is to edit the Makefile. If | |
| 3866 you do this, the distribution should @emph{not} contain a file named | |
| 3867 @file{Makefile}. Instead, it should include a file @file{Makefile.in} which | |
| 3868 contains the input used for editing. Once again, this is so that people | |
| 3869 won't be able to build the program without configuring it first. | |
| 3870 | |
| 3871 If @code{configure} does write the @file{Makefile}, then @file{Makefile} | |
| 3872 should have a target named @file{Makefile} which causes @code{configure} | |
| 3873 to be rerun, setting up the same configuration that was set up last | |
| 3874 time. The files that @code{configure} reads should be listed as | |
| 3875 dependencies of @file{Makefile}. | |
| 3876 | |
| 3877 All the files which are output from the @code{configure} script should | |
| 3878 have comments at the beginning explaining that they were generated | |
| 3879 automatically using @code{configure}. This is so that users won't think | |
| 3880 of trying to edit them by hand. | |
| 3881 | |
| 3882 The @code{configure} script should write a file named @file{config.status} | |
| 3883 which describes which configuration options were specified when the | |
| 3884 program was last configured. This file should be a shell script which, | |
| 3885 if run, will recreate the same configuration. | |
| 3886 | |
| 3887 The @code{configure} script should accept an option of the form | |
| 3888 @samp{--srcdir=@var{dirname}} to specify the directory where sources are found | |
| 3889 (if it is not the current directory). This makes it possible to build | |
| 3890 the program in a separate directory, so that the actual source directory | |
| 3891 is not modified. | |
| 3892 | |
| 3893 If the user does not specify @samp{--srcdir}, then @code{configure} should | |
| 3894 check both @file{.} and @file{..} to see if it can find the sources. If | |
| 3895 it finds the sources in one of these places, it should use them from | |
| 3896 there. Otherwise, it should report that it cannot find the sources, and | |
| 3897 should exit with nonzero status. | |
| 3898 | |
| 3899 Usually the easy way to support @samp{--srcdir} is by editing a | |
| 3900 definition of @code{VPATH} into the Makefile. Some rules may need to | |
| 3901 refer explicitly to the specified source directory. To make this | |
| 3902 possible, @code{configure} can add to the Makefile a variable named | |
| 3903 @code{srcdir} whose value is precisely the specified directory. | |
| 3904 | |
| 9740 | 3905 In addition, the @samp{configure} script should take options |
| 3906 corresponding to most of the standard directory variables | |
| 3907 (@pxref{Directory Variables}). Here is the list: | |
| 3908 | |
| 3909 @example | |
| 3910 --prefix --exec-prefix --bindir --sbindir --libexecdir --sysconfdir | |
| 3911 --sharedstatedir --localstatedir --libdir --includedir --oldincludedir | |
| 3912 --datarootdir --datadir --infodir --localedir --mandir --docdir | |
| 3913 --htmldir --dvidir --pdfdir --psdir | |
| 3914 @end example | |
| 3915 | |
| 4958 | 3916 The @code{configure} script should also take an argument which specifies the |
| 3917 type of system to build the program for. This argument should look like | |
| 3918 this: | |
| 3919 | |
| 3920 @example | |
| 3921 @var{cpu}-@var{company}-@var{system} | |
| 3922 @end example | |
| 3923 | |
| 3924 For example, an Athlon-based GNU/Linux system might be | |
| 3925 @samp{i686-pc-linux-gnu}. | |
| 3926 | |
| 3927 The @code{configure} script needs to be able to decode all plausible | |
| 3928 alternatives for how to describe a machine. Thus, | |
| 6066 | 3929 @samp{athlon-pc-gnu/linux} would be a valid alias. There is a shell |
| 3930 script called | |
| 9823 | 3931 @uref{http://git.savannah.gnu.org/@/gitweb/@/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD, |
| 6066 | 3932 @file{config.sub}} that you can use as a subroutine to validate system |
| 3933 types and canonicalize aliases. | |
| 4958 | 3934 |
| 3935 The @code{configure} script should also take the option | |
| 3936 @option{--build=@var{buildtype}}, which should be equivalent to a | |
| 3937 plain @var{buildtype} argument. For example, @samp{configure | |
| 3938 --build=i686-pc-linux-gnu} is equivalent to @samp{configure | |
| 3939 i686-pc-linux-gnu}. When the build type is not specified by an option | |
| 6066 | 3940 or argument, the @code{configure} script should normally guess it using |
| 3941 the shell script | |
| 9823 | 3942 @uref{http://git.savannah.gnu.org/@/gitweb/@/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD, |
| 6066 | 3943 @file{config.guess}}. |
| 4958 | 3944 |
| 3945 @cindex optional features, configure-time | |
| 3946 Other options are permitted to specify in more detail the software | |
| 7159 | 3947 or hardware present on the machine, to include or exclude optional parts |
| 3948 of the package, or to adjust the name of some tools or arguments to them: | |
| 4958 | 3949 |
| 3950 @table @samp | |
| 3951 @item --enable-@var{feature}@r{[}=@var{parameter}@r{]} | |
| 3952 Configure the package to build and install an optional user-level | |
| 3953 facility called @var{feature}. This allows users to choose which | |
| 3954 optional features to include. Giving an optional @var{parameter} of | |
| 3955 @samp{no} should omit @var{feature}, if it is built by default. | |
| 3956 | |
| 3957 No @samp{--enable} option should @strong{ever} cause one feature to | |
| 3958 replace another. No @samp{--enable} option should ever substitute one | |
| 3959 useful behavior for another useful behavior. The only proper use for | |
| 3960 @samp{--enable} is for questions of whether to build part of the program | |
| 3961 or exclude it. | |
| 3962 | |
| 3963 @item --with-@var{package} | |
| 3964 @c @r{[}=@var{parameter}@r{]} | |
| 3965 The package @var{package} will be installed, so configure this package | |
| 3966 to work with @var{package}. | |
| 3967 | |
| 3968 @c Giving an optional @var{parameter} of | |
| 3969 @c @samp{no} should omit @var{package}, if it is used by default. | |
| 3970 | |
| 3971 Possible values of @var{package} include | |
| 3972 @samp{gnu-as} (or @samp{gas}), @samp{gnu-ld}, @samp{gnu-libc}, | |
| 3973 @samp{gdb}, | |
| 3974 @samp{x}, | |
| 3975 and | |
| 3976 @samp{x-toolkit}. | |
| 3977 | |
| 3978 Do not use a @samp{--with} option to specify the file name to use to | |
| 3979 find certain files. That is outside the scope of what @samp{--with} | |
| 3980 options are for. | |
| 7159 | 3981 |
| 3982 @item @var{variable}=@var{value} | |
| 3983 Set the value of the variable @var{variable} to @var{value}. This is | |
| 3984 used to override the default values of commands or arguments in the | |
| 3985 build process. For example, the user could issue @samp{configure | |
| 3986 CFLAGS=-g CXXFLAGS=-g} to build with debugging information and without | |
| 3987 the default optimization. | |
| 3988 | |
| 3989 Specifying variables as arguments to @code{configure}, like this: | |
| 3990 @example | |
| 3991 ./configure CC=gcc | |
| 3992 @end example | |
| 3993 is preferable to setting them in environment variables: | |
| 3994 @example | |
| 3995 CC=gcc ./configure | |
| 3996 @end example | |
| 3997 as it helps to recreate the same configuration later with | |
| 11990 | 3998 @file{config.status}. However, both methods should be supported. |
| 4958 | 3999 @end table |
| 4000 | |
| 7159 | 4001 All @code{configure} scripts should accept all of the ``detail'' |
| 4002 options and the variable settings, whether or not they make any | |
| 4003 difference to the particular package at hand. In particular, they | |
| 4004 should accept any option that starts with @samp{--with-} or | |
| 4005 @samp{--enable-}. This is so users will be able to configure an | |
| 4006 entire GNU source tree at once with a single set of options. | |
| 4958 | 4007 |
| 4008 You will note that the categories @samp{--with-} and @samp{--enable-} | |
| 4009 are narrow: they @strong{do not} provide a place for any sort of option | |
| 4010 you might think of. That is deliberate. We want to limit the possible | |
| 4011 configuration options in GNU software. We do not want GNU programs to | |
| 4012 have idiosyncratic configuration options. | |
| 4013 | |
| 4014 Packages that perform part of the compilation process may support | |
| 4015 cross-compilation. In such a case, the host and target machines for the | |
| 4016 program may be different. | |
| 4017 | |
| 4018 The @code{configure} script should normally treat the specified type of | |
| 4019 system as both the host and the target, thus producing a program which | |
| 4020 works for the same type of machine that it runs on. | |
| 4021 | |
| 4022 To compile a program to run on a host type that differs from the build | |
| 4023 type, use the configure option @option{--host=@var{hosttype}}, where | |
| 4024 @var{hosttype} uses the same syntax as @var{buildtype}. The host type | |
| 4025 normally defaults to the build type. | |
| 4026 | |
| 4027 To configure a cross-compiler, cross-assembler, or what have you, you | |
| 4028 should specify a target different from the host, using the configure | |
| 4029 option @samp{--target=@var{targettype}}. The syntax for | |
| 4030 @var{targettype} is the same as for the host type. So the command would | |
| 4031 look like this: | |
| 4032 | |
| 4033 @example | |
| 4034 ./configure --host=@var{hosttype} --target=@var{targettype} | |
| 4035 @end example | |
| 4036 | |
| 4037 The target type normally defaults to the host type. | |
| 4038 Programs for which cross-operation is not meaningful need not accept the | |
| 4039 @samp{--target} option, because configuring an entire operating system for | |
| 4040 cross-operation is not a meaningful operation. | |
| 4041 | |
| 4042 Some programs have ways of configuring themselves automatically. If | |
| 4043 your program is set up to do this, your @code{configure} script can simply | |
| 4044 ignore most of its arguments. | |
| 4045 | |
| 4046 @comment The makefile standards are in a separate file that is also | |
| 4047 @comment included by make.texinfo. Done by roland@gnu.ai.mit.edu on 1/6/93. | |
| 4048 @comment For this document, turn chapters into sections, etc. | |
| 4049 @lowersections | |
| 4050 @include make-stds.texi | |
| 4051 @raisesections | |
| 4052 | |
| 4053 @node Releases | |
| 4054 @section Making Releases | |
| 4055 @cindex packaging | |
| 4056 | |
| 17142 | 4057 @cindex version numbers, for releases |
| 4958 | 4058 You should identify each release with a pair of version numbers, a |
| 4059 major version and a minor. We have no objection to using more than | |
| 4060 two numbers, but it is very unlikely that you really need them. | |
| 4061 | |
| 4062 Package the distribution of @code{Foo version 69.96} up in a gzipped tar | |
| 4063 file with the name @file{foo-69.96.tar.gz}. It should unpack into a | |
| 4064 subdirectory named @file{foo-69.96}. | |
| 4065 | |
| 4066 Building and installing the program should never modify any of the files | |
| 4067 contained in the distribution. This means that all the files that form | |
| 4068 part of the program in any way must be classified into @dfn{source | |
| 4069 files} and @dfn{non-source files}. Source files are written by humans | |
| 4070 and never changed automatically; non-source files are produced from | |
| 4071 source files by programs under the control of the Makefile. | |
| 4072 | |
| 4073 @cindex @file{README} file | |
| 17142 | 4074 The distribution should contain a file named @file{README} with a |
| 4075 general overview of the package: | |
| 4076 | |
| 4077 @itemize | |
| 4078 @item the name of the package; | |
| 4079 | |
| 4080 @item the version number of the package, or refer to where in the | |
| 4081 package the version can be found; | |
| 4082 | |
| 4083 @item a general description of what the package does; | |
| 4084 | |
| 17256 | 4085 @item a reference to the file @file{INSTALL}, which |
| 17142 | 4086 should in turn contain an explanation of the installation procedure; |
| 4087 | |
| 4088 @item a brief explanation of any unusual top-level directories or | |
| 4089 files, or other hints for readers to find their way around the source; | |
| 4090 | |
| 4091 @item a reference to the file which contains the copying conditions. | |
| 4092 The GNU GPL, if used, should be in a file called @file{COPYING}. If | |
| 4093 the GNU LGPL is used, it should be in a file called | |
| 11485 | 4094 @file{COPYING.LESSER}. |
| 17142 | 4095 @end itemize |
| 4958 | 4096 |
| 15494 | 4097 Naturally, all the source files must be in the distribution. It is |
| 4098 okay to include non-source files in the distribution along with the | |
| 4099 source files they are generated from, provided they are up-to-date | |
| 4100 with the source they are made from, and machine-independent, so that | |
| 4101 normal building of the distribution will never modify them. We | |
| 4102 commonly include non-source files produced by Autoconf, Automake, | |
| 17142 | 4103 Bison, @code{flex}, @TeX{}, and @code{makeinfo}; this helps avoid |
| 4958 | 4104 unnecessary dependencies between our distributions, so that users can |
| 17142 | 4105 install whichever versions of whichever packages they like. Do not |
| 4106 induce new dependencies on other software lightly. | |
| 4958 | 4107 |
| 4108 Non-source files that might actually be modified by building and | |
| 4109 installing the program should @strong{never} be included in the | |
| 4110 distribution. So if you do distribute non-source files, always make | |
| 4111 sure they are up to date when you make a new distribution. | |
| 4112 | |
| 12439 | 4113 Make sure that all the files in the distribution are world-readable, and |
| 4114 that directories are world-readable and world-searchable (octal mode 755). | |
| 4115 We used to recommend that all directories in the distribution also be | |
| 4116 world-writable (octal mode 777), because ancient versions of @code{tar} | |
| 4117 would otherwise not cope when extracting the archive as an unprivileged | |
| 4118 user. That can easily lead to security issues when creating the archive, | |
| 4119 however, so now we recommend against that. | |
| 4958 | 4120 |
| 4121 Don't include any symbolic links in the distribution itself. If the tar | |
| 4122 file contains symbolic links, then people cannot even unpack it on | |
| 4123 systems that don't support symbolic links. Also, don't use multiple | |
| 4124 names for one file in different directories, because certain file | |
| 4125 systems cannot handle this and that prevents unpacking the | |
| 4126 distribution. | |
| 4127 | |
| 4128 Try to make sure that all the file names will be unique on MS-DOS. A | |
| 4129 name on MS-DOS consists of up to 8 characters, optionally followed by a | |
| 4130 period and up to three characters. MS-DOS will truncate extra | |
| 4131 characters both before and after the period. Thus, | |
| 4132 @file{foobarhacker.c} and @file{foobarhacker.o} are not ambiguous; they | |
| 4133 are truncated to @file{foobarha.c} and @file{foobarha.o}, which are | |
| 4134 distinct. | |
| 4135 | |
| 4136 @cindex @file{texinfo.tex}, in a distribution | |
| 4137 Include in your distribution a copy of the @file{texinfo.tex} you used | |
| 4138 to test print any @file{*.texinfo} or @file{*.texi} files. | |
| 4139 | |
| 4140 Likewise, if your program uses small GNU software packages like regex, | |
| 4141 getopt, obstack, or termcap, include them in the distribution file. | |
| 4142 Leaving them out would make the distribution file a little smaller at | |
| 4143 the expense of possible inconvenience to a user who doesn't know what | |
| 4144 other files to get. | |
| 4145 | |
| 4146 @node References | |
| 4147 @chapter References to Non-Free Software and Documentation | |
| 4148 @cindex references to non-free material | |
| 4149 | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4150 A GNU program should not recommend, promote, or grant legitimacy to |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4151 the use of any non-free program. Proprietary software is a social and |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4152 ethical problem, and our aim is to put an end to that problem. We |
| 4958 | 4153 can't stop some people from writing proprietary programs, or stop |
| 4154 other people from using them, but we can and should refuse to | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4155 advertise them to new potential customers, or to give the public the |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4156 idea that their existence is ethical. |
| 4958 | 4157 |
| 5566 | 4158 The GNU definition of free software is found on the GNU web site at |
| 9823 | 4159 @url{http://www.gnu.org/@/philosophy/@/free-sw.html}, and the definition |
| 6537 | 4160 of free documentation is found at |
| 9823 | 4161 @url{http://www.gnu.org/@/philosophy/@/free-doc.html}. The terms ``free'' |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4162 and ``non-free'', used in this document, refer to those definitions. |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4163 |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4164 A list of important licenses and whether they qualify as free is in |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4165 @url{http://www.gnu.org/@/licenses/@/license-list.html}. If it is not |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4166 clear whether a license qualifies as free, please ask the GNU Project |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4167 by writing to @email{licensing@@gnu.org}. We will answer, and if the |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4168 license is an important one, we will add it to the list. |
| 4958 | 4169 |
| 4170 When a non-free program or system is well known, you can mention it in | |
| 4171 passing---that is harmless, since users who might want to use it | |
| 4172 probably already know about it. For instance, it is fine to explain | |
| 4173 how to build your package on top of some widely used non-free | |
| 4174 operating system, or how to use it together with some widely used | |
| 4175 non-free program. | |
| 4176 | |
| 4177 However, you should give only the necessary information to help those | |
| 4178 who already use the non-free program to use your program with | |
| 4179 it---don't give, or refer to, any further information about the | |
| 4180 proprietary program, and don't imply that the proprietary program | |
| 4181 enhances your program, or that its existence is in any way a good | |
| 4182 thing. The goal should be that people already using the proprietary | |
| 4183 program will get the advice they need about how to use your free | |
| 4184 program with it, while people who don't already use the proprietary | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4185 program will not see anything likely to lead them to take an interest |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4186 in it. |
| 4958 | 4187 |
| 4188 If a non-free program or system is obscure in your program's domain, | |
| 4189 your program should not mention or support it at all, since doing so | |
| 4190 would tend to popularize the non-free program more than it popularizes | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4191 your program. (You cannot hope to find many additional users for your |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4192 program among the users of Foobar, if the existence of Foobar is not |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4193 generally known among people who might want to use your program.) |
| 4958 | 4194 |
| 4195 Sometimes a program is free software in itself but depends on a | |
| 4196 non-free platform in order to run. For instance, many Java programs | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4197 depend on some non-free Java libraries. To recommend or promote such |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4198 a program is to promote the other programs it needs. This is why we |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4199 are careful about listing Java programs in the Free Software |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4200 Directory: we don't want to promote the non-free Java libraries. |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4201 |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4202 We hope this particular problem with Java will be gone by and by, as |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4203 we replace the remaining non-free standard Java libraries with free |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4204 software, but the general principle will remain the same: don't |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4205 recommend, promote or legitimize programs that depend on non-free |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4206 software to run. |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4207 |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4208 Some free programs strongly encourage the use of non-free software. A |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4209 typical example is @command{mplayer}. It is free software in itself, |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4210 and the free code can handle some kinds of files. However, |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4211 @command{mplayer} recommends use of non-free codecs for other kinds of |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4212 files, and users that install @command{mplayer} are very likely to |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4213 install those codecs along with it. To recommend @command{mplayer} |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4214 is, in effect, to promote use of the non-free codecs. |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4215 |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4216 Thus, you should not recommend programs that strongly encourage the |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4217 use of non-free software. This is why we do not list |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4218 @command{mplayer} in the Free Software Directory. |
| 4958 | 4219 |
| 4220 A GNU package should not refer the user to any non-free documentation | |
| 4221 for free software. Free documentation that can be included in free | |
| 4222 operating systems is essential for completing the GNU system, or any | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4223 free operating system, so encouraging it is a priority; to recommend |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4224 use of documentation that we are not allowed to include undermines the |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4225 impetus for the community to produce documentation that we can |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4226 include. So GNU packages should never recommend non-free |
| 4958 | 4227 documentation. |
| 4228 | |
| 4229 By contrast, it is ok to refer to journal articles and textbooks in | |
| 4230 the comments of a program for explanation of how it functions, even | |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4231 though they are non-free. This is because we don't include such |
| 13440 | 4232 things in the GNU system even if they are free---they are outside the |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4233 scope of what a software distribution needs to include. |
| 4958 | 4234 |
| 4235 Referring to a web site that describes or recommends a non-free | |
| 16158 | 4236 program is promoting that program, so please do not make links to (or |
|
9485
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4237 mention by name) web sites that contain such material. This policy is |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4238 relevant particularly for the web pages for a GNU package. |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4239 |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4240 Following links from nearly any web site can lead eventually to |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4241 non-free software; this is inherent in the nature of the web. So it |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4242 makes no sense to criticize a site for having such links. As long as |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4243 the site does not itself recommend a non-free program, there is no |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4244 need to consider the question of the sites that it links to for other |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4245 reasons. |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4246 |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4247 Thus, for example, you should not refer to AT&T's web site if that |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4248 recommends AT&T's non-free software packages; you should not refer to |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4249 a site that links to AT&T's site presenting it as a place to get some |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4250 non-free program, because that link recommends and legitimizes the |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4251 non-free program. However, that a site contains a link to AT&T's web |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4252 site for some other purpose (such as long-distance telephone service) |
|
4e0536363af3
* doc/fdl.texi, doc/gpl-3.0.texi, doc/lgpl-3.0.texi:
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
9204
diff
changeset
|
4253 is not an objection against it. |
| 9115 | 4254 |
| 4255 @node GNU Free Documentation License | |
| 4256 @appendix GNU Free Documentation License | |
| 4257 | |
| 4258 @cindex FDL, GNU Free Documentation License | |
|
10788
a25a90d69546
fdl.texi: make a symlink to the latest version
Eric Blake <ebb9@byu.net>
parents:
10785
diff
changeset
|
4259 @include fdl.texi |
| 4958 | 4260 |
| 4261 @node Index | |
| 4262 @unnumbered Index | |
| 4263 @printindex cp | |
| 4264 | |
| 4265 @bye | |
| 4266 | |
| 4267 Local variables: | |
| 4268 eval: (add-hook 'write-file-hooks 'time-stamp) | |
| 4269 time-stamp-start: "@set lastupdate " | |
| 4270 time-stamp-end: "$" | |
| 4271 time-stamp-format: "%:b %:d, %:y" | |
| 11990 | 4272 compile-command: "cd work.s && make" |
| 4958 | 4273 End: |