[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
www/prep standards/index.html standards/standar...
|
From: |
Karl Berry |
|
Subject: |
www/prep standards/index.html standards/standar... |
|
Date: |
Mon, 07 May 2012 00:48:44 +0000 |
CVSROOT: /web/www
Module name: www
Changes by: Karl Berry <karl> 12/05/07 00:48:43
Modified files:
prep/standards : index.html standards.dvi.gz standards.html
standards.html.gz standards.html_node.tar.gz
standards.info.tar.gz standards.pdf
standards.ps.gz standards.texi.tar.gz
standards.txt standards.txt.gz
prep/standards/html_node: CPU-Portability.html
Change-Log-Concepts.html
Change-Logs.html Character-Set.html
Command-Variables.html
Command_002dLine-Interfaces.html
Comments.html Compatibility.html
Conditional-Changes.html
Conditional-Compilation.html
Configuration.html Contributions.html
DESTDIR.html Design-Advice.html
Directory-Variables.html
Doc-Strings-and-Manuals.html
Documentation.html
Dynamic-Plug_002dIn-Interfaces.html
Errors.html File-Usage.html
Formatting.html
GNU-Free-Documentation-License.html
GNU-Manuals.html
Graphical-Interfaces.html Index.html
Indicating-the-Part-Changed.html
Install-Command-Categories.html
Internationalization.html
Legal-Issues.html Libraries.html
License-for-Manuals.html
Makefile-Basics.html
Makefile-Conventions.html
Man-Pages.html Managing-Releases.html
Manual-Credits.html
Manual-Structure-Details.html
Memory-Usage.html Mmap.html
NEWS-File.html Names.html
Non_002dGNU-Standards.html
OID-Allocations.html Option-Table.html
Preface.html Printed-Manuals.html
Program-Behavior.html
Quote-Characters.html
Reading-Non_002dFree-Code.html
Reading-other-Manuals.html
References.html Releases.html
Semantics.html Simple-Changes.html
Source-Language.html Standard-C.html
Standard-Targets.html
Style-of-Change-Logs.html
Syntactic-Conventions.html
System-Functions.html
System-Portability.html
Trademarks.html User-Interfaces.html
Using-Extensions.html
Utilities-in-Makefiles.html
Writing-C.html _002d_002dhelp.html
_002d_002dversion.html index.html
prep/maintain : index.html maintain.dvi.gz maintain.html.gz
maintain.html_node.tar.gz maintain.info.tar.gz
maintain.pdf maintain.ps.gz
maintain.texi.tar.gz maintain.txt
maintain.txt.gz
Log message:
regen for cross-manual links
CVSWeb URLs:
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/index.html?cvsroot=www&r1=1.68&r2=1.69
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.dvi.gz?cvsroot=www&rev=1.64
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.html?cvsroot=www&r1=1.64&r2=1.65
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.html.gz?cvsroot=www&rev=1.65
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.html_node.tar.gz?cvsroot=www&rev=1.65
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.info.tar.gz?cvsroot=www&rev=1.64
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.pdf?cvsroot=www&rev=1.64
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.ps.gz?cvsroot=www&rev=1.64
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.texi.tar.gz?cvsroot=www&rev=1.64
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.txt?cvsroot=www&r1=1.62&r2=1.63
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.txt.gz?cvsroot=www&rev=1.64
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/CPU-Portability.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Change-Log-Concepts.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Change-Logs.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Character-Set.html?cvsroot=www&r1=1.46&r2=1.47
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Command-Variables.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Command_002dLine-Interfaces.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Comments.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Compatibility.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Conditional-Changes.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Conditional-Compilation.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Configuration.html?cvsroot=www&r1=1.56&r2=1.57
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Contributions.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/DESTDIR.html?cvsroot=www&r1=1.43&r2=1.44
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Design-Advice.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Directory-Variables.html?cvsroot=www&r1=1.57&r2=1.58
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Doc-Strings-and-Manuals.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Documentation.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Dynamic-Plug_002dIn-Interfaces.html?cvsroot=www&r1=1.13&r2=1.14
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Errors.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/File-Usage.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Formatting.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/GNU-Free-Documentation-License.html?cvsroot=www&r1=1.56&r2=1.57
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/GNU-Manuals.html?cvsroot=www&r1=1.55&r2=1.56
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Graphical-Interfaces.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Index.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Indicating-the-Part-Changed.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Install-Command-Categories.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Internationalization.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Legal-Issues.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Libraries.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/License-for-Manuals.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Makefile-Basics.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Makefile-Conventions.html?cvsroot=www&r1=1.57&r2=1.58
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Man-Pages.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Managing-Releases.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Manual-Credits.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Manual-Structure-Details.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Memory-Usage.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Mmap.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/NEWS-File.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Names.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Non_002dGNU-Standards.html?cvsroot=www&r1=1.44&r2=1.45
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/OID-Allocations.html?cvsroot=www&r1=1.28&r2=1.29
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Option-Table.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Preface.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Printed-Manuals.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Program-Behavior.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Quote-Characters.html?cvsroot=www&r1=1.46&r2=1.47
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Reading-Non_002dFree-Code.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Reading-other-Manuals.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/References.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Releases.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Semantics.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Simple-Changes.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Source-Language.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Standard-C.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Standard-Targets.html?cvsroot=www&r1=1.56&r2=1.57
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Style-of-Change-Logs.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Syntactic-Conventions.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/System-Functions.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/System-Portability.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Trademarks.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/User-Interfaces.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Using-Extensions.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Utilities-in-Makefiles.html?cvsroot=www&r1=1.56&r2=1.57
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Writing-C.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/_002d_002dhelp.html?cvsroot=www&r1=1.38&r2=1.39
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/_002d_002dversion.html?cvsroot=www&r1=1.39&r2=1.40
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/index.html?cvsroot=www&r1=1.54&r2=1.55
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/index.html?cvsroot=www&r1=1.85&r2=1.86
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.dvi.gz?cvsroot=www&rev=1.78
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.html.gz?cvsroot=www&rev=1.79
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.html_node.tar.gz?cvsroot=www&rev=1.79
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.info.tar.gz?cvsroot=www&rev=1.78
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.pdf?cvsroot=www&rev=1.79
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.ps.gz?cvsroot=www&rev=1.78
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.texi.tar.gz?cvsroot=www&rev=1.78
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.txt?cvsroot=www&r1=1.80&r2=1.81
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/maintain/maintain.txt.gz?cvsroot=www&rev=1.78
Patches:
Index: standards/index.html
===================================================================
RCS file: /web/www/www/prep/standards/index.html,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -b -r1.68 -r1.69
--- standards/index.html 8 Apr 2012 00:23:22 -0000 1.68
+++ standards/index.html 7 May 2012 00:47:44 -0000 1.69
@@ -4,27 +4,27 @@
<h2>GNU coding standards</h2>
<address>Free Software Foundation</address>
-<address>last updated April 07, 2012</address>
+<address>last updated May 06, 2012</address>
<p>This manual (standards) is available in the following formats:</p>
<ul>
<li><a href="standards.html">HTML
- (336K bytes)</a> - entirely on one web page.</li>
+ (352K bytes)</a> - entirely on one web page.</li>
<li><a href="html_node/index.html">HTML</a> - with one web page per
node.</li>
<li><a href="standards.html.gz">HTML compressed
(88K gzipped characters)</a> - entirely on
one web page.</li>
<li><a href="standards.html_node.tar.gz">HTML compressed
- (100K gzipped tar file)</a> -
+ (104K gzipped tar file)</a> -
with one web page per node.</li>
<li><a href="standards.info.tar.gz">Info document
(76K bytes gzipped tar file)</a>.</li>
<li><a href="standards.txt">ASCII text
- (212K bytes)</a>.</li>
+ (200K bytes)</a>.</li>
<li><a href="standards.txt.gz">ASCII text compressed
- (72K bytes gzipped)</a>.</li>
+ (68K bytes gzipped)</a>.</li>
<li><a href="standards.dvi.gz">TeX dvi file
(116K bytes gzipped)</a>.</li>
<li><a href="standards.ps.gz">PostScript file
Index: standards/standards.dvi.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.dvi.gz,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -b -r1.63 -r1.64
Binary files /tmp/cvsp1E542 and /tmp/cvs7YMsJp differ
Index: standards/standards.html
===================================================================
RCS file: /web/www/www/prep/standards/standards.html,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -b -r1.64 -r1.65
--- standards/standards.html 8 Apr 2012 00:23:23 -0000 1.64
+++ standards/standards.html 7 May 2012 00:47:44 -0000 1.65
@@ -1,13 +1,6 @@
-<html lang="en">
-<head>
-<title>GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="top" href="#Top">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -18,163 +11,208 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-"GNU Free Documentation License".-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards</title>
+
+<meta name="description" content="GNU Coding Standards">
+<meta name="keywords" content="GNU Coding Standards">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="#Top" rel="start" title="Top">
+<link href="#Index" rel="index" title="Index">
+<link href="#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="dir.html#Top" rel="up" title="(dir)">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<h1 class="settitle">GNU Coding Standards</h1>
-<div class="contents">
-<h2>Table of Contents</h2>
-<ul>
-<li><a name="toc_Top" href="#Top">GNU Coding Standards</a>
-<li><a name="toc_Preface" href="#Preface">1 About the GNU Coding Standards</a>
-<li><a name="toc_Legal-Issues" href="#Legal-Issues">2 Keeping Free Software
Free</a>
-<ul>
-<li><a href="#Reading-Non_002dFree-Code">2.1 Referring to Proprietary
Programs</a>
-<li><a href="#Contributions">2.2 Accepting Contributions</a>
-<li><a href="#Trademarks">2.3 Trademarks</a>
-</li></ul>
-<li><a name="toc_Design-Advice" href="#Design-Advice">3 General Program
Design</a>
-<ul>
-<li><a href="#Source-Language">3.1 Which Languages to Use</a>
-<li><a href="#Compatibility">3.2 Compatibility with Other Implementations</a>
-<li><a href="#Using-Extensions">3.3 Using Non-standard Features</a>
-<li><a href="#Standard-C">3.4 Standard C and Pre-Standard C</a>
-<li><a href="#Conditional-Compilation">3.5 Conditional Compilation</a>
-</li></ul>
-<li><a name="toc_Program-Behavior" href="#Program-Behavior">4 Program Behavior
for All Programs</a>
-<ul>
-<li><a href="#Non_002dGNU-Standards">4.1 Non-GNU Standards</a>
-<li><a href="#Semantics">4.2 Writing Robust Programs</a>
-<li><a href="#Libraries">4.3 Library Behavior</a>
-<li><a href="#Errors">4.4 Formatting Error Messages</a>
-<li><a href="#User-Interfaces">4.5 Standards for Interfaces Generally</a>
-<li><a href="#Graphical-Interfaces">4.6 Standards for Graphical Interfaces</a>
-<li><a href="#Command_002dLine-Interfaces">4.7 Standards for Command Line
Interfaces</a>
-<ul>
-<li><a href="#_002d_002dversion">4.7.1 <samp><span
class="option">--version</span></samp></a>
-<li><a href="#_002d_002dhelp">4.7.2 <samp><span
class="option">--help</span></samp></a>
-</li></ul>
-<li><a href="#Dynamic-Plug_002dIn-Interfaces">4.8 Standards for Dynamic
Plug-in Interfaces</a>
-<li><a href="#Option-Table">4.9 Table of Long Options</a>
-<li><a href="#OID-Allocations">4.10 OID Allocations</a>
-<li><a href="#Memory-Usage">4.11 Memory Usage</a>
-<li><a href="#File-Usage">4.12 File Usage</a>
-</li></ul>
-<li><a name="toc_Writing-C" href="#Writing-C">5 Making The Best Use of C</a>
-<ul>
-<li><a href="#Formatting">5.1 Formatting Your Source Code</a>
-<li><a href="#Comments">5.2 Commenting Your Work</a>
-<li><a href="#Syntactic-Conventions">5.3 Clean Use of C Constructs</a>
-<li><a href="#Names">5.4 Naming Variables, Functions, and Files</a>
-<li><a href="#System-Portability">5.5 Portability between System Types</a>
-<li><a href="#CPU-Portability">5.6 Portability between <span
class="sc">cpu</span>s</a>
-<li><a href="#System-Functions">5.7 Calling System Functions</a>
-<li><a href="#Internationalization">5.8 Internationalization</a>
-<li><a href="#Character-Set">5.9 Character Set</a>
-<li><a href="#Quote-Characters">5.10 Quote Characters</a>
-<li><a href="#Mmap">5.11 Mmap</a>
-</li></ul>
-<li><a name="toc_Documentation" href="#Documentation">6 Documenting
Programs</a>
-<ul>
-<li><a href="#GNU-Manuals">6.1 GNU Manuals</a>
-<li><a href="#Doc-Strings-and-Manuals">6.2 Doc Strings and Manuals</a>
-<li><a href="#Manual-Structure-Details">6.3 Manual Structure Details</a>
-<li><a href="#License-for-Manuals">6.4 License for Manuals</a>
-<li><a href="#Manual-Credits">6.5 Manual Credits</a>
-<li><a href="#Printed-Manuals">6.6 Printed Manuals</a>
-<li><a href="#NEWS-File">6.7 The NEWS File</a>
-<li><a href="#Change-Logs">6.8 Change Logs</a>
-<ul>
-<li><a href="#Change-Log-Concepts">6.8.1 Change Log Concepts</a>
-<li><a href="#Style-of-Change-Logs">6.8.2 Style of Change Logs</a>
-<li><a href="#Simple-Changes">6.8.3 Simple Changes</a>
-<li><a href="#Conditional-Changes">6.8.4 Conditional Changes</a>
-<li><a href="#Indicating-the-Part-Changed">6.8.5 Indicating the Part
Changed</a>
-</li></ul>
-<li><a href="#Man-Pages">6.9 Man Pages</a>
-<li><a href="#Reading-other-Manuals">6.10 Reading other Manuals</a>
-</li></ul>
-<li><a name="toc_Managing-Releases" href="#Managing-Releases">7 The Release
Process</a>
-<ul>
-<li><a href="#Configuration">7.1 How Configuration Should Work</a>
-<li><a href="#Makefile-Conventions">7.2 Makefile Conventions</a>
-<ul>
-<li><a href="#Makefile-Basics">7.2.1 General Conventions for Makefiles</a>
-<li><a href="#Utilities-in-Makefiles">7.2.2 Utilities in Makefiles</a>
-<li><a href="#Command-Variables">7.2.3 Variables for Specifying Commands</a>
-<li><a href="#DESTDIR">7.2.4 <code>DESTDIR</code>: Support for Staged
Installs</a>
-<li><a href="#Directory-Variables">7.2.5 Variables for Installation
Directories</a>
-<li><a href="#Standard-Targets">7.2.6 Standard Targets for Users</a>
-<li><a href="#Install-Command-Categories">7.2.7 Install Command Categories</a>
-</li></ul>
-<li><a href="#Releases">7.3 Making Releases</a>
-</li></ul>
-<li><a name="toc_References" href="#References">8 References to Non-Free
Software and Documentation</a>
-<li><a name="toc_GNU-Free-Documentation-License"
href="#GNU-Free-Documentation-License">Appendix A GNU Free Documentation
License</a>
-<li><a name="toc_Index" href="#Index">Index</a>
-</li></ul>
-</div>
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
+<h1 class="settitle" align="center">GNU Coding Standards</h1>
-<div class="node">
-<a name="Top"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Preface">Preface</a>,
-Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
+
+
+
+<a name="SEC_Contents"></a>
+<h2 class="contents-heading">Table of Contents</h2>
+
+<div class="contents">
+
+<ul class="no-bullet">
+ <li><a name="toc-About-the-GNU-Coding-Standards" href="#Preface">1 About the
GNU Coding Standards</a></li>
+ <li><a name="toc-Keeping-Free-Software-Free" href="#Legal-Issues">2 Keeping
Free Software Free</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Referring-to-Proprietary-Programs"
href="#Reading-Non_002dFree-Code">2.1 Referring to Proprietary Programs</a></li>
+ <li><a name="toc-Accepting-Contributions" href="#Contributions">2.2
Accepting Contributions</a></li>
+ <li><a name="toc-Trademarks-1" href="#Trademarks">2.3 Trademarks</a></li>
+ </ul></li>
+ <li><a name="toc-General-Program-Design" href="#Design-Advice">3 General
Program Design</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Which-Languages-to-Use" href="#Source-Language">3.1 Which
Languages to Use</a></li>
+ <li><a name="toc-Compatibility-with-Other-Implementations"
href="#Compatibility">3.2 Compatibility with Other Implementations</a></li>
+ <li><a name="toc-Using-Non_002dstandard-Features"
href="#Using-Extensions">3.3 Using Non-standard Features</a></li>
+ <li><a name="toc-Standard-C-and-Pre_002dStandard-C" href="#Standard-C">3.4
Standard C and Pre-Standard C</a></li>
+ <li><a name="toc-Conditional-Compilation-1"
href="#Conditional-Compilation">3.5 Conditional Compilation</a></li>
+ </ul></li>
+ <li><a name="toc-Program-Behavior-for-All-Programs"
href="#Program-Behavior">4 Program Behavior for All Programs</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Non_002dGNU-Standards-1"
href="#Non_002dGNU-Standards">4.1 Non-GNU Standards</a></li>
+ <li><a name="toc-Writing-Robust-Programs" href="#Semantics">4.2 Writing
Robust Programs</a></li>
+ <li><a name="toc-Library-Behavior" href="#Libraries">4.3 Library
Behavior</a></li>
+ <li><a name="toc-Formatting-Error-Messages" href="#Errors">4.4 Formatting
Error Messages</a></li>
+ <li><a name="toc-Standards-for-Interfaces-Generally"
href="#User-Interfaces">4.5 Standards for Interfaces Generally</a></li>
+ <li><a name="toc-Standards-for-Graphical-Interfaces"
href="#Graphical-Interfaces">4.6 Standards for Graphical Interfaces</a></li>
+ <li><a name="toc-Standards-for-Command-Line-Interfaces"
href="#Command_002dLine-Interfaces">4.7 Standards for Command Line
Interfaces</a>
+ <ul class="no-bullet">
+ <li><a name="toc-_002d_002dversion-1" href="#g_t_002d_002dversion">4.7.1
‘<samp>--version</samp>’</a></li>
+ <li><a name="toc-_002d_002dhelp-1" href="#g_t_002d_002dhelp">4.7.2
‘<samp>--help</samp>’</a></li>
+ </ul></li>
+ <li><a name="toc-Standards-for-Dynamic-Plug_002din-Interfaces"
href="#Dynamic-Plug_002dIn-Interfaces">4.8 Standards for Dynamic Plug-in
Interfaces</a></li>
+ <li><a name="toc-Table-of-Long-Options" href="#Option-Table">4.9 Table of
Long Options</a></li>
+ <li><a name="toc-OID-Allocations-1" href="#OID-Allocations">4.10 OID
Allocations</a></li>
+ <li><a name="toc-Memory-Usage-1" href="#Memory-Usage">4.11 Memory
Usage</a></li>
+ <li><a name="toc-File-Usage-1" href="#File-Usage">4.12 File Usage</a></li>
+ </ul></li>
+ <li><a name="toc-Making-The-Best-Use-of-C" href="#Writing-C">5 Making The
Best Use of C</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Formatting-Your-Source-Code" href="#Formatting">5.1
Formatting Your Source Code</a></li>
+ <li><a name="toc-Commenting-Your-Work" href="#Comments">5.2 Commenting
Your Work</a></li>
+ <li><a name="toc-Clean-Use-of-C-Constructs"
href="#Syntactic-Conventions">5.3 Clean Use of C Constructs</a></li>
+ <li><a name="toc-Naming-Variables_002c-Functions_002c-and-Files"
href="#Names">5.4 Naming Variables, Functions, and Files</a></li>
+ <li><a name="toc-Portability-between-System-Types"
href="#System-Portability">5.5 Portability between System Types</a></li>
+ <li><a name="toc-Portability-between-CPUs" href="#CPU-Portability">5.6
Portability between <small>CPU</small>s</a></li>
+ <li><a name="toc-Calling-System-Functions" href="#System-Functions">5.7
Calling System Functions</a></li>
+ <li><a name="toc-Internationalization-1" href="#Internationalization">5.8
Internationalization</a></li>
+ <li><a name="toc-Character-Set-1" href="#Character-Set">5.9 Character
Set</a></li>
+ <li><a name="toc-Quote-Characters-1" href="#Quote-Characters">5.10 Quote
Characters</a></li>
+ <li><a name="toc-Mmap-1" href="#Mmap">5.11 Mmap</a></li>
+ </ul></li>
+ <li><a name="toc-Documenting-Programs" href="#Documentation">6 Documenting
Programs</a>
+ <ul class="no-bullet">
+ <li><a name="toc-GNU-Manuals-1" href="#GNU-Manuals">6.1 GNU
Manuals</a></li>
+ <li><a name="toc-Doc-Strings-and-Manuals-1"
href="#Doc-Strings-and-Manuals">6.2 Doc Strings and Manuals</a></li>
+ <li><a name="toc-Manual-Structure-Details-1"
href="#Manual-Structure-Details">6.3 Manual Structure Details</a></li>
+ <li><a name="toc-License-for-Manuals-1" href="#License-for-Manuals">6.4
License for Manuals</a></li>
+ <li><a name="toc-Manual-Credits-1" href="#Manual-Credits">6.5 Manual
Credits</a></li>
+ <li><a name="toc-Printed-Manuals-1" href="#Printed-Manuals">6.6 Printed
Manuals</a></li>
+ <li><a name="toc-The-NEWS-File" href="#NEWS-File">6.7 The NEWS
File</a></li>
+ <li><a name="toc-Change-Logs-1" href="#Change-Logs">6.8 Change Logs</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Change-Log-Concepts-1"
href="#Change-Log-Concepts">6.8.1 Change Log Concepts</a></li>
+ <li><a name="toc-Style-of-Change-Logs-1"
href="#Style-of-Change-Logs">6.8.2 Style of Change Logs</a></li>
+ <li><a name="toc-Simple-Changes-1" href="#Simple-Changes">6.8.3 Simple
Changes</a></li>
+ <li><a name="toc-Conditional-Changes-1"
href="#Conditional-Changes">6.8.4 Conditional Changes</a></li>
+ <li><a name="toc-Indicating-the-Part-Changed-1"
href="#Indicating-the-Part-Changed">6.8.5 Indicating the Part Changed</a></li>
+ </ul></li>
+ <li><a name="toc-Man-Pages-1" href="#Man-Pages">6.9 Man Pages</a></li>
+ <li><a name="toc-Reading-other-Manuals-1"
href="#Reading-other-Manuals">6.10 Reading other Manuals</a></li>
+ </ul></li>
+ <li><a name="toc-The-Release-Process" href="#Managing-Releases">7 The
Release Process</a>
+ <ul class="no-bullet">
+ <li><a name="toc-How-Configuration-Should-Work" href="#Configuration">7.1
How Configuration Should Work</a></li>
+ <li><a name="toc-Makefile-Conventions-1" href="#Makefile-Conventions">7.2
Makefile Conventions</a>
+ <ul class="no-bullet">
+ <li><a name="toc-General-Conventions-for-Makefiles"
href="#Makefile-Basics">7.2.1 General Conventions for Makefiles</a></li>
+ <li><a name="toc-Utilities-in-Makefiles-1"
href="#Utilities-in-Makefiles">7.2.2 Utilities in Makefiles</a></li>
+ <li><a name="toc-Variables-for-Specifying-Commands"
href="#Command-Variables">7.2.3 Variables for Specifying Commands</a></li>
+ <li><a name="toc-DESTDIR_003a-Support-for-Staged-Installs"
href="#DESTDIR">7.2.4 <code>DESTDIR</code>: Support for Staged Installs</a></li>
+ <li><a name="toc-Variables-for-Installation-Directories"
href="#Directory-Variables">7.2.5 Variables for Installation
Directories</a></li>
+ <li><a name="toc-Standard-Targets-for-Users"
href="#Standard-Targets">7.2.6 Standard Targets for Users</a></li>
+ <li><a name="toc-Install-Command-Categories-1"
href="#Install-Command-Categories">7.2.7 Install Command Categories</a></li>
+ </ul></li>
+ <li><a name="toc-Making-Releases" href="#Releases">7.3 Making
Releases</a></li>
+ </ul></li>
+ <li><a name="toc-References-to-Non_002dFree-Software-and-Documentation"
href="#References">8 References to Non-Free Software and Documentation</a></li>
+ <li><a name="toc-GNU-Free-Documentation-License-1"
href="#GNU-Free-Documentation-License">Appendix A GNU Free Documentation
License</a></li>
+ <li><a name="toc-Index-1" href="#Index">Index</a></li>
+</ul>
</div>
-<h2 class="unnumbered">GNU Coding Standards</h2>
-<p>The GNU coding standards, last updated April 7, 2012.
+<a name="Top"></a>
+<div class="header">
+<p>
+Next: <a href="#Preface" accesskey="n" rel="next">Preface</a>, Up: <a
href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+<a name="GNU-Coding-Standards"></a>
+<h1 class="top">GNU Coding Standards</h1>
- <p>Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+<p>The GNU coding standards, last updated April 7, 2012.
+</p>
+<p>Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012 Free Software Foundation, Inc.
-
- <p>Permission is granted to copy, distribute and/or modify this document
+</p>
+<p>Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
“GNU Free Documentation License”.
+</p>
-<ul class="menu">
-<li><a accesskey="1" href="#Preface">Preface</a>: About
the GNU Coding Standards.
-<li><a accesskey="2" href="#Legal-Issues">Legal Issues</a>:
Keeping free software free.
-<li><a accesskey="3" href="#Design-Advice">Design Advice</a>:
General program design.
-<li><a accesskey="4" href="#Program-Behavior">Program Behavior</a>:
Program behavior for all programs
-<li><a accesskey="5" href="#Writing-C">Writing C</a>:
Making the best use of C.
-<li><a accesskey="6" href="#Documentation">Documentation</a>:
Documenting programs.
-<li><a accesskey="7" href="#Managing-Releases">Managing Releases</a>:
The release process.
-<li><a accesskey="8" href="#References">References</a>:
Mentioning non-free software or documentation.
-<li><a accesskey="9" href="#GNU-Free-Documentation-License">GNU Free
Documentation License</a>: Copying and sharing this manual.
-<li><a href="#Index">Index</a>
-
- </ul>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Preface"
accesskey="1">Preface</a>:</td><td> </td><td align="left"
valign="top">About the GNU Coding Standards.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Legal-Issues"
accesskey="2">Legal Issues</a>:</td><td> </td><td align="left"
valign="top">Keeping free software free.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Design-Advice"
accesskey="3">Design Advice</a>:</td><td> </td><td align="left"
valign="top">General program design.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Program-Behavior"
accesskey="4">Program Behavior</a>:</td><td> </td><td align="left"
valign="top">Program behavior for all programs
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Writing-C"
accesskey="5">Writing C</a>:</td><td> </td><td align="left"
valign="top">Making the best use of C.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Documentation"
accesskey="6">Documentation</a>:</td><td> </td><td align="left"
valign="top">Documenting programs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Managing-Releases"
accesskey="7">Managing Releases</a>:</td><td> </td><td align="left"
valign="top">The release process.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#References"
accesskey="8">References</a>:</td><td> </td><td align="left"
valign="top">Mentioning non-free software or documentation.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="#GNU-Free-Documentation-License" accesskey="9">GNU Free Documentation
License</a>:</td><td> </td><td align="left" valign="top">Copying and
sharing this manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="#Index">Index</a>:</td><td> </td><td align="left" valign="top">
+</td></tr>
+<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
+</pre></th></tr></table>
-<div class="node">
+<hr>
<a name="Preface"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Legal-Issues">Legal Issues</a>,
-Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#Legal-Issues" accesskey="n" rel="next">Legal Issues</a>,
Previous: <a href="#Top" accesskey="p" rel="previous">Top</a>, Up: <a
href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="About-the-GNU-Coding-Standards"></a>
<h2 class="chapter">1 About the GNU Coding Standards</h2>
<p>The GNU Coding Standards were written by Richard Stallman and other GNU
@@ -184,187 +222,195 @@
programs written in C, but many of the rules and principles are useful
even if you write in another programming language. The rules often
state reasons for writing in a certain way.
-
- <p><a
name="index-where-to-obtain-_0040code_007bstandards_002etexi_007d-1"></a><a
name="index-downloading-this-manual-2"></a>If you did not obtain this file
directly from the GNU project and
+</p>
+<a name="index-where-to-obtain-standards_002etexi"></a>
+<a name="index-downloading-this-manual"></a>
+<p>If you did not obtain this file directly from the GNU project and
recently, please check for a newer version. You can get the GNU
Coding Standards from the GNU web server in many
different formats, including the Texinfo source, PDF, HTML, DVI, plain
text, and more, at: <a
href="http://www.gnu.org/prep/standards/";>http://www.gnu.org/prep/standards/</a>.
-
- <p>If you are maintaining an official GNU package, in addition to this
+</p>
+<p>If you are maintaining an official GNU package, in addition to this
document, please read and follow the GNU maintainer information
-(see <a href="maintain.html#Top">Contents</a>).
-
- <p><a
name="index-g_t_0040code_007bgnustandards_002dcommit_0040_0040gnu_002eorg_007d-mailing-list-3"></a>If
you want to receive diffs for every change to these GNU documents,
+(see <a href="http://www.gnu.org/prep/maintain/maintain.html#Top";>Contents</a>
in <cite>Information for Maintainers of GNU
+Software</cite>).
+</p>
+<a name="index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"></a>
+<p>If you want to receive diffs for every change to these GNU documents,
join the mailing list <code>address@hidden</code>, via the web
interface at
<a
href="http://lists.gnu.org/mailman/listinfo/gnustandards-commit";>http://lists.gnu.org/mailman/listinfo/gnustandards-commit</a>.
Archives are also available there.
-
- <p><a
name="index-g_t_0040code_007bbug_002dstandards_0040_0040gnu_002eorg_007d-email-address-4"></a><a
name="index-Savannah-repository-for-gnustandards-5"></a><a
name="index-gnustandards-project-repository-6"></a>Please send corrections or
suggestions for this document to
+</p>
+<a name="index-bug_002dstandards_0040gnu_002eorg-email-address"></a>
+<a name="index-Savannah-repository-for-gnustandards"></a>
+<a name="index-gnustandards-project-repository"></a>
+<p>Please send corrections or suggestions for this document to
<a href="mailto:address@hidden";>address@hidden</a>. If you make a suggestion,
please
include a suggested new wording for it, to help us consider the
suggestion efficiently. We prefer a context diff to the Texinfo
-source, but if that's difficult for you, you can make a context diff
+source, but if that’s difficult for you, you can make a context diff
for some other version of this document, or propose it in any way that
makes it clear. The source repository for this document can be found
at <a
href="http://savannah.gnu.org/projects/gnustandards";>http://savannah.gnu.org/projects/gnustandards</a>.
-
- <p>These standards cover the minimum of what is important when writing a
+</p>
+<p>These standards cover the minimum of what is important when writing a
GNU package. Likely, the need for additional standards will come up.
Sometimes, you might suggest that such standards be added to this
document. If you think your standards would be generally useful, please
do suggest them.
-
- <p>You should also set standards for your package on many questions not
+</p>
+<p>You should also set standards for your package on many questions not
addressed or not firmly specified here. The most important point is to
be self-consistent—try to stick to the conventions you pick, and try
to document them as much as possible. That way, your program will be
more maintainable by others.
-
- <p>The GNU Hello program serves as an example of how to follow the GNU
+</p>
+<p>The GNU Hello program serves as an example of how to follow the GNU
coding standards for a trivial program.
<a
href="http://www.gnu.org/software/hello/hello.html";>http://www.gnu.org/software/hello/hello.html</a>.
-
- <p>This release of the GNU Coding Standards was last updated
+</p>
+<p>This release of the GNU Coding Standards was last updated
April 7, 2012.
+</p>
-<div class="node">
+<hr>
<a name="Legal-Issues"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Design-Advice">Design Advice</a>,
-Previous: <a rel="previous" accesskey="p" href="#Preface">Preface</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#Design-Advice" accesskey="n" rel="next">Design Advice</a>,
Previous: <a href="#Preface" accesskey="p" rel="previous">Preface</a>, Up: <a
href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Keeping-Free-Software-Free"></a>
<h2 class="chapter">2 Keeping Free Software Free</h2>
+<a name="index-legal-aspects"></a>
-<p><a name="index-legal-aspects-7"></a>
-This chapter discusses how you can make sure that GNU software
+<p>This chapter discusses how you can make sure that GNU software
avoids legal difficulties, and other related issues.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Reading-Non_002dFree-Code"
accesskey="1">Reading Non-Free Code</a>:</td><td> </td><td
align="left" valign="top">Referring to proprietary programs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Contributions"
accesskey="2">Contributions</a>:</td><td> </td><td align="left"
valign="top">Accepting contributions.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Trademarks"
accesskey="3">Trademarks</a>:</td><td> </td><td align="left"
valign="top">How we deal with trademark issues.
+</td></tr>
+</table>
-<ul class="menu">
-<li><a accesskey="1" href="#Reading-Non_002dFree-Code">Reading Non-Free
Code</a>: Referring to proprietary programs.
-<li><a accesskey="2" href="#Contributions">Contributions</a>:
Accepting contributions.
-<li><a accesskey="3" href="#Trademarks">Trademarks</a>: How
we deal with trademark issues.
-</ul>
-
-<div class="node">
-<a name="Reading-Non-Free-Code"></a>
+<hr>
<a name="Reading-Non_002dFree-Code"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Contributions">Contributions</a>,
-Up: <a rel="up" accesskey="u" href="#Legal-Issues">Legal Issues</a>
-
+<div class="header">
+<p>
+Next: <a href="#Contributions" accesskey="n" rel="next">Contributions</a>, Up:
<a href="#Legal-Issues" accesskey="u" rel="up">Legal Issues</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Referring-to-Proprietary-Programs"></a>
<h3 class="section">2.1 Referring to Proprietary Programs</h3>
+<a name="index-proprietary-programs"></a>
+<a name="index-avoiding-proprietary-code"></a>
-<p><a name="index-proprietary-programs-8"></a><a
name="index-avoiding-proprietary-code-9"></a>
-Don't in any circumstances refer to Unix source code for or during
+<p>Don’t in any circumstances refer to Unix source code for or during
your work on GNU! (Or to any other proprietary programs.)
-
- <p>If you have a vague recollection of the internals of a Unix program,
-this does not absolutely mean you can't write an imitation of it, but
+</p>
+<p>If you have a vague recollection of the internals of a Unix program,
+this does not absolutely mean you can’t write an imitation of it, but
do try to organize the imitation internally along different lines,
because this is likely to make the details of the Unix version
irrelevant and dissimilar to your results.
-
- <p>For example, Unix utilities were generally optimized to minimize
+</p>
+<p>For example, Unix utilities were generally optimized to minimize
memory use; if you go for speed instead, your program will be very
different. You could keep the entire input file in memory and scan it
there instead of using stdio. Use a smarter algorithm discovered more
recently than the Unix program. Eliminate use of temporary files. Do
it in one pass instead of two (we did this in the assembler).
-
- <p>Or, on the contrary, emphasize simplicity instead of speed. For some
-applications, the speed of today's computers makes simpler algorithms
+</p>
+<p>Or, on the contrary, emphasize simplicity instead of speed. For some
+applications, the speed of today’s computers makes simpler algorithms
adequate.
-
- <p>Or go for generality. For example, Unix programs often have static
+</p>
+<p>Or go for generality. For example, Unix programs often have static
tables or fixed-size strings, which make for arbitrary limits; use
dynamic allocation instead. Make sure your program handles NULs and
other funny characters in the input files. Add a programming language
for extensibility and write part of the program in that language.
-
- <p>Or turn some parts of the program into independently usable libraries.
+</p>
+<p>Or turn some parts of the program into independently usable libraries.
Or use a simple garbage collector instead of tracking precisely when
to free memory, or use a new GNU facility such as obstacks.
+</p>
-<div class="node">
+<hr>
<a name="Contributions"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Trademarks">Trademarks</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Reading-Non_002dFree-Code">Reading Non-Free Code</a>,
-Up: <a rel="up" accesskey="u" href="#Legal-Issues">Legal Issues</a>
-
+<div class="header">
+<p>
+Next: <a href="#Trademarks" accesskey="n" rel="next">Trademarks</a>, Previous:
<a href="#Reading-Non_002dFree-Code" accesskey="p" rel="previous">Reading
Non-Free Code</a>, Up: <a href="#Legal-Issues" accesskey="u" rel="up">Legal
Issues</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Accepting-Contributions"></a>
<h3 class="section">2.2 Accepting Contributions</h3>
+<a name="index-legal-papers"></a>
+<a name="index-accepting-contributions"></a>
-<p><a name="index-legal-papers-10"></a><a
name="index-accepting-contributions-11"></a>
-If the program you are working on is copyrighted by the Free Software
+<p>If the program you are working on is copyrighted by the Free Software
Foundation, then when someone else sends you a piece of code to add to
the program, we need legal papers to use it—just as we asked you to
sign papers initially. <em>Each</em> person who makes a nontrivial
contribution to a program must sign some sort of legal papers in order
for us to have clear title to the program; the main author alone is not
enough.
-
- <p>So, before adding in any contributions from other people, please tell
+</p>
+<p>So, before adding in any contributions from other people, please tell
us, so we can arrange to get the papers. Then wait until we tell you
that we have received the signed papers, before you actually use the
contribution.
-
- <p>This applies both before you release the program and afterward. If
+</p>
+<p>This applies both before you release the program and afterward. If
you receive diffs to fix a bug, and they make significant changes, we
need legal papers for that change.
-
- <p>This also applies to comments and documentation files. For copyright
+</p>
+<p>This also applies to comments and documentation files. For copyright
law, comments and code are just text. Copyright applies to all kinds of
text, so we need legal papers for all kinds.
-
- <p>We know it is frustrating to ask for legal papers; it's frustrating for
-us as well. But if you don't wait, you are going out on a limb—for
-example, what if the contributor's employer won't sign a disclaimer?
+</p>
+<p>We know it is frustrating to ask for legal papers; it’s frustrating
for
+us as well. But if you don’t wait, you are going out on a limb—for
+example, what if the contributor’s employer won’t sign a
disclaimer?
You might have to take that code out again!
-
- <p>You don't need papers for changes of a few lines here or there, since
-they are not significant for copyright purposes. Also, you don't need
+</p>
+<p>You don’t need papers for changes of a few lines here or there, since
+they are not significant for copyright purposes. Also, you don’t need
papers if all you get from the suggestion is some ideas, not actual code
which you use. For example, if someone sent you one implementation, but
-you write a different implementation of the same idea, you don't need to
+you write a different implementation of the same idea, you don’t need to
get papers.
-
- <p>The very worst thing is if you forget to tell us about the other
+</p>
+<p>The very worst thing is if you forget to tell us about the other
contributor. We could be very embarrassed in court some day as a
result.
-
- <p>We have more detailed advice for maintainers of GNU packages. If you
+</p>
+<p>We have more detailed advice for maintainers of GNU packages. If you
have reached the stage of maintaining a GNU program (whether released
-or not), please take a look: see <a href="maintain.html#Legal-Matters">Legal
Matters</a>.
+or not), please take a look: see <a
href="http://www.gnu.org/prep/maintain/maintain.html#Legal-Matters";>Legal
Matters</a> in <cite>Information for GNU Maintainers</cite>.
+</p>
-<div class="node">
+<hr>
<a name="Trademarks"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p"
href="#Contributions">Contributions</a>,
-Up: <a rel="up" accesskey="u" href="#Legal-Issues">Legal Issues</a>
-
+<div class="header">
+<p>
+Previous: <a href="#Contributions" accesskey="p"
rel="previous">Contributions</a>, Up: <a href="#Legal-Issues" accesskey="u"
rel="up">Legal Issues</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Trademarks-1"></a>
<h3 class="section">2.3 Trademarks</h3>
+<a name="index-trademarks"></a>
-<p><a name="index-trademarks-12"></a>
-Please do not include any trademark acknowledgements in GNU software
+<p>Please do not include any trademark acknowledgements in GNU software
packages or documentation.
-
- <p>Trademark acknowledgements are the statements that such-and-such is a
+</p>
+<p>Trademark acknowledgements are the statements that such-and-such is a
trademark of so-and-so. The GNU Project has no objection to the basic
idea of trademarks, but these acknowledgements feel like kowtowing,
-and there is no legal requirement for them, so we don't use them.
-
- <p>What is legally required, as regards other people's trademarks, is to
+and there is no legal requirement for them, so we don’t use them.
+</p>
+<p>What is legally required, as regards other people’s trademarks, is to
avoid using them in ways which a reader might reasonably understand as
naming or labeling our own programs or activities. For example, since
“Objective C” is (or at least was) a trademark, we made sure to say
@@ -373,232 +419,236 @@
a shorter way of saying the former, but it does not explicitly state
the relationship, so it could be misinterpreted as using “Objective
C” as a label for the compiler rather than for the language.
-
- <p>Please don't use “win” as an abbreviation for Microsoft
Windows in
+</p>
+<p>Please don’t use “win” as an abbreviation for Microsoft
Windows in
GNU software or documentation. In hacker terminology, calling
something a “win” is a form of praise. If you wish to praise
Microsoft Windows when speaking on your own, by all means do so, but
not in GNU software. Usually we write the name “Windows” in full,
but when brevity is very important (as in file names and sometimes
symbol names), we abbreviate it to “w”. For instance, the files
and
-functions in Emacs that deal with Windows start with ‘<samp><span
class="samp">w32</span></samp>’.
-
-<div class="node">
+functions in Emacs that deal with Windows start with
‘<samp>w32</samp>’.
+</p>
+<hr>
<a name="Design-Advice"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Program-Behavior">Program
Behavior</a>,
-Previous: <a rel="previous" accesskey="p" href="#Legal-Issues">Legal
Issues</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#Program-Behavior" accesskey="n" rel="next">Program
Behavior</a>, Previous: <a href="#Legal-Issues" accesskey="p"
rel="previous">Legal Issues</a>, Up: <a href="#Top" accesskey="u"
rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="General-Program-Design"></a>
<h2 class="chapter">3 General Program Design</h2>
+<a name="index-program-design"></a>
-<p><a name="index-program-design-13"></a>
-This chapter discusses some of the issues you should take into
+<p>This chapter discusses some of the issues you should take into
account when designing your program.
+</p>
-<!-- Standard or ANSI C -->
-<!-- In 1989 the American National Standards Institute (ANSI) standardized -->
-<!-- C as standard X3.159-1989. In December of that year the -->
-<!-- International Standards Organization ISO adopted the ANSI C standard -->
-<!-- making minor changes. In 1990 ANSI then re-adopted ISO standard -->
-<!-- C. This version of C is known as either ANSI C or Standard C. -->
-<!-- A major revision of the C Standard appeared in 1999. -->
-<ul class="menu">
-<li><a accesskey="1" href="#Source-Language">Source Language</a>:
Which languages to use.
-<li><a accesskey="2" href="#Compatibility">Compatibility</a>:
Compatibility with other implementations.
-<li><a accesskey="3" href="#Using-Extensions">Using Extensions</a>:
Using non-standard features.
-<li><a accesskey="4" href="#Standard-C">Standard C</a>:
Using standard C features.
-<li><a accesskey="5" href="#Conditional-Compilation">Conditional
Compilation</a>: Compiling code only if a conditional is true.
-</ul>
-<div class="node">
-<a name="Source-Language"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Compatibility">Compatibility</a>,
-Up: <a rel="up" accesskey="u" href="#Design-Advice">Design Advice</a>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Source-Language"
accesskey="1">Source Language</a>:</td><td> </td><td align="left"
valign="top">Which languages to use.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Compatibility"
accesskey="2">Compatibility</a>:</td><td> </td><td align="left"
valign="top">Compatibility with other implementations.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Using-Extensions"
accesskey="3">Using Extensions</a>:</td><td> </td><td align="left"
valign="top">Using non-standard features.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Standard-C"
accesskey="4">Standard C</a>:</td><td> </td><td align="left"
valign="top">Using standard C features.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Conditional-Compilation"
accesskey="5">Conditional Compilation</a>:</td><td> </td><td
align="left" valign="top">Compiling code only if a conditional is true.
+</td></tr>
+</table>
+<hr>
+<a name="Source-Language"></a>
+<div class="header">
+<p>
+Next: <a href="#Compatibility" accesskey="n" rel="next">Compatibility</a>, Up:
<a href="#Design-Advice" accesskey="u" rel="up">Design Advice</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Which-Languages-to-Use"></a>
<h3 class="section">3.1 Which Languages to Use</h3>
+<a name="index-programming-languages"></a>
-<p><a name="index-programming-languages-14"></a>
-When you want to use a language that gets compiled and runs at high
+<p>When you want to use a language that gets compiled and runs at high
speed, the best language to use is C. Using another language is like
using a non-standard feature: it will cause trouble for users. Even if
GCC supports the other language, users may find it inconvenient to have
to install the compiler for that other language in order to build your
program. For example, if you write your program in C++, people will
have to install the GNU C++ compiler in order to compile your program.
-
- <p>C has one other advantage over C++ and other compiled languages: more
+</p>
+<p>C has one other advantage over C++ and other compiled languages: more
people know C, so more people will find it easy to read and modify the
program if it is written in C.
-
- <p>So in general it is much better to use C, rather than the
+</p>
+<p>So in general it is much better to use C, rather than the
comparable alternatives.
-
- <p>But there are two exceptions to that conclusion:
-
- <ul>
-<li>It is no problem to use another language to write a tool specifically
+</p>
+<p>But there are two exceptions to that conclusion:
+</p>
+<ul>
+<li> It is no problem to use another language to write a tool specifically
intended for use with that language. That is because the only people
who want to build the tool will be those who have installed the other
language anyway.
- <li>If an application is of interest only to a narrow part of the
community,
+</li><li> If an application is of interest only to a narrow part of the
community,
then the question of which language it is written in has less effect on
other people, so you may as well please yourself.
-</ul>
+</li></ul>
- <p>Many programs are designed to be extensible: they include an interpreter
+<p>Many programs are designed to be extensible: they include an interpreter
for a language that is higher level than C. Often much of the program
is written in that language, too. The Emacs editor pioneered this
technique.
-
- <p><a name="index-Guile-15"></a><a name="index-GNOME-and-Guile-16"></a>The
standard extensibility interpreter for GNU software is Guile
+</p>
+<a name="index-Guile"></a>
+<a name="index-GNOME-and-Guile"></a>
+<p>The standard extensibility interpreter for GNU software is Guile
(<a
href="http://www.gnu.org/software/guile/";>http://www.gnu.org/software/guile/</a>),
which implements the
language Scheme (an especially clean and simple dialect of Lisp).
Guile also includes bindings for GTK+/GNOME, making it practical to
-write modern GUI functionality within Guile. We don't reject programs
+write modern GUI functionality within Guile. We don’t reject programs
written in other “scripting languages” such as Perl and Python, but
using Guile is very important for the overall consistency of the GNU
system.
+</p>
-<div class="node">
+<hr>
<a name="Compatibility"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Using-Extensions">Using
Extensions</a>,
-Previous: <a rel="previous" accesskey="p" href="#Source-Language">Source
Language</a>,
-Up: <a rel="up" accesskey="u" href="#Design-Advice">Design Advice</a>
-
+<div class="header">
+<p>
+Next: <a href="#Using-Extensions" accesskey="n" rel="next">Using
Extensions</a>, Previous: <a href="#Source-Language" accesskey="p"
rel="previous">Source Language</a>, Up: <a href="#Design-Advice" accesskey="u"
rel="up">Design Advice</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Compatibility-with-Other-Implementations"></a>
<h3 class="section">3.2 Compatibility with Other Implementations</h3>
+<a name="index-compatibility-with-C-and-POSIX-standards"></a>
+<a name="index-POSIX-compatibility"></a>
-<p><a
name="index-compatibility-with-C-and-_0040sc_007bposix_007d-standards-17"></a><a
name="index-g_t_0040sc_007bposix_007d-compatibility-18"></a>
-With occasional exceptions, utility programs and libraries for GNU
+<p>With occasional exceptions, utility programs and libraries for GNU
should be upward compatible with those in Berkeley Unix, and upward
compatible with Standard C if Standard C specifies their
-behavior, and upward compatible with <span class="sc">posix</span> if <span
class="sc">posix</span> specifies
+behavior, and upward compatible with <small>POSIX</small> if
<small>POSIX</small> specifies
their behavior.
-
- <p>When these standards conflict, it is useful to offer compatibility
+</p>
+<p>When these standards conflict, it is useful to offer compatibility
modes for each of them.
-
- <p><a name="index-options-for-compatibility-19"></a>Standard C and <span
class="sc">posix</span> prohibit many kinds of extensions. Feel
-free to make the extensions anyway, and include a ‘<samp><span
class="samp">--ansi</span></samp>’,
-‘<samp><span class="samp">--posix</span></samp>’, or
‘<samp><span class="samp">--compatible</span></samp>’ option to
turn them off.
+</p>
+<a name="index-options-for-compatibility"></a>
+<p>Standard C and <small>POSIX</small> prohibit many kinds of extensions. Feel
+free to make the extensions anyway, and include a
‘<samp>--ansi</samp>’,
+‘<samp>--posix</samp>’, or ‘<samp>--compatible</samp>’
option to turn them off.
However, if the extension has a significant chance of breaking any real
programs or scripts, then it is not really upward compatible. So you
should try to redesign its interface to make it upward compatible.
-
- <p><a
name="index-g_t_0040code_007bPOSIXLY_005fCORRECT_007d_002c-environment-variable-20"></a>Many
GNU programs suppress extensions that conflict with <span
class="sc">posix</span> if the
+</p>
+<a name="index-POSIXLY_005fCORRECT_002c-environment-variable"></a>
+<p>Many GNU programs suppress extensions that conflict with
<small>POSIX</small> if the
environment variable <code>POSIXLY_CORRECT</code> is defined (even if it is
defined with a null value). Please make your program recognize this
variable if appropriate.
-
- <p>When a feature is used only by users (not by programs or command
+</p>
+<p>When a feature is used only by users (not by programs or command
files), and it is done poorly in Unix, feel free to replace it
completely with something totally different and better. (For example,
<code>vi</code> is replaced with Emacs.) But it is nice to offer a compatible
feature as well. (There is a free <code>vi</code> clone, so we offer it.)
-
- <p>Additional useful features are welcome regardless of whether
+</p>
+<p>Additional useful features are welcome regardless of whether
there is any precedent for them.
-
-<div class="node">
+</p>
+<hr>
<a name="Using-Extensions"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Standard-C">Standard C</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Compatibility">Compatibility</a>,
-Up: <a rel="up" accesskey="u" href="#Design-Advice">Design Advice</a>
-
+<div class="header">
+<p>
+Next: <a href="#Standard-C" accesskey="n" rel="next">Standard C</a>, Previous:
<a href="#Compatibility" accesskey="p" rel="previous">Compatibility</a>, Up: <a
href="#Design-Advice" accesskey="u" rel="up">Design Advice</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Using-Non_002dstandard-Features"></a>
<h3 class="section">3.3 Using Non-standard Features</h3>
+<a name="index-non_002dstandard-extensions"></a>
-<p><a name="index-non_002dstandard-extensions-21"></a>
-Many GNU facilities that already exist support a number of convenient
+<p>Many GNU facilities that already exist support a number of convenient
extensions over the comparable Unix facilities. Whether to use these
extensions in implementing your program is a difficult question.
-
- <p>On the one hand, using the extensions can make a cleaner program.
+</p>
+<p>On the one hand, using the extensions can make a cleaner program.
On the other hand, people will not be able to build the program
unless the other GNU tools are available. This might cause the
program to work on fewer kinds of machines.
-
- <p>With some extensions, it might be easy to provide both alternatives.
+</p>
+<p>With some extensions, it might be easy to provide both alternatives.
For example, you can define functions with a “keyword”
<code>INLINE</code>
and define that as a macro to expand into either <code>inline</code> or
nothing, depending on the compiler.
-
- <p>In general, perhaps it is best not to use the extensions if you can
+</p>
+<p>In general, perhaps it is best not to use the extensions if you can
straightforwardly do without them, but to use the extensions if they
are a big improvement.
-
- <p>An exception to this rule are the large, established programs (such as
+</p>
+<p>An exception to this rule are the large, established programs (such as
Emacs) which run on a great variety of systems. Using GNU extensions in
-such programs would make many users unhappy, so we don't do that.
-
- <p>Another exception is for programs that are used as part of compilation:
+such programs would make many users unhappy, so we don’t do that.
+</p>
+<p>Another exception is for programs that are used as part of compilation:
anything that must be compiled with other compilers in order to
bootstrap the GNU compilation facilities. If these require the GNU
compiler, then no one can compile them without having them installed
already. That would be extremely troublesome in certain cases.
-
-<div class="node">
+</p>
+<hr>
<a name="Standard-C"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#Conditional-Compilation">Conditional Compilation</a>,
-Previous: <a rel="previous" accesskey="p" href="#Using-Extensions">Using
Extensions</a>,
-Up: <a rel="up" accesskey="u" href="#Design-Advice">Design Advice</a>
-
+<div class="header">
+<p>
+Next: <a href="#Conditional-Compilation" accesskey="n" rel="next">Conditional
Compilation</a>, Previous: <a href="#Using-Extensions" accesskey="p"
rel="previous">Using Extensions</a>, Up: <a href="#Design-Advice" accesskey="u"
rel="up">Design Advice</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Standard-C-and-Pre_002dStandard-C"></a>
<h3 class="section">3.4 Standard C and Pre-Standard C</h3>
+<a name="index-ANSI-C-standard"></a>
-<p><a name="index-g_t_0040sc_007bansi_007d-C-standard-22"></a>
-1989 Standard C is widespread enough now that it is ok to use its
+<p>1989 Standard C is widespread enough now that it is ok to use its
features in new programs. There is one exception: do not ever use the
“trigraph” feature of Standard C.
-
- <p>1999 Standard C is not widespread yet, so please do not require its
+</p>
+<p>1999 Standard C is not widespread yet, so please do not require its
features in programs. It is ok to use its features if they are present.
-
- <p>However, it is easy to support pre-standard compilers in most programs,
+</p>
+<p>However, it is easy to support pre-standard compilers in most programs,
so if you know how to do that, feel free. If a program you are
maintaining has such support, you should try to keep it working.
-
- <p><a name="index-function-prototypes-23"></a>To support pre-standard C,
instead of writing function definitions in
+</p>
+<a name="index-function-prototypes"></a>
+<p>To support pre-standard C, instead of writing function definitions in
standard prototype form,
-
-<pre class="example"> int
- foo (int x, int y)
- ...
-</pre>
- <p class="noindent">write the definition in pre-standard style like this,
-
-<pre class="example"> int
- foo (x, y)
+</p>
+<div class="example">
+<pre class="example">int
+foo (int x, int y)
+…
+</pre></div>
+
+<p>write the definition in pre-standard style like this,
+</p>
+<div class="example">
+<pre class="example">int
+foo (x, y)
int x, y;
- ...
-</pre>
- <p class="noindent">and use a separate declaration to specify the argument
prototype:
+…
+</pre></div>
+
+<p>and use a separate declaration to specify the argument prototype:
+</p>
+<div class="example">
+<pre class="example">int foo (int, int);
+</pre></div>
-<pre class="example"> int foo (int, int);
-</pre>
- <p>You need such a declaration anyway, in a header file, to get the benefit
+<p>You need such a declaration anyway, in a header file, to get the benefit
of prototypes in all the files where the function is called. And once
you have the declaration, you normally lose nothing by writing the
function definition in the pre-standard style.
-
- <p>This technique does not work for integer types narrower than
<code>int</code>.
+</p>
+<p>This technique does not work for integer types narrower than
<code>int</code>.
If you think of an argument as being of a type narrower than <code>int</code>,
declare it as <code>int</code> instead.
-
- <p>There are a few special cases where this technique is hard to use. For
+</p>
+<p>There are a few special cases where this technique is hard to use. For
example, if a function argument needs to hold the system type
<code>dev_t</code>, you run into trouble, because <code>dev_t</code> is
shorter than
<code>int</code> on some machines; but you cannot use <code>int</code> instead,
@@ -607,320 +657,348 @@
definition. The only way to support non-standard C and pass such an
argument is to check the width of <code>dev_t</code> using Autoconf and choose
the argument type accordingly. This may not be worth the trouble.
-
- <p>In order to support pre-standard compilers that do not recognize
+</p>
+<p>In order to support pre-standard compilers that do not recognize
prototypes, you may want to use a preprocessor macro like this:
+</p>
+<div class="example">
+<pre class="example">/* Declare the prototype for a general external function.
*/
+#if defined (__STDC__) || defined (WINDOWSNT)
+#define P_(proto) proto
+#else
+#define P_(proto) ()
+#endif
+</pre></div>
-<pre class="example"> /* Declare the prototype for a general external
function. */
- #if defined (__STDC__) || defined (WINDOWSNT)
- #define P_(proto) proto
- #else
- #define P_(proto) ()
- #endif
-</pre>
- <div class="node">
+<hr>
<a name="Conditional-Compilation"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p" href="#Standard-C">Standard
C</a>,
-Up: <a rel="up" accesskey="u" href="#Design-Advice">Design Advice</a>
-
+<div class="header">
+<p>
+Previous: <a href="#Standard-C" accesskey="p" rel="previous">Standard C</a>,
Up: <a href="#Design-Advice" accesskey="u" rel="up">Design Advice</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Conditional-Compilation-1"></a>
<h3 class="section">3.5 Conditional Compilation</h3>
<p>When supporting configuration options already known when building your
program we prefer using <code>if (... )</code> over conditional compilation,
as in the former case the compiler is able to perform more extensive
checking of all possible code paths.
-
- <p>For example, please write
-
+</p>
+<p>For example, please write
+</p>
+<div class="smallexample">
<pre class="smallexample"> if (HAS_FOO)
...
else
...
-</pre>
- <p class="noindent">instead of:
+</pre></div>
+<p>instead of:
+</p>
+<div class="smallexample">
<pre class="smallexample"> #ifdef HAS_FOO
...
#else
...
#endif
-</pre>
- <p>A modern compiler such as GCC will generate exactly the same code in
+</pre></div>
+
+<p>A modern compiler such as GCC will generate exactly the same code in
both cases, and we have been using similar techniques with good success
in several projects. Of course, the former method assumes that
<code>HAS_FOO</code> is defined as either 0 or 1.
-
- <p>While this is not a silver bullet solving all portability problems,
+</p>
+<p>While this is not a silver bullet solving all portability problems,
and is not always appropriate, following this policy would have saved
GCC developers many hours, or even days, per year.
-
- <p>In the case of function-like macros like <code>REVERSIBLE_CC_MODE</code>
in
+</p>
+<p>In the case of function-like macros like <code>REVERSIBLE_CC_MODE</code> in
GCC which cannot be simply used in <code>if (...)</code> statements, there is
an easy workaround. Simply introduce another macro
<code>HAS_REVERSIBLE_CC_MODE</code> as in the following example:
-
+</p>
+<div class="smallexample">
<pre class="smallexample"> #ifdef REVERSIBLE_CC_MODE
#define HAS_REVERSIBLE_CC_MODE 1
#else
#define HAS_REVERSIBLE_CC_MODE 0
#endif
-</pre>
- <div class="node">
-<a name="Program-Behavior"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Writing-C">Writing C</a>,
-Previous: <a rel="previous" accesskey="p" href="#Design-Advice">Design
Advice</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
+</pre></div>
+<hr>
+<a name="Program-Behavior"></a>
+<div class="header">
+<p>
+Next: <a href="#Writing-C" accesskey="n" rel="next">Writing C</a>, Previous:
<a href="#Design-Advice" accesskey="p" rel="previous">Design Advice</a>, Up: <a
href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Program-Behavior-for-All-Programs"></a>
<h2 class="chapter">4 Program Behavior for All Programs</h2>
<p>This chapter describes conventions for writing robust
software. It also describes general standards for error messages, the
command line interface, and how libraries should behave.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Non_002dGNU-Standards"
accesskey="1">Non-GNU Standards</a>:</td><td> </td><td align="left"
valign="top">We consider standards such as POSIX;
+ we don’t "obey" them.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Semantics"
accesskey="2">Semantics</a>:</td><td> </td><td align="left"
valign="top">Writing robust programs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Libraries"
accesskey="3">Libraries</a>:</td><td> </td><td align="left"
valign="top">Library behavior.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Errors"
accesskey="4">Errors</a>:</td><td> </td><td align="left"
valign="top">Formatting error messages.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#User-Interfaces"
accesskey="5">User Interfaces</a>:</td><td> </td><td align="left"
valign="top">Standards about interfaces generally.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Graphical-Interfaces"
accesskey="6">Graphical Interfaces</a>:</td><td> </td><td
align="left" valign="top">Standards for graphical interfaces.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="#Command_002dLine-Interfaces" accesskey="7">Command-Line
Interfaces</a>:</td><td> </td><td align="left"
valign="top">Standards for command line interfaces.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="#Dynamic-Plug_002dIn-Interfaces" accesskey="8">Dynamic Plug-In
Interfaces</a>:</td><td> </td><td align="left"
valign="top">Standards for dynamic plug-in interfaces.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Option-Table"
accesskey="9">Option Table</a>:</td><td> </td><td align="left"
valign="top">Table of long options.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#OID-Allocations">OID
Allocations</a>:</td><td> </td><td align="left" valign="top">Table
of OID slots for GNU.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Memory-Usage">Memory
Usage</a>:</td><td> </td><td align="left" valign="top">When and how
to care about memory needs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#File-Usage">File
Usage</a>:</td><td> </td><td align="left" valign="top">Which files
to use, and where.
+</td></tr>
+</table>
-<ul class="menu">
-<li><a accesskey="1" href="#Non_002dGNU-Standards">Non-GNU Standards</a>:
We consider standards such as POSIX;
- we don't "obey" them.
-<li><a accesskey="2" href="#Semantics">Semantics</a>:
Writing robust programs.
-<li><a accesskey="3" href="#Libraries">Libraries</a>:
Library behavior.
-<li><a accesskey="4" href="#Errors">Errors</a>:
Formatting error messages.
-<li><a accesskey="5" href="#User-Interfaces">User Interfaces</a>:
Standards about interfaces generally.
-<li><a accesskey="6" href="#Graphical-Interfaces">Graphical Interfaces</a>:
Standards for graphical interfaces.
-<li><a accesskey="7" href="#Command_002dLine-Interfaces">Command-Line
Interfaces</a>: Standards for command line interfaces.
-<li><a accesskey="8" href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In
Interfaces</a>: Standards for dynamic plug-in interfaces.
-<li><a accesskey="9" href="#Option-Table">Option Table</a>:
Table of long options.
-<li><a href="#OID-Allocations">OID Allocations</a>: Table of OID
slots for GNU.
-<li><a href="#Memory-Usage">Memory Usage</a>: When and how to
care about memory needs.
-<li><a href="#File-Usage">File Usage</a>: Which files to
use, and where.
-</ul>
-
-<div class="node">
-<a name="Non-GNU-Standards"></a>
+<hr>
<a name="Non_002dGNU-Standards"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Semantics">Semantics</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Semantics" accesskey="n" rel="next">Semantics</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Non_002dGNU-Standards-1"></a>
<h3 class="section">4.1 Non-GNU Standards</h3>
<p>The GNU Project regards standards published by other organizations as
suggestions, not orders. We consider those standards, but we do not
“obey” them. In developing a GNU program, you should implement
-an outside standard's specifications when that makes the GNU system
-better overall in an objective sense. When it doesn't, you shouldn't.
-
- <p>In most cases, following published standards is convenient for
+an outside standard’s specifications when that makes the GNU system
+better overall in an objective sense. When it doesn’t, you
shouldn’t.
+</p>
+<p>In most cases, following published standards is convenient for
users—it means that their programs or scripts will work more
portably. For instance, GCC implements nearly all the features of
Standard C as specified by that standard. C program developers would
be unhappy if it did not. And GNU utilities mostly follow
specifications of POSIX.2; shell script writers and users would be
unhappy if our programs were incompatible.
-
- <p>But we do not follow either of these specifications rigidly, and there
+</p>
+<p>But we do not follow either of these specifications rigidly, and there
are specific points on which we decided not to follow them, so as to
make the GNU system better for users.
-
- <p>For instance, Standard C says that nearly all extensions to C are
+</p>
+<p>For instance, Standard C says that nearly all extensions to C are
prohibited. How silly! GCC implements many extensions, some of which
were later adopted as part of the standard. If you want these
constructs to give an error message as “required” by the standard,
-you must specify ‘<samp><span
class="samp">--pedantic</span></samp>’, which was implemented only so that
+you must specify ‘<samp>--pedantic</samp>’, which was implemented
only so that
we can say “GCC is a 100% implementation of the standard”, not
because there is any reason to actually use it.
-
- <p>POSIX.2 specifies that ‘<samp><span
class="samp">df</span></samp>’ and ‘<samp><span
class="samp">du</span></samp>’ must output sizes by
+</p>
+<p>POSIX.2 specifies that ‘<samp>df</samp>’ and
‘<samp>du</samp>’ must output sizes by
default in units of 512 bytes. What users want is units of 1k, so
that is what we do by default. If you want the ridiculous behavior
“required” by POSIX, you must set the environment variable
-‘<samp><span class="samp">POSIXLY_CORRECT</span></samp>’ (which
was originally going to be named
-‘<samp><span class="samp">POSIX_ME_HARDER</span></samp>’).
-
- <p>GNU utilities also depart from the letter of the POSIX.2 specification
+‘<samp>POSIXLY_CORRECT</samp>’ (which was originally going to be
named
+‘<samp>POSIX_ME_HARDER</samp>’).
+</p>
+<p>GNU utilities also depart from the letter of the POSIX.2 specification
when they support long-named command-line options, and intermixing
options with ordinary arguments. This minor incompatibility with
POSIX is never a problem in practice, and it is very useful.
-
- <p>In particular, don't reject a new feature, or remove an old one,
+</p>
+<p>In particular, don’t reject a new feature, or remove an old one,
merely because a standard says it is “forbidden” or
“deprecated”.
+</p>
-<div class="node">
+<hr>
<a name="Semantics"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Libraries">Libraries</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Non_002dGNU-Standards">Non-GNU Standards</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Libraries" accesskey="n" rel="next">Libraries</a>, Previous:
<a href="#Non_002dGNU-Standards" accesskey="p" rel="previous">Non-GNU
Standards</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Writing-Robust-Programs"></a>
<h3 class="section">4.2 Writing Robust Programs</h3>
-<p><a name="index-arbitrary-limits-on-data-24"></a>Avoid arbitrary limits on
the length or number of <em>any</em> data
+<a name="index-arbitrary-limits-on-data"></a>
+<p>Avoid arbitrary limits on the length or number of <em>any</em> data
structure, including file names, lines, files, and symbols, by allocating
all data structures dynamically. In most Unix utilities, “long lines
are silently truncated”. This is not acceptable in a GNU utility.
-
- <p><a name="index-g_t_0040code_007bNUL_007d-characters-25"></a><a
name="index-libiconv-26"></a>Utilities reading files should not drop NUL
characters, or any other
+</p>
+<a name="index-NUL-characters"></a>
+<a name="index-libiconv"></a>
+<p>Utilities reading files should not drop NUL characters, or any other
nonprinting characters <em>including those with codes above 0177</em>.
The only sensible exceptions would be utilities specifically intended
-for interface to certain types of terminals or printers that can't
+for interface to certain types of terminals or printers that can’t
handle those characters. Whenever possible, try to make programs work
properly with sequences of bytes that represent multibyte characters;
UTF-8 is the most important.
-
- <p><a name="index-error-messages-27"></a>Check every system call for an
error return, unless you know you wish
+</p>
+<a name="index-error-messages"></a>
+<p>Check every system call for an error return, unless you know you wish
to ignore errors. Include the system error text (from <code>perror</code>,
<code>strerror</code>, or equivalent) in <em>every</em> error message
resulting from a failing system call, as well as the name of the file
if any and the name of the utility. Just “cannot open foo.c” or
“stat failed” is not sufficient.
-
- <p><a name="index-g_t_0040code_007bmalloc_007d-return-value-28"></a><a
name="index-memory-allocation-failure-29"></a>Check every call to
<code>malloc</code> or <code>realloc</code> to see if it
+</p>
+<a name="index-malloc-return-value"></a>
+<a name="index-memory-allocation-failure"></a>
+<p>Check every call to <code>malloc</code> or <code>realloc</code> to see if it
returned zero. Check <code>realloc</code> even if you are making the block
smaller; in a system that rounds block sizes to a power of 2,
<code>realloc</code> may get a different block if you ask for less space.
-
- <p>In Unix, <code>realloc</code> can destroy the storage block if it returns
+</p>
+<p>In Unix, <code>realloc</code> can destroy the storage block if it returns
zero. GNU <code>realloc</code> does not have this bug: if it fails, the
original block is unchanged. Feel free to assume the bug is fixed. If
you wish to run your program on Unix, and wish to avoid lossage in this
case, you can use the GNU <code>malloc</code>.
-
- <p>You must expect <code>free</code> to alter the contents of the block
that was
+</p>
+<p>You must expect <code>free</code> to alter the contents of the block that
was
freed. Anything you want to fetch from the block, you must fetch before
calling <code>free</code>.
-
- <p>If <code>malloc</code> fails in a noninteractive program, make that a
fatal
+</p>
+<p>If <code>malloc</code> fails in a noninteractive program, make that a fatal
error. In an interactive program (one that reads commands from the
user), it is better to abort the command and return to the command
reader loop. This allows the user to kill other processes to free up
virtual memory, and then try the command again.
-
- <p><a name="index-command_002dline-arguments_002c-decoding-30"></a>Use
<code>getopt_long</code> to decode arguments, unless the argument syntax
+</p>
+<a name="index-command_002dline-arguments_002c-decoding"></a>
+<p>Use <code>getopt_long</code> to decode arguments, unless the argument syntax
makes this unreasonable.
-
- <p>When static storage is to be written in during program execution, use
+</p>
+<p>When static storage is to be written in during program execution, use
explicit C code to initialize it. Reserve C initialized declarations
for data that will not be changed.
-<!-- ADR: why? -->
-
- <p>Try to avoid low-level interfaces to obscure Unix data structures (such
+</p>
+<p>Try to avoid low-level interfaces to obscure Unix data structures (such
as file directories, utmp, or the layout of kernel memory), since these
are less likely to work compatibly. If you need to find all the files
in a directory, use <code>readdir</code> or some other high-level interface.
These are supported compatibly by GNU.
-
- <p><a name="index-signal-handling-31"></a>The preferred signal handling
facilities are the BSD variant of
-<code>signal</code>, and the <span class="sc">posix</span>
<code>sigaction</code> function; the
+</p>
+<a name="index-signal-handling"></a>
+<p>The preferred signal handling facilities are the BSD variant of
+<code>signal</code>, and the <small>POSIX</small> <code>sigaction</code>
function; the
alternative USG <code>signal</code> interface is an inferior design.
-
- <p>Nowadays, using the <span class="sc">posix</span> signal functions may
be the easiest way
+</p>
+<p>Nowadays, using the <small>POSIX</small> signal functions may be the
easiest way
to make a program portable. If you use <code>signal</code>, then on GNU/Linux
systems running GNU libc version 1, you should include
-<samp><span class="file">bsd/signal.h</span></samp> instead of <samp><span
class="file">signal.h</span></samp>, so as to get BSD
+‘<tt>bsd/signal.h</tt>’ instead of
‘<tt>signal.h</tt>’, so as to get BSD
behavior. It is up to you whether to support systems where
<code>signal</code> has only the USG behavior, or give up on them.
-
- <p><a name="index-impossible-conditions-32"></a>In error checks that detect
“impossible” conditions, just abort.
+</p>
+<a name="index-impossible-conditions"></a>
+<p>In error checks that detect “impossible” conditions, just abort.
There is usually no point in printing any message. These checks
indicate the existence of bugs. Whoever wants to fix the bugs will have
to read the source code and run a debugger. So explain the problem with
comments in the source. The relevant data will be in variables, which
are easy to examine with the debugger, so there is no point moving them
elsewhere.
-
- <p>Do not use a count of errors as the exit status for a program.
+</p>
+<p>Do not use a count of errors as the exit status for a program.
<em>That does not work</em>, because exit status values are limited to 8
bits (0 through 255). A single run of the program might have 256
errors; if you try to return 256 as the exit status, the parent process
will see 0 as the status, and it will appear that the program succeeded.
-
- <p><a name="index-temporary-files-33"></a><a
name="index-g_t_0040code_007bTMPDIR_007d-environment-variable-34"></a>If you
make temporary files, check the <code>TMPDIR</code> environment
+</p>
+<a name="index-temporary-files"></a>
+<a name="index-TMPDIR-environment-variable"></a>
+<p>If you make temporary files, check the <code>TMPDIR</code> environment
variable; if that variable is defined, use the specified directory
-instead of <samp><span class="file">/tmp</span></samp>.
-
- <p>In addition, be aware that there is a possible security problem when
+instead of ‘<tt>/tmp</tt>’.
+</p>
+<p>In addition, be aware that there is a possible security problem when
creating temporary files in world-writable directories. In C, you can
avoid this problem by creating temporary files in this manner:
-
-<pre class="example"> fd = open (filename, O_WRONLY | O_CREAT | O_EXCL,
0600);
-</pre>
- <p class="noindent">or by using the <code>mkstemps</code> function from
Gnulib
-(see <a href="gnulib.html#mkstemps">mkstemps</a>).
-
- <p>In bash, use <code>set -C</code> (long name <code>noclobber</code>) to
avoid this
+</p>
+<div class="example">
+<pre class="example">fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600);
+</pre></div>
+
+<p>or by using the <code>mkstemps</code> function from Gnulib
+(see <a
href="http://www.gnu.org/software/gnulib/manual/gnulib.html#mkstemps";>mkstemps</a>
in <cite>Gnulib</cite>).
+</p>
+<p>In bash, use <code>set -C</code> (long name <code>noclobber</code>) to
avoid this
problem. In addition, the <code>mktemp</code> utility is a more general
solution for creating temporary files from shell scripts
-(see <a href="coreutils.html#mktemp-invocation">mktemp invocation</a>).
+(see <a
href="http://www.gnu.org/software/coreutils/manual/coreutils#mktemp-invocation";>mktemp
invocation</a> in <cite>GNU Coreutils</cite>).
+</p>
-<div class="node">
+<hr>
<a name="Libraries"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Errors">Errors</a>,
-Previous: <a rel="previous" accesskey="p" href="#Semantics">Semantics</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Errors" accesskey="n" rel="next">Errors</a>, Previous: <a
href="#Semantics" accesskey="p" rel="previous">Semantics</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Library-Behavior"></a>
<h3 class="section">4.3 Library Behavior</h3>
+<a name="index-libraries"></a>
-<p><a name="index-libraries-35"></a>
-Try to make library functions reentrant. If they need to do dynamic
+<p>Try to make library functions reentrant. If they need to do dynamic
storage allocation, at least try to avoid any nonreentrancy aside from
that of <code>malloc</code> itself.
-
- <p>Here are certain name conventions for libraries, to avoid name
+</p>
+<p>Here are certain name conventions for libraries, to avoid name
conflicts.
-
- <p>Choose a name prefix for the library, more than two characters long.
+</p>
+<p>Choose a name prefix for the library, more than two characters long.
All external function and variable names should start with this
prefix. In addition, there should only be one of these in any given
library member. This usually means putting each one in a separate
source file.
-
- <p>An exception can be made when two external symbols are always used
+</p>
+<p>An exception can be made when two external symbols are always used
together, so that no reasonable program could use one without the
other; then they can both go in the same file.
-
- <p>External symbols that are not documented entry points for the user
-should have names beginning with ‘<samp><span
class="samp">_</span></samp>’. The ‘<samp><span
class="samp">_</span></samp>’ should be
+</p>
+<p>External symbols that are not documented entry points for the user
+should have names beginning with ‘<samp>_</samp>’. The
‘<samp>_</samp>’ should be
followed by the chosen name prefix for the library, to prevent
collisions with other libraries. These can go in the same files with
user entry points if you like.
-
- <p>Static functions and variables can be used as you like and need not
+</p>
+<p>Static functions and variables can be used as you like and need not
fit any naming convention.
-
-<div class="node">
+</p>
+<hr>
<a name="Errors"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#User-Interfaces">User
Interfaces</a>,
-Previous: <a rel="previous" accesskey="p" href="#Libraries">Libraries</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#User-Interfaces" accesskey="n" rel="next">User Interfaces</a>,
Previous: <a href="#Libraries" accesskey="p" rel="previous">Libraries</a>, Up:
<a href="#Program-Behavior" accesskey="u" rel="up">Program Behavior</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Formatting-Error-Messages"></a>
<h3 class="section">4.4 Formatting Error Messages</h3>
+<a name="index-formatting-error-messages"></a>
+<a name="index-error-messages_002c-formatting"></a>
-<p><a name="index-formatting-error-messages-36"></a><a
name="index-error-messages_002c-formatting-37"></a>
-Error messages from compilers should look like this:
-
-<pre class="example"> <var>sourcefile</var>:<var>lineno</var>:
<var>message</var>
-</pre>
- <p class="noindent">If you want to mention the column number, use one of
these formats:
+<p>Error messages from compilers should look like this:
+</p>
+<div class="example">
+<pre class="example"><var>sourcefile</var>:<var>lineno</var>:
<var>message</var>
+</pre></div>
+
+<p>If you want to mention the column number, use one of these formats:
+</p>
+<div class="example">
+<pre
class="example"><var>sourcefile</var>:<var>lineno</var>:<var>column</var>:
<var>message</var>
+<var>sourcefile</var>:<var>lineno</var>.<var>column</var>: <var>message</var>
-<pre class="example">
<var>sourcefile</var>:<var>lineno</var>:<var>column</var>: <var>message</var>
- <var>sourcefile</var>:<var>lineno</var>.<var>column</var>:
<var>message</var>
+</pre></div>
-</pre>
- <p class="noindent">Line numbers should start from 1 at the beginning of
the file, and
+<p>Line numbers should start from 1 at the beginning of the file, and
column numbers should start from 1 at the beginning of the line.
(Both of these conventions are chosen for compatibility.) Calculate
column numbers assuming that space and all ASCII printing characters
@@ -928,373 +1006,436 @@
non-ASCII characters, Unicode character widths should be used when in
a UTF-8 locale; GNU libc and GNU gnulib provide suitable
<code>wcwidth</code> functions.
-
- <p>The error message can also give both the starting and ending positions
+</p>
+<p>The error message can also give both the starting and ending positions
of the erroneous text. There are several formats so that you can
avoid redundant information such as a duplicate line number.
Here are the possible formats:
+</p>
+<div class="example">
+<pre
class="example"><var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>line2</var>.<var>column2</var>:
<var>message</var>
+<var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>column2</var>:
<var>message</var>
+<var>sourcefile</var>:<var>line1</var>-<var>line2</var>: <var>message</var>
+</pre></div>
+
+<p>When an error is spread over several files, you can use this format:
+</p>
+<div class="example">
+<pre
class="example"><var>file1</var>:<var>line1</var>.<var>column1</var>-<var>file2</var>:<var>line2</var>.<var>column2</var>:
<var>message</var>
+</pre></div>
+
+<p>Error messages from other noninteractive programs should look like this:
+</p>
+<div class="example">
+<pre
class="example"><var>program</var>:<var>sourcefile</var>:<var>lineno</var>:
<var>message</var>
+</pre></div>
+
+<p>when there is an appropriate source file, or like this:
+</p>
+<div class="example">
+<pre class="example"><var>program</var>: <var>message</var>
+</pre></div>
+
+<p>when there is no relevant source file.
+</p>
+<p>If you want to mention the column number, use this format:
+</p>
+<div class="example">
+<pre
class="example"><var>program</var>:<var>sourcefile</var>:<var>lineno</var>:<var>column</var>:
<var>message</var>
+</pre></div>
-<pre class="example">
<var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>line2</var>.<var>column2</var>:
<var>message</var>
-
<var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>column2</var>:
<var>message</var>
- <var>sourcefile</var>:<var>line1</var>-<var>line2</var>:
<var>message</var>
-</pre>
- <p class="noindent">When an error is spread over several files, you can use
this format:
-
-<pre class="example">
<var>file1</var>:<var>line1</var>.<var>column1</var>-<var>file2</var>:<var>line2</var>.<var>column2</var>:
<var>message</var>
-</pre>
- <p>Error messages from other noninteractive programs should look like this:
-
-<pre class="example">
<var>program</var>:<var>sourcefile</var>:<var>lineno</var>: <var>message</var>
-</pre>
- <p class="noindent">when there is an appropriate source file, or like this:
-
-<pre class="example"> <var>program</var>: <var>message</var>
-</pre>
- <p class="noindent">when there is no relevant source file.
-
- <p>If you want to mention the column number, use this format:
-
-<pre class="example">
<var>program</var>:<var>sourcefile</var>:<var>lineno</var>:<var>column</var>:
<var>message</var>
-</pre>
- <p>In an interactive program (one that is reading commands from a
+<p>In an interactive program (one that is reading commands from a
terminal), it is better not to include the program name in an error
message. The place to indicate which program is running is in the
prompt or with the screen layout. (When the same program runs with
input from a source other than a terminal, it is not interactive and
would do best to print error messages using the noninteractive style.)
-
- <p>The string <var>message</var> should not begin with a capital letter when
-it follows a program name and/or file name, because that isn't the
+</p>
+<p>The string <var>message</var> should not begin with a capital letter when
+it follows a program name and/or file name, because that isn’t the
beginning of a sentence. (The sentence conceptually starts at the
beginning of the line.) Also, it should not end with a period.
-
- <p>Error messages from interactive programs, and other messages such as
+</p>
+<p>Error messages from interactive programs, and other messages such as
usage messages, should start with a capital letter. But they should not
end with a period.
-
-<div class="node">
+</p>
+<hr>
<a name="User-Interfaces"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Graphical-Interfaces">Graphical
Interfaces</a>,
-Previous: <a rel="previous" accesskey="p" href="#Errors">Errors</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Graphical-Interfaces" accesskey="n" rel="next">Graphical
Interfaces</a>, Previous: <a href="#Errors" accesskey="p"
rel="previous">Errors</a>, Up: <a href="#Program-Behavior" accesskey="u"
rel="up">Program Behavior</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Standards-for-Interfaces-Generally"></a>
<h3 class="section">4.5 Standards for Interfaces Generally</h3>
-<p><a name="index-program-name-and-its-behavior-38"></a><a
name="index-behavior_002c-dependent-on-program_0027s-name-39"></a>Please don't
make the behavior of a utility depend on the name used
+<a name="index-program-name-and-its-behavior"></a>
+<a name="index-behavior_002c-dependent-on-program_0027s-name"></a>
+<p>Please don’t make the behavior of a utility depend on the name used
to invoke it. It is useful sometimes to make a link to a utility
with a different name, and that should not change what it does.
-
- <p>Instead, use a run time option or a compilation switch or both
+</p>
+<p>Instead, use a run time option or a compilation switch or both
to select among the alternate behaviors.
-
- <p><a
name="index-output-device-and-program_0027s-behavior-40"></a>Likewise, please
don't make the behavior of the program depend on the
+</p>
+<a name="index-output-device-and-program_0027s-behavior"></a>
+<p>Likewise, please don’t make the behavior of the program depend on the
type of output device it is used with. Device independence is an
-important principle of the system's design; do not compromise it merely
+important principle of the system’s design; do not compromise it merely
to save someone from typing an option now and then. (Variation in error
message syntax when using a terminal is ok, because that is a side issue
that people do not depend on.)
-
- <p>If you think one behavior is most useful when the output is to a
+</p>
+<p>If you think one behavior is most useful when the output is to a
terminal, and another is most useful when the output is a file or a
pipe, then it is usually best to make the default behavior the one that
is useful with output to a terminal, and have an option for the other
behavior.
-
- <p>Compatibility requires certain programs to depend on the type of output
+</p>
+<p>Compatibility requires certain programs to depend on the type of output
device. It would be disastrous if <code>ls</code> or <code>sh</code> did not
do so
in the way all users expect. In some of these cases, we supplement the
program with a preferred alternate version that does not depend on the
output device type. For example, we provide a <code>dir</code> program much
like <code>ls</code> except that its default output format is always
multi-column format.
+</p>
-<div class="node">
+<hr>
<a name="Graphical-Interfaces"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a>,
-Previous: <a rel="previous" accesskey="p" href="#User-Interfaces">User
Interfaces</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Command_002dLine-Interfaces" accesskey="n"
rel="next">Command-Line Interfaces</a>, Previous: <a href="#User-Interfaces"
accesskey="p" rel="previous">User Interfaces</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Standards-for-Graphical-Interfaces"></a>
<h3 class="section">4.6 Standards for Graphical Interfaces</h3>
+<a name="index-graphical-user-interface"></a>
+<a name="index-interface-styles"></a>
+<a name="index-user-interface-styles"></a>
-<p><a name="index-graphical-user-interface-41"></a><a
name="index-interface-styles-42"></a><a
name="index-user-interface-styles-43"></a>
-<a name="index-GTK_002b-44"></a>When you write a program that provides a
graphical user interface,
+<a name="index-GTK_002b"></a>
+<p>When you write a program that provides a graphical user interface,
please make it work with the X Window System and the GTK+ toolkit
unless the functionality specifically requires some alternative (for
example, “displaying jpeg images while in console mode”).
-
- <p>In addition, please provide a command-line interface to control the
+</p>
+<p>In addition, please provide a command-line interface to control the
functionality. (In many cases, the graphical user interface can be a
separate program which invokes the command-line program.) This is
so that the same jobs can be done from scripts.
-
- <p><a name="index-CORBA-45"></a><a name="index-GNOME-46"></a><a
name="index-D_002dbus-47"></a><a name="index-keyboard-interface-48"></a><a
name="index-library-interface-49"></a>Please also consider providing a D-bus
interface for use from other
+</p>
+<a name="index-CORBA"></a>
+<a name="index-GNOME"></a>
+<a name="index-D_002dbus"></a>
+<a name="index-keyboard-interface"></a>
+<a name="index-library-interface"></a>
+<p>Please also consider providing a D-bus interface for use from other
running programs, such as within GNOME. (GNOME used to use CORBA
for this, but that is being phased out.) In addition, consider
providing a library interface (for use from C), and perhaps a
keyboard-driven console interface (for use by users from console
mode). Once you are doing the work to provide the functionality and
-the graphical interface, these won't be much extra work.
+the graphical interface, these won’t be much extra work.
+</p>
-<div class="node">
-<a name="Command-Line-Interfaces"></a>
+<hr>
<a name="Command_002dLine-Interfaces"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Graphical-Interfaces">Graphical Interfaces</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Dynamic-Plug_002dIn-Interfaces" accesskey="n"
rel="next">Dynamic Plug-In Interfaces</a>, Previous: <a
href="#Graphical-Interfaces" accesskey="p" rel="previous">Graphical
Interfaces</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Standards-for-Command-Line-Interfaces"></a>
<h3 class="section">4.7 Standards for Command Line Interfaces</h3>
+<a name="index-command_002dline-interface"></a>
-<p><a name="index-command_002dline-interface-50"></a>
-<a name="index-getopt-51"></a>It is a good idea to follow the <span
class="sc">posix</span> guidelines for the
+<a name="index-getopt"></a>
+<p>It is a good idea to follow the <small>POSIX</small> guidelines for the
command-line options of a program. The easiest way to do this is to use
<code>getopt</code> to parse them. Note that the GNU version of
<code>getopt</code>
will normally permit options anywhere among the arguments unless the
-special argument ‘<samp><span class="samp">--</span></samp>’ is
used. This is not what <span class="sc">posix</span>
+special argument ‘<samp>--</samp>’ is used. This is not what
<small>POSIX</small>
specifies; it is a GNU extension.
-
- <p><a name="index-long_002dnamed-options-52"></a>Please define long-named
options that are equivalent to the
+</p>
+<a name="index-long_002dnamed-options"></a>
+<p>Please define long-named options that are equivalent to the
single-letter Unix-style options. We hope to make GNU more user
friendly this way. This is easy to do with the GNU function
<code>getopt_long</code>.
-
- <p>One of the advantages of long-named options is that they can be
+</p>
+<p>One of the advantages of long-named options is that they can be
consistent from program to program. For example, users should be able
to expect the “verbose” option of any GNU program which has one,
to be
-spelled precisely ‘<samp><span
class="samp">--verbose</span></samp>’. To achieve this uniformity, look
at
+spelled precisely ‘<samp>--verbose</samp>’. To achieve this
uniformity, look at
the table of common long-option names when you choose the option names
for your program (see <a href="#Option-Table">Option Table</a>).
-
- <p>It is usually a good idea for file names given as ordinary arguments to
+</p>
+<p>It is usually a good idea for file names given as ordinary arguments to
be input files only; any output files would be specified using options
-(preferably ‘<samp><span class="samp">-o</span></samp>’ or
‘<samp><span class="samp">--output</span></samp>’). Even if you
allow an output
+(preferably ‘<samp>-o</samp>’ or
‘<samp>--output</samp>’). Even if you allow an output
file name as an ordinary argument for compatibility, try to provide an
option as another way to specify it. This will lead to more consistency
among GNU utilities, and fewer idiosyncrasies for users to remember.
-
- <p><a name="index-standard-command_002dline-options-53"></a><a
name="index-options_002c-standard-command_002dline-54"></a><a
name="index-CGI-programs_002c-standard-options-for-55"></a><a
name="index-PATH_005fINFO_002c-specifying-standard-options-as-56"></a>All
programs should support two standard options: ‘<samp><span
class="samp">--version</span></samp>’
-and ‘<samp><span class="samp">--help</span></samp>’. CGI programs
should accept these as command-line
-options, and also if given as the <samp><span
class="env">PATH_INFO</span></samp>; for instance,
-visiting <a
href="http://example.org/p.cgi/--help";>http://example.org/p.cgi/–help</a>
in a browser should
-output the same information as invoking ‘<samp><span class="samp">p.cgi
--help</span></samp>’ from the
+</p>
+<a name="index-standard-command_002dline-options"></a>
+<a name="index-options_002c-standard-command_002dline"></a>
+<a name="index-CGI-programs_002c-standard-options-for"></a>
+<a name="index-PATH_005fINFO_002c-specifying-standard-options-as"></a>
+<p>All programs should support two standard options:
‘<samp>--version</samp>’
+and ‘<samp>--help</samp>’. CGI programs should accept these as
command-line
+options, and also if given as the <code>PATH_INFO</code>; for instance,
+visiting <a
href="http://example.org/p.cgi/--help";>http://example.org/p.cgi/--help</a> in a
browser should
+output the same information as invoking ‘<samp>p.cgi
--help</samp>’ from the
command line.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#g_t_002d_002dversion"
accesskey="1">--version</a>:</td><td> </td><td align="left"
valign="top">The standard output for –version.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#g_t_002d_002dhelp"
accesskey="2">--help</a>:</td><td> </td><td align="left"
valign="top">The standard output for –help.
+</td></tr>
+</table>
-<ul class="menu">
-<li><a accesskey="1" href="#g_t_002d_002dversion">--version</a>: The
standard output for --version.
-<li><a accesskey="2" href="#g_t_002d_002dhelp">--help</a>: The
standard output for --help.
-</ul>
-
-<div class="node">
-<a name="--version"></a>
+<hr>
<a name="g_t_002d_002dversion"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#g_t_002d_002dhelp">--help</a>,
-Up: <a rel="up" accesskey="u"
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a>
-
+<div class="header">
+<p>
+Next: <a href="#g_t_002d_002dhelp" accesskey="n" rel="next">--help</a>, Up: <a
href="#Command_002dLine-Interfaces" accesskey="u" rel="up">Command-Line
Interfaces</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
+<a name="g_t_002d_002dversion-1"></a>
+<h4 class="subsection">4.7.1 ‘<samp>--version</samp>’</h4>
-<h4 class="subsection">4.7.1 <samp><span
class="option">--version</span></samp></h4>
+<a name="index-_002d_002dversion-output"></a>
-<p><a name="index-g_t_0040samp_007b_002d_002dversion_007d-output-57"></a>
-The standard <code>--version</code> option should direct the program to
+<p>The standard <code>--version</code> option should direct the program to
print information about its name, version, origin and legal status,
all on standard output, and then exit successfully. Other options and
arguments should be ignored once this is seen, and the program should
not perform its normal function.
-
- <p><a name="index-canonical-name-of-a-program-58"></a><a
name="index-program_0027s-canonical-name-59"></a>The first line is meant to be
easy for a program to parse; the version
+</p>
+<a name="index-canonical-name-of-a-program"></a>
+<a name="index-program_0027s-canonical-name"></a>
+<p>The first line is meant to be easy for a program to parse; the version
number proper starts after the last space. In addition, it contains
the canonical name for this program, in this format:
+</p>
+<div class="example">
+<pre class="example">GNU Emacs 19.30
+</pre></div>
-<pre class="example"> GNU Emacs 19.30
-</pre>
- <p class="noindent">The program's name should be a constant string;
<em>don't</em> compute it
+<p>The program’s name should be a constant string; <em>don’t</em>
compute it
from <code>argv[0]</code>. The idea is to state the standard or canonical
name for the program, not its file name. There are other ways to find
out the precise file name where a command is found in <code>PATH</code>.
-
- <p>If the program is a subsidiary part of a larger package, mention the
+</p>
+<p>If the program is a subsidiary part of a larger package, mention the
package name in parentheses, like this:
+</p>
+<div class="example">
+<pre class="example">emacsserver (GNU Emacs) 19.30
+</pre></div>
-<pre class="example"> emacsserver (GNU Emacs) 19.30
-</pre>
- <p class="noindent">If the package has a version number which is different
from this
-program's version number, you can mention the package version number
+<p>If the package has a version number which is different from this
+program’s version number, you can mention the package version number
just before the close-parenthesis.
-
- <p>If you <em>need</em> to mention the version numbers of libraries which
+</p>
+<p>If you <em>need</em> to mention the version numbers of libraries which
are distributed separately from the package which contains this program,
you can do so by printing an additional line of version info for each
library you want to mention. Use the same format for these lines as for
the first line.
-
- <p>Please do not mention all of the libraries that the program uses
“just
+</p>
+<p>Please do not mention all of the libraries that the program uses “just
for completeness”—that would produce a lot of unhelpful clutter.
Please mention library version numbers only if you find in practice that
they are very important to you in debugging.
-
- <p>The following line, after the version number line or lines, should be a
+</p>
+<p>The following line, after the version number line or lines, should be a
copyright notice. If more than one copyright notice is called for, put
each on a separate line.
-
- <p>Next should follow a line stating the license, preferably using one of
+</p>
+<p>Next should follow a line stating the license, preferably using one of
abbreviations below, and a brief statement that the program is free
software, and that users are free to copy and change it. Also mention
that there is no warranty, to the extent permitted by law. See
recommended wording below.
-
- <p>It is ok to finish the output with a list of the major authors of the
+</p>
+<p>It is ok to finish the output with a list of the major authors of the
program, as a way of giving credit.
+</p>
+<p>Here’s an example of output that follows these rules:
+</p>
+<div class="smallexample">
+<pre class="smallexample">GNU hello 2.3
+Copyright (C) 2007 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later
<http://gnu.org/licenses/gpl.html>
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+</pre></div>
- <p>Here's an example of output that follows these rules:
-
-<pre class="smallexample"> GNU hello 2.3
- Copyright (C) 2007 Free Software Foundation, Inc.
- License GPLv3+: GNU GPL version 3 or later
<http://gnu.org/licenses/gpl.html>
- This is free software: you are free to change and redistribute it.
- There is NO WARRANTY, to the extent permitted by law.
-</pre>
- <p>You should adapt this to your program, of course, filling in the proper
+<p>You should adapt this to your program, of course, filling in the proper
year, copyright holder, name of program, and the references to
distribution terms, and changing the rest of the wording as necessary.
-
- <p>This copyright notice only needs to mention the most recent year in
-which changes were made—there's no need to list the years for previous
-versions' changes. You don't have to mention the name of the program in
+</p>
+<p>This copyright notice only needs to mention the most recent year in
+which changes were made—there’s no need to list the years for
previous
+versions’ changes. You don’t have to mention the name of the
program in
these notices, if that is inconvenient, since it appeared in the first
line. (The rules are different for copyright notices in source files;
-see <a href="maintain.html#Copyright-Notices">Copyright Notices</a>.)
-
- <p>Translations of the above lines must preserve the validity of the
-copyright notices (see <a
href="#Internationalization">Internationalization</a>). If the translation's
-character set supports it, the ‘<samp><span
class="samp">(C)</span></samp>’ should be replaced with the
+see <a
href="http://www.gnu.org/prep/maintain/maintain.html#Copyright-Notices";>Copyright
Notices</a> in <cite>Information for GNU Maintainers</cite>.)
+</p>
+<p>Translations of the above lines must preserve the validity of the
+copyright notices (see <a
href="#Internationalization">Internationalization</a>). If the
translation’s
+character set supports it, the ‘<samp>(C)</samp>’ should be
replaced with the
copyright symbol, as follows:
-
- <p>©
-
- <p>Write the word “Copyright” exactly like that, in English.
Do not
+</p>
+<p>©
+</p>
+<p>Write the word “Copyright” exactly like that, in English. Do
not
translate it into another language. International treaties recognize
the English word “Copyright”; translations into other languages do
not
have legal significance.
-
- <p>Finally, here is the table of our suggested license abbreviations.
-Any abbreviation can be followed by ‘<samp><span
class="samp">v</span><var>version</var><span
class="samp">[+]</span></samp>’, meaning
-that particular version, or later versions with the ‘<samp><span
class="samp">+</span></samp>’, as shown
+</p>
+<p>Finally, here is the table of our suggested license abbreviations.
+Any abbreviation can be followed by
‘<samp>v<var>version</var>[+]</samp>’, meaning
+that particular version, or later versions with the
‘<samp>+</samp>’, as shown
above.
-
- <p>In the case of exceptions for extra permissions with the GPL, we use
-‘<samp><span class="samp">/</span></samp>’ for a separator; the
version number can follow the license
+</p>
+<p>In the case of exceptions for extra permissions with the GPL, we use
+‘<samp>/</samp>’ for a separator; the version number can follow
the license
abbreviation as usual, as in the examples below.
-
- <dl>
-<dt>GPL<dd>GNU General Public License, <a
href="http://www.gnu.org/licenses/gpl.html";>http://www.gnu.org/licenses/gpl.html</a>.
-
- <br><dt>LGPL<dd>GNU Lesser General Public License, <a
href="http://www.gnu.org/licenses/lgpl.html";>http://www.gnu.org/licenses/lgpl.html</a>.
-
- <br><dt>GPL/Ada<dd>GNU GPL with the exception for Ada.
-
- <br><dt>Apache<dd>The Apache Software Foundation license,
+</p>
+<dl compact="compact">
+<dt>GPL</dt>
+<dd><p>GNU General Public License, <a
href="http://www.gnu.org/licenses/gpl.html";>http://www.gnu.org/licenses/gpl.html</a>.
+</p>
+</dd>
+<dt>LGPL</dt>
+<dd><p>GNU Lesser General Public License, <a
href="http://www.gnu.org/licenses/lgpl.html";>http://www.gnu.org/licenses/lgpl.html</a>.
+</p>
+</dd>
+<dt>GPL/Ada</dt>
+<dd><p>GNU GPL with the exception for Ada.
+</p>
+</dd>
+<dt>Apache</dt>
+<dd><p>The Apache Software Foundation license,
<a href="http://www.apache.org/licenses";>http://www.apache.org/licenses</a>.
-
- <br><dt>Artistic<dd>The Artistic license used for Perl, <a
href="http://www.perlfoundation.org/legal";>http://www.perlfoundation.org/legal</a>.
-
- <br><dt>Expat<dd>The Expat license, <a
href="http://www.jclark.com/xml/copying.txt";>http://www.jclark.com/xml/copying.txt</a>.
-
- <br><dt>MPL<dd>The Mozilla Public License, <a
href="http://www.mozilla.org/MPL/";>http://www.mozilla.org/MPL/</a>.
-
- <br><dt>OBSD<dd>The original (4-clause) BSD license, incompatible with
the GNU GPL
+</p>
+</dd>
+<dt>Artistic</dt>
+<dd><p>The Artistic license used for Perl, <a
href="http://www.perlfoundation.org/legal";>http://www.perlfoundation.org/legal</a>.
+</p>
+</dd>
+<dt>Expat</dt>
+<dd><p>The Expat license, <a
href="http://www.jclark.com/xml/copying.txt";>http://www.jclark.com/xml/copying.txt</a>.
+</p>
+</dd>
+<dt>MPL</dt>
+<dd><p>The Mozilla Public License, <a
href="http://www.mozilla.org/MPL/";>http://www.mozilla.org/MPL/</a>.
+</p>
+</dd>
+<dt>OBSD</dt>
+<dd><p>The original (4-clause) BSD license, incompatible with the GNU GPL
<a
href="http://www.xfree86.org/3.3.6/COPYRIGHT2.html#6";>http://www.xfree86.org/3.3.6/COPYRIGHT2.html#6</a>.
-
- <br><dt>PHP<dd>The license used for PHP, <a
href="http://www.php.net/license/";>http://www.php.net/license/</a>.
-
- <br><dt>public domain<dd>The non-license that is being in the public
domain,
+</p>
+</dd>
+<dt>PHP</dt>
+<dd><p>The license used for PHP, <a
href="http://www.php.net/license/";>http://www.php.net/license/</a>.
+</p>
+</dd>
+<dt>public domain</dt>
+<dd><p>The non-license that is being in the public domain,
<a
href="http://www.gnu.org/licenses/license-list.html#PublicDomain";>http://www.gnu.org/licenses/license-list.html#PublicDomain</a>.
-
- <br><dt>Python<dd>The license for Python, <a
href="http://www.python.org/2.0.1/license.html";>http://www.python.org/2.0.1/license.html</a>.
-
- <br><dt>RBSD<dd>The revised (3-clause) BSD, compatible with the GNU
GPL,<br>
+</p>
+</dd>
+<dt>Python</dt>
+<dd><p>The license for Python, <a
href="http://www.python.org/2.0.1/license.html";>http://www.python.org/2.0.1/license.html</a>.
+</p>
+</dd>
+<dt>RBSD</dt>
+<dd><p>The revised (3-clause) BSD, compatible with the GNU GPL,<br>
<a
href="http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5";>http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5</a>.
-
- <br><dt>X11<dd>The simple non-copyleft license used for most versions of
the X Window
+</p>
+</dd>
+<dt>X11</dt>
+<dd><p>The simple non-copyleft license used for most versions of the X Window
System, <a
href="http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3";>http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3</a>.
+</p>
+</dd>
+<dt>Zlib</dt>
+<dd><p>The license for Zlib, <a
href="http://www.gzip.org/zlib/zlib_license.html";>http://www.gzip.org/zlib/zlib_license.html</a>.
+</p>
+</dd>
+</dl>
- <br><dt>Zlib<dd>The license for Zlib, <a
href="http://www.gzip.org/zlib/zlib_license.html";>http://www.gzip.org/zlib/zlib_license.html</a>.
-
- </dl>
-
- <p>More information about these licenses and many more are on the GNU
+<p>More information about these licenses and many more are on the GNU
licensing web pages,
<a
href="http://www.gnu.org/licenses/license-list.html";>http://www.gnu.org/licenses/license-list.html</a>.
+</p>
-<div class="node">
-<a name="--help"></a>
+<hr>
<a name="g_t_002d_002dhelp"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p"
href="#g_t_002d_002dversion">--version</a>,
-Up: <a rel="up" accesskey="u"
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a>
-
+<div class="header">
+<p>
+Previous: <a href="#g_t_002d_002dversion" accesskey="p"
rel="previous">--version</a>, Up: <a href="#Command_002dLine-Interfaces"
accesskey="u" rel="up">Command-Line Interfaces</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
+<a name="g_t_002d_002dhelp-1"></a>
+<h4 class="subsection">4.7.2 ‘<samp>--help</samp>’</h4>
-<h4 class="subsection">4.7.2 <samp><span
class="option">--help</span></samp></h4>
+<a name="index-_002d_002dhelp-output"></a>
-<p><a name="index-g_t_0040samp_007b_002d_002dhelp_007d-output-60"></a>
-The standard <code>--help</code> option should output brief documentation
+<p>The standard <code>--help</code> option should output brief documentation
for how to invoke the program, on standard output, then exit
successfully. Other options and arguments should be ignored once this
is seen, and the program should not perform its normal function.
-
- <p><a name="index-address-for-bug-reports-61"></a><a
name="index-bug-reports-62"></a>Near the end of the ‘<samp><span
class="samp">--help</span></samp>’ option's output, please place lines
-giving the email address for bug reports, the package's home page
-(normally <<code>http://www.gnu.org/software/</code><var>pkg</var>>, and
the
+</p>
+<a name="index-address-for-bug-reports"></a>
+<a name="index-bug-reports"></a>
+<p>Near the end of the ‘<samp>--help</samp>’ option’s
output, please place lines
+giving the email address for bug reports, the package’s home page
+(normally <<code>http://www.gnu.org/software/<var>pkg</var></code>>, and
the
general page for help using GNU programs. The format should be like this:
+</p>
+<div class="example">
+<pre class="example">Report bugs to: <var>mailing-address</var>
+<var>pkg</var> home page: <http://www.gnu.org/software/<var>pkg</var>/>
+General help using GNU software: <http://www.gnu.org/gethelp/>
+</pre></div>
-<pre class="example"> Report bugs to: <var>mailing-address</var>
- <var>pkg</var> home page:
<http://www.gnu.org/software/<var>pkg</var>/>
- General help using GNU software: <http://www.gnu.org/gethelp/>
-</pre>
- <p>It is ok to mention other appropriate mailing lists and web pages.
+<p>It is ok to mention other appropriate mailing lists and web pages.
+</p>
-<div class="node">
-<a name="Dynamic-Plug-In-Interfaces"></a>
+<hr>
<a name="Dynamic-Plug_002dIn-Interfaces"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Option-Table">Option Table</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Option-Table" accesskey="n" rel="next">Option Table</a>,
Previous: <a href="#Command_002dLine-Interfaces" accesskey="p"
rel="previous">Command-Line Interfaces</a>, Up: <a href="#Program-Behavior"
accesskey="u" rel="up">Program Behavior</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Standards-for-Dynamic-Plug_002din-Interfaces"></a>
<h3 class="section">4.8 Standards for Dynamic Plug-in Interfaces</h3>
+<a name="index-plug_002dins"></a>
+<a name="index-dynamic-plug_002dins"></a>
-<p><a name="index-plug_002dins-63"></a><a
name="index-dynamic-plug_002dins-64"></a>
-Another aspect of keeping free programs free is encouraging
+<p>Another aspect of keeping free programs free is encouraging
development of free plug-ins, and discouraging development of
proprietary plug-ins. Many GNU programs will not have anything like
plug-ins at all, but those that do should follow these
practices.
-
- <p>First, the general plug-in architecture design should closely tie the
+</p>
+<p>First, the general plug-in architecture design should closely tie the
plug-in to the original code, such that the plug-in and the base
program are parts of one extended program. For GCC, for example,
-plug-ins receive and modify GCC's internal data structures, and so
+plug-ins receive and modify GCC’s internal data structures, and so
clearly form an extended program with the base GCC.
-
- <p><a name="index-plugin_005fis_005fGPL_005fcompatible-65"></a>Second, you
should require plug-in developers to affirm that their
+</p>
+<a name="index-plugin_005fis_005fGPL_005fcompatible"></a>
+<p>Second, you should require plug-in developers to affirm that their
plug-ins are released under an appropriate license. This should be
enforced with a simple programmatic check. For GCC, again for
example, a plug-in must define the global symbol
<code>plugin_is_GPL_compatible</code>, thus asserting that the plug-in is
-released under a GPL-compatible license (see <a
href="gccint.html#Plugins">Plugins</a>).
-
- <p>By adding this check to your program you are not creating a new legal
+released under a GPL-compatible license (see <a
href="http://gcc.gnu.org/onlinedocs/gccint/Plugins.html#Plugins";>Plugins</a> in
<cite>GCC Internals</cite>).
+</p>
+<p>By adding this check to your program you are not creating a new legal
requirement. The GPL itself requires plug-ins to be free software,
licensed compatibly. As long as you have followed the first rule above
to keep plug-ins closely tied to your original program, the GPL and AGPL
@@ -1304,833 +1445,1529 @@
distribute proprietary plug-ins to legally defend themselves. If a case
about this got to court, we can point to that symbol as evidence that
the plug-in developer understood that the license had this requirement.
+</p>
-<div class="node">
+<hr>
<a name="Option-Table"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#OID-Allocations">OID
Allocations</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#OID-Allocations" accesskey="n" rel="next">OID Allocations</a>,
Previous: <a href="#Dynamic-Plug_002dIn-Interfaces" accesskey="p"
rel="previous">Dynamic Plug-In Interfaces</a>, Up: <a href="#Program-Behavior"
accesskey="u" rel="up">Program Behavior</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Table-of-Long-Options"></a>
<h3 class="section">4.9 Table of Long Options</h3>
+<a name="index-long-option-names"></a>
+<a name="index-table-of-long-options"></a>
-<p><a name="index-long-option-names-66"></a><a
name="index-table-of-long-options-67"></a>
-Here is a table of long options used by GNU programs. It is surely
+<p>Here is a table of long options used by GNU programs. It is surely
incomplete, but we aim to list all the options that a new program might
want to be compatible with. If you use names not already in the table,
please send <a href="mailto:address@hidden";>address@hidden</a> a list of them,
with their
meanings, so we can update the table.
+</p>
-<!-- Please leave newlines between items in this table; it's much easier -->
-<!-- to update when it isn't completely squashed together and unreadable. -->
-<!-- When there is more than one short option for a long option name, put -->
-<!-- a semicolon between the lists of the programs that use them, not a -->
-<!-- period. -friedman -->
- <dl>
-<dt>‘<samp><span
class="samp">after-date</span></samp>’<dd>‘<samp><span
class="samp">-N</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">all</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>du</code>, <code>ls</code>,
<code>nm</code>, <code>stty</code>, <code>uname</code>,
+<dl compact="compact">
+<dt>‘<samp>after-date</samp>’</dt>
+<dd><p>‘<samp>-N</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>all</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>du</code>, <code>ls</code>,
<code>nm</code>, <code>stty</code>, <code>uname</code>,
and <code>unexpand</code>.
-
- <br><dt>‘<samp><span
class="samp">all-text</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">almost-all</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">append</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>etags</code>, <code>tee</code>,
<code>time</code>;
-‘<samp><span class="samp">-r</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">archive</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>cp</code>.
-
- <br><dt>‘<samp><span
class="samp">archive-name</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">arglength</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">ascii</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">assign</span></samp>’<dd>‘<samp><span
class="samp">-v</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">assume-new</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">assume-old</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">auto-check</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">auto-pager</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">auto-reference</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">avoid-wraps</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">background</span></samp>’<dd>For server programs, run in the
background.
-
- <br><dt>‘<samp><span
class="samp">backward-search</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">basename</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">batch</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span class="samp">baud</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">before</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>tac</code>.
-
- <br><dt>‘<samp><span
class="samp">binary</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>cpio</code> and <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">bits-per-code</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">block-size</span></samp>’<dd>Used in <code>cpio</code> and
<code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">blocks</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>head</code> and <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">break-file</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">brief</span></samp>’<dd>Used in various programs to make
output shorter.
-
- <br><dt>‘<samp><span
class="samp">bytes</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>head</code>, <code>split</code>,
and <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">c</span><tt>++</tt></samp>’<dd>‘<samp><span
class="samp">-C</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">catenate</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span class="samp">cd</span></samp>’<dd>Used
in various programs to specify the directory to use.
-
- <br><dt>‘<samp><span
class="samp">changes</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>chgrp</code> and
<code>chown</code>.
-
- <br><dt>‘<samp><span
class="samp">classify</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">colons</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">command</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>su</code>;
-‘<samp><span class="samp">-x</span></samp>’ in GDB.
-
- <br><dt>‘<samp><span
class="samp">compare</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">compat</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">compress</span></samp>’<dd>‘<samp><span
class="samp">-Z</span></samp>’ in <code>tar</code> and <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">concatenate</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">confirmation</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">context</span></samp>’<dd>Used in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">copyleft</span></samp>’<dd>‘<samp><span
class="samp">-W copyleft</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">copyright</span></samp>’<dd>‘<samp><span
class="samp">-C</span></samp>’ in <code>ptx</code>, <code>recode</code>,
and <code>wdiff</code>;
-‘<samp><span class="samp">-W copyright</span></samp>’ in
<code>gawk</code>.
-
- <br><dt>‘<samp><span class="samp">core</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">count</span></samp>’<dd>‘<samp><span
class="samp">-q</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">count-links</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">create</span></samp>’<dd>Used in <code>tar</code> and
<code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">cut-mark</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">cxref</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">date</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">debug</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>make</code> and <code>m4</code>;
-‘<samp><span class="samp">-t</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">define</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">defines</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in Bison and <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">delete</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">dereference</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>chgrp</code>, <code>chown</code>,
<code>cpio</code>, <code>du</code>,
+</p>
+</dd>
+<dt>‘<samp>all-text</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>almost-all</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>append</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>etags</code>, <code>tee</code>,
<code>time</code>;
+‘<samp>-r</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>archive</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>cp</code>.
+</p>
+</dd>
+<dt>‘<samp>archive-name</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>arglength</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>ascii</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>assign</samp>’</dt>
+<dd><p>‘<samp>-v</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>assume-new</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>assume-old</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>auto-check</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>auto-pager</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>auto-reference</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>avoid-wraps</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>background</samp>’</dt>
+<dd><p>For server programs, run in the background.
+</p>
+</dd>
+<dt>‘<samp>backward-search</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>basename</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>batch</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>baud</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>before</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>tac</code>.
+</p>
+</dd>
+<dt>‘<samp>binary</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>cpio</code> and
<code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>bits-per-code</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>block-size</samp>’</dt>
+<dd><p>Used in <code>cpio</code> and <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>blocks</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>head</code> and
<code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>break-file</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>brief</samp>’</dt>
+<dd><p>Used in various programs to make output shorter.
+</p>
+</dd>
+<dt>‘<samp>bytes</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>head</code>, <code>split</code>,
and <code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>c<tt>++</tt></samp>’</dt>
+<dd><p>‘<samp>-C</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>catenate</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>cd</samp>’</dt>
+<dd><p>Used in various programs to specify the directory to use.
+</p>
+</dd>
+<dt>‘<samp>changes</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>chgrp</code> and
<code>chown</code>.
+</p>
+</dd>
+<dt>‘<samp>classify</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>colons</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>command</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>su</code>;
+‘<samp>-x</samp>’ in GDB.
+</p>
+</dd>
+<dt>‘<samp>compare</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>compat</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>compress</samp>’</dt>
+<dd><p>‘<samp>-Z</samp>’ in <code>tar</code> and <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>concatenate</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>confirmation</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>context</samp>’</dt>
+<dd><p>Used in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>copyleft</samp>’</dt>
+<dd><p>‘<samp>-W copyleft</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>copyright</samp>’</dt>
+<dd><p>‘<samp>-C</samp>’ in <code>ptx</code>, <code>recode</code>,
and <code>wdiff</code>;
+‘<samp>-W copyright</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>core</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>count</samp>’</dt>
+<dd><p>‘<samp>-q</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>count-links</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>create</samp>’</dt>
+<dd><p>Used in <code>tar</code> and <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>cut-mark</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>cxref</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>date</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>debug</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>make</code> and <code>m4</code>;
+‘<samp>-t</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>define</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>defines</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in Bison and <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>delete</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>dereference</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>chgrp</code>,
<code>chown</code>, <code>cpio</code>, <code>du</code>,
<code>ls</code>, and <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">dereference-args</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">device</span></samp>’<dd>Specify an I/O device (special file
name).
-
- <br><dt>‘<samp><span
class="samp">diacritics</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">dictionary-order</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>look</code>.
-
- <br><dt>‘<samp><span
class="samp">diff</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">digits</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">directory</span></samp>’<dd>Specify the directory to use, in
various programs. In <code>ls</code>, it
+</p>
+</dd>
+<dt>‘<samp>dereference-args</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>device</samp>’</dt>
+<dd><p>Specify an I/O device (special file name).
+</p>
+</dd>
+<dt>‘<samp>diacritics</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>dictionary-order</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>look</code>.
+</p>
+</dd>
+<dt>‘<samp>diff</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>digits</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>directory</samp>’</dt>
+<dd><p>Specify the directory to use, in various programs. In <code>ls</code>,
it
means to show directories themselves rather than their contents. In
<code>rm</code> and <code>ln</code>, it means to not treat links to directories
specially.
-
- <br><dt>‘<samp><span
class="samp">discard-all</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">discard-locals</span></samp>’<dd>‘<samp><span
class="samp">-X</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">dry-run</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">ed</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">elide-empty-files</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">end-delete</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">end-insert</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">entire-new-file</span></samp>’<dd>‘<samp><span
class="samp">-N</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">environment-overrides</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">eof</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">epoch</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">error-limit</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">error-output</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">escape</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">exclude-from</span></samp>’<dd>‘<samp><span
class="samp">-X</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span class="samp">exec</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">exit</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">exit-0</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>unshar</code>.
-
- <br><dt>‘<samp><span
class="samp">expand-tabs</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">expression</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>sed</code>.
-
- <br><dt>‘<samp><span
class="samp">extern-only</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">extract</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>cpio</code>;
-‘<samp><span class="samp">-x</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">faces</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>finger</code>.
-
- <br><dt>‘<samp><span
class="samp">fast</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">fatal-warnings</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">file</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>gawk</code>, <code>info</code>,
<code>make</code>, <code>mt</code>,
+</p>
+</dd>
+<dt>‘<samp>discard-all</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>discard-locals</samp>’</dt>
+<dd><p>‘<samp>-X</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>dry-run</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>ed</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>elide-empty-files</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>end-delete</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>end-insert</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>entire-new-file</samp>’</dt>
+<dd><p>‘<samp>-N</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>environment-overrides</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>eof</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>epoch</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>error-limit</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>error-output</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>escape</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>exclude-from</samp>’</dt>
+<dd><p>‘<samp>-X</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>exec</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>exit</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>exit-0</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>unshar</code>.
+</p>
+</dd>
+<dt>‘<samp>expand-tabs</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>expression</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>sed</code>.
+</p>
+</dd>
+<dt>‘<samp>extern-only</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>extract</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>cpio</code>;
+‘<samp>-x</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>faces</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>finger</code>.
+</p>
+</dd>
+<dt>‘<samp>fast</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>fatal-warnings</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>file</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>gawk</code>, <code>info</code>,
<code>make</code>, <code>mt</code>,
<code>sed</code>, and <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">field-separator</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">file-prefix</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">file-type</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">files-from</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">fill-column</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">flag-truncation</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">fixed-output-files</span></samp>’<dd>‘<samp><span
class="samp">-y</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">follow</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">footnote-style</span></samp>’<dd>Used in
<code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">force</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, and <code>rm</code>.
-
- <br><dt>‘<samp><span
class="samp">force-prefix</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">foreground</span></samp>’<dd>For server programs, run in the
foreground;
-in other words, don't do anything special to run the server
+</p>
+</dd>
+<dt>‘<samp>field-separator</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>file-prefix</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>file-type</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>files-from</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>fill-column</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>flag-truncation</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>fixed-output-files</samp>’</dt>
+<dd><p>‘<samp>-y</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>follow</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>footnote-style</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>force</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, and <code>rm</code>.
+</p>
+</dd>
+<dt>‘<samp>force-prefix</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>foreground</samp>’</dt>
+<dd><p>For server programs, run in the foreground;
+in other words, don’t do anything special to run the server
in the background.
-
- <br><dt>‘<samp><span
class="samp">format</span></samp>’<dd>Used in <code>ls</code>,
<code>time</code>, and <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">freeze-state</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">fullname</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">gap-size</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">get</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">graphic</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>ul</code>.
-
- <br><dt>‘<samp><span
class="samp">graphics</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">group</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>install</code>.
-
- <br><dt>‘<samp><span
class="samp">gzip</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>tar</code> and <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">hashsize</span></samp>’<dd>‘<samp><span
class="samp">-H</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">header</span></samp>’<dd>‘<samp><span
class="samp">-h</span></samp>’ in <code>objdump</code> and
<code>recode</code>
-
- <br><dt>‘<samp><span
class="samp">heading</span></samp>’<dd>‘<samp><span
class="samp">-H</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span class="samp">help</span></samp>’<dd>Used
to ask for brief usage information.
-
- <br><dt>‘<samp><span
class="samp">here-delimiter</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">hide-control-chars</span></samp>’<dd>‘<samp><span
class="samp">-q</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span class="samp">html</span></samp>’<dd>In
<code>makeinfo</code>, output HTML.
-
- <br><dt>‘<samp><span
class="samp">idle</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">ifdef</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>ls</code>;
-‘<samp><span class="samp">-x</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-all-space</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-backups</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-blank-lines</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-case</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>look</code> and <code>ptx</code>;
-‘<samp><span class="samp">-i</span></samp>’ in <code>diff</code>
and <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-errors</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-file</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-indentation</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-init-file</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in Oleo.
-
- <br><dt>‘<samp><span
class="samp">ignore-interrupts</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>tee</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-matching-lines</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-space-change</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-zeros</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">include</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>etags</code>;
-‘<samp><span class="samp">-I</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">include-dir</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">incremental</span></samp>’<dd>‘<samp><span
class="samp">-G</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">info</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’, ‘<samp><span
class="samp">-l</span></samp>’, and ‘<samp><span
class="samp">-m</span></samp>’ in Finger.
-
- <br><dt>‘<samp><span
class="samp">init-file</span></samp>’<dd>In some programs, specify the
name of the file to read as the user's
+</p>
+</dd>
+<dt>‘<samp>format</samp>’</dt>
+<dd><p>Used in <code>ls</code>, <code>time</code>, and <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>freeze-state</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>fullname</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>gap-size</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>get</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>graphic</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>ul</code>.
+</p>
+</dd>
+<dt>‘<samp>graphics</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>group</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>install</code>.
+</p>
+</dd>
+<dt>‘<samp>gzip</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>tar</code> and <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>hashsize</samp>’</dt>
+<dd><p>‘<samp>-H</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>header</samp>’</dt>
+<dd><p>‘<samp>-h</samp>’ in <code>objdump</code> and
<code>recode</code>
+</p>
+</dd>
+<dt>‘<samp>heading</samp>’</dt>
+<dd><p>‘<samp>-H</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>help</samp>’</dt>
+<dd><p>Used to ask for brief usage information.
+</p>
+</dd>
+<dt>‘<samp>here-delimiter</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>hide-control-chars</samp>’</dt>
+<dd><p>‘<samp>-q</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>html</samp>’</dt>
+<dd><p>In <code>makeinfo</code>, output HTML.
+</p>
+</dd>
+<dt>‘<samp>idle</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>ifdef</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>ls</code>;
+‘<samp>-x</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-all-space</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-backups</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-blank-lines</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-case</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>look</code> and <code>ptx</code>;
+‘<samp>-i</samp>’ in <code>diff</code> and <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-errors</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-file</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-indentation</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-init-file</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in Oleo.
+</p>
+</dd>
+<dt>‘<samp>ignore-interrupts</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>tee</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-matching-lines</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-space-change</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-zeros</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>include</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>etags</code>;
+‘<samp>-I</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>include-dir</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>incremental</samp>’</dt>
+<dd><p>‘<samp>-G</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>info</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’, ‘<samp>-l</samp>’, and
‘<samp>-m</samp>’ in Finger.
+</p>
+</dd>
+<dt>‘<samp>init-file</samp>’</dt>
+<dd><p>In some programs, specify the name of the file to read as the
user’s
init file.
-
- <br><dt>‘<samp><span
class="samp">initial</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>expand</code>.
-
- <br><dt>‘<samp><span
class="samp">initial-tab</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">inode</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">interactive</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, <code>rm</code>;
-‘<samp><span class="samp">-e</span></samp>’ in <code>m4</code>;
-‘<samp><span class="samp">-p</span></samp>’ in <code>xargs</code>;
-‘<samp><span class="samp">-w</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">intermix-type</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">iso-8601</span></samp>’<dd>Used in <code>date</code>
-
- <br><dt>‘<samp><span
class="samp">jobs</span></samp>’<dd>‘<samp><span
class="samp">-j</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">just-print</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">keep-going</span></samp>’<dd>‘<samp><span
class="samp">-k</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">keep-files</span></samp>’<dd>‘<samp><span
class="samp">-k</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">kilobytes</span></samp>’<dd>‘<samp><span
class="samp">-k</span></samp>’ in <code>du</code> and <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">language</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">less-mode</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">level-for-gzip</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">line-bytes</span></samp>’<dd>‘<samp><span
class="samp">-C</span></samp>’ in <code>split</code>.
-
- <br><dt>‘<samp><span
class="samp">lines</span></samp>’<dd>Used in <code>split</code>,
<code>head</code>, and <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">link</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">lint</span></samp>’<dt>‘<samp><span
class="samp">lint-old</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">list</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>cpio</code>;
-‘<samp><span class="samp">-l</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">list</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">literal</span></samp>’<dd>‘<samp><span
class="samp">-N</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">load-average</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">login</span></samp>’<dd>Used in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">machine</span></samp>’<dd>Used in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">macro-name</span></samp>’<dd>‘<samp><span
class="samp">-M</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">mail</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>hello</code> and
<code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">make-directories</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">makefile</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">mapped</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">max-args</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">max-chars</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">max-lines</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">max-load</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">max-procs</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">mesg</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">message</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">minimal</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">mixed-uuencode</span></samp>’<dd>‘<samp><span
class="samp">-M</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">mode</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>install</code>,
<code>mkdir</code>, and <code>mkfifo</code>.
-
- <br><dt>‘<samp><span
class="samp">modification-time</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">multi-volume</span></samp>’<dd>‘<samp><span
class="samp">-M</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">name-prefix</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">nesting-limit</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">net-headers</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">new-file</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">no-builtin-rules</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">no-character-count</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-check-existing</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-common</span></samp>’<dd>‘<samp><span
class="samp">-3</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">no-create</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">no-defines</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">no-deleted</span></samp>’<dd>‘<samp><span
class="samp">-1</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">no-dereference</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>cp</code>.
-
- <br><dt>‘<samp><span
class="samp">no-inserted</span></samp>’<dd>‘<samp><span
class="samp">-2</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">no-keep-going</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">no-lines</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">no-piping</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-prof</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">no-regex</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">no-sort</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">no-splash</span></samp>’<dd>Don't print a startup splash
screen.
-
- <br><dt>‘<samp><span
class="samp">no-split</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">no-static</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">no-time</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">no-timestamp</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-validate</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">no-wait</span></samp>’<dd>Used in <code>emacsclient</code>.
-
- <br><dt>‘<samp><span
class="samp">no-warn</span></samp>’<dd>Used in various programs to
inhibit warnings.
-
- <br><dt>‘<samp><span
class="samp">node</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>info</code>.
-
- <br><dt>‘<samp><span
class="samp">nodename</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">nonmatching</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">nstuff</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>objdump</code>.
-
- <br><dt>‘<samp><span
class="samp">null</span></samp>’<dd>‘<samp><span
class="samp">-0</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">number</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">number-nonblank</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">numeric-sort</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">numeric-uid-gid</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>cpio</code> and <code>ls</code>.
-
- <br><dt>‘<samp><span class="samp">nx</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">old-archive</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">old-file</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">one-file-system</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>tar</code>, <code>cp</code>, and
<code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">only-file</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">only-prof</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">only-time</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">options</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>getopt</code>,
<code>fdlist</code>, <code>fdmount</code>,
+</p>
+</dd>
+<dt>‘<samp>initial</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>expand</code>.
+</p>
+</dd>
+<dt>‘<samp>initial-tab</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>inode</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>interactive</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, <code>rm</code>;
+‘<samp>-e</samp>’ in <code>m4</code>;
+‘<samp>-p</samp>’ in <code>xargs</code>;
+‘<samp>-w</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>intermix-type</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>iso-8601</samp>’</dt>
+<dd><p>Used in <code>date</code>
+</p>
+</dd>
+<dt>‘<samp>jobs</samp>’</dt>
+<dd><p>‘<samp>-j</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>just-print</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>keep-going</samp>’</dt>
+<dd><p>‘<samp>-k</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>keep-files</samp>’</dt>
+<dd><p>‘<samp>-k</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>kilobytes</samp>’</dt>
+<dd><p>‘<samp>-k</samp>’ in <code>du</code> and <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>language</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>less-mode</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>level-for-gzip</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>line-bytes</samp>’</dt>
+<dd><p>‘<samp>-C</samp>’ in <code>split</code>.
+</p>
+</dd>
+<dt>‘<samp>lines</samp>’</dt>
+<dd><p>Used in <code>split</code>, <code>head</code>, and <code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>link</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>lint</samp>’</dt>
+<dt>‘<samp>lint-old</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>list</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>cpio</code>;
+‘<samp>-l</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>list</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>literal</samp>’</dt>
+<dd><p>‘<samp>-N</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>load-average</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>login</samp>’</dt>
+<dd><p>Used in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>machine</samp>’</dt>
+<dd><p>Used in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>macro-name</samp>’</dt>
+<dd><p>‘<samp>-M</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>mail</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>hello</code> and
<code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>make-directories</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>makefile</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>mapped</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>max-args</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>max-chars</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>max-lines</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>max-load</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>max-procs</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>mesg</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>message</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>minimal</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>mixed-uuencode</samp>’</dt>
+<dd><p>‘<samp>-M</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>mode</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>install</code>,
<code>mkdir</code>, and <code>mkfifo</code>.
+</p>
+</dd>
+<dt>‘<samp>modification-time</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>multi-volume</samp>’</dt>
+<dd><p>‘<samp>-M</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>name-prefix</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>nesting-limit</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>net-headers</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>new-file</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>no-builtin-rules</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>no-character-count</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-check-existing</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-common</samp>’</dt>
+<dd><p>‘<samp>-3</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>no-create</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>no-defines</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>no-deleted</samp>’</dt>
+<dd><p>‘<samp>-1</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>no-dereference</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>cp</code>.
+</p>
+</dd>
+<dt>‘<samp>no-inserted</samp>’</dt>
+<dd><p>‘<samp>-2</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>no-keep-going</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>no-lines</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>no-piping</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-prof</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>no-regex</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>no-sort</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>no-splash</samp>’</dt>
+<dd><p>Don’t print a startup splash screen.
+</p>
+</dd>
+<dt>‘<samp>no-split</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>no-static</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>no-time</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>no-timestamp</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-validate</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>no-wait</samp>’</dt>
+<dd><p>Used in <code>emacsclient</code>.
+</p>
+</dd>
+<dt>‘<samp>no-warn</samp>’</dt>
+<dd><p>Used in various programs to inhibit warnings.
+</p>
+</dd>
+<dt>‘<samp>node</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>info</code>.
+</p>
+</dd>
+<dt>‘<samp>nodename</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>nonmatching</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>nstuff</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>objdump</code>.
+</p>
+</dd>
+<dt>‘<samp>null</samp>’</dt>
+<dd><p>‘<samp>-0</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>number</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>number-nonblank</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>numeric-sort</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>numeric-uid-gid</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>cpio</code> and <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>nx</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>old-archive</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>old-file</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>one-file-system</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>tar</code>, <code>cp</code>, and
<code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>only-file</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>only-prof</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>only-time</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>options</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>getopt</code>,
<code>fdlist</code>, <code>fdmount</code>,
<code>fdmountd</code>, and <code>fdumount</code>.
-
- <br><dt>‘<samp><span class="samp">output</span></samp>’<dd>In
various programs, specify the output file name.
-
- <br><dt>‘<samp><span
class="samp">output-prefix</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">override</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>rm</code>.
-
- <br><dt>‘<samp><span
class="samp">overwrite</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>unshar</code>.
-
- <br><dt>‘<samp><span
class="samp">owner</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>install</code>.
-
- <br><dt>‘<samp><span
class="samp">paginate</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">paragraph-indent</span></samp>’<dd>Used in
<code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">parents</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>mkdir</code> and
<code>rmdir</code>.
-
- <br><dt>‘<samp><span
class="samp">pass-all</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>ul</code>.
-
- <br><dt>‘<samp><span
class="samp">pass-through</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">port</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>finger</code>.
-
- <br><dt>‘<samp><span
class="samp">portability</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>cpio</code> and <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">posix</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">prefix-builtins</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">prefix</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve</span></samp>’<dd>Used in <code>tar</code> and
<code>cp</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-environment</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-modification-time</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-order</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-permissions</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">print</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">print-chars</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>cmp</code>.
-
- <br><dt>‘<samp><span
class="samp">print-data-base</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">print-directory</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">print-file-name</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">print-symdefs</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">printer</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">prompt</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>ed</code>.
-
- <br><dt>‘<samp><span
class="samp">proxy</span></samp>’<dd>Specify an HTTP proxy.
-
- <br><dt>‘<samp><span
class="samp">query-user</span></samp>’<dd>‘<samp><span
class="samp">-X</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">question</span></samp>’<dd>‘<samp><span
class="samp">-q</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">quiet</span></samp>’<dd>Used in many programs to inhibit the
usual output. Every
-program accepting ‘<samp><span class="samp">--quiet</span></samp>’
should accept ‘<samp><span class="samp">--silent</span></samp>’ as a
+</p>
+</dd>
+<dt>‘<samp>output</samp>’</dt>
+<dd><p>In various programs, specify the output file name.
+</p>
+</dd>
+<dt>‘<samp>output-prefix</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>override</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>rm</code>.
+</p>
+</dd>
+<dt>‘<samp>overwrite</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>unshar</code>.
+</p>
+</dd>
+<dt>‘<samp>owner</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>install</code>.
+</p>
+</dd>
+<dt>‘<samp>paginate</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>paragraph-indent</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>parents</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>mkdir</code> and
<code>rmdir</code>.
+</p>
+</dd>
+<dt>‘<samp>pass-all</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>ul</code>.
+</p>
+</dd>
+<dt>‘<samp>pass-through</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>port</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>finger</code>.
+</p>
+</dd>
+<dt>‘<samp>portability</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>cpio</code> and <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>posix</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>prefix-builtins</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>prefix</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve</samp>’</dt>
+<dd><p>Used in <code>tar</code> and <code>cp</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-environment</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-modification-time</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-order</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-permissions</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>print</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>print-chars</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>cmp</code>.
+</p>
+</dd>
+<dt>‘<samp>print-data-base</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>print-directory</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>print-file-name</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>print-symdefs</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>printer</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>prompt</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>ed</code>.
+</p>
+</dd>
+<dt>‘<samp>proxy</samp>’</dt>
+<dd><p>Specify an HTTP proxy.
+</p>
+</dd>
+<dt>‘<samp>query-user</samp>’</dt>
+<dd><p>‘<samp>-X</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>question</samp>’</dt>
+<dd><p>‘<samp>-q</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>quiet</samp>’</dt>
+<dd><p>Used in many programs to inhibit the usual output. Every
+program accepting ‘<samp>--quiet</samp>’ should accept
‘<samp>--silent</samp>’ as a
synonym.
-
- <br><dt>‘<samp><span
class="samp">quiet-unshar</span></samp>’<dd>‘<samp><span
class="samp">-Q</span></samp>’ in <code>shar</code>
-
- <br><dt>‘<samp><span
class="samp">quote-name</span></samp>’<dd>‘<samp><span
class="samp">-Q</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">rcs</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">re-interval</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">read-full-blocks</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">readnow</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">recon</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">record-number</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">recursive</span></samp>’<dd>Used in <code>chgrp</code>,
<code>chown</code>, <code>cp</code>, <code>ls</code>, <code>diff</code>,
+</p>
+</dd>
+<dt>‘<samp>quiet-unshar</samp>’</dt>
+<dd><p>‘<samp>-Q</samp>’ in <code>shar</code>
+</p>
+</dd>
+<dt>‘<samp>quote-name</samp>’</dt>
+<dd><p>‘<samp>-Q</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>rcs</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>re-interval</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>read-full-blocks</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>readnow</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>recon</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>record-number</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>recursive</samp>’</dt>
+<dd><p>Used in <code>chgrp</code>, <code>chown</code>, <code>cp</code>,
<code>ls</code>, <code>diff</code>,
and <code>rm</code>.
-
- <br><dt>‘<samp><span
class="samp">reference</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">references</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">regex</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>tac</code> and <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">release</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">reload-state</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">relocation</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>objdump</code>.
-
- <br><dt>‘<samp><span
class="samp">rename</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">replace</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">report-identical-files</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">reset-access-time</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">reverse</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>ls</code> and <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">reversed-ed</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">right-side-defs</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">same-order</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">same-permissions</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">save</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>stty</code>.
-
- <br><dt>‘<samp><span class="samp">se</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">sentence-regexp</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">separate-dirs</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">separator</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>tac</code>.
-
- <br><dt>‘<samp><span
class="samp">sequence</span></samp>’<dd>Used by <code>recode</code> to
chose files or pipes for sequencing passes.
-
- <br><dt>‘<samp><span
class="samp">shell</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">show-all</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">show-c-function</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">show-ends</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">show-function-line</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">show-tabs</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">silent</span></samp>’<dd>Used in many programs to inhibit
the usual output.
+</p>
+</dd>
+<dt>‘<samp>reference</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>references</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>regex</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>tac</code> and
<code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>release</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>reload-state</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>relocation</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>objdump</code>.
+</p>
+</dd>
+<dt>‘<samp>rename</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>replace</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>report-identical-files</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>reset-access-time</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>reverse</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>ls</code> and <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>reversed-ed</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>right-side-defs</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>same-order</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>same-permissions</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>save</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>stty</code>.
+</p>
+</dd>
+<dt>‘<samp>se</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>sentence-regexp</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>separate-dirs</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>separator</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>tac</code>.
+</p>
+</dd>
+<dt>‘<samp>sequence</samp>’</dt>
+<dd><p>Used by <code>recode</code> to chose files or pipes for sequencing
passes.
+</p>
+</dd>
+<dt>‘<samp>shell</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>show-all</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>show-c-function</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>show-ends</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>show-function-line</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>show-tabs</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>silent</samp>’</dt>
+<dd><p>Used in many programs to inhibit the usual output.
Every program accepting
-‘<samp><span class="samp">--silent</span></samp>’ should accept
‘<samp><span class="samp">--quiet</span></samp>’ as a synonym.
-
- <br><dt>‘<samp><span
class="samp">size</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">socket</span></samp>’<dd>Specify a file descriptor for a
network server to use for its socket,
+‘<samp>--silent</samp>’ should accept
‘<samp>--quiet</samp>’ as a synonym.
+</p>
+</dd>
+<dt>‘<samp>size</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>socket</samp>’</dt>
+<dd><p>Specify a file descriptor for a network server to use for its socket,
instead of opening and binding a new socket. This provides a way to
run, in a non-privileged process, a server that normally needs a
reserved port number.
-
- <br><dt>‘<samp><span class="samp">sort</span></samp>’<dd>Used
in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">source</span></samp>’<dd>‘<samp><span class="samp">-W
source</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">sparse</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">speed-large-files</span></samp>’<dd>‘<samp><span
class="samp">-H</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">split-at</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>unshar</code>.
-
- <br><dt>‘<samp><span
class="samp">split-size-limit</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">squeeze-blank</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">start-delete</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">start-insert</span></samp>’<dd>‘<samp><span
class="samp">-y</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">starting-file</span></samp>’<dd>Used in <code>tar</code> and
<code>diff</code> to specify which file within
+</p>
+</dd>
+<dt>‘<samp>sort</samp>’</dt>
+<dd><p>Used in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>source</samp>’</dt>
+<dd><p>‘<samp>-W source</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>sparse</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>speed-large-files</samp>’</dt>
+<dd><p>‘<samp>-H</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>split-at</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>unshar</code>.
+</p>
+</dd>
+<dt>‘<samp>split-size-limit</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>squeeze-blank</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>start-delete</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>start-insert</samp>’</dt>
+<dd><p>‘<samp>-y</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>starting-file</samp>’</dt>
+<dd><p>Used in <code>tar</code> and <code>diff</code> to specify which file
within
a directory to start processing with.
-
- <br><dt>‘<samp><span
class="samp">statistics</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">stdin-file-list</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">stop</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">strict</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">strip</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>install</code>.
-
- <br><dt>‘<samp><span
class="samp">strip-all</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">strip-debug</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">submitter</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">suffix</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
-
- <br><dt>‘<samp><span
class="samp">suffix-format</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">sum</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">summarize</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">symbolic</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>ln</code>.
-
- <br><dt>‘<samp><span
class="samp">symbols</span></samp>’<dd>Used in GDB and
<code>objdump</code>.
-
- <br><dt>‘<samp><span
class="samp">synclines</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">sysname</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">tabs</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>expand</code> and
<code>unexpand</code>.
-
- <br><dt>‘<samp><span
class="samp">tabsize</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">terminal</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>tput</code> and <code>ul</code>.
-‘<samp><span class="samp">-t</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">text</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">text-files</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span class="samp">time</span></samp>’<dd>Used
in <code>ls</code> and <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">timeout</span></samp>’<dd>Specify how long to wait before
giving up on some operation.
-
- <br><dt>‘<samp><span
class="samp">to-stdout</span></samp>’<dd>‘<samp><span
class="samp">-O</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">total</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">touch</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>make</code>, <code>ranlib</code>,
and <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">trace</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">traditional</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>hello</code>;
-‘<samp><span class="samp">-W traditional</span></samp>’ in
<code>gawk</code>;
-‘<samp><span class="samp">-G</span></samp>’ in <code>ed</code>,
<code>m4</code>, and <code>ptx</code>.
-
- <br><dt>‘<samp><span class="samp">tty</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">typedefs</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">typedefs-and-c++</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">typeset-mode</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">uncompress</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">unconditional</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">undefine</span></samp>’<dd>‘<samp><span
class="samp">-U</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">undefined-only</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">update</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>cp</code>, <code>ctags</code>,
<code>mv</code>, <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">usage</span></samp>’<dd>Used in <code>gawk</code>; same as
‘<samp><span class="samp">--help</span></samp>’.
-
- <br><dt>‘<samp><span
class="samp">uuencode</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">vanilla-operation</span></samp>’<dd>‘<samp><span
class="samp">-V</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">verbose</span></samp>’<dd>Print more information about
progress. Many programs support this.
-
- <br><dt>‘<samp><span
class="samp">verify</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">version</span></samp>’<dd>Print the version number.
-
- <br><dt>‘<samp><span
class="samp">version-control</span></samp>’<dd>‘<samp><span
class="samp">-V</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
-
- <br><dt>‘<samp><span
class="samp">vgrind</span></samp>’<dd>‘<samp><span
class="samp">-v</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">volume</span></samp>’<dd>‘<samp><span
class="samp">-V</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">what-if</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">whole-size-limit</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">width</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>ls</code> and <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">word-regexp</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">writable</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">zeros</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>statistics</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>stdin-file-list</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>stop</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>strict</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>strip</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>install</code>.
+</p>
+</dd>
+<dt>‘<samp>strip-all</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>strip-debug</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>submitter</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>suffix</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
+</p>
+</dd>
+<dt>‘<samp>suffix-format</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>sum</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>summarize</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>symbolic</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>ln</code>.
+</p>
+</dd>
+<dt>‘<samp>symbols</samp>’</dt>
+<dd><p>Used in GDB and <code>objdump</code>.
+</p>
+</dd>
+<dt>‘<samp>synclines</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>sysname</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>tabs</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>expand</code> and
<code>unexpand</code>.
+</p>
+</dd>
+<dt>‘<samp>tabsize</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>terminal</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>tput</code> and <code>ul</code>.
+‘<samp>-t</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>text</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>text-files</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>time</samp>’</dt>
+<dd><p>Used in <code>ls</code> and <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>timeout</samp>’</dt>
+<dd><p>Specify how long to wait before giving up on some operation.
+</p>
+</dd>
+<dt>‘<samp>to-stdout</samp>’</dt>
+<dd><p>‘<samp>-O</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>total</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>touch</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>make</code>,
<code>ranlib</code>, and <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>trace</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>traditional</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>hello</code>;
+‘<samp>-W traditional</samp>’ in <code>gawk</code>;
+‘<samp>-G</samp>’ in <code>ed</code>, <code>m4</code>, and
<code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>tty</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>typedefs</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>typedefs-and-c++</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>typeset-mode</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>uncompress</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>unconditional</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>undefine</samp>’</dt>
+<dd><p>‘<samp>-U</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>undefined-only</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>update</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>cp</code>, <code>ctags</code>,
<code>mv</code>, <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>usage</samp>’</dt>
+<dd><p>Used in <code>gawk</code>; same as ‘<samp>--help</samp>’.
+</p>
+</dd>
+<dt>‘<samp>uuencode</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>vanilla-operation</samp>’</dt>
+<dd><p>‘<samp>-V</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>verbose</samp>’</dt>
+<dd><p>Print more information about progress. Many programs support this.
+</p>
+</dd>
+<dt>‘<samp>verify</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>version</samp>’</dt>
+<dd><p>Print the version number.
+</p>
+</dd>
+<dt>‘<samp>version-control</samp>’</dt>
+<dd><p>‘<samp>-V</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
+</p>
+</dd>
+<dt>‘<samp>vgrind</samp>’</dt>
+<dd><p>‘<samp>-v</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>volume</samp>’</dt>
+<dd><p>‘<samp>-V</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>what-if</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>whole-size-limit</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>width</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>ls</code> and <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>word-regexp</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>writable</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>zeros</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>gprof</code>.
+</p></dd>
</dl>
-<div class="node">
+<hr>
<a name="OID-Allocations"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Memory-Usage">Memory Usage</a>,
-Previous: <a rel="previous" accesskey="p" href="#Option-Table">Option
Table</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Next: <a href="#Memory-Usage" accesskey="n" rel="next">Memory Usage</a>,
Previous: <a href="#Option-Table" accesskey="p" rel="previous">Option
Table</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="OID-Allocations-1"></a>
<h3 class="section">4.10 OID Allocations</h3>
+<a name="index-OID-allocations-for-GNU"></a>
+<a name="index-SNMP"></a>
+<a name="index-LDAP"></a>
+<a name="index-X_002e509"></a>
-<p><a name="index-OID-allocations-for-GNU-68"></a><a
name="index-SNMP-69"></a><a name="index-LDAP-70"></a><a
name="index-X_002e509-71"></a>
-The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the
+<p>The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the
GNU Project (thanks to Werner Koch). These are used for SNMP, LDAP,
X.509 certificates, and so on. The web site
<a
href="http://www.alvestrand.no/objectid";>http://www.alvestrand.no/objectid</a>
has a (voluntary) listing of
many OID assignments.
-
- <p>If you need a new slot for your GNU package, write
+</p>
+<p>If you need a new slot for your GNU package, write
<a href="mailto:address@hidden";>address@hidden</a>. Here is a list of arcs
currently
assigned:
+</p>
+<div class="example">
+<pre class="example">
+1.3.6.1.4.1.11591 GNU
-<pre class="example"> <!-- This table of OID's is included in the GNU
Coding Standards. -->
- <!-- Copyright 2008, 2009, 2010 Free Software Foundation, Inc. -->
- <!-- Copying and distribution of this file, with or without modification,
-->
- <!-- are permitted in any medium without royalty provided the copyright
-->
- <!-- notice and this notice are preserved. -->
- <!-- When adding new OIDs, please add them also to -->
- <!-- http://www.alvestrand.no/objectid/ (except it gets an internal -->
- <!-- server error, so never mind) -->
- <!-- (Our page is
http://www.alvestrand.no/objectid/1.3.6.1.4.1.11591.html.) -->
-
- 1.3.6.1.4.1.11591 GNU
-
- 1.3.6.1.4.1.11591.1 GNU Radius
+1.3.6.1.4.1.11591.1 GNU Radius
- 1.3.6.1.4.1.11591.2 GnuPG
+1.3.6.1.4.1.11591.2 GnuPG
1.3.6.1.4.1.11591.2.1 notation
1.3.6.1.4.1.11591.2.1.1 pkaAddress
- 1.3.6.1.4.1.11591.3 GNU Radar
+1.3.6.1.4.1.11591.3 GNU Radar
- 1.3.6.1.4.1.11591.4 GNU GSS
+1.3.6.1.4.1.11591.4 GNU GSS
- <!-- Added 2008-10-24 on request from Sergey Poznyakoff <address@hidden>
-->
- 1.3.6.1.4.1.11591.5 GNU Mailutils
+1.3.6.1.4.1.11591.5 GNU Mailutils
- <!-- Added 2009-03-03 on request from Simon Josefsson <address@hidden> -->
- 1.3.6.1.4.1.11591.6 GNU Shishi
+1.3.6.1.4.1.11591.6 GNU Shishi
- <!-- Added 2010-05-17 on request from Eric Blossom <address@hidden> -->
- 1.3.6.1.4.1.11591.7 GNU Radio
+1.3.6.1.4.1.11591.7 GNU Radio
- <!-- Added 2010-07-02 on request from Sergey Poznyakoff <address@hidden>
-->
- 1.3.6.1.4.1.11591.8 GNU Dico
+1.3.6.1.4.1.11591.8 GNU Dico
- 1.3.6.1.4.1.11591.12 digestAlgorithm
+1.3.6.1.4.1.11591.12 digestAlgorithm
1.3.6.1.4.1.11591.12.2 TIGER/192
1.3.6.1.4.1.11591.13 encryptionAlgorithm
1.3.6.1.4.1.11591.13.2 Serpent
@@ -2148,173 +2985,199 @@
1.3.6.1.4.1.11591.13.2.44 Serpent-256-CFB
1.3.6.1.4.1.11591.14 CRC algorithms
1.3.6.1.4.1.11591.14.1 CRC 32
-</pre>
- <div class="node">
-<a name="Memory-Usage"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#File-Usage">File Usage</a>,
-Previous: <a rel="previous" accesskey="p" href="#OID-Allocations">OID
Allocations</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
+</pre></div>
-</div>
+<hr>
+<a name="Memory-Usage"></a>
+<div class="header">
+<p>
+Next: <a href="#File-Usage" accesskey="n" rel="next">File Usage</a>, Previous:
<a href="#OID-Allocations" accesskey="p" rel="previous">OID Allocations</a>,
Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program Behavior</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+<a name="Memory-Usage-1"></a>
<h3 class="section">4.11 Memory Usage</h3>
+<a name="index-memory-usage"></a>
-<p><a name="index-memory-usage-72"></a>
-If a program typically uses just a few meg of memory, don't bother making any
+<p>If a program typically uses just a few meg of memory, don’t bother
making any
effort to reduce memory usage. For example, if it is impractical for
other reasons to operate on files more than a few meg long, it is
reasonable to read entire input files into memory to operate on them.
-
- <p>However, for programs such as <code>cat</code> or <code>tail</code>,
that can
+</p>
+<p>However, for programs such as <code>cat</code> or <code>tail</code>, that
can
usefully operate on very large files, it is important to avoid using a
technique that would artificially limit the size of files it can handle.
If a program works by lines and could be applied to arbitrary
user-supplied input files, it should keep only a line in memory, because
this is not very hard and users will want to be able to operate on input
files that are bigger than will fit in memory all at once.
-
- <p>If your program creates complicated data structures, just make them in
+</p>
+<p>If your program creates complicated data structures, just make them in
memory and give a fatal error if <code>malloc</code> returns zero.
-
- <p><a name="index-valgrind-73"></a><a
name="index-memory-leak-74"></a>Memory analysis tools such as <samp><span
class="command">valgrind</span></samp> can be useful, but
-don't complicate a program merely to avoid their false alarms. For
-example, if memory is used until just before a process exits, don't
+</p>
+<a name="index-valgrind"></a>
+<a name="index-memory-leak"></a>
+<p>Memory analysis tools such as <code>valgrind</code> can be useful, but
+don’t complicate a program merely to avoid their false alarms. For
+example, if memory is used until just before a process exits, don’t
free it simply to silence such a tool.
+</p>
-<div class="node">
+<hr>
<a name="File-Usage"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p" href="#Memory-Usage">Memory
Usage</a>,
-Up: <a rel="up" accesskey="u" href="#Program-Behavior">Program
Behavior</a>
-
+<div class="header">
+<p>
+Previous: <a href="#Memory-Usage" accesskey="p" rel="previous">Memory
Usage</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="File-Usage-1"></a>
<h3 class="section">4.12 File Usage</h3>
+<a name="index-file-usage"></a>
-<p><a name="index-file-usage-75"></a>
-Programs should be prepared to operate when <samp><span
class="file">/usr</span></samp> and <samp><span class="file">/etc</span></samp>
+<p>Programs should be prepared to operate when ‘<tt>/usr</tt>’ and
‘<tt>/etc</tt>’
are read-only file systems. Thus, if the program manages log files,
lock files, backup files, score files, or any other files which are
modified for internal purposes, these files should not be stored in
-<samp><span class="file">/usr</span></samp> or <samp><span
class="file">/etc</span></samp>.
-
- <p>There are two exceptions. <samp><span class="file">/etc</span></samp>
is used to store system
+‘<tt>/usr</tt>’ or ‘<tt>/etc</tt>’.
+</p>
+<p>There are two exceptions. ‘<tt>/etc</tt>’ is used to store
system
configuration information; it is reasonable for a program to modify
-files in <samp><span class="file">/etc</span></samp> when its job is to update
the system configuration.
+files in ‘<tt>/etc</tt>’ when its job is to update the system
configuration.
Also, if the user explicitly asks to modify one file in a directory, it
is reasonable for the program to store other files in the same
directory.
-
-<div class="node">
+</p>
+<hr>
<a name="Writing-C"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Documentation">Documentation</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Program-Behavior">Program Behavior</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#Documentation" accesskey="n" rel="next">Documentation</a>,
Previous: <a href="#Program-Behavior" accesskey="p" rel="previous">Program
Behavior</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Making-The-Best-Use-of-C"></a>
<h2 class="chapter">5 Making The Best Use of C</h2>
<p>This chapter provides advice on how best to use the C language
when writing GNU software.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Formatting"
accesskey="1">Formatting</a>:</td><td> </td><td align="left"
valign="top">Formatting your source code.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Comments"
accesskey="2">Comments</a>:</td><td> </td><td align="left"
valign="top">Commenting your work.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Syntactic-Conventions"
accesskey="3">Syntactic Conventions</a>:</td><td> </td><td
align="left" valign="top">Clean use of C constructs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Names"
accesskey="4">Names</a>:</td><td> </td><td align="left"
valign="top">Naming variables, functions, and files.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#System-Portability"
accesskey="5">System Portability</a>:</td><td> </td><td align="left"
valign="top">Portability among different operating systems.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#CPU-Portability"
accesskey="6">CPU Portability</a>:</td><td> </td><td align="left"
valign="top">Supporting the range of CPU types.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#System-Functions"
accesskey="7">System Functions</a>:</td><td> </td><td align="left"
valign="top">Portability and “standard” library functions.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Internationalization"
accesskey="8">Internationalization</a>:</td><td> </td><td
align="left" valign="top">Techniques for internationalization.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Character-Set"
accesskey="9">Character Set</a>:</td><td> </td><td align="left"
valign="top">Use ASCII by default.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Quote-Characters">Quote
Characters</a>:</td><td> </td><td align="left" valign="top">Use
"..." or ’...’ in the C locale.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="#Mmap">Mmap</a>:</td><td> </td><td align="left"
valign="top">How you can safely use <code>mmap</code>.
+</td></tr>
+</table>
-<ul class="menu">
-<li><a accesskey="1" href="#Formatting">Formatting</a>:
Formatting your source code.
-<li><a accesskey="2" href="#Comments">Comments</a>:
Commenting your work.
-<li><a accesskey="3" href="#Syntactic-Conventions">Syntactic Conventions</a>:
Clean use of C constructs.
-<li><a accesskey="4" href="#Names">Names</a>: Naming
variables, functions, and files.
-<li><a accesskey="5" href="#System-Portability">System Portability</a>:
Portability among different operating systems.
-<li><a accesskey="6" href="#CPU-Portability">CPU Portability</a>:
Supporting the range of CPU types.
-<li><a accesskey="7" href="#System-Functions">System Functions</a>:
Portability and ``standard'' library functions.
-<li><a accesskey="8" href="#Internationalization">Internationalization</a>:
Techniques for internationalization.
-<li><a accesskey="9" href="#Character-Set">Character Set</a>:
Use ASCII by default.
-<li><a href="#Quote-Characters">Quote Characters</a>: Use "..." or
'...' in the C locale.
-<li><a href="#Mmap">Mmap</a>: How you can safely use
<code>mmap</code>.
-</ul>
-
-<div class="node">
+<hr>
<a name="Formatting"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Comments">Comments</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#Comments" accesskey="n" rel="next">Comments</a>, Up: <a
href="#Writing-C" accesskey="u" rel="up">Writing C</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Formatting-Your-Source-Code"></a>
<h3 class="section">5.1 Formatting Your Source Code</h3>
+<a name="index-formatting-source-code"></a>
-<p><a name="index-formatting-source-code-76"></a>
-<a name="index-open-brace-77"></a><a
name="index-braces_002c-in-C-source-78"></a><a
name="index-function-definitions_002c-formatting-79"></a>It is important to put
the open-brace that starts the body of a C
+<a name="index-open-brace"></a>
+<a name="index-braces_002c-in-C-source"></a>
+<a name="index-function-definitions_002c-formatting"></a>
+<p>It is important to put the open-brace that starts the body of a C
function in column one, so that they will start a defun. Several
tools look for open-braces in column one to find the beginnings of C
functions. These tools will not work on code not formatted that way.
-
- <p>Avoid putting open-brace, open-parenthesis or open-bracket in column
-one when they are inside a function, so that they won't start a defun.
+</p>
+<p>Avoid putting open-brace, open-parenthesis or open-bracket in column
+one when they are inside a function, so that they won’t start a defun.
The open-brace that starts a <code>struct</code> body can go in column one
if you find it useful to treat that definition as a defun.
-
- <p>It is also important for function definitions to start the name of the
+</p>
+<p>It is also important for function definitions to start the name of the
function in column one. This helps people to search for function
definitions, and may also help certain tools recognize them. Thus,
using Standard C syntax, the format is this:
+</p>
+<div class="example">
+<pre class="example">static char *
+concat (char *s1, char *s2)
+{
+ …
+}
+</pre></div>
-<pre class="example"> static char *
- concat (char *s1, char *s2)
- {
- ...
- }
-</pre>
- <p class="noindent">or, if you want to use traditional C syntax, format the
definition like
+<p>or, if you want to use traditional C syntax, format the definition like
this:
-
-<pre class="example"> static char *
- concat (s1, s2) /* Name starts in column one here */
+</p>
+<div class="example">
+<pre class="example">static char *
+concat (s1, s2) /* Name starts in column one here */
char *s1, *s2;
- { /* Open brace in column one here */
- ...
- }
-</pre>
- <p>In Standard C, if the arguments don't fit nicely on one line,
-split it like this:
+{ /* Open brace in column one here */
+ …
+}
+</pre></div>
-<pre class="example"> int
- lots_of_args (int an_integer, long a_long, short a_short,
+<p>In Standard C, if the arguments don’t fit nicely on one line,
+split it like this:
+</p>
+<div class="example">
+<pre class="example">int
+lots_of_args (int an_integer, long a_long, short a_short,
double a_double, float a_float)
- ...
-</pre>
- <p><a
name="index-g_t_0040code_007bstruct_007d-types_002c-formatting-80"></a><a
name="index-g_t_0040code_007benum_007d-types_002c-formatting-81"></a>For
<code>struct</code> and <code>enum</code> types, likewise put the braces in
-column one, unless the whole contents fits on one line:
+…
+</pre></div>
-<pre class="example"> struct foo
- {
+<a name="index-struct-types_002c-formatting"></a>
+<a name="index-enum-types_002c-formatting"></a>
+<p>For <code>struct</code> and <code>enum</code> types, likewise put the
braces in
+column one, unless the whole contents fits on one line:
+</p>
+<div class="example">
+<pre class="example">struct foo
+{
int a, b;
- }
-<br><span class="roman">or</span><br>
- struct foo { int a, b; }
-</pre>
- <p>The rest of this section gives our recommendations for other aspects of
+}
+</pre><pre class="example"><span class="roman">or</span>
+</pre><pre class="example">struct foo { int a, b; }
+</pre></div>
+
+<p>The rest of this section gives our recommendations for other aspects of
C formatting style, which is also the default style of the <code>indent</code>
program in version 1.2 and newer. It corresponds to the options
+</p>
+<div class="smallexample">
+<pre class="smallexample">-nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce -cp1
-cs -di2
+-ndj -nfc1 -nfca -hnl -i2 -ip5 -lp -pcs -psl -nsc -nsob
+</pre></div>
-<pre class="smallexample"> -nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce
-cp1 -cs -di2
- -ndj -nfc1 -nfca -hnl -i2 -ip5 -lp -pcs -psl -nsc -nsob
-</pre>
- <p>We don't think of these recommendations as requirements, because it
+<p>We don’t think of these recommendations as requirements, because it
causes no problems for users if two different programs have different
formatting styles.
-
- <p>But whatever style you use, please use it consistently, since a mixture
+</p>
+<p>But whatever style you use, please use it consistently, since a mixture
of styles within one program tends to look ugly. If you are
contributing changes to an existing program, please follow the style of
that program.
-
- <p>For the body of the function, our recommended style looks like this:
-
-<pre class="example"> if (x < foo (y, z))
+</p>
+<p>For the body of the function, our recommended style looks like this:
+</p>
+<div class="example">
+<pre class="example">if (x < foo (y, z))
haha = bar[4] + 5;
- else
+else
{
while (z)
{
@@ -2323,84 +3186,98 @@
}
return ++x + bar ();
}
-</pre>
- <p><a name="index-spaces-before-open_002dparen-82"></a>We find it easier to
read a program when it has spaces before the
-open-parentheses and after the commas. Especially after the commas.
+</pre></div>
- <p>When you split an expression into multiple lines, split it
+<a name="index-spaces-before-open_002dparen"></a>
+<p>We find it easier to read a program when it has spaces before the
+open-parentheses and after the commas. Especially after the commas.
+</p>
+<p>When you split an expression into multiple lines, split it
before an operator, not after one. Here is the right way:
-
- <p><a name="index-expressions_002c-splitting-83"></a>
-<pre class="example"> if (foo_this_is_long && bar > win (x, y,
z)
+</p>
+<a name="index-expressions_002c-splitting"></a>
+<div class="example">
+<pre class="example">if (foo_this_is_long && bar > win (x, y, z)
&& remaining_condition)
-</pre>
- <p>Try to avoid having two operators of different precedence at the same
-level of indentation. For example, don't write this:
+</pre></div>
-<pre class="example"> mode = (inmode[j] == VOIDmode
+<p>Try to avoid having two operators of different precedence at the same
+level of indentation. For example, don’t write this:
+</p>
+<div class="example">
+<pre class="example">mode = (inmode[j] == VOIDmode
|| GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])
? outmode[j] : inmode[j]);
-</pre>
- <p>Instead, use extra parentheses so that the indentation shows the nesting:
+</pre></div>
-<pre class="example"> mode = ((inmode[j] == VOIDmode
+<p>Instead, use extra parentheses so that the indentation shows the nesting:
+</p>
+<div class="example">
+<pre class="example">mode = ((inmode[j] == VOIDmode
|| (GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])))
? outmode[j] : inmode[j]);
-</pre>
- <p>Insert extra parentheses so that Emacs will indent the code properly.
-For example, the following indentation looks nice if you do it by hand,
+</pre></div>
-<pre class="example"> v = rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+<p>Insert extra parentheses so that Emacs will indent the code properly.
+For example, the following indentation looks nice if you do it by hand,
+</p>
+<div class="example">
+<pre class="example">v = rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+ rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000;
-</pre>
- <p class="noindent">but Emacs would alter it. Adding a set of parentheses
produces
-something that looks equally nice, and which Emacs will preserve:
+</pre></div>
-<pre class="example"> v = (rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+<p>but Emacs would alter it. Adding a set of parentheses produces
+something that looks equally nice, and which Emacs will preserve:
+</p>
+<div class="example">
+<pre class="example">v = (rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+ rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000);
-</pre>
- <p>Format do-while statements like this:
+</pre></div>
-<pre class="example"> do
+<p>Format do-while statements like this:
+</p>
+<div class="example">
+<pre class="example">do
{
a = foo (a);
}
- while (a > 0);
-</pre>
- <p><a name="index-formfeed-84"></a><a
name="index-control_002dL-85"></a>Please use formfeed characters (control-L) to
divide the program into
+while (a > 0);
+</pre></div>
+
+<a name="index-formfeed"></a>
+<a name="index-control_002dL"></a>
+<p>Please use formfeed characters (control-L) to divide the program into
pages at logical places (but not within a function). It does not matter
just how long the pages are, since they do not have to fit on a printed
page. The formfeeds should appear alone on lines by themselves.
-
-<div class="node">
+</p>
+<hr>
<a name="Comments"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Syntactic-Conventions">Syntactic
Conventions</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Formatting">Formatting</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#Syntactic-Conventions" accesskey="n" rel="next">Syntactic
Conventions</a>, Previous: <a href="#Formatting" accesskey="p"
rel="previous">Formatting</a>, Up: <a href="#Writing-C" accesskey="u"
rel="up">Writing C</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Commenting-Your-Work"></a>
<h3 class="section">5.2 Commenting Your Work</h3>
+<a name="index-commenting"></a>
-<p><a name="index-commenting-86"></a>
-Every program should start with a comment saying briefly what it is for.
-Example: ‘<samp><span class="samp">fmt - filter for simple filling of
text</span></samp>’. This comment
-should be at the top of the source file containing the ‘<samp><span
class="samp">main</span></samp>’
+<p>Every program should start with a comment saying briefly what it is for.
+Example: ‘<samp>fmt - filter for simple filling of text</samp>’.
This comment
+should be at the top of the source file containing the
‘<samp>main</samp>’
function of the program.
-
- <p>Also, please write a brief comment at the start of each source file,
+</p>
+<p>Also, please write a brief comment at the start of each source file,
with the file name and a line or two about the overall purpose of the
file.
-
- <p>Please write the comments in a GNU program in English, because English
+</p>
+<p>Please write the comments in a GNU program in English, because English
is the one language that nearly all programmers in all countries can
read. If you do not write English well, please write comments in
English as well as you can, then ask other people to help rewrite them.
-If you can't write comments in English, please find someone to work with
+If you can’t write comments in English, please find someone to work with
you and translate your comments into English.
-
- <p>Please put a comment on each function saying what the function does,
+</p>
+<p>Please put a comment on each function saying what the function does,
what sorts of arguments it gets, and what the possible values of
arguments mean and are used for. It is not necessary to duplicate in
words the meaning of the C argument declarations, if a C type is being
@@ -2410,100 +3287,113 @@
possible values that would not work the way one would expect (such as,
that strings containing newlines are not guaranteed to work), be sure
to say so.
-
- <p>Also explain the significance of the return value, if there is one.
-
- <p>Please put two spaces after the end of a sentence in your comments, so
+</p>
+<p>Also explain the significance of the return value, if there is one.
+</p>
+<p>Please put two spaces after the end of a sentence in your comments, so
that the Emacs sentence commands will work. Also, please write
complete sentences and capitalize the first word. If a lower-case
-identifier comes at the beginning of a sentence, don't capitalize it!
-Changing the spelling makes it a different identifier. If you don't
+identifier comes at the beginning of a sentence, don’t capitalize it!
+Changing the spelling makes it a different identifier. If you don’t
like starting a sentence with a lower case letter, write the sentence
-differently (e.g., “The identifier lower-case is <small
class="dots">...</small>”).
-
- <p>The comment on a function is much clearer if you use the argument
+differently (e.g., “The identifier lower-case is …”).
+</p>
+<p>The comment on a function is much clearer if you use the argument
names to speak about the argument values. The variable name itself
should be lower case, but write it in upper case when you are speaking
about the value rather than the variable itself. Thus, “the inode
number NODE_NUM” rather than “an inode”.
-
- <p>There is usually no purpose in restating the name of the function in
+</p>
+<p>There is usually no purpose in restating the name of the function in
the comment before it, because readers can see that for themselves.
There might be an exception when the comment is so long that the function
itself would be off the bottom of the screen.
-
- <p>There should be a comment on each static variable as well, like this:
-
-<pre class="example"> /* Nonzero means truncate lines in the display;
+</p>
+<p>There should be a comment on each static variable as well, like this:
+</p>
+<div class="example">
+<pre class="example">/* Nonzero means truncate lines in the display;
zero means continue them. */
- int truncate_lines;
-</pre>
- <p><a name="index-conditionals_002c-comments-for-87"></a><a
name="index-g_t_0040code_007b_0023endif_007d_002c-commenting-88"></a>Every
‘<samp><span class="samp">#endif</span></samp>’ should have a
comment, except in the case of short
+int truncate_lines;
+</pre></div>
+
+<a name="index-conditionals_002c-comments-for"></a>
+<a name="index-_0023endif_002c-commenting"></a>
+<p>Every ‘<samp>#endif</samp>’ should have a comment, except in
the case of short
conditionals (just a few lines) that are not nested. The comment should
state the condition of the conditional that is ending, <em>including
-its sense</em>. ‘<samp><span class="samp">#else</span></samp>’
should have a comment describing the condition
+its sense</em>. ‘<samp>#else</samp>’ should have a comment
describing the condition
<em>and sense</em> of the code that follows. For example:
+</p>
+<div class="example">
+<pre class="example">#ifdef foo
+ …
+#else /* not foo */
+ …
+#endif /* not foo */
+</pre><pre class="example">#ifdef foo
+ …
+#endif /* foo */
+</pre></div>
+
+<p>but, by contrast, write the comments this way for a
‘<samp>#ifndef</samp>’:
+</p>
+<div class="example">
+<pre class="example">#ifndef foo
+ …
+#else /* foo */
+ …
+#endif /* foo */
+</pre><pre class="example">#ifndef foo
+ …
+#endif /* not foo */
+</pre></div>
-<pre class="example"> #ifdef foo
- ...
- #else /* not foo */
- ...
- #endif /* not foo */
- #ifdef foo
- ...
- #endif /* foo */
-</pre>
- <p class="noindent">but, by contrast, write the comments this way for a
‘<samp><span class="samp">#ifndef</span></samp>’:
-
-<pre class="example"> #ifndef foo
- ...
- #else /* foo */
- ...
- #endif /* foo */
- #ifndef foo
- ...
- #endif /* not foo */
-</pre>
- <div class="node">
+<hr>
<a name="Syntactic-Conventions"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Names">Names</a>,
-Previous: <a rel="previous" accesskey="p" href="#Comments">Comments</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#Names" accesskey="n" rel="next">Names</a>, Previous: <a
href="#Comments" accesskey="p" rel="previous">Comments</a>, Up: <a
href="#Writing-C" accesskey="u" rel="up">Writing C</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Clean-Use-of-C-Constructs"></a>
<h3 class="section">5.3 Clean Use of C Constructs</h3>
+<a name="index-syntactic-conventions"></a>
-<p><a name="index-syntactic-conventions-89"></a>
-<a name="index-implicit-_0040code_007bint_007d-90"></a><a
name="index-function-argument_002c-declaring-91"></a>Please explicitly declare
the types of all objects. For example, you
+<a name="index-implicit-int"></a>
+<a name="index-function-argument_002c-declaring"></a>
+<p>Please explicitly declare the types of all objects. For example, you
should explicitly declare all arguments to functions, and you should
declare functions to return <code>int</code> rather than omitting the
<code>int</code>.
-
- <p><a name="index-compiler-warnings-92"></a><a
name="index-g_t_0040samp_007b_002dWall_007d-compiler-option-93"></a>Some
programmers like to use the GCC ‘<samp><span
class="samp">-Wall</span></samp>’ option, and change the
+</p>
+<a name="index-compiler-warnings"></a>
+<a name="index-_002dWall-compiler-option"></a>
+<p>Some programmers like to use the GCC ‘<samp>-Wall</samp>’
option, and change the
code whenever it issues a warning. If you want to do this, then do.
-Other programmers prefer not to use ‘<samp><span
class="samp">-Wall</span></samp>’, because it gives
+Other programmers prefer not to use ‘<samp>-Wall</samp>’, because
it gives
warnings for valid and legitimate code which they do not want to change.
If you want to do this, then do. The compiler should be your servant,
not your master.
-
- <p><a name="index-clang-94"></a><a name="index-lint-95"></a>Don't make the
program ugly just to placate static analysis tools such
-as <samp><span class="command">lint</span></samp>, <samp><span
class="command">clang</span></samp>, and GCC with extra warnings
-options such as <samp><span class="option">-Wconversion</span></samp> and
<samp><span class="option">-Wundef</span></samp>. These
+</p>
+<a name="index-clang"></a>
+<a name="index-lint"></a>
+<p>Don’t make the program ugly just to placate static analysis tools such
+as <code>lint</code>, <code>clang</code>, and GCC with extra warnings
+options such as ‘<samp>-Wconversion</samp>’ and
‘<samp>-Wundef</samp>’. These
tools can help find bugs and unclear code, but they can also generate
so many false alarms that it hurts readability to silence them with
unnecessary casts, wrappers, and other complications. For example,
-please don't insert casts to <code>void</code> or calls to do-nothing
+please don’t insert casts to <code>void</code> or calls to do-nothing
functions merely to pacify a lint checker.
-
- <p>Declarations of external functions and functions to appear later in the
+</p>
+<p>Declarations of external functions and functions to appear later in the
source file should all go in one place near the beginning of the file
(somewhere before the first function definition in the file), or else
-should go in a header file. Don't put <code>extern</code> declarations inside
+should go in a header file. Don’t put <code>extern</code> declarations
inside
functions.
-
- <p><a name="index-temporary-variables-96"></a>It used to be common practice
to use the same local variables (with
+</p>
+<a name="index-temporary-variables"></a>
+<p>It used to be common practice to use the same local variables (with
names like <code>tem</code>) over and over for different values within one
function. Instead of doing this, it is better to declare a separate local
variable for each distinct purpose, and give it a name which is
@@ -2511,454 +3401,522 @@
facilitates optimization by good compilers. You can also move the
declaration of each local variable into the smallest scope that includes
all its uses. This makes the program even cleaner.
-
- <p>Don't use local variables or parameters that shadow global identifiers.
-GCC's ‘<samp><span class="samp">-Wshadow</span></samp>’ option can
detect this problem.
-
- <p><a name="index-multiple-variables-in-a-line-97"></a>Don't declare
multiple variables in one declaration that spans lines.
+</p>
+<p>Don’t use local variables or parameters that shadow global
identifiers.
+GCC’s ‘<samp>-Wshadow</samp>’ option can detect this problem.
+</p>
+<a name="index-multiple-variables-in-a-line"></a>
+<p>Don’t declare multiple variables in one declaration that spans lines.
Start a new declaration on each line, instead. For example, instead
of this:
-
-<pre class="example"> int foo,
+</p>
+<div class="example">
+<pre class="example">int foo,
bar;
-</pre>
- <p class="noindent">write either this:
+</pre></div>
-<pre class="example"> int foo, bar;
-</pre>
- <p class="noindent">or this:
-
-<pre class="example"> int foo;
- int bar;
-</pre>
- <p class="noindent">(If they are global variables, each should have a
comment preceding it
-anyway.)
+<p>write either this:
+</p>
+<div class="example">
+<pre class="example">int foo, bar;
+</pre></div>
+
+<p>or this:
+</p>
+<div class="example">
+<pre class="example">int foo;
+int bar;
+</pre></div>
- <p>When you have an <code>if</code>-<code>else</code> statement nested in
another
+<p>(If they are global variables, each should have a comment preceding it
+anyway.)
+</p>
+<p>When you have an <code>if</code>-<code>else</code> statement nested in
another
<code>if</code> statement, always put braces around the
<code>if</code>-<code>else</code>.
Thus, never write like this:
-
-<pre class="example"> if (foo)
+</p>
+<div class="example">
+<pre class="example">if (foo)
if (bar)
win ();
else
lose ();
-</pre>
- <p class="noindent">always like this:
+</pre></div>
-<pre class="example"> if (foo)
+<p>always like this:
+</p>
+<div class="example">
+<pre class="example">if (foo)
{
if (bar)
win ();
else
lose ();
}
-</pre>
- <p>If you have an <code>if</code> statement nested inside of an
<code>else</code>
+</pre></div>
+
+<p>If you have an <code>if</code> statement nested inside of an
<code>else</code>
statement, either write <code>else if</code> on one line, like this,
+</p>
+<div class="example">
+<pre class="example">if (foo)
+ …
+else if (bar)
+ …
+</pre></div>
-<pre class="example"> if (foo)
- ...
- else if (bar)
- ...
-</pre>
- <p class="noindent">with its <code>then</code>-part indented like the
preceding <code>then</code>-part,
+<p>with its <code>then</code>-part indented like the preceding
<code>then</code>-part,
or write the nested <code>if</code> within braces like this:
-
-<pre class="example"> if (foo)
- ...
- else
+</p>
+<div class="example">
+<pre class="example">if (foo)
+ …
+else
{
if (bar)
- ...
+ …
}
-</pre>
- <p>Don't declare both a structure tag and variables or typedefs in the
+</pre></div>
+
+<p>Don’t declare both a structure tag and variables or typedefs in the
same declaration. Instead, declare the structure tag separately
and then use it to declare the variables or typedefs.
-
- <p>Try to avoid assignments inside <code>if</code>-conditions (assignments
-inside <code>while</code>-conditions are ok). For example, don't write
+</p>
+<p>Try to avoid assignments inside <code>if</code>-conditions (assignments
+inside <code>while</code>-conditions are ok). For example, don’t write
this:
+</p>
+<div class="example">
+<pre class="example">if ((foo = (char *) malloc (sizeof *foo)) == 0)
+ fatal ("virtual memory exhausted");
+</pre></div>
+
+<p>instead, write this:
+</p>
+<div class="example">
+<pre class="example">foo = (char *) malloc (sizeof *foo);
+if (foo == 0)
+ fatal ("virtual memory exhausted");
+</pre></div>
-<pre class="example"> if ((foo = (char *) malloc (sizeof *foo)) == 0)
- fatal ("virtual memory exhausted");
-</pre>
- <p class="noindent">instead, write this:
-
-<pre class="example"> foo = (char *) malloc (sizeof *foo);
- if (foo == 0)
- fatal ("virtual memory exhausted");
-</pre>
- <p>This example uses zero without a cast as a null pointer constant.
+<p>This example uses zero without a cast as a null pointer constant.
This is perfectly fine, except that a cast is needed when calling a
varargs function or when using <code>sizeof</code>.
-
-<div class="node">
+</p>
+<hr>
<a name="Names"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#System-Portability">System
Portability</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Syntactic-Conventions">Syntactic Conventions</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#System-Portability" accesskey="n" rel="next">System
Portability</a>, Previous: <a href="#Syntactic-Conventions" accesskey="p"
rel="previous">Syntactic Conventions</a>, Up: <a href="#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Naming-Variables_002c-Functions_002c-and-Files"></a>
<h3 class="section">5.4 Naming Variables, Functions, and Files</h3>
-<p><a name="index-names-of-variables_002c-functions_002c-and-files-98"></a>The
names of global variables and functions in a program serve as
-comments of a sort. So don't choose terse names—instead, look for
+<a name="index-names-of-variables_002c-functions_002c-and-files"></a>
+<p>The names of global variables and functions in a program serve as
+comments of a sort. So don’t choose terse names—instead, look for
names that give useful information about the meaning of the variable or
function. In a GNU program, names should be English, like other
comments.
-
- <p>Local variable names can be shorter, because they are used only within
+</p>
+<p>Local variable names can be shorter, because they are used only within
one context, where (presumably) comments explain their purpose.
-
- <p>Try to limit your use of abbreviations in symbol names. It is ok to
+</p>
+<p>Try to limit your use of abbreviations in symbol names. It is ok to
make a few abbreviations, explain what they mean, and then use them
-frequently, but don't use lots of obscure abbreviations.
-
- <p>Please use underscores to separate words in a name, so that the Emacs
+frequently, but don’t use lots of obscure abbreviations.
+</p>
+<p>Please use underscores to separate words in a name, so that the Emacs
word commands can be useful within them. Stick to lower case; reserve
upper case for macros and <code>enum</code> constants, and for name-prefixes
that follow a uniform convention.
-
- <p>For example, you should use names like
<code>ignore_space_change_flag</code>;
-don't use names like <code>iCantReadThis</code>.
-
- <p>Variables that indicate whether command-line options have been
+</p>
+<p>For example, you should use names like
<code>ignore_space_change_flag</code>;
+don’t use names like <code>iCantReadThis</code>.
+</p>
+<p>Variables that indicate whether command-line options have been
specified should be named after the meaning of the option, not after
the option-letter. A comment should state both the exact meaning of
the option and its letter. For example,
+</p>
+<div class="example">
+<pre class="example">/* Ignore changes in horizontal whitespace (-b). */
+int ignore_space_change_flag;
+</pre></div>
-<pre class="example"> /* Ignore changes in horizontal whitespace (-b). */
- int ignore_space_change_flag;
-</pre>
- <p>When you want to define names with constant integer values, use
-<code>enum</code> rather than ‘<samp><span
class="samp">#define</span></samp>’. GDB knows about enumeration
+<p>When you want to define names with constant integer values, use
+<code>enum</code> rather than ‘<samp>#define</samp>’. GDB knows
about enumeration
constants.
-
- <p><a name="index-file_002dname-limitations-99"></a><a
name="index-doschk-100"></a>You might want to make sure that none of the file
names would conflict
+</p>
+<a name="index-file_002dname-limitations"></a>
+<a name="index-doschk"></a>
+<p>You might want to make sure that none of the file names would conflict
if the files were loaded onto an MS-DOS file system which shortens the
names. You can use the program <code>doschk</code> to test for this.
-
- <p>Some GNU programs were designed to limit themselves to file names of 14
+</p>
+<p>Some GNU programs were designed to limit themselves to file names of 14
characters or less, to avoid file name conflicts if they are read into
older System V systems. Please preserve this feature in the existing
GNU programs that have it, but there is no need to do this in new GNU
programs. <code>doschk</code> also reports file names longer than 14
characters.
+</p>
-<div class="node">
+<hr>
<a name="System-Portability"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#CPU-Portability">CPU
Portability</a>,
-Previous: <a rel="previous" accesskey="p" href="#Names">Names</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#CPU-Portability" accesskey="n" rel="next">CPU Portability</a>,
Previous: <a href="#Names" accesskey="p" rel="previous">Names</a>, Up: <a
href="#Writing-C" accesskey="u" rel="up">Writing C</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Portability-between-System-Types"></a>
<h3 class="section">5.5 Portability between System Types</h3>
+<a name="index-portability_002c-between-system-types"></a>
-<p><a name="index-portability_002c-between-system-types-101"></a>
-In the Unix world, “portability” refers to porting to different
Unix
+<p>In the Unix world, “portability” refers to porting to different
Unix
versions. For a GNU program, this kind of portability is desirable, but
not paramount.
-
- <p>The primary purpose of GNU software is to run on top of the GNU kernel,
-compiled with the GNU C compiler, on various types of <span
class="sc">cpu</span>. So the
+</p>
+<p>The primary purpose of GNU software is to run on top of the GNU kernel,
+compiled with the GNU C compiler, on various types of <small>CPU</small>. So
the
kinds of portability that are absolutely necessary are quite limited.
But it is important to support Linux-based GNU systems, since they
are the form of GNU that is popular.
-
- <p>Beyond that, it is good to support the other free operating systems
+</p>
+<p>Beyond that, it is good to support the other free operating systems
(*BSD), and it is nice to support other Unix-like systems if you want
to. Supporting a variety of Unix-like systems is desirable, although
not paramount. It is usually not too hard, so you may as well do it.
-But you don't have to consider it an obligation, if it does turn out to
+But you don’t have to consider it an obligation, if it does turn out to
be hard.
-
- <p><a name="index-autoconf-102"></a>The easiest way to achieve portability
to most Unix-like systems is to
-use Autoconf. It's unlikely that your program needs to know more
+</p>
+<a name="index-autoconf"></a>
+<p>The easiest way to achieve portability to most Unix-like systems is to
+use Autoconf. It’s unlikely that your program needs to know more
information about the host platform than Autoconf can provide, simply
because most of the programs that need such knowledge have already been
written.
-
- <p>Avoid using the format of semi-internal data bases (e.g., directories)
+</p>
+<p>Avoid using the format of semi-internal data bases (e.g., directories)
when there is a higher-level alternative (<code>readdir</code>).
-
- <p><a
name="index-non_002d_0040sc_007bposix_007d-systems_002c-and-portability-103"></a>As
for systems that are not like Unix, such as MSDOS, Windows, VMS, MVS,
+</p>
+<a name="index-non_002dPOSIX-systems_002c-and-portability"></a>
+<p>As for systems that are not like Unix, such as MSDOS, Windows, VMS, MVS,
and older Macintosh systems, supporting them is often a lot of work.
When that is the case, it is better to spend your time adding features
that will be useful on GNU and GNU/Linux, rather than on supporting
other incompatible systems.
-
- <p>If you do support Windows, please do not abbreviate it as
“win”. In
+</p>
+<p>If you do support Windows, please do not abbreviate it as
“win”. In
hacker terminology, calling something a “win” is a form of praise.
-You're free to praise Microsoft Windows on your own if you want, but
-please don't do this in GNU packages. Instead of abbreviating
+You’re free to praise Microsoft Windows on your own if you want, but
+please don’t do this in GNU packages. Instead of abbreviating
“Windows” to “win”, you can write it in full or
abbreviate it to
-“woe” or “w”. In GNU Emacs, for instance, we use
‘<samp><span class="samp">w32</span></samp>’ in
+“woe” or “w”. In GNU Emacs, for instance, we use
‘<samp>w32</samp>’ in
file names of Windows-specific files, but the macro for Windows
conditionals is called <code>WINDOWSNT</code>.
-
- <p>It is a good idea to define the “feature test macro”
+</p>
+<p>It is a good idea to define the “feature test macro”
<code>_GNU_SOURCE</code> when compiling your C files. When you compile on GNU
or GNU/Linux, this will enable the declarations of GNU library extension
functions, and that will usually give you a compiler error message if
you define the same function names in some other way in your program.
-(You don't have to actually <em>use</em> these functions, if you prefer
+(You don’t have to actually <em>use</em> these functions, if you prefer
to make the program more portable to other systems.)
-
- <p>But whether or not you use these GNU extensions, you should avoid
+</p>
+<p>But whether or not you use these GNU extensions, you should avoid
using their names for any other meanings. Doing so would make it hard
to move your code into other GNU programs.
-
-<div class="node">
+</p>
+<hr>
<a name="CPU-Portability"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#System-Functions">System
Functions</a>,
-Previous: <a rel="previous" accesskey="p"
href="#System-Portability">System Portability</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
-</div>
-
-<h3 class="section">5.6 Portability between <span class="sc">cpu</span>s</h3>
-
-<p><a name="index-data-types_002c-and-portability-104"></a><a
name="index-portability_002c-and-data-types-105"></a>Even GNU systems will
differ because of differences among <span class="sc">cpu</span>
+<div class="header">
+<p>
+Next: <a href="#System-Functions" accesskey="n" rel="next">System
Functions</a>, Previous: <a href="#System-Portability" accesskey="p"
rel="previous">System Portability</a>, Up: <a href="#Writing-C" accesskey="u"
rel="up">Writing C</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+<a name="Portability-between-CPUs"></a>
+<h3 class="section">5.6 Portability between <small>CPU</small>s</h3>
+
+<a name="index-data-types_002c-and-portability"></a>
+<a name="index-portability_002c-and-data-types"></a>
+<p>Even GNU systems will differ because of differences among <small>CPU</small>
types—for example, difference in byte ordering and alignment
requirements. It is absolutely essential to handle these differences.
-However, don't make any effort to cater to the possibility that an
-<code>int</code> will be less than 32 bits. We don't support 16-bit machines
+However, don’t make any effort to cater to the possibility that an
+<code>int</code> will be less than 32 bits. We don’t support 16-bit
machines
in GNU.
-
- <p>Similarly, don't make any effort to cater to the possibility that
+</p>
+<p>Similarly, don’t make any effort to cater to the possibility that
<code>long</code> will be smaller than predefined types like
<code>size_t</code>.
For example, the following code is ok:
+</p>
+<div class="example">
+<pre class="example">printf ("size = %lu\n", (unsigned long) sizeof
array);
+printf ("diff = %ld\n", (long) (pointer2 - pointer1));
+</pre></div>
-<pre class="example"> printf ("size = %lu\n", (unsigned long) sizeof
array);
- printf ("diff = %ld\n", (long) (pointer2 - pointer1));
-</pre>
- <p>1989 Standard C requires this to work, and we know of only one
+<p>1989 Standard C requires this to work, and we know of only one
counterexample: 64-bit programs on Microsoft Windows. We will leave
it to those who want to port GNU programs to that environment to
figure out how to do it.
-
- <p>Predefined file-size types like <code>off_t</code> are an exception:
they are
-longer than <code>long</code> on many platforms, so code like the above won't
+</p>
+<p>Predefined file-size types like <code>off_t</code> are an exception: they
are
+longer than <code>long</code> on many platforms, so code like the above
won’t
work with them. One way to print an <code>off_t</code> value portably is to
print its digits yourself, one by one.
-
- <p>Don't assume that the address of an <code>int</code> object is also the
+</p>
+<p>Don’t assume that the address of an <code>int</code> object is also
the
address of its least-significant byte. This is false on big-endian
-machines. Thus, don't make the following mistake:
-
-<pre class="example"> int c;
- ...
- while ((c = getchar ()) != EOF)
+machines. Thus, don’t make the following mistake:
+</p>
+<div class="example">
+<pre class="example">int c;
+…
+while ((c = getchar ()) != EOF)
write (file_descriptor, &c, 1);
-</pre>
- <p class="noindent">Instead, use <code>unsigned char</code> as follows.
(The <code>unsigned</code>
+</pre></div>
+
+<p>Instead, use <code>unsigned char</code> as follows. (The
<code>unsigned</code>
is for portability to unusual systems where <code>char</code> is signed and
where there is integer overflow checking.)
-
-<pre class="example"> int c;
- while ((c = getchar ()) != EOF)
+</p>
+<div class="example">
+<pre class="example">int c;
+while ((c = getchar ()) != EOF)
{
unsigned char u = c;
write (file_descriptor, &u, 1);
}
-</pre>
- <p><a name="index-casting-pointers-to-integers-106"></a>Avoid casting
pointers to integers if you can. Such casts greatly
+</pre></div>
+
+<a name="index-casting-pointers-to-integers"></a>
+<p>Avoid casting pointers to integers if you can. Such casts greatly
reduce portability, and in most programs they are easy to avoid. In the
cases where casting pointers to integers is essential—such as, a Lisp
interpreter which stores type information as well as an address in one
-word—you'll have to make explicit provisions to handle different word
+word—you’ll have to make explicit provisions to handle different
word
sizes. You will also need to make provision for systems in which the
normal range of addresses you can get from <code>malloc</code> starts far away
from zero.
+</p>
-<div class="node">
+<hr>
<a name="System-Functions"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#Internationalization">Internationalization</a>,
-Previous: <a rel="previous" accesskey="p" href="#CPU-Portability">CPU
Portability</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#Internationalization" accesskey="n"
rel="next">Internationalization</a>, Previous: <a href="#CPU-Portability"
accesskey="p" rel="previous">CPU Portability</a>, Up: <a href="#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Calling-System-Functions"></a>
<h3 class="section">5.7 Calling System Functions</h3>
-<p><a name="index-C-library-functions_002c-and-portability-107"></a><a
name="index-POSIX-functions_002c-and-portability-108"></a><a
name="index-library-functions_002c-and-portability-109"></a><a
name="index-portability_002c-and-library-functions-110"></a>
-Historically, C implementations differed substantially, and many
+<a name="index-C-library-functions_002c-and-portability"></a>
+<a name="index-POSIX-functions_002c-and-portability"></a>
+<a name="index-library-functions_002c-and-portability"></a>
+<a name="index-portability_002c-and-library-functions"></a>
+
+<p>Historically, C implementations differed substantially, and many
systems lacked a full implementation of ANSI/ISO C89. Nowadays,
however, very few systems lack a C89 compiler and GNU C supports
almost all of C99. Similarly, most systems implement POSIX.1-1993
libraries and tools, and many have POSIX.1-2001.
-
- <p>Hence, there is little reason to support old C or non-POSIX systems,
+</p>
+<p>Hence, there is little reason to support old C or non-POSIX systems,
and you may want to take advantage of C99 and POSIX-1.2001 to write
clearer, more portable, or faster code. You should use standard
interfaces where possible; but if GNU extensions make your program
-more maintainable, powerful, or otherwise better, don't hesitate to
-use them. In any case, don't make your own declaration of system
-functions; that's a recipe for conflict.
-
- <p>Despite the standards, nearly every library function has some sort of
+more maintainable, powerful, or otherwise better, don’t hesitate to
+use them. In any case, don’t make your own declaration of system
+functions; that’s a recipe for conflict.
+</p>
+<p>Despite the standards, nearly every library function has some sort of
portability issue on some system or another. Here are some examples:
-
- <dl>
-<dt><code>open</code><dd>Names with trailing <code>/</code>'s are mishandled
on many platforms.
-
- <br><dt><code>printf</code><dd><code>long double</code> may be
unimplemented; floating values Infinity and
+</p>
+<dl compact="compact">
+<dt><code>open</code></dt>
+<dd><p>Names with trailing <code>/</code>’s are mishandled on many
platforms.
+</p>
+</dd>
+<dt><code>printf</code></dt>
+<dd><p><code>long double</code> may be unimplemented; floating values Infinity
and
NaN are often mishandled; output for large precisions may be
incorrect.
-
- <br><dt><code>readlink</code><dd>May return <code>int</code> instead of
<code>ssize_t</code>.
-
- <br><dt><code>scanf</code><dd>On Windows, <code>errno</code> is not set
on failure.
+</p>
+</dd>
+<dt><code>readlink</code></dt>
+<dd><p>May return <code>int</code> instead of <code>ssize_t</code>.
+</p>
+</dd>
+<dt><code>scanf</code></dt>
+<dd><p>On Windows, <code>errno</code> is not set on failure.
+</p></dd>
</dl>
- <p><a name="index-Gnulib-111"></a><a
href="http://www.gnu.org/software/gnulib/";>Gnulib</a> is a big help in
+<a name="index-Gnulib"></a>
+<p><a href="http://www.gnu.org/software/gnulib/";>Gnulib</a> is a big help in
this regard. Gnulib provides implementations of standard interfaces
on many of the systems that lack them, including portable
implementations of enhanced GNU interfaces, thereby making their use
portable, and of POSIX-1.2008 interfaces, some of which are missing
even on up-to-date GNU systems.
-
- <p><a name="index-xmalloc_002c-in-Gnulib-112"></a><a
name="index-error-messages_002c-in-Gnulib-113"></a><a
name="index-data-structures_002c-in-Gnulib-114"></a>Gnulib also provides many
useful non-standard interfaces; for example,
+</p>
+<a name="index-xmalloc_002c-in-Gnulib"></a>
+<a name="index-error-messages_002c-in-Gnulib"></a>
+<a name="index-data-structures_002c-in-Gnulib"></a>
+<p>Gnulib also provides many useful non-standard interfaces; for example,
C implementations of standard data structures (hash tables, binary
trees), error-checking type-safe wrappers for memory allocation
functions (<code>xmalloc</code>, <code>xrealloc</code>), and output of error
messages.
-
- <p>Gnulib integrates with GNU Autoconf and Automake to remove much of the
+</p>
+<p>Gnulib integrates with GNU Autoconf and Automake to remove much of the
burden of writing portable code from the programmer: Gnulib makes your
configure script automatically determine what features are missing and
use the Gnulib code to supply the missing pieces.
-
- <p>The Gnulib and Autoconf manuals have extensive sections on
-portability: <a href="gnulib.html#Top">Introduction</a> and
-see <a href="autoconf.html#Portable-C-and-C_002b_002b">Portable C and C++</a>.
Please consult them
+</p>
+<p>The Gnulib and Autoconf manuals have extensive sections on
+portability: <a
href="http://www.gnu.org/software/gnulib/manual/gnulib.html#Top";>Introduction</a>
in <cite>Gnulib</cite> and
+see <a
href="http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-C-and-C_002b_002b";>Portable
C and C++</a> in <cite>Autoconf</cite>. Please consult them
for many more details.
+</p>
-<div class="node">
+<hr>
<a name="Internationalization"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Character-Set">Character Set</a>,
-Previous: <a rel="previous" accesskey="p" href="#System-Functions">System
Functions</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#Character-Set" accesskey="n" rel="next">Character Set</a>,
Previous: <a href="#System-Functions" accesskey="p" rel="previous">System
Functions</a>, Up: <a href="#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Internationalization-1"></a>
<h3 class="section">5.8 Internationalization</h3>
+<a name="index-internationalization"></a>
-<p><a name="index-internationalization-115"></a>
-<a name="index-gettext-116"></a>GNU has a library called GNU gettext that
makes it easy to translate the
+<a name="index-gettext"></a>
+<p>GNU has a library called GNU gettext that makes it easy to translate the
messages in a program into various languages. You should use this
library in every program. Use English for the messages as they appear
in the program, and let gettext provide the way to translate them into
other languages.
-
- <p>Using GNU gettext involves putting a call to the <code>gettext</code>
macro
+</p>
+<p>Using GNU gettext involves putting a call to the <code>gettext</code> macro
around each string that might need translation—like this:
-
-<pre class="example"> printf (gettext ("Processing file '%s'..."), file);
-</pre>
- <p class="noindent">This permits GNU gettext to replace the string
<code>"Processing file
-'%s'..."</code> with a translated version.
-
- <p>Once a program uses gettext, please make a point of writing calls to
+</p>
+<div class="example">
+<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+</pre></div>
+
+<p>This permits GNU gettext to replace the string <code>"Processing file
+'%s'..."</code> with a translated version.
+</p>
+<p>Once a program uses gettext, please make a point of writing calls to
<code>gettext</code> when you add new strings that call for translation.
-
- <p>Using GNU gettext in a package involves specifying a <dfn>text domain
-name</dfn> for the package. The text domain name is used to separate the
+</p>
+<p>Using GNU gettext in a package involves specifying a <em>text domain
+name</em> for the package. The text domain name is used to separate the
translations for this package from the translations for other packages.
Normally, the text domain name should be the same as the name of the
-package—for example, ‘<samp><span
class="samp">coreutils</span></samp>’ for the GNU core utilities.
-
- <p><a name="index-message-text_002c-and-internationalization-117"></a>To
enable gettext to work well, avoid writing code that makes
+package—for example, ‘<samp>coreutils</samp>’ for the GNU
core utilities.
+</p>
+<a name="index-message-text_002c-and-internationalization"></a>
+<p>To enable gettext to work well, avoid writing code that makes
assumptions about the structure of words or sentences. When you want
the precise text of a sentence to vary depending on the data, use two or
more alternative string constants each containing a complete sentences,
rather than inserting conditionalized words or phrases into a single
sentence framework.
+</p>
+<p>Here is an example of what not to do:
+</p>
+<div class="smallexample">
+<pre class="smallexample">printf ("%s is full", capacity >
5000000 ? "disk" : "floppy disk");
+</pre></div>
+
+<p>If you apply gettext to all strings, like this,
+</p>
+<div class="smallexample">
+<pre class="smallexample">printf (gettext ("%s is full"),
+ capacity > 5000000 ? gettext ("disk") : gettext
("floppy disk"));
+</pre></div>
- <p>Here is an example of what not to do:
-
-<pre class="smallexample"> printf ("%s is full", capacity > 5000000 ?
"disk" : "floppy disk");
-</pre>
- <p>If you apply gettext to all strings, like this,
-
-<pre class="smallexample"> printf (gettext ("%s is full"),
- capacity > 5000000 ? gettext ("disk") : gettext ("floppy
disk"));
-</pre>
- <p class="noindent">the translator will hardly know that "disk" and "floppy
disk" are meant to
+<p>the translator will hardly know that "disk" and "floppy
disk" are meant to
be substituted in the other string. Worse, in some languages (like French)
-the construction will not work: the translation of the word "full" depends
+the construction will not work: the translation of the word "full"
depends
on the gender of the first part of the sentence; it happens to be not the
-same for "disk" as for "floppy disk".
-
- <p>Complete sentences can be translated without problems:
+same for "disk" as for "floppy disk".
+</p>
+<p>Complete sentences can be translated without problems:
+</p>
+<div class="example">
+<pre class="example">printf (capacity > 5000000 ? gettext ("disk is
full")
+ : gettext ("floppy disk is full"));
+</pre></div>
-<pre class="example"> printf (capacity > 5000000 ? gettext ("disk is
full")
- : gettext ("floppy disk is full"));
-</pre>
- <p>A similar problem appears at the level of sentence structure with this
+<p>A similar problem appears at the level of sentence structure with this
code:
+</p>
+<div class="example">
+<pre class="example">printf ("# Implicit rule search has%s been
done.\n",
+ f->tried_implicit ? "" : " not");
+</pre></div>
-<pre class="example"> printf ("# Implicit rule search has%s been done.\n",
- f->tried_implicit ? "" : " not");
-</pre>
- <p class="noindent">Adding <code>gettext</code> calls to this code cannot
give correct results for
+<p>Adding <code>gettext</code> calls to this code cannot give correct results
for
all languages, because negation in some languages requires adding words
at more than one place in the sentence. By contrast, adding
<code>gettext</code> calls does the job straightforwardly if the code starts
out like this:
+</p>
+<div class="example">
+<pre class="example">printf (f->tried_implicit
+ ? "# Implicit rule search has been done.\n",
+ : "# Implicit rule search has not been done.\n");
+</pre></div>
+
+<p>Another example is this one:
+</p>
+<div class="example">
+<pre class="example">printf ("%d file%s processed", nfiles,
+ nfiles != 1 ? "s" : "");
+</pre></div>
+
+<p>The problem with this example is that it assumes that plurals are made
+by adding ‘s’. If you apply gettext to the format string, like
this,
+</p>
+<div class="example">
+<pre class="example">printf (gettext ("%d file%s processed"), nfiles,
+ nfiles != 1 ? "s" : "");
+</pre></div>
-<pre class="example"> printf (f->tried_implicit
- ? "# Implicit rule search has been done.\n",
- : "# Implicit rule search has not been done.\n");
-</pre>
- <p>Another example is this one:
-
-<pre class="example"> printf ("%d file%s processed", nfiles,
- nfiles != 1 ? "s" : "");
-</pre>
- <p class="noindent">The problem with this example is that it assumes that
plurals are made
-by adding `s'. If you apply gettext to the format string, like this,
-
-<pre class="example"> printf (gettext ("%d file%s processed"), nfiles,
- nfiles != 1 ? "s" : "");
-</pre>
- <p class="noindent">the message can use different words, but it will still
be forced to use
-`s' for the plural. Here is a better way, with gettext being applied to
+<p>the message can use different words, but it will still be forced to use
+‘s’ for the plural. Here is a better way, with gettext being
applied to
the two strings independently:
-
-<pre class="example"> printf ((nfiles != 1 ? gettext ("%d files processed")
- : gettext ("%d file processed")),
+</p>
+<div class="example">
+<pre class="example">printf ((nfiles != 1 ? gettext ("%d files
processed")
+ : gettext ("%d file processed")),
nfiles);
-</pre>
- <p class="noindent">But this still doesn't work for languages like Polish,
which has three
+</pre></div>
+
+<p>But this still doesn’t work for languages like Polish, which has three
plural forms: one for nfiles == 1, one for nfiles == 2, 3, 4, 22, 23, 24, ...
and one for the rest. The GNU <code>ngettext</code> function solves this
problem:
-
-<pre class="example"> printf (ngettext ("%d files processed", "%d file
processed", nfiles),
+</p>
+<div class="example">
+<pre class="example">printf (ngettext ("%d files processed",
"%d file processed", nfiles),
nfiles);
-</pre>
- <div class="node">
-<a name="Character-Set"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Quote-Characters">Quote
Characters</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Internationalization">Internationalization</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
+</pre></div>
-</div>
+<hr>
+<a name="Character-Set"></a>
+<div class="header">
+<p>
+Next: <a href="#Quote-Characters" accesskey="n" rel="next">Quote
Characters</a>, Previous: <a href="#Internationalization" accesskey="p"
rel="previous">Internationalization</a>, Up: <a href="#Writing-C" accesskey="u"
rel="up">Writing C</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+<a name="Character-Set-1"></a>
<h3 class="section">5.9 Character Set</h3>
+<a name="index-character-set"></a>
+<a name="index-encodings"></a>
+<a name="index-ASCII-characters"></a>
+<a name="index-non_002dASCII-characters"></a>
-<p><a name="index-character-set-118"></a><a name="index-encodings-119"></a><a
name="index-ASCII-characters-120"></a><a
name="index-non_002dASCII-characters-121"></a>
-Sticking to the ASCII character set (plain text, 7-bit characters) is
+<p>Sticking to the ASCII character set (plain text, 7-bit characters) is
preferred in GNU source code comments, text documents, and other
contexts, unless there is good reason to do something else because of
the application domain. For example, if source code deals with the
@@ -2966,118 +3924,134 @@
accented characters in month names like “Floréal”. Also,
it is OK
(but not required) to use non-ASCII characters to represent proper
names of contributors in change logs (see <a href="#Change-Logs">Change
Logs</a>).
-
- <p>If you need to use non-ASCII characters, you should normally stick
+</p>
+<p>If you need to use non-ASCII characters, you should normally stick
with one encoding, certainly within a single file. UTF-8 is likely to
be the best choice.
+</p>
-<div class="node">
+<hr>
<a name="Quote-Characters"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Mmap">Mmap</a>,
-Previous: <a rel="previous" accesskey="p" href="#Character-Set">Character
Set</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
-
+<div class="header">
+<p>
+Next: <a href="#Mmap" accesskey="n" rel="next">Mmap</a>, Previous: <a
href="#Character-Set" accesskey="p" rel="previous">Character Set</a>, Up: <a
href="#Writing-C" accesskey="u" rel="up">Writing C</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Quote-Characters-1"></a>
<h3 class="section">5.10 Quote Characters</h3>
+<a name="index-quote-characters"></a>
+<a name="index-locale_002dspecific-quote-characters"></a>
+<a name="index-left-quote"></a>
+<a name="index-right-quote"></a>
+<a name="index-opening-quote"></a>
+<a name="index-single-quote"></a>
+<a name="index-double-quote"></a>
+<a name="index-grave-accent"></a>
-<p><a name="index-quote-characters-122"></a><a
name="index-locale_002dspecific-quote-characters-123"></a><a
name="index-left-quote-124"></a><a name="index-right-quote-125"></a><a
name="index-opening-quote-126"></a><a name="index-single-quote-127"></a><a
name="index-double-quote-128"></a><a name="index-grave-accent-129"></a>
-
- <p>In the C locale, the output of GNU programs should stick to plain
+<p>In the C locale, the output of GNU programs should stick to plain
ASCII for quotation characters in messages to users: preferably 0x22
-(‘<samp><span class="samp">"</span></samp>’) or 0x27
(‘<samp><span class="samp">'</span></samp>’) for both opening and
closing quotes.
-Although GNU programs traditionally used 0x60 (‘<samp><span
class="samp">`</span></samp>’) for opening
-and 0x27 (‘<samp><span class="samp">'</span></samp>’) for closing
quotes, nowadays quotes ‘<samp><span class="samp">`like
-this'</span></samp>’ are typically rendered asymmetrically, so quoting
‘<samp><span class="samp">"like
-this"</span></samp>’ or ‘<samp><span class="samp">'like
this'</span></samp>’ typically looks better.
-
- <p>It is ok, but not required, for GNU programs to generate
+(‘<samp>"</samp>’) or 0x27 (‘<samp>'</samp>’) for
both opening and closing quotes.
+Although GNU programs traditionally used 0x60 (‘<samp>`</samp>’)
for opening
+and 0x27 (‘<samp>'</samp>’) for closing quotes, nowadays quotes
‘<samp>`like
+this'</samp>’ are typically rendered asymmetrically, so quoting
‘<samp>"like
+this"</samp>’ or ‘<samp>'like this'</samp>’ typically
looks better.
+</p>
+<p>It is ok, but not required, for GNU programs to generate
locale-specific quotes in non-C locales. For example:
-
-<pre class="example"> printf (gettext ("Processing file '%s'..."), file);
-</pre>
- <p class="noindent">Here, a French translation might cause
<code>gettext</code> to return the
-string <code>"Traitement de fichier
-‹ %s ›..."</code>, yielding quotes
+</p>
+<div class="example">
+<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+</pre></div>
+
+<p>Here, a French translation might cause <code>gettext</code> to return the
+string <code>"Traitement de fichier
+‹ %s ›..."</code>, yielding quotes
more appropriate for a French locale.
-
- <p>Sometimes a program may need to use opening and closing quotes
+</p>
+<p>Sometimes a program may need to use opening and closing quotes
directly. By convention, <code>gettext</code> translates the string
-‘<samp><span class="samp">"`"</span></samp>’ to the opening quote
and the string ‘<samp><span class="samp">"'"</span></samp>’ to the
+‘<samp>"`"</samp>’ to the opening quote and the string
‘<samp>"'"</samp>’ to the
closing quote, and a program can use these translations. Generally,
though, it is better to translate quote characters in the context of
longer strings.
-
- <p>If the output of your program is ever likely to be parsed by another
+</p>
+<p>If the output of your program is ever likely to be parsed by another
program, it is good to provide an option that makes this parsing
reliable. For example, you could escape special characters using
conventions from the C language or the Bourne shell. See for example
-the option <samp><span class="option">--quoting-style</span></samp> of GNU
<code>ls</code>.
+the option ‘<samp>--quoting-style</samp>’ of GNU <code>ls</code>.
+</p>
-<div class="node">
-<a name="Mmap"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p" href="#Quote-Characters">Quote
Characters</a>,
-Up: <a rel="up" accesskey="u" href="#Writing-C">Writing C</a>
+<hr>
+<a name="Mmap"></a>
+<div class="header">
+<p>
+Previous: <a href="#Quote-Characters" accesskey="p" rel="previous">Quote
Characters</a>, Up: <a href="#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Mmap-1"></a>
<h3 class="section">5.11 Mmap</h3>
+<a name="index-mmap"></a>
-<p><a name="index-mmap-130"></a>
-Don't assume that <code>mmap</code> either works on all files or fails
+<p>Don’t assume that <code>mmap</code> either works on all files or fails
for all files. It may work on some files and fail on others.
-
- <p>The proper way to use <code>mmap</code> is to try it on the specific
file for
-which you want to use it—and if <code>mmap</code> doesn't work, fall
back on
+</p>
+<p>The proper way to use <code>mmap</code> is to try it on the specific file
for
+which you want to use it—and if <code>mmap</code> doesn’t work,
fall back on
doing the job in another way using <code>read</code> and <code>write</code>.
-
- <p>The reason this precaution is needed is that the GNU kernel (the HURD)
+</p>
+<p>The reason this precaution is needed is that the GNU kernel (the HURD)
provides a user-extensible file system, in which there can be many
different kinds of “ordinary files”. Many of them support
<code>mmap</code>, but some do not. It is important to make programs handle
all these kinds of files.
+</p>
-<div class="node">
+<hr>
<a name="Documentation"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Managing-Releases">Managing
Releases</a>,
-Previous: <a rel="previous" accesskey="p" href="#Writing-C">Writing C</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#Managing-Releases" accesskey="n" rel="next">Managing
Releases</a>, Previous: <a href="#Writing-C" accesskey="p"
rel="previous">Writing C</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Documenting-Programs"></a>
<h2 class="chapter">6 Documenting Programs</h2>
+<a name="index-documentation"></a>
-<p><a name="index-documentation-131"></a>
-A GNU program should ideally come with full free documentation, adequate
+<p>A GNU program should ideally come with full free documentation, adequate
for both reference and tutorial purposes. If the package can be
programmed or extended, the documentation should cover programming or
extending it, as well as just using it.
-
-<ul class="menu">
-<li><a accesskey="1" href="#GNU-Manuals">GNU Manuals</a>:
Writing proper manuals.
-<li><a accesskey="2" href="#Doc-Strings-and-Manuals">Doc Strings and
Manuals</a>: Compiling doc strings doesn't make a manual.
-<li><a accesskey="3" href="#Manual-Structure-Details">Manual Structure
Details</a>: Specific structure conventions.
-<li><a accesskey="4" href="#License-for-Manuals">License for Manuals</a>:
Writing the distribution terms for a manual.
-<li><a accesskey="5" href="#Manual-Credits">Manual Credits</a>:
Giving credit to documentation contributors.
-<li><a accesskey="6" href="#Printed-Manuals">Printed Manuals</a>:
Mentioning the printed manual.
-<li><a accesskey="7" href="#NEWS-File">NEWS File</a>: NEWS
files supplement manuals.
-<li><a accesskey="8" href="#Change-Logs">Change Logs</a>:
Recording changes.
-<li><a accesskey="9" href="#Man-Pages">Man Pages</a>: Man
pages are secondary.
-<li><a href="#Reading-other-Manuals">Reading other Manuals</a>: How far
you can go in learning
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#GNU-Manuals"
accesskey="1">GNU Manuals</a>:</td><td> </td><td align="left"
valign="top">Writing proper manuals.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Doc-Strings-and-Manuals"
accesskey="2">Doc Strings and Manuals</a>:</td><td> </td><td
align="left" valign="top">Compiling doc strings doesn’t make a manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Manual-Structure-Details"
accesskey="3">Manual Structure Details</a>:</td><td> </td><td
align="left" valign="top">Specific structure conventions.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#License-for-Manuals"
accesskey="4">License for Manuals</a>:</td><td> </td><td
align="left" valign="top">Writing the distribution terms for a manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Manual-Credits"
accesskey="5">Manual Credits</a>:</td><td> </td><td align="left"
valign="top">Giving credit to documentation contributors.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Printed-Manuals"
accesskey="6">Printed Manuals</a>:</td><td> </td><td align="left"
valign="top">Mentioning the printed manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#NEWS-File"
accesskey="7">NEWS File</a>:</td><td> </td><td align="left"
valign="top">NEWS files supplement manuals.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Change-Logs"
accesskey="8">Change Logs</a>:</td><td> </td><td align="left"
valign="top">Recording changes.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Man-Pages"
accesskey="9">Man Pages</a>:</td><td> </td><td align="left"
valign="top">Man pages are secondary.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="#Reading-other-Manuals">Reading other
Manuals</a>:</td><td> </td><td align="left" valign="top">How far you
can go in learning
from other manuals.
-</ul>
+</td></tr>
+</table>
-<div class="node">
+<hr>
<a name="GNU-Manuals"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Doc-Strings-and-Manuals">Doc
Strings and Manuals</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#Doc-Strings-and-Manuals" accesskey="n" rel="next">Doc Strings
and Manuals</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="GNU-Manuals-1"></a>
<h3 class="section">6.1 GNU Manuals</h3>
<p>The preferred document format for the GNU system is the Texinfo
@@ -3088,22 +4062,22 @@
HTML output from Texinfo source. See the Texinfo manual, either the
hardcopy, or the on-line version available through <code>info</code> or the
Emacs Info subsystem (<kbd>C-h i</kbd>).
-
- <p>Nowadays some other formats such as Docbook and Sgmltexi can be
+</p>
+<p>Nowadays some other formats such as Docbook and Sgmltexi can be
converted automatically into Texinfo. It is ok to produce the Texinfo
documentation by conversion this way, as long as it gives good results.
-
- <p>Make sure your manual is clear to a reader who knows nothing about the
+</p>
+<p>Make sure your manual is clear to a reader who knows nothing about the
topic and reads it straight through. This means covering basic topics
at the beginning, and advanced topics only later. This also means
defining every specialized term when it is first used.
-
- <p>Programmers tend to carry over the structure of the program as the
+</p>
+<p>Programmers tend to carry over the structure of the program as the
structure for its documentation. But this structure is not
necessarily good for explaining how to use the program; it may be
irrelevant and confusing for a user.
-
- <p>Instead, the right way to structure documentation is according to the
+</p>
+<p>Instead, the right way to structure documentation is according to the
concepts and questions that a user will have in mind when reading it.
This principle applies at every level, from the lowest (ordering
sentences in a paragraph) to the highest (ordering of chapter topics
@@ -3113,87 +4087,86 @@
documentation is to learn to notice when you have unthinkingly
structured the documentation like the implementation, stop yourself,
and look for better alternatives.
-
- <p>For example, each program in the GNU system probably ought to be
+</p>
+<p>For example, each program in the GNU system probably ought to be
documented in one manual; but this does not mean each program should
have its own manual. That would be following the structure of the
implementation, rather than the structure that helps the user
understand.
-
- <p>Instead, each manual should cover a coherent <em>topic</em>. For
example,
+</p>
+<p>Instead, each manual should cover a coherent <em>topic</em>. For example,
instead of a manual for <code>diff</code> and a manual for <code>diff3</code>,
we
have one manual for “comparison of files” which covers both of
those
programs, as well as <code>cmp</code>. By documenting these programs
together, we can make the whole subject clearer.
-
- <p>The manual which discusses a program should certainly document all of
-the program's command-line options and all of its commands. It should
-give examples of their use. But don't organize the manual as a list
+</p>
+<p>The manual which discusses a program should certainly document all of
+the program’s command-line options and all of its commands. It should
+give examples of their use. But don’t organize the manual as a list
of features. Instead, organize it logically, by subtopics. Address
the questions that a user will ask when thinking about the job that
-the program does. Don't just tell the reader what each feature can
+the program does. Don’t just tell the reader what each feature can
do—say what jobs it is good for, and show how to use it for those
jobs. Explain what is recommended usage, and what kinds of usage
users should avoid.
-
- <p>In general, a GNU manual should serve both as tutorial and reference.
+</p>
+<p>In general, a GNU manual should serve both as tutorial and reference.
It should be set up for convenient access to each topic through Info,
and for reading straight through (appendixes aside). A GNU manual
should give a good introduction to a beginner reading through from the
start, and should also provide all the details that hackers want.
The Bison manual is a good example of this—please take a look at it
to see what we mean.
-
- <p>That is not as hard as it first sounds. Arrange each chapter as a
+</p>
+<p>That is not as hard as it first sounds. Arrange each chapter as a
logical breakdown of its topic, but order the sections, and write their
text, so that reading the chapter straight through makes sense. Do
likewise when structuring the book into chapters, and when structuring a
section into paragraphs. The watchword is, <em>at each point, address
the most fundamental and important issue raised by the preceding text.</em>
-
- <p>If necessary, add extra chapters at the beginning of the manual which
+</p>
+<p>If necessary, add extra chapters at the beginning of the manual which
are purely tutorial and cover the basics of the subject. These provide
the framework for a beginner to understand the rest of the manual. The
Bison manual provides a good example of how to do this.
-
- <p>To serve as a reference, a manual should have an Index that list all the
+</p>
+<p>To serve as a reference, a manual should have an Index that list all the
functions, variables, options, and important concepts that are part of
the program. One combined Index should do for a short manual, but
sometimes for a complex package it is better to use multiple indices.
The Texinfo manual includes advice on preparing good index entries, see
-<a href="texinfo.html#Index-Entries">Making Index Entries</a>, and
-see <a href="texinfo.html#Indexing-Commands">Defining the Entries of an
Index</a>.
-
- <p>Don't use Unix man pages as a model for how to write GNU documentation;
+<a
href="http://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Index-Entries";>Making
Index Entries</a> in <cite>GNU Texinfo</cite>, and
+see <a
href="http://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Indexing-Commands";>Defining
the Entries of an
+Index</a> in <cite>GNU Texinfo</cite>.
+</p>
+<p>Don’t use Unix man pages as a model for how to write GNU
documentation;
most of them are terse, badly structured, and give inadequate
explanation of the underlying concepts. (There are, of course, some
exceptions.) Also, Unix man pages use a particular format which is
different from what we use in GNU manuals.
-
- <p>Please include an email address in the manual for where to report
+</p>
+<p>Please include an email address in the manual for where to report
bugs <em>in the text of the manual</em>.
-
- <p>Please do not use the term “pathname” that is used in Unix
+</p>
+<p>Please do not use the term “pathname” that is used in Unix
documentation; use “file name” (two words) instead. We use the
term
“path” only for search paths, which are lists of directory names.
-
- <p>Please do not use the term “illegal” to refer to erroneous
input to
+</p>
+<p>Please do not use the term “illegal” to refer to erroneous
input to
a computer program. Please use “invalid” for this, and reserve the
term “illegal” for activities prohibited by law.
-
- <p>Please do not write ‘<samp><span
class="samp">()</span></samp>’ after a function name just to indicate
+</p>
+<p>Please do not write ‘<samp>()</samp>’ after a function name
just to indicate
it is a function. <code>foo ()</code> is not a function, it is a function
call with no arguments.
-
-<div class="node">
+</p>
+<hr>
<a name="Doc-Strings-and-Manuals"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Manual-Structure-Details">Manual
Structure Details</a>,
-Previous: <a rel="previous" accesskey="p" href="#GNU-Manuals">GNU
Manuals</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#Manual-Structure-Details" accesskey="n" rel="next">Manual
Structure Details</a>, Previous: <a href="#GNU-Manuals" accesskey="p"
rel="previous">GNU Manuals</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Doc-Strings-and-Manuals-1"></a>
<h3 class="section">6.2 Doc Strings and Manuals</h3>
<p>Some programming systems, such as Emacs, provide a documentation string
@@ -3202,12 +4175,12 @@
little additional text to go around them—but you must not do it. That
approach is a fundamental mistake. The text of well-written
documentation strings will be entirely wrong for a manual.
-
- <p>A documentation string needs to stand alone—when it appears on the
+</p>
+<p>A documentation string needs to stand alone—when it appears on the
screen, there will be no other text to introduce or explain it.
Meanwhile, it can be rather informal in style.
-
- <p>The text describing a function or variable in a manual must not stand
+</p>
+<p>The text describing a function or variable in a manual must not stand
alone; it appears in the context of a section or subsection. Other text
at the beginning of the section should explain some of the concepts, and
should often make some general points that apply to several functions or
@@ -3216,100 +4189,92 @@
written to stand alone would repeat some of that information; this
redundancy looks bad. Meanwhile, the informality that is acceptable in
a documentation string is totally unacceptable in a manual.
-
- <p>The only good way to use documentation strings in writing a good manual
+</p>
+<p>The only good way to use documentation strings in writing a good manual
is to use them as a source of information for writing good text.
-
-<div class="node">
+</p>
+<hr>
<a name="Manual-Structure-Details"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#License-for-Manuals">License for
Manuals</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Doc-Strings-and-Manuals">Doc Strings and Manuals</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#License-for-Manuals" accesskey="n" rel="next">License for
Manuals</a>, Previous: <a href="#Doc-Strings-and-Manuals" accesskey="p"
rel="previous">Doc Strings and Manuals</a>, Up: <a href="#Documentation"
accesskey="u" rel="up">Documentation</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Manual-Structure-Details-1"></a>
<h3 class="section">6.3 Manual Structure Details</h3>
+<a name="index-manual-structure"></a>
-<p><a name="index-manual-structure-132"></a>
-The title page of the manual should state the version of the programs or
+<p>The title page of the manual should state the version of the programs or
packages documented in the manual. The Top node of the manual should
also contain this information. If the manual is changing more
frequently than or independent of the program, also state a version
number for the manual in both of these places.
-
- <p>Each program documented in the manual should have a node named
-‘<samp><var>program</var><span class="samp">
Invocation</span></samp>’ or ‘<samp><span class="samp">Invoking
</span><var>program</var></samp>’. This
-node (together with its subnodes, if any) should describe the program's
+</p>
+<p>Each program documented in the manual should have a node named
+‘<samp><var>program</var> Invocation</samp>’ or
‘<samp>Invoking <var>program</var></samp>’. This
+node (together with its subnodes, if any) should describe the program’s
command line arguments and how to run it (the sort of information people
-would look for in a man page). Start with an ‘<samp><span
class="samp">@example</span></samp>’
+would look for in a man page). Start with an
‘<samp>@example</samp>’
containing a template for all the options and arguments that the program
uses.
-
- <p>Alternatively, put a menu item in some menu whose item name fits one of
+</p>
+<p>Alternatively, put a menu item in some menu whose item name fits one of
the above patterns. This identifies the node which that item points to
-as the node for this purpose, regardless of the node's actual name.
-
- <p>The ‘<samp><span class="samp">--usage</span></samp>’ feature
of the Info reader looks for such a node
+as the node for this purpose, regardless of the node’s actual name.
+</p>
+<p>The ‘<samp>--usage</samp>’ feature of the Info reader looks for
such a node
or menu item in order to find the relevant text, so it is essential
for every Texinfo file to have one.
-
- <p>If one manual describes several programs, it should have such a node for
+</p>
+<p>If one manual describes several programs, it should have such a node for
each program described in the manual.
-
-<div class="node">
+</p>
+<hr>
<a name="License-for-Manuals"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Manual-Credits">Manual
Credits</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Manual-Structure-Details">Manual Structure Details</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#Manual-Credits" accesskey="n" rel="next">Manual Credits</a>,
Previous: <a href="#Manual-Structure-Details" accesskey="p"
rel="previous">Manual Structure Details</a>, Up: <a href="#Documentation"
accesskey="u" rel="up">Documentation</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="License-for-Manuals-1"></a>
<h3 class="section">6.4 License for Manuals</h3>
+<a name="index-license-for-manuals"></a>
-<p><a name="index-license-for-manuals-133"></a>
-Please use the GNU Free Documentation License for all GNU manuals that
+<p>Please use the GNU Free Documentation License for all GNU manuals that
are more than a few pages long. Likewise for a collection of short
documents—you only need one copy of the GNU FDL for the whole
collection. For a single short document, you can use a very permissive
non-copyleft license, to avoid taking up space with a long license.
-
- <p>See <a
href="http://www.gnu.org/copyleft/fdl-howto.html";>http://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
+</p>
+<p>See <a
href="http://www.gnu.org/copyleft/fdl-howto.html";>http://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
of how to employ the GFDL.
-
- <p>Note that it is not obligatory to include a copy of the GNU GPL or GNU
+</p>
+<p>Note that it is not obligatory to include a copy of the GNU GPL or GNU
LGPL in a manual whose license is neither the GPL nor the LGPL. It can
-be a good idea to include the program's license in a large manual; in a
+be a good idea to include the program’s license in a large manual; in a
short manual, whose size would be increased considerably by including
-the program's license, it is probably better not to include it.
-
-<div class="node">
+the program’s license, it is probably better not to include it.
+</p>
+<hr>
<a name="Manual-Credits"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Printed-Manuals">Printed
Manuals</a>,
-Previous: <a rel="previous" accesskey="p"
href="#License-for-Manuals">License for Manuals</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#Printed-Manuals" accesskey="n" rel="next">Printed Manuals</a>,
Previous: <a href="#License-for-Manuals" accesskey="p" rel="previous">License
for Manuals</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Manual-Credits-1"></a>
<h3 class="section">6.5 Manual Credits</h3>
+<a name="index-credits-for-manuals"></a>
-<p><a name="index-credits-for-manuals-134"></a>
-Please credit the principal human writers of the manual as the authors,
+<p>Please credit the principal human writers of the manual as the authors,
on the title page of the manual. If a company sponsored the work, thank
the company in a suitable place in the manual, but do not cite the
company as an author.
-
-<div class="node">
+</p>
+<hr>
<a name="Printed-Manuals"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#NEWS-File">NEWS File</a>,
-Previous: <a rel="previous" accesskey="p" href="#Manual-Credits">Manual
Credits</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#NEWS-File" accesskey="n" rel="next">NEWS File</a>, Previous:
<a href="#Manual-Credits" accesskey="p" rel="previous">Manual Credits</a>, Up:
<a href="#Documentation" accesskey="u" rel="up">Documentation</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Printed-Manuals-1"></a>
<h3 class="section">6.6 Printed Manuals</h3>
<p>The FSF publishes some GNU manuals in printed form. To encourage sales
@@ -3318,364 +4283,378 @@
information for getting it—for instance, with a link to the page
<a
href="http://www.gnu.org/order/order.html";>http://www.gnu.org/order/order.html</a>.
This should not be included
in the printed manual, though, because there it is redundant.
-
- <p>It is also useful to explain in the on-line forms of the manual how the
+</p>
+<p>It is also useful to explain in the on-line forms of the manual how the
user can print out the manual from the sources.
-
-<div class="node">
+</p>
+<hr>
<a name="NEWS-File"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Change-Logs">Change Logs</a>,
-Previous: <a rel="previous" accesskey="p" href="#Printed-Manuals">Printed
Manuals</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#Change-Logs" accesskey="n" rel="next">Change Logs</a>,
Previous: <a href="#Printed-Manuals" accesskey="p" rel="previous">Printed
Manuals</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="The-NEWS-File"></a>
<h3 class="section">6.7 The NEWS File</h3>
+<a name="index-NEWS-file"></a>
-<p><a name="index-g_t_0040file_007bNEWS_007d-file-135"></a>
-In addition to its manual, the package should have a file named
-<samp><span class="file">NEWS</span></samp> which contains a list of
user-visible changes worth
+<p>In addition to its manual, the package should have a file named
+‘<tt>NEWS</tt>’ which contains a list of user-visible changes worth
mentioning. In each new release, add items to the front of the file and
-identify the version they pertain to. Don't discard old items; leave
+identify the version they pertain to. Don’t discard old items; leave
them in the file after the newer items. This way, a user upgrading from
any previous version can see what is new.
-
- <p>If the <samp><span class="file">NEWS</span></samp> file gets very long,
move some of the older items
-into a file named <samp><span class="file">ONEWS</span></samp> and put a note
at the end referring the
+</p>
+<p>If the ‘<tt>NEWS</tt>’ file gets very long, move some of the
older items
+into a file named ‘<tt>ONEWS</tt>’ and put a note at the end
referring the
user to that file.
-
-<div class="node">
+</p>
+<hr>
<a name="Change-Logs"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Man-Pages">Man Pages</a>,
-Previous: <a rel="previous" accesskey="p" href="#NEWS-File">NEWS File</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Next: <a href="#Man-Pages" accesskey="n" rel="next">Man Pages</a>, Previous:
<a href="#NEWS-File" accesskey="p" rel="previous">NEWS File</a>, Up: <a
href="#Documentation" accesskey="u" rel="up">Documentation</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Change-Logs-1"></a>
<h3 class="section">6.8 Change Logs</h3>
+<a name="index-change-logs"></a>
-<p><a name="index-change-logs-136"></a>
-Keep a change log to describe all the changes made to program source
+<p>Keep a change log to describe all the changes made to program source
files. The purpose of this is so that people investigating bugs in the
future will know about the changes that might have introduced the bug.
Often a new bug can be found by looking at what was recently changed.
More importantly, change logs can help you eliminate conceptual
inconsistencies between different parts of a program, by giving you a
history of how the conflicting concepts arose and who they came from.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Change-Log-Concepts"
accesskey="1">Change Log Concepts</a>:</td><td> </td><td
align="left" valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Style-of-Change-Logs"
accesskey="2">Style of Change Logs</a>:</td><td> </td><td
align="left" valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Simple-Changes"
accesskey="3">Simple Changes</a>:</td><td> </td><td align="left"
valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Conditional-Changes"
accesskey="4">Conditional Changes</a>:</td><td> </td><td
align="left" valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="#Indicating-the-Part-Changed" accesskey="5">Indicating the Part
Changed</a>:</td><td> </td><td align="left" valign="top">
+</td></tr>
+</table>
-<ul class="menu">
-<li><a accesskey="1" href="#Change-Log-Concepts">Change Log Concepts</a>
-<li><a accesskey="2" href="#Style-of-Change-Logs">Style of Change Logs</a>
-<li><a accesskey="3" href="#Simple-Changes">Simple Changes</a>
-<li><a accesskey="4" href="#Conditional-Changes">Conditional Changes</a>
-<li><a accesskey="5" href="#Indicating-the-Part-Changed">Indicating the Part
Changed</a>
-</ul>
-
-<div class="node">
+<hr>
<a name="Change-Log-Concepts"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Style-of-Change-Logs">Style of
Change Logs</a>,
-Up: <a rel="up" accesskey="u" href="#Change-Logs">Change Logs</a>
-
+<div class="header">
+<p>
+Next: <a href="#Style-of-Change-Logs" accesskey="n" rel="next">Style of Change
Logs</a>, Up: <a href="#Change-Logs" accesskey="u" rel="up">Change Logs</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Change-Log-Concepts-1"></a>
<h4 class="subsection">6.8.1 Change Log Concepts</h4>
<p>You can think of the change log as a conceptual “undo list”
which
explains how earlier versions were different from the current version.
-People can see the current version; they don't need the change log
+People can see the current version; they don’t need the change log
to tell them what is in it. What they want from a change log is a
clear explanation of how the earlier version differed.
-
- <p>The change log file is normally called <samp><span
class="file">ChangeLog</span></samp> and covers an
+</p>
+<p>The change log file is normally called ‘<tt>ChangeLog</tt>’ and
covers an
entire directory. Each directory can have its own change log, or a
-directory can use the change log of its parent directory—it's up to
+directory can use the change log of its parent directory—it’s up to
you.
-
- <p>Another alternative is to record change log information with a version
+</p>
+<p>Another alternative is to record change log information with a version
control system such as RCS or CVS. This can be converted automatically
-to a <samp><span class="file">ChangeLog</span></samp> file using
<code>rcs2log</code>; in Emacs, the command
+to a ‘<tt>ChangeLog</tt>’ file using <code>rcs2log</code>; in
Emacs, the command
<kbd>C-x v a</kbd> (<code>vc-update-change-log</code>) does the job.
-
- <p>There's no need to describe the full purpose of the changes or how
+</p>
+<p>There’s no need to describe the full purpose of the changes or how
they work together. However, sometimes it is useful to write one line
to describe the overall purpose of a change or a batch of changes. If
-you think that a change calls for explanation, you're probably right.
+you think that a change calls for explanation, you’re probably right.
Please do explain it—but please put the full explanation in comments
in the code, where people will see it whenever they see the code. For
example, “New function” is enough for the change log when you add a
function, because there should be a comment before the function
definition to explain what it does.
-
- <p>In the past, we recommended not mentioning changes in non-software
-files (manuals, help files, etc.) in change logs. However, we've been
+</p>
+<p>In the past, we recommended not mentioning changes in non-software
+files (manuals, help files, etc.) in change logs. However, we’ve been
advised that it is a good idea to include them, for the sake of
copyright records.
-
- <p>The easiest way to add an entry to <samp><span
class="file">ChangeLog</span></samp> is with the Emacs
+</p>
+<p>The easiest way to add an entry to ‘<tt>ChangeLog</tt>’ is with
the Emacs
command <kbd>M-x add-change-log-entry</kbd>. An entry should have an
asterisk, the name of the changed file, and then in parentheses the name
of the changed functions, variables or whatever, followed by a colon.
Then describe the changes you made to that function or variable.
-
-<div class="node">
+</p>
+<hr>
<a name="Style-of-Change-Logs"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Simple-Changes">Simple
Changes</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Change-Log-Concepts">Change Log Concepts</a>,
-Up: <a rel="up" accesskey="u" href="#Change-Logs">Change Logs</a>
-
+<div class="header">
+<p>
+Next: <a href="#Simple-Changes" accesskey="n" rel="next">Simple Changes</a>,
Previous: <a href="#Change-Log-Concepts" accesskey="p" rel="previous">Change
Log Concepts</a>, Up: <a href="#Change-Logs" accesskey="u" rel="up">Change
Logs</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Style-of-Change-Logs-1"></a>
<h4 class="subsection">6.8.2 Style of Change Logs</h4>
+<a name="index-change-logs_002c-style"></a>
-<p><a name="index-change-logs_002c-style-137"></a>
-Here are some simple examples of change log entries, starting with the
+<p>Here are some simple examples of change log entries, starting with the
header line that says who made the change and when it was installed,
followed by descriptions of specific changes. (These examples are
drawn from Emacs and GCC.)
+</p>
+<div class="example">
+<pre class="example">1998-08-17 Richard Stallman <address@hidden>
+
+* register.el (insert-register): Return nil.
+(jump-to-register): Likewise.
+
+* sort.el (sort-subr): Return nil.
+
+* tex-mode.el (tex-bibtex-file, tex-file, tex-region):
+Restart the tex shell if process is gone or stopped.
+(tex-shell-running): New function.
+
+* expr.c (store_one_arg): Round size up for move_block_to_reg.
+(expand_call): Round up when emitting USE insns.
+* stmt.c (assign_parms): Round size up for move_block_from_reg.
+</pre></div>
-<pre class="example"> 1998-08-17 Richard Stallman <address@hidden>
-
- * register.el (insert-register): Return nil.
- (jump-to-register): Likewise.
-
- * sort.el (sort-subr): Return nil.
-
- * tex-mode.el (tex-bibtex-file, tex-file, tex-region):
- Restart the tex shell if process is gone or stopped.
- (tex-shell-running): New function.
-
- * expr.c (store_one_arg): Round size up for move_block_to_reg.
- (expand_call): Round up when emitting USE insns.
- * stmt.c (assign_parms): Round size up for move_block_from_reg.
-</pre>
- <p>It's important to name the changed function or variable in full. Don't
-abbreviate function or variable names, and don't combine them.
+<p>It’s important to name the changed function or variable in full.
Don’t
+abbreviate function or variable names, and don’t combine them.
Subsequent maintainers will often search for a function name to find all
the change log entries that pertain to it; if you abbreviate the name,
-they won't find it when they search.
-
- <p>For example, some people are tempted to abbreviate groups of function
-names by writing ‘<samp><span class="samp">* register.el
({insert,jump-to}-register)</span></samp>’;
+they won’t find it when they search.
+</p>
+<p>For example, some people are tempted to abbreviate groups of function
+names by writing ‘<samp>* register.el
({insert,jump-to}-register)</samp>’;
this is not a good idea, since searching for <code>jump-to-register</code> or
<code>insert-register</code> would not find that entry.
-
- <p>Separate unrelated change log entries with blank lines. When two
+</p>
+<p>Separate unrelated change log entries with blank lines. When two
entries represent parts of the same change, so that they work together,
-then don't put blank lines between them. Then you can omit the file
+then don’t put blank lines between them. Then you can omit the file
name and the asterisk when successive entries are in the same file.
+</p>
+<p>Break long lists of function names by closing continued lines with
+‘<samp>)</samp>’, rather than ‘<samp>,</samp>’, and
opening the continuation with
+‘<samp>(</samp>’ as in this example:
+</p>
+<div class="example">
+<pre class="example">* keyboard.c (menu_bar_items, tool_bar_items)
+(Fexecute_extended_command): Deal with 'keymap' property.
+</pre></div>
- <p>Break long lists of function names by closing continued lines with
-‘<samp><span class="samp">)</span></samp>’, rather than
‘<samp><span class="samp">,</span></samp>’, and opening the
continuation with
-‘<samp><span class="samp">(</span></samp>’ as in this example:
-
-<pre class="example"> * keyboard.c (menu_bar_items, tool_bar_items)
- (Fexecute_extended_command): Deal with 'keymap' property.
-</pre>
- <p>When you install someone else's changes, put the contributor's name in
+<p>When you install someone else’s changes, put the contributor’s
name in
the change log entry rather than in the text of the entry. In other
words, write this:
-
-<pre class="example"> 2002-07-14 John Doe <address@hidden>
+</p>
+<div class="example">
+<pre class="example">2002-07-14 John Doe <address@hidden>
* sewing.c: Make it sew.
-</pre>
- <p class="noindent">rather than this:
+</pre></div>
-<pre class="example"> 2002-07-14 Usual Maintainer <address@hidden>
+<p>rather than this:
+</p>
+<div class="example">
+<pre class="example">2002-07-14 Usual Maintainer <address@hidden>
* sewing.c: Make it sew. Patch by address@hidden
-</pre>
- <p>As for the date, that should be the date you applied the change.
+</pre></div>
-<div class="node">
+<p>As for the date, that should be the date you applied the change.
+</p>
+<hr>
<a name="Simple-Changes"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Conditional-Changes">Conditional
Changes</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Style-of-Change-Logs">Style of Change Logs</a>,
-Up: <a rel="up" accesskey="u" href="#Change-Logs">Change Logs</a>
-
+<div class="header">
+<p>
+Next: <a href="#Conditional-Changes" accesskey="n" rel="next">Conditional
Changes</a>, Previous: <a href="#Style-of-Change-Logs" accesskey="p"
rel="previous">Style of Change Logs</a>, Up: <a href="#Change-Logs"
accesskey="u" rel="up">Change Logs</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Simple-Changes-1"></a>
<h4 class="subsection">6.8.3 Simple Changes</h4>
-<p>Certain simple kinds of changes don't need much detail in the change
+<p>Certain simple kinds of changes don’t need much detail in the change
log.
-
- <p>When you change the calling sequence of a function in a simple fashion,
+</p>
+<p>When you change the calling sequence of a function in a simple fashion,
and you change all the callers of the function to use the new calling
sequence, there is no need to make individual entries for all the
callers that you changed. Just write in the entry for the function
being called, “All callers changed”—like this:
+</p>
+<div class="example">
+<pre class="example">* keyboard.c (Fcommand_execute): New arg SPECIAL.
+All callers changed.
+</pre></div>
-<pre class="example"> * keyboard.c (Fcommand_execute): New arg SPECIAL.
- All callers changed.
-</pre>
- <p>When you change just comments or doc strings, it is enough to write an
+<p>When you change just comments or doc strings, it is enough to write an
entry for the file, without mentioning the functions. Just “Doc
fixes” is enough for the change log.
-
- <p>There's no technical need to make change log entries for documentation
+</p>
+<p>There’s no technical need to make change log entries for documentation
files. This is because documentation is not susceptible to bugs that
are hard to fix. Documentation does not consist of parts that must
interact in a precisely engineered fashion. To correct an error, you
need not know the history of the erroneous passage; it is enough to
compare what the documentation says with the way the program actually
works.
-
- <p>However, you should keep change logs for documentation files when the
+</p>
+<p>However, you should keep change logs for documentation files when the
project gets copyright assignments from its contributors, so as to
make the records of authorship more accurate.
-
-<div class="node">
+</p>
+<hr>
<a name="Conditional-Changes"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#Indicating-the-Part-Changed">Indicating the Part Changed</a>,
-Previous: <a rel="previous" accesskey="p" href="#Simple-Changes">Simple
Changes</a>,
-Up: <a rel="up" accesskey="u" href="#Change-Logs">Change Logs</a>
-
+<div class="header">
+<p>
+Next: <a href="#Indicating-the-Part-Changed" accesskey="n"
rel="next">Indicating the Part Changed</a>, Previous: <a href="#Simple-Changes"
accesskey="p" rel="previous">Simple Changes</a>, Up: <a href="#Change-Logs"
accesskey="u" rel="up">Change Logs</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Conditional-Changes-1"></a>
<h4 class="subsection">6.8.4 Conditional Changes</h4>
+<a name="index-conditional-changes_002c-and-change-logs"></a>
+<a name="index-change-logs_002c-conditional-changes"></a>
-<p><a name="index-conditional-changes_002c-and-change-logs-138"></a><a
name="index-change-logs_002c-conditional-changes-139"></a>
-Source files can often contain code that is conditional to build-time
+<p>Source files can often contain code that is conditional to build-time
or static conditions. For example, C programs can contain
compile-time <code>#if</code> conditionals; programs implemented in
interpreted languages can contain module imports of function
definitions that are only performed for certain versions of the
-interpreter; and Automake <samp><span class="file">Makefile.am</span></samp>
files can contain
+interpreter; and Automake ‘<tt>Makefile.am</tt>’ files can contain
variable definitions or target declarations that are only to be
considered if a configure-time Automake conditional is true.
-
- <p>Many changes are conditional as well: sometimes you add a new variable,
+</p>
+<p>Many changes are conditional as well: sometimes you add a new variable,
or function, or even a new program or library, which is entirely
dependent on a build-time condition. It is useful to indicate
in the change log the conditions for which a change applies.
-
- <p>Our convention for indicating conditional changes is to use
+</p>
+<p>Our convention for indicating conditional changes is to use
<em>square brackets around the name of the condition</em>.
-
- <p>Conditional changes can happen in numerous scenarios and with many
+</p>
+<p>Conditional changes can happen in numerous scenarios and with many
variations, so here are some examples to help clarify. This first
example describes changes in C, Perl, and Python files which are
conditional but do not have an associated function or entity name:
-
-<pre class="example"> * xterm.c [SOLARIS2]: Include <string.h>.
- * FilePath.pm [$^O eq 'VMS']: Import the VMS::Feature module.
- * framework.py [sys.version_info < (2, 6)]: Make "with" statement
+</p>
+<div class="example">
+<pre class="example">* xterm.c [SOLARIS2]: Include <string.h>.
+* FilePath.pm [$^O eq 'VMS']: Import the VMS::Feature module.
+* framework.py [sys.version_info < (2, 6)]: Make "with" statement
available by importing it from __future__,
to support also python 2.5.
-</pre>
- <p>Our other examples will for simplicity be limited to C, as the minor
+</pre></div>
+
+<p>Our other examples will for simplicity be limited to C, as the minor
changes necessary to adapt them to other languages should be
self-evident.
-
- <p>Next, here is an entry describing a new definition which is entirely
+</p>
+<p>Next, here is an entry describing a new definition which is entirely
conditional: the C macro <code>FRAME_WINDOW_P</code> is defined (and used)
only when the macro <code>HAVE_X_WINDOWS</code> is defined:
+</p>
+<div class="example">
+<pre class="example">* frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P): Macro
defined.
+</pre></div>
-<pre class="example"> * frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P): Macro
defined.
-</pre>
- <p>Next, an entry for a change within the function
<code>init_display</code>,
+<p>Next, an entry for a change within the function <code>init_display</code>,
whose definition as a whole is unconditional, but the changes
-themselves are contained in a ‘<samp><span class="samp">#ifdef
HAVE_LIBNCURSES</span></samp>’
+themselves are contained in a ‘<samp>#ifdef HAVE_LIBNCURSES</samp>’
conditional:
+</p>
+<div class="example">
+<pre class="example">* dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call
tgetent.
+</pre></div>
-<pre class="example"> * dispnew.c (init_display) [HAVE_LIBNCURSES]: If X,
call tgetent.
-</pre>
- <p>Finally, here is an entry for a change that takes effect only when
+<p>Finally, here is an entry for a change that takes effect only when
a certain macro is <em>not</em> defined:
+</p>
+<div class="example">
+<pre class="example">(gethostname) [!HAVE_SOCKETS]: Replace with winsock
version.
+</pre></div>
-<pre class="example"> (gethostname) [!HAVE_SOCKETS]: Replace with winsock
version.
-</pre>
- <div class="node">
+<hr>
<a name="Indicating-the-Part-Changed"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p"
href="#Conditional-Changes">Conditional Changes</a>,
-Up: <a rel="up" accesskey="u" href="#Change-Logs">Change Logs</a>
-
+<div class="header">
+<p>
+Previous: <a href="#Conditional-Changes" accesskey="p"
rel="previous">Conditional Changes</a>, Up: <a href="#Change-Logs"
accesskey="u" rel="up">Change Logs</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Indicating-the-Part-Changed-1"></a>
<h4 class="subsection">6.8.5 Indicating the Part Changed</h4>
<p>Indicate the part of a function which changed by using angle brackets
enclosing an indication of what the changed part does. Here is an entry
for a change in the part of the function <code>sh-while-getopts</code> that
deals with <code>sh</code> commands:
+</p>
+<div class="example">
+<pre class="example">* progmodes/sh-script.el (sh-while-getopts) <sh>:
Handle case that
+user-specified option string is empty.
+</pre></div>
-<pre class="example"> * progmodes/sh-script.el (sh-while-getopts)
<sh>: Handle case that
- user-specified option string is empty.
-</pre>
- <div class="node">
-<a name="Man-Pages"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Reading-other-Manuals">Reading
other Manuals</a>,
-Previous: <a rel="previous" accesskey="p" href="#Change-Logs">Change
Logs</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
+<hr>
+<a name="Man-Pages"></a>
+<div class="header">
+<p>
+Next: <a href="#Reading-other-Manuals" accesskey="n" rel="next">Reading other
Manuals</a>, Previous: <a href="#Change-Logs" accesskey="p"
rel="previous">Change Logs</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Man-Pages-1"></a>
<h3 class="section">6.9 Man Pages</h3>
+<a name="index-man-pages"></a>
-<p><a name="index-man-pages-140"></a>
-In the GNU project, man pages are secondary. It is not necessary or
+<p>In the GNU project, man pages are secondary. It is not necessary or
expected for every GNU program to have a man page, but some of them do.
-It's your choice whether to include a man page in your program.
-
- <p>When you make this decision, consider that supporting a man page
+It’s your choice whether to include a man page in your program.
+</p>
+<p>When you make this decision, consider that supporting a man page
requires continual effort each time the program is changed. The time
you spend on the man page is time taken away from more useful work.
-
- <p>For a simple program which changes little, updating the man page may be
+</p>
+<p>For a simple program which changes little, updating the man page may be
a small job. Then there is little reason not to include a man page, if
you have one.
-
- <p>For a large program that changes a great deal, updating a man page may
+</p>
+<p>For a large program that changes a great deal, updating a man page may
be a substantial burden. If a user offers to donate a man page, you may
find this gift costly to accept. It may be better to refuse the man
page unless the same person agrees to take full responsibility for
maintaining it—so that you can wash your hands of it entirely. If
-this volunteer later ceases to do the job, then don't feel obliged to
+this volunteer later ceases to do the job, then don’t feel obliged to
pick it up yourself; it may be better to withdraw the man page from the
distribution until someone else agrees to update it.
-
- <p>When a program changes only a little, you may feel that the
+</p>
+<p>When a program changes only a little, you may feel that the
discrepancies are small enough that the man page remains useful without
updating. If so, put a prominent note near the beginning of the man
-page explaining that you don't maintain it and that the Texinfo manual
+page explaining that you don’t maintain it and that the Texinfo manual
is more authoritative. The note should say how to access the Texinfo
documentation.
-
- <p>Be sure that man pages include a copyright statement and free license.
+</p>
+<p>Be sure that man pages include a copyright statement and free license.
The simple all-permissive license is appropriate for simple man pages
-(see <a href="maintain.html#License-Notices-for-Other-Files">License Notices
for Other Files</a>).
-
- <p>For long man pages, with enough explanation and documentation that
-they can be considered true manuals, use the GFDL (see <a
href="#License-for-Manuals">License for Manuals</a>).
-
- <p>Finally, the GNU help2man program
+(see <a
href="http://www.gnu.org/prep/maintain/maintain.html#License-Notices-for-Other-Files";>License
Notices for Other Files</a> in <cite>Information for GNU
+Maintainers</cite>).
+</p>
+<p>For long man pages, with enough explanation and documentation that
+they can be considered true manuals, use the GFDL (see <a
href="#License-for-Manuals">License for
+Manuals</a>).
+</p>
+<p>Finally, the GNU help2man program
(<a
href="http://www.gnu.org/software/help2man/";>http://www.gnu.org/software/help2man/</a>)
is one way to automate
-generation of a man page, in this case from <samp><span
class="option">--help</span></samp> output.
+generation of a man page, in this case from ‘<samp>--help</samp>’
output.
This is sufficient in many cases.
-
-<div class="node">
+</p>
+<hr>
<a name="Reading-other-Manuals"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p" href="#Man-Pages">Man Pages</a>,
-Up: <a rel="up" accesskey="u" href="#Documentation">Documentation</a>
-
+<div class="header">
+<p>
+Previous: <a href="#Man-Pages" accesskey="p" rel="previous">Man Pages</a>, Up:
<a href="#Documentation" accesskey="u" rel="up">Documentation</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Reading-other-Manuals-1"></a>
<h3 class="section">6.10 Reading other Manuals</h3>
<p>There may be non-free books or documentation files that describe the
program you are documenting.
-
- <p>It is ok to use these documents for reference, just as the author of a
+</p>
+<p>It is ok to use these documents for reference, just as the author of a
new algebra textbook can read other books on algebra. A large portion
of any non-fiction book consists of facts, in this case facts about how
a certain program works, and these facts are necessarily the same for
@@ -3683,454 +4662,477 @@
outline structure, wording, tables or examples from preexisting non-free
documentation. Copying from free documentation may be ok; please check
with the FSF about the individual case.
-
-<div class="node">
+</p>
+<hr>
<a name="Managing-Releases"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#References">References</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Documentation">Documentation</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#References" accesskey="n" rel="next">References</a>, Previous:
<a href="#Documentation" accesskey="p" rel="previous">Documentation</a>, Up: <a
href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="The-Release-Process"></a>
<h2 class="chapter">7 The Release Process</h2>
+<a name="index-releasing"></a>
-<p><a name="index-releasing-141"></a>
-Making a release is more than just bundling up your source files in a
+<p>Making a release is more than just bundling up your source files in a
tar file and putting it up for FTP. You should set up your software so
that it can be configured to run on a variety of systems. Your Makefile
should conform to the GNU standards described below, and your directory
layout should also conform to the standards discussed below. Doing so
makes it easy to include your package into the larger framework of
all GNU software.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Configuration"
accesskey="1">Configuration</a>:</td><td> </td><td align="left"
valign="top">How configuration of GNU packages should work.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Makefile-Conventions"
accesskey="2">Makefile Conventions</a>:</td><td> </td><td
align="left" valign="top">Makefile conventions.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Releases"
accesskey="3">Releases</a>:</td><td> </td><td align="left"
valign="top">Making releases
+</td></tr>
+</table>
-<ul class="menu">
-<li><a accesskey="1" href="#Configuration">Configuration</a>:
How configuration of GNU packages should work.
-<li><a accesskey="2" href="#Makefile-Conventions">Makefile Conventions</a>:
Makefile conventions.
-<li><a accesskey="3" href="#Releases">Releases</a>: Making
releases
-</ul>
-
-<div class="node">
+<hr>
<a name="Configuration"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Makefile-Conventions">Makefile
Conventions</a>,
-Up: <a rel="up" accesskey="u" href="#Managing-Releases">Managing
Releases</a>
-
+<div class="header">
+<p>
+Next: <a href="#Makefile-Conventions" accesskey="n" rel="next">Makefile
Conventions</a>, Up: <a href="#Managing-Releases" accesskey="u"
rel="up">Managing Releases</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="How-Configuration-Should-Work"></a>
<h3 class="section">7.1 How Configuration Should Work</h3>
+<a name="index-program-configuration"></a>
-<p><a name="index-program-configuration-142"></a>
-<a name="index-configure-143"></a>Each GNU distribution should come with a
shell script named
+<a name="index-configure"></a>
+<p>Each GNU distribution should come with a shell script named
<code>configure</code>. This script is given arguments which describe the
kind of machine and system you want to compile the program for.
The <code>configure</code> script must record the configuration options so
that they affect compilation.
-
- <p>The description here is the specification of the interface for the
+</p>
+<p>The description here is the specification of the interface for the
<code>configure</code> script in GNU packages. Many packages implement it
-using GNU Autoconf (see <a href="autoconf.html#Top">Introduction</a>)
-and/or GNU Automake (see <a href="automake.html#Top">Introduction</a>),
+using GNU Autoconf (see <a
href="http://www.gnu.org/software/autoconf/manual/autoconf.html#Top";>Introduction</a>
in <cite>Autoconf</cite>)
+and/or GNU Automake (see <a
href="http://www.gnu.org/software/automake/manual/automake.html#Top";>Introduction</a>
in <cite>Automake</cite>),
but you do not have to use these tools. You can implement it any way
you like; for instance, by making <code>configure</code> be a wrapper around
a completely different configuration system.
-
- <p>Another way for the <code>configure</code> script to operate is to make a
-link from a standard name such as <samp><span
class="file">config.h</span></samp> to the proper
+</p>
+<p>Another way for the <code>configure</code> script to operate is to make a
+link from a standard name such as ‘<tt>config.h</tt>’ to the proper
configuration file for the chosen system. If you use this technique,
the distribution should <em>not</em> contain a file named
-<samp><span class="file">config.h</span></samp>. This is so that people won't
be able to build the
+‘<tt>config.h</tt>’. This is so that people won’t be able
to build the
program without configuring it first.
-
- <p>Another thing that <code>configure</code> can do is to edit the
Makefile. If
+</p>
+<p>Another thing that <code>configure</code> can do is to edit the Makefile.
If
you do this, the distribution should <em>not</em> contain a file named
-<samp><span class="file">Makefile</span></samp>. Instead, it should include a
file <samp><span class="file">Makefile.in</span></samp> which
+‘<tt>Makefile</tt>’. Instead, it should include a file
‘<tt>Makefile.in</tt>’ which
contains the input used for editing. Once again, this is so that people
-won't be able to build the program without configuring it first.
-
- <p>If <code>configure</code> does write the <samp><span
class="file">Makefile</span></samp>, then <samp><span
class="file">Makefile</span></samp>
-should have a target named <samp><span class="file">Makefile</span></samp>
which causes <code>configure</code>
+won’t be able to build the program without configuring it first.
+</p>
+<p>If <code>configure</code> does write the ‘<tt>Makefile</tt>’,
then ‘<tt>Makefile</tt>’
+should have a target named ‘<tt>Makefile</tt>’ which causes
<code>configure</code>
to be rerun, setting up the same configuration that was set up last
time. The files that <code>configure</code> reads should be listed as
-dependencies of <samp><span class="file">Makefile</span></samp>.
-
- <p>All the files which are output from the <code>configure</code> script
should
+dependencies of ‘<tt>Makefile</tt>’.
+</p>
+<p>All the files which are output from the <code>configure</code> script should
have comments at the beginning explaining that they were generated
-automatically using <code>configure</code>. This is so that users won't think
+automatically using <code>configure</code>. This is so that users won’t
think
of trying to edit them by hand.
-
- <p>The <code>configure</code> script should write a file named <samp><span
class="file">config.status</span></samp>
+</p>
+<p>The <code>configure</code> script should write a file named
‘<tt>config.status</tt>’
which describes which configuration options were specified when the
program was last configured. This file should be a shell script which,
if run, will recreate the same configuration.
-
- <p>The <code>configure</code> script should accept an option of the form
-‘<samp><span
class="samp">--srcdir=</span><var>dirname</var></samp>’ to specify the
directory where sources are found
+</p>
+<p>The <code>configure</code> script should accept an option of the form
+‘<samp>--srcdir=<var>dirname</var></samp>’ to specify the
directory where sources are found
(if it is not the current directory). This makes it possible to build
the program in a separate directory, so that the actual source directory
is not modified.
-
- <p>If the user does not specify ‘<samp><span
class="samp">--srcdir</span></samp>’, then <code>configure</code> should
-check both <samp><span class="file">.</span></samp> and <samp><span
class="file">..</span></samp> to see if it can find the sources. If
+</p>
+<p>If the user does not specify ‘<samp>--srcdir</samp>’, then
<code>configure</code> should
+check both ‘<tt>.</tt>’ and ‘<tt>..</tt>’ to see if it
can find the sources. If
it finds the sources in one of these places, it should use them from
there. Otherwise, it should report that it cannot find the sources, and
should exit with nonzero status.
-
- <p>Usually the easy way to support ‘<samp><span
class="samp">--srcdir</span></samp>’ is by editing a
+</p>
+<p>Usually the easy way to support ‘<samp>--srcdir</samp>’ is by
editing a
definition of <code>VPATH</code> into the Makefile. Some rules may need to
refer explicitly to the specified source directory. To make this
possible, <code>configure</code> can add to the Makefile a variable named
<code>srcdir</code> whose value is precisely the specified directory.
-
- <p>In addition, the ‘<samp><span
class="samp">configure</span></samp>’ script should take options
+</p>
+<p>In addition, the ‘<samp>configure</samp>’ script should take
options
corresponding to most of the standard directory variables
(see <a href="#Directory-Variables">Directory Variables</a>). Here is the
list:
+</p>
+<div class="example">
+<pre class="example">--prefix --exec-prefix --bindir --sbindir --libexecdir
--sysconfdir
+--sharedstatedir --localstatedir --libdir --includedir --oldincludedir
+--datarootdir --datadir --infodir --localedir --mandir --docdir
+--htmldir --dvidir --pdfdir --psdir
+</pre></div>
-<pre class="example"> --prefix --exec-prefix --bindir --sbindir
--libexecdir --sysconfdir
- --sharedstatedir --localstatedir --libdir --includedir --oldincludedir
- --datarootdir --datadir --infodir --localedir --mandir --docdir
- --htmldir --dvidir --pdfdir --psdir
-</pre>
- <p>The <code>configure</code> script should also take an argument which
specifies the
+<p>The <code>configure</code> script should also take an argument which
specifies the
type of system to build the program for. This argument should look like
this:
-
-<pre class="example"> <var>cpu</var>-<var>company</var>-<var>system</var>
-</pre>
- <p>For example, an Athlon-based GNU/Linux system might be
-‘<samp><span class="samp">i686-pc-linux-gnu</span></samp>’.
-
- <p>The <code>configure</code> script needs to be able to decode all
plausible
+</p>
+<div class="example">
+<pre class="example"><var>cpu</var>-<var>company</var>-<var>system</var>
+</pre></div>
+
+<p>For example, an Athlon-based GNU/Linux system might be
+‘<samp>i686-pc-linux-gnu</samp>’.
+</p>
+<p>The <code>configure</code> script needs to be able to decode all plausible
alternatives for how to describe a machine. Thus,
-‘<samp><span class="samp">athlon-pc-gnu/linux</span></samp>’ would
be a valid alias. There is a shell
+‘<samp>athlon-pc-gnu/linux</samp>’ would be a valid alias. There
is a shell
script called
-<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD";><samp><span
class="file">config.sub</span></samp></a> that you can use as a subroutine to
validate system
+<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD";>‘<tt>config.sub</tt>’</a>
that you can use as a subroutine to validate system
types and canonicalize aliases.
-
- <p>The <code>configure</code> script should also take the option
-<samp><span class="option">--build=</span><var>buildtype</var></samp>, which
should be equivalent to a
-plain <var>buildtype</var> argument. For example, ‘<samp><span
class="samp">configure
---build=i686-pc-linux-gnu</span></samp>’ is equivalent to
‘<samp><span class="samp">configure
-i686-pc-linux-gnu</span></samp>’. When the build type is not specified
by an option
+</p>
+<p>The <code>configure</code> script should also take the option
+‘<samp>--build=<var>buildtype</var></samp>’, which should be
equivalent to a
+plain <var>buildtype</var> argument. For example, ‘<samp>configure
+--build=i686-pc-linux-gnu</samp>’ is equivalent to ‘<samp>configure
+i686-pc-linux-gnu</samp>’. When the build type is not specified by an
option
or argument, the <code>configure</code> script should normally guess it using
the shell script
-<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD";><samp><span
class="file">config.guess</span></samp></a>.
-
- <p><a name="index-optional-features_002c-configure_002dtime-144"></a>Other
options are permitted to specify in more detail the software
+<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD";>‘<tt>config.guess</tt>’</a>.
+</p>
+<a name="index-optional-features_002c-configure_002dtime"></a>
+<p>Other options are permitted to specify in more detail the software
or hardware present on the machine, to include or exclude optional parts
of the package, or to adjust the name of some tools or arguments to them:
-
- <dl>
-<dt>‘<samp><span class="samp">--enable-</span><var>feature</var><span
class="samp">[=</span><var>parameter</var><span
class="samp">]</span></samp>’<dd>Configure the package to build and
install an optional user-level
+</p>
+<dl compact="compact">
+<dt>‘<samp>--enable-<var>feature</var><span
class="roman">[</span>=<var>parameter</var><span
class="roman">]</span></samp>’</dt>
+<dd><p>Configure the package to build and install an optional user-level
facility called <var>feature</var>. This allows users to choose which
optional features to include. Giving an optional <var>parameter</var> of
-‘<samp><span class="samp">no</span></samp>’ should omit
<var>feature</var>, if it is built by default.
-
- <p>No ‘<samp><span class="samp">--enable</span></samp>’
option should <strong>ever</strong> cause one feature to
-replace another. No ‘<samp><span
class="samp">--enable</span></samp>’ option should ever substitute one
+‘<samp>no</samp>’ should omit <var>feature</var>, if it is built
by default.
+</p>
+<p>No ‘<samp>--enable</samp>’ option should <strong>ever</strong>
cause one feature to
+replace another. No ‘<samp>--enable</samp>’ option should ever
substitute one
useful behavior for another useful behavior. The only proper use for
-‘<samp><span class="samp">--enable</span></samp>’ is for questions
of whether to build part of the program
+‘<samp>--enable</samp>’ is for questions of whether to build part
of the program
or exclude it.
-
- <br><dt>‘<samp><span
class="samp">--with-</span><var>package</var></samp>’<dd><!--
@address@hidden@r{]} -->
-The package <var>package</var> will be installed, so configure this package
+</p>
+</dd>
+<dt>‘<samp>--with-<var>package</var></samp>’</dt>
+<dd><p>The package <var>package</var> will be installed, so configure this
package
to work with <var>package</var>.
+</p>
- <!-- Giving an optional @var{parameter} of -->
- <!-- @samp{no} should omit @var{package}, if it is used by default. -->
- <p>Possible values of <var>package</var> include
-‘<samp><span class="samp">gnu-as</span></samp>’ (or
‘<samp><span class="samp">gas</span></samp>’), ‘<samp><span
class="samp">gnu-ld</span></samp>’, ‘<samp><span
class="samp">gnu-libc</span></samp>’,
-‘<samp><span class="samp">gdb</span></samp>’,
-‘<samp><span class="samp">x</span></samp>’,
+<p>Possible values of <var>package</var> include
+‘<samp>gnu-as</samp>’ (or ‘<samp>gas</samp>’),
‘<samp>gnu-ld</samp>’, ‘<samp>gnu-libc</samp>’,
+‘<samp>gdb</samp>’,
+‘<samp>x</samp>’,
and
-‘<samp><span class="samp">x-toolkit</span></samp>’.
-
- <p>Do not use a ‘<samp><span
class="samp">--with</span></samp>’ option to specify the file name to use
to
-find certain files. That is outside the scope of what ‘<samp><span
class="samp">--with</span></samp>’
+‘<samp>x-toolkit</samp>’.
+</p>
+<p>Do not use a ‘<samp>--with</samp>’ option to specify the file
name to use to
+find certain files. That is outside the scope of what
‘<samp>--with</samp>’
options are for.
-
- <br><dt>‘<samp><var>variable</var><span
class="samp">=</span><var>value</var></samp>’<dd>Set the value of the
variable <var>variable</var> to <var>value</var>. This is
+</p>
+</dd>
+<dt>‘<samp><var>variable</var>=<var>value</var></samp>’</dt>
+<dd><p>Set the value of the variable <var>variable</var> to <var>value</var>.
This is
used to override the default values of commands or arguments in the
-build process. For example, the user could issue ‘<samp><span
class="samp">configure
-CFLAGS=-g CXXFLAGS=-g</span></samp>’ to build with debugging information
and without
+build process. For example, the user could issue ‘<samp>configure
+CFLAGS=-g CXXFLAGS=-g</samp>’ to build with debugging information and
without
the default optimization.
-
- <p>Specifying variables as arguments to <code>configure</code>, like this:
- <pre class="example"> ./configure CC=gcc
-</pre>
- <p>is preferable to setting them in environment variables:
- <pre class="example"> CC=gcc ./configure
-</pre>
- <p>as it helps to recreate the same configuration later with
-<samp><span class="file">config.status</span></samp>. However, both methods
should be supported.
+</p>
+<p>Specifying variables as arguments to <code>configure</code>, like this:
+</p><div class="example">
+<pre class="example">./configure CC=gcc
+</pre></div>
+<p>is preferable to setting them in environment variables:
+</p><div class="example">
+<pre class="example">CC=gcc ./configure
+</pre></div>
+<p>as it helps to recreate the same configuration later with
+‘<tt>config.status</tt>’. However, both methods should be
supported.
+</p></dd>
</dl>
- <p>All <code>configure</code> scripts should accept all of the
“detail”
+<p>All <code>configure</code> scripts should accept all of the
“detail”
options and the variable settings, whether or not they make any
difference to the particular package at hand. In particular, they
-should accept any option that starts with ‘<samp><span
class="samp">--with-</span></samp>’ or
-‘<samp><span class="samp">--enable-</span></samp>’. This is so
users will be able to configure an
+should accept any option that starts with ‘<samp>--with-</samp>’ or
+‘<samp>--enable-</samp>’. This is so users will be able to
configure an
entire GNU source tree at once with a single set of options.
-
- <p>You will note that the categories ‘<samp><span
class="samp">--with-</span></samp>’ and ‘<samp><span
class="samp">--enable-</span></samp>’
+</p>
+<p>You will note that the categories ‘<samp>--with-</samp>’ and
‘<samp>--enable-</samp>’
are narrow: they <strong>do not</strong> provide a place for any sort of option
you might think of. That is deliberate. We want to limit the possible
configuration options in GNU software. We do not want GNU programs to
have idiosyncratic configuration options.
-
- <p>Packages that perform part of the compilation process may support
+</p>
+<p>Packages that perform part of the compilation process may support
cross-compilation. In such a case, the host and target machines for the
program may be different.
-
- <p>The <code>configure</code> script should normally treat the specified
type of
+</p>
+<p>The <code>configure</code> script should normally treat the specified type
of
system as both the host and the target, thus producing a program which
works for the same type of machine that it runs on.
-
- <p>To compile a program to run on a host type that differs from the build
-type, use the configure option <samp><span
class="option">--host=</span><var>hosttype</var></samp>, where
+</p>
+<p>To compile a program to run on a host type that differs from the build
+type, use the configure option
‘<samp>--host=<var>hosttype</var></samp>’, where
<var>hosttype</var> uses the same syntax as <var>buildtype</var>. The host
type
normally defaults to the build type.
-
- <p>To configure a cross-compiler, cross-assembler, or what have you, you
+</p>
+<p>To configure a cross-compiler, cross-assembler, or what have you, you
should specify a target different from the host, using the configure
-option ‘<samp><span
class="samp">--target=</span><var>targettype</var></samp>’. The syntax
for
+option ‘<samp>--target=<var>targettype</var></samp>’. The syntax
for
<var>targettype</var> is the same as for the host type. So the command would
look like this:
+</p>
+<div class="example">
+<pre class="example">./configure --host=<var>hosttype</var>
--target=<var>targettype</var>
+</pre></div>
-<pre class="example"> ./configure --host=<var>hosttype</var>
--target=<var>targettype</var>
-</pre>
- <p>The target type normally defaults to the host type.
+<p>The target type normally defaults to the host type.
Programs for which cross-operation is not meaningful need not accept the
-‘<samp><span class="samp">--target</span></samp>’ option, because
configuring an entire operating system for
+‘<samp>--target</samp>’ option, because configuring an entire
operating system for
cross-operation is not a meaningful operation.
-
- <p>Some programs have ways of configuring themselves automatically. If
+</p>
+<p>Some programs have ways of configuring themselves automatically. If
your program is set up to do this, your <code>configure</code> script can
simply
ignore most of its arguments.
+</p>
-<!-- The makefile standards are in a separate file that is also -->
-<!-- included by make.texinfo. Done by address@hidden on 1/6/93. -->
-<!-- For this document, turn chapters into sections, etc. -->
-<!-- This file is included by both standards.texi and make.texinfo. -->
-<!-- It was broken out of standards.texi on 1/6/93 by roland. -->
-<div class="node">
+<hr>
<a name="Makefile-Conventions"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Releases">Releases</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Configuration">Configuration</a>,
-Up: <a rel="up" accesskey="u" href="#Managing-Releases">Managing
Releases</a>
-
+<div class="header">
+<p>
+Next: <a href="#Releases" accesskey="n" rel="next">Releases</a>, Previous: <a
href="#Configuration" accesskey="p" rel="previous">Configuration</a>, Up: <a
href="#Managing-Releases" accesskey="u" rel="up">Managing Releases</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Makefile-Conventions-1"></a>
<h3 class="section">7.2 Makefile Conventions</h3>
+<a name="index-makefile_002c-conventions-for"></a>
+<a name="index-conventions-for-makefiles"></a>
+<a name="index-standards-for-makefiles"></a>
-<p><a name="index-makefile_002c-conventions-for-145"></a><a
name="index-conventions-for-makefiles-146"></a><a
name="index-standards-for-makefiles-147"></a>
-<!-- Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2001, -->
-<!-- 2004, 2005, 2006, 2007, 2008, 2010 Free Software Foundation, Inc. -->
-<!-- Permission is granted to copy, distribute and/or modify this document -->
-<!-- under the terms of the GNU Free Documentation License, Version 1.3 -->
-<!-- or any later version published by the Free Software Foundation; -->
-<!-- with no Invariant Sections, with no -->
-<!-- Front-Cover Texts, and with no Back-Cover Texts. -->
-<!-- A copy of the license is included in the section entitled ``GNU -->
-<!-- Free Documentation License''. -->
- <p>This
+<p>This
describes conventions for writing the Makefiles for GNU programs.
Using Automake will help you write a Makefile that follows these
conventions. For more information on portable Makefiles, see
-<span class="sc">posix</span> and <a
href="autoconf.html#Portable-Make">Portable Make Programming</a>.
+<small>POSIX</small> and <a
href="http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Make";>Portable
Make Programming</a> in <cite>Autoconf</cite>.
+</p>
-<ul class="menu">
-<li><a accesskey="1" href="#Makefile-Basics">Makefile Basics</a>:
General conventions for Makefiles.
-<li><a accesskey="2" href="#Utilities-in-Makefiles">Utilities in
Makefiles</a>: Utilities to be used in Makefiles.
-<li><a accesskey="3" href="#Command-Variables">Command Variables</a>:
Variables for specifying commands.
-<li><a accesskey="4" href="#DESTDIR">DESTDIR</a>:
Supporting staged installs.
-<li><a accesskey="5" href="#Directory-Variables">Directory Variables</a>:
Variables for installation directories.
-<li><a accesskey="6" href="#Standard-Targets">Standard Targets</a>:
Standard targets for users.
-<li><a accesskey="7" href="#Install-Command-Categories">Install Command
Categories</a>: Three categories of commands in the `install'
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="#Makefile-Basics"
accesskey="1">Makefile Basics</a>:</td><td> </td><td align="left"
valign="top">General conventions for Makefiles.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Utilities-in-Makefiles"
accesskey="2">Utilities in Makefiles</a>:</td><td> </td><td
align="left" valign="top">Utilities to be used in Makefiles.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Command-Variables"
accesskey="3">Command Variables</a>:</td><td> </td><td align="left"
valign="top">Variables for specifying commands.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#DESTDIR"
accesskey="4">DESTDIR</a>:</td><td> </td><td align="left"
valign="top">Supporting staged installs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Directory-Variables"
accesskey="5">Directory Variables</a>:</td><td> </td><td
align="left" valign="top">Variables for installation directories.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Standard-Targets"
accesskey="6">Standard Targets</a>:</td><td> </td><td align="left"
valign="top">Standard targets for users.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="#Install-Command-Categories"
accesskey="7">Install Command Categories</a>:</td><td> </td><td
align="left" valign="top">Three categories of commands in the
‘install’
rule: normal, pre-install and post-install.
-</ul>
+</td></tr>
+</table>
-<div class="node">
+<hr>
<a name="Makefile-Basics"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#Utilities-in-Makefiles">Utilities in Makefiles</a>,
-Up: <a rel="up" accesskey="u" href="#Makefile-Conventions">Makefile
Conventions</a>
-
+<div class="header">
+<p>
+Next: <a href="#Utilities-in-Makefiles" accesskey="n" rel="next">Utilities in
Makefiles</a>, Up: <a href="#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="General-Conventions-for-Makefiles"></a>
<h4 class="subsection">7.2.1 General Conventions for Makefiles</h4>
<p>Every Makefile should contain this line:
+</p>
+<div class="example">
+<pre class="example">SHELL = /bin/sh
+</pre></div>
-<pre class="example"> SHELL = /bin/sh
-</pre>
- <p class="noindent">to avoid trouble on systems where the
<code>SHELL</code> variable might be
+<p>to avoid trouble on systems where the <code>SHELL</code> variable might be
inherited from the environment. (This is never a problem with GNU
<code>make</code>.)
-
- <p>Different <code>make</code> programs have incompatible suffix lists and
+</p>
+<p>Different <code>make</code> programs have incompatible suffix lists and
implicit rules, and this sometimes creates confusion or misbehavior. So
it is a good idea to set the suffix list explicitly using only the
suffixes you need in the particular Makefile, like this:
+</p>
+<div class="example">
+<pre class="example">.SUFFIXES:
+.SUFFIXES: .c .o
+</pre></div>
-<pre class="example"> .SUFFIXES:
- .SUFFIXES: .c .o
-</pre>
- <p class="noindent">The first line clears out the suffix list, the second
introduces all
+<p>The first line clears out the suffix list, the second introduces all
suffixes which may be subject to implicit rules in this Makefile.
-
- <p>Don't assume that <samp><span class="file">.</span></samp> is in the
path for command execution. When
+</p>
+<p>Don’t assume that ‘<tt>.</tt>’ is in the path for command
execution. When
you need to run programs that are a part of your package during the
-make, please make sure that it uses <samp><span class="file">./</span></samp>
if the program is built as
-part of the make or <samp><span class="file">$(srcdir)/</span></samp> if the
file is an unchanging part
+make, please make sure that it uses ‘<tt>./</tt>’ if the program
is built as
+part of the make or ‘<tt>$(srcdir)/</tt>’ if the file is an
unchanging part
of the source code. Without one of these prefixes, the current search
path is used.
-
- <p>The distinction between <samp><span class="file">./</span></samp> (the
<dfn>build directory</dfn>) and
-<samp><span class="file">$(srcdir)/</span></samp> (the <dfn>source
directory</dfn>) is important because
-users can build in a separate directory using the ‘<samp><span
class="samp">--srcdir</span></samp>’ option
-to <samp><span class="file">configure</span></samp>. A rule of the form:
-
-<pre class="smallexample"> foo.1 : foo.man sedscript
+</p>
+<p>The distinction between ‘<tt>./</tt>’ (the <em>build
directory</em>) and
+‘<tt>$(srcdir)/</tt>’ (the <em>source directory</em>) is important
because
+users can build in a separate directory using the
‘<samp>--srcdir</samp>’ option
+to ‘<tt>configure</tt>’. A rule of the form:
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.1 : foo.man sedscript
sed -f sedscript foo.man > foo.1
-</pre>
- <p class="noindent">will fail when the build directory is not the source
directory, because
-<samp><span class="file">foo.man</span></samp> and <samp><span
class="file">sedscript</span></samp> are in the source directory.
+</pre></div>
- <p>When using GNU <code>make</code>, relying on ‘<samp><span
class="samp">VPATH</span></samp>’ to find the source
+<p>will fail when the build directory is not the source directory, because
+‘<tt>foo.man</tt>’ and ‘<tt>sedscript</tt>’ are in the
source directory.
+</p>
+<p>When using GNU <code>make</code>, relying on
‘<samp>VPATH</samp>’ to find the source
file will work in the case where there is a single dependency file,
-since the <code>make</code> automatic variable ‘<samp><span
class="samp">$<</span></samp>’ will represent the
-source file wherever it is. (Many versions of <code>make</code> set
‘<samp><span class="samp">$<</span></samp>’
+since the <code>make</code> automatic variable
‘<samp>$<</samp>’ will represent the
+source file wherever it is. (Many versions of <code>make</code> set
‘<samp>$<</samp>’
only in implicit rules.) A Makefile target like
-
-<pre class="smallexample"> foo.o : bar.c
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c bar.c -o foo.o
-</pre>
- <p class="noindent">should instead be written as
+</pre></div>
-<pre class="smallexample"> foo.o : bar.c
+<p>should instead be written as
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c $< -o $@
-</pre>
- <p class="noindent">in order to allow ‘<samp><span
class="samp">VPATH</span></samp>’ to work correctly. When the target has
-multiple dependencies, using an explicit ‘<samp><span
class="samp">$(srcdir)</span></samp>’ is the easiest
-way to make the rule work well. For example, the target above for
-<samp><span class="file">foo.1</span></samp> is best written as:
+</pre></div>
-<pre class="smallexample"> foo.1 : foo.man sedscript
+<p>in order to allow ‘<samp>VPATH</samp>’ to work correctly. When
the target has
+multiple dependencies, using an explicit ‘<samp>$(srcdir)</samp>’
is the easiest
+way to make the rule work well. For example, the target above for
+‘<tt>foo.1</tt>’ is best written as:
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.1 : foo.man sedscript
sed -f $(srcdir)/sedscript $(srcdir)/foo.man > $@
-</pre>
- <p>GNU distributions usually contain some files which are not source
+</pre></div>
+
+<p>GNU distributions usually contain some files which are not source
files—for example, Info files, and the output from Autoconf, Automake,
Bison or Flex. Since these files normally appear in the source
directory, they should always appear in the source directory, not in the
build directory. So Makefile rules to update them should put the
updated files in the source directory.
-
- <p>However, if a file does not appear in the distribution, then the
+</p>
+<p>However, if a file does not appear in the distribution, then the
Makefile should not put it in the source directory, because building a
program in ordinary circumstances should not modify the source directory
in any way.
-
- <p>Try to make the build and installation targets, at least (and all their
+</p>
+<p>Try to make the build and installation targets, at least (and all their
subtargets) work correctly with a parallel <code>make</code>.
-
-<div class="node">
+</p>
+<hr>
<a name="Utilities-in-Makefiles"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Command-Variables">Command
Variables</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Makefile-Basics">Makefile Basics</a>,
-Up: <a rel="up" accesskey="u" href="#Makefile-Conventions">Makefile
Conventions</a>
-
+<div class="header">
+<p>
+Next: <a href="#Command-Variables" accesskey="n" rel="next">Command
Variables</a>, Previous: <a href="#Makefile-Basics" accesskey="p"
rel="previous">Makefile Basics</a>, Up: <a href="#Makefile-Conventions"
accesskey="u" rel="up">Makefile Conventions</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Utilities-in-Makefiles-1"></a>
<h4 class="subsection">7.2.2 Utilities in Makefiles</h4>
<p>Write the Makefile commands (and any shell scripts, such as
<code>configure</code>) to run under <code>sh</code> (both the traditional
Bourne
-shell and the <span class="sc">posix</span> shell), not <code>csh</code>.
Don't use any
-special features of <code>ksh</code> or <code>bash</code>, or <span
class="sc">posix</span> features
+shell and the <small>POSIX</small> shell), not <code>csh</code>. Don’t
use any
+special features of <code>ksh</code> or <code>bash</code>, or
<small>POSIX</small> features
not widely supported in traditional Bourne <code>sh</code>.
-
- <p>The <code>configure</code> script and the Makefile rules for building and
+</p>
+<p>The <code>configure</code> script and the Makefile rules for building and
installation should not use any utilities directly except these:
+</p>
-<!-- dd find -->
-<!-- gunzip gzip md5sum -->
-<!-- mkfifo mknod tee uname -->
-<pre class="example"> awk cat cmp cp diff echo egrep expr false grep
install-info ln ls
- mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true
-</pre>
- <p>Compression programs such as <code>gzip</code> can be used in the
-<code>dist</code> rule.
+<div class="example">
+<pre class="example">awk cat cmp cp diff echo egrep expr false grep
install-info ln ls
+mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true
+</pre></div>
- <p>Generally, stick to the widely-supported (usually
-<span class="sc">posix</span>-specified) options and features of these
programs. For
-example, don't use ‘<samp><span class="samp">mkdir
-p</span></samp>’, convenient as it may be, because a
-few systems don't support it at all and with others, it is not safe
+<p>Compression programs such as <code>gzip</code> can be used in the
+<code>dist</code> rule.
+</p>
+<p>Generally, stick to the widely-supported (usually
+<small>POSIX</small>-specified) options and features of these programs. For
+example, don’t use ‘<samp>mkdir -p</samp>’, convenient as it
may be, because a
+few systems don’t support it at all and with others, it is not safe
for parallel execution. For a list of known incompatibilities, see
-<a href="autoconf.html#Portable-Shell">Portable Shell Programming</a>.
+<a
href="http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell";>Portable
Shell Programming</a> in <cite>Autoconf</cite>.
+</p>
- <p>It is a good idea to avoid creating symbolic links in makefiles, since a
-few file systems don't support them.
-
- <p>The Makefile rules for building and installation can also use compilers
+<p>It is a good idea to avoid creating symbolic links in makefiles, since a
+few file systems don’t support them.
+</p>
+<p>The Makefile rules for building and installation can also use compilers
and related programs, but should do so via <code>make</code> variables so that
the
user can substitute alternatives. Here are some of the programs we
mean:
+</p>
+<div class="example">
+<pre class="example">ar bison cc flex install ld ldconfig lex
+make makeinfo ranlib texi2dvi yacc
+</pre></div>
+
+<p>Use the following <code>make</code> variables to run those programs:
+</p>
+<div class="example">
+<pre class="example">$(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD) $(LDCONFIG)
$(LEX)
+$(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
+</pre></div>
-<pre class="example"> ar bison cc flex install ld ldconfig lex
- make makeinfo ranlib texi2dvi yacc
-</pre>
- <p>Use the following <code>make</code> variables to run those programs:
-
-<pre class="example"> $(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD)
$(LDCONFIG) $(LEX)
- $(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
-</pre>
- <p>When you use <code>ranlib</code> or <code>ldconfig</code>, you should
make sure
+<p>When you use <code>ranlib</code> or <code>ldconfig</code>, you should make
sure
nothing bad happens if the system does not have the program in question.
Arrange to ignore an error from that command, and print a message before
the command to tell the user that failure of this command does not mean
-a problem. (The Autoconf ‘<samp><span
class="samp">AC_PROG_RANLIB</span></samp>’ macro can help with
+a problem. (The Autoconf ‘<samp>AC_PROG_RANLIB</samp>’ macro can
help with
this.)
+</p>
+<p>If you use symbolic links, you should implement a fallback for systems
+that don’t have symbolic links.
+</p>
+<p>Additional utilities that can be used via Make variables are:
+</p>
+<div class="example">
+<pre class="example">chgrp chmod chown mknod
+</pre></div>
- <p>If you use symbolic links, you should implement a fallback for systems
-that don't have symbolic links.
-
- <p>Additional utilities that can be used via Make variables are:
-
-<pre class="example"> chgrp chmod chown mknod
-</pre>
- <p>It is ok to use other utilities in Makefile portions (or scripts)
+<p>It is ok to use other utilities in Makefile portions (or scripts)
intended only for particular systems where you know those utilities
exist.
-
-<div class="node">
+</p>
+<hr>
<a name="Command-Variables"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#DESTDIR">DESTDIR</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Utilities-in-Makefiles">Utilities in Makefiles</a>,
-Up: <a rel="up" accesskey="u" href="#Makefile-Conventions">Makefile
Conventions</a>
-
+<div class="header">
+<p>
+Next: <a href="#DESTDIR" accesskey="n" rel="next">DESTDIR</a>, Previous: <a
href="#Utilities-in-Makefiles" accesskey="p" rel="previous">Utilities in
Makefiles</a>, Up: <a href="#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Variables-for-Specifying-Commands"></a>
<h4 class="subsection">7.2.3 Variables for Specifying Commands</h4>
<p>Makefiles should provide variables for overriding certain commands, options,
and so on.
-
- <p>In particular, you should run most utility programs via variables.
+</p>
+<p>In particular, you should run most utility programs via variables.
Thus, if you use Bison, have a variable named <code>BISON</code> whose default
-value is set with ‘<samp><span class="samp">BISON =
bison</span></samp>’, and refer to it with
+value is set with ‘<samp>BISON = bison</samp>’, and refer to it
with
<code>$(BISON)</code> whenever you need to use Bison.
-
- <p>File management utilities such as <code>ln</code>, <code>rm</code>,
<code>mv</code>, and
+</p>
+<p>File management utilities such as <code>ln</code>, <code>rm</code>,
<code>mv</code>, and
so on, need not be referred to through variables in this way, since users
-don't need to replace them with other programs.
-
- <p>Each program-name variable should come with an options variable that is
-used to supply options to the program. Append ‘<samp><span
class="samp">FLAGS</span></samp>’ to the
+don’t need to replace them with other programs.
+</p>
+<p>Each program-name variable should come with an options variable that is
+used to supply options to the program. Append
‘<samp>FLAGS</samp>’ to the
program-name variable name to get the options variable name—for
example, <code>BISONFLAGS</code>. (The names <code>CFLAGS</code> for the C
compiler, <code>YFLAGS</code> for yacc, and <code>LFLAGS</code> for lex, are
@@ -4138,118 +5140,129 @@
Use <code>CPPFLAGS</code> in any compilation command that runs the
preprocessor, and use <code>LDFLAGS</code> in any compilation command that
does linking as well as in any direct use of <code>ld</code>.
-
- <p>If there are C compiler options that <em>must</em> be used for proper
+</p>
+<p>If there are C compiler options that <em>must</em> be used for proper
compilation of certain files, do not include them in <code>CFLAGS</code>.
Users expect to be able to specify <code>CFLAGS</code> freely themselves.
Instead, arrange to pass the necessary options to the C compiler
independently of <code>CFLAGS</code>, by writing them explicitly in the
compilation commands or by defining an implicit rule, like this:
-
-<pre class="smallexample"> CFLAGS = -g
- ALL_CFLAGS = -I. $(CFLAGS)
- .c.o:
+</p>
+<div class="smallexample">
+<pre class="smallexample">CFLAGS = -g
+ALL_CFLAGS = -I. $(CFLAGS)
+.c.o:
$(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
-</pre>
- <p>Do include the ‘<samp><span class="samp">-g</span></samp>’
option in <code>CFLAGS</code>, because that is not
+</pre></div>
+
+<p>Do include the ‘<samp>-g</samp>’ option in <code>CFLAGS</code>,
because that is not
<em>required</em> for proper compilation. You can consider it a default
that is only recommended. If the package is set up so that it is
-compiled with GCC by default, then you might as well include
‘<samp><span class="samp">-O</span></samp>’
+compiled with GCC by default, then you might as well include
‘<samp>-O</samp>’
in the default value of <code>CFLAGS</code> as well.
-
- <p>Put <code>CFLAGS</code> last in the compilation command, after other
variables
+</p>
+<p>Put <code>CFLAGS</code> last in the compilation command, after other
variables
containing compiler options, so the user can use <code>CFLAGS</code> to
override the others.
-
- <p><code>CFLAGS</code> should be used in every invocation of the C compiler,
+</p>
+<p><code>CFLAGS</code> should be used in every invocation of the C compiler,
both those which do compilation and those which do linking.
-
- <p>Every Makefile should define the variable <code>INSTALL</code>, which is
the
+</p>
+<p>Every Makefile should define the variable <code>INSTALL</code>, which is the
basic command for installing a file into the system.
-
- <p>Every Makefile should also define the variables
<code>INSTALL_PROGRAM</code>
+</p>
+<p>Every Makefile should also define the variables <code>INSTALL_PROGRAM</code>
and <code>INSTALL_DATA</code>. (The default for <code>INSTALL_PROGRAM</code>
should
be <code>$(INSTALL)</code>; the default for <code>INSTALL_DATA</code> should be
<code>${INSTALL} -m 644</code>.) Then it should use those variables as the
commands for actual installation, for executables and non-executables
respectively. Minimal use of these variables is as follows:
+</p>
+<div class="example">
+<pre class="example">$(INSTALL_PROGRAM) foo $(bindir)/foo
+$(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
+</pre></div>
-<pre class="example"> $(INSTALL_PROGRAM) foo $(bindir)/foo
- $(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
-</pre>
- <p>However, it is preferable to support a <code>DESTDIR</code> prefix on the
+<p>However, it is preferable to support a <code>DESTDIR</code> prefix on the
target files, as explained in the next section.
-
- <p>It is acceptable, but not required, to install multiple files in one
+</p>
+<p>It is acceptable, but not required, to install multiple files in one
command, with the final argument being a directory, as in:
+</p>
+<div class="example">
+<pre class="example">$(INSTALL_PROGRAM) foo bar baz $(bindir)
+</pre></div>
-<pre class="example"> $(INSTALL_PROGRAM) foo bar baz $(bindir)
-</pre>
- <div class="node">
-<a name="DESTDIR"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Directory-Variables">Directory
Variables</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Command-Variables">Command Variables</a>,
-Up: <a rel="up" accesskey="u" href="#Makefile-Conventions">Makefile
Conventions</a>
+<hr>
+<a name="DESTDIR"></a>
+<div class="header">
+<p>
+Next: <a href="#Directory-Variables" accesskey="n" rel="next">Directory
Variables</a>, Previous: <a href="#Command-Variables" accesskey="p"
rel="previous">Command Variables</a>, Up: <a href="#Makefile-Conventions"
accesskey="u" rel="up">Makefile Conventions</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="DESTDIR_003a-Support-for-Staged-Installs"></a>
<h4 class="subsection">7.2.4 <code>DESTDIR</code>: Support for Staged
Installs</h4>
-<p><a name="index-DESTDIR-148"></a><a name="index-staged-installs-149"></a><a
name="index-installations_002c-staged-150"></a>
-<code>DESTDIR</code> is a variable prepended to each installed target file,
+<a name="index-DESTDIR"></a>
+<a name="index-staged-installs"></a>
+<a name="index-installations_002c-staged"></a>
+
+<p><code>DESTDIR</code> is a variable prepended to each installed target file,
like this:
+</p>
+<div class="example">
+<pre class="example">$(INSTALL_PROGRAM) foo $(DESTDIR)$(bindir)/foo
+$(INSTALL_DATA) libfoo.a $(DESTDIR)$(libdir)/libfoo.a
+</pre></div>
-<pre class="example"> $(INSTALL_PROGRAM) foo $(DESTDIR)$(bindir)/foo
- $(INSTALL_DATA) libfoo.a $(DESTDIR)$(libdir)/libfoo.a
-</pre>
- <p>The <code>DESTDIR</code> variable is specified by the user on the
<code>make</code>
+<p>The <code>DESTDIR</code> variable is specified by the user on the
<code>make</code>
command line as an absolute file name. For example:
+</p>
+<div class="example">
+<pre class="example">make DESTDIR=/tmp/stage install
+</pre></div>
-<pre class="example"> make DESTDIR=/tmp/stage install
-</pre>
- <p class="noindent"><code>DESTDIR</code> should be supported only in the
<code>install*</code> and
+<p><code>DESTDIR</code> should be supported only in the <code>install*</code>
and
<code>uninstall*</code> targets, as those are the only targets where it is
useful.
-
- <p>If your installation step would normally install
-<samp><span class="file">/usr/local/bin/foo</span></samp> and <samp><span
class="file">/usr/local/lib/libfoo.a</span></samp>, then an
+</p>
+<p>If your installation step would normally install
+‘<tt>/usr/local/bin/foo</tt>’ and
‘<tt>/usr/local/lib/libfoo.a</tt>’, then an
installation invoked as in the example above would install
-<samp><span class="file">/tmp/stage/usr/local/bin/foo</span></samp> and
-<samp><span class="file">/tmp/stage/usr/local/lib/libfoo.a</span></samp>
instead.
-
- <p>Prepending the variable <code>DESTDIR</code> to each target in this way
-provides for <dfn>staged installs</dfn>, where the installed files are not
+‘<tt>/tmp/stage/usr/local/bin/foo</tt>’ and
+‘<tt>/tmp/stage/usr/local/lib/libfoo.a</tt>’ instead.
+</p>
+<p>Prepending the variable <code>DESTDIR</code> to each target in this way
+provides for <em>staged installs</em>, where the installed files are not
placed directly into their expected location but are instead copied
into a temporary location (<code>DESTDIR</code>). However, installed files
maintain their relative directory structure and any embedded file names
will not be modified.
-
- <p>You should not set the value of <code>DESTDIR</code> in your <samp><span
class="file">Makefile</span></samp>
+</p>
+<p>You should not set the value of <code>DESTDIR</code> in your
‘<tt>Makefile</tt>’
at all; then the files are installed into their expected locations by
default. Also, specifying <code>DESTDIR</code> should not change the
operation of the software in any way, so its value should not be
included in any file contents.
-
- <p><code>DESTDIR</code> support is commonly used in package creation. It is
+</p>
+<p><code>DESTDIR</code> support is commonly used in package creation. It is
also helpful to users who want to understand what a given package will
-install where, and to allow users who don't normally have permissions
+install where, and to allow users who don’t normally have permissions
to install into protected areas to build and install before gaining
those permissions. Finally, it can be useful with tools such as
<code>stow</code>, where code is installed in one place but made to appear
to be installed somewhere else using symbolic links or special mount
operations. So, we strongly recommend GNU packages support
<code>DESTDIR</code>, though it is not an absolute requirement.
+</p>
-<div class="node">
+<hr>
<a name="Directory-Variables"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Standard-Targets">Standard
Targets</a>,
-Previous: <a rel="previous" accesskey="p" href="#DESTDIR">DESTDIR</a>,
-Up: <a rel="up" accesskey="u" href="#Makefile-Conventions">Makefile
Conventions</a>
-
+<div class="header">
+<p>
+Next: <a href="#Standard-Targets" accesskey="n" rel="next">Standard
Targets</a>, Previous: <a href="#DESTDIR" accesskey="p"
rel="previous">DESTDIR</a>, Up: <a href="#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Variables-for-Installation-Directories"></a>
<h4 class="subsection">7.2.5 Variables for Installation Directories</h4>
<p>Installation directories should always be named by variables, so it is
@@ -4258,757 +5271,881 @@
described below. They are based on a standard file system layout;
variants of it are used in GNU/Linux and other modern operating
systems.
-
- <p>Installers are expected to override these values when calling
-<samp><span class="command">make</span></samp> (e.g., <kbd>make prefix=/usr
install</kbd> or
-<samp><span class="command">configure</span></samp> (e.g., <kbd>configure
--prefix=/usr</kbd>). GNU
+</p>
+<p>Installers are expected to override these values when calling
+<code>make</code> (e.g., <kbd>make prefix=/usr install</kbd> or
+<code>configure</code> (e.g., <kbd>configure --prefix=/usr</kbd>). GNU
packages should not try to guess which value should be appropriate for
these variables on the system they are being installed onto: use the
default settings specified here so that all GNU packages behave
identically, allowing the installer to achieve any desired layout.
-
- <p><a name="index-directories_002c-creating-installation-151"></a><a
name="index-installation-directories_002c-creating-152"></a>All installation
directories, and their parent directories, should be
+</p>
+<a name="index-directories_002c-creating-installation"></a>
+<a name="index-installation-directories_002c-creating"></a>
+<p>All installation directories, and their parent directories, should be
created (if necessary) before they are installed into.
-
- <p>These first two variables set the root for the installation. All the
+</p>
+<p>These first two variables set the root for the installation. All the
other installation directories should be subdirectories of one of
these two, and nothing should be directly installed into these two
directories.
-
- <dl>
-<dt><code>prefix</code><dd><a name="index-prefix-153"></a>A prefix used in
constructing the default values of the variables listed
-below. The default value of <code>prefix</code> should be <samp><span
class="file">/usr/local</span></samp>.
+</p>
+<dl compact="compact">
+<dt><code>prefix</code></dt>
+<dd><a name="index-prefix"></a>
+<p>A prefix used in constructing the default values of the variables listed
+below. The default value of <code>prefix</code> should be
‘<tt>/usr/local</tt>’.
When building the complete GNU system, the prefix will be empty and
-<samp><span class="file">/usr</span></samp> will be a symbolic link to
<samp><span class="file">/</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@prefix@</span></samp>’.)
-
- <p>Running ‘<samp><span class="samp">make
install</span></samp>’ with a different value of <code>prefix</code> from
+‘<tt>/usr</tt>’ will be a symbolic link to
‘<tt>/</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@prefix@</samp>’.)
+</p>
+<p>Running ‘<samp>make install</samp>’ with a different value of
<code>prefix</code> from
the one used to build the program should <em>not</em> recompile the
program.
-
- <br><dt><code>exec_prefix</code><dd><a
name="index-exec_005fprefix-154"></a>A prefix used in constructing the default
values of some of the
+</p>
+</dd>
+<dt><code>exec_prefix</code></dt>
+<dd><a name="index-exec_005fprefix"></a>
+<p>A prefix used in constructing the default values of some of the
variables listed below. The default value of <code>exec_prefix</code> should
be <code>$(prefix)</code>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@exec_prefix@</span></samp>’.)
-
- <p>Generally, <code>$(exec_prefix)</code> is used for directories that
contain
+(If you are using Autoconf, write it as
‘<samp>@exec_prefix@</samp>’.)
+</p>
+<p>Generally, <code>$(exec_prefix)</code> is used for directories that contain
machine-specific files (such as executables and subroutine libraries),
while <code>$(prefix)</code> is used directly for other directories.
-
- <p>Running ‘<samp><span class="samp">make
install</span></samp>’ with a different value of <code>exec_prefix</code>
+</p>
+<p>Running ‘<samp>make install</samp>’ with a different value of
<code>exec_prefix</code>
from the one used to build the program should <em>not</em> recompile the
program.
+</p></dd>
</dl>
- <p>Executable programs are installed in one of the following directories.
-
- <dl>
-<dt><code>bindir</code><dd><a name="index-bindir-155"></a>The directory for
installing executable programs that users can run.
-This should normally be <samp><span class="file">/usr/local/bin</span></samp>,
but write it as
-<samp><span class="file">$(exec_prefix)/bin</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@bindir@</span></samp>’.)
-
- <br><dt><code>sbindir</code><dd><a name="index-sbindir-156"></a>The
directory for installing executable programs that can be run from
+<p>Executable programs are installed in one of the following directories.
+</p>
+<dl compact="compact">
+<dt><code>bindir</code></dt>
+<dd><a name="index-bindir"></a>
+<p>The directory for installing executable programs that users can run.
+This should normally be ‘<tt>/usr/local/bin</tt>’, but write it as
+‘<tt>$(exec_prefix)/bin</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@bindir@</samp>’.)
+</p>
+</dd>
+<dt><code>sbindir</code></dt>
+<dd><a name="index-sbindir"></a>
+<p>The directory for installing executable programs that can be run from
the shell, but are only generally useful to system administrators. This
-should normally be <samp><span class="file">/usr/local/sbin</span></samp>, but
write it as
-<samp><span class="file">$(exec_prefix)/sbin</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@sbindir@</span></samp>’.)
-
- <br><dt><code>libexecdir</code><dd><a
name="index-libexecdir-157"></a><!-- This paragraph adjusted to avoid overfull
hbox -roland 5jul94 -->
-The directory for installing executable programs to be run by other
+should normally be ‘<tt>/usr/local/sbin</tt>’, but write it as
+‘<tt>$(exec_prefix)/sbin</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@sbindir@</samp>’.)
+</p>
+</dd>
+<dt><code>libexecdir</code></dt>
+<dd><a name="index-libexecdir"></a>
+<p>The directory for installing executable programs to be run by other
programs rather than by users. This directory should normally be
-<samp><span class="file">/usr/local/libexec</span></samp>, but write it as
<samp><span class="file">$(exec_prefix)/libexec</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@libexecdir@</span></samp>’.)
-
- <p>The definition of ‘<samp><span
class="samp">libexecdir</span></samp>’ is the same for all packages, so
+‘<tt>/usr/local/libexec</tt>’, but write it as
‘<tt>$(exec_prefix)/libexec</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@libexecdir@</samp>’.)
+</p>
+<p>The definition of ‘<samp>libexecdir</samp>’ is the same for all
packages, so
you should install your data in a subdirectory thereof. Most packages
-install their data under <samp><span
class="file">$(libexecdir)/</span><var>package-name</var><span
class="file">/</span></samp>,
+install their data under
‘<tt>$(libexecdir)/<var>package-name</var>/</tt>’,
possibly within additional subdirectories thereof, such as
-<samp><span class="file">$(libexecdir)/</span><var>package-name</var><span
class="file">/</span><var>machine</var><span
class="file">/</span><var>version</var></samp>.
+‘<tt>$(libexecdir)/<var>package-name</var>/<var>machine</var>/<var>version</var></tt>’.
+</p></dd>
</dl>
- <p>Data files used by the program during its execution are divided into
+<p>Data files used by the program during its execution are divided into
categories in two ways.
-
- <ul>
-<li>Some files are normally modified by programs; others are never normally
+</p>
+<ul>
+<li> Some files are normally modified by programs; others are never normally
modified (though users may edit some of these).
- <li>Some files are architecture-independent and can be shared by all
+</li><li> Some files are architecture-independent and can be shared by all
machines at a site; some are architecture-dependent and can be shared
only by machines of the same kind and operating system; others may never
be shared between two machines.
-</ul>
+</li></ul>
- <p>This makes for six different possibilities. However, we want to
+<p>This makes for six different possibilities. However, we want to
discourage the use of architecture-dependent files, aside from object
files and libraries. It is much cleaner to make other data files
architecture-independent, and it is generally not hard.
-
- <p>Here are the variables Makefiles should use to specify directories
+</p>
+<p>Here are the variables Makefiles should use to specify directories
to put these various kinds of files in:
-
- <dl>
-<dt>‘<samp><span class="samp">datarootdir</span></samp>’<dd>The
root of the directory tree for read-only architecture-independent
-data files. This should normally be <samp><span
class="file">/usr/local/share</span></samp>, but
-write it as <samp><span class="file">$(prefix)/share</span></samp>. (If you
are using Autoconf, write
-it as ‘<samp><span class="samp">@datarootdir@</span></samp>’.)
‘<samp><span class="samp">datadir</span></samp>’'s default value is
-based on this variable; so are ‘<samp><span
class="samp">infodir</span></samp>’, ‘<samp><span
class="samp">mandir</span></samp>’, and
+</p>
+<dl compact="compact">
+<dt>‘<samp>datarootdir</samp>’</dt>
+<dd><p>The root of the directory tree for read-only architecture-independent
+data files. This should normally be ‘<tt>/usr/local/share</tt>’,
but
+write it as ‘<tt>$(prefix)/share</tt>’. (If you are using
Autoconf, write
+it as ‘<samp>@datarootdir@</samp>’.)
‘<samp>datadir</samp>’’s default value is
+based on this variable; so are ‘<samp>infodir</samp>’,
‘<samp>mandir</samp>’, and
others.
-
- <br><dt>‘<samp><span
class="samp">datadir</span></samp>’<dd>The directory for installing
idiosyncratic read-only
+</p>
+</dd>
+<dt>‘<samp>datadir</samp>’</dt>
+<dd><p>The directory for installing idiosyncratic read-only
architecture-independent data files for this program. This is usually
-the same place as ‘<samp><span
class="samp">datarootdir</span></samp>’, but we use the two separate
+the same place as ‘<samp>datarootdir</samp>’, but we use the two
separate
variables so that you can move these program-specific files without
altering the location for Info files, man pages, etc.
-
- <!-- raggedright (not until next Texinfo release) -->
- <p>This should normally be <samp><span
class="file">/usr/local/share</span></samp>, but write it as
-<samp><span class="file">$(datarootdir)</span></samp>. (If you are using
Autoconf, write it as
-‘<samp><span class="samp">@datadir@</span></samp>’.)
-<!-- end raggedright -->
-
- <p>The definition of ‘<samp><span
class="samp">datadir</span></samp>’ is the same for all packages, so you
+</p>
+<p>This should normally be ‘<tt>/usr/local/share</tt>’, but write
it as
+‘<tt>$(datarootdir)</tt>’. (If you are using Autoconf, write it as
+‘<samp>@datadir@</samp>’.)
+</p>
+<p>The definition of ‘<samp>datadir</samp>’ is the same for all
packages, so you
should install your data in a subdirectory thereof. Most packages
-install their data under <samp><span
class="file">$(datadir)/</span><var>package-name</var><span
class="file">/</span></samp>.
-
- <br><dt>‘<samp><span
class="samp">sysconfdir</span></samp>’<dd>The directory for installing
read-only data files that pertain to a
+install their data under
‘<tt>$(datadir)/<var>package-name</var>/</tt>’.
+</p>
+</dd>
+<dt>‘<samp>sysconfdir</samp>’</dt>
+<dd><p>The directory for installing read-only data files that pertain to a
single machine–that is to say, files for configuring a host. Mailer
-and network configuration files, <samp><span
class="file">/etc/passwd</span></samp>, and so forth belong
+and network configuration files, ‘<tt>/etc/passwd</tt>’, and so
forth belong
here. All the files in this directory should be ordinary ASCII text
-files. This directory should normally be <samp><span
class="file">/usr/local/etc</span></samp>, but
-write it as <samp><span class="file">$(prefix)/etc</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@sysconfdir@</span></samp>’.)
-
- <p>Do not install executables here in this directory (they probably belong
-in <samp><span class="file">$(libexecdir)</span></samp> or <samp><span
class="file">$(sbindir)</span></samp>). Also do not install
+files. This directory should normally be
‘<tt>/usr/local/etc</tt>’, but
+write it as ‘<tt>$(prefix)/etc</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@sysconfdir@</samp>’.)
+</p>
+<p>Do not install executables here in this directory (they probably belong
+in ‘<tt>$(libexecdir)</tt>’ or ‘<tt>$(sbindir)</tt>’).
Also do not install
files that are modified in the normal course of their use (programs
whose purpose is to change the configuration of the system excluded).
-Those probably belong in <samp><span
class="file">$(localstatedir)</span></samp>.
-
- <br><dt>‘<samp><span
class="samp">sharedstatedir</span></samp>’<dd>The directory for
installing architecture-independent data files which
+Those probably belong in ‘<tt>$(localstatedir)</tt>’.
+</p>
+</dd>
+<dt>‘<samp>sharedstatedir</samp>’</dt>
+<dd><p>The directory for installing architecture-independent data files which
the programs modify while they run. This should normally be
-<samp><span class="file">/usr/local/com</span></samp>, but write it as
<samp><span class="file">$(prefix)/com</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@sharedstatedir@</span></samp>’.)
-
- <br><dt>‘<samp><span
class="samp">localstatedir</span></samp>’<dd>The directory for installing
data files which the programs modify while
+‘<tt>/usr/local/com</tt>’, but write it as
‘<tt>$(prefix)/com</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@sharedstatedir@</samp>’.)
+</p>
+</dd>
+<dt>‘<samp>localstatedir</samp>’</dt>
+<dd><p>The directory for installing data files which the programs modify while
they run, and that pertain to one specific machine. Users should never
-need to modify files in this directory to configure the package's
+need to modify files in this directory to configure the package’s
operation; put such configuration information in separate files that go
-in <samp><span class="file">$(datadir)</span></samp> or <samp><span
class="file">$(sysconfdir)</span></samp>. <samp><span
class="file">$(localstatedir)</span></samp>
-should normally be <samp><span class="file">/usr/local/var</span></samp>, but
write it as
-<samp><span class="file">$(prefix)/var</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@localstatedir@</span></samp>’.)
+in ‘<tt>$(datadir)</tt>’ or ‘<tt>$(sysconfdir)</tt>’.
‘<tt>$(localstatedir)</tt>’
+should normally be ‘<tt>/usr/local/var</tt>’, but write it as
+‘<tt>$(prefix)/var</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@localstatedir@</samp>’.)
+</p></dd>
</dl>
- <p>These variables specify the directory for installing certain specific
+<p>These variables specify the directory for installing certain specific
types of files, if your program has them. Every GNU package should
-have Info files, so every program needs ‘<samp><span
class="samp">infodir</span></samp>’, but not all
-need ‘<samp><span class="samp">libdir</span></samp>’ or
‘<samp><span class="samp">lispdir</span></samp>’.
-
- <dl>
-<dt>‘<samp><span class="samp">includedir</span></samp>’<dd>The
directory for installing header files to be included by user
-programs with the C ‘<samp><span
class="samp">#include</span></samp>’ preprocessor directive. This
-should normally be <samp><span class="file">/usr/local/include</span></samp>,
but write it as
-<samp><span class="file">$(prefix)/include</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@includedir@</span></samp>’.)
-
- <p>Most compilers other than GCC do not look for header files in directory
-<samp><span class="file">/usr/local/include</span></samp>. So installing the
header files this way is
+have Info files, so every program needs ‘<samp>infodir</samp>’,
but not all
+need ‘<samp>libdir</samp>’ or ‘<samp>lispdir</samp>’.
+</p>
+<dl compact="compact">
+<dt>‘<samp>includedir</samp>’</dt>
+<dd><p>The directory for installing header files to be included by user
+programs with the C ‘<samp>#include</samp>’ preprocessor
directive. This
+should normally be ‘<tt>/usr/local/include</tt>’, but write it as
+‘<tt>$(prefix)/include</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@includedir@</samp>’.)
+</p>
+<p>Most compilers other than GCC do not look for header files in directory
+‘<tt>/usr/local/include</tt>’. So installing the header files
this way is
only useful with GCC. Sometimes this is not a problem because some
libraries are only really intended to work with GCC. But some libraries
are intended to work with other compilers. They should install their
header files in two places, one specified by <code>includedir</code> and one
specified by <code>oldincludedir</code>.
-
- <br><dt>‘<samp><span
class="samp">oldincludedir</span></samp>’<dd>The directory for installing
‘<samp><span class="samp">#include</span></samp>’ header files for
use with
-compilers other than GCC. This should normally be <samp><span
class="file">/usr/include</span></samp>.
-(If you are using Autoconf, you can write it as ‘<samp><span
class="samp">@oldincludedir@</span></samp>’.)
-
- <p>The Makefile commands should check whether the value of
+</p>
+</dd>
+<dt>‘<samp>oldincludedir</samp>’</dt>
+<dd><p>The directory for installing ‘<samp>#include</samp>’ header
files for use with
+compilers other than GCC. This should normally be
‘<tt>/usr/include</tt>’.
+(If you are using Autoconf, you can write it as
‘<samp>@oldincludedir@</samp>’.)
+</p>
+<p>The Makefile commands should check whether the value of
<code>oldincludedir</code> is empty. If it is, they should not try to use
it; they should cancel the second installation of the header files.
-
- <p>A package should not replace an existing header in this directory
unless
+</p>
+<p>A package should not replace an existing header in this directory unless
the header came from the same package. Thus, if your Foo package
-provides a header file <samp><span class="file">foo.h</span></samp>, then it
should install the header
+provides a header file ‘<tt>foo.h</tt>’, then it should install
the header
file in the <code>oldincludedir</code> directory if either (1) there is no
-<samp><span class="file">foo.h</span></samp> there or (2) the <samp><span
class="file">foo.h</span></samp> that exists came from the Foo
+‘<tt>foo.h</tt>’ there or (2) the ‘<tt>foo.h</tt>’
that exists came from the Foo
package.
-
- <p>To tell whether <samp><span class="file">foo.h</span></samp> came from
the Foo package, put a magic
+</p>
+<p>To tell whether ‘<tt>foo.h</tt>’ came from the Foo package, put
a magic
string in the file—part of a comment—and <code>grep</code> for
that string.
-
- <br><dt>‘<samp><span
class="samp">docdir</span></samp>’<dd>The directory for installing
documentation files (other than Info) for
+</p>
+</dd>
+<dt>‘<samp>docdir</samp>’</dt>
+<dd><p>The directory for installing documentation files (other than Info) for
this package. By default, it should be
-<samp><span
class="file">/usr/local/share/doc/</span><var>yourpkg</var></samp>, but it
should be written as
-<samp><span class="file">$(datarootdir)/doc/</span><var>yourpkg</var></samp>.
(If you are using Autoconf,
-write it as ‘<samp><span class="samp">@docdir@</span></samp>’.)
The <var>yourpkg</var> subdirectory, which
+‘<tt>/usr/local/share/doc/<var>yourpkg</var></tt>’, but it should
be written as
+‘<tt>$(datarootdir)/doc/<var>yourpkg</var></tt>’. (If you are
using Autoconf,
+write it as ‘<samp>@docdir@</samp>’.) The <var>yourpkg</var>
subdirectory, which
may include a version number, prevents collisions among files with
-common names, such as <samp><span class="file">README</span></samp>.
-
- <br><dt>‘<samp><span
class="samp">infodir</span></samp>’<dd>The directory for installing the
Info files for this package. By
-default, it should be <samp><span
class="file">/usr/local/share/info</span></samp>, but it should be
-written as <samp><span class="file">$(datarootdir)/info</span></samp>. (If
you are using Autoconf,
-write it as ‘<samp><span class="samp">@infodir@</span></samp>’.)
<code>infodir</code> is separate from
+common names, such as ‘<tt>README</tt>’.
+</p>
+</dd>
+<dt>‘<samp>infodir</samp>’</dt>
+<dd><p>The directory for installing the Info files for this package. By
+default, it should be ‘<tt>/usr/local/share/info</tt>’, but it
should be
+written as ‘<tt>$(datarootdir)/info</tt>’. (If you are using
Autoconf,
+write it as ‘<samp>@infodir@</samp>’.) <code>infodir</code> is
separate from
<code>docdir</code> for compatibility with existing practice.
-
- <br><dt>‘<samp><span
class="samp">htmldir</span></samp>’<dt>‘<samp><span
class="samp">dvidir</span></samp>’<dt>‘<samp><span
class="samp">pdfdir</span></samp>’<dt>‘<samp><span
class="samp">psdir</span></samp>’<dd>Directories for installing
documentation files in the particular
+</p>
+</dd>
+<dt>‘<samp>htmldir</samp>’</dt>
+<dt>‘<samp>dvidir</samp>’</dt>
+<dt>‘<samp>pdfdir</samp>’</dt>
+<dt>‘<samp>psdir</samp>’</dt>
+<dd><p>Directories for installing documentation files in the particular
format. They should all be set to <code>$(docdir)</code> by default. (If
-you are using Autoconf, write them as ‘<samp><span
class="samp">@htmldir@</span></samp>’,
-‘<samp><span class="samp">@dvidir@</span></samp>’, etc.) Packages
which supply several translations
+you are using Autoconf, write them as ‘<samp>@htmldir@</samp>’,
+‘<samp>@dvidir@</samp>’, etc.) Packages which supply several
translations
of their documentation should install them in
-‘<samp><span class="samp">$(htmldir)/</span></samp>’<var>ll</var>,
‘<samp><span class="samp">$(pdfdir)/</span></samp>’<var>ll</var>,
etc. where
-<var>ll</var> is a locale abbreviation such as ‘<samp><span
class="samp">en</span></samp>’ or ‘<samp><span
class="samp">pt_BR</span></samp>’.
-
- <br><dt>‘<samp><span
class="samp">libdir</span></samp>’<dd>The directory for object files and
libraries of object code. Do not
-install executables here, they probably ought to go in <samp><span
class="file">$(libexecdir)</span></samp>
+‘<samp>$(htmldir)/</samp>’<var>ll</var>,
‘<samp>$(pdfdir)/</samp>’<var>ll</var>, etc. where
+<var>ll</var> is a locale abbreviation such as ‘<samp>en</samp>’
or ‘<samp>pt_BR</samp>’.
+</p>
+</dd>
+<dt>‘<samp>libdir</samp>’</dt>
+<dd><p>The directory for object files and libraries of object code. Do not
+install executables here, they probably ought to go in
‘<tt>$(libexecdir)</tt>’
instead. The value of <code>libdir</code> should normally be
-<samp><span class="file">/usr/local/lib</span></samp>, but write it as
<samp><span class="file">$(exec_prefix)/lib</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@libdir@</span></samp>’.)
-
- <br><dt>‘<samp><span
class="samp">lispdir</span></samp>’<dd>The directory for installing any
Emacs Lisp files in this package. By
-default, it should be <samp><span
class="file">/usr/local/share/emacs/site-lisp</span></samp>, but it
-should be written as <samp><span
class="file">$(datarootdir)/emacs/site-lisp</span></samp>.
-
- <p>If you are using Autoconf, write the default as ‘<samp><span
class="samp">@lispdir@</span></samp>’.
-In order to make ‘<samp><span
class="samp">@lispdir@</span></samp>’ work, you need the following lines
-in your <samp><span class="file">configure.in</span></samp> file:
-
- <pre class="example"> lispdir='${datarootdir}/emacs/site-lisp'
- AC_SUBST(lispdir)
-</pre>
- <br><dt>‘<samp><span
class="samp">localedir</span></samp>’<dd>The directory for installing
locale-specific message catalogs for this
-package. By default, it should be <samp><span
class="file">/usr/local/share/locale</span></samp>, but
-it should be written as <samp><span
class="file">$(datarootdir)/locale</span></samp>. (If you are
-using Autoconf, write it as ‘<samp><span
class="samp">@localedir@</span></samp>’.) This directory
+‘<tt>/usr/local/lib</tt>’, but write it as
‘<tt>$(exec_prefix)/lib</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@libdir@</samp>’.)
+</p>
+</dd>
+<dt>‘<samp>lispdir</samp>’</dt>
+<dd><p>The directory for installing any Emacs Lisp files in this package. By
+default, it should be ‘<tt>/usr/local/share/emacs/site-lisp</tt>’,
but it
+should be written as ‘<tt>$(datarootdir)/emacs/site-lisp</tt>’.
+</p>
+<p>If you are using Autoconf, write the default as
‘<samp>@lispdir@</samp>’.
+In order to make ‘<samp>@lispdir@</samp>’ work, you need the
following lines
+in your ‘<tt>configure.in</tt>’ file:
+</p>
+<div class="example">
+<pre class="example">lispdir='${datarootdir}/emacs/site-lisp'
+AC_SUBST(lispdir)
+</pre></div>
+
+</dd>
+<dt>‘<samp>localedir</samp>’</dt>
+<dd><p>The directory for installing locale-specific message catalogs for this
+package. By default, it should be
‘<tt>/usr/local/share/locale</tt>’, but
+it should be written as ‘<tt>$(datarootdir)/locale</tt>’. (If you
are
+using Autoconf, write it as ‘<samp>@localedir@</samp>’.) This
directory
usually has a subdirectory per locale.
+</p></dd>
</dl>
- <p>Unix-style man pages are installed in one of the following:
-
- <dl>
-<dt>‘<samp><span class="samp">mandir</span></samp>’<dd>The
top-level directory for installing the man pages (if any) for this
-package. It will normally be <samp><span
class="file">/usr/local/share/man</span></samp>, but you
-should write it as <samp><span class="file">$(datarootdir)/man</span></samp>.
(If you are using
-Autoconf, write it as ‘<samp><span
class="samp">@mandir@</span></samp>’.)
-
- <br><dt>‘<samp><span
class="samp">man1dir</span></samp>’<dd>The directory for installing
section 1 man pages. Write it as
-<samp><span class="file">$(mandir)/man1</span></samp>.
-<br><dt>‘<samp><span class="samp">man2dir</span></samp>’<dd>The
directory for installing section 2 man pages. Write it as
-<samp><span class="file">$(mandir)/man2</span></samp>
-<br><dt>‘<samp><span class="samp">...</span></samp>’<dd>
-<strong>Don't make the primary documentation for any GNU software be a
+<p>Unix-style man pages are installed in one of the following:
+</p>
+<dl compact="compact">
+<dt>‘<samp>mandir</samp>’</dt>
+<dd><p>The top-level directory for installing the man pages (if any) for this
+package. It will normally be ‘<tt>/usr/local/share/man</tt>’, but
you
+should write it as ‘<tt>$(datarootdir)/man</tt>’. (If you are
using
+Autoconf, write it as ‘<samp>@mandir@</samp>’.)
+</p>
+</dd>
+<dt>‘<samp>man1dir</samp>’</dt>
+<dd><p>The directory for installing section 1 man pages. Write it as
+‘<tt>$(mandir)/man1</tt>’.
+</p></dd>
+<dt>‘<samp>man2dir</samp>’</dt>
+<dd><p>The directory for installing section 2 man pages. Write it as
+‘<tt>$(mandir)/man2</tt>’
+</p></dd>
+<dt>‘<samp>…</samp>’</dt>
+<dd>
+<p><strong>Don’t make the primary documentation for any GNU software be a
man page. Write a manual in Texinfo instead. Man pages are just for
the sake of people running GNU software on Unix, which is a secondary
application only.</strong>
-
- <br><dt>‘<samp><span
class="samp">manext</span></samp>’<dd>The file name extension for the
installed man page. This should contain
-a period followed by the appropriate digit; it should normally be
‘<samp><span class="samp">.1</span></samp>’.
-
- <br><dt>‘<samp><span
class="samp">man1ext</span></samp>’<dd>The file name extension for
installed section 1 man pages.
-<br><dt>‘<samp><span class="samp">man2ext</span></samp>’<dd>The
file name extension for installed section 2 man pages.
-<br><dt>‘<samp><span class="samp">...</span></samp>’<dd>Use these
names instead of ‘<samp><span class="samp">manext</span></samp>’ if
the package needs to install man
+</p>
+</dd>
+<dt>‘<samp>manext</samp>’</dt>
+<dd><p>The file name extension for the installed man page. This should contain
+a period followed by the appropriate digit; it should normally be
‘<samp>.1</samp>’.
+</p>
+</dd>
+<dt>‘<samp>man1ext</samp>’</dt>
+<dd><p>The file name extension for installed section 1 man pages.
+</p></dd>
+<dt>‘<samp>man2ext</samp>’</dt>
+<dd><p>The file name extension for installed section 2 man pages.
+</p></dd>
+<dt>‘<samp>…</samp>’</dt>
+<dd><p>Use these names instead of ‘<samp>manext</samp>’ if the
package needs to install man
pages in more than one section of the manual.
+</p></dd>
</dl>
- <p>And finally, you should set the following variable:
-
- <dl>
-<dt>‘<samp><span class="samp">srcdir</span></samp>’<dd>The
directory for the sources being compiled. The value of this
+<p>And finally, you should set the following variable:
+</p>
+<dl compact="compact">
+<dt>‘<samp>srcdir</samp>’</dt>
+<dd><p>The directory for the sources being compiled. The value of this
variable is normally inserted by the <code>configure</code> shell script.
-(If you are using Autoconf, use ‘<samp><span class="samp">srcdir =
@srcdir@</span></samp>’.)
+(If you are using Autoconf, use ‘<samp>srcdir = @srcdir@</samp>’.)
+</p></dd>
</dl>
- <p>For example:
+<p>For example:
+</p>
+<div class="smallexample">
+<pre class="smallexample"># Common prefix for installation directories.
+# NOTE: This directory must exist when you start the install.
+prefix = /usr/local
+datarootdir = $(prefix)/share
+datadir = $(datarootdir)
+exec_prefix = $(prefix)
+# Where to put the executable for the command `gcc'.
+bindir = $(exec_prefix)/bin
+# Where to put the directories used by the compiler.
+libexecdir = $(exec_prefix)/libexec
+# Where to put the Info files.
+infodir = $(datarootdir)/info
+</pre></div>
-<pre class="smallexample"> <!-- I have changed some of the comments here
slightly to fix an overfull -->
- <!-- hbox, so the make manual can format correctly. -roland -->
- # Common prefix for installation directories.
- # NOTE: This directory must exist when you start the install.
- prefix = /usr/local
- datarootdir = $(prefix)/share
- datadir = $(datarootdir)
- exec_prefix = $(prefix)
- # Where to put the executable for the command `gcc'.
- bindir = $(exec_prefix)/bin
- # Where to put the directories used by the compiler.
- libexecdir = $(exec_prefix)/libexec
- # Where to put the Info files.
- infodir = $(datarootdir)/info
-</pre>
- <p>If your program installs a large number of files into one of the
+<p>If your program installs a large number of files into one of the
standard user-specified directories, it might be useful to group them
into a subdirectory particular to that program. If you do this, you
should write the <code>install</code> rule to create these subdirectories.
-
- <p>Do not expect the user to include the subdirectory name in the value of
+</p>
+<p>Do not expect the user to include the subdirectory name in the value of
any of the variables listed above. The idea of having a uniform set of
variable names for installation directories is to enable the user to
specify the exact same values for several different GNU packages. In
order for this to be useful, all the packages must be designed so that
they will work sensibly when the user does so.
-
- <p>At times, not all of these variables may be implemented in the current
+</p>
+<p>At times, not all of these variables may be implemented in the current
release of Autoconf and/or Automake; but as of Autoconf 2.60, we
believe all of them are. When any are missing, the descriptions here
serve as specifications for what Autoconf will implement. As a
programmer, you can either use a development version of Autoconf or
avoid using these variables until a stable release is made which
supports them.
+</p>
-<div class="node">
+<hr>
<a name="Standard-Targets"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#Install-Command-Categories">Install Command Categories</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Directory-Variables">Directory Variables</a>,
-Up: <a rel="up" accesskey="u" href="#Makefile-Conventions">Makefile
Conventions</a>
-
+<div class="header">
+<p>
+Next: <a href="#Install-Command-Categories" accesskey="n" rel="next">Install
Command Categories</a>, Previous: <a href="#Directory-Variables" accesskey="p"
rel="previous">Directory Variables</a>, Up: <a href="#Makefile-Conventions"
accesskey="u" rel="up">Makefile Conventions</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Standard-Targets-for-Users"></a>
<h4 class="subsection">7.2.6 Standard Targets for Users</h4>
<p>All GNU programs should have the following targets in their Makefiles:
-
- <dl>
-<dt>‘<samp><span class="samp">all</span></samp>’<dd>Compile the
entire program. This should be the default target. This
+</p>
+<dl compact="compact">
+<dt>‘<samp>all</samp>’</dt>
+<dd><p>Compile the entire program. This should be the default target. This
target need not rebuild any documentation files; Info files should
normally be included in the distribution, and DVI (and other
documentation format) files should be made only when explicitly asked
for.
-
- <p>By default, the Make rules should compile and link with
‘<samp><span class="samp">-g</span></samp>’, so
+</p>
+<p>By default, the Make rules should compile and link with
‘<samp>-g</samp>’, so
that executable programs have debugging symbols. Otherwise, you are
essentially helpless in the face of a crash, and it is often far from
easy to reproduce with a fresh build.
-
- <br><dt>‘<samp><span
class="samp">install</span></samp>’<dd>Compile the program and copy the
executables, libraries, and so on to
+</p>
+</dd>
+<dt>‘<samp>install</samp>’</dt>
+<dd><p>Compile the program and copy the executables, libraries, and so on to
the file names where they should reside for actual use. If there is a
simple test to verify that a program is properly installed, this target
should run that test.
-
- <p>Do not strip executables when installing them. This helps eventual
+</p>
+<p>Do not strip executables when installing them. This helps eventual
debugging that may be needed later, and nowadays disk space is cheap
and dynamic loaders typically ensure debug sections are not loaded during
normal execution. Users that need stripped binaries may invoke the
<code>install-strip</code> target to do that.
-
- <p>If possible, write the <code>install</code> target rule so that it
does not
+</p>
+<p>If possible, write the <code>install</code> target rule so that it does not
modify anything in the directory where the program was built, provided
-‘<samp><span class="samp">make all</span></samp>’ has just been
done. This is convenient for building the
+‘<samp>make all</samp>’ has just been done. This is convenient
for building the
program under one user name and installing it under another.
-
- <p>The commands should create all the directories in which files are to be
-installed, if they don't already exist. This includes the directories
+</p>
+<p>The commands should create all the directories in which files are to be
+installed, if they don’t already exist. This includes the directories
specified as the values of the variables <code>prefix</code> and
<code>exec_prefix</code>, as well as all subdirectories that are needed.
One way to do this is by means of an <code>installdirs</code> target
as described below.
-
- <p>Use ‘<samp><span class="samp">-</span></samp>’ before any
command for installing a man page, so that
+</p>
+<p>Use ‘<samp>-</samp>’ before any command for installing a man
page, so that
<code>make</code> will ignore any errors. This is in case there are systems
-that don't have the Unix man page documentation system installed.
-
- <p>The way to install Info files is to copy them into <samp><span
class="file">$(infodir)</span></samp>
+that don’t have the Unix man page documentation system installed.
+</p>
+<p>The way to install Info files is to copy them into
‘<tt>$(infodir)</tt>’
with <code>$(INSTALL_DATA)</code> (see <a href="#Command-Variables">Command
Variables</a>), and then run
the <code>install-info</code> program if it is present.
<code>install-info</code>
-is a program that edits the Info <samp><span class="file">dir</span></samp>
file to add or update the
+is a program that edits the Info ‘<tt>dir</tt>’ file to add or
update the
menu entry for the given Info file; it is part of the Texinfo package.
-
- <p>Here is a sample rule to install an Info file that also tries to
+</p>
+<p>Here is a sample rule to install an Info file that also tries to
handle some additional situations, such as <code>install-info</code> not
being present.
-
- <!-- This example has been carefully formatted for the Make manual. -->
- <!-- Please do not reformat it without talking to address@hidden -->
- <pre class="smallexample"> do-install-info: foo.info installdirs
+</p>
+<div class="smallexample">
+<pre class="smallexample">do-install-info: foo.info installdirs
$(NORMAL_INSTALL)
- # Prefer an info file in . to one in srcdir.
+# Prefer an info file in . to one in srcdir.
if test -f foo.info; then d=.; \
- else d="$(srcdir)"; fi; \
+ else d="$(srcdir)"; fi; \
$(INSTALL_DATA) $$d/foo.info \
- "$(DESTDIR)$(infodir)/foo.info"
- # Run install-info only if it exists.
- # Use `if' instead of just prepending `-' to the
- # line so we notice real errors from install-info.
- # Use `$(SHELL) -c' because some shells do not
- # fail gracefully when there is an unknown command.
+ "$(DESTDIR)$(infodir)/foo.info"
+# Run install-info only if it exists.
+# Use `if' instead of just prepending `-' to the
+# line so we notice real errors from install-info.
+# Use `$(SHELL) -c' because some shells do not
+# fail gracefully when there is an unknown command.
$(POST_INSTALL)
if $(SHELL) -c 'install-info --version' \
>/dev/null 2>&1; then \
- install-info --dir-file="$(DESTDIR)$(infodir)/dir" \
- "$(DESTDIR)$(infodir)/foo.info"; \
+ install-info --dir-file="$(DESTDIR)$(infodir)/dir" \
+ "$(DESTDIR)$(infodir)/foo.info"; \
else true; fi
-</pre>
- <p>When writing the <code>install</code> target, you must classify all the
-commands into three categories: normal ones, <dfn>pre-installation</dfn>
-commands and <dfn>post-installation</dfn> commands. See <a
href="#Install-Command-Categories">Install Command Categories</a>.
+</pre></div>
- <br><dt>‘<samp><span
class="samp">install-html</span></samp>’<dt>‘<samp><span
class="samp">install-dvi</span></samp>’<dt>‘<samp><span
class="samp">install-pdf</span></samp>’<dt>‘<samp><span
class="samp">install-ps</span></samp>’<dd>These targets install
documentation in formats other than Info;
-they're intended to be called explicitly by the person installing the
+<p>When writing the <code>install</code> target, you must classify all the
+commands into three categories: normal ones, <em>pre-installation</em>
+commands and <em>post-installation</em> commands. See <a
href="#Install-Command-Categories">Install Command
+Categories</a>.
+</p>
+</dd>
+<dt>‘<samp>install-html</samp>’</dt>
+<dt>‘<samp>install-dvi</samp>’</dt>
+<dt>‘<samp>install-pdf</samp>’</dt>
+<dt>‘<samp>install-ps</samp>’</dt>
+<dd><p>These targets install documentation in formats other than Info;
+they’re intended to be called explicitly by the person installing the
package, if that format is desired. GNU prefers Info files, so these
must be installed by the <code>install</code> target.
-
- <p>When you have many documentation files to install, we recommend that
+</p>
+<p>When you have many documentation files to install, we recommend that
you avoid collisions and clutter by arranging for these targets to
install in subdirectories of the appropriate installation directory,
such as <code>htmldir</code>. As one example, if your package has multiple
manuals, and you wish to install HTML documentation with many files
-(such as the “split” mode output by <code>makeinfo --html</code>),
you'll
+(such as the “split” mode output by <code>makeinfo --html</code>),
you’ll
certainly want to use subdirectories, or two nodes with the same name
in different manuals will overwrite each other.
-
- <p>Please make these <code>install-</code><var>format</var> targets
invoke the
+</p>
+<p>Please make these <code>install-<var>format</var></code> targets invoke the
commands for the <var>format</var> target, for example, by making
<var>format</var> a dependency.
-
- <br><dt>‘<samp><span
class="samp">uninstall</span></samp>’<dd>Delete all the installed
files—the copies that the ‘<samp><span
class="samp">install</span></samp>’
-and ‘<samp><span class="samp">install-*</span></samp>’ targets
create.
-
- <p>This rule should not modify the directories where compilation is done,
+</p>
+</dd>
+<dt>‘<samp>uninstall</samp>’</dt>
+<dd><p>Delete all the installed files—the copies that the
‘<samp>install</samp>’
+and ‘<samp>install-*</samp>’ targets create.
+</p>
+<p>This rule should not modify the directories where compilation is done,
only the directories where files are installed.
-
- <p>The uninstallation commands are divided into three categories, just
like
+</p>
+<p>The uninstallation commands are divided into three categories, just like
the installation commands. See <a href="#Install-Command-Categories">Install
Command Categories</a>.
-
- <br><dt>‘<samp><span
class="samp">install-strip</span></samp>’<dd>Like <code>install</code>,
but strip the executable files while installing
+</p>
+</dd>
+<dt>‘<samp>install-strip</samp>’</dt>
+<dd><p>Like <code>install</code>, but strip the executable files while
installing
them. In simple cases, this target can use the <code>install</code> target in
a simple way:
-
- <pre class="smallexample"> install-strip:
+</p>
+<div class="smallexample">
+<pre class="smallexample">install-strip:
$(MAKE) INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' \
install
-</pre>
- <p>But if the package installs scripts as well as real executables, the
-<code>install-strip</code> target can't just refer to the <code>install</code>
-target; it has to strip the executables but not the scripts.
+</pre></div>
- <p><code>install-strip</code> should not strip the executables in the
build
+<p>But if the package installs scripts as well as real executables, the
+<code>install-strip</code> target can’t just refer to the
<code>install</code>
+target; it has to strip the executables but not the scripts.
+</p>
+<p><code>install-strip</code> should not strip the executables in the build
directory which are being copied for installation. It should only strip
the copies that are installed.
-
- <p>Normally we do not recommend stripping an executable unless you are
sure
+</p>
+<p>Normally we do not recommend stripping an executable unless you are sure
the program has no bugs. However, it can be reasonable to install a
stripped executable for actual execution while saving the unstripped
executable elsewhere in case there is a bug.
-
- <br><dt>‘<samp><span
class="samp">clean</span></samp>’<dd>Delete all files in the current
directory that are normally created by
+</p>
+</dd>
+<dt>‘<samp>clean</samp>’</dt>
+<dd><p>Delete all files in the current directory that are normally created by
building the program. Also delete files in other directories if they
-are created by this makefile. However, don't delete the files that
+are created by this makefile. However, don’t delete the files that
record the configuration. Also preserve files that could be made by
-building, but normally aren't because the distribution comes with
+building, but normally aren’t because the distribution comes with
them. There is no need to delete parent directories that were created
-with ‘<samp><span class="samp">mkdir -p</span></samp>’, since they
could have existed anyway.
-
- <p>Delete <samp><span class="file">.dvi</span></samp> files here if they
are not part of the distribution.
-
- <br><dt>‘<samp><span
class="samp">distclean</span></samp>’<dd>Delete all files in the current
directory (or created by this
+with ‘<samp>mkdir -p</samp>’, since they could have existed anyway.
+</p>
+<p>Delete ‘<tt>.dvi</tt>’ files here if they are not part of the
distribution.
+</p>
+</dd>
+<dt>‘<samp>distclean</samp>’</dt>
+<dd><p>Delete all files in the current directory (or created by this
makefile) that are created by configuring or building the program. If
you have unpacked the source and built the program without creating
-any other files, ‘<samp><span class="samp">make
distclean</span></samp>’ should leave only the files
+any other files, ‘<samp>make distclean</samp>’ should leave only
the files
that were in the distribution. However, there is no need to delete
-parent directories that were created with ‘<samp><span
class="samp">mkdir -p</span></samp>’, since they
+parent directories that were created with ‘<samp>mkdir -p</samp>’,
since they
could have existed anyway.
-
- <br><dt>‘<samp><span
class="samp">mostlyclean</span></samp>’<dd>Like ‘<samp><span
class="samp">clean</span></samp>’, but may refrain from deleting a few
files that people
-normally don't want to recompile. For example, the ‘<samp><span
class="samp">mostlyclean</span></samp>’
-target for GCC does not delete <samp><span
class="file">libgcc.a</span></samp>, because recompiling it
+</p>
+</dd>
+<dt>‘<samp>mostlyclean</samp>’</dt>
+<dd><p>Like ‘<samp>clean</samp>’, but may refrain from deleting a
few files that people
+normally don’t want to recompile. For example, the
‘<samp>mostlyclean</samp>’
+target for GCC does not delete ‘<tt>libgcc.a</tt>’, because
recompiling it
is rarely necessary and takes a lot of time.
-
- <br><dt>‘<samp><span
class="samp">maintainer-clean</span></samp>’<dd>Delete almost everything
that can be reconstructed with this Makefile.
+</p>
+</dd>
+<dt>‘<samp>maintainer-clean</samp>’</dt>
+<dd><p>Delete almost everything that can be reconstructed with this Makefile.
This typically includes everything deleted by <code>distclean</code>, plus
more: C source files produced by Bison, tags tables, Info files, and
so on.
-
- <p>The reason we say “almost everything” is that running the
command
-‘<samp><span class="samp">make maintainer-clean</span></samp>’
should not delete <samp><span class="file">configure</span></samp> even
-if <samp><span class="file">configure</span></samp> can be remade using a rule
in the Makefile. More
-generally, ‘<samp><span class="samp">make
maintainer-clean</span></samp>’ should not delete anything
-that needs to exist in order to run <samp><span
class="file">configure</span></samp> and then begin to
+</p>
+<p>The reason we say “almost everything” is that running the
command
+‘<samp>make maintainer-clean</samp>’ should not delete
‘<tt>configure</tt>’ even
+if ‘<tt>configure</tt>’ can be remade using a rule in the
Makefile. More
+generally, ‘<samp>make maintainer-clean</samp>’ should not delete
anything
+that needs to exist in order to run ‘<tt>configure</tt>’ and then
begin to
build the program. Also, there is no need to delete parent
-directories that were created with ‘<samp><span class="samp">mkdir
-p</span></samp>’, since they could
+directories that were created with ‘<samp>mkdir -p</samp>’, since
they could
have existed anyway. These are the only exceptions;
<code>maintainer-clean</code> should delete everything else that can be
rebuilt.
-
- <p>The ‘<samp><span
class="samp">maintainer-clean</span></samp>’ target is intended to be
used by a maintainer of
+</p>
+<p>The ‘<samp>maintainer-clean</samp>’ target is intended to be
used by a maintainer of
the package, not by ordinary users. You may need special tools to
-reconstruct some of the files that ‘<samp><span class="samp">make
maintainer-clean</span></samp>’ deletes.
-Since these files are normally included in the distribution, we don't
+reconstruct some of the files that ‘<samp>make
maintainer-clean</samp>’ deletes.
+Since these files are normally included in the distribution, we don’t
take care to make them easy to reconstruct. If you find you need to
-unpack the full distribution again, don't blame us.
-
- <p>To help make users aware of this, the commands for the special
+unpack the full distribution again, don’t blame us.
+</p>
+<p>To help make users aware of this, the commands for the special
<code>maintainer-clean</code> target should start with these two:
-
- <pre class="smallexample"> @echo 'This command is intended for
maintainers to use; it'
- @echo 'deletes files that may need special tools to rebuild.'
-</pre>
- <br><dt>‘<samp><span
class="samp">TAGS</span></samp>’<dd>Update a tags table for this program.
-<!-- ADR: how? -->
-
- <br><dt>‘<samp><span
class="samp">info</span></samp>’<dd>Generate any Info files needed. The
best way to write the rules is as
+</p>
+<div class="smallexample">
+<pre class="smallexample">@echo 'This command is intended for maintainers to
use; it'
address@hidden 'deletes files that may need special tools to rebuild.'
+</pre></div>
+
+</dd>
+<dt>‘<samp>TAGS</samp>’</dt>
+<dd><p>Update a tags table for this program.
+</p>
+</dd>
+<dt>‘<samp>info</samp>’</dt>
+<dd><p>Generate any Info files needed. The best way to write the rules is as
follows:
+</p>
+<div class="smallexample">
+<pre class="smallexample">info: foo.info
- <pre class="smallexample"> info: foo.info
-
- foo.info: foo.texi chap1.texi chap2.texi
+foo.info: foo.texi chap1.texi chap2.texi
$(MAKEINFO) $(srcdir)/foo.texi
-</pre>
- <p class="noindent">You must define the variable <code>MAKEINFO</code> in
the Makefile. It should
+</pre></div>
+
+<p>You must define the variable <code>MAKEINFO</code> in the Makefile. It
should
run the <code>makeinfo</code> program, which is part of the Texinfo
distribution.
-
- <p>Normally a GNU distribution comes with Info files, and that means the
+</p>
+<p>Normally a GNU distribution comes with Info files, and that means the
Info files are present in the source directory. Therefore, the Make
rule for an info file should update it in the source directory. When
users build the package, ordinarily Make will not update the Info files
because they will already be up to date.
-
- <br><dt>‘<samp><span
class="samp">dvi</span></samp>’<dt>‘<samp><span
class="samp">html</span></samp>’<dt>‘<samp><span
class="samp">pdf</span></samp>’<dt>‘<samp><span
class="samp">ps</span></samp>’<dd>Generate documentation files in the
given format. These targets
+</p>
+</dd>
+<dt>‘<samp>dvi</samp>’</dt>
+<dt>‘<samp>html</samp>’</dt>
+<dt>‘<samp>pdf</samp>’</dt>
+<dt>‘<samp>ps</samp>’</dt>
+<dd><p>Generate documentation files in the given format. These targets
should always exist, but any or all can be a no-op if the given output
format cannot be generated. These targets should not be dependencies
of the <code>all</code> target; the user must manually invoke them.
+</p>
+<p>Here’s an example rule for generating DVI files from Texinfo:
+</p>
+<div class="smallexample">
+<pre class="smallexample">dvi: foo.dvi
- <p>Here's an example rule for generating DVI files from Texinfo:
-
- <pre class="smallexample"> dvi: foo.dvi
-
- foo.dvi: foo.texi chap1.texi chap2.texi
+foo.dvi: foo.texi chap1.texi chap2.texi
$(TEXI2DVI) $(srcdir)/foo.texi
-</pre>
- <p class="noindent">You must define the variable <code>TEXI2DVI</code> in
the Makefile. It
+</pre></div>
+
+<p>You must define the variable <code>TEXI2DVI</code> in the Makefile. It
should run the program <code>texi2dvi</code>, which is part of the Texinfo
distribution. (<code>texi2dvi</code> uses TeX to do the real work of
formatting. TeX is not distributed with Texinfo.) Alternatively,
write only the dependencies, and allow GNU <code>make</code> to provide the
command.
+</p>
+<p>Here’s another example, this one for generating HTML from Texinfo:
+</p>
+<div class="smallexample">
+<pre class="smallexample">html: foo.html
- <p>Here's another example, this one for generating HTML from Texinfo:
-
- <pre class="smallexample"> html: foo.html
-
- foo.html: foo.texi chap1.texi chap2.texi
+foo.html: foo.texi chap1.texi chap2.texi
$(TEXI2HTML) $(srcdir)/foo.texi
-</pre>
- <p class="noindent">Again, you would define the variable
<code>TEXI2HTML</code> in the Makefile;
-for example, it might run <code>makeinfo --no-split --html</code>
-(<samp><span class="command">makeinfo</span></samp> is part of the Texinfo
distribution).
+</pre></div>
- <br><dt>‘<samp><span
class="samp">dist</span></samp>’<dd>Create a distribution tar file for
this program. The tar file should be
+<p>Again, you would define the variable <code>TEXI2HTML</code> in the Makefile;
+for example, it might run <code>makeinfo --no-split --html</code>
+(<code>makeinfo</code> is part of the Texinfo distribution).
+</p>
+</dd>
+<dt>‘<samp>dist</samp>’</dt>
+<dd><p>Create a distribution tar file for this program. The tar file should be
set up so that the file names in the tar file start with a subdirectory
name which is the name of the package it is a distribution for. This
name can include the version number.
-
- <p>For example, the distribution tar file of GCC version 1.40 unpacks into
-a subdirectory named <samp><span class="file">gcc-1.40</span></samp>.
-
- <p>The easiest way to do this is to create a subdirectory appropriately
+</p>
+<p>For example, the distribution tar file of GCC version 1.40 unpacks into
+a subdirectory named ‘<tt>gcc-1.40</tt>’.
+</p>
+<p>The easiest way to do this is to create a subdirectory appropriately
named, use <code>ln</code> or <code>cp</code> to install the proper files in
it, and
then <code>tar</code> that subdirectory.
-
- <p>Compress the tar file with <code>gzip</code>. For example, the actual
-distribution file for GCC version 1.40 is called <samp><span
class="file">gcc-1.40.tar.gz</span></samp>.
+</p>
+<p>Compress the tar file with <code>gzip</code>. For example, the actual
+distribution file for GCC version 1.40 is called
‘<tt>gcc-1.40.tar.gz</tt>’.
It is ok to support other free compression formats as well.
-
- <p>The <code>dist</code> target should explicitly depend on all
non-source files
+</p>
+<p>The <code>dist</code> target should explicitly depend on all non-source
files
that are in the distribution, to make sure they are up to date in the
distribution.
See <a href="#Releases">Making Releases</a>.
-
- <br><dt>‘<samp><span
class="samp">check</span></samp>’<dd>Perform self-tests (if any). The
user must build the program before
+</p>
+</dd>
+<dt>‘<samp>check</samp>’</dt>
+<dd><p>Perform self-tests (if any). The user must build the program before
running the tests, but need not install the program; you should write
the self-tests so that they work when the program is built but not
installed.
+</p></dd>
</dl>
- <p>The following targets are suggested as conventional names, for programs
+<p>The following targets are suggested as conventional names, for programs
in which they are useful.
-
- <dl>
-<dt><code>installcheck</code><dd>Perform installation tests (if any). The
user must build and install
+</p>
+<dl compact="compact">
+<dt><code>installcheck</code></dt>
+<dd><p>Perform installation tests (if any). The user must build and install
the program before running the tests. You should not assume that
-<samp><span class="file">$(bindir)</span></samp> is in the search path.
-
- <br><dt><code>installdirs</code><dd>It's useful to add a target named
‘<samp><span class="samp">installdirs</span></samp>’ to create the
+‘<tt>$(bindir)</tt>’ is in the search path.
+</p>
+</dd>
+<dt><code>installdirs</code></dt>
+<dd><p>It’s useful to add a target named
‘<samp>installdirs</samp>’ to create the
directories where files are installed, and their parent directories.
-There is a script called <samp><span class="file">mkinstalldirs</span></samp>
which is convenient for
+There is a script called ‘<tt>mkinstalldirs</tt>’ which is
convenient for
this; you can find it in the Gnulib package.
You can use a rule like this:
-
- <!-- This has been carefully formatted to look decent in the Make manual.
-->
- <!-- Please be sure not to make it extend any further to the
right.-roland -->
- <pre class="smallexample"> # Make sure all installation
directories (e.g. $(bindir))
- # actually exist by making them if necessary.
- installdirs: mkinstalldirs
+</p>
+<div class="smallexample">
+<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+# actually exist by making them if necessary.
+installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs $(bindir) $(datadir) \
$(libdir) $(infodir) \
$(mandir)
-</pre>
- <p class="noindent">or, if you wish to support <samp><span
class="env">DESTDIR</span></samp> (strongly encouraged),
+</pre></div>
- <pre class="smallexample"> # Make sure all installation
directories (e.g. $(bindir))
- # actually exist by making them if necessary.
- installdirs: mkinstalldirs
+<p>or, if you wish to support <code>DESTDIR</code> (strongly encouraged),
+</p>
+<div class="smallexample">
+<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+# actually exist by making them if necessary.
+installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs \
$(DESTDIR)$(bindir) $(DESTDIR)$(datadir) \
$(DESTDIR)$(libdir) $(DESTDIR)$(infodir) \
$(DESTDIR)$(mandir)
-</pre>
- <p>This rule should not modify the directories where compilation is done.
+</pre></div>
+
+<p>This rule should not modify the directories where compilation is done.
It should do nothing but create installation directories.
+</p></dd>
</dl>
-<div class="node">
+<hr>
<a name="Install-Command-Categories"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p"
href="#Standard-Targets">Standard Targets</a>,
-Up: <a rel="up" accesskey="u" href="#Makefile-Conventions">Makefile
Conventions</a>
-
+<div class="header">
+<p>
+Previous: <a href="#Standard-Targets" accesskey="p" rel="previous">Standard
Targets</a>, Up: <a href="#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Install-Command-Categories-1"></a>
<h4 class="subsection">7.2.7 Install Command Categories</h4>
-<p><a name="index-pre_002dinstallation-commands-158"></a><a
name="index-post_002dinstallation-commands-159"></a>When writing the
<code>install</code> target, you must classify all the
-commands into three categories: normal ones, <dfn>pre-installation</dfn>
-commands and <dfn>post-installation</dfn> commands.
-
- <p>Normal commands move files into their proper places, and set their
+<a name="index-pre_002dinstallation-commands"></a>
+<a name="index-post_002dinstallation-commands"></a>
+<p>When writing the <code>install</code> target, you must classify all the
+commands into three categories: normal ones, <em>pre-installation</em>
+commands and <em>post-installation</em> commands.
+</p>
+<p>Normal commands move files into their proper places, and set their
modes. They may not alter any files except the ones that come entirely
from the package they belong to.
-
- <p>Pre-installation and post-installation commands may alter other files;
+</p>
+<p>Pre-installation and post-installation commands may alter other files;
in particular, they can edit global configuration files or data bases.
-
- <p>Pre-installation commands are typically executed before the normal
+</p>
+<p>Pre-installation commands are typically executed before the normal
commands, and post-installation commands are typically run after the
normal commands.
-
- <p>The most common use for a post-installation command is to run
+</p>
+<p>The most common use for a post-installation command is to run
<code>install-info</code>. This cannot be done with a normal command, since
it alters a file (the Info directory) which does not come entirely and
solely from the package being installed. It is a post-installation
command because it needs to be done after the normal command which
-installs the package's Info files.
-
- <p>Most programs don't need any pre-installation commands, but we have the
+installs the package’s Info files.
+</p>
+<p>Most programs don’t need any pre-installation commands, but we have
the
feature just in case it is needed.
-
- <p>To classify the commands in the <code>install</code> rule into these
three
-categories, insert <dfn>category lines</dfn> among them. A category line
+</p>
+<p>To classify the commands in the <code>install</code> rule into these three
+categories, insert <em>category lines</em> among them. A category line
specifies the category for the commands that follow.
-
- <p>A category line consists of a tab and a reference to a special Make
+</p>
+<p>A category line consists of a tab and a reference to a special Make
variable, plus an optional comment at the end. There are three
variables you can use, one for each category; the variable name
specifies the category. Category lines are no-ops in ordinary execution
because these three Make variables are normally undefined (and you
<em>should not</em> define them in the makefile).
-
- <p>Here are the three possible category lines, each with a comment that
+</p>
+<p>Here are the three possible category lines, each with a comment that
explains what it means:
-
+</p>
+<div class="smallexample">
<pre class="smallexample"> $(PRE_INSTALL) # <span
class="roman">Pre-install commands follow.</span>
$(POST_INSTALL) # <span class="roman">Post-install commands
follow.</span>
$(NORMAL_INSTALL) # <span class="roman">Normal commands
follow.</span>
-</pre>
- <p>If you don't use a category line at the beginning of the
<code>install</code>
+</pre></div>
+
+<p>If you don’t use a category line at the beginning of the
<code>install</code>
rule, all the commands are classified as normal until the first category
-line. If you don't use any category lines, all the commands are
+line. If you don’t use any category lines, all the commands are
classified as normal.
-
- <p>These are the category lines for <code>uninstall</code>:
-
+</p>
+<p>These are the category lines for <code>uninstall</code>:
+</p>
+<div class="smallexample">
<pre class="smallexample"> $(PRE_UNINSTALL) # <span
class="roman">Pre-uninstall commands follow.</span>
$(POST_UNINSTALL) # <span class="roman">Post-uninstall
commands follow.</span>
$(NORMAL_UNINSTALL) # <span class="roman">Normal commands
follow.</span>
-</pre>
- <p>Typically, a pre-uninstall command would be used for deleting entries
-from the Info directory.
+</pre></div>
- <p>If the <code>install</code> or <code>uninstall</code> target has any
dependencies
+<p>Typically, a pre-uninstall command would be used for deleting entries
+from the Info directory.
+</p>
+<p>If the <code>install</code> or <code>uninstall</code> target has any
dependencies
which act as subroutines of installation, then you should start
-<em>each</em> dependency's commands with a category line, and start the
-main target's commands with a category line also. This way, you can
+<em>each</em> dependency’s commands with a category line, and start the
+main target’s commands with a category line also. This way, you can
ensure that each command is placed in the right category regardless of
which of the dependencies actually run.
-
- <p>Pre-installation and post-installation commands should not run any
+</p>
+<p>Pre-installation and post-installation commands should not run any
programs except for these:
+</p>
+<div class="example">
+<pre class="example">[ basename bash cat chgrp chmod chown cmp cp dd diff echo
+egrep expand expr false fgrep find getopt grep gunzip gzip
+hostname install install-info kill ldconfig ln ls md5sum
+mkdir mkfifo mknod mv printenv pwd rm rmdir sed sort tee
+test touch true uname xargs yes
+</pre></div>
-<pre class="example"> [ basename bash cat chgrp chmod chown cmp cp dd diff
echo
- egrep expand expr false fgrep find getopt grep gunzip gzip
- hostname install install-info kill ldconfig ln ls md5sum
- mkdir mkfifo mknod mv printenv pwd rm rmdir sed sort tee
- test touch true uname xargs yes
-</pre>
- <p><a name="index-binary-packages-160"></a>The reason for distinguishing
the commands in this way is for the sake
+<a name="index-binary-packages"></a>
+<p>The reason for distinguishing the commands in this way is for the sake
of making binary packages. Typically a binary package contains all the
executables and other files that need to be installed, and has its own
method of installing them—so it does not need to run the normal
installation commands. But installing the binary package does need to
execute the pre-installation and post-installation commands.
-
- <p>Programs to build binary packages work by extracting the
+</p>
+<p>Programs to build binary packages work by extracting the
pre-installation and post-installation commands. Here is one way of
-extracting the pre-installation commands (the <samp><span
class="option">-s</span></samp> option to
-<samp><span class="command">make</span></samp> is needed to silence messages
about entering
+extracting the pre-installation commands (the ‘<samp>-s</samp>’
option to
+<code>make</code> is needed to silence messages about entering
subdirectories):
-
-<pre class="smallexample"> make -s -n install -o all \
+</p>
+<div class="smallexample">
+<pre class="smallexample">make -s -n install -o all \
PRE_INSTALL=pre-install \
POST_INSTALL=post-install \
NORMAL_INSTALL=normal-install \
| gawk -f pre-install.awk
-</pre>
- <p class="noindent">where the file <samp><span
class="file">pre-install.awk</span></samp> could contain this:
+</pre></div>
-<pre class="smallexample"> $0 ~ /^(normal-install|post-install)[ \t]*$/
{on = 0}
- on {print $0}
- $0 ~ /^pre-install[ \t]*$/ {on = 1}
-</pre>
- <div class="node">
-<a name="Releases"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p"
href="#Makefile-Conventions">Makefile Conventions</a>,
-Up: <a rel="up" accesskey="u" href="#Managing-Releases">Managing
Releases</a>
+<p>where the file ‘<tt>pre-install.awk</tt>’ could contain this:
+</p>
+<div class="smallexample">
+<pre class="smallexample">$0 ~ /^(normal-install|post-install)[ \t]*$/ {on = 0}
+on {print $0}
+$0 ~ /^pre-install[ \t]*$/ {on = 1}
+</pre></div>
+<hr>
+<a name="Releases"></a>
+<div class="header">
+<p>
+Previous: <a href="#Makefile-Conventions" accesskey="p"
rel="previous">Makefile Conventions</a>, Up: <a href="#Managing-Releases"
accesskey="u" rel="up">Managing Releases</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="Making-Releases"></a>
<h3 class="section">7.3 Making Releases</h3>
+<a name="index-packaging"></a>
-<p><a name="index-packaging-161"></a>
-You should identify each release with a pair of version numbers, a
+<p>You should identify each release with a pair of version numbers, a
major version and a minor. We have no objection to using more than
two numbers, but it is very unlikely that you really need them.
-
- <p>Package the distribution of <code>Foo version 69.96</code> up in a
gzipped tar
-file with the name <samp><span class="file">foo-69.96.tar.gz</span></samp>.
It should unpack into a
-subdirectory named <samp><span class="file">foo-69.96</span></samp>.
-
- <p>Building and installing the program should never modify any of the files
+</p>
+<p>Package the distribution of <code>Foo version 69.96</code> up in a gzipped
tar
+file with the name ‘<tt>foo-69.96.tar.gz</tt>’. It should unpack
into a
+subdirectory named ‘<tt>foo-69.96</tt>’.
+</p>
+<p>Building and installing the program should never modify any of the files
contained in the distribution. This means that all the files that form
-part of the program in any way must be classified into <dfn>source
-files</dfn> and <dfn>non-source files</dfn>. Source files are written by
humans
+part of the program in any way must be classified into <em>source
+files</em> and <em>non-source files</em>. Source files are written by humans
and never changed automatically; non-source files are produced from
source files by programs under the control of the Makefile.
-
- <p><a name="index-g_t_0040file_007bREADME_007d-file-162"></a>The
distribution should contain a file named <samp><span
class="file">README</span></samp> which gives
+</p>
+<a name="index-README-file"></a>
+<p>The distribution should contain a file named ‘<tt>README</tt>’
which gives
the name of the package, and a general description of what it does. It
is also good to explain the purpose of each of the first-level
-subdirectories in the package, if there are any. The <samp><span
class="file">README</span></samp> file
+subdirectories in the package, if there are any. The
‘<tt>README</tt>’ file
should either state the version number of the package, or refer to where
in the package it can be found.
-
- <p>The <samp><span class="file">README</span></samp> file should refer to
the file <samp><span class="file">INSTALL</span></samp>, which
+</p>
+<p>The ‘<tt>README</tt>’ file should refer to the file
‘<tt>INSTALL</tt>’, which
should contain an explanation of the installation procedure.
-
- <p>The <samp><span class="file">README</span></samp> file should also refer
to the file which contains the
+</p>
+<p>The ‘<tt>README</tt>’ file should also refer to the file which
contains the
copying conditions. The GNU GPL, if used, should be in a file called
-<samp><span class="file">COPYING</span></samp>. If the GNU LGPL is used, it
should be in a file called
-<samp><span class="file">COPYING.LESSER</span></samp>.
-
- <p>Naturally, all the source files must be in the distribution. It is
+‘<tt>COPYING</tt>’. If the GNU LGPL is used, it should be in a
file called
+‘<tt>COPYING.LESSER</tt>’.
+</p>
+<p>Naturally, all the source files must be in the distribution. It is
okay to include non-source files in the distribution along with the
source files they are generated from, provided they are up-to-date
with the source they are made from, and machine-independent, so that
@@ -5017,127 +6154,126 @@
Bison, <code>lex</code>, TeX, and <code>makeinfo</code>; this helps avoid
unnecessary dependencies between our distributions, so that users can
install whichever packages they want to install.
-
- <p>Non-source files that might actually be modified by building and
+</p>
+<p>Non-source files that might actually be modified by building and
installing the program should <strong>never</strong> be included in the
distribution. So if you do distribute non-source files, always make
sure they are up to date when you make a new distribution.
-
- <p>Make sure that all the files in the distribution are world-readable, and
+</p>
+<p>Make sure that all the files in the distribution are world-readable, and
that directories are world-readable and world-searchable (octal mode 755).
We used to recommend that all directories in the distribution also be
world-writable (octal mode 777), because ancient versions of <code>tar</code>
would otherwise not cope when extracting the archive as an unprivileged
user. That can easily lead to security issues when creating the archive,
however, so now we recommend against that.
-
- <p>Don't include any symbolic links in the distribution itself. If the tar
+</p>
+<p>Don’t include any symbolic links in the distribution itself. If the
tar
file contains symbolic links, then people cannot even unpack it on
-systems that don't support symbolic links. Also, don't use multiple
+systems that don’t support symbolic links. Also, don’t use
multiple
names for one file in different directories, because certain file
systems cannot handle this and that prevents unpacking the
distribution.
-
- <p>Try to make sure that all the file names will be unique on MS-DOS. A
+</p>
+<p>Try to make sure that all the file names will be unique on MS-DOS. A
name on MS-DOS consists of up to 8 characters, optionally followed by a
period and up to three characters. MS-DOS will truncate extra
characters both before and after the period. Thus,
-<samp><span class="file">foobarhacker.c</span></samp> and <samp><span
class="file">foobarhacker.o</span></samp> are not ambiguous; they
-are truncated to <samp><span class="file">foobarha.c</span></samp> and
<samp><span class="file">foobarha.o</span></samp>, which are
+‘<tt>foobarhacker.c</tt>’ and
‘<tt>foobarhacker.o</tt>’ are not ambiguous; they
+are truncated to ‘<tt>foobarha.c</tt>’ and
‘<tt>foobarha.o</tt>’, which are
distinct.
-
- <p><a
name="index-g_t_0040file_007btexinfo_002etex_007d_002c-in-a-distribution-163"></a>Include
in your distribution a copy of the <samp><span
class="file">texinfo.tex</span></samp> you used
-to test print any <samp><span class="file">*.texinfo</span></samp> or
<samp><span class="file">*.texi</span></samp> files.
-
- <p>Likewise, if your program uses small GNU software packages like regex,
+</p>
+<a name="index-texinfo_002etex_002c-in-a-distribution"></a>
+<p>Include in your distribution a copy of the
‘<tt>texinfo.tex</tt>’ you used
+to test print any ‘<tt>*.texinfo</tt>’ or
‘<tt>*.texi</tt>’ files.
+</p>
+<p>Likewise, if your program uses small GNU software packages like regex,
getopt, obstack, or termcap, include them in the distribution file.
Leaving them out would make the distribution file a little smaller at
-the expense of possible inconvenience to a user who doesn't know what
+the expense of possible inconvenience to a user who doesn’t know what
other files to get.
-
-<div class="node">
+</p>
+<hr>
<a name="References"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n"
href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>,
-Previous: <a rel="previous" accesskey="p"
href="#Managing-Releases">Managing Releases</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#GNU-Free-Documentation-License" accesskey="n" rel="next">GNU
Free Documentation License</a>, Previous: <a href="#Managing-Releases"
accesskey="p" rel="previous">Managing Releases</a>, Up: <a href="#Top"
accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="References-to-Non_002dFree-Software-and-Documentation"></a>
<h2 class="chapter">8 References to Non-Free Software and Documentation</h2>
+<a name="index-references-to-non_002dfree-material"></a>
-<p><a name="index-references-to-non_002dfree-material-164"></a>
-A GNU program should not recommend, promote, or grant legitimacy to
+<p>A GNU program should not recommend, promote, or grant legitimacy to
the use of any non-free program. Proprietary software is a social and
ethical problem, and our aim is to put an end to that problem. We
-can't stop some people from writing proprietary programs, or stop
+can’t stop some people from writing proprietary programs, or stop
other people from using them, but we can and should refuse to
advertise them to new potential customers, or to give the public the
idea that their existence is ethical.
-
- <p>The GNU definition of free software is found on the GNU web site at
+</p>
+<p>The GNU definition of free software is found on the GNU web site at
<a
href="http://www.gnu.org/philosophy/free-sw.html";>http://www.gnu.org/philosophy/free-sw.html</a>,
and the definition
of free documentation is found at
<a
href="http://www.gnu.org/philosophy/free-doc.html";>http://www.gnu.org/philosophy/free-doc.html</a>.
The terms “free”
and “non-free”, used in this document, refer to those definitions.
-
- <p>A list of important licenses and whether they qualify as free is in
+</p>
+<p>A list of important licenses and whether they qualify as free is in
<a
href="http://www.gnu.org/licenses/license-list.html";>http://www.gnu.org/licenses/license-list.html</a>.
If it is not
clear whether a license qualifies as free, please ask the GNU Project
by writing to <a href="mailto:address@hidden";>address@hidden</a>. We will
answer, and if the
license is an important one, we will add it to the list.
-
- <p>When a non-free program or system is well known, you can mention it in
+</p>
+<p>When a non-free program or system is well known, you can mention it in
passing—that is harmless, since users who might want to use it
probably already know about it. For instance, it is fine to explain
how to build your package on top of some widely used non-free
operating system, or how to use it together with some widely used
non-free program.
-
- <p>However, you should give only the necessary information to help those
+</p>
+<p>However, you should give only the necessary information to help those
who already use the non-free program to use your program with
-it—don't give, or refer to, any further information about the
-proprietary program, and don't imply that the proprietary program
+it—don’t give, or refer to, any further information about the
+proprietary program, and don’t imply that the proprietary program
enhances your program, or that its existence is in any way a good
thing. The goal should be that people already using the proprietary
program will get the advice they need about how to use your free
-program with it, while people who don't already use the proprietary
+program with it, while people who don’t already use the proprietary
program will not see anything likely to lead them to take an interest
in it.
-
- <p>If a non-free program or system is obscure in your program's domain,
+</p>
+<p>If a non-free program or system is obscure in your program’s domain,
your program should not mention or support it at all, since doing so
would tend to popularize the non-free program more than it popularizes
your program. (You cannot hope to find many additional users for your
program among the users of Foobar, if the existence of Foobar is not
generally known among people who might want to use your program.)
-
- <p>Sometimes a program is free software in itself but depends on a
+</p>
+<p>Sometimes a program is free software in itself but depends on a
non-free platform in order to run. For instance, many Java programs
depend on some non-free Java libraries. To recommend or promote such
a program is to promote the other programs it needs. This is why we
are careful about listing Java programs in the Free Software
-Directory: we don't want to promote the non-free Java libraries.
-
- <p>We hope this particular problem with Java will be gone by and by, as
+Directory: we don’t want to promote the non-free Java libraries.
+</p>
+<p>We hope this particular problem with Java will be gone by and by, as
we replace the remaining non-free standard Java libraries with free
-software, but the general principle will remain the same: don't
+software, but the general principle will remain the same: don’t
recommend, promote or legitimize programs that depend on non-free
software to run.
-
- <p>Some free programs strongly encourage the use of non-free software. A
-typical example is <samp><span class="command">mplayer</span></samp>. It is
free software in itself,
+</p>
+<p>Some free programs strongly encourage the use of non-free software. A
+typical example is <code>mplayer</code>. It is free software in itself,
and the free code can handle some kinds of files. However,
-<samp><span class="command">mplayer</span></samp> recommends use of non-free
codecs for other kinds of
-files, and users that install <samp><span
class="command">mplayer</span></samp> are very likely to
-install those codecs along with it. To recommend <samp><span
class="command">mplayer</span></samp>
+<code>mplayer</code> recommends use of non-free codecs for other kinds of
+files, and users that install <code>mplayer</code> are very likely to
+install those codecs along with it. To recommend <code>mplayer</code>
is, in effect, to promote use of the non-free codecs.
-
- <p>Thus, you should not recommend programs that strongly encourage the
+</p>
+<p>Thus, you should not recommend programs that strongly encourage the
use of non-free software. This is why we do not list
-<samp><span class="command">mplayer</span></samp> in the Free Software
Directory.
-
- <p>A GNU package should not refer the user to any non-free documentation
+<code>mplayer</code> in the Free Software Directory.
+</p>
+<p>A GNU package should not refer the user to any non-free documentation
for free software. Free documentation that can be included in free
operating systems is essential for completing the GNU system, or any
free operating system, so encouraging it is a priority; to recommend
@@ -5145,84 +6281,81 @@
impetus for the community to produce documentation that we can
include. So GNU packages should never recommend non-free
documentation.
-
- <p>By contrast, it is ok to refer to journal articles and textbooks in
+</p>
+<p>By contrast, it is ok to refer to journal articles and textbooks in
the comments of a program for explanation of how it functions, even
-though they are non-free. This is because we don't include such
+though they are non-free. This is because we don’t include such
things in the GNU system even if they are free—they are outside the
scope of what a software distribution needs to include.
-
- <p>Referring to a web site that describes or recommends a non-free
+</p>
+<p>Referring to a web site that describes or recommends a non-free
program is promoting that program, so please do not make links to (or
mention by name) web sites that contain such material. This policy is
relevant particularly for the web pages for a GNU package.
-
- <p>Following links from nearly any web site can lead eventually to
+</p>
+<p>Following links from nearly any web site can lead eventually to
non-free software; this is inherent in the nature of the web. So it
makes no sense to criticize a site for having such links. As long as
the site does not itself recommend a non-free program, there is no
need to consider the question of the sites that it links to for other
reasons.
-
- <p>Thus, for example, you should not refer to AT&T's web site if that
-recommends AT&T's non-free software packages; you should not refer to
-a site that links to AT&T's site presenting it as a place to get some
+</p>
+<p>Thus, for example, you should not refer to AT&T’s web site if that
+recommends AT&T’s non-free software packages; you should not refer to
+a site that links to AT&T’s site presenting it as a place to get some
non-free program, because that link recommends and legitimizes the
-non-free program. However, that a site contains a link to AT&T's web
+non-free program. However, that a site contains a link to AT&T’s web
site for some other purpose (such as long-distance telephone service)
is not an objection against it.
-
-<div class="node">
+</p>
+<hr>
<a name="GNU-Free-Documentation-License"></a>
-<p><hr>
-Next: <a rel="next" accesskey="n" href="#Index">Index</a>,
-Previous: <a rel="previous" accesskey="p"
href="#References">References</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a
href="#References" accesskey="p" rel="previous">References</a>, Up: <a
href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<a name="GNU-Free-Documentation-License-1"></a>
<h2 class="appendix">Appendix A GNU Free Documentation License</h2>
-<p><a name="index-FDL_002c-GNU-Free-Documentation-License-165"></a>
-
-<!-- The GNU Free Documentation License. -->
-<div align="center">Version 1.3, 3 November 2008</div>
+<a name="index-FDL_002c-GNU-Free-Documentation-License"></a>
+<p align="center">Version 1.3, 3 November 2008
+</p>
+
+<div class="display">
+<pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
+<a href="http://fsf.org/";>http://fsf.org/</a>
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+</pre></div>
-<!-- This file is intended to be included within another document, -->
-<!-- hence no sectioning command or @node. -->
-<pre class="display"> Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
- <a href="http://fsf.org/";>http://fsf.org/</a>
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-</pre>
- <ol type=1 start=0>
-<li>PREAMBLE
+<ol>
+<li> PREAMBLE
- <p>The purpose of this License is to make a manual, textbook, or other
-functional and useful document <dfn>free</dfn> in the sense of freedom: to
+<p>The purpose of this License is to make a manual, textbook, or other
+functional and useful document <em>free</em> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
-
- <p>This License is a kind of “copyleft”, which means that
derivative
+</p>
+<p>This License is a kind of “copyleft”, which means that
derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
-
- <p>We have designed this License in order to use it for manuals for free
+</p>
+<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
+</p>
+</li><li> APPLICABILITY AND DEFINITIONS
- <li>APPLICABILITY AND DEFINITIONS
-
- <p>This License applies to any manual or other work, in any medium, that
+<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
@@ -5231,14 +6364,14 @@
licensee, and is addressed as “you”. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
-
- <p>A “Modified Version” of the Document means any work
containing the
+</p>
+<p>A “Modified Version” of the Document means any work containing
the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
-
- <p>A “Secondary Section” is a named appendix or a
front-matter section
+</p>
+<p>A “Secondary Section” is a named appendix or a front-matter
section
of the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall
+publishers or authors of the Document to the Document’s overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
@@ -5246,21 +6379,21 @@
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
-
- <p>The “Invariant Sections” are certain Secondary Sections
whose titles
+</p>
+<p>The “Invariant Sections” are certain Secondary Sections whose
titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
-
- <p>The “Cover Texts” are certain short passages of text that
are listed,
+</p>
+<p>The “Cover Texts” are certain short passages of text that are
listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
- <p>A “Transparent” copy of the Document means a
machine-readable copy,
+</p>
+<p>A “Transparent” copy of the Document means a machine-readable
copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
@@ -5272,8 +6405,8 @@
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not “Transparent” is called
“Opaque”.
-
- <p>Examples of suitable formats for Transparent copies include plain
+</p>
+<p>Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input
format, SGML or XML using a publicly available
DTD, and standard-conforming simple HTML,
@@ -5285,35 +6418,35 @@
not generally available, and the machine-generated HTML,
PostScript or PDF produced by some word processors for
output purposes only.
-
- <p>The “Title Page” means, for a printed book, the title page
itself,
+</p>
+<p>The “Title Page” means, for a printed book, the title page
itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, “Title Page”
means
-the text near the most prominent appearance of the work's title,
+the text near the most prominent appearance of the work’s title,
preceding the beginning of the body of the text.
-
- <p>The “publisher” means any person or entity that
distributes copies
+</p>
+<p>The “publisher” means any person or entity that distributes
copies
of the Document to the public.
-
- <p>A section “Entitled XYZ” means a named subunit of the
Document whose
+</p>
+<p>A section “Entitled XYZ” means a named subunit of the Document
whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as “Acknowledgements”,
“Dedications”, “Endorsements”, or
“History”.) To “Preserve the Title”
of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
-
- <p>The Document may include Warranty Disclaimers next to the notice which
+</p>
+<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
+</p>
+</li><li> VERBATIM COPYING
- <li>VERBATIM COPYING
-
- <p>You may copy and distribute the Document in any medium, either
+<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
@@ -5322,15 +6455,15 @@
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
-
- <p>You may also lend copies, under the same conditions stated above, and
+</p>
+<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
+</p>
+</li><li> COPYING IN QUANTITY
- <li>COPYING IN QUANTITY
-
- <p>If you publish printed copies (or copies in media that commonly have
+<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
+Document’s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
@@ -5340,13 +6473,13 @@
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
-
- <p>If the required texts for either cover are too voluminous to fit
+</p>
+<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
-
- <p>If you publish or distribute Opaque copies of the Document numbering
+</p>
+<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
@@ -5358,51 +6491,51 @@
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
-
- <p>It is requested, but not required, that you contact the authors of the
+</p>
+<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
+</p>
+</li><li> MODIFICATIONS
- <li>MODIFICATIONS
-
- <p>You may copy and distribute a Modified Version of the Document under
+<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
-
- <ol type=A start=1>
-<li>Use in the Title Page (and on the covers, if any) a title distinct
+</p>
+<ol>
+<li> Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
- <li>List on the Title Page, as authors, one or more persons or
entities
+</li><li> List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
- <li>State on the Title page the name of the publisher of the
+</li><li> State on the Title page the name of the publisher of the
Modified Version, as the publisher.
- <li>Preserve all the copyright notices of the Document.
+</li><li> Preserve all the copyright notices of the Document.
- <li>Add an appropriate copyright notice for your modifications
+</li><li> Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
- <li>Include, immediately after the copyright notices, a license
notice
+</li><li> Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
- <li>Preserve in that license notice the full lists of Invariant
Sections
-and required Cover Texts given in the Document's license notice.
+</li><li> Preserve in that license notice the full lists of Invariant Sections
+and required Cover Texts given in the Document’s license notice.
- <li>Include an unaltered copy of this License.
+</li><li> Include an unaltered copy of this License.
- <li>Preserve the section Entitled “History”, Preserve
its Title, and add
+</li><li> Preserve the section Entitled “History”, Preserve its
Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled “History” in the Document, create one
@@ -5410,7 +6543,7 @@
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
- <li>Preserve the network location, if any, given in the Document for
+</li><li> Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the “History” section.
@@ -5418,38 +6551,38 @@
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
- <li>For any section Entitled “Acknowledgements” or
“Dedications”, Preserve
+</li><li> For any section Entitled “Acknowledgements” or
“Dedications”, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.
- <li>Preserve all the Invariant Sections of the Document,
+</li><li> Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
- <li>Delete any section Entitled “Endorsements”. Such a
section
+</li><li> Delete any section Entitled “Endorsements”. Such a
section
may not be included in the Modified Version.
- <li>Do not retitle any existing section to be Entitled
“Endorsements” or
+</li><li> Do not retitle any existing section to be Entitled
“Endorsements” or
to conflict in title with any Invariant Section.
- <li>Preserve any Warranty Disclaimers.
- </ol>
+</li><li> Preserve any Warranty Disclaimers.
+</li></ol>
- <p>If the Modified Version includes new front-matter sections or
+<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
+list of Invariant Sections in the Modified Version’s license notice.
These titles must be distinct from any other section titles.
-
- <p>You may add a section Entitled “Endorsements”, provided it
contains
+</p>
+<p>You may add a section Entitled “Endorsements”, provided it
contains
nothing but endorsements of your Modified Version by various
parties—for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
-
- <p>You may add a passage of up to five words as a Front-Cover Text, and a
+</p>
+<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
@@ -5458,21 +6591,21 @@
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
-
- <p>The author(s) and publisher(s) of the Document do not by this License
+</p>
+<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
+</p>
+</li><li> COMBINING DOCUMENTS
- <li>COMBINING DOCUMENTS
-
- <p>You may combine the Document with other documents released under this
+<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
-
- <p>The combined work need only contain one copy of this License, and
+</p>
+<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
@@ -5480,48 +6613,48 @@
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
-
- <p>In the combination, you must combine any sections Entitled
“History”
+</p>
+<p>In the combination, you must combine any sections Entitled
“History”
in the various original documents, forming one section Entitled
“History”; likewise combine any sections Entitled
“Acknowledgements”,
and any sections Entitled “Dedications”. You must delete all
sections Entitled “Endorsements.”
+</p>
+</li><li> COLLECTIONS OF DOCUMENTS
- <li>COLLECTIONS OF DOCUMENTS
-
- <p>You may make a collection consisting of the Document and other
documents
+<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
-
- <p>You may extract a single document from such a collection, and
distribute
+</p>
+<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
+</p>
+</li><li> AGGREGATION WITH INDEPENDENT WORKS
- <li>AGGREGATION WITH INDEPENDENT WORKS
-
- <p>A compilation of the Document or its derivatives with other separate
+<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an “aggregate” if the copyright
resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
+of the compilation’s users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
-
- <p>If the Cover Text requirement of section 3 is applicable to these
+</p>
+<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
+the entire aggregate, the Document’s Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
+</p>
+</li><li> TRANSLATION
- <li>TRANSLATION
-
- <p>Translation is considered a kind of modification, so you may
+<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
@@ -5533,48 +6666,48 @@
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
-
- <p>If a section in the Document is Entitled
“Acknowledgements”,
+</p>
+<p>If a section in the Document is Entitled “Acknowledgements”,
“Dedications”, or “History”, the requirement (section
4) to Preserve
its Title (section 1) will typically require changing the actual
title.
+</p>
+</li><li> TERMINATION
- <li>TERMINATION
-
- <p>You may not copy, modify, sublicense, or distribute the Document
+<p>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
-
- <p>However, if you cease all violation of this License, then your license
+</p>
+<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
-
- <p>Moreover, your license from a particular copyright holder is
+</p>
+<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
-
- <p>Termination of your rights under this section does not terminate the
+</p>
+<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
+</p>
+</li><li> FUTURE REVISIONS OF THIS LICENSE
- <li>FUTURE REVISIONS OF THIS LICENSE
-
- <p>The Free Software Foundation may publish new, revised versions
+<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
<a href="http://www.gnu.org/copyleft/";>http://www.gnu.org/copyleft/</a>.
-
- <p>Each version of the License is given a distinguishing version number.
+</p>
+<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License “or any later version” applies to it, you have the option
of
following the terms and conditions either of that specified version or
@@ -5583,47 +6716,49 @@
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation. If the Document
specifies that a proxy can decide which future versions of this
-License can be used, that proxy's public statement of acceptance of a
+License can be used, that proxy’s public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
+</p>
+</li><li> RELICENSING
- <li>RELICENSING
-
- <p>“Massive Multiauthor Collaboration Site” (or “MMC
Site”) means any
+<p>“Massive Multiauthor Collaboration Site” (or “MMC
Site”) means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works. A
public wiki that anybody can edit is an example of such a server. A
“Massive Multiauthor Collaboration” (or “MMC”)
contained in the
site means any set of copyrightable works thus published on the MMC
site.
-
- <p>“CC-BY-SA” means the Creative Commons Attribution-Share
Alike 3.0
+</p>
+<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike
3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
-
- <p>“Incorporate” means to publish or republish a Document, in
whole or
+</p>
+<p>“Incorporate” means to publish or republish a Document, in
whole or
in part, as part of another Document.
-
- <p>An MMC is “eligible for relicensing” if it is licensed
under this
+</p>
+<p>An MMC is “eligible for relicensing” if it is licensed under
this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole
or in part into the MMC, (1) had no cover texts or invariant sections,
and (2) were thus incorporated prior to November 1, 2008.
-
- <p>The operator of an MMC Site may republish an MMC contained in the site
+</p>
+<p>The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
+</p>
+</li></ol>
- </ol>
-
+<a name="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></a>
<h3 class="heading">ADDENDUM: How to use this License for your documents</h3>
<p>To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
-
+</p>
+<div class="smallexample">
<pre class="smallexample"> Copyright (C) <var>year</var> <var>your
name</var>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
@@ -5631,201 +6766,356 @@
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
-</pre>
- <p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the “with<small class="dots">...</small>Texts.” line with
this:
+</pre></div>
+<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the “with…Texts.” line with this:
+</p>
+<div class="smallexample">
<pre class="smallexample"> with the Invariant Sections being <var>list
their titles</var>, with
the Front-Cover Texts being <var>list</var>, and with the Back-Cover
Texts
being <var>list</var>.
-</pre>
- <p>If you have Invariant Sections without Cover Texts, or some other
+</pre></div>
+
+<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
-
- <p>If your document contains nontrivial examples of program code, we
+</p>
+<p>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
+</p>
-<!-- Local Variables: -->
-<!-- ispell-local-pdict: "ispell-dict" -->
-<!-- End: -->
-<div class="node">
+<hr>
<a name="Index"></a>
-<p><hr>
-Previous: <a rel="previous" accesskey="p"
href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>,
-Up: <a rel="up" accesskey="u" href="#Top">Top</a>
-
+<div class="header">
+<p>
+Previous: <a href="#GNU-Free-Documentation-License" accesskey="p"
rel="previous">GNU Free Documentation License</a>, Up: <a href="#Top"
accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<a name="Index-1"></a>
<h2 class="unnumbered">Index</h2>
+<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter"
href="#Index_cp_symbol-1"><b>#</b></a>
+
+<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+
+<br>
+<a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-Q"><b>Q</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+
+</td></tr></table>
+<table class="index-cp" border="0">
+<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left">
Section</th></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_symbol-1">#</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-_0023endif_002c-commenting"><code>#endif</code>,
commenting</a>:</td><td> </td><td valign="top"><a
href="#Comments">Comments</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_symbol-2">-</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-_002d_002dhelp-output">‘<samp>--help</samp>’
output</a>:</td><td> </td><td valign="top"><a
href="#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-_002d_002dversion-output">‘<samp>--version</samp>’
output</a>:</td><td> </td><td valign="top"><a
href="#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-_002dWall-compiler-option">‘<samp>-Wall</samp>’
compiler option</a>:</td><td> </td><td valign="top"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-A">A</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-accepting-contributions">accepting
contributions</a>:</td><td> </td><td valign="top"><a
href="#Contributions">Contributions</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-address-for-bug-reports">address
for bug reports</a>:</td><td> </td><td valign="top"><a
href="#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-ANSI-C-standard"><small>ANSI</small> C
standard</a>:</td><td> </td><td valign="top"><a
href="#Standard-C">Standard C</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-arbitrary-limits-on-data">arbitrary limits on
data</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-ASCII-characters">ASCII
characters</a>:</td><td> </td><td valign="top"><a
href="#Character-Set">Character Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-autoconf"><code>autoconf</code></a>:</td><td> </td><td
valign="top"><a href="#System-Portability">System Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-avoiding-proprietary-code">avoiding proprietary
code</a>:</td><td> </td><td valign="top"><a
href="#Reading-Non_002dFree-Code">Reading Non-Free Code</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-B">B</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-behavior_002c-dependent-on-program_0027s-name">behavior, dependent
on program’s name</a>:</td><td> </td><td valign="top"><a
href="#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-binary-packages">binary
packages</a>:</td><td> </td><td valign="top"><a
href="#Install-Command-Categories">Install Command Categories</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-bindir"><code>bindir</code></a>:</td><td> </td><td
valign="top"><a href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-braces_002c-in-C-source">braces,
in C source</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-bug-reports">bug
reports</a>:</td><td> </td><td valign="top"><a
href="#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-bug_002dstandards_0040gnu_002eorg-email-address"><code>address@hidden</code>
email address</a>:</td><td> </td><td valign="top"><a
href="#Preface">Preface</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-C">C</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-C-library-functions_002c-and-portability">C library functions, and
portability</a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-canonical-name-of-a-program">canonical name of a
program</a>:</td><td> </td><td valign="top"><a
href="#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-casting-pointers-to-integers">casting pointers to
integers</a>:</td><td> </td><td valign="top"><a
href="#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-CGI-programs_002c-standard-options-for">CGI programs, standard
options for</a>:</td><td> </td><td valign="top"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-change-logs">change
logs</a>:</td><td> </td><td valign="top"><a href="#Change-Logs">Change
Logs</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-change-logs_002c-conditional-changes">change logs, conditional
changes</a>:</td><td> </td><td valign="top"><a
href="#Conditional-Changes">Conditional Changes</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-change-logs_002c-style">change
logs, style</a>:</td><td> </td><td valign="top"><a
href="#Style-of-Change-Logs">Style of Change Logs</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-character-set">character
set</a>:</td><td> </td><td valign="top"><a href="#Character-Set">Character
Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-clang"><code>clang</code></a>:</td><td> </td><td
valign="top"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-command_002dline-arguments_002c-decoding">command-line arguments,
decoding</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-command_002dline-interface">command-line
interface</a>:</td><td> </td><td valign="top"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-commenting">commenting</a>:</td><td> </td><td valign="top"><a
href="#Comments">Comments</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-compatibility-with-C-and-POSIX-standards">compatibility with C and
<small>POSIX</small> standards</a>:</td><td> </td><td valign="top"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-compiler-warnings">compiler
warnings</a>:</td><td> </td><td valign="top"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-conditional-changes_002c-and-change-logs">conditional changes, and
change logs</a>:</td><td> </td><td valign="top"><a
href="#Conditional-Changes">Conditional Changes</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-conditionals_002c-comments-for">conditionals, comments
for</a>:</td><td> </td><td valign="top"><a
href="#Comments">Comments</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-configure"><code>configure</code></a>:</td><td> </td><td
valign="top"><a href="#Configuration">Configuration</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-control_002dL">control-L</a>:</td><td> </td><td
valign="top"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-conventions-for-makefiles">conventions for
makefiles</a>:</td><td> </td><td valign="top"><a
href="#Makefile-Conventions">Makefile Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-CORBA">CORBA</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-credits-for-manuals">credits for
manuals</a>:</td><td> </td><td valign="top"><a
href="#Manual-Credits">Manual Credits</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-D">D</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-D_002dbus">D-bus</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-data-structures_002c-in-Gnulib"><code>data structures, in
Gnulib</code></a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-data-types_002c-and-portability">data types, and
portability</a>:</td><td> </td><td valign="top"><a
href="#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-DESTDIR"><code>DESTDIR</code></a>:</td><td> </td><td
valign="top"><a href="#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-directories_002c-creating-installation">directories, creating
installation</a>:</td><td> </td><td valign="top"><a
href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-documentation">documentation</a>:</td><td> </td><td
valign="top"><a href="#Documentation">Documentation</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-doschk"><code>doschk</code></a>:</td><td> </td><td
valign="top"><a href="#Names">Names</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-double-quote">double
quote</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-downloading-this-manual">downloading this
manual</a>:</td><td> </td><td valign="top"><a
href="#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-dynamic-plug_002dins">dynamic
plug-ins</a>:</td><td> </td><td valign="top"><a
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-E">E</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-encodings">encodings</a>:</td><td> </td><td valign="top"><a
href="#Character-Set">Character Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-enum-types_002c-formatting"><code>enum</code> types,
formatting</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-error-messages">error
messages</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-error-messages_002c-formatting">error messages,
formatting</a>:</td><td> </td><td valign="top"><a
href="#Errors">Errors</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-error-messages_002c-in-Gnulib"><code>error messages, in
Gnulib</code></a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-exec_005fprefix"><code>exec_prefix</code></a>:</td><td> </td><td
valign="top"><a href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-expressions_002c-splitting">expressions,
splitting</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-F">F</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-FDL_002c-GNU-Free-Documentation-License">FDL, GNU Free
Documentation License</a>:</td><td> </td><td valign="top"><a
href="#GNU-Free-Documentation-License">GNU Free Documentation
License</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-file-usage">file
usage</a>:</td><td> </td><td valign="top"><a href="#File-Usage">File
Usage</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-file_002dname-limitations">file-name
limitations</a>:</td><td> </td><td valign="top"><a
href="#Names">Names</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-formatting-error-messages">formatting error
messages</a>:</td><td> </td><td valign="top"><a
href="#Errors">Errors</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-formatting-source-code">formatting source
code</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-formfeed">formfeed</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-function-argument_002c-declaring">function argument,
declaring</a>:</td><td> </td><td valign="top"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-function-definitions_002c-formatting">function definitions,
formatting</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-function-prototypes">function
prototypes</a>:</td><td> </td><td valign="top"><a
href="#Standard-C">Standard C</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-G">G</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-getopt"><code>getopt</code></a>:</td><td> </td><td
valign="top"><a href="#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-gettext"><code>gettext</code></a>:</td><td> </td><td
valign="top"><a href="#Internationalization">Internationalization</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-GNOME">GNOME</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-GNOME-and-Guile">GNOME and
Guile</a>:</td><td> </td><td valign="top"><a
href="#Source-Language">Source Language</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-Gnulib">Gnulib</a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-gnustandards-project-repository">gnustandards project
repository</a>:</td><td> </td><td valign="top"><a
href="#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"><code>address@hidden</code>
mailing list</a>:</td><td> </td><td valign="top"><a
href="#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-graphical-user-interface">graphical user
interface</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-grave-accent">grave
accent</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-GTK_002b">GTK+</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-Guile">Guile</a>:</td><td> </td><td valign="top"><a
href="#Source-Language">Source Language</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-I">I</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-implicit-int">implicit
<code>int</code></a>:</td><td> </td><td valign="top"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-impossible-conditions">impossible
conditions</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-installation-directories_002c-creating">installation directories,
creating</a>:</td><td> </td><td valign="top"><a
href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-installations_002c-staged">installations,
staged</a>:</td><td> </td><td valign="top"><a
href="#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-interface-styles">interface
styles</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-internationalization">internationalization</a>:</td><td> </td><td
valign="top"><a href="#Internationalization">Internationalization</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-K">K</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-keyboard-interface">keyboard
interface</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-L">L</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-LDAP">LDAP</a>:</td><td> </td><td valign="top"><a
href="#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-left-quote">left
quote</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-legal-aspects">legal
aspects</a>:</td><td> </td><td valign="top"><a href="#Legal-Issues">Legal
Issues</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-legal-papers">legal
papers</a>:</td><td> </td><td valign="top"><a
href="#Contributions">Contributions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-libexecdir"><code>libexecdir</code></a>:</td><td> </td><td
valign="top"><a href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-libiconv"><code>libiconv</code></a>:</td><td> </td><td
valign="top"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-libraries">libraries</a>:</td><td> </td><td valign="top"><a
href="#Libraries">Libraries</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-library-functions_002c-and-portability">library functions, and
portability</a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-library-interface">library
interface</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-license-for-manuals">license for
manuals</a>:</td><td> </td><td valign="top"><a
href="#License-for-Manuals">License for Manuals</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-lint"><code>lint</code></a>:</td><td> </td><td
valign="top"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-locale_002dspecific-quote-characters">locale-specific quote
characters</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-long-option-names">long option
names</a>:</td><td> </td><td valign="top"><a href="#Option-Table">Option
Table</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-long_002dnamed-options">long-named
options</a>:</td><td> </td><td valign="top"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-M">M</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-makefile_002c-conventions-for">makefile, conventions
for</a>:</td><td> </td><td valign="top"><a
href="#Makefile-Conventions">Makefile Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-malloc-return-value"><code>malloc</code> return
value</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-man-pages">man
pages</a>:</td><td> </td><td valign="top"><a href="#Man-Pages">Man
Pages</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-manual-structure">manual
structure</a>:</td><td> </td><td valign="top"><a
href="#Manual-Structure-Details">Manual Structure Details</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-memory-allocation-failure">memory allocation
failure</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-memory-leak">memory
leak</a>:</td><td> </td><td valign="top"><a href="#Memory-Usage">Memory
Usage</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-memory-usage">memory
usage</a>:</td><td> </td><td valign="top"><a href="#Memory-Usage">Memory
Usage</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-message-text_002c-and-internationalization">message text, and
internationalization</a>:</td><td> </td><td valign="top"><a
href="#Internationalization">Internationalization</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-mmap"><code>mmap</code></a>:</td><td> </td><td
valign="top"><a href="#Mmap">Mmap</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-multiple-variables-in-a-line">multiple variables in a
line</a>:</td><td> </td><td valign="top"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-N">N</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-names-of-variables_002c-functions_002c-and-files">names of
variables, functions, and files</a>:</td><td> </td><td valign="top"><a
href="#Names">Names</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-NEWS-file">‘<tt>NEWS</tt>’
file</a>:</td><td> </td><td valign="top"><a href="#NEWS-File">NEWS
File</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-non_002dASCII-characters">non-ASCII
characters</a>:</td><td> </td><td valign="top"><a
href="#Character-Set">Character Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-non_002dPOSIX-systems_002c-and-portability">non-<small>POSIX</small>
systems, and portability</a>:</td><td> </td><td valign="top"><a
href="#System-Portability">System Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-non_002dstandard-extensions">non-standard
extensions</a>:</td><td> </td><td valign="top"><a
href="#Using-Extensions">Using Extensions</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-NUL-characters"><code>NUL</code>
characters</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-O">O</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-OID-allocations-for-GNU">OID
allocations for GNU</a>:</td><td> </td><td valign="top"><a
href="#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-open-brace">open
brace</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-opening-quote">opening
quote</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-optional-features_002c-configure_002dtime">optional features,
configure-time</a>:</td><td> </td><td valign="top"><a
href="#Configuration">Configuration</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-options-for-compatibility">options for
compatibility</a>:</td><td> </td><td valign="top"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-options_002c-standard-command_002dline">options, standard
command-line</a>:</td><td> </td><td valign="top"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-output-device-and-program_0027s-behavior">output device and
program’s behavior</a>:</td><td> </td><td valign="top"><a
href="#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-P">P</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-packaging">packaging</a>:</td><td> </td><td valign="top"><a
href="#Releases">Releases</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-PATH_005fINFO_002c-specifying-standard-options-as">PATH_INFO,
specifying standard options as</a>:</td><td> </td><td valign="top"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-plug_002dins">plug-ins</a>:</td><td> </td><td valign="top"><a
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-plugin_005fis_005fGPL_005fcompatible"><code>plugin_is_GPL_compatible</code></a>:</td><td> </td><td
valign="top"><a href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-portability_002c-and-data-types">portability, and data
types</a>:</td><td> </td><td valign="top"><a href="#CPU-Portability">CPU
Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-portability_002c-and-library-functions">portability, and library
functions</a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-portability_002c-between-system-types">portability, between system
types</a>:</td><td> </td><td valign="top"><a
href="#System-Portability">System Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-POSIX-compatibility"><small>POSIX</small>
compatibility</a>:</td><td> </td><td valign="top"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-POSIX-functions_002c-and-portability">POSIX functions, and
portability</a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-POSIXLY_005fCORRECT_002c-environment-variable"><code>POSIXLY_CORRECT</code>,
environment variable</a>:</td><td> </td><td valign="top"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-post_002dinstallation-commands">post-installation
commands</a>:</td><td> </td><td valign="top"><a
href="#Install-Command-Categories">Install Command Categories</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-pre_002dinstallation-commands">pre-installation
commands</a>:</td><td> </td><td valign="top"><a
href="#Install-Command-Categories">Install Command Categories</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-prefix"><code>prefix</code></a>:</td><td> </td><td
valign="top"><a href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-program-configuration">program
configuration</a>:</td><td> </td><td valign="top"><a
href="#Configuration">Configuration</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-program-design">program
design</a>:</td><td> </td><td valign="top"><a href="#Design-Advice">Design
Advice</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-program-name-and-its-behavior">program name and its
behavior</a>:</td><td> </td><td valign="top"><a
href="#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-program_0027s-canonical-name">program’s canonical
name</a>:</td><td> </td><td valign="top"><a
href="#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-programming-languages">programming
languages</a>:</td><td> </td><td valign="top"><a
href="#Source-Language">Source Language</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-proprietary-programs">proprietary
programs</a>:</td><td> </td><td valign="top"><a
href="#Reading-Non_002dFree-Code">Reading Non-Free Code</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-Q">Q</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-quote-characters">quote
characters</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-R">R</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-README-file">‘<tt>README</tt>’
file</a>:</td><td> </td><td valign="top"><a
href="#Releases">Releases</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-references-to-non_002dfree-material">references to non-free
material</a>:</td><td> </td><td valign="top"><a
href="#References">References</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-releasing">releasing</a>:</td><td> </td><td valign="top"><a
href="#Managing-Releases">Managing Releases</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-right-quote">right
quote</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-S">S</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-Savannah-repository-for-gnustandards">Savannah repository for
gnustandards</a>:</td><td> </td><td valign="top"><a
href="#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-sbindir"><code>sbindir</code></a>:</td><td> </td><td
valign="top"><a href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-signal-handling">signal
handling</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-single-quote">single
quote</a>:</td><td> </td><td valign="top"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-SNMP">SNMP</a>:</td><td> </td><td valign="top"><a
href="#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-spaces-before-open_002dparen">spaces before
open-paren</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-staged-installs">staged
installs</a>:</td><td> </td><td valign="top"><a
href="#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-standard-command_002dline-options">standard command-line
options</a>:</td><td> </td><td valign="top"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-standards-for-makefiles">standards for
makefiles</a>:</td><td> </td><td valign="top"><a
href="#Makefile-Conventions">Makefile Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-struct-types_002c-formatting"><code>struct</code> types,
formatting</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-syntactic-conventions">syntactic
conventions</a>:</td><td> </td><td valign="top"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-T">T</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-table-of-long-options">table of
long options</a>:</td><td> </td><td valign="top"><a
href="#Option-Table">Option Table</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-temporary-files">temporary
files</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-temporary-variables">temporary
variables</a>:</td><td> </td><td valign="top"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-texinfo_002etex_002c-in-a-distribution">‘<tt>texinfo.tex</tt>’,
in a distribution</a>:</td><td> </td><td valign="top"><a
href="#Releases">Releases</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-TMPDIR-environment-variable"><code>TMPDIR</code> environment
variable</a>:</td><td> </td><td valign="top"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-trademarks">trademarks</a>:</td><td> </td><td valign="top"><a
href="#Trademarks">Trademarks</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-U">U</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-user-interface-styles">user
interface styles</a>:</td><td> </td><td valign="top"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-V">V</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-valgrind"><code>valgrind</code></a>:</td><td> </td><td
valign="top"><a href="#Memory-Usage">Memory Usage</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-W">W</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-where-to-obtain-standards_002etexi">where to obtain
<code>standards.texi</code></a>:</td><td> </td><td valign="top"><a
href="#Preface">Preface</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-X">X</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-X_002e509">X.509</a>:</td><td> </td><td valign="top"><a
href="#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-xmalloc_002c-in-Gnulib"><code>xmalloc, in
Gnulib</code></a>:</td><td> </td><td valign="top"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+</table>
+<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter"
href="#Index_cp_symbol-1"><b>#</b></a>
+
+<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+
+<br>
+<a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-Q"><b>Q</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+
+</td></tr></table>
+
+<hr>
+
-<ul class="index-cp" compact>
-<li><a
href="#index-g_t_0040code_007b_0023endif_007d_002c-commenting-88"><code>#endif</code>,
commenting</a>: <a href="#Comments">Comments</a></li>
-<li><a
href="#index-g_t_0040samp_007b_002d_002dhelp_007d-output-60">‘<samp><span
class="samp">--help</span></samp>’ output</a>: <a
href="#g_t_002d_002dhelp">--help</a></li>
-<li><a
href="#index-g_t_0040samp_007b_002d_002dversion_007d-output-57">‘<samp><span
class="samp">--version</span></samp>’ output</a>: <a
href="#g_t_002d_002dversion">--version</a></li>
-<li><a
href="#index-g_t_0040samp_007b_002dWall_007d-compiler-option-93">‘<samp><span
class="samp">-Wall</span></samp>’ compiler option</a>: <a
href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a href="#index-accepting-contributions-11">accepting contributions</a>:
<a href="#Contributions">Contributions</a></li>
-<li><a href="#index-address-for-bug-reports-61">address for bug reports</a>:
<a href="#g_t_002d_002dhelp">--help</a></li>
-<li><a href="#index-g_t_0040sc_007bansi_007d-C-standard-22"><span
class="sc">ansi</span> C standard</a>: <a href="#Standard-C">Standard C</a></li>
-<li><a href="#index-arbitrary-limits-on-data-24">arbitrary limits on data</a>:
<a href="#Semantics">Semantics</a></li>
-<li><a href="#index-ASCII-characters-120">ASCII characters</a>: <a
href="#Character-Set">Character Set</a></li>
-<li><a href="#index-autoconf-102"><code>autoconf</code></a>: <a
href="#System-Portability">System Portability</a></li>
-<li><a href="#index-avoiding-proprietary-code-9">avoiding proprietary
code</a>: <a href="#Reading-Non_002dFree-Code">Reading Non-Free Code</a></li>
-<li><a
href="#index-behavior_002c-dependent-on-program_0027s-name-39">behavior,
dependent on program's name</a>: <a href="#User-Interfaces">User
Interfaces</a></li>
-<li><a href="#index-binary-packages-160">binary packages</a>: <a
href="#Install-Command-Categories">Install Command Categories</a></li>
-<li><a href="#index-bindir-155"><code>bindir</code></a>: <a
href="#Directory-Variables">Directory Variables</a></li>
-<li><a href="#index-braces_002c-in-C-source-78">braces, in C source</a>: <a
href="#Formatting">Formatting</a></li>
-<li><a href="#index-bug-reports-62">bug reports</a>: <a
href="#g_t_002d_002dhelp">--help</a></li>
-<li><a
href="#index-g_t_0040code_007bbug_002dstandards_0040_0040gnu_002eorg_007d-email-address-4"><code>address@hidden</code>
email address</a>: <a href="#Preface">Preface</a></li>
-<li><a href="#index-C-library-functions_002c-and-portability-107">C library
functions, and portability</a>: <a href="#System-Functions">System
Functions</a></li>
-<li><a href="#index-canonical-name-of-a-program-58">canonical name of a
program</a>: <a href="#g_t_002d_002dversion">--version</a></li>
-<li><a href="#index-casting-pointers-to-integers-106">casting pointers to
integers</a>: <a href="#CPU-Portability">CPU Portability</a></li>
-<li><a href="#index-CGI-programs_002c-standard-options-for-55">CGI programs,
standard options for</a>: <a href="#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a href="#index-change-logs-136">change logs</a>: <a
href="#Change-Logs">Change Logs</a></li>
-<li><a href="#index-change-logs_002c-conditional-changes-139">change logs,
conditional changes</a>: <a href="#Conditional-Changes">Conditional
Changes</a></li>
-<li><a href="#index-change-logs_002c-style-137">change logs, style</a>: <a
href="#Style-of-Change-Logs">Style of Change Logs</a></li>
-<li><a href="#index-character-set-118">character set</a>: <a
href="#Character-Set">Character Set</a></li>
-<li><a href="#index-clang-94"><code>clang</code></a>: <a
href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a href="#index-command_002dline-arguments_002c-decoding-30">command-line
arguments, decoding</a>: <a href="#Semantics">Semantics</a></li>
-<li><a href="#index-command_002dline-interface-50">command-line interface</a>:
<a href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></li>
-<li><a href="#index-commenting-86">commenting</a>: <a
href="#Comments">Comments</a></li>
-<li><a
href="#index-compatibility-with-C-and-_0040sc_007bposix_007d-standards-17">compatibility
with C and <span class="sc">posix</span> standards</a>: <a
href="#Compatibility">Compatibility</a></li>
-<li><a href="#index-compiler-warnings-92">compiler warnings</a>: <a
href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a href="#index-conditional-changes_002c-and-change-logs-138">conditional
changes, and change logs</a>: <a href="#Conditional-Changes">Conditional
Changes</a></li>
-<li><a href="#index-conditionals_002c-comments-for-87">conditionals, comments
for</a>: <a href="#Comments">Comments</a></li>
-<li><a href="#index-configure-143"><code>configure</code></a>: <a
href="#Configuration">Configuration</a></li>
-<li><a href="#index-control_002dL-85">control-L</a>: <a
href="#Formatting">Formatting</a></li>
-<li><a href="#index-conventions-for-makefiles-146">conventions for
makefiles</a>: <a href="#Makefile-Conventions">Makefile Conventions</a></li>
-<li><a href="#index-CORBA-45">CORBA</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-credits-for-manuals-134">credits for manuals</a>: <a
href="#Manual-Credits">Manual Credits</a></li>
-<li><a href="#index-D_002dbus-47">D-bus</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-data-structures_002c-in-Gnulib-114"><code>data structures,
in Gnulib</code></a>: <a href="#System-Functions">System Functions</a></li>
-<li><a href="#index-data-types_002c-and-portability-104">data types, and
portability</a>: <a href="#CPU-Portability">CPU Portability</a></li>
-<li><a href="#index-DESTDIR-148"><code>DESTDIR</code></a>: <a
href="#DESTDIR">DESTDIR</a></li>
-<li><a href="#index-directories_002c-creating-installation-151">directories,
creating installation</a>: <a href="#Directory-Variables">Directory
Variables</a></li>
-<li><a href="#index-documentation-131">documentation</a>: <a
href="#Documentation">Documentation</a></li>
-<li><a href="#index-doschk-100"><code>doschk</code></a>: <a
href="#Names">Names</a></li>
-<li><a href="#index-double-quote-128">double quote</a>: <a
href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-downloading-this-manual-2">downloading this manual</a>: <a
href="#Preface">Preface</a></li>
-<li><a href="#index-dynamic-plug_002dins-64">dynamic plug-ins</a>: <a
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></li>
-<li><a href="#index-encodings-119">encodings</a>: <a
href="#Character-Set">Character Set</a></li>
-<li><a
href="#index-g_t_0040code_007benum_007d-types_002c-formatting-81"><code>enum</code>
types, formatting</a>: <a href="#Formatting">Formatting</a></li>
-<li><a href="#index-error-messages-27">error messages</a>: <a
href="#Semantics">Semantics</a></li>
-<li><a href="#index-error-messages_002c-formatting-37">error messages,
formatting</a>: <a href="#Errors">Errors</a></li>
-<li><a href="#index-error-messages_002c-in-Gnulib-113"><code>error messages,
in Gnulib</code></a>: <a href="#System-Functions">System Functions</a></li>
-<li><a href="#index-exec_005fprefix-154"><code>exec_prefix</code></a>: <a
href="#Directory-Variables">Directory Variables</a></li>
-<li><a href="#index-expressions_002c-splitting-83">expressions, splitting</a>:
<a href="#Formatting">Formatting</a></li>
-<li><a href="#index-FDL_002c-GNU-Free-Documentation-License-165">FDL, GNU Free
Documentation License</a>: <a href="#GNU-Free-Documentation-License">GNU Free
Documentation License</a></li>
-<li><a href="#index-file-usage-75">file usage</a>: <a href="#File-Usage">File
Usage</a></li>
-<li><a href="#index-file_002dname-limitations-99">file-name limitations</a>:
<a href="#Names">Names</a></li>
-<li><a href="#index-formatting-error-messages-36">formatting error
messages</a>: <a href="#Errors">Errors</a></li>
-<li><a href="#index-formatting-source-code-76">formatting source code</a>: <a
href="#Formatting">Formatting</a></li>
-<li><a href="#index-formfeed-84">formfeed</a>: <a
href="#Formatting">Formatting</a></li>
-<li><a href="#index-function-argument_002c-declaring-91">function argument,
declaring</a>: <a href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a href="#index-function-definitions_002c-formatting-79">function
definitions, formatting</a>: <a href="#Formatting">Formatting</a></li>
-<li><a href="#index-function-prototypes-23">function prototypes</a>: <a
href="#Standard-C">Standard C</a></li>
-<li><a href="#index-getopt-51"><code>getopt</code></a>: <a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></li>
-<li><a href="#index-gettext-116"><code>gettext</code></a>: <a
href="#Internationalization">Internationalization</a></li>
-<li><a href="#index-GNOME-46">GNOME</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-GNOME-and-Guile-16">GNOME and Guile</a>: <a
href="#Source-Language">Source Language</a></li>
-<li><a href="#index-Gnulib-111">Gnulib</a>: <a href="#System-Functions">System
Functions</a></li>
-<li><a href="#index-gnustandards-project-repository-6">gnustandards project
repository</a>: <a href="#Preface">Preface</a></li>
-<li><a
href="#index-g_t_0040code_007bgnustandards_002dcommit_0040_0040gnu_002eorg_007d-mailing-list-3"><code>address@hidden</code>
mailing list</a>: <a href="#Preface">Preface</a></li>
-<li><a href="#index-graphical-user-interface-41">graphical user interface</a>:
<a href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-grave-accent-129">grave accent</a>: <a
href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-GTK_002b-44">GTK+</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-Guile-15">Guile</a>: <a href="#Source-Language">Source
Language</a></li>
-<li><a href="#index-implicit-_0040code_007bint_007d-90">implicit
<code>int</code></a>: <a href="#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a href="#index-impossible-conditions-32">impossible conditions</a>: <a
href="#Semantics">Semantics</a></li>
-<li><a href="#index-installation-directories_002c-creating-152">installation
directories, creating</a>: <a href="#Directory-Variables">Directory
Variables</a></li>
-<li><a href="#index-installations_002c-staged-150">installations, staged</a>:
<a href="#DESTDIR">DESTDIR</a></li>
-<li><a href="#index-interface-styles-42">interface styles</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-internationalization-115">internationalization</a>: <a
href="#Internationalization">Internationalization</a></li>
-<li><a href="#index-keyboard-interface-48">keyboard interface</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-LDAP-70">LDAP</a>: <a href="#OID-Allocations">OID
Allocations</a></li>
-<li><a href="#index-left-quote-124">left quote</a>: <a
href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-legal-aspects-7">legal aspects</a>: <a
href="#Legal-Issues">Legal Issues</a></li>
-<li><a href="#index-legal-papers-10">legal papers</a>: <a
href="#Contributions">Contributions</a></li>
-<li><a href="#index-libexecdir-157"><code>libexecdir</code></a>: <a
href="#Directory-Variables">Directory Variables</a></li>
-<li><a href="#index-libiconv-26"><code>libiconv</code></a>: <a
href="#Semantics">Semantics</a></li>
-<li><a href="#index-libraries-35">libraries</a>: <a
href="#Libraries">Libraries</a></li>
-<li><a href="#index-library-functions_002c-and-portability-109">library
functions, and portability</a>: <a href="#System-Functions">System
Functions</a></li>
-<li><a href="#index-library-interface-49">library interface</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-license-for-manuals-133">license for manuals</a>: <a
href="#License-for-Manuals">License for Manuals</a></li>
-<li><a href="#index-lint-95"><code>lint</code></a>: <a
href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a href="#index-locale_002dspecific-quote-characters-123">locale-specific
quote characters</a>: <a href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-long-option-names-66">long option names</a>: <a
href="#Option-Table">Option Table</a></li>
-<li><a href="#index-long_002dnamed-options-52">long-named options</a>: <a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></li>
-<li><a href="#index-makefile_002c-conventions-for-145">makefile, conventions
for</a>: <a href="#Makefile-Conventions">Makefile Conventions</a></li>
-<li><a
href="#index-g_t_0040code_007bmalloc_007d-return-value-28"><code>malloc</code>
return value</a>: <a href="#Semantics">Semantics</a></li>
-<li><a href="#index-man-pages-140">man pages</a>: <a href="#Man-Pages">Man
Pages</a></li>
-<li><a href="#index-manual-structure-132">manual structure</a>: <a
href="#Manual-Structure-Details">Manual Structure Details</a></li>
-<li><a href="#index-memory-allocation-failure-29">memory allocation
failure</a>: <a href="#Semantics">Semantics</a></li>
-<li><a href="#index-memory-leak-74">memory leak</a>: <a
href="#Memory-Usage">Memory Usage</a></li>
-<li><a href="#index-memory-usage-72">memory usage</a>: <a
href="#Memory-Usage">Memory Usage</a></li>
-<li><a href="#index-message-text_002c-and-internationalization-117">message
text, and internationalization</a>: <a
href="#Internationalization">Internationalization</a></li>
-<li><a href="#index-mmap-130"><code>mmap</code></a>: <a
href="#Mmap">Mmap</a></li>
-<li><a href="#index-multiple-variables-in-a-line-97">multiple variables in a
line</a>: <a href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a href="#index-names-of-variables_002c-functions_002c-and-files-98">names
of variables, functions, and files</a>: <a href="#Names">Names</a></li>
-<li><a href="#index-g_t_0040file_007bNEWS_007d-file-135"><samp><span
class="file">NEWS</span></samp> file</a>: <a href="#NEWS-File">NEWS
File</a></li>
-<li><a href="#index-non_002dASCII-characters-121">non-ASCII characters</a>: <a
href="#Character-Set">Character Set</a></li>
-<li><a
href="#index-non_002d_0040sc_007bposix_007d-systems_002c-and-portability-103">non-<span
class="sc">posix</span> systems, and portability</a>: <a
href="#System-Portability">System Portability</a></li>
-<li><a href="#index-non_002dstandard-extensions-21">non-standard
extensions</a>: <a href="#Using-Extensions">Using Extensions</a></li>
-<li><a href="#index-g_t_0040code_007bNUL_007d-characters-25"><code>NUL</code>
characters</a>: <a href="#Semantics">Semantics</a></li>
-<li><a href="#index-OID-allocations-for-GNU-68">OID allocations for GNU</a>:
<a href="#OID-Allocations">OID Allocations</a></li>
-<li><a href="#index-open-brace-77">open brace</a>: <a
href="#Formatting">Formatting</a></li>
-<li><a href="#index-opening-quote-126">opening quote</a>: <a
href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-optional-features_002c-configure_002dtime-144">optional
features, configure-time</a>: <a href="#Configuration">Configuration</a></li>
-<li><a href="#index-options-for-compatibility-19">options for
compatibility</a>: <a href="#Compatibility">Compatibility</a></li>
-<li><a href="#index-options_002c-standard-command_002dline-54">options,
standard command-line</a>: <a href="#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a href="#index-output-device-and-program_0027s-behavior-40">output device
and program's behavior</a>: <a href="#User-Interfaces">User Interfaces</a></li>
-<li><a href="#index-packaging-161">packaging</a>: <a
href="#Releases">Releases</a></li>
-<li><a
href="#index-PATH_005fINFO_002c-specifying-standard-options-as-56">PATH_INFO,
specifying standard options as</a>: <a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></li>
-<li><a href="#index-plug_002dins-63">plug-ins</a>: <a
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></li>
-<li><a
href="#index-plugin_005fis_005fGPL_005fcompatible-65"><code>plugin_is_GPL_compatible</code></a>:
<a href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></li>
-<li><a href="#index-portability_002c-and-data-types-105">portability, and data
types</a>: <a href="#CPU-Portability">CPU Portability</a></li>
-<li><a href="#index-portability_002c-and-library-functions-110">portability,
and library functions</a>: <a href="#System-Functions">System Functions</a></li>
-<li><a href="#index-portability_002c-between-system-types-101">portability,
between system types</a>: <a href="#System-Portability">System
Portability</a></li>
-<li><a href="#index-g_t_0040sc_007bposix_007d-compatibility-18"><span
class="sc">posix</span> compatibility</a>: <a
href="#Compatibility">Compatibility</a></li>
-<li><a href="#index-POSIX-functions_002c-and-portability-108">POSIX functions,
and portability</a>: <a href="#System-Functions">System Functions</a></li>
-<li><a
href="#index-g_t_0040code_007bPOSIXLY_005fCORRECT_007d_002c-environment-variable-20"><code>POSIXLY_CORRECT</code>,
environment variable</a>: <a href="#Compatibility">Compatibility</a></li>
-<li><a href="#index-post_002dinstallation-commands-159">post-installation
commands</a>: <a href="#Install-Command-Categories">Install Command
Categories</a></li>
-<li><a href="#index-pre_002dinstallation-commands-158">pre-installation
commands</a>: <a href="#Install-Command-Categories">Install Command
Categories</a></li>
-<li><a href="#index-prefix-153"><code>prefix</code></a>: <a
href="#Directory-Variables">Directory Variables</a></li>
-<li><a href="#index-program-configuration-142">program configuration</a>: <a
href="#Configuration">Configuration</a></li>
-<li><a href="#index-program-design-13">program design</a>: <a
href="#Design-Advice">Design Advice</a></li>
-<li><a href="#index-program-name-and-its-behavior-38">program name and its
behavior</a>: <a href="#User-Interfaces">User Interfaces</a></li>
-<li><a href="#index-program_0027s-canonical-name-59">program's canonical
name</a>: <a href="#g_t_002d_002dversion">--version</a></li>
-<li><a href="#index-programming-languages-14">programming languages</a>: <a
href="#Source-Language">Source Language</a></li>
-<li><a href="#index-proprietary-programs-8">proprietary programs</a>: <a
href="#Reading-Non_002dFree-Code">Reading Non-Free Code</a></li>
-<li><a href="#index-quote-characters-122">quote characters</a>: <a
href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-g_t_0040file_007bREADME_007d-file-162"><samp><span
class="file">README</span></samp> file</a>: <a
href="#Releases">Releases</a></li>
-<li><a href="#index-references-to-non_002dfree-material-164">references to
non-free material</a>: <a href="#References">References</a></li>
-<li><a href="#index-releasing-141">releasing</a>: <a
href="#Managing-Releases">Managing Releases</a></li>
-<li><a href="#index-right-quote-125">right quote</a>: <a
href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-Savannah-repository-for-gnustandards-5">Savannah
repository for gnustandards</a>: <a href="#Preface">Preface</a></li>
-<li><a href="#index-sbindir-156"><code>sbindir</code></a>: <a
href="#Directory-Variables">Directory Variables</a></li>
-<li><a href="#index-signal-handling-31">signal handling</a>: <a
href="#Semantics">Semantics</a></li>
-<li><a href="#index-single-quote-127">single quote</a>: <a
href="#Quote-Characters">Quote Characters</a></li>
-<li><a href="#index-SNMP-69">SNMP</a>: <a href="#OID-Allocations">OID
Allocations</a></li>
-<li><a href="#index-spaces-before-open_002dparen-82">spaces before
open-paren</a>: <a href="#Formatting">Formatting</a></li>
-<li><a href="#index-staged-installs-149">staged installs</a>: <a
href="#DESTDIR">DESTDIR</a></li>
-<li><a href="#index-standard-command_002dline-options-53">standard
command-line options</a>: <a href="#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a href="#index-standards-for-makefiles-147">standards for makefiles</a>:
<a href="#Makefile-Conventions">Makefile Conventions</a></li>
-<li><a
href="#index-g_t_0040code_007bstruct_007d-types_002c-formatting-80"><code>struct</code>
types, formatting</a>: <a href="#Formatting">Formatting</a></li>
-<li><a href="#index-syntactic-conventions-89">syntactic conventions</a>: <a
href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a href="#index-table-of-long-options-67">table of long options</a>: <a
href="#Option-Table">Option Table</a></li>
-<li><a href="#index-temporary-files-33">temporary files</a>: <a
href="#Semantics">Semantics</a></li>
-<li><a href="#index-temporary-variables-96">temporary variables</a>: <a
href="#Syntactic-Conventions">Syntactic Conventions</a></li>
-<li><a
href="#index-g_t_0040file_007btexinfo_002etex_007d_002c-in-a-distribution-163"><samp><span
class="file">texinfo.tex</span></samp>, in a distribution</a>: <a
href="#Releases">Releases</a></li>
-<li><a
href="#index-g_t_0040code_007bTMPDIR_007d-environment-variable-34"><code>TMPDIR</code>
environment variable</a>: <a href="#Semantics">Semantics</a></li>
-<li><a href="#index-trademarks-12">trademarks</a>: <a
href="#Trademarks">Trademarks</a></li>
-<li><a href="#index-user-interface-styles-43">user interface styles</a>: <a
href="#Graphical-Interfaces">Graphical Interfaces</a></li>
-<li><a href="#index-valgrind-73"><code>valgrind</code></a>: <a
href="#Memory-Usage">Memory Usage</a></li>
-<li><a
href="#index-where-to-obtain-_0040code_007bstandards_002etexi_007d-1">where to
obtain <code>standards.texi</code></a>: <a href="#Preface">Preface</a></li>
-<li><a href="#index-X_002e509-71">X.509</a>: <a href="#OID-Allocations">OID
Allocations</a></li>
-<li><a href="#index-xmalloc_002c-in-Gnulib-112"><code>xmalloc, in
Gnulib</code></a>: <a href="#System-Functions">System Functions</a></li>
- </ul></body></html>
+</body>
+</html>
Index: standards/standards.html.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.html.gz,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -b -r1.64 -r1.65
Binary files /tmp/cvsNIv0c6 and /tmp/cvsvenq2s differ
Index: standards/standards.html_node.tar.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.html_node.tar.gz,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -b -r1.64 -r1.65
Binary files /tmp/cvsM2iEg7 and /tmp/cvs7F2E7t differ
Index: standards/standards.info.tar.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.info.tar.gz,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -b -r1.63 -r1.64
Binary files /tmp/cvsSmrT29 and /tmp/cvsjjSlVw differ
Index: standards/standards.pdf
===================================================================
RCS file: /web/www/www/prep/standards/standards.pdf,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -b -r1.63 -r1.64
Binary files /tmp/cvsbjttO8 and /tmp/cvsQOMNJv differ
Index: standards/standards.ps.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.ps.gz,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -b -r1.63 -r1.64
Binary files /tmp/cvsmYp5Wc and /tmp/cvsprDiWz differ
Index: standards/standards.texi.tar.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.texi.tar.gz,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -b -r1.63 -r1.64
Binary files /tmp/cvslCvPOe and /tmp/cvsXEGQPB differ
Index: standards/standards.txt
===================================================================
RCS file: /web/www/www/prep/standards/standards.txt,v
retrieving revision 1.62
retrieving revision 1.63
diff -u -b -r1.62 -r1.63
--- standards/standards.txt 8 Apr 2012 00:23:25 -0000 1.62
+++ standards/standards.txt 7 May 2012 00:47:47 -0000 1.63
@@ -1,6 +1,3 @@
-Table of Contents
-*****************
-
GNU Coding Standards
1 About the GNU Coding Standards
2 Keeping Free Software Free
@@ -21,8 +18,8 @@
4.5 Standards for Interfaces Generally
4.6 Standards for Graphical Interfaces
4.7 Standards for Command Line Interfaces
- 4.7.1 `--version'
- 4.7.2 `--help'
+ 4.7.1 '--version'
+ 4.7.2 '--help'
4.8 Standards for Dynamic Plug-in Interfaces
4.9 Table of Long Options
4.10 OID Allocations
@@ -62,7 +59,7 @@
7.2.1 General Conventions for Makefiles
7.2.2 Utilities in Makefiles
7.2.3 Variables for Specifying Commands
- 7.2.4 `DESTDIR': Support for Staged Installs
+ 7.2.4 'DESTDIR': Support for Staged Installs
7.2.5 Variables for Installation Directories
7.2.6 Standard Targets for Users
7.2.7 Install Command Categories
@@ -70,8 +67,6 @@
8 References to Non-Free Software and Documentation
Appendix A GNU Free Documentation License
Index
-
-
GNU Coding Standards
********************
@@ -103,16 +98,16 @@
recently, please check for a newer version. You can get the GNU Coding
Standards from the GNU web server in many different formats, including
the Texinfo source, PDF, HTML, DVI, plain text, and more, at:
-`http://www.gnu.org/prep/standards/'.
+'http://www.gnu.org/prep/standards/'.
If you are maintaining an official GNU package, in addition to this
document, please read and follow the GNU maintainer information (*note
Contents: (maintain)Top.).
If you want to receive diffs for every change to these GNU documents,
-join the mailing list address@hidden', via the web
+join the mailing list 'address@hidden', via the web
interface at
-`http://lists.gnu.org/mailman/listinfo/gnustandards-commit'. Archives
+'http://lists.gnu.org/mailman/listinfo/gnustandards-commit'. Archives
are also available there.
Please send corrections or suggestions for this document to
@@ -122,7 +117,7 @@
that's difficult for you, you can make a context diff for some other
version of this document, or propose it in any way that makes it clear.
The source repository for this document can be found at
-`http://savannah.gnu.org/projects/gnustandards'.
+'http://savannah.gnu.org/projects/gnustandards'.
These standards cover the minimum of what is important when writing a
GNU package. Likely, the need for additional standards will come up.
@@ -132,13 +127,13 @@
You should also set standards for your package on many questions not
addressed or not firmly specified here. The most important point is to
-be self-consistent--try to stick to the conventions you pick, and try
-to document them as much as possible. That way, your program will be
-more maintainable by others.
+be self-consistent--try to stick to the conventions you pick, and try to
+document them as much as possible. That way, your program will be more
+maintainable by others.
The GNU Hello program serves as an example of how to follow the GNU
coding standards for a trivial program.
-`http://www.gnu.org/software/hello/hello.html'.
+'http://www.gnu.org/software/hello/hello.html'.
This release of the GNU Coding Standards was last updated April 7,
2012.
@@ -156,10 +151,10 @@
work on GNU! (Or to any other proprietary programs.)
If you have a vague recollection of the internals of a Unix program,
-this does not absolutely mean you can't write an imitation of it, but
-do try to organize the imitation internally along different lines,
-because this is likely to make the details of the Unix version
-irrelevant and dissimilar to your results.
+this does not absolutely mean you can't write an imitation of it, but do
+try to organize the imitation internally along different lines, because
+this is likely to make the details of the Unix version irrelevant and
+dissimilar to your results.
For example, Unix utilities were generally optimized to minimize
memory use; if you go for speed instead, your program will be very
@@ -224,9 +219,8 @@
result.
We have more detailed advice for maintainers of GNU packages. If you
-have reached the stage of maintaining a GNU program (whether released
-or not), please take a look: *note Legal Matters: (maintain)Legal
-Matters.
+have reached the stage of maintaining a GNU program (whether released or
+not), please take a look: *note (maintain)Legal Matters::.
2.3 Trademarks
==============
@@ -242,21 +236,21 @@
What is legally required, as regards other people's trademarks, is to
avoid using them in ways which a reader might reasonably understand as
naming or labeling our own programs or activities. For example, since
-"Objective C" is (or at least was) a trademark, we made sure to say
-that we provide a "compiler for the Objective C language" rather than
-an "Objective C compiler". The latter would have been meant as a
-shorter way of saying the former, but it does not explicitly state the
+"Objective C" is (or at least was) a trademark, we made sure to say that
+we provide a "compiler for the Objective C language" rather than an
+"Objective C compiler". The latter would have been meant as a shorter
+way of saying the former, but it does not explicitly state the
relationship, so it could be misinterpreted as using "Objective C" as a
label for the compiler rather than for the language.
Please don't use "win" as an abbreviation for Microsoft Windows in
-GNU software or documentation. In hacker terminology, calling
-something a "win" is a form of praise. If you wish to praise Microsoft
-Windows when speaking on your own, by all means do so, but not in GNU
-software. Usually we write the name "Windows" in full, but when
-brevity is very important (as in file names and sometimes symbol
-names), we abbreviate it to "w". For instance, the files and functions
-in Emacs that deal with Windows start with `w32'.
+GNU software or documentation. In hacker terminology, calling something
+a "win" is a form of praise. If you wish to praise Microsoft Windows
+when speaking on your own, by all means do so, but not in GNU software.
+Usually we write the name "Windows" in full, but when brevity is very
+important (as in file names and sometimes symbol names), we abbreviate
+it to "w". For instance, the files and functions in Emacs that deal
+with Windows start with 'w32'.
3 General Program Design
************************
@@ -290,9 +284,8 @@
installed the other language anyway.
* If an application is of interest only to a narrow part of the
- community, then the question of which language it is written in
- has less effect on other people, so you may as well please
- yourself.
+ community, then the question of which language it is written in has
+ less effect on other people, so you may as well please yourself.
Many programs are designed to be extensible: they include an
interpreter for a language that is higher level than C. Often much of
@@ -300,7 +293,7 @@
pioneered this technique.
The standard extensibility interpreter for GNU software is Guile
-(`http://www.gnu.org/software/guile/'), which implements the language
+('http://www.gnu.org/software/guile/'), which implements the language
Scheme (an especially clean and simple dialect of Lisp). Guile also
includes bindings for GTK+/GNOME, making it practical to write modern
GUI functionality within Guile. We don't reject programs written in
@@ -318,26 +311,26 @@
When these standards conflict, it is useful to offer compatibility
modes for each of them.
- Standard C and POSIX prohibit many kinds of extensions. Feel free
-to make the extensions anyway, and include a `--ansi', `--posix', or
-`--compatible' option to turn them off. However, if the extension has
-a significant chance of breaking any real programs or scripts, then it
-is not really upward compatible. So you should try to redesign its
+ Standard C and POSIX prohibit many kinds of extensions. Feel free to
+make the extensions anyway, and include a '--ansi', '--posix', or
+'--compatible' option to turn them off. However, if the extension has a
+significant chance of breaking any real programs or scripts, then it is
+not really upward compatible. So you should try to redesign its
interface to make it upward compatible.
Many GNU programs suppress extensions that conflict with POSIX if the
-environment variable `POSIXLY_CORRECT' is defined (even if it is
-defined with a null value). Please make your program recognize this
-variable if appropriate.
+environment variable 'POSIXLY_CORRECT' is defined (even if it is defined
+with a null value). Please make your program recognize this variable if
+appropriate.
When a feature is used only by users (not by programs or command
files), and it is done poorly in Unix, feel free to replace it
completely with something totally different and better. (For example,
-`vi' is replaced with Emacs.) But it is nice to offer a compatible
-feature as well. (There is a free `vi' clone, so we offer it.)
+'vi' is replaced with Emacs.) But it is nice to offer a compatible
+feature as well. (There is a free 'vi' clone, so we offer it.)
- Additional useful features are welcome regardless of whether there
-is any precedent for them.
+ Additional useful features are welcome regardless of whether there is
+any precedent for them.
3.3 Using Non-standard Features
===============================
@@ -346,31 +339,29 @@
extensions over the comparable Unix facilities. Whether to use these
extensions in implementing your program is a difficult question.
- On the one hand, using the extensions can make a cleaner program.
-On the other hand, people will not be able to build the program unless
-the other GNU tools are available. This might cause the program to
-work on fewer kinds of machines.
+ On the one hand, using the extensions can make a cleaner program. On
+the other hand, people will not be able to build the program unless the
+other GNU tools are available. This might cause the program to work on
+fewer kinds of machines.
With some extensions, it might be easy to provide both alternatives.
-For example, you can define functions with a "keyword" `INLINE' and
-define that as a macro to expand into either `inline' or nothing,
+For example, you can define functions with a "keyword" 'INLINE' and
+define that as a macro to expand into either 'inline' or nothing,
depending on the compiler.
In general, perhaps it is best not to use the extensions if you can
-straightforwardly do without them, but to use the extensions if they
-are a big improvement.
+straightforwardly do without them, but to use the extensions if they are
+a big improvement.
An exception to this rule are the large, established programs (such
-as Emacs) which run on a great variety of systems. Using GNU
-extensions in such programs would make many users unhappy, so we don't
-do that.
+as Emacs) which run on a great variety of systems. Using GNU extensions
+in such programs would make many users unhappy, so we don't do that.
Another exception is for programs that are used as part of
compilation: anything that must be compiled with other compilers in
-order to bootstrap the GNU compilation facilities. If these require
-the GNU compiler, then no one can compile them without having them
-installed already. That would be extremely troublesome in certain
-cases.
+order to bootstrap the GNU compilation facilities. If these require the
+GNU compiler, then no one can compile them without having them installed
+already. That would be extremely troublesome in certain cases.
3.4 Standard C and Pre-Standard C
=================================
@@ -409,18 +400,18 @@
And once you have the declaration, you normally lose nothing by writing
the function definition in the pre-standard style.
- This technique does not work for integer types narrower than `int'.
-If you think of an argument as being of a type narrower than `int',
-declare it as `int' instead.
+ This technique does not work for integer types narrower than 'int'.
+If you think of an argument as being of a type narrower than 'int',
+declare it as 'int' instead.
There are a few special cases where this technique is hard to use.
For example, if a function argument needs to hold the system type
-`dev_t', you run into trouble, because `dev_t' is shorter than `int' on
-some machines; but you cannot use `int' instead, because `dev_t' is
-wider than `int' on some machines. There is no type you can safely use
+'dev_t', you run into trouble, because 'dev_t' is shorter than 'int' on
+some machines; but you cannot use 'int' instead, because 'dev_t' is
+wider than 'int' on some machines. There is no type you can safely use
on all machines in a non-standard definition. The only way to support
non-standard C and pass such an argument is to check the width of
-`dev_t' using Autoconf and choose the argument type accordingly. This
+'dev_t' using Autoconf and choose the argument type accordingly. This
may not be worth the trouble.
In order to support pre-standard compilers that do not recognize
@@ -437,7 +428,7 @@
===========================
When supporting configuration options already known when building your
-program we prefer using `if (... )' over conditional compilation, as in
+program we prefer using 'if (... )' over conditional compilation, as in
the former case the compiler is able to perform more extensive checking
of all possible code paths.
@@ -459,15 +450,15 @@
A modern compiler such as GCC will generate exactly the same code in
both cases, and we have been using similar techniques with good success
in several projects. Of course, the former method assumes that
-`HAS_FOO' is defined as either 0 or 1.
+'HAS_FOO' is defined as either 0 or 1.
While this is not a silver bullet solving all portability problems,
and is not always appropriate, following this policy would have saved
GCC developers many hours, or even days, per year.
- In the case of function-like macros like `REVERSIBLE_CC_MODE' in GCC
-which cannot be simply used in `if (...)' statements, there is an easy
-workaround. Simply introduce another macro `HAS_REVERSIBLE_CC_MODE' as
+ In the case of function-like macros like 'REVERSIBLE_CC_MODE' in GCC
+which cannot be simply used in 'if (...)' statements, there is an easy
+workaround. Simply introduce another macro 'HAS_REVERSIBLE_CC_MODE' as
in the following example:
#ifdef REVERSIBLE_CC_MODE
@@ -479,8 +470,8 @@
4 Program Behavior for All Programs
***********************************
-This chapter describes conventions for writing robust software. It
-also describes general standards for error messages, the command line
+This chapter describes conventions for writing robust software. It also
+describes general standards for error messages, the command line
interface, and how libraries should behave.
4.1 Non-GNU Standards
@@ -495,8 +486,8 @@
In most cases, following published standards is convenient for
users--it means that their programs or scripts will work more portably.
For instance, GCC implements nearly all the features of Standard C as
-specified by that standard. C program developers would be unhappy if
-it did not. And GNU utilities mostly follow specifications of POSIX.2;
+specified by that standard. C program developers would be unhappy if it
+did not. And GNU utilities mostly follow specifications of POSIX.2;
shell script writers and users would be unhappy if our programs were
incompatible.
@@ -508,21 +499,20 @@
prohibited. How silly! GCC implements many extensions, some of which
were later adopted as part of the standard. If you want these
constructs to give an error message as "required" by the standard, you
-must specify `--pedantic', which was implemented only so that we can
-say "GCC is a 100% implementation of the standard", not because there
-is any reason to actually use it.
+must specify '--pedantic', which was implemented only so that we can say
+"GCC is a 100% implementation of the standard", not because there is any
+reason to actually use it.
- POSIX.2 specifies that `df' and `du' must output sizes by default in
+ POSIX.2 specifies that 'df' and 'du' must output sizes by default in
units of 512 bytes. What users want is units of 1k, so that is what we
-do by default. If you want the ridiculous behavior "required" by
-POSIX, you must set the environment variable `POSIXLY_CORRECT' (which
-was originally going to be named `POSIX_ME_HARDER').
+do by default. If you want the ridiculous behavior "required" by POSIX,
+you must set the environment variable 'POSIXLY_CORRECT' (which was
+originally going to be named 'POSIX_ME_HARDER').
GNU utilities also depart from the letter of the POSIX.2
specification when they support long-named command-line options, and
-intermixing options with ordinary arguments. This minor
-incompatibility with POSIX is never a problem in practice, and it is
-very useful.
+intermixing options with ordinary arguments. This minor incompatibility
+with POSIX is never a problem in practice, and it is very useful.
In particular, don't reject a new feature, or remove an old one,
merely because a standard says it is "forbidden" or "deprecated".
@@ -539,39 +529,39 @@
nonprinting characters _including those with codes above 0177_. The
only sensible exceptions would be utilities specifically intended for
interface to certain types of terminals or printers that can't handle
-those characters. Whenever possible, try to make programs work
-properly with sequences of bytes that represent multibyte characters;
-UTF-8 is the most important.
+those characters. Whenever possible, try to make programs work properly
+with sequences of bytes that represent multibyte characters; UTF-8 is
+the most important.
Check every system call for an error return, unless you know you wish
-to ignore errors. Include the system error text (from `perror',
-`strerror', or equivalent) in _every_ error message resulting from a
-failing system call, as well as the name of the file if any and the
-name of the utility. Just "cannot open foo.c" or "stat failed" is not
+to ignore errors. Include the system error text (from 'perror',
+'strerror', or equivalent) in _every_ error message resulting from a
+failing system call, as well as the name of the file if any and the name
+of the utility. Just "cannot open foo.c" or "stat failed" is not
sufficient.
- Check every call to `malloc' or `realloc' to see if it returned
-zero. Check `realloc' even if you are making the block smaller; in a
-system that rounds block sizes to a power of 2, `realloc' may get a
-different block if you ask for less space.
-
- In Unix, `realloc' can destroy the storage block if it returns zero.
-GNU `realloc' does not have this bug: if it fails, the original block
-is unchanged. Feel free to assume the bug is fixed. If you wish to
-run your program on Unix, and wish to avoid lossage in this case, you
-can use the GNU `malloc'.
+ Check every call to 'malloc' or 'realloc' to see if it returned zero.
+Check 'realloc' even if you are making the block smaller; in a system
+that rounds block sizes to a power of 2, 'realloc' may get a different
+block if you ask for less space.
+
+ In Unix, 'realloc' can destroy the storage block if it returns zero.
+GNU 'realloc' does not have this bug: if it fails, the original block is
+unchanged. Feel free to assume the bug is fixed. If you wish to run
+your program on Unix, and wish to avoid lossage in this case, you can
+use the GNU 'malloc'.
- You must expect `free' to alter the contents of the block that was
+ You must expect 'free' to alter the contents of the block that was
freed. Anything you want to fetch from the block, you must fetch before
-calling `free'.
+calling 'free'.
- If `malloc' fails in a noninteractive program, make that a fatal
+ If 'malloc' fails in a noninteractive program, make that a fatal
error. In an interactive program (one that reads commands from the
user), it is better to abort the command and return to the command
reader loop. This allows the user to kill other processes to free up
virtual memory, and then try the command again.
- Use `getopt_long' to decode arguments, unless the argument syntax
+ Use 'getopt_long' to decode arguments, unless the argument syntax
makes this unreasonable.
When static storage is to be written in during program execution, use
@@ -581,19 +571,19 @@
Try to avoid low-level interfaces to obscure Unix data structures
(such as file directories, utmp, or the layout of kernel memory), since
these are less likely to work compatibly. If you need to find all the
-files in a directory, use `readdir' or some other high-level interface.
+files in a directory, use 'readdir' or some other high-level interface.
These are supported compatibly by GNU.
The preferred signal handling facilities are the BSD variant of
-`signal', and the POSIX `sigaction' function; the alternative USG
-`signal' interface is an inferior design.
+'signal', and the POSIX 'sigaction' function; the alternative USG
+'signal' interface is an inferior design.
Nowadays, using the POSIX signal functions may be the easiest way to
-make a program portable. If you use `signal', then on GNU/Linux
-systems running GNU libc version 1, you should include `bsd/signal.h'
-instead of `signal.h', so as to get BSD behavior. It is up to you
-whether to support systems where `signal' has only the USG behavior, or
-give up on them.
+make a program portable. If you use 'signal', then on GNU/Linux systems
+running GNU libc version 1, you should include 'bsd/signal.h' instead of
+'signal.h', so as to get BSD behavior. It is up to you whether to
+support systems where 'signal' has only the USG behavior, or give up on
+them.
In error checks that detect "impossible" conditions, just abort.
There is usually no point in printing any message. These checks
@@ -603,15 +593,15 @@
are easy to examine with the debugger, so there is no point moving them
elsewhere.
- Do not use a count of errors as the exit status for a program.
-_That does not work_, because exit status values are limited to 8 bits
-(0 through 255). A single run of the program might have 256 errors; if
-you try to return 256 as the exit status, the parent process will see 0
-as the status, and it will appear that the program succeeded.
-
- If you make temporary files, check the `TMPDIR' environment
-variable; if that variable is defined, use the specified directory
-instead of `/tmp'.
+ Do not use a count of errors as the exit status for a program. _That
+does not work_, because exit status values are limited to 8 bits (0
+through 255). A single run of the program might have 256 errors; if you
+try to return 256 as the exit status, the parent process will see 0 as
+the status, and it will appear that the program succeeded.
+
+ If you make temporary files, check the 'TMPDIR' environment variable;
+if that variable is defined, use the specified directory instead of
+'/tmp'.
In addition, be aware that there is a possible security problem when
creating temporary files in world-writable directories. In C, you can
@@ -619,20 +609,20 @@
fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600);
-or by using the `mkstemps' function from Gnulib (*note mkstemps:
-(gnulib)mkstemps.).
+or by using the 'mkstemps' function from Gnulib (*note
+(gnulib)mkstemps::).
- In bash, use `set -C' (long name `noclobber') to avoid this problem.
-In addition, the `mktemp' utility is a more general solution for
-creating temporary files from shell scripts (*note mktemp invocation:
-(coreutils)mktemp invocation.).
+ In bash, use 'set -C' (long name 'noclobber') to avoid this problem.
+In addition, the 'mktemp' utility is a more general solution for
+creating temporary files from shell scripts (*note (coreutils)mktemp
+invocation::).
4.3 Library Behavior
====================
Try to make library functions reentrant. If they need to do dynamic
storage allocation, at least try to avoid any nonreentrancy aside from
-that of `malloc' itself.
+that of 'malloc' itself.
Here are certain name conventions for libraries, to avoid name
conflicts.
@@ -643,14 +633,14 @@
member. This usually means putting each one in a separate source file.
An exception can be made when two external symbols are always used
-together, so that no reasonable program could use one without the
-other; then they can both go in the same file.
+together, so that no reasonable program could use one without the other;
+then they can both go in the same file.
External symbols that are not documented entry points for the user
-should have names beginning with `_'. The `_' should be followed by
-the chosen name prefix for the library, to prevent collisions with
-other libraries. These can go in the same files with user entry points
-if you like.
+should have names beginning with '_'. The '_' should be followed by the
+chosen name prefix for the library, to prevent collisions with other
+libraries. These can go in the same files with user entry points if you
+like.
Static functions and variables can be used as you like and need not
fit any naming convention.
@@ -670,10 +660,10 @@
Line numbers should start from 1 at the beginning of the file, and
column numbers should start from 1 at the beginning of the line. (Both
of these conventions are chosen for compatibility.) Calculate column
-numbers assuming that space and all ASCII printing characters have
-equal width, and assuming tab stops every 8 columns. For non-ASCII
+numbers assuming that space and all ASCII printing characters have equal
+width, and assuming tab stops every 8 columns. For non-ASCII
characters, Unicode character widths should be used when in a UTF-8
-locale; GNU libc and GNU gnulib provide suitable `wcwidth' functions.
+locale; GNU libc and GNU gnulib provide suitable 'wcwidth' functions.
The error message can also give both the starting and ending
positions of the erroneous text. There are several formats so that you
@@ -743,20 +733,20 @@
behavior.
Compatibility requires certain programs to depend on the type of
-output device. It would be disastrous if `ls' or `sh' did not do so in
+output device. It would be disastrous if 'ls' or 'sh' did not do so in
the way all users expect. In some of these cases, we supplement the
program with a preferred alternate version that does not depend on the
-output device type. For example, we provide a `dir' program much like
-`ls' except that its default output format is always multi-column
+output device type. For example, we provide a 'dir' program much like
+'ls' except that its default output format is always multi-column
format.
4.6 Standards for Graphical Interfaces
======================================
When you write a program that provides a graphical user interface,
-please make it work with the X Window System and the GTK+ toolkit
-unless the functionality specifically requires some alternative (for
-example, "displaying jpeg images while in console mode").
+please make it work with the X Window System and the GTK+ toolkit unless
+the functionality specifically requires some alternative (for example,
+"displaying jpeg images while in console mode").
In addition, please provide a command-line interface to control the
functionality. (In many cases, the graphical user interface can be a
@@ -768,47 +758,47 @@
this, but that is being phased out.) In addition, consider providing a
library interface (for use from C), and perhaps a keyboard-driven
console interface (for use by users from console mode). Once you are
-doing the work to provide the functionality and the graphical
-interface, these won't be much extra work.
+doing the work to provide the functionality and the graphical interface,
+these won't be much extra work.
4.7 Standards for Command Line Interfaces
=========================================
It is a good idea to follow the POSIX guidelines for the command-line
-options of a program. The easiest way to do this is to use `getopt' to
-parse them. Note that the GNU version of `getopt' will normally permit
-options anywhere among the arguments unless the special argument `--'
-is used. This is not what POSIX specifies; it is a GNU extension.
+options of a program. The easiest way to do this is to use 'getopt' to
+parse them. Note that the GNU version of 'getopt' will normally permit
+options anywhere among the arguments unless the special argument '--' is
+used. This is not what POSIX specifies; it is a GNU extension.
Please define long-named options that are equivalent to the
single-letter Unix-style options. We hope to make GNU more user
friendly this way. This is easy to do with the GNU function
-`getopt_long'.
+'getopt_long'.
One of the advantages of long-named options is that they can be
consistent from program to program. For example, users should be able
to expect the "verbose" option of any GNU program which has one, to be
-spelled precisely `--verbose'. To achieve this uniformity, look at the
+spelled precisely '--verbose'. To achieve this uniformity, look at the
table of common long-option names when you choose the option names for
your program (*note Option Table::).
It is usually a good idea for file names given as ordinary arguments
to be input files only; any output files would be specified using
-options (preferably `-o' or `--output'). Even if you allow an output
+options (preferably '-o' or '--output'). Even if you allow an output
file name as an ordinary argument for compatibility, try to provide an
option as another way to specify it. This will lead to more consistency
among GNU utilities, and fewer idiosyncrasies for users to remember.
- All programs should support two standard options: `--version' and
-`--help'. CGI programs should accept these as command-line options,
-and also if given as the `PATH_INFO'; for instance, visiting
-`http://example.org/p.cgi/--help' in a browser should output the same
-information as invoking `p.cgi --help' from the command line.
+ All programs should support two standard options: '--version' and
+'--help'. CGI programs should accept these as command-line options, and
+also if given as the 'PATH_INFO'; for instance, visiting
+'http://example.org/p.cgi/--help' in a browser should output the same
+information as invoking 'p.cgi --help' from the command line.
-4.7.1 `--version'
+4.7.1 '--version'
-----------------
-The standard `--version' option should direct the program to print
+The standard '--version' option should direct the program to print
information about its name, version, origin and legal status, all on
standard output, and then exit successfully. Other options and
arguments should be ignored once this is seen, and the program should
@@ -821,9 +811,9 @@
GNU Emacs 19.30
The program's name should be a constant string; _don't_ compute it from
-`argv[0]'. The idea is to state the standard or canonical name for the
+'argv[0]'. The idea is to state the standard or canonical name for the
program, not its file name. There are other ways to find out the
-precise file name where a command is found in `PATH'.
+precise file name where a command is found in 'PATH'.
If the program is a subsidiary part of a larger package, mention the
package name in parentheses, like this:
@@ -835,8 +825,8 @@
just before the close-parenthesis.
If you _need_ to mention the version numbers of libraries which are
-distributed separately from the package which contains this program,
-you can do so by printing an additional line of version info for each
+distributed separately from the package which contains this program, you
+can do so by printing an additional line of version info for each
library you want to mention. Use the same format for these lines as for
the first line.
@@ -845,9 +835,9 @@
Please mention library version numbers only if you find in practice that
they are very important to you in debugging.
- The following line, after the version number line or lines, should
-be a copyright notice. If more than one copyright notice is called
-for, put each on a separate line.
+ The following line, after the version number line or lines, should be
+a copyright notice. If more than one copyright notice is called for,
+put each on a separate line.
Next should follow a line stating the license, preferably using one
of abbreviations below, and a brief statement that the program is free
@@ -875,11 +865,11 @@
versions' changes. You don't have to mention the name of the program in
these notices, if that is inconvenient, since it appeared in the first
line. (The rules are different for copyright notices in source files;
-*note Copyright Notices: (maintain)Copyright Notices.)
+*note (maintain)Copyright Notices::.)
Translations of the above lines must preserve the validity of the
copyright notices (*note Internationalization::). If the translation's
-character set supports it, the `(C)' should be replaced with the
+character set supports it, the '(C)' should be replaced with the
copyright symbol, as follows:
(the official copyright symbol, which is the letter C in a circle);
@@ -890,75 +880,74 @@
have legal significance.
Finally, here is the table of our suggested license abbreviations.
-Any abbreviation can be followed by `vVERSION[+]', meaning that
-particular version, or later versions with the `+', as shown above.
+Any abbreviation can be followed by 'vVERSION[+]', meaning that
+particular version, or later versions with the '+', as shown above.
In the case of exceptions for extra permissions with the GPL, we use
-`/' for a separator; the version number can follow the license
+'/' for a separator; the version number can follow the license
abbreviation as usual, as in the examples below.
GPL
- GNU General Public License, `http://www.gnu.org/licenses/gpl.html'.
+ GNU General Public License, 'http://www.gnu.org/licenses/gpl.html'.
LGPL
GNU Lesser General Public License,
- `http://www.gnu.org/licenses/lgpl.html'.
+ 'http://www.gnu.org/licenses/lgpl.html'.
GPL/Ada
GNU GPL with the exception for Ada.
Apache
The Apache Software Foundation license,
- `http://www.apache.org/licenses'.
+ 'http://www.apache.org/licenses'.
Artistic
The Artistic license used for Perl,
- `http://www.perlfoundation.org/legal'.
+ 'http://www.perlfoundation.org/legal'.
Expat
- The Expat license, `http://www.jclark.com/xml/copying.txt'.
+ The Expat license, 'http://www.jclark.com/xml/copying.txt'.
MPL
- The Mozilla Public License, `http://www.mozilla.org/MPL/'.
+ The Mozilla Public License, 'http://www.mozilla.org/MPL/'.
OBSD
The original (4-clause) BSD license, incompatible with the GNU GPL
- `http://www.xfree86.org/3.3.6/COPYRIGHT2.html#6'.
+ 'http://www.xfree86.org/3.3.6/COPYRIGHT2.html#6'.
PHP
- The license used for PHP, `http://www.php.net/license/'.
+ The license used for PHP, 'http://www.php.net/license/'.
public domain
The non-license that is being in the public domain,
- `http://www.gnu.org/licenses/license-list.html#PublicDomain'.
+ 'http://www.gnu.org/licenses/license-list.html#PublicDomain'.
Python
- The license for Python, `http://www.python.org/2.0.1/license.html'.
+ The license for Python, 'http://www.python.org/2.0.1/license.html'.
RBSD
The revised (3-clause) BSD, compatible with the GNU GPL,
- `http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5'.
+ 'http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5'.
X11
The simple non-copyleft license used for most versions of the X
- Window System, `http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3'.
+ Window System, 'http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3'.
Zlib
- The license for Zlib, `http://www.gzip.org/zlib/zlib_license.html'.
-
+ The license for Zlib, 'http://www.gzip.org/zlib/zlib_license.html'.
More information about these licenses and many more are on the GNU
-licensing web pages, `http://www.gnu.org/licenses/license-list.html'.
+licensing web pages, 'http://www.gnu.org/licenses/license-list.html'.
-4.7.2 `--help'
+4.7.2 '--help'
--------------
-The standard `--help' option should output brief documentation for how
+The standard '--help' option should output brief documentation for how
to invoke the program, on standard output, then exit successfully.
-Other options and arguments should be ignored once this is seen, and
-the program should not perform its normal function.
+Other options and arguments should be ignored once this is seen, and the
+program should not perform its normal function.
- Near the end of the `--help' option's output, please place lines
+ Near the end of the '--help' option's output, please place lines
giving the email address for bug reports, the package's home page
(normally <http://www.gnu.org/software/PKG>, and the general page for
help using GNU programs. The format should be like this:
@@ -974,21 +963,21 @@
Another aspect of keeping free programs free is encouraging development
of free plug-ins, and discouraging development of proprietary plug-ins.
-Many GNU programs will not have anything like plug-ins at all, but
-those that do should follow these practices.
+Many GNU programs will not have anything like plug-ins at all, but those
+that do should follow these practices.
First, the general plug-in architecture design should closely tie the
-plug-in to the original code, such that the plug-in and the base
-program are parts of one extended program. For GCC, for example,
-plug-ins receive and modify GCC's internal data structures, and so
-clearly form an extended program with the base GCC.
+plug-in to the original code, such that the plug-in and the base program
+are parts of one extended program. For GCC, for example, plug-ins
+receive and modify GCC's internal data structures, and so clearly form
+an extended program with the base GCC.
Second, you should require plug-in developers to affirm that their
plug-ins are released under an appropriate license. This should be
enforced with a simple programmatic check. For GCC, again for example,
-a plug-in must define the global symbol `plugin_is_GPL_compatible',
-thus asserting that the plug-in is released under a GPL-compatible
-license (*note Plugins: (gccint)Plugins.).
+a plug-in must define the global symbol 'plugin_is_GPL_compatible', thus
+asserting that the plug-in is released under a GPL-compatible license
+(*note Plugins: (gccint)Plugins.).
By adding this check to your program you are not creating a new legal
requirement. The GPL itself requires plug-ins to be free software,
@@ -1007,1087 +996,1087 @@
Here is a table of long options used by GNU programs. It is surely
incomplete, but we aim to list all the options that a new program might
want to be compatible with. If you use names not already in the table,
-please send <address@hidden> a list of them, with their
-meanings, so we can update the table.
+please send <address@hidden> a list of them, with their meanings,
+so we can update the table.
-`after-date'
- `-N' in `tar'.
+'after-date'
+ '-N' in 'tar'.
-`all'
- `-a' in `du', `ls', `nm', `stty', `uname', and `unexpand'.
+'all'
+ '-a' in 'du', 'ls', 'nm', 'stty', 'uname', and 'unexpand'.
-`all-text'
- `-a' in `diff'.
+'all-text'
+ '-a' in 'diff'.
-`almost-all'
- `-A' in `ls'.
+'almost-all'
+ '-A' in 'ls'.
-`append'
- `-a' in `etags', `tee', `time'; `-r' in `tar'.
+'append'
+ '-a' in 'etags', 'tee', 'time'; '-r' in 'tar'.
-`archive'
- `-a' in `cp'.
+'archive'
+ '-a' in 'cp'.
-`archive-name'
- `-n' in `shar'.
+'archive-name'
+ '-n' in 'shar'.
-`arglength'
- `-l' in `m4'.
+'arglength'
+ '-l' in 'm4'.
-`ascii'
- `-a' in `diff'.
+'ascii'
+ '-a' in 'diff'.
-`assign'
- `-v' in `gawk'.
+'assign'
+ '-v' in 'gawk'.
-`assume-new'
- `-W' in `make'.
+'assume-new'
+ '-W' in 'make'.
-`assume-old'
- `-o' in `make'.
+'assume-old'
+ '-o' in 'make'.
-`auto-check'
- `-a' in `recode'.
+'auto-check'
+ '-a' in 'recode'.
-`auto-pager'
- `-a' in `wdiff'.
+'auto-pager'
+ '-a' in 'wdiff'.
-`auto-reference'
- `-A' in `ptx'.
+'auto-reference'
+ '-A' in 'ptx'.
-`avoid-wraps'
- `-n' in `wdiff'.
+'avoid-wraps'
+ '-n' in 'wdiff'.
-`background'
+'background'
For server programs, run in the background.
-`backward-search'
- `-B' in `ctags'.
+'backward-search'
+ '-B' in 'ctags'.
-`basename'
- `-f' in `shar'.
+'basename'
+ '-f' in 'shar'.
-`batch'
+'batch'
Used in GDB.
-`baud'
+'baud'
Used in GDB.
-`before'
- `-b' in `tac'.
+'before'
+ '-b' in 'tac'.
-`binary'
- `-b' in `cpio' and `diff'.
+'binary'
+ '-b' in 'cpio' and 'diff'.
-`bits-per-code'
- `-b' in `shar'.
+'bits-per-code'
+ '-b' in 'shar'.
-`block-size'
- Used in `cpio' and `tar'.
+'block-size'
+ Used in 'cpio' and 'tar'.
-`blocks'
- `-b' in `head' and `tail'.
+'blocks'
+ '-b' in 'head' and 'tail'.
-`break-file'
- `-b' in `ptx'.
+'break-file'
+ '-b' in 'ptx'.
-`brief'
+'brief'
Used in various programs to make output shorter.
-`bytes'
- `-c' in `head', `split', and `tail'.
+'bytes'
+ '-c' in 'head', 'split', and 'tail'.
-`c++'
- `-C' in `etags'.
+'c++'
+ '-C' in 'etags'.
-`catenate'
- `-A' in `tar'.
+'catenate'
+ '-A' in 'tar'.
-`cd'
+'cd'
Used in various programs to specify the directory to use.
-`changes'
- `-c' in `chgrp' and `chown'.
+'changes'
+ '-c' in 'chgrp' and 'chown'.
-`classify'
- `-F' in `ls'.
+'classify'
+ '-F' in 'ls'.
-`colons'
- `-c' in `recode'.
+'colons'
+ '-c' in 'recode'.
-`command'
- `-c' in `su'; `-x' in GDB.
+'command'
+ '-c' in 'su'; '-x' in GDB.
-`compare'
- `-d' in `tar'.
+'compare'
+ '-d' in 'tar'.
-`compat'
- Used in `gawk'.
+'compat'
+ Used in 'gawk'.
-`compress'
- `-Z' in `tar' and `shar'.
+'compress'
+ '-Z' in 'tar' and 'shar'.
-`concatenate'
- `-A' in `tar'.
+'concatenate'
+ '-A' in 'tar'.
-`confirmation'
- `-w' in `tar'.
+'confirmation'
+ '-w' in 'tar'.
-`context'
- Used in `diff'.
+'context'
+ Used in 'diff'.
-`copyleft'
- `-W copyleft' in `gawk'.
+'copyleft'
+ '-W copyleft' in 'gawk'.
-`copyright'
- `-C' in `ptx', `recode', and `wdiff'; `-W copyright' in `gawk'.
+'copyright'
+ '-C' in 'ptx', 'recode', and 'wdiff'; '-W copyright' in 'gawk'.
-`core'
+'core'
Used in GDB.
-`count'
- `-q' in `who'.
+'count'
+ '-q' in 'who'.
-`count-links'
- `-l' in `du'.
+'count-links'
+ '-l' in 'du'.
-`create'
- Used in `tar' and `cpio'.
+'create'
+ Used in 'tar' and 'cpio'.
-`cut-mark'
- `-c' in `shar'.
+'cut-mark'
+ '-c' in 'shar'.
-`cxref'
- `-x' in `ctags'.
+'cxref'
+ '-x' in 'ctags'.
-`date'
- `-d' in `touch'.
+'date'
+ '-d' in 'touch'.
-`debug'
- `-d' in `make' and `m4'; `-t' in Bison.
+'debug'
+ '-d' in 'make' and 'm4'; '-t' in Bison.
-`define'
- `-D' in `m4'.
+'define'
+ '-D' in 'm4'.
-`defines'
- `-d' in Bison and `ctags'.
+'defines'
+ '-d' in Bison and 'ctags'.
-`delete'
- `-D' in `tar'.
+'delete'
+ '-D' in 'tar'.
-`dereference'
- `-L' in `chgrp', `chown', `cpio', `du', `ls', and `tar'.
+'dereference'
+ '-L' in 'chgrp', 'chown', 'cpio', 'du', 'ls', and 'tar'.
-`dereference-args'
- `-D' in `du'.
+'dereference-args'
+ '-D' in 'du'.
-`device'
+'device'
Specify an I/O device (special file name).
-`diacritics'
- `-d' in `recode'.
+'diacritics'
+ '-d' in 'recode'.
-`dictionary-order'
- `-d' in `look'.
+'dictionary-order'
+ '-d' in 'look'.
-`diff'
- `-d' in `tar'.
+'diff'
+ '-d' in 'tar'.
-`digits'
- `-n' in `csplit'.
+'digits'
+ '-n' in 'csplit'.
-`directory'
- Specify the directory to use, in various programs. In `ls', it
+'directory'
+ Specify the directory to use, in various programs. In 'ls', it
means to show directories themselves rather than their contents.
- In `rm' and `ln', it means to not treat links to directories
+ In 'rm' and 'ln', it means to not treat links to directories
specially.
-`discard-all'
- `-x' in `strip'.
+'discard-all'
+ '-x' in 'strip'.
-`discard-locals'
- `-X' in `strip'.
+'discard-locals'
+ '-X' in 'strip'.
-`dry-run'
- `-n' in `make'.
+'dry-run'
+ '-n' in 'make'.
-`ed'
- `-e' in `diff'.
+'ed'
+ '-e' in 'diff'.
-`elide-empty-files'
- `-z' in `csplit'.
+'elide-empty-files'
+ '-z' in 'csplit'.
-`end-delete'
- `-x' in `wdiff'.
+'end-delete'
+ '-x' in 'wdiff'.
-`end-insert'
- `-z' in `wdiff'.
+'end-insert'
+ '-z' in 'wdiff'.
-`entire-new-file'
- `-N' in `diff'.
+'entire-new-file'
+ '-N' in 'diff'.
-`environment-overrides'
- `-e' in `make'.
+'environment-overrides'
+ '-e' in 'make'.
-`eof'
- `-e' in `xargs'.
+'eof'
+ '-e' in 'xargs'.
-`epoch'
+'epoch'
Used in GDB.
-`error-limit'
- Used in `makeinfo'.
+'error-limit'
+ Used in 'makeinfo'.
-`error-output'
- `-o' in `m4'.
+'error-output'
+ '-o' in 'm4'.
-`escape'
- `-b' in `ls'.
+'escape'
+ '-b' in 'ls'.
-`exclude-from'
- `-X' in `tar'.
+'exclude-from'
+ '-X' in 'tar'.
-`exec'
+'exec'
Used in GDB.
-`exit'
- `-x' in `xargs'.
+'exit'
+ '-x' in 'xargs'.
-`exit-0'
- `-e' in `unshar'.
+'exit-0'
+ '-e' in 'unshar'.
-`expand-tabs'
- `-t' in `diff'.
+'expand-tabs'
+ '-t' in 'diff'.
-`expression'
- `-e' in `sed'.
+'expression'
+ '-e' in 'sed'.
-`extern-only'
- `-g' in `nm'.
+'extern-only'
+ '-g' in 'nm'.
-`extract'
- `-i' in `cpio'; `-x' in `tar'.
+'extract'
+ '-i' in 'cpio'; '-x' in 'tar'.
-`faces'
- `-f' in `finger'.
+'faces'
+ '-f' in 'finger'.
-`fast'
- `-f' in `su'.
+'fast'
+ '-f' in 'su'.
-`fatal-warnings'
- `-E' in `m4'.
+'fatal-warnings'
+ '-E' in 'm4'.
-`file'
- `-f' in `gawk', `info', `make', `mt', `sed', and `tar'.
+'file'
+ '-f' in 'gawk', 'info', 'make', 'mt', 'sed', and 'tar'.
-`field-separator'
- `-F' in `gawk'.
+'field-separator'
+ '-F' in 'gawk'.
-`file-prefix'
- `-b' in Bison.
+'file-prefix'
+ '-b' in Bison.
-`file-type'
- `-F' in `ls'.
+'file-type'
+ '-F' in 'ls'.
-`files-from'
- `-T' in `tar'.
+'files-from'
+ '-T' in 'tar'.
-`fill-column'
- Used in `makeinfo'.
+'fill-column'
+ Used in 'makeinfo'.
-`flag-truncation'
- `-F' in `ptx'.
+'flag-truncation'
+ '-F' in 'ptx'.
-`fixed-output-files'
- `-y' in Bison.
+'fixed-output-files'
+ '-y' in Bison.
-`follow'
- `-f' in `tail'.
+'follow'
+ '-f' in 'tail'.
-`footnote-style'
- Used in `makeinfo'.
+'footnote-style'
+ Used in 'makeinfo'.
-`force'
- `-f' in `cp', `ln', `mv', and `rm'.
+'force'
+ '-f' in 'cp', 'ln', 'mv', and 'rm'.
-`force-prefix'
- `-F' in `shar'.
+'force-prefix'
+ '-F' in 'shar'.
-`foreground'
+'foreground'
For server programs, run in the foreground; in other words, don't
do anything special to run the server in the background.
-`format'
- Used in `ls', `time', and `ptx'.
+'format'
+ Used in 'ls', 'time', and 'ptx'.
-`freeze-state'
- `-F' in `m4'.
+'freeze-state'
+ '-F' in 'm4'.
-`fullname'
+'fullname'
Used in GDB.
-`gap-size'
- `-g' in `ptx'.
+'gap-size'
+ '-g' in 'ptx'.
-`get'
- `-x' in `tar'.
+'get'
+ '-x' in 'tar'.
-`graphic'
- `-i' in `ul'.
+'graphic'
+ '-i' in 'ul'.
-`graphics'
- `-g' in `recode'.
+'graphics'
+ '-g' in 'recode'.
-`group'
- `-g' in `install'.
+'group'
+ '-g' in 'install'.
-`gzip'
- `-z' in `tar' and `shar'.
+'gzip'
+ '-z' in 'tar' and 'shar'.
-`hashsize'
- `-H' in `m4'.
+'hashsize'
+ '-H' in 'm4'.
-`header'
- `-h' in `objdump' and `recode'
+'header'
+ '-h' in 'objdump' and 'recode'
-`heading'
- `-H' in `who'.
+'heading'
+ '-H' in 'who'.
-`help'
+'help'
Used to ask for brief usage information.
-`here-delimiter'
- `-d' in `shar'.
+'here-delimiter'
+ '-d' in 'shar'.
-`hide-control-chars'
- `-q' in `ls'.
+'hide-control-chars'
+ '-q' in 'ls'.
-`html'
- In `makeinfo', output HTML.
+'html'
+ In 'makeinfo', output HTML.
-`idle'
- `-u' in `who'.
+'idle'
+ '-u' in 'who'.
-`ifdef'
- `-D' in `diff'.
+'ifdef'
+ '-D' in 'diff'.
-`ignore'
- `-I' in `ls'; `-x' in `recode'.
+'ignore'
+ '-I' in 'ls'; '-x' in 'recode'.
-`ignore-all-space'
- `-w' in `diff'.
+'ignore-all-space'
+ '-w' in 'diff'.
-`ignore-backups'
- `-B' in `ls'.
+'ignore-backups'
+ '-B' in 'ls'.
-`ignore-blank-lines'
- `-B' in `diff'.
+'ignore-blank-lines'
+ '-B' in 'diff'.
-`ignore-case'
- `-f' in `look' and `ptx'; `-i' in `diff' and `wdiff'.
+'ignore-case'
+ '-f' in 'look' and 'ptx'; '-i' in 'diff' and 'wdiff'.
-`ignore-errors'
- `-i' in `make'.
+'ignore-errors'
+ '-i' in 'make'.
-`ignore-file'
- `-i' in `ptx'.
+'ignore-file'
+ '-i' in 'ptx'.
-`ignore-indentation'
- `-I' in `etags'.
+'ignore-indentation'
+ '-I' in 'etags'.
-`ignore-init-file'
- `-f' in Oleo.
+'ignore-init-file'
+ '-f' in Oleo.
-`ignore-interrupts'
- `-i' in `tee'.
+'ignore-interrupts'
+ '-i' in 'tee'.
-`ignore-matching-lines'
- `-I' in `diff'.
+'ignore-matching-lines'
+ '-I' in 'diff'.
-`ignore-space-change'
- `-b' in `diff'.
+'ignore-space-change'
+ '-b' in 'diff'.
-`ignore-zeros'
- `-i' in `tar'.
+'ignore-zeros'
+ '-i' in 'tar'.
-`include'
- `-i' in `etags'; `-I' in `m4'.
+'include'
+ '-i' in 'etags'; '-I' in 'm4'.
-`include-dir'
- `-I' in `make'.
+'include-dir'
+ '-I' in 'make'.
-`incremental'
- `-G' in `tar'.
+'incremental'
+ '-G' in 'tar'.
-`info'
- `-i', `-l', and `-m' in Finger.
+'info'
+ '-i', '-l', and '-m' in Finger.
-`init-file'
+'init-file'
In some programs, specify the name of the file to read as the
user's init file.
-`initial'
- `-i' in `expand'.
+'initial'
+ '-i' in 'expand'.
-`initial-tab'
- `-T' in `diff'.
+'initial-tab'
+ '-T' in 'diff'.
-`inode'
- `-i' in `ls'.
+'inode'
+ '-i' in 'ls'.
-`interactive'
- `-i' in `cp', `ln', `mv', `rm'; `-e' in `m4'; `-p' in `xargs';
- `-w' in `tar'.
+'interactive'
+ '-i' in 'cp', 'ln', 'mv', 'rm'; '-e' in 'm4'; '-p' in 'xargs'; '-w'
+ in 'tar'.
-`intermix-type'
- `-p' in `shar'.
+'intermix-type'
+ '-p' in 'shar'.
-`iso-8601'
- Used in `date'
+'iso-8601'
+ Used in 'date'
-`jobs'
- `-j' in `make'.
+'jobs'
+ '-j' in 'make'.
-`just-print'
- `-n' in `make'.
+'just-print'
+ '-n' in 'make'.
-`keep-going'
- `-k' in `make'.
+'keep-going'
+ '-k' in 'make'.
-`keep-files'
- `-k' in `csplit'.
+'keep-files'
+ '-k' in 'csplit'.
-`kilobytes'
- `-k' in `du' and `ls'.
+'kilobytes'
+ '-k' in 'du' and 'ls'.
-`language'
- `-l' in `etags'.
+'language'
+ '-l' in 'etags'.
-`less-mode'
- `-l' in `wdiff'.
+'less-mode'
+ '-l' in 'wdiff'.
-`level-for-gzip'
- `-g' in `shar'.
+'level-for-gzip'
+ '-g' in 'shar'.
-`line-bytes'
- `-C' in `split'.
+'line-bytes'
+ '-C' in 'split'.
-`lines'
- Used in `split', `head', and `tail'.
+'lines'
+ Used in 'split', 'head', and 'tail'.
-`link'
- `-l' in `cpio'.
+'link'
+ '-l' in 'cpio'.
-`lint'
-`lint-old'
- Used in `gawk'.
+'lint'
+'lint-old'
+ Used in 'gawk'.
-`list'
- `-t' in `cpio'; `-l' in `recode'.
+'list'
+ '-t' in 'cpio'; '-l' in 'recode'.
-`list'
- `-t' in `tar'.
+'list'
+ '-t' in 'tar'.
-`literal'
- `-N' in `ls'.
+'literal'
+ '-N' in 'ls'.
-`load-average'
- `-l' in `make'.
+'load-average'
+ '-l' in 'make'.
-`login'
- Used in `su'.
+'login'
+ Used in 'su'.
-`machine'
- Used in `uname'.
+'machine'
+ Used in 'uname'.
-`macro-name'
- `-M' in `ptx'.
+'macro-name'
+ '-M' in 'ptx'.
-`mail'
- `-m' in `hello' and `uname'.
+'mail'
+ '-m' in 'hello' and 'uname'.
-`make-directories'
- `-d' in `cpio'.
+'make-directories'
+ '-d' in 'cpio'.
-`makefile'
- `-f' in `make'.
+'makefile'
+ '-f' in 'make'.
-`mapped'
+'mapped'
Used in GDB.
-`max-args'
- `-n' in `xargs'.
+'max-args'
+ '-n' in 'xargs'.
-`max-chars'
- `-n' in `xargs'.
+'max-chars'
+ '-n' in 'xargs'.
-`max-lines'
- `-l' in `xargs'.
+'max-lines'
+ '-l' in 'xargs'.
-`max-load'
- `-l' in `make'.
+'max-load'
+ '-l' in 'make'.
-`max-procs'
- `-P' in `xargs'.
+'max-procs'
+ '-P' in 'xargs'.
-`mesg'
- `-T' in `who'.
+'mesg'
+ '-T' in 'who'.
-`message'
- `-T' in `who'.
+'message'
+ '-T' in 'who'.
-`minimal'
- `-d' in `diff'.
+'minimal'
+ '-d' in 'diff'.
-`mixed-uuencode'
- `-M' in `shar'.
+'mixed-uuencode'
+ '-M' in 'shar'.
-`mode'
- `-m' in `install', `mkdir', and `mkfifo'.
+'mode'
+ '-m' in 'install', 'mkdir', and 'mkfifo'.
-`modification-time'
- `-m' in `tar'.
+'modification-time'
+ '-m' in 'tar'.
-`multi-volume'
- `-M' in `tar'.
+'multi-volume'
+ '-M' in 'tar'.
-`name-prefix'
- `-a' in Bison.
+'name-prefix'
+ '-a' in Bison.
-`nesting-limit'
- `-L' in `m4'.
+'nesting-limit'
+ '-L' in 'm4'.
-`net-headers'
- `-a' in `shar'.
+'net-headers'
+ '-a' in 'shar'.
-`new-file'
- `-W' in `make'.
+'new-file'
+ '-W' in 'make'.
-`no-builtin-rules'
- `-r' in `make'.
+'no-builtin-rules'
+ '-r' in 'make'.
-`no-character-count'
- `-w' in `shar'.
+'no-character-count'
+ '-w' in 'shar'.
-`no-check-existing'
- `-x' in `shar'.
+'no-check-existing'
+ '-x' in 'shar'.
-`no-common'
- `-3' in `wdiff'.
+'no-common'
+ '-3' in 'wdiff'.
-`no-create'
- `-c' in `touch'.
+'no-create'
+ '-c' in 'touch'.
-`no-defines'
- `-D' in `etags'.
+'no-defines'
+ '-D' in 'etags'.
-`no-deleted'
- `-1' in `wdiff'.
+'no-deleted'
+ '-1' in 'wdiff'.
-`no-dereference'
- `-d' in `cp'.
+'no-dereference'
+ '-d' in 'cp'.
-`no-inserted'
- `-2' in `wdiff'.
+'no-inserted'
+ '-2' in 'wdiff'.
-`no-keep-going'
- `-S' in `make'.
+'no-keep-going'
+ '-S' in 'make'.
-`no-lines'
- `-l' in Bison.
+'no-lines'
+ '-l' in Bison.
-`no-piping'
- `-P' in `shar'.
+'no-piping'
+ '-P' in 'shar'.
-`no-prof'
- `-e' in `gprof'.
+'no-prof'
+ '-e' in 'gprof'.
-`no-regex'
- `-R' in `etags'.
+'no-regex'
+ '-R' in 'etags'.
-`no-sort'
- `-p' in `nm'.
+'no-sort'
+ '-p' in 'nm'.
-`no-splash'
+'no-splash'
Don't print a startup splash screen.
-`no-split'
- Used in `makeinfo'.
+'no-split'
+ Used in 'makeinfo'.
-`no-static'
- `-a' in `gprof'.
+'no-static'
+ '-a' in 'gprof'.
-`no-time'
- `-E' in `gprof'.
+'no-time'
+ '-E' in 'gprof'.
-`no-timestamp'
- `-m' in `shar'.
+'no-timestamp'
+ '-m' in 'shar'.
-`no-validate'
- Used in `makeinfo'.
+'no-validate'
+ Used in 'makeinfo'.
-`no-wait'
- Used in `emacsclient'.
+'no-wait'
+ Used in 'emacsclient'.
-`no-warn'
+'no-warn'
Used in various programs to inhibit warnings.
-`node'
- `-n' in `info'.
+'node'
+ '-n' in 'info'.
-`nodename'
- `-n' in `uname'.
+'nodename'
+ '-n' in 'uname'.
-`nonmatching'
- `-f' in `cpio'.
+'nonmatching'
+ '-f' in 'cpio'.
-`nstuff'
- `-n' in `objdump'.
+'nstuff'
+ '-n' in 'objdump'.
-`null'
- `-0' in `xargs'.
+'null'
+ '-0' in 'xargs'.
-`number'
- `-n' in `cat'.
+'number'
+ '-n' in 'cat'.
-`number-nonblank'
- `-b' in `cat'.
+'number-nonblank'
+ '-b' in 'cat'.
-`numeric-sort'
- `-n' in `nm'.
+'numeric-sort'
+ '-n' in 'nm'.
-`numeric-uid-gid'
- `-n' in `cpio' and `ls'.
+'numeric-uid-gid'
+ '-n' in 'cpio' and 'ls'.
-`nx'
+'nx'
Used in GDB.
-`old-archive'
- `-o' in `tar'.
+'old-archive'
+ '-o' in 'tar'.
-`old-file'
- `-o' in `make'.
+'old-file'
+ '-o' in 'make'.
-`one-file-system'
- `-l' in `tar', `cp', and `du'.
+'one-file-system'
+ '-l' in 'tar', 'cp', and 'du'.
-`only-file'
- `-o' in `ptx'.
+'only-file'
+ '-o' in 'ptx'.
-`only-prof'
- `-f' in `gprof'.
+'only-prof'
+ '-f' in 'gprof'.
-`only-time'
- `-F' in `gprof'.
+'only-time'
+ '-F' in 'gprof'.
-`options'
- `-o' in `getopt', `fdlist', `fdmount', `fdmountd', and `fdumount'.
+'options'
+ '-o' in 'getopt', 'fdlist', 'fdmount', 'fdmountd', and 'fdumount'.
-`output'
+'output'
In various programs, specify the output file name.
-`output-prefix'
- `-o' in `shar'.
+'output-prefix'
+ '-o' in 'shar'.
-`override'
- `-o' in `rm'.
+'override'
+ '-o' in 'rm'.
-`overwrite'
- `-c' in `unshar'.
+'overwrite'
+ '-c' in 'unshar'.
-`owner'
- `-o' in `install'.
+'owner'
+ '-o' in 'install'.
-`paginate'
- `-l' in `diff'.
+'paginate'
+ '-l' in 'diff'.
-`paragraph-indent'
- Used in `makeinfo'.
+'paragraph-indent'
+ Used in 'makeinfo'.
-`parents'
- `-p' in `mkdir' and `rmdir'.
+'parents'
+ '-p' in 'mkdir' and 'rmdir'.
-`pass-all'
- `-p' in `ul'.
+'pass-all'
+ '-p' in 'ul'.
-`pass-through'
- `-p' in `cpio'.
+'pass-through'
+ '-p' in 'cpio'.
-`port'
- `-P' in `finger'.
+'port'
+ '-P' in 'finger'.
-`portability'
- `-c' in `cpio' and `tar'.
+'portability'
+ '-c' in 'cpio' and 'tar'.
-`posix'
- Used in `gawk'.
+'posix'
+ Used in 'gawk'.
-`prefix-builtins'
- `-P' in `m4'.
+'prefix-builtins'
+ '-P' in 'm4'.
-`prefix'
- `-f' in `csplit'.
+'prefix'
+ '-f' in 'csplit'.
-`preserve'
- Used in `tar' and `cp'.
+'preserve'
+ Used in 'tar' and 'cp'.
-`preserve-environment'
- `-p' in `su'.
+'preserve-environment'
+ '-p' in 'su'.
-`preserve-modification-time'
- `-m' in `cpio'.
+'preserve-modification-time'
+ '-m' in 'cpio'.
-`preserve-order'
- `-s' in `tar'.
+'preserve-order'
+ '-s' in 'tar'.
-`preserve-permissions'
- `-p' in `tar'.
+'preserve-permissions'
+ '-p' in 'tar'.
-`print'
- `-l' in `diff'.
+'print'
+ '-l' in 'diff'.
-`print-chars'
- `-L' in `cmp'.
+'print-chars'
+ '-L' in 'cmp'.
-`print-data-base'
- `-p' in `make'.
+'print-data-base'
+ '-p' in 'make'.
-`print-directory'
- `-w' in `make'.
+'print-directory'
+ '-w' in 'make'.
-`print-file-name'
- `-o' in `nm'.
+'print-file-name'
+ '-o' in 'nm'.
-`print-symdefs'
- `-s' in `nm'.
+'print-symdefs'
+ '-s' in 'nm'.
-`printer'
- `-p' in `wdiff'.
+'printer'
+ '-p' in 'wdiff'.
-`prompt'
- `-p' in `ed'.
+'prompt'
+ '-p' in 'ed'.
-`proxy'
+'proxy'
Specify an HTTP proxy.
-`query-user'
- `-X' in `shar'.
+'query-user'
+ '-X' in 'shar'.
-`question'
- `-q' in `make'.
+'question'
+ '-q' in 'make'.
-`quiet'
+'quiet'
Used in many programs to inhibit the usual output. Every program
- accepting `--quiet' should accept `--silent' as a synonym.
+ accepting '--quiet' should accept '--silent' as a synonym.
-`quiet-unshar'
- `-Q' in `shar'
+'quiet-unshar'
+ '-Q' in 'shar'
-`quote-name'
- `-Q' in `ls'.
+'quote-name'
+ '-Q' in 'ls'.
-`rcs'
- `-n' in `diff'.
+'rcs'
+ '-n' in 'diff'.
-`re-interval'
- Used in `gawk'.
+'re-interval'
+ Used in 'gawk'.
-`read-full-blocks'
- `-B' in `tar'.
+'read-full-blocks'
+ '-B' in 'tar'.
-`readnow'
+'readnow'
Used in GDB.
-`recon'
- `-n' in `make'.
+'recon'
+ '-n' in 'make'.
-`record-number'
- `-R' in `tar'.
+'record-number'
+ '-R' in 'tar'.
-`recursive'
- Used in `chgrp', `chown', `cp', `ls', `diff', and `rm'.
+'recursive'
+ Used in 'chgrp', 'chown', 'cp', 'ls', 'diff', and 'rm'.
-`reference'
- `-r' in `touch'.
+'reference'
+ '-r' in 'touch'.
-`references'
- `-r' in `ptx'.
+'references'
+ '-r' in 'ptx'.
-`regex'
- `-r' in `tac' and `etags'.
+'regex'
+ '-r' in 'tac' and 'etags'.
-`release'
- `-r' in `uname'.
+'release'
+ '-r' in 'uname'.
-`reload-state'
- `-R' in `m4'.
+'reload-state'
+ '-R' in 'm4'.
-`relocation'
- `-r' in `objdump'.
+'relocation'
+ '-r' in 'objdump'.
-`rename'
- `-r' in `cpio'.
+'rename'
+ '-r' in 'cpio'.
-`replace'
- `-i' in `xargs'.
+'replace'
+ '-i' in 'xargs'.
-`report-identical-files'
- `-s' in `diff'.
+'report-identical-files'
+ '-s' in 'diff'.
-`reset-access-time'
- `-a' in `cpio'.
+'reset-access-time'
+ '-a' in 'cpio'.
-`reverse'
- `-r' in `ls' and `nm'.
+'reverse'
+ '-r' in 'ls' and 'nm'.
-`reversed-ed'
- `-f' in `diff'.
+'reversed-ed'
+ '-f' in 'diff'.
-`right-side-defs'
- `-R' in `ptx'.
+'right-side-defs'
+ '-R' in 'ptx'.
-`same-order'
- `-s' in `tar'.
+'same-order'
+ '-s' in 'tar'.
-`same-permissions'
- `-p' in `tar'.
+'same-permissions'
+ '-p' in 'tar'.
-`save'
- `-g' in `stty'.
+'save'
+ '-g' in 'stty'.
-`se'
+'se'
Used in GDB.
-`sentence-regexp'
- `-S' in `ptx'.
+'sentence-regexp'
+ '-S' in 'ptx'.
-`separate-dirs'
- `-S' in `du'.
+'separate-dirs'
+ '-S' in 'du'.
-`separator'
- `-s' in `tac'.
+'separator'
+ '-s' in 'tac'.
-`sequence'
- Used by `recode' to chose files or pipes for sequencing passes.
+'sequence'
+ Used by 'recode' to chose files or pipes for sequencing passes.
-`shell'
- `-s' in `su'.
+'shell'
+ '-s' in 'su'.
-`show-all'
- `-A' in `cat'.
+'show-all'
+ '-A' in 'cat'.
-`show-c-function'
- `-p' in `diff'.
+'show-c-function'
+ '-p' in 'diff'.
-`show-ends'
- `-E' in `cat'.
+'show-ends'
+ '-E' in 'cat'.
-`show-function-line'
- `-F' in `diff'.
+'show-function-line'
+ '-F' in 'diff'.
-`show-tabs'
- `-T' in `cat'.
+'show-tabs'
+ '-T' in 'cat'.
-`silent'
+'silent'
Used in many programs to inhibit the usual output. Every program
- accepting `--silent' should accept `--quiet' as a synonym.
+ accepting '--silent' should accept '--quiet' as a synonym.
-`size'
- `-s' in `ls'.
+'size'
+ '-s' in 'ls'.
-`socket'
+'socket'
Specify a file descriptor for a network server to use for its
- socket, instead of opening and binding a new socket. This
- provides a way to run, in a non-privileged process, a server that
- normally needs a reserved port number.
+ socket, instead of opening and binding a new socket. This provides
+ a way to run, in a non-privileged process, a server that normally
+ needs a reserved port number.
-`sort'
- Used in `ls'.
+'sort'
+ Used in 'ls'.
-`source'
- `-W source' in `gawk'.
+'source'
+ '-W source' in 'gawk'.
-`sparse'
- `-S' in `tar'.
+'sparse'
+ '-S' in 'tar'.
-`speed-large-files'
- `-H' in `diff'.
+'speed-large-files'
+ '-H' in 'diff'.
-`split-at'
- `-E' in `unshar'.
+'split-at'
+ '-E' in 'unshar'.
-`split-size-limit'
- `-L' in `shar'.
+'split-size-limit'
+ '-L' in 'shar'.
-`squeeze-blank'
- `-s' in `cat'.
+'squeeze-blank'
+ '-s' in 'cat'.
-`start-delete'
- `-w' in `wdiff'.
+'start-delete'
+ '-w' in 'wdiff'.
-`start-insert'
- `-y' in `wdiff'.
+'start-insert'
+ '-y' in 'wdiff'.
-`starting-file'
- Used in `tar' and `diff' to specify which file within a directory
+'starting-file'
+ Used in 'tar' and 'diff' to specify which file within a directory
to start processing with.
-`statistics'
- `-s' in `wdiff'.
+'statistics'
+ '-s' in 'wdiff'.
-`stdin-file-list'
- `-S' in `shar'.
+'stdin-file-list'
+ '-S' in 'shar'.
-`stop'
- `-S' in `make'.
+'stop'
+ '-S' in 'make'.
-`strict'
- `-s' in `recode'.
+'strict'
+ '-s' in 'recode'.
-`strip'
- `-s' in `install'.
+'strip'
+ '-s' in 'install'.
-`strip-all'
- `-s' in `strip'.
+'strip-all'
+ '-s' in 'strip'.
-`strip-debug'
- `-S' in `strip'.
+'strip-debug'
+ '-S' in 'strip'.
-`submitter'
- `-s' in `shar'.
+'submitter'
+ '-s' in 'shar'.
-`suffix'
- `-S' in `cp', `ln', `mv'.
+'suffix'
+ '-S' in 'cp', 'ln', 'mv'.
-`suffix-format'
- `-b' in `csplit'.
+'suffix-format'
+ '-b' in 'csplit'.
-`sum'
- `-s' in `gprof'.
+'sum'
+ '-s' in 'gprof'.
-`summarize'
- `-s' in `du'.
+'summarize'
+ '-s' in 'du'.
-`symbolic'
- `-s' in `ln'.
+'symbolic'
+ '-s' in 'ln'.
-`symbols'
- Used in GDB and `objdump'.
+'symbols'
+ Used in GDB and 'objdump'.
-`synclines'
- `-s' in `m4'.
+'synclines'
+ '-s' in 'm4'.
-`sysname'
- `-s' in `uname'.
+'sysname'
+ '-s' in 'uname'.
-`tabs'
- `-t' in `expand' and `unexpand'.
+'tabs'
+ '-t' in 'expand' and 'unexpand'.
-`tabsize'
- `-T' in `ls'.
+'tabsize'
+ '-T' in 'ls'.
-`terminal'
- `-T' in `tput' and `ul'. `-t' in `wdiff'.
+'terminal'
+ '-T' in 'tput' and 'ul'. '-t' in 'wdiff'.
-`text'
- `-a' in `diff'.
+'text'
+ '-a' in 'diff'.
-`text-files'
- `-T' in `shar'.
+'text-files'
+ '-T' in 'shar'.
-`time'
- Used in `ls' and `touch'.
+'time'
+ Used in 'ls' and 'touch'.
-`timeout'
+'timeout'
Specify how long to wait before giving up on some operation.
-`to-stdout'
- `-O' in `tar'.
+'to-stdout'
+ '-O' in 'tar'.
-`total'
- `-c' in `du'.
+'total'
+ '-c' in 'du'.
-`touch'
- `-t' in `make', `ranlib', and `recode'.
+'touch'
+ '-t' in 'make', 'ranlib', and 'recode'.
-`trace'
- `-t' in `m4'.
+'trace'
+ '-t' in 'm4'.
-`traditional'
- `-t' in `hello'; `-W traditional' in `gawk'; `-G' in `ed', `m4',
- and `ptx'.
+'traditional'
+ '-t' in 'hello'; '-W traditional' in 'gawk'; '-G' in 'ed', 'm4',
+ and 'ptx'.
-`tty'
+'tty'
Used in GDB.
-`typedefs'
- `-t' in `ctags'.
+'typedefs'
+ '-t' in 'ctags'.
-`typedefs-and-c++'
- `-T' in `ctags'.
+'typedefs-and-c++'
+ '-T' in 'ctags'.
-`typeset-mode'
- `-t' in `ptx'.
+'typeset-mode'
+ '-t' in 'ptx'.
-`uncompress'
- `-z' in `tar'.
+'uncompress'
+ '-z' in 'tar'.
-`unconditional'
- `-u' in `cpio'.
+'unconditional'
+ '-u' in 'cpio'.
-`undefine'
- `-U' in `m4'.
+'undefine'
+ '-U' in 'm4'.
-`undefined-only'
- `-u' in `nm'.
+'undefined-only'
+ '-u' in 'nm'.
-`update'
- `-u' in `cp', `ctags', `mv', `tar'.
+'update'
+ '-u' in 'cp', 'ctags', 'mv', 'tar'.
-`usage'
- Used in `gawk'; same as `--help'.
+'usage'
+ Used in 'gawk'; same as '--help'.
-`uuencode'
- `-B' in `shar'.
+'uuencode'
+ '-B' in 'shar'.
-`vanilla-operation'
- `-V' in `shar'.
+'vanilla-operation'
+ '-V' in 'shar'.
-`verbose'
+'verbose'
Print more information about progress. Many programs support this.
-`verify'
- `-W' in `tar'.
+'verify'
+ '-W' in 'tar'.
-`version'
+'version'
Print the version number.
-`version-control'
- `-V' in `cp', `ln', `mv'.
+'version-control'
+ '-V' in 'cp', 'ln', 'mv'.
-`vgrind'
- `-v' in `ctags'.
+'vgrind'
+ '-v' in 'ctags'.
-`volume'
- `-V' in `tar'.
+'volume'
+ '-V' in 'tar'.
-`what-if'
- `-W' in `make'.
+'what-if'
+ '-W' in 'make'.
-`whole-size-limit'
- `-l' in `shar'.
+'whole-size-limit'
+ '-l' in 'shar'.
-`width'
- `-w' in `ls' and `ptx'.
+'width'
+ '-w' in 'ls' and 'ptx'.
-`word-regexp'
- `-W' in `ptx'.
+'word-regexp'
+ '-W' in 'ptx'.
-`writable'
- `-T' in `who'.
+'writable'
+ '-T' in 'who'.
-`zeros'
- `-z' in `gprof'.
+'zeros'
+ '-z' in 'gprof'.
4.10 OID Allocations
====================
@@ -2095,7 +2084,7 @@
The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the
GNU Project (thanks to Werner Koch). These are used for SNMP, LDAP,
X.509 certificates, and so on. The web site
-`http://www.alvestrand.no/objectid' has a (voluntary) listing of many
+'http://www.alvestrand.no/objectid' has a (voluntary) listing of many
OID assignments.
If you need a new slot for your GNU package, write
@@ -2147,10 +2136,10 @@
If a program typically uses just a few meg of memory, don't bother
making any effort to reduce memory usage. For example, if it is
impractical for other reasons to operate on files more than a few meg
-long, it is reasonable to read entire input files into memory to
-operate on them.
+long, it is reasonable to read entire input files into memory to operate
+on them.
- However, for programs such as `cat' or `tail', that can usefully
+ However, for programs such as 'cat' or 'tail', that can usefully
operate on very large files, it is important to avoid using a technique
that would artificially limit the size of files it can handle. If a
program works by lines and could be applied to arbitrary user-supplied
@@ -2159,9 +2148,9 @@
are bigger than will fit in memory all at once.
If your program creates complicated data structures, just make them
-in memory and give a fatal error if `malloc' returns zero.
+in memory and give a fatal error if 'malloc' returns zero.
- Memory analysis tools such as `valgrind' can be useful, but don't
+ Memory analysis tools such as 'valgrind' can be useful, but don't
complicate a program merely to avoid their false alarms. For example,
if memory is used until just before a process exits, don't free it
simply to silence such a tool.
@@ -2169,15 +2158,15 @@
4.12 File Usage
===============
-Programs should be prepared to operate when `/usr' and `/etc' are
+Programs should be prepared to operate when '/usr' and '/etc' are
read-only file systems. Thus, if the program manages log files, lock
files, backup files, score files, or any other files which are modified
-for internal purposes, these files should not be stored in `/usr' or
-`/etc'.
+for internal purposes, these files should not be stored in '/usr' or
+'/etc'.
- There are two exceptions. `/etc' is used to store system
+ There are two exceptions. '/etc' is used to store system
configuration information; it is reasonable for a program to modify
-files in `/etc' when its job is to update the system configuration.
+files in '/etc' when its job is to update the system configuration.
Also, if the user explicitly asks to modify one file in a directory, it
is reasonable for the program to store other files in the same
directory.
@@ -2198,7 +2187,7 @@
Avoid putting open-brace, open-parenthesis or open-bracket in column
one when they are inside a function, so that they won't start a defun.
-The open-brace that starts a `struct' body can go in column one if you
+The open-brace that starts a 'struct' body can go in column one if you
find it useful to treat that definition as a defun.
It is also important for function definitions to start the name of
@@ -2230,8 +2219,8 @@
double a_double, float a_float)
...
- For `struct' and `enum' types, likewise put the braces in column
-one, unless the whole contents fits on one line:
+ For 'struct' and 'enum' types, likewise put the braces in column one,
+unless the whole contents fits on one line:
struct foo
{
@@ -2241,7 +2230,7 @@
struct foo { int a, b; }
The rest of this section gives our recommendations for other aspects
-of C formatting style, which is also the default style of the `indent'
+of C formatting style, which is also the default style of the 'indent'
program in version 1.2 and newer. It corresponds to the options
-nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce -cp1 -cs -di2
@@ -2322,31 +2311,31 @@
========================
Every program should start with a comment saying briefly what it is for.
-Example: `fmt - filter for simple filling of text'. This comment
-should be at the top of the source file containing the `main' function
-of the program.
+Example: 'fmt - filter for simple filling of text'. This comment should
+be at the top of the source file containing the 'main' function of the
+program.
Also, please write a brief comment at the start of each source file,
with the file name and a line or two about the overall purpose of the
file.
Please write the comments in a GNU program in English, because
-English is the one language that nearly all programmers in all
-countries can read. If you do not write English well, please write
-comments in English as well as you can, then ask other people to help
-rewrite them. If you can't write comments in English, please find
-someone to work with you and translate your comments into English.
+English is the one language that nearly all programmers in all countries
+can read. If you do not write English well, please write comments in
+English as well as you can, then ask other people to help rewrite them.
+If you can't write comments in English, please find someone to work with
+you and translate your comments into English.
Please put a comment on each function saying what the function does,
what sorts of arguments it gets, and what the possible values of
arguments mean and are used for. It is not necessary to duplicate in
words the meaning of the C argument declarations, if a C type is being
used in its customary fashion. If there is anything nonstandard about
-its use (such as an argument of type `char *' which is really the
+its use (such as an argument of type 'char *' which is really the
address of the second character of a string, not the first), or any
possible values that would not work the way one would expect (such as,
-that strings containing newlines are not guaranteed to work), be sure
-to say so.
+that strings containing newlines are not guaranteed to work), be sure to
+say so.
Also explain the significance of the return value, if there is one.
@@ -2375,10 +2364,10 @@
zero means continue them. */
int truncate_lines;
- Every `#endif' should have a comment, except in the case of short
+ Every '#endif' should have a comment, except in the case of short
conditionals (just a few lines) that are not nested. The comment should
state the condition of the conditional that is ending, _including its
-sense_. `#else' should have a comment describing the condition _and
+sense_. '#else' should have a comment describing the condition _and
sense_ of the code that follows. For example:
#ifdef foo
@@ -2390,7 +2379,7 @@
...
#endif /* foo */
-but, by contrast, write the comments this way for a `#ifndef':
+but, by contrast, write the comments this way for a '#ifndef':
#ifndef foo
...
@@ -2406,31 +2395,31 @@
Please explicitly declare the types of all objects. For example, you
should explicitly declare all arguments to functions, and you should
-declare functions to return `int' rather than omitting the `int'.
+declare functions to return 'int' rather than omitting the 'int'.
- Some programmers like to use the GCC `-Wall' option, and change the
+ Some programmers like to use the GCC '-Wall' option, and change the
code whenever it issues a warning. If you want to do this, then do.
-Other programmers prefer not to use `-Wall', because it gives warnings
+Other programmers prefer not to use '-Wall', because it gives warnings
for valid and legitimate code which they do not want to change. If you
-want to do this, then do. The compiler should be your servant, not
-your master.
+want to do this, then do. The compiler should be your servant, not your
+master.
Don't make the program ugly just to placate static analysis tools
-such as `lint', `clang', and GCC with extra warnings options such as
-`-Wconversion' and `-Wundef'. These tools can help find bugs and
+such as 'lint', 'clang', and GCC with extra warnings options such as
+'-Wconversion' and '-Wundef'. These tools can help find bugs and
unclear code, but they can also generate so many false alarms that it
hurts readability to silence them with unnecessary casts, wrappers, and
-other complications. For example, please don't insert casts to `void'
+other complications. For example, please don't insert casts to 'void'
or calls to do-nothing functions merely to pacify a lint checker.
Declarations of external functions and functions to appear later in
the source file should all go in one place near the beginning of the
file (somewhere before the first function definition in the file), or
-else should go in a header file. Don't put `extern' declarations inside
+else should go in a header file. Don't put 'extern' declarations inside
functions.
It used to be common practice to use the same local variables (with
-names like `tem') over and over for different values within one
+names like 'tem') over and over for different values within one
function. Instead of doing this, it is better to declare a separate
local variable for each distinct purpose, and give it a name which is
meaningful. This not only makes programs easier to understand, it also
@@ -2439,7 +2428,7 @@
all its uses. This makes the program even cleaner.
Don't use local variables or parameters that shadow global
-identifiers. GCC's `-Wshadow' option can detect this problem.
+identifiers. GCC's '-Wshadow' option can detect this problem.
Don't declare multiple variables in one declaration that spans lines.
Start a new declaration on each line, instead. For example, instead of
@@ -2460,8 +2449,8 @@
(If they are global variables, each should have a comment preceding it
anyway.)
- When you have an `if'-`else' statement nested in another `if'
-statement, always put braces around the `if'-`else'. Thus, never write
+ When you have an 'if'-'else' statement nested in another 'if'
+statement, always put braces around the 'if'-'else'. Thus, never write
like this:
if (foo)
@@ -2480,16 +2469,16 @@
lose ();
}
- If you have an `if' statement nested inside of an `else' statement,
-either write `else if' on one line, like this,
+ If you have an 'if' statement nested inside of an 'else' statement,
+either write 'else if' on one line, like this,
if (foo)
...
else if (bar)
...
-with its `then'-part indented like the preceding `then'-part, or write
-the nested `if' within braces like this:
+with its 'then'-part indented like the preceding 'then'-part, or write
+the nested 'if' within braces like this:
if (foo)
...
@@ -2503,8 +2492,8 @@
same declaration. Instead, declare the structure tag separately and
then use it to declare the variables or typedefs.
- Try to avoid assignments inside `if'-conditions (assignments inside
-`while'-conditions are ok). For example, don't write this:
+ Try to avoid assignments inside 'if'-conditions (assignments inside
+'while'-conditions are ok). For example, don't write this:
if ((foo = (char *) malloc (sizeof *foo)) == 0)
fatal ("virtual memory exhausted");
@@ -2517,7 +2506,7 @@
This example uses zero without a cast as a null pointer constant.
This is perfectly fine, except that a cast is needed when calling a
-varargs function or when using `sizeof'.
+varargs function or when using 'sizeof'.
5.4 Naming Variables, Functions, and Files
==========================================
@@ -2537,32 +2526,32 @@
Please use underscores to separate words in a name, so that the Emacs
word commands can be useful within them. Stick to lower case; reserve
-upper case for macros and `enum' constants, and for name-prefixes that
+upper case for macros and 'enum' constants, and for name-prefixes that
follow a uniform convention.
- For example, you should use names like `ignore_space_change_flag';
-don't use names like `iCantReadThis'.
+ For example, you should use names like 'ignore_space_change_flag';
+don't use names like 'iCantReadThis'.
Variables that indicate whether command-line options have been
-specified should be named after the meaning of the option, not after
-the option-letter. A comment should state both the exact meaning of
-the option and its letter. For example,
+specified should be named after the meaning of the option, not after the
+option-letter. A comment should state both the exact meaning of the
+option and its letter. For example,
/* Ignore changes in horizontal whitespace (-b). */
int ignore_space_change_flag;
When you want to define names with constant integer values, use
-`enum' rather than `#define'. GDB knows about enumeration constants.
+'enum' rather than '#define'. GDB knows about enumeration constants.
You might want to make sure that none of the file names would
conflict if the files were loaded onto an MS-DOS file system which
-shortens the names. You can use the program `doschk' to test for this.
+shortens the names. You can use the program 'doschk' to test for this.
Some GNU programs were designed to limit themselves to file names of
14 characters or less, to avoid file name conflicts if they are read
into older System V systems. Please preserve this feature in the
existing GNU programs that have it, but there is no need to do this in
-new GNU programs. `doschk' also reports file names longer than 14
+new GNU programs. 'doschk' also reports file names longer than 14
characters.
5.5 Portability between System Types
@@ -2592,7 +2581,7 @@
written.
Avoid using the format of semi-internal data bases (e.g.,
-directories) when there is a higher-level alternative (`readdir').
+directories) when there is a higher-level alternative ('readdir').
As for systems that are not like Unix, such as MSDOS, Windows, VMS,
MVS, and older Macintosh systems, supporting them is often a lot of
@@ -2603,19 +2592,18 @@
If you do support Windows, please do not abbreviate it as "win". In
hacker terminology, calling something a "win" is a form of praise.
You're free to praise Microsoft Windows on your own if you want, but
-please don't do this in GNU packages. Instead of abbreviating
-"Windows" to "win", you can write it in full or abbreviate it to "woe"
-or "w". In GNU Emacs, for instance, we use `w32' in file names of
-Windows-specific files, but the macro for Windows conditionals is
-called `WINDOWSNT'.
-
- It is a good idea to define the "feature test macro" `_GNU_SOURCE'
-when compiling your C files. When you compile on GNU or GNU/Linux,
-this will enable the declarations of GNU library extension functions,
-and that will usually give you a compiler error message if you define
-the same function names in some other way in your program. (You don't
-have to actually _use_ these functions, if you prefer to make the
-program more portable to other systems.)
+please don't do this in GNU packages. Instead of abbreviating "Windows"
+to "win", you can write it in full or abbreviate it to "woe" or "w". In
+GNU Emacs, for instance, we use 'w32' in file names of Windows-specific
+files, but the macro for Windows conditionals is called 'WINDOWSNT'.
+
+ It is a good idea to define the "feature test macro" '_GNU_SOURCE'
+when compiling your C files. When you compile on GNU or GNU/Linux, this
+will enable the declarations of GNU library extension functions, and
+that will usually give you a compiler error message if you define the
+same function names in some other way in your program. (You don't have
+to actually _use_ these functions, if you prefer to make the program
+more portable to other systems.)
But whether or not you use these GNU extensions, you should avoid
using their names for any other meanings. Doing so would make it hard
@@ -2624,15 +2612,14 @@
5.6 Portability between CPUs
============================
-Even GNU systems will differ because of differences among CPU
-types--for example, difference in byte ordering and alignment
-requirements. It is absolutely essential to handle these differences.
-However, don't make any effort to cater to the possibility that an
-`int' will be less than 32 bits. We don't support 16-bit machines in
-GNU.
+Even GNU systems will differ because of differences among CPU types--for
+example, difference in byte ordering and alignment requirements. It is
+absolutely essential to handle these differences. However, don't make
+any effort to cater to the possibility that an 'int' will be less than
+32 bits. We don't support 16-bit machines in GNU.
Similarly, don't make any effort to cater to the possibility that
-`long' will be smaller than predefined types like `size_t'. For
+'long' will be smaller than predefined types like 'size_t'. For
example, the following code is ok:
printf ("size = %lu\n", (unsigned long) sizeof array);
@@ -2640,15 +2627,15 @@
1989 Standard C requires this to work, and we know of only one
counterexample: 64-bit programs on Microsoft Windows. We will leave it
-to those who want to port GNU programs to that environment to figure
-out how to do it.
+to those who want to port GNU programs to that environment to figure out
+how to do it.
- Predefined file-size types like `off_t' are an exception: they are
-longer than `long' on many platforms, so code like the above won't work
-with them. One way to print an `off_t' value portably is to print its
+ Predefined file-size types like 'off_t' are an exception: they are
+longer than 'long' on many platforms, so code like the above won't work
+with them. One way to print an 'off_t' value portably is to print its
digits yourself, one by one.
- Don't assume that the address of an `int' object is also the address
+ Don't assume that the address of an 'int' object is also the address
of its least-significant byte. This is false on big-endian machines.
Thus, don't make the following mistake:
@@ -2657,9 +2644,9 @@
while ((c = getchar ()) != EOF)
write (file_descriptor, &c, 1);
-Instead, use `unsigned char' as follows. (The `unsigned' is for
-portability to unusual systems where `char' is signed and where there
-is integer overflow checking.)
+Instead, use 'unsigned char' as follows. (The 'unsigned' is for
+portability to unusual systems where 'char' is signed and where there is
+integer overflow checking.)
int c;
while ((c = getchar ()) != EOF)
@@ -2674,42 +2661,42 @@
interpreter which stores type information as well as an address in one
word--you'll have to make explicit provisions to handle different word
sizes. You will also need to make provision for systems in which the
-normal range of addresses you can get from `malloc' starts far away
-from zero.
+normal range of addresses you can get from 'malloc' starts far away from
+zero.
5.7 Calling System Functions
============================
-Historically, C implementations differed substantially, and many
-systems lacked a full implementation of ANSI/ISO C89. Nowadays,
-however, very few systems lack a C89 compiler and GNU C supports almost
-all of C99. Similarly, most systems implement POSIX.1-1993 libraries
-and tools, and many have POSIX.1-2001.
+Historically, C implementations differed substantially, and many systems
+lacked a full implementation of ANSI/ISO C89. Nowadays, however, very
+few systems lack a C89 compiler and GNU C supports almost all of C99.
+Similarly, most systems implement POSIX.1-1993 libraries and tools, and
+many have POSIX.1-2001.
Hence, there is little reason to support old C or non-POSIX systems,
and you may want to take advantage of C99 and POSIX-1.2001 to write
clearer, more portable, or faster code. You should use standard
interfaces where possible; but if GNU extensions make your program more
-maintainable, powerful, or otherwise better, don't hesitate to use
-them. In any case, don't make your own declaration of system
-functions; that's a recipe for conflict.
+maintainable, powerful, or otherwise better, don't hesitate to use them.
+In any case, don't make your own declaration of system functions; that's
+a recipe for conflict.
Despite the standards, nearly every library function has some sort of
portability issue on some system or another. Here are some examples:
-`open'
- Names with trailing `/''s are mishandled on many platforms.
+'open'
+ Names with trailing '/''s are mishandled on many platforms.
-`printf'
- `long double' may be unimplemented; floating values Infinity and
+'printf'
+ 'long double' may be unimplemented; floating values Infinity and
NaN are often mishandled; output for large precisions may be
incorrect.
-`readlink'
- May return `int' instead of `ssize_t'.
+'readlink'
+ May return 'int' instead of 'ssize_t'.
-`scanf'
- On Windows, `errno' is not set on failure.
+'scanf'
+ On Windows, 'errno' is not set on failure.
Gnulib (http://www.gnu.org/software/gnulib/) is a big help in this
regard. Gnulib provides implementations of standard interfaces on many
@@ -2721,7 +2708,7 @@
Gnulib also provides many useful non-standard interfaces; for
example, C implementations of standard data structures (hash tables,
binary trees), error-checking type-safe wrappers for memory allocation
-functions (`xmalloc', `xrealloc'), and output of error messages.
+functions ('xmalloc', 'xrealloc'), and output of error messages.
Gnulib integrates with GNU Autoconf and Automake to remove much of
the burden of writing portable code from the programmer: Gnulib makes
@@ -2729,8 +2716,8 @@
and use the Gnulib code to supply the missing pieces.
The Gnulib and Autoconf manuals have extensive sections on
-portability: *note Introduction: (gnulib)Top. and *note Portable C and
-C++: (autoconf)Portable C and C++. Please consult them for many more
+portability: *note Introduction: (gnulib)Top. and *note
+(autoconf)Portable C and C++::. Please consult them for many more
details.
5.8 Internationalization
@@ -2742,22 +2729,22 @@
in the program, and let gettext provide the way to translate them into
other languages.
- Using GNU gettext involves putting a call to the `gettext' macro
+ Using GNU gettext involves putting a call to the 'gettext' macro
around each string that might need translation--like this:
printf (gettext ("Processing file '%s'..."), file);
-This permits GNU gettext to replace the string `"Processing file
+This permits GNU gettext to replace the string '"Processing file
'%s'..."' with a translated version.
Once a program uses gettext, please make a point of writing calls to
-`gettext' when you add new strings that call for translation.
+'gettext' when you add new strings that call for translation.
Using GNU gettext in a package involves specifying a "text domain
name" for the package. The text domain name is used to separate the
translations for this package from the translations for other packages.
Normally, the text domain name should be the same as the name of the
-package--for example, `coreutils' for the GNU core utilities.
+package--for example, 'coreutils' for the GNU core utilities.
To enable gettext to work well, avoid writing code that makes
assumptions about the structure of words or sentences. When you want
@@ -2792,9 +2779,9 @@
printf ("# Implicit rule search has%s been done.\n",
f->tried_implicit ? "" : " not");
-Adding `gettext' calls to this code cannot give correct results for all
+Adding 'gettext' calls to this code cannot give correct results for all
languages, because negation in some languages requires adding words at
-more than one place in the sentence. By contrast, adding `gettext'
+more than one place in the sentence. By contrast, adding 'gettext'
calls does the job straightforwardly if the code starts out like this:
printf (f->tried_implicit
@@ -2807,13 +2794,13 @@
nfiles != 1 ? "s" : "");
The problem with this example is that it assumes that plurals are made
-by adding `s'. If you apply gettext to the format string, like this,
+by adding 's'. If you apply gettext to the format string, like this,
printf (gettext ("%d file%s processed"), nfiles,
nfiles != 1 ? "s" : "");
the message can use different words, but it will still be forced to use
-`s' for the plural. Here is a better way, with gettext being applied to
+'s' for the plural. Here is a better way, with gettext being applied to
the two strings independently:
printf ((nfiles != 1 ? gettext ("%d files processed")
@@ -2822,7 +2809,7 @@
But this still doesn't work for languages like Polish, which has three
plural forms: one for nfiles == 1, one for nfiles == 2, 3, 4, 22, 23,
-24, ... and one for the rest. The GNU `ngettext' function solves this
+24, ... and one for the rest. The GNU 'ngettext' function solves this
problem:
printf (ngettext ("%d files processed", "%d file processed", nfiles),
@@ -2836,9 +2823,9 @@
contexts, unless there is good reason to do something else because of
the application domain. For example, if source code deals with the
French Revolutionary calendar, it is OK if its literal strings contain
-accented characters in month names like "Flore'al". Also, it is OK
-(but not required) to use non-ASCII characters to represent proper
-names of contributors in change logs (*note Change Logs::).
+accented characters in month names like "Flore'al". Also, it is OK (but
+not required) to use non-ASCII characters to represent proper names of
+contributors in change logs (*note Change Logs::).
If you need to use non-ASCII characters, you should normally stick
with one encoding, certainly within a single file. UTF-8 is likely to
@@ -2848,11 +2835,11 @@
=====================
In the C locale, the output of GNU programs should stick to plain ASCII
-for quotation characters in messages to users: preferably 0x22 (`"') or
-0x27 (`'') for both opening and closing quotes. Although GNU programs
-traditionally used 0x60 (``') for opening and 0x27 (`'') for closing
-quotes, nowadays quotes ``like this'' are typically rendered
-asymmetrically, so quoting `"like this"' or `'like this'' typically
+for quotation characters in messages to users: preferably 0x22 ('"') or
+0x27 (''') for both opening and closing quotes. Although GNU programs
+traditionally used 0x60 ('`') for opening and 0x27 (''') for closing
+quotes, nowadays quotes '`like this'' are typically rendered
+asymmetrically, so quoting '"like this"' or ''like this'' typically
looks better.
It is ok, but not required, for GNU programs to generate
@@ -2860,13 +2847,13 @@
printf (gettext ("Processing file '%s'..."), file);
-Here, a French translation might cause `gettext' to return the string
-`"Traitement de fichier < %s >..."', yielding quotes more appropriate
+Here, a French translation might cause 'gettext' to return the string
+'"Traitement de fichier < %s >..."', yielding quotes more appropriate
for a French locale.
Sometimes a program may need to use opening and closing quotes
-directly. By convention, `gettext' translates the string `"`"' to the
-opening quote and the string `"'"' to the closing quote, and a program
+directly. By convention, 'gettext' translates the string '"`"' to the
+opening quote and the string '"'"' to the closing quote, and a program
can use these translations. Generally, though, it is better to
translate quote characters in the context of longer strings.
@@ -2874,23 +2861,23 @@
program, it is good to provide an option that makes this parsing
reliable. For example, you could escape special characters using
conventions from the C language or the Bourne shell. See for example
-the option `--quoting-style' of GNU `ls'.
+the option '--quoting-style' of GNU 'ls'.
5.11 Mmap
=========
-Don't assume that `mmap' either works on all files or fails for all
+Don't assume that 'mmap' either works on all files or fails for all
files. It may work on some files and fail on others.
- The proper way to use `mmap' is to try it on the specific file for
-which you want to use it--and if `mmap' doesn't work, fall back on
-doing the job in another way using `read' and `write'.
+ The proper way to use 'mmap' is to try it on the specific file for
+which you want to use it--and if 'mmap' doesn't work, fall back on doing
+the job in another way using 'read' and 'write'.
The reason this precaution is needed is that the GNU kernel (the
HURD) provides a user-extensible file system, in which there can be many
-different kinds of "ordinary files". Many of them support `mmap', but
-some do not. It is important to make programs handle all these kinds
-of files.
+different kinds of "ordinary files". Many of them support 'mmap', but
+some do not. It is important to make programs handle all these kinds of
+files.
6 Documenting Programs
**********************
@@ -2909,8 +2896,8 @@
makes it possible to produce a good quality formatted book, using TeX,
and to generate an Info file. It is also possible to generate HTML
output from Texinfo source. See the Texinfo manual, either the
-hardcopy, or the on-line version available through `info' or the Emacs
-Info subsystem (`C-h i').
+hardcopy, or the on-line version available through 'info' or the Emacs
+Info subsystem ('C-h i').
Nowadays some other formats such as Docbook and Sgmltexi can be
converted automatically into Texinfo. It is ok to produce the Texinfo
@@ -2934,8 +2921,8 @@
structure of the implementation of the software being documented--but
often they are different. An important part of learning to write good
documentation is to learn to notice when you have unthinkingly
-structured the documentation like the implementation, stop yourself,
-and look for better alternatives.
+structured the documentation like the implementation, stop yourself, and
+look for better alternatives.
For example, each program in the GNU system probably ought to be
documented in one manual; but this does not mean each program should
@@ -2944,10 +2931,10 @@
understand.
Instead, each manual should cover a coherent _topic_. For example,
-instead of a manual for `diff' and a manual for `diff3', we have one
-manual for "comparison of files" which covers both of those programs,
-as well as `cmp'. By documenting these programs together, we can make
-the whole subject clearer.
+instead of a manual for 'diff' and a manual for 'diff3', we have one
+manual for "comparison of files" which covers both of those programs, as
+well as 'cmp'. By documenting these programs together, we can make the
+whole subject clearer.
The manual which discusses a program should certainly document all of
the program's command-line options and all of its commands. It should
@@ -3000,13 +2987,13 @@
documentation; use "file name" (two words) instead. We use the term
"path" only for search paths, which are lists of directory names.
- Please do not use the term "illegal" to refer to erroneous input to
-a computer program. Please use "invalid" for this, and reserve the
-term "illegal" for activities prohibited by law.
-
- Please do not write `()' after a function name just to indicate it
-is a function. `foo ()' is not a function, it is a function call with
-no arguments.
+ Please do not use the term "illegal" to refer to erroneous input to a
+computer program. Please use "invalid" for this, and reserve the term
+"illegal" for activities prohibited by law.
+
+ Please do not write '()' after a function name just to indicate it is
+a function. 'foo ()' is not a function, it is a function call with no
+arguments.
6.2 Doc Strings and Manuals
===========================
@@ -3045,17 +3032,17 @@
number for the manual in both of these places.
Each program documented in the manual should have a node named
-`PROGRAM Invocation' or `Invoking PROGRAM'. This node (together with
+'PROGRAM Invocation' or 'Invoking PROGRAM'. This node (together with
its subnodes, if any) should describe the program's command line
arguments and how to run it (the sort of information people would look
-for in a man page). Start with an address@hidden' containing a template for
+for in a man page). Start with an '@example' containing a template for
all the options and arguments that the program uses.
Alternatively, put a menu item in some menu whose item name fits one
of the above patterns. This identifies the node which that item points
to as the node for this purpose, regardless of the node's actual name.
- The `--usage' feature of the Info reader looks for such a node or
+ The '--usage' feature of the Info reader looks for such a node or
menu item in order to find the relevant text, so it is essential for
every Texinfo file to have one.
@@ -3071,7 +3058,7 @@
collection. For a single short document, you can use a very permissive
non-copyleft license, to avoid taking up space with a long license.
- See `http://www.gnu.org/copyleft/fdl-howto.html' for more explanation
+ See 'http://www.gnu.org/copyleft/fdl-howto.html' for more explanation
of how to employ the GFDL.
Note that it is not obligatory to include a copy of the GNU GPL or
@@ -3096,7 +3083,7 @@
of these manuals, the on-line versions of the manual should mention at
the very start that the printed manual is available and should point at
information for getting it--for instance, with a link to the page
-`http://www.gnu.org/order/order.html'. This should not be included in
+'http://www.gnu.org/order/order.html'. This should not be included in
the printed manual, though, because there it is redundant.
It is also useful to explain in the on-line forms of the manual how
@@ -3105,15 +3092,15 @@
6.7 The NEWS File
=================
-In addition to its manual, the package should have a file named `NEWS'
-which contains a list of user-visible changes worth mentioning. In
-each new release, add items to the front of the file and identify the
-version they pertain to. Don't discard old items; leave them in the
-file after the newer items. This way, a user upgrading from any
-previous version can see what is new.
+In addition to its manual, the package should have a file named 'NEWS'
+which contains a list of user-visible changes worth mentioning. In each
+new release, add items to the front of the file and identify the version
+they pertain to. Don't discard old items; leave them in the file after
+the newer items. This way, a user upgrading from any previous version
+can see what is new.
- If the `NEWS' file gets very long, move some of the older items into
-a file named `ONEWS' and put a note at the end referring the user to
+ If the 'NEWS' file gets very long, move some of the older items into
+a file named 'ONEWS' and put a note at the end referring the user to
that file.
6.8 Change Logs
@@ -3136,22 +3123,22 @@
tell them what is in it. What they want from a change log is a clear
explanation of how the earlier version differed.
- The change log file is normally called `ChangeLog' and covers an
+ The change log file is normally called 'ChangeLog' and covers an
entire directory. Each directory can have its own change log, or a
directory can use the change log of its parent directory--it's up to
you.
Another alternative is to record change log information with a
version control system such as RCS or CVS. This can be converted
-automatically to a `ChangeLog' file using `rcs2log'; in Emacs, the
-command `C-x v a' (`vc-update-change-log') does the job.
+automatically to a 'ChangeLog' file using 'rcs2log'; in Emacs, the
+command 'C-x v a' ('vc-update-change-log') does the job.
There's no need to describe the full purpose of the changes or how
they work together. However, sometimes it is useful to write one line
to describe the overall purpose of a change or a batch of changes. If
you think that a change calls for explanation, you're probably right.
-Please do explain it--but please put the full explanation in comments
-in the code, where people will see it whenever they see the code. For
+Please do explain it--but please put the full explanation in comments in
+the code, where people will see it whenever they see the code. For
example, "New function" is enough for the change log when you add a
function, because there should be a comment before the function
definition to explain what it does.
@@ -3161,8 +3148,8 @@
advised that it is a good idea to include them, for the sake of
copyright records.
- The easiest way to add an entry to `ChangeLog' is with the Emacs
-command `M-x add-change-log-entry'. An entry should have an asterisk,
+ The easiest way to add an entry to 'ChangeLog' is with the Emacs
+command 'M-x add-change-log-entry'. An entry should have an asterisk,
the name of the changed file, and then in parentheses the name of the
changed functions, variables or whatever, followed by a colon. Then
describe the changes you made to that function or variable.
@@ -3172,8 +3159,8 @@
Here are some simple examples of change log entries, starting with the
header line that says who made the change and when it was installed,
-followed by descriptions of specific changes. (These examples are
-drawn from Emacs and GCC.)
+followed by descriptions of specific changes. (These examples are drawn
+from Emacs and GCC.)
1998-08-17 Richard Stallman <address@hidden>
@@ -3197,9 +3184,9 @@
they won't find it when they search.
For example, some people are tempted to abbreviate groups of function
-names by writing `* register.el ({insert,jump-to}-register)'; this is
-not a good idea, since searching for `jump-to-register' or
-`insert-register' would not find that entry.
+names by writing '* register.el ({insert,jump-to}-register)'; this is
+not a good idea, since searching for 'jump-to-register' or
+'insert-register' would not find that entry.
Separate unrelated change log entries with blank lines. When two
entries represent parts of the same change, so that they work together,
@@ -3207,7 +3194,7 @@
name and the asterisk when successive entries are in the same file.
Break long lists of function names by closing continued lines with
-`)', rather than `,', and opening the continuation with `(' as in this
+')', rather than ',', and opening the continuation with '(' as in this
example:
* keyboard.c (menu_bar_items, tool_bar_items)
@@ -3263,11 +3250,11 @@
6.8.4 Conditional Changes
-------------------------
-Source files can often contain code that is conditional to build-time
-or static conditions. For example, C programs can contain compile-time
-`#if' conditionals; programs implemented in interpreted languages can
+Source files can often contain code that is conditional to build-time or
+static conditions. For example, C programs can contain compile-time
+'#if' conditionals; programs implemented in interpreted languages can
contain module imports of function definitions that are only performed
-for certain versions of the interpreter; and Automake `Makefile.am'
+for certain versions of the interpreter; and Automake 'Makefile.am'
files can contain variable definitions or target declarations that are
only to be considered if a configure-time Automake conditional is true.
@@ -3295,14 +3282,14 @@
self-evident.
Next, here is an entry describing a new definition which is entirely
-conditional: the C macro `FRAME_WINDOW_P' is defined (and used) only
-when the macro `HAVE_X_WINDOWS' is defined:
+conditional: the C macro 'FRAME_WINDOW_P' is defined (and used) only
+when the macro 'HAVE_X_WINDOWS' is defined:
* frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P): Macro defined.
- Next, an entry for a change within the function `init_display',
-whose definition as a whole is unconditional, but the changes
-themselves are contained in a `#ifdef HAVE_LIBNCURSES' conditional:
+ Next, an entry for a change within the function 'init_display', whose
+definition as a whole is unconditional, but the changes themselves are
+contained in a '#ifdef HAVE_LIBNCURSES' conditional:
* dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call tgetent.
@@ -3316,8 +3303,8 @@
Indicate the part of a function which changed by using angle brackets
enclosing an indication of what the changed part does. Here is an entry
-for a change in the part of the function `sh-while-getopts' that deals
-with `sh' commands:
+for a change in the part of the function 'sh-while-getopts' that deals
+with 'sh' commands:
* progmodes/sh-script.el (sh-while-getopts) <sh>: Handle case that
user-specified option string is empty.
@@ -3338,12 +3325,12 @@
if you have one.
For a large program that changes a great deal, updating a man page
-may be a substantial burden. If a user offers to donate a man page,
-you may find this gift costly to accept. It may be better to refuse
-the man page unless the same person agrees to take full responsibility
-for maintaining it--so that you can wash your hands of it entirely. If
-this volunteer later ceases to do the job, then don't feel obliged to
-pick it up yourself; it may be better to withdraw the man page from the
+may be a substantial burden. If a user offers to donate a man page, you
+may find this gift costly to accept. It may be better to refuse the man
+page unless the same person agrees to take full responsibility for
+maintaining it--so that you can wash your hands of it entirely. If this
+volunteer later ceases to do the job, then don't feel obliged to pick it
+up yourself; it may be better to withdraw the man page from the
distribution until someone else agrees to update it.
When a program changes only a little, you may feel that the
@@ -3355,16 +3342,15 @@
Be sure that man pages include a copyright statement and free
license. The simple all-permissive license is appropriate for simple
-man pages (*note License Notices for Other Files: (maintain)License
-Notices for Other Files.).
+man pages (*note (maintain)License Notices for Other Files::).
For long man pages, with enough explanation and documentation that
they can be considered true manuals, use the GFDL (*note License for
Manuals::).
Finally, the GNU help2man program
-(`http://www.gnu.org/software/help2man/') is one way to automate
-generation of a man page, in this case from `--help' output. This is
+('http://www.gnu.org/software/help2man/') is one way to automate
+generation of a man page, in this case from '--help' output. This is
sufficient in many cases.
6.10 Reading other Manuals
@@ -3396,150 +3382,146 @@
7.1 How Configuration Should Work
=================================
-Each GNU distribution should come with a shell script named
-`configure'. This script is given arguments which describe the kind of
-machine and system you want to compile the program for. The
-`configure' script must record the configuration options so that they
-affect compilation.
+Each GNU distribution should come with a shell script named 'configure'.
+This script is given arguments which describe the kind of machine and
+system you want to compile the program for. The 'configure' script must
+record the configuration options so that they affect compilation.
The description here is the specification of the interface for the
-`configure' script in GNU packages. Many packages implement it using
+'configure' script in GNU packages. Many packages implement it using
GNU Autoconf (*note Introduction: (autoconf)Top.) and/or GNU Automake
(*note Introduction: (automake)Top.), but you do not have to use these
tools. You can implement it any way you like; for instance, by making
-`configure' be a wrapper around a completely different configuration
+'configure' be a wrapper around a completely different configuration
system.
- Another way for the `configure' script to operate is to make a link
-from a standard name such as `config.h' to the proper configuration
-file for the chosen system. If you use this technique, the
-distribution should _not_ contain a file named `config.h'. This is so
-that people won't be able to build the program without configuring it
-first.
+ Another way for the 'configure' script to operate is to make a link
+from a standard name such as 'config.h' to the proper configuration file
+for the chosen system. If you use this technique, the distribution
+should _not_ contain a file named 'config.h'. This is so that people
+won't be able to build the program without configuring it first.
- Another thing that `configure' can do is to edit the Makefile. If
+ Another thing that 'configure' can do is to edit the Makefile. If
you do this, the distribution should _not_ contain a file named
-`Makefile'. Instead, it should include a file `Makefile.in' which
+'Makefile'. Instead, it should include a file 'Makefile.in' which
contains the input used for editing. Once again, this is so that people
won't be able to build the program without configuring it first.
- If `configure' does write the `Makefile', then `Makefile' should
-have a target named `Makefile' which causes `configure' to be rerun,
-setting up the same configuration that was set up last time. The files
-that `configure' reads should be listed as dependencies of `Makefile'.
+ If 'configure' does write the 'Makefile', then 'Makefile' should have
+a target named 'Makefile' which causes 'configure' to be rerun, setting
+up the same configuration that was set up last time. The files that
+'configure' reads should be listed as dependencies of 'Makefile'.
- All the files which are output from the `configure' script should
+ All the files which are output from the 'configure' script should
have comments at the beginning explaining that they were generated
-automatically using `configure'. This is so that users won't think of
+automatically using 'configure'. This is so that users won't think of
trying to edit them by hand.
- The `configure' script should write a file named `config.status'
+ The 'configure' script should write a file named 'config.status'
which describes which configuration options were specified when the
program was last configured. This file should be a shell script which,
if run, will recreate the same configuration.
- The `configure' script should accept an option of the form
-`--srcdir=DIRNAME' to specify the directory where sources are found (if
+ The 'configure' script should accept an option of the form
+'--srcdir=DIRNAME' to specify the directory where sources are found (if
it is not the current directory). This makes it possible to build the
program in a separate directory, so that the actual source directory is
not modified.
- If the user does not specify `--srcdir', then `configure' should
-check both `.' and `..' to see if it can find the sources. If it finds
+ If the user does not specify '--srcdir', then 'configure' should
+check both '.' and '..' to see if it can find the sources. If it finds
the sources in one of these places, it should use them from there.
Otherwise, it should report that it cannot find the sources, and should
exit with nonzero status.
- Usually the easy way to support `--srcdir' is by editing a
-definition of `VPATH' into the Makefile. Some rules may need to refer
-explicitly to the specified source directory. To make this possible,
-`configure' can add to the Makefile a variable named `srcdir' whose
-value is precisely the specified directory.
-
- In addition, the `configure' script should take options
-corresponding to most of the standard directory variables (*note
-Directory Variables::). Here is the list:
+ Usually the easy way to support '--srcdir' is by editing a definition
+of 'VPATH' into the Makefile. Some rules may need to refer explicitly
+to the specified source directory. To make this possible, 'configure'
+can add to the Makefile a variable named 'srcdir' whose value is
+precisely the specified directory.
+
+ In addition, the 'configure' script should take options corresponding
+to most of the standard directory variables (*note Directory
+Variables::). Here is the list:
--prefix --exec-prefix --bindir --sbindir --libexecdir --sysconfdir
--sharedstatedir --localstatedir --libdir --includedir --oldincludedir
--datarootdir --datadir --infodir --localedir --mandir --docdir
--htmldir --dvidir --pdfdir --psdir
- The `configure' script should also take an argument which specifies
+ The 'configure' script should also take an argument which specifies
the type of system to build the program for. This argument should look
like this:
CPU-COMPANY-SYSTEM
For example, an Athlon-based GNU/Linux system might be
-`i686-pc-linux-gnu'.
+'i686-pc-linux-gnu'.
- The `configure' script needs to be able to decode all plausible
-alternatives for how to describe a machine. Thus,
-`athlon-pc-gnu/linux' would be a valid alias. There is a shell script
-called `config.sub'
+ The 'configure' script needs to be able to decode all plausible
+alternatives for how to describe a machine. Thus, 'athlon-pc-gnu/linux'
+would be a valid alias. There is a shell script called 'config.sub'
(http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD)
that you can use as a subroutine to validate system types and
canonicalize aliases.
- The `configure' script should also take the option
-`--build=BUILDTYPE', which should be equivalent to a plain BUILDTYPE
-argument. For example, `configure --build=i686-pc-linux-gnu' is
-equivalent to `configure i686-pc-linux-gnu'. When the build type is
-not specified by an option or argument, the `configure' script should
-normally guess it using the shell script `config.guess'
+ The 'configure' script should also take the option
+'--build=BUILDTYPE', which should be equivalent to a plain BUILDTYPE
+argument. For example, 'configure --build=i686-pc-linux-gnu' is
+equivalent to 'configure i686-pc-linux-gnu'. When the build type is not
+specified by an option or argument, the 'configure' script should
+normally guess it using the shell script 'config.guess'
(http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD).
- Other options are permitted to specify in more detail the software
-or hardware present on the machine, to include or exclude optional parts
-of the package, or to adjust the name of some tools or arguments to
-them:
+ Other options are permitted to specify in more detail the software or
+hardware present on the machine, to include or exclude optional parts of
+the package, or to adjust the name of some tools or arguments to them:
-`--enable-FEATURE[=PARAMETER]'
+'--enable-FEATURE[=PARAMETER]'
Configure the package to build and install an optional user-level
facility called FEATURE. This allows users to choose which
- optional features to include. Giving an optional PARAMETER of
- `no' should omit FEATURE, if it is built by default.
+ optional features to include. Giving an optional PARAMETER of 'no'
+ should omit FEATURE, if it is built by default.
- No `--enable' option should *ever* cause one feature to replace
- another. No `--enable' option should ever substitute one useful
+ No '--enable' option should *ever* cause one feature to replace
+ another. No '--enable' option should ever substitute one useful
behavior for another useful behavior. The only proper use for
- `--enable' is for questions of whether to build part of the program
+ '--enable' is for questions of whether to build part of the program
or exclude it.
-`--with-PACKAGE'
- The package PACKAGE will be installed, so configure this package
- to work with PACKAGE.
+'--with-PACKAGE'
+ The package PACKAGE will be installed, so configure this package to
+ work with PACKAGE.
- Possible values of PACKAGE include `gnu-as' (or `gas'), `gnu-ld',
- `gnu-libc', `gdb', `x', and `x-toolkit'.
+ Possible values of PACKAGE include 'gnu-as' (or 'gas'), 'gnu-ld',
+ 'gnu-libc', 'gdb', 'x', and 'x-toolkit'.
- Do not use a `--with' option to specify the file name to use to
- find certain files. That is outside the scope of what `--with'
+ Do not use a '--with' option to specify the file name to use to
+ find certain files. That is outside the scope of what '--with'
options are for.
-`VARIABLE=VALUE'
+'VARIABLE=VALUE'
Set the value of the variable VARIABLE to VALUE. This is used to
override the default values of commands or arguments in the build
- process. For example, the user could issue `configure CFLAGS=-g
+ process. For example, the user could issue 'configure CFLAGS=-g
CXXFLAGS=-g' to build with debugging information and without the
default optimization.
- Specifying variables as arguments to `configure', like this:
+ Specifying variables as arguments to 'configure', like this:
./configure CC=gcc
is preferable to setting them in environment variables:
CC=gcc ./configure
as it helps to recreate the same configuration later with
- `config.status'. However, both methods should be supported.
+ 'config.status'. However, both methods should be supported.
- All `configure' scripts should accept all of the "detail" options
-and the variable settings, whether or not they make any difference to
-the particular package at hand. In particular, they should accept any
-option that starts with `--with-' or `--enable-'. This is so users
-will be able to configure an entire GNU source tree at once with a
-single set of options.
+ All 'configure' scripts should accept all of the "detail" options and
+the variable settings, whether or not they make any difference to the
+particular package at hand. In particular, they should accept any
+option that starts with '--with-' or '--enable-'. This is so users will
+be able to configure an entire GNU source tree at once with a single set
+of options.
- You will note that the categories `--with-' and `--enable-' are
+ You will note that the categories '--with-' and '--enable-' are
narrow: they *do not* provide a place for any sort of option you might
think of. That is deliberate. We want to limit the possible
configuration options in GNU software. We do not want GNU programs to
@@ -3549,29 +3531,29 @@
cross-compilation. In such a case, the host and target machines for the
program may be different.
- The `configure' script should normally treat the specified type of
+ The 'configure' script should normally treat the specified type of
system as both the host and the target, thus producing a program which
works for the same type of machine that it runs on.
To compile a program to run on a host type that differs from the
-build type, use the configure option `--host=HOSTTYPE', where HOSTTYPE
+build type, use the configure option '--host=HOSTTYPE', where HOSTTYPE
uses the same syntax as BUILDTYPE. The host type normally defaults to
the build type.
To configure a cross-compiler, cross-assembler, or what have you, you
should specify a target different from the host, using the configure
-option `--target=TARGETTYPE'. The syntax for TARGETTYPE is the same as
+option '--target=TARGETTYPE'. The syntax for TARGETTYPE is the same as
for the host type. So the command would look like this:
./configure --host=HOSTTYPE --target=TARGETTYPE
The target type normally defaults to the host type. Programs for
-which cross-operation is not meaningful need not accept the `--target'
+which cross-operation is not meaningful need not accept the '--target'
option, because configuring an entire operating system for
cross-operation is not a meaningful operation.
Some programs have ways of configuring themselves automatically. If
-your program is set up to do this, your `configure' script can simply
+your program is set up to do this, your 'configure' script can simply
ignore most of its arguments.
7.2 Makefile Conventions
@@ -3589,14 +3571,14 @@
SHELL = /bin/sh
-to avoid trouble on systems where the `SHELL' variable might be
+to avoid trouble on systems where the 'SHELL' variable might be
inherited from the environment. (This is never a problem with GNU
-`make'.)
+'make'.)
- Different `make' programs have incompatible suffix lists and
-implicit rules, and this sometimes creates confusion or misbehavior. So
-it is a good idea to set the suffix list explicitly using only the
-suffixes you need in the particular Makefile, like this:
+ Different 'make' programs have incompatible suffix lists and implicit
+rules, and this sometimes creates confusion or misbehavior. So it is a
+good idea to set the suffix list explicitly using only the suffixes you
+need in the particular Makefile, like this:
.SUFFIXES:
.SUFFIXES: .c .o
@@ -3604,29 +3586,28 @@
The first line clears out the suffix list, the second introduces all
suffixes which may be subject to implicit rules in this Makefile.
- Don't assume that `.' is in the path for command execution. When
-you need to run programs that are a part of your package during the
-make, please make sure that it uses `./' if the program is built as
-part of the make or `$(srcdir)/' if the file is an unchanging part of
-the source code. Without one of these prefixes, the current search
-path is used.
-
- The distinction between `./' (the "build directory") and
-`$(srcdir)/' (the "source directory") is important because users can
-build in a separate directory using the `--srcdir' option to
-`configure'. A rule of the form:
+ Don't assume that '.' is in the path for command execution. When you
+need to run programs that are a part of your package during the make,
+please make sure that it uses './' if the program is built as part of
+the make or '$(srcdir)/' if the file is an unchanging part of the source
+code. Without one of these prefixes, the current search path is used.
+
+ The distinction between './' (the "build directory") and '$(srcdir)/'
+(the "source directory") is important because users can build in a
+separate directory using the '--srcdir' option to 'configure'. A rule
+of the form:
foo.1 : foo.man sedscript
sed -f sedscript foo.man > foo.1
will fail when the build directory is not the source directory, because
-`foo.man' and `sedscript' are in the source directory.
+'foo.man' and 'sedscript' are in the source directory.
- When using GNU `make', relying on `VPATH' to find the source file
-will work in the case where there is a single dependency file, since
-the `make' automatic variable `$<' will represent the source file
-wherever it is. (Many versions of `make' set `$<' only in implicit
-rules.) A Makefile target like
+ When using GNU 'make', relying on 'VPATH' to find the source file
+will work in the case where there is a single dependency file, since the
+'make' automatic variable '$<' will represent the source file wherever
+it is. (Many versions of 'make' set '$<' only in implicit rules.) A
+Makefile target like
foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c bar.c -o foo.o
@@ -3636,9 +3617,9 @@
foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c $< -o $@
-in order to allow `VPATH' to work correctly. When the target has
-multiple dependencies, using an explicit `$(srcdir)' is the easiest way
-to make the rule work well. For example, the target above for `foo.1'
+in order to allow 'VPATH' to work correctly. When the target has
+multiple dependencies, using an explicit '$(srcdir)' is the easiest way
+to make the rule work well. For example, the target above for 'foo.1'
is best written as:
foo.1 : foo.man sedscript
@@ -3657,27 +3638,26 @@
in any way.
Try to make the build and installation targets, at least (and all
-their subtargets) work correctly with a parallel `make'.
+their subtargets) work correctly with a parallel 'make'.
7.2.2 Utilities in Makefiles
----------------------------
-Write the Makefile commands (and any shell scripts, such as
-`configure') to run under `sh' (both the traditional Bourne shell and
-the POSIX shell), not `csh'. Don't use any special features of `ksh'
-or `bash', or POSIX features not widely supported in traditional Bourne
-`sh'.
+Write the Makefile commands (and any shell scripts, such as 'configure')
+to run under 'sh' (both the traditional Bourne shell and the POSIX
+shell), not 'csh'. Don't use any special features of 'ksh' or 'bash',
+or POSIX features not widely supported in traditional Bourne 'sh'.
- The `configure' script and the Makefile rules for building and
+ The 'configure' script and the Makefile rules for building and
installation should not use any utilities directly except these:
awk cat cmp cp diff echo egrep expr false grep install-info ln ls
mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true
- Compression programs such as `gzip' can be used in the `dist' rule.
+ Compression programs such as 'gzip' can be used in the 'dist' rule.
Generally, stick to the widely-supported (usually POSIX-specified)
-options and features of these programs. For example, don't use `mkdir
+options and features of these programs. For example, don't use 'mkdir
-p', convenient as it may be, because a few systems don't support it at
all and with others, it is not safe for parallel execution. For a list
of known incompatibilities, see *note Portable Shell Programming:
@@ -3687,23 +3667,23 @@
since a few file systems don't support them.
The Makefile rules for building and installation can also use
-compilers and related programs, but should do so via `make' variables
-so that the user can substitute alternatives. Here are some of the
+compilers and related programs, but should do so via 'make' variables so
+that the user can substitute alternatives. Here are some of the
programs we mean:
ar bison cc flex install ld ldconfig lex
make makeinfo ranlib texi2dvi yacc
- Use the following `make' variables to run those programs:
+ Use the following 'make' variables to run those programs:
$(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD) $(LDCONFIG) $(LEX)
$(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
- When you use `ranlib' or `ldconfig', you should make sure nothing
-bad happens if the system does not have the program in question.
-Arrange to ignore an error from that command, and print a message before
-the command to tell the user that failure of this command does not mean
-a problem. (The Autoconf `AC_PROG_RANLIB' macro can help with this.)
+ When you use 'ranlib' or 'ldconfig', you should make sure nothing bad
+happens if the system does not have the program in question. Arrange to
+ignore an error from that command, and print a message before the
+command to tell the user that failure of this command does not mean a
+problem. (The Autoconf 'AC_PROG_RANLIB' macro can help with this.)
If you use symbolic links, you should implement a fallback for
systems that don't have symbolic links.
@@ -3723,115 +3703,112 @@
options, and so on.
In particular, you should run most utility programs via variables.
-Thus, if you use Bison, have a variable named `BISON' whose default
-value is set with `BISON = bison', and refer to it with `$(BISON)'
+Thus, if you use Bison, have a variable named 'BISON' whose default
+value is set with 'BISON = bison', and refer to it with '$(BISON)'
whenever you need to use Bison.
- File management utilities such as `ln', `rm', `mv', and so on, need
-not be referred to through variables in this way, since users don't
-need to replace them with other programs.
+ File management utilities such as 'ln', 'rm', 'mv', and so on, need
+not be referred to through variables in this way, since users don't need
+to replace them with other programs.
Each program-name variable should come with an options variable that
-is used to supply options to the program. Append `FLAGS' to the
+is used to supply options to the program. Append 'FLAGS' to the
program-name variable name to get the options variable name--for
-example, `BISONFLAGS'. (The names `CFLAGS' for the C compiler,
-`YFLAGS' for yacc, and `LFLAGS' for lex, are exceptions to this rule,
-but we keep them because they are standard.) Use `CPPFLAGS' in any
-compilation command that runs the preprocessor, and use `LDFLAGS' in
-any compilation command that does linking as well as in any direct use
-of `ld'.
+example, 'BISONFLAGS'. (The names 'CFLAGS' for the C compiler, 'YFLAGS'
+for yacc, and 'LFLAGS' for lex, are exceptions to this rule, but we keep
+them because they are standard.) Use 'CPPFLAGS' in any compilation
+command that runs the preprocessor, and use 'LDFLAGS' in any compilation
+command that does linking as well as in any direct use of 'ld'.
If there are C compiler options that _must_ be used for proper
-compilation of certain files, do not include them in `CFLAGS'. Users
-expect to be able to specify `CFLAGS' freely themselves. Instead,
-arrange to pass the necessary options to the C compiler independently
-of `CFLAGS', by writing them explicitly in the compilation commands or
-by defining an implicit rule, like this:
+compilation of certain files, do not include them in 'CFLAGS'. Users
+expect to be able to specify 'CFLAGS' freely themselves. Instead,
+arrange to pass the necessary options to the C compiler independently of
+'CFLAGS', by writing them explicitly in the compilation commands or by
+defining an implicit rule, like this:
CFLAGS = -g
ALL_CFLAGS = -I. $(CFLAGS)
.c.o:
$(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
- Do include the `-g' option in `CFLAGS', because that is not
+ Do include the '-g' option in 'CFLAGS', because that is not
_required_ for proper compilation. You can consider it a default that
is only recommended. If the package is set up so that it is compiled
-with GCC by default, then you might as well include `-O' in the default
-value of `CFLAGS' as well.
+with GCC by default, then you might as well include '-O' in the default
+value of 'CFLAGS' as well.
- Put `CFLAGS' last in the compilation command, after other variables
-containing compiler options, so the user can use `CFLAGS' to override
+ Put 'CFLAGS' last in the compilation command, after other variables
+containing compiler options, so the user can use 'CFLAGS' to override
the others.
- `CFLAGS' should be used in every invocation of the C compiler, both
+ 'CFLAGS' should be used in every invocation of the C compiler, both
those which do compilation and those which do linking.
- Every Makefile should define the variable `INSTALL', which is the
+ Every Makefile should define the variable 'INSTALL', which is the
basic command for installing a file into the system.
- Every Makefile should also define the variables `INSTALL_PROGRAM'
-and `INSTALL_DATA'. (The default for `INSTALL_PROGRAM' should be
-`$(INSTALL)'; the default for `INSTALL_DATA' should be `${INSTALL} -m
+ Every Makefile should also define the variables 'INSTALL_PROGRAM' and
+'INSTALL_DATA'. (The default for 'INSTALL_PROGRAM' should be
+'$(INSTALL)'; the default for 'INSTALL_DATA' should be '${INSTALL} -m
644'.) Then it should use those variables as the commands for actual
-installation, for executables and non-executables respectively.
-Minimal use of these variables is as follows:
+installation, for executables and non-executables respectively. Minimal
+use of these variables is as follows:
$(INSTALL_PROGRAM) foo $(bindir)/foo
$(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
- However, it is preferable to support a `DESTDIR' prefix on the
-target files, as explained in the next section.
+ However, it is preferable to support a 'DESTDIR' prefix on the target
+files, as explained in the next section.
It is acceptable, but not required, to install multiple files in one
command, with the final argument being a directory, as in:
$(INSTALL_PROGRAM) foo bar baz $(bindir)
-7.2.4 `DESTDIR': Support for Staged Installs
+7.2.4 'DESTDIR': Support for Staged Installs
--------------------------------------------
-`DESTDIR' is a variable prepended to each installed target file, like
+'DESTDIR' is a variable prepended to each installed target file, like
this:
$(INSTALL_PROGRAM) foo $(DESTDIR)$(bindir)/foo
$(INSTALL_DATA) libfoo.a $(DESTDIR)$(libdir)/libfoo.a
- The `DESTDIR' variable is specified by the user on the `make'
-command line as an absolute file name. For example:
+ The 'DESTDIR' variable is specified by the user on the 'make' command
+line as an absolute file name. For example:
make DESTDIR=/tmp/stage install
-`DESTDIR' should be supported only in the `install*' and `uninstall*'
+'DESTDIR' should be supported only in the 'install*' and 'uninstall*'
targets, as those are the only targets where it is useful.
- If your installation step would normally install
-`/usr/local/bin/foo' and `/usr/local/lib/libfoo.a', then an
-installation invoked as in the example above would install
-`/tmp/stage/usr/local/bin/foo' and `/tmp/stage/usr/local/lib/libfoo.a'
-instead.
-
- Prepending the variable `DESTDIR' to each target in this way
-provides for "staged installs", where the installed files are not
-placed directly into their expected location but are instead copied
-into a temporary location (`DESTDIR'). However, installed files
-maintain their relative directory structure and any embedded file names
-will not be modified.
+ If your installation step would normally install '/usr/local/bin/foo'
+and '/usr/local/lib/libfoo.a', then an installation invoked as in the
+example above would install '/tmp/stage/usr/local/bin/foo' and
+'/tmp/stage/usr/local/lib/libfoo.a' instead.
+
+ Prepending the variable 'DESTDIR' to each target in this way provides
+for "staged installs", where the installed files are not placed directly
+into their expected location but are instead copied into a temporary
+location ('DESTDIR'). However, installed files maintain their relative
+directory structure and any embedded file names will not be modified.
- You should not set the value of `DESTDIR' in your `Makefile' at all;
+ You should not set the value of 'DESTDIR' in your 'Makefile' at all;
then the files are installed into their expected locations by default.
-Also, specifying `DESTDIR' should not change the operation of the
+Also, specifying 'DESTDIR' should not change the operation of the
software in any way, so its value should not be included in any file
contents.
- `DESTDIR' support is commonly used in package creation. It is also
+ 'DESTDIR' support is commonly used in package creation. It is also
helpful to users who want to understand what a given package will
-install where, and to allow users who don't normally have permissions
-to install into protected areas to build and install before gaining
-those permissions. Finally, it can be useful with tools such as
-`stow', where code is installed in one place but made to appear to be
-installed somewhere else using symbolic links or special mount
-operations. So, we strongly recommend GNU packages support `DESTDIR',
-though it is not an absolute requirement.
+install where, and to allow users who don't normally have permissions to
+install into protected areas to build and install before gaining those
+permissions. Finally, it can be useful with tools such as 'stow', where
+code is installed in one place but made to appear to be installed
+somewhere else using symbolic links or special mount operations. So, we
+strongly recommend GNU packages support 'DESTDIR', though it is not an
+absolute requirement.
7.2.5 Variables for Installation Directories
--------------------------------------------
@@ -3842,8 +3819,8 @@
below. They are based on a standard file system layout; variants of it
are used in GNU/Linux and other modern operating systems.
- Installers are expected to override these values when calling `make'
-(e.g., `make prefix=/usr install' or `configure' (e.g., `configure
+ Installers are expected to override these values when calling 'make'
+(e.g., 'make prefix=/usr install' or 'configure' (e.g., 'configure
--prefix=/usr'). GNU packages should not try to guess which value
should be appropriate for these variables on the system they are being
installed onto: use the default settings specified here so that all GNU
@@ -3858,58 +3835,58 @@
two, and nothing should be directly installed into these two
directories.
-`prefix'
+'prefix'
A prefix used in constructing the default values of the variables
- listed below. The default value of `prefix' should be
- `/usr/local'. When building the complete GNU system, the prefix
- will be empty and `/usr' will be a symbolic link to `/'. (If you
- are using Autoconf, write it as address@hidden@'.)
+ listed below. The default value of 'prefix' should be
+ '/usr/local'. When building the complete GNU system, the prefix
+ will be empty and '/usr' will be a symbolic link to '/'. (If you
+ are using Autoconf, write it as '@prefix@'.)
- Running `make install' with a different value of `prefix' from the
+ Running 'make install' with a different value of 'prefix' from the
one used to build the program should _not_ recompile the program.
-`exec_prefix'
+'exec_prefix'
A prefix used in constructing the default values of some of the
- variables listed below. The default value of `exec_prefix' should
- be `$(prefix)'. (If you are using Autoconf, write it as
- address@hidden@'.)
+ variables listed below. The default value of 'exec_prefix' should
+ be '$(prefix)'. (If you are using Autoconf, write it as
+ '@exec_prefix@'.)
- Generally, `$(exec_prefix)' is used for directories that contain
+ Generally, '$(exec_prefix)' is used for directories that contain
machine-specific files (such as executables and subroutine
- libraries), while `$(prefix)' is used directly for other
+ libraries), while '$(prefix)' is used directly for other
directories.
- Running `make install' with a different value of `exec_prefix'
- from the one used to build the program should _not_ recompile the
+ Running 'make install' with a different value of 'exec_prefix' from
+ the one used to build the program should _not_ recompile the
program.
Executable programs are installed in one of the following
directories.
-`bindir'
+'bindir'
The directory for installing executable programs that users can
- run. This should normally be `/usr/local/bin', but write it as
- `$(exec_prefix)/bin'. (If you are using Autoconf, write it as
- address@hidden@'.)
+ run. This should normally be '/usr/local/bin', but write it as
+ '$(exec_prefix)/bin'. (If you are using Autoconf, write it as
+ '@bindir@'.)
-`sbindir'
+'sbindir'
The directory for installing executable programs that can be run
from the shell, but are only generally useful to system
- administrators. This should normally be `/usr/local/sbin', but
- write it as `$(exec_prefix)/sbin'. (If you are using Autoconf,
- write it as address@hidden@'.)
+ administrators. This should normally be '/usr/local/sbin', but
+ write it as '$(exec_prefix)/sbin'. (If you are using Autoconf,
+ write it as '@sbindir@'.)
-`libexecdir'
+'libexecdir'
The directory for installing executable programs to be run by other
programs rather than by users. This directory should normally be
- `/usr/local/libexec', but write it as `$(exec_prefix)/libexec'.
- (If you are using Autoconf, write it as address@hidden@'.)
+ '/usr/local/libexec', but write it as '$(exec_prefix)/libexec'.
+ (If you are using Autoconf, write it as '@libexecdir@'.)
- The definition of `libexecdir' is the same for all packages, so
- you should install your data in a subdirectory thereof. Most
- packages install their data under `$(libexecdir)/PACKAGE-NAME/',
- possibly within additional subdirectories thereof, such as
- `$(libexecdir)/PACKAGE-NAME/MACHINE/VERSION'.
+ The definition of 'libexecdir' is the same for all packages, so you
+ should install your data in a subdirectory thereof. Most packages
+ install their data under '$(libexecdir)/PACKAGE-NAME/', possibly
+ within additional subdirectories thereof, such as
+ '$(libexecdir)/PACKAGE-NAME/MACHINE/VERSION'.
Data files used by the program during its execution are divided into
categories in two ways.
@@ -3927,199 +3904,195 @@
files and libraries. It is much cleaner to make other data files
architecture-independent, and it is generally not hard.
- Here are the variables Makefiles should use to specify directories
-to put these various kinds of files in:
+ Here are the variables Makefiles should use to specify directories to
+put these various kinds of files in:
-`datarootdir'
+'datarootdir'
The root of the directory tree for read-only
architecture-independent data files. This should normally be
- `/usr/local/share', but write it as `$(prefix)/share'. (If you
- are using Autoconf, write it as address@hidden@'.) `datadir''s
- default value is based on this variable; so are `infodir',
- `mandir', and others.
+ '/usr/local/share', but write it as '$(prefix)/share'. (If you are
+ using Autoconf, write it as '@datarootdir@'.) 'datadir''s default
+ value is based on this variable; so are 'infodir', 'mandir', and
+ others.
-`datadir'
+'datadir'
The directory for installing idiosyncratic read-only
architecture-independent data files for this program. This is
- usually the same place as `datarootdir', but we use the two
+ usually the same place as 'datarootdir', but we use the two
separate variables so that you can move these program-specific
files without altering the location for Info files, man pages, etc.
- This should normally be `/usr/local/share', but write it as
- `$(datarootdir)'. (If you are using Autoconf, write it as
- address@hidden@'.)
+ This should normally be '/usr/local/share', but write it as
+ '$(datarootdir)'. (If you are using Autoconf, write it as
+ '@datadir@'.)
- The definition of `datadir' is the same for all packages, so you
+ The definition of 'datadir' is the same for all packages, so you
should install your data in a subdirectory thereof. Most packages
- install their data under `$(datadir)/PACKAGE-NAME/'.
+ install their data under '$(datadir)/PACKAGE-NAME/'.
-`sysconfdir'
+'sysconfdir'
The directory for installing read-only data files that pertain to a
single machine-that is to say, files for configuring a host.
- Mailer and network configuration files, `/etc/passwd', and so
- forth belong here. All the files in this directory should be
- ordinary ASCII text files. This directory should normally be
- `/usr/local/etc', but write it as `$(prefix)/etc'. (If you are
- using Autoconf, write it as address@hidden@'.)
+ Mailer and network configuration files, '/etc/passwd', and so forth
+ belong here. All the files in this directory should be ordinary
+ ASCII text files. This directory should normally be
+ '/usr/local/etc', but write it as '$(prefix)/etc'. (If you are
+ using Autoconf, write it as '@sysconfdir@'.)
Do not install executables here in this directory (they probably
- belong in `$(libexecdir)' or `$(sbindir)'). Also do not install
+ belong in '$(libexecdir)' or '$(sbindir)'). Also do not install
files that are modified in the normal course of their use (programs
whose purpose is to change the configuration of the system
- excluded). Those probably belong in `$(localstatedir)'.
+ excluded). Those probably belong in '$(localstatedir)'.
-`sharedstatedir'
+'sharedstatedir'
The directory for installing architecture-independent data files
which the programs modify while they run. This should normally be
- `/usr/local/com', but write it as `$(prefix)/com'. (If you are
- using Autoconf, write it as address@hidden@'.)
+ '/usr/local/com', but write it as '$(prefix)/com'. (If you are
+ using Autoconf, write it as '@sharedstatedir@'.)
-`localstatedir'
+'localstatedir'
The directory for installing data files which the programs modify
while they run, and that pertain to one specific machine. Users
should never need to modify files in this directory to configure
the package's operation; put such configuration information in
- separate files that go in `$(datadir)' or `$(sysconfdir)'.
- `$(localstatedir)' should normally be `/usr/local/var', but write
- it as `$(prefix)/var'. (If you are using Autoconf, write it as
- address@hidden@'.)
+ separate files that go in '$(datadir)' or '$(sysconfdir)'.
+ '$(localstatedir)' should normally be '/usr/local/var', but write
+ it as '$(prefix)/var'. (If you are using Autoconf, write it as
+ '@localstatedir@'.)
These variables specify the directory for installing certain specific
-types of files, if your program has them. Every GNU package should
-have Info files, so every program needs `infodir', but not all need
-`libdir' or `lispdir'.
+types of files, if your program has them. Every GNU package should have
+Info files, so every program needs 'infodir', but not all need 'libdir'
+or 'lispdir'.
-`includedir'
+'includedir'
The directory for installing header files to be included by user
- programs with the C `#include' preprocessor directive. This
- should normally be `/usr/local/include', but write it as
- `$(prefix)/include'. (If you are using Autoconf, write it as
- address@hidden@'.)
+ programs with the C '#include' preprocessor directive. This should
+ normally be '/usr/local/include', but write it as
+ '$(prefix)/include'. (If you are using Autoconf, write it as
+ '@includedir@'.)
Most compilers other than GCC do not look for header files in
- directory `/usr/local/include'. So installing the header files
+ directory '/usr/local/include'. So installing the header files
this way is only useful with GCC. Sometimes this is not a problem
because some libraries are only really intended to work with GCC.
- But some libraries are intended to work with other compilers.
- They should install their header files in two places, one
- specified by `includedir' and one specified by `oldincludedir'.
-
-`oldincludedir'
- The directory for installing `#include' header files for use with
- compilers other than GCC. This should normally be `/usr/include'.
- (If you are using Autoconf, you can write it as address@hidden@'.)
+ But some libraries are intended to work with other compilers. They
+ should install their header files in two places, one specified by
+ 'includedir' and one specified by 'oldincludedir'.
+
+'oldincludedir'
+ The directory for installing '#include' header files for use with
+ compilers other than GCC. This should normally be '/usr/include'.
+ (If you are using Autoconf, you can write it as '@oldincludedir@'.)
The Makefile commands should check whether the value of
- `oldincludedir' is empty. If it is, they should not try to use
- it; they should cancel the second installation of the header files.
+ 'oldincludedir' is empty. If it is, they should not try to use it;
+ they should cancel the second installation of the header files.
A package should not replace an existing header in this directory
unless the header came from the same package. Thus, if your Foo
- package provides a header file `foo.h', then it should install the
- header file in the `oldincludedir' directory if either (1) there
- is no `foo.h' there or (2) the `foo.h' that exists came from the
- Foo package.
+ package provides a header file 'foo.h', then it should install the
+ header file in the 'oldincludedir' directory if either (1) there is
+ no 'foo.h' there or (2) the 'foo.h' that exists came from the Foo
+ package.
- To tell whether `foo.h' came from the Foo package, put a magic
- string in the file--part of a comment--and `grep' for that string.
+ To tell whether 'foo.h' came from the Foo package, put a magic
+ string in the file--part of a comment--and 'grep' for that string.
-`docdir'
+'docdir'
The directory for installing documentation files (other than Info)
for this package. By default, it should be
- `/usr/local/share/doc/YOURPKG', but it should be written as
- `$(datarootdir)/doc/YOURPKG'. (If you are using Autoconf, write
- it as address@hidden@'.) The YOURPKG subdirectory, which may include a
+ '/usr/local/share/doc/YOURPKG', but it should be written as
+ '$(datarootdir)/doc/YOURPKG'. (If you are using Autoconf, write it
+ as '@docdir@'.) The YOURPKG subdirectory, which may include a
version number, prevents collisions among files with common names,
- such as `README'.
+ such as 'README'.
-`infodir'
+'infodir'
The directory for installing the Info files for this package. By
- default, it should be `/usr/local/share/info', but it should be
- written as `$(datarootdir)/info'. (If you are using Autoconf,
- write it as address@hidden@'.) `infodir' is separate from `docdir' for
+ default, it should be '/usr/local/share/info', but it should be
+ written as '$(datarootdir)/info'. (If you are using Autoconf,
+ write it as '@infodir@'.) 'infodir' is separate from 'docdir' for
compatibility with existing practice.
-`htmldir'
-`dvidir'
-`pdfdir'
-`psdir'
+'htmldir'
+'dvidir'
+'pdfdir'
+'psdir'
Directories for installing documentation files in the particular
- format. They should all be set to `$(docdir)' by default. (If
- you are using Autoconf, write them as address@hidden@', address@hidden@',
- etc.) Packages which supply several translations of their
- documentation should install them in `$(htmldir)/'LL,
- `$(pdfdir)/'LL, etc. where LL is a locale abbreviation such as
- `en' or `pt_BR'.
+ format. They should all be set to '$(docdir)' by default. (If you
+ are using Autoconf, write them as '@htmldir@', '@dvidir@', etc.)
+ Packages which supply several translations of their documentation
+ should install them in '$(htmldir)/'LL, '$(pdfdir)/'LL, etc. where
+ LL is a locale abbreviation such as 'en' or 'pt_BR'.
-`libdir'
+'libdir'
The directory for object files and libraries of object code. Do
not install executables here, they probably ought to go in
- `$(libexecdir)' instead. The value of `libdir' should normally be
- `/usr/local/lib', but write it as `$(exec_prefix)/lib'. (If you
- are using Autoconf, write it as address@hidden@'.)
+ '$(libexecdir)' instead. The value of 'libdir' should normally be
+ '/usr/local/lib', but write it as '$(exec_prefix)/lib'. (If you
+ are using Autoconf, write it as '@libdir@'.)
-`lispdir'
+'lispdir'
The directory for installing any Emacs Lisp files in this package.
- By default, it should be `/usr/local/share/emacs/site-lisp', but it
- should be written as `$(datarootdir)/emacs/site-lisp'.
+ By default, it should be '/usr/local/share/emacs/site-lisp', but it
+ should be written as '$(datarootdir)/emacs/site-lisp'.
- If you are using Autoconf, write the default as address@hidden@'. In
- order to make address@hidden@' work, you need the following lines in
- your `configure.in' file:
+ If you are using Autoconf, write the default as '@lispdir@'. In
+ order to make '@lispdir@' work, you need the following lines in
+ your 'configure.in' file:
lispdir='${datarootdir}/emacs/site-lisp'
AC_SUBST(lispdir)
-`localedir'
+'localedir'
The directory for installing locale-specific message catalogs for
- this package. By default, it should be `/usr/local/share/locale',
- but it should be written as `$(datarootdir)/locale'. (If you are
- using Autoconf, write it as address@hidden@'.) This directory
- usually has a subdirectory per locale.
+ this package. By default, it should be '/usr/local/share/locale',
+ but it should be written as '$(datarootdir)/locale'. (If you are
+ using Autoconf, write it as '@localedir@'.) This directory usually
+ has a subdirectory per locale.
Unix-style man pages are installed in one of the following:
-`mandir'
+'mandir'
The top-level directory for installing the man pages (if any) for
- this package. It will normally be `/usr/local/share/man', but you
- should write it as `$(datarootdir)/man'. (If you are using
- Autoconf, write it as address@hidden@'.)
+ this package. It will normally be '/usr/local/share/man', but you
+ should write it as '$(datarootdir)/man'. (If you are using
+ Autoconf, write it as '@mandir@'.)
-`man1dir'
+'man1dir'
The directory for installing section 1 man pages. Write it as
- `$(mandir)/man1'.
-
-`man2dir'
+ '$(mandir)/man1'.
+'man2dir'
The directory for installing section 2 man pages. Write it as
- `$(mandir)/man2'
+ '$(mandir)/man2'
+'...'
-`...'
- *Don't make the primary documentation for any GNU software be a
- man page. Write a manual in Texinfo instead. Man pages are just
- for the sake of people running GNU software on Unix, which is a
+ *Don't make the primary documentation for any GNU software be a man
+ page. Write a manual in Texinfo instead. Man pages are just for
+ the sake of people running GNU software on Unix, which is a
secondary application only.*
-`manext'
+'manext'
The file name extension for the installed man page. This should
contain a period followed by the appropriate digit; it should
- normally be `.1'.
+ normally be '.1'.
-`man1ext'
+'man1ext'
The file name extension for installed section 1 man pages.
-
-`man2ext'
+'man2ext'
The file name extension for installed section 2 man pages.
-
-`...'
- Use these names instead of `manext' if the package needs to
- install man pages in more than one section of the manual.
+'...'
+ Use these names instead of 'manext' if the package needs to install
+ man pages in more than one section of the manual.
And finally, you should set the following variable:
-`srcdir'
+'srcdir'
The directory for the sources being compiled. The value of this
- variable is normally inserted by the `configure' shell script.
- (If you are using Autoconf, use `srcdir = @srcdir@'.)
+ variable is normally inserted by the 'configure' shell script. (If
+ you are using Autoconf, use 'srcdir = @srcdir@'.)
For example:
@@ -4139,7 +4112,7 @@
If your program installs a large number of files into one of the
standard user-specified directories, it might be useful to group them
into a subdirectory particular to that program. If you do this, you
-should write the `install' rule to create these subdirectories.
+should write the 'install' rule to create these subdirectories.
Do not expect the user to include the subdirectory name in the value
of any of the variables listed above. The idea of having a uniform set
@@ -4161,19 +4134,19 @@
All GNU programs should have the following targets in their Makefiles:
-`all'
+'all'
Compile the entire program. This should be the default target.
This target need not rebuild any documentation files; Info files
should normally be included in the distribution, and DVI (and other
documentation format) files should be made only when explicitly
asked for.
- By default, the Make rules should compile and link with `-g', so
+ By default, the Make rules should compile and link with '-g', so
that executable programs have debugging symbols. Otherwise, you
are essentially helpless in the face of a crash, and it is often
far from easy to reproduce with a fresh build.
-`install'
+'install'
Compile the program and copy the executables, libraries, and so on
to the file names where they should reside for actual use. If
there is a simple test to verify that a program is properly
@@ -4183,34 +4156,34 @@
debugging that may be needed later, and nowadays disk space is
cheap and dynamic loaders typically ensure debug sections are not
loaded during normal execution. Users that need stripped binaries
- may invoke the `install-strip' target to do that.
+ may invoke the 'install-strip' target to do that.
- If possible, write the `install' target rule so that it does not
+ If possible, write the 'install' target rule so that it does not
modify anything in the directory where the program was built,
- provided `make all' has just been done. This is convenient for
+ provided 'make all' has just been done. This is convenient for
building the program under one user name and installing it under
another.
The commands should create all the directories in which files are
to be installed, if they don't already exist. This includes the
- directories specified as the values of the variables `prefix' and
- `exec_prefix', as well as all subdirectories that are needed. One
- way to do this is by means of an `installdirs' target as described
+ directories specified as the values of the variables 'prefix' and
+ 'exec_prefix', as well as all subdirectories that are needed. One
+ way to do this is by means of an 'installdirs' target as described
below.
- Use `-' before any command for installing a man page, so that
- `make' will ignore any errors. This is in case there are systems
+ Use '-' before any command for installing a man page, so that
+ 'make' will ignore any errors. This is in case there are systems
that don't have the Unix man page documentation system installed.
- The way to install Info files is to copy them into `$(infodir)'
- with `$(INSTALL_DATA)' (*note Command Variables::), and then run
- the `install-info' program if it is present. `install-info' is a
- program that edits the Info `dir' file to add or update the menu
+ The way to install Info files is to copy them into '$(infodir)'
+ with '$(INSTALL_DATA)' (*note Command Variables::), and then run
+ the 'install-info' program if it is present. 'install-info' is a
+ program that edits the Info 'dir' file to add or update the menu
entry for the given Info file; it is part of the Texinfo package.
Here is a sample rule to install an Info file that also tries to
- handle some additional situations, such as `install-info' not
- being present.
+ handle some additional situations, such as 'install-info' not being
+ present.
do-install-info: foo.info installdirs
$(NORMAL_INSTALL)
@@ -4231,47 +4204,47 @@
"$(DESTDIR)$(infodir)/foo.info"; \
else true; fi
- When writing the `install' target, you must classify all the
+ When writing the 'install' target, you must classify all the
commands into three categories: normal ones, "pre-installation"
commands and "post-installation" commands. *Note Install Command
Categories::.
-`install-html'
-`install-dvi'
-`install-pdf'
-`install-ps'
+'install-html'
+'install-dvi'
+'install-pdf'
+'install-ps'
These targets install documentation in formats other than Info;
they're intended to be called explicitly by the person installing
- the package, if that format is desired. GNU prefers Info files,
- so these must be installed by the `install' target.
+ the package, if that format is desired. GNU prefers Info files, so
+ these must be installed by the 'install' target.
When you have many documentation files to install, we recommend
that you avoid collisions and clutter by arranging for these
targets to install in subdirectories of the appropriate
- installation directory, such as `htmldir'. As one example, if
- your package has multiple manuals, and you wish to install HTML
+ installation directory, such as 'htmldir'. As one example, if your
+ package has multiple manuals, and you wish to install HTML
documentation with many files (such as the "split" mode output by
- `makeinfo --html'), you'll certainly want to use subdirectories,
- or two nodes with the same name in different manuals will
- overwrite each other.
+ 'makeinfo --html'), you'll certainly want to use subdirectories, or
+ two nodes with the same name in different manuals will overwrite
+ each other.
- Please make these `install-FORMAT' targets invoke the commands for
+ Please make these 'install-FORMAT' targets invoke the commands for
the FORMAT target, for example, by making FORMAT a dependency.
-`uninstall'
- Delete all the installed files--the copies that the `install' and
- `install-*' targets create.
+'uninstall'
+ Delete all the installed files--the copies that the 'install' and
+ 'install-*' targets create.
This rule should not modify the directories where compilation is
done, only the directories where files are installed.
- The uninstallation commands are divided into three categories,
- just like the installation commands. *Note Install Command
+ The uninstallation commands are divided into three categories, just
+ like the installation commands. *Note Install Command
Categories::.
-`install-strip'
- Like `install', but strip the executable files while installing
- them. In simple cases, this target can use the `install' target in
+'install-strip'
+ Like 'install', but strip the executable files while installing
+ them. In simple cases, this target can use the 'install' target in
a simple way:
install-strip:
@@ -4279,105 +4252,105 @@
install
But if the package installs scripts as well as real executables,
- the `install-strip' target can't just refer to the `install'
+ the 'install-strip' target can't just refer to the 'install'
target; it has to strip the executables but not the scripts.
- `install-strip' should not strip the executables in the build
+ 'install-strip' should not strip the executables in the build
directory which are being copied for installation. It should only
strip the copies that are installed.
- Normally we do not recommend stripping an executable unless you
- are sure the program has no bugs. However, it can be reasonable
- to install a stripped executable for actual execution while saving
- the unstripped executable elsewhere in case there is a bug.
-
-`clean'
- Delete all files in the current directory that are normally
- created by building the program. Also delete files in other
- directories if they are created by this makefile. However, don't
- delete the files that record the configuration. Also preserve
- files that could be made by building, but normally aren't because
- the distribution comes with them. There is no need to delete
- parent directories that were created with `mkdir -p', since they
- could have existed anyway.
+ Normally we do not recommend stripping an executable unless you are
+ sure the program has no bugs. However, it can be reasonable to
+ install a stripped executable for actual execution while saving the
+ unstripped executable elsewhere in case there is a bug.
+
+'clean'
+ Delete all files in the current directory that are normally created
+ by building the program. Also delete files in other directories if
+ they are created by this makefile. However, don't delete the files
+ that record the configuration. Also preserve files that could be
+ made by building, but normally aren't because the distribution
+ comes with them. There is no need to delete parent directories
+ that were created with 'mkdir -p', since they could have existed
+ anyway.
- Delete `.dvi' files here if they are not part of the distribution.
+ Delete '.dvi' files here if they are not part of the distribution.
-`distclean'
+'distclean'
Delete all files in the current directory (or created by this
makefile) that are created by configuring or building the program.
If you have unpacked the source and built the program without
- creating any other files, `make distclean' should leave only the
+ creating any other files, 'make distclean' should leave only the
files that were in the distribution. However, there is no need to
- delete parent directories that were created with `mkdir -p', since
+ delete parent directories that were created with 'mkdir -p', since
they could have existed anyway.
-`mostlyclean'
- Like `clean', but may refrain from deleting a few files that people
- normally don't want to recompile. For example, the `mostlyclean'
- target for GCC does not delete `libgcc.a', because recompiling it
+'mostlyclean'
+ Like 'clean', but may refrain from deleting a few files that people
+ normally don't want to recompile. For example, the 'mostlyclean'
+ target for GCC does not delete 'libgcc.a', because recompiling it
is rarely necessary and takes a lot of time.
-`maintainer-clean'
+'maintainer-clean'
Delete almost everything that can be reconstructed with this
Makefile. This typically includes everything deleted by
- `distclean', plus more: C source files produced by Bison, tags
+ 'distclean', plus more: C source files produced by Bison, tags
tables, Info files, and so on.
The reason we say "almost everything" is that running the command
- `make maintainer-clean' should not delete `configure' even if
- `configure' can be remade using a rule in the Makefile. More
- generally, `make maintainer-clean' should not delete anything that
- needs to exist in order to run `configure' and then begin to build
+ 'make maintainer-clean' should not delete 'configure' even if
+ 'configure' can be remade using a rule in the Makefile. More
+ generally, 'make maintainer-clean' should not delete anything that
+ needs to exist in order to run 'configure' and then begin to build
the program. Also, there is no need to delete parent directories
- that were created with `mkdir -p', since they could have existed
- anyway. These are the only exceptions; `maintainer-clean' should
+ that were created with 'mkdir -p', since they could have existed
+ anyway. These are the only exceptions; 'maintainer-clean' should
delete everything else that can be rebuilt.
- The `maintainer-clean' target is intended to be used by a
+ The 'maintainer-clean' target is intended to be used by a
maintainer of the package, not by ordinary users. You may need
- special tools to reconstruct some of the files that `make
- maintainer-clean' deletes. Since these files are normally
- included in the distribution, we don't take care to make them easy
- to reconstruct. If you find you need to unpack the full
- distribution again, don't blame us.
+ special tools to reconstruct some of the files that 'make
+ maintainer-clean' deletes. Since these files are normally included
+ in the distribution, we don't take care to make them easy to
+ reconstruct. If you find you need to unpack the full distribution
+ again, don't blame us.
To help make users aware of this, the commands for the special
- `maintainer-clean' target should start with these two:
+ 'maintainer-clean' target should start with these two:
@echo 'This command is intended for maintainers to use; it'
@echo 'deletes files that may need special tools to rebuild.'
-`TAGS'
+'TAGS'
Update a tags table for this program.
-`info'
- Generate any Info files needed. The best way to write the rules
- is as follows:
+'info'
+ Generate any Info files needed. The best way to write the rules is
+ as follows:
info: foo.info
foo.info: foo.texi chap1.texi chap2.texi
$(MAKEINFO) $(srcdir)/foo.texi
- You must define the variable `MAKEINFO' in the Makefile. It should
- run the `makeinfo' program, which is part of the Texinfo
+ You must define the variable 'MAKEINFO' in the Makefile. It should
+ run the 'makeinfo' program, which is part of the Texinfo
distribution.
Normally a GNU distribution comes with Info files, and that means
- the Info files are present in the source directory. Therefore,
- the Make rule for an info file should update it in the source
+ the Info files are present in the source directory. Therefore, the
+ Make rule for an info file should update it in the source
directory. When users build the package, ordinarily Make will not
update the Info files because they will already be up to date.
-`dvi'
-`html'
-`pdf'
-`ps'
+'dvi'
+'html'
+'pdf'
+'ps'
Generate documentation files in the given format. These targets
should always exist, but any or all can be a no-op if the given
output format cannot be generated. These targets should not be
- dependencies of the `all' target; the user must manually invoke
+ dependencies of the 'all' target; the user must manually invoke
them.
Here's an example rule for generating DVI files from Texinfo:
@@ -4387,11 +4360,11 @@
foo.dvi: foo.texi chap1.texi chap2.texi
$(TEXI2DVI) $(srcdir)/foo.texi
- You must define the variable `TEXI2DVI' in the Makefile. It
- should run the program `texi2dvi', which is part of the Texinfo
- distribution. (`texi2dvi' uses TeX to do the real work of
+ You must define the variable 'TEXI2DVI' in the Makefile. It should
+ run the program 'texi2dvi', which is part of the Texinfo
+ distribution. ('texi2dvi' uses TeX to do the real work of
formatting. TeX is not distributed with Texinfo.) Alternatively,
- write only the dependencies, and allow GNU `make' to provide the
+ write only the dependencies, and allow GNU 'make' to provide the
command.
Here's another example, this one for generating HTML from Texinfo:
@@ -4401,32 +4374,32 @@
foo.html: foo.texi chap1.texi chap2.texi
$(TEXI2HTML) $(srcdir)/foo.texi
- Again, you would define the variable `TEXI2HTML' in the Makefile;
- for example, it might run `makeinfo --no-split --html' (`makeinfo'
+ Again, you would define the variable 'TEXI2HTML' in the Makefile;
+ for example, it might run 'makeinfo --no-split --html' ('makeinfo'
is part of the Texinfo distribution).
-`dist'
+'dist'
Create a distribution tar file for this program. The tar file
should be set up so that the file names in the tar file start with
a subdirectory name which is the name of the package it is a
distribution for. This name can include the version number.
For example, the distribution tar file of GCC version 1.40 unpacks
- into a subdirectory named `gcc-1.40'.
+ into a subdirectory named 'gcc-1.40'.
The easiest way to do this is to create a subdirectory
- appropriately named, use `ln' or `cp' to install the proper files
- in it, and then `tar' that subdirectory.
+ appropriately named, use 'ln' or 'cp' to install the proper files
+ in it, and then 'tar' that subdirectory.
- Compress the tar file with `gzip'. For example, the actual
- distribution file for GCC version 1.40 is called `gcc-1.40.tar.gz'.
+ Compress the tar file with 'gzip'. For example, the actual
+ distribution file for GCC version 1.40 is called 'gcc-1.40.tar.gz'.
It is ok to support other free compression formats as well.
- The `dist' target should explicitly depend on all non-source files
+ The 'dist' target should explicitly depend on all non-source files
that are in the distribution, to make sure they are up to date in
the distribution. *Note Making Releases: Releases.
-`check'
+'check'
Perform self-tests (if any). The user must build the program
before running the tests, but need not install the program; you
should write the self-tests so that they work when the program is
@@ -4435,15 +4408,15 @@
The following targets are suggested as conventional names, for
programs in which they are useful.
-`installcheck'
+'installcheck'
Perform installation tests (if any). The user must build and
install the program before running the tests. You should not
- assume that `$(bindir)' is in the search path.
+ assume that '$(bindir)' is in the search path.
-`installdirs'
- It's useful to add a target named `installdirs' to create the
+'installdirs'
+ It's useful to add a target named 'installdirs' to create the
directories where files are installed, and their parent
- directories. There is a script called `mkinstalldirs' which is
+ directories. There is a script called 'mkinstalldirs' which is
convenient for this; you can find it in the Gnulib package. You
can use a rule like this:
@@ -4454,7 +4427,7 @@
$(libdir) $(infodir) \
$(mandir)
- or, if you wish to support `DESTDIR' (strongly encouraged),
+ or, if you wish to support 'DESTDIR' (strongly encouraged),
# Make sure all installation directories (e.g. $(bindir))
# actually exist by making them if necessary.
@@ -4470,7 +4443,7 @@
7.2.7 Install Command Categories
--------------------------------
-When writing the `install' target, you must classify all the commands
+When writing the 'install' target, you must classify all the commands
into three categories: normal ones, "pre-installation" commands and
"post-installation" commands.
@@ -4487,7 +4460,7 @@
normal commands.
The most common use for a post-installation command is to run
-`install-info'. This cannot be done with a normal command, since it
+'install-info'. This cannot be done with a normal command, since it
alters a file (the Info directory) which does not come entirely and
solely from the package being installed. It is a post-installation
command because it needs to be done after the normal command which
@@ -4496,7 +4469,7 @@
Most programs don't need any pre-installation commands, but we have
the feature just in case it is needed.
- To classify the commands in the `install' rule into these three
+ To classify the commands in the 'install' rule into these three
categories, insert "category lines" among them. A category line
specifies the category for the commands that follow.
@@ -4514,12 +4487,12 @@
$(POST_INSTALL) # Post-install commands follow.
$(NORMAL_INSTALL) # Normal commands follow.
- If you don't use a category line at the beginning of the `install'
+ If you don't use a category line at the beginning of the 'install'
rule, all the commands are classified as normal until the first category
line. If you don't use any category lines, all the commands are
classified as normal.
- These are the category lines for `uninstall':
+ These are the category lines for 'uninstall':
$(PRE_UNINSTALL) # Pre-uninstall commands follow.
$(POST_UNINSTALL) # Post-uninstall commands follow.
@@ -4528,8 +4501,8 @@
Typically, a pre-uninstall command would be used for deleting entries
from the Info directory.
- If the `install' or `uninstall' target has any dependencies which
-act as subroutines of installation, then you should start _each_
+ If the 'install' or 'uninstall' target has any dependencies which act
+as subroutines of installation, then you should start _each_
dependency's commands with a category line, and start the main target's
commands with a category line also. This way, you can ensure that each
command is placed in the right category regardless of which of the
@@ -4545,15 +4518,15 @@
test touch true uname xargs yes
The reason for distinguishing the commands in this way is for the
-sake of making binary packages. Typically a binary package contains
-all the executables and other files that need to be installed, and has
-its own method of installing them--so it does not need to run the normal
+sake of making binary packages. Typically a binary package contains all
+the executables and other files that need to be installed, and has its
+own method of installing them--so it does not need to run the normal
installation commands. But installing the binary package does need to
execute the pre-installation and post-installation commands.
Programs to build binary packages work by extracting the
pre-installation and post-installation commands. Here is one way of
-extracting the pre-installation commands (the `-s' option to `make' is
+extracting the pre-installation commands (the '-s' option to 'make' is
needed to silence messages about entering subdirectories):
make -s -n install -o all \
@@ -4562,7 +4535,7 @@
NORMAL_INSTALL=normal-install \
| gawk -f pre-install.awk
-where the file `pre-install.awk' could contain this:
+where the file 'pre-install.awk' could contain this:
$0 ~ /^(normal-install|post-install)[ \t]*$/ {on = 0}
on {print $0}
@@ -4571,43 +4544,43 @@
7.3 Making Releases
===================
-You should identify each release with a pair of version numbers, a
-major version and a minor. We have no objection to using more than two
+You should identify each release with a pair of version numbers, a major
+version and a minor. We have no objection to using more than two
numbers, but it is very unlikely that you really need them.
- Package the distribution of `Foo version 69.96' up in a gzipped tar
-file with the name `foo-69.96.tar.gz'. It should unpack into a
-subdirectory named `foo-69.96'.
+ Package the distribution of 'Foo version 69.96' up in a gzipped tar
+file with the name 'foo-69.96.tar.gz'. It should unpack into a
+subdirectory named 'foo-69.96'.
Building and installing the program should never modify any of the
-files contained in the distribution. This means that all the files
-that form part of the program in any way must be classified into "source
+files contained in the distribution. This means that all the files that
+form part of the program in any way must be classified into "source
files" and "non-source files". Source files are written by humans and
never changed automatically; non-source files are produced from source
files by programs under the control of the Makefile.
- The distribution should contain a file named `README' which gives
-the name of the package, and a general description of what it does. It
-is also good to explain the purpose of each of the first-level
-subdirectories in the package, if there are any. The `README' file
+ The distribution should contain a file named 'README' which gives the
+name of the package, and a general description of what it does. It is
+also good to explain the purpose of each of the first-level
+subdirectories in the package, if there are any. The 'README' file
should either state the version number of the package, or refer to where
in the package it can be found.
- The `README' file should refer to the file `INSTALL', which should
+ The 'README' file should refer to the file 'INSTALL', which should
contain an explanation of the installation procedure.
- The `README' file should also refer to the file which contains the
+ The 'README' file should also refer to the file which contains the
copying conditions. The GNU GPL, if used, should be in a file called
-`COPYING'. If the GNU LGPL is used, it should be in a file called
-`COPYING.LESSER'.
+'COPYING'. If the GNU LGPL is used, it should be in a file called
+'COPYING.LESSER'.
Naturally, all the source files must be in the distribution. It is
okay to include non-source files in the distribution along with the
source files they are generated from, provided they are up-to-date with
the source they are made from, and machine-independent, so that normal
building of the distribution will never modify them. We commonly
-include non-source files produced by Autoconf, Automake, Bison, `lex',
-TeX, and `makeinfo'; this helps avoid unnecessary dependencies between
+include non-source files produced by Autoconf, Automake, Bison, 'lex',
+TeX, and 'makeinfo'; this helps avoid unnecessary dependencies between
our distributions, so that users can install whichever packages they
want to install.
@@ -4617,11 +4590,11 @@
to date when you make a new distribution.
Make sure that all the files in the distribution are world-readable,
-and that directories are world-readable and world-searchable (octal
-mode 755). We used to recommend that all directories in the
-distribution also be world-writable (octal mode 777), because ancient
-versions of `tar' would otherwise not cope when extracting the archive
-as an unprivileged user. That can easily lead to security issues when
+and that directories are world-readable and world-searchable (octal mode
+755). We used to recommend that all directories in the distribution
+also be world-writable (octal mode 777), because ancient versions of
+'tar' would otherwise not cope when extracting the archive as an
+unprivileged user. That can easily lead to security issues when
creating the archive, however, so now we recommend against that.
Don't include any symbolic links in the distribution itself. If the
@@ -4633,12 +4606,12 @@
Try to make sure that all the file names will be unique on MS-DOS. A
name on MS-DOS consists of up to 8 characters, optionally followed by a
period and up to three characters. MS-DOS will truncate extra
-characters both before and after the period. Thus, `foobarhacker.c'
-and `foobarhacker.o' are not ambiguous; they are truncated to
-`foobarha.c' and `foobarha.o', which are distinct.
+characters both before and after the period. Thus, 'foobarhacker.c' and
+'foobarhacker.o' are not ambiguous; they are truncated to 'foobarha.c'
+and 'foobarha.o', which are distinct.
- Include in your distribution a copy of the `texinfo.tex' you used to
-test print any `*.texinfo' or `*.texi' files.
+ Include in your distribution a copy of the 'texinfo.tex' you used to
+test print any '*.texinfo' or '*.texi' files.
Likewise, if your program uses small GNU software packages like
regex, getopt, obstack, or termcap, include them in the distribution
@@ -4651,28 +4624,28 @@
A GNU program should not recommend, promote, or grant legitimacy to the
use of any non-free program. Proprietary software is a social and
-ethical problem, and our aim is to put an end to that problem. We
-can't stop some people from writing proprietary programs, or stop other
-people from using them, but we can and should refuse to advertise them
-to new potential customers, or to give the public the idea that their
-existence is ethical.
+ethical problem, and our aim is to put an end to that problem. We can't
+stop some people from writing proprietary programs, or stop other people
+from using them, but we can and should refuse to advertise them to new
+potential customers, or to give the public the idea that their existence
+is ethical.
The GNU definition of free software is found on the GNU web site at
-`http://www.gnu.org/philosophy/free-sw.html', and the definition of
-free documentation is found at
-`http://www.gnu.org/philosophy/free-doc.html'. The terms "free" and
-"non-free", used in this document, refer to those definitions.
+'http://www.gnu.org/philosophy/free-sw.html', and the definition of free
+documentation is found at 'http://www.gnu.org/philosophy/free-doc.html'.
+The terms "free" and "non-free", used in this document, refer to those
+definitions.
A list of important licenses and whether they qualify as free is in
-`http://www.gnu.org/licenses/license-list.html'. If it is not clear
+'http://www.gnu.org/licenses/license-list.html'. If it is not clear
whether a license qualifies as free, please ask the GNU Project by
writing to <address@hidden>. We will answer, and if the license is
an important one, we will add it to the list.
When a non-free program or system is well known, you can mention it
in passing--that is harmless, since users who might want to use it
-probably already know about it. For instance, it is fine to explain
-how to build your package on top of some widely used non-free operating
+probably already know about it. For instance, it is fine to explain how
+to build your package on top of some widely used non-free operating
system, or how to use it together with some widely used non-free
program.
@@ -4681,8 +4654,8 @@
give, or refer to, any further information about the proprietary
program, and don't imply that the proprietary program enhances your
program, or that its existence is in any way a good thing. The goal
-should be that people already using the proprietary program will get
-the advice they need about how to use your free program with it, while
+should be that people already using the proprietary program will get the
+advice they need about how to use your free program with it, while
people who don't already use the proprietary program will not see
anything likely to lead them to take an interest in it.
@@ -4707,22 +4680,22 @@
software to run.
Some free programs strongly encourage the use of non-free software.
-A typical example is `mplayer'. It is free software in itself, and the
-free code can handle some kinds of files. However, `mplayer'
-recommends use of non-free codecs for other kinds of files, and users
-that install `mplayer' are very likely to install those codecs along
-with it. To recommend `mplayer' is, in effect, to promote use of the
-non-free codecs.
+A typical example is 'mplayer'. It is free software in itself, and the
+free code can handle some kinds of files. However, 'mplayer' recommends
+use of non-free codecs for other kinds of files, and users that install
+'mplayer' are very likely to install those codecs along with it. To
+recommend 'mplayer' is, in effect, to promote use of the non-free
+codecs.
Thus, you should not recommend programs that strongly encourage the
-use of non-free software. This is why we do not list `mplayer' in the
+use of non-free software. This is why we do not list 'mplayer' in the
Free Software Directory.
A GNU package should not refer the user to any non-free documentation
for free software. Free documentation that can be included in free
operating systems is essential for completing the GNU system, or any
-free operating system, so encouraging it is a priority; to recommend
-use of documentation that we are not allowed to include undermines the
+free operating system, so encouraging it is a priority; to recommend use
+of documentation that we are not allowed to include undermines the
impetus for the community to produce documentation that we can include.
So GNU packages should never recommend non-free documentation.
@@ -4749,8 +4722,8 @@
site that links to AT&T's site presenting it as a place to get some
non-free program, because that link recommends and legitimizes the
non-free program. However, that a site contains a link to AT&T's web
-site for some other purpose (such as long-distance telephone service)
-is not an objection against it.
+site for some other purpose (such as long-distance telephone service) is
+not an objection against it.
Appendix A GNU Free Documentation License
*****************************************
@@ -4758,7 +4731,7 @@
Version 1.3, 3 November 2008
Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
- `http://fsf.org/'
+ 'http://fsf.org/'
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
@@ -4783,21 +4756,21 @@
free program should come with manuals providing the same freedoms
that the software does. But this License is not limited to
software manuals; it can be used for any textual work, regardless
- of subject matter or whether it is published as a printed book.
- We recommend this License principally for works whose purpose is
+ of subject matter or whether it is published as a printed book. We
+ recommend this License principally for works whose purpose is
instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium,
- that contains a notice placed by the copyright holder saying it
- can be distributed under the terms of this License. Such a notice
+ that contains a notice placed by the copyright holder saying it can
+ be distributed under the terms of this License. Such a notice
grants a world-wide, royalty-free license, unlimited in duration,
to use that work under the conditions stated herein. The
"Document", below, refers to any such manual or work. Any member
- of the public is a licensee, and is addressed as "you". You
- accept the license if you copy, modify or distribute the work in a
- way requiring permission under copyright law.
+ of the public is a licensee, and is addressed as "you". You accept
+ the license if you copy, modify or distribute the work in a way
+ requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
@@ -4815,12 +4788,12 @@
regarding them.
The "Invariant Sections" are certain Secondary Sections whose
- titles are designated, as being those of Invariant Sections, in
- the notice that says that the Document is released under this
- License. If a section does not fit the above definition of
- Secondary then it is not allowed to be designated as Invariant.
- The Document may contain zero Invariant Sections. If the Document
- does not identify any Invariant Sections then there are none.
+ titles are designated, as being those of Invariant Sections, in the
+ notice that says that the Document is released under this License.
+ If a section does not fit the above definition of Secondary then it
+ is not allowed to be designated as Invariant. The Document may
+ contain zero Invariant Sections. If the Document does not identify
+ any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are
listed, as Front-Cover Texts or Back-Cover Texts, in the notice
@@ -4831,27 +4804,27 @@
A "Transparent" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
- straightforwardly with generic text editors or (for images
- composed of pixels) generic paint programs or (for drawings) some
- widely available drawing editor, and that is suitable for input to
- text formatters or for automatic translation to a variety of
- formats suitable for input to text formatters. A copy made in an
- otherwise Transparent file format whose markup, or absence of
- markup, has been arranged to thwart or discourage subsequent
- modification by readers is not Transparent. An image format is
- not Transparent if used for any substantial amount of text. A
- copy that is not "Transparent" is called "Opaque".
+ straightforwardly with generic text editors or (for images composed
+ of pixels) generic paint programs or (for drawings) some widely
+ available drawing editor, and that is suitable for input to text
+ formatters or for automatic translation to a variety of formats
+ suitable for input to text formatters. A copy made in an otherwise
+ Transparent file format whose markup, or absence of markup, has
+ been arranged to thwart or discourage subsequent modification by
+ readers is not Transparent. An image format is not Transparent if
+ used for any substantial amount of text. A copy that is not
+ "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format,
- SGML or XML using a publicly available DTD, and
- standard-conforming simple HTML, PostScript or PDF designed for
- human modification. Examples of transparent image formats include
- PNG, XCF and JPG. Opaque formats include proprietary formats that
- can be read and edited only by proprietary word processors, SGML or
- XML for which the DTD and/or processing tools are not generally
- available, and the machine-generated HTML, PostScript or PDF
- produced by some word processors for output purposes only.
+ SGML or XML using a publicly available DTD, and standard-conforming
+ simple HTML, PostScript or PDF designed for human modification.
+ Examples of transparent image formats include PNG, XCF and JPG.
+ Opaque formats include proprietary formats that can be read and
+ edited only by proprietary word processors, SGML or XML for which
+ the DTD and/or processing tools are not generally available, and
+ the machine-generated HTML, PostScript or PDF produced by some word
+ processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the
@@ -4889,8 +4862,8 @@
may not use technical measures to obstruct or control the reading
or further copying of the copies you make or distribute. However,
you may accept compensation in exchange for copies. If you
- distribute a large enough number of copies you must also follow
- the conditions in section 3.
+ distribute a large enough number of copies you must also follow the
+ conditions in section 3.
You may also lend copies, under the same conditions stated above,
and you may publicly display copies.
@@ -4904,12 +4877,11 @@
these Cover Texts: Front-Cover Texts on the front cover, and
Back-Cover Texts on the back cover. Both covers must also clearly
and legibly identify you as the publisher of these copies. The
- front cover must present the full title with all words of the
- title equally prominent and visible. You may add other material
- on the covers in addition. Copying with changes limited to the
- covers, as long as they preserve the title of the Document and
- satisfy these conditions, can be treated as verbatim copying in
- other respects.
+ front cover must present the full title with all words of the title
+ equally prominent and visible. You may add other material on the
+ covers in addition. Copying with changes limited to the covers, as
+ long as they preserve the title of the Document and satisfy these
+ conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
@@ -4917,40 +4889,39 @@
adjacent pages.
If you publish or distribute Opaque copies of the Document
- numbering more than 100, you must either include a
- machine-readable Transparent copy along with each Opaque copy, or
- state in or with each Opaque copy a computer-network location from
- which the general network-using public has access to download
- using public-standard network protocols a complete Transparent
- copy of the Document, free of added material. If you use the
- latter option, you must take reasonably prudent steps, when you
- begin distribution of Opaque copies in quantity, to ensure that
- this Transparent copy will remain thus accessible at the stated
- location until at least one year after the last time you
- distribute an Opaque copy (directly or through your agents or
- retailers) of that edition to the public.
+ numbering more than 100, you must either include a machine-readable
+ Transparent copy along with each Opaque copy, or state in or with
+ each Opaque copy a computer-network location from which the general
+ network-using public has access to download using public-standard
+ network protocols a complete Transparent copy of the Document, free
+ of added material. If you use the latter option, you must take
+ reasonably prudent steps, when you begin distribution of Opaque
+ copies in quantity, to ensure that this Transparent copy will
+ remain thus accessible at the stated location until at least one
+ year after the last time you distribute an Opaque copy (directly or
+ through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of
- the Document well before redistributing any large number of
- copies, to give them a chance to provide you with an updated
- version of the Document.
+ the Document well before redistributing any large number of copies,
+ to give them a chance to provide you with an updated version of the
+ Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document
under the conditions of sections 2 and 3 above, provided that you
- release the Modified Version under precisely this License, with
- the Modified Version filling the role of the Document, thus
- licensing distribution and modification of the Modified Version to
- whoever possesses a copy of it. In addition, you must do these
- things in the Modified Version:
+ release the Modified Version under precisely this License, with the
+ Modified Version filling the role of the Document, thus licensing
+ distribution and modification of the Modified Version to whoever
+ possesses a copy of it. In addition, you must do these things in
+ the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title
- distinct from that of the Document, and from those of
- previous versions (which should, if there were any, be listed
- in the History section of the Document). You may use the
- same title as a previous version if the original publisher of
- that version gives permission.
+ distinct from that of the Document, and from those of previous
+ versions (which should, if there were any, be listed in the
+ History section of the Document). You may use the same title
+ as a previous version if the original publisher of that
+ version gives permission.
B. List on the Title Page, as authors, one or more persons or
entities responsible for authorship of the modifications in
@@ -4980,31 +4951,30 @@
I. Preserve the section Entitled "History", Preserve its Title,
and add to it an item stating at least the title, year, new
- authors, and publisher of the Modified Version as given on
- the Title Page. If there is no section Entitled "History" in
- the Document, create one stating the title, year, authors,
- and publisher of the Document as given on its Title Page,
- then add an item describing the Modified Version as stated in
- the previous sentence.
+ authors, and publisher of the Modified Version as given on the
+ Title Page. If there is no section Entitled "History" in the
+ Document, create one stating the title, year, authors, and
+ publisher of the Document as given on its Title Page, then add
+ an item describing the Modified Version as stated in the
+ previous sentence.
J. Preserve the network location, if any, given in the Document
for public access to a Transparent copy of the Document, and
likewise the network locations given in the Document for
- previous versions it was based on. These may be placed in
- the "History" section. You may omit a network location for a
- work that was published at least four years before the
- Document itself, or if the original publisher of the version
- it refers to gives permission.
+ previous versions it was based on. These may be placed in the
+ "History" section. You may omit a network location for a work
+ that was published at least four years before the Document
+ itself, or if the original publisher of the version it refers
+ to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications",
- Preserve the Title of the section, and preserve in the
- section all the substance and tone of each of the contributor
+ Preserve the Title of the section, and preserve in the section
+ all the substance and tone of each of the contributor
acknowledgements and/or dedications given therein.
- L. Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section
- titles.
+ L. Preserve all the Invariant Sections of the Document, unaltered
+ in their text and in their titles. Section numbers or the
+ equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section
may not be included in the Modified Version.
@@ -5017,11 +4987,11 @@
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no
- material copied from the Document, you may at your option
- designate some or all of these sections as invariant. To do this,
- add their titles to the list of Invariant Sections in the Modified
- Version's license notice. These titles must be distinct from any
- other section titles.
+ material copied from the Document, you may at your option designate
+ some or all of these sections as invariant. To do this, add their
+ titles to the list of Invariant Sections in the Modified Version's
+ license notice. These titles must be distinct from any other
+ section titles.
You may add a section Entitled "Endorsements", provided it contains
nothing but endorsements of your Modified Version by various
@@ -5030,15 +5000,15 @@
definition of a standard.
You may add a passage of up to five words as a Front-Cover Text,
- and a passage of up to 25 words as a Back-Cover Text, to the end
- of the list of Cover Texts in the Modified Version. Only one
- passage of Front-Cover Text and one of Back-Cover Text may be
- added by (or through arrangements made by) any one entity. If the
- Document already includes a cover text for the same cover,
- previously added by you or by arrangement made by the same entity
- you are acting on behalf of, you may not add another; but you may
- replace the old one, on explicit permission from the previous
- publisher that added the old one.
+ and a passage of up to 25 words as a Back-Cover Text, to the end of
+ the list of Cover Texts in the Modified Version. Only one passage
+ of Front-Cover Text and one of Back-Cover Text may be added by (or
+ through arrangements made by) any one entity. If the Document
+ already includes a cover text for the same cover, previously added
+ by you or by arrangement made by the same entity you are acting on
+ behalf of, you may not add another; but you may replace the old
+ one, on explicit permission from the previous publisher that added
+ the old one.
The author(s) and publisher(s) of the Document do not by this
License give permission to use their names for publicity for or to
@@ -5048,8 +5018,8 @@
You may combine the Document with other documents released under
this License, under the terms defined in section 4 above for
- modified versions, provided that you include in the combination
- all of the Invariant Sections of all of the original documents,
+ modified versions, provided that you include in the combination all
+ of the Invariant Sections of all of the original documents,
unmodified, and list them all as Invariant Sections of your
combined work in its license notice, and that you preserve all
their Warranty Disclaimers.
@@ -5076,20 +5046,20 @@
documents released under this License, and replace the individual
copies of this License in the various documents with a single copy
that is included in the collection, provided that you follow the
- rules of this License for verbatim copying of each of the
- documents in all other respects.
+ rules of this License for verbatim copying of each of the documents
+ in all other respects.
You may extract a single document from such a collection, and
distribute it individually under this License, provided you insert
- a copy of this License into the extracted document, and follow
- this License in all other respects regarding verbatim copying of
- that document.
+ a copy of this License into the extracted document, and follow this
+ License in all other respects regarding verbatim copying of that
+ document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other
- separate and independent documents or works, in or on a volume of
- a storage or distribution medium, is called an "aggregate" if the
+ separate and independent documents or works, in or on a volume of a
+ storage or distribution medium, is called an "aggregate" if the
copyright resulting from the compilation is not used to limit the
legal rights of the compilation's users beyond what the individual
works permit. When the Document is included in an aggregate, this
@@ -5134,8 +5104,8 @@
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
- provisionally, unless and until the copyright holder explicitly
- and finally terminates your license, and (b) permanently, if the
+ provisionally, unless and until the copyright holder explicitly and
+ finally terminates your license, and (b) permanently, if the
copyright holder fails to notify you of the violation by some
reasonable means prior to 60 days after the cessation.
@@ -5147,10 +5117,10 @@
after your receipt of the notice.
Termination of your rights under this section does not terminate
- the licenses of parties who have received copies or rights from
- you under this License. If your rights have been terminated and
- not permanently reinstated, receipt of a copy of some or all of
- the same material does not give you any rights to use it.
+ the licenses of parties who have received copies or rights from you
+ under this License. If your rights have been terminated and not
+ permanently reinstated, receipt of a copy of some or all of the
+ same material does not give you any rights to use it.
10. FUTURE REVISIONS OF THIS LICENSE
@@ -5158,18 +5128,18 @@
the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
- `http://www.gnu.org/copyleft/'.
+ 'http://www.gnu.org/copyleft/'.
Each version of the License is given a distinguishing version
number. If the Document specifies that a particular numbered
version of this License "or any later version" applies to it, you
have the option of following the terms and conditions either of
that specified version or of any later version that has been
- published (not as a draft) by the Free Software Foundation. If
- the Document does not specify a version number of this License,
- you may choose any version ever published (not as a draft) by the
- Free Software Foundation. If the Document specifies that a proxy
- can decide which future versions of this License can be used, that
+ published (not as a draft) by the Free Software Foundation. If the
+ Document does not specify a version number of this License, you may
+ choose any version ever published (not as a draft) by the Free
+ Software Foundation. If the Document specifies that a proxy can
+ decide which future versions of this License can be used, that
proxy's public statement of acceptance of a version permanently
authorizes you to choose that version for the Document.
@@ -5203,7 +5173,6 @@
site under CC-BY-SA on the same site at any time before August 1,
2009, provided the MMC is eligible for relicensing.
-
ADDENDUM: How to use this License for your documents
====================================================
@@ -5231,176 +5200,10 @@
situation.
If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License, to
-permit their use in free software.
+recommend releasing these examples in parallel under your choice of free
+software license, such as the GNU General Public License, to permit
+their use in free software.
Index
*****
-#endif, commenting: See 5.2. (line 2378)
---help output: See 4.7.2. (line 956)
---version output: See 4.7.1. (line 811)
--Wall compiler option: See 5.3. (line 2411)
-accepting contributions: See 2.2. (line 189)
-address for bug reports: See 4.7.2. (line 961)
-ANSI C standard: See 3.4. (line 378)
-arbitrary limits on data: See 4.2. (line 533)
-ASCII characters: See 5.9. (line 2834)
-autoconf: See 5.5. (line 2588)
-avoiding proprietary code: See 2.1. (line 155)
-behavior, dependent on program's name: See 4.5. (line 725)
-binary packages: See 7.2.7. (line 4547)
-bindir: See 7.2.5. (line 3890)
-braces, in C source: See 5.1. (line 2194)
-bug reports: See 4.7.2. (line 961)
address@hidden email address: See 1. (line 118)
-C library functions, and portability: See 5.7. (line 2683)
-canonical name of a program: See 4.7.1. (line 817)
-casting pointers to integers: See 5.6. (line 2671)
-CGI programs, standard options for: See 4.7. (line 802)
-change logs: See 6.8. (line 3122)
-change logs, conditional changes: See 6.8.4. (line 3266)
-change logs, style: See 6.8.2. (line 3173)
-character set: See 5.9. (line 2834)
-clang: See 5.3. (line 2418)
-command-line arguments, decoding: See 4.2. (line 574)
-command-line interface: See 4.7. (line 777)
-commenting: See 5.2. (line 2324)
-compatibility with C and POSIX standards: See 3.2. (line 313)
-compiler warnings: See 5.3. (line 2411)
-conditional changes, and change logs: See 6.8.4. (line 3266)
-conditionals, comments for: See 5.2. (line 2378)
-configure: See 7.1. (line 3399)
-control-L: See 5.1. (line 2316)
-conventions for makefiles: See 7.2. (line 3580)
-CORBA: See 4.6. (line 766)
-credits for manuals: See 6.5. (line 3087)
-D-bus: See 4.6. (line 766)
-data structures, in Gnulib: See 5.7. (line 2721)
-data types, and portability: See 5.6. (line 2627)
-DESTDIR: See 7.2.4. (line 3793)
-directories, creating installation: See 7.2.5. (line 3853)
-documentation: See 6. (line 2898)
-doschk: See 5.4. (line 2557)
-double quote: See 5.10. (line 2850)
-downloading this manual: See 1. (line 102)
-dynamic plug-ins: See 4.8. (line 975)
-encodings: See 5.9. (line 2834)
-enum types, formatting: See 5.1. (line 2233)
-error messages: See 4.2. (line 546)
-error messages, formatting: See 4.4. (line 661)
-error messages, in Gnulib: See 5.7. (line 2721)
-exec_prefix: See 7.2.5. (line 3872)
-expressions, splitting: See 5.1. (line 2279)
-FDL, GNU Free Documentation License: See Appendix A.
- (line 4758)
-file usage: See 4.12. (line 2172)
-file-name limitations: See 5.4. (line 2557)
-formatting error messages: See 4.4. (line 661)
-formatting source code: See 5.1. (line 2194)
-formfeed: See 5.1. (line 2316)
-function argument, declaring: See 5.3. (line 2407)
-function definitions, formatting: See 5.1. (line 2194)
-function prototypes: See 3.4. (line 389)
-getopt: See 4.7. (line 777)
-gettext: See 5.8. (line 2739)
-GNOME: See 4.6. (line 766)
-GNOME and Guile: See 3.1. (line 302)
-Gnulib: See 5.7. (line 2714)
-gnustandards project repository: See 1. (line 118)
address@hidden mailing list: See 1. (line 112)
-graphical user interface: See 4.6. (line 756)
-grave accent: See 5.10. (line 2850)
-GTK+: See 4.6. (line 756)
-Guile: See 3.1. (line 302)
-implicit int: See 5.3. (line 2407)
-impossible conditions: See 4.2. (line 598)
-installation directories, creating: See 7.2.5. (line 3853)
-installations, staged: See 7.2.4. (line 3793)
-interface styles: See 4.6. (line 756)
-internationalization: See 5.8. (line 2739)
-keyboard interface: See 4.6. (line 766)
-LDAP: See 4.10. (line 2095)
-left quote: See 5.10. (line 2850)
-legal aspects: See 2. (line 149)
-legal papers: See 2.2. (line 189)
-libexecdir: See 7.2.5. (line 3903)
-libiconv: See 4.2. (line 538)
-libraries: See 4.3. (line 633)
-library functions, and portability: See 5.7. (line 2683)
-library interface: See 4.6. (line 766)
-license for manuals: See 6.4. (line 3068)
-lint: See 5.3. (line 2418)
-locale-specific quote characters: See 5.10. (line 2850)
-long option names: See 4.9. (line 1007)
-long-named options: See 4.7. (line 783)
-makefile, conventions for: See 7.2. (line 3580)
-malloc return value: See 4.2. (line 553)
-man pages: See 6.9. (line 3328)
-manual structure: See 6.3. (line 3041)
-memory allocation failure: See 4.2. (line 553)
-memory leak: See 4.11. (line 2164)
-memory usage: See 4.11. (line 2147)
-message text, and internationalization: See 5.8. (line 2762)
-mmap: See 5.11. (line 2882)
-multiple variables in a line: See 5.3. (line 2444)
-names of variables, functions, and files: See 5.4. (line 2525)
-NEWS file: See 6.7. (line 3108)
-non-ASCII characters: See 5.9. (line 2834)
-non-POSIX systems, and portability: See 5.5. (line 2597)
-non-standard extensions: See 3.3. (line 345)
-NUL characters: See 4.2. (line 538)
-OID allocations for GNU: See 4.10. (line 2095)
-open brace: See 5.1. (line 2194)
-opening quote: See 5.10. (line 2850)
-optional features, configure-time: See 7.1. (line 3493)
-options for compatibility: See 3.2. (line 321)
-options, standard command-line: See 4.7. (line 802)
-output device and program's behavior: See 4.5. (line 732)
-packaging: See 7.3. (line 4574)
-PATH_INFO, specifying standard options as: See 4.7. (line 802)
-plug-ins: See 4.8. (line 975)
-plugin_is_GPL_compatible: See 4.8. (line 986)
-portability, and data types: See 5.6. (line 2627)
-portability, and library functions: See 5.7. (line 2683)
-portability, between system types: See 5.5. (line 2571)
-POSIX compatibility: See 3.2. (line 313)
-POSIX functions, and portability: See 5.7. (line 2683)
-POSIXLY_CORRECT, environment variable: See 3.2. (line 328)
-post-installation commands: See 7.2.7. (line 4473)
-pre-installation commands: See 7.2.7. (line 4473)
-prefix: See 7.2.5. (line 3862)
-program configuration: See 7.1. (line 3399)
-program design: See 3. (line 264)
-program name and its behavior: See 4.5. (line 725)
-program's canonical name: See 4.7.1. (line 817)
-programming languages: See 3.1. (line 270)
-proprietary programs: See 2.1. (line 155)
-quote characters: See 5.10. (line 2850)
-README file: See 7.3. (line 4589)
-references to non-free material: See 8. (line 4652)
-releasing: See 7. (line 3388)
-right quote: See 5.10. (line 2850)
-Savannah repository for gnustandards: See 1. (line 118)
-sbindir: See 7.2.5. (line 3896)
-signal handling: See 4.2. (line 587)
-single quote: See 5.10. (line 2850)
-SNMP: See 4.10. (line 2095)
-spaces before open-paren: See 5.1. (line 2273)
-staged installs: See 7.2.4. (line 3793)
-standard command-line options: See 4.7. (line 802)
-standards for makefiles: See 7.2. (line 3580)
-struct types, formatting: See 5.1. (line 2233)
-syntactic conventions: See 5.3. (line 2407)
-table of long options: See 4.9. (line 1007)
-temporary files: See 4.2. (line 612)
-temporary variables: See 5.3. (line 2432)
-texinfo.tex, in a distribution: See 7.3. (line 4640)
-TMPDIR environment variable: See 4.2. (line 612)
-trademarks: See 2.3. (line 234)
-user interface styles: See 4.6. (line 756)
-valgrind: See 4.11. (line 2164)
-where to obtain standards.texi: See 1. (line 102)
-X.509: See 4.10. (line 2095)
-xmalloc, in Gnulib: See 5.7. (line 2721)
Index: standards/standards.txt.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.txt.gz,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -b -r1.63 -r1.64
Binary files /tmp/cvsYKKyVh and /tmp/cvsnTdV3E differ
Index: standards/html_node/CPU-Portability.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/CPU-Portability.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/CPU-Portability.html 8 Apr 2012 00:23:36 -0000
1.54
+++ standards/html_node/CPU-Portability.html 7 May 2012 00:48:06 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>CPU Portability - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="System-Portability.html#System-Portability"
title="System Portability">
-<link rel="next" href="System-Functions.html#System-Functions" title="System
Functions">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,84 +11,132 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: CPU Portability</title>
+
+<meta name="description" content="GNU Coding Standards: CPU Portability">
+<meta name="keywords" content="GNU Coding Standards: CPU Portability">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="System-Functions.html#System-Functions" rel="next" title="System
Functions">
+<link href="System-Portability.html#System-Portability" rel="previous"
title="System Portability">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="CPU-Portability"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="System-Functions.html#System-Functions">System Functions</a>,
-Previous: <a rel="previous" accesskey="p"
href="System-Portability.html#System-Portability">System Portability</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="System-Functions.html#System-Functions" accesskey="n"
rel="next">System Functions</a>, Previous: <a
href="System-Portability.html#System-Portability" accesskey="p"
rel="previous">System Portability</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
+<hr>
+<a name="Portability-between-CPUs"></a>
+<h3 class="section">5.6 Portability between <small>CPU</small>s</h3>
-<h3 class="section">5.6 Portability between <span class="sc">cpu</span>s</h3>
-
-<p><a name="index-data-types_002c-and-portability-104"></a><a
name="index-portability_002c-and-data-types-105"></a>Even GNU systems will
differ because of differences among <span class="sc">cpu</span>
+<a name="index-data-types_002c-and-portability"></a>
+<a name="index-portability_002c-and-data-types"></a>
+<p>Even GNU systems will differ because of differences among <small>CPU</small>
types—for example, difference in byte ordering and alignment
requirements. It is absolutely essential to handle these differences.
-However, don't make any effort to cater to the possibility that an
-<code>int</code> will be less than 32 bits. We don't support 16-bit machines
+However, don’t make any effort to cater to the possibility that an
+<code>int</code> will be less than 32 bits. We don’t support 16-bit
machines
in GNU.
-
- <p>Similarly, don't make any effort to cater to the possibility that
+</p>
+<p>Similarly, don’t make any effort to cater to the possibility that
<code>long</code> will be smaller than predefined types like
<code>size_t</code>.
For example, the following code is ok:
+</p>
+<div class="example">
+<pre class="example">printf ("size = %lu\n", (unsigned long) sizeof
array);
+printf ("diff = %ld\n", (long) (pointer2 - pointer1));
+</pre></div>
-<pre class="example"> printf ("size = %lu\n", (unsigned long) sizeof
array);
- printf ("diff = %ld\n", (long) (pointer2 - pointer1));
-</pre>
- <p>1989 Standard C requires this to work, and we know of only one
+<p>1989 Standard C requires this to work, and we know of only one
counterexample: 64-bit programs on Microsoft Windows. We will leave
it to those who want to port GNU programs to that environment to
figure out how to do it.
-
- <p>Predefined file-size types like <code>off_t</code> are an exception:
they are
-longer than <code>long</code> on many platforms, so code like the above won't
+</p>
+<p>Predefined file-size types like <code>off_t</code> are an exception: they
are
+longer than <code>long</code> on many platforms, so code like the above
won’t
work with them. One way to print an <code>off_t</code> value portably is to
print its digits yourself, one by one.
-
- <p>Don't assume that the address of an <code>int</code> object is also the
+</p>
+<p>Don’t assume that the address of an <code>int</code> object is also
the
address of its least-significant byte. This is false on big-endian
-machines. Thus, don't make the following mistake:
-
-<pre class="example"> int c;
- ...
- while ((c = getchar ()) != EOF)
+machines. Thus, don’t make the following mistake:
+</p>
+<div class="example">
+<pre class="example">int c;
+…
+while ((c = getchar ()) != EOF)
write (file_descriptor, &c, 1);
-</pre>
- <p class="noindent">Instead, use <code>unsigned char</code> as follows.
(The <code>unsigned</code>
+</pre></div>
+
+<p>Instead, use <code>unsigned char</code> as follows. (The
<code>unsigned</code>
is for portability to unusual systems where <code>char</code> is signed and
where there is integer overflow checking.)
-
-<pre class="example"> int c;
- while ((c = getchar ()) != EOF)
+</p>
+<div class="example">
+<pre class="example">int c;
+while ((c = getchar ()) != EOF)
{
unsigned char u = c;
write (file_descriptor, &u, 1);
}
-</pre>
- <p><a name="index-casting-pointers-to-integers-106"></a>Avoid casting
pointers to integers if you can. Such casts greatly
+</pre></div>
+
+<a name="index-casting-pointers-to-integers"></a>
+<p>Avoid casting pointers to integers if you can. Such casts greatly
reduce portability, and in most programs they are easy to avoid. In the
cases where casting pointers to integers is essential—such as, a Lisp
interpreter which stores type information as well as an address in one
-word—you'll have to make explicit provisions to handle different word
+word—you’ll have to make explicit provisions to handle different
word
sizes. You will also need to make provision for systems in which the
normal range of addresses you can get from <code>malloc</code> starts far away
from zero.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="System-Functions.html#System-Functions" accesskey="n"
rel="next">System Functions</a>, Previous: <a
href="System-Portability.html#System-Portability" accesskey="p"
rel="previous">System Portability</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Change-Log-Concepts.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Change-Log-Concepts.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Change-Log-Concepts.html 8 Apr 2012 00:23:41
-0000 1.54
+++ standards/html_node/Change-Log-Concepts.html 7 May 2012 00:48:07
-0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Change Log Concepts - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Change-Logs.html#Change-Logs" title="Change Logs">
-<link rel="next" href="Style-of-Change-Logs.html#Style-of-Change-Logs"
title="Style of Change Logs">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,67 +11,106 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Change Log Concepts</title>
+
+<meta name="description" content="GNU Coding Standards: Change Log Concepts">
+<meta name="keywords" content="GNU Coding Standards: Change Log Concepts">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Change-Logs.html#Change-Logs" rel="up" title="Change Logs">
+<link href="Style-of-Change-Logs.html#Style-of-Change-Logs" rel="next"
title="Style of Change Logs">
+<link href="Change-Logs.html#Change-Logs" rel="previous" title="Change Logs">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Change-Log-Concepts"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Style-of-Change-Logs.html#Style-of-Change-Logs">Style of Change Logs</a>,
-Up: <a rel="up" accesskey="u" href="Change-Logs.html#Change-Logs">Change
Logs</a>
-<hr>
+Next: <a href="Style-of-Change-Logs.html#Style-of-Change-Logs" accesskey="n"
rel="next">Style of Change Logs</a>, Up: <a href="Change-Logs.html#Change-Logs"
accesskey="u" rel="up">Change Logs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Change-Log-Concepts-1"></a>
<h4 class="subsection">6.8.1 Change Log Concepts</h4>
<p>You can think of the change log as a conceptual “undo list”
which
explains how earlier versions were different from the current version.
-People can see the current version; they don't need the change log
+People can see the current version; they don’t need the change log
to tell them what is in it. What they want from a change log is a
clear explanation of how the earlier version differed.
-
- <p>The change log file is normally called <samp><span
class="file">ChangeLog</span></samp> and covers an
+</p>
+<p>The change log file is normally called ‘<tt>ChangeLog</tt>’ and
covers an
entire directory. Each directory can have its own change log, or a
-directory can use the change log of its parent directory—it's up to
+directory can use the change log of its parent directory—it’s up to
you.
-
- <p>Another alternative is to record change log information with a version
+</p>
+<p>Another alternative is to record change log information with a version
control system such as RCS or CVS. This can be converted automatically
-to a <samp><span class="file">ChangeLog</span></samp> file using
<code>rcs2log</code>; in Emacs, the command
+to a ‘<tt>ChangeLog</tt>’ file using <code>rcs2log</code>; in
Emacs, the command
<kbd>C-x v a</kbd> (<code>vc-update-change-log</code>) does the job.
-
- <p>There's no need to describe the full purpose of the changes or how
+</p>
+<p>There’s no need to describe the full purpose of the changes or how
they work together. However, sometimes it is useful to write one line
to describe the overall purpose of a change or a batch of changes. If
-you think that a change calls for explanation, you're probably right.
+you think that a change calls for explanation, you’re probably right.
Please do explain it—but please put the full explanation in comments
in the code, where people will see it whenever they see the code. For
example, “New function” is enough for the change log when you add a
function, because there should be a comment before the function
definition to explain what it does.
-
- <p>In the past, we recommended not mentioning changes in non-software
-files (manuals, help files, etc.) in change logs. However, we've been
+</p>
+<p>In the past, we recommended not mentioning changes in non-software
+files (manuals, help files, etc.) in change logs. However, we’ve been
advised that it is a good idea to include them, for the sake of
copyright records.
-
- <p>The easiest way to add an entry to <samp><span
class="file">ChangeLog</span></samp> is with the Emacs
+</p>
+<p>The easiest way to add an entry to ‘<tt>ChangeLog</tt>’ is with
the Emacs
command <kbd>M-x add-change-log-entry</kbd>. An entry should have an
asterisk, the name of the changed file, and then in parentheses the name
of the changed functions, variables or whatever, followed by a colon.
Then describe the changes you made to that function or variable.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Style-of-Change-Logs.html#Style-of-Change-Logs" accesskey="n"
rel="next">Style of Change Logs</a>, Up: <a href="Change-Logs.html#Change-Logs"
accesskey="u" rel="up">Change Logs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Change-Logs.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Change-Logs.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Change-Logs.html 8 Apr 2012 00:23:42 -0000
1.54
+++ standards/html_node/Change-Logs.html 7 May 2012 00:48:07 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Change Logs - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="NEWS-File.html#NEWS-File" title="NEWS File">
-<link rel="next" href="Man-Pages.html#Man-Pages" title="Man Pages">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,48 +11,86 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Change Logs</title>
+
+<meta name="description" content="GNU Coding Standards: Change Logs">
+<meta name="keywords" content="GNU Coding Standards: Change Logs">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Change-Log-Concepts.html#Change-Log-Concepts" rel="next"
title="Change Log Concepts">
+<link href="NEWS-File.html#NEWS-File" rel="previous" title="NEWS File">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Change-Logs"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="Man-Pages.html#Man-Pages">Man
Pages</a>,
-Previous: <a rel="previous" accesskey="p"
href="NEWS-File.html#NEWS-File">NEWS File</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="Man-Pages.html#Man-Pages" accesskey="n" rel="next">Man
Pages</a>, Previous: <a href="NEWS-File.html#NEWS-File" accesskey="p"
rel="previous">NEWS File</a>, Up: <a href="Documentation.html#Documentation"
accesskey="u" rel="up">Documentation</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Change-Logs-1"></a>
<h3 class="section">6.8 Change Logs</h3>
+<a name="index-change-logs"></a>
-<p><a name="index-change-logs-136"></a>
-Keep a change log to describe all the changes made to program source
+<p>Keep a change log to describe all the changes made to program source
files. The purpose of this is so that people investigating bugs in the
future will know about the changes that might have introduced the bug.
Often a new bug can be found by looking at what was recently changed.
More importantly, change logs can help you eliminate conceptual
inconsistencies between different parts of a program, by giving you a
history of how the conflicting concepts arose and who they came from.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="Change-Log-Concepts.html#Change-Log-Concepts" accesskey="1">Change Log
Concepts</a>:</td><td> </td><td align="left" valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Style-of-Change-Logs.html#Style-of-Change-Logs" accesskey="2">Style of
Change Logs</a>:</td><td> </td><td align="left" valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Simple-Changes.html#Simple-Changes" accesskey="3">Simple
Changes</a>:</td><td> </td><td align="left" valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Conditional-Changes.html#Conditional-Changes" accesskey="4">Conditional
Changes</a>:</td><td> </td><td align="left" valign="top">
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed"
accesskey="5">Indicating the Part Changed</a>:</td><td> </td><td
align="left" valign="top">
+</td></tr>
+</table>
+
-<ul class="menu">
-<li><a accesskey="1"
href="Change-Log-Concepts.html#Change-Log-Concepts">Change Log Concepts</a>
-<li><a accesskey="2"
href="Style-of-Change-Logs.html#Style-of-Change-Logs">Style of Change Logs</a>
-<li><a accesskey="3" href="Simple-Changes.html#Simple-Changes">Simple
Changes</a>
-<li><a accesskey="4"
href="Conditional-Changes.html#Conditional-Changes">Conditional Changes</a>
-<li><a accesskey="5"
href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed">Indicating
the Part Changed</a>
-</ul>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Character-Set.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Character-Set.html,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -b -r1.46 -r1.47
--- standards/html_node/Character-Set.html 8 Apr 2012 00:23:44 -0000
1.46
+++ standards/html_node/Character-Set.html 7 May 2012 00:48:07 -0000
1.47
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Character Set - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="Internationalization.html#Internationalization"
title="Internationalization">
-<link rel="next" href="Quote-Characters.html#Quote-Characters" title="Quote
Characters">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,34 +11,67 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Character Set</title>
+
+<meta name="description" content="GNU Coding Standards: Character Set">
+<meta name="keywords" content="GNU Coding Standards: Character Set">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Quote-Characters.html#Quote-Characters" rel="next" title="Quote
Characters">
+<link href="Internationalization.html#Internationalization" rel="previous"
title="Internationalization">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Character-Set"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Quote-Characters.html#Quote-Characters">Quote Characters</a>,
-Previous: <a rel="previous" accesskey="p"
href="Internationalization.html#Internationalization">Internationalization</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="Quote-Characters.html#Quote-Characters" accesskey="n"
rel="next">Quote Characters</a>, Previous: <a
href="Internationalization.html#Internationalization" accesskey="p"
rel="previous">Internationalization</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Character-Set-1"></a>
<h3 class="section">5.9 Character Set</h3>
+<a name="index-character-set"></a>
+<a name="index-encodings"></a>
+<a name="index-ASCII-characters"></a>
+<a name="index-non_002dASCII-characters"></a>
-<p><a name="index-character-set-118"></a><a name="index-encodings-119"></a><a
name="index-ASCII-characters-120"></a><a
name="index-non_002dASCII-characters-121"></a>
-Sticking to the ASCII character set (plain text, 7-bit characters) is
+<p>Sticking to the ASCII character set (plain text, 7-bit characters) is
preferred in GNU source code comments, text documents, and other
contexts, unless there is good reason to do something else because of
the application domain. For example, if source code deals with the
@@ -56,10 +79,14 @@
accented characters in month names like “Floréal”. Also,
it is OK
(but not required) to use non-ASCII characters to represent proper
names of contributors in change logs (see <a
href="Change-Logs.html#Change-Logs">Change Logs</a>).
-
- <p>If you need to use non-ASCII characters, you should normally stick
+</p>
+<p>If you need to use non-ASCII characters, you should normally stick
with one encoding, certainly within a single file. UTF-8 is likely to
be the best choice.
+</p>
+
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Command-Variables.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Command-Variables.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Command-Variables.html 8 Apr 2012 00:23:45 -0000
1.54
+++ standards/html_node/Command-Variables.html 7 May 2012 00:48:07 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Command Variables - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link rel="prev" href="Utilities-in-Makefiles.html#Utilities-in-Makefiles"
title="Utilities in Makefiles">
-<link rel="next" href="DESTDIR.html#DESTDIR" title="DESTDIR">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,46 +11,76 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Command Variables</title>
+
+<meta name="description" content="GNU Coding Standards: Command Variables">
+<meta name="keywords" content="GNU Coding Standards: Command Variables">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="up"
title="Makefile Conventions">
+<link href="DESTDIR.html#DESTDIR" rel="next" title="DESTDIR">
+<link href="Utilities-in-Makefiles.html#Utilities-in-Makefiles" rel="previous"
title="Utilities in Makefiles">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Command-Variables"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="DESTDIR.html#DESTDIR">DESTDIR</a>,
-Previous: <a rel="previous" accesskey="p"
href="Utilities-in-Makefiles.html#Utilities-in-Makefiles">Utilities in
Makefiles</a>,
-Up: <a rel="up" accesskey="u"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>
-<hr>
+Next: <a href="DESTDIR.html#DESTDIR" accesskey="n" rel="next">DESTDIR</a>,
Previous: <a href="Utilities-in-Makefiles.html#Utilities-in-Makefiles"
accesskey="p" rel="previous">Utilities in Makefiles</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Variables-for-Specifying-Commands"></a>
<h4 class="subsection">7.2.3 Variables for Specifying Commands</h4>
<p>Makefiles should provide variables for overriding certain commands, options,
and so on.
-
- <p>In particular, you should run most utility programs via variables.
+</p>
+<p>In particular, you should run most utility programs via variables.
Thus, if you use Bison, have a variable named <code>BISON</code> whose default
-value is set with ‘<samp><span class="samp">BISON =
bison</span></samp>’, and refer to it with
+value is set with ‘<samp>BISON = bison</samp>’, and refer to it
with
<code>$(BISON)</code> whenever you need to use Bison.
-
- <p>File management utilities such as <code>ln</code>, <code>rm</code>,
<code>mv</code>, and
+</p>
+<p>File management utilities such as <code>ln</code>, <code>rm</code>,
<code>mv</code>, and
so on, need not be referred to through variables in this way, since users
-don't need to replace them with other programs.
-
- <p>Each program-name variable should come with an options variable that is
-used to supply options to the program. Append ‘<samp><span
class="samp">FLAGS</span></samp>’ to the
+don’t need to replace them with other programs.
+</p>
+<p>Each program-name variable should come with an options variable that is
+used to supply options to the program. Append
‘<samp>FLAGS</samp>’ to the
program-name variable name to get the options variable name—for
example, <code>BISONFLAGS</code>. (The names <code>CFLAGS</code> for the C
compiler, <code>YFLAGS</code> for yacc, and <code>LFLAGS</code> for lex, are
@@ -68,52 +88,67 @@
Use <code>CPPFLAGS</code> in any compilation command that runs the
preprocessor, and use <code>LDFLAGS</code> in any compilation command that
does linking as well as in any direct use of <code>ld</code>.
-
- <p>If there are C compiler options that <em>must</em> be used for proper
+</p>
+<p>If there are C compiler options that <em>must</em> be used for proper
compilation of certain files, do not include them in <code>CFLAGS</code>.
Users expect to be able to specify <code>CFLAGS</code> freely themselves.
Instead, arrange to pass the necessary options to the C compiler
independently of <code>CFLAGS</code>, by writing them explicitly in the
compilation commands or by defining an implicit rule, like this:
-
-<pre class="smallexample"> CFLAGS = -g
- ALL_CFLAGS = -I. $(CFLAGS)
- .c.o:
+</p>
+<div class="smallexample">
+<pre class="smallexample">CFLAGS = -g
+ALL_CFLAGS = -I. $(CFLAGS)
+.c.o:
$(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
-</pre>
- <p>Do include the ‘<samp><span class="samp">-g</span></samp>’
option in <code>CFLAGS</code>, because that is not
+</pre></div>
+
+<p>Do include the ‘<samp>-g</samp>’ option in <code>CFLAGS</code>,
because that is not
<em>required</em> for proper compilation. You can consider it a default
that is only recommended. If the package is set up so that it is
-compiled with GCC by default, then you might as well include
‘<samp><span class="samp">-O</span></samp>’
+compiled with GCC by default, then you might as well include
‘<samp>-O</samp>’
in the default value of <code>CFLAGS</code> as well.
-
- <p>Put <code>CFLAGS</code> last in the compilation command, after other
variables
+</p>
+<p>Put <code>CFLAGS</code> last in the compilation command, after other
variables
containing compiler options, so the user can use <code>CFLAGS</code> to
override the others.
-
- <p><code>CFLAGS</code> should be used in every invocation of the C compiler,
+</p>
+<p><code>CFLAGS</code> should be used in every invocation of the C compiler,
both those which do compilation and those which do linking.
-
- <p>Every Makefile should define the variable <code>INSTALL</code>, which is
the
+</p>
+<p>Every Makefile should define the variable <code>INSTALL</code>, which is the
basic command for installing a file into the system.
-
- <p>Every Makefile should also define the variables
<code>INSTALL_PROGRAM</code>
+</p>
+<p>Every Makefile should also define the variables <code>INSTALL_PROGRAM</code>
and <code>INSTALL_DATA</code>. (The default for <code>INSTALL_PROGRAM</code>
should
be <code>$(INSTALL)</code>; the default for <code>INSTALL_DATA</code> should be
<code>${INSTALL} -m 644</code>.) Then it should use those variables as the
commands for actual installation, for executables and non-executables
respectively. Minimal use of these variables is as follows:
+</p>
+<div class="example">
+<pre class="example">$(INSTALL_PROGRAM) foo $(bindir)/foo
+$(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
+</pre></div>
-<pre class="example"> $(INSTALL_PROGRAM) foo $(bindir)/foo
- $(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
-</pre>
- <p>However, it is preferable to support a <code>DESTDIR</code> prefix on the
+<p>However, it is preferable to support a <code>DESTDIR</code> prefix on the
target files, as explained in the next section.
-
- <p>It is acceptable, but not required, to install multiple files in one
+</p>
+<p>It is acceptable, but not required, to install multiple files in one
command, with the final argument being a directory, as in:
+</p>
+<div class="example">
+<pre class="example">$(INSTALL_PROGRAM) foo bar baz $(bindir)
+</pre></div>
+
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="DESTDIR.html#DESTDIR" accesskey="n" rel="next">DESTDIR</a>,
Previous: <a href="Utilities-in-Makefiles.html#Utilities-in-Makefiles"
accesskey="p" rel="previous">Utilities in Makefiles</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
-<pre class="example"> $(INSTALL_PROGRAM) foo bar baz $(bindir)
-</pre>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Command_002dLine-Interfaces.html
===================================================================
RCS file:
/web/www/www/prep/standards/html_node/Command_002dLine-Interfaces.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Command_002dLine-Interfaces.html 8 Apr 2012
00:23:48 -0000 1.54
+++ standards/html_node/Command_002dLine-Interfaces.html 7 May 2012
00:48:07 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Command-Line Interfaces - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="Graphical-Interfaces.html#Graphical-Interfaces"
title="Graphical Interfaces">
-<link rel="next"
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
title="Dynamic Plug-In Interfaces">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,71 +11,116 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Command-Line Interfaces</title>
+
+<meta name="description" content="GNU Coding Standards: Command-Line
Interfaces">
+<meta name="keywords" content="GNU Coding Standards: Command-Line Interfaces">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="_002d_002dversion.html#g_t_002d_002dversion" rel="next"
title="--version">
+<link href="Graphical-Interfaces.html#Graphical-Interfaces" rel="previous"
title="Graphical Interfaces">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
-<a name="Command-Line-Interfaces"></a>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Command_002dLine-Interfaces"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a>,
-Previous: <a rel="previous" accesskey="p"
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical Interfaces</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
accesskey="n" rel="next">Dynamic Plug-In Interfaces</a>, Previous: <a
href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="p"
rel="previous">Graphical Interfaces</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Standards-for-Command-Line-Interfaces"></a>
<h3 class="section">4.7 Standards for Command Line Interfaces</h3>
+<a name="index-command_002dline-interface"></a>
-<p><a name="index-command_002dline-interface-50"></a>
-<a name="index-getopt-51"></a>It is a good idea to follow the <span
class="sc">posix</span> guidelines for the
+<a name="index-getopt"></a>
+<p>It is a good idea to follow the <small>POSIX</small> guidelines for the
command-line options of a program. The easiest way to do this is to use
<code>getopt</code> to parse them. Note that the GNU version of
<code>getopt</code>
will normally permit options anywhere among the arguments unless the
-special argument ‘<samp><span class="samp">--</span></samp>’ is
used. This is not what <span class="sc">posix</span>
+special argument ‘<samp>--</samp>’ is used. This is not what
<small>POSIX</small>
specifies; it is a GNU extension.
-
- <p><a name="index-long_002dnamed-options-52"></a>Please define long-named
options that are equivalent to the
+</p>
+<a name="index-long_002dnamed-options"></a>
+<p>Please define long-named options that are equivalent to the
single-letter Unix-style options. We hope to make GNU more user
friendly this way. This is easy to do with the GNU function
<code>getopt_long</code>.
-
- <p>One of the advantages of long-named options is that they can be
+</p>
+<p>One of the advantages of long-named options is that they can be
consistent from program to program. For example, users should be able
to expect the “verbose” option of any GNU program which has one,
to be
-spelled precisely ‘<samp><span
class="samp">--verbose</span></samp>’. To achieve this uniformity, look
at
+spelled precisely ‘<samp>--verbose</samp>’. To achieve this
uniformity, look at
the table of common long-option names when you choose the option names
for your program (see <a href="Option-Table.html#Option-Table">Option
Table</a>).
-
- <p>It is usually a good idea for file names given as ordinary arguments to
+</p>
+<p>It is usually a good idea for file names given as ordinary arguments to
be input files only; any output files would be specified using options
-(preferably ‘<samp><span class="samp">-o</span></samp>’ or
‘<samp><span class="samp">--output</span></samp>’). Even if you
allow an output
+(preferably ‘<samp>-o</samp>’ or
‘<samp>--output</samp>’). Even if you allow an output
file name as an ordinary argument for compatibility, try to provide an
option as another way to specify it. This will lead to more consistency
among GNU utilities, and fewer idiosyncrasies for users to remember.
-
- <p><a name="index-standard-command_002dline-options-53"></a><a
name="index-options_002c-standard-command_002dline-54"></a><a
name="index-CGI-programs_002c-standard-options-for-55"></a><a
name="index-PATH_005fINFO_002c-specifying-standard-options-as-56"></a>All
programs should support two standard options: ‘<samp><span
class="samp">--version</span></samp>’
-and ‘<samp><span class="samp">--help</span></samp>’. CGI programs
should accept these as command-line
-options, and also if given as the <samp><span
class="env">PATH_INFO</span></samp>; for instance,
-visiting <a
href="http://example.org/p.cgi/--help";>http://example.org/p.cgi/–help</a>
in a browser should
-output the same information as invoking ‘<samp><span class="samp">p.cgi
--help</span></samp>’ from the
+</p>
+<a name="index-standard-command_002dline-options"></a>
+<a name="index-options_002c-standard-command_002dline"></a>
+<a name="index-CGI-programs_002c-standard-options-for"></a>
+<a name="index-PATH_005fINFO_002c-specifying-standard-options-as"></a>
+<p>All programs should support two standard options:
‘<samp>--version</samp>’
+and ‘<samp>--help</samp>’. CGI programs should accept these as
command-line
+options, and also if given as the <code>PATH_INFO</code>; for instance,
+visiting <a
href="http://example.org/p.cgi/--help";>http://example.org/p.cgi/--help</a> in a
browser should
+output the same information as invoking ‘<samp>p.cgi
--help</samp>’ from the
command line.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="_002d_002dversion.html#g_t_002d_002dversion"
accesskey="1">--version</a>:</td><td> </td><td align="left"
valign="top">The standard output for –version.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="_002d_002dhelp.html#g_t_002d_002dhelp"
accesskey="2">--help</a>:</td><td> </td><td align="left"
valign="top">The standard output for –help.
+</td></tr>
+</table>
+
+<hr>
+<div class="header">
+<p>
+Next: <a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
accesskey="n" rel="next">Dynamic Plug-In Interfaces</a>, Previous: <a
href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="p"
rel="previous">Graphical Interfaces</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
-<ul class="menu">
-<li><a accesskey="1"
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a>: The
standard output for --version.
-<li><a accesskey="2" href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a>:
The standard output for --help.
-</ul>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Comments.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Comments.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Comments.html 8 Apr 2012 00:23:48 -0000 1.54
+++ standards/html_node/Comments.html 7 May 2012 00:48:07 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Comments - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="Formatting.html#Formatting" title="Formatting">
-<link rel="next" href="Syntactic-Conventions.html#Syntactic-Conventions"
title="Syntactic Conventions">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,50 +11,80 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Comments</title>
+
+<meta name="description" content="GNU Coding Standards: Comments">
+<meta name="keywords" content="GNU Coding Standards: Comments">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Syntactic-Conventions.html#Syntactic-Conventions" rel="next"
title="Syntactic Conventions">
+<link href="Formatting.html#Formatting" rel="previous" title="Formatting">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Comments"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a>,
-Previous: <a rel="previous" accesskey="p"
href="Formatting.html#Formatting">Formatting</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="Syntactic-Conventions.html#Syntactic-Conventions" accesskey="n"
rel="next">Syntactic Conventions</a>, Previous: <a
href="Formatting.html#Formatting" accesskey="p" rel="previous">Formatting</a>,
Up: <a href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Commenting-Your-Work"></a>
<h3 class="section">5.2 Commenting Your Work</h3>
+<a name="index-commenting"></a>
-<p><a name="index-commenting-86"></a>
-Every program should start with a comment saying briefly what it is for.
-Example: ‘<samp><span class="samp">fmt - filter for simple filling of
text</span></samp>’. This comment
-should be at the top of the source file containing the ‘<samp><span
class="samp">main</span></samp>’
+<p>Every program should start with a comment saying briefly what it is for.
+Example: ‘<samp>fmt - filter for simple filling of text</samp>’.
This comment
+should be at the top of the source file containing the
‘<samp>main</samp>’
function of the program.
-
- <p>Also, please write a brief comment at the start of each source file,
+</p>
+<p>Also, please write a brief comment at the start of each source file,
with the file name and a line or two about the overall purpose of the
file.
-
- <p>Please write the comments in a GNU program in English, because English
+</p>
+<p>Please write the comments in a GNU program in English, because English
is the one language that nearly all programmers in all countries can
read. If you do not write English well, please write comments in
English as well as you can, then ask other people to help rewrite them.
-If you can't write comments in English, please find someone to work with
+If you can’t write comments in English, please find someone to work with
you and translate your comments into English.
-
- <p>Please put a comment on each function saying what the function does,
+</p>
+<p>Please put a comment on each function saying what the function does,
what sorts of arguments it gets, and what the possible values of
arguments mean and are used for. It is not necessary to duplicate in
words the meaning of the C argument declarations, if a C type is being
@@ -74,59 +94,75 @@
possible values that would not work the way one would expect (such as,
that strings containing newlines are not guaranteed to work), be sure
to say so.
-
- <p>Also explain the significance of the return value, if there is one.
-
- <p>Please put two spaces after the end of a sentence in your comments, so
+</p>
+<p>Also explain the significance of the return value, if there is one.
+</p>
+<p>Please put two spaces after the end of a sentence in your comments, so
that the Emacs sentence commands will work. Also, please write
complete sentences and capitalize the first word. If a lower-case
-identifier comes at the beginning of a sentence, don't capitalize it!
-Changing the spelling makes it a different identifier. If you don't
+identifier comes at the beginning of a sentence, don’t capitalize it!
+Changing the spelling makes it a different identifier. If you don’t
like starting a sentence with a lower case letter, write the sentence
-differently (e.g., “The identifier lower-case is <small
class="dots">...</small>”).
-
- <p>The comment on a function is much clearer if you use the argument
+differently (e.g., “The identifier lower-case is …”).
+</p>
+<p>The comment on a function is much clearer if you use the argument
names to speak about the argument values. The variable name itself
should be lower case, but write it in upper case when you are speaking
about the value rather than the variable itself. Thus, “the inode
number NODE_NUM” rather than “an inode”.
-
- <p>There is usually no purpose in restating the name of the function in
+</p>
+<p>There is usually no purpose in restating the name of the function in
the comment before it, because readers can see that for themselves.
There might be an exception when the comment is so long that the function
itself would be off the bottom of the screen.
-
- <p>There should be a comment on each static variable as well, like this:
-
-<pre class="example"> /* Nonzero means truncate lines in the display;
+</p>
+<p>There should be a comment on each static variable as well, like this:
+</p>
+<div class="example">
+<pre class="example">/* Nonzero means truncate lines in the display;
zero means continue them. */
- int truncate_lines;
-</pre>
- <p><a name="index-conditionals_002c-comments-for-87"></a><a
name="index-g_t_0040code_007b_0023endif_007d_002c-commenting-88"></a>Every
‘<samp><span class="samp">#endif</span></samp>’ should have a
comment, except in the case of short
+int truncate_lines;
+</pre></div>
+
+<a name="index-conditionals_002c-comments-for"></a>
+<a name="index-_0023endif_002c-commenting"></a>
+<p>Every ‘<samp>#endif</samp>’ should have a comment, except in
the case of short
conditionals (just a few lines) that are not nested. The comment should
state the condition of the conditional that is ending, <em>including
-its sense</em>. ‘<samp><span class="samp">#else</span></samp>’
should have a comment describing the condition
+its sense</em>. ‘<samp>#else</samp>’ should have a comment
describing the condition
<em>and sense</em> of the code that follows. For example:
+</p>
+<div class="example">
+<pre class="example">#ifdef foo
+ …
+#else /* not foo */
+ …
+#endif /* not foo */
+</pre><pre class="example">#ifdef foo
+ …
+#endif /* foo */
+</pre></div>
+
+<p>but, by contrast, write the comments this way for a
‘<samp>#ifndef</samp>’:
+</p>
+<div class="example">
+<pre class="example">#ifndef foo
+ …
+#else /* foo */
+ …
+#endif /* foo */
+</pre><pre class="example">#ifndef foo
+ …
+#endif /* not foo */
+</pre></div>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Syntactic-Conventions.html#Syntactic-Conventions" accesskey="n"
rel="next">Syntactic Conventions</a>, Previous: <a
href="Formatting.html#Formatting" accesskey="p" rel="previous">Formatting</a>,
Up: <a href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
-<pre class="example"> #ifdef foo
- ...
- #else /* not foo */
- ...
- #endif /* not foo */
- #ifdef foo
- ...
- #endif /* foo */
-</pre>
- <p class="noindent">but, by contrast, write the comments this way for a
‘<samp><span class="samp">#ifndef</span></samp>’:
-
-<pre class="example"> #ifndef foo
- ...
- #else /* foo */
- ...
- #endif /* foo */
- #ifndef foo
- ...
- #endif /* not foo */
-</pre>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Compatibility.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Compatibility.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Compatibility.html 8 Apr 2012 00:23:48 -0000
1.54
+++ standards/html_node/Compatibility.html 7 May 2012 00:48:07 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Compatibility - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Design-Advice.html#Design-Advice" title="Design Advice">
-<link rel="prev" href="Source-Language.html#Source-Language" title="Source
Language">
-<link rel="next" href="Using-Extensions.html#Using-Extensions" title="Using
Extensions">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,62 +11,98 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Compatibility</title>
+
+<meta name="description" content="GNU Coding Standards: Compatibility">
+<meta name="keywords" content="GNU Coding Standards: Compatibility">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Design-Advice.html#Design-Advice" rel="up" title="Design Advice">
+<link href="Using-Extensions.html#Using-Extensions" rel="next" title="Using
Extensions">
+<link href="Source-Language.html#Source-Language" rel="previous" title="Source
Language">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Compatibility"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Using-Extensions.html#Using-Extensions">Using Extensions</a>,
-Previous: <a rel="previous" accesskey="p"
href="Source-Language.html#Source-Language">Source Language</a>,
-Up: <a rel="up" accesskey="u"
href="Design-Advice.html#Design-Advice">Design Advice</a>
-<hr>
+Next: <a href="Using-Extensions.html#Using-Extensions" accesskey="n"
rel="next">Using Extensions</a>, Previous: <a
href="Source-Language.html#Source-Language" accesskey="p" rel="previous">Source
Language</a>, Up: <a href="Design-Advice.html#Design-Advice" accesskey="u"
rel="up">Design Advice</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Compatibility-with-Other-Implementations"></a>
<h3 class="section">3.2 Compatibility with Other Implementations</h3>
+<a name="index-compatibility-with-C-and-POSIX-standards"></a>
+<a name="index-POSIX-compatibility"></a>
-<p><a
name="index-compatibility-with-C-and-_0040sc_007bposix_007d-standards-17"></a><a
name="index-g_t_0040sc_007bposix_007d-compatibility-18"></a>
-With occasional exceptions, utility programs and libraries for GNU
+<p>With occasional exceptions, utility programs and libraries for GNU
should be upward compatible with those in Berkeley Unix, and upward
compatible with Standard C if Standard C specifies their
-behavior, and upward compatible with <span class="sc">posix</span> if <span
class="sc">posix</span> specifies
+behavior, and upward compatible with <small>POSIX</small> if
<small>POSIX</small> specifies
their behavior.
-
- <p>When these standards conflict, it is useful to offer compatibility
+</p>
+<p>When these standards conflict, it is useful to offer compatibility
modes for each of them.
-
- <p><a name="index-options-for-compatibility-19"></a>Standard C and <span
class="sc">posix</span> prohibit many kinds of extensions. Feel
-free to make the extensions anyway, and include a ‘<samp><span
class="samp">--ansi</span></samp>’,
-‘<samp><span class="samp">--posix</span></samp>’, or
‘<samp><span class="samp">--compatible</span></samp>’ option to
turn them off.
+</p>
+<a name="index-options-for-compatibility"></a>
+<p>Standard C and <small>POSIX</small> prohibit many kinds of extensions. Feel
+free to make the extensions anyway, and include a
‘<samp>--ansi</samp>’,
+‘<samp>--posix</samp>’, or ‘<samp>--compatible</samp>’
option to turn them off.
However, if the extension has a significant chance of breaking any real
programs or scripts, then it is not really upward compatible. So you
should try to redesign its interface to make it upward compatible.
-
- <p><a
name="index-g_t_0040code_007bPOSIXLY_005fCORRECT_007d_002c-environment-variable-20"></a>Many
GNU programs suppress extensions that conflict with <span
class="sc">posix</span> if the
+</p>
+<a name="index-POSIXLY_005fCORRECT_002c-environment-variable"></a>
+<p>Many GNU programs suppress extensions that conflict with
<small>POSIX</small> if the
environment variable <code>POSIXLY_CORRECT</code> is defined (even if it is
defined with a null value). Please make your program recognize this
variable if appropriate.
-
- <p>When a feature is used only by users (not by programs or command
+</p>
+<p>When a feature is used only by users (not by programs or command
files), and it is done poorly in Unix, feel free to replace it
completely with something totally different and better. (For example,
<code>vi</code> is replaced with Emacs.) But it is nice to offer a compatible
feature as well. (There is a free <code>vi</code> clone, so we offer it.)
-
- <p>Additional useful features are welcome regardless of whether
+</p>
+<p>Additional useful features are welcome regardless of whether
there is any precedent for them.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Conditional-Changes.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Conditional-Changes.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Conditional-Changes.html 8 Apr 2012 00:23:48
-0000 1.54
+++ standards/html_node/Conditional-Changes.html 7 May 2012 00:48:07
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Conditional Changes - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Change-Logs.html#Change-Logs" title="Change Logs">
-<link rel="prev" href="Simple-Changes.html#Simple-Changes" title="Simple
Changes">
-<link rel="next"
href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed"
title="Indicating the Part Changed">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,82 +11,129 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Conditional Changes</title>
+
+<meta name="description" content="GNU Coding Standards: Conditional Changes">
+<meta name="keywords" content="GNU Coding Standards: Conditional Changes">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Change-Logs.html#Change-Logs" rel="up" title="Change Logs">
+<link href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed"
rel="next" title="Indicating the Part Changed">
+<link href="Simple-Changes.html#Simple-Changes" rel="previous" title="Simple
Changes">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Conditional-Changes"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed">Indicating
the Part Changed</a>,
-Previous: <a rel="previous" accesskey="p"
href="Simple-Changes.html#Simple-Changes">Simple Changes</a>,
-Up: <a rel="up" accesskey="u" href="Change-Logs.html#Change-Logs">Change
Logs</a>
-<hr>
+Next: <a href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed"
accesskey="n" rel="next">Indicating the Part Changed</a>, Previous: <a
href="Simple-Changes.html#Simple-Changes" accesskey="p" rel="previous">Simple
Changes</a>, Up: <a href="Change-Logs.html#Change-Logs" accesskey="u"
rel="up">Change Logs</a> [<a href="index.html#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="Index.html#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Conditional-Changes-1"></a>
<h4 class="subsection">6.8.4 Conditional Changes</h4>
+<a name="index-conditional-changes_002c-and-change-logs"></a>
+<a name="index-change-logs_002c-conditional-changes"></a>
-<p><a name="index-conditional-changes_002c-and-change-logs-138"></a><a
name="index-change-logs_002c-conditional-changes-139"></a>
-Source files can often contain code that is conditional to build-time
+<p>Source files can often contain code that is conditional to build-time
or static conditions. For example, C programs can contain
compile-time <code>#if</code> conditionals; programs implemented in
interpreted languages can contain module imports of function
definitions that are only performed for certain versions of the
-interpreter; and Automake <samp><span class="file">Makefile.am</span></samp>
files can contain
+interpreter; and Automake ‘<tt>Makefile.am</tt>’ files can contain
variable definitions or target declarations that are only to be
considered if a configure-time Automake conditional is true.
-
- <p>Many changes are conditional as well: sometimes you add a new variable,
+</p>
+<p>Many changes are conditional as well: sometimes you add a new variable,
or function, or even a new program or library, which is entirely
dependent on a build-time condition. It is useful to indicate
in the change log the conditions for which a change applies.
-
- <p>Our convention for indicating conditional changes is to use
+</p>
+<p>Our convention for indicating conditional changes is to use
<em>square brackets around the name of the condition</em>.
-
- <p>Conditional changes can happen in numerous scenarios and with many
+</p>
+<p>Conditional changes can happen in numerous scenarios and with many
variations, so here are some examples to help clarify. This first
example describes changes in C, Perl, and Python files which are
conditional but do not have an associated function or entity name:
-
-<pre class="example"> * xterm.c [SOLARIS2]: Include <string.h>.
- * FilePath.pm [$^O eq 'VMS']: Import the VMS::Feature module.
- * framework.py [sys.version_info < (2, 6)]: Make "with" statement
+</p>
+<div class="example">
+<pre class="example">* xterm.c [SOLARIS2]: Include <string.h>.
+* FilePath.pm [$^O eq 'VMS']: Import the VMS::Feature module.
+* framework.py [sys.version_info < (2, 6)]: Make "with" statement
available by importing it from __future__,
to support also python 2.5.
-</pre>
- <p>Our other examples will for simplicity be limited to C, as the minor
+</pre></div>
+
+<p>Our other examples will for simplicity be limited to C, as the minor
changes necessary to adapt them to other languages should be
self-evident.
-
- <p>Next, here is an entry describing a new definition which is entirely
+</p>
+<p>Next, here is an entry describing a new definition which is entirely
conditional: the C macro <code>FRAME_WINDOW_P</code> is defined (and used)
only when the macro <code>HAVE_X_WINDOWS</code> is defined:
+</p>
+<div class="example">
+<pre class="example">* frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P): Macro
defined.
+</pre></div>
-<pre class="example"> * frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P): Macro
defined.
-</pre>
- <p>Next, an entry for a change within the function
<code>init_display</code>,
+<p>Next, an entry for a change within the function <code>init_display</code>,
whose definition as a whole is unconditional, but the changes
-themselves are contained in a ‘<samp><span class="samp">#ifdef
HAVE_LIBNCURSES</span></samp>’
+themselves are contained in a ‘<samp>#ifdef HAVE_LIBNCURSES</samp>’
conditional:
+</p>
+<div class="example">
+<pre class="example">* dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call
tgetent.
+</pre></div>
-<pre class="example"> * dispnew.c (init_display) [HAVE_LIBNCURSES]: If X,
call tgetent.
-</pre>
- <p>Finally, here is an entry for a change that takes effect only when
+<p>Finally, here is an entry for a change that takes effect only when
a certain macro is <em>not</em> defined:
+</p>
+<div class="example">
+<pre class="example">(gethostname) [!HAVE_SOCKETS]: Replace with winsock
version.
+</pre></div>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed"
accesskey="n" rel="next">Indicating the Part Changed</a>, Previous: <a
href="Simple-Changes.html#Simple-Changes" accesskey="p" rel="previous">Simple
Changes</a>, Up: <a href="Change-Logs.html#Change-Logs" accesskey="u"
rel="up">Change Logs</a> [<a href="index.html#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="Index.html#Index"
title="Index" rel="index">Index</a>]</p>
+</div>
+
-<pre class="example"> (gethostname) [!HAVE_SOCKETS]: Replace with winsock
version.
-</pre>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Conditional-Compilation.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Conditional-Compilation.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Conditional-Compilation.html 8 Apr 2012 00:23:49
-0000 1.54
+++ standards/html_node/Conditional-Compilation.html 7 May 2012 00:48:07
-0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Conditional Compilation - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Design-Advice.html#Design-Advice" title="Design Advice">
-<link rel="prev" href="Standard-C.html#Standard-C" title="Standard C">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,70 +11,110 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Conditional Compilation</title>
+
+<meta name="description" content="GNU Coding Standards: Conditional
Compilation">
+<meta name="keywords" content="GNU Coding Standards: Conditional Compilation">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Design-Advice.html#Design-Advice" rel="up" title="Design Advice">
+<link href="Program-Behavior.html#Program-Behavior" rel="next" title="Program
Behavior">
+<link href="Standard-C.html#Standard-C" rel="previous" title="Standard C">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Conditional-Compilation"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Standard-C.html#Standard-C">Standard C</a>,
-Up: <a rel="up" accesskey="u"
href="Design-Advice.html#Design-Advice">Design Advice</a>
-<hr>
+Previous: <a href="Standard-C.html#Standard-C" accesskey="p"
rel="previous">Standard C</a>, Up: <a href="Design-Advice.html#Design-Advice"
accesskey="u" rel="up">Design Advice</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Conditional-Compilation-1"></a>
<h3 class="section">3.5 Conditional Compilation</h3>
<p>When supporting configuration options already known when building your
program we prefer using <code>if (... )</code> over conditional compilation,
as in the former case the compiler is able to perform more extensive
checking of all possible code paths.
-
- <p>For example, please write
-
+</p>
+<p>For example, please write
+</p>
+<div class="smallexample">
<pre class="smallexample"> if (HAS_FOO)
...
else
...
-</pre>
- <p class="noindent">instead of:
+</pre></div>
+<p>instead of:
+</p>
+<div class="smallexample">
<pre class="smallexample"> #ifdef HAS_FOO
...
#else
...
#endif
-</pre>
- <p>A modern compiler such as GCC will generate exactly the same code in
+</pre></div>
+
+<p>A modern compiler such as GCC will generate exactly the same code in
both cases, and we have been using similar techniques with good success
in several projects. Of course, the former method assumes that
<code>HAS_FOO</code> is defined as either 0 or 1.
-
- <p>While this is not a silver bullet solving all portability problems,
+</p>
+<p>While this is not a silver bullet solving all portability problems,
and is not always appropriate, following this policy would have saved
GCC developers many hours, or even days, per year.
-
- <p>In the case of function-like macros like <code>REVERSIBLE_CC_MODE</code>
in
+</p>
+<p>In the case of function-like macros like <code>REVERSIBLE_CC_MODE</code> in
GCC which cannot be simply used in <code>if (...)</code> statements, there is
an easy workaround. Simply introduce another macro
<code>HAS_REVERSIBLE_CC_MODE</code> as in the following example:
-
+</p>
+<div class="smallexample">
<pre class="smallexample"> #ifdef REVERSIBLE_CC_MODE
#define HAS_REVERSIBLE_CC_MODE 1
#else
#define HAS_REVERSIBLE_CC_MODE 0
#endif
-</pre>
- </body></html>
+</pre></div>
+
+
+
+</body>
+</html>
Index: standards/html_node/Configuration.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Configuration.html,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -b -r1.56 -r1.57
--- standards/html_node/Configuration.html 8 Apr 2012 00:23:49 -0000
1.56
+++ standards/html_node/Configuration.html 7 May 2012 00:48:07 -0000
1.57
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Configuration - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Managing-Releases.html#Managing-Releases" title="Managing
Releases">
-<link rel="next" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,223 +11,272 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Configuration</title>
+
+<meta name="description" content="GNU Coding Standards: Configuration">
+<meta name="keywords" content="GNU Coding Standards: Configuration">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Managing-Releases.html#Managing-Releases" rel="up" title="Managing
Releases">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="next"
title="Makefile Conventions">
+<link href="Managing-Releases.html#Managing-Releases" rel="previous"
title="Managing Releases">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Configuration"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>,
-Up: <a rel="up" accesskey="u"
href="Managing-Releases.html#Managing-Releases">Managing Releases</a>
-<hr>
+Next: <a href="Makefile-Conventions.html#Makefile-Conventions" accesskey="n"
rel="next">Makefile Conventions</a>, Up: <a
href="Managing-Releases.html#Managing-Releases" accesskey="u" rel="up">Managing
Releases</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="How-Configuration-Should-Work"></a>
<h3 class="section">7.1 How Configuration Should Work</h3>
+<a name="index-program-configuration"></a>
-<p><a name="index-program-configuration-142"></a>
-<a name="index-configure-143"></a>Each GNU distribution should come with a
shell script named
+<a name="index-configure"></a>
+<p>Each GNU distribution should come with a shell script named
<code>configure</code>. This script is given arguments which describe the
kind of machine and system you want to compile the program for.
The <code>configure</code> script must record the configuration options so
that they affect compilation.
-
- <p>The description here is the specification of the interface for the
+</p>
+<p>The description here is the specification of the interface for the
<code>configure</code> script in GNU packages. Many packages implement it
-using GNU Autoconf (see <a href="../autoconf/index.html#Top">Introduction</a>)
-and/or GNU Automake (see <a
href="../automake/index.html#Top">Introduction</a>),
+using GNU Autoconf (see <a
href="http://www.gnu.org/software/autoconf/manual/html_node/index.html#Top";>Introduction</a>
in <cite>Autoconf</cite>)
+and/or GNU Automake (see <a
href="http://www.gnu.org/software/automake/manual/html_node/index.html#Top";>Introduction</a>
in <cite>Automake</cite>),
but you do not have to use these tools. You can implement it any way
you like; for instance, by making <code>configure</code> be a wrapper around
a completely different configuration system.
-
- <p>Another way for the <code>configure</code> script to operate is to make a
-link from a standard name such as <samp><span
class="file">config.h</span></samp> to the proper
+</p>
+<p>Another way for the <code>configure</code> script to operate is to make a
+link from a standard name such as ‘<tt>config.h</tt>’ to the proper
configuration file for the chosen system. If you use this technique,
the distribution should <em>not</em> contain a file named
-<samp><span class="file">config.h</span></samp>. This is so that people won't
be able to build the
+‘<tt>config.h</tt>’. This is so that people won’t be able
to build the
program without configuring it first.
-
- <p>Another thing that <code>configure</code> can do is to edit the
Makefile. If
+</p>
+<p>Another thing that <code>configure</code> can do is to edit the Makefile.
If
you do this, the distribution should <em>not</em> contain a file named
-<samp><span class="file">Makefile</span></samp>. Instead, it should include a
file <samp><span class="file">Makefile.in</span></samp> which
+‘<tt>Makefile</tt>’. Instead, it should include a file
‘<tt>Makefile.in</tt>’ which
contains the input used for editing. Once again, this is so that people
-won't be able to build the program without configuring it first.
-
- <p>If <code>configure</code> does write the <samp><span
class="file">Makefile</span></samp>, then <samp><span
class="file">Makefile</span></samp>
-should have a target named <samp><span class="file">Makefile</span></samp>
which causes <code>configure</code>
+won’t be able to build the program without configuring it first.
+</p>
+<p>If <code>configure</code> does write the ‘<tt>Makefile</tt>’,
then ‘<tt>Makefile</tt>’
+should have a target named ‘<tt>Makefile</tt>’ which causes
<code>configure</code>
to be rerun, setting up the same configuration that was set up last
time. The files that <code>configure</code> reads should be listed as
-dependencies of <samp><span class="file">Makefile</span></samp>.
-
- <p>All the files which are output from the <code>configure</code> script
should
+dependencies of ‘<tt>Makefile</tt>’.
+</p>
+<p>All the files which are output from the <code>configure</code> script should
have comments at the beginning explaining that they were generated
-automatically using <code>configure</code>. This is so that users won't think
+automatically using <code>configure</code>. This is so that users won’t
think
of trying to edit them by hand.
-
- <p>The <code>configure</code> script should write a file named <samp><span
class="file">config.status</span></samp>
+</p>
+<p>The <code>configure</code> script should write a file named
‘<tt>config.status</tt>’
which describes which configuration options were specified when the
program was last configured. This file should be a shell script which,
if run, will recreate the same configuration.
-
- <p>The <code>configure</code> script should accept an option of the form
-‘<samp><span
class="samp">--srcdir=</span><var>dirname</var></samp>’ to specify the
directory where sources are found
+</p>
+<p>The <code>configure</code> script should accept an option of the form
+‘<samp>--srcdir=<var>dirname</var></samp>’ to specify the
directory where sources are found
(if it is not the current directory). This makes it possible to build
the program in a separate directory, so that the actual source directory
is not modified.
-
- <p>If the user does not specify ‘<samp><span
class="samp">--srcdir</span></samp>’, then <code>configure</code> should
-check both <samp><span class="file">.</span></samp> and <samp><span
class="file">..</span></samp> to see if it can find the sources. If
+</p>
+<p>If the user does not specify ‘<samp>--srcdir</samp>’, then
<code>configure</code> should
+check both ‘<tt>.</tt>’ and ‘<tt>..</tt>’ to see if it
can find the sources. If
it finds the sources in one of these places, it should use them from
there. Otherwise, it should report that it cannot find the sources, and
should exit with nonzero status.
-
- <p>Usually the easy way to support ‘<samp><span
class="samp">--srcdir</span></samp>’ is by editing a
+</p>
+<p>Usually the easy way to support ‘<samp>--srcdir</samp>’ is by
editing a
definition of <code>VPATH</code> into the Makefile. Some rules may need to
refer explicitly to the specified source directory. To make this
possible, <code>configure</code> can add to the Makefile a variable named
<code>srcdir</code> whose value is precisely the specified directory.
-
- <p>In addition, the ‘<samp><span
class="samp">configure</span></samp>’ script should take options
+</p>
+<p>In addition, the ‘<samp>configure</samp>’ script should take
options
corresponding to most of the standard directory variables
(see <a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a>). Here is the list:
+</p>
+<div class="example">
+<pre class="example">--prefix --exec-prefix --bindir --sbindir --libexecdir
--sysconfdir
+--sharedstatedir --localstatedir --libdir --includedir --oldincludedir
+--datarootdir --datadir --infodir --localedir --mandir --docdir
+--htmldir --dvidir --pdfdir --psdir
+</pre></div>
-<pre class="example"> --prefix --exec-prefix --bindir --sbindir
--libexecdir --sysconfdir
- --sharedstatedir --localstatedir --libdir --includedir --oldincludedir
- --datarootdir --datadir --infodir --localedir --mandir --docdir
- --htmldir --dvidir --pdfdir --psdir
-</pre>
- <p>The <code>configure</code> script should also take an argument which
specifies the
+<p>The <code>configure</code> script should also take an argument which
specifies the
type of system to build the program for. This argument should look like
this:
-
-<pre class="example"> <var>cpu</var>-<var>company</var>-<var>system</var>
-</pre>
- <p>For example, an Athlon-based GNU/Linux system might be
-‘<samp><span class="samp">i686-pc-linux-gnu</span></samp>’.
-
- <p>The <code>configure</code> script needs to be able to decode all
plausible
+</p>
+<div class="example">
+<pre class="example"><var>cpu</var>-<var>company</var>-<var>system</var>
+</pre></div>
+
+<p>For example, an Athlon-based GNU/Linux system might be
+‘<samp>i686-pc-linux-gnu</samp>’.
+</p>
+<p>The <code>configure</code> script needs to be able to decode all plausible
alternatives for how to describe a machine. Thus,
-‘<samp><span class="samp">athlon-pc-gnu/linux</span></samp>’ would
be a valid alias. There is a shell
+‘<samp>athlon-pc-gnu/linux</samp>’ would be a valid alias. There
is a shell
script called
-<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD";><samp><span
class="file">config.sub</span></samp></a> that you can use as a subroutine to
validate system
+<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub;hb=HEAD";>‘<tt>config.sub</tt>’</a>
that you can use as a subroutine to validate system
types and canonicalize aliases.
-
- <p>The <code>configure</code> script should also take the option
-<samp><span class="option">--build=</span><var>buildtype</var></samp>, which
should be equivalent to a
-plain <var>buildtype</var> argument. For example, ‘<samp><span
class="samp">configure
---build=i686-pc-linux-gnu</span></samp>’ is equivalent to
‘<samp><span class="samp">configure
-i686-pc-linux-gnu</span></samp>’. When the build type is not specified
by an option
+</p>
+<p>The <code>configure</code> script should also take the option
+‘<samp>--build=<var>buildtype</var></samp>’, which should be
equivalent to a
+plain <var>buildtype</var> argument. For example, ‘<samp>configure
+--build=i686-pc-linux-gnu</samp>’ is equivalent to ‘<samp>configure
+i686-pc-linux-gnu</samp>’. When the build type is not specified by an
option
or argument, the <code>configure</code> script should normally guess it using
the shell script
-<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD";><samp><span
class="file">config.guess</span></samp></a>.
-
- <p><a name="index-optional-features_002c-configure_002dtime-144"></a>Other
options are permitted to specify in more detail the software
+<a
href="http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.guess;hb=HEAD";>‘<tt>config.guess</tt>’</a>.
+</p>
+<a name="index-optional-features_002c-configure_002dtime"></a>
+<p>Other options are permitted to specify in more detail the software
or hardware present on the machine, to include or exclude optional parts
of the package, or to adjust the name of some tools or arguments to them:
-
- <dl>
-<dt>‘<samp><span class="samp">--enable-</span><var>feature</var><span
class="samp">[=</span><var>parameter</var><span
class="samp">]</span></samp>’<dd>Configure the package to build and
install an optional user-level
+</p>
+<dl compact="compact">
+<dt>‘<samp>--enable-<var>feature</var><span
class="roman">[</span>=<var>parameter</var><span
class="roman">]</span></samp>’</dt>
+<dd><p>Configure the package to build and install an optional user-level
facility called <var>feature</var>. This allows users to choose which
optional features to include. Giving an optional <var>parameter</var> of
-‘<samp><span class="samp">no</span></samp>’ should omit
<var>feature</var>, if it is built by default.
-
- <p>No ‘<samp><span class="samp">--enable</span></samp>’
option should <strong>ever</strong> cause one feature to
-replace another. No ‘<samp><span
class="samp">--enable</span></samp>’ option should ever substitute one
+‘<samp>no</samp>’ should omit <var>feature</var>, if it is built
by default.
+</p>
+<p>No ‘<samp>--enable</samp>’ option should <strong>ever</strong>
cause one feature to
+replace another. No ‘<samp>--enable</samp>’ option should ever
substitute one
useful behavior for another useful behavior. The only proper use for
-‘<samp><span class="samp">--enable</span></samp>’ is for questions
of whether to build part of the program
+‘<samp>--enable</samp>’ is for questions of whether to build part
of the program
or exclude it.
-
- <br><dt>‘<samp><span
class="samp">--with-</span><var>package</var></samp>’<dd><!--
@address@hidden@r{]} -->
-The package <var>package</var> will be installed, so configure this package
+</p>
+</dd>
+<dt>‘<samp>--with-<var>package</var></samp>’</dt>
+<dd><p>The package <var>package</var> will be installed, so configure this
package
to work with <var>package</var>.
+</p>
- <!-- Giving an optional @var{parameter} of -->
- <!-- @samp{no} should omit @var{package}, if it is used by default. -->
- <p>Possible values of <var>package</var> include
-‘<samp><span class="samp">gnu-as</span></samp>’ (or
‘<samp><span class="samp">gas</span></samp>’), ‘<samp><span
class="samp">gnu-ld</span></samp>’, ‘<samp><span
class="samp">gnu-libc</span></samp>’,
-‘<samp><span class="samp">gdb</span></samp>’,
-‘<samp><span class="samp">x</span></samp>’,
+<p>Possible values of <var>package</var> include
+‘<samp>gnu-as</samp>’ (or ‘<samp>gas</samp>’),
‘<samp>gnu-ld</samp>’, ‘<samp>gnu-libc</samp>’,
+‘<samp>gdb</samp>’,
+‘<samp>x</samp>’,
and
-‘<samp><span class="samp">x-toolkit</span></samp>’.
-
- <p>Do not use a ‘<samp><span
class="samp">--with</span></samp>’ option to specify the file name to use
to
-find certain files. That is outside the scope of what ‘<samp><span
class="samp">--with</span></samp>’
+‘<samp>x-toolkit</samp>’.
+</p>
+<p>Do not use a ‘<samp>--with</samp>’ option to specify the file
name to use to
+find certain files. That is outside the scope of what
‘<samp>--with</samp>’
options are for.
-
- <br><dt>‘<samp><var>variable</var><span
class="samp">=</span><var>value</var></samp>’<dd>Set the value of the
variable <var>variable</var> to <var>value</var>. This is
+</p>
+</dd>
+<dt>‘<samp><var>variable</var>=<var>value</var></samp>’</dt>
+<dd><p>Set the value of the variable <var>variable</var> to <var>value</var>.
This is
used to override the default values of commands or arguments in the
-build process. For example, the user could issue ‘<samp><span
class="samp">configure
-CFLAGS=-g CXXFLAGS=-g</span></samp>’ to build with debugging information
and without
+build process. For example, the user could issue ‘<samp>configure
+CFLAGS=-g CXXFLAGS=-g</samp>’ to build with debugging information and
without
the default optimization.
-
- <p>Specifying variables as arguments to <code>configure</code>, like this:
- <pre class="example"> ./configure CC=gcc
-</pre>
- <p>is preferable to setting them in environment variables:
- <pre class="example"> CC=gcc ./configure
-</pre>
- <p>as it helps to recreate the same configuration later with
-<samp><span class="file">config.status</span></samp>. However, both methods
should be supported.
+</p>
+<p>Specifying variables as arguments to <code>configure</code>, like this:
+</p><div class="example">
+<pre class="example">./configure CC=gcc
+</pre></div>
+<p>is preferable to setting them in environment variables:
+</p><div class="example">
+<pre class="example">CC=gcc ./configure
+</pre></div>
+<p>as it helps to recreate the same configuration later with
+‘<tt>config.status</tt>’. However, both methods should be
supported.
+</p></dd>
</dl>
- <p>All <code>configure</code> scripts should accept all of the
“detail”
+<p>All <code>configure</code> scripts should accept all of the
“detail”
options and the variable settings, whether or not they make any
difference to the particular package at hand. In particular, they
-should accept any option that starts with ‘<samp><span
class="samp">--with-</span></samp>’ or
-‘<samp><span class="samp">--enable-</span></samp>’. This is so
users will be able to configure an
+should accept any option that starts with ‘<samp>--with-</samp>’ or
+‘<samp>--enable-</samp>’. This is so users will be able to
configure an
entire GNU source tree at once with a single set of options.
-
- <p>You will note that the categories ‘<samp><span
class="samp">--with-</span></samp>’ and ‘<samp><span
class="samp">--enable-</span></samp>’
+</p>
+<p>You will note that the categories ‘<samp>--with-</samp>’ and
‘<samp>--enable-</samp>’
are narrow: they <strong>do not</strong> provide a place for any sort of option
you might think of. That is deliberate. We want to limit the possible
configuration options in GNU software. We do not want GNU programs to
have idiosyncratic configuration options.
-
- <p>Packages that perform part of the compilation process may support
+</p>
+<p>Packages that perform part of the compilation process may support
cross-compilation. In such a case, the host and target machines for the
program may be different.
-
- <p>The <code>configure</code> script should normally treat the specified
type of
+</p>
+<p>The <code>configure</code> script should normally treat the specified type
of
system as both the host and the target, thus producing a program which
works for the same type of machine that it runs on.
-
- <p>To compile a program to run on a host type that differs from the build
-type, use the configure option <samp><span
class="option">--host=</span><var>hosttype</var></samp>, where
+</p>
+<p>To compile a program to run on a host type that differs from the build
+type, use the configure option
‘<samp>--host=<var>hosttype</var></samp>’, where
<var>hosttype</var> uses the same syntax as <var>buildtype</var>. The host
type
normally defaults to the build type.
-
- <p>To configure a cross-compiler, cross-assembler, or what have you, you
+</p>
+<p>To configure a cross-compiler, cross-assembler, or what have you, you
should specify a target different from the host, using the configure
-option ‘<samp><span
class="samp">--target=</span><var>targettype</var></samp>’. The syntax
for
+option ‘<samp>--target=<var>targettype</var></samp>’. The syntax
for
<var>targettype</var> is the same as for the host type. So the command would
look like this:
+</p>
+<div class="example">
+<pre class="example">./configure --host=<var>hosttype</var>
--target=<var>targettype</var>
+</pre></div>
-<pre class="example"> ./configure --host=<var>hosttype</var>
--target=<var>targettype</var>
-</pre>
- <p>The target type normally defaults to the host type.
+<p>The target type normally defaults to the host type.
Programs for which cross-operation is not meaningful need not accept the
-‘<samp><span class="samp">--target</span></samp>’ option, because
configuring an entire operating system for
+‘<samp>--target</samp>’ option, because configuring an entire
operating system for
cross-operation is not a meaningful operation.
-
- <p>Some programs have ways of configuring themselves automatically. If
+</p>
+<p>Some programs have ways of configuring themselves automatically. If
your program is set up to do this, your <code>configure</code> script can
simply
ignore most of its arguments.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Makefile-Conventions.html#Makefile-Conventions" accesskey="n"
rel="next">Makefile Conventions</a>, Up: <a
href="Managing-Releases.html#Managing-Releases" accesskey="u" rel="up">Managing
Releases</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
-<!-- The makefile standards are in a separate file that is also -->
-<!-- included by make.texinfo. Done by address@hidden on 1/6/93. -->
-<!-- For this document, turn chapters into sections, etc. -->
-<!-- This file is included by both standards.texi and make.texinfo. -->
-<!-- It was broken out of standards.texi on 1/6/93 by roland. -->
- </body></html>
+</body>
+</html>
Index: standards/html_node/Contributions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Contributions.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Contributions.html 8 Apr 2012 00:23:49 -0000
1.54
+++ standards/html_node/Contributions.html 7 May 2012 00:48:07 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Contributions - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Legal-Issues.html#Legal-Issues" title="Legal Issues">
-<link rel="prev"
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code" title="Reading
Non-Free Code">
-<link rel="next" href="Trademarks.html#Trademarks" title="Trademarks">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,73 +11,113 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Contributions</title>
+
+<meta name="description" content="GNU Coding Standards: Contributions">
+<meta name="keywords" content="GNU Coding Standards: Contributions">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Legal-Issues.html#Legal-Issues" rel="up" title="Legal Issues">
+<link href="Trademarks.html#Trademarks" rel="next" title="Trademarks">
+<link href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code"
rel="previous" title="Reading Non-Free Code">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Contributions"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Trademarks.html#Trademarks">Trademarks</a>,
-Previous: <a rel="previous" accesskey="p"
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">Reading
Non-Free Code</a>,
-Up: <a rel="up" accesskey="u" href="Legal-Issues.html#Legal-Issues">Legal
Issues</a>
-<hr>
+Next: <a href="Trademarks.html#Trademarks" accesskey="n"
rel="next">Trademarks</a>, Previous: <a
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code" accesskey="p"
rel="previous">Reading Non-Free Code</a>, Up: <a
href="Legal-Issues.html#Legal-Issues" accesskey="u" rel="up">Legal Issues</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Accepting-Contributions"></a>
<h3 class="section">2.2 Accepting Contributions</h3>
+<a name="index-legal-papers"></a>
+<a name="index-accepting-contributions"></a>
-<p><a name="index-legal-papers-10"></a><a
name="index-accepting-contributions-11"></a>
-If the program you are working on is copyrighted by the Free Software
+<p>If the program you are working on is copyrighted by the Free Software
Foundation, then when someone else sends you a piece of code to add to
the program, we need legal papers to use it—just as we asked you to
sign papers initially. <em>Each</em> person who makes a nontrivial
contribution to a program must sign some sort of legal papers in order
for us to have clear title to the program; the main author alone is not
enough.
-
- <p>So, before adding in any contributions from other people, please tell
+</p>
+<p>So, before adding in any contributions from other people, please tell
us, so we can arrange to get the papers. Then wait until we tell you
that we have received the signed papers, before you actually use the
contribution.
-
- <p>This applies both before you release the program and afterward. If
+</p>
+<p>This applies both before you release the program and afterward. If
you receive diffs to fix a bug, and they make significant changes, we
need legal papers for that change.
-
- <p>This also applies to comments and documentation files. For copyright
+</p>
+<p>This also applies to comments and documentation files. For copyright
law, comments and code are just text. Copyright applies to all kinds of
text, so we need legal papers for all kinds.
-
- <p>We know it is frustrating to ask for legal papers; it's frustrating for
-us as well. But if you don't wait, you are going out on a limb—for
-example, what if the contributor's employer won't sign a disclaimer?
+</p>
+<p>We know it is frustrating to ask for legal papers; it’s frustrating
for
+us as well. But if you don’t wait, you are going out on a limb—for
+example, what if the contributor’s employer won’t sign a
disclaimer?
You might have to take that code out again!
-
- <p>You don't need papers for changes of a few lines here or there, since
-they are not significant for copyright purposes. Also, you don't need
+</p>
+<p>You don’t need papers for changes of a few lines here or there, since
+they are not significant for copyright purposes. Also, you don’t need
papers if all you get from the suggestion is some ideas, not actual code
which you use. For example, if someone sent you one implementation, but
-you write a different implementation of the same idea, you don't need to
+you write a different implementation of the same idea, you don’t need to
get papers.
-
- <p>The very worst thing is if you forget to tell us about the other
+</p>
+<p>The very worst thing is if you forget to tell us about the other
contributor. We could be very embarrassed in court some day as a
result.
-
- <p>We have more detailed advice for maintainers of GNU packages. If you
+</p>
+<p>We have more detailed advice for maintainers of GNU packages. If you
have reached the stage of maintaining a GNU program (whether released
-or not), please take a look: see <a
href="../maintain/Legal-Matters.html#Legal-Matters">Legal Matters</a>.
+or not), please take a look: see <a
href="http://www.gnu.org/prep/maintain/html_node/Legal-Matters.html#Legal-Matters";>Legal
Matters</a> in <cite>Information for GNU Maintainers</cite>.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Trademarks.html#Trademarks" accesskey="n"
rel="next">Trademarks</a>, Previous: <a
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code" accesskey="p"
rel="previous">Reading Non-Free Code</a>, Up: <a
href="Legal-Issues.html#Legal-Issues" accesskey="u" rel="up">Legal Issues</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/DESTDIR.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/DESTDIR.html,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -b -r1.43 -r1.44
--- standards/html_node/DESTDIR.html 8 Apr 2012 00:23:49 -0000 1.43
+++ standards/html_node/DESTDIR.html 7 May 2012 00:48:07 -0000 1.44
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>DESTDIR - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link rel="prev" href="Command-Variables.html#Command-Variables"
title="Command Variables">
-<link rel="next" href="Directory-Variables.html#Directory-Variables"
title="Directory Variables">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,76 +11,122 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: DESTDIR</title>
+
+<meta name="description" content="GNU Coding Standards: DESTDIR">
+<meta name="keywords" content="GNU Coding Standards: DESTDIR">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="up"
title="Makefile Conventions">
+<link href="Directory-Variables.html#Directory-Variables" rel="next"
title="Directory Variables">
+<link href="Command-Variables.html#Command-Variables" rel="previous"
title="Command Variables">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="DESTDIR"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Directory-Variables.html#Directory-Variables">Directory Variables</a>,
-Previous: <a rel="previous" accesskey="p"
href="Command-Variables.html#Command-Variables">Command Variables</a>,
-Up: <a rel="up" accesskey="u"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>
-<hr>
+Next: <a href="Directory-Variables.html#Directory-Variables" accesskey="n"
rel="next">Directory Variables</a>, Previous: <a
href="Command-Variables.html#Command-Variables" accesskey="p"
rel="previous">Command Variables</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="DESTDIR_003a-Support-for-Staged-Installs"></a>
<h4 class="subsection">7.2.4 <code>DESTDIR</code>: Support for Staged
Installs</h4>
-<p><a name="index-DESTDIR-148"></a><a name="index-staged-installs-149"></a><a
name="index-installations_002c-staged-150"></a>
-<code>DESTDIR</code> is a variable prepended to each installed target file,
+<a name="index-DESTDIR"></a>
+<a name="index-staged-installs"></a>
+<a name="index-installations_002c-staged"></a>
+
+<p><code>DESTDIR</code> is a variable prepended to each installed target file,
like this:
+</p>
+<div class="example">
+<pre class="example">$(INSTALL_PROGRAM) foo $(DESTDIR)$(bindir)/foo
+$(INSTALL_DATA) libfoo.a $(DESTDIR)$(libdir)/libfoo.a
+</pre></div>
-<pre class="example"> $(INSTALL_PROGRAM) foo $(DESTDIR)$(bindir)/foo
- $(INSTALL_DATA) libfoo.a $(DESTDIR)$(libdir)/libfoo.a
-</pre>
- <p>The <code>DESTDIR</code> variable is specified by the user on the
<code>make</code>
+<p>The <code>DESTDIR</code> variable is specified by the user on the
<code>make</code>
command line as an absolute file name. For example:
+</p>
+<div class="example">
+<pre class="example">make DESTDIR=/tmp/stage install
+</pre></div>
-<pre class="example"> make DESTDIR=/tmp/stage install
-</pre>
- <p class="noindent"><code>DESTDIR</code> should be supported only in the
<code>install*</code> and
+<p><code>DESTDIR</code> should be supported only in the <code>install*</code>
and
<code>uninstall*</code> targets, as those are the only targets where it is
useful.
-
- <p>If your installation step would normally install
-<samp><span class="file">/usr/local/bin/foo</span></samp> and <samp><span
class="file">/usr/local/lib/libfoo.a</span></samp>, then an
+</p>
+<p>If your installation step would normally install
+‘<tt>/usr/local/bin/foo</tt>’ and
‘<tt>/usr/local/lib/libfoo.a</tt>’, then an
installation invoked as in the example above would install
-<samp><span class="file">/tmp/stage/usr/local/bin/foo</span></samp> and
-<samp><span class="file">/tmp/stage/usr/local/lib/libfoo.a</span></samp>
instead.
-
- <p>Prepending the variable <code>DESTDIR</code> to each target in this way
-provides for <dfn>staged installs</dfn>, where the installed files are not
+‘<tt>/tmp/stage/usr/local/bin/foo</tt>’ and
+‘<tt>/tmp/stage/usr/local/lib/libfoo.a</tt>’ instead.
+</p>
+<p>Prepending the variable <code>DESTDIR</code> to each target in this way
+provides for <em>staged installs</em>, where the installed files are not
placed directly into their expected location but are instead copied
into a temporary location (<code>DESTDIR</code>). However, installed files
maintain their relative directory structure and any embedded file names
will not be modified.
-
- <p>You should not set the value of <code>DESTDIR</code> in your <samp><span
class="file">Makefile</span></samp>
+</p>
+<p>You should not set the value of <code>DESTDIR</code> in your
‘<tt>Makefile</tt>’
at all; then the files are installed into their expected locations by
default. Also, specifying <code>DESTDIR</code> should not change the
operation of the software in any way, so its value should not be
included in any file contents.
-
- <p><code>DESTDIR</code> support is commonly used in package creation. It is
+</p>
+<p><code>DESTDIR</code> support is commonly used in package creation. It is
also helpful to users who want to understand what a given package will
-install where, and to allow users who don't normally have permissions
+install where, and to allow users who don’t normally have permissions
to install into protected areas to build and install before gaining
those permissions. Finally, it can be useful with tools such as
<code>stow</code>, where code is installed in one place but made to appear
to be installed somewhere else using symbolic links or special mount
operations. So, we strongly recommend GNU packages support
<code>DESTDIR</code>, though it is not an absolute requirement.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Directory-Variables.html#Directory-Variables" accesskey="n"
rel="next">Directory Variables</a>, Previous: <a
href="Command-Variables.html#Command-Variables" accesskey="p"
rel="previous">Command Variables</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Design-Advice.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Design-Advice.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Design-Advice.html 8 Apr 2012 00:23:49 -0000
1.54
+++ standards/html_node/Design-Advice.html 7 May 2012 00:48:07 -0000
1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Design Advice - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="Legal-Issues.html#Legal-Issues" title="Legal Issues">
-<link rel="next" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,50 +11,83 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Design Advice</title>
+
+<meta name="description" content="GNU Coding Standards: Design Advice">
+<meta name="keywords" content="GNU Coding Standards: Design Advice">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Source-Language.html#Source-Language" rel="next" title="Source
Language">
+<link href="Trademarks.html#Trademarks" rel="previous" title="Trademarks">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Design-Advice"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>,
-Previous: <a rel="previous" accesskey="p"
href="Legal-Issues.html#Legal-Issues">Legal Issues</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="Program-Behavior.html#Program-Behavior" accesskey="n"
rel="next">Program Behavior</a>, Previous: <a
href="Legal-Issues.html#Legal-Issues" accesskey="p" rel="previous">Legal
Issues</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="General-Program-Design"></a>
<h2 class="chapter">3 General Program Design</h2>
+<a name="index-program-design"></a>
-<p><a name="index-program-design-13"></a>
-This chapter discusses some of the issues you should take into
+<p>This chapter discusses some of the issues you should take into
account when designing your program.
+</p>
+
+
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="Source-Language.html#Source-Language" accesskey="1">Source
Language</a>:</td><td> </td><td align="left" valign="top">Which
languages to use.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Compatibility.html#Compatibility"
accesskey="2">Compatibility</a>:</td><td> </td><td align="left"
valign="top">Compatibility with other implementations.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Using-Extensions.html#Using-Extensions" accesskey="3">Using
Extensions</a>:</td><td> </td><td align="left" valign="top">Using
non-standard features.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Standard-C.html#Standard-C"
accesskey="4">Standard C</a>:</td><td> </td><td align="left"
valign="top">Using standard C features.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Conditional-Compilation.html#Conditional-Compilation"
accesskey="5">Conditional Compilation</a>:</td><td> </td><td
align="left" valign="top">Compiling code only if a conditional is true.
+</td></tr>
+</table>
+
-<!-- Standard or ANSI C -->
-<!-- In 1989 the American National Standards Institute (ANSI) standardized -->
-<!-- C as standard X3.159-1989. In December of that year the -->
-<!-- International Standards Organization ISO adopted the ANSI C standard -->
-<!-- making minor changes. In 1990 ANSI then re-adopted ISO standard -->
-<!-- C. This version of C is known as either ANSI C or Standard C. -->
-<!-- A major revision of the C Standard appeared in 1999. -->
-<ul class="menu">
-<li><a accesskey="1" href="Source-Language.html#Source-Language">Source
Language</a>: Which languages to use.
-<li><a accesskey="2"
href="Compatibility.html#Compatibility">Compatibility</a>:
Compatibility with other implementations.
-<li><a accesskey="3" href="Using-Extensions.html#Using-Extensions">Using
Extensions</a>: Using non-standard features.
-<li><a accesskey="4" href="Standard-C.html#Standard-C">Standard C</a>:
Using standard C features.
-<li><a accesskey="5"
href="Conditional-Compilation.html#Conditional-Compilation">Conditional
Compilation</a>: Compiling code only if a conditional is true.
-</ul>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Directory-Variables.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Directory-Variables.html,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -b -r1.57 -r1.58
--- standards/html_node/Directory-Variables.html 8 Apr 2012 00:23:49
-0000 1.57
+++ standards/html_node/Directory-Variables.html 7 May 2012 00:48:07
-0000 1.58
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Directory Variables - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link rel="prev" href="DESTDIR.html#DESTDIR" title="DESTDIR">
-<link rel="next" href="Standard-Targets.html#Standard-Targets" title="Standard
Targets">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,30 +11,60 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Directory Variables</title>
+
+<meta name="description" content="GNU Coding Standards: Directory Variables">
+<meta name="keywords" content="GNU Coding Standards: Directory Variables">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="up"
title="Makefile Conventions">
+<link href="Standard-Targets.html#Standard-Targets" rel="next" title="Standard
Targets">
+<link href="DESTDIR.html#DESTDIR" rel="previous" title="DESTDIR">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Directory-Variables"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Standard-Targets.html#Standard-Targets">Standard Targets</a>,
-Previous: <a rel="previous" accesskey="p"
href="DESTDIR.html#DESTDIR">DESTDIR</a>,
-Up: <a rel="up" accesskey="u"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>
-<hr>
+Next: <a href="Standard-Targets.html#Standard-Targets" accesskey="n"
rel="next">Standard Targets</a>, Previous: <a href="DESTDIR.html#DESTDIR"
accesskey="p" rel="previous">DESTDIR</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Variables-for-Installation-Directories"></a>
<h4 class="subsection">7.2.5 Variables for Installation Directories</h4>
<p>Installation directories should always be named by variables, so it is
@@ -53,304 +73,376 @@
described below. They are based on a standard file system layout;
variants of it are used in GNU/Linux and other modern operating
systems.
-
- <p>Installers are expected to override these values when calling
-<samp><span class="command">make</span></samp> (e.g., <kbd>make prefix=/usr
install</kbd> or
-<samp><span class="command">configure</span></samp> (e.g., <kbd>configure
--prefix=/usr</kbd>). GNU
+</p>
+<p>Installers are expected to override these values when calling
+<code>make</code> (e.g., <kbd>make prefix=/usr install</kbd> or
+<code>configure</code> (e.g., <kbd>configure --prefix=/usr</kbd>). GNU
packages should not try to guess which value should be appropriate for
these variables on the system they are being installed onto: use the
default settings specified here so that all GNU packages behave
identically, allowing the installer to achieve any desired layout.
-
- <p><a name="index-directories_002c-creating-installation-151"></a><a
name="index-installation-directories_002c-creating-152"></a>All installation
directories, and their parent directories, should be
+</p>
+<a name="index-directories_002c-creating-installation"></a>
+<a name="index-installation-directories_002c-creating"></a>
+<p>All installation directories, and their parent directories, should be
created (if necessary) before they are installed into.
-
- <p>These first two variables set the root for the installation. All the
+</p>
+<p>These first two variables set the root for the installation. All the
other installation directories should be subdirectories of one of
these two, and nothing should be directly installed into these two
directories.
-
- <dl>
-<dt><code>prefix</code><dd><a name="index-prefix-153"></a>A prefix used in
constructing the default values of the variables listed
-below. The default value of <code>prefix</code> should be <samp><span
class="file">/usr/local</span></samp>.
+</p>
+<dl compact="compact">
+<dt><code>prefix</code></dt>
+<dd><a name="index-prefix"></a>
+<p>A prefix used in constructing the default values of the variables listed
+below. The default value of <code>prefix</code> should be
‘<tt>/usr/local</tt>’.
When building the complete GNU system, the prefix will be empty and
-<samp><span class="file">/usr</span></samp> will be a symbolic link to
<samp><span class="file">/</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@prefix@</span></samp>’.)
-
- <p>Running ‘<samp><span class="samp">make
install</span></samp>’ with a different value of <code>prefix</code> from
+‘<tt>/usr</tt>’ will be a symbolic link to
‘<tt>/</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@prefix@</samp>’.)
+</p>
+<p>Running ‘<samp>make install</samp>’ with a different value of
<code>prefix</code> from
the one used to build the program should <em>not</em> recompile the
program.
-
- <br><dt><code>exec_prefix</code><dd><a
name="index-exec_005fprefix-154"></a>A prefix used in constructing the default
values of some of the
+</p>
+</dd>
+<dt><code>exec_prefix</code></dt>
+<dd><a name="index-exec_005fprefix"></a>
+<p>A prefix used in constructing the default values of some of the
variables listed below. The default value of <code>exec_prefix</code> should
be <code>$(prefix)</code>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@exec_prefix@</span></samp>’.)
-
- <p>Generally, <code>$(exec_prefix)</code> is used for directories that
contain
+(If you are using Autoconf, write it as
‘<samp>@exec_prefix@</samp>’.)
+</p>
+<p>Generally, <code>$(exec_prefix)</code> is used for directories that contain
machine-specific files (such as executables and subroutine libraries),
while <code>$(prefix)</code> is used directly for other directories.
-
- <p>Running ‘<samp><span class="samp">make
install</span></samp>’ with a different value of <code>exec_prefix</code>
+</p>
+<p>Running ‘<samp>make install</samp>’ with a different value of
<code>exec_prefix</code>
from the one used to build the program should <em>not</em> recompile the
program.
+</p></dd>
</dl>
- <p>Executable programs are installed in one of the following directories.
-
- <dl>
-<dt><code>bindir</code><dd><a name="index-bindir-155"></a>The directory for
installing executable programs that users can run.
-This should normally be <samp><span class="file">/usr/local/bin</span></samp>,
but write it as
-<samp><span class="file">$(exec_prefix)/bin</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@bindir@</span></samp>’.)
-
- <br><dt><code>sbindir</code><dd><a name="index-sbindir-156"></a>The
directory for installing executable programs that can be run from
+<p>Executable programs are installed in one of the following directories.
+</p>
+<dl compact="compact">
+<dt><code>bindir</code></dt>
+<dd><a name="index-bindir"></a>
+<p>The directory for installing executable programs that users can run.
+This should normally be ‘<tt>/usr/local/bin</tt>’, but write it as
+‘<tt>$(exec_prefix)/bin</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@bindir@</samp>’.)
+</p>
+</dd>
+<dt><code>sbindir</code></dt>
+<dd><a name="index-sbindir"></a>
+<p>The directory for installing executable programs that can be run from
the shell, but are only generally useful to system administrators. This
-should normally be <samp><span class="file">/usr/local/sbin</span></samp>, but
write it as
-<samp><span class="file">$(exec_prefix)/sbin</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@sbindir@</span></samp>’.)
-
- <br><dt><code>libexecdir</code><dd><a
name="index-libexecdir-157"></a><!-- This paragraph adjusted to avoid overfull
hbox -roland 5jul94 -->
-The directory for installing executable programs to be run by other
+should normally be ‘<tt>/usr/local/sbin</tt>’, but write it as
+‘<tt>$(exec_prefix)/sbin</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@sbindir@</samp>’.)
+</p>
+</dd>
+<dt><code>libexecdir</code></dt>
+<dd><a name="index-libexecdir"></a>
+<p>The directory for installing executable programs to be run by other
programs rather than by users. This directory should normally be
-<samp><span class="file">/usr/local/libexec</span></samp>, but write it as
<samp><span class="file">$(exec_prefix)/libexec</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@libexecdir@</span></samp>’.)
-
- <p>The definition of ‘<samp><span
class="samp">libexecdir</span></samp>’ is the same for all packages, so
+‘<tt>/usr/local/libexec</tt>’, but write it as
‘<tt>$(exec_prefix)/libexec</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@libexecdir@</samp>’.)
+</p>
+<p>The definition of ‘<samp>libexecdir</samp>’ is the same for all
packages, so
you should install your data in a subdirectory thereof. Most packages
-install their data under <samp><span
class="file">$(libexecdir)/</span><var>package-name</var><span
class="file">/</span></samp>,
+install their data under
‘<tt>$(libexecdir)/<var>package-name</var>/</tt>’,
possibly within additional subdirectories thereof, such as
-<samp><span class="file">$(libexecdir)/</span><var>package-name</var><span
class="file">/</span><var>machine</var><span
class="file">/</span><var>version</var></samp>.
+‘<tt>$(libexecdir)/<var>package-name</var>/<var>machine</var>/<var>version</var></tt>’.
+</p></dd>
</dl>
- <p>Data files used by the program during its execution are divided into
+<p>Data files used by the program during its execution are divided into
categories in two ways.
-
- <ul>
-<li>Some files are normally modified by programs; others are never normally
+</p>
+<ul>
+<li> Some files are normally modified by programs; others are never normally
modified (though users may edit some of these).
- <li>Some files are architecture-independent and can be shared by all
+</li><li> Some files are architecture-independent and can be shared by all
machines at a site; some are architecture-dependent and can be shared
only by machines of the same kind and operating system; others may never
be shared between two machines.
-</ul>
+</li></ul>
- <p>This makes for six different possibilities. However, we want to
+<p>This makes for six different possibilities. However, we want to
discourage the use of architecture-dependent files, aside from object
files and libraries. It is much cleaner to make other data files
architecture-independent, and it is generally not hard.
-
- <p>Here are the variables Makefiles should use to specify directories
+</p>
+<p>Here are the variables Makefiles should use to specify directories
to put these various kinds of files in:
-
- <dl>
-<dt>‘<samp><span class="samp">datarootdir</span></samp>’<dd>The
root of the directory tree for read-only architecture-independent
-data files. This should normally be <samp><span
class="file">/usr/local/share</span></samp>, but
-write it as <samp><span class="file">$(prefix)/share</span></samp>. (If you
are using Autoconf, write
-it as ‘<samp><span class="samp">@datarootdir@</span></samp>’.)
‘<samp><span class="samp">datadir</span></samp>’'s default value is
-based on this variable; so are ‘<samp><span
class="samp">infodir</span></samp>’, ‘<samp><span
class="samp">mandir</span></samp>’, and
+</p>
+<dl compact="compact">
+<dt>‘<samp>datarootdir</samp>’</dt>
+<dd><p>The root of the directory tree for read-only architecture-independent
+data files. This should normally be ‘<tt>/usr/local/share</tt>’,
but
+write it as ‘<tt>$(prefix)/share</tt>’. (If you are using
Autoconf, write
+it as ‘<samp>@datarootdir@</samp>’.)
‘<samp>datadir</samp>’’s default value is
+based on this variable; so are ‘<samp>infodir</samp>’,
‘<samp>mandir</samp>’, and
others.
-
- <br><dt>‘<samp><span
class="samp">datadir</span></samp>’<dd>The directory for installing
idiosyncratic read-only
+</p>
+</dd>
+<dt>‘<samp>datadir</samp>’</dt>
+<dd><p>The directory for installing idiosyncratic read-only
architecture-independent data files for this program. This is usually
-the same place as ‘<samp><span
class="samp">datarootdir</span></samp>’, but we use the two separate
+the same place as ‘<samp>datarootdir</samp>’, but we use the two
separate
variables so that you can move these program-specific files without
altering the location for Info files, man pages, etc.
-
- <!-- raggedright (not until next Texinfo release) -->
- <p>This should normally be <samp><span
class="file">/usr/local/share</span></samp>, but write it as
-<samp><span class="file">$(datarootdir)</span></samp>. (If you are using
Autoconf, write it as
-‘<samp><span class="samp">@datadir@</span></samp>’.)
-<!-- end raggedright -->
-
- <p>The definition of ‘<samp><span
class="samp">datadir</span></samp>’ is the same for all packages, so you
+</p>
+<p>This should normally be ‘<tt>/usr/local/share</tt>’, but write
it as
+‘<tt>$(datarootdir)</tt>’. (If you are using Autoconf, write it as
+‘<samp>@datadir@</samp>’.)
+</p>
+<p>The definition of ‘<samp>datadir</samp>’ is the same for all
packages, so you
should install your data in a subdirectory thereof. Most packages
-install their data under <samp><span
class="file">$(datadir)/</span><var>package-name</var><span
class="file">/</span></samp>.
-
- <br><dt>‘<samp><span
class="samp">sysconfdir</span></samp>’<dd>The directory for installing
read-only data files that pertain to a
+install their data under
‘<tt>$(datadir)/<var>package-name</var>/</tt>’.
+</p>
+</dd>
+<dt>‘<samp>sysconfdir</samp>’</dt>
+<dd><p>The directory for installing read-only data files that pertain to a
single machine–that is to say, files for configuring a host. Mailer
-and network configuration files, <samp><span
class="file">/etc/passwd</span></samp>, and so forth belong
+and network configuration files, ‘<tt>/etc/passwd</tt>’, and so
forth belong
here. All the files in this directory should be ordinary ASCII text
-files. This directory should normally be <samp><span
class="file">/usr/local/etc</span></samp>, but
-write it as <samp><span class="file">$(prefix)/etc</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@sysconfdir@</span></samp>’.)
-
- <p>Do not install executables here in this directory (they probably belong
-in <samp><span class="file">$(libexecdir)</span></samp> or <samp><span
class="file">$(sbindir)</span></samp>). Also do not install
+files. This directory should normally be
‘<tt>/usr/local/etc</tt>’, but
+write it as ‘<tt>$(prefix)/etc</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@sysconfdir@</samp>’.)
+</p>
+<p>Do not install executables here in this directory (they probably belong
+in ‘<tt>$(libexecdir)</tt>’ or ‘<tt>$(sbindir)</tt>’).
Also do not install
files that are modified in the normal course of their use (programs
whose purpose is to change the configuration of the system excluded).
-Those probably belong in <samp><span
class="file">$(localstatedir)</span></samp>.
-
- <br><dt>‘<samp><span
class="samp">sharedstatedir</span></samp>’<dd>The directory for
installing architecture-independent data files which
+Those probably belong in ‘<tt>$(localstatedir)</tt>’.
+</p>
+</dd>
+<dt>‘<samp>sharedstatedir</samp>’</dt>
+<dd><p>The directory for installing architecture-independent data files which
the programs modify while they run. This should normally be
-<samp><span class="file">/usr/local/com</span></samp>, but write it as
<samp><span class="file">$(prefix)/com</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@sharedstatedir@</span></samp>’.)
-
- <br><dt>‘<samp><span
class="samp">localstatedir</span></samp>’<dd>The directory for installing
data files which the programs modify while
+‘<tt>/usr/local/com</tt>’, but write it as
‘<tt>$(prefix)/com</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@sharedstatedir@</samp>’.)
+</p>
+</dd>
+<dt>‘<samp>localstatedir</samp>’</dt>
+<dd><p>The directory for installing data files which the programs modify while
they run, and that pertain to one specific machine. Users should never
-need to modify files in this directory to configure the package's
+need to modify files in this directory to configure the package’s
operation; put such configuration information in separate files that go
-in <samp><span class="file">$(datadir)</span></samp> or <samp><span
class="file">$(sysconfdir)</span></samp>. <samp><span
class="file">$(localstatedir)</span></samp>
-should normally be <samp><span class="file">/usr/local/var</span></samp>, but
write it as
-<samp><span class="file">$(prefix)/var</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@localstatedir@</span></samp>’.)
+in ‘<tt>$(datadir)</tt>’ or ‘<tt>$(sysconfdir)</tt>’.
‘<tt>$(localstatedir)</tt>’
+should normally be ‘<tt>/usr/local/var</tt>’, but write it as
+‘<tt>$(prefix)/var</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@localstatedir@</samp>’.)
+</p></dd>
</dl>
- <p>These variables specify the directory for installing certain specific
+<p>These variables specify the directory for installing certain specific
types of files, if your program has them. Every GNU package should
-have Info files, so every program needs ‘<samp><span
class="samp">infodir</span></samp>’, but not all
-need ‘<samp><span class="samp">libdir</span></samp>’ or
‘<samp><span class="samp">lispdir</span></samp>’.
-
- <dl>
-<dt>‘<samp><span class="samp">includedir</span></samp>’<dd>The
directory for installing header files to be included by user
-programs with the C ‘<samp><span
class="samp">#include</span></samp>’ preprocessor directive. This
-should normally be <samp><span class="file">/usr/local/include</span></samp>,
but write it as
-<samp><span class="file">$(prefix)/include</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@includedir@</span></samp>’.)
-
- <p>Most compilers other than GCC do not look for header files in directory
-<samp><span class="file">/usr/local/include</span></samp>. So installing the
header files this way is
+have Info files, so every program needs ‘<samp>infodir</samp>’,
but not all
+need ‘<samp>libdir</samp>’ or ‘<samp>lispdir</samp>’.
+</p>
+<dl compact="compact">
+<dt>‘<samp>includedir</samp>’</dt>
+<dd><p>The directory for installing header files to be included by user
+programs with the C ‘<samp>#include</samp>’ preprocessor
directive. This
+should normally be ‘<tt>/usr/local/include</tt>’, but write it as
+‘<tt>$(prefix)/include</tt>’.
+(If you are using Autoconf, write it as
‘<samp>@includedir@</samp>’.)
+</p>
+<p>Most compilers other than GCC do not look for header files in directory
+‘<tt>/usr/local/include</tt>’. So installing the header files
this way is
only useful with GCC. Sometimes this is not a problem because some
libraries are only really intended to work with GCC. But some libraries
are intended to work with other compilers. They should install their
header files in two places, one specified by <code>includedir</code> and one
specified by <code>oldincludedir</code>.
-
- <br><dt>‘<samp><span
class="samp">oldincludedir</span></samp>’<dd>The directory for installing
‘<samp><span class="samp">#include</span></samp>’ header files for
use with
-compilers other than GCC. This should normally be <samp><span
class="file">/usr/include</span></samp>.
-(If you are using Autoconf, you can write it as ‘<samp><span
class="samp">@oldincludedir@</span></samp>’.)
-
- <p>The Makefile commands should check whether the value of
+</p>
+</dd>
+<dt>‘<samp>oldincludedir</samp>’</dt>
+<dd><p>The directory for installing ‘<samp>#include</samp>’ header
files for use with
+compilers other than GCC. This should normally be
‘<tt>/usr/include</tt>’.
+(If you are using Autoconf, you can write it as
‘<samp>@oldincludedir@</samp>’.)
+</p>
+<p>The Makefile commands should check whether the value of
<code>oldincludedir</code> is empty. If it is, they should not try to use
it; they should cancel the second installation of the header files.
-
- <p>A package should not replace an existing header in this directory
unless
+</p>
+<p>A package should not replace an existing header in this directory unless
the header came from the same package. Thus, if your Foo package
-provides a header file <samp><span class="file">foo.h</span></samp>, then it
should install the header
+provides a header file ‘<tt>foo.h</tt>’, then it should install
the header
file in the <code>oldincludedir</code> directory if either (1) there is no
-<samp><span class="file">foo.h</span></samp> there or (2) the <samp><span
class="file">foo.h</span></samp> that exists came from the Foo
+‘<tt>foo.h</tt>’ there or (2) the ‘<tt>foo.h</tt>’
that exists came from the Foo
package.
-
- <p>To tell whether <samp><span class="file">foo.h</span></samp> came from
the Foo package, put a magic
+</p>
+<p>To tell whether ‘<tt>foo.h</tt>’ came from the Foo package, put
a magic
string in the file—part of a comment—and <code>grep</code> for
that string.
-
- <br><dt>‘<samp><span
class="samp">docdir</span></samp>’<dd>The directory for installing
documentation files (other than Info) for
+</p>
+</dd>
+<dt>‘<samp>docdir</samp>’</dt>
+<dd><p>The directory for installing documentation files (other than Info) for
this package. By default, it should be
-<samp><span
class="file">/usr/local/share/doc/</span><var>yourpkg</var></samp>, but it
should be written as
-<samp><span class="file">$(datarootdir)/doc/</span><var>yourpkg</var></samp>.
(If you are using Autoconf,
-write it as ‘<samp><span class="samp">@docdir@</span></samp>’.)
The <var>yourpkg</var> subdirectory, which
+‘<tt>/usr/local/share/doc/<var>yourpkg</var></tt>’, but it should
be written as
+‘<tt>$(datarootdir)/doc/<var>yourpkg</var></tt>’. (If you are
using Autoconf,
+write it as ‘<samp>@docdir@</samp>’.) The <var>yourpkg</var>
subdirectory, which
may include a version number, prevents collisions among files with
-common names, such as <samp><span class="file">README</span></samp>.
-
- <br><dt>‘<samp><span
class="samp">infodir</span></samp>’<dd>The directory for installing the
Info files for this package. By
-default, it should be <samp><span
class="file">/usr/local/share/info</span></samp>, but it should be
-written as <samp><span class="file">$(datarootdir)/info</span></samp>. (If
you are using Autoconf,
-write it as ‘<samp><span class="samp">@infodir@</span></samp>’.)
<code>infodir</code> is separate from
+common names, such as ‘<tt>README</tt>’.
+</p>
+</dd>
+<dt>‘<samp>infodir</samp>’</dt>
+<dd><p>The directory for installing the Info files for this package. By
+default, it should be ‘<tt>/usr/local/share/info</tt>’, but it
should be
+written as ‘<tt>$(datarootdir)/info</tt>’. (If you are using
Autoconf,
+write it as ‘<samp>@infodir@</samp>’.) <code>infodir</code> is
separate from
<code>docdir</code> for compatibility with existing practice.
-
- <br><dt>‘<samp><span
class="samp">htmldir</span></samp>’<dt>‘<samp><span
class="samp">dvidir</span></samp>’<dt>‘<samp><span
class="samp">pdfdir</span></samp>’<dt>‘<samp><span
class="samp">psdir</span></samp>’<dd>Directories for installing
documentation files in the particular
+</p>
+</dd>
+<dt>‘<samp>htmldir</samp>’</dt>
+<dt>‘<samp>dvidir</samp>’</dt>
+<dt>‘<samp>pdfdir</samp>’</dt>
+<dt>‘<samp>psdir</samp>’</dt>
+<dd><p>Directories for installing documentation files in the particular
format. They should all be set to <code>$(docdir)</code> by default. (If
-you are using Autoconf, write them as ‘<samp><span
class="samp">@htmldir@</span></samp>’,
-‘<samp><span class="samp">@dvidir@</span></samp>’, etc.) Packages
which supply several translations
+you are using Autoconf, write them as ‘<samp>@htmldir@</samp>’,
+‘<samp>@dvidir@</samp>’, etc.) Packages which supply several
translations
of their documentation should install them in
-‘<samp><span class="samp">$(htmldir)/</span></samp>’<var>ll</var>,
‘<samp><span class="samp">$(pdfdir)/</span></samp>’<var>ll</var>,
etc. where
-<var>ll</var> is a locale abbreviation such as ‘<samp><span
class="samp">en</span></samp>’ or ‘<samp><span
class="samp">pt_BR</span></samp>’.
-
- <br><dt>‘<samp><span
class="samp">libdir</span></samp>’<dd>The directory for object files and
libraries of object code. Do not
-install executables here, they probably ought to go in <samp><span
class="file">$(libexecdir)</span></samp>
+‘<samp>$(htmldir)/</samp>’<var>ll</var>,
‘<samp>$(pdfdir)/</samp>’<var>ll</var>, etc. where
+<var>ll</var> is a locale abbreviation such as ‘<samp>en</samp>’
or ‘<samp>pt_BR</samp>’.
+</p>
+</dd>
+<dt>‘<samp>libdir</samp>’</dt>
+<dd><p>The directory for object files and libraries of object code. Do not
+install executables here, they probably ought to go in
‘<tt>$(libexecdir)</tt>’
instead. The value of <code>libdir</code> should normally be
-<samp><span class="file">/usr/local/lib</span></samp>, but write it as
<samp><span class="file">$(exec_prefix)/lib</span></samp>.
-(If you are using Autoconf, write it as ‘<samp><span
class="samp">@libdir@</span></samp>’.)
-
- <br><dt>‘<samp><span
class="samp">lispdir</span></samp>’<dd>The directory for installing any
Emacs Lisp files in this package. By
-default, it should be <samp><span
class="file">/usr/local/share/emacs/site-lisp</span></samp>, but it
-should be written as <samp><span
class="file">$(datarootdir)/emacs/site-lisp</span></samp>.
-
- <p>If you are using Autoconf, write the default as ‘<samp><span
class="samp">@lispdir@</span></samp>’.
-In order to make ‘<samp><span
class="samp">@lispdir@</span></samp>’ work, you need the following lines
-in your <samp><span class="file">configure.in</span></samp> file:
-
- <pre class="example"> lispdir='${datarootdir}/emacs/site-lisp'
- AC_SUBST(lispdir)
-</pre>
- <br><dt>‘<samp><span
class="samp">localedir</span></samp>’<dd>The directory for installing
locale-specific message catalogs for this
-package. By default, it should be <samp><span
class="file">/usr/local/share/locale</span></samp>, but
-it should be written as <samp><span
class="file">$(datarootdir)/locale</span></samp>. (If you are
-using Autoconf, write it as ‘<samp><span
class="samp">@localedir@</span></samp>’.) This directory
+‘<tt>/usr/local/lib</tt>’, but write it as
‘<tt>$(exec_prefix)/lib</tt>’.
+(If you are using Autoconf, write it as ‘<samp>@libdir@</samp>’.)
+</p>
+</dd>
+<dt>‘<samp>lispdir</samp>’</dt>
+<dd><p>The directory for installing any Emacs Lisp files in this package. By
+default, it should be ‘<tt>/usr/local/share/emacs/site-lisp</tt>’,
but it
+should be written as ‘<tt>$(datarootdir)/emacs/site-lisp</tt>’.
+</p>
+<p>If you are using Autoconf, write the default as
‘<samp>@lispdir@</samp>’.
+In order to make ‘<samp>@lispdir@</samp>’ work, you need the
following lines
+in your ‘<tt>configure.in</tt>’ file:
+</p>
+<div class="example">
+<pre class="example">lispdir='${datarootdir}/emacs/site-lisp'
+AC_SUBST(lispdir)
+</pre></div>
+
+</dd>
+<dt>‘<samp>localedir</samp>’</dt>
+<dd><p>The directory for installing locale-specific message catalogs for this
+package. By default, it should be
‘<tt>/usr/local/share/locale</tt>’, but
+it should be written as ‘<tt>$(datarootdir)/locale</tt>’. (If you
are
+using Autoconf, write it as ‘<samp>@localedir@</samp>’.) This
directory
usually has a subdirectory per locale.
+</p></dd>
</dl>
- <p>Unix-style man pages are installed in one of the following:
-
- <dl>
-<dt>‘<samp><span class="samp">mandir</span></samp>’<dd>The
top-level directory for installing the man pages (if any) for this
-package. It will normally be <samp><span
class="file">/usr/local/share/man</span></samp>, but you
-should write it as <samp><span class="file">$(datarootdir)/man</span></samp>.
(If you are using
-Autoconf, write it as ‘<samp><span
class="samp">@mandir@</span></samp>’.)
-
- <br><dt>‘<samp><span
class="samp">man1dir</span></samp>’<dd>The directory for installing
section 1 man pages. Write it as
-<samp><span class="file">$(mandir)/man1</span></samp>.
-<br><dt>‘<samp><span class="samp">man2dir</span></samp>’<dd>The
directory for installing section 2 man pages. Write it as
-<samp><span class="file">$(mandir)/man2</span></samp>
-<br><dt>‘<samp><span class="samp">...</span></samp>’<dd>
-<strong>Don't make the primary documentation for any GNU software be a
+<p>Unix-style man pages are installed in one of the following:
+</p>
+<dl compact="compact">
+<dt>‘<samp>mandir</samp>’</dt>
+<dd><p>The top-level directory for installing the man pages (if any) for this
+package. It will normally be ‘<tt>/usr/local/share/man</tt>’, but
you
+should write it as ‘<tt>$(datarootdir)/man</tt>’. (If you are
using
+Autoconf, write it as ‘<samp>@mandir@</samp>’.)
+</p>
+</dd>
+<dt>‘<samp>man1dir</samp>’</dt>
+<dd><p>The directory for installing section 1 man pages. Write it as
+‘<tt>$(mandir)/man1</tt>’.
+</p></dd>
+<dt>‘<samp>man2dir</samp>’</dt>
+<dd><p>The directory for installing section 2 man pages. Write it as
+‘<tt>$(mandir)/man2</tt>’
+</p></dd>
+<dt>‘<samp>…</samp>’</dt>
+<dd>
+<p><strong>Don’t make the primary documentation for any GNU software be a
man page. Write a manual in Texinfo instead. Man pages are just for
the sake of people running GNU software on Unix, which is a secondary
application only.</strong>
-
- <br><dt>‘<samp><span
class="samp">manext</span></samp>’<dd>The file name extension for the
installed man page. This should contain
-a period followed by the appropriate digit; it should normally be
‘<samp><span class="samp">.1</span></samp>’.
-
- <br><dt>‘<samp><span
class="samp">man1ext</span></samp>’<dd>The file name extension for
installed section 1 man pages.
-<br><dt>‘<samp><span class="samp">man2ext</span></samp>’<dd>The
file name extension for installed section 2 man pages.
-<br><dt>‘<samp><span class="samp">...</span></samp>’<dd>Use these
names instead of ‘<samp><span class="samp">manext</span></samp>’ if
the package needs to install man
+</p>
+</dd>
+<dt>‘<samp>manext</samp>’</dt>
+<dd><p>The file name extension for the installed man page. This should contain
+a period followed by the appropriate digit; it should normally be
‘<samp>.1</samp>’.
+</p>
+</dd>
+<dt>‘<samp>man1ext</samp>’</dt>
+<dd><p>The file name extension for installed section 1 man pages.
+</p></dd>
+<dt>‘<samp>man2ext</samp>’</dt>
+<dd><p>The file name extension for installed section 2 man pages.
+</p></dd>
+<dt>‘<samp>…</samp>’</dt>
+<dd><p>Use these names instead of ‘<samp>manext</samp>’ if the
package needs to install man
pages in more than one section of the manual.
+</p></dd>
</dl>
- <p>And finally, you should set the following variable:
-
- <dl>
-<dt>‘<samp><span class="samp">srcdir</span></samp>’<dd>The
directory for the sources being compiled. The value of this
+<p>And finally, you should set the following variable:
+</p>
+<dl compact="compact">
+<dt>‘<samp>srcdir</samp>’</dt>
+<dd><p>The directory for the sources being compiled. The value of this
variable is normally inserted by the <code>configure</code> shell script.
-(If you are using Autoconf, use ‘<samp><span class="samp">srcdir =
@srcdir@</span></samp>’.)
+(If you are using Autoconf, use ‘<samp>srcdir = @srcdir@</samp>’.)
+</p></dd>
</dl>
- <p>For example:
+<p>For example:
+</p>
+<div class="smallexample">
+<pre class="smallexample"># Common prefix for installation directories.
+# NOTE: This directory must exist when you start the install.
+prefix = /usr/local
+datarootdir = $(prefix)/share
+datadir = $(datarootdir)
+exec_prefix = $(prefix)
+# Where to put the executable for the command `gcc'.
+bindir = $(exec_prefix)/bin
+# Where to put the directories used by the compiler.
+libexecdir = $(exec_prefix)/libexec
+# Where to put the Info files.
+infodir = $(datarootdir)/info
+</pre></div>
-<pre class="smallexample"> <!-- I have changed some of the comments here
slightly to fix an overfull -->
- <!-- hbox, so the make manual can format correctly. -roland -->
- # Common prefix for installation directories.
- # NOTE: This directory must exist when you start the install.
- prefix = /usr/local
- datarootdir = $(prefix)/share
- datadir = $(datarootdir)
- exec_prefix = $(prefix)
- # Where to put the executable for the command `gcc'.
- bindir = $(exec_prefix)/bin
- # Where to put the directories used by the compiler.
- libexecdir = $(exec_prefix)/libexec
- # Where to put the Info files.
- infodir = $(datarootdir)/info
-</pre>
- <p>If your program installs a large number of files into one of the
+<p>If your program installs a large number of files into one of the
standard user-specified directories, it might be useful to group them
into a subdirectory particular to that program. If you do this, you
should write the <code>install</code> rule to create these subdirectories.
-
- <p>Do not expect the user to include the subdirectory name in the value of
+</p>
+<p>Do not expect the user to include the subdirectory name in the value of
any of the variables listed above. The idea of having a uniform set of
variable names for installation directories is to enable the user to
specify the exact same values for several different GNU packages. In
order for this to be useful, all the packages must be designed so that
they will work sensibly when the user does so.
-
- <p>At times, not all of these variables may be implemented in the current
+</p>
+<p>At times, not all of these variables may be implemented in the current
release of Autoconf and/or Automake; but as of Autoconf 2.60, we
believe all of them are. When any are missing, the descriptions here
serve as specifications for what Autoconf will implement. As a
programmer, you can either use a development version of Autoconf or
avoid using these variables until a stable release is made which
supports them.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Standard-Targets.html#Standard-Targets" accesskey="n"
rel="next">Standard Targets</a>, Previous: <a href="DESTDIR.html#DESTDIR"
accesskey="p" rel="previous">DESTDIR</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Doc-Strings-and-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Doc-Strings-and-Manuals.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Doc-Strings-and-Manuals.html 8 Apr 2012 00:23:49
-0000 1.54
+++ standards/html_node/Doc-Strings-and-Manuals.html 7 May 2012 00:48:07
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Doc Strings and Manuals - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="GNU-Manuals.html#GNU-Manuals" title="GNU Manuals">
-<link rel="next" href="Manual-Structure-Details.html#Manual-Structure-Details"
title="Manual Structure Details">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,30 +11,60 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Doc Strings and Manuals</title>
+
+<meta name="description" content="GNU Coding Standards: Doc Strings and
Manuals">
+<meta name="keywords" content="GNU Coding Standards: Doc Strings and Manuals">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Manual-Structure-Details.html#Manual-Structure-Details" rel="next"
title="Manual Structure Details">
+<link href="GNU-Manuals.html#GNU-Manuals" rel="previous" title="GNU Manuals">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Doc-Strings-and-Manuals"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Manual-Structure-Details.html#Manual-Structure-Details">Manual Structure
Details</a>,
-Previous: <a rel="previous" accesskey="p"
href="GNU-Manuals.html#GNU-Manuals">GNU Manuals</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="Manual-Structure-Details.html#Manual-Structure-Details"
accesskey="n" rel="next">Manual Structure Details</a>, Previous: <a
href="GNU-Manuals.html#GNU-Manuals" accesskey="p" rel="previous">GNU
Manuals</a>, Up: <a href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Doc-Strings-and-Manuals-1"></a>
<h3 class="section">6.2 Doc Strings and Manuals</h3>
<p>Some programming systems, such as Emacs, provide a documentation string
@@ -53,12 +73,12 @@
little additional text to go around them—but you must not do it. That
approach is a fundamental mistake. The text of well-written
documentation strings will be entirely wrong for a manual.
-
- <p>A documentation string needs to stand alone—when it appears on the
+</p>
+<p>A documentation string needs to stand alone—when it appears on the
screen, there will be no other text to introduce or explain it.
Meanwhile, it can be rather informal in style.
-
- <p>The text describing a function or variable in a manual must not stand
+</p>
+<p>The text describing a function or variable in a manual must not stand
alone; it appears in the context of a section or subsection. Other text
at the beginning of the section should explain some of the concepts, and
should often make some general points that apply to several functions or
@@ -67,9 +87,12 @@
written to stand alone would repeat some of that information; this
redundancy looks bad. Meanwhile, the informality that is acceptable in
a documentation string is totally unacceptable in a manual.
-
- <p>The only good way to use documentation strings in writing a good manual
+</p>
+<p>The only good way to use documentation strings in writing a good manual
is to use them as a source of information for writing good text.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Documentation.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Documentation.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Documentation.html 8 Apr 2012 00:23:49 -0000
1.54
+++ standards/html_node/Documentation.html 7 May 2012 00:48:07 -0000
1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Documentation - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="next" href="Managing-Releases.html#Managing-Releases"
title="Managing Releases">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,51 +11,94 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Documentation</title>
+
+<meta name="description" content="GNU Coding Standards: Documentation">
+<meta name="keywords" content="GNU Coding Standards: Documentation">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="GNU-Manuals.html#GNU-Manuals" rel="next" title="GNU Manuals">
+<link href="Mmap.html#Mmap" rel="previous" title="Mmap">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Documentation"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Managing-Releases.html#Managing-Releases">Managing Releases</a>,
-Previous: <a rel="previous" accesskey="p"
href="Writing-C.html#Writing-C">Writing C</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="Managing-Releases.html#Managing-Releases" accesskey="n"
rel="next">Managing Releases</a>, Previous: <a href="Writing-C.html#Writing-C"
accesskey="p" rel="previous">Writing C</a>, Up: <a href="index.html#Top"
accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Documenting-Programs"></a>
<h2 class="chapter">6 Documenting Programs</h2>
+<a name="index-documentation"></a>
-<p><a name="index-documentation-131"></a>
-A GNU program should ideally come with full free documentation, adequate
+<p>A GNU program should ideally come with full free documentation, adequate
for both reference and tutorial purposes. If the package can be
programmed or extended, the documentation should cover programming or
extending it, as well as just using it.
-
-<ul class="menu">
-<li><a accesskey="1" href="GNU-Manuals.html#GNU-Manuals">GNU Manuals</a>:
Writing proper manuals.
-<li><a accesskey="2"
href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals">Doc Strings and
Manuals</a>: Compiling doc strings doesn't make a manual.
-<li><a accesskey="3"
href="Manual-Structure-Details.html#Manual-Structure-Details">Manual Structure
Details</a>: Specific structure conventions.
-<li><a accesskey="4"
href="License-for-Manuals.html#License-for-Manuals">License for Manuals</a>:
Writing the distribution terms for a manual.
-<li><a accesskey="5" href="Manual-Credits.html#Manual-Credits">Manual
Credits</a>: Giving credit to documentation contributors.
-<li><a accesskey="6" href="Printed-Manuals.html#Printed-Manuals">Printed
Manuals</a>: Mentioning the printed manual.
-<li><a accesskey="7" href="NEWS-File.html#NEWS-File">NEWS File</a>:
NEWS files supplement manuals.
-<li><a accesskey="8" href="Change-Logs.html#Change-Logs">Change Logs</a>:
Recording changes.
-<li><a accesskey="9" href="Man-Pages.html#Man-Pages">Man Pages</a>:
Man pages are secondary.
-<li><a href="Reading-other-Manuals.html#Reading-other-Manuals">Reading other
Manuals</a>: How far you can go in learning
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="GNU-Manuals.html#GNU-Manuals" accesskey="1">GNU
Manuals</a>:</td><td> </td><td align="left" valign="top">Writing
proper manuals.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals" accesskey="2">Doc
Strings and Manuals</a>:</td><td> </td><td align="left"
valign="top">Compiling doc strings doesn’t make a manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Manual-Structure-Details.html#Manual-Structure-Details"
accesskey="3">Manual Structure Details</a>:</td><td> </td><td
align="left" valign="top">Specific structure conventions.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="License-for-Manuals.html#License-for-Manuals" accesskey="4">License for
Manuals</a>:</td><td> </td><td align="left" valign="top">Writing the
distribution terms for a manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Manual-Credits.html#Manual-Credits" accesskey="5">Manual
Credits</a>:</td><td> </td><td align="left" valign="top">Giving
credit to documentation contributors.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Printed-Manuals.html#Printed-Manuals" accesskey="6">Printed
Manuals</a>:</td><td> </td><td align="left" valign="top">Mentioning
the printed manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="NEWS-File.html#NEWS-File"
accesskey="7">NEWS File</a>:</td><td> </td><td align="left"
valign="top">NEWS files supplement manuals.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Change-Logs.html#Change-Logs" accesskey="8">Change
Logs</a>:</td><td> </td><td align="left" valign="top">Recording
changes.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Man-Pages.html#Man-Pages"
accesskey="9">Man Pages</a>:</td><td> </td><td align="left"
valign="top">Man pages are secondary.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Reading-other-Manuals.html#Reading-other-Manuals">Reading other
Manuals</a>:</td><td> </td><td align="left" valign="top">How far you
can go in learning
from other manuals.
-</ul>
+</td></tr>
+</table>
+
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Dynamic-Plug_002dIn-Interfaces.html
===================================================================
RCS file:
/web/www/www/prep/standards/html_node/Dynamic-Plug_002dIn-Interfaces.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- standards/html_node/Dynamic-Plug_002dIn-Interfaces.html 8 Apr 2012
00:23:50 -0000 1.13
+++ standards/html_node/Dynamic-Plug_002dIn-Interfaces.html 7 May 2012
00:48:07 -0000 1.14
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Dynamic Plug-In Interfaces - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
title="Command-Line Interfaces">
-<link rel="next" href="Option-Table.html#Option-Table" title="Option Table">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,54 +11,85 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Dynamic Plug-In Interfaces</title>
+
+<meta name="description" content="GNU Coding Standards: Dynamic Plug-In
Interfaces">
+<meta name="keywords" content="GNU Coding Standards: Dynamic Plug-In
Interfaces">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Option-Table.html#Option-Table" rel="next" title="Option Table">
+<link href="_002d_002dhelp.html#g_t_002d_002dhelp" rel="previous"
title="--help">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
-<a name="Dynamic-Plug-In-Interfaces"></a>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Dynamic-Plug_002dIn-Interfaces"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Option-Table.html#Option-Table">Option Table</a>,
-Previous: <a rel="previous" accesskey="p"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="Option-Table.html#Option-Table" accesskey="n" rel="next">Option
Table</a>, Previous: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="p" rel="previous">Command-Line Interfaces</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Standards-for-Dynamic-Plug_002din-Interfaces"></a>
<h3 class="section">4.8 Standards for Dynamic Plug-in Interfaces</h3>
+<a name="index-plug_002dins"></a>
+<a name="index-dynamic-plug_002dins"></a>
-<p><a name="index-plug_002dins-63"></a><a
name="index-dynamic-plug_002dins-64"></a>
-Another aspect of keeping free programs free is encouraging
+<p>Another aspect of keeping free programs free is encouraging
development of free plug-ins, and discouraging development of
proprietary plug-ins. Many GNU programs will not have anything like
plug-ins at all, but those that do should follow these
practices.
-
- <p>First, the general plug-in architecture design should closely tie the
+</p>
+<p>First, the general plug-in architecture design should closely tie the
plug-in to the original code, such that the plug-in and the base
program are parts of one extended program. For GCC, for example,
-plug-ins receive and modify GCC's internal data structures, and so
+plug-ins receive and modify GCC’s internal data structures, and so
clearly form an extended program with the base GCC.
-
- <p><a name="index-plugin_005fis_005fGPL_005fcompatible-65"></a>Second, you
should require plug-in developers to affirm that their
+</p>
+<a name="index-plugin_005fis_005fGPL_005fcompatible"></a>
+<p>Second, you should require plug-in developers to affirm that their
plug-ins are released under an appropriate license. This should be
enforced with a simple programmatic check. For GCC, again for
example, a plug-in must define the global symbol
<code>plugin_is_GPL_compatible</code>, thus asserting that the plug-in is
-released under a GPL-compatible license (see <a
href="../gccint/Plugins.html#Plugins">Plugins</a>).
-
- <p>By adding this check to your program you are not creating a new legal
+released under a GPL-compatible license (see <a
href="http://gcc.gnu.org/onlinedocs/gccint/Plugins.html#Plugins";>Plugins</a> in
<cite>GCC Internals</cite>).
+</p>
+<p>By adding this check to your program you are not creating a new legal
requirement. The GPL itself requires plug-ins to be free software,
licensed compatibly. As long as you have followed the first rule above
to keep plug-ins closely tied to your original program, the GPL and AGPL
@@ -78,6 +99,15 @@
distribute proprietary plug-ins to legally defend themselves. If a case
about this got to court, we can point to that symbol as evidence that
the plug-in developer understood that the license had this requirement.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Option-Table.html#Option-Table" accesskey="n" rel="next">Option
Table</a>, Previous: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="p" rel="previous">Command-Line Interfaces</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Errors.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Errors.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Errors.html 8 Apr 2012 00:23:50 -0000 1.54
+++ standards/html_node/Errors.html 7 May 2012 00:48:07 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Errors - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="Libraries.html#Libraries" title="Libraries">
-<link rel="next" href="User-Interfaces.html#User-Interfaces" title="User
Interfaces">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,44 +11,79 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Errors</title>
+
+<meta name="description" content="GNU Coding Standards: Errors">
+<meta name="keywords" content="GNU Coding Standards: Errors">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="User-Interfaces.html#User-Interfaces" rel="next" title="User
Interfaces">
+<link href="Libraries.html#Libraries" rel="previous" title="Libraries">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Errors"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="User-Interfaces.html#User-Interfaces">User Interfaces</a>,
-Previous: <a rel="previous" accesskey="p"
href="Libraries.html#Libraries">Libraries</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="User-Interfaces.html#User-Interfaces" accesskey="n"
rel="next">User Interfaces</a>, Previous: <a href="Libraries.html#Libraries"
accesskey="p" rel="previous">Libraries</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Formatting-Error-Messages"></a>
<h3 class="section">4.4 Formatting Error Messages</h3>
+<a name="index-formatting-error-messages"></a>
+<a name="index-error-messages_002c-formatting"></a>
-<p><a name="index-formatting-error-messages-36"></a><a
name="index-error-messages_002c-formatting-37"></a>
-Error messages from compilers should look like this:
-
-<pre class="example"> <var>sourcefile</var>:<var>lineno</var>:
<var>message</var>
-</pre>
- <p class="noindent">If you want to mention the column number, use one of
these formats:
+<p>Error messages from compilers should look like this:
+</p>
+<div class="example">
+<pre class="example"><var>sourcefile</var>:<var>lineno</var>:
<var>message</var>
+</pre></div>
+
+<p>If you want to mention the column number, use one of these formats:
+</p>
+<div class="example">
+<pre
class="example"><var>sourcefile</var>:<var>lineno</var>:<var>column</var>:
<var>message</var>
+<var>sourcefile</var>:<var>lineno</var>.<var>column</var>: <var>message</var>
-<pre class="example">
<var>sourcefile</var>:<var>lineno</var>:<var>column</var>: <var>message</var>
- <var>sourcefile</var>:<var>lineno</var>.<var>column</var>:
<var>message</var>
+</pre></div>
-</pre>
- <p class="noindent">Line numbers should start from 1 at the beginning of
the file, and
+<p>Line numbers should start from 1 at the beginning of the file, and
column numbers should start from 1 at the beginning of the line.
(Both of these conventions are chosen for compatibility.) Calculate
column numbers assuming that space and all ASCII printing characters
@@ -66,49 +91,67 @@
non-ASCII characters, Unicode character widths should be used when in
a UTF-8 locale; GNU libc and GNU gnulib provide suitable
<code>wcwidth</code> functions.
-
- <p>The error message can also give both the starting and ending positions
+</p>
+<p>The error message can also give both the starting and ending positions
of the erroneous text. There are several formats so that you can
avoid redundant information such as a duplicate line number.
Here are the possible formats:
+</p>
+<div class="example">
+<pre
class="example"><var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>line2</var>.<var>column2</var>:
<var>message</var>
+<var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>column2</var>:
<var>message</var>
+<var>sourcefile</var>:<var>line1</var>-<var>line2</var>: <var>message</var>
+</pre></div>
+
+<p>When an error is spread over several files, you can use this format:
+</p>
+<div class="example">
+<pre
class="example"><var>file1</var>:<var>line1</var>.<var>column1</var>-<var>file2</var>:<var>line2</var>.<var>column2</var>:
<var>message</var>
+</pre></div>
+
+<p>Error messages from other noninteractive programs should look like this:
+</p>
+<div class="example">
+<pre
class="example"><var>program</var>:<var>sourcefile</var>:<var>lineno</var>:
<var>message</var>
+</pre></div>
+
+<p>when there is an appropriate source file, or like this:
+</p>
+<div class="example">
+<pre class="example"><var>program</var>: <var>message</var>
+</pre></div>
+
+<p>when there is no relevant source file.
+</p>
+<p>If you want to mention the column number, use this format:
+</p>
+<div class="example">
+<pre
class="example"><var>program</var>:<var>sourcefile</var>:<var>lineno</var>:<var>column</var>:
<var>message</var>
+</pre></div>
-<pre class="example">
<var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>line2</var>.<var>column2</var>:
<var>message</var>
-
<var>sourcefile</var>:<var>line1</var>.<var>column1</var>-<var>column2</var>:
<var>message</var>
- <var>sourcefile</var>:<var>line1</var>-<var>line2</var>:
<var>message</var>
-</pre>
- <p class="noindent">When an error is spread over several files, you can use
this format:
-
-<pre class="example">
<var>file1</var>:<var>line1</var>.<var>column1</var>-<var>file2</var>:<var>line2</var>.<var>column2</var>:
<var>message</var>
-</pre>
- <p>Error messages from other noninteractive programs should look like this:
-
-<pre class="example">
<var>program</var>:<var>sourcefile</var>:<var>lineno</var>: <var>message</var>
-</pre>
- <p class="noindent">when there is an appropriate source file, or like this:
-
-<pre class="example"> <var>program</var>: <var>message</var>
-</pre>
- <p class="noindent">when there is no relevant source file.
-
- <p>If you want to mention the column number, use this format:
-
-<pre class="example">
<var>program</var>:<var>sourcefile</var>:<var>lineno</var>:<var>column</var>:
<var>message</var>
-</pre>
- <p>In an interactive program (one that is reading commands from a
+<p>In an interactive program (one that is reading commands from a
terminal), it is better not to include the program name in an error
message. The place to indicate which program is running is in the
prompt or with the screen layout. (When the same program runs with
input from a source other than a terminal, it is not interactive and
would do best to print error messages using the noninteractive style.)
-
- <p>The string <var>message</var> should not begin with a capital letter when
-it follows a program name and/or file name, because that isn't the
+</p>
+<p>The string <var>message</var> should not begin with a capital letter when
+it follows a program name and/or file name, because that isn’t the
beginning of a sentence. (The sentence conceptually starts at the
beginning of the line.) Also, it should not end with a period.
-
- <p>Error messages from interactive programs, and other messages such as
+</p>
+<p>Error messages from interactive programs, and other messages such as
usage messages, should start with a capital letter. But they should not
end with a period.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="User-Interfaces.html#User-Interfaces" accesskey="n"
rel="next">User Interfaces</a>, Previous: <a href="Libraries.html#Libraries"
accesskey="p" rel="previous">Libraries</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/File-Usage.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/File-Usage.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/File-Usage.html 8 Apr 2012 00:23:50 -0000 1.54
+++ standards/html_node/File-Usage.html 7 May 2012 00:48:07 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>File Usage - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="Memory-Usage.html#Memory-Usage" title="Memory Usage">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,44 +11,78 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: File Usage</title>
+
+<meta name="description" content="GNU Coding Standards: File Usage">
+<meta name="keywords" content="GNU Coding Standards: File Usage">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Writing-C.html#Writing-C" rel="next" title="Writing C">
+<link href="Memory-Usage.html#Memory-Usage" rel="previous" title="Memory
Usage">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="File-Usage"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Memory-Usage.html#Memory-Usage">Memory Usage</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Previous: <a href="Memory-Usage.html#Memory-Usage" accesskey="p"
rel="previous">Memory Usage</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="File-Usage-1"></a>
<h3 class="section">4.12 File Usage</h3>
+<a name="index-file-usage"></a>
-<p><a name="index-file-usage-75"></a>
-Programs should be prepared to operate when <samp><span
class="file">/usr</span></samp> and <samp><span class="file">/etc</span></samp>
+<p>Programs should be prepared to operate when ‘<tt>/usr</tt>’ and
‘<tt>/etc</tt>’
are read-only file systems. Thus, if the program manages log files,
lock files, backup files, score files, or any other files which are
modified for internal purposes, these files should not be stored in
-<samp><span class="file">/usr</span></samp> or <samp><span
class="file">/etc</span></samp>.
-
- <p>There are two exceptions. <samp><span class="file">/etc</span></samp>
is used to store system
+‘<tt>/usr</tt>’ or ‘<tt>/etc</tt>’.
+</p>
+<p>There are two exceptions. ‘<tt>/etc</tt>’ is used to store
system
configuration information; it is reasonable for a program to modify
-files in <samp><span class="file">/etc</span></samp> when its job is to update
the system configuration.
+files in ‘<tt>/etc</tt>’ when its job is to update the system
configuration.
Also, if the user explicitly asks to modify one file in a directory, it
is reasonable for the program to store other files in the same
directory.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Formatting.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Formatting.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Formatting.html 8 Apr 2012 00:23:50 -0000 1.54
+++ standards/html_node/Formatting.html 7 May 2012 00:48:07 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Formatting - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="next" href="Comments.html#Comments" title="Comments">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,102 +11,149 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Formatting</title>
+
+<meta name="description" content="GNU Coding Standards: Formatting">
+<meta name="keywords" content="GNU Coding Standards: Formatting">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Comments.html#Comments" rel="next" title="Comments">
+<link href="Writing-C.html#Writing-C" rel="previous" title="Writing C">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Formatting"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Comments.html#Comments">Comments</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="Comments.html#Comments" accesskey="n" rel="next">Comments</a>,
Up: <a href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Formatting-Your-Source-Code"></a>
<h3 class="section">5.1 Formatting Your Source Code</h3>
+<a name="index-formatting-source-code"></a>
-<p><a name="index-formatting-source-code-76"></a>
-<a name="index-open-brace-77"></a><a
name="index-braces_002c-in-C-source-78"></a><a
name="index-function-definitions_002c-formatting-79"></a>It is important to put
the open-brace that starts the body of a C
+<a name="index-open-brace"></a>
+<a name="index-braces_002c-in-C-source"></a>
+<a name="index-function-definitions_002c-formatting"></a>
+<p>It is important to put the open-brace that starts the body of a C
function in column one, so that they will start a defun. Several
tools look for open-braces in column one to find the beginnings of C
functions. These tools will not work on code not formatted that way.
-
- <p>Avoid putting open-brace, open-parenthesis or open-bracket in column
-one when they are inside a function, so that they won't start a defun.
+</p>
+<p>Avoid putting open-brace, open-parenthesis or open-bracket in column
+one when they are inside a function, so that they won’t start a defun.
The open-brace that starts a <code>struct</code> body can go in column one
if you find it useful to treat that definition as a defun.
-
- <p>It is also important for function definitions to start the name of the
+</p>
+<p>It is also important for function definitions to start the name of the
function in column one. This helps people to search for function
definitions, and may also help certain tools recognize them. Thus,
using Standard C syntax, the format is this:
+</p>
+<div class="example">
+<pre class="example">static char *
+concat (char *s1, char *s2)
+{
+ …
+}
+</pre></div>
-<pre class="example"> static char *
- concat (char *s1, char *s2)
- {
- ...
- }
-</pre>
- <p class="noindent">or, if you want to use traditional C syntax, format the
definition like
+<p>or, if you want to use traditional C syntax, format the definition like
this:
-
-<pre class="example"> static char *
- concat (s1, s2) /* Name starts in column one here */
+</p>
+<div class="example">
+<pre class="example">static char *
+concat (s1, s2) /* Name starts in column one here */
char *s1, *s2;
- { /* Open brace in column one here */
- ...
- }
-</pre>
- <p>In Standard C, if the arguments don't fit nicely on one line,
-split it like this:
+{ /* Open brace in column one here */
+ …
+}
+</pre></div>
-<pre class="example"> int
- lots_of_args (int an_integer, long a_long, short a_short,
+<p>In Standard C, if the arguments don’t fit nicely on one line,
+split it like this:
+</p>
+<div class="example">
+<pre class="example">int
+lots_of_args (int an_integer, long a_long, short a_short,
double a_double, float a_float)
- ...
-</pre>
- <p><a
name="index-g_t_0040code_007bstruct_007d-types_002c-formatting-80"></a><a
name="index-g_t_0040code_007benum_007d-types_002c-formatting-81"></a>For
<code>struct</code> and <code>enum</code> types, likewise put the braces in
-column one, unless the whole contents fits on one line:
+…
+</pre></div>
-<pre class="example"> struct foo
- {
+<a name="index-struct-types_002c-formatting"></a>
+<a name="index-enum-types_002c-formatting"></a>
+<p>For <code>struct</code> and <code>enum</code> types, likewise put the
braces in
+column one, unless the whole contents fits on one line:
+</p>
+<div class="example">
+<pre class="example">struct foo
+{
int a, b;
- }
-<br><span class="roman">or</span><br>
- struct foo { int a, b; }
-</pre>
- <p>The rest of this section gives our recommendations for other aspects of
+}
+</pre><pre class="example"><span class="roman">or</span>
+</pre><pre class="example">struct foo { int a, b; }
+</pre></div>
+
+<p>The rest of this section gives our recommendations for other aspects of
C formatting style, which is also the default style of the <code>indent</code>
program in version 1.2 and newer. It corresponds to the options
+</p>
+<div class="smallexample">
+<pre class="smallexample">-nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce -cp1
-cs -di2
+-ndj -nfc1 -nfca -hnl -i2 -ip5 -lp -pcs -psl -nsc -nsob
+</pre></div>
-<pre class="smallexample"> -nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce
-cp1 -cs -di2
- -ndj -nfc1 -nfca -hnl -i2 -ip5 -lp -pcs -psl -nsc -nsob
-</pre>
- <p>We don't think of these recommendations as requirements, because it
+<p>We don’t think of these recommendations as requirements, because it
causes no problems for users if two different programs have different
formatting styles.
-
- <p>But whatever style you use, please use it consistently, since a mixture
+</p>
+<p>But whatever style you use, please use it consistently, since a mixture
of styles within one program tends to look ugly. If you are
contributing changes to an existing program, please follow the style of
that program.
-
- <p>For the body of the function, our recommended style looks like this:
-
-<pre class="example"> if (x < foo (y, z))
+</p>
+<p>For the body of the function, our recommended style looks like this:
+</p>
+<div class="example">
+<pre class="example">if (x < foo (y, z))
haha = bar[4] + 5;
- else
+else
{
while (z)
{
@@ -124,54 +162,78 @@
}
return ++x + bar ();
}
-</pre>
- <p><a name="index-spaces-before-open_002dparen-82"></a>We find it easier to
read a program when it has spaces before the
-open-parentheses and after the commas. Especially after the commas.
+</pre></div>
- <p>When you split an expression into multiple lines, split it
+<a name="index-spaces-before-open_002dparen"></a>
+<p>We find it easier to read a program when it has spaces before the
+open-parentheses and after the commas. Especially after the commas.
+</p>
+<p>When you split an expression into multiple lines, split it
before an operator, not after one. Here is the right way:
-
- <p><a name="index-expressions_002c-splitting-83"></a>
-<pre class="example"> if (foo_this_is_long && bar > win (x, y,
z)
+</p>
+<a name="index-expressions_002c-splitting"></a>
+<div class="example">
+<pre class="example">if (foo_this_is_long && bar > win (x, y, z)
&& remaining_condition)
-</pre>
- <p>Try to avoid having two operators of different precedence at the same
-level of indentation. For example, don't write this:
+</pre></div>
-<pre class="example"> mode = (inmode[j] == VOIDmode
+<p>Try to avoid having two operators of different precedence at the same
+level of indentation. For example, don’t write this:
+</p>
+<div class="example">
+<pre class="example">mode = (inmode[j] == VOIDmode
|| GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])
? outmode[j] : inmode[j]);
-</pre>
- <p>Instead, use extra parentheses so that the indentation shows the nesting:
+</pre></div>
-<pre class="example"> mode = ((inmode[j] == VOIDmode
+<p>Instead, use extra parentheses so that the indentation shows the nesting:
+</p>
+<div class="example">
+<pre class="example">mode = ((inmode[j] == VOIDmode
|| (GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])))
? outmode[j] : inmode[j]);
-</pre>
- <p>Insert extra parentheses so that Emacs will indent the code properly.
-For example, the following indentation looks nice if you do it by hand,
+</pre></div>
-<pre class="example"> v = rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+<p>Insert extra parentheses so that Emacs will indent the code properly.
+For example, the following indentation looks nice if you do it by hand,
+</p>
+<div class="example">
+<pre class="example">v = rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+ rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000;
-</pre>
- <p class="noindent">but Emacs would alter it. Adding a set of parentheses
produces
-something that looks equally nice, and which Emacs will preserve:
+</pre></div>
-<pre class="example"> v = (rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+<p>but Emacs would alter it. Adding a set of parentheses produces
+something that looks equally nice, and which Emacs will preserve:
+</p>
+<div class="example">
+<pre class="example">v = (rup->ru_utime.tv_sec*1000 +
rup->ru_utime.tv_usec/1000
+ rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000);
-</pre>
- <p>Format do-while statements like this:
+</pre></div>
-<pre class="example"> do
+<p>Format do-while statements like this:
+</p>
+<div class="example">
+<pre class="example">do
{
a = foo (a);
}
- while (a > 0);
-</pre>
- <p><a name="index-formfeed-84"></a><a
name="index-control_002dL-85"></a>Please use formfeed characters (control-L) to
divide the program into
+while (a > 0);
+</pre></div>
+
+<a name="index-formfeed"></a>
+<a name="index-control_002dL"></a>
+<p>Please use formfeed characters (control-L) to divide the program into
pages at logical places (but not within a function). It does not matter
just how long the pages are, since they do not have to fit on a printed
page. The formfeeds should appear alone on lines by themselves.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Comments.html#Comments" accesskey="n" rel="next">Comments</a>,
Up: <a href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/GNU-Free-Documentation-License.html
===================================================================
RCS file:
/web/www/www/prep/standards/html_node/GNU-Free-Documentation-License.html,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -b -r1.56 -r1.57
--- standards/html_node/GNU-Free-Documentation-License.html 8 Apr 2012
00:23:50 -0000 1.56
+++ standards/html_node/GNU-Free-Documentation-License.html 7 May 2012
00:48:08 -0000 1.57
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>GNU Free Documentation License - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="References.html#References" title="References">
-<link rel="next" href="Index.html#Index" title="Index">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,72 +11,101 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: GNU Free Documentation License</title>
+
+<meta name="description" content="GNU Coding Standards: GNU Free Documentation
License">
+<meta name="keywords" content="GNU Coding Standards: GNU Free Documentation
License">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Index.html#Index" rel="next" title="Index">
+<link href="References.html#References" rel="previous" title="References">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="GNU-Free-Documentation-License"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="Index.html#Index">Index</a>,
-Previous: <a rel="previous" accesskey="p"
href="References.html#References">References</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="Index.html#Index" accesskey="n" rel="next">Index</a>, Previous:
<a href="References.html#References" accesskey="p"
rel="previous">References</a>, Up: <a href="index.html#Top" accesskey="u"
rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="GNU-Free-Documentation-License-1"></a>
<h2 class="appendix">Appendix A GNU Free Documentation License</h2>
-<p><a name="index-FDL_002c-GNU-Free-Documentation-License-165"></a>
+<a name="index-FDL_002c-GNU-Free-Documentation-License"></a>
+<p align="center">Version 1.3, 3 November 2008
+</p>
+
+<div class="display">
+<pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
+<a href="http://fsf.org/";>http://fsf.org/</a>
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+</pre></div>
-<!-- The GNU Free Documentation License. -->
-<div align="center">Version 1.3, 3 November 2008</div>
+<ol>
+<li> PREAMBLE
-<!-- This file is intended to be included within another document, -->
-<!-- hence no sectioning command or @node. -->
-<pre class="display"> Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
- <a href="http://fsf.org/";>http://fsf.org/</a>
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-</pre>
- <ol type=1 start=0>
-<li>PREAMBLE
-
- <p>The purpose of this License is to make a manual, textbook, or other
-functional and useful document <dfn>free</dfn> in the sense of freedom: to
+<p>The purpose of this License is to make a manual, textbook, or other
+functional and useful document <em>free</em> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
-
- <p>This License is a kind of “copyleft”, which means that
derivative
+</p>
+<p>This License is a kind of “copyleft”, which means that
derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
-
- <p>We have designed this License in order to use it for manuals for free
+</p>
+<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
+</p>
+</li><li> APPLICABILITY AND DEFINITIONS
- <li>APPLICABILITY AND DEFINITIONS
-
- <p>This License applies to any manual or other work, in any medium, that
+<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
@@ -94,14 +114,14 @@
licensee, and is addressed as “you”. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
-
- <p>A “Modified Version” of the Document means any work
containing the
+</p>
+<p>A “Modified Version” of the Document means any work containing
the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
-
- <p>A “Secondary Section” is a named appendix or a
front-matter section
+</p>
+<p>A “Secondary Section” is a named appendix or a front-matter
section
of the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall
+publishers or authors of the Document to the Document’s overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
@@ -109,21 +129,21 @@
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
-
- <p>The “Invariant Sections” are certain Secondary Sections
whose titles
+</p>
+<p>The “Invariant Sections” are certain Secondary Sections whose
titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
-
- <p>The “Cover Texts” are certain short passages of text that
are listed,
+</p>
+<p>The “Cover Texts” are certain short passages of text that are
listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
- <p>A “Transparent” copy of the Document means a
machine-readable copy,
+</p>
+<p>A “Transparent” copy of the Document means a machine-readable
copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
@@ -135,8 +155,8 @@
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not “Transparent” is called
“Opaque”.
-
- <p>Examples of suitable formats for Transparent copies include plain
+</p>
+<p>Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input
format, SGML or XML using a publicly available
DTD, and standard-conforming simple HTML,
@@ -148,35 +168,35 @@
not generally available, and the machine-generated HTML,
PostScript or PDF produced by some word processors for
output purposes only.
-
- <p>The “Title Page” means, for a printed book, the title page
itself,
+</p>
+<p>The “Title Page” means, for a printed book, the title page
itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, “Title Page”
means
-the text near the most prominent appearance of the work's title,
+the text near the most prominent appearance of the work’s title,
preceding the beginning of the body of the text.
-
- <p>The “publisher” means any person or entity that
distributes copies
+</p>
+<p>The “publisher” means any person or entity that distributes
copies
of the Document to the public.
-
- <p>A section “Entitled XYZ” means a named subunit of the
Document whose
+</p>
+<p>A section “Entitled XYZ” means a named subunit of the Document
whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as “Acknowledgements”,
“Dedications”, “Endorsements”, or
“History”.) To “Preserve the Title”
of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
-
- <p>The Document may include Warranty Disclaimers next to the notice which
+</p>
+<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
+</p>
+</li><li> VERBATIM COPYING
- <li>VERBATIM COPYING
-
- <p>You may copy and distribute the Document in any medium, either
+<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
@@ -185,15 +205,15 @@
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
-
- <p>You may also lend copies, under the same conditions stated above, and
+</p>
+<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
+</p>
+</li><li> COPYING IN QUANTITY
- <li>COPYING IN QUANTITY
-
- <p>If you publish printed copies (or copies in media that commonly have
+<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
+Document’s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
@@ -203,13 +223,13 @@
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
-
- <p>If the required texts for either cover are too voluminous to fit
+</p>
+<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
-
- <p>If you publish or distribute Opaque copies of the Document numbering
+</p>
+<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
@@ -221,51 +241,51 @@
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
-
- <p>It is requested, but not required, that you contact the authors of the
+</p>
+<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
+</p>
+</li><li> MODIFICATIONS
- <li>MODIFICATIONS
-
- <p>You may copy and distribute a Modified Version of the Document under
+<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
-
- <ol type=A start=1>
-<li>Use in the Title Page (and on the covers, if any) a title distinct
+</p>
+<ol>
+<li> Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
- <li>List on the Title Page, as authors, one or more persons or
entities
+</li><li> List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
- <li>State on the Title page the name of the publisher of the
+</li><li> State on the Title page the name of the publisher of the
Modified Version, as the publisher.
- <li>Preserve all the copyright notices of the Document.
+</li><li> Preserve all the copyright notices of the Document.
- <li>Add an appropriate copyright notice for your modifications
+</li><li> Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
- <li>Include, immediately after the copyright notices, a license
notice
+</li><li> Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
- <li>Preserve in that license notice the full lists of Invariant
Sections
-and required Cover Texts given in the Document's license notice.
+</li><li> Preserve in that license notice the full lists of Invariant Sections
+and required Cover Texts given in the Document’s license notice.
- <li>Include an unaltered copy of this License.
+</li><li> Include an unaltered copy of this License.
- <li>Preserve the section Entitled “History”, Preserve
its Title, and add
+</li><li> Preserve the section Entitled “History”, Preserve its
Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled “History” in the Document, create one
@@ -273,7 +293,7 @@
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
- <li>Preserve the network location, if any, given in the Document for
+</li><li> Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the “History” section.
@@ -281,38 +301,38 @@
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
- <li>For any section Entitled “Acknowledgements” or
“Dedications”, Preserve
+</li><li> For any section Entitled “Acknowledgements” or
“Dedications”, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.
- <li>Preserve all the Invariant Sections of the Document,
+</li><li> Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
- <li>Delete any section Entitled “Endorsements”. Such a
section
+</li><li> Delete any section Entitled “Endorsements”. Such a
section
may not be included in the Modified Version.
- <li>Do not retitle any existing section to be Entitled
“Endorsements” or
+</li><li> Do not retitle any existing section to be Entitled
“Endorsements” or
to conflict in title with any Invariant Section.
- <li>Preserve any Warranty Disclaimers.
- </ol>
+</li><li> Preserve any Warranty Disclaimers.
+</li></ol>
- <p>If the Modified Version includes new front-matter sections or
+<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
+list of Invariant Sections in the Modified Version’s license notice.
These titles must be distinct from any other section titles.
-
- <p>You may add a section Entitled “Endorsements”, provided it
contains
+</p>
+<p>You may add a section Entitled “Endorsements”, provided it
contains
nothing but endorsements of your Modified Version by various
parties—for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
-
- <p>You may add a passage of up to five words as a Front-Cover Text, and a
+</p>
+<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
@@ -321,21 +341,21 @@
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
-
- <p>The author(s) and publisher(s) of the Document do not by this License
+</p>
+<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
+</p>
+</li><li> COMBINING DOCUMENTS
- <li>COMBINING DOCUMENTS
-
- <p>You may combine the Document with other documents released under this
+<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
-
- <p>The combined work need only contain one copy of this License, and
+</p>
+<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
@@ -343,48 +363,48 @@
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
-
- <p>In the combination, you must combine any sections Entitled
“History”
+</p>
+<p>In the combination, you must combine any sections Entitled
“History”
in the various original documents, forming one section Entitled
“History”; likewise combine any sections Entitled
“Acknowledgements”,
and any sections Entitled “Dedications”. You must delete all
sections Entitled “Endorsements.”
+</p>
+</li><li> COLLECTIONS OF DOCUMENTS
- <li>COLLECTIONS OF DOCUMENTS
-
- <p>You may make a collection consisting of the Document and other
documents
+<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
-
- <p>You may extract a single document from such a collection, and
distribute
+</p>
+<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
+</p>
+</li><li> AGGREGATION WITH INDEPENDENT WORKS
- <li>AGGREGATION WITH INDEPENDENT WORKS
-
- <p>A compilation of the Document or its derivatives with other separate
+<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an “aggregate” if the copyright
resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
+of the compilation’s users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
-
- <p>If the Cover Text requirement of section 3 is applicable to these
+</p>
+<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
+the entire aggregate, the Document’s Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
+</p>
+</li><li> TRANSLATION
- <li>TRANSLATION
-
- <p>Translation is considered a kind of modification, so you may
+<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
@@ -396,48 +416,48 @@
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
-
- <p>If a section in the Document is Entitled
“Acknowledgements”,
+</p>
+<p>If a section in the Document is Entitled “Acknowledgements”,
“Dedications”, or “History”, the requirement (section
4) to Preserve
its Title (section 1) will typically require changing the actual
title.
+</p>
+</li><li> TERMINATION
- <li>TERMINATION
-
- <p>You may not copy, modify, sublicense, or distribute the Document
+<p>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
-
- <p>However, if you cease all violation of this License, then your license
+</p>
+<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
-
- <p>Moreover, your license from a particular copyright holder is
+</p>
+<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
-
- <p>Termination of your rights under this section does not terminate the
+</p>
+<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
+</p>
+</li><li> FUTURE REVISIONS OF THIS LICENSE
- <li>FUTURE REVISIONS OF THIS LICENSE
-
- <p>The Free Software Foundation may publish new, revised versions
+<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
<a href="http://www.gnu.org/copyleft/";>http://www.gnu.org/copyleft/</a>.
-
- <p>Each version of the License is given a distinguishing version number.
+</p>
+<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License “or any later version” applies to it, you have the option
of
following the terms and conditions either of that specified version or
@@ -446,47 +466,49 @@
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation. If the Document
specifies that a proxy can decide which future versions of this
-License can be used, that proxy's public statement of acceptance of a
+License can be used, that proxy’s public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
+</p>
+</li><li> RELICENSING
- <li>RELICENSING
-
- <p>“Massive Multiauthor Collaboration Site” (or “MMC
Site”) means any
+<p>“Massive Multiauthor Collaboration Site” (or “MMC
Site”) means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works. A
public wiki that anybody can edit is an example of such a server. A
“Massive Multiauthor Collaboration” (or “MMC”)
contained in the
site means any set of copyrightable works thus published on the MMC
site.
-
- <p>“CC-BY-SA” means the Creative Commons Attribution-Share
Alike 3.0
+</p>
+<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike
3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
-
- <p>“Incorporate” means to publish or republish a Document, in
whole or
+</p>
+<p>“Incorporate” means to publish or republish a Document, in
whole or
in part, as part of another Document.
-
- <p>An MMC is “eligible for relicensing” if it is licensed
under this
+</p>
+<p>An MMC is “eligible for relicensing” if it is licensed under
this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole
or in part into the MMC, (1) had no cover texts or invariant sections,
and (2) were thus incorporated prior to November 1, 2008.
-
- <p>The operator of an MMC Site may republish an MMC contained in the site
+</p>
+<p>The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
+</p>
+</li></ol>
- </ol>
-
+<a name="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></a>
<h3 class="heading">ADDENDUM: How to use this License for your documents</h3>
<p>To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
-
+</p>
+<div class="smallexample">
<pre class="smallexample"> Copyright (C) <var>year</var> <var>your
name</var>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
@@ -494,25 +516,34 @@
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
-</pre>
- <p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the “with<small class="dots">...</small>Texts.” line with
this:
+</pre></div>
+<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the “with…Texts.” line with this:
+</p>
+<div class="smallexample">
<pre class="smallexample"> with the Invariant Sections being <var>list
their titles</var>, with
the Front-Cover Texts being <var>list</var>, and with the Back-Cover
Texts
being <var>list</var>.
-</pre>
- <p>If you have Invariant Sections without Cover Texts, or some other
+</pre></div>
+
+<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
-
- <p>If your document contains nontrivial examples of program code, we
+</p>
+<p>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Index.html#Index" accesskey="n" rel="next">Index</a>, Previous:
<a href="References.html#References" accesskey="p"
rel="previous">References</a>, Up: <a href="index.html#Top" accesskey="u"
rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
-<!-- Local Variables: -->
-<!-- ispell-local-pdict: "ispell-dict" -->
-<!-- End: -->
- </body></html>
+</body>
+</html>
Index: standards/html_node/GNU-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/GNU-Manuals.html,v
retrieving revision 1.55
retrieving revision 1.56
diff -u -b -r1.55 -r1.56
--- standards/html_node/GNU-Manuals.html 8 Apr 2012 00:23:50 -0000
1.55
+++ standards/html_node/GNU-Manuals.html 7 May 2012 00:48:08 -0000
1.56
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>GNU Manuals - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="next" href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals"
title="Doc Strings and Manuals">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,29 +11,60 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: GNU Manuals</title>
+
+<meta name="description" content="GNU Coding Standards: GNU Manuals">
+<meta name="keywords" content="GNU Coding Standards: GNU Manuals">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals" rel="next"
title="Doc Strings and Manuals">
+<link href="Documentation.html#Documentation" rel="previous"
title="Documentation">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="GNU-Manuals"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals">Doc Strings and
Manuals</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals"
accesskey="n" rel="next">Doc Strings and Manuals</a>, Up: <a
href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="GNU-Manuals-1"></a>
<h3 class="section">6.1 GNU Manuals</h3>
<p>The preferred document format for the GNU system is the Texinfo
@@ -53,22 +75,22 @@
HTML output from Texinfo source. See the Texinfo manual, either the
hardcopy, or the on-line version available through <code>info</code> or the
Emacs Info subsystem (<kbd>C-h i</kbd>).
-
- <p>Nowadays some other formats such as Docbook and Sgmltexi can be
+</p>
+<p>Nowadays some other formats such as Docbook and Sgmltexi can be
converted automatically into Texinfo. It is ok to produce the Texinfo
documentation by conversion this way, as long as it gives good results.
-
- <p>Make sure your manual is clear to a reader who knows nothing about the
+</p>
+<p>Make sure your manual is clear to a reader who knows nothing about the
topic and reads it straight through. This means covering basic topics
at the beginning, and advanced topics only later. This also means
defining every specialized term when it is first used.
-
- <p>Programmers tend to carry over the structure of the program as the
+</p>
+<p>Programmers tend to carry over the structure of the program as the
structure for its documentation. But this structure is not
necessarily good for explaining how to use the program; it may be
irrelevant and confusing for a user.
-
- <p>Instead, the right way to structure documentation is according to the
+</p>
+<p>Instead, the right way to structure documentation is according to the
concepts and questions that a user will have in mind when reading it.
This principle applies at every level, from the lowest (ordering
sentences in a paragraph) to the highest (ordering of chapter topics
@@ -78,77 +100,86 @@
documentation is to learn to notice when you have unthinkingly
structured the documentation like the implementation, stop yourself,
and look for better alternatives.
-
- <p>For example, each program in the GNU system probably ought to be
+</p>
+<p>For example, each program in the GNU system probably ought to be
documented in one manual; but this does not mean each program should
have its own manual. That would be following the structure of the
implementation, rather than the structure that helps the user
understand.
-
- <p>Instead, each manual should cover a coherent <em>topic</em>. For
example,
+</p>
+<p>Instead, each manual should cover a coherent <em>topic</em>. For example,
instead of a manual for <code>diff</code> and a manual for <code>diff3</code>,
we
have one manual for “comparison of files” which covers both of
those
programs, as well as <code>cmp</code>. By documenting these programs
together, we can make the whole subject clearer.
-
- <p>The manual which discusses a program should certainly document all of
-the program's command-line options and all of its commands. It should
-give examples of their use. But don't organize the manual as a list
+</p>
+<p>The manual which discusses a program should certainly document all of
+the program’s command-line options and all of its commands. It should
+give examples of their use. But don’t organize the manual as a list
of features. Instead, organize it logically, by subtopics. Address
the questions that a user will ask when thinking about the job that
-the program does. Don't just tell the reader what each feature can
+the program does. Don’t just tell the reader what each feature can
do—say what jobs it is good for, and show how to use it for those
jobs. Explain what is recommended usage, and what kinds of usage
users should avoid.
-
- <p>In general, a GNU manual should serve both as tutorial and reference.
+</p>
+<p>In general, a GNU manual should serve both as tutorial and reference.
It should be set up for convenient access to each topic through Info,
and for reading straight through (appendixes aside). A GNU manual
should give a good introduction to a beginner reading through from the
start, and should also provide all the details that hackers want.
The Bison manual is a good example of this—please take a look at it
to see what we mean.
-
- <p>That is not as hard as it first sounds. Arrange each chapter as a
+</p>
+<p>That is not as hard as it first sounds. Arrange each chapter as a
logical breakdown of its topic, but order the sections, and write their
text, so that reading the chapter straight through makes sense. Do
likewise when structuring the book into chapters, and when structuring a
section into paragraphs. The watchword is, <em>at each point, address
the most fundamental and important issue raised by the preceding text.</em>
-
- <p>If necessary, add extra chapters at the beginning of the manual which
+</p>
+<p>If necessary, add extra chapters at the beginning of the manual which
are purely tutorial and cover the basics of the subject. These provide
the framework for a beginner to understand the rest of the manual. The
Bison manual provides a good example of how to do this.
-
- <p>To serve as a reference, a manual should have an Index that list all the
+</p>
+<p>To serve as a reference, a manual should have an Index that list all the
functions, variables, options, and important concepts that are part of
the program. One combined Index should do for a short manual, but
sometimes for a complex package it is better to use multiple indices.
The Texinfo manual includes advice on preparing good index entries, see
-<a href="../texinfo/Index-Entries.html#Index-Entries">Making Index
Entries</a>, and
-see <a href="../texinfo/Indexing-Commands.html#Indexing-Commands">Defining the
Entries of an Index</a>.
-
- <p>Don't use Unix man pages as a model for how to write GNU documentation;
+<a
href="http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Index-Entries.html#Index-Entries";>Making
Index Entries</a> in <cite>GNU Texinfo</cite>, and
+see <a
href="http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Indexing-Commands.html#Indexing-Commands";>Defining
the Entries of an
+Index</a> in <cite>GNU Texinfo</cite>.
+</p>
+<p>Don’t use Unix man pages as a model for how to write GNU
documentation;
most of them are terse, badly structured, and give inadequate
explanation of the underlying concepts. (There are, of course, some
exceptions.) Also, Unix man pages use a particular format which is
different from what we use in GNU manuals.
-
- <p>Please include an email address in the manual for where to report
+</p>
+<p>Please include an email address in the manual for where to report
bugs <em>in the text of the manual</em>.
-
- <p>Please do not use the term “pathname” that is used in Unix
+</p>
+<p>Please do not use the term “pathname” that is used in Unix
documentation; use “file name” (two words) instead. We use the
term
“path” only for search paths, which are lists of directory names.
-
- <p>Please do not use the term “illegal” to refer to erroneous
input to
+</p>
+<p>Please do not use the term “illegal” to refer to erroneous
input to
a computer program. Please use “invalid” for this, and reserve the
term “illegal” for activities prohibited by law.
-
- <p>Please do not write ‘<samp><span
class="samp">()</span></samp>’ after a function name just to indicate
+</p>
+<p>Please do not write ‘<samp>()</samp>’ after a function name
just to indicate
it is a function. <code>foo ()</code> is not a function, it is a function
call with no arguments.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals"
accesskey="n" rel="next">Doc Strings and Manuals</a>, Up: <a
href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Graphical-Interfaces.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Graphical-Interfaces.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Graphical-Interfaces.html 8 Apr 2012 00:23:50
-0000 1.54
+++ standards/html_node/Graphical-Interfaces.html 7 May 2012 00:48:08
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Graphical Interfaces - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="User-Interfaces.html#User-Interfaces" title="User
Interfaces">
-<link rel="next"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
title="Command-Line Interfaces">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,50 +11,92 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Graphical Interfaces</title>
+
+<meta name="description" content="GNU Coding Standards: Graphical Interfaces">
+<meta name="keywords" content="GNU Coding Standards: Graphical Interfaces">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
rel="next" title="Command-Line Interfaces">
+<link href="User-Interfaces.html#User-Interfaces" rel="previous" title="User
Interfaces">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Graphical-Interfaces"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a>,
-Previous: <a rel="previous" accesskey="p"
href="User-Interfaces.html#User-Interfaces">User Interfaces</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="n" rel="next">Command-Line Interfaces</a>, Previous: <a
href="User-Interfaces.html#User-Interfaces" accesskey="p" rel="previous">User
Interfaces</a>, Up: <a href="Program-Behavior.html#Program-Behavior"
accesskey="u" rel="up">Program Behavior</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Standards-for-Graphical-Interfaces"></a>
<h3 class="section">4.6 Standards for Graphical Interfaces</h3>
+<a name="index-graphical-user-interface"></a>
+<a name="index-interface-styles"></a>
+<a name="index-user-interface-styles"></a>
-<p><a name="index-graphical-user-interface-41"></a><a
name="index-interface-styles-42"></a><a
name="index-user-interface-styles-43"></a>
-<a name="index-GTK_002b-44"></a>When you write a program that provides a
graphical user interface,
+<a name="index-GTK_002b"></a>
+<p>When you write a program that provides a graphical user interface,
please make it work with the X Window System and the GTK+ toolkit
unless the functionality specifically requires some alternative (for
example, “displaying jpeg images while in console mode”).
-
- <p>In addition, please provide a command-line interface to control the
+</p>
+<p>In addition, please provide a command-line interface to control the
functionality. (In many cases, the graphical user interface can be a
separate program which invokes the command-line program.) This is
so that the same jobs can be done from scripts.
-
- <p><a name="index-CORBA-45"></a><a name="index-GNOME-46"></a><a
name="index-D_002dbus-47"></a><a name="index-keyboard-interface-48"></a><a
name="index-library-interface-49"></a>Please also consider providing a D-bus
interface for use from other
+</p>
+<a name="index-CORBA"></a>
+<a name="index-GNOME"></a>
+<a name="index-D_002dbus"></a>
+<a name="index-keyboard-interface"></a>
+<a name="index-library-interface"></a>
+<p>Please also consider providing a D-bus interface for use from other
running programs, such as within GNOME. (GNOME used to use CORBA
for this, but that is being phased out.) In addition, consider
providing a library interface (for use from C), and perhaps a
keyboard-driven console interface (for use by users from console
mode). Once you are doing the work to provide the functionality and
-the graphical interface, these won't be much extra work.
+the graphical interface, these won’t be much extra work.
+</p>
+
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Index.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Index.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Index.html 8 Apr 2012 00:23:50 -0000 1.54
+++ standards/html_node/Index.html 7 May 2012 00:48:08 -0000 1.55
@@ -1,14 +1,6 @@
-<html lang="en">
-<head>
-<title>Index - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
title="GNU Free Documentation License">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -19,196 +11,385 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Index</title>
+
+<meta name="description" content="GNU Coding Standards: Index">
+<meta name="keywords" content="GNU Coding Standards: Index">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
rel="previous" title="GNU Free Documentation License">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Index"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
+Previous: <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
accesskey="p" rel="previous">GNU Free Documentation License</a>, Up: <a
href="index.html#Top" accesskey="u" rel="up">Top</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
<hr>
+<a name="Index-1"></a>
+<h2 class="unnumbered">Index</h2>
+<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter"
href="#Index_cp_symbol-1"><b>#</b></a>
+
+<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+
+<br>
+<a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-Q"><b>Q</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+
+</td></tr></table>
+<table class="index-cp" border="0">
+<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left">
Section</th></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_symbol-1">#</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Comments.html#index-_0023endif_002c-commenting"><code>#endif</code>,
commenting</a>:</td><td> </td><td valign="top"><a
href="Comments.html#Comments">Comments</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_symbol-2">-</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="_002d_002dhelp.html#index-_002d_002dhelp-output">‘<samp>--help</samp>’
output</a>:</td><td> </td><td valign="top"><a
href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td valign="top"><a
href="_002d_002dversion.html#index-_002d_002dversion-output">‘<samp>--version</samp>’
output</a>:</td><td> </td><td valign="top"><a
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-_002dWall-compiler-option">‘<samp>-Wall</samp>’
compiler option</a>:</td><td> </td><td valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-A">A</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Contributions.html#index-accepting-contributions">accepting
contributions</a>:</td><td> </td><td valign="top"><a
href="Contributions.html#Contributions">Contributions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="_002d_002dhelp.html#index-address-for-bug-reports">address for bug
reports</a>:</td><td> </td><td valign="top"><a
href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Standard-C.html#index-ANSI-C-standard"><small>ANSI</small> C
standard</a>:</td><td> </td><td valign="top"><a
href="Standard-C.html#Standard-C">Standard C</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-arbitrary-limits-on-data">arbitrary limits on
data</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Character-Set.html#index-ASCII-characters">ASCII
characters</a>:</td><td> </td><td valign="top"><a
href="Character-Set.html#Character-Set">Character Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Portability.html#index-autoconf"><code>autoconf</code></a>:</td><td> </td><td
valign="top"><a href="System-Portability.html#System-Portability">System
Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Reading-Non_002dFree-Code.html#index-avoiding-proprietary-code">avoiding
proprietary code</a>:</td><td> </td><td valign="top"><a
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">Reading
Non-Free Code</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-B">B</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="User-Interfaces.html#index-behavior_002c-dependent-on-program_0027s-name">behavior,
dependent on program’s name</a>:</td><td> </td><td valign="top"><a
href="User-Interfaces.html#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Install-Command-Categories.html#index-binary-packages">binary
packages</a>:</td><td> </td><td valign="top"><a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Directory-Variables.html#index-bindir"><code>bindir</code></a>:</td><td> </td><td
valign="top"><a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-braces_002c-in-C-source">braces, in C
source</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="_002d_002dhelp.html#index-bug-reports">bug
reports</a>:</td><td> </td><td valign="top"><a
href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Preface.html#index-bug_002dstandards_0040gnu_002eorg-email-address"><code>address@hidden</code>
email address</a>:</td><td> </td><td valign="top"><a
href="Preface.html#Preface">Preface</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-C">C</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-C-library-functions_002c-and-portability">C
library functions, and portability</a>:</td><td> </td><td valign="top"><a
href="System-Functions.html#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="_002d_002dversion.html#index-canonical-name-of-a-program">canonical name
of a program</a>:</td><td> </td><td valign="top"><a
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td valign="top"><a
href="CPU-Portability.html#index-casting-pointers-to-integers">casting pointers
to integers</a>:</td><td> </td><td valign="top"><a
href="CPU-Portability.html#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Command_002dLine-Interfaces.html#index-CGI-programs_002c-standard-options-for">CGI
programs, standard options for</a>:</td><td> </td><td valign="top"><a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Change-Logs.html#index-change-logs">change
logs</a>:</td><td> </td><td valign="top"><a
href="Change-Logs.html#Change-Logs">Change Logs</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Conditional-Changes.html#index-change-logs_002c-conditional-changes">change
logs, conditional changes</a>:</td><td> </td><td valign="top"><a
href="Conditional-Changes.html#Conditional-Changes">Conditional
Changes</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Style-of-Change-Logs.html#index-change-logs_002c-style">change logs,
style</a>:</td><td> </td><td valign="top"><a
href="Style-of-Change-Logs.html#Style-of-Change-Logs">Style of Change
Logs</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Character-Set.html#index-character-set">character
set</a>:</td><td> </td><td valign="top"><a
href="Character-Set.html#Character-Set">Character Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-clang"><code>clang</code></a>:</td><td> </td><td
valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-command_002dline-arguments_002c-decoding">command-line
arguments, decoding</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Command_002dLine-Interfaces.html#index-command_002dline-interface">command-line
interface</a>:</td><td> </td><td valign="top"><a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Comments.html#index-commenting">commenting</a>:</td><td> </td><td
valign="top"><a href="Comments.html#Comments">Comments</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Compatibility.html#index-compatibility-with-C-and-POSIX-standards">compatibility
with C and <small>POSIX</small> standards</a>:</td><td> </td><td
valign="top"><a
href="Compatibility.html#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-compiler-warnings">compiler
warnings</a>:</td><td> </td><td valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Conditional-Changes.html#index-conditional-changes_002c-and-change-logs">conditional
changes, and change logs</a>:</td><td> </td><td valign="top"><a
href="Conditional-Changes.html#Conditional-Changes">Conditional
Changes</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Comments.html#index-conditionals_002c-comments-for">conditionals,
comments for</a>:</td><td> </td><td valign="top"><a
href="Comments.html#Comments">Comments</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Configuration.html#index-configure"><code>configure</code></a>:</td><td> </td><td
valign="top"><a
href="Configuration.html#Configuration">Configuration</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-control_002dL">control-L</a>:</td><td> </td><td
valign="top"><a href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Makefile-Conventions.html#index-conventions-for-makefiles">conventions
for makefiles</a>:</td><td> </td><td valign="top"><a
href="Makefile-Conventions.html#Makefile-Conventions">Makefile
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-CORBA">CORBA</a>:</td><td> </td><td
valign="top"><a href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Manual-Credits.html#index-credits-for-manuals">credits for
manuals</a>:</td><td> </td><td valign="top"><a
href="Manual-Credits.html#Manual-Credits">Manual Credits</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-D">D</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-D_002dbus">D-bus</a>:</td><td> </td><td
valign="top"><a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-data-structures_002c-in-Gnulib"><code>data
structures, in Gnulib</code></a>:</td><td> </td><td valign="top"><a
href="System-Functions.html#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="CPU-Portability.html#index-data-types_002c-and-portability">data types,
and portability</a>:</td><td> </td><td valign="top"><a
href="CPU-Portability.html#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="DESTDIR.html#index-DESTDIR"><code>DESTDIR</code></a>:</td><td> </td><td
valign="top"><a href="DESTDIR.html#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Directory-Variables.html#index-directories_002c-creating-installation">directories,
creating installation</a>:</td><td> </td><td valign="top"><a
href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Documentation.html#index-documentation">documentation</a>:</td><td> </td><td
valign="top"><a
href="Documentation.html#Documentation">Documentation</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Names.html#index-doschk"><code>doschk</code></a>:</td><td> </td><td
valign="top"><a href="Names.html#Names">Names</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-double-quote">double
quote</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Preface.html#index-downloading-this-manual">downloading this
manual</a>:</td><td> </td><td valign="top"><a
href="Preface.html#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-dynamic-plug_002dins">dynamic
plug-ins</a>:</td><td> </td><td valign="top"><a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-E">E</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Character-Set.html#index-encodings">encodings</a>:</td><td> </td><td
valign="top"><a href="Character-Set.html#Character-Set">Character
Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-enum-types_002c-formatting"><code>enum</code>
types, formatting</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-error-messages">error
messages</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Errors.html#index-error-messages_002c-formatting">error messages,
formatting</a>:</td><td> </td><td valign="top"><a
href="Errors.html#Errors">Errors</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-error-messages_002c-in-Gnulib"><code>error
messages, in Gnulib</code></a>:</td><td> </td><td valign="top"><a
href="System-Functions.html#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Directory-Variables.html#index-exec_005fprefix"><code>exec_prefix</code></a>:</td><td> </td><td
valign="top"><a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-expressions_002c-splitting">expressions,
splitting</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-F">F</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="GNU-Free-Documentation-License.html#index-FDL_002c-GNU-Free-Documentation-License">FDL,
GNU Free Documentation License</a>:</td><td> </td><td valign="top"><a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</a></td></tr>
+<tr><td></td><td valign="top"><a href="File-Usage.html#index-file-usage">file
usage</a>:</td><td> </td><td valign="top"><a
href="File-Usage.html#File-Usage">File Usage</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Names.html#index-file_002dname-limitations">file-name
limitations</a>:</td><td> </td><td valign="top"><a
href="Names.html#Names">Names</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Errors.html#index-formatting-error-messages">formatting error
messages</a>:</td><td> </td><td valign="top"><a
href="Errors.html#Errors">Errors</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-formatting-source-code">formatting source
code</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-formfeed">formfeed</a>:</td><td> </td><td
valign="top"><a href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-function-argument_002c-declaring">function
argument, declaring</a>:</td><td> </td><td valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-function-definitions_002c-formatting">function
definitions, formatting</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Standard-C.html#index-function-prototypes">function
prototypes</a>:</td><td> </td><td valign="top"><a
href="Standard-C.html#Standard-C">Standard C</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-G">G</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Command_002dLine-Interfaces.html#index-getopt"><code>getopt</code></a>:</td><td> </td><td
valign="top"><a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Internationalization.html#index-gettext"><code>gettext</code></a>:</td><td> </td><td
valign="top"><a
href="Internationalization.html#Internationalization">Internationalization</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-GNOME">GNOME</a>:</td><td> </td><td
valign="top"><a href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Source-Language.html#index-GNOME-and-Guile">GNOME and
Guile</a>:</td><td> </td><td valign="top"><a
href="Source-Language.html#Source-Language">Source Language</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-Gnulib">Gnulib</a>:</td><td> </td><td
valign="top"><a href="System-Functions.html#System-Functions">System
Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Preface.html#index-gnustandards-project-repository">gnustandards project
repository</a>:</td><td> </td><td valign="top"><a
href="Preface.html#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Preface.html#index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"><code>address@hidden</code>
mailing list</a>:</td><td> </td><td valign="top"><a
href="Preface.html#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-graphical-user-interface">graphical user
interface</a>:</td><td> </td><td valign="top"><a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-grave-accent">grave
accent</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-GTK_002b">GTK+</a>:</td><td> </td><td
valign="top"><a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Source-Language.html#index-Guile">Guile</a>:</td><td> </td><td
valign="top"><a href="Source-Language.html#Source-Language">Source
Language</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-I">I</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-implicit-int">implicit
<code>int</code></a>:</td><td> </td><td valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-impossible-conditions">impossible
conditions</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Directory-Variables.html#index-installation-directories_002c-creating">installation
directories, creating</a>:</td><td> </td><td valign="top"><a
href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="DESTDIR.html#index-installations_002c-staged">installations,
staged</a>:</td><td> </td><td valign="top"><a
href="DESTDIR.html#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-interface-styles">interface
styles</a>:</td><td> </td><td valign="top"><a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Internationalization.html#index-internationalization">internationalization</a>:</td><td> </td><td
valign="top"><a
href="Internationalization.html#Internationalization">Internationalization</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-K">K</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-keyboard-interface">keyboard
interface</a>:</td><td> </td><td valign="top"><a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-L">L</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="OID-Allocations.html#index-LDAP">LDAP</a>:</td><td> </td><td
valign="top"><a href="OID-Allocations.html#OID-Allocations">OID
Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-left-quote">left
quote</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Legal-Issues.html#index-legal-aspects">legal
aspects</a>:</td><td> </td><td valign="top"><a
href="Legal-Issues.html#Legal-Issues">Legal Issues</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Contributions.html#index-legal-papers">legal
papers</a>:</td><td> </td><td valign="top"><a
href="Contributions.html#Contributions">Contributions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Directory-Variables.html#index-libexecdir"><code>libexecdir</code></a>:</td><td> </td><td
valign="top"><a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-libiconv"><code>libiconv</code></a>:</td><td> </td><td
valign="top"><a href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Libraries.html#index-libraries">libraries</a>:</td><td> </td><td
valign="top"><a href="Libraries.html#Libraries">Libraries</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-library-functions_002c-and-portability">library
functions, and portability</a>:</td><td> </td><td valign="top"><a
href="System-Functions.html#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-library-interface">library
interface</a>:</td><td> </td><td valign="top"><a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="License-for-Manuals.html#index-license-for-manuals">license for
manuals</a>:</td><td> </td><td valign="top"><a
href="License-for-Manuals.html#License-for-Manuals">License for
Manuals</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-lint"><code>lint</code></a>:</td><td> </td><td
valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-locale_002dspecific-quote-characters">locale-specific
quote characters</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Option-Table.html#index-long-option-names">long option
names</a>:</td><td> </td><td valign="top"><a
href="Option-Table.html#Option-Table">Option Table</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Command_002dLine-Interfaces.html#index-long_002dnamed-options">long-named
options</a>:</td><td> </td><td valign="top"><a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-M">M</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Makefile-Conventions.html#index-makefile_002c-conventions-for">makefile,
conventions for</a>:</td><td> </td><td valign="top"><a
href="Makefile-Conventions.html#Makefile-Conventions">Makefile
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-malloc-return-value"><code>malloc</code> return
value</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a href="Man-Pages.html#index-man-pages">man
pages</a>:</td><td> </td><td valign="top"><a
href="Man-Pages.html#Man-Pages">Man Pages</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Manual-Structure-Details.html#index-manual-structure">manual
structure</a>:</td><td> </td><td valign="top"><a
href="Manual-Structure-Details.html#Manual-Structure-Details">Manual Structure
Details</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-memory-allocation-failure">memory allocation
failure</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Memory-Usage.html#index-memory-leak">memory
leak</a>:</td><td> </td><td valign="top"><a
href="Memory-Usage.html#Memory-Usage">Memory Usage</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Memory-Usage.html#index-memory-usage">memory
usage</a>:</td><td> </td><td valign="top"><a
href="Memory-Usage.html#Memory-Usage">Memory Usage</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Internationalization.html#index-message-text_002c-and-internationalization">message
text, and internationalization</a>:</td><td> </td><td valign="top"><a
href="Internationalization.html#Internationalization">Internationalization</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Mmap.html#index-mmap"><code>mmap</code></a>:</td><td> </td><td
valign="top"><a href="Mmap.html#Mmap">Mmap</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-multiple-variables-in-a-line">multiple
variables in a line</a>:</td><td> </td><td valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-N">N</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Names.html#index-names-of-variables_002c-functions_002c-and-files">names
of variables, functions, and files</a>:</td><td> </td><td valign="top"><a
href="Names.html#Names">Names</a></td></tr>
+<tr><td></td><td valign="top"><a
href="NEWS-File.html#index-NEWS-file">‘<tt>NEWS</tt>’
file</a>:</td><td> </td><td valign="top"><a
href="NEWS-File.html#NEWS-File">NEWS File</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Character-Set.html#index-non_002dASCII-characters">non-ASCII
characters</a>:</td><td> </td><td valign="top"><a
href="Character-Set.html#Character-Set">Character Set</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Portability.html#index-non_002dPOSIX-systems_002c-and-portability">non-<small>POSIX</small>
systems, and portability</a>:</td><td> </td><td valign="top"><a
href="System-Portability.html#System-Portability">System
Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Using-Extensions.html#index-non_002dstandard-extensions">non-standard
extensions</a>:</td><td> </td><td valign="top"><a
href="Using-Extensions.html#Using-Extensions">Using Extensions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-NUL-characters"><code>NUL</code>
characters</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-O">O</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="OID-Allocations.html#index-OID-allocations-for-GNU">OID allocations for
GNU</a>:</td><td> </td><td valign="top"><a
href="OID-Allocations.html#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a href="Formatting.html#index-open-brace">open
brace</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-opening-quote">opening
quote</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Configuration.html#index-optional-features_002c-configure_002dtime">optional
features, configure-time</a>:</td><td> </td><td valign="top"><a
href="Configuration.html#Configuration">Configuration</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Compatibility.html#index-options-for-compatibility">options for
compatibility</a>:</td><td> </td><td valign="top"><a
href="Compatibility.html#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Command_002dLine-Interfaces.html#index-options_002c-standard-command_002dline">options,
standard command-line</a>:</td><td> </td><td valign="top"><a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="User-Interfaces.html#index-output-device-and-program_0027s-behavior">output
device and program’s behavior</a>:</td><td> </td><td
valign="top"><a href="User-Interfaces.html#User-Interfaces">User
Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-P">P</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Releases.html#index-packaging">packaging</a>:</td><td> </td><td
valign="top"><a href="Releases.html#Releases">Releases</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Command_002dLine-Interfaces.html#index-PATH_005fINFO_002c-specifying-standard-options-as">PATH_INFO,
specifying standard options as</a>:</td><td> </td><td valign="top"><a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-plug_002dins">plug-ins</a>:</td><td> </td><td
valign="top"><a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-plugin_005fis_005fGPL_005fcompatible"><code>plugin_is_GPL_compatible</code></a>:</td><td> </td><td
valign="top"><a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="CPU-Portability.html#index-portability_002c-and-data-types">portability,
and data types</a>:</td><td> </td><td valign="top"><a
href="CPU-Portability.html#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-portability_002c-and-library-functions">portability,
and library functions</a>:</td><td> </td><td valign="top"><a
href="System-Functions.html#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Portability.html#index-portability_002c-between-system-types">portability,
between system types</a>:</td><td> </td><td valign="top"><a
href="System-Portability.html#System-Portability">System
Portability</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Compatibility.html#index-POSIX-compatibility"><small>POSIX</small>
compatibility</a>:</td><td> </td><td valign="top"><a
href="Compatibility.html#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-POSIX-functions_002c-and-portability">POSIX
functions, and portability</a>:</td><td> </td><td valign="top"><a
href="System-Functions.html#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Compatibility.html#index-POSIXLY_005fCORRECT_002c-environment-variable"><code>POSIXLY_CORRECT</code>,
environment variable</a>:</td><td> </td><td valign="top"><a
href="Compatibility.html#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Install-Command-Categories.html#index-post_002dinstallation-commands">post-installation
commands</a>:</td><td> </td><td valign="top"><a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Install-Command-Categories.html#index-pre_002dinstallation-commands">pre-installation
commands</a>:</td><td> </td><td valign="top"><a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Directory-Variables.html#index-prefix"><code>prefix</code></a>:</td><td> </td><td
valign="top"><a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Configuration.html#index-program-configuration">program
configuration</a>:</td><td> </td><td valign="top"><a
href="Configuration.html#Configuration">Configuration</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Design-Advice.html#index-program-design">program
design</a>:</td><td> </td><td valign="top"><a
href="Design-Advice.html#Design-Advice">Design Advice</a></td></tr>
+<tr><td></td><td valign="top"><a
href="User-Interfaces.html#index-program-name-and-its-behavior">program name
and its behavior</a>:</td><td> </td><td valign="top"><a
href="User-Interfaces.html#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="_002d_002dversion.html#index-program_0027s-canonical-name">program’s
canonical name</a>:</td><td> </td><td valign="top"><a
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Source-Language.html#index-programming-languages">programming
languages</a>:</td><td> </td><td valign="top"><a
href="Source-Language.html#Source-Language">Source Language</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Reading-Non_002dFree-Code.html#index-proprietary-programs">proprietary
programs</a>:</td><td> </td><td valign="top"><a
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">Reading
Non-Free Code</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-Q">Q</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-quote-characters">quote
characters</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-R">R</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Releases.html#index-README-file">‘<tt>README</tt>’
file</a>:</td><td> </td><td valign="top"><a
href="Releases.html#Releases">Releases</a></td></tr>
+<tr><td></td><td valign="top"><a
href="References.html#index-references-to-non_002dfree-material">references to
non-free material</a>:</td><td> </td><td valign="top"><a
href="References.html#References">References</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Managing-Releases.html#index-releasing">releasing</a>:</td><td> </td><td
valign="top"><a href="Managing-Releases.html#Managing-Releases">Managing
Releases</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-right-quote">right
quote</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-S">S</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Preface.html#index-Savannah-repository-for-gnustandards">Savannah
repository for gnustandards</a>:</td><td> </td><td valign="top"><a
href="Preface.html#Preface">Preface</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Directory-Variables.html#index-sbindir"><code>sbindir</code></a>:</td><td> </td><td
valign="top"><a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-signal-handling">signal
handling</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Quote-Characters.html#index-single-quote">single
quote</a>:</td><td> </td><td valign="top"><a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td valign="top"><a
href="OID-Allocations.html#index-SNMP">SNMP</a>:</td><td> </td><td
valign="top"><a href="OID-Allocations.html#OID-Allocations">OID
Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-spaces-before-open_002dparen">spaces before
open-paren</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="DESTDIR.html#index-staged-installs">staged
installs</a>:</td><td> </td><td valign="top"><a
href="DESTDIR.html#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Command_002dLine-Interfaces.html#index-standard-command_002dline-options">standard
command-line options</a>:</td><td> </td><td valign="top"><a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Makefile-Conventions.html#index-standards-for-makefiles">standards for
makefiles</a>:</td><td> </td><td valign="top"><a
href="Makefile-Conventions.html#Makefile-Conventions">Makefile
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Formatting.html#index-struct-types_002c-formatting"><code>struct</code>
types, formatting</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-syntactic-conventions">syntactic
conventions</a>:</td><td> </td><td valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-T">T</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Option-Table.html#index-table-of-long-options">table of long
options</a>:</td><td> </td><td valign="top"><a
href="Option-Table.html#Option-Table">Option Table</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-temporary-files">temporary
files</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Syntactic-Conventions.html#index-temporary-variables">temporary
variables</a>:</td><td> </td><td valign="top"><a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Releases.html#index-texinfo_002etex_002c-in-a-distribution">‘<tt>texinfo.tex</tt>’,
in a distribution</a>:</td><td> </td><td valign="top"><a
href="Releases.html#Releases">Releases</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Semantics.html#index-TMPDIR-environment-variable"><code>TMPDIR</code>
environment variable</a>:</td><td> </td><td valign="top"><a
href="Semantics.html#Semantics">Semantics</a></td></tr>
+<tr><td></td><td valign="top"><a
href="Trademarks.html#index-trademarks">trademarks</a>:</td><td> </td><td
valign="top"><a href="Trademarks.html#Trademarks">Trademarks</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-U">U</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Graphical-Interfaces.html#index-user-interface-styles">user interface
styles</a>:</td><td> </td><td valign="top"><a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-V">V</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Memory-Usage.html#index-valgrind"><code>valgrind</code></a>:</td><td> </td><td
valign="top"><a href="Memory-Usage.html#Memory-Usage">Memory
Usage</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-W">W</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="Preface.html#index-where-to-obtain-standards_002etexi">where to obtain
<code>standards.texi</code></a>:</td><td> </td><td valign="top"><a
href="Preface.html#Preface">Preface</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+<tr><th><a name="Index_cp_letter-X">X</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a
href="OID-Allocations.html#index-X_002e509">X.509</a>:</td><td> </td><td
valign="top"><a href="OID-Allocations.html#OID-Allocations">OID
Allocations</a></td></tr>
+<tr><td></td><td valign="top"><a
href="System-Functions.html#index-xmalloc_002c-in-Gnulib"><code>xmalloc, in
Gnulib</code></a>:</td><td> </td><td valign="top"><a
href="System-Functions.html#System-Functions">System Functions</a></td></tr>
+<tr><td colspan="4"> <hr></td></tr>
+</table>
+<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter"
href="#Index_cp_symbol-1"><b>#</b></a>
+
+<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+
+<br>
+<a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-E"><b>E</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-G"><b>G</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-K"><b>K</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-O"><b>O</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-Q"><b>Q</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-T"><b>T</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
+
+<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+
+</td></tr></table>
+
+<hr>
+<div class="header">
+<p>
+Previous: <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
accesskey="p" rel="previous">GNU Free Documentation License</a>, Up: <a
href="index.html#Top" accesskey="u" rel="up">Top</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-<h2 class="unnumbered">Index</h2>
-<ul class="index-cp" compact>
-<li><a
href="Comments.html#index-g_t_0040code_007b_0023endif_007d_002c-commenting-88"><code>#endif</code>,
commenting</a>: <a href="Comments.html#Comments">Comments</a></li>
-<li><a
href="_002d_002dhelp.html#index-g_t_0040samp_007b_002d_002dhelp_007d-output-60">‘<samp><span
class="samp">--help</span></samp>’ output</a>: <a
href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a></li>
-<li><a
href="_002d_002dversion.html#index-g_t_0040samp_007b_002d_002dversion_007d-output-57">‘<samp><span
class="samp">--version</span></samp>’ output</a>: <a
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a></li>
-<li><a
href="Syntactic-Conventions.html#index-g_t_0040samp_007b_002dWall_007d-compiler-option-93">‘<samp><span
class="samp">-Wall</span></samp>’ compiler option</a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a href="Contributions.html#index-accepting-contributions-11">accepting
contributions</a>: <a
href="Contributions.html#Contributions">Contributions</a></li>
-<li><a href="_002d_002dhelp.html#index-address-for-bug-reports-61">address for
bug reports</a>: <a href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a></li>
-<li><a
href="Standard-C.html#index-g_t_0040sc_007bansi_007d-C-standard-22"><span
class="sc">ansi</span> C standard</a>: <a
href="Standard-C.html#Standard-C">Standard C</a></li>
-<li><a href="Semantics.html#index-arbitrary-limits-on-data-24">arbitrary
limits on data</a>: <a href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="Character-Set.html#index-ASCII-characters-120">ASCII
characters</a>: <a href="Character-Set.html#Character-Set">Character
Set</a></li>
-<li><a
href="System-Portability.html#index-autoconf-102"><code>autoconf</code></a>: <a
href="System-Portability.html#System-Portability">System Portability</a></li>
-<li><a
href="Reading-Non_002dFree-Code.html#index-avoiding-proprietary-code-9">avoiding
proprietary code</a>: <a
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">Reading
Non-Free Code</a></li>
-<li><a
href="User-Interfaces.html#index-behavior_002c-dependent-on-program_0027s-name-39">behavior,
dependent on program's name</a>: <a
href="User-Interfaces.html#User-Interfaces">User Interfaces</a></li>
-<li><a href="Install-Command-Categories.html#index-binary-packages-160">binary
packages</a>: <a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a></li>
-<li><a
href="Directory-Variables.html#index-bindir-155"><code>bindir</code></a>: <a
href="Directory-Variables.html#Directory-Variables">Directory Variables</a></li>
-<li><a href="Formatting.html#index-braces_002c-in-C-source-78">braces, in C
source</a>: <a href="Formatting.html#Formatting">Formatting</a></li>
-<li><a href="_002d_002dhelp.html#index-bug-reports-62">bug reports</a>: <a
href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a></li>
-<li><a
href="Preface.html#index-g_t_0040code_007bbug_002dstandards_0040_0040gnu_002eorg_007d-email-address-4"><code>address@hidden</code>
email address</a>: <a href="Preface.html#Preface">Preface</a></li>
-<li><a
href="System-Functions.html#index-C-library-functions_002c-and-portability-107">C
library functions, and portability</a>: <a
href="System-Functions.html#System-Functions">System Functions</a></li>
-<li><a
href="_002d_002dversion.html#index-canonical-name-of-a-program-58">canonical
name of a program</a>: <a
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a></li>
-<li><a
href="CPU-Portability.html#index-casting-pointers-to-integers-106">casting
pointers to integers</a>: <a href="CPU-Portability.html#CPU-Portability">CPU
Portability</a></li>
-<li><a
href="Command_002dLine-Interfaces.html#index-CGI-programs_002c-standard-options-for-55">CGI
programs, standard options for</a>: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a href="Change-Logs.html#index-change-logs-136">change logs</a>: <a
href="Change-Logs.html#Change-Logs">Change Logs</a></li>
-<li><a
href="Conditional-Changes.html#index-change-logs_002c-conditional-changes-139">change
logs, conditional changes</a>: <a
href="Conditional-Changes.html#Conditional-Changes">Conditional Changes</a></li>
-<li><a
href="Style-of-Change-Logs.html#index-change-logs_002c-style-137">change logs,
style</a>: <a href="Style-of-Change-Logs.html#Style-of-Change-Logs">Style of
Change Logs</a></li>
-<li><a href="Character-Set.html#index-character-set-118">character set</a>: <a
href="Character-Set.html#Character-Set">Character Set</a></li>
-<li><a
href="Syntactic-Conventions.html#index-clang-94"><code>clang</code></a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a
href="Semantics.html#index-command_002dline-arguments_002c-decoding-30">command-line
arguments, decoding</a>: <a href="Semantics.html#Semantics">Semantics</a></li>
-<li><a
href="Command_002dLine-Interfaces.html#index-command_002dline-interface-50">command-line
interface</a>: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a href="Comments.html#index-commenting-86">commenting</a>: <a
href="Comments.html#Comments">Comments</a></li>
-<li><a
href="Compatibility.html#index-compatibility-with-C-and-_0040sc_007bposix_007d-standards-17">compatibility
with C and <span class="sc">posix</span> standards</a>: <a
href="Compatibility.html#Compatibility">Compatibility</a></li>
-<li><a href="Syntactic-Conventions.html#index-compiler-warnings-92">compiler
warnings</a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a
href="Conditional-Changes.html#index-conditional-changes_002c-and-change-logs-138">conditional
changes, and change logs</a>: <a
href="Conditional-Changes.html#Conditional-Changes">Conditional Changes</a></li>
-<li><a
href="Comments.html#index-conditionals_002c-comments-for-87">conditionals,
comments for</a>: <a href="Comments.html#Comments">Comments</a></li>
-<li><a
href="Configuration.html#index-configure-143"><code>configure</code></a>: <a
href="Configuration.html#Configuration">Configuration</a></li>
-<li><a href="Formatting.html#index-control_002dL-85">control-L</a>: <a
href="Formatting.html#Formatting">Formatting</a></li>
-<li><a
href="Makefile-Conventions.html#index-conventions-for-makefiles-146">conventions
for makefiles</a>: <a
href="Makefile-Conventions.html#Makefile-Conventions">Makefile
Conventions</a></li>
-<li><a href="Graphical-Interfaces.html#index-CORBA-45">CORBA</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a href="Manual-Credits.html#index-credits-for-manuals-134">credits for
manuals</a>: <a href="Manual-Credits.html#Manual-Credits">Manual
Credits</a></li>
-<li><a href="Graphical-Interfaces.html#index-D_002dbus-47">D-bus</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a
href="System-Functions.html#index-data-structures_002c-in-Gnulib-114"><code>data
structures, in Gnulib</code></a>: <a
href="System-Functions.html#System-Functions">System Functions</a></li>
-<li><a
href="CPU-Portability.html#index-data-types_002c-and-portability-104">data
types, and portability</a>: <a href="CPU-Portability.html#CPU-Portability">CPU
Portability</a></li>
-<li><a href="DESTDIR.html#index-DESTDIR-148"><code>DESTDIR</code></a>: <a
href="DESTDIR.html#DESTDIR">DESTDIR</a></li>
-<li><a
href="Directory-Variables.html#index-directories_002c-creating-installation-151">directories,
creating installation</a>: <a
href="Directory-Variables.html#Directory-Variables">Directory Variables</a></li>
-<li><a href="Documentation.html#index-documentation-131">documentation</a>: <a
href="Documentation.html#Documentation">Documentation</a></li>
-<li><a href="Names.html#index-doschk-100"><code>doschk</code></a>: <a
href="Names.html#Names">Names</a></li>
-<li><a href="Quote-Characters.html#index-double-quote-128">double quote</a>:
<a href="Quote-Characters.html#Quote-Characters">Quote Characters</a></li>
-<li><a href="Preface.html#index-downloading-this-manual-2">downloading this
manual</a>: <a href="Preface.html#Preface">Preface</a></li>
-<li><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-dynamic-plug_002dins-64">dynamic
plug-ins</a>: <a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a></li>
-<li><a href="Character-Set.html#index-encodings-119">encodings</a>: <a
href="Character-Set.html#Character-Set">Character Set</a></li>
-<li><a
href="Formatting.html#index-g_t_0040code_007benum_007d-types_002c-formatting-81"><code>enum</code>
types, formatting</a>: <a href="Formatting.html#Formatting">Formatting</a></li>
-<li><a href="Semantics.html#index-error-messages-27">error messages</a>: <a
href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="Errors.html#index-error-messages_002c-formatting-37">error
messages, formatting</a>: <a href="Errors.html#Errors">Errors</a></li>
-<li><a
href="System-Functions.html#index-error-messages_002c-in-Gnulib-113"><code>error
messages, in Gnulib</code></a>: <a
href="System-Functions.html#System-Functions">System Functions</a></li>
-<li><a
href="Directory-Variables.html#index-exec_005fprefix-154"><code>exec_prefix</code></a>:
<a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></li>
-<li><a href="Formatting.html#index-expressions_002c-splitting-83">expressions,
splitting</a>: <a href="Formatting.html#Formatting">Formatting</a></li>
-<li><a
href="GNU-Free-Documentation-License.html#index-FDL_002c-GNU-Free-Documentation-License-165">FDL,
GNU Free Documentation License</a>: <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</a></li>
-<li><a href="File-Usage.html#index-file-usage-75">file usage</a>: <a
href="File-Usage.html#File-Usage">File Usage</a></li>
-<li><a href="Names.html#index-file_002dname-limitations-99">file-name
limitations</a>: <a href="Names.html#Names">Names</a></li>
-<li><a href="Errors.html#index-formatting-error-messages-36">formatting error
messages</a>: <a href="Errors.html#Errors">Errors</a></li>
-<li><a href="Formatting.html#index-formatting-source-code-76">formatting
source code</a>: <a href="Formatting.html#Formatting">Formatting</a></li>
-<li><a href="Formatting.html#index-formfeed-84">formfeed</a>: <a
href="Formatting.html#Formatting">Formatting</a></li>
-<li><a
href="Syntactic-Conventions.html#index-function-argument_002c-declaring-91">function
argument, declaring</a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a
href="Formatting.html#index-function-definitions_002c-formatting-79">function
definitions, formatting</a>: <a
href="Formatting.html#Formatting">Formatting</a></li>
-<li><a href="Standard-C.html#index-function-prototypes-23">function
prototypes</a>: <a href="Standard-C.html#Standard-C">Standard C</a></li>
-<li><a
href="Command_002dLine-Interfaces.html#index-getopt-51"><code>getopt</code></a>:
<a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a
href="Internationalization.html#index-gettext-116"><code>gettext</code></a>: <a
href="Internationalization.html#Internationalization">Internationalization</a></li>
-<li><a href="Graphical-Interfaces.html#index-GNOME-46">GNOME</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a href="Source-Language.html#index-GNOME-and-Guile-16">GNOME and
Guile</a>: <a href="Source-Language.html#Source-Language">Source
Language</a></li>
-<li><a href="System-Functions.html#index-Gnulib-111">Gnulib</a>: <a
href="System-Functions.html#System-Functions">System Functions</a></li>
-<li><a
href="Preface.html#index-gnustandards-project-repository-6">gnustandards
project repository</a>: <a href="Preface.html#Preface">Preface</a></li>
-<li><a
href="Preface.html#index-g_t_0040code_007bgnustandards_002dcommit_0040_0040gnu_002eorg_007d-mailing-list-3"><code>address@hidden</code>
mailing list</a>: <a href="Preface.html#Preface">Preface</a></li>
-<li><a
href="Graphical-Interfaces.html#index-graphical-user-interface-41">graphical
user interface</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a href="Quote-Characters.html#index-grave-accent-129">grave accent</a>:
<a href="Quote-Characters.html#Quote-Characters">Quote Characters</a></li>
-<li><a href="Graphical-Interfaces.html#index-GTK_002b-44">GTK+</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a href="Source-Language.html#index-Guile-15">Guile</a>: <a
href="Source-Language.html#Source-Language">Source Language</a></li>
-<li><a
href="Syntactic-Conventions.html#index-implicit-_0040code_007bint_007d-90">implicit
<code>int</code></a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a href="Semantics.html#index-impossible-conditions-32">impossible
conditions</a>: <a href="Semantics.html#Semantics">Semantics</a></li>
-<li><a
href="Directory-Variables.html#index-installation-directories_002c-creating-152">installation
directories, creating</a>: <a
href="Directory-Variables.html#Directory-Variables">Directory Variables</a></li>
-<li><a href="DESTDIR.html#index-installations_002c-staged-150">installations,
staged</a>: <a href="DESTDIR.html#DESTDIR">DESTDIR</a></li>
-<li><a href="Graphical-Interfaces.html#index-interface-styles-42">interface
styles</a>: <a href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a
href="Internationalization.html#index-internationalization-115">internationalization</a>:
<a
href="Internationalization.html#Internationalization">Internationalization</a></li>
-<li><a href="Graphical-Interfaces.html#index-keyboard-interface-48">keyboard
interface</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a href="OID-Allocations.html#index-LDAP-70">LDAP</a>: <a
href="OID-Allocations.html#OID-Allocations">OID Allocations</a></li>
-<li><a href="Quote-Characters.html#index-left-quote-124">left quote</a>: <a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></li>
-<li><a href="Legal-Issues.html#index-legal-aspects-7">legal aspects</a>: <a
href="Legal-Issues.html#Legal-Issues">Legal Issues</a></li>
-<li><a href="Contributions.html#index-legal-papers-10">legal papers</a>: <a
href="Contributions.html#Contributions">Contributions</a></li>
-<li><a
href="Directory-Variables.html#index-libexecdir-157"><code>libexecdir</code></a>:
<a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a></li>
-<li><a href="Semantics.html#index-libiconv-26"><code>libiconv</code></a>: <a
href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="Libraries.html#index-libraries-35">libraries</a>: <a
href="Libraries.html#Libraries">Libraries</a></li>
-<li><a
href="System-Functions.html#index-library-functions_002c-and-portability-109">library
functions, and portability</a>: <a
href="System-Functions.html#System-Functions">System Functions</a></li>
-<li><a href="Graphical-Interfaces.html#index-library-interface-49">library
interface</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a href="License-for-Manuals.html#index-license-for-manuals-133">license
for manuals</a>: <a href="License-for-Manuals.html#License-for-Manuals">License
for Manuals</a></li>
-<li><a href="Syntactic-Conventions.html#index-lint-95"><code>lint</code></a>:
<a href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a
href="Quote-Characters.html#index-locale_002dspecific-quote-characters-123">locale-specific
quote characters</a>: <a href="Quote-Characters.html#Quote-Characters">Quote
Characters</a></li>
-<li><a href="Option-Table.html#index-long-option-names-66">long option
names</a>: <a href="Option-Table.html#Option-Table">Option Table</a></li>
-<li><a
href="Command_002dLine-Interfaces.html#index-long_002dnamed-options-52">long-named
options</a>: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a
href="Makefile-Conventions.html#index-makefile_002c-conventions-for-145">makefile,
conventions for</a>: <a
href="Makefile-Conventions.html#Makefile-Conventions">Makefile
Conventions</a></li>
-<li><a
href="Semantics.html#index-g_t_0040code_007bmalloc_007d-return-value-28"><code>malloc</code>
return value</a>: <a href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="Man-Pages.html#index-man-pages-140">man pages</a>: <a
href="Man-Pages.html#Man-Pages">Man Pages</a></li>
-<li><a href="Manual-Structure-Details.html#index-manual-structure-132">manual
structure</a>: <a
href="Manual-Structure-Details.html#Manual-Structure-Details">Manual Structure
Details</a></li>
-<li><a href="Semantics.html#index-memory-allocation-failure-29">memory
allocation failure</a>: <a href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="Memory-Usage.html#index-memory-leak-74">memory leak</a>: <a
href="Memory-Usage.html#Memory-Usage">Memory Usage</a></li>
-<li><a href="Memory-Usage.html#index-memory-usage-72">memory usage</a>: <a
href="Memory-Usage.html#Memory-Usage">Memory Usage</a></li>
-<li><a
href="Internationalization.html#index-message-text_002c-and-internationalization-117">message
text, and internationalization</a>: <a
href="Internationalization.html#Internationalization">Internationalization</a></li>
-<li><a href="Mmap.html#index-mmap-130"><code>mmap</code></a>: <a
href="Mmap.html#Mmap">Mmap</a></li>
-<li><a
href="Syntactic-Conventions.html#index-multiple-variables-in-a-line-97">multiple
variables in a line</a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a
href="Names.html#index-names-of-variables_002c-functions_002c-and-files-98">names
of variables, functions, and files</a>: <a
href="Names.html#Names">Names</a></li>
-<li><a
href="NEWS-File.html#index-g_t_0040file_007bNEWS_007d-file-135"><samp><span
class="file">NEWS</span></samp> file</a>: <a
href="NEWS-File.html#NEWS-File">NEWS File</a></li>
-<li><a href="Character-Set.html#index-non_002dASCII-characters-121">non-ASCII
characters</a>: <a href="Character-Set.html#Character-Set">Character
Set</a></li>
-<li><a
href="System-Portability.html#index-non_002d_0040sc_007bposix_007d-systems_002c-and-portability-103">non-<span
class="sc">posix</span> systems, and portability</a>: <a
href="System-Portability.html#System-Portability">System Portability</a></li>
-<li><a
href="Using-Extensions.html#index-non_002dstandard-extensions-21">non-standard
extensions</a>: <a href="Using-Extensions.html#Using-Extensions">Using
Extensions</a></li>
-<li><a
href="Semantics.html#index-g_t_0040code_007bNUL_007d-characters-25"><code>NUL</code>
characters</a>: <a href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="OID-Allocations.html#index-OID-allocations-for-GNU-68">OID
allocations for GNU</a>: <a href="OID-Allocations.html#OID-Allocations">OID
Allocations</a></li>
-<li><a href="Formatting.html#index-open-brace-77">open brace</a>: <a
href="Formatting.html#Formatting">Formatting</a></li>
-<li><a href="Quote-Characters.html#index-opening-quote-126">opening quote</a>:
<a href="Quote-Characters.html#Quote-Characters">Quote Characters</a></li>
-<li><a
href="Configuration.html#index-optional-features_002c-configure_002dtime-144">optional
features, configure-time</a>: <a
href="Configuration.html#Configuration">Configuration</a></li>
-<li><a href="Compatibility.html#index-options-for-compatibility-19">options
for compatibility</a>: <a
href="Compatibility.html#Compatibility">Compatibility</a></li>
-<li><a
href="Command_002dLine-Interfaces.html#index-options_002c-standard-command_002dline-54">options,
standard command-line</a>: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a
href="User-Interfaces.html#index-output-device-and-program_0027s-behavior-40">output
device and program's behavior</a>: <a
href="User-Interfaces.html#User-Interfaces">User Interfaces</a></li>
-<li><a href="Releases.html#index-packaging-161">packaging</a>: <a
href="Releases.html#Releases">Releases</a></li>
-<li><a
href="Command_002dLine-Interfaces.html#index-PATH_005fINFO_002c-specifying-standard-options-as-56">PATH_INFO,
specifying standard options as</a>: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-plug_002dins-63">plug-ins</a>:
<a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a></li>
-<li><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-plugin_005fis_005fGPL_005fcompatible-65"><code>plugin_is_GPL_compatible</code></a>:
<a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a></li>
-<li><a
href="CPU-Portability.html#index-portability_002c-and-data-types-105">portability,
and data types</a>: <a href="CPU-Portability.html#CPU-Portability">CPU
Portability</a></li>
-<li><a
href="System-Functions.html#index-portability_002c-and-library-functions-110">portability,
and library functions</a>: <a
href="System-Functions.html#System-Functions">System Functions</a></li>
-<li><a
href="System-Portability.html#index-portability_002c-between-system-types-101">portability,
between system types</a>: <a
href="System-Portability.html#System-Portability">System Portability</a></li>
-<li><a
href="Compatibility.html#index-g_t_0040sc_007bposix_007d-compatibility-18"><span
class="sc">posix</span> compatibility</a>: <a
href="Compatibility.html#Compatibility">Compatibility</a></li>
-<li><a
href="System-Functions.html#index-POSIX-functions_002c-and-portability-108">POSIX
functions, and portability</a>: <a
href="System-Functions.html#System-Functions">System Functions</a></li>
-<li><a
href="Compatibility.html#index-g_t_0040code_007bPOSIXLY_005fCORRECT_007d_002c-environment-variable-20"><code>POSIXLY_CORRECT</code>,
environment variable</a>: <a
href="Compatibility.html#Compatibility">Compatibility</a></li>
-<li><a
href="Install-Command-Categories.html#index-post_002dinstallation-commands-159">post-installation
commands</a>: <a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a></li>
-<li><a
href="Install-Command-Categories.html#index-pre_002dinstallation-commands-158">pre-installation
commands</a>: <a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a></li>
-<li><a
href="Directory-Variables.html#index-prefix-153"><code>prefix</code></a>: <a
href="Directory-Variables.html#Directory-Variables">Directory Variables</a></li>
-<li><a href="Configuration.html#index-program-configuration-142">program
configuration</a>: <a
href="Configuration.html#Configuration">Configuration</a></li>
-<li><a href="Design-Advice.html#index-program-design-13">program design</a>:
<a href="Design-Advice.html#Design-Advice">Design Advice</a></li>
-<li><a
href="User-Interfaces.html#index-program-name-and-its-behavior-38">program name
and its behavior</a>: <a href="User-Interfaces.html#User-Interfaces">User
Interfaces</a></li>
-<li><a
href="_002d_002dversion.html#index-program_0027s-canonical-name-59">program's
canonical name</a>: <a
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a></li>
-<li><a href="Source-Language.html#index-programming-languages-14">programming
languages</a>: <a href="Source-Language.html#Source-Language">Source
Language</a></li>
-<li><a
href="Reading-Non_002dFree-Code.html#index-proprietary-programs-8">proprietary
programs</a>: <a
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">Reading
Non-Free Code</a></li>
-<li><a href="Quote-Characters.html#index-quote-characters-122">quote
characters</a>: <a href="Quote-Characters.html#Quote-Characters">Quote
Characters</a></li>
-<li><a
href="Releases.html#index-g_t_0040file_007bREADME_007d-file-162"><samp><span
class="file">README</span></samp> file</a>: <a
href="Releases.html#Releases">Releases</a></li>
-<li><a
href="References.html#index-references-to-non_002dfree-material-164">references
to non-free material</a>: <a
href="References.html#References">References</a></li>
-<li><a href="Managing-Releases.html#index-releasing-141">releasing</a>: <a
href="Managing-Releases.html#Managing-Releases">Managing Releases</a></li>
-<li><a href="Quote-Characters.html#index-right-quote-125">right quote</a>: <a
href="Quote-Characters.html#Quote-Characters">Quote Characters</a></li>
-<li><a
href="Preface.html#index-Savannah-repository-for-gnustandards-5">Savannah
repository for gnustandards</a>: <a href="Preface.html#Preface">Preface</a></li>
-<li><a
href="Directory-Variables.html#index-sbindir-156"><code>sbindir</code></a>: <a
href="Directory-Variables.html#Directory-Variables">Directory Variables</a></li>
-<li><a href="Semantics.html#index-signal-handling-31">signal handling</a>: <a
href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="Quote-Characters.html#index-single-quote-127">single quote</a>:
<a href="Quote-Characters.html#Quote-Characters">Quote Characters</a></li>
-<li><a href="OID-Allocations.html#index-SNMP-69">SNMP</a>: <a
href="OID-Allocations.html#OID-Allocations">OID Allocations</a></li>
-<li><a href="Formatting.html#index-spaces-before-open_002dparen-82">spaces
before open-paren</a>: <a href="Formatting.html#Formatting">Formatting</a></li>
-<li><a href="DESTDIR.html#index-staged-installs-149">staged installs</a>: <a
href="DESTDIR.html#DESTDIR">DESTDIR</a></li>
-<li><a
href="Command_002dLine-Interfaces.html#index-standard-command_002dline-options-53">standard
command-line options</a>: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a></li>
-<li><a
href="Makefile-Conventions.html#index-standards-for-makefiles-147">standards
for makefiles</a>: <a
href="Makefile-Conventions.html#Makefile-Conventions">Makefile
Conventions</a></li>
-<li><a
href="Formatting.html#index-g_t_0040code_007bstruct_007d-types_002c-formatting-80"><code>struct</code>
types, formatting</a>: <a href="Formatting.html#Formatting">Formatting</a></li>
-<li><a
href="Syntactic-Conventions.html#index-syntactic-conventions-89">syntactic
conventions</a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a href="Option-Table.html#index-table-of-long-options-67">table of long
options</a>: <a href="Option-Table.html#Option-Table">Option Table</a></li>
-<li><a href="Semantics.html#index-temporary-files-33">temporary files</a>: <a
href="Semantics.html#Semantics">Semantics</a></li>
-<li><a
href="Syntactic-Conventions.html#index-temporary-variables-96">temporary
variables</a>: <a
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a></li>
-<li><a
href="Releases.html#index-g_t_0040file_007btexinfo_002etex_007d_002c-in-a-distribution-163"><samp><span
class="file">texinfo.tex</span></samp>, in a distribution</a>: <a
href="Releases.html#Releases">Releases</a></li>
-<li><a
href="Semantics.html#index-g_t_0040code_007bTMPDIR_007d-environment-variable-34"><code>TMPDIR</code>
environment variable</a>: <a href="Semantics.html#Semantics">Semantics</a></li>
-<li><a href="Trademarks.html#index-trademarks-12">trademarks</a>: <a
href="Trademarks.html#Trademarks">Trademarks</a></li>
-<li><a href="Graphical-Interfaces.html#index-user-interface-styles-43">user
interface styles</a>: <a
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical
Interfaces</a></li>
-<li><a href="Memory-Usage.html#index-valgrind-73"><code>valgrind</code></a>:
<a href="Memory-Usage.html#Memory-Usage">Memory Usage</a></li>
-<li><a
href="Preface.html#index-where-to-obtain-_0040code_007bstandards_002etexi_007d-1">where
to obtain <code>standards.texi</code></a>: <a
href="Preface.html#Preface">Preface</a></li>
-<li><a href="OID-Allocations.html#index-X_002e509-71">X.509</a>: <a
href="OID-Allocations.html#OID-Allocations">OID Allocations</a></li>
-<li><a
href="System-Functions.html#index-xmalloc_002c-in-Gnulib-112"><code>xmalloc, in
Gnulib</code></a>: <a href="System-Functions.html#System-Functions">System
Functions</a></li>
- </ul></body></html>
+</body>
+</html>
Index: standards/html_node/Indicating-the-Part-Changed.html
===================================================================
RCS file:
/web/www/www/prep/standards/html_node/Indicating-the-Part-Changed.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Indicating-the-Part-Changed.html 8 Apr 2012
00:23:51 -0000 1.54
+++ standards/html_node/Indicating-the-Part-Changed.html 7 May 2012
00:48:08 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Indicating the Part Changed - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Change-Logs.html#Change-Logs" title="Change Logs">
-<link rel="prev" href="Conditional-Changes.html#Conditional-Changes"
title="Conditional Changes">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,38 +11,75 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Indicating the Part Changed</title>
+
+<meta name="description" content="GNU Coding Standards: Indicating the Part
Changed">
+<meta name="keywords" content="GNU Coding Standards: Indicating the Part
Changed">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Change-Logs.html#Change-Logs" rel="up" title="Change Logs">
+<link href="Man-Pages.html#Man-Pages" rel="next" title="Man Pages">
+<link href="Conditional-Changes.html#Conditional-Changes" rel="previous"
title="Conditional Changes">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Indicating-the-Part-Changed"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Conditional-Changes.html#Conditional-Changes">Conditional Changes</a>,
-Up: <a rel="up" accesskey="u" href="Change-Logs.html#Change-Logs">Change
Logs</a>
-<hr>
+Previous: <a href="Conditional-Changes.html#Conditional-Changes" accesskey="p"
rel="previous">Conditional Changes</a>, Up: <a
href="Change-Logs.html#Change-Logs" accesskey="u" rel="up">Change Logs</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Indicating-the-Part-Changed-1"></a>
<h4 class="subsection">6.8.5 Indicating the Part Changed</h4>
<p>Indicate the part of a function which changed by using angle brackets
enclosing an indication of what the changed part does. Here is an entry
for a change in the part of the function <code>sh-while-getopts</code> that
deals with <code>sh</code> commands:
+</p>
+<div class="example">
+<pre class="example">* progmodes/sh-script.el (sh-while-getopts) <sh>:
Handle case that
+user-specified option string is empty.
+</pre></div>
+
+
+
-<pre class="example"> * progmodes/sh-script.el (sh-while-getopts)
<sh>: Handle case that
- user-specified option string is empty.
-</pre>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Install-Command-Categories.html
===================================================================
RCS file:
/web/www/www/prep/standards/html_node/Install-Command-Categories.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Install-Command-Categories.html 8 Apr 2012 00:23:51
-0000 1.54
+++ standards/html_node/Install-Command-Categories.html 7 May 2012 00:48:08
-0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Install Command Categories - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link rel="prev" href="Standard-Targets.html#Standard-Targets" title="Standard
Targets">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,128 +11,180 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Install Command Categories</title>
+
+<meta name="description" content="GNU Coding Standards: Install Command
Categories">
+<meta name="keywords" content="GNU Coding Standards: Install Command
Categories">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="up"
title="Makefile Conventions">
+<link href="Releases.html#Releases" rel="next" title="Releases">
+<link href="Standard-Targets.html#Standard-Targets" rel="previous"
title="Standard Targets">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Install-Command-Categories"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Standard-Targets.html#Standard-Targets">Standard Targets</a>,
-Up: <a rel="up" accesskey="u"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>
-<hr>
+Previous: <a href="Standard-Targets.html#Standard-Targets" accesskey="p"
rel="previous">Standard Targets</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Install-Command-Categories-1"></a>
<h4 class="subsection">7.2.7 Install Command Categories</h4>
-<p><a name="index-pre_002dinstallation-commands-158"></a><a
name="index-post_002dinstallation-commands-159"></a>When writing the
<code>install</code> target, you must classify all the
-commands into three categories: normal ones, <dfn>pre-installation</dfn>
-commands and <dfn>post-installation</dfn> commands.
-
- <p>Normal commands move files into their proper places, and set their
+<a name="index-pre_002dinstallation-commands"></a>
+<a name="index-post_002dinstallation-commands"></a>
+<p>When writing the <code>install</code> target, you must classify all the
+commands into three categories: normal ones, <em>pre-installation</em>
+commands and <em>post-installation</em> commands.
+</p>
+<p>Normal commands move files into their proper places, and set their
modes. They may not alter any files except the ones that come entirely
from the package they belong to.
-
- <p>Pre-installation and post-installation commands may alter other files;
+</p>
+<p>Pre-installation and post-installation commands may alter other files;
in particular, they can edit global configuration files or data bases.
-
- <p>Pre-installation commands are typically executed before the normal
+</p>
+<p>Pre-installation commands are typically executed before the normal
commands, and post-installation commands are typically run after the
normal commands.
-
- <p>The most common use for a post-installation command is to run
+</p>
+<p>The most common use for a post-installation command is to run
<code>install-info</code>. This cannot be done with a normal command, since
it alters a file (the Info directory) which does not come entirely and
solely from the package being installed. It is a post-installation
command because it needs to be done after the normal command which
-installs the package's Info files.
-
- <p>Most programs don't need any pre-installation commands, but we have the
+installs the package’s Info files.
+</p>
+<p>Most programs don’t need any pre-installation commands, but we have
the
feature just in case it is needed.
-
- <p>To classify the commands in the <code>install</code> rule into these
three
-categories, insert <dfn>category lines</dfn> among them. A category line
+</p>
+<p>To classify the commands in the <code>install</code> rule into these three
+categories, insert <em>category lines</em> among them. A category line
specifies the category for the commands that follow.
-
- <p>A category line consists of a tab and a reference to a special Make
+</p>
+<p>A category line consists of a tab and a reference to a special Make
variable, plus an optional comment at the end. There are three
variables you can use, one for each category; the variable name
specifies the category. Category lines are no-ops in ordinary execution
because these three Make variables are normally undefined (and you
<em>should not</em> define them in the makefile).
-
- <p>Here are the three possible category lines, each with a comment that
+</p>
+<p>Here are the three possible category lines, each with a comment that
explains what it means:
-
+</p>
+<div class="smallexample">
<pre class="smallexample"> $(PRE_INSTALL) # <span
class="roman">Pre-install commands follow.</span>
$(POST_INSTALL) # <span class="roman">Post-install commands
follow.</span>
$(NORMAL_INSTALL) # <span class="roman">Normal commands
follow.</span>
-</pre>
- <p>If you don't use a category line at the beginning of the
<code>install</code>
+</pre></div>
+
+<p>If you don’t use a category line at the beginning of the
<code>install</code>
rule, all the commands are classified as normal until the first category
-line. If you don't use any category lines, all the commands are
+line. If you don’t use any category lines, all the commands are
classified as normal.
-
- <p>These are the category lines for <code>uninstall</code>:
-
+</p>
+<p>These are the category lines for <code>uninstall</code>:
+</p>
+<div class="smallexample">
<pre class="smallexample"> $(PRE_UNINSTALL) # <span
class="roman">Pre-uninstall commands follow.</span>
$(POST_UNINSTALL) # <span class="roman">Post-uninstall
commands follow.</span>
$(NORMAL_UNINSTALL) # <span class="roman">Normal commands
follow.</span>
-</pre>
- <p>Typically, a pre-uninstall command would be used for deleting entries
-from the Info directory.
+</pre></div>
- <p>If the <code>install</code> or <code>uninstall</code> target has any
dependencies
+<p>Typically, a pre-uninstall command would be used for deleting entries
+from the Info directory.
+</p>
+<p>If the <code>install</code> or <code>uninstall</code> target has any
dependencies
which act as subroutines of installation, then you should start
-<em>each</em> dependency's commands with a category line, and start the
-main target's commands with a category line also. This way, you can
+<em>each</em> dependency’s commands with a category line, and start the
+main target’s commands with a category line also. This way, you can
ensure that each command is placed in the right category regardless of
which of the dependencies actually run.
-
- <p>Pre-installation and post-installation commands should not run any
+</p>
+<p>Pre-installation and post-installation commands should not run any
programs except for these:
+</p>
+<div class="example">
+<pre class="example">[ basename bash cat chgrp chmod chown cmp cp dd diff echo
+egrep expand expr false fgrep find getopt grep gunzip gzip
+hostname install install-info kill ldconfig ln ls md5sum
+mkdir mkfifo mknod mv printenv pwd rm rmdir sed sort tee
+test touch true uname xargs yes
+</pre></div>
-<pre class="example"> [ basename bash cat chgrp chmod chown cmp cp dd diff
echo
- egrep expand expr false fgrep find getopt grep gunzip gzip
- hostname install install-info kill ldconfig ln ls md5sum
- mkdir mkfifo mknod mv printenv pwd rm rmdir sed sort tee
- test touch true uname xargs yes
-</pre>
- <p><a name="index-binary-packages-160"></a>The reason for distinguishing
the commands in this way is for the sake
+<a name="index-binary-packages"></a>
+<p>The reason for distinguishing the commands in this way is for the sake
of making binary packages. Typically a binary package contains all the
executables and other files that need to be installed, and has its own
method of installing them—so it does not need to run the normal
installation commands. But installing the binary package does need to
execute the pre-installation and post-installation commands.
-
- <p>Programs to build binary packages work by extracting the
+</p>
+<p>Programs to build binary packages work by extracting the
pre-installation and post-installation commands. Here is one way of
-extracting the pre-installation commands (the <samp><span
class="option">-s</span></samp> option to
-<samp><span class="command">make</span></samp> is needed to silence messages
about entering
+extracting the pre-installation commands (the ‘<samp>-s</samp>’
option to
+<code>make</code> is needed to silence messages about entering
subdirectories):
-
-<pre class="smallexample"> make -s -n install -o all \
+</p>
+<div class="smallexample">
+<pre class="smallexample">make -s -n install -o all \
PRE_INSTALL=pre-install \
POST_INSTALL=post-install \
NORMAL_INSTALL=normal-install \
| gawk -f pre-install.awk
-</pre>
- <p class="noindent">where the file <samp><span
class="file">pre-install.awk</span></samp> could contain this:
+</pre></div>
+
+<p>where the file ‘<tt>pre-install.awk</tt>’ could contain this:
+</p>
+<div class="smallexample">
+<pre class="smallexample">$0 ~ /^(normal-install|post-install)[ \t]*$/ {on = 0}
+on {print $0}
+$0 ~ /^pre-install[ \t]*$/ {on = 1}
+</pre></div>
+
+<hr>
+<div class="header">
+<p>
+Previous: <a href="Standard-Targets.html#Standard-Targets" accesskey="p"
rel="previous">Standard Targets</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
-<pre class="smallexample"> $0 ~ /^(normal-install|post-install)[ \t]*$/
{on = 0}
- on {print $0}
- $0 ~ /^pre-install[ \t]*$/ {on = 1}
-</pre>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Internationalization.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Internationalization.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Internationalization.html 8 Apr 2012 00:23:51
-0000 1.54
+++ standards/html_node/Internationalization.html 7 May 2012 00:48:08
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Internationalization - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="System-Functions.html#System-Functions" title="System
Functions">
-<link rel="next" href="Character-Set.html#Character-Set" title="Character Set">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,124 +11,185 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Internationalization</title>
+
+<meta name="description" content="GNU Coding Standards: Internationalization">
+<meta name="keywords" content="GNU Coding Standards: Internationalization">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Character-Set.html#Character-Set" rel="next" title="Character Set">
+<link href="System-Functions.html#System-Functions" rel="previous"
title="System Functions">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Internationalization"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Character-Set.html#Character-Set">Character Set</a>,
-Previous: <a rel="previous" accesskey="p"
href="System-Functions.html#System-Functions">System Functions</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="Character-Set.html#Character-Set" accesskey="n"
rel="next">Character Set</a>, Previous: <a
href="System-Functions.html#System-Functions" accesskey="p"
rel="previous">System Functions</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Internationalization-1"></a>
<h3 class="section">5.8 Internationalization</h3>
+<a name="index-internationalization"></a>
-<p><a name="index-internationalization-115"></a>
-<a name="index-gettext-116"></a>GNU has a library called GNU gettext that
makes it easy to translate the
+<a name="index-gettext"></a>
+<p>GNU has a library called GNU gettext that makes it easy to translate the
messages in a program into various languages. You should use this
library in every program. Use English for the messages as they appear
in the program, and let gettext provide the way to translate them into
other languages.
-
- <p>Using GNU gettext involves putting a call to the <code>gettext</code>
macro
+</p>
+<p>Using GNU gettext involves putting a call to the <code>gettext</code> macro
around each string that might need translation—like this:
-
-<pre class="example"> printf (gettext ("Processing file '%s'..."), file);
-</pre>
- <p class="noindent">This permits GNU gettext to replace the string
<code>"Processing file
-'%s'..."</code> with a translated version.
-
- <p>Once a program uses gettext, please make a point of writing calls to
+</p>
+<div class="example">
+<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+</pre></div>
+
+<p>This permits GNU gettext to replace the string <code>"Processing file
+'%s'..."</code> with a translated version.
+</p>
+<p>Once a program uses gettext, please make a point of writing calls to
<code>gettext</code> when you add new strings that call for translation.
-
- <p>Using GNU gettext in a package involves specifying a <dfn>text domain
-name</dfn> for the package. The text domain name is used to separate the
+</p>
+<p>Using GNU gettext in a package involves specifying a <em>text domain
+name</em> for the package. The text domain name is used to separate the
translations for this package from the translations for other packages.
Normally, the text domain name should be the same as the name of the
-package—for example, ‘<samp><span
class="samp">coreutils</span></samp>’ for the GNU core utilities.
-
- <p><a name="index-message-text_002c-and-internationalization-117"></a>To
enable gettext to work well, avoid writing code that makes
+package—for example, ‘<samp>coreutils</samp>’ for the GNU
core utilities.
+</p>
+<a name="index-message-text_002c-and-internationalization"></a>
+<p>To enable gettext to work well, avoid writing code that makes
assumptions about the structure of words or sentences. When you want
the precise text of a sentence to vary depending on the data, use two or
more alternative string constants each containing a complete sentences,
rather than inserting conditionalized words or phrases into a single
sentence framework.
+</p>
+<p>Here is an example of what not to do:
+</p>
+<div class="smallexample">
+<pre class="smallexample">printf ("%s is full", capacity >
5000000 ? "disk" : "floppy disk");
+</pre></div>
+
+<p>If you apply gettext to all strings, like this,
+</p>
+<div class="smallexample">
+<pre class="smallexample">printf (gettext ("%s is full"),
+ capacity > 5000000 ? gettext ("disk") : gettext
("floppy disk"));
+</pre></div>
- <p>Here is an example of what not to do:
-
-<pre class="smallexample"> printf ("%s is full", capacity > 5000000 ?
"disk" : "floppy disk");
-</pre>
- <p>If you apply gettext to all strings, like this,
-
-<pre class="smallexample"> printf (gettext ("%s is full"),
- capacity > 5000000 ? gettext ("disk") : gettext ("floppy
disk"));
-</pre>
- <p class="noindent">the translator will hardly know that "disk" and "floppy
disk" are meant to
+<p>the translator will hardly know that "disk" and "floppy
disk" are meant to
be substituted in the other string. Worse, in some languages (like French)
-the construction will not work: the translation of the word "full" depends
+the construction will not work: the translation of the word "full"
depends
on the gender of the first part of the sentence; it happens to be not the
-same for "disk" as for "floppy disk".
-
- <p>Complete sentences can be translated without problems:
+same for "disk" as for "floppy disk".
+</p>
+<p>Complete sentences can be translated without problems:
+</p>
+<div class="example">
+<pre class="example">printf (capacity > 5000000 ? gettext ("disk is
full")
+ : gettext ("floppy disk is full"));
+</pre></div>
-<pre class="example"> printf (capacity > 5000000 ? gettext ("disk is
full")
- : gettext ("floppy disk is full"));
-</pre>
- <p>A similar problem appears at the level of sentence structure with this
+<p>A similar problem appears at the level of sentence structure with this
code:
+</p>
+<div class="example">
+<pre class="example">printf ("# Implicit rule search has%s been
done.\n",
+ f->tried_implicit ? "" : " not");
+</pre></div>
-<pre class="example"> printf ("# Implicit rule search has%s been done.\n",
- f->tried_implicit ? "" : " not");
-</pre>
- <p class="noindent">Adding <code>gettext</code> calls to this code cannot
give correct results for
+<p>Adding <code>gettext</code> calls to this code cannot give correct results
for
all languages, because negation in some languages requires adding words
at more than one place in the sentence. By contrast, adding
<code>gettext</code> calls does the job straightforwardly if the code starts
out like this:
+</p>
+<div class="example">
+<pre class="example">printf (f->tried_implicit
+ ? "# Implicit rule search has been done.\n",
+ : "# Implicit rule search has not been done.\n");
+</pre></div>
+
+<p>Another example is this one:
+</p>
+<div class="example">
+<pre class="example">printf ("%d file%s processed", nfiles,
+ nfiles != 1 ? "s" : "");
+</pre></div>
+
+<p>The problem with this example is that it assumes that plurals are made
+by adding ‘s’. If you apply gettext to the format string, like
this,
+</p>
+<div class="example">
+<pre class="example">printf (gettext ("%d file%s processed"), nfiles,
+ nfiles != 1 ? "s" : "");
+</pre></div>
-<pre class="example"> printf (f->tried_implicit
- ? "# Implicit rule search has been done.\n",
- : "# Implicit rule search has not been done.\n");
-</pre>
- <p>Another example is this one:
-
-<pre class="example"> printf ("%d file%s processed", nfiles,
- nfiles != 1 ? "s" : "");
-</pre>
- <p class="noindent">The problem with this example is that it assumes that
plurals are made
-by adding `s'. If you apply gettext to the format string, like this,
-
-<pre class="example"> printf (gettext ("%d file%s processed"), nfiles,
- nfiles != 1 ? "s" : "");
-</pre>
- <p class="noindent">the message can use different words, but it will still
be forced to use
-`s' for the plural. Here is a better way, with gettext being applied to
+<p>the message can use different words, but it will still be forced to use
+‘s’ for the plural. Here is a better way, with gettext being
applied to
the two strings independently:
-
-<pre class="example"> printf ((nfiles != 1 ? gettext ("%d files processed")
- : gettext ("%d file processed")),
+</p>
+<div class="example">
+<pre class="example">printf ((nfiles != 1 ? gettext ("%d files
processed")
+ : gettext ("%d file processed")),
nfiles);
-</pre>
- <p class="noindent">But this still doesn't work for languages like Polish,
which has three
+</pre></div>
+
+<p>But this still doesn’t work for languages like Polish, which has three
plural forms: one for nfiles == 1, one for nfiles == 2, 3, 4, 22, 23, 24, ...
and one for the rest. The GNU <code>ngettext</code> function solves this
problem:
-
-<pre class="example"> printf (ngettext ("%d files processed", "%d file
processed", nfiles),
+</p>
+<div class="example">
+<pre class="example">printf (ngettext ("%d files processed",
"%d file processed", nfiles),
nfiles);
-</pre>
- </body></html>
+</pre></div>
+
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Character-Set.html#Character-Set" accesskey="n"
rel="next">Character Set</a>, Previous: <a
href="System-Functions.html#System-Functions" accesskey="p"
rel="previous">System Functions</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
+
+</body>
+</html>
Index: standards/html_node/Legal-Issues.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Legal-Issues.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Legal-Issues.html 8 Apr 2012 00:23:51 -0000
1.54
+++ standards/html_node/Legal-Issues.html 7 May 2012 00:48:08 -0000
1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Legal Issues - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="Preface.html#Preface" title="Preface">
-<link rel="next" href="Design-Advice.html#Design-Advice" title="Design Advice">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,41 +11,77 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Legal Issues</title>
+
+<meta name="description" content="GNU Coding Standards: Legal Issues">
+<meta name="keywords" content="GNU Coding Standards: Legal Issues">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code"
rel="next" title="Reading Non-Free Code">
+<link href="Preface.html#Preface" rel="previous" title="Preface">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Legal-Issues"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Design-Advice.html#Design-Advice">Design Advice</a>,
-Previous: <a rel="previous" accesskey="p"
href="Preface.html#Preface">Preface</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="Design-Advice.html#Design-Advice" accesskey="n"
rel="next">Design Advice</a>, Previous: <a href="Preface.html#Preface"
accesskey="p" rel="previous">Preface</a>, Up: <a href="index.html#Top"
accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Keeping-Free-Software-Free"></a>
<h2 class="chapter">2 Keeping Free Software Free</h2>
+<a name="index-legal-aspects"></a>
-<p><a name="index-legal-aspects-7"></a>
-This chapter discusses how you can make sure that GNU software
+<p>This chapter discusses how you can make sure that GNU software
avoids legal difficulties, and other related issues.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code"
accesskey="1">Reading Non-Free Code</a>:</td><td> </td><td
align="left" valign="top">Referring to proprietary programs.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Contributions.html#Contributions"
accesskey="2">Contributions</a>:</td><td> </td><td align="left"
valign="top">Accepting contributions.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Trademarks.html#Trademarks"
accesskey="3">Trademarks</a>:</td><td> </td><td align="left"
valign="top">How we deal with trademark issues.
+</td></tr>
+</table>
+
-<ul class="menu">
-<li><a accesskey="1"
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">Reading
Non-Free Code</a>: Referring to proprietary programs.
-<li><a accesskey="2"
href="Contributions.html#Contributions">Contributions</a>:
Accepting contributions.
-<li><a accesskey="3" href="Trademarks.html#Trademarks">Trademarks</a>:
How we deal with trademark issues.
-</ul>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Libraries.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Libraries.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Libraries.html 8 Apr 2012 00:23:51 -0000 1.54
+++ standards/html_node/Libraries.html 7 May 2012 00:48:08 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Libraries - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="Semantics.html#Semantics" title="Semantics">
-<link rel="next" href="Errors.html#Errors" title="Errors">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,58 +11,91 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Libraries</title>
+
+<meta name="description" content="GNU Coding Standards: Libraries">
+<meta name="keywords" content="GNU Coding Standards: Libraries">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Errors.html#Errors" rel="next" title="Errors">
+<link href="Semantics.html#Semantics" rel="previous" title="Semantics">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Libraries"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="Errors.html#Errors">Errors</a>,
-Previous: <a rel="previous" accesskey="p"
href="Semantics.html#Semantics">Semantics</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="Errors.html#Errors" accesskey="n" rel="next">Errors</a>,
Previous: <a href="Semantics.html#Semantics" accesskey="p"
rel="previous">Semantics</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Library-Behavior"></a>
<h3 class="section">4.3 Library Behavior</h3>
+<a name="index-libraries"></a>
-<p><a name="index-libraries-35"></a>
-Try to make library functions reentrant. If they need to do dynamic
+<p>Try to make library functions reentrant. If they need to do dynamic
storage allocation, at least try to avoid any nonreentrancy aside from
that of <code>malloc</code> itself.
-
- <p>Here are certain name conventions for libraries, to avoid name
+</p>
+<p>Here are certain name conventions for libraries, to avoid name
conflicts.
-
- <p>Choose a name prefix for the library, more than two characters long.
+</p>
+<p>Choose a name prefix for the library, more than two characters long.
All external function and variable names should start with this
prefix. In addition, there should only be one of these in any given
library member. This usually means putting each one in a separate
source file.
-
- <p>An exception can be made when two external symbols are always used
+</p>
+<p>An exception can be made when two external symbols are always used
together, so that no reasonable program could use one without the
other; then they can both go in the same file.
-
- <p>External symbols that are not documented entry points for the user
-should have names beginning with ‘<samp><span
class="samp">_</span></samp>’. The ‘<samp><span
class="samp">_</span></samp>’ should be
+</p>
+<p>External symbols that are not documented entry points for the user
+should have names beginning with ‘<samp>_</samp>’. The
‘<samp>_</samp>’ should be
followed by the chosen name prefix for the library, to prevent
collisions with other libraries. These can go in the same files with
user entry points if you like.
-
- <p>Static functions and variables can be used as you like and need not
+</p>
+<p>Static functions and variables can be used as you like and need not
fit any naming convention.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/License-for-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/License-for-Manuals.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/License-for-Manuals.html 8 Apr 2012 00:23:51
-0000 1.54
+++ standards/html_node/License-for-Manuals.html 7 May 2012 00:48:08
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>License for Manuals - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="Manual-Structure-Details.html#Manual-Structure-Details"
title="Manual Structure Details">
-<link rel="next" href="Manual-Credits.html#Manual-Credits" title="Manual
Credits">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,47 +11,80 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: License for Manuals</title>
+
+<meta name="description" content="GNU Coding Standards: License for Manuals">
+<meta name="keywords" content="GNU Coding Standards: License for Manuals">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Manual-Credits.html#Manual-Credits" rel="next" title="Manual
Credits">
+<link href="Manual-Structure-Details.html#Manual-Structure-Details"
rel="previous" title="Manual Structure Details">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="License-for-Manuals"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Manual-Credits.html#Manual-Credits">Manual Credits</a>,
-Previous: <a rel="previous" accesskey="p"
href="Manual-Structure-Details.html#Manual-Structure-Details">Manual Structure
Details</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="Manual-Credits.html#Manual-Credits" accesskey="n"
rel="next">Manual Credits</a>, Previous: <a
href="Manual-Structure-Details.html#Manual-Structure-Details" accesskey="p"
rel="previous">Manual Structure Details</a>, Up: <a
href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="License-for-Manuals-1"></a>
<h3 class="section">6.4 License for Manuals</h3>
+<a name="index-license-for-manuals"></a>
-<p><a name="index-license-for-manuals-133"></a>
-Please use the GNU Free Documentation License for all GNU manuals that
+<p>Please use the GNU Free Documentation License for all GNU manuals that
are more than a few pages long. Likewise for a collection of short
documents—you only need one copy of the GNU FDL for the whole
collection. For a single short document, you can use a very permissive
non-copyleft license, to avoid taking up space with a long license.
-
- <p>See <a
href="http://www.gnu.org/copyleft/fdl-howto.html";>http://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
+</p>
+<p>See <a
href="http://www.gnu.org/copyleft/fdl-howto.html";>http://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
of how to employ the GFDL.
-
- <p>Note that it is not obligatory to include a copy of the GNU GPL or GNU
+</p>
+<p>Note that it is not obligatory to include a copy of the GNU GPL or GNU
LGPL in a manual whose license is neither the GPL nor the LGPL. It can
-be a good idea to include the program's license in a large manual; in a
+be a good idea to include the program’s license in a large manual; in a
short manual, whose size would be increased considerably by including
-the program's license, it is probably better not to include it.
+the program’s license, it is probably better not to include it.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Makefile-Basics.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Makefile-Basics.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Makefile-Basics.html 8 Apr 2012 00:23:51 -0000
1.54
+++ standards/html_node/Makefile-Basics.html 7 May 2012 00:48:08 -0000
1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Makefile Basics - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link rel="next" href="Utilities-in-Makefiles.html#Utilities-in-Makefiles"
title="Utilities in Makefiles">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,104 +11,155 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Makefile Basics</title>
+
+<meta name="description" content="GNU Coding Standards: Makefile Basics">
+<meta name="keywords" content="GNU Coding Standards: Makefile Basics">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="up"
title="Makefile Conventions">
+<link href="Utilities-in-Makefiles.html#Utilities-in-Makefiles" rel="next"
title="Utilities in Makefiles">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="previous"
title="Makefile Conventions">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Makefile-Basics"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Utilities-in-Makefiles.html#Utilities-in-Makefiles">Utilities in
Makefiles</a>,
-Up: <a rel="up" accesskey="u"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>
-<hr>
+Next: <a href="Utilities-in-Makefiles.html#Utilities-in-Makefiles"
accesskey="n" rel="next">Utilities in Makefiles</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="General-Conventions-for-Makefiles"></a>
<h4 class="subsection">7.2.1 General Conventions for Makefiles</h4>
<p>Every Makefile should contain this line:
+</p>
+<div class="example">
+<pre class="example">SHELL = /bin/sh
+</pre></div>
-<pre class="example"> SHELL = /bin/sh
-</pre>
- <p class="noindent">to avoid trouble on systems where the
<code>SHELL</code> variable might be
+<p>to avoid trouble on systems where the <code>SHELL</code> variable might be
inherited from the environment. (This is never a problem with GNU
<code>make</code>.)
-
- <p>Different <code>make</code> programs have incompatible suffix lists and
+</p>
+<p>Different <code>make</code> programs have incompatible suffix lists and
implicit rules, and this sometimes creates confusion or misbehavior. So
it is a good idea to set the suffix list explicitly using only the
suffixes you need in the particular Makefile, like this:
+</p>
+<div class="example">
+<pre class="example">.SUFFIXES:
+.SUFFIXES: .c .o
+</pre></div>
-<pre class="example"> .SUFFIXES:
- .SUFFIXES: .c .o
-</pre>
- <p class="noindent">The first line clears out the suffix list, the second
introduces all
+<p>The first line clears out the suffix list, the second introduces all
suffixes which may be subject to implicit rules in this Makefile.
-
- <p>Don't assume that <samp><span class="file">.</span></samp> is in the
path for command execution. When
+</p>
+<p>Don’t assume that ‘<tt>.</tt>’ is in the path for command
execution. When
you need to run programs that are a part of your package during the
-make, please make sure that it uses <samp><span class="file">./</span></samp>
if the program is built as
-part of the make or <samp><span class="file">$(srcdir)/</span></samp> if the
file is an unchanging part
+make, please make sure that it uses ‘<tt>./</tt>’ if the program
is built as
+part of the make or ‘<tt>$(srcdir)/</tt>’ if the file is an
unchanging part
of the source code. Without one of these prefixes, the current search
path is used.
-
- <p>The distinction between <samp><span class="file">./</span></samp> (the
<dfn>build directory</dfn>) and
-<samp><span class="file">$(srcdir)/</span></samp> (the <dfn>source
directory</dfn>) is important because
-users can build in a separate directory using the ‘<samp><span
class="samp">--srcdir</span></samp>’ option
-to <samp><span class="file">configure</span></samp>. A rule of the form:
-
-<pre class="smallexample"> foo.1 : foo.man sedscript
+</p>
+<p>The distinction between ‘<tt>./</tt>’ (the <em>build
directory</em>) and
+‘<tt>$(srcdir)/</tt>’ (the <em>source directory</em>) is important
because
+users can build in a separate directory using the
‘<samp>--srcdir</samp>’ option
+to ‘<tt>configure</tt>’. A rule of the form:
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.1 : foo.man sedscript
sed -f sedscript foo.man > foo.1
-</pre>
- <p class="noindent">will fail when the build directory is not the source
directory, because
-<samp><span class="file">foo.man</span></samp> and <samp><span
class="file">sedscript</span></samp> are in the source directory.
+</pre></div>
- <p>When using GNU <code>make</code>, relying on ‘<samp><span
class="samp">VPATH</span></samp>’ to find the source
+<p>will fail when the build directory is not the source directory, because
+‘<tt>foo.man</tt>’ and ‘<tt>sedscript</tt>’ are in the
source directory.
+</p>
+<p>When using GNU <code>make</code>, relying on
‘<samp>VPATH</samp>’ to find the source
file will work in the case where there is a single dependency file,
-since the <code>make</code> automatic variable ‘<samp><span
class="samp">$<</span></samp>’ will represent the
-source file wherever it is. (Many versions of <code>make</code> set
‘<samp><span class="samp">$<</span></samp>’
+since the <code>make</code> automatic variable
‘<samp>$<</samp>’ will represent the
+source file wherever it is. (Many versions of <code>make</code> set
‘<samp>$<</samp>’
only in implicit rules.) A Makefile target like
-
-<pre class="smallexample"> foo.o : bar.c
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c bar.c -o foo.o
-</pre>
- <p class="noindent">should instead be written as
+</pre></div>
-<pre class="smallexample"> foo.o : bar.c
+<p>should instead be written as
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c $< -o $@
-</pre>
- <p class="noindent">in order to allow ‘<samp><span
class="samp">VPATH</span></samp>’ to work correctly. When the target has
-multiple dependencies, using an explicit ‘<samp><span
class="samp">$(srcdir)</span></samp>’ is the easiest
-way to make the rule work well. For example, the target above for
-<samp><span class="file">foo.1</span></samp> is best written as:
+</pre></div>
-<pre class="smallexample"> foo.1 : foo.man sedscript
+<p>in order to allow ‘<samp>VPATH</samp>’ to work correctly. When
the target has
+multiple dependencies, using an explicit ‘<samp>$(srcdir)</samp>’
is the easiest
+way to make the rule work well. For example, the target above for
+‘<tt>foo.1</tt>’ is best written as:
+</p>
+<div class="smallexample">
+<pre class="smallexample">foo.1 : foo.man sedscript
sed -f $(srcdir)/sedscript $(srcdir)/foo.man > $@
-</pre>
- <p>GNU distributions usually contain some files which are not source
+</pre></div>
+
+<p>GNU distributions usually contain some files which are not source
files—for example, Info files, and the output from Autoconf, Automake,
Bison or Flex. Since these files normally appear in the source
directory, they should always appear in the source directory, not in the
build directory. So Makefile rules to update them should put the
updated files in the source directory.
-
- <p>However, if a file does not appear in the distribution, then the
+</p>
+<p>However, if a file does not appear in the distribution, then the
Makefile should not put it in the source directory, because building a
program in ordinary circumstances should not modify the source directory
in any way.
-
- <p>Try to make the build and installation targets, at least (and all their
+</p>
+<p>Try to make the build and installation targets, at least (and all their
subtargets) work correctly with a parallel <code>make</code>.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Utilities-in-Makefiles.html#Utilities-in-Makefiles"
accesskey="n" rel="next">Utilities in Makefiles</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Makefile-Conventions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Makefile-Conventions.html,v
retrieving revision 1.57
retrieving revision 1.58
diff -u -b -r1.57 -r1.58
--- standards/html_node/Makefile-Conventions.html 8 Apr 2012 00:23:52
-0000 1.57
+++ standards/html_node/Makefile-Conventions.html 7 May 2012 00:48:08
-0000 1.58
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Makefile Conventions - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Managing-Releases.html#Managing-Releases" title="Managing
Releases">
-<link rel="prev" href="Configuration.html#Configuration" title="Configuration">
-<link rel="next" href="Releases.html#Releases" title="Releases">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,59 +11,93 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Makefile Conventions</title>
+
+<meta name="description" content="GNU Coding Standards: Makefile Conventions">
+<meta name="keywords" content="GNU Coding Standards: Makefile Conventions">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Managing-Releases.html#Managing-Releases" rel="up" title="Managing
Releases">
+<link href="Makefile-Basics.html#Makefile-Basics" rel="next" title="Makefile
Basics">
+<link href="Configuration.html#Configuration" rel="previous"
title="Configuration">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Makefile-Conventions"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Releases.html#Releases">Releases</a>,
-Previous: <a rel="previous" accesskey="p"
href="Configuration.html#Configuration">Configuration</a>,
-Up: <a rel="up" accesskey="u"
href="Managing-Releases.html#Managing-Releases">Managing Releases</a>
-<hr>
+Next: <a href="Releases.html#Releases" accesskey="n" rel="next">Releases</a>,
Previous: <a href="Configuration.html#Configuration" accesskey="p"
rel="previous">Configuration</a>, Up: <a
href="Managing-Releases.html#Managing-Releases" accesskey="u" rel="up">Managing
Releases</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Makefile-Conventions-1"></a>
<h3 class="section">7.2 Makefile Conventions</h3>
+<a name="index-makefile_002c-conventions-for"></a>
+<a name="index-conventions-for-makefiles"></a>
+<a name="index-standards-for-makefiles"></a>
-<p><a name="index-makefile_002c-conventions-for-145"></a><a
name="index-conventions-for-makefiles-146"></a><a
name="index-standards-for-makefiles-147"></a>
-<!-- Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2001, -->
-<!-- 2004, 2005, 2006, 2007, 2008, 2010 Free Software Foundation, Inc. -->
-<!-- Permission is granted to copy, distribute and/or modify this document -->
-<!-- under the terms of the GNU Free Documentation License, Version 1.3 -->
-<!-- or any later version published by the Free Software Foundation; -->
-<!-- with no Invariant Sections, with no -->
-<!-- Front-Cover Texts, and with no Back-Cover Texts. -->
-<!-- A copy of the license is included in the section entitled ``GNU -->
-<!-- Free Documentation License''. -->
- <p>This
+<p>This
describes conventions for writing the Makefiles for GNU programs.
Using Automake will help you write a Makefile that follows these
conventions. For more information on portable Makefiles, see
-<span class="sc">posix</span> and <a
href="../autoconf/Portable-Make.html#Portable-Make">Portable Make
Programming</a>.
+<small>POSIX</small> and <a
href="http://www.gnu.org/software/autoconf/manual/html_node/Portable-Make.html#Portable-Make";>Portable
Make Programming</a> in <cite>Autoconf</cite>.
+</p>
-<ul class="menu">
-<li><a accesskey="1" href="Makefile-Basics.html#Makefile-Basics">Makefile
Basics</a>: General conventions for Makefiles.
-<li><a accesskey="2"
href="Utilities-in-Makefiles.html#Utilities-in-Makefiles">Utilities in
Makefiles</a>: Utilities to be used in Makefiles.
-<li><a accesskey="3" href="Command-Variables.html#Command-Variables">Command
Variables</a>: Variables for specifying commands.
-<li><a accesskey="4" href="DESTDIR.html#DESTDIR">DESTDIR</a>:
Supporting staged installs.
-<li><a accesskey="5"
href="Directory-Variables.html#Directory-Variables">Directory Variables</a>:
Variables for installation directories.
-<li><a accesskey="6" href="Standard-Targets.html#Standard-Targets">Standard
Targets</a>: Standard targets for users.
-<li><a accesskey="7"
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a>: Three categories of commands in the `install'
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="Makefile-Basics.html#Makefile-Basics" accesskey="1">Makefile
Basics</a>:</td><td> </td><td align="left" valign="top">General
conventions for Makefiles.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Utilities-in-Makefiles.html#Utilities-in-Makefiles"
accesskey="2">Utilities in Makefiles</a>:</td><td> </td><td
align="left" valign="top">Utilities to be used in Makefiles.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Command-Variables.html#Command-Variables" accesskey="3">Command
Variables</a>:</td><td> </td><td align="left" valign="top">Variables
for specifying commands.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="DESTDIR.html#DESTDIR"
accesskey="4">DESTDIR</a>:</td><td> </td><td align="left"
valign="top">Supporting staged installs.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Directory-Variables.html#Directory-Variables" accesskey="5">Directory
Variables</a>:</td><td> </td><td align="left" valign="top">Variables
for installation directories.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Standard-Targets.html#Standard-Targets" accesskey="6">Standard
Targets</a>:</td><td> </td><td align="left" valign="top">Standard
targets for users.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Install-Command-Categories.html#Install-Command-Categories"
accesskey="7">Install Command Categories</a>:</td><td> </td><td
align="left" valign="top">Three categories of commands in the
‘install’
rule: normal, pre-install and post-install.
-</ul>
+</td></tr>
+</table>
+
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Man-Pages.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Man-Pages.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Man-Pages.html 8 Apr 2012 00:23:52 -0000 1.54
+++ standards/html_node/Man-Pages.html 7 May 2012 00:48:08 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Man Pages - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="Change-Logs.html#Change-Logs" title="Change Logs">
-<link rel="next" href="Reading-other-Manuals.html#Reading-other-Manuals"
title="Reading other Manuals">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,72 +11,112 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Man Pages</title>
+
+<meta name="description" content="GNU Coding Standards: Man Pages">
+<meta name="keywords" content="GNU Coding Standards: Man Pages">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Reading-other-Manuals.html#Reading-other-Manuals" rel="next"
title="Reading other Manuals">
+<link href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed"
rel="previous" title="Indicating the Part Changed">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Man-Pages"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Reading-other-Manuals.html#Reading-other-Manuals">Reading other
Manuals</a>,
-Previous: <a rel="previous" accesskey="p"
href="Change-Logs.html#Change-Logs">Change Logs</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="Reading-other-Manuals.html#Reading-other-Manuals" accesskey="n"
rel="next">Reading other Manuals</a>, Previous: <a
href="Change-Logs.html#Change-Logs" accesskey="p" rel="previous">Change
Logs</a>, Up: <a href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Man-Pages-1"></a>
<h3 class="section">6.9 Man Pages</h3>
+<a name="index-man-pages"></a>
-<p><a name="index-man-pages-140"></a>
-In the GNU project, man pages are secondary. It is not necessary or
+<p>In the GNU project, man pages are secondary. It is not necessary or
expected for every GNU program to have a man page, but some of them do.
-It's your choice whether to include a man page in your program.
-
- <p>When you make this decision, consider that supporting a man page
+It’s your choice whether to include a man page in your program.
+</p>
+<p>When you make this decision, consider that supporting a man page
requires continual effort each time the program is changed. The time
you spend on the man page is time taken away from more useful work.
-
- <p>For a simple program which changes little, updating the man page may be
+</p>
+<p>For a simple program which changes little, updating the man page may be
a small job. Then there is little reason not to include a man page, if
you have one.
-
- <p>For a large program that changes a great deal, updating a man page may
+</p>
+<p>For a large program that changes a great deal, updating a man page may
be a substantial burden. If a user offers to donate a man page, you may
find this gift costly to accept. It may be better to refuse the man
page unless the same person agrees to take full responsibility for
maintaining it—so that you can wash your hands of it entirely. If
-this volunteer later ceases to do the job, then don't feel obliged to
+this volunteer later ceases to do the job, then don’t feel obliged to
pick it up yourself; it may be better to withdraw the man page from the
distribution until someone else agrees to update it.
-
- <p>When a program changes only a little, you may feel that the
+</p>
+<p>When a program changes only a little, you may feel that the
discrepancies are small enough that the man page remains useful without
updating. If so, put a prominent note near the beginning of the man
-page explaining that you don't maintain it and that the Texinfo manual
+page explaining that you don’t maintain it and that the Texinfo manual
is more authoritative. The note should say how to access the Texinfo
documentation.
-
- <p>Be sure that man pages include a copyright statement and free license.
+</p>
+<p>Be sure that man pages include a copyright statement and free license.
The simple all-permissive license is appropriate for simple man pages
-(see <a
href="../maintain/License-Notices-for-Other-Files.html#License-Notices-for-Other-Files">License
Notices for Other Files</a>).
-
- <p>For long man pages, with enough explanation and documentation that
-they can be considered true manuals, use the GFDL (see <a
href="License-for-Manuals.html#License-for-Manuals">License for Manuals</a>).
-
- <p>Finally, the GNU help2man program
+(see <a
href="http://www.gnu.org/prep/maintain/html_node/License-Notices-for-Other-Files.html#License-Notices-for-Other-Files";>License
Notices for Other Files</a> in <cite>Information for GNU
+Maintainers</cite>).
+</p>
+<p>For long man pages, with enough explanation and documentation that
+they can be considered true manuals, use the GFDL (see <a
href="License-for-Manuals.html#License-for-Manuals">License for
+Manuals</a>).
+</p>
+<p>Finally, the GNU help2man program
(<a
href="http://www.gnu.org/software/help2man/";>http://www.gnu.org/software/help2man/</a>)
is one way to automate
-generation of a man page, in this case from <samp><span
class="option">--help</span></samp> output.
+generation of a man page, in this case from ‘<samp>--help</samp>’
output.
This is sufficient in many cases.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Reading-other-Manuals.html#Reading-other-Manuals" accesskey="n"
rel="next">Reading other Manuals</a>, Previous: <a
href="Change-Logs.html#Change-Logs" accesskey="p" rel="previous">Change
Logs</a>, Up: <a href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Managing-Releases.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Managing-Releases.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Managing-Releases.html 8 Apr 2012 00:23:52 -0000
1.54
+++ standards/html_node/Managing-Releases.html 7 May 2012 00:48:08 -0000
1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Managing Releases - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="Documentation.html#Documentation" title="Documentation">
-<link rel="next" href="References.html#References" title="References">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,46 +11,82 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Managing Releases</title>
+
+<meta name="description" content="GNU Coding Standards: Managing Releases">
+<meta name="keywords" content="GNU Coding Standards: Managing Releases">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Configuration.html#Configuration" rel="next" title="Configuration">
+<link href="Reading-other-Manuals.html#Reading-other-Manuals" rel="previous"
title="Reading other Manuals">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Managing-Releases"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="References.html#References">References</a>,
-Previous: <a rel="previous" accesskey="p"
href="Documentation.html#Documentation">Documentation</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="References.html#References" accesskey="n"
rel="next">References</a>, Previous: <a href="Documentation.html#Documentation"
accesskey="p" rel="previous">Documentation</a>, Up: <a href="index.html#Top"
accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="The-Release-Process"></a>
<h2 class="chapter">7 The Release Process</h2>
+<a name="index-releasing"></a>
-<p><a name="index-releasing-141"></a>
-Making a release is more than just bundling up your source files in a
+<p>Making a release is more than just bundling up your source files in a
tar file and putting it up for FTP. You should set up your software so
that it can be configured to run on a variety of systems. Your Makefile
should conform to the GNU standards described below, and your directory
layout should also conform to the standards discussed below. Doing so
makes it easy to include your package into the larger framework of
all GNU software.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="Configuration.html#Configuration"
accesskey="1">Configuration</a>:</td><td> </td><td align="left"
valign="top">How configuration of GNU packages should work.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="2">Makefile
Conventions</a>:</td><td> </td><td align="left"
valign="top">Makefile conventions.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Releases.html#Releases"
accesskey="3">Releases</a>:</td><td> </td><td align="left"
valign="top">Making releases
+</td></tr>
+</table>
+
-<ul class="menu">
-<li><a accesskey="1"
href="Configuration.html#Configuration">Configuration</a>: How
configuration of GNU packages should work.
-<li><a accesskey="2"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>:
Makefile conventions.
-<li><a accesskey="3" href="Releases.html#Releases">Releases</a>:
Making releases
-</ul>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Manual-Credits.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Manual-Credits.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Manual-Credits.html 8 Apr 2012 00:23:52 -0000
1.54
+++ standards/html_node/Manual-Credits.html 7 May 2012 00:48:08 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Manual Credits - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="License-for-Manuals.html#License-for-Manuals"
title="License for Manuals">
-<link rel="next" href="Printed-Manuals.html#Printed-Manuals" title="Printed
Manuals">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,37 +11,70 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Manual Credits</title>
+
+<meta name="description" content="GNU Coding Standards: Manual Credits">
+<meta name="keywords" content="GNU Coding Standards: Manual Credits">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Printed-Manuals.html#Printed-Manuals" rel="next" title="Printed
Manuals">
+<link href="License-for-Manuals.html#License-for-Manuals" rel="previous"
title="License for Manuals">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Manual-Credits"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Printed-Manuals.html#Printed-Manuals">Printed Manuals</a>,
-Previous: <a rel="previous" accesskey="p"
href="License-for-Manuals.html#License-for-Manuals">License for Manuals</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="Printed-Manuals.html#Printed-Manuals" accesskey="n"
rel="next">Printed Manuals</a>, Previous: <a
href="License-for-Manuals.html#License-for-Manuals" accesskey="p"
rel="previous">License for Manuals</a>, Up: <a
href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Manual-Credits-1"></a>
<h3 class="section">6.5 Manual Credits</h3>
+<a name="index-credits-for-manuals"></a>
-<p><a name="index-credits-for-manuals-134"></a>
-Please credit the principal human writers of the manual as the authors,
+<p>Please credit the principal human writers of the manual as the authors,
on the title page of the manual. If a company sponsored the work, thank
the company in a suitable place in the manual, but do not cite the
company as an author.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Manual-Structure-Details.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Manual-Structure-Details.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Manual-Structure-Details.html 8 Apr 2012 00:23:53
-0000 1.54
+++ standards/html_node/Manual-Structure-Details.html 7 May 2012 00:48:08
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Manual Structure Details - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals"
title="Doc Strings and Manuals">
-<link rel="next" href="License-for-Manuals.html#License-for-Manuals"
title="License for Manuals">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,57 +11,90 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Manual Structure Details</title>
+
+<meta name="description" content="GNU Coding Standards: Manual Structure
Details">
+<meta name="keywords" content="GNU Coding Standards: Manual Structure Details">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="License-for-Manuals.html#License-for-Manuals" rel="next"
title="License for Manuals">
+<link href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals"
rel="previous" title="Doc Strings and Manuals">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Manual-Structure-Details"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="License-for-Manuals.html#License-for-Manuals">License for Manuals</a>,
-Previous: <a rel="previous" accesskey="p"
href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals">Doc Strings and
Manuals</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="License-for-Manuals.html#License-for-Manuals" accesskey="n"
rel="next">License for Manuals</a>, Previous: <a
href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals" accesskey="p"
rel="previous">Doc Strings and Manuals</a>, Up: <a
href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Manual-Structure-Details-1"></a>
<h3 class="section">6.3 Manual Structure Details</h3>
+<a name="index-manual-structure"></a>
-<p><a name="index-manual-structure-132"></a>
-The title page of the manual should state the version of the programs or
+<p>The title page of the manual should state the version of the programs or
packages documented in the manual. The Top node of the manual should
also contain this information. If the manual is changing more
frequently than or independent of the program, also state a version
number for the manual in both of these places.
-
- <p>Each program documented in the manual should have a node named
-‘<samp><var>program</var><span class="samp">
Invocation</span></samp>’ or ‘<samp><span class="samp">Invoking
</span><var>program</var></samp>’. This
-node (together with its subnodes, if any) should describe the program's
+</p>
+<p>Each program documented in the manual should have a node named
+‘<samp><var>program</var> Invocation</samp>’ or
‘<samp>Invoking <var>program</var></samp>’. This
+node (together with its subnodes, if any) should describe the program’s
command line arguments and how to run it (the sort of information people
-would look for in a man page). Start with an ‘<samp><span
class="samp">@example</span></samp>’
+would look for in a man page). Start with an
‘<samp>@example</samp>’
containing a template for all the options and arguments that the program
uses.
-
- <p>Alternatively, put a menu item in some menu whose item name fits one of
+</p>
+<p>Alternatively, put a menu item in some menu whose item name fits one of
the above patterns. This identifies the node which that item points to
-as the node for this purpose, regardless of the node's actual name.
-
- <p>The ‘<samp><span class="samp">--usage</span></samp>’ feature
of the Info reader looks for such a node
+as the node for this purpose, regardless of the node’s actual name.
+</p>
+<p>The ‘<samp>--usage</samp>’ feature of the Info reader looks for
such a node
or menu item in order to find the relevant text, so it is essential
for every Texinfo file to have one.
-
- <p>If one manual describes several programs, it should have such a node for
+</p>
+<p>If one manual describes several programs, it should have such a node for
each program described in the manual.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Memory-Usage.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Memory-Usage.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Memory-Usage.html 8 Apr 2012 00:23:53 -0000
1.54
+++ standards/html_node/Memory-Usage.html 7 May 2012 00:48:08 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Memory Usage - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="OID-Allocations.html#OID-Allocations" title="OID
Allocations">
-<link rel="next" href="File-Usage.html#File-Usage" title="File Usage">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,53 +11,89 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Memory Usage</title>
+
+<meta name="description" content="GNU Coding Standards: Memory Usage">
+<meta name="keywords" content="GNU Coding Standards: Memory Usage">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="File-Usage.html#File-Usage" rel="next" title="File Usage">
+<link href="OID-Allocations.html#OID-Allocations" rel="previous" title="OID
Allocations">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Memory-Usage"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="File-Usage.html#File-Usage">File
Usage</a>,
-Previous: <a rel="previous" accesskey="p"
href="OID-Allocations.html#OID-Allocations">OID Allocations</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="File-Usage.html#File-Usage" accesskey="n" rel="next">File
Usage</a>, Previous: <a href="OID-Allocations.html#OID-Allocations"
accesskey="p" rel="previous">OID Allocations</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Memory-Usage-1"></a>
<h3 class="section">4.11 Memory Usage</h3>
+<a name="index-memory-usage"></a>
-<p><a name="index-memory-usage-72"></a>
-If a program typically uses just a few meg of memory, don't bother making any
+<p>If a program typically uses just a few meg of memory, don’t bother
making any
effort to reduce memory usage. For example, if it is impractical for
other reasons to operate on files more than a few meg long, it is
reasonable to read entire input files into memory to operate on them.
-
- <p>However, for programs such as <code>cat</code> or <code>tail</code>,
that can
+</p>
+<p>However, for programs such as <code>cat</code> or <code>tail</code>, that
can
usefully operate on very large files, it is important to avoid using a
technique that would artificially limit the size of files it can handle.
If a program works by lines and could be applied to arbitrary
user-supplied input files, it should keep only a line in memory, because
this is not very hard and users will want to be able to operate on input
files that are bigger than will fit in memory all at once.
-
- <p>If your program creates complicated data structures, just make them in
+</p>
+<p>If your program creates complicated data structures, just make them in
memory and give a fatal error if <code>malloc</code> returns zero.
-
- <p><a name="index-valgrind-73"></a><a
name="index-memory-leak-74"></a>Memory analysis tools such as <samp><span
class="command">valgrind</span></samp> can be useful, but
-don't complicate a program merely to avoid their false alarms. For
-example, if memory is used until just before a process exits, don't
+</p>
+<a name="index-valgrind"></a>
+<a name="index-memory-leak"></a>
+<p>Memory analysis tools such as <code>valgrind</code> can be useful, but
+don’t complicate a program merely to avoid their false alarms. For
+example, if memory is used until just before a process exits, don’t
free it simply to silence such a tool.
+</p>
+
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Mmap.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Mmap.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Mmap.html 8 Apr 2012 00:23:53 -0000 1.54
+++ standards/html_node/Mmap.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Mmap - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="Quote-Characters.html#Quote-Characters" title="Quote
Characters">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,44 +11,79 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Mmap</title>
+
+<meta name="description" content="GNU Coding Standards: Mmap">
+<meta name="keywords" content="GNU Coding Standards: Mmap">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Documentation.html#Documentation" rel="next" title="Documentation">
+<link href="Quote-Characters.html#Quote-Characters" rel="previous"
title="Quote Characters">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Mmap"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Quote-Characters.html#Quote-Characters">Quote Characters</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Previous: <a href="Quote-Characters.html#Quote-Characters" accesskey="p"
rel="previous">Quote Characters</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Mmap-1"></a>
<h3 class="section">5.11 Mmap</h3>
+<a name="index-mmap"></a>
-<p><a name="index-mmap-130"></a>
-Don't assume that <code>mmap</code> either works on all files or fails
+<p>Don’t assume that <code>mmap</code> either works on all files or fails
for all files. It may work on some files and fail on others.
-
- <p>The proper way to use <code>mmap</code> is to try it on the specific
file for
-which you want to use it—and if <code>mmap</code> doesn't work, fall
back on
+</p>
+<p>The proper way to use <code>mmap</code> is to try it on the specific file
for
+which you want to use it—and if <code>mmap</code> doesn’t work,
fall back on
doing the job in another way using <code>read</code> and <code>write</code>.
-
- <p>The reason this precaution is needed is that the GNU kernel (the HURD)
+</p>
+<p>The reason this precaution is needed is that the GNU kernel (the HURD)
provides a user-extensible file system, in which there can be many
different kinds of “ordinary files”. Many of them support
<code>mmap</code>, but some do not. It is important to make programs handle
all these kinds of files.
+</p>
+
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/NEWS-File.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/NEWS-File.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/NEWS-File.html 8 Apr 2012 00:23:53 -0000 1.54
+++ standards/html_node/NEWS-File.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>NEWS File - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="Printed-Manuals.html#Printed-Manuals" title="Printed
Manuals">
-<link rel="next" href="Change-Logs.html#Change-Logs" title="Change Logs">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,43 +11,76 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: NEWS File</title>
+
+<meta name="description" content="GNU Coding Standards: NEWS File">
+<meta name="keywords" content="GNU Coding Standards: NEWS File">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Change-Logs.html#Change-Logs" rel="next" title="Change Logs">
+<link href="Printed-Manuals.html#Printed-Manuals" rel="previous"
title="Printed Manuals">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="NEWS-File"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Change-Logs.html#Change-Logs">Change Logs</a>,
-Previous: <a rel="previous" accesskey="p"
href="Printed-Manuals.html#Printed-Manuals">Printed Manuals</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="Change-Logs.html#Change-Logs" accesskey="n" rel="next">Change
Logs</a>, Previous: <a href="Printed-Manuals.html#Printed-Manuals"
accesskey="p" rel="previous">Printed Manuals</a>, Up: <a
href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="The-NEWS-File"></a>
<h3 class="section">6.7 The NEWS File</h3>
+<a name="index-NEWS-file"></a>
-<p><a name="index-g_t_0040file_007bNEWS_007d-file-135"></a>
-In addition to its manual, the package should have a file named
-<samp><span class="file">NEWS</span></samp> which contains a list of
user-visible changes worth
+<p>In addition to its manual, the package should have a file named
+‘<tt>NEWS</tt>’ which contains a list of user-visible changes worth
mentioning. In each new release, add items to the front of the file and
-identify the version they pertain to. Don't discard old items; leave
+identify the version they pertain to. Don’t discard old items; leave
them in the file after the newer items. This way, a user upgrading from
any previous version can see what is new.
-
- <p>If the <samp><span class="file">NEWS</span></samp> file gets very long,
move some of the older items
-into a file named <samp><span class="file">ONEWS</span></samp> and put a note
at the end referring the
+</p>
+<p>If the ‘<tt>NEWS</tt>’ file gets very long, move some of the
older items
+into a file named ‘<tt>ONEWS</tt>’ and put a note at the end
referring the
user to that file.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Names.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Names.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Names.html 8 Apr 2012 00:23:53 -0000 1.54
+++ standards/html_node/Names.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Names - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="Syntactic-Conventions.html#Syntactic-Conventions"
title="Syntactic Conventions">
-<link rel="next" href="System-Portability.html#System-Portability"
title="System Portability">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,75 +11,119 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Names</title>
+
+<meta name="description" content="GNU Coding Standards: Names">
+<meta name="keywords" content="GNU Coding Standards: Names">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="System-Portability.html#System-Portability" rel="next"
title="System Portability">
+<link href="Syntactic-Conventions.html#Syntactic-Conventions" rel="previous"
title="Syntactic Conventions">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Names"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="System-Portability.html#System-Portability">System Portability</a>,
-Previous: <a rel="previous" accesskey="p"
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="System-Portability.html#System-Portability" accesskey="n"
rel="next">System Portability</a>, Previous: <a
href="Syntactic-Conventions.html#Syntactic-Conventions" accesskey="p"
rel="previous">Syntactic Conventions</a>, Up: <a
href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Naming-Variables_002c-Functions_002c-and-Files"></a>
<h3 class="section">5.4 Naming Variables, Functions, and Files</h3>
-<p><a name="index-names-of-variables_002c-functions_002c-and-files-98"></a>The
names of global variables and functions in a program serve as
-comments of a sort. So don't choose terse names—instead, look for
+<a name="index-names-of-variables_002c-functions_002c-and-files"></a>
+<p>The names of global variables and functions in a program serve as
+comments of a sort. So don’t choose terse names—instead, look for
names that give useful information about the meaning of the variable or
function. In a GNU program, names should be English, like other
comments.
-
- <p>Local variable names can be shorter, because they are used only within
+</p>
+<p>Local variable names can be shorter, because they are used only within
one context, where (presumably) comments explain their purpose.
-
- <p>Try to limit your use of abbreviations in symbol names. It is ok to
+</p>
+<p>Try to limit your use of abbreviations in symbol names. It is ok to
make a few abbreviations, explain what they mean, and then use them
-frequently, but don't use lots of obscure abbreviations.
-
- <p>Please use underscores to separate words in a name, so that the Emacs
+frequently, but don’t use lots of obscure abbreviations.
+</p>
+<p>Please use underscores to separate words in a name, so that the Emacs
word commands can be useful within them. Stick to lower case; reserve
upper case for macros and <code>enum</code> constants, and for name-prefixes
that follow a uniform convention.
-
- <p>For example, you should use names like
<code>ignore_space_change_flag</code>;
-don't use names like <code>iCantReadThis</code>.
-
- <p>Variables that indicate whether command-line options have been
+</p>
+<p>For example, you should use names like
<code>ignore_space_change_flag</code>;
+don’t use names like <code>iCantReadThis</code>.
+</p>
+<p>Variables that indicate whether command-line options have been
specified should be named after the meaning of the option, not after
the option-letter. A comment should state both the exact meaning of
the option and its letter. For example,
+</p>
+<div class="example">
+<pre class="example">/* Ignore changes in horizontal whitespace (-b). */
+int ignore_space_change_flag;
+</pre></div>
-<pre class="example"> /* Ignore changes in horizontal whitespace (-b). */
- int ignore_space_change_flag;
-</pre>
- <p>When you want to define names with constant integer values, use
-<code>enum</code> rather than ‘<samp><span
class="samp">#define</span></samp>’. GDB knows about enumeration
+<p>When you want to define names with constant integer values, use
+<code>enum</code> rather than ‘<samp>#define</samp>’. GDB knows
about enumeration
constants.
-
- <p><a name="index-file_002dname-limitations-99"></a><a
name="index-doschk-100"></a>You might want to make sure that none of the file
names would conflict
+</p>
+<a name="index-file_002dname-limitations"></a>
+<a name="index-doschk"></a>
+<p>You might want to make sure that none of the file names would conflict
if the files were loaded onto an MS-DOS file system which shortens the
names. You can use the program <code>doschk</code> to test for this.
-
- <p>Some GNU programs were designed to limit themselves to file names of 14
+</p>
+<p>Some GNU programs were designed to limit themselves to file names of 14
characters or less, to avoid file name conflicts if they are read into
older System V systems. Please preserve this feature in the existing
GNU programs that have it, but there is no need to do this in new GNU
programs. <code>doschk</code> also reports file names longer than 14
characters.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="System-Portability.html#System-Portability" accesskey="n"
rel="next">System Portability</a>, Previous: <a
href="Syntactic-Conventions.html#Syntactic-Conventions" accesskey="p"
rel="previous">Syntactic Conventions</a>, Up: <a
href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Non_002dGNU-Standards.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Non_002dGNU-Standards.html,v
retrieving revision 1.44
retrieving revision 1.45
diff -u -b -r1.44 -r1.45
--- standards/html_node/Non_002dGNU-Standards.html 8 Apr 2012 00:23:54
-0000 1.44
+++ standards/html_node/Non_002dGNU-Standards.html 7 May 2012 00:48:09
-0000 1.45
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Non-GNU Standards - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="next" href="Semantics.html#Semantics" title="Semantics">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,72 +11,111 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Non-GNU Standards</title>
+
+<meta name="description" content="GNU Coding Standards: Non-GNU Standards">
+<meta name="keywords" content="GNU Coding Standards: Non-GNU Standards">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Semantics.html#Semantics" rel="next" title="Semantics">
+<link href="Program-Behavior.html#Program-Behavior" rel="previous"
title="Program Behavior">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
-<a name="Non-GNU-Standards"></a>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Non_002dGNU-Standards"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Semantics.html#Semantics">Semantics</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="Semantics.html#Semantics" accesskey="n"
rel="next">Semantics</a>, Up: <a href="Program-Behavior.html#Program-Behavior"
accesskey="u" rel="up">Program Behavior</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Non_002dGNU-Standards-1"></a>
<h3 class="section">4.1 Non-GNU Standards</h3>
<p>The GNU Project regards standards published by other organizations as
suggestions, not orders. We consider those standards, but we do not
“obey” them. In developing a GNU program, you should implement
-an outside standard's specifications when that makes the GNU system
-better overall in an objective sense. When it doesn't, you shouldn't.
-
- <p>In most cases, following published standards is convenient for
+an outside standard’s specifications when that makes the GNU system
+better overall in an objective sense. When it doesn’t, you
shouldn’t.
+</p>
+<p>In most cases, following published standards is convenient for
users—it means that their programs or scripts will work more
portably. For instance, GCC implements nearly all the features of
Standard C as specified by that standard. C program developers would
be unhappy if it did not. And GNU utilities mostly follow
specifications of POSIX.2; shell script writers and users would be
unhappy if our programs were incompatible.
-
- <p>But we do not follow either of these specifications rigidly, and there
+</p>
+<p>But we do not follow either of these specifications rigidly, and there
are specific points on which we decided not to follow them, so as to
make the GNU system better for users.
-
- <p>For instance, Standard C says that nearly all extensions to C are
+</p>
+<p>For instance, Standard C says that nearly all extensions to C are
prohibited. How silly! GCC implements many extensions, some of which
were later adopted as part of the standard. If you want these
constructs to give an error message as “required” by the standard,
-you must specify ‘<samp><span
class="samp">--pedantic</span></samp>’, which was implemented only so that
+you must specify ‘<samp>--pedantic</samp>’, which was implemented
only so that
we can say “GCC is a 100% implementation of the standard”, not
because there is any reason to actually use it.
-
- <p>POSIX.2 specifies that ‘<samp><span
class="samp">df</span></samp>’ and ‘<samp><span
class="samp">du</span></samp>’ must output sizes by
+</p>
+<p>POSIX.2 specifies that ‘<samp>df</samp>’ and
‘<samp>du</samp>’ must output sizes by
default in units of 512 bytes. What users want is units of 1k, so
that is what we do by default. If you want the ridiculous behavior
“required” by POSIX, you must set the environment variable
-‘<samp><span class="samp">POSIXLY_CORRECT</span></samp>’ (which
was originally going to be named
-‘<samp><span class="samp">POSIX_ME_HARDER</span></samp>’).
-
- <p>GNU utilities also depart from the letter of the POSIX.2 specification
+‘<samp>POSIXLY_CORRECT</samp>’ (which was originally going to be
named
+‘<samp>POSIX_ME_HARDER</samp>’).
+</p>
+<p>GNU utilities also depart from the letter of the POSIX.2 specification
when they support long-named command-line options, and intermixing
options with ordinary arguments. This minor incompatibility with
POSIX is never a problem in practice, and it is very useful.
-
- <p>In particular, don't reject a new feature, or remove an old one,
+</p>
+<p>In particular, don’t reject a new feature, or remove an old one,
merely because a standard says it is “forbidden” or
“deprecated”.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Semantics.html#Semantics" accesskey="n"
rel="next">Semantics</a>, Up: <a href="Program-Behavior.html#Program-Behavior"
accesskey="u" rel="up">Program Behavior</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/OID-Allocations.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/OID-Allocations.html,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -b -r1.28 -r1.29
--- standards/html_node/OID-Allocations.html 8 Apr 2012 00:23:54 -0000
1.28
+++ standards/html_node/OID-Allocations.html 7 May 2012 00:48:09 -0000
1.29
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>OID Allocations - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="Option-Table.html#Option-Table" title="Option Table">
-<link rel="next" href="Memory-Usage.html#Memory-Usage" title="Memory Usage">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,78 +11,99 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: OID Allocations</title>
+
+<meta name="description" content="GNU Coding Standards: OID Allocations">
+<meta name="keywords" content="GNU Coding Standards: OID Allocations">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Memory-Usage.html#Memory-Usage" rel="next" title="Memory Usage">
+<link href="Option-Table.html#Option-Table" rel="previous" title="Option
Table">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="OID-Allocations"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Memory-Usage.html#Memory-Usage">Memory Usage</a>,
-Previous: <a rel="previous" accesskey="p"
href="Option-Table.html#Option-Table">Option Table</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="Memory-Usage.html#Memory-Usage" accesskey="n" rel="next">Memory
Usage</a>, Previous: <a href="Option-Table.html#Option-Table" accesskey="p"
rel="previous">Option Table</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="OID-Allocations-1"></a>
<h3 class="section">4.10 OID Allocations</h3>
+<a name="index-OID-allocations-for-GNU"></a>
+<a name="index-SNMP"></a>
+<a name="index-LDAP"></a>
+<a name="index-X_002e509"></a>
-<p><a name="index-OID-allocations-for-GNU-68"></a><a
name="index-SNMP-69"></a><a name="index-LDAP-70"></a><a
name="index-X_002e509-71"></a>
-The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the
+<p>The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the
GNU Project (thanks to Werner Koch). These are used for SNMP, LDAP,
X.509 certificates, and so on. The web site
<a
href="http://www.alvestrand.no/objectid";>http://www.alvestrand.no/objectid</a>
has a (voluntary) listing of
many OID assignments.
-
- <p>If you need a new slot for your GNU package, write
+</p>
+<p>If you need a new slot for your GNU package, write
<a href="mailto:address@hidden";>address@hidden</a>. Here is a list of arcs
currently
assigned:
+</p>
+<div class="example">
+<pre class="example">
+1.3.6.1.4.1.11591 GNU
-<pre class="example"> <!-- This table of OID's is included in the GNU
Coding Standards. -->
- <!-- Copyright 2008, 2009, 2010 Free Software Foundation, Inc. -->
- <!-- Copying and distribution of this file, with or without modification,
-->
- <!-- are permitted in any medium without royalty provided the copyright
-->
- <!-- notice and this notice are preserved. -->
- <!-- When adding new OIDs, please add them also to -->
- <!-- http://www.alvestrand.no/objectid/ (except it gets an internal -->
- <!-- server error, so never mind) -->
- <!-- (Our page is
http://www.alvestrand.no/objectid/1.3.6.1.4.1.11591.html.) -->
-
- 1.3.6.1.4.1.11591 GNU
-
- 1.3.6.1.4.1.11591.1 GNU Radius
+1.3.6.1.4.1.11591.1 GNU Radius
- 1.3.6.1.4.1.11591.2 GnuPG
+1.3.6.1.4.1.11591.2 GnuPG
1.3.6.1.4.1.11591.2.1 notation
1.3.6.1.4.1.11591.2.1.1 pkaAddress
- 1.3.6.1.4.1.11591.3 GNU Radar
+1.3.6.1.4.1.11591.3 GNU Radar
- 1.3.6.1.4.1.11591.4 GNU GSS
+1.3.6.1.4.1.11591.4 GNU GSS
- <!-- Added 2008-10-24 on request from Sergey Poznyakoff <address@hidden>
-->
- 1.3.6.1.4.1.11591.5 GNU Mailutils
+1.3.6.1.4.1.11591.5 GNU Mailutils
- <!-- Added 2009-03-03 on request from Simon Josefsson <address@hidden> -->
- 1.3.6.1.4.1.11591.6 GNU Shishi
+1.3.6.1.4.1.11591.6 GNU Shishi
- <!-- Added 2010-05-17 on request from Eric Blossom <address@hidden> -->
- 1.3.6.1.4.1.11591.7 GNU Radio
+1.3.6.1.4.1.11591.7 GNU Radio
- <!-- Added 2010-07-02 on request from Sergey Poznyakoff <address@hidden>
-->
- 1.3.6.1.4.1.11591.8 GNU Dico
+1.3.6.1.4.1.11591.8 GNU Dico
- 1.3.6.1.4.1.11591.12 digestAlgorithm
+1.3.6.1.4.1.11591.12 digestAlgorithm
1.3.6.1.4.1.11591.12.2 TIGER/192
1.3.6.1.4.1.11591.13 encryptionAlgorithm
1.3.6.1.4.1.11591.13.2 Serpent
@@ -110,6 +121,11 @@
1.3.6.1.4.1.11591.13.2.44 Serpent-256-CFB
1.3.6.1.4.1.11591.14 CRC algorithms
1.3.6.1.4.1.11591.14.1 CRC 32
-</pre>
- </body></html>
+</pre></div>
+
+
+
+
+</body>
+</html>
Index: standards/html_node/Option-Table.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Option-Table.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Option-Table.html 8 Apr 2012 00:23:55 -0000
1.54
+++ standards/html_node/Option-Table.html 7 May 2012 00:48:09 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Option Table - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev"
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
title="Dynamic Plug-In Interfaces">
-<link rel="next" href="OID-Allocations.html#OID-Allocations" title="OID
Allocations">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,789 +11,1535 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Option Table</title>
+
+<meta name="description" content="GNU Coding Standards: Option Table">
+<meta name="keywords" content="GNU Coding Standards: Option Table">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="OID-Allocations.html#OID-Allocations" rel="next" title="OID
Allocations">
+<link
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
rel="previous" title="Dynamic Plug-In Interfaces">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Option-Table"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="OID-Allocations.html#OID-Allocations">OID Allocations</a>,
-Previous: <a rel="previous" accesskey="p"
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="OID-Allocations.html#OID-Allocations" accesskey="n"
rel="next">OID Allocations</a>, Previous: <a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
accesskey="p" rel="previous">Dynamic Plug-In Interfaces</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Table-of-Long-Options"></a>
<h3 class="section">4.9 Table of Long Options</h3>
+<a name="index-long-option-names"></a>
+<a name="index-table-of-long-options"></a>
-<p><a name="index-long-option-names-66"></a><a
name="index-table-of-long-options-67"></a>
-Here is a table of long options used by GNU programs. It is surely
+<p>Here is a table of long options used by GNU programs. It is surely
incomplete, but we aim to list all the options that a new program might
want to be compatible with. If you use names not already in the table,
please send <a href="mailto:address@hidden";>address@hidden</a> a list of them,
with their
meanings, so we can update the table.
+</p>
-<!-- Please leave newlines between items in this table; it's much easier -->
-<!-- to update when it isn't completely squashed together and unreadable. -->
-<!-- When there is more than one short option for a long option name, put -->
-<!-- a semicolon between the lists of the programs that use them, not a -->
-<!-- period. -friedman -->
- <dl>
-<dt>‘<samp><span
class="samp">after-date</span></samp>’<dd>‘<samp><span
class="samp">-N</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">all</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>du</code>, <code>ls</code>,
<code>nm</code>, <code>stty</code>, <code>uname</code>,
+<dl compact="compact">
+<dt>‘<samp>after-date</samp>’</dt>
+<dd><p>‘<samp>-N</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>all</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>du</code>, <code>ls</code>,
<code>nm</code>, <code>stty</code>, <code>uname</code>,
and <code>unexpand</code>.
-
- <br><dt>‘<samp><span
class="samp">all-text</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">almost-all</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">append</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>etags</code>, <code>tee</code>,
<code>time</code>;
-‘<samp><span class="samp">-r</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">archive</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>cp</code>.
-
- <br><dt>‘<samp><span
class="samp">archive-name</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">arglength</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">ascii</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">assign</span></samp>’<dd>‘<samp><span
class="samp">-v</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">assume-new</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">assume-old</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">auto-check</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">auto-pager</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">auto-reference</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">avoid-wraps</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">background</span></samp>’<dd>For server programs, run in the
background.
-
- <br><dt>‘<samp><span
class="samp">backward-search</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">basename</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">batch</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span class="samp">baud</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">before</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>tac</code>.
-
- <br><dt>‘<samp><span
class="samp">binary</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>cpio</code> and <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">bits-per-code</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">block-size</span></samp>’<dd>Used in <code>cpio</code> and
<code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">blocks</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>head</code> and <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">break-file</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">brief</span></samp>’<dd>Used in various programs to make
output shorter.
-
- <br><dt>‘<samp><span
class="samp">bytes</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>head</code>, <code>split</code>,
and <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">c</span><tt>++</tt></samp>’<dd>‘<samp><span
class="samp">-C</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">catenate</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span class="samp">cd</span></samp>’<dd>Used
in various programs to specify the directory to use.
-
- <br><dt>‘<samp><span
class="samp">changes</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>chgrp</code> and
<code>chown</code>.
-
- <br><dt>‘<samp><span
class="samp">classify</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">colons</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">command</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>su</code>;
-‘<samp><span class="samp">-x</span></samp>’ in GDB.
-
- <br><dt>‘<samp><span
class="samp">compare</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">compat</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">compress</span></samp>’<dd>‘<samp><span
class="samp">-Z</span></samp>’ in <code>tar</code> and <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">concatenate</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">confirmation</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">context</span></samp>’<dd>Used in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">copyleft</span></samp>’<dd>‘<samp><span
class="samp">-W copyleft</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">copyright</span></samp>’<dd>‘<samp><span
class="samp">-C</span></samp>’ in <code>ptx</code>, <code>recode</code>,
and <code>wdiff</code>;
-‘<samp><span class="samp">-W copyright</span></samp>’ in
<code>gawk</code>.
-
- <br><dt>‘<samp><span class="samp">core</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">count</span></samp>’<dd>‘<samp><span
class="samp">-q</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">count-links</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">create</span></samp>’<dd>Used in <code>tar</code> and
<code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">cut-mark</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">cxref</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">date</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">debug</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>make</code> and <code>m4</code>;
-‘<samp><span class="samp">-t</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">define</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">defines</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in Bison and <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">delete</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">dereference</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>chgrp</code>, <code>chown</code>,
<code>cpio</code>, <code>du</code>,
+</p>
+</dd>
+<dt>‘<samp>all-text</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>almost-all</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>append</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>etags</code>, <code>tee</code>,
<code>time</code>;
+‘<samp>-r</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>archive</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>cp</code>.
+</p>
+</dd>
+<dt>‘<samp>archive-name</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>arglength</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>ascii</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>assign</samp>’</dt>
+<dd><p>‘<samp>-v</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>assume-new</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>assume-old</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>auto-check</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>auto-pager</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>auto-reference</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>avoid-wraps</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>background</samp>’</dt>
+<dd><p>For server programs, run in the background.
+</p>
+</dd>
+<dt>‘<samp>backward-search</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>basename</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>batch</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>baud</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>before</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>tac</code>.
+</p>
+</dd>
+<dt>‘<samp>binary</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>cpio</code> and
<code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>bits-per-code</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>block-size</samp>’</dt>
+<dd><p>Used in <code>cpio</code> and <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>blocks</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>head</code> and
<code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>break-file</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>brief</samp>’</dt>
+<dd><p>Used in various programs to make output shorter.
+</p>
+</dd>
+<dt>‘<samp>bytes</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>head</code>, <code>split</code>,
and <code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>c<tt>++</tt></samp>’</dt>
+<dd><p>‘<samp>-C</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>catenate</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>cd</samp>’</dt>
+<dd><p>Used in various programs to specify the directory to use.
+</p>
+</dd>
+<dt>‘<samp>changes</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>chgrp</code> and
<code>chown</code>.
+</p>
+</dd>
+<dt>‘<samp>classify</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>colons</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>command</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>su</code>;
+‘<samp>-x</samp>’ in GDB.
+</p>
+</dd>
+<dt>‘<samp>compare</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>compat</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>compress</samp>’</dt>
+<dd><p>‘<samp>-Z</samp>’ in <code>tar</code> and <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>concatenate</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>confirmation</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>context</samp>’</dt>
+<dd><p>Used in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>copyleft</samp>’</dt>
+<dd><p>‘<samp>-W copyleft</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>copyright</samp>’</dt>
+<dd><p>‘<samp>-C</samp>’ in <code>ptx</code>, <code>recode</code>,
and <code>wdiff</code>;
+‘<samp>-W copyright</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>core</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>count</samp>’</dt>
+<dd><p>‘<samp>-q</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>count-links</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>create</samp>’</dt>
+<dd><p>Used in <code>tar</code> and <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>cut-mark</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>cxref</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>date</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>debug</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>make</code> and <code>m4</code>;
+‘<samp>-t</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>define</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>defines</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in Bison and <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>delete</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>dereference</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>chgrp</code>,
<code>chown</code>, <code>cpio</code>, <code>du</code>,
<code>ls</code>, and <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">dereference-args</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">device</span></samp>’<dd>Specify an I/O device (special file
name).
-
- <br><dt>‘<samp><span
class="samp">diacritics</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">dictionary-order</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>look</code>.
-
- <br><dt>‘<samp><span
class="samp">diff</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">digits</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">directory</span></samp>’<dd>Specify the directory to use, in
various programs. In <code>ls</code>, it
+</p>
+</dd>
+<dt>‘<samp>dereference-args</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>device</samp>’</dt>
+<dd><p>Specify an I/O device (special file name).
+</p>
+</dd>
+<dt>‘<samp>diacritics</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>dictionary-order</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>look</code>.
+</p>
+</dd>
+<dt>‘<samp>diff</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>digits</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>directory</samp>’</dt>
+<dd><p>Specify the directory to use, in various programs. In <code>ls</code>,
it
means to show directories themselves rather than their contents. In
<code>rm</code> and <code>ln</code>, it means to not treat links to directories
specially.
-
- <br><dt>‘<samp><span
class="samp">discard-all</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">discard-locals</span></samp>’<dd>‘<samp><span
class="samp">-X</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">dry-run</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">ed</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">elide-empty-files</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">end-delete</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">end-insert</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">entire-new-file</span></samp>’<dd>‘<samp><span
class="samp">-N</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">environment-overrides</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">eof</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">epoch</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">error-limit</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">error-output</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">escape</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">exclude-from</span></samp>’<dd>‘<samp><span
class="samp">-X</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span class="samp">exec</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">exit</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">exit-0</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>unshar</code>.
-
- <br><dt>‘<samp><span
class="samp">expand-tabs</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">expression</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>sed</code>.
-
- <br><dt>‘<samp><span
class="samp">extern-only</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">extract</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>cpio</code>;
-‘<samp><span class="samp">-x</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">faces</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>finger</code>.
-
- <br><dt>‘<samp><span
class="samp">fast</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">fatal-warnings</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">file</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>gawk</code>, <code>info</code>,
<code>make</code>, <code>mt</code>,
+</p>
+</dd>
+<dt>‘<samp>discard-all</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>discard-locals</samp>’</dt>
+<dd><p>‘<samp>-X</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>dry-run</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>ed</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>elide-empty-files</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>end-delete</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>end-insert</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>entire-new-file</samp>’</dt>
+<dd><p>‘<samp>-N</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>environment-overrides</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>eof</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>epoch</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>error-limit</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>error-output</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>escape</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>exclude-from</samp>’</dt>
+<dd><p>‘<samp>-X</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>exec</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>exit</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>exit-0</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>unshar</code>.
+</p>
+</dd>
+<dt>‘<samp>expand-tabs</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>expression</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>sed</code>.
+</p>
+</dd>
+<dt>‘<samp>extern-only</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>extract</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>cpio</code>;
+‘<samp>-x</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>faces</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>finger</code>.
+</p>
+</dd>
+<dt>‘<samp>fast</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>fatal-warnings</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>file</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>gawk</code>, <code>info</code>,
<code>make</code>, <code>mt</code>,
<code>sed</code>, and <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">field-separator</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">file-prefix</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">file-type</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">files-from</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">fill-column</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">flag-truncation</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">fixed-output-files</span></samp>’<dd>‘<samp><span
class="samp">-y</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">follow</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">footnote-style</span></samp>’<dd>Used in
<code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">force</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, and <code>rm</code>.
-
- <br><dt>‘<samp><span
class="samp">force-prefix</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">foreground</span></samp>’<dd>For server programs, run in the
foreground;
-in other words, don't do anything special to run the server
+</p>
+</dd>
+<dt>‘<samp>field-separator</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>file-prefix</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>file-type</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>files-from</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>fill-column</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>flag-truncation</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>fixed-output-files</samp>’</dt>
+<dd><p>‘<samp>-y</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>follow</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>footnote-style</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>force</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, and <code>rm</code>.
+</p>
+</dd>
+<dt>‘<samp>force-prefix</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>foreground</samp>’</dt>
+<dd><p>For server programs, run in the foreground;
+in other words, don’t do anything special to run the server
in the background.
-
- <br><dt>‘<samp><span
class="samp">format</span></samp>’<dd>Used in <code>ls</code>,
<code>time</code>, and <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">freeze-state</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">fullname</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">gap-size</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">get</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">graphic</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>ul</code>.
-
- <br><dt>‘<samp><span
class="samp">graphics</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">group</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>install</code>.
-
- <br><dt>‘<samp><span
class="samp">gzip</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>tar</code> and <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">hashsize</span></samp>’<dd>‘<samp><span
class="samp">-H</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">header</span></samp>’<dd>‘<samp><span
class="samp">-h</span></samp>’ in <code>objdump</code> and
<code>recode</code>
-
- <br><dt>‘<samp><span
class="samp">heading</span></samp>’<dd>‘<samp><span
class="samp">-H</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span class="samp">help</span></samp>’<dd>Used
to ask for brief usage information.
-
- <br><dt>‘<samp><span
class="samp">here-delimiter</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">hide-control-chars</span></samp>’<dd>‘<samp><span
class="samp">-q</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span class="samp">html</span></samp>’<dd>In
<code>makeinfo</code>, output HTML.
-
- <br><dt>‘<samp><span
class="samp">idle</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">ifdef</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>ls</code>;
-‘<samp><span class="samp">-x</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-all-space</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-backups</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-blank-lines</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-case</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>look</code> and <code>ptx</code>;
-‘<samp><span class="samp">-i</span></samp>’ in <code>diff</code>
and <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-errors</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-file</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-indentation</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-init-file</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in Oleo.
-
- <br><dt>‘<samp><span
class="samp">ignore-interrupts</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>tee</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-matching-lines</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-space-change</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">ignore-zeros</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">include</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>etags</code>;
-‘<samp><span class="samp">-I</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">include-dir</span></samp>’<dd>‘<samp><span
class="samp">-I</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">incremental</span></samp>’<dd>‘<samp><span
class="samp">-G</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">info</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’, ‘<samp><span
class="samp">-l</span></samp>’, and ‘<samp><span
class="samp">-m</span></samp>’ in Finger.
-
- <br><dt>‘<samp><span
class="samp">init-file</span></samp>’<dd>In some programs, specify the
name of the file to read as the user's
+</p>
+</dd>
+<dt>‘<samp>format</samp>’</dt>
+<dd><p>Used in <code>ls</code>, <code>time</code>, and <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>freeze-state</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>fullname</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>gap-size</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>get</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>graphic</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>ul</code>.
+</p>
+</dd>
+<dt>‘<samp>graphics</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>group</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>install</code>.
+</p>
+</dd>
+<dt>‘<samp>gzip</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>tar</code> and <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>hashsize</samp>’</dt>
+<dd><p>‘<samp>-H</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>header</samp>’</dt>
+<dd><p>‘<samp>-h</samp>’ in <code>objdump</code> and
<code>recode</code>
+</p>
+</dd>
+<dt>‘<samp>heading</samp>’</dt>
+<dd><p>‘<samp>-H</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>help</samp>’</dt>
+<dd><p>Used to ask for brief usage information.
+</p>
+</dd>
+<dt>‘<samp>here-delimiter</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>hide-control-chars</samp>’</dt>
+<dd><p>‘<samp>-q</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>html</samp>’</dt>
+<dd><p>In <code>makeinfo</code>, output HTML.
+</p>
+</dd>
+<dt>‘<samp>idle</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>ifdef</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>ls</code>;
+‘<samp>-x</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-all-space</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-backups</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-blank-lines</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-case</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>look</code> and <code>ptx</code>;
+‘<samp>-i</samp>’ in <code>diff</code> and <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-errors</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-file</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-indentation</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-init-file</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in Oleo.
+</p>
+</dd>
+<dt>‘<samp>ignore-interrupts</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>tee</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-matching-lines</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-space-change</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>ignore-zeros</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>include</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>etags</code>;
+‘<samp>-I</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>include-dir</samp>’</dt>
+<dd><p>‘<samp>-I</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>incremental</samp>’</dt>
+<dd><p>‘<samp>-G</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>info</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’, ‘<samp>-l</samp>’, and
‘<samp>-m</samp>’ in Finger.
+</p>
+</dd>
+<dt>‘<samp>init-file</samp>’</dt>
+<dd><p>In some programs, specify the name of the file to read as the
user’s
init file.
-
- <br><dt>‘<samp><span
class="samp">initial</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>expand</code>.
-
- <br><dt>‘<samp><span
class="samp">initial-tab</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">inode</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">interactive</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, <code>rm</code>;
-‘<samp><span class="samp">-e</span></samp>’ in <code>m4</code>;
-‘<samp><span class="samp">-p</span></samp>’ in <code>xargs</code>;
-‘<samp><span class="samp">-w</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">intermix-type</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">iso-8601</span></samp>’<dd>Used in <code>date</code>
-
- <br><dt>‘<samp><span
class="samp">jobs</span></samp>’<dd>‘<samp><span
class="samp">-j</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">just-print</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">keep-going</span></samp>’<dd>‘<samp><span
class="samp">-k</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">keep-files</span></samp>’<dd>‘<samp><span
class="samp">-k</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">kilobytes</span></samp>’<dd>‘<samp><span
class="samp">-k</span></samp>’ in <code>du</code> and <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">language</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">less-mode</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">level-for-gzip</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">line-bytes</span></samp>’<dd>‘<samp><span
class="samp">-C</span></samp>’ in <code>split</code>.
-
- <br><dt>‘<samp><span
class="samp">lines</span></samp>’<dd>Used in <code>split</code>,
<code>head</code>, and <code>tail</code>.
-
- <br><dt>‘<samp><span
class="samp">link</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">lint</span></samp>’<dt>‘<samp><span
class="samp">lint-old</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">list</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>cpio</code>;
-‘<samp><span class="samp">-l</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">list</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">literal</span></samp>’<dd>‘<samp><span
class="samp">-N</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">load-average</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">login</span></samp>’<dd>Used in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">machine</span></samp>’<dd>Used in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">macro-name</span></samp>’<dd>‘<samp><span
class="samp">-M</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">mail</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>hello</code> and
<code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">make-directories</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">makefile</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">mapped</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">max-args</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">max-chars</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">max-lines</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">max-load</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">max-procs</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">mesg</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">message</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>who</code>.
-
- <br><dt>‘<samp><span
class="samp">minimal</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">mixed-uuencode</span></samp>’<dd>‘<samp><span
class="samp">-M</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">mode</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>install</code>,
<code>mkdir</code>, and <code>mkfifo</code>.
-
- <br><dt>‘<samp><span
class="samp">modification-time</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">multi-volume</span></samp>’<dd>‘<samp><span
class="samp">-M</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">name-prefix</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">nesting-limit</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">net-headers</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">new-file</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">no-builtin-rules</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">no-character-count</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-check-existing</span></samp>’<dd>‘<samp><span
class="samp">-x</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-common</span></samp>’<dd>‘<samp><span
class="samp">-3</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">no-create</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">no-defines</span></samp>’<dd>‘<samp><span
class="samp">-D</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">no-deleted</span></samp>’<dd>‘<samp><span
class="samp">-1</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">no-dereference</span></samp>’<dd>‘<samp><span
class="samp">-d</span></samp>’ in <code>cp</code>.
-
- <br><dt>‘<samp><span
class="samp">no-inserted</span></samp>’<dd>‘<samp><span
class="samp">-2</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">no-keep-going</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">no-lines</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in Bison.
-
- <br><dt>‘<samp><span
class="samp">no-piping</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-prof</span></samp>’<dd>‘<samp><span
class="samp">-e</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">no-regex</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">no-sort</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">no-splash</span></samp>’<dd>Don't print a startup splash
screen.
-
- <br><dt>‘<samp><span
class="samp">no-split</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">no-static</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">no-time</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">no-timestamp</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">no-validate</span></samp>’<dd>Used in <code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">no-wait</span></samp>’<dd>Used in <code>emacsclient</code>.
-
- <br><dt>‘<samp><span
class="samp">no-warn</span></samp>’<dd>Used in various programs to
inhibit warnings.
-
- <br><dt>‘<samp><span
class="samp">node</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>info</code>.
-
- <br><dt>‘<samp><span
class="samp">nodename</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">nonmatching</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">nstuff</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>objdump</code>.
-
- <br><dt>‘<samp><span
class="samp">null</span></samp>’<dd>‘<samp><span
class="samp">-0</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">number</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">number-nonblank</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">numeric-sort</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">numeric-uid-gid</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>cpio</code> and <code>ls</code>.
-
- <br><dt>‘<samp><span class="samp">nx</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">old-archive</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">old-file</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">one-file-system</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>tar</code>, <code>cp</code>, and
<code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">only-file</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">only-prof</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">only-time</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">options</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>getopt</code>,
<code>fdlist</code>, <code>fdmount</code>,
+</p>
+</dd>
+<dt>‘<samp>initial</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>expand</code>.
+</p>
+</dd>
+<dt>‘<samp>initial-tab</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>inode</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>interactive</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>, <code>rm</code>;
+‘<samp>-e</samp>’ in <code>m4</code>;
+‘<samp>-p</samp>’ in <code>xargs</code>;
+‘<samp>-w</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>intermix-type</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>iso-8601</samp>’</dt>
+<dd><p>Used in <code>date</code>
+</p>
+</dd>
+<dt>‘<samp>jobs</samp>’</dt>
+<dd><p>‘<samp>-j</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>just-print</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>keep-going</samp>’</dt>
+<dd><p>‘<samp>-k</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>keep-files</samp>’</dt>
+<dd><p>‘<samp>-k</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>kilobytes</samp>’</dt>
+<dd><p>‘<samp>-k</samp>’ in <code>du</code> and <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>language</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>less-mode</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>level-for-gzip</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>line-bytes</samp>’</dt>
+<dd><p>‘<samp>-C</samp>’ in <code>split</code>.
+</p>
+</dd>
+<dt>‘<samp>lines</samp>’</dt>
+<dd><p>Used in <code>split</code>, <code>head</code>, and <code>tail</code>.
+</p>
+</dd>
+<dt>‘<samp>link</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>lint</samp>’</dt>
+<dt>‘<samp>lint-old</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>list</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>cpio</code>;
+‘<samp>-l</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>list</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>literal</samp>’</dt>
+<dd><p>‘<samp>-N</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>load-average</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>login</samp>’</dt>
+<dd><p>Used in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>machine</samp>’</dt>
+<dd><p>Used in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>macro-name</samp>’</dt>
+<dd><p>‘<samp>-M</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>mail</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>hello</code> and
<code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>make-directories</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>makefile</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>mapped</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>max-args</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>max-chars</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>max-lines</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>max-load</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>max-procs</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>mesg</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>message</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>minimal</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>mixed-uuencode</samp>’</dt>
+<dd><p>‘<samp>-M</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>mode</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>install</code>,
<code>mkdir</code>, and <code>mkfifo</code>.
+</p>
+</dd>
+<dt>‘<samp>modification-time</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>multi-volume</samp>’</dt>
+<dd><p>‘<samp>-M</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>name-prefix</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>nesting-limit</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>net-headers</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>new-file</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>no-builtin-rules</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>no-character-count</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-check-existing</samp>’</dt>
+<dd><p>‘<samp>-x</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-common</samp>’</dt>
+<dd><p>‘<samp>-3</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>no-create</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>no-defines</samp>’</dt>
+<dd><p>‘<samp>-D</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>no-deleted</samp>’</dt>
+<dd><p>‘<samp>-1</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>no-dereference</samp>’</dt>
+<dd><p>‘<samp>-d</samp>’ in <code>cp</code>.
+</p>
+</dd>
+<dt>‘<samp>no-inserted</samp>’</dt>
+<dd><p>‘<samp>-2</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>no-keep-going</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>no-lines</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in Bison.
+</p>
+</dd>
+<dt>‘<samp>no-piping</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-prof</samp>’</dt>
+<dd><p>‘<samp>-e</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>no-regex</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>no-sort</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>no-splash</samp>’</dt>
+<dd><p>Don’t print a startup splash screen.
+</p>
+</dd>
+<dt>‘<samp>no-split</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>no-static</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>no-time</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>no-timestamp</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>no-validate</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>no-wait</samp>’</dt>
+<dd><p>Used in <code>emacsclient</code>.
+</p>
+</dd>
+<dt>‘<samp>no-warn</samp>’</dt>
+<dd><p>Used in various programs to inhibit warnings.
+</p>
+</dd>
+<dt>‘<samp>node</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>info</code>.
+</p>
+</dd>
+<dt>‘<samp>nodename</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>nonmatching</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>nstuff</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>objdump</code>.
+</p>
+</dd>
+<dt>‘<samp>null</samp>’</dt>
+<dd><p>‘<samp>-0</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>number</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>number-nonblank</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>numeric-sort</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>numeric-uid-gid</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>cpio</code> and <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>nx</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>old-archive</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>old-file</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>one-file-system</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>tar</code>, <code>cp</code>, and
<code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>only-file</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>only-prof</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>only-time</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>options</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>getopt</code>,
<code>fdlist</code>, <code>fdmount</code>,
<code>fdmountd</code>, and <code>fdumount</code>.
-
- <br><dt>‘<samp><span class="samp">output</span></samp>’<dd>In
various programs, specify the output file name.
-
- <br><dt>‘<samp><span
class="samp">output-prefix</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">override</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>rm</code>.
-
- <br><dt>‘<samp><span
class="samp">overwrite</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>unshar</code>.
-
- <br><dt>‘<samp><span
class="samp">owner</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>install</code>.
-
- <br><dt>‘<samp><span
class="samp">paginate</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">paragraph-indent</span></samp>’<dd>Used in
<code>makeinfo</code>.
-
- <br><dt>‘<samp><span
class="samp">parents</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>mkdir</code> and
<code>rmdir</code>.
-
- <br><dt>‘<samp><span
class="samp">pass-all</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>ul</code>.
-
- <br><dt>‘<samp><span
class="samp">pass-through</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">port</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>finger</code>.
-
- <br><dt>‘<samp><span
class="samp">portability</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>cpio</code> and <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">posix</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">prefix-builtins</span></samp>’<dd>‘<samp><span
class="samp">-P</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">prefix</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve</span></samp>’<dd>Used in <code>tar</code> and
<code>cp</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-environment</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-modification-time</span></samp>’<dd>‘<samp><span
class="samp">-m</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-order</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">preserve-permissions</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">print</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">print-chars</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>cmp</code>.
-
- <br><dt>‘<samp><span
class="samp">print-data-base</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">print-directory</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">print-file-name</span></samp>’<dd>‘<samp><span
class="samp">-o</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">print-symdefs</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">printer</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">prompt</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>ed</code>.
-
- <br><dt>‘<samp><span
class="samp">proxy</span></samp>’<dd>Specify an HTTP proxy.
-
- <br><dt>‘<samp><span
class="samp">query-user</span></samp>’<dd>‘<samp><span
class="samp">-X</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">question</span></samp>’<dd>‘<samp><span
class="samp">-q</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">quiet</span></samp>’<dd>Used in many programs to inhibit the
usual output. Every
-program accepting ‘<samp><span class="samp">--quiet</span></samp>’
should accept ‘<samp><span class="samp">--silent</span></samp>’ as a
+</p>
+</dd>
+<dt>‘<samp>output</samp>’</dt>
+<dd><p>In various programs, specify the output file name.
+</p>
+</dd>
+<dt>‘<samp>output-prefix</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>override</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>rm</code>.
+</p>
+</dd>
+<dt>‘<samp>overwrite</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>unshar</code>.
+</p>
+</dd>
+<dt>‘<samp>owner</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>install</code>.
+</p>
+</dd>
+<dt>‘<samp>paginate</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>paragraph-indent</samp>’</dt>
+<dd><p>Used in <code>makeinfo</code>.
+</p>
+</dd>
+<dt>‘<samp>parents</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>mkdir</code> and
<code>rmdir</code>.
+</p>
+</dd>
+<dt>‘<samp>pass-all</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>ul</code>.
+</p>
+</dd>
+<dt>‘<samp>pass-through</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>port</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>finger</code>.
+</p>
+</dd>
+<dt>‘<samp>portability</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>cpio</code> and <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>posix</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>prefix-builtins</samp>’</dt>
+<dd><p>‘<samp>-P</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>prefix</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve</samp>’</dt>
+<dd><p>Used in <code>tar</code> and <code>cp</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-environment</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-modification-time</samp>’</dt>
+<dd><p>‘<samp>-m</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-order</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>preserve-permissions</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>print</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>print-chars</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>cmp</code>.
+</p>
+</dd>
+<dt>‘<samp>print-data-base</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>print-directory</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>print-file-name</samp>’</dt>
+<dd><p>‘<samp>-o</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>print-symdefs</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>printer</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>prompt</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>ed</code>.
+</p>
+</dd>
+<dt>‘<samp>proxy</samp>’</dt>
+<dd><p>Specify an HTTP proxy.
+</p>
+</dd>
+<dt>‘<samp>query-user</samp>’</dt>
+<dd><p>‘<samp>-X</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>question</samp>’</dt>
+<dd><p>‘<samp>-q</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>quiet</samp>’</dt>
+<dd><p>Used in many programs to inhibit the usual output. Every
+program accepting ‘<samp>--quiet</samp>’ should accept
‘<samp>--silent</samp>’ as a
synonym.
-
- <br><dt>‘<samp><span
class="samp">quiet-unshar</span></samp>’<dd>‘<samp><span
class="samp">-Q</span></samp>’ in <code>shar</code>
-
- <br><dt>‘<samp><span
class="samp">quote-name</span></samp>’<dd>‘<samp><span
class="samp">-Q</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">rcs</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">re-interval</span></samp>’<dd>Used in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">read-full-blocks</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">readnow</span></samp>’<dd>Used in GDB.
-
- <br><dt>‘<samp><span
class="samp">recon</span></samp>’<dd>‘<samp><span
class="samp">-n</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">record-number</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">recursive</span></samp>’<dd>Used in <code>chgrp</code>,
<code>chown</code>, <code>cp</code>, <code>ls</code>, <code>diff</code>,
+</p>
+</dd>
+<dt>‘<samp>quiet-unshar</samp>’</dt>
+<dd><p>‘<samp>-Q</samp>’ in <code>shar</code>
+</p>
+</dd>
+<dt>‘<samp>quote-name</samp>’</dt>
+<dd><p>‘<samp>-Q</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>rcs</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>re-interval</samp>’</dt>
+<dd><p>Used in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>read-full-blocks</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>readnow</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>recon</samp>’</dt>
+<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>record-number</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>recursive</samp>’</dt>
+<dd><p>Used in <code>chgrp</code>, <code>chown</code>, <code>cp</code>,
<code>ls</code>, <code>diff</code>,
and <code>rm</code>.
-
- <br><dt>‘<samp><span
class="samp">reference</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">references</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">regex</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>tac</code> and <code>etags</code>.
-
- <br><dt>‘<samp><span
class="samp">release</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">reload-state</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">relocation</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>objdump</code>.
-
- <br><dt>‘<samp><span
class="samp">rename</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">replace</span></samp>’<dd>‘<samp><span
class="samp">-i</span></samp>’ in <code>xargs</code>.
-
- <br><dt>‘<samp><span
class="samp">report-identical-files</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">reset-access-time</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">reverse</span></samp>’<dd>‘<samp><span
class="samp">-r</span></samp>’ in <code>ls</code> and <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">reversed-ed</span></samp>’<dd>‘<samp><span
class="samp">-f</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">right-side-defs</span></samp>’<dd>‘<samp><span
class="samp">-R</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">same-order</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">same-permissions</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">save</span></samp>’<dd>‘<samp><span
class="samp">-g</span></samp>’ in <code>stty</code>.
-
- <br><dt>‘<samp><span class="samp">se</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">sentence-regexp</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">separate-dirs</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">separator</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>tac</code>.
-
- <br><dt>‘<samp><span
class="samp">sequence</span></samp>’<dd>Used by <code>recode</code> to
chose files or pipes for sequencing passes.
-
- <br><dt>‘<samp><span
class="samp">shell</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>su</code>.
-
- <br><dt>‘<samp><span
class="samp">show-all</span></samp>’<dd>‘<samp><span
class="samp">-A</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">show-c-function</span></samp>’<dd>‘<samp><span
class="samp">-p</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">show-ends</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">show-function-line</span></samp>’<dd>‘<samp><span
class="samp">-F</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">show-tabs</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">silent</span></samp>’<dd>Used in many programs to inhibit
the usual output.
+</p>
+</dd>
+<dt>‘<samp>reference</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>references</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>regex</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>tac</code> and
<code>etags</code>.
+</p>
+</dd>
+<dt>‘<samp>release</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>reload-state</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>relocation</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>objdump</code>.
+</p>
+</dd>
+<dt>‘<samp>rename</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>replace</samp>’</dt>
+<dd><p>‘<samp>-i</samp>’ in <code>xargs</code>.
+</p>
+</dd>
+<dt>‘<samp>report-identical-files</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>reset-access-time</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>reverse</samp>’</dt>
+<dd><p>‘<samp>-r</samp>’ in <code>ls</code> and <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>reversed-ed</samp>’</dt>
+<dd><p>‘<samp>-f</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>right-side-defs</samp>’</dt>
+<dd><p>‘<samp>-R</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>same-order</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>same-permissions</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>save</samp>’</dt>
+<dd><p>‘<samp>-g</samp>’ in <code>stty</code>.
+</p>
+</dd>
+<dt>‘<samp>se</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>sentence-regexp</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>separate-dirs</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>separator</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>tac</code>.
+</p>
+</dd>
+<dt>‘<samp>sequence</samp>’</dt>
+<dd><p>Used by <code>recode</code> to chose files or pipes for sequencing
passes.
+</p>
+</dd>
+<dt>‘<samp>shell</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>su</code>.
+</p>
+</dd>
+<dt>‘<samp>show-all</samp>’</dt>
+<dd><p>‘<samp>-A</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>show-c-function</samp>’</dt>
+<dd><p>‘<samp>-p</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>show-ends</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>show-function-line</samp>’</dt>
+<dd><p>‘<samp>-F</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>show-tabs</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>silent</samp>’</dt>
+<dd><p>Used in many programs to inhibit the usual output.
Every program accepting
-‘<samp><span class="samp">--silent</span></samp>’ should accept
‘<samp><span class="samp">--quiet</span></samp>’ as a synonym.
-
- <br><dt>‘<samp><span
class="samp">size</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">socket</span></samp>’<dd>Specify a file descriptor for a
network server to use for its socket,
+‘<samp>--silent</samp>’ should accept
‘<samp>--quiet</samp>’ as a synonym.
+</p>
+</dd>
+<dt>‘<samp>size</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>socket</samp>’</dt>
+<dd><p>Specify a file descriptor for a network server to use for its socket,
instead of opening and binding a new socket. This provides a way to
run, in a non-privileged process, a server that normally needs a
reserved port number.
-
- <br><dt>‘<samp><span class="samp">sort</span></samp>’<dd>Used
in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">source</span></samp>’<dd>‘<samp><span class="samp">-W
source</span></samp>’ in <code>gawk</code>.
-
- <br><dt>‘<samp><span
class="samp">sparse</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">speed-large-files</span></samp>’<dd>‘<samp><span
class="samp">-H</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">split-at</span></samp>’<dd>‘<samp><span
class="samp">-E</span></samp>’ in <code>unshar</code>.
-
- <br><dt>‘<samp><span
class="samp">split-size-limit</span></samp>’<dd>‘<samp><span
class="samp">-L</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">squeeze-blank</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>cat</code>.
-
- <br><dt>‘<samp><span
class="samp">start-delete</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">start-insert</span></samp>’<dd>‘<samp><span
class="samp">-y</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">starting-file</span></samp>’<dd>Used in <code>tar</code> and
<code>diff</code> to specify which file within
+</p>
+</dd>
+<dt>‘<samp>sort</samp>’</dt>
+<dd><p>Used in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>source</samp>’</dt>
+<dd><p>‘<samp>-W source</samp>’ in <code>gawk</code>.
+</p>
+</dd>
+<dt>‘<samp>sparse</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>speed-large-files</samp>’</dt>
+<dd><p>‘<samp>-H</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>split-at</samp>’</dt>
+<dd><p>‘<samp>-E</samp>’ in <code>unshar</code>.
+</p>
+</dd>
+<dt>‘<samp>split-size-limit</samp>’</dt>
+<dd><p>‘<samp>-L</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>squeeze-blank</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>cat</code>.
+</p>
+</dd>
+<dt>‘<samp>start-delete</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>start-insert</samp>’</dt>
+<dd><p>‘<samp>-y</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>starting-file</samp>’</dt>
+<dd><p>Used in <code>tar</code> and <code>diff</code> to specify which file
within
a directory to start processing with.
+</p>
+</dd>
+<dt>‘<samp>statistics</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>stdin-file-list</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>stop</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>strict</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>strip</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>install</code>.
+</p>
+</dd>
+<dt>‘<samp>strip-all</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>strip-debug</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>strip</code>.
+</p>
+</dd>
+<dt>‘<samp>submitter</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>suffix</samp>’</dt>
+<dd><p>‘<samp>-S</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
+</p>
+</dd>
+<dt>‘<samp>suffix-format</samp>’</dt>
+<dd><p>‘<samp>-b</samp>’ in <code>csplit</code>.
+</p>
+</dd>
+<dt>‘<samp>sum</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>gprof</code>.
+</p>
+</dd>
+<dt>‘<samp>summarize</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>symbolic</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>ln</code>.
+</p>
+</dd>
+<dt>‘<samp>symbols</samp>’</dt>
+<dd><p>Used in GDB and <code>objdump</code>.
+</p>
+</dd>
+<dt>‘<samp>synclines</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>sysname</samp>’</dt>
+<dd><p>‘<samp>-s</samp>’ in <code>uname</code>.
+</p>
+</dd>
+<dt>‘<samp>tabs</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>expand</code> and
<code>unexpand</code>.
+</p>
+</dd>
+<dt>‘<samp>tabsize</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>ls</code>.
+</p>
+</dd>
+<dt>‘<samp>terminal</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>tput</code> and <code>ul</code>.
+‘<samp>-t</samp>’ in <code>wdiff</code>.
+</p>
+</dd>
+<dt>‘<samp>text</samp>’</dt>
+<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+</p>
+</dd>
+<dt>‘<samp>text-files</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>time</samp>’</dt>
+<dd><p>Used in <code>ls</code> and <code>touch</code>.
+</p>
+</dd>
+<dt>‘<samp>timeout</samp>’</dt>
+<dd><p>Specify how long to wait before giving up on some operation.
+</p>
+</dd>
+<dt>‘<samp>to-stdout</samp>’</dt>
+<dd><p>‘<samp>-O</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>total</samp>’</dt>
+<dd><p>‘<samp>-c</samp>’ in <code>du</code>.
+</p>
+</dd>
+<dt>‘<samp>touch</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>make</code>,
<code>ranlib</code>, and <code>recode</code>.
+</p>
+</dd>
+<dt>‘<samp>trace</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>traditional</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>hello</code>;
+‘<samp>-W traditional</samp>’ in <code>gawk</code>;
+‘<samp>-G</samp>’ in <code>ed</code>, <code>m4</code>, and
<code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>tty</samp>’</dt>
+<dd><p>Used in GDB.
+</p>
+</dd>
+<dt>‘<samp>typedefs</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>typedefs-and-c++</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>typeset-mode</samp>’</dt>
+<dd><p>‘<samp>-t</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>uncompress</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>unconditional</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>cpio</code>.
+</p>
+</dd>
+<dt>‘<samp>undefine</samp>’</dt>
+<dd><p>‘<samp>-U</samp>’ in <code>m4</code>.
+</p>
+</dd>
+<dt>‘<samp>undefined-only</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>nm</code>.
+</p>
+</dd>
+<dt>‘<samp>update</samp>’</dt>
+<dd><p>‘<samp>-u</samp>’ in <code>cp</code>, <code>ctags</code>,
<code>mv</code>, <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>usage</samp>’</dt>
+<dd><p>Used in <code>gawk</code>; same as ‘<samp>--help</samp>’.
+</p>
+</dd>
+<dt>‘<samp>uuencode</samp>’</dt>
+<dd><p>‘<samp>-B</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>vanilla-operation</samp>’</dt>
+<dd><p>‘<samp>-V</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>verbose</samp>’</dt>
+<dd><p>Print more information about progress. Many programs support this.
+</p>
+</dd>
+<dt>‘<samp>verify</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>version</samp>’</dt>
+<dd><p>Print the version number.
+</p>
+</dd>
+<dt>‘<samp>version-control</samp>’</dt>
+<dd><p>‘<samp>-V</samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
+</p>
+</dd>
+<dt>‘<samp>vgrind</samp>’</dt>
+<dd><p>‘<samp>-v</samp>’ in <code>ctags</code>.
+</p>
+</dd>
+<dt>‘<samp>volume</samp>’</dt>
+<dd><p>‘<samp>-V</samp>’ in <code>tar</code>.
+</p>
+</dd>
+<dt>‘<samp>what-if</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+</p>
+</dd>
+<dt>‘<samp>whole-size-limit</samp>’</dt>
+<dd><p>‘<samp>-l</samp>’ in <code>shar</code>.
+</p>
+</dd>
+<dt>‘<samp>width</samp>’</dt>
+<dd><p>‘<samp>-w</samp>’ in <code>ls</code> and <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>word-regexp</samp>’</dt>
+<dd><p>‘<samp>-W</samp>’ in <code>ptx</code>.
+</p>
+</dd>
+<dt>‘<samp>writable</samp>’</dt>
+<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+</p>
+</dd>
+<dt>‘<samp>zeros</samp>’</dt>
+<dd><p>‘<samp>-z</samp>’ in <code>gprof</code>.
+</p></dd>
+</dl>
- <br><dt>‘<samp><span
class="samp">statistics</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">stdin-file-list</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">stop</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">strict</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">strip</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>install</code>.
-
- <br><dt>‘<samp><span
class="samp">strip-all</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">strip-debug</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>strip</code>.
-
- <br><dt>‘<samp><span
class="samp">submitter</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">suffix</span></samp>’<dd>‘<samp><span
class="samp">-S</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
-
- <br><dt>‘<samp><span
class="samp">suffix-format</span></samp>’<dd>‘<samp><span
class="samp">-b</span></samp>’ in <code>csplit</code>.
-
- <br><dt>‘<samp><span
class="samp">sum</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>gprof</code>.
-
- <br><dt>‘<samp><span
class="samp">summarize</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">symbolic</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>ln</code>.
-
- <br><dt>‘<samp><span
class="samp">symbols</span></samp>’<dd>Used in GDB and
<code>objdump</code>.
-
- <br><dt>‘<samp><span
class="samp">synclines</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">sysname</span></samp>’<dd>‘<samp><span
class="samp">-s</span></samp>’ in <code>uname</code>.
-
- <br><dt>‘<samp><span
class="samp">tabs</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>expand</code> and
<code>unexpand</code>.
-
- <br><dt>‘<samp><span
class="samp">tabsize</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>ls</code>.
-
- <br><dt>‘<samp><span
class="samp">terminal</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>tput</code> and <code>ul</code>.
-‘<samp><span class="samp">-t</span></samp>’ in <code>wdiff</code>.
-
- <br><dt>‘<samp><span
class="samp">text</span></samp>’<dd>‘<samp><span
class="samp">-a</span></samp>’ in <code>diff</code>.
-
- <br><dt>‘<samp><span
class="samp">text-files</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span class="samp">time</span></samp>’<dd>Used
in <code>ls</code> and <code>touch</code>.
-
- <br><dt>‘<samp><span
class="samp">timeout</span></samp>’<dd>Specify how long to wait before
giving up on some operation.
-
- <br><dt>‘<samp><span
class="samp">to-stdout</span></samp>’<dd>‘<samp><span
class="samp">-O</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">total</span></samp>’<dd>‘<samp><span
class="samp">-c</span></samp>’ in <code>du</code>.
-
- <br><dt>‘<samp><span
class="samp">touch</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>make</code>, <code>ranlib</code>,
and <code>recode</code>.
-
- <br><dt>‘<samp><span
class="samp">trace</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">traditional</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>hello</code>;
-‘<samp><span class="samp">-W traditional</span></samp>’ in
<code>gawk</code>;
-‘<samp><span class="samp">-G</span></samp>’ in <code>ed</code>,
<code>m4</code>, and <code>ptx</code>.
-
- <br><dt>‘<samp><span class="samp">tty</span></samp>’<dd>Used
in GDB.
-
- <br><dt>‘<samp><span
class="samp">typedefs</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">typedefs-and-c++</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">typeset-mode</span></samp>’<dd>‘<samp><span
class="samp">-t</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">uncompress</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">unconditional</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>cpio</code>.
-
- <br><dt>‘<samp><span
class="samp">undefine</span></samp>’<dd>‘<samp><span
class="samp">-U</span></samp>’ in <code>m4</code>.
-
- <br><dt>‘<samp><span
class="samp">undefined-only</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>nm</code>.
-
- <br><dt>‘<samp><span
class="samp">update</span></samp>’<dd>‘<samp><span
class="samp">-u</span></samp>’ in <code>cp</code>, <code>ctags</code>,
<code>mv</code>, <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">usage</span></samp>’<dd>Used in <code>gawk</code>; same as
‘<samp><span class="samp">--help</span></samp>’.
-
- <br><dt>‘<samp><span
class="samp">uuencode</span></samp>’<dd>‘<samp><span
class="samp">-B</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">vanilla-operation</span></samp>’<dd>‘<samp><span
class="samp">-V</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">verbose</span></samp>’<dd>Print more information about
progress. Many programs support this.
-
- <br><dt>‘<samp><span
class="samp">verify</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">version</span></samp>’<dd>Print the version number.
-
- <br><dt>‘<samp><span
class="samp">version-control</span></samp>’<dd>‘<samp><span
class="samp">-V</span></samp>’ in <code>cp</code>, <code>ln</code>,
<code>mv</code>.
-
- <br><dt>‘<samp><span
class="samp">vgrind</span></samp>’<dd>‘<samp><span
class="samp">-v</span></samp>’ in <code>ctags</code>.
-
- <br><dt>‘<samp><span
class="samp">volume</span></samp>’<dd>‘<samp><span
class="samp">-V</span></samp>’ in <code>tar</code>.
-
- <br><dt>‘<samp><span
class="samp">what-if</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>make</code>.
-
- <br><dt>‘<samp><span
class="samp">whole-size-limit</span></samp>’<dd>‘<samp><span
class="samp">-l</span></samp>’ in <code>shar</code>.
-
- <br><dt>‘<samp><span
class="samp">width</span></samp>’<dd>‘<samp><span
class="samp">-w</span></samp>’ in <code>ls</code> and <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">word-regexp</span></samp>’<dd>‘<samp><span
class="samp">-W</span></samp>’ in <code>ptx</code>.
-
- <br><dt>‘<samp><span
class="samp">writable</span></samp>’<dd>‘<samp><span
class="samp">-T</span></samp>’ in <code>who</code>.
+<hr>
+<div class="header">
+<p>
+Next: <a href="OID-Allocations.html#OID-Allocations" accesskey="n"
rel="next">OID Allocations</a>, Previous: <a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
accesskey="p" rel="previous">Dynamic Plug-In Interfaces</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
- <br><dt>‘<samp><span
class="samp">zeros</span></samp>’<dd>‘<samp><span
class="samp">-z</span></samp>’ in <code>gprof</code>.
-</dl>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Preface.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Preface.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Preface.html 8 Apr 2012 00:23:55 -0000 1.54
+++ standards/html_node/Preface.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Preface - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="index.html#Top" title="Top">
-<link rel="next" href="Legal-Issues.html#Legal-Issues" title="Legal Issues">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,30 +11,60 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Preface</title>
+
+<meta name="description" content="GNU Coding Standards: Preface">
+<meta name="keywords" content="GNU Coding Standards: Preface">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Legal-Issues.html#Legal-Issues" rel="next" title="Legal Issues">
+<link href="index.html#Top" rel="previous" title="Top">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Preface"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Legal-Issues.html#Legal-Issues">Legal Issues</a>,
-Previous: <a rel="previous" accesskey="p" href="index.html#Top">Top</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="Legal-Issues.html#Legal-Issues" accesskey="n" rel="next">Legal
Issues</a>, Previous: <a href="index.html#Top" accesskey="p"
rel="previous">Top</a>, Up: <a href="index.html#Top" accesskey="u"
rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="About-the-GNU-Coding-Standards"></a>
<h2 class="chapter">1 About the GNU Coding Standards</h2>
<p>The GNU Coding Standards were written by Richard Stallman and other GNU
@@ -53,50 +74,66 @@
programs written in C, but many of the rules and principles are useful
even if you write in another programming language. The rules often
state reasons for writing in a certain way.
-
- <p><a
name="index-where-to-obtain-_0040code_007bstandards_002etexi_007d-1"></a><a
name="index-downloading-this-manual-2"></a>If you did not obtain this file
directly from the GNU project and
+</p>
+<a name="index-where-to-obtain-standards_002etexi"></a>
+<a name="index-downloading-this-manual"></a>
+<p>If you did not obtain this file directly from the GNU project and
recently, please check for a newer version. You can get the GNU
Coding Standards from the GNU web server in many
different formats, including the Texinfo source, PDF, HTML, DVI, plain
text, and more, at: <a
href="http://www.gnu.org/prep/standards/";>http://www.gnu.org/prep/standards/</a>.
-
- <p>If you are maintaining an official GNU package, in addition to this
+</p>
+<p>If you are maintaining an official GNU package, in addition to this
document, please read and follow the GNU maintainer information
-(see <a href="../maintain/index.html#Top">Contents</a>).
-
- <p><a
name="index-g_t_0040code_007bgnustandards_002dcommit_0040_0040gnu_002eorg_007d-mailing-list-3"></a>If
you want to receive diffs for every change to these GNU documents,
+(see <a
href="http://www.gnu.org/prep/maintain/html_node/index.html#Top";>Contents</a>
in <cite>Information for Maintainers of GNU
+Software</cite>).
+</p>
+<a name="index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"></a>
+<p>If you want to receive diffs for every change to these GNU documents,
join the mailing list <code>address@hidden</code>, via the web
interface at
<a
href="http://lists.gnu.org/mailman/listinfo/gnustandards-commit";>http://lists.gnu.org/mailman/listinfo/gnustandards-commit</a>.
Archives are also available there.
-
- <p><a
name="index-g_t_0040code_007bbug_002dstandards_0040_0040gnu_002eorg_007d-email-address-4"></a><a
name="index-Savannah-repository-for-gnustandards-5"></a><a
name="index-gnustandards-project-repository-6"></a>Please send corrections or
suggestions for this document to
+</p>
+<a name="index-bug_002dstandards_0040gnu_002eorg-email-address"></a>
+<a name="index-Savannah-repository-for-gnustandards"></a>
+<a name="index-gnustandards-project-repository"></a>
+<p>Please send corrections or suggestions for this document to
<a href="mailto:address@hidden";>address@hidden</a>. If you make a suggestion,
please
include a suggested new wording for it, to help us consider the
suggestion efficiently. We prefer a context diff to the Texinfo
-source, but if that's difficult for you, you can make a context diff
+source, but if that’s difficult for you, you can make a context diff
for some other version of this document, or propose it in any way that
makes it clear. The source repository for this document can be found
at <a
href="http://savannah.gnu.org/projects/gnustandards";>http://savannah.gnu.org/projects/gnustandards</a>.
-
- <p>These standards cover the minimum of what is important when writing a
+</p>
+<p>These standards cover the minimum of what is important when writing a
GNU package. Likely, the need for additional standards will come up.
Sometimes, you might suggest that such standards be added to this
document. If you think your standards would be generally useful, please
do suggest them.
-
- <p>You should also set standards for your package on many questions not
+</p>
+<p>You should also set standards for your package on many questions not
addressed or not firmly specified here. The most important point is to
be self-consistent—try to stick to the conventions you pick, and try
to document them as much as possible. That way, your program will be
more maintainable by others.
-
- <p>The GNU Hello program serves as an example of how to follow the GNU
+</p>
+<p>The GNU Hello program serves as an example of how to follow the GNU
coding standards for a trivial program.
<a
href="http://www.gnu.org/software/hello/hello.html";>http://www.gnu.org/software/hello/hello.html</a>.
-
- <p>This release of the GNU Coding Standards was last updated
+</p>
+<p>This release of the GNU Coding Standards was last updated
April 7, 2012.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Legal-Issues.html#Legal-Issues" accesskey="n" rel="next">Legal
Issues</a>, Previous: <a href="index.html#Top" accesskey="p"
rel="previous">Top</a>, Up: <a href="index.html#Top" accesskey="u"
rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Printed-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Printed-Manuals.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Printed-Manuals.html 8 Apr 2012 00:23:55 -0000
1.54
+++ standards/html_node/Printed-Manuals.html 7 May 2012 00:48:09 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Printed Manuals - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="Manual-Credits.html#Manual-Credits" title="Manual
Credits">
-<link rel="next" href="NEWS-File.html#NEWS-File" title="NEWS File">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,30 +11,60 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Printed Manuals</title>
+
+<meta name="description" content="GNU Coding Standards: Printed Manuals">
+<meta name="keywords" content="GNU Coding Standards: Printed Manuals">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="NEWS-File.html#NEWS-File" rel="next" title="NEWS File">
+<link href="Manual-Credits.html#Manual-Credits" rel="previous" title="Manual
Credits">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Printed-Manuals"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="NEWS-File.html#NEWS-File">NEWS
File</a>,
-Previous: <a rel="previous" accesskey="p"
href="Manual-Credits.html#Manual-Credits">Manual Credits</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Next: <a href="NEWS-File.html#NEWS-File" accesskey="n" rel="next">NEWS
File</a>, Previous: <a href="Manual-Credits.html#Manual-Credits" accesskey="p"
rel="previous">Manual Credits</a>, Up: <a
href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Printed-Manuals-1"></a>
<h3 class="section">6.6 Printed Manuals</h3>
<p>The FSF publishes some GNU manuals in printed form. To encourage sales
@@ -53,9 +73,12 @@
information for getting it—for instance, with a link to the page
<a
href="http://www.gnu.org/order/order.html";>http://www.gnu.org/order/order.html</a>.
This should not be included
in the printed manual, though, because there it is redundant.
-
- <p>It is also useful to explain in the on-line forms of the manual how the
+</p>
+<p>It is also useful to explain in the on-line forms of the manual how the
user can print out the manual from the sources.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Program-Behavior.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Program-Behavior.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Program-Behavior.html 8 Apr 2012 00:23:55 -0000
1.54
+++ standards/html_node/Program-Behavior.html 7 May 2012 00:48:09 -0000
1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Program Behavior - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="Design-Advice.html#Design-Advice" title="Design Advice">
-<link rel="next" href="Writing-C.html#Writing-C" title="Writing C">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,51 +11,96 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Program Behavior</title>
+
+<meta name="description" content="GNU Coding Standards: Program Behavior">
+<meta name="keywords" content="GNU Coding Standards: Program Behavior">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Non_002dGNU-Standards.html#Non_002dGNU-Standards" rel="next"
title="Non-GNU Standards">
+<link href="Conditional-Compilation.html#Conditional-Compilation"
rel="previous" title="Conditional Compilation">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Program-Behavior"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="Writing-C.html#Writing-C">Writing
C</a>,
-Previous: <a rel="previous" accesskey="p"
href="Design-Advice.html#Design-Advice">Design Advice</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="Writing-C.html#Writing-C" accesskey="n" rel="next">Writing
C</a>, Previous: <a href="Design-Advice.html#Design-Advice" accesskey="p"
rel="previous">Design Advice</a>, Up: <a href="index.html#Top" accesskey="u"
rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Program-Behavior-for-All-Programs"></a>
<h2 class="chapter">4 Program Behavior for All Programs</h2>
<p>This chapter describes conventions for writing robust
software. It also describes general standards for error messages, the
command line interface, and how libraries should behave.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a
href="Non_002dGNU-Standards.html#Non_002dGNU-Standards" accesskey="1">Non-GNU
Standards</a>:</td><td> </td><td align="left" valign="top">We
consider standards such as POSIX;
+ we don’t "obey" them.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Semantics.html#Semantics"
accesskey="2">Semantics</a>:</td><td> </td><td align="left"
valign="top">Writing robust programs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Libraries.html#Libraries"
accesskey="3">Libraries</a>:</td><td> </td><td align="left"
valign="top">Library behavior.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Errors.html#Errors"
accesskey="4">Errors</a>:</td><td> </td><td align="left"
valign="top">Formatting error messages.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="User-Interfaces.html#User-Interfaces" accesskey="5">User
Interfaces</a>:</td><td> </td><td align="left"
valign="top">Standards about interfaces generally.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="6">Graphical
Interfaces</a>:</td><td> </td><td align="left"
valign="top">Standards for graphical interfaces.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="7">Command-Line Interfaces</a>:</td><td> </td><td
align="left" valign="top">Standards for command line interfaces.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
accesskey="8">Dynamic Plug-In Interfaces</a>:</td><td> </td><td
align="left" valign="top">Standards for dynamic plug-in interfaces.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Option-Table.html#Option-Table" accesskey="9">Option
Table</a>:</td><td> </td><td align="left" valign="top">Table of long
options.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="OID-Allocations.html#OID-Allocations">OID
Allocations</a>:</td><td> </td><td align="left" valign="top">Table
of OID slots for GNU.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Memory-Usage.html#Memory-Usage">Memory
Usage</a>:</td><td> </td><td align="left" valign="top">When and how
to care about memory needs.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="File-Usage.html#File-Usage">File Usage</a>:</td><td> </td><td
align="left" valign="top">Which files to use, and where.
+</td></tr>
+</table>
+
-<ul class="menu">
-<li><a accesskey="1"
href="Non_002dGNU-Standards.html#Non_002dGNU-Standards">Non-GNU Standards</a>:
We consider standards such as POSIX;
- we don't "obey" them.
-<li><a accesskey="2" href="Semantics.html#Semantics">Semantics</a>:
Writing robust programs.
-<li><a accesskey="3" href="Libraries.html#Libraries">Libraries</a>:
Library behavior.
-<li><a accesskey="4" href="Errors.html#Errors">Errors</a>:
Formatting error messages.
-<li><a accesskey="5" href="User-Interfaces.html#User-Interfaces">User
Interfaces</a>: Standards about interfaces generally.
-<li><a accesskey="6"
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical Interfaces</a>:
Standards for graphical interfaces.
-<li><a accesskey="7"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a>: Standards for command line interfaces.
-<li><a accesskey="8"
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">Dynamic
Plug-In Interfaces</a>: Standards for dynamic plug-in interfaces.
-<li><a accesskey="9" href="Option-Table.html#Option-Table">Option Table</a>:
Table of long options.
-<li><a href="OID-Allocations.html#OID-Allocations">OID Allocations</a>:
Table of OID slots for GNU.
-<li><a href="Memory-Usage.html#Memory-Usage">Memory Usage</a>:
When and how to care about memory needs.
-<li><a href="File-Usage.html#File-Usage">File Usage</a>:
Which files to use, and where.
-</ul>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Quote-Characters.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Quote-Characters.html,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -b -r1.46 -r1.47
--- standards/html_node/Quote-Characters.html 8 Apr 2012 00:23:55 -0000
1.46
+++ standards/html_node/Quote-Characters.html 7 May 2012 00:48:09 -0000
1.47
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Quote Characters - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="Character-Set.html#Character-Set" title="Character Set">
-<link rel="next" href="Mmap.html#Mmap" title="Mmap">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,64 +11,107 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Quote Characters</title>
+
+<meta name="description" content="GNU Coding Standards: Quote Characters">
+<meta name="keywords" content="GNU Coding Standards: Quote Characters">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Mmap.html#Mmap" rel="next" title="Mmap">
+<link href="Character-Set.html#Character-Set" rel="previous" title="Character
Set">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Quote-Characters"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="Mmap.html#Mmap">Mmap</a>,
-Previous: <a rel="previous" accesskey="p"
href="Character-Set.html#Character-Set">Character Set</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="Mmap.html#Mmap" accesskey="n" rel="next">Mmap</a>, Previous: <a
href="Character-Set.html#Character-Set" accesskey="p" rel="previous">Character
Set</a>, Up: <a href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing
C</a> [<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Quote-Characters-1"></a>
<h3 class="section">5.10 Quote Characters</h3>
+<a name="index-quote-characters"></a>
+<a name="index-locale_002dspecific-quote-characters"></a>
+<a name="index-left-quote"></a>
+<a name="index-right-quote"></a>
+<a name="index-opening-quote"></a>
+<a name="index-single-quote"></a>
+<a name="index-double-quote"></a>
+<a name="index-grave-accent"></a>
-<p><a name="index-quote-characters-122"></a><a
name="index-locale_002dspecific-quote-characters-123"></a><a
name="index-left-quote-124"></a><a name="index-right-quote-125"></a><a
name="index-opening-quote-126"></a><a name="index-single-quote-127"></a><a
name="index-double-quote-128"></a><a name="index-grave-accent-129"></a>
-
- <p>In the C locale, the output of GNU programs should stick to plain
+<p>In the C locale, the output of GNU programs should stick to plain
ASCII for quotation characters in messages to users: preferably 0x22
-(‘<samp><span class="samp">"</span></samp>’) or 0x27
(‘<samp><span class="samp">'</span></samp>’) for both opening and
closing quotes.
-Although GNU programs traditionally used 0x60 (‘<samp><span
class="samp">`</span></samp>’) for opening
-and 0x27 (‘<samp><span class="samp">'</span></samp>’) for closing
quotes, nowadays quotes ‘<samp><span class="samp">`like
-this'</span></samp>’ are typically rendered asymmetrically, so quoting
‘<samp><span class="samp">"like
-this"</span></samp>’ or ‘<samp><span class="samp">'like
this'</span></samp>’ typically looks better.
-
- <p>It is ok, but not required, for GNU programs to generate
+(‘<samp>"</samp>’) or 0x27 (‘<samp>'</samp>’) for
both opening and closing quotes.
+Although GNU programs traditionally used 0x60 (‘<samp>`</samp>’)
for opening
+and 0x27 (‘<samp>'</samp>’) for closing quotes, nowadays quotes
‘<samp>`like
+this'</samp>’ are typically rendered asymmetrically, so quoting
‘<samp>"like
+this"</samp>’ or ‘<samp>'like this'</samp>’ typically
looks better.
+</p>
+<p>It is ok, but not required, for GNU programs to generate
locale-specific quotes in non-C locales. For example:
-
-<pre class="example"> printf (gettext ("Processing file '%s'..."), file);
-</pre>
- <p class="noindent">Here, a French translation might cause
<code>gettext</code> to return the
-string <code>"Traitement de fichier
-‹ %s ›..."</code>, yielding quotes
+</p>
+<div class="example">
+<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+</pre></div>
+
+<p>Here, a French translation might cause <code>gettext</code> to return the
+string <code>"Traitement de fichier
+‹ %s ›..."</code>, yielding quotes
more appropriate for a French locale.
-
- <p>Sometimes a program may need to use opening and closing quotes
+</p>
+<p>Sometimes a program may need to use opening and closing quotes
directly. By convention, <code>gettext</code> translates the string
-‘<samp><span class="samp">"`"</span></samp>’ to the opening quote
and the string ‘<samp><span class="samp">"'"</span></samp>’ to the
+‘<samp>"`"</samp>’ to the opening quote and the string
‘<samp>"'"</samp>’ to the
closing quote, and a program can use these translations. Generally,
though, it is better to translate quote characters in the context of
longer strings.
-
- <p>If the output of your program is ever likely to be parsed by another
+</p>
+<p>If the output of your program is ever likely to be parsed by another
program, it is good to provide an option that makes this parsing
reliable. For example, you could escape special characters using
conventions from the C language or the Bourne shell. See for example
-the option <samp><span class="option">--quoting-style</span></samp> of GNU
<code>ls</code>.
+the option ‘<samp>--quoting-style</samp>’ of GNU <code>ls</code>.
+</p>
+
+
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Reading-Non_002dFree-Code.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Reading-Non_002dFree-Code.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Reading-Non_002dFree-Code.html 8 Apr 2012 00:23:55
-0000 1.54
+++ standards/html_node/Reading-Non_002dFree-Code.html 7 May 2012 00:48:09
-0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Reading Non-Free Code - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Legal-Issues.html#Legal-Issues" title="Legal Issues">
-<link rel="next" href="Contributions.html#Contributions" title="Contributions">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,62 +11,102 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Reading Non-Free Code</title>
+
+<meta name="description" content="GNU Coding Standards: Reading Non-Free Code">
+<meta name="keywords" content="GNU Coding Standards: Reading Non-Free Code">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Legal-Issues.html#Legal-Issues" rel="up" title="Legal Issues">
+<link href="Contributions.html#Contributions" rel="next" title="Contributions">
+<link href="Legal-Issues.html#Legal-Issues" rel="previous" title="Legal
Issues">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
-<a name="Reading-Non-Free-Code"></a>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Reading-Non_002dFree-Code"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Contributions.html#Contributions">Contributions</a>,
-Up: <a rel="up" accesskey="u" href="Legal-Issues.html#Legal-Issues">Legal
Issues</a>
-<hr>
+Next: <a href="Contributions.html#Contributions" accesskey="n"
rel="next">Contributions</a>, Up: <a href="Legal-Issues.html#Legal-Issues"
accesskey="u" rel="up">Legal Issues</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Referring-to-Proprietary-Programs"></a>
<h3 class="section">2.1 Referring to Proprietary Programs</h3>
+<a name="index-proprietary-programs"></a>
+<a name="index-avoiding-proprietary-code"></a>
-<p><a name="index-proprietary-programs-8"></a><a
name="index-avoiding-proprietary-code-9"></a>
-Don't in any circumstances refer to Unix source code for or during
+<p>Don’t in any circumstances refer to Unix source code for or during
your work on GNU! (Or to any other proprietary programs.)
-
- <p>If you have a vague recollection of the internals of a Unix program,
-this does not absolutely mean you can't write an imitation of it, but
+</p>
+<p>If you have a vague recollection of the internals of a Unix program,
+this does not absolutely mean you can’t write an imitation of it, but
do try to organize the imitation internally along different lines,
because this is likely to make the details of the Unix version
irrelevant and dissimilar to your results.
-
- <p>For example, Unix utilities were generally optimized to minimize
+</p>
+<p>For example, Unix utilities were generally optimized to minimize
memory use; if you go for speed instead, your program will be very
different. You could keep the entire input file in memory and scan it
there instead of using stdio. Use a smarter algorithm discovered more
recently than the Unix program. Eliminate use of temporary files. Do
it in one pass instead of two (we did this in the assembler).
-
- <p>Or, on the contrary, emphasize simplicity instead of speed. For some
-applications, the speed of today's computers makes simpler algorithms
+</p>
+<p>Or, on the contrary, emphasize simplicity instead of speed. For some
+applications, the speed of today’s computers makes simpler algorithms
adequate.
-
- <p>Or go for generality. For example, Unix programs often have static
+</p>
+<p>Or go for generality. For example, Unix programs often have static
tables or fixed-size strings, which make for arbitrary limits; use
dynamic allocation instead. Make sure your program handles NULs and
other funny characters in the input files. Add a programming language
for extensibility and write part of the program in that language.
-
- <p>Or turn some parts of the program into independently usable libraries.
+</p>
+<p>Or turn some parts of the program into independently usable libraries.
Or use a simple garbage collector instead of tracking precisely when
to free memory, or use a new GNU facility such as obstacks.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Contributions.html#Contributions" accesskey="n"
rel="next">Contributions</a>, Up: <a href="Legal-Issues.html#Legal-Issues"
accesskey="u" rel="up">Legal Issues</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Reading-other-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Reading-other-Manuals.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Reading-other-Manuals.html 8 Apr 2012 00:23:55
-0000 1.54
+++ standards/html_node/Reading-other-Manuals.html 7 May 2012 00:48:09
-0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Reading other Manuals - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Documentation.html#Documentation" title="Documentation">
-<link rel="prev" href="Man-Pages.html#Man-Pages" title="Man Pages">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,35 +11,66 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Reading other Manuals</title>
+
+<meta name="description" content="GNU Coding Standards: Reading other Manuals">
+<meta name="keywords" content="GNU Coding Standards: Reading other Manuals">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Documentation.html#Documentation" rel="up" title="Documentation">
+<link href="Managing-Releases.html#Managing-Releases" rel="next"
title="Managing Releases">
+<link href="Man-Pages.html#Man-Pages" rel="previous" title="Man Pages">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Reading-other-Manuals"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Man-Pages.html#Man-Pages">Man Pages</a>,
-Up: <a rel="up" accesskey="u"
href="Documentation.html#Documentation">Documentation</a>
-<hr>
+Previous: <a href="Man-Pages.html#Man-Pages" accesskey="p" rel="previous">Man
Pages</a>, Up: <a href="Documentation.html#Documentation" accesskey="u"
rel="up">Documentation</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Reading-other-Manuals-1"></a>
<h3 class="section">6.10 Reading other Manuals</h3>
<p>There may be non-free books or documentation files that describe the
program you are documenting.
-
- <p>It is ok to use these documents for reference, just as the author of a
+</p>
+<p>It is ok to use these documents for reference, just as the author of a
new algebra textbook can read other books on algebra. A large portion
of any non-fiction book consists of facts, in this case facts about how
a certain program works, and these facts are necessarily the same for
@@ -56,6 +78,9 @@
outline structure, wording, tables or examples from preexisting non-free
documentation. Copying from free documentation may be ok; please check
with the FSF about the individual case.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/References.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/References.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/References.html 8 Apr 2012 00:23:55 -0000 1.54
+++ standards/html_node/References.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>References - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="Managing-Releases.html#Managing-Releases"
title="Managing Releases">
-<link rel="next"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
title="GNU Free Documentation License">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,104 +11,134 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: References</title>
+
+<meta name="description" content="GNU Coding Standards: References">
+<meta name="keywords" content="GNU Coding Standards: References">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
rel="next" title="GNU Free Documentation License">
+<link href="Releases.html#Releases" rel="previous" title="Releases">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="References"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</a>,
-Previous: <a rel="previous" accesskey="p"
href="Managing-Releases.html#Managing-Releases">Managing Releases</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a
href="Managing-Releases.html#Managing-Releases" accesskey="p"
rel="previous">Managing Releases</a>, Up: <a href="index.html#Top"
accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="References-to-Non_002dFree-Software-and-Documentation"></a>
<h2 class="chapter">8 References to Non-Free Software and Documentation</h2>
+<a name="index-references-to-non_002dfree-material"></a>
-<p><a name="index-references-to-non_002dfree-material-164"></a>
-A GNU program should not recommend, promote, or grant legitimacy to
+<p>A GNU program should not recommend, promote, or grant legitimacy to
the use of any non-free program. Proprietary software is a social and
ethical problem, and our aim is to put an end to that problem. We
-can't stop some people from writing proprietary programs, or stop
+can’t stop some people from writing proprietary programs, or stop
other people from using them, but we can and should refuse to
advertise them to new potential customers, or to give the public the
idea that their existence is ethical.
-
- <p>The GNU definition of free software is found on the GNU web site at
+</p>
+<p>The GNU definition of free software is found on the GNU web site at
<a
href="http://www.gnu.org/philosophy/free-sw.html";>http://www.gnu.org/philosophy/free-sw.html</a>,
and the definition
of free documentation is found at
<a
href="http://www.gnu.org/philosophy/free-doc.html";>http://www.gnu.org/philosophy/free-doc.html</a>.
The terms “free”
and “non-free”, used in this document, refer to those definitions.
-
- <p>A list of important licenses and whether they qualify as free is in
+</p>
+<p>A list of important licenses and whether they qualify as free is in
<a
href="http://www.gnu.org/licenses/license-list.html";>http://www.gnu.org/licenses/license-list.html</a>.
If it is not
clear whether a license qualifies as free, please ask the GNU Project
by writing to <a href="mailto:address@hidden";>address@hidden</a>. We will
answer, and if the
license is an important one, we will add it to the list.
-
- <p>When a non-free program or system is well known, you can mention it in
+</p>
+<p>When a non-free program or system is well known, you can mention it in
passing—that is harmless, since users who might want to use it
probably already know about it. For instance, it is fine to explain
how to build your package on top of some widely used non-free
operating system, or how to use it together with some widely used
non-free program.
-
- <p>However, you should give only the necessary information to help those
+</p>
+<p>However, you should give only the necessary information to help those
who already use the non-free program to use your program with
-it—don't give, or refer to, any further information about the
-proprietary program, and don't imply that the proprietary program
+it—don’t give, or refer to, any further information about the
+proprietary program, and don’t imply that the proprietary program
enhances your program, or that its existence is in any way a good
thing. The goal should be that people already using the proprietary
program will get the advice they need about how to use your free
-program with it, while people who don't already use the proprietary
+program with it, while people who don’t already use the proprietary
program will not see anything likely to lead them to take an interest
in it.
-
- <p>If a non-free program or system is obscure in your program's domain,
+</p>
+<p>If a non-free program or system is obscure in your program’s domain,
your program should not mention or support it at all, since doing so
would tend to popularize the non-free program more than it popularizes
your program. (You cannot hope to find many additional users for your
program among the users of Foobar, if the existence of Foobar is not
generally known among people who might want to use your program.)
-
- <p>Sometimes a program is free software in itself but depends on a
+</p>
+<p>Sometimes a program is free software in itself but depends on a
non-free platform in order to run. For instance, many Java programs
depend on some non-free Java libraries. To recommend or promote such
a program is to promote the other programs it needs. This is why we
are careful about listing Java programs in the Free Software
-Directory: we don't want to promote the non-free Java libraries.
-
- <p>We hope this particular problem with Java will be gone by and by, as
+Directory: we don’t want to promote the non-free Java libraries.
+</p>
+<p>We hope this particular problem with Java will be gone by and by, as
we replace the remaining non-free standard Java libraries with free
-software, but the general principle will remain the same: don't
+software, but the general principle will remain the same: don’t
recommend, promote or legitimize programs that depend on non-free
software to run.
-
- <p>Some free programs strongly encourage the use of non-free software. A
-typical example is <samp><span class="command">mplayer</span></samp>. It is
free software in itself,
+</p>
+<p>Some free programs strongly encourage the use of non-free software. A
+typical example is <code>mplayer</code>. It is free software in itself,
and the free code can handle some kinds of files. However,
-<samp><span class="command">mplayer</span></samp> recommends use of non-free
codecs for other kinds of
-files, and users that install <samp><span
class="command">mplayer</span></samp> are very likely to
-install those codecs along with it. To recommend <samp><span
class="command">mplayer</span></samp>
+<code>mplayer</code> recommends use of non-free codecs for other kinds of
+files, and users that install <code>mplayer</code> are very likely to
+install those codecs along with it. To recommend <code>mplayer</code>
is, in effect, to promote use of the non-free codecs.
-
- <p>Thus, you should not recommend programs that strongly encourage the
+</p>
+<p>Thus, you should not recommend programs that strongly encourage the
use of non-free software. This is why we do not list
-<samp><span class="command">mplayer</span></samp> in the Free Software
Directory.
-
- <p>A GNU package should not refer the user to any non-free documentation
+<code>mplayer</code> in the Free Software Directory.
+</p>
+<p>A GNU package should not refer the user to any non-free documentation
for free software. Free documentation that can be included in free
operating systems is essential for completing the GNU system, or any
free operating system, so encouraging it is a priority; to recommend
@@ -125,32 +146,40 @@
impetus for the community to produce documentation that we can
include. So GNU packages should never recommend non-free
documentation.
-
- <p>By contrast, it is ok to refer to journal articles and textbooks in
+</p>
+<p>By contrast, it is ok to refer to journal articles and textbooks in
the comments of a program for explanation of how it functions, even
-though they are non-free. This is because we don't include such
+though they are non-free. This is because we don’t include such
things in the GNU system even if they are free—they are outside the
scope of what a software distribution needs to include.
-
- <p>Referring to a web site that describes or recommends a non-free
+</p>
+<p>Referring to a web site that describes or recommends a non-free
program is promoting that program, so please do not make links to (or
mention by name) web sites that contain such material. This policy is
relevant particularly for the web pages for a GNU package.
-
- <p>Following links from nearly any web site can lead eventually to
+</p>
+<p>Following links from nearly any web site can lead eventually to
non-free software; this is inherent in the nature of the web. So it
makes no sense to criticize a site for having such links. As long as
the site does not itself recommend a non-free program, there is no
need to consider the question of the sites that it links to for other
reasons.
-
- <p>Thus, for example, you should not refer to AT&T's web site if that
-recommends AT&T's non-free software packages; you should not refer to
-a site that links to AT&T's site presenting it as a place to get some
+</p>
+<p>Thus, for example, you should not refer to AT&T’s web site if that
+recommends AT&T’s non-free software packages; you should not refer to
+a site that links to AT&T’s site presenting it as a place to get some
non-free program, because that link recommends and legitimizes the
-non-free program. However, that a site contains a link to AT&T's web
+non-free program. However, that a site contains a link to AT&T’s web
site for some other purpose (such as long-distance telephone service)
is not an objection against it.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a
href="Managing-Releases.html#Managing-Releases" accesskey="p"
rel="previous">Managing Releases</a>, Up: <a href="index.html#Top"
accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Releases.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Releases.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Releases.html 8 Apr 2012 00:23:56 -0000 1.54
+++ standards/html_node/Releases.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Releases - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Managing-Releases.html#Managing-Releases" title="Managing
Releases">
-<link rel="prev" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,63 +11,95 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Releases</title>
+
+<meta name="description" content="GNU Coding Standards: Releases">
+<meta name="keywords" content="GNU Coding Standards: Releases">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Managing-Releases.html#Managing-Releases" rel="up" title="Managing
Releases">
+<link href="References.html#References" rel="next" title="References">
+<link href="Install-Command-Categories.html#Install-Command-Categories"
rel="previous" title="Install Command Categories">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Releases"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>,
-Up: <a rel="up" accesskey="u"
href="Managing-Releases.html#Managing-Releases">Managing Releases</a>
-<hr>
+Previous: <a href="Makefile-Conventions.html#Makefile-Conventions"
accesskey="p" rel="previous">Makefile Conventions</a>, Up: <a
href="Managing-Releases.html#Managing-Releases" accesskey="u" rel="up">Managing
Releases</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Making-Releases"></a>
<h3 class="section">7.3 Making Releases</h3>
+<a name="index-packaging"></a>
-<p><a name="index-packaging-161"></a>
-You should identify each release with a pair of version numbers, a
+<p>You should identify each release with a pair of version numbers, a
major version and a minor. We have no objection to using more than
two numbers, but it is very unlikely that you really need them.
-
- <p>Package the distribution of <code>Foo version 69.96</code> up in a
gzipped tar
-file with the name <samp><span class="file">foo-69.96.tar.gz</span></samp>.
It should unpack into a
-subdirectory named <samp><span class="file">foo-69.96</span></samp>.
-
- <p>Building and installing the program should never modify any of the files
+</p>
+<p>Package the distribution of <code>Foo version 69.96</code> up in a gzipped
tar
+file with the name ‘<tt>foo-69.96.tar.gz</tt>’. It should unpack
into a
+subdirectory named ‘<tt>foo-69.96</tt>’.
+</p>
+<p>Building and installing the program should never modify any of the files
contained in the distribution. This means that all the files that form
-part of the program in any way must be classified into <dfn>source
-files</dfn> and <dfn>non-source files</dfn>. Source files are written by
humans
+part of the program in any way must be classified into <em>source
+files</em> and <em>non-source files</em>. Source files are written by humans
and never changed automatically; non-source files are produced from
source files by programs under the control of the Makefile.
-
- <p><a name="index-g_t_0040file_007bREADME_007d-file-162"></a>The
distribution should contain a file named <samp><span
class="file">README</span></samp> which gives
+</p>
+<a name="index-README-file"></a>
+<p>The distribution should contain a file named ‘<tt>README</tt>’
which gives
the name of the package, and a general description of what it does. It
is also good to explain the purpose of each of the first-level
-subdirectories in the package, if there are any. The <samp><span
class="file">README</span></samp> file
+subdirectories in the package, if there are any. The
‘<tt>README</tt>’ file
should either state the version number of the package, or refer to where
in the package it can be found.
-
- <p>The <samp><span class="file">README</span></samp> file should refer to
the file <samp><span class="file">INSTALL</span></samp>, which
+</p>
+<p>The ‘<tt>README</tt>’ file should refer to the file
‘<tt>INSTALL</tt>’, which
should contain an explanation of the installation procedure.
-
- <p>The <samp><span class="file">README</span></samp> file should also refer
to the file which contains the
+</p>
+<p>The ‘<tt>README</tt>’ file should also refer to the file which
contains the
copying conditions. The GNU GPL, if used, should be in a file called
-<samp><span class="file">COPYING</span></samp>. If the GNU LGPL is used, it
should be in a file called
-<samp><span class="file">COPYING.LESSER</span></samp>.
-
- <p>Naturally, all the source files must be in the distribution. It is
+‘<tt>COPYING</tt>’. If the GNU LGPL is used, it should be in a
file called
+‘<tt>COPYING.LESSER</tt>’.
+</p>
+<p>Naturally, all the source files must be in the distribution. It is
okay to include non-source files in the distribution along with the
source files they are generated from, provided they are up-to-date
with the source they are made from, and machine-independent, so that
@@ -85,43 +108,52 @@
Bison, <code>lex</code>, TeX, and <code>makeinfo</code>; this helps avoid
unnecessary dependencies between our distributions, so that users can
install whichever packages they want to install.
-
- <p>Non-source files that might actually be modified by building and
+</p>
+<p>Non-source files that might actually be modified by building and
installing the program should <strong>never</strong> be included in the
distribution. So if you do distribute non-source files, always make
sure they are up to date when you make a new distribution.
-
- <p>Make sure that all the files in the distribution are world-readable, and
+</p>
+<p>Make sure that all the files in the distribution are world-readable, and
that directories are world-readable and world-searchable (octal mode 755).
We used to recommend that all directories in the distribution also be
world-writable (octal mode 777), because ancient versions of <code>tar</code>
would otherwise not cope when extracting the archive as an unprivileged
user. That can easily lead to security issues when creating the archive,
however, so now we recommend against that.
-
- <p>Don't include any symbolic links in the distribution itself. If the tar
+</p>
+<p>Don’t include any symbolic links in the distribution itself. If the
tar
file contains symbolic links, then people cannot even unpack it on
-systems that don't support symbolic links. Also, don't use multiple
+systems that don’t support symbolic links. Also, don’t use
multiple
names for one file in different directories, because certain file
systems cannot handle this and that prevents unpacking the
distribution.
-
- <p>Try to make sure that all the file names will be unique on MS-DOS. A
+</p>
+<p>Try to make sure that all the file names will be unique on MS-DOS. A
name on MS-DOS consists of up to 8 characters, optionally followed by a
period and up to three characters. MS-DOS will truncate extra
characters both before and after the period. Thus,
-<samp><span class="file">foobarhacker.c</span></samp> and <samp><span
class="file">foobarhacker.o</span></samp> are not ambiguous; they
-are truncated to <samp><span class="file">foobarha.c</span></samp> and
<samp><span class="file">foobarha.o</span></samp>, which are
+‘<tt>foobarhacker.c</tt>’ and
‘<tt>foobarhacker.o</tt>’ are not ambiguous; they
+are truncated to ‘<tt>foobarha.c</tt>’ and
‘<tt>foobarha.o</tt>’, which are
distinct.
-
- <p><a
name="index-g_t_0040file_007btexinfo_002etex_007d_002c-in-a-distribution-163"></a>Include
in your distribution a copy of the <samp><span
class="file">texinfo.tex</span></samp> you used
-to test print any <samp><span class="file">*.texinfo</span></samp> or
<samp><span class="file">*.texi</span></samp> files.
-
- <p>Likewise, if your program uses small GNU software packages like regex,
+</p>
+<a name="index-texinfo_002etex_002c-in-a-distribution"></a>
+<p>Include in your distribution a copy of the
‘<tt>texinfo.tex</tt>’ you used
+to test print any ‘<tt>*.texinfo</tt>’ or
‘<tt>*.texi</tt>’ files.
+</p>
+<p>Likewise, if your program uses small GNU software packages like regex,
getopt, obstack, or termcap, include them in the distribution file.
Leaving them out would make the distribution file a little smaller at
-the expense of possible inconvenience to a user who doesn't know what
+the expense of possible inconvenience to a user who doesn’t know what
other files to get.
+</p>
+<hr>
+<div class="header">
+<p>
+Previous: <a href="Makefile-Conventions.html#Makefile-Conventions"
accesskey="p" rel="previous">Makefile Conventions</a>, Up: <a
href="Managing-Releases.html#Managing-Releases" accesskey="u" rel="up">Managing
Releases</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Semantics.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Semantics.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Semantics.html 8 Apr 2012 00:23:56 -0000 1.54
+++ standards/html_node/Semantics.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Semantics - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="Non_002dGNU-Standards.html#Non_002dGNU-Standards"
title="Non-GNU Standards">
-<link rel="next" href="Libraries.html#Libraries" title="Libraries">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,129 +11,180 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Semantics</title>
+
+<meta name="description" content="GNU Coding Standards: Semantics">
+<meta name="keywords" content="GNU Coding Standards: Semantics">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Libraries.html#Libraries" rel="next" title="Libraries">
+<link href="Non_002dGNU-Standards.html#Non_002dGNU-Standards" rel="previous"
title="Non-GNU Standards">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Semantics"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Libraries.html#Libraries">Libraries</a>,
-Previous: <a rel="previous" accesskey="p"
href="Non_002dGNU-Standards.html#Non_002dGNU-Standards">Non-GNU Standards</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="Libraries.html#Libraries" accesskey="n"
rel="next">Libraries</a>, Previous: <a
href="Non_002dGNU-Standards.html#Non_002dGNU-Standards" accesskey="p"
rel="previous">Non-GNU Standards</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Writing-Robust-Programs"></a>
<h3 class="section">4.2 Writing Robust Programs</h3>
-<p><a name="index-arbitrary-limits-on-data-24"></a>Avoid arbitrary limits on
the length or number of <em>any</em> data
+<a name="index-arbitrary-limits-on-data"></a>
+<p>Avoid arbitrary limits on the length or number of <em>any</em> data
structure, including file names, lines, files, and symbols, by allocating
all data structures dynamically. In most Unix utilities, “long lines
are silently truncated”. This is not acceptable in a GNU utility.
-
- <p><a name="index-g_t_0040code_007bNUL_007d-characters-25"></a><a
name="index-libiconv-26"></a>Utilities reading files should not drop NUL
characters, or any other
+</p>
+<a name="index-NUL-characters"></a>
+<a name="index-libiconv"></a>
+<p>Utilities reading files should not drop NUL characters, or any other
nonprinting characters <em>including those with codes above 0177</em>.
The only sensible exceptions would be utilities specifically intended
-for interface to certain types of terminals or printers that can't
+for interface to certain types of terminals or printers that can’t
handle those characters. Whenever possible, try to make programs work
properly with sequences of bytes that represent multibyte characters;
UTF-8 is the most important.
-
- <p><a name="index-error-messages-27"></a>Check every system call for an
error return, unless you know you wish
+</p>
+<a name="index-error-messages"></a>
+<p>Check every system call for an error return, unless you know you wish
to ignore errors. Include the system error text (from <code>perror</code>,
<code>strerror</code>, or equivalent) in <em>every</em> error message
resulting from a failing system call, as well as the name of the file
if any and the name of the utility. Just “cannot open foo.c” or
“stat failed” is not sufficient.
-
- <p><a name="index-g_t_0040code_007bmalloc_007d-return-value-28"></a><a
name="index-memory-allocation-failure-29"></a>Check every call to
<code>malloc</code> or <code>realloc</code> to see if it
+</p>
+<a name="index-malloc-return-value"></a>
+<a name="index-memory-allocation-failure"></a>
+<p>Check every call to <code>malloc</code> or <code>realloc</code> to see if it
returned zero. Check <code>realloc</code> even if you are making the block
smaller; in a system that rounds block sizes to a power of 2,
<code>realloc</code> may get a different block if you ask for less space.
-
- <p>In Unix, <code>realloc</code> can destroy the storage block if it returns
+</p>
+<p>In Unix, <code>realloc</code> can destroy the storage block if it returns
zero. GNU <code>realloc</code> does not have this bug: if it fails, the
original block is unchanged. Feel free to assume the bug is fixed. If
you wish to run your program on Unix, and wish to avoid lossage in this
case, you can use the GNU <code>malloc</code>.
-
- <p>You must expect <code>free</code> to alter the contents of the block
that was
+</p>
+<p>You must expect <code>free</code> to alter the contents of the block that
was
freed. Anything you want to fetch from the block, you must fetch before
calling <code>free</code>.
-
- <p>If <code>malloc</code> fails in a noninteractive program, make that a
fatal
+</p>
+<p>If <code>malloc</code> fails in a noninteractive program, make that a fatal
error. In an interactive program (one that reads commands from the
user), it is better to abort the command and return to the command
reader loop. This allows the user to kill other processes to free up
virtual memory, and then try the command again.
-
- <p><a name="index-command_002dline-arguments_002c-decoding-30"></a>Use
<code>getopt_long</code> to decode arguments, unless the argument syntax
+</p>
+<a name="index-command_002dline-arguments_002c-decoding"></a>
+<p>Use <code>getopt_long</code> to decode arguments, unless the argument syntax
makes this unreasonable.
-
- <p>When static storage is to be written in during program execution, use
+</p>
+<p>When static storage is to be written in during program execution, use
explicit C code to initialize it. Reserve C initialized declarations
for data that will not be changed.
-<!-- ADR: why? -->
-
- <p>Try to avoid low-level interfaces to obscure Unix data structures (such
+</p>
+<p>Try to avoid low-level interfaces to obscure Unix data structures (such
as file directories, utmp, or the layout of kernel memory), since these
are less likely to work compatibly. If you need to find all the files
in a directory, use <code>readdir</code> or some other high-level interface.
These are supported compatibly by GNU.
-
- <p><a name="index-signal-handling-31"></a>The preferred signal handling
facilities are the BSD variant of
-<code>signal</code>, and the <span class="sc">posix</span>
<code>sigaction</code> function; the
+</p>
+<a name="index-signal-handling"></a>
+<p>The preferred signal handling facilities are the BSD variant of
+<code>signal</code>, and the <small>POSIX</small> <code>sigaction</code>
function; the
alternative USG <code>signal</code> interface is an inferior design.
-
- <p>Nowadays, using the <span class="sc">posix</span> signal functions may
be the easiest way
+</p>
+<p>Nowadays, using the <small>POSIX</small> signal functions may be the
easiest way
to make a program portable. If you use <code>signal</code>, then on GNU/Linux
systems running GNU libc version 1, you should include
-<samp><span class="file">bsd/signal.h</span></samp> instead of <samp><span
class="file">signal.h</span></samp>, so as to get BSD
+‘<tt>bsd/signal.h</tt>’ instead of
‘<tt>signal.h</tt>’, so as to get BSD
behavior. It is up to you whether to support systems where
<code>signal</code> has only the USG behavior, or give up on them.
-
- <p><a name="index-impossible-conditions-32"></a>In error checks that detect
“impossible” conditions, just abort.
+</p>
+<a name="index-impossible-conditions"></a>
+<p>In error checks that detect “impossible” conditions, just abort.
There is usually no point in printing any message. These checks
indicate the existence of bugs. Whoever wants to fix the bugs will have
to read the source code and run a debugger. So explain the problem with
comments in the source. The relevant data will be in variables, which
are easy to examine with the debugger, so there is no point moving them
elsewhere.
-
- <p>Do not use a count of errors as the exit status for a program.
+</p>
+<p>Do not use a count of errors as the exit status for a program.
<em>That does not work</em>, because exit status values are limited to 8
bits (0 through 255). A single run of the program might have 256
errors; if you try to return 256 as the exit status, the parent process
will see 0 as the status, and it will appear that the program succeeded.
-
- <p><a name="index-temporary-files-33"></a><a
name="index-g_t_0040code_007bTMPDIR_007d-environment-variable-34"></a>If you
make temporary files, check the <code>TMPDIR</code> environment
+</p>
+<a name="index-temporary-files"></a>
+<a name="index-TMPDIR-environment-variable"></a>
+<p>If you make temporary files, check the <code>TMPDIR</code> environment
variable; if that variable is defined, use the specified directory
-instead of <samp><span class="file">/tmp</span></samp>.
-
- <p>In addition, be aware that there is a possible security problem when
+instead of ‘<tt>/tmp</tt>’.
+</p>
+<p>In addition, be aware that there is a possible security problem when
creating temporary files in world-writable directories. In C, you can
avoid this problem by creating temporary files in this manner:
-
-<pre class="example"> fd = open (filename, O_WRONLY | O_CREAT | O_EXCL,
0600);
-</pre>
- <p class="noindent">or by using the <code>mkstemps</code> function from
Gnulib
-(see <a href="../gnulib/mkstemps.html#mkstemps">mkstemps</a>).
-
- <p>In bash, use <code>set -C</code> (long name <code>noclobber</code>) to
avoid this
+</p>
+<div class="example">
+<pre class="example">fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600);
+</pre></div>
+
+<p>or by using the <code>mkstemps</code> function from Gnulib
+(see <a
href="http://www.gnu.org/software/gnulib/manual/html_node/mkstemps.html#mkstemps";>mkstemps</a>
in <cite>Gnulib</cite>).
+</p>
+<p>In bash, use <code>set -C</code> (long name <code>noclobber</code>) to
avoid this
problem. In addition, the <code>mktemp</code> utility is a more general
solution for creating temporary files from shell scripts
-(see <a href="../coreutils/mktemp-invocation.html#mktemp-invocation">mktemp
invocation</a>).
+(see <a
href="http://www.gnu.org/software/coreutils/manual/html_node/mktemp-invocation.html#mktemp-invocation";>mktemp
invocation</a> in <cite>GNU Coreutils</cite>).
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Libraries.html#Libraries" accesskey="n"
rel="next">Libraries</a>, Previous: <a
href="Non_002dGNU-Standards.html#Non_002dGNU-Standards" accesskey="p"
rel="previous">Non-GNU Standards</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Simple-Changes.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Simple-Changes.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Simple-Changes.html 8 Apr 2012 00:23:56 -0000
1.54
+++ standards/html_node/Simple-Changes.html 7 May 2012 00:48:09 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Simple Changes - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Change-Logs.html#Change-Logs" title="Change Logs">
-<link rel="prev" href="Style-of-Change-Logs.html#Style-of-Change-Logs"
title="Style of Change Logs">
-<link rel="next" href="Conditional-Changes.html#Conditional-Changes"
title="Conditional Changes">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,59 +11,94 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Simple Changes</title>
+
+<meta name="description" content="GNU Coding Standards: Simple Changes">
+<meta name="keywords" content="GNU Coding Standards: Simple Changes">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Change-Logs.html#Change-Logs" rel="up" title="Change Logs">
+<link href="Conditional-Changes.html#Conditional-Changes" rel="next"
title="Conditional Changes">
+<link href="Style-of-Change-Logs.html#Style-of-Change-Logs" rel="previous"
title="Style of Change Logs">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Simple-Changes"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Conditional-Changes.html#Conditional-Changes">Conditional Changes</a>,
-Previous: <a rel="previous" accesskey="p"
href="Style-of-Change-Logs.html#Style-of-Change-Logs">Style of Change Logs</a>,
-Up: <a rel="up" accesskey="u" href="Change-Logs.html#Change-Logs">Change
Logs</a>
-<hr>
+Next: <a href="Conditional-Changes.html#Conditional-Changes" accesskey="n"
rel="next">Conditional Changes</a>, Previous: <a
href="Style-of-Change-Logs.html#Style-of-Change-Logs" accesskey="p"
rel="previous">Style of Change Logs</a>, Up: <a
href="Change-Logs.html#Change-Logs" accesskey="u" rel="up">Change Logs</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Simple-Changes-1"></a>
<h4 class="subsection">6.8.3 Simple Changes</h4>
-<p>Certain simple kinds of changes don't need much detail in the change
+<p>Certain simple kinds of changes don’t need much detail in the change
log.
-
- <p>When you change the calling sequence of a function in a simple fashion,
+</p>
+<p>When you change the calling sequence of a function in a simple fashion,
and you change all the callers of the function to use the new calling
sequence, there is no need to make individual entries for all the
callers that you changed. Just write in the entry for the function
being called, “All callers changed”—like this:
+</p>
+<div class="example">
+<pre class="example">* keyboard.c (Fcommand_execute): New arg SPECIAL.
+All callers changed.
+</pre></div>
-<pre class="example"> * keyboard.c (Fcommand_execute): New arg SPECIAL.
- All callers changed.
-</pre>
- <p>When you change just comments or doc strings, it is enough to write an
+<p>When you change just comments or doc strings, it is enough to write an
entry for the file, without mentioning the functions. Just “Doc
fixes” is enough for the change log.
-
- <p>There's no technical need to make change log entries for documentation
+</p>
+<p>There’s no technical need to make change log entries for documentation
files. This is because documentation is not susceptible to bugs that
are hard to fix. Documentation does not consist of parts that must
interact in a precisely engineered fashion. To correct an error, you
need not know the history of the erroneous passage; it is enough to
compare what the documentation says with the way the program actually
works.
-
- <p>However, you should keep change logs for documentation files when the
+</p>
+<p>However, you should keep change logs for documentation files when the
project gets copyright assignments from its contributors, so as to
make the records of authorship more accurate.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Source-Language.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Source-Language.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Source-Language.html 8 Apr 2012 00:23:56 -0000
1.54
+++ standards/html_node/Source-Language.html 7 May 2012 00:48:09 -0000
1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Source Language - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Design-Advice.html#Design-Advice" title="Design Advice">
-<link rel="next" href="Compatibility.html#Compatibility" title="Compatibility">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,73 +11,115 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Source Language</title>
+
+<meta name="description" content="GNU Coding Standards: Source Language">
+<meta name="keywords" content="GNU Coding Standards: Source Language">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Design-Advice.html#Design-Advice" rel="up" title="Design Advice">
+<link href="Compatibility.html#Compatibility" rel="next" title="Compatibility">
+<link href="Design-Advice.html#Design-Advice" rel="previous" title="Design
Advice">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Source-Language"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Compatibility.html#Compatibility">Compatibility</a>,
-Up: <a rel="up" accesskey="u"
href="Design-Advice.html#Design-Advice">Design Advice</a>
-<hr>
+Next: <a href="Compatibility.html#Compatibility" accesskey="n"
rel="next">Compatibility</a>, Up: <a href="Design-Advice.html#Design-Advice"
accesskey="u" rel="up">Design Advice</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Which-Languages-to-Use"></a>
<h3 class="section">3.1 Which Languages to Use</h3>
+<a name="index-programming-languages"></a>
-<p><a name="index-programming-languages-14"></a>
-When you want to use a language that gets compiled and runs at high
+<p>When you want to use a language that gets compiled and runs at high
speed, the best language to use is C. Using another language is like
using a non-standard feature: it will cause trouble for users. Even if
GCC supports the other language, users may find it inconvenient to have
to install the compiler for that other language in order to build your
program. For example, if you write your program in C++, people will
have to install the GNU C++ compiler in order to compile your program.
-
- <p>C has one other advantage over C++ and other compiled languages: more
+</p>
+<p>C has one other advantage over C++ and other compiled languages: more
people know C, so more people will find it easy to read and modify the
program if it is written in C.
-
- <p>So in general it is much better to use C, rather than the
+</p>
+<p>So in general it is much better to use C, rather than the
comparable alternatives.
-
- <p>But there are two exceptions to that conclusion:
-
- <ul>
-<li>It is no problem to use another language to write a tool specifically
+</p>
+<p>But there are two exceptions to that conclusion:
+</p>
+<ul>
+<li> It is no problem to use another language to write a tool specifically
intended for use with that language. That is because the only people
who want to build the tool will be those who have installed the other
language anyway.
- <li>If an application is of interest only to a narrow part of the
community,
+</li><li> If an application is of interest only to a narrow part of the
community,
then the question of which language it is written in has less effect on
other people, so you may as well please yourself.
-</ul>
+</li></ul>
- <p>Many programs are designed to be extensible: they include an interpreter
+<p>Many programs are designed to be extensible: they include an interpreter
for a language that is higher level than C. Often much of the program
is written in that language, too. The Emacs editor pioneered this
technique.
-
- <p><a name="index-Guile-15"></a><a name="index-GNOME-and-Guile-16"></a>The
standard extensibility interpreter for GNU software is Guile
+</p>
+<a name="index-Guile"></a>
+<a name="index-GNOME-and-Guile"></a>
+<p>The standard extensibility interpreter for GNU software is Guile
(<a
href="http://www.gnu.org/software/guile/";>http://www.gnu.org/software/guile/</a>),
which implements the
language Scheme (an especially clean and simple dialect of Lisp).
Guile also includes bindings for GTK+/GNOME, making it practical to
-write modern GUI functionality within Guile. We don't reject programs
+write modern GUI functionality within Guile. We don’t reject programs
written in other “scripting languages” such as Perl and Python, but
using Guile is very important for the overall consistency of the GNU
system.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Compatibility.html#Compatibility" accesskey="n"
rel="next">Compatibility</a>, Up: <a href="Design-Advice.html#Design-Advice"
accesskey="u" rel="up">Design Advice</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Standard-C.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Standard-C.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Standard-C.html 8 Apr 2012 00:23:56 -0000 1.54
+++ standards/html_node/Standard-C.html 7 May 2012 00:48:09 -0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Standard C - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Design-Advice.html#Design-Advice" title="Design Advice">
-<link rel="prev" href="Using-Extensions.html#Using-Extensions" title="Using
Extensions">
-<link rel="next" href="Conditional-Compilation.html#Conditional-Compilation"
title="Conditional Compilation">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,72 +11,109 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Standard C</title>
+
+<meta name="description" content="GNU Coding Standards: Standard C">
+<meta name="keywords" content="GNU Coding Standards: Standard C">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Design-Advice.html#Design-Advice" rel="up" title="Design Advice">
+<link href="Conditional-Compilation.html#Conditional-Compilation" rel="next"
title="Conditional Compilation">
+<link href="Using-Extensions.html#Using-Extensions" rel="previous"
title="Using Extensions">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Standard-C"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Conditional-Compilation.html#Conditional-Compilation">Conditional
Compilation</a>,
-Previous: <a rel="previous" accesskey="p"
href="Using-Extensions.html#Using-Extensions">Using Extensions</a>,
-Up: <a rel="up" accesskey="u"
href="Design-Advice.html#Design-Advice">Design Advice</a>
-<hr>
+Next: <a href="Conditional-Compilation.html#Conditional-Compilation"
accesskey="n" rel="next">Conditional Compilation</a>, Previous: <a
href="Using-Extensions.html#Using-Extensions" accesskey="p"
rel="previous">Using Extensions</a>, Up: <a
href="Design-Advice.html#Design-Advice" accesskey="u" rel="up">Design
Advice</a> [<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Standard-C-and-Pre_002dStandard-C"></a>
<h3 class="section">3.4 Standard C and Pre-Standard C</h3>
+<a name="index-ANSI-C-standard"></a>
-<p><a name="index-g_t_0040sc_007bansi_007d-C-standard-22"></a>
-1989 Standard C is widespread enough now that it is ok to use its
+<p>1989 Standard C is widespread enough now that it is ok to use its
features in new programs. There is one exception: do not ever use the
“trigraph” feature of Standard C.
-
- <p>1999 Standard C is not widespread yet, so please do not require its
+</p>
+<p>1999 Standard C is not widespread yet, so please do not require its
features in programs. It is ok to use its features if they are present.
-
- <p>However, it is easy to support pre-standard compilers in most programs,
+</p>
+<p>However, it is easy to support pre-standard compilers in most programs,
so if you know how to do that, feel free. If a program you are
maintaining has such support, you should try to keep it working.
-
- <p><a name="index-function-prototypes-23"></a>To support pre-standard C,
instead of writing function definitions in
+</p>
+<a name="index-function-prototypes"></a>
+<p>To support pre-standard C, instead of writing function definitions in
standard prototype form,
+</p>
+<div class="example">
+<pre class="example">int
+foo (int x, int y)
+…
+</pre></div>
+
+<p>write the definition in pre-standard style like this,
+</p>
+<div class="example">
+<pre class="example">int
+foo (x, y)
+ int x, y;
+…
+</pre></div>
-<pre class="example"> int
- foo (int x, int y)
- ...
-</pre>
- <p class="noindent">write the definition in pre-standard style like this,
+<p>and use a separate declaration to specify the argument prototype:
+</p>
+<div class="example">
+<pre class="example">int foo (int, int);
+</pre></div>
-<pre class="example"> int
- foo (x, y)
- int x, y;
- ...
-</pre>
- <p class="noindent">and use a separate declaration to specify the argument
prototype:
-
-<pre class="example"> int foo (int, int);
-</pre>
- <p>You need such a declaration anyway, in a header file, to get the benefit
+<p>You need such a declaration anyway, in a header file, to get the benefit
of prototypes in all the files where the function is called. And once
you have the declaration, you normally lose nothing by writing the
function definition in the pre-standard style.
-
- <p>This technique does not work for integer types narrower than
<code>int</code>.
+</p>
+<p>This technique does not work for integer types narrower than
<code>int</code>.
If you think of an argument as being of a type narrower than <code>int</code>,
declare it as <code>int</code> instead.
-
- <p>There are a few special cases where this technique is hard to use. For
+</p>
+<p>There are a few special cases where this technique is hard to use. For
example, if a function argument needs to hold the system type
<code>dev_t</code>, you run into trouble, because <code>dev_t</code> is
shorter than
<code>int</code> on some machines; but you cannot use <code>int</code> instead,
@@ -95,16 +122,26 @@
definition. The only way to support non-standard C and pass such an
argument is to check the width of <code>dev_t</code> using Autoconf and choose
the argument type accordingly. This may not be worth the trouble.
-
- <p>In order to support pre-standard compilers that do not recognize
+</p>
+<p>In order to support pre-standard compilers that do not recognize
prototypes, you may want to use a preprocessor macro like this:
+</p>
+<div class="example">
+<pre class="example">/* Declare the prototype for a general external function.
*/
+#if defined (__STDC__) || defined (WINDOWSNT)
+#define P_(proto) proto
+#else
+#define P_(proto) ()
+#endif
+</pre></div>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Conditional-Compilation.html#Conditional-Compilation"
accesskey="n" rel="next">Conditional Compilation</a>, Previous: <a
href="Using-Extensions.html#Using-Extensions" accesskey="p"
rel="previous">Using Extensions</a>, Up: <a
href="Design-Advice.html#Design-Advice" accesskey="u" rel="up">Design
Advice</a> [<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
-<pre class="example"> /* Declare the prototype for a general external
function. */
- #if defined (__STDC__) || defined (WINDOWSNT)
- #define P_(proto) proto
- #else
- #define P_(proto) ()
- #endif
-</pre>
- </body></html>
+</body>
+</html>
Index: standards/html_node/Standard-Targets.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Standard-Targets.html,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -b -r1.56 -r1.57
--- standards/html_node/Standard-Targets.html 8 Apr 2012 00:23:56 -0000
1.56
+++ standards/html_node/Standard-Targets.html 7 May 2012 00:48:10 -0000
1.57
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Standard Targets - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link rel="prev" href="Directory-Variables.html#Directory-Variables"
title="Directory Variables">
-<link rel="next"
href="Install-Command-Categories.html#Install-Command-Categories"
title="Install Command Categories">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,322 +11,410 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Standard Targets</title>
+
+<meta name="description" content="GNU Coding Standards: Standard Targets">
+<meta name="keywords" content="GNU Coding Standards: Standard Targets">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="up"
title="Makefile Conventions">
+<link href="Install-Command-Categories.html#Install-Command-Categories"
rel="next" title="Install Command Categories">
+<link href="Directory-Variables.html#Directory-Variables" rel="previous"
title="Directory Variables">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Standard-Targets"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a>,
-Previous: <a rel="previous" accesskey="p"
href="Directory-Variables.html#Directory-Variables">Directory Variables</a>,
-Up: <a rel="up" accesskey="u"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>
-<hr>
+Next: <a href="Install-Command-Categories.html#Install-Command-Categories"
accesskey="n" rel="next">Install Command Categories</a>, Previous: <a
href="Directory-Variables.html#Directory-Variables" accesskey="p"
rel="previous">Directory Variables</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Standard-Targets-for-Users"></a>
<h4 class="subsection">7.2.6 Standard Targets for Users</h4>
<p>All GNU programs should have the following targets in their Makefiles:
-
- <dl>
-<dt>‘<samp><span class="samp">all</span></samp>’<dd>Compile the
entire program. This should be the default target. This
+</p>
+<dl compact="compact">
+<dt>‘<samp>all</samp>’</dt>
+<dd><p>Compile the entire program. This should be the default target. This
target need not rebuild any documentation files; Info files should
normally be included in the distribution, and DVI (and other
documentation format) files should be made only when explicitly asked
for.
-
- <p>By default, the Make rules should compile and link with
‘<samp><span class="samp">-g</span></samp>’, so
+</p>
+<p>By default, the Make rules should compile and link with
‘<samp>-g</samp>’, so
that executable programs have debugging symbols. Otherwise, you are
essentially helpless in the face of a crash, and it is often far from
easy to reproduce with a fresh build.
-
- <br><dt>‘<samp><span
class="samp">install</span></samp>’<dd>Compile the program and copy the
executables, libraries, and so on to
+</p>
+</dd>
+<dt>‘<samp>install</samp>’</dt>
+<dd><p>Compile the program and copy the executables, libraries, and so on to
the file names where they should reside for actual use. If there is a
simple test to verify that a program is properly installed, this target
should run that test.
-
- <p>Do not strip executables when installing them. This helps eventual
+</p>
+<p>Do not strip executables when installing them. This helps eventual
debugging that may be needed later, and nowadays disk space is cheap
and dynamic loaders typically ensure debug sections are not loaded during
normal execution. Users that need stripped binaries may invoke the
<code>install-strip</code> target to do that.
-
- <p>If possible, write the <code>install</code> target rule so that it
does not
+</p>
+<p>If possible, write the <code>install</code> target rule so that it does not
modify anything in the directory where the program was built, provided
-‘<samp><span class="samp">make all</span></samp>’ has just been
done. This is convenient for building the
+‘<samp>make all</samp>’ has just been done. This is convenient
for building the
program under one user name and installing it under another.
-
- <p>The commands should create all the directories in which files are to be
-installed, if they don't already exist. This includes the directories
+</p>
+<p>The commands should create all the directories in which files are to be
+installed, if they don’t already exist. This includes the directories
specified as the values of the variables <code>prefix</code> and
<code>exec_prefix</code>, as well as all subdirectories that are needed.
One way to do this is by means of an <code>installdirs</code> target
as described below.
-
- <p>Use ‘<samp><span class="samp">-</span></samp>’ before any
command for installing a man page, so that
+</p>
+<p>Use ‘<samp>-</samp>’ before any command for installing a man
page, so that
<code>make</code> will ignore any errors. This is in case there are systems
-that don't have the Unix man page documentation system installed.
-
- <p>The way to install Info files is to copy them into <samp><span
class="file">$(infodir)</span></samp>
+that don’t have the Unix man page documentation system installed.
+</p>
+<p>The way to install Info files is to copy them into
‘<tt>$(infodir)</tt>’
with <code>$(INSTALL_DATA)</code> (see <a
href="Command-Variables.html#Command-Variables">Command Variables</a>), and
then run
the <code>install-info</code> program if it is present.
<code>install-info</code>
-is a program that edits the Info <samp><span class="file">dir</span></samp>
file to add or update the
+is a program that edits the Info ‘<tt>dir</tt>’ file to add or
update the
menu entry for the given Info file; it is part of the Texinfo package.
-
- <p>Here is a sample rule to install an Info file that also tries to
+</p>
+<p>Here is a sample rule to install an Info file that also tries to
handle some additional situations, such as <code>install-info</code> not
being present.
-
- <!-- This example has been carefully formatted for the Make manual. -->
- <!-- Please do not reformat it without talking to address@hidden -->
- <pre class="smallexample"> do-install-info: foo.info installdirs
+</p>
+<div class="smallexample">
+<pre class="smallexample">do-install-info: foo.info installdirs
$(NORMAL_INSTALL)
- # Prefer an info file in . to one in srcdir.
+# Prefer an info file in . to one in srcdir.
if test -f foo.info; then d=.; \
- else d="$(srcdir)"; fi; \
+ else d="$(srcdir)"; fi; \
$(INSTALL_DATA) $$d/foo.info \
- "$(DESTDIR)$(infodir)/foo.info"
- # Run install-info only if it exists.
- # Use `if' instead of just prepending `-' to the
- # line so we notice real errors from install-info.
- # Use `$(SHELL) -c' because some shells do not
- # fail gracefully when there is an unknown command.
+ "$(DESTDIR)$(infodir)/foo.info"
+# Run install-info only if it exists.
+# Use `if' instead of just prepending `-' to the
+# line so we notice real errors from install-info.
+# Use `$(SHELL) -c' because some shells do not
+# fail gracefully when there is an unknown command.
$(POST_INSTALL)
if $(SHELL) -c 'install-info --version' \
>/dev/null 2>&1; then \
- install-info --dir-file="$(DESTDIR)$(infodir)/dir" \
- "$(DESTDIR)$(infodir)/foo.info"; \
+ install-info --dir-file="$(DESTDIR)$(infodir)/dir" \
+ "$(DESTDIR)$(infodir)/foo.info"; \
else true; fi
-</pre>
- <p>When writing the <code>install</code> target, you must classify all the
-commands into three categories: normal ones, <dfn>pre-installation</dfn>
-commands and <dfn>post-installation</dfn> commands. See <a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a>.
+</pre></div>
- <br><dt>‘<samp><span
class="samp">install-html</span></samp>’<dt>‘<samp><span
class="samp">install-dvi</span></samp>’<dt>‘<samp><span
class="samp">install-pdf</span></samp>’<dt>‘<samp><span
class="samp">install-ps</span></samp>’<dd>These targets install
documentation in formats other than Info;
-they're intended to be called explicitly by the person installing the
+<p>When writing the <code>install</code> target, you must classify all the
+commands into three categories: normal ones, <em>pre-installation</em>
+commands and <em>post-installation</em> commands. See <a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command
+Categories</a>.
+</p>
+</dd>
+<dt>‘<samp>install-html</samp>’</dt>
+<dt>‘<samp>install-dvi</samp>’</dt>
+<dt>‘<samp>install-pdf</samp>’</dt>
+<dt>‘<samp>install-ps</samp>’</dt>
+<dd><p>These targets install documentation in formats other than Info;
+they’re intended to be called explicitly by the person installing the
package, if that format is desired. GNU prefers Info files, so these
must be installed by the <code>install</code> target.
-
- <p>When you have many documentation files to install, we recommend that
+</p>
+<p>When you have many documentation files to install, we recommend that
you avoid collisions and clutter by arranging for these targets to
install in subdirectories of the appropriate installation directory,
such as <code>htmldir</code>. As one example, if your package has multiple
manuals, and you wish to install HTML documentation with many files
-(such as the “split” mode output by <code>makeinfo --html</code>),
you'll
+(such as the “split” mode output by <code>makeinfo --html</code>),
you’ll
certainly want to use subdirectories, or two nodes with the same name
in different manuals will overwrite each other.
-
- <p>Please make these <code>install-</code><var>format</var> targets
invoke the
+</p>
+<p>Please make these <code>install-<var>format</var></code> targets invoke the
commands for the <var>format</var> target, for example, by making
<var>format</var> a dependency.
-
- <br><dt>‘<samp><span
class="samp">uninstall</span></samp>’<dd>Delete all the installed
files—the copies that the ‘<samp><span
class="samp">install</span></samp>’
-and ‘<samp><span class="samp">install-*</span></samp>’ targets
create.
-
- <p>This rule should not modify the directories where compilation is done,
+</p>
+</dd>
+<dt>‘<samp>uninstall</samp>’</dt>
+<dd><p>Delete all the installed files—the copies that the
‘<samp>install</samp>’
+and ‘<samp>install-*</samp>’ targets create.
+</p>
+<p>This rule should not modify the directories where compilation is done,
only the directories where files are installed.
-
- <p>The uninstallation commands are divided into three categories, just
like
+</p>
+<p>The uninstallation commands are divided into three categories, just like
the installation commands. See <a
href="Install-Command-Categories.html#Install-Command-Categories">Install
Command Categories</a>.
-
- <br><dt>‘<samp><span
class="samp">install-strip</span></samp>’<dd>Like <code>install</code>,
but strip the executable files while installing
+</p>
+</dd>
+<dt>‘<samp>install-strip</samp>’</dt>
+<dd><p>Like <code>install</code>, but strip the executable files while
installing
them. In simple cases, this target can use the <code>install</code> target in
a simple way:
-
- <pre class="smallexample"> install-strip:
+</p>
+<div class="smallexample">
+<pre class="smallexample">install-strip:
$(MAKE) INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' \
install
-</pre>
- <p>But if the package installs scripts as well as real executables, the
-<code>install-strip</code> target can't just refer to the <code>install</code>
-target; it has to strip the executables but not the scripts.
+</pre></div>
- <p><code>install-strip</code> should not strip the executables in the
build
+<p>But if the package installs scripts as well as real executables, the
+<code>install-strip</code> target can’t just refer to the
<code>install</code>
+target; it has to strip the executables but not the scripts.
+</p>
+<p><code>install-strip</code> should not strip the executables in the build
directory which are being copied for installation. It should only strip
the copies that are installed.
-
- <p>Normally we do not recommend stripping an executable unless you are
sure
+</p>
+<p>Normally we do not recommend stripping an executable unless you are sure
the program has no bugs. However, it can be reasonable to install a
stripped executable for actual execution while saving the unstripped
executable elsewhere in case there is a bug.
-
- <br><dt>‘<samp><span
class="samp">clean</span></samp>’<dd>Delete all files in the current
directory that are normally created by
+</p>
+</dd>
+<dt>‘<samp>clean</samp>’</dt>
+<dd><p>Delete all files in the current directory that are normally created by
building the program. Also delete files in other directories if they
-are created by this makefile. However, don't delete the files that
+are created by this makefile. However, don’t delete the files that
record the configuration. Also preserve files that could be made by
-building, but normally aren't because the distribution comes with
+building, but normally aren’t because the distribution comes with
them. There is no need to delete parent directories that were created
-with ‘<samp><span class="samp">mkdir -p</span></samp>’, since they
could have existed anyway.
-
- <p>Delete <samp><span class="file">.dvi</span></samp> files here if they
are not part of the distribution.
-
- <br><dt>‘<samp><span
class="samp">distclean</span></samp>’<dd>Delete all files in the current
directory (or created by this
+with ‘<samp>mkdir -p</samp>’, since they could have existed anyway.
+</p>
+<p>Delete ‘<tt>.dvi</tt>’ files here if they are not part of the
distribution.
+</p>
+</dd>
+<dt>‘<samp>distclean</samp>’</dt>
+<dd><p>Delete all files in the current directory (or created by this
makefile) that are created by configuring or building the program. If
you have unpacked the source and built the program without creating
-any other files, ‘<samp><span class="samp">make
distclean</span></samp>’ should leave only the files
+any other files, ‘<samp>make distclean</samp>’ should leave only
the files
that were in the distribution. However, there is no need to delete
-parent directories that were created with ‘<samp><span
class="samp">mkdir -p</span></samp>’, since they
+parent directories that were created with ‘<samp>mkdir -p</samp>’,
since they
could have existed anyway.
-
- <br><dt>‘<samp><span
class="samp">mostlyclean</span></samp>’<dd>Like ‘<samp><span
class="samp">clean</span></samp>’, but may refrain from deleting a few
files that people
-normally don't want to recompile. For example, the ‘<samp><span
class="samp">mostlyclean</span></samp>’
-target for GCC does not delete <samp><span
class="file">libgcc.a</span></samp>, because recompiling it
+</p>
+</dd>
+<dt>‘<samp>mostlyclean</samp>’</dt>
+<dd><p>Like ‘<samp>clean</samp>’, but may refrain from deleting a
few files that people
+normally don’t want to recompile. For example, the
‘<samp>mostlyclean</samp>’
+target for GCC does not delete ‘<tt>libgcc.a</tt>’, because
recompiling it
is rarely necessary and takes a lot of time.
-
- <br><dt>‘<samp><span
class="samp">maintainer-clean</span></samp>’<dd>Delete almost everything
that can be reconstructed with this Makefile.
+</p>
+</dd>
+<dt>‘<samp>maintainer-clean</samp>’</dt>
+<dd><p>Delete almost everything that can be reconstructed with this Makefile.
This typically includes everything deleted by <code>distclean</code>, plus
more: C source files produced by Bison, tags tables, Info files, and
so on.
-
- <p>The reason we say “almost everything” is that running the
command
-‘<samp><span class="samp">make maintainer-clean</span></samp>’
should not delete <samp><span class="file">configure</span></samp> even
-if <samp><span class="file">configure</span></samp> can be remade using a rule
in the Makefile. More
-generally, ‘<samp><span class="samp">make
maintainer-clean</span></samp>’ should not delete anything
-that needs to exist in order to run <samp><span
class="file">configure</span></samp> and then begin to
+</p>
+<p>The reason we say “almost everything” is that running the
command
+‘<samp>make maintainer-clean</samp>’ should not delete
‘<tt>configure</tt>’ even
+if ‘<tt>configure</tt>’ can be remade using a rule in the
Makefile. More
+generally, ‘<samp>make maintainer-clean</samp>’ should not delete
anything
+that needs to exist in order to run ‘<tt>configure</tt>’ and then
begin to
build the program. Also, there is no need to delete parent
-directories that were created with ‘<samp><span class="samp">mkdir
-p</span></samp>’, since they could
+directories that were created with ‘<samp>mkdir -p</samp>’, since
they could
have existed anyway. These are the only exceptions;
<code>maintainer-clean</code> should delete everything else that can be
rebuilt.
-
- <p>The ‘<samp><span
class="samp">maintainer-clean</span></samp>’ target is intended to be
used by a maintainer of
+</p>
+<p>The ‘<samp>maintainer-clean</samp>’ target is intended to be
used by a maintainer of
the package, not by ordinary users. You may need special tools to
-reconstruct some of the files that ‘<samp><span class="samp">make
maintainer-clean</span></samp>’ deletes.
-Since these files are normally included in the distribution, we don't
+reconstruct some of the files that ‘<samp>make
maintainer-clean</samp>’ deletes.
+Since these files are normally included in the distribution, we don’t
take care to make them easy to reconstruct. If you find you need to
-unpack the full distribution again, don't blame us.
-
- <p>To help make users aware of this, the commands for the special
+unpack the full distribution again, don’t blame us.
+</p>
+<p>To help make users aware of this, the commands for the special
<code>maintainer-clean</code> target should start with these two:
-
- <pre class="smallexample"> @echo 'This command is intended for
maintainers to use; it'
- @echo 'deletes files that may need special tools to rebuild.'
-</pre>
- <br><dt>‘<samp><span
class="samp">TAGS</span></samp>’<dd>Update a tags table for this program.
-<!-- ADR: how? -->
-
- <br><dt>‘<samp><span
class="samp">info</span></samp>’<dd>Generate any Info files needed. The
best way to write the rules is as
+</p>
+<div class="smallexample">
+<pre class="smallexample">@echo 'This command is intended for maintainers to
use; it'
address@hidden 'deletes files that may need special tools to rebuild.'
+</pre></div>
+
+</dd>
+<dt>‘<samp>TAGS</samp>’</dt>
+<dd><p>Update a tags table for this program.
+</p>
+</dd>
+<dt>‘<samp>info</samp>’</dt>
+<dd><p>Generate any Info files needed. The best way to write the rules is as
follows:
+</p>
+<div class="smallexample">
+<pre class="smallexample">info: foo.info
- <pre class="smallexample"> info: foo.info
-
- foo.info: foo.texi chap1.texi chap2.texi
+foo.info: foo.texi chap1.texi chap2.texi
$(MAKEINFO) $(srcdir)/foo.texi
-</pre>
- <p class="noindent">You must define the variable <code>MAKEINFO</code> in
the Makefile. It should
+</pre></div>
+
+<p>You must define the variable <code>MAKEINFO</code> in the Makefile. It
should
run the <code>makeinfo</code> program, which is part of the Texinfo
distribution.
-
- <p>Normally a GNU distribution comes with Info files, and that means the
+</p>
+<p>Normally a GNU distribution comes with Info files, and that means the
Info files are present in the source directory. Therefore, the Make
rule for an info file should update it in the source directory. When
users build the package, ordinarily Make will not update the Info files
because they will already be up to date.
-
- <br><dt>‘<samp><span
class="samp">dvi</span></samp>’<dt>‘<samp><span
class="samp">html</span></samp>’<dt>‘<samp><span
class="samp">pdf</span></samp>’<dt>‘<samp><span
class="samp">ps</span></samp>’<dd>Generate documentation files in the
given format. These targets
+</p>
+</dd>
+<dt>‘<samp>dvi</samp>’</dt>
+<dt>‘<samp>html</samp>’</dt>
+<dt>‘<samp>pdf</samp>’</dt>
+<dt>‘<samp>ps</samp>’</dt>
+<dd><p>Generate documentation files in the given format. These targets
should always exist, but any or all can be a no-op if the given output
format cannot be generated. These targets should not be dependencies
of the <code>all</code> target; the user must manually invoke them.
+</p>
+<p>Here’s an example rule for generating DVI files from Texinfo:
+</p>
+<div class="smallexample">
+<pre class="smallexample">dvi: foo.dvi
- <p>Here's an example rule for generating DVI files from Texinfo:
-
- <pre class="smallexample"> dvi: foo.dvi
-
- foo.dvi: foo.texi chap1.texi chap2.texi
+foo.dvi: foo.texi chap1.texi chap2.texi
$(TEXI2DVI) $(srcdir)/foo.texi
-</pre>
- <p class="noindent">You must define the variable <code>TEXI2DVI</code> in
the Makefile. It
+</pre></div>
+
+<p>You must define the variable <code>TEXI2DVI</code> in the Makefile. It
should run the program <code>texi2dvi</code>, which is part of the Texinfo
distribution. (<code>texi2dvi</code> uses TeX to do the real work of
formatting. TeX is not distributed with Texinfo.) Alternatively,
write only the dependencies, and allow GNU <code>make</code> to provide the
command.
+</p>
+<p>Here’s another example, this one for generating HTML from Texinfo:
+</p>
+<div class="smallexample">
+<pre class="smallexample">html: foo.html
- <p>Here's another example, this one for generating HTML from Texinfo:
-
- <pre class="smallexample"> html: foo.html
-
- foo.html: foo.texi chap1.texi chap2.texi
+foo.html: foo.texi chap1.texi chap2.texi
$(TEXI2HTML) $(srcdir)/foo.texi
-</pre>
- <p class="noindent">Again, you would define the variable
<code>TEXI2HTML</code> in the Makefile;
-for example, it might run <code>makeinfo --no-split --html</code>
-(<samp><span class="command">makeinfo</span></samp> is part of the Texinfo
distribution).
+</pre></div>
- <br><dt>‘<samp><span
class="samp">dist</span></samp>’<dd>Create a distribution tar file for
this program. The tar file should be
+<p>Again, you would define the variable <code>TEXI2HTML</code> in the Makefile;
+for example, it might run <code>makeinfo --no-split --html</code>
+(<code>makeinfo</code> is part of the Texinfo distribution).
+</p>
+</dd>
+<dt>‘<samp>dist</samp>’</dt>
+<dd><p>Create a distribution tar file for this program. The tar file should be
set up so that the file names in the tar file start with a subdirectory
name which is the name of the package it is a distribution for. This
name can include the version number.
-
- <p>For example, the distribution tar file of GCC version 1.40 unpacks into
-a subdirectory named <samp><span class="file">gcc-1.40</span></samp>.
-
- <p>The easiest way to do this is to create a subdirectory appropriately
+</p>
+<p>For example, the distribution tar file of GCC version 1.40 unpacks into
+a subdirectory named ‘<tt>gcc-1.40</tt>’.
+</p>
+<p>The easiest way to do this is to create a subdirectory appropriately
named, use <code>ln</code> or <code>cp</code> to install the proper files in
it, and
then <code>tar</code> that subdirectory.
-
- <p>Compress the tar file with <code>gzip</code>. For example, the actual
-distribution file for GCC version 1.40 is called <samp><span
class="file">gcc-1.40.tar.gz</span></samp>.
+</p>
+<p>Compress the tar file with <code>gzip</code>. For example, the actual
+distribution file for GCC version 1.40 is called
‘<tt>gcc-1.40.tar.gz</tt>’.
It is ok to support other free compression formats as well.
-
- <p>The <code>dist</code> target should explicitly depend on all
non-source files
+</p>
+<p>The <code>dist</code> target should explicitly depend on all non-source
files
that are in the distribution, to make sure they are up to date in the
distribution.
See <a href="Releases.html#Releases">Making Releases</a>.
-
- <br><dt>‘<samp><span
class="samp">check</span></samp>’<dd>Perform self-tests (if any). The
user must build the program before
+</p>
+</dd>
+<dt>‘<samp>check</samp>’</dt>
+<dd><p>Perform self-tests (if any). The user must build the program before
running the tests, but need not install the program; you should write
the self-tests so that they work when the program is built but not
installed.
+</p></dd>
</dl>
- <p>The following targets are suggested as conventional names, for programs
+<p>The following targets are suggested as conventional names, for programs
in which they are useful.
-
- <dl>
-<dt><code>installcheck</code><dd>Perform installation tests (if any). The
user must build and install
+</p>
+<dl compact="compact">
+<dt><code>installcheck</code></dt>
+<dd><p>Perform installation tests (if any). The user must build and install
the program before running the tests. You should not assume that
-<samp><span class="file">$(bindir)</span></samp> is in the search path.
-
- <br><dt><code>installdirs</code><dd>It's useful to add a target named
‘<samp><span class="samp">installdirs</span></samp>’ to create the
+‘<tt>$(bindir)</tt>’ is in the search path.
+</p>
+</dd>
+<dt><code>installdirs</code></dt>
+<dd><p>It’s useful to add a target named
‘<samp>installdirs</samp>’ to create the
directories where files are installed, and their parent directories.
-There is a script called <samp><span class="file">mkinstalldirs</span></samp>
which is convenient for
+There is a script called ‘<tt>mkinstalldirs</tt>’ which is
convenient for
this; you can find it in the Gnulib package.
You can use a rule like this:
-
- <!-- This has been carefully formatted to look decent in the Make manual.
-->
- <!-- Please be sure not to make it extend any further to the
right.-roland -->
- <pre class="smallexample"> # Make sure all installation
directories (e.g. $(bindir))
- # actually exist by making them if necessary.
- installdirs: mkinstalldirs
+</p>
+<div class="smallexample">
+<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+# actually exist by making them if necessary.
+installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs $(bindir) $(datadir) \
$(libdir) $(infodir) \
$(mandir)
-</pre>
- <p class="noindent">or, if you wish to support <samp><span
class="env">DESTDIR</span></samp> (strongly encouraged),
+</pre></div>
- <pre class="smallexample"> # Make sure all installation
directories (e.g. $(bindir))
- # actually exist by making them if necessary.
- installdirs: mkinstalldirs
+<p>or, if you wish to support <code>DESTDIR</code> (strongly encouraged),
+</p>
+<div class="smallexample">
+<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+# actually exist by making them if necessary.
+installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs \
$(DESTDIR)$(bindir) $(DESTDIR)$(datadir) \
$(DESTDIR)$(libdir) $(DESTDIR)$(infodir) \
$(DESTDIR)$(mandir)
-</pre>
- <p>This rule should not modify the directories where compilation is done.
+</pre></div>
+
+<p>This rule should not modify the directories where compilation is done.
It should do nothing but create installation directories.
+</p></dd>
</dl>
- </body></html>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Install-Command-Categories.html#Install-Command-Categories"
accesskey="n" rel="next">Install Command Categories</a>, Previous: <a
href="Directory-Variables.html#Directory-Variables" accesskey="p"
rel="previous">Directory Variables</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
+
+</body>
+</html>
Index: standards/html_node/Style-of-Change-Logs.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Style-of-Change-Logs.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Style-of-Change-Logs.html 8 Apr 2012 00:23:56
-0000 1.54
+++ standards/html_node/Style-of-Change-Logs.html 7 May 2012 00:48:10
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Style of Change Logs - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Change-Logs.html#Change-Logs" title="Change Logs">
-<link rel="prev" href="Change-Log-Concepts.html#Change-Log-Concepts"
title="Change Log Concepts">
-<link rel="next" href="Simple-Changes.html#Simple-Changes" title="Simple
Changes">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,91 +11,137 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Style of Change Logs</title>
+
+<meta name="description" content="GNU Coding Standards: Style of Change Logs">
+<meta name="keywords" content="GNU Coding Standards: Style of Change Logs">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Change-Logs.html#Change-Logs" rel="up" title="Change Logs">
+<link href="Simple-Changes.html#Simple-Changes" rel="next" title="Simple
Changes">
+<link href="Change-Log-Concepts.html#Change-Log-Concepts" rel="previous"
title="Change Log Concepts">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Style-of-Change-Logs"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Simple-Changes.html#Simple-Changes">Simple Changes</a>,
-Previous: <a rel="previous" accesskey="p"
href="Change-Log-Concepts.html#Change-Log-Concepts">Change Log Concepts</a>,
-Up: <a rel="up" accesskey="u" href="Change-Logs.html#Change-Logs">Change
Logs</a>
-<hr>
+Next: <a href="Simple-Changes.html#Simple-Changes" accesskey="n"
rel="next">Simple Changes</a>, Previous: <a
href="Change-Log-Concepts.html#Change-Log-Concepts" accesskey="p"
rel="previous">Change Log Concepts</a>, Up: <a
href="Change-Logs.html#Change-Logs" accesskey="u" rel="up">Change Logs</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Style-of-Change-Logs-1"></a>
<h4 class="subsection">6.8.2 Style of Change Logs</h4>
+<a name="index-change-logs_002c-style"></a>
-<p><a name="index-change-logs_002c-style-137"></a>
-Here are some simple examples of change log entries, starting with the
+<p>Here are some simple examples of change log entries, starting with the
header line that says who made the change and when it was installed,
followed by descriptions of specific changes. (These examples are
drawn from Emacs and GCC.)
+</p>
+<div class="example">
+<pre class="example">1998-08-17 Richard Stallman <address@hidden>
+
+* register.el (insert-register): Return nil.
+(jump-to-register): Likewise.
+
+* sort.el (sort-subr): Return nil.
+
+* tex-mode.el (tex-bibtex-file, tex-file, tex-region):
+Restart the tex shell if process is gone or stopped.
+(tex-shell-running): New function.
+
+* expr.c (store_one_arg): Round size up for move_block_to_reg.
+(expand_call): Round up when emitting USE insns.
+* stmt.c (assign_parms): Round size up for move_block_from_reg.
+</pre></div>
-<pre class="example"> 1998-08-17 Richard Stallman <address@hidden>
-
- * register.el (insert-register): Return nil.
- (jump-to-register): Likewise.
-
- * sort.el (sort-subr): Return nil.
-
- * tex-mode.el (tex-bibtex-file, tex-file, tex-region):
- Restart the tex shell if process is gone or stopped.
- (tex-shell-running): New function.
-
- * expr.c (store_one_arg): Round size up for move_block_to_reg.
- (expand_call): Round up when emitting USE insns.
- * stmt.c (assign_parms): Round size up for move_block_from_reg.
-</pre>
- <p>It's important to name the changed function or variable in full. Don't
-abbreviate function or variable names, and don't combine them.
+<p>It’s important to name the changed function or variable in full.
Don’t
+abbreviate function or variable names, and don’t combine them.
Subsequent maintainers will often search for a function name to find all
the change log entries that pertain to it; if you abbreviate the name,
-they won't find it when they search.
-
- <p>For example, some people are tempted to abbreviate groups of function
-names by writing ‘<samp><span class="samp">* register.el
({insert,jump-to}-register)</span></samp>’;
+they won’t find it when they search.
+</p>
+<p>For example, some people are tempted to abbreviate groups of function
+names by writing ‘<samp>* register.el
({insert,jump-to}-register)</samp>’;
this is not a good idea, since searching for <code>jump-to-register</code> or
<code>insert-register</code> would not find that entry.
-
- <p>Separate unrelated change log entries with blank lines. When two
+</p>
+<p>Separate unrelated change log entries with blank lines. When two
entries represent parts of the same change, so that they work together,
-then don't put blank lines between them. Then you can omit the file
+then don’t put blank lines between them. Then you can omit the file
name and the asterisk when successive entries are in the same file.
+</p>
+<p>Break long lists of function names by closing continued lines with
+‘<samp>)</samp>’, rather than ‘<samp>,</samp>’, and
opening the continuation with
+‘<samp>(</samp>’ as in this example:
+</p>
+<div class="example">
+<pre class="example">* keyboard.c (menu_bar_items, tool_bar_items)
+(Fexecute_extended_command): Deal with 'keymap' property.
+</pre></div>
- <p>Break long lists of function names by closing continued lines with
-‘<samp><span class="samp">)</span></samp>’, rather than
‘<samp><span class="samp">,</span></samp>’, and opening the
continuation with
-‘<samp><span class="samp">(</span></samp>’ as in this example:
-
-<pre class="example"> * keyboard.c (menu_bar_items, tool_bar_items)
- (Fexecute_extended_command): Deal with 'keymap' property.
-</pre>
- <p>When you install someone else's changes, put the contributor's name in
+<p>When you install someone else’s changes, put the contributor’s
name in
the change log entry rather than in the text of the entry. In other
words, write this:
-
-<pre class="example"> 2002-07-14 John Doe <address@hidden>
+</p>
+<div class="example">
+<pre class="example">2002-07-14 John Doe <address@hidden>
* sewing.c: Make it sew.
-</pre>
- <p class="noindent">rather than this:
+</pre></div>
-<pre class="example"> 2002-07-14 Usual Maintainer <address@hidden>
+<p>rather than this:
+</p>
+<div class="example">
+<pre class="example">2002-07-14 Usual Maintainer <address@hidden>
* sewing.c: Make it sew. Patch by address@hidden
-</pre>
- <p>As for the date, that should be the date you applied the change.
+</pre></div>
+
+<p>As for the date, that should be the date you applied the change.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Simple-Changes.html#Simple-Changes" accesskey="n"
rel="next">Simple Changes</a>, Previous: <a
href="Change-Log-Concepts.html#Change-Log-Concepts" accesskey="p"
rel="previous">Change Log Concepts</a>, Up: <a
href="Change-Logs.html#Change-Logs" accesskey="u" rel="up">Change Logs</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Syntactic-Conventions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Syntactic-Conventions.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Syntactic-Conventions.html 8 Apr 2012 00:23:56
-0000 1.54
+++ standards/html_node/Syntactic-Conventions.html 7 May 2012 00:48:10
-0000 1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Syntactic Conventions - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="Comments.html#Comments" title="Comments">
-<link rel="next" href="Names.html#Names" title="Names">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,61 +11,98 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Syntactic Conventions</title>
+
+<meta name="description" content="GNU Coding Standards: Syntactic Conventions">
+<meta name="keywords" content="GNU Coding Standards: Syntactic Conventions">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Names.html#Names" rel="next" title="Names">
+<link href="Comments.html#Comments" rel="previous" title="Comments">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Syntactic-Conventions"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="Names.html#Names">Names</a>,
-Previous: <a rel="previous" accesskey="p"
href="Comments.html#Comments">Comments</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="Names.html#Names" accesskey="n" rel="next">Names</a>, Previous:
<a href="Comments.html#Comments" accesskey="p" rel="previous">Comments</a>, Up:
<a href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Clean-Use-of-C-Constructs"></a>
<h3 class="section">5.3 Clean Use of C Constructs</h3>
+<a name="index-syntactic-conventions"></a>
-<p><a name="index-syntactic-conventions-89"></a>
-<a name="index-implicit-_0040code_007bint_007d-90"></a><a
name="index-function-argument_002c-declaring-91"></a>Please explicitly declare
the types of all objects. For example, you
+<a name="index-implicit-int"></a>
+<a name="index-function-argument_002c-declaring"></a>
+<p>Please explicitly declare the types of all objects. For example, you
should explicitly declare all arguments to functions, and you should
declare functions to return <code>int</code> rather than omitting the
<code>int</code>.
-
- <p><a name="index-compiler-warnings-92"></a><a
name="index-g_t_0040samp_007b_002dWall_007d-compiler-option-93"></a>Some
programmers like to use the GCC ‘<samp><span
class="samp">-Wall</span></samp>’ option, and change the
+</p>
+<a name="index-compiler-warnings"></a>
+<a name="index-_002dWall-compiler-option"></a>
+<p>Some programmers like to use the GCC ‘<samp>-Wall</samp>’
option, and change the
code whenever it issues a warning. If you want to do this, then do.
-Other programmers prefer not to use ‘<samp><span
class="samp">-Wall</span></samp>’, because it gives
+Other programmers prefer not to use ‘<samp>-Wall</samp>’, because
it gives
warnings for valid and legitimate code which they do not want to change.
If you want to do this, then do. The compiler should be your servant,
not your master.
-
- <p><a name="index-clang-94"></a><a name="index-lint-95"></a>Don't make the
program ugly just to placate static analysis tools such
-as <samp><span class="command">lint</span></samp>, <samp><span
class="command">clang</span></samp>, and GCC with extra warnings
-options such as <samp><span class="option">-Wconversion</span></samp> and
<samp><span class="option">-Wundef</span></samp>. These
+</p>
+<a name="index-clang"></a>
+<a name="index-lint"></a>
+<p>Don’t make the program ugly just to placate static analysis tools such
+as <code>lint</code>, <code>clang</code>, and GCC with extra warnings
+options such as ‘<samp>-Wconversion</samp>’ and
‘<samp>-Wundef</samp>’. These
tools can help find bugs and unclear code, but they can also generate
so many false alarms that it hurts readability to silence them with
unnecessary casts, wrappers, and other complications. For example,
-please don't insert casts to <code>void</code> or calls to do-nothing
+please don’t insert casts to <code>void</code> or calls to do-nothing
functions merely to pacify a lint checker.
-
- <p>Declarations of external functions and functions to appear later in the
+</p>
+<p>Declarations of external functions and functions to appear later in the
source file should all go in one place near the beginning of the file
(somewhere before the first function definition in the file), or else
-should go in a header file. Don't put <code>extern</code> declarations inside
+should go in a header file. Don’t put <code>extern</code> declarations
inside
functions.
-
- <p><a name="index-temporary-variables-96"></a>It used to be common practice
to use the same local variables (with
+</p>
+<a name="index-temporary-variables"></a>
+<p>It used to be common practice to use the same local variables (with
names like <code>tem</code>) over and over for different values within one
function. Instead of doing this, it is better to declare a separate local
variable for each distinct purpose, and give it a name which is
@@ -83,88 +110,115 @@
facilitates optimization by good compilers. You can also move the
declaration of each local variable into the smallest scope that includes
all its uses. This makes the program even cleaner.
-
- <p>Don't use local variables or parameters that shadow global identifiers.
-GCC's ‘<samp><span class="samp">-Wshadow</span></samp>’ option can
detect this problem.
-
- <p><a name="index-multiple-variables-in-a-line-97"></a>Don't declare
multiple variables in one declaration that spans lines.
+</p>
+<p>Don’t use local variables or parameters that shadow global
identifiers.
+GCC’s ‘<samp>-Wshadow</samp>’ option can detect this problem.
+</p>
+<a name="index-multiple-variables-in-a-line"></a>
+<p>Don’t declare multiple variables in one declaration that spans lines.
Start a new declaration on each line, instead. For example, instead
of this:
-
-<pre class="example"> int foo,
+</p>
+<div class="example">
+<pre class="example">int foo,
bar;
-</pre>
- <p class="noindent">write either this:
+</pre></div>
-<pre class="example"> int foo, bar;
-</pre>
- <p class="noindent">or this:
-
-<pre class="example"> int foo;
- int bar;
-</pre>
- <p class="noindent">(If they are global variables, each should have a
comment preceding it
-anyway.)
+<p>write either this:
+</p>
+<div class="example">
+<pre class="example">int foo, bar;
+</pre></div>
+
+<p>or this:
+</p>
+<div class="example">
+<pre class="example">int foo;
+int bar;
+</pre></div>
- <p>When you have an <code>if</code>-<code>else</code> statement nested in
another
+<p>(If they are global variables, each should have a comment preceding it
+anyway.)
+</p>
+<p>When you have an <code>if</code>-<code>else</code> statement nested in
another
<code>if</code> statement, always put braces around the
<code>if</code>-<code>else</code>.
Thus, never write like this:
-
-<pre class="example"> if (foo)
+</p>
+<div class="example">
+<pre class="example">if (foo)
if (bar)
win ();
else
lose ();
-</pre>
- <p class="noindent">always like this:
+</pre></div>
-<pre class="example"> if (foo)
+<p>always like this:
+</p>
+<div class="example">
+<pre class="example">if (foo)
{
if (bar)
win ();
else
lose ();
}
-</pre>
- <p>If you have an <code>if</code> statement nested inside of an
<code>else</code>
+</pre></div>
+
+<p>If you have an <code>if</code> statement nested inside of an
<code>else</code>
statement, either write <code>else if</code> on one line, like this,
+</p>
+<div class="example">
+<pre class="example">if (foo)
+ …
+else if (bar)
+ …
+</pre></div>
-<pre class="example"> if (foo)
- ...
- else if (bar)
- ...
-</pre>
- <p class="noindent">with its <code>then</code>-part indented like the
preceding <code>then</code>-part,
+<p>with its <code>then</code>-part indented like the preceding
<code>then</code>-part,
or write the nested <code>if</code> within braces like this:
-
-<pre class="example"> if (foo)
- ...
- else
+</p>
+<div class="example">
+<pre class="example">if (foo)
+ …
+else
{
if (bar)
- ...
+ …
}
-</pre>
- <p>Don't declare both a structure tag and variables or typedefs in the
+</pre></div>
+
+<p>Don’t declare both a structure tag and variables or typedefs in the
same declaration. Instead, declare the structure tag separately
and then use it to declare the variables or typedefs.
-
- <p>Try to avoid assignments inside <code>if</code>-conditions (assignments
-inside <code>while</code>-conditions are ok). For example, don't write
+</p>
+<p>Try to avoid assignments inside <code>if</code>-conditions (assignments
+inside <code>while</code>-conditions are ok). For example, don’t write
this:
+</p>
+<div class="example">
+<pre class="example">if ((foo = (char *) malloc (sizeof *foo)) == 0)
+ fatal ("virtual memory exhausted");
+</pre></div>
+
+<p>instead, write this:
+</p>
+<div class="example">
+<pre class="example">foo = (char *) malloc (sizeof *foo);
+if (foo == 0)
+ fatal ("virtual memory exhausted");
+</pre></div>
-<pre class="example"> if ((foo = (char *) malloc (sizeof *foo)) == 0)
- fatal ("virtual memory exhausted");
-</pre>
- <p class="noindent">instead, write this:
-
-<pre class="example"> foo = (char *) malloc (sizeof *foo);
- if (foo == 0)
- fatal ("virtual memory exhausted");
-</pre>
- <p>This example uses zero without a cast as a null pointer constant.
+<p>This example uses zero without a cast as a null pointer constant.
This is perfectly fine, except that a cast is needed when calling a
varargs function or when using <code>sizeof</code>.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Names.html#Names" accesskey="n" rel="next">Names</a>, Previous:
<a href="Comments.html#Comments" accesskey="p" rel="previous">Comments</a>, Up:
<a href="Writing-C.html#Writing-C" accesskey="u" rel="up">Writing C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/System-Functions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/System-Functions.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/System-Functions.html 8 Apr 2012 00:23:56 -0000
1.54
+++ standards/html_node/System-Functions.html 7 May 2012 00:48:10 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>System Functions - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="CPU-Portability.html#CPU-Portability" title="CPU
Portability">
-<link rel="next" href="Internationalization.html#Internationalization"
title="Internationalization">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,84 +11,139 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: System Functions</title>
+
+<meta name="description" content="GNU Coding Standards: System Functions">
+<meta name="keywords" content="GNU Coding Standards: System Functions">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="Internationalization.html#Internationalization" rel="next"
title="Internationalization">
+<link href="CPU-Portability.html#CPU-Portability" rel="previous" title="CPU
Portability">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="System-Functions"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Internationalization.html#Internationalization">Internationalization</a>,
-Previous: <a rel="previous" accesskey="p"
href="CPU-Portability.html#CPU-Portability">CPU Portability</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="Internationalization.html#Internationalization" accesskey="n"
rel="next">Internationalization</a>, Previous: <a
href="CPU-Portability.html#CPU-Portability" accesskey="p" rel="previous">CPU
Portability</a>, Up: <a href="Writing-C.html#Writing-C" accesskey="u"
rel="up">Writing C</a> [<a href="index.html#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="Index.html#Index"
title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Calling-System-Functions"></a>
<h3 class="section">5.7 Calling System Functions</h3>
-<p><a name="index-C-library-functions_002c-and-portability-107"></a><a
name="index-POSIX-functions_002c-and-portability-108"></a><a
name="index-library-functions_002c-and-portability-109"></a><a
name="index-portability_002c-and-library-functions-110"></a>
-Historically, C implementations differed substantially, and many
+<a name="index-C-library-functions_002c-and-portability"></a>
+<a name="index-POSIX-functions_002c-and-portability"></a>
+<a name="index-library-functions_002c-and-portability"></a>
+<a name="index-portability_002c-and-library-functions"></a>
+
+<p>Historically, C implementations differed substantially, and many
systems lacked a full implementation of ANSI/ISO C89. Nowadays,
however, very few systems lack a C89 compiler and GNU C supports
almost all of C99. Similarly, most systems implement POSIX.1-1993
libraries and tools, and many have POSIX.1-2001.
-
- <p>Hence, there is little reason to support old C or non-POSIX systems,
+</p>
+<p>Hence, there is little reason to support old C or non-POSIX systems,
and you may want to take advantage of C99 and POSIX-1.2001 to write
clearer, more portable, or faster code. You should use standard
interfaces where possible; but if GNU extensions make your program
-more maintainable, powerful, or otherwise better, don't hesitate to
-use them. In any case, don't make your own declaration of system
-functions; that's a recipe for conflict.
-
- <p>Despite the standards, nearly every library function has some sort of
+more maintainable, powerful, or otherwise better, don’t hesitate to
+use them. In any case, don’t make your own declaration of system
+functions; that’s a recipe for conflict.
+</p>
+<p>Despite the standards, nearly every library function has some sort of
portability issue on some system or another. Here are some examples:
-
- <dl>
-<dt><code>open</code><dd>Names with trailing <code>/</code>'s are mishandled
on many platforms.
-
- <br><dt><code>printf</code><dd><code>long double</code> may be
unimplemented; floating values Infinity and
+</p>
+<dl compact="compact">
+<dt><code>open</code></dt>
+<dd><p>Names with trailing <code>/</code>’s are mishandled on many
platforms.
+</p>
+</dd>
+<dt><code>printf</code></dt>
+<dd><p><code>long double</code> may be unimplemented; floating values Infinity
and
NaN are often mishandled; output for large precisions may be
incorrect.
-
- <br><dt><code>readlink</code><dd>May return <code>int</code> instead of
<code>ssize_t</code>.
-
- <br><dt><code>scanf</code><dd>On Windows, <code>errno</code> is not set
on failure.
+</p>
+</dd>
+<dt><code>readlink</code></dt>
+<dd><p>May return <code>int</code> instead of <code>ssize_t</code>.
+</p>
+</dd>
+<dt><code>scanf</code></dt>
+<dd><p>On Windows, <code>errno</code> is not set on failure.
+</p></dd>
</dl>
- <p><a name="index-Gnulib-111"></a><a
href="http://www.gnu.org/software/gnulib/";>Gnulib</a> is a big help in
+<a name="index-Gnulib"></a>
+<p><a href="http://www.gnu.org/software/gnulib/";>Gnulib</a> is a big help in
this regard. Gnulib provides implementations of standard interfaces
on many of the systems that lack them, including portable
implementations of enhanced GNU interfaces, thereby making their use
portable, and of POSIX-1.2008 interfaces, some of which are missing
even on up-to-date GNU systems.
-
- <p><a name="index-xmalloc_002c-in-Gnulib-112"></a><a
name="index-error-messages_002c-in-Gnulib-113"></a><a
name="index-data-structures_002c-in-Gnulib-114"></a>Gnulib also provides many
useful non-standard interfaces; for example,
+</p>
+<a name="index-xmalloc_002c-in-Gnulib"></a>
+<a name="index-error-messages_002c-in-Gnulib"></a>
+<a name="index-data-structures_002c-in-Gnulib"></a>
+<p>Gnulib also provides many useful non-standard interfaces; for example,
C implementations of standard data structures (hash tables, binary
trees), error-checking type-safe wrappers for memory allocation
functions (<code>xmalloc</code>, <code>xrealloc</code>), and output of error
messages.
-
- <p>Gnulib integrates with GNU Autoconf and Automake to remove much of the
+</p>
+<p>Gnulib integrates with GNU Autoconf and Automake to remove much of the
burden of writing portable code from the programmer: Gnulib makes your
configure script automatically determine what features are missing and
use the Gnulib code to supply the missing pieces.
-
- <p>The Gnulib and Autoconf manuals have extensive sections on
-portability: <a href="../gnulib/index.html#Top">Introduction</a> and
-see <a
href="../autoconf/Portable-C-and-C_002b_002b.html#Portable-C-and-C_002b_002b">Portable
C and C++</a>. Please consult them
+</p>
+<p>The Gnulib and Autoconf manuals have extensive sections on
+portability: <a
href="http://www.gnu.org/software/gnulib/manual/html_node/index.html#Top";>Introduction</a>
in <cite>Gnulib</cite> and
+see <a
href="http://www.gnu.org/software/autoconf/manual/html_node/Portable-C-and-C_002b_002b.html#Portable-C-and-C_002b_002b";>Portable
C and C++</a> in <cite>Autoconf</cite>. Please consult them
for many more details.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Internationalization.html#Internationalization" accesskey="n"
rel="next">Internationalization</a>, Previous: <a
href="CPU-Portability.html#CPU-Portability" accesskey="p" rel="previous">CPU
Portability</a>, Up: <a href="Writing-C.html#Writing-C" accesskey="u"
rel="up">Writing C</a> [<a href="index.html#SEC_Contents" title="Table
of contents" rel="contents">Contents</a>][<a href="Index.html#Index"
title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/System-Portability.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/System-Portability.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/System-Portability.html 8 Apr 2012 00:23:56 -0000
1.54
+++ standards/html_node/System-Portability.html 7 May 2012 00:48:10 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>System Portability - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Writing-C.html#Writing-C" title="Writing C">
-<link rel="prev" href="Names.html#Names" title="Names">
-<link rel="next" href="CPU-Portability.html#CPU-Portability" title="CPU
Portability">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,85 +11,125 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: System Portability</title>
+
+<meta name="description" content="GNU Coding Standards: System Portability">
+<meta name="keywords" content="GNU Coding Standards: System Portability">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Writing-C.html#Writing-C" rel="up" title="Writing C">
+<link href="CPU-Portability.html#CPU-Portability" rel="next" title="CPU
Portability">
+<link href="Names.html#Names" rel="previous" title="Names">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="System-Portability"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="CPU-Portability.html#CPU-Portability">CPU Portability</a>,
-Previous: <a rel="previous" accesskey="p"
href="Names.html#Names">Names</a>,
-Up: <a rel="up" accesskey="u" href="Writing-C.html#Writing-C">Writing
C</a>
-<hr>
+Next: <a href="CPU-Portability.html#CPU-Portability" accesskey="n"
rel="next">CPU Portability</a>, Previous: <a href="Names.html#Names"
accesskey="p" rel="previous">Names</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Portability-between-System-Types"></a>
<h3 class="section">5.5 Portability between System Types</h3>
+<a name="index-portability_002c-between-system-types"></a>
-<p><a name="index-portability_002c-between-system-types-101"></a>
-In the Unix world, “portability” refers to porting to different
Unix
+<p>In the Unix world, “portability” refers to porting to different
Unix
versions. For a GNU program, this kind of portability is desirable, but
not paramount.
-
- <p>The primary purpose of GNU software is to run on top of the GNU kernel,
-compiled with the GNU C compiler, on various types of <span
class="sc">cpu</span>. So the
+</p>
+<p>The primary purpose of GNU software is to run on top of the GNU kernel,
+compiled with the GNU C compiler, on various types of <small>CPU</small>. So
the
kinds of portability that are absolutely necessary are quite limited.
But it is important to support Linux-based GNU systems, since they
are the form of GNU that is popular.
-
- <p>Beyond that, it is good to support the other free operating systems
+</p>
+<p>Beyond that, it is good to support the other free operating systems
(*BSD), and it is nice to support other Unix-like systems if you want
to. Supporting a variety of Unix-like systems is desirable, although
not paramount. It is usually not too hard, so you may as well do it.
-But you don't have to consider it an obligation, if it does turn out to
+But you don’t have to consider it an obligation, if it does turn out to
be hard.
-
- <p><a name="index-autoconf-102"></a>The easiest way to achieve portability
to most Unix-like systems is to
-use Autoconf. It's unlikely that your program needs to know more
+</p>
+<a name="index-autoconf"></a>
+<p>The easiest way to achieve portability to most Unix-like systems is to
+use Autoconf. It’s unlikely that your program needs to know more
information about the host platform than Autoconf can provide, simply
because most of the programs that need such knowledge have already been
written.
-
- <p>Avoid using the format of semi-internal data bases (e.g., directories)
+</p>
+<p>Avoid using the format of semi-internal data bases (e.g., directories)
when there is a higher-level alternative (<code>readdir</code>).
-
- <p><a
name="index-non_002d_0040sc_007bposix_007d-systems_002c-and-portability-103"></a>As
for systems that are not like Unix, such as MSDOS, Windows, VMS, MVS,
+</p>
+<a name="index-non_002dPOSIX-systems_002c-and-portability"></a>
+<p>As for systems that are not like Unix, such as MSDOS, Windows, VMS, MVS,
and older Macintosh systems, supporting them is often a lot of work.
When that is the case, it is better to spend your time adding features
that will be useful on GNU and GNU/Linux, rather than on supporting
other incompatible systems.
-
- <p>If you do support Windows, please do not abbreviate it as
“win”. In
+</p>
+<p>If you do support Windows, please do not abbreviate it as
“win”. In
hacker terminology, calling something a “win” is a form of praise.
-You're free to praise Microsoft Windows on your own if you want, but
-please don't do this in GNU packages. Instead of abbreviating
+You’re free to praise Microsoft Windows on your own if you want, but
+please don’t do this in GNU packages. Instead of abbreviating
“Windows” to “win”, you can write it in full or
abbreviate it to
-“woe” or “w”. In GNU Emacs, for instance, we use
‘<samp><span class="samp">w32</span></samp>’ in
+“woe” or “w”. In GNU Emacs, for instance, we use
‘<samp>w32</samp>’ in
file names of Windows-specific files, but the macro for Windows
conditionals is called <code>WINDOWSNT</code>.
-
- <p>It is a good idea to define the “feature test macro”
+</p>
+<p>It is a good idea to define the “feature test macro”
<code>_GNU_SOURCE</code> when compiling your C files. When you compile on GNU
or GNU/Linux, this will enable the declarations of GNU library extension
functions, and that will usually give you a compiler error message if
you define the same function names in some other way in your program.
-(You don't have to actually <em>use</em> these functions, if you prefer
+(You don’t have to actually <em>use</em> these functions, if you prefer
to make the program more portable to other systems.)
-
- <p>But whether or not you use these GNU extensions, you should avoid
+</p>
+<p>But whether or not you use these GNU extensions, you should avoid
using their names for any other meanings. Doing so would make it hard
to move your code into other GNU programs.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="CPU-Portability.html#CPU-Portability" accesskey="n"
rel="next">CPU Portability</a>, Previous: <a href="Names.html#Names"
accesskey="p" rel="previous">Names</a>, Up: <a href="Writing-C.html#Writing-C"
accesskey="u" rel="up">Writing C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Trademarks.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Trademarks.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Trademarks.html 8 Apr 2012 00:23:56 -0000 1.54
+++ standards/html_node/Trademarks.html 7 May 2012 00:48:10 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Trademarks - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Legal-Issues.html#Legal-Issues" title="Legal Issues">
-<link rel="prev" href="Contributions.html#Contributions" title="Contributions">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,41 +11,72 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Trademarks</title>
+
+<meta name="description" content="GNU Coding Standards: Trademarks">
+<meta name="keywords" content="GNU Coding Standards: Trademarks">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Legal-Issues.html#Legal-Issues" rel="up" title="Legal Issues">
+<link href="Design-Advice.html#Design-Advice" rel="next" title="Design Advice">
+<link href="Contributions.html#Contributions" rel="previous"
title="Contributions">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Trademarks"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="Contributions.html#Contributions">Contributions</a>,
-Up: <a rel="up" accesskey="u" href="Legal-Issues.html#Legal-Issues">Legal
Issues</a>
-<hr>
+Previous: <a href="Contributions.html#Contributions" accesskey="p"
rel="previous">Contributions</a>, Up: <a href="Legal-Issues.html#Legal-Issues"
accesskey="u" rel="up">Legal Issues</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Trademarks-1"></a>
<h3 class="section">2.3 Trademarks</h3>
+<a name="index-trademarks"></a>
-<p><a name="index-trademarks-12"></a>
-Please do not include any trademark acknowledgements in GNU software
+<p>Please do not include any trademark acknowledgements in GNU software
packages or documentation.
-
- <p>Trademark acknowledgements are the statements that such-and-such is a
+</p>
+<p>Trademark acknowledgements are the statements that such-and-such is a
trademark of so-and-so. The GNU Project has no objection to the basic
idea of trademarks, but these acknowledgements feel like kowtowing,
-and there is no legal requirement for them, so we don't use them.
-
- <p>What is legally required, as regards other people's trademarks, is to
+and there is no legal requirement for them, so we don’t use them.
+</p>
+<p>What is legally required, as regards other people’s trademarks, is to
avoid using them in ways which a reader might reasonably understand as
naming or labeling our own programs or activities. For example, since
“Objective C” is (or at least was) a trademark, we made sure to say
@@ -63,15 +85,18 @@
a shorter way of saying the former, but it does not explicitly state
the relationship, so it could be misinterpreted as using “Objective
C” as a label for the compiler rather than for the language.
-
- <p>Please don't use “win” as an abbreviation for Microsoft
Windows in
+</p>
+<p>Please don’t use “win” as an abbreviation for Microsoft
Windows in
GNU software or documentation. In hacker terminology, calling
something a “win” is a form of praise. If you wish to praise
Microsoft Windows when speaking on your own, by all means do so, but
not in GNU software. Usually we write the name “Windows” in full,
but when brevity is very important (as in file names and sometimes
symbol names), we abbreviate it to “w”. For instance, the files
and
-functions in Emacs that deal with Windows start with ‘<samp><span
class="samp">w32</span></samp>’.
+functions in Emacs that deal with Windows start with
‘<samp>w32</samp>’.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/User-Interfaces.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/User-Interfaces.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/User-Interfaces.html 8 Apr 2012 00:23:57 -0000
1.54
+++ standards/html_node/User-Interfaces.html 7 May 2012 00:48:10 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>User Interfaces - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="prev" href="Errors.html#Errors" title="Errors">
-<link rel="next" href="Graphical-Interfaces.html#Graphical-Interfaces"
title="Graphical Interfaces">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,59 +11,101 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: User Interfaces</title>
+
+<meta name="description" content="GNU Coding Standards: User Interfaces">
+<meta name="keywords" content="GNU Coding Standards: User Interfaces">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Program-Behavior.html#Program-Behavior" rel="up" title="Program
Behavior">
+<link href="Graphical-Interfaces.html#Graphical-Interfaces" rel="next"
title="Graphical Interfaces">
+<link href="Errors.html#Errors" rel="previous" title="Errors">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="User-Interfaces"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Graphical-Interfaces.html#Graphical-Interfaces">Graphical Interfaces</a>,
-Previous: <a rel="previous" accesskey="p"
href="Errors.html#Errors">Errors</a>,
-Up: <a rel="up" accesskey="u"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>
-<hr>
+Next: <a href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="n"
rel="next">Graphical Interfaces</a>, Previous: <a href="Errors.html#Errors"
accesskey="p" rel="previous">Errors</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Standards-for-Interfaces-Generally"></a>
<h3 class="section">4.5 Standards for Interfaces Generally</h3>
-<p><a name="index-program-name-and-its-behavior-38"></a><a
name="index-behavior_002c-dependent-on-program_0027s-name-39"></a>Please don't
make the behavior of a utility depend on the name used
+<a name="index-program-name-and-its-behavior"></a>
+<a name="index-behavior_002c-dependent-on-program_0027s-name"></a>
+<p>Please don’t make the behavior of a utility depend on the name used
to invoke it. It is useful sometimes to make a link to a utility
with a different name, and that should not change what it does.
-
- <p>Instead, use a run time option or a compilation switch or both
+</p>
+<p>Instead, use a run time option or a compilation switch or both
to select among the alternate behaviors.
-
- <p><a
name="index-output-device-and-program_0027s-behavior-40"></a>Likewise, please
don't make the behavior of the program depend on the
+</p>
+<a name="index-output-device-and-program_0027s-behavior"></a>
+<p>Likewise, please don’t make the behavior of the program depend on the
type of output device it is used with. Device independence is an
-important principle of the system's design; do not compromise it merely
+important principle of the system’s design; do not compromise it merely
to save someone from typing an option now and then. (Variation in error
message syntax when using a terminal is ok, because that is a side issue
that people do not depend on.)
-
- <p>If you think one behavior is most useful when the output is to a
+</p>
+<p>If you think one behavior is most useful when the output is to a
terminal, and another is most useful when the output is a file or a
pipe, then it is usually best to make the default behavior the one that
is useful with output to a terminal, and have an option for the other
behavior.
-
- <p>Compatibility requires certain programs to depend on the type of output
+</p>
+<p>Compatibility requires certain programs to depend on the type of output
device. It would be disastrous if <code>ls</code> or <code>sh</code> did not
do so
in the way all users expect. In some of these cases, we supplement the
program with a preferred alternate version that does not depend on the
output device type. For example, we provide a <code>dir</code> program much
like <code>ls</code> except that its default output format is always
multi-column format.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="n"
rel="next">Graphical Interfaces</a>, Previous: <a href="Errors.html#Errors"
accesskey="p" rel="previous">Errors</a>, Up: <a
href="Program-Behavior.html#Program-Behavior" accesskey="u" rel="up">Program
Behavior</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Using-Extensions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Using-Extensions.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Using-Extensions.html 8 Apr 2012 00:23:57 -0000
1.54
+++ standards/html_node/Using-Extensions.html 7 May 2012 00:48:10 -0000
1.55
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Using Extensions - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Design-Advice.html#Design-Advice" title="Design Advice">
-<link rel="prev" href="Compatibility.html#Compatibility" title="Compatibility">
-<link rel="next" href="Standard-C.html#Standard-C" title="Standard C">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,60 +11,93 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Using Extensions</title>
+
+<meta name="description" content="GNU Coding Standards: Using Extensions">
+<meta name="keywords" content="GNU Coding Standards: Using Extensions">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Design-Advice.html#Design-Advice" rel="up" title="Design Advice">
+<link href="Standard-C.html#Standard-C" rel="next" title="Standard C">
+<link href="Compatibility.html#Compatibility" rel="previous"
title="Compatibility">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Using-Extensions"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Standard-C.html#Standard-C">Standard C</a>,
-Previous: <a rel="previous" accesskey="p"
href="Compatibility.html#Compatibility">Compatibility</a>,
-Up: <a rel="up" accesskey="u"
href="Design-Advice.html#Design-Advice">Design Advice</a>
-<hr>
+Next: <a href="Standard-C.html#Standard-C" accesskey="n" rel="next">Standard
C</a>, Previous: <a href="Compatibility.html#Compatibility" accesskey="p"
rel="previous">Compatibility</a>, Up: <a
href="Design-Advice.html#Design-Advice" accesskey="u" rel="up">Design
Advice</a> [<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Using-Non_002dstandard-Features"></a>
<h3 class="section">3.3 Using Non-standard Features</h3>
+<a name="index-non_002dstandard-extensions"></a>
-<p><a name="index-non_002dstandard-extensions-21"></a>
-Many GNU facilities that already exist support a number of convenient
+<p>Many GNU facilities that already exist support a number of convenient
extensions over the comparable Unix facilities. Whether to use these
extensions in implementing your program is a difficult question.
-
- <p>On the one hand, using the extensions can make a cleaner program.
+</p>
+<p>On the one hand, using the extensions can make a cleaner program.
On the other hand, people will not be able to build the program
unless the other GNU tools are available. This might cause the
program to work on fewer kinds of machines.
-
- <p>With some extensions, it might be easy to provide both alternatives.
+</p>
+<p>With some extensions, it might be easy to provide both alternatives.
For example, you can define functions with a “keyword”
<code>INLINE</code>
and define that as a macro to expand into either <code>inline</code> or
nothing, depending on the compiler.
-
- <p>In general, perhaps it is best not to use the extensions if you can
+</p>
+<p>In general, perhaps it is best not to use the extensions if you can
straightforwardly do without them, but to use the extensions if they
are a big improvement.
-
- <p>An exception to this rule are the large, established programs (such as
+</p>
+<p>An exception to this rule are the large, established programs (such as
Emacs) which run on a great variety of systems. Using GNU extensions in
-such programs would make many users unhappy, so we don't do that.
-
- <p>Another exception is for programs that are used as part of compilation:
+such programs would make many users unhappy, so we don’t do that.
+</p>
+<p>Another exception is for programs that are used as part of compilation:
anything that must be compiled with other compilers in order to
bootstrap the GNU compilation facilities. If these require the GNU
compiler, then no one can compile them without having them installed
already. That would be extremely troublesome in certain cases.
+</p>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Utilities-in-Makefiles.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Utilities-in-Makefiles.html,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -b -r1.56 -r1.57
--- standards/html_node/Utilities-in-Makefiles.html 8 Apr 2012 00:23:57
-0000 1.56
+++ standards/html_node/Utilities-in-Makefiles.html 7 May 2012 00:48:10
-0000 1.57
@@ -1,16 +1,6 @@
-<html lang="en">
-<head>
-<title>Utilities in Makefiles - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up" href="Makefile-Conventions.html#Makefile-Conventions"
title="Makefile Conventions">
-<link rel="prev" href="Makefile-Basics.html#Makefile-Basics" title="Makefile
Basics">
-<link rel="next" href="Command-Variables.html#Command-Variables"
title="Command Variables">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -21,90 +11,135 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Utilities in Makefiles</title>
+
+<meta name="description" content="GNU Coding Standards: Utilities in
Makefiles">
+<meta name="keywords" content="GNU Coding Standards: Utilities in Makefiles">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Makefile-Conventions.html#Makefile-Conventions" rel="up"
title="Makefile Conventions">
+<link href="Command-Variables.html#Command-Variables" rel="next"
title="Command Variables">
+<link href="Makefile-Basics.html#Makefile-Basics" rel="previous"
title="Makefile Basics">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Utilities-in-Makefiles"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Command-Variables.html#Command-Variables">Command Variables</a>,
-Previous: <a rel="previous" accesskey="p"
href="Makefile-Basics.html#Makefile-Basics">Makefile Basics</a>,
-Up: <a rel="up" accesskey="u"
href="Makefile-Conventions.html#Makefile-Conventions">Makefile Conventions</a>
-<hr>
+Next: <a href="Command-Variables.html#Command-Variables" accesskey="n"
rel="next">Command Variables</a>, Previous: <a
href="Makefile-Basics.html#Makefile-Basics" accesskey="p"
rel="previous">Makefile Basics</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Utilities-in-Makefiles-1"></a>
<h4 class="subsection">7.2.2 Utilities in Makefiles</h4>
<p>Write the Makefile commands (and any shell scripts, such as
<code>configure</code>) to run under <code>sh</code> (both the traditional
Bourne
-shell and the <span class="sc">posix</span> shell), not <code>csh</code>.
Don't use any
-special features of <code>ksh</code> or <code>bash</code>, or <span
class="sc">posix</span> features
+shell and the <small>POSIX</small> shell), not <code>csh</code>. Don’t
use any
+special features of <code>ksh</code> or <code>bash</code>, or
<small>POSIX</small> features
not widely supported in traditional Bourne <code>sh</code>.
-
- <p>The <code>configure</code> script and the Makefile rules for building and
+</p>
+<p>The <code>configure</code> script and the Makefile rules for building and
installation should not use any utilities directly except these:
+</p>
-<!-- dd find -->
-<!-- gunzip gzip md5sum -->
-<!-- mkfifo mknod tee uname -->
-<pre class="example"> awk cat cmp cp diff echo egrep expr false grep
install-info ln ls
- mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true
-</pre>
- <p>Compression programs such as <code>gzip</code> can be used in the
-<code>dist</code> rule.
+<div class="example">
+<pre class="example">awk cat cmp cp diff echo egrep expr false grep
install-info ln ls
+mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true
+</pre></div>
- <p>Generally, stick to the widely-supported (usually
-<span class="sc">posix</span>-specified) options and features of these
programs. For
-example, don't use ‘<samp><span class="samp">mkdir
-p</span></samp>’, convenient as it may be, because a
-few systems don't support it at all and with others, it is not safe
+<p>Compression programs such as <code>gzip</code> can be used in the
+<code>dist</code> rule.
+</p>
+<p>Generally, stick to the widely-supported (usually
+<small>POSIX</small>-specified) options and features of these programs. For
+example, don’t use ‘<samp>mkdir -p</samp>’, convenient as it
may be, because a
+few systems don’t support it at all and with others, it is not safe
for parallel execution. For a list of known incompatibilities, see
-<a href="../autoconf/Portable-Shell.html#Portable-Shell">Portable Shell
Programming</a>.
+<a
href="http://www.gnu.org/software/autoconf/manual/html_node/Portable-Shell.html#Portable-Shell";>Portable
Shell Programming</a> in <cite>Autoconf</cite>.
+</p>
- <p>It is a good idea to avoid creating symbolic links in makefiles, since a
-few file systems don't support them.
-
- <p>The Makefile rules for building and installation can also use compilers
+<p>It is a good idea to avoid creating symbolic links in makefiles, since a
+few file systems don’t support them.
+</p>
+<p>The Makefile rules for building and installation can also use compilers
and related programs, but should do so via <code>make</code> variables so that
the
user can substitute alternatives. Here are some of the programs we
mean:
+</p>
+<div class="example">
+<pre class="example">ar bison cc flex install ld ldconfig lex
+make makeinfo ranlib texi2dvi yacc
+</pre></div>
+
+<p>Use the following <code>make</code> variables to run those programs:
+</p>
+<div class="example">
+<pre class="example">$(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD) $(LDCONFIG)
$(LEX)
+$(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
+</pre></div>
-<pre class="example"> ar bison cc flex install ld ldconfig lex
- make makeinfo ranlib texi2dvi yacc
-</pre>
- <p>Use the following <code>make</code> variables to run those programs:
-
-<pre class="example"> $(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD)
$(LDCONFIG) $(LEX)
- $(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
-</pre>
- <p>When you use <code>ranlib</code> or <code>ldconfig</code>, you should
make sure
+<p>When you use <code>ranlib</code> or <code>ldconfig</code>, you should make
sure
nothing bad happens if the system does not have the program in question.
Arrange to ignore an error from that command, and print a message before
the command to tell the user that failure of this command does not mean
-a problem. (The Autoconf ‘<samp><span
class="samp">AC_PROG_RANLIB</span></samp>’ macro can help with
+a problem. (The Autoconf ‘<samp>AC_PROG_RANLIB</samp>’ macro can
help with
this.)
+</p>
+<p>If you use symbolic links, you should implement a fallback for systems
+that don’t have symbolic links.
+</p>
+<p>Additional utilities that can be used via Make variables are:
+</p>
+<div class="example">
+<pre class="example">chgrp chmod chown mknod
+</pre></div>
- <p>If you use symbolic links, you should implement a fallback for systems
-that don't have symbolic links.
-
- <p>Additional utilities that can be used via Make variables are:
-
-<pre class="example"> chgrp chmod chown mknod
-</pre>
- <p>It is ok to use other utilities in Makefile portions (or scripts)
+<p>It is ok to use other utilities in Makefile portions (or scripts)
intended only for particular systems where you know those utilities
exist.
+</p>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Command-Variables.html#Command-Variables" accesskey="n"
rel="next">Command Variables</a>, Previous: <a
href="Makefile-Basics.html#Makefile-Basics" accesskey="p"
rel="previous">Makefile Basics</a>, Up: <a
href="Makefile-Conventions.html#Makefile-Conventions" accesskey="u"
rel="up">Makefile Conventions</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/Writing-C.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Writing-C.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/Writing-C.html 8 Apr 2012 00:23:57 -0000 1.54
+++ standards/html_node/Writing-C.html 7 May 2012 00:48:10 -0000 1.55
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>Writing C - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="prev" href="Program-Behavior.html#Program-Behavior" title="Program
Behavior">
-<link rel="next" href="Documentation.html#Documentation" title="Documentation">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,48 +11,92 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Writing C</title>
+
+<meta name="description" content="GNU Coding Standards: Writing C">
+<meta name="keywords" content="GNU Coding Standards: Writing C">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="index.html#Top" rel="up" title="Top">
+<link href="Formatting.html#Formatting" rel="next" title="Formatting">
+<link href="File-Usage.html#File-Usage" rel="previous" title="File Usage">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="Writing-C"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="Documentation.html#Documentation">Documentation</a>,
-Previous: <a rel="previous" accesskey="p"
href="Program-Behavior.html#Program-Behavior">Program Behavior</a>,
-Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
-<hr>
+Next: <a href="Documentation.html#Documentation" accesskey="n"
rel="next">Documentation</a>, Previous: <a
href="Program-Behavior.html#Program-Behavior" accesskey="p"
rel="previous">Program Behavior</a>, Up: <a href="index.html#Top" accesskey="u"
rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
-
+<hr>
+<a name="Making-The-Best-Use-of-C"></a>
<h2 class="chapter">5 Making The Best Use of C</h2>
<p>This chapter provides advice on how best to use the C language
when writing GNU software.
+</p>
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="Formatting.html#Formatting"
accesskey="1">Formatting</a>:</td><td> </td><td align="left"
valign="top">Formatting your source code.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Comments.html#Comments"
accesskey="2">Comments</a>:</td><td> </td><td align="left"
valign="top">Commenting your work.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Syntactic-Conventions.html#Syntactic-Conventions" accesskey="3">Syntactic
Conventions</a>:</td><td> </td><td align="left" valign="top">Clean
use of C constructs.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Names.html#Names"
accesskey="4">Names</a>:</td><td> </td><td align="left"
valign="top">Naming variables, functions, and files.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="System-Portability.html#System-Portability" accesskey="5">System
Portability</a>:</td><td> </td><td align="left"
valign="top">Portability among different operating systems.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="CPU-Portability.html#CPU-Portability" accesskey="6">CPU
Portability</a>:</td><td> </td><td align="left"
valign="top">Supporting the range of CPU types.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="System-Functions.html#System-Functions" accesskey="7">System
Functions</a>:</td><td> </td><td align="left"
valign="top">Portability and “standard” library functions.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Internationalization.html#Internationalization"
accesskey="8">Internationalization</a>:</td><td> </td><td
align="left" valign="top">Techniques for internationalization.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Character-Set.html#Character-Set" accesskey="9">Character
Set</a>:</td><td> </td><td align="left" valign="top">Use ASCII by
default.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Quote-Characters.html#Quote-Characters">Quote
Characters</a>:</td><td> </td><td align="left" valign="top">Use
"..." or ’...’ in the C locale.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Mmap.html#Mmap">Mmap</a>:</td><td> </td><td align="left"
valign="top">How you can safely use <code>mmap</code>.
+</td></tr>
+</table>
+
-<ul class="menu">
-<li><a accesskey="1" href="Formatting.html#Formatting">Formatting</a>:
Formatting your source code.
-<li><a accesskey="2" href="Comments.html#Comments">Comments</a>:
Commenting your work.
-<li><a accesskey="3"
href="Syntactic-Conventions.html#Syntactic-Conventions">Syntactic
Conventions</a>: Clean use of C constructs.
-<li><a accesskey="4" href="Names.html#Names">Names</a>:
Naming variables, functions, and files.
-<li><a accesskey="5" href="System-Portability.html#System-Portability">System
Portability</a>: Portability among different operating systems.
-<li><a accesskey="6" href="CPU-Portability.html#CPU-Portability">CPU
Portability</a>: Supporting the range of CPU types.
-<li><a accesskey="7" href="System-Functions.html#System-Functions">System
Functions</a>: Portability and ``standard'' library functions.
-<li><a accesskey="8"
href="Internationalization.html#Internationalization">Internationalization</a>:
Techniques for internationalization.
-<li><a accesskey="9" href="Character-Set.html#Character-Set">Character
Set</a>: Use ASCII by default.
-<li><a href="Quote-Characters.html#Quote-Characters">Quote Characters</a>:
Use "..." or '...' in the C locale.
-<li><a href="Mmap.html#Mmap">Mmap</a>: How you can
safely use <code>mmap</code>.
-</ul>
- </body></html>
+</body>
+</html>
Index: standards/html_node/_002d_002dhelp.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/_002d_002dhelp.html,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -b -r1.38 -r1.39
--- standards/html_node/_002d_002dhelp.html 8 Apr 2012 00:23:57 -0000
1.38
+++ standards/html_node/_002d_002dhelp.html 7 May 2012 00:48:10 -0000
1.39
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>--help - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
title="Command-Line Interfaces">
-<link rel="prev" href="_002d_002dversion.html#g_t_002d_002dversion"
title="--version">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,48 +11,87 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: --help</title>
+
+<meta name="description" content="GNU Coding Standards: --help">
+<meta name="keywords" content="GNU Coding Standards: --help">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
rel="up" title="Command-Line Interfaces">
+<link
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces"
rel="next" title="Dynamic Plug-In Interfaces">
+<link href="_002d_002dversion.html#g_t_002d_002dversion" rel="previous"
title="--version">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
-<a name="--help"></a>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="g_t_002d_002dhelp"></a>
+<div class="header">
<p>
-Previous: <a rel="previous" accesskey="p"
href="_002d_002dversion.html#g_t_002d_002dversion">--version</a>,
-Up: <a rel="up" accesskey="u"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a>
-<hr>
+Previous: <a href="_002d_002dversion.html#g_t_002d_002dversion" accesskey="p"
rel="previous">--version</a>, Up: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="u" rel="up">Command-Line Interfaces</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
+<hr>
+<a name="g_t_002d_002dhelp-1"></a>
+<h4 class="subsection">4.7.2 ‘<samp>--help</samp>’</h4>
-<h4 class="subsection">4.7.2 <samp><span
class="option">--help</span></samp></h4>
+<a name="index-_002d_002dhelp-output"></a>
-<p><a name="index-g_t_0040samp_007b_002d_002dhelp_007d-output-60"></a>
-The standard <code>--help</code> option should output brief documentation
+<p>The standard <code>--help</code> option should output brief documentation
for how to invoke the program, on standard output, then exit
successfully. Other options and arguments should be ignored once this
is seen, and the program should not perform its normal function.
-
- <p><a name="index-address-for-bug-reports-61"></a><a
name="index-bug-reports-62"></a>Near the end of the ‘<samp><span
class="samp">--help</span></samp>’ option's output, please place lines
-giving the email address for bug reports, the package's home page
-(normally <<code>http://www.gnu.org/software/</code><var>pkg</var>>, and
the
+</p>
+<a name="index-address-for-bug-reports"></a>
+<a name="index-bug-reports"></a>
+<p>Near the end of the ‘<samp>--help</samp>’ option’s
output, please place lines
+giving the email address for bug reports, the package’s home page
+(normally <<code>http://www.gnu.org/software/<var>pkg</var></code>>, and
the
general page for help using GNU programs. The format should be like this:
+</p>
+<div class="example">
+<pre class="example">Report bugs to: <var>mailing-address</var>
+<var>pkg</var> home page: <http://www.gnu.org/software/<var>pkg</var>/>
+General help using GNU software: <http://www.gnu.org/gethelp/>
+</pre></div>
+
+<p>It is ok to mention other appropriate mailing lists and web pages.
+</p>
+
-<pre class="example"> Report bugs to: <var>mailing-address</var>
- <var>pkg</var> home page:
<http://www.gnu.org/software/<var>pkg</var>/>
- General help using GNU software: <http://www.gnu.org/gethelp/>
-</pre>
- <p>It is ok to mention other appropriate mailing lists and web pages.
- </body></html>
+</body>
+</html>
Index: standards/html_node/_002d_002dversion.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/_002d_002dversion.html,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -b -r1.39 -r1.40
--- standards/html_node/_002d_002dversion.html 8 Apr 2012 00:23:57 -0000
1.39
+++ standards/html_node/_002d_002dversion.html 7 May 2012 00:48:10 -0000
1.40
@@ -1,15 +1,6 @@
-<html lang="en">
-<head>
-<title>--version - GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="index.html#Top">
-<link rel="up"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
title="Command-Line Interfaces">
-<link rel="next" href="_002d_002dhelp.html#g_t_002d_002dhelp" title="--help">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -20,162 +11,238 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: --version</title>
+
+<meta name="description" content="GNU Coding Standards: --version">
+<meta name="keywords" content="GNU Coding Standards: --version">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
rel="up" title="Command-Line Interfaces">
+<link href="_002d_002dhelp.html#g_t_002d_002dhelp" rel="next" title="--help">
+<link href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
rel="previous" title="Command-Line Interfaces">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<div class="node">
-<a name="--version"></a>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
<a name="g_t_002d_002dversion"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n"
href="_002d_002dhelp.html#g_t_002d_002dhelp">--help</a>,
-Up: <a rel="up" accesskey="u"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">Command-Line
Interfaces</a>
-<hr>
+Next: <a href="_002d_002dhelp.html#g_t_002d_002dhelp" accesskey="n"
rel="next">--help</a>, Up: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="u" rel="up">Command-Line Interfaces</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
</div>
+<hr>
+<a name="g_t_002d_002dversion-1"></a>
+<h4 class="subsection">4.7.1 ‘<samp>--version</samp>’</h4>
-<h4 class="subsection">4.7.1 <samp><span
class="option">--version</span></samp></h4>
+<a name="index-_002d_002dversion-output"></a>
-<p><a name="index-g_t_0040samp_007b_002d_002dversion_007d-output-57"></a>
-The standard <code>--version</code> option should direct the program to
+<p>The standard <code>--version</code> option should direct the program to
print information about its name, version, origin and legal status,
all on standard output, and then exit successfully. Other options and
arguments should be ignored once this is seen, and the program should
not perform its normal function.
-
- <p><a name="index-canonical-name-of-a-program-58"></a><a
name="index-program_0027s-canonical-name-59"></a>The first line is meant to be
easy for a program to parse; the version
+</p>
+<a name="index-canonical-name-of-a-program"></a>
+<a name="index-program_0027s-canonical-name"></a>
+<p>The first line is meant to be easy for a program to parse; the version
number proper starts after the last space. In addition, it contains
the canonical name for this program, in this format:
+</p>
+<div class="example">
+<pre class="example">GNU Emacs 19.30
+</pre></div>
-<pre class="example"> GNU Emacs 19.30
-</pre>
- <p class="noindent">The program's name should be a constant string;
<em>don't</em> compute it
+<p>The program’s name should be a constant string; <em>don’t</em>
compute it
from <code>argv[0]</code>. The idea is to state the standard or canonical
name for the program, not its file name. There are other ways to find
out the precise file name where a command is found in <code>PATH</code>.
-
- <p>If the program is a subsidiary part of a larger package, mention the
+</p>
+<p>If the program is a subsidiary part of a larger package, mention the
package name in parentheses, like this:
+</p>
+<div class="example">
+<pre class="example">emacsserver (GNU Emacs) 19.30
+</pre></div>
-<pre class="example"> emacsserver (GNU Emacs) 19.30
-</pre>
- <p class="noindent">If the package has a version number which is different
from this
-program's version number, you can mention the package version number
+<p>If the package has a version number which is different from this
+program’s version number, you can mention the package version number
just before the close-parenthesis.
-
- <p>If you <em>need</em> to mention the version numbers of libraries which
+</p>
+<p>If you <em>need</em> to mention the version numbers of libraries which
are distributed separately from the package which contains this program,
you can do so by printing an additional line of version info for each
library you want to mention. Use the same format for these lines as for
the first line.
-
- <p>Please do not mention all of the libraries that the program uses
“just
+</p>
+<p>Please do not mention all of the libraries that the program uses “just
for completeness”—that would produce a lot of unhelpful clutter.
Please mention library version numbers only if you find in practice that
they are very important to you in debugging.
-
- <p>The following line, after the version number line or lines, should be a
+</p>
+<p>The following line, after the version number line or lines, should be a
copyright notice. If more than one copyright notice is called for, put
each on a separate line.
-
- <p>Next should follow a line stating the license, preferably using one of
+</p>
+<p>Next should follow a line stating the license, preferably using one of
abbreviations below, and a brief statement that the program is free
software, and that users are free to copy and change it. Also mention
that there is no warranty, to the extent permitted by law. See
recommended wording below.
-
- <p>It is ok to finish the output with a list of the major authors of the
+</p>
+<p>It is ok to finish the output with a list of the major authors of the
program, as a way of giving credit.
+</p>
+<p>Here’s an example of output that follows these rules:
+</p>
+<div class="smallexample">
+<pre class="smallexample">GNU hello 2.3
+Copyright (C) 2007 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later
<http://gnu.org/licenses/gpl.html>
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+</pre></div>
- <p>Here's an example of output that follows these rules:
-
-<pre class="smallexample"> GNU hello 2.3
- Copyright (C) 2007 Free Software Foundation, Inc.
- License GPLv3+: GNU GPL version 3 or later
<http://gnu.org/licenses/gpl.html>
- This is free software: you are free to change and redistribute it.
- There is NO WARRANTY, to the extent permitted by law.
-</pre>
- <p>You should adapt this to your program, of course, filling in the proper
+<p>You should adapt this to your program, of course, filling in the proper
year, copyright holder, name of program, and the references to
distribution terms, and changing the rest of the wording as necessary.
-
- <p>This copyright notice only needs to mention the most recent year in
-which changes were made—there's no need to list the years for previous
-versions' changes. You don't have to mention the name of the program in
+</p>
+<p>This copyright notice only needs to mention the most recent year in
+which changes were made—there’s no need to list the years for
previous
+versions’ changes. You don’t have to mention the name of the
program in
these notices, if that is inconvenient, since it appeared in the first
line. (The rules are different for copyright notices in source files;
-see <a href="../maintain/Copyright-Notices.html#Copyright-Notices">Copyright
Notices</a>.)
-
- <p>Translations of the above lines must preserve the validity of the
-copyright notices (see <a
href="Internationalization.html#Internationalization">Internationalization</a>).
If the translation's
-character set supports it, the ‘<samp><span
class="samp">(C)</span></samp>’ should be replaced with the
+see <a
href="http://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html#Copyright-Notices";>Copyright
Notices</a> in <cite>Information for GNU Maintainers</cite>.)
+</p>
+<p>Translations of the above lines must preserve the validity of the
+copyright notices (see <a
href="Internationalization.html#Internationalization">Internationalization</a>).
If the translation’s
+character set supports it, the ‘<samp>(C)</samp>’ should be
replaced with the
copyright symbol, as follows:
-
- <p>©
-
- <p>Write the word “Copyright” exactly like that, in English.
Do not
+</p>
+<p>©
+</p>
+<p>Write the word “Copyright” exactly like that, in English. Do
not
translate it into another language. International treaties recognize
the English word “Copyright”; translations into other languages do
not
have legal significance.
-
- <p>Finally, here is the table of our suggested license abbreviations.
-Any abbreviation can be followed by ‘<samp><span
class="samp">v</span><var>version</var><span
class="samp">[+]</span></samp>’, meaning
-that particular version, or later versions with the ‘<samp><span
class="samp">+</span></samp>’, as shown
+</p>
+<p>Finally, here is the table of our suggested license abbreviations.
+Any abbreviation can be followed by
‘<samp>v<var>version</var>[+]</samp>’, meaning
+that particular version, or later versions with the
‘<samp>+</samp>’, as shown
above.
-
- <p>In the case of exceptions for extra permissions with the GPL, we use
-‘<samp><span class="samp">/</span></samp>’ for a separator; the
version number can follow the license
+</p>
+<p>In the case of exceptions for extra permissions with the GPL, we use
+‘<samp>/</samp>’ for a separator; the version number can follow
the license
abbreviation as usual, as in the examples below.
-
- <dl>
-<dt>GPL<dd>GNU General Public License, <a
href="http://www.gnu.org/licenses/gpl.html";>http://www.gnu.org/licenses/gpl.html</a>.
-
- <br><dt>LGPL<dd>GNU Lesser General Public License, <a
href="http://www.gnu.org/licenses/lgpl.html";>http://www.gnu.org/licenses/lgpl.html</a>.
-
- <br><dt>GPL/Ada<dd>GNU GPL with the exception for Ada.
-
- <br><dt>Apache<dd>The Apache Software Foundation license,
+</p>
+<dl compact="compact">
+<dt>GPL</dt>
+<dd><p>GNU General Public License, <a
href="http://www.gnu.org/licenses/gpl.html";>http://www.gnu.org/licenses/gpl.html</a>.
+</p>
+</dd>
+<dt>LGPL</dt>
+<dd><p>GNU Lesser General Public License, <a
href="http://www.gnu.org/licenses/lgpl.html";>http://www.gnu.org/licenses/lgpl.html</a>.
+</p>
+</dd>
+<dt>GPL/Ada</dt>
+<dd><p>GNU GPL with the exception for Ada.
+</p>
+</dd>
+<dt>Apache</dt>
+<dd><p>The Apache Software Foundation license,
<a href="http://www.apache.org/licenses";>http://www.apache.org/licenses</a>.
-
- <br><dt>Artistic<dd>The Artistic license used for Perl, <a
href="http://www.perlfoundation.org/legal";>http://www.perlfoundation.org/legal</a>.
-
- <br><dt>Expat<dd>The Expat license, <a
href="http://www.jclark.com/xml/copying.txt";>http://www.jclark.com/xml/copying.txt</a>.
-
- <br><dt>MPL<dd>The Mozilla Public License, <a
href="http://www.mozilla.org/MPL/";>http://www.mozilla.org/MPL/</a>.
-
- <br><dt>OBSD<dd>The original (4-clause) BSD license, incompatible with
the GNU GPL
+</p>
+</dd>
+<dt>Artistic</dt>
+<dd><p>The Artistic license used for Perl, <a
href="http://www.perlfoundation.org/legal";>http://www.perlfoundation.org/legal</a>.
+</p>
+</dd>
+<dt>Expat</dt>
+<dd><p>The Expat license, <a
href="http://www.jclark.com/xml/copying.txt";>http://www.jclark.com/xml/copying.txt</a>.
+</p>
+</dd>
+<dt>MPL</dt>
+<dd><p>The Mozilla Public License, <a
href="http://www.mozilla.org/MPL/";>http://www.mozilla.org/MPL/</a>.
+</p>
+</dd>
+<dt>OBSD</dt>
+<dd><p>The original (4-clause) BSD license, incompatible with the GNU GPL
<a
href="http://www.xfree86.org/3.3.6/COPYRIGHT2.html#6";>http://www.xfree86.org/3.3.6/COPYRIGHT2.html#6</a>.
-
- <br><dt>PHP<dd>The license used for PHP, <a
href="http://www.php.net/license/";>http://www.php.net/license/</a>.
-
- <br><dt>public domain<dd>The non-license that is being in the public
domain,
+</p>
+</dd>
+<dt>PHP</dt>
+<dd><p>The license used for PHP, <a
href="http://www.php.net/license/";>http://www.php.net/license/</a>.
+</p>
+</dd>
+<dt>public domain</dt>
+<dd><p>The non-license that is being in the public domain,
<a
href="http://www.gnu.org/licenses/license-list.html#PublicDomain";>http://www.gnu.org/licenses/license-list.html#PublicDomain</a>.
-
- <br><dt>Python<dd>The license for Python, <a
href="http://www.python.org/2.0.1/license.html";>http://www.python.org/2.0.1/license.html</a>.
-
- <br><dt>RBSD<dd>The revised (3-clause) BSD, compatible with the GNU
GPL,<br>
+</p>
+</dd>
+<dt>Python</dt>
+<dd><p>The license for Python, <a
href="http://www.python.org/2.0.1/license.html";>http://www.python.org/2.0.1/license.html</a>.
+</p>
+</dd>
+<dt>RBSD</dt>
+<dd><p>The revised (3-clause) BSD, compatible with the GNU GPL,<br>
<a
href="http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5";>http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5</a>.
-
- <br><dt>X11<dd>The simple non-copyleft license used for most versions of
the X Window
+</p>
+</dd>
+<dt>X11</dt>
+<dd><p>The simple non-copyleft license used for most versions of the X Window
System, <a
href="http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3";>http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3</a>.
+</p>
+</dd>
+<dt>Zlib</dt>
+<dd><p>The license for Zlib, <a
href="http://www.gzip.org/zlib/zlib_license.html";>http://www.gzip.org/zlib/zlib_license.html</a>.
+</p>
+</dd>
+</dl>
- <br><dt>Zlib<dd>The license for Zlib, <a
href="http://www.gzip.org/zlib/zlib_license.html";>http://www.gzip.org/zlib/zlib_license.html</a>.
-
- </dl>
-
- <p>More information about these licenses and many more are on the GNU
+<p>More information about these licenses and many more are on the GNU
licensing web pages,
<a
href="http://www.gnu.org/licenses/license-list.html";>http://www.gnu.org/licenses/license-list.html</a>.
+</p>
+
+<hr>
+<div class="header">
+<p>
+Next: <a href="_002d_002dhelp.html#g_t_002d_002dhelp" accesskey="n"
rel="next">--help</a>, Up: <a
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="u" rel="up">Command-Line Interfaces</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html#Index" title="Index"
rel="index">Index</a>]</p>
+</div>
+
- </body></html>
+</body>
+</html>
Index: standards/html_node/index.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/index.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -b -r1.54 -r1.55
--- standards/html_node/index.html 8 Apr 2012 00:23:58 -0000 1.54
+++ standards/html_node/index.html 7 May 2012 00:48:10 -0000 1.55
@@ -1,13 +1,6 @@
-<html lang="en">
-<head>
-<title>GNU Coding Standards</title>
-<meta http-equiv="Content-Type" content="text/html">
-<meta name="description" content="GNU Coding Standards">
-<meta name="generator" content="makeinfo 4.13">
-<link title="Top" rel="start" href="#Top">
-<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
-<!--
-The GNU coding standards, last updated April 7, 2012.
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<!-- The GNU coding standards, last updated April 7, 2012.
Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -18,153 +11,210 @@
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
-"GNU Free Documentation License".-->
-<meta http-equiv="Content-Style-Type" content="text/css">
-<style type="text/css"><!--
- pre.display { font-family:inherit }
- pre.format { font-family:inherit }
- pre.smalldisplay { font-family:inherit; font-size:smaller }
- pre.smallformat { font-family:inherit; font-size:smaller }
- pre.smallexample { font-size:smaller }
- pre.smalllisp { font-size:smaller }
- span.sc { font-variant:small-caps }
- span.roman { font-family:serif; font-weight:normal; }
- span.sansserif { font-family:sans-serif; font-weight:normal; }
---></style>
+"GNU Free Documentation License". -->
+<!-- Created by Texinfo 4.13.90+dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>GNU Coding Standards: Top</title>
+
+<meta name="description" content="GNU Coding Standards: Top">
+<meta name="keywords" content="GNU Coding Standards: Top">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="texi2any">
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link href="#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="../dir/index.html" rel="up" title="(dir)">
+<link href="Preface.html#Preface" rel="next" title="Preface">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {margin-left: 3.2em}
+pre.display {font-family: serif}
+pre.format {font-family: serif}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+pre.smalldisplay {font-family: serif; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: serif; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space:pre}
+span.nolinebreak {white-space:pre}
+span.roman {font-family:serif; font-weight:normal}
+span.sansserif {font-family:sans-serif; font-weight:normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
</head>
-<body>
-<h1 class="settitle">GNU Coding Standards</h1>
+
+<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#800080" alink="#FF0000">
+<h1 class="settitle" align="center">GNU Coding Standards</h1>
+
+
+
+
+
+
+
+<a name="SEC_Contents"></a>
+<h2 class="contents-heading">Table of Contents</h2>
+
<div class="contents">
-<h2>Table of Contents</h2>
-<ul>
-<li><a name="toc_Top" href="index.html#Top">GNU Coding Standards</a>
-<li><a name="toc_Preface" href="Preface.html#Preface">1 About the GNU Coding
Standards</a>
-<li><a name="toc_Legal-Issues" href="Legal-Issues.html#Legal-Issues">2 Keeping
Free Software Free</a>
-<ul>
-<li><a href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">2.1
Referring to Proprietary Programs</a>
-<li><a href="Contributions.html#Contributions">2.2 Accepting Contributions</a>
-<li><a href="Trademarks.html#Trademarks">2.3 Trademarks</a>
-</li></ul>
-<li><a name="toc_Design-Advice" href="Design-Advice.html#Design-Advice">3
General Program Design</a>
-<ul>
-<li><a href="Source-Language.html#Source-Language">3.1 Which Languages to
Use</a>
-<li><a href="Compatibility.html#Compatibility">3.2 Compatibility with Other
Implementations</a>
-<li><a href="Using-Extensions.html#Using-Extensions">3.3 Using Non-standard
Features</a>
-<li><a href="Standard-C.html#Standard-C">3.4 Standard C and Pre-Standard C</a>
-<li><a href="Conditional-Compilation.html#Conditional-Compilation">3.5
Conditional Compilation</a>
-</li></ul>
-<li><a name="toc_Program-Behavior"
href="Program-Behavior.html#Program-Behavior">4 Program Behavior for All
Programs</a>
-<ul>
-<li><a href="Non_002dGNU-Standards.html#Non_002dGNU-Standards">4.1 Non-GNU
Standards</a>
-<li><a href="Semantics.html#Semantics">4.2 Writing Robust Programs</a>
-<li><a href="Libraries.html#Libraries">4.3 Library Behavior</a>
-<li><a href="Errors.html#Errors">4.4 Formatting Error Messages</a>
-<li><a href="User-Interfaces.html#User-Interfaces">4.5 Standards for
Interfaces Generally</a>
-<li><a href="Graphical-Interfaces.html#Graphical-Interfaces">4.6 Standards for
Graphical Interfaces</a>
-<li><a href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">4.7
Standards for Command Line Interfaces</a>
-<ul>
-<li><a href="_002d_002dversion.html#_002d_002dversion">4.7.1 <samp><span
class="option">--version</span></samp></a>
-<li><a href="_002d_002dhelp.html#_002d_002dhelp">4.7.2 <samp><span
class="option">--help</span></samp></a>
-</li></ul>
-<li><a
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">4.8
Standards for Dynamic Plug-in Interfaces</a>
-<li><a href="Option-Table.html#Option-Table">4.9 Table of Long Options</a>
-<li><a href="OID-Allocations.html#OID-Allocations">4.10 OID Allocations</a>
-<li><a href="Memory-Usage.html#Memory-Usage">4.11 Memory Usage</a>
-<li><a href="File-Usage.html#File-Usage">4.12 File Usage</a>
-</li></ul>
-<li><a name="toc_Writing-C" href="Writing-C.html#Writing-C">5 Making The Best
Use of C</a>
-<ul>
-<li><a href="Formatting.html#Formatting">5.1 Formatting Your Source Code</a>
-<li><a href="Comments.html#Comments">5.2 Commenting Your Work</a>
-<li><a href="Syntactic-Conventions.html#Syntactic-Conventions">5.3 Clean Use
of C Constructs</a>
-<li><a href="Names.html#Names">5.4 Naming Variables, Functions, and Files</a>
-<li><a href="System-Portability.html#System-Portability">5.5 Portability
between System Types</a>
-<li><a href="CPU-Portability.html#CPU-Portability">5.6 Portability between
<span class="sc">cpu</span>s</a>
-<li><a href="System-Functions.html#System-Functions">5.7 Calling System
Functions</a>
-<li><a href="Internationalization.html#Internationalization">5.8
Internationalization</a>
-<li><a href="Character-Set.html#Character-Set">5.9 Character Set</a>
-<li><a href="Quote-Characters.html#Quote-Characters">5.10 Quote Characters</a>
-<li><a href="Mmap.html#Mmap">5.11 Mmap</a>
-</li></ul>
-<li><a name="toc_Documentation" href="Documentation.html#Documentation">6
Documenting Programs</a>
-<ul>
-<li><a href="GNU-Manuals.html#GNU-Manuals">6.1 GNU Manuals</a>
-<li><a href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals">6.2 Doc
Strings and Manuals</a>
-<li><a href="Manual-Structure-Details.html#Manual-Structure-Details">6.3
Manual Structure Details</a>
-<li><a href="License-for-Manuals.html#License-for-Manuals">6.4 License for
Manuals</a>
-<li><a href="Manual-Credits.html#Manual-Credits">6.5 Manual Credits</a>
-<li><a href="Printed-Manuals.html#Printed-Manuals">6.6 Printed Manuals</a>
-<li><a href="NEWS-File.html#NEWS-File">6.7 The NEWS File</a>
-<li><a href="Change-Logs.html#Change-Logs">6.8 Change Logs</a>
-<ul>
-<li><a href="Change-Log-Concepts.html#Change-Log-Concepts">6.8.1 Change Log
Concepts</a>
-<li><a href="Style-of-Change-Logs.html#Style-of-Change-Logs">6.8.2 Style of
Change Logs</a>
-<li><a href="Simple-Changes.html#Simple-Changes">6.8.3 Simple Changes</a>
-<li><a href="Conditional-Changes.html#Conditional-Changes">6.8.4 Conditional
Changes</a>
-<li><a
href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed">6.8.5
Indicating the Part Changed</a>
-</li></ul>
-<li><a href="Man-Pages.html#Man-Pages">6.9 Man Pages</a>
-<li><a href="Reading-other-Manuals.html#Reading-other-Manuals">6.10 Reading
other Manuals</a>
-</li></ul>
-<li><a name="toc_Managing-Releases"
href="Managing-Releases.html#Managing-Releases">7 The Release Process</a>
-<ul>
-<li><a href="Configuration.html#Configuration">7.1 How Configuration Should
Work</a>
-<li><a href="Makefile-Conventions.html#Makefile-Conventions">7.2 Makefile
Conventions</a>
-<ul>
-<li><a href="Makefile-Basics.html#Makefile-Basics">7.2.1 General Conventions
for Makefiles</a>
-<li><a href="Utilities-in-Makefiles.html#Utilities-in-Makefiles">7.2.2
Utilities in Makefiles</a>
-<li><a href="Command-Variables.html#Command-Variables">7.2.3 Variables for
Specifying Commands</a>
-<li><a href="DESTDIR.html#DESTDIR">7.2.4 <code>DESTDIR</code>: Support for
Staged Installs</a>
-<li><a href="Directory-Variables.html#Directory-Variables">7.2.5 Variables for
Installation Directories</a>
-<li><a href="Standard-Targets.html#Standard-Targets">7.2.6 Standard Targets
for Users</a>
-<li><a href="Install-Command-Categories.html#Install-Command-Categories">7.2.7
Install Command Categories</a>
-</li></ul>
-<li><a href="Releases.html#Releases">7.3 Making Releases</a>
-</li></ul>
-<li><a name="toc_References" href="References.html#References">8 References to
Non-Free Software and Documentation</a>
-<li><a name="toc_GNU-Free-Documentation-License"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">Appendix
A GNU Free Documentation License</a>
-<li><a name="toc_Index" href="Index.html#Index">Index</a>
-</li></ul>
-</div>
+<ul class="no-bullet">
+ <li><a name="toc-About-the-GNU-Coding-Standards"
href="Preface.html#Preface">1 About the GNU Coding Standards</a></li>
+ <li><a name="toc-Keeping-Free-Software-Free"
href="Legal-Issues.html#Legal-Issues">2 Keeping Free Software Free</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Referring-to-Proprietary-Programs"
href="Reading-Non_002dFree-Code.html#Reading-Non_002dFree-Code">2.1 Referring
to Proprietary Programs</a></li>
+ <li><a name="toc-Accepting-Contributions"
href="Contributions.html#Contributions">2.2 Accepting Contributions</a></li>
+ <li><a name="toc-Trademarks-1" href="Trademarks.html#Trademarks">2.3
Trademarks</a></li>
+ </ul></li>
+ <li><a name="toc-General-Program-Design"
href="Design-Advice.html#Design-Advice">3 General Program Design</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Which-Languages-to-Use"
href="Source-Language.html#Source-Language">3.1 Which Languages to Use</a></li>
+ <li><a name="toc-Compatibility-with-Other-Implementations"
href="Compatibility.html#Compatibility">3.2 Compatibility with Other
Implementations</a></li>
+ <li><a name="toc-Using-Non_002dstandard-Features"
href="Using-Extensions.html#Using-Extensions">3.3 Using Non-standard
Features</a></li>
+ <li><a name="toc-Standard-C-and-Pre_002dStandard-C"
href="Standard-C.html#Standard-C">3.4 Standard C and Pre-Standard C</a></li>
+ <li><a name="toc-Conditional-Compilation-1"
href="Conditional-Compilation.html#Conditional-Compilation">3.5 Conditional
Compilation</a></li>
+ </ul></li>
+ <li><a name="toc-Program-Behavior-for-All-Programs"
href="Program-Behavior.html#Program-Behavior">4 Program Behavior for All
Programs</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Non_002dGNU-Standards-1"
href="Non_002dGNU-Standards.html#Non_002dGNU-Standards">4.1 Non-GNU
Standards</a></li>
+ <li><a name="toc-Writing-Robust-Programs"
href="Semantics.html#Semantics">4.2 Writing Robust Programs</a></li>
+ <li><a name="toc-Library-Behavior" href="Libraries.html#Libraries">4.3
Library Behavior</a></li>
+ <li><a name="toc-Formatting-Error-Messages" href="Errors.html#Errors">4.4
Formatting Error Messages</a></li>
+ <li><a name="toc-Standards-for-Interfaces-Generally"
href="User-Interfaces.html#User-Interfaces">4.5 Standards for Interfaces
Generally</a></li>
+ <li><a name="toc-Standards-for-Graphical-Interfaces"
href="Graphical-Interfaces.html#Graphical-Interfaces">4.6 Standards for
Graphical Interfaces</a></li>
+ <li><a name="toc-Standards-for-Command-Line-Interfaces"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">4.7
Standards for Command Line Interfaces</a>
+ <ul class="no-bullet">
+ <li><a name="toc-_002d_002dversion-1"
href="_002d_002dversion.html#g_t_002d_002dversion">4.7.1
‘<samp>--version</samp>’</a></li>
+ <li><a name="toc-_002d_002dhelp-1"
href="_002d_002dhelp.html#g_t_002d_002dhelp">4.7.2
‘<samp>--help</samp>’</a></li>
+ </ul></li>
+ <li><a name="toc-Standards-for-Dynamic-Plug_002din-Interfaces"
href="Dynamic-Plug_002dIn-Interfaces.html#Dynamic-Plug_002dIn-Interfaces">4.8
Standards for Dynamic Plug-in Interfaces</a></li>
+ <li><a name="toc-Table-of-Long-Options"
href="Option-Table.html#Option-Table">4.9 Table of Long Options</a></li>
+ <li><a name="toc-OID-Allocations-1"
href="OID-Allocations.html#OID-Allocations">4.10 OID Allocations</a></li>
+ <li><a name="toc-Memory-Usage-1"
href="Memory-Usage.html#Memory-Usage">4.11 Memory Usage</a></li>
+ <li><a name="toc-File-Usage-1" href="File-Usage.html#File-Usage">4.12 File
Usage</a></li>
+ </ul></li>
+ <li><a name="toc-Making-The-Best-Use-of-C" href="Writing-C.html#Writing-C">5
Making The Best Use of C</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Formatting-Your-Source-Code"
href="Formatting.html#Formatting">5.1 Formatting Your Source Code</a></li>
+ <li><a name="toc-Commenting-Your-Work" href="Comments.html#Comments">5.2
Commenting Your Work</a></li>
+ <li><a name="toc-Clean-Use-of-C-Constructs"
href="Syntactic-Conventions.html#Syntactic-Conventions">5.3 Clean Use of C
Constructs</a></li>
+ <li><a name="toc-Naming-Variables_002c-Functions_002c-and-Files"
href="Names.html#Names">5.4 Naming Variables, Functions, and Files</a></li>
+ <li><a name="toc-Portability-between-System-Types"
href="System-Portability.html#System-Portability">5.5 Portability between
System Types</a></li>
+ <li><a name="toc-Portability-between-CPUs"
href="CPU-Portability.html#CPU-Portability">5.6 Portability between
<small>CPU</small>s</a></li>
+ <li><a name="toc-Calling-System-Functions"
href="System-Functions.html#System-Functions">5.7 Calling System
Functions</a></li>
+ <li><a name="toc-Internationalization-1"
href="Internationalization.html#Internationalization">5.8
Internationalization</a></li>
+ <li><a name="toc-Character-Set-1"
href="Character-Set.html#Character-Set">5.9 Character Set</a></li>
+ <li><a name="toc-Quote-Characters-1"
href="Quote-Characters.html#Quote-Characters">5.10 Quote Characters</a></li>
+ <li><a name="toc-Mmap-1" href="Mmap.html#Mmap">5.11 Mmap</a></li>
+ </ul></li>
+ <li><a name="toc-Documenting-Programs"
href="Documentation.html#Documentation">6 Documenting Programs</a>
+ <ul class="no-bullet">
+ <li><a name="toc-GNU-Manuals-1" href="GNU-Manuals.html#GNU-Manuals">6.1
GNU Manuals</a></li>
+ <li><a name="toc-Doc-Strings-and-Manuals-1"
href="Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals">6.2 Doc Strings and
Manuals</a></li>
+ <li><a name="toc-Manual-Structure-Details-1"
href="Manual-Structure-Details.html#Manual-Structure-Details">6.3 Manual
Structure Details</a></li>
+ <li><a name="toc-License-for-Manuals-1"
href="License-for-Manuals.html#License-for-Manuals">6.4 License for
Manuals</a></li>
+ <li><a name="toc-Manual-Credits-1"
href="Manual-Credits.html#Manual-Credits">6.5 Manual Credits</a></li>
+ <li><a name="toc-Printed-Manuals-1"
href="Printed-Manuals.html#Printed-Manuals">6.6 Printed Manuals</a></li>
+ <li><a name="toc-The-NEWS-File" href="NEWS-File.html#NEWS-File">6.7 The
NEWS File</a></li>
+ <li><a name="toc-Change-Logs-1" href="Change-Logs.html#Change-Logs">6.8
Change Logs</a>
+ <ul class="no-bullet">
+ <li><a name="toc-Change-Log-Concepts-1"
href="Change-Log-Concepts.html#Change-Log-Concepts">6.8.1 Change Log
Concepts</a></li>
+ <li><a name="toc-Style-of-Change-Logs-1"
href="Style-of-Change-Logs.html#Style-of-Change-Logs">6.8.2 Style of Change
Logs</a></li>
+ <li><a name="toc-Simple-Changes-1"
href="Simple-Changes.html#Simple-Changes">6.8.3 Simple Changes</a></li>
+ <li><a name="toc-Conditional-Changes-1"
href="Conditional-Changes.html#Conditional-Changes">6.8.4 Conditional
Changes</a></li>
+ <li><a name="toc-Indicating-the-Part-Changed-1"
href="Indicating-the-Part-Changed.html#Indicating-the-Part-Changed">6.8.5
Indicating the Part Changed</a></li>
+ </ul></li>
+ <li><a name="toc-Man-Pages-1" href="Man-Pages.html#Man-Pages">6.9 Man
Pages</a></li>
+ <li><a name="toc-Reading-other-Manuals-1"
href="Reading-other-Manuals.html#Reading-other-Manuals">6.10 Reading other
Manuals</a></li>
+ </ul></li>
+ <li><a name="toc-The-Release-Process"
href="Managing-Releases.html#Managing-Releases">7 The Release Process</a>
+ <ul class="no-bullet">
+ <li><a name="toc-How-Configuration-Should-Work"
href="Configuration.html#Configuration">7.1 How Configuration Should
Work</a></li>
+ <li><a name="toc-Makefile-Conventions-1"
href="Makefile-Conventions.html#Makefile-Conventions">7.2 Makefile
Conventions</a>
+ <ul class="no-bullet">
+ <li><a name="toc-General-Conventions-for-Makefiles"
href="Makefile-Basics.html#Makefile-Basics">7.2.1 General Conventions for
Makefiles</a></li>
+ <li><a name="toc-Utilities-in-Makefiles-1"
href="Utilities-in-Makefiles.html#Utilities-in-Makefiles">7.2.2 Utilities in
Makefiles</a></li>
+ <li><a name="toc-Variables-for-Specifying-Commands"
href="Command-Variables.html#Command-Variables">7.2.3 Variables for Specifying
Commands</a></li>
+ <li><a name="toc-DESTDIR_003a-Support-for-Staged-Installs"
href="DESTDIR.html#DESTDIR">7.2.4 <code>DESTDIR</code>: Support for Staged
Installs</a></li>
+ <li><a name="toc-Variables-for-Installation-Directories"
href="Directory-Variables.html#Directory-Variables">7.2.5 Variables for
Installation Directories</a></li>
+ <li><a name="toc-Standard-Targets-for-Users"
href="Standard-Targets.html#Standard-Targets">7.2.6 Standard Targets for
Users</a></li>
+ <li><a name="toc-Install-Command-Categories-1"
href="Install-Command-Categories.html#Install-Command-Categories">7.2.7 Install
Command Categories</a></li>
+ </ul></li>
+ <li><a name="toc-Making-Releases" href="Releases.html#Releases">7.3 Making
Releases</a></li>
+ </ul></li>
+ <li><a name="toc-References-to-Non_002dFree-Software-and-Documentation"
href="References.html#References">8 References to Non-Free Software and
Documentation</a></li>
+ <li><a name="toc-GNU-Free-Documentation-License-1"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">Appendix
A GNU Free Documentation License</a></li>
+ <li><a name="toc-Index-1" href="Index.html#Index">Index</a></li>
+</ul>
+</div>
-<div class="node">
<a name="Top"></a>
+<div class="header">
<p>
-Next: <a rel="next" accesskey="n" href="Preface.html#Preface">Preface</a>,
-Up: <a rel="up" accesskey="u" href="../index.html#dir">(dir)</a>
-<hr>
+Next: <a href="Preface.html#Preface" accesskey="n" rel="next">Preface</a>, Up:
<a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
-
-<h2 class="unnumbered">GNU Coding Standards</h2>
+<hr>
+<a name="GNU-Coding-Standards"></a>
+<h1 class="top">GNU Coding Standards</h1>
<p>The GNU coding standards, last updated April 7, 2012.
-
- <p>Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+</p>
+<p>Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012 Free Software Foundation, Inc.
-
- <p>Permission is granted to copy, distribute and/or modify this document
+</p>
+<p>Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
“GNU Free Documentation License”.
+</p>
+
+<table class="menu" border="0" cellspacing="0">
+<tr><td align="left" valign="top">• <a href="Preface.html#Preface"
accesskey="1">Preface</a>:</td><td> </td><td align="left"
valign="top">About the GNU Coding Standards.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Legal-Issues.html#Legal-Issues" accesskey="2">Legal
Issues</a>:</td><td> </td><td align="left" valign="top">Keeping free
software free.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Design-Advice.html#Design-Advice" accesskey="3">Design
Advice</a>:</td><td> </td><td align="left" valign="top">General
program design.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Program-Behavior.html#Program-Behavior" accesskey="4">Program
Behavior</a>:</td><td> </td><td align="left" valign="top">Program
behavior for all programs
+</td></tr>
+<tr><td align="left" valign="top">• <a href="Writing-C.html#Writing-C"
accesskey="5">Writing C</a>:</td><td> </td><td align="left"
valign="top">Making the best use of C.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Documentation.html#Documentation"
accesskey="6">Documentation</a>:</td><td> </td><td align="left"
valign="top">Documenting programs.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Managing-Releases.html#Managing-Releases" accesskey="7">Managing
Releases</a>:</td><td> </td><td align="left" valign="top">The
release process.
+</td></tr>
+<tr><td align="left" valign="top">• <a href="References.html#References"
accesskey="8">References</a>:</td><td> </td><td align="left"
valign="top">Mentioning non-free software or documentation.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
accesskey="9">GNU Free Documentation License</a>:</td><td> </td><td
align="left" valign="top">Copying and sharing this manual.
+</td></tr>
+<tr><td align="left" valign="top">• <a
href="Index.html#Index">Index</a>:</td><td> </td><td align="left"
valign="top">
+</td></tr>
+<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
+</pre></th></tr></table>
-<ul class="menu">
-<li><a accesskey="1" href="Preface.html#Preface">Preface</a>:
About the GNU Coding Standards.
-<li><a accesskey="2" href="Legal-Issues.html#Legal-Issues">Legal Issues</a>:
Keeping free software free.
-<li><a accesskey="3" href="Design-Advice.html#Design-Advice">Design
Advice</a>: General program design.
-<li><a accesskey="4" href="Program-Behavior.html#Program-Behavior">Program
Behavior</a>: Program behavior for all programs
-<li><a accesskey="5" href="Writing-C.html#Writing-C">Writing C</a>:
Making the best use of C.
-<li><a accesskey="6"
href="Documentation.html#Documentation">Documentation</a>:
Documenting programs.
-<li><a accesskey="7" href="Managing-Releases.html#Managing-Releases">Managing
Releases</a>: The release process.
-<li><a accesskey="8" href="References.html#References">References</a>:
Mentioning non-free software or documentation.
-<li><a accesskey="9"
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License">GNU
Free Documentation License</a>: Copying and sharing this manual.
-<li><a href="Index.html#Index">Index</a>
+<hr>
+<div class="header">
+<p>
+Next: <a href="Preface.html#Preface" accesskey="n" rel="next">Preface</a>, Up:
<a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a
href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a
href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
- </ul>
- </body></html>
+</body>
+</html>
Index: maintain/index.html
===================================================================
RCS file: /web/www/www/prep/maintain/index.html,v
retrieving revision 1.85
retrieving revision 1.86
diff -u -b -r1.85 -r1.86
--- maintain/index.html 14 Apr 2012 21:41:40 -0000 1.85
+++ maintain/index.html 7 May 2012 00:48:15 -0000 1.86
@@ -4,7 +4,7 @@
<h2>Information for maintainers of GNU software</h2>
<address>Free Software Foundation</address>
-<address>last updated April 14, 2012</address>
+<address>last updated May 06, 2012</address>
<p>This manual (maintain) is available in the following formats:</p>
Index: maintain/maintain.dvi.gz
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.dvi.gz,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -b -r1.77 -r1.78
Binary files /tmp/cvsXWZHkM and /tmp/cvsE9A1Ka differ
Index: maintain/maintain.html.gz
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.html.gz,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -b -r1.78 -r1.79
Binary files /tmp/cvs7d8ElK and /tmp/cvsdmMsN8 differ
Index: maintain/maintain.html_node.tar.gz
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.html_node.tar.gz,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -b -r1.78 -r1.79
Binary files /tmp/cvst09qtL and /tmp/cvsVo7RW9 differ
Index: maintain/maintain.info.tar.gz
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.info.tar.gz,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -b -r1.77 -r1.78
Binary files /tmp/cvsCV4HeO and /tmp/cvsfuDAJc differ
Index: maintain/maintain.pdf
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.pdf,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -b -r1.78 -r1.79
Binary files /tmp/cvszey8YM and /tmp/cvsER8Bwb differ
Index: maintain/maintain.ps.gz
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.ps.gz,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -b -r1.77 -r1.78
Binary files /tmp/cvsQBPlKQ and /tmp/cvsPhuulf differ
Index: maintain/maintain.texi.tar.gz
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.texi.tar.gz,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -b -r1.77 -r1.78
Binary files /tmp/cvsvzijmQ and /tmp/cvs2i5bZe differ
Index: maintain/maintain.txt
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.txt,v
retrieving revision 1.80
retrieving revision 1.81
diff -u -b -r1.80 -r1.81
--- maintain/maintain.txt 14 Apr 2012 21:41:43 -0000 1.80
+++ maintain/maintain.txt 7 May 2012 00:48:27 -0000 1.81
@@ -1719,8 +1719,8 @@
Since 'www.gnu.org' works through CVS, CVS keywords in your manual, such
as '$Log: maintain.txt,v $
-as 'Revision 1.80 2012/04/14 21:41:43 karl
-as 'rms: explain that employer can assign copyright
+as 'Revision 1.81 2012/05/07 00:48:27 karl
+as 'regen for cross-manual links
as '', need special treatment (even if you don't happen to maintain
your manual in CVS).
Index: maintain/maintain.txt.gz
===================================================================
RCS file: /web/www/www/prep/maintain/maintain.txt.gz,v
retrieving revision 1.77
retrieving revision 1.78
diff -u -b -r1.77 -r1.78
Binary files /tmp/cvsTfZFIR and /tmp/cvsNZRWog differ
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- www/prep standards/index.html standards/standar...,
Karl Berry <=