[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
www/prep/standards index.html standards.dvi.gz ...
|
From: |
Alfred M. Szmidt |
|
Subject: |
www/prep/standards index.html standards.dvi.gz ... |
|
Date: |
Wed, 29 May 2024 14:09:33 -0400 (EDT) |
CVSROOT: /web/www
Module name: www
Changes by: Alfred M. Szmidt <ams> 24/05/29 14:09:32
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.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
Finding-Program-Files.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
Log message:
standards: Update.
CVSWeb URLs:
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/index.html?cvsroot=www&r1=1.102&r2=1.103
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.dvi.gz?cvsroot=www&rev=1.98
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.html?cvsroot=www&r1=1.98&r2=1.99
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.html.gz?cvsroot=www&rev=1.99
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.html_node.tar.gz?cvsroot=www&rev=1.99
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.info.tar.gz?cvsroot=www&rev=1.98
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.pdf?cvsroot=www&rev=1.98
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.texi.tar.gz?cvsroot=www&rev=1.98
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.txt?cvsroot=www&r1=1.95&r2=1.96
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/standards.txt.gz?cvsroot=www&rev=1.98
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/CPU-Portability.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Change-Log-Concepts.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Change-Logs.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Character-Set.html?cvsroot=www&r1=1.76&r2=1.77
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Command-Variables.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Command_002dLine-Interfaces.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Comments.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Compatibility.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Conditional-Changes.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Conditional-Compilation.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Configuration.html?cvsroot=www&r1=1.86&r2=1.87
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Contributions.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/DESTDIR.html?cvsroot=www&r1=1.73&r2=1.74
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Design-Advice.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Directory-Variables.html?cvsroot=www&r1=1.89&r2=1.90
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Doc-Strings-and-Manuals.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Documentation.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Dynamic-Plug_002dIn-Interfaces.html?cvsroot=www&r1=1.43&r2=1.44
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Errors.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/File-Usage.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Finding-Program-Files.html?cvsroot=www&r1=1.4&r2=1.5
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Formatting.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/GNU-Free-Documentation-License.html?cvsroot=www&r1=1.86&r2=1.87
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/GNU-Manuals.html?cvsroot=www&r1=1.85&r2=1.86
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Graphical-Interfaces.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Index.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Indicating-the-Part-Changed.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Install-Command-Categories.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Internationalization.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Legal-Issues.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Libraries.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/License-for-Manuals.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Makefile-Basics.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Makefile-Conventions.html?cvsroot=www&r1=1.89&r2=1.90
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Man-Pages.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Managing-Releases.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Manual-Credits.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Manual-Structure-Details.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Memory-Usage.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Mmap.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/NEWS-File.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Names.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Non_002dGNU-Standards.html?cvsroot=www&r1=1.74&r2=1.75
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/OID-Allocations.html?cvsroot=www&r1=1.59&r2=1.60
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Option-Table.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Preface.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Printed-Manuals.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Program-Behavior.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Quote-Characters.html?cvsroot=www&r1=1.76&r2=1.77
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Reading-Non_002dFree-Code.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Reading-other-Manuals.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/References.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Releases.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Semantics.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Simple-Changes.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Source-Language.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Standard-C.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Standard-Targets.html?cvsroot=www&r1=1.87&r2=1.88
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Style-of-Change-Logs.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Syntactic-Conventions.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/System-Functions.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/System-Portability.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Trademarks.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/User-Interfaces.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Using-Extensions.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Utilities-in-Makefiles.html?cvsroot=www&r1=1.86&r2=1.87
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/Writing-C.html?cvsroot=www&r1=1.84&r2=1.85
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/_002d_002dhelp.html?cvsroot=www&r1=1.68&r2=1.69
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/_002d_002dversion.html?cvsroot=www&r1=1.69&r2=1.70
http://web.cvs.savannah.gnu.org/viewcvs/www/prep/standards/html_node/index.html?cvsroot=www&r1=1.84&r2=1.85
Patches:
Index: index.html
===================================================================
RCS file: /web/www/www/prep/standards/index.html,v
retrieving revision 1.102
retrieving revision 1.103
diff -u -b -r1.102 -r1.103
--- index.html 8 Jul 2021 18:18:41 -0000 1.102
+++ index.html 29 May 2024 18:09:28 -0000 1.103
@@ -1,50 +1,46 @@
<!--#include virtual="/server/header.html" -->
-<!-- Parent-Version: 1.78 -->
-
-<!--
-Copyright (C) 2006-2021 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. This file is offered as-is,
-without any warranty.
--->
-
-<title>GNU Coding Standards - GNU Project - Free Software Foundation</title>
+<title>GNU coding standards - GNU Project - Free Software Foundation
(FSF)</title>
<!--#include virtual="/server/banner.html" -->
-<h2>GNU Coding Standards</h2>
+<h2>GNU coding standards</h2>
-<address>Free Software Foundation</address>
-<address>last updated July 08, 2021</address>
+<address>GNU Project</address>
+<address>last updated May 29, 2024</address>
-<p>This manual (standards) is available in the following formats:</p>
+<p>This translation of the <a href="http://perldoc.perl.org/";>Perl
+documentation</a> from POD to Texinfo is not official, and not endorsed
+by the Perl developers (indeed, they haven't seen it). It was created
+by the GNU Texinfo developers because they found it useful to have the
+core Perl documentation available in Info and other formats, and thought
+they would share the results. Suggestions welcome.</p>
+
+<p>This output is created entirely by the Texinfo tools; see the <a
+href="http://cvs.savannah.gnu.org/viewvc/texinfo/contrib/perldoc-all/?root=texinfo";>contrib/perldoc-all</a>
+directory in the Texinfo sources for the procedure used.</p>
+
+<p>This documentation (standards) is available in the following formats:</p>
<ul>
<li><a href="standards.html">HTML
- (368K bytes)</a> - entirely on one web page.</li>
-<li><a href="html_node/index.html">HTML</a> - with one web page per
- node.</li>
+ (404K bytes)</a> - entirely on one web page.</li>
+<li><a href="html_chapter/index.html">HTML</a> - with one web page per
+ chapter.</li>
<li><a href="standards.html.gz">HTML compressed
- (88K gzipped characters)</a> - entirely on
+ (92K gzipped characters)</a> - entirely on
one web page.</li>
-<li><a href="standards.html_node.tar.gz">HTML compressed
- (108K gzipped tar file)</a> -
- with one web page per node.</li>
+<li><a href="standards.html_chapter.tar.gz">HTML compressed
+ (K gzipped tar file)</a> -
+ with one web page per chapter.</li>
<li><a href="standards.info.tar.gz">Info document
- (76K bytes gzipped tar file)</a>.</li>
-<li><a href="standards.txt">ASCII text
- (232K bytes)</a>.</li>
-<li><a href="standards.txt.gz">ASCII text compressed
- (76K bytes gzipped)</a>.</li>
+ (80K bytes gzipped tar file)</a>.</li>
<li><a href="standards.dvi.gz">TeX dvi file
(124K bytes gzipped)</a>.</li>
<li><a href="standards.pdf">PDF file
- (448K bytes)</a>.</li>
+ (444K bytes)</a>.</li>
<li><a href="standards.texi.tar.gz">Texinfo source
- (76K bytes gzipped tar file).</a></li>
+ (120K bytes gzipped tar file).</a></li>
</ul>
-<p>You can <a href="https://shop.fsf.org/";>buy printed copies of
+<p>You can <a href="http://shop.fsf.org/";>buy printed copies of
some manuals</a> (among other items) from the Free Software Foundation;
this helps support FSF activities.</p>
@@ -60,23 +56,20 @@
</div><!-- for id="content", starts in the include above -->
<!--#include virtual="/server/footer.html" -->
<div id="footer">
-<div class="unprintable">
<p>Please send general FSF & GNU inquiries to
<a href="mailto:gnu@gnu.org";><gnu@gnu.org></a>.
There are also <a href="/contact/">other ways to contact</a>
-the FSF. Broken links and other corrections or suggestions can be sent
-to <a
href="mailto:bug-standards@gnu.org";><bug-standards@gnu.org></a>.</p>
-</div>
+the FSF.<br />
+Please send broken links and other corrections or suggestions to
+<a href="mailto:webmasters@gnu.org";><webmasters@gnu.org></a>.</p>
-<p>Copyright © 2020 Free Software Foundation, Inc.</p>
+<p>Copyright © 2013 Free Software Foundation, Inc.</p>
<p>This page is licensed under a <a rel="license"
-href="https://creativecommons.org/licenses/by-nd/3.0/us/";>Creative
+href="http://creativecommons.org/licenses/by-nd/3.0/us/";>Creative
Commons Attribution-NoDerivs 3.0 United States License</a>.</p>
-<!--#include virtual="/server/bottom-notes.html" -->
-
</div>
</div>
</body>
Index: standards.dvi.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.dvi.gz,v
retrieving revision 1.97
retrieving revision 1.98
diff -u -b -r1.97 -r1.98
Binary files /var/tmp/cvsAX1psB and /var/tmp/cvsXjeR0S differ
Index: standards.html
===================================================================
RCS file: /web/www/www/prep/standards/standards.html,v
retrieving revision 1.98
retrieving revision 1.99
diff -u -b -r1.98 -r1.99
--- standards.html 8 Jul 2021 18:18:41 -0000 1.98
+++ standards.html 29 May 2024 18:09:28 -0000 1.99
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>GNU Coding Standards</title>
<meta name="description" content="GNU Coding Standards">
@@ -23,35 +23,30 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<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="/manual" rel="up" title="(dir)">
+<link href="#Preface" rel="next" title="Preface">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+a.summary-letter-printindex {text-decoration: none}
+div.center {text-align:center}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+pre.display-preformatted {font-family: inherit}
+span.r {font-family: initial; font-weight: normal; font-style: normal}
+span:hover a.copiable-link {visibility: visible}
+td.printindex-index-entry {vertical-align: top}
+td.printindex-index-section {vertical-align: top; padding-left: 1em}
+th.entries-header-printindex {text-align:left}
+th.sections-header-printindex {text-align:left; padding-left: 1em}
+ul.mark-bullet {list-style-type: disc}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -60,7 +55,6 @@
</head>
<body lang="en">
-<h1 class="settitle" align="center">GNU Coding Standards</h1>
@@ -68,112 +62,15 @@
-<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-Finding-the-Program_0027s-Executable-and-Associated-Files"
href="#Finding-Program-Files">4.6 Finding the Program’s Executable and
Associated Files</a></li>
- <li><a name="toc-Standards-for-Graphical-Interfaces"
href="#Graphical-Interfaces">4.7 Standards for Graphical Interfaces</a></li>
- <li><a name="toc-Standards-for-Command-Line-Interfaces"
href="#Command_002dLine-Interfaces">4.8 Standards for Command Line
Interfaces</a>
- <ul class="no-bullet">
- <li><a name="toc-_002d_002dversion-1" href="#g_t_002d_002dversion">4.8.1
<samp>--version</samp></a></li>
- <li><a name="toc-_002d_002dhelp-1" href="#g_t_002d_002dhelp">4.8.2
<samp>--help</samp></a></li>
- </ul></li>
- <li><a name="toc-Standards-for-Dynamic-Plug_002din-Interfaces"
href="#Dynamic-Plug_002dIn-Interfaces">4.9 Standards for Dynamic Plug-in
Interfaces</a></li>
- <li><a name="toc-Table-of-Long-Options" href="#Option-Table">4.10 Table of
Long Options</a></li>
- <li><a name="toc-OID-Allocations-1" href="#OID-Allocations">4.11 OID
Allocations</a></li>
- <li><a name="toc-Memory-Usage-1" href="#Memory-Usage">4.12 Memory
Usage</a></li>
- <li><a name="toc-File-Usage-1" href="#File-Usage">4.13 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 CPUs</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-and-Conventions"
href="#Change-Log-Concepts">6.8.1 Change Log Concepts and Conventions</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>
-
-
-<a name="Top"></a>
-<div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="#Preface" accesskey="n" rel="next">Preface</a>, Up: <a
href="/manual" 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>
+Next: <a href="#Preface" accesskey="n" rel="next">About the GNU Coding
Standards</a>, Up: <a href="/manual" 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>
+<h1 class="top" id="GNU-Coding-Standards"><span>GNU Coding Standards<a
class="copiable-link" href="#GNU-Coding-Standards"> ¶</a></span></h1>
-<p>The GNU coding standards, last updated July 1, 2021.
+<p>The GNU coding standards, last updated May 26, 2024.
</p>
<p>Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -188,39 +85,109 @@
“GNU Free Documentation License”.
</p>
-<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="region-contents" id="SEC_Contents">
+<h2 class="contents-heading">Table of Contents</h2>
+
+<div class="contents">
+<ul class="toc-numbered-mark">
+ <li><a id="toc-About-the-GNU-Coding-Standards" href="#Preface">1 About the
GNU Coding Standards</a></li>
+ <li><a id="toc-Keeping-Free-Software-Free" href="#Legal-Issues">2 Keeping
Free Software Free</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Referring-to-Proprietary-Programs"
href="#Reading-Non_002dFree-Code">2.1 Referring to Proprietary Programs</a></li>
+ <li><a id="toc-Accepting-Contributions" href="#Contributions">2.2
Accepting Contributions</a></li>
+ <li><a id="toc-Trademarks" href="#Trademarks">2.3 Trademarks</a></li>
+ </ul></li>
+ <li><a id="toc-General-Program-Design" href="#Design-Advice">3 General
Program Design</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Which-Languages-to-Use" href="#Source-Language">3.1 Which
Languages to Use</a></li>
+ <li><a id="toc-Compatibility-with-Other-Implementations"
href="#Compatibility">3.2 Compatibility with Other Implementations</a></li>
+ <li><a id="toc-Using-Non_002dstandard-Features"
href="#Using-Extensions">3.3 Using Non-standard Features</a></li>
+ <li><a id="toc-Standard-C-and-Pre_002dStandard-C" href="#Standard-C">3.4
Standard C and Pre-Standard C</a></li>
+ <li><a id="toc-Conditional-Compilation"
href="#Conditional-Compilation">3.5 Conditional Compilation</a></li>
+ </ul></li>
+ <li><a id="toc-Program-Behavior-for-All-Programs" href="#Program-Behavior">4
Program Behavior for All Programs</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Non_002dGNU-Standards" href="#Non_002dGNU-Standards">4.1
Non-GNU Standards</a></li>
+ <li><a id="toc-Writing-Robust-Programs" href="#Semantics">4.2 Writing
Robust Programs</a></li>
+ <li><a id="toc-Library-Behavior" href="#Libraries">4.3 Library
Behavior</a></li>
+ <li><a id="toc-Formatting-Error-Messages" href="#Errors">4.4 Formatting
Error Messages</a></li>
+ <li><a id="toc-Standards-for-Interfaces-Generally"
href="#User-Interfaces">4.5 Standards for Interfaces Generally</a></li>
+ <li><a id="toc-Finding-the-Program_0027s-Executable-and-Associated-Files"
href="#Finding-Program-Files">4.6 Finding the Program’s Executable and
Associated Files</a></li>
+ <li><a id="toc-Standards-for-Graphical-Interfaces"
href="#Graphical-Interfaces">4.7 Standards for Graphical Interfaces</a></li>
+ <li><a id="toc-Standards-for-Command-Line-Interfaces"
href="#Command_002dLine-Interfaces">4.8 Standards for Command Line
Interfaces</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-_002d_002dversion" href="#g_t_002d_002dversion">4.8.1
<samp class="option">--version</samp></a></li>
+ <li><a id="toc-_002d_002dhelp" href="#g_t_002d_002dhelp">4.8.2 <samp
class="option">--help</samp></a></li>
+ </ul></li>
+ <li><a id="toc-Standards-for-Dynamic-Plug_002din-Interfaces"
href="#Dynamic-Plug_002dIn-Interfaces">4.9 Standards for Dynamic Plug-in
Interfaces</a></li>
+ <li><a id="toc-Table-of-Long-Options" href="#Option-Table">4.10 Table of
Long Options</a></li>
+ <li><a id="toc-OID-Allocations" href="#OID-Allocations">4.11 OID
Allocations</a></li>
+ <li><a id="toc-Memory-Usage" href="#Memory-Usage">4.12 Memory
Usage</a></li>
+ <li><a id="toc-File-Usage" href="#File-Usage">4.13 File Usage</a></li>
+ </ul></li>
+ <li><a id="toc-Making-The-Best-Use-of-C" href="#Writing-C">5 Making The Best
Use of C</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Formatting-Your-Source-Code" href="#Formatting">5.1
Formatting Your Source Code</a></li>
+ <li><a id="toc-Commenting-Your-Work" href="#Comments">5.2 Commenting Your
Work</a></li>
+ <li><a id="toc-Clean-Use-of-C-Constructs"
href="#Syntactic-Conventions">5.3 Clean Use of C Constructs</a></li>
+ <li><a id="toc-Naming-Variables_002c-Functions_002c-and-Files"
href="#Names">5.4 Naming Variables, Functions, and Files</a></li>
+ <li><a id="toc-Portability-between-System-Types"
href="#System-Portability">5.5 Portability between System Types</a></li>
+ <li><a id="toc-Portability-between-CPUs" href="#CPU-Portability">5.6
Portability between CPUs</a></li>
+ <li><a id="toc-Calling-System-Functions" href="#System-Functions">5.7
Calling System Functions</a></li>
+ <li><a id="toc-Internationalization" href="#Internationalization">5.8
Internationalization</a></li>
+ <li><a id="toc-Character-Set" href="#Character-Set">5.9 Character
Set</a></li>
+ <li><a id="toc-Quote-Characters" href="#Quote-Characters">5.10 Quote
Characters</a></li>
+ <li><a id="toc-Mmap" href="#Mmap">5.11 Mmap</a></li>
+ </ul></li>
+ <li><a id="toc-Documenting-Programs" href="#Documentation">6 Documenting
Programs</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-GNU-Manuals" href="#GNU-Manuals">6.1 GNU Manuals</a></li>
+ <li><a id="toc-Doc-Strings-and-Manuals"
href="#Doc-Strings-and-Manuals">6.2 Doc Strings and Manuals</a></li>
+ <li><a id="toc-Manual-Structure-Details"
href="#Manual-Structure-Details">6.3 Manual Structure Details</a></li>
+ <li><a id="toc-License-for-Manuals" href="#License-for-Manuals">6.4
License for Manuals</a></li>
+ <li><a id="toc-Manual-Credits" href="#Manual-Credits">6.5 Manual
Credits</a></li>
+ <li><a id="toc-Printed-Manuals" href="#Printed-Manuals">6.6 Printed
Manuals</a></li>
+ <li><a id="toc-The-NEWS-File" href="#NEWS-File">6.7 The NEWS File</a></li>
+ <li><a id="toc-Change-Logs" href="#Change-Logs">6.8 Change Logs</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Change-Log-Concepts-and-Conventions"
href="#Change-Log-Concepts">6.8.1 Change Log Concepts and Conventions</a></li>
+ <li><a id="toc-Style-of-Change-Logs" href="#Style-of-Change-Logs">6.8.2
Style of Change Logs</a></li>
+ <li><a id="toc-Simple-Changes" href="#Simple-Changes">6.8.3 Simple
Changes</a></li>
+ <li><a id="toc-Conditional-Changes" href="#Conditional-Changes">6.8.4
Conditional Changes</a></li>
+ <li><a id="toc-Indicating-the-Part-Changed"
href="#Indicating-the-Part-Changed">6.8.5 Indicating the Part Changed</a></li>
+ </ul></li>
+ <li><a id="toc-Man-Pages" href="#Man-Pages">6.9 Man Pages</a></li>
+ <li><a id="toc-Reading-other-Manuals" href="#Reading-other-Manuals">6.10
Reading other Manuals</a></li>
+ </ul></li>
+ <li><a id="toc-The-Release-Process" href="#Managing-Releases">7 The Release
Process</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-How-Configuration-Should-Work" href="#Configuration">7.1
How Configuration Should Work</a></li>
+ <li><a id="toc-Makefile-Conventions" href="#Makefile-Conventions">7.2
Makefile Conventions</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-General-Conventions-for-Makefiles"
href="#Makefile-Basics">7.2.1 General Conventions for Makefiles</a></li>
+ <li><a id="toc-Utilities-in-Makefiles"
href="#Utilities-in-Makefiles">7.2.2 Utilities in Makefiles</a></li>
+ <li><a id="toc-Variables-for-Specifying-Commands"
href="#Command-Variables">7.2.3 Variables for Specifying Commands</a></li>
+ <li><a id="toc-DESTDIR_003a-Support-for-Staged-Installs"
href="#DESTDIR">7.2.4 <code class="code">DESTDIR</code>: Support for Staged
Installs</a></li>
+ <li><a id="toc-Variables-for-Installation-Directories"
href="#Directory-Variables">7.2.5 Variables for Installation
Directories</a></li>
+ <li><a id="toc-Standard-Targets-for-Users"
href="#Standard-Targets">7.2.6 Standard Targets for Users</a></li>
+ <li><a id="toc-Install-Command-Categories"
href="#Install-Command-Categories">7.2.7 Install Command Categories</a></li>
+ </ul></li>
+ <li><a id="toc-Making-Releases" href="#Releases">7.3 Making
Releases</a></li>
+ </ul></li>
+ <li><a id="toc-References-to-Non_002dFree-Software-and-Documentation"
href="#References">8 References to Non-Free Software and Documentation</a></li>
+ <li><a id="toc-GNU-Free-Documentation-License"
href="#GNU-Free-Documentation-License">Appendix A GNU Free Documentation
License</a></li>
+ <li><a id="toc-Index" href="#Index" rel="index">Index</a></li>
+</ul>
+</div>
+</div>
<hr>
-<a name="Preface"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Preface">
+<div class="nav-panel">
<p>
-Next: <a href="#Legal-Issues" accesskey="n" rel="next">Legal Issues</a>,
Previous: <a href="#Top" accesskey="p" rel="prev">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>
+Next: <a href="#Legal-Issues" accesskey="n" rel="next">Keeping Free Software
Free</a>, Previous: <a href="#Top" accesskey="p" rel="prev">GNU Coding
Standards</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU Coding
Standards</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>
+<h2 class="chapter" id="About-the-GNU-Coding-Standards"><span>1 About the GNU
Coding Standards<a class="copiable-link"
href="#About-the-GNU-Coding-Standards"> ¶</a></span></h2>
<p>The GNU Coding Standards were written by Richard Stallman and other GNU
Project volunteers. Their purpose is to make the GNU system clean,
@@ -230,37 +197,37 @@
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-standards_002etexi"></a>
-<a name="index-downloading-this-manual"></a>
+<a class="index-entry-id" id="index-where-to-obtain-standards_002etexi"></a>
+<a class="index-entry-id" id="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="https://www.gnu.org/prep/standards/";>https://www.gnu.org/prep/standards/</a>.
+text, and more, at: <a class="uref"
href="https://www.gnu.org/prep/standards/";>https://www.gnu.org/prep/standards/</a>.
</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="http://www.gnu.org/prep/maintain/maintain.html#Top";>Contents</a>
in <cite>Information for Maintainers of GNU
+(see <a data-manual="maintain"
href="https://www.gnu.org/prep/maintain/maintain.html#Top";>Contents</a> in
<cite class="cite">Information for Maintainers of GNU
Software</cite>).
</p>
-<a name="index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"></a>
+<a class="index-entry-id"
id="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>gnustandards-commit@gnu.org</code>, via the web
+join the mailing list <code class="code">gnustandards-commit@gnu.org</code>,
via the web
interface at
-<a
href="https://lists.gnu.org/mailman/listinfo/gnustandards-commit";>https://lists.gnu.org/mailman/listinfo/gnustandards-commit</a>.
+<a class="url"
href="https://lists.gnu.org/mailman/listinfo/gnustandards-commit";>https://lists.gnu.org/mailman/listinfo/gnustandards-commit</a>.
Archives are also available there.
</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>
+<a class="index-entry-id"
id="index-bug_002dstandards_0040gnu_002eorg-email-address"></a>
+<a class="index-entry-id" id="index-Savannah-repository-for-gnustandards"></a>
+<a class="index-entry-id" id="index-gnustandards-project-repository"></a>
<p>Please send corrections or suggestions for this document to
-<a href="mailto:bug-standards@gnu.org";>bug-standards@gnu.org</a>. If you make
a suggestion, please
+<a class="email"
href="mailto:bug-standards@gnu.org";>bug-standards@gnu.org</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
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="https://savannah.gnu.org/projects/gnustandards";>https://savannah.gnu.org/projects/gnustandards</a>.
+at <a class="url"
href="https://savannah.gnu.org/projects/gnustandards";>https://savannah.gnu.org/projects/gnustandards</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.
@@ -276,44 +243,40 @@
</p>
<p>The GNU Hello program serves as an example of how to follow the GNU
coding standards for a trivial program.
-<a
href="https://www.gnu.org/software/hello/hello.html";>https://www.gnu.org/software/hello/hello.html</a>.
+<a class="uref"
href="https://www.gnu.org/software/hello/hello.html";>https://www.gnu.org/software/hello/hello.html</a>.
</p>
<p>This release of the GNU Coding Standards was last updated
-July 1, 2021.
+May 26, 2024.
</p>
<hr>
-<a name="Legal-Issues"></a>
-<div class="header">
+</div>
+<div class="chapter-level-extent" id="Legal-Issues">
+<div class="nav-panel">
<p>
-Next: <a href="#Design-Advice" accesskey="n" rel="next">Design Advice</a>,
Previous: <a href="#Preface" accesskey="p" rel="prev">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>
+Next: <a href="#Design-Advice" accesskey="n" rel="next">General Program
Design</a>, Previous: <a href="#Preface" accesskey="p" rel="prev">About the GNU
Coding Standards</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU Coding
Standards</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>
+<h2 class="chapter" id="Keeping-Free-Software-Free"><span>2 Keeping Free
Software Free<a class="copiable-link" href="#Keeping-Free-Software-Free">
¶</a></span></h2>
+<a class="index-entry-id" id="index-legal-aspects"></a>
<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="mini-toc">
+<li><a href="#Reading-Non_002dFree-Code" accesskey="1">Referring to
Proprietary Programs</a></li>
+<li><a href="#Contributions" accesskey="2">Accepting Contributions</a></li>
+<li><a href="#Trademarks" accesskey="3">Trademarks</a></li>
+</ul>
<hr>
-<a name="Reading-Non_002dFree-Code"></a>
-<div class="header">
+<div class="section-level-extent" id="Reading-Non_002dFree-Code">
+<div class="nav-panel">
<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>
+Next: <a href="#Contributions" accesskey="n" rel="next">Accepting
Contributions</a>, Up: <a href="#Legal-Issues" accesskey="u" rel="up">Keeping
Free Software Free</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>
+<h3 class="section" id="Referring-to-Proprietary-Programs"><span>2.1 Referring
to Proprietary Programs<a class="copiable-link"
href="#Referring-to-Proprietary-Programs"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-proprietary-programs"></a>
+<a class="index-entry-id" id="index-avoiding-proprietary-code"></a>
<p>Don’t in any circumstances refer to Unix source code for or during
your work on GNU! (Or to any other proprietary programs.)
@@ -347,20 +310,20 @@
</p>
<hr>
-<a name="Contributions"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Contributions">
+<div class="nav-panel">
<p>
-Next: <a href="#Trademarks" accesskey="n" rel="next">Trademarks</a>, Previous:
<a href="#Reading-Non_002dFree-Code" accesskey="p" rel="prev">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>
+Next: <a href="#Trademarks" accesskey="n" rel="next">Trademarks</a>, Previous:
<a href="#Reading-Non_002dFree-Code" accesskey="p" rel="prev">Referring to
Proprietary Programs</a>, Up: <a href="#Legal-Issues" accesskey="u"
rel="up">Keeping Free Software Free</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>
+<h3 class="section" id="Accepting-Contributions"><span>2.2 Accepting
Contributions<a class="copiable-link" href="#Accepting-Contributions">
¶</a></span></h3>
+<a class="index-entry-id" id="index-legal-papers"></a>
+<a class="index-entry-id" id="index-accepting-contributions"></a>
<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
+sign papers initially. <em class="emph">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.
@@ -396,18 +359,18 @@
</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="http://www.gnu.org/prep/maintain/maintain.html#Legal-Matters";>Legal
Matters</a> in <cite>Information for GNU Maintainers</cite>.
+or not), please take a look: see <a data-manual="maintain"
href="https://www.gnu.org/prep/maintain/maintain.html#Legal-Matters";>Legal
Matters</a> in <cite class="cite">Information for GNU Maintainers</cite>.
</p>
<hr>
-<a name="Trademarks"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Trademarks">
+<div class="nav-panel">
<p>
-Previous: <a href="#Contributions" accesskey="p" rel="prev">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>
+Previous: <a href="#Contributions" accesskey="p" rel="prev">Accepting
Contributions</a>, Up: <a href="#Legal-Issues" accesskey="u" rel="up">Keeping
Free Software Free</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>
+<h3 class="section" id="Trademarks-1"><span>2.3 Trademarks<a
class="copiable-link" href="#Trademarks-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-trademarks"></a>
<p>Please do not include any trademark acknowledgments in GNU software
packages or documentation.
@@ -432,45 +395,40 @@
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 so in
GNU packages. Please write “Windows” in full, or abbreviate it to
-“w.” See <a href="#System-Portability">System Portability</a>.
+“w.” See <a class="xref" href="#System-Portability">Portability
between System Types</a>.
</p>
<hr>
-<a name="Design-Advice"></a>
-<div class="header">
+</div>
+</div>
+<div class="chapter-level-extent" id="Design-Advice">
+<div class="nav-panel">
<p>
-Next: <a href="#Program-Behavior" accesskey="n" rel="next">Program
Behavior</a>, Previous: <a href="#Legal-Issues" accesskey="p" rel="prev">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>
+Next: <a href="#Program-Behavior" accesskey="n" rel="next">Program Behavior
for All Programs</a>, Previous: <a href="#Legal-Issues" accesskey="p"
rel="prev">Keeping Free Software Free</a>, Up: <a href="#Top" accesskey="u"
rel="up">GNU Coding Standards</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>
+<h2 class="chapter" id="General-Program-Design"><span>3 General Program
Design<a class="copiable-link" href="#General-Program-Design">
¶</a></span></h2>
+<a class="index-entry-id" id="index-program-design"></a>
<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"
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>
+<ul class="mini-toc">
+<li><a href="#Source-Language" accesskey="1">Which Languages to Use</a></li>
+<li><a href="#Compatibility" accesskey="2">Compatibility with Other
Implementations</a></li>
+<li><a href="#Using-Extensions" accesskey="3">Using Non-standard
Features</a></li>
+<li><a href="#Standard-C" accesskey="4">Standard C and Pre-Standard C</a></li>
+<li><a href="#Conditional-Compilation" accesskey="5">Conditional
Compilation</a></li>
+</ul>
<hr>
-<a name="Source-Language"></a>
-<div class="header">
+<div class="section-level-extent" id="Source-Language">
+<div class="nav-panel">
<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>
+Next: <a href="#Compatibility" accesskey="n" rel="next">Compatibility with
Other Implementations</a>, Up: <a href="#Design-Advice" accesskey="u"
rel="up">General Program Design</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>
+<h3 class="section" id="Which-Languages-to-Use"><span>3.1 Which Languages to
Use<a class="copiable-link" href="#Which-Languages-to-Use">
¶</a></span></h3>
+<a class="index-entry-id" id="index-programming-languages"></a>
<p>When you want to use a language that gets compiled and runs at high
speed, the best language to use is C. C++ is ok too, but please don’t
@@ -482,18 +440,18 @@
particular role in the GNU System: it is the preferred language to
extend programs written in C/C++, and also a fine language for a wide
range of applications. The more GNU components use Guile and Scheme,
-the more users are able to extend and combine them (see <a
href="http://www.gnu.org/software/guile/manual/guile.html#The-Emacs-Thesis";>The
Emacs
-Thesis</a> in <cite>GNU Guile Reference Manual</cite>).
+the more users are able to extend and combine them (see <a data-manual="guile"
href="https://www.gnu.org/software/guile/manual/guile.html#The-Emacs-Thesis";>The
Emacs
+Thesis</a> in <cite class="cite">GNU Guile Reference Manual</cite>).
</p>
<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"></a>
-<a name="index-GNOME-and-Guile"></a>
+<a class="index-entry-id" id="index-Guile"></a>
+<a class="index-entry-id" id="index-GNOME-and-Guile"></a>
<p>The standard extensibility interpreter for GNU software is Guile
-(<a
href="https://www.gnu.org/software/guile/";>https://www.gnu.org/software/guile/</a>),
which implements the
+(<a class="uref"
href="https://www.gnu.org/software/guile/";>https://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
@@ -503,16 +461,16 @@
</p>
<hr>
-<a name="Compatibility"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Compatibility">
+<div class="nav-panel">
<p>
-Next: <a href="#Using-Extensions" accesskey="n" rel="next">Using
Extensions</a>, Previous: <a href="#Source-Language" accesskey="p"
rel="prev">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>
+Next: <a href="#Using-Extensions" accesskey="n" rel="next">Using Non-standard
Features</a>, Previous: <a href="#Source-Language" accesskey="p"
rel="prev">Which Languages to Use</a>, Up: <a href="#Design-Advice"
accesskey="u" rel="up">General Program Design</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-C-compatibility"></a>
-<a name="index-POSIX-compatibility"></a>
+<h3 class="section" id="Compatibility-with-Other-Implementations"><span>3.2
Compatibility with Other Implementations<a class="copiable-link"
href="#Compatibility-with-Other-Implementations"> ¶</a></span></h3>
+<a class="index-entry-id"
id="index-compatibility-with-C-and-POSIX-standards"></a>
+<a class="index-entry-id" id="index-C-compatibility"></a>
+<a class="index-entry-id" id="index-POSIX-compatibility"></a>
<p>With occasional exceptions, utility programs and libraries for GNU
should be upward compatible with those in Berkeley Unix, and upward
@@ -523,38 +481,38 @@
<p>When these standards conflict, it is useful to offer compatibility
modes for each of them.
</p>
-<a name="index-options-for-compatibility"></a>
+<a class="index-entry-id" id="index-options-for-compatibility"></a>
<p>Standard C and POSIX 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.
+free to make the extensions anyway, and include a ‘<samp
class="samp">--ansi</samp>’,
+‘<samp class="samp">--posix</samp>’, or ‘<samp
class="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-POSIXLY_005fCORRECT_002c-environment-variable"></a>
+<a class="index-entry-id"
id="index-POSIXLY_005fCORRECT_002c-environment-variable"></a>
<p>Many GNU programs suppress extensions that conflict with POSIX if the
-environment variable <code>POSIXLY_CORRECT</code> is defined (even if it is
+environment variable <code class="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>
<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.)
+<code class="code">vi</code> is replaced with Emacs.) But it is nice to offer
a compatible
+feature as well. (There is a free <code class="code">vi</code> clone, so we
offer it.)
</p>
<p>Additional useful features are welcome regardless of whether
there is any precedent for them.
</p>
<hr>
-<a name="Using-Extensions"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Using-Extensions">
+<div class="nav-panel">
<p>
-Next: <a href="#Standard-C" accesskey="n" rel="next">Standard C</a>, Previous:
<a href="#Compatibility" accesskey="p" rel="prev">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>
+Next: <a href="#Standard-C" accesskey="n" rel="next">Standard C and
Pre-Standard C</a>, Previous: <a href="#Compatibility" accesskey="p"
rel="prev">Compatibility with Other Implementations</a>, Up: <a
href="#Design-Advice" accesskey="u" rel="up">General Program Design</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>
+<h3 class="section" id="Using-Non_002dstandard-Features"><span>3.3 Using
Non-standard Features<a class="copiable-link"
href="#Using-Non_002dstandard-Features"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-non_002dstandard-extensions"></a>
<p>Many GNU facilities that already exist support a number of convenient
extensions over the comparable Unix facilities. Whether to use these
@@ -566,8 +524,8 @@
program to work on fewer kinds of machines.
</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
+For example, you can define functions with a “keyword” <code
class="code">INLINE</code>
+and define that as a macro to expand into either <code
class="code">inline</code> or
nothing, depending on the compiler.
</p>
<p>In general, perhaps it is best not to use the extensions if you can
@@ -585,14 +543,14 @@
already. That would be extremely troublesome in certain cases.
</p>
<hr>
-<a name="Standard-C"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Standard-C">
+<div class="nav-panel">
<p>
-Next: <a href="#Conditional-Compilation" accesskey="n" rel="next">Conditional
Compilation</a>, Previous: <a href="#Using-Extensions" accesskey="p"
rel="prev">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>
+Next: <a href="#Conditional-Compilation" accesskey="n" rel="next">Conditional
Compilation</a>, Previous: <a href="#Using-Extensions" accesskey="p"
rel="prev">Using Non-standard Features</a>, Up: <a href="#Design-Advice"
accesskey="u" rel="up">General Program Design</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>
+<h3 class="section" id="Standard-C-and-Pre_002dStandard-C"><span>3.4 Standard
C and Pre-Standard C<a class="copiable-link"
href="#Standard-C-and-Pre_002dStandard-C"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ANSI-C-standard"></a>
<p>1989 Standard C is widespread enough now that it is ok to use its
features in programs. There is one exception: do not ever use the
@@ -611,29 +569,29 @@
<p>However, it is easy to support pre-standard compilers in most programs,
so if you know how to do that, feel free.
</p>
-<a name="index-function-prototypes"></a>
+<a class="index-entry-id" id="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
+<pre class="example-preformatted">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
+<pre class="example-preformatted">int
foo (x, y)
int x, y;
-…
+...
</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 class="example-preformatted">int foo (int, int);
</pre></div>
<p>You need such a declaration anyway, in a header file, to get the benefit
@@ -641,25 +599,25 @@
you have the declaration, you normally lose nothing by writing the
function definition in the pre-standard style.
</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>This technique does not work for integer types narrower than <code
class="code">int</code>.
+If you think of an argument as being of a type narrower than <code
class="code">int</code>,
+declare it as <code class="code">int</code> instead.
</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,
-because <code>dev_t</code> is wider than <code>int</code> on some machines.
There
+<code class="code">dev_t</code>, you run into trouble, because <code
class="code">dev_t</code> is shorter than
+<code class="code">int</code> on some machines; but you cannot use <code
class="code">int</code> instead,
+because <code class="code">dev_t</code> is wider than <code
class="code">int</code> 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 <code>dev_t</code> using Autoconf and choose
+argument is to check the width of <code class="code">dev_t</code> using
Autoconf and choose
the argument type accordingly. This may not be worth the trouble.
</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.
*/
+<pre class="example-preformatted">/* Declare the prototype for a general
external function. */
#if defined (__STDC__) || defined (WINDOWSNT)
#define P_(proto) proto
#else
@@ -668,23 +626,23 @@
</pre></div>
<hr>
-<a name="Conditional-Compilation"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Conditional-Compilation">
+<div class="nav-panel">
<p>
-Previous: <a href="#Standard-C" accesskey="p" rel="prev">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>
+Previous: <a href="#Standard-C" accesskey="p" rel="prev">Standard C and
Pre-Standard C</a>, Up: <a href="#Design-Advice" accesskey="u" rel="up">General
Program Design</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>
+<h3 class="section" id="Conditional-Compilation-1"><span>3.5 Conditional
Compilation<a class="copiable-link" href="#Conditional-Compilation-1">
¶</a></span></h3>
<p>When supporting configuration options already known when building your
-program we prefer using <code>if (... )</code> over conditional compilation,
+program we prefer using <code class="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>
<p>For example, please write
</p>
-<div class="smallexample">
-<pre class="smallexample"> if (HAS_FOO)
+<div class="example smallexample">
+<pre class="example-preformatted"> if (HAS_FOO)
...
else
...
@@ -692,8 +650,8 @@
<p>instead of:
</p>
-<div class="smallexample">
-<pre class="smallexample"> #ifdef HAS_FOO
+<div class="example smallexample">
+<pre class="example-preformatted"> #ifdef HAS_FOO
...
#else
...
@@ -703,19 +661,19 @@
<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.
+<code class="code">HAS_FOO</code> is defined as either 0 or 1.
</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>
-<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
+<p>In the case of function-like macros like <code
class="code">REVERSIBLE_CC_MODE</code> in
+GCC which cannot be simply used in <code class="code">if (...)</code>
statements, there is
an easy workaround. Simply introduce another macro
-<code>HAS_REVERSIBLE_CC_MODE</code> as in the following example:
+<code class="code">HAS_REVERSIBLE_CC_MODE</code> as in the following example:
</p>
-<div class="smallexample">
-<pre class="smallexample"> #ifdef REVERSIBLE_CC_MODE
+<div class="example smallexample">
+<pre class="example-preformatted"> #ifdef REVERSIBLE_CC_MODE
#define HAS_REVERSIBLE_CC_MODE 1
#else
#define HAS_REVERSIBLE_CC_MODE 0
@@ -723,57 +681,42 @@
</pre></div>
<hr>
-<a name="Program-Behavior"></a>
-<div class="header">
+</div>
+</div>
+<div class="chapter-level-extent" id="Program-Behavior">
+<div class="nav-panel">
<p>
-Next: <a href="#Writing-C" accesskey="n" rel="next">Writing C</a>, Previous:
<a href="#Design-Advice" accesskey="p" rel="prev">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>
+Next: <a href="#Writing-C" accesskey="n" rel="next">Making The Best Use of
C</a>, Previous: <a href="#Design-Advice" accesskey="p" rel="prev">General
Program Design</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU Coding
Standards</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>
+<h2 class="chapter" id="Program-Behavior-for-All-Programs"><span>4 Program
Behavior for All Programs<a class="copiable-link"
href="#Program-Behavior-for-All-Programs"> ¶</a></span></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="#Finding-Program-Files"
accesskey="6">Finding Program Files</a>:</td><td> </td><td
align="left" valign="top">How to find the program’s executable
- and other files that go with it.
-</td></tr>
-<tr><td align="left" valign="top">• <a href="#Graphical-Interfaces"
accesskey="7">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="8">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="9">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">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="mini-toc">
+<li><a href="#Non_002dGNU-Standards" accesskey="1">Non-GNU Standards</a></li>
+<li><a href="#Semantics" accesskey="2">Writing Robust Programs</a></li>
+<li><a href="#Libraries" accesskey="3">Library Behavior</a></li>
+<li><a href="#Errors" accesskey="4">Formatting Error Messages</a></li>
+<li><a href="#User-Interfaces" accesskey="5">Standards for Interfaces
Generally</a></li>
+<li><a href="#Finding-Program-Files" accesskey="6">Finding the Program’s
Executable and Associated Files</a></li>
+<li><a href="#Graphical-Interfaces" accesskey="7">Standards for Graphical
Interfaces</a></li>
+<li><a href="#Command_002dLine-Interfaces" accesskey="8">Standards for Command
Line Interfaces</a></li>
+<li><a href="#Dynamic-Plug_002dIn-Interfaces" accesskey="9">Standards for
Dynamic Plug-in Interfaces</a></li>
+<li><a href="#Option-Table">Table of Long Options</a></li>
+<li><a href="#OID-Allocations">OID Allocations</a></li>
+<li><a href="#Memory-Usage">Memory Usage</a></li>
+<li><a href="#File-Usage">File Usage</a></li>
+</ul>
<hr>
-<a name="Non_002dGNU-Standards"></a>
-<div class="header">
+<div class="section-level-extent" id="Non_002dGNU-Standards">
+<div class="nav-panel">
<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>
+Next: <a href="#Semantics" accesskey="n" rel="next">Writing Robust
Programs</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior for All Programs</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>
+<h3 class="section" id="Non_002dGNU-Standards-1"><span>4.1 Non-GNU Standards<a
class="copiable-link" href="#Non_002dGNU-Standards-1"> ¶</a></span></h3>
<p>The GNU Project regards standards published by other organizations as
suggestions, not orders. We consider those standards, but we do not
@@ -797,16 +740,16 @@
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>--pedantic</samp>’, which was implemented
only so that
+you must specify ‘<samp class="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>
-<p>POSIX.2 specifies that ‘<samp>df</samp>’ and
‘<samp>du</samp>’ must output sizes by
+<p>POSIX.2 specifies that ‘<samp class="samp">df</samp>’ and
‘<samp class="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>POSIXLY_CORRECT</samp>’ (which was originally going to be
named
-‘<samp>POSIX_ME_HARDER</samp>’).
+‘<samp class="samp">POSIXLY_CORRECT</samp>’ (which was originally
going to be named
+‘<samp class="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
@@ -818,54 +761,54 @@
</p>
<hr>
-<a name="Semantics"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Semantics">
+<div class="nav-panel">
<p>
-Next: <a href="#Libraries" accesskey="n" rel="next">Libraries</a>, Previous:
<a href="#Non_002dGNU-Standards" accesskey="p" rel="prev">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>
+Next: <a href="#Libraries" accesskey="n" rel="next">Library Behavior</a>,
Previous: <a href="#Non_002dGNU-Standards" accesskey="p" rel="prev">Non-GNU
Standards</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior for All Programs</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>
+<h3 class="section" id="Writing-Robust-Programs"><span>4.2 Writing Robust
Programs<a class="copiable-link" href="#Writing-Robust-Programs">
¶</a></span></h3>
-<a name="index-arbitrary-limits-on-data"></a>
-<p>Avoid arbitrary limits on the length or number of <em>any</em> data
+<a class="index-entry-id" id="index-arbitrary-limits-on-data"></a>
+<p>Avoid arbitrary limits on the length or number of <em class="emph">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-NUL-characters"></a>
-<a name="index-libiconv"></a>
+<a class="index-entry-id" id="index-NUL-characters"></a>
+<a class="index-entry-id" id="index-libiconv"></a>
<p>Utilities reading files should not drop NUL characters, or any other
nonprinting characters. Programs should work properly with multibyte
character encodings, such as UTF-8. You can use libiconv to deal with
a range of encodings.
</p>
-<a name="index-error-messages"></a>
+<a class="index-entry-id" id="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>strerror</code>, or equivalent) in <em>every</em> error message
+<code class="code">strerror</code>, or equivalent) in <em
class="emph">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-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 <code>NULL</code>. Check <code>realloc</code> even if you are making
the
+<a class="index-entry-id" id="index-malloc-return-value"></a>
+<a class="index-entry-id" id="index-memory-allocation-failure"></a>
+<p>Check every call to <code class="code">malloc</code> or <code
class="code">realloc</code> to see if it
+returned <code class="code">NULL</code>. Check <code
class="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.
+<code class="code">realloc</code> may get a different block if you ask for
less space.
</p>
-<p>You must expect <code>free</code> to alter the contents of the block that
was
+<p>You must expect <code class="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>.
+calling <code class="code">free</code>.
</p>
-<p>If <code>malloc</code> fails in a noninteractive program, make that a fatal
+<p>If <code class="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"></a>
-<p>Use <code>getopt_long</code> to decode arguments, unless the argument syntax
+<a class="index-entry-id"
id="index-command_002dline-arguments_002c-decoding"></a>
+<p>Use <code class="code">getopt_long</code> to decode arguments, unless the
argument syntax
makes this unreasonable.
</p>
<p>When static storage is to be written in during program execution, use
@@ -877,22 +820,22 @@
<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.
+in a directory, use <code class="code">readdir</code> or some other high-level
interface.
These are supported compatibly by GNU.
</p>
-<a name="index-signal-handling"></a>
+<a class="index-entry-id" id="index-signal-handling"></a>
<p>The preferred signal handling facilities are the BSD variant of
-<code>signal</code>, and the POSIX <code>sigaction</code> function; the
-alternative USG <code>signal</code> interface is an inferior design.
+<code class="code">signal</code>, and the POSIX <code
class="code">sigaction</code> function; the
+alternative USG <code class="code">signal</code> interface is an inferior
design.
</p>
<p>Nowadays, using the POSIX signal functions may be the easiest way
-to make a program portable. If you use <code>signal</code>, then on GNU/Linux
+to make a program portable. If you use <code class="code">signal</code>, then
on GNU/Linux
systems running GNU libc version 1, you should include
-<samp>bsd/signal.h</samp> instead of <samp>signal.h</samp>, so as to get BSD
+<samp class="file">bsd/signal.h</samp> instead of <samp
class="file">signal.h</samp>, 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.
+<code class="code">signal</code> has only the USG behavior, or give up on them.
</p>
-<a name="index-impossible-conditions"></a>
+<a class="index-entry-id" id="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
@@ -902,47 +845,47 @@
elsewhere.
</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
+<em class="emph">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"></a>
-<a name="index-TMPDIR-environment-variable"></a>
-<p>If you make temporary files, check the <code>TMPDIR</code> environment
+<a class="index-entry-id" id="index-temporary-files"></a>
+<a class="index-entry-id" id="index-TMPDIR-environment-variable"></a>
+<p>If you make temporary files, check the <code class="code">TMPDIR</code>
environment
variable; if that variable is defined, use the specified directory
-instead of <samp>/tmp</samp>.
+instead of <samp class="file">/tmp</samp>.
</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:
</p>
<div class="example">
-<pre class="example">fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600);
+<pre class="example-preformatted">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>or by using the <code class="code">mkstemps</code> function from Gnulib
+(see <a data-manual="gnulib"
href="https://www.gnu.org/software/gnulib/manual/gnulib.html#mkstemps";>mkstemps</a>
in <cite class="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
+<p>In bash, use <code class="code">set -C</code> (long name <code
class="code">noclobber</code>) to avoid this
+problem. In addition, the <code class="code">mktemp</code> utility is a more
general
solution for creating temporary files from shell scripts
-(see <a
href="http://www.gnu.org/software/coreutils/manual/coreutils#mktemp-invocation";>mktemp
invocation</a> in <cite>GNU Coreutils</cite>).
+(see <a data-manual="coreutils"
href="https://www.gnu.org/software/coreutils/manual/coreutils.html#mktemp-invocation";>mktemp
invocation</a> in <cite class="cite">GNU Coreutils</cite>).
</p>
<hr>
-<a name="Libraries"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Libraries">
+<div class="nav-panel">
<p>
-Next: <a href="#Errors" accesskey="n" rel="next">Errors</a>, Previous: <a
href="#Semantics" accesskey="p" rel="prev">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>
+Next: <a href="#Errors" accesskey="n" rel="next">Formatting Error
Messages</a>, Previous: <a href="#Semantics" accesskey="p" rel="prev">Writing
Robust Programs</a>, Up: <a href="#Program-Behavior" accesskey="u"
rel="up">Program Behavior for All Programs</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>
+<h3 class="section" id="Library-Behavior"><span>4.3 Library Behavior<a
class="copiable-link" href="#Library-Behavior"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-libraries"></a>
<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.
+that of <code class="code">malloc</code> itself.
</p>
<p>Here are certain name conventions for libraries, to avoid name
conflicts.
@@ -958,7 +901,7 @@
other; then they can both go in the same file.
</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
+should have names beginning with ‘<samp class="samp">_</samp>’.
The ‘<samp class="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.
@@ -967,27 +910,27 @@
fit any naming convention.
</p>
<hr>
-<a name="Errors"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Errors">
+<div class="nav-panel">
<p>
-Next: <a href="#User-Interfaces" accesskey="n" rel="next">User Interfaces</a>,
Previous: <a href="#Libraries" accesskey="p" rel="prev">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>
+Next: <a href="#User-Interfaces" accesskey="n" rel="next">Standards for
Interfaces Generally</a>, Previous: <a href="#Libraries" accesskey="p"
rel="prev">Library Behavior</a>, Up: <a href="#Program-Behavior" accesskey="u"
rel="up">Program Behavior for All Programs</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>
+<h3 class="section" id="Formatting-Error-Messages"><span>4.4 Formatting Error
Messages<a class="copiable-link" href="#Formatting-Error-Messages">
¶</a></span></h3>
+<a class="index-entry-id" id="index-formatting-error-messages"></a>
+<a class="index-entry-id" id="index-error-messages_002c-formatting"></a>
<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 class="example-preformatted"><var class="var">sourcefile</var>:<var
class="var">lineno</var>: <var class="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-preformatted"><var class="var">sourcefile</var>:<var
class="var">lineno</var>:<var class="var">column</var>: <var
class="var">message</var>
+<var class="var">sourcefile</var>:<var class="var">lineno</var>.<var
class="var">column</var>: <var class="var">message</var>
</pre></div>
@@ -998,7 +941,7 @@
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
-<code>wcwidth</code> functions.
+<code class="code">wcwidth</code> functions.
</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
@@ -1006,27 +949,27 @@
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 class="example-preformatted"><var class="var">sourcefile</var>:<var
class="var">line1</var>.<var class="var">column1</var>-<var
class="var">line2</var>.<var class="var">column2</var>: <var
class="var">message</var>
+<var class="var">sourcefile</var>:<var class="var">line1</var>.<var
class="var">column1</var>-<var class="var">column2</var>: <var
class="var">message</var>
+<var class="var">sourcefile</var>:<var class="var">line1</var>-<var
class="var">line2</var>: <var class="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 class="example-preformatted"><var class="var">file1</var>:<var
class="var">line1</var>.<var class="var">column1</var>-<var
class="var">file2</var>:<var class="var">line2</var>.<var
class="var">column2</var>: <var class="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 class="example-preformatted"><var class="var">program</var>:<var
class="var">sourcefile</var>:<var class="var">lineno</var>: <var
class="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 class="example-preformatted"><var class="var">program</var>: <var
class="var">message</var>
</pre></div>
<p>when there is no relevant source file.
@@ -1034,7 +977,7 @@
<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 class="example-preformatted"><var class="var">program</var>:<var
class="var">sourcefile</var>:<var class="var">lineno</var>:<var
class="var">column</var>: <var class="var">message</var>
</pre></div>
<p>In an interactive program (one that is reading commands from a
@@ -1044,7 +987,7 @@
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>
-<p>The string <var>message</var> should not begin with a capital letter when
+<p>The string <var class="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.
@@ -1054,20 +997,20 @@
end with a period.
</p>
<hr>
-<a name="User-Interfaces"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="User-Interfaces">
+<div class="nav-panel">
<p>
-Next: <a href="#Finding-Program-Files" accesskey="n" rel="next">Finding
Program Files</a>, Previous: <a href="#Errors" accesskey="p"
rel="prev">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>
+Next: <a href="#Finding-Program-Files" accesskey="n" rel="next">Finding the
Program’s Executable and Associated Files</a>, Previous: <a
href="#Errors" accesskey="p" rel="prev">Formatting Error Messages</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior for All
Programs</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>
+<h3 class="section" id="Standards-for-Interfaces-Generally"><span>4.5
Standards for Interfaces Generally<a class="copiable-link"
href="#Standards-for-Interfaces-Generally"> ¶</a></span></h3>
-<a name="index-program-name-and-its-behavior"></a>
-<a name="index-behavior_002c-dependent-on-program_0027s-name"></a>
+<a class="index-entry-id" id="index-program-name-and-its-behavior"></a>
+<a class="index-entry-id"
id="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. Thus, if you
-make <samp>foo</samp> a link to <samp>ls</samp>, the program should behave the
+make <samp class="file">foo</samp> a link to <samp class="file">ls</samp>, the
program should behave the
same regardless of which of those names is used to invoke it.
</p>
<p>Instead, use a run time option or a compilation switch or both to
@@ -1075,7 +1018,7 @@
of the program, with different default behaviors, and install them
under two different names.
</p>
-<a name="index-output-device-and-program_0027s-behavior"></a>
+<a class="index-entry-id"
id="index-output-device-and-program_0027s-behavior"></a>
<p>Likewise, please don’t make the behavior of a command-line program
depend on the type of output device it gets as standard output or
standard input. Device independence is an important principle of the
@@ -1095,50 +1038,50 @@
binary data. Sending such output to a terminal is useless and can
cause trouble. If such a program normally sends its output to stdout,
it should detect, in these cases, when the output is a terminal and
-give an error message instead. The <code>-f</code> option should override
+give an error message instead. The <code class="code">-f</code> option should
override
this exception, thus permitting the output to go to the terminal.
</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
+device. It would be disastrous if <code class="code">ls</code> or <code
class="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
+output device type. For example, we provide a <code class="code">dir</code>
program much
+like <code class="code">ls</code> except that its default output format is
always
multi-column format.
</p>
<hr>
-<a name="Finding-Program-Files"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Finding-Program-Files">
+<div class="nav-panel">
<p>
-Next: <a href="#Graphical-Interfaces" accesskey="n" rel="next">Graphical
Interfaces</a>, Previous: <a href="#User-Interfaces" accesskey="p"
rel="prev">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>
+Next: <a href="#Graphical-Interfaces" accesskey="n" rel="next">Standards for
Graphical Interfaces</a>, Previous: <a href="#User-Interfaces" accesskey="p"
rel="prev">Standards for Interfaces Generally</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior for All
Programs</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="Finding-the-Program_0027s-Executable-and-Associated-Files"></a>
-<h3 class="section">4.6 Finding the Program’s Executable and Associated
Files</h3>
+<h3 class="section"
id="Finding-the-Program_0027s-Executable-and-Associated-Files"><span>4.6
Finding the Program’s Executable and Associated Files<a
class="copiable-link"
href="#Finding-the-Program_0027s-Executable-and-Associated-Files">
¶</a></span></h3>
<p>A program may need to find the executable file it was started with, so
as to relaunch the same program. It may need to find associated
files, either source files or files constructed by building, that
it uses at run time.
</p>
-<p>The way to find them starts with looking at <code>argv[0]</code>.
+<p>The way to find them starts with looking at <code
class="code">argv[0]</code>.
</p>
<p>If that string contains a slash, it is by convention the file name of
the executable and its directory part is the directory that contained
the executable. This is the case when the program was not found
-through <code>PATH</code>, which normally means it was built but not
+through <code class="env">PATH</code>, which normally means it was built but
not
installed, and run from the build directory. The program can use the
-<code>argv[0]</code> file name to relaunch itself, and can look in its
+<code class="code">argv[0]</code> file name to relaunch itself, and can look
in its
directory part for associated files. If that file name is not
absolute, then it is relative to the working directory in which the
program started.
</p>
-<p>If <code>argv[0]</code> does not contain a slash, it is a command name whose
-executable was found via <code>PATH</code>. The program should search for
-that name in the directories in <code>PATH</code>, interpreting <samp>.</samp>
as
+<p>If <code class="code">argv[0]</code> does not contain a slash, it is a
command name whose
+executable was found via <code class="env">PATH</code>. The program should
search for
+that name in the directories in <code class="env">PATH</code>, interpreting
<samp class="file">.</samp> as
the working directory that was current when the program started.
</p>
<p>If this procedure finds the executable, we call the directory it was
-found in the <em>invocation directory</em>. The program should check
+found in the <em class="dfn">invocation directory</em>. The program should
check
for the presence in that directory of the associated files it needs.
</p>
<p>If the program’s executable is normally built in a subdirectory of the
@@ -1153,44 +1096,44 @@
</p>
<p>If this procedure doesn’t come up with an invocation directory that is
valid—normally the case for an installed program that was found via
-<code>PATH</code>—the program should look for the associated files in the
+<code class="env">PATH</code>—the program should look for the associated
files in the
directories where the program’s makefile installs them.
-See <a href="#Directory-Variables">Directory Variables</a>.
+See <a class="xref" href="#Directory-Variables">Variables for Installation
Directories</a>.
</p>
-<p>Providing valid information in <code>argv[0]</code> is a convention, not
+<p>Providing valid information in <code class="code">argv[0]</code> is a
convention, not
guaranteed. Well-behaved programs that launch other programs, such as
shells, follow the convention; your code should follow it too, when
launching other programs. But it is always possible to launch the
-program and give a nonsensical value in <code>argv[0]</code>.
+program and give a nonsensical value in <code class="code">argv[0]</code>.
</p>
<p>Therefore, any program that needs to know the location of its
executable, or that of of other associated files, should offer the
user environment variables to specify those locations explicitly.
</p>
-<p><strong>Don’t give special privilege, such as with the
<code>setuid</code>
+<p><strong class="strong">Don’t give special privilege, such as with the
<code class="code">setuid</code>
bit, to programs that will search heuristically for associated files
or for their own executables when invoked that way.</strong> Limit that
privilege to programs that find associated files in hard-coded
-installed locations such as under <samp>/usr</samp> and <samp>/etc</samp>.
+installed locations such as under <samp class="file">/usr</samp> and <samp
class="file">/etc</samp>.
</p>
-<p>See <a
href="http://www.gnu.org/software/bash/manual/bash.html#Bourne-Shell-Variables";>Bourne
Shell Variables</a> in <cite>Bash Reference Manual</cite>,
-for more information about <code>PATH</code>.
+<p>See <a data-manual="bash"
href="https://www.gnu.org/software/bash/manual/bash.html#Bourne-Shell-Variables";>Bourne
Shell Variables</a> in <cite class="cite">Bash Reference Manual</cite>,
+for more information about <code class="env">PATH</code>.
</p>
<hr>
-<a name="Graphical-Interfaces"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Graphical-Interfaces">
+<div class="nav-panel">
<p>
-Next: <a href="#Command_002dLine-Interfaces" accesskey="n"
rel="next">Command-Line Interfaces</a>, Previous: <a
href="#Finding-Program-Files" accesskey="p" rel="prev">Finding Program
Files</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>
+Next: <a href="#Command_002dLine-Interfaces" accesskey="n"
rel="next">Standards for Command Line Interfaces</a>, Previous: <a
href="#Finding-Program-Files" accesskey="p" rel="prev">Finding the
Program’s Executable and Associated Files</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior for All
Programs</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.7 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>
+<h3 class="section" id="Standards-for-Graphical-Interfaces"><span>4.7
Standards for Graphical Interfaces<a class="copiable-link"
href="#Standards-for-Graphical-Interfaces"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-graphical-user-interface"></a>
+<a class="index-entry-id" id="index-interface-styles"></a>
+<a class="index-entry-id" id="index-user-interface-styles"></a>
-<a name="index-GTK_002b"></a>
-<a name="index-GNUstep"></a>
+<a class="index-entry-id" id="index-GTK_002b"></a>
+<a class="index-entry-id" id="index-GNUstep"></a>
<p>When you write a program that provides a graphical user interface,
please make it work with the X Window System, using the GTK+ toolkit
or the GNUstep toolkit, unless the functionality specifically requires
@@ -1202,11 +1145,11 @@
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"></a>
-<a name="index-GNOME"></a>
-<a name="index-D_002dbus"></a>
-<a name="index-keyboard-interface"></a>
-<a name="index-library-interface"></a>
+<a class="index-entry-id" id="index-CORBA"></a>
+<a class="index-entry-id" id="index-GNOME"></a>
+<a class="index-entry-id" id="index-D_002dbus"></a>
+<a class="index-entry-id" id="index-keyboard-interface"></a>
+<a class="index-entry-id" id="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
@@ -1217,109 +1160,106 @@
</p>
<p>Please make your program interoperate with access technology such as
screen readers (see
-<a
href="https://www.gnu.org/accessibility/accessibility.html";>https://www.gnu.org/accessibility/accessibility.html</a>).
This should
+<a class="url"
href="https://www.gnu.org/accessibility/accessibility.html";>https://www.gnu.org/accessibility/accessibility.html</a>).
This should
be automatic if you use GTK+.
</p>
<hr>
-<a name="Command_002dLine-Interfaces"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Command_002dLine-Interfaces">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="#Dynamic-Plug_002dIn-Interfaces" accesskey="n"
rel="next">Standards for Dynamic Plug-in Interfaces</a>, Previous: <a
href="#Graphical-Interfaces" accesskey="p" rel="prev">Standards for Graphical
Interfaces</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior for All Programs</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.8 Standards for Command Line Interfaces</h3>
-<a name="index-command_002dline-interface"></a>
+<h3 class="section" id="Standards-for-Command-Line-Interfaces"><span>4.8
Standards for Command Line Interfaces<a class="copiable-link"
href="#Standards-for-Command-Line-Interfaces"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-command_002dline-interface"></a>
-<a name="index-getopt"></a>
+<a class="index-entry-id" id="index-getopt"></a>
<p>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
-<code>getopt</code> to parse them. Note that the GNU version of
<code>getopt</code>
+<code class="code">getopt</code> to parse them. Note that the GNU version of
<code class="code">getopt</code>
will normally permit options anywhere among the arguments unless the
-special argument ‘<samp>--</samp>’ is used. This is not what POSIX
+special argument ‘<samp class="samp">--</samp>’ is used. This is
not what POSIX
specifies; it is a GNU extension.
</p>
-<a name="index-long_002dnamed-options"></a>
+<a class="index-entry-id" id="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>.
+<code class="code">getopt_long</code>.
</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>--verbose</samp>’. To achieve this
uniformity, look at
+spelled precisely ‘<samp class="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>).
+for your program (see <a class="pxref" href="#Option-Table">Table of Long
Options</a>).
</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>-o</samp>’ or
‘<samp>--output</samp>’). Even if you allow an output
+(preferably ‘<samp class="samp">-o</samp>’ or ‘<samp
class="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"></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 ‘<code>http://example.org/p.cgi/--help</code>’ in a
browser should
-output the same information as invoking ‘<samp>p.cgi
--help</samp>’ from the
+<a class="index-entry-id" id="index-standard-command_002dline-options"></a>
+<a class="index-entry-id"
id="index-options_002c-standard-command_002dline"></a>
+<a class="index-entry-id"
id="index-CGI-programs_002c-standard-options-for"></a>
+<a class="index-entry-id"
id="index-PATH_005fINFO_002c-specifying-standard-options-as"></a>
+<p>All programs should support two standard options: ‘<samp
class="samp">--version</samp>’
+and ‘<samp class="samp">--help</samp>’. CGI programs should
accept these as command-line
+options, and also if given as the <code class="env">PATH_INFO</code>; for
instance,
+visiting ‘<code
class="indicateurl">http://example.org/p.cgi/--help</code>’ in a browser
should
+output the same information as invoking ‘<samp class="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="mini-toc">
+<li><a href="#g_t_002d_002dversion" accesskey="1"><samp
class="option">--version</samp></a></li>
+<li><a href="#g_t_002d_002dhelp" accesskey="2"><samp
class="option">--help</samp></a></li>
+</ul>
<hr>
-<a name="g_t_002d_002dversion"></a>
-<div class="header">
+<div class="subsection-level-extent" id="g_t_002d_002dversion">
+<div class="nav-panel">
<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>
+Next: <a href="#g_t_002d_002dhelp" accesskey="n" rel="next"><samp
class="option">--help</samp></a>, Up: <a href="#Command_002dLine-Interfaces"
accesskey="u" rel="up">Standards for 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.8.1 <samp>--version</samp></h4>
+<h4 class="subsection" id="g_t_002d_002dversion-1"><span>4.8.1 <samp
class="option">--version</samp><a class="copiable-link"
href="#g_t_002d_002dversion-1"> ¶</a></span></h4>
-<a name="index-_002d_002dversion-output"></a>
+<a class="index-entry-id" id="index-_002d_002dversion-output"></a>
-<p>The standard <code>--version</code> option should direct the program to
+<p>The standard <code class="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"></a>
-<a name="index-program_0027s-canonical-name"></a>
+<a class="index-entry-id" id="index-canonical-name-of-a-program"></a>
+<a class="index-entry-id" id="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 class="example-preformatted">GNU Emacs 19.30
</pre></div>
-<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
+<p>The program’s name should be a constant string; <em
class="emph">don’t</em> compute it
+from <code class="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>.
+out the precise file name where a command is found in <code
class="code">PATH</code>.
</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 class="example-preformatted">emacsserver (GNU Emacs) 19.30
</pre></div>
<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>
-<p>If you <em>need</em> to mention the version numbers of libraries which
+<p>If you <em class="emph">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
@@ -1335,7 +1275,7 @@
each on a separate line.
</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
+the 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.
@@ -1345,8 +1285,8 @@
</p>
<p>Here’s an example of output that follows these rules:
</p>
-<div class="smallexample">
-<pre class="smallexample">GNU hello 2.3
+<div class="example smallexample">
+<pre class="example-preformatted">GNU hello 2.3
Copyright (C) 2007 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later
<https://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
@@ -1362,11 +1302,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;
-see <a
href="http://www.gnu.org/prep/maintain/maintain.html#Copyright-Notices";>Copyright
Notices</a> in <cite>Information for GNU Maintainers</cite>.)
+see <a data-manual="maintain"
href="https://www.gnu.org/prep/maintain/maintain.html#Copyright-Notices";>Copyright
Notices</a> in <cite class="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 notices (see <a class="pxref"
href="#Internationalization">Internationalization</a>). If the
translation’s
+character set supports it, the ‘<samp class="samp">(C)</samp>’
should be replaced with the
copyright symbol, as follows:
</p>
<p>©
@@ -1377,22 +1317,22 @@
have legal significance.
</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. In the case of a GNU license, <em>always</em> indicate the permitted
+Any abbreviation can be followed by ‘<samp class="samp">v<var
class="var">version</var>[+]</samp>’, meaning
+that particular version, or later versions with the ‘<samp
class="samp">+</samp>’, as shown
+above. In the case of a GNU license, <em class="emph">always</em> indicate
the permitted
versions in this way.
</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
+‘<samp class="samp">/</samp>’ for a separator; the version number
can follow the license
abbreviation as usual, as in the examples below.
</p>
-<dl compact="compact">
+<dl class="table">
<dt>GPL</dt>
-<dd><p>GNU General Public License, <a
href="https://www.gnu.org/licenses/gpl.html";>https://www.gnu.org/licenses/gpl.html</a>.
+<dd><p>GNU General Public License, <a class="url"
href="https://www.gnu.org/licenses/gpl.html";>https://www.gnu.org/licenses/gpl.html</a>.
</p>
</dd>
<dt>LGPL</dt>
-<dd><p>GNU Lesser General Public License, <a
href="https://www.gnu.org/licenses/lgpl.html";>https://www.gnu.org/licenses/lgpl.html</a>.
+<dd><p>GNU Lesser General Public License, <a class="url"
href="https://www.gnu.org/licenses/lgpl.html";>https://www.gnu.org/licenses/lgpl.html</a>.
</p>
</dd>
<dt>GPL/Ada</dt>
@@ -1401,88 +1341,88 @@
</dd>
<dt>Apache</dt>
<dd><p>The Apache Software Foundation license,
-<a
href="https://directory.fsf.org/wiki/License:Apache2.0";>https://directory.fsf.org/wiki/License:Apache2.0</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:Apache2.0";>https://directory.fsf.org/wiki/License:Apache2.0</a>.
</p>
</dd>
<dt>Artistic</dt>
<dd><p>The Artistic license used for Perl,
-<a
href="https://directory.fsf.org/wiki/License:ArtisticLicense2.0";>https://directory.fsf.org/wiki/License:ArtisticLicense2.0</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:ArtisticLicense2.0";>https://directory.fsf.org/wiki/License:ArtisticLicense2.0</a>.
</p>
</dd>
<dt>Expat</dt>
-<dd><p>The Expat license, <a
href="https://directory.fsf.org/wiki/License:Expat";>https://directory.fsf.org/wiki/License:Expat</a>.
+<dd><p>The Expat license, <a class="url"
href="https://directory.fsf.org/wiki/License:Expat";>https://directory.fsf.org/wiki/License:Expat</a>.
</p>
</dd>
<dt>MPL</dt>
-<dd><p>The Mozilla Public License, <a
href="https://directory.fsf.org/wiki/License:MPLv2.0";>https://directory.fsf.org/wiki/License:MPLv2.0</a>.
+<dd><p>The Mozilla Public License, <a class="url"
href="https://directory.fsf.org/wiki/License:MPLv2.0";>https://directory.fsf.org/wiki/License:MPLv2.0</a>.
</p>
</dd>
<dt>OBSD</dt>
<dd><p>The original (4-clause) BSD license, incompatible with the GNU GPL,<br>
-<a
href="https://directory.fsf.org/wiki/License:BSD_4Clause";>https://directory.fsf.org/wiki/License:BSD_4Clause</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:BSD_4Clause";>https://directory.fsf.org/wiki/License:BSD_4Clause</a>.
</p>
</dd>
<dt>PHP</dt>
-<dd><p>The license used for PHP, <a
href="https://directory.fsf.org/wiki/License:PHPv3.01";>https://directory.fsf.org/wiki/License:PHPv3.01</a>.
+<dd><p>The license used for PHP, <a class="url"
href="https://directory.fsf.org/wiki/License:PHPv3.01";>https://directory.fsf.org/wiki/License:PHPv3.01</a>.
</p>
</dd>
<dt>public domain</dt>
<dd><p>The non-license that is being in the public domain,<br>
-<a
href="https://www.gnu.org/licenses/license-list.html#PublicDomain";>https://www.gnu.org/licenses/license-list.html#PublicDomain</a>.
+<a class="url"
href="https://www.gnu.org/licenses/license-list.html#PublicDomain";>https://www.gnu.org/licenses/license-list.html#PublicDomain</a>.
</p>
</dd>
<dt>Python</dt>
<dd><p>The license for Python,
-<a
href="https://directory.fsf.org/wiki/License:Python2.0.1";>https://directory.fsf.org/wiki/License:Python2.0.1</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:Python2.0.1";>https://directory.fsf.org/wiki/License:Python2.0.1</a>.
</p>
</dd>
<dt>RBSD</dt>
<dd><p>The revised (3-clause) BSD, compatible with the GNU GPL,<br>
-<a
href="https://directory.fsf.org/wiki/License:BSD_3Clause";>https://directory.fsf.org/wiki/License:BSD_3Clause</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:BSD_3Clause";>https://directory.fsf.org/wiki/License:BSD_3Clause</a>.
</p>
</dd>
<dt>X11</dt>
<dd><p>The simple non-copyleft license used for most versions of the X Window
-System, <a
href="https://directory.fsf.org/wiki/License:X11";>https://directory.fsf.org/wiki/License:X11</a>.
+System, <a class="url"
href="https://directory.fsf.org/wiki/License:X11";>https://directory.fsf.org/wiki/License:X11</a>.
</p>
</dd>
<dt>Zlib</dt>
-<dd><p>The license for Zlib, <a
href="https://directory.fsf.org/wiki/License:Zlib";>https://directory.fsf.org/wiki/License:Zlib</a>.
+<dd><p>The license for Zlib, <a class="url"
href="https://directory.fsf.org/wiki/License:Zlib";>https://directory.fsf.org/wiki/License:Zlib</a>.
</p>
</dd>
</dl>
<p>More information about these licenses and many more are on the GNU
licensing web pages,
-<a
href="https://www.gnu.org/licenses/license-list.html";>https://www.gnu.org/licenses/license-list.html</a>.
+<a class="url"
href="https://www.gnu.org/licenses/license-list.html";>https://www.gnu.org/licenses/license-list.html</a>.
</p>
<hr>
-<a name="g_t_002d_002dhelp"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="g_t_002d_002dhelp">
+<div class="nav-panel">
<p>
-Previous: <a href="#g_t_002d_002dversion" accesskey="p"
rel="prev">--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>
+Previous: <a href="#g_t_002d_002dversion" accesskey="p" rel="prev"><samp
class="option">--version</samp></a>, Up: <a href="#Command_002dLine-Interfaces"
accesskey="u" rel="up">Standards for 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.8.2 <samp>--help</samp></h4>
+<h4 class="subsection" id="g_t_002d_002dhelp-1"><span>4.8.2 <samp
class="option">--help</samp><a class="copiable-link"
href="#g_t_002d_002dhelp-1"> ¶</a></span></h4>
-<a name="index-_002d_002dhelp-output"></a>
+<a class="index-entry-id" id="index-_002d_002dhelp-output"></a>
-<p>The standard <code>--help</code> option should output brief documentation
+<p>The standard <code class="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"></a>
-<a name="index-bug-reports"></a>
-<p>Near the end of the ‘<samp>--help</samp>’ option’s
output, please place lines
+<a class="index-entry-id" id="index-address-for-bug-reports"></a>
+<a class="index-entry-id" id="index-bug-reports"></a>
+<p>Near the end of the ‘<samp class="samp">--help</samp>’
option’s output, please place lines
giving the email address for bug reports, the package’s home page
-(normally
‘<code>https://www.gnu.org/software/<var>pkg</var></code>’), and the
+(normally ‘<code class="indicateurl">https://www.gnu.org/software/<var
class="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: <https://www.gnu.org/software/<var>pkg</var>/>
+<pre class="example-preformatted">Report bugs to: <var
class="var">mailing-address</var>
+<var class="var">pkg</var> home page: <https://www.gnu.org/software/<var
class="var">pkg</var>/>
General help using GNU software: <https://www.gnu.org/gethelp/>
</pre></div>
@@ -1490,15 +1430,16 @@
</p>
<hr>
-<a name="Dynamic-Plug_002dIn-Interfaces"></a>
-<div class="header">
+</div>
+</div>
+<div class="section-level-extent" id="Dynamic-Plug_002dIn-Interfaces">
+<div class="nav-panel">
<p>
-Next: <a href="#Option-Table" accesskey="n" rel="next">Option Table</a>,
Previous: <a href="#Command_002dLine-Interfaces" accesskey="p"
rel="prev">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>
+Next: <a href="#Option-Table" accesskey="n" rel="next">Table of Long
Options</a>, Previous: <a href="#Command_002dLine-Interfaces" accesskey="p"
rel="prev">Standards for Command Line Interfaces</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior for All
Programs</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.9 Standards for Dynamic Plug-in Interfaces</h3>
-<a name="index-plug_002dins"></a>
-<a name="index-dynamic-plug_002dins"></a>
+<h3 class="section"
id="Standards-for-Dynamic-Plug_002din-Interfaces"><span>4.9 Standards for
Dynamic Plug-in Interfaces<a class="copiable-link"
href="#Standards-for-Dynamic-Plug_002din-Interfaces"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-plug_002dins"></a>
+<a class="index-entry-id" id="index-dynamic-plug_002dins"></a>
<p>Another aspect of keeping free programs free is encouraging
development of free plug-ins, and discouraging development of
@@ -1512,13 +1453,13 @@
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"></a>
+<a class="index-entry-id" id="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="http://gcc.gnu.org/onlinedocs/gccint/Plugins.html#Plugins";>Plugins</a> in
<cite>GCC Internals</cite>).
+<code class="code">plugin_is_GPL_compatible</code>, thus asserting that the
plug-in is
+released under a GPL-compatible license (see <a data-manual="gccint"
href="https://gcc.gnu.org/onlinedocs/gccint/Plugins.html#Plugins";>Plugins</a>
in <cite class="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,
@@ -1533,1505 +1474,1505 @@
</p>
<hr>
-<a name="Option-Table"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Option-Table">
+<div class="nav-panel">
<p>
-Next: <a href="#OID-Allocations" accesskey="n" rel="next">OID Allocations</a>,
Previous: <a href="#Dynamic-Plug_002dIn-Interfaces" accesskey="p"
rel="prev">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>
+Next: <a href="#OID-Allocations" accesskey="n" rel="next">OID Allocations</a>,
Previous: <a href="#Dynamic-Plug_002dIn-Interfaces" accesskey="p"
rel="prev">Standards for Dynamic Plug-in Interfaces</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior for All
Programs</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.10 Table of Long Options</h3>
-<a name="index-long-option-names"></a>
-<a name="index-table-of-long-options"></a>
+<h3 class="section" id="Table-of-Long-Options"><span>4.10 Table of Long
Options<a class="copiable-link" href="#Table-of-Long-Options">
¶</a></span></h3>
+<a class="index-entry-id" id="index-long-option-names"></a>
+<a class="index-entry-id" id="index-table-of-long-options"></a>
<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:bug-standards@gnu.org";>bug-standards@gnu.org</a> a
list of them, with their
+please send <a class="email"
href="mailto:bug-standards@gnu.org";>bug-standards@gnu.org</a> a list of them,
with their
meanings, so we can update the table.
</p>
-<dl compact="compact">
-<dt>‘<samp>after-date</samp>’</dt>
-<dd><p>‘<samp>-N</samp>’ in <code>tar</code>.
+<dl class="table">
+<dt>‘<samp class="samp">after-date</samp>’</dt>
+<dd><p>‘<samp class="samp">-N</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">all</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">du</code>, <code class="code">ls</code>, <code
class="code">nm</code>, <code class="code">stty</code>, <code
class="code">uname</code>,
+and <code class="code">unexpand</code>.
</p>
</dd>
-<dt>‘<samp>all-text</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">all-text</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>almost-all</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">almost-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">append</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">etags</code>, <code class="code">tee</code>, <code
class="code">time</code>;
+‘<samp class="samp">-r</samp>’ in <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>archive</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>cp</code>.
+<dt>‘<samp class="samp">archive</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">cp</code>.
</p>
</dd>
-<dt>‘<samp>archive-name</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">archive-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>arglength</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">arglength</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>ascii</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ascii</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>assign</samp>’</dt>
-<dd><p>‘<samp>-v</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">assign</samp>’</dt>
+<dd><p>‘<samp class="samp">-v</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>assume-new</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">assume-new</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>assume-old</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">assume-old</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>auto-check</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">auto-check</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>auto-pager</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">auto-pager</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>auto-reference</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">auto-reference</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>avoid-wraps</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">avoid-wraps</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>background</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">backward-search</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>basename</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">basename</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>batch</samp>’</dt>
+<dt>‘<samp class="samp">batch</samp>’</dt>
<dd><p>Used in GDB.
</p>
</dd>
-<dt>‘<samp>baud</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">before</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">tac</code>.
</p>
</dd>
-<dt>‘<samp>binary</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>cpio</code> and
<code>diff</code>.
+<dt>‘<samp class="samp">binary</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">cpio</code> and <code class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>bits-per-code</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">bits-per-code</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>block-size</samp>’</dt>
-<dd><p>Used in <code>cpio</code> and <code>tar</code>.
+<dt>‘<samp class="samp">block-size</samp>’</dt>
+<dd><p>Used in <code class="code">cpio</code> and <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>blocks</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>head</code> and
<code>tail</code>.
+<dt>‘<samp class="samp">blocks</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">head</code> and <code class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>break-file</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">break-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>brief</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">bytes</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">head</code>, <code class="code">split</code>, and <code
class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>c<tt>++</tt></samp>’</dt>
-<dd><p>‘<samp>-C</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">c<code class="t">++</code></samp>’</dt>
+<dd><p>‘<samp class="samp">-C</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>catenate</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">catenate</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>cd</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">changes</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">chgrp</code> and <code class="code">chown</code>.
</p>
</dd>
-<dt>‘<samp>classify</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">classify</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>colons</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">colons</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>command</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>su</code>;
-‘<samp>-x</samp>’ in GDB.
+<dt>‘<samp class="samp">command</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">su</code>;
+‘<samp class="samp">-x</samp>’ in GDB.
</p>
</dd>
-<dt>‘<samp>compare</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">compare</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>compat</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">compat</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>compress</samp>’</dt>
-<dd><p>‘<samp>-Z</samp>’ in <code>tar</code> and <code>shar</code>.
+<dt>‘<samp class="samp">compress</samp>’</dt>
+<dd><p>‘<samp class="samp">-Z</samp>’ in <code
class="code">tar</code> and <code class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>concatenate</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">concatenate</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>confirmation</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">confirmation</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>context</samp>’</dt>
-<dd><p>Used in <code>diff</code>.
+<dt>‘<samp class="samp">context</samp>’</dt>
+<dd><p>Used in <code class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>copyleft</samp>’</dt>
-<dd><p>‘<samp>-W copyleft</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">copyleft</samp>’</dt>
+<dd><p>‘<samp class="samp">-W copyleft</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">copyright</samp>’</dt>
+<dd><p>‘<samp class="samp">-C</samp>’ in <code
class="code">ptx</code>, <code class="code">recode</code>, and <code
class="code">wdiff</code>;
+‘<samp class="samp">-W copyright</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>core</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">count</samp>’</dt>
+<dd><p>‘<samp class="samp">-q</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>count-links</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">count-links</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>create</samp>’</dt>
-<dd><p>Used in <code>tar</code> and <code>cpio</code>.
+<dt>‘<samp class="samp">create</samp>’</dt>
+<dd><p>Used in <code class="code">tar</code> and <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>cut-mark</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">cut-mark</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>cxref</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>ctags</code>.
+<dt>‘<samp class="samp">cxref</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>date</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>touch</code>.
+<dt>‘<samp class="samp">date</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="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.
+<dt>‘<samp class="samp">debug</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">make</code> and <code class="code">m4</code>;
+‘<samp class="samp">-t</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>define</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">define</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>defines</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in Bison and <code>ctags</code>.
+<dt>‘<samp class="samp">defines</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in Bison and <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>delete</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">delete</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">dereference</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">chgrp</code>, <code class="code">chown</code>, <code
class="code">cpio</code>, <code class="code">du</code>,
+<code class="code">ls</code>, and <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>dereference-args</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">dereference-args</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>device</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">diacritics</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>dictionary-order</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>look</code>.
+<dt>‘<samp class="samp">dictionary-order</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">look</code>.
</p>
</dd>
-<dt>‘<samp>diff</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">diff</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>digits</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">digits</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="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
+<dt>‘<samp class="samp">directory</samp>’</dt>
+<dd><p>Specify the directory to use, in various programs. In <code
class="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
+<code class="code">rm</code> and <code class="code">ln</code>, it means to not
treat links to directories
specially.
</p>
</dd>
-<dt>‘<samp>discard-all</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">discard-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>discard-locals</samp>’</dt>
-<dd><p>‘<samp>-X</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">discard-locals</samp>’</dt>
+<dd><p>‘<samp class="samp">-X</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>dry-run</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">dry-run</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>ed</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ed</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>elide-empty-files</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">elide-empty-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>end-delete</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">end-delete</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>end-insert</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">end-insert</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>entire-new-file</samp>’</dt>
-<dd><p>‘<samp>-N</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">entire-new-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-N</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>environment-overrides</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">environment-overrides</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>eof</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">eof</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>epoch</samp>’</dt>
+<dt>‘<samp class="samp">epoch</samp>’</dt>
<dd><p>Used in GDB.
</p>
</dd>
-<dt>‘<samp>error-limit</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">error-limit</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>error-output</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">error-output</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>escape</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">escape</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>exclude-from</samp>’</dt>
-<dd><p>‘<samp>-X</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">exclude-from</samp>’</dt>
+<dd><p>‘<samp class="samp">-X</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>exec</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">exit</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>exit-0</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>unshar</code>.
+<dt>‘<samp class="samp">exit-0</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">unshar</code>.
</p>
</dd>
-<dt>‘<samp>expand-tabs</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">expand-tabs</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>expression</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>sed</code>.
+<dt>‘<samp class="samp">expression</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">sed</code>.
</p>
</dd>
-<dt>‘<samp>extern-only</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">extern-only</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">extract</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">cpio</code>;
+‘<samp class="samp">-x</samp>’ in <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>faces</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>finger</code>.
+<dt>‘<samp class="samp">faces</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">finger</code>.
</p>
</dd>
-<dt>‘<samp>fast</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>su</code>.
+<dt>‘<samp class="samp">fast</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>fatal-warnings</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">fatal-warnings</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">file</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">gawk</code>, <code class="code">info</code>, <code
class="code">make</code>, <code class="code">mt</code>,
+<code class="code">sed</code>, and <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>field-separator</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">field-separator</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>file-prefix</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in Bison.
+<dt>‘<samp class="samp">file-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>file-type</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">file-type</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>files-from</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">files-from</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>fill-column</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">fill-column</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>flag-truncation</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">flag-truncation</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>fixed-output-files</samp>’</dt>
-<dd><p>‘<samp>-y</samp>’ in Bison.
+<dt>‘<samp class="samp">fixed-output-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-y</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>follow</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>tail</code>.
+<dt>‘<samp class="samp">follow</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>footnote-style</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">footnote-style</samp>’</dt>
+<dd><p>Used in <code class="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>.
+<dt>‘<samp class="samp">force</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>, and <code class="code">rm</code>.
</p>
</dd>
-<dt>‘<samp>force-prefix</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">force-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>foreground</samp>’</dt>
+<dt>‘<samp class="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.
</p>
</dd>
-<dt>‘<samp>format</samp>’</dt>
-<dd><p>Used in <code>ls</code>, <code>time</code>, and <code>ptx</code>.
+<dt>‘<samp class="samp">format</samp>’</dt>
+<dd><p>Used in <code class="code">ls</code>, <code class="code">time</code>,
and <code class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>freeze-state</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">freeze-state</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>fullname</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">gap-size</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>get</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">get</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>graphic</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>ul</code>.
+<dt>‘<samp class="samp">graphic</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">ul</code>.
</p>
</dd>
-<dt>‘<samp>graphics</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">graphics</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>group</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>install</code>.
+<dt>‘<samp class="samp">group</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">install</code>.
</p>
</dd>
-<dt>‘<samp>gzip</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>tar</code> and <code>shar</code>.
+<dt>‘<samp class="samp">gzip</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">tar</code> and <code class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>hashsize</samp>’</dt>
-<dd><p>‘<samp>-H</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">hashsize</samp>’</dt>
+<dd><p>‘<samp class="samp">-H</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>header</samp>’</dt>
-<dd><p>‘<samp>-h</samp>’ in <code>objdump</code> and
<code>recode</code>
+<dt>‘<samp class="samp">header</samp>’</dt>
+<dd><p>‘<samp class="samp">-h</samp>’ in <code
class="code">objdump</code> and <code class="code">recode</code>
</p>
</dd>
-<dt>‘<samp>heading</samp>’</dt>
-<dd><p>‘<samp>-H</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">heading</samp>’</dt>
+<dd><p>‘<samp class="samp">-H</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>help</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">here-delimiter</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>hide-control-chars</samp>’</dt>
-<dd><p>‘<samp>-q</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">hide-control-chars</samp>’</dt>
+<dd><p>‘<samp class="samp">-q</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>html</samp>’</dt>
-<dd><p>In <code>makeinfo</code>, output HTML.
+<dt>‘<samp class="samp">html</samp>’</dt>
+<dd><p>In <code class="code">makeinfo</code>, output HTML.
</p>
</dd>
-<dt>‘<samp>idle</samp>’</dt>
-<dd><p>‘<samp>-u</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">idle</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>ifdef</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ifdef</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">ignore</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">ls</code>;
+‘<samp class="samp">-x</samp>’ in <code class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>ignore-all-space</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-all-space</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-backups</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">ignore-backups</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>ignore-blank-lines</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-blank-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">ignore-case</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">look</code> and <code class="code">ptx</code>;
+‘<samp class="samp">-i</samp>’ in <code class="code">diff</code>
and <code class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-errors</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">ignore-errors</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>ignore-file</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">ignore-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>ignore-indentation</samp>’</dt>
-<dd><p>‘<samp>-I</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">ignore-indentation</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>ignore-init-file</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in Oleo.
+<dt>‘<samp class="samp">ignore-init-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in Oleo.
</p>
</dd>
-<dt>‘<samp>ignore-interrupts</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>tee</code>.
+<dt>‘<samp class="samp">ignore-interrupts</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">tee</code>.
</p>
</dd>
-<dt>‘<samp>ignore-matching-lines</samp>’</dt>
-<dd><p>‘<samp>-I</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-matching-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-space-change</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-space-change</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-zeros</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">ignore-zeros</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">include</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">etags</code>;
+‘<samp class="samp">-I</samp>’ in <code class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>include-dir</samp>’</dt>
-<dd><p>‘<samp>-I</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">include-dir</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>incremental</samp>’</dt>
-<dd><p>‘<samp>-G</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">incremental</samp>’</dt>
+<dd><p>‘<samp class="samp">-G</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>info</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’, ‘<samp>-l</samp>’, and
‘<samp>-m</samp>’ in Finger.
+<dt>‘<samp class="samp">info</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’, ‘<samp
class="samp">-l</samp>’, and ‘<samp class="samp">-m</samp>’
in Finger.
</p>
</dd>
-<dt>‘<samp>init-file</samp>’</dt>
+<dt>‘<samp class="samp">init-file</samp>’</dt>
<dd><p>In some programs, specify the name of the file to read as the
user’s
init file.
</p>
</dd>
-<dt>‘<samp>initial</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>expand</code>.
+<dt>‘<samp class="samp">initial</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">expand</code>.
</p>
</dd>
-<dt>‘<samp>initial-tab</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">initial-tab</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>inode</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">inode</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">interactive</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>, <code class="code">rm</code>;
+‘<samp class="samp">-e</samp>’ in <code class="code">m4</code>;
+‘<samp class="samp">-p</samp>’ in <code class="code">xargs</code>;
+‘<samp class="samp">-w</samp>’ in <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>intermix-type</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">intermix-type</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>iso-8601</samp>’</dt>
-<dd><p>Used in <code>date</code>
+<dt>‘<samp class="samp">iso-8601</samp>’</dt>
+<dd><p>Used in <code class="code">date</code>
</p>
</dd>
-<dt>‘<samp>jobs</samp>’</dt>
-<dd><p>‘<samp>-j</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">jobs</samp>’</dt>
+<dd><p>‘<samp class="samp">-j</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>just-print</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">just-print</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>keep-going</samp>’</dt>
-<dd><p>‘<samp>-k</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">keep-going</samp>’</dt>
+<dd><p>‘<samp class="samp">-k</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>keep-files</samp>’</dt>
-<dd><p>‘<samp>-k</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">keep-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-k</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>kilobytes</samp>’</dt>
-<dd><p>‘<samp>-k</samp>’ in <code>du</code> and <code>ls</code>.
+<dt>‘<samp class="samp">kilobytes</samp>’</dt>
+<dd><p>‘<samp class="samp">-k</samp>’ in <code
class="code">du</code> and <code class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>language</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">language</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>less-mode</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">less-mode</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>level-for-gzip</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">level-for-gzip</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>line-bytes</samp>’</dt>
-<dd><p>‘<samp>-C</samp>’ in <code>split</code>.
+<dt>‘<samp class="samp">line-bytes</samp>’</dt>
+<dd><p>‘<samp class="samp">-C</samp>’ in <code
class="code">split</code>.
</p>
</dd>
-<dt>‘<samp>lines</samp>’</dt>
-<dd><p>Used in <code>split</code>, <code>head</code>, and <code>tail</code>.
+<dt>‘<samp class="samp">lines</samp>’</dt>
+<dd><p>Used in <code class="code">split</code>, <code
class="code">head</code>, and <code class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>link</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">link</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>lint</samp>’</dt>
-<dt>‘<samp>lint-old</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">lint</samp>’</dt>
+<dt>‘<samp class="samp">lint-old</samp>’</dt>
+<dd><p>Used in <code class="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>.
+<dt>‘<samp class="samp">list</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">cpio</code>;
+‘<samp class="samp">-l</samp>’ in <code class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>list</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">list</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>literal</samp>’</dt>
-<dd><p>‘<samp>-N</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">literal</samp>’</dt>
+<dd><p>‘<samp class="samp">-N</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>load-average</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">load-average</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>login</samp>’</dt>
-<dd><p>Used in <code>su</code>.
+<dt>‘<samp class="samp">login</samp>’</dt>
+<dd><p>Used in <code class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>machine</samp>’</dt>
-<dd><p>Used in <code>uname</code>.
+<dt>‘<samp class="samp">machine</samp>’</dt>
+<dd><p>Used in <code class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>macro-name</samp>’</dt>
-<dd><p>‘<samp>-M</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">macro-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-M</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>mail</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>hello</code> and
<code>uname</code>.
+<dt>‘<samp class="samp">mail</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">hello</code> and <code class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>make-directories</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">make-directories</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>makefile</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">makefile</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>mapped</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">max-args</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>max-chars</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">max-chars</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>max-lines</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">max-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>max-load</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">max-load</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>max-procs</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">max-procs</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>mesg</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">mesg</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>message</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">message</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>minimal</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">minimal</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>mixed-uuencode</samp>’</dt>
-<dd><p>‘<samp>-M</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">mixed-uuencode</samp>’</dt>
+<dd><p>‘<samp class="samp">-M</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">mode</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">install</code>, <code class="code">mkdir</code>, and <code
class="code">mkfifo</code>.
</p>
</dd>
-<dt>‘<samp>modification-time</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">modification-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>multi-volume</samp>’</dt>
-<dd><p>‘<samp>-M</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">multi-volume</samp>’</dt>
+<dd><p>‘<samp class="samp">-M</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>name-prefix</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in Bison.
+<dt>‘<samp class="samp">name-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>nesting-limit</samp>’</dt>
-<dd><p>‘<samp>-L</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">nesting-limit</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>net-headers</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">net-headers</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>new-file</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">new-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>no-builtin-rules</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">no-builtin-rules</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>no-character-count</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-character-count</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-check-existing</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-check-existing</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-common</samp>’</dt>
-<dd><p>‘<samp>-3</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">no-common</samp>’</dt>
+<dd><p>‘<samp class="samp">-3</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>no-create</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>touch</code>.
+<dt>‘<samp class="samp">no-create</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">touch</code>.
</p>
</dd>
-<dt>‘<samp>no-defines</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">no-defines</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>no-deleted</samp>’</dt>
-<dd><p>‘<samp>-1</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">no-deleted</samp>’</dt>
+<dd><p>‘<samp class="samp">-1</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>no-dereference</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>cp</code>.
+<dt>‘<samp class="samp">no-dereference</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">cp</code>.
</p>
</dd>
-<dt>‘<samp>no-inserted</samp>’</dt>
-<dd><p>‘<samp>-2</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">no-inserted</samp>’</dt>
+<dd><p>‘<samp class="samp">-2</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>no-keep-going</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">no-keep-going</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>no-lines</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in Bison.
+<dt>‘<samp class="samp">no-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>no-piping</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-piping</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-prof</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">no-prof</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>no-regex</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">no-regex</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>no-sort</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">no-sort</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>no-splash</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">no-split</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>no-static</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">no-static</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>no-time</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">no-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>no-timestamp</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-timestamp</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-validate</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">no-validate</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>no-wait</samp>’</dt>
-<dd><p>Used in <code>emacsclient</code>.
+<dt>‘<samp class="samp">no-wait</samp>’</dt>
+<dd><p>Used in <code class="code">emacsclient</code>.
</p>
</dd>
-<dt>‘<samp>no-warn</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">node</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">info</code>.
</p>
</dd>
-<dt>‘<samp>nodename</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>uname</code>.
+<dt>‘<samp class="samp">nodename</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>nonmatching</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">nonmatching</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>nstuff</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>objdump</code>.
+<dt>‘<samp class="samp">nstuff</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">objdump</code>.
</p>
</dd>
-<dt>‘<samp>null</samp>’</dt>
-<dd><p>‘<samp>-0</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">null</samp>’</dt>
+<dd><p>‘<samp class="samp">-0</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>number</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">number</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>number-nonblank</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">number-nonblank</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>numeric-sort</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">numeric-sort</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">numeric-uid-gid</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">cpio</code> and <code class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>nx</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">old-archive</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>old-file</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">old-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">one-file-system</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">tar</code>, <code class="code">cp</code>, and <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>only-file</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">only-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>only-prof</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">only-prof</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>only-time</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">only-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">options</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">getopt</code>, <code class="code">fdlist</code>, <code
class="code">fdmount</code>,
+<code class="code">fdmountd</code>, and <code class="code">fdumount</code>.
</p>
</dd>
-<dt>‘<samp>output</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">output-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>override</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>rm</code>.
+<dt>‘<samp class="samp">override</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">rm</code>.
</p>
</dd>
-<dt>‘<samp>overwrite</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>unshar</code>.
+<dt>‘<samp class="samp">overwrite</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">unshar</code>.
</p>
</dd>
-<dt>‘<samp>owner</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>install</code>.
+<dt>‘<samp class="samp">owner</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">install</code>.
</p>
</dd>
-<dt>‘<samp>paginate</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">paginate</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>paragraph-indent</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">paragraph-indent</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>parents</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>mkdir</code> and
<code>rmdir</code>.
+<dt>‘<samp class="samp">parents</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">mkdir</code> and <code class="code">rmdir</code>.
</p>
</dd>
-<dt>‘<samp>pass-all</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>ul</code>.
+<dt>‘<samp class="samp">pass-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">ul</code>.
</p>
</dd>
-<dt>‘<samp>pass-through</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">pass-through</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>port</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>finger</code>.
+<dt>‘<samp class="samp">port</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">finger</code>.
</p>
</dd>
-<dt>‘<samp>portability</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>cpio</code> and <code>tar</code>.
+<dt>‘<samp class="samp">portability</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">cpio</code> and <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>posix</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">posix</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>prefix-builtins</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">prefix-builtins</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>prefix</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>preserve</samp>’</dt>
-<dd><p>Used in <code>tar</code> and <code>cp</code>.
+<dt>‘<samp class="samp">preserve</samp>’</dt>
+<dd><p>Used in <code class="code">tar</code> and <code class="code">cp</code>.
</p>
</dd>
-<dt>‘<samp>preserve-environment</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>su</code>.
+<dt>‘<samp class="samp">preserve-environment</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>preserve-modification-time</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">preserve-modification-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>preserve-order</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">preserve-order</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>preserve-permissions</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">preserve-permissions</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>print</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">print</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>print-chars</samp>’</dt>
-<dd><p>‘<samp>-L</samp>’ in <code>cmp</code>.
+<dt>‘<samp class="samp">print-chars</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">cmp</code>.
</p>
</dd>
-<dt>‘<samp>print-data-base</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">print-data-base</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>print-directory</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">print-directory</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>print-file-name</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">print-file-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>print-symdefs</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">print-symdefs</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>printer</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">printer</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>prompt</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>ed</code>.
+<dt>‘<samp class="samp">prompt</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">ed</code>.
</p>
</dd>
-<dt>‘<samp>proxy</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">query-user</samp>’</dt>
+<dd><p>‘<samp class="samp">-X</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>question</samp>’</dt>
-<dd><p>‘<samp>-q</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">question</samp>’</dt>
+<dd><p>‘<samp class="samp">-q</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>quiet</samp>’</dt>
+<dt>‘<samp class="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
+program accepting ‘<samp class="samp">--quiet</samp>’ should
accept ‘<samp class="samp">--silent</samp>’ as a
synonym.
</p>
</dd>
-<dt>‘<samp>quiet-unshar</samp>’</dt>
-<dd><p>‘<samp>-Q</samp>’ in <code>shar</code>
+<dt>‘<samp class="samp">quiet-unshar</samp>’</dt>
+<dd><p>‘<samp class="samp">-Q</samp>’ in <code
class="code">shar</code>
</p>
</dd>
-<dt>‘<samp>quote-name</samp>’</dt>
-<dd><p>‘<samp>-Q</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">quote-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-Q</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>rcs</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">rcs</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>re-interval</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">re-interval</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>read-full-blocks</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">read-full-blocks</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>readnow</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">recon</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>record-number</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">record-number</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">recursive</samp>’</dt>
+<dd><p>Used in <code class="code">chgrp</code>, <code
class="code">chown</code>, <code class="code">cp</code>, <code
class="code">ls</code>, <code class="code">diff</code>,
+and <code class="code">rm</code>.
</p>
</dd>
-<dt>‘<samp>reference</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>touch</code>.
+<dt>‘<samp class="samp">reference</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">touch</code>.
</p>
</dd>
-<dt>‘<samp>references</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">references</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>regex</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>tac</code> and
<code>etags</code>.
+<dt>‘<samp class="samp">regex</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">tac</code> and <code class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>release</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>uname</code>.
+<dt>‘<samp class="samp">release</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>reload-state</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">reload-state</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>relocation</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>objdump</code>.
+<dt>‘<samp class="samp">relocation</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">objdump</code>.
</p>
</dd>
-<dt>‘<samp>rename</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">rename</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>replace</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">replace</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>report-identical-files</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">report-identical-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>reset-access-time</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">reset-access-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>reverse</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>ls</code> and <code>nm</code>.
+<dt>‘<samp class="samp">reverse</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">ls</code> and <code class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>reversed-ed</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">reversed-ed</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>right-side-defs</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">right-side-defs</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>same-order</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">same-order</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>same-permissions</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">same-permissions</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>save</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>stty</code>.
+<dt>‘<samp class="samp">save</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">stty</code>.
</p>
</dd>
-<dt>‘<samp>se</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">sentence-regexp</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>separate-dirs</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">separate-dirs</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>separator</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>tac</code>.
+<dt>‘<samp class="samp">separator</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="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.
+<dt>‘<samp class="samp">sequence</samp>’</dt>
+<dd><p>Used by <code class="code">recode</code> to choose files or pipes for
sequencing passes.
</p>
</dd>
-<dt>‘<samp>shell</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>su</code>.
+<dt>‘<samp class="samp">shell</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>show-all</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">show-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>show-c-function</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">show-c-function</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>show-ends</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">show-ends</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>show-function-line</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">show-function-line</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>show-tabs</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">show-tabs</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>silent</samp>’</dt>
+<dt>‘<samp class="samp">silent</samp>’</dt>
<dd><p>Used in many programs to inhibit the usual output.
Every program accepting
-‘<samp>--silent</samp>’ should accept
‘<samp>--quiet</samp>’ as a synonym.
+‘<samp class="samp">--silent</samp>’ should accept ‘<samp
class="samp">--quiet</samp>’ as a synonym.
</p>
</dd>
-<dt>‘<samp>size</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">size</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>socket</samp>’</dt>
+<dt>‘<samp class="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.
</p>
</dd>
-<dt>‘<samp>sort</samp>’</dt>
-<dd><p>Used in <code>ls</code>.
+<dt>‘<samp class="samp">sort</samp>’</dt>
+<dd><p>Used in <code class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>source</samp>’</dt>
-<dd><p>‘<samp>-W source</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">source</samp>’</dt>
+<dd><p>‘<samp class="samp">-W source</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>sparse</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">sparse</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>speed-large-files</samp>’</dt>
-<dd><p>‘<samp>-H</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">speed-large-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-H</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>split-at</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>unshar</code>.
+<dt>‘<samp class="samp">split-at</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="code">unshar</code>.
</p>
</dd>
-<dt>‘<samp>split-size-limit</samp>’</dt>
-<dd><p>‘<samp>-L</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">split-size-limit</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>squeeze-blank</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">squeeze-blank</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>start-delete</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">start-delete</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>start-insert</samp>’</dt>
-<dd><p>‘<samp>-y</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">start-insert</samp>’</dt>
+<dd><p>‘<samp class="samp">-y</samp>’ in <code
class="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
+<dt>‘<samp class="samp">starting-file</samp>’</dt>
+<dd><p>Used in <code class="code">tar</code> and <code
class="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>.
+<dt>‘<samp class="samp">statistics</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>stdin-file-list</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">stdin-file-list</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>stop</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">stop</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>strict</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">strict</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>strip</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>install</code>.
+<dt>‘<samp class="samp">strip</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">install</code>.
</p>
</dd>
-<dt>‘<samp>strip-all</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">strip-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>strip-debug</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">strip-debug</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>submitter</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">submitter</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">suffix</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>.
</p>
</dd>
-<dt>‘<samp>suffix-format</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">suffix-format</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>sum</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">sum</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>summarize</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">summarize</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>symbolic</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>ln</code>.
+<dt>‘<samp class="samp">symbolic</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">ln</code>.
</p>
</dd>
-<dt>‘<samp>symbols</samp>’</dt>
-<dd><p>Used in GDB and <code>objdump</code>.
+<dt>‘<samp class="samp">symbols</samp>’</dt>
+<dd><p>Used in GDB and <code class="code">objdump</code>.
</p>
</dd>
-<dt>‘<samp>synclines</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">synclines</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>sysname</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>uname</code>.
+<dt>‘<samp class="samp">sysname</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>tabs</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>expand</code> and
<code>unexpand</code>.
+<dt>‘<samp class="samp">tabs</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">expand</code> and <code class="code">unexpand</code>.
</p>
</dd>
-<dt>‘<samp>tabsize</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">tabsize</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">terminal</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">tput</code> and <code class="code">ul</code>.
+‘<samp class="samp">-t</samp>’ in <code class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>text</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">text</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>text-files</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">text-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>time</samp>’</dt>
-<dd><p>Used in <code>ls</code> and <code>touch</code>.
+<dt>‘<samp class="samp">time</samp>’</dt>
+<dd><p>Used in <code class="code">ls</code> and <code
class="code">touch</code>.
</p>
</dd>
-<dt>‘<samp>timeout</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">to-stdout</samp>’</dt>
+<dd><p>‘<samp class="samp">-O</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>total</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">total</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">touch</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">make</code>, <code class="code">ranlib</code>, and <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>trace</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">trace</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">traditional</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">hello</code>;
+‘<samp class="samp">-W traditional</samp>’ in <code
class="code">gawk</code>;
+‘<samp class="samp">-G</samp>’ in <code class="code">ed</code>,
<code class="code">m4</code>, and <code class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>tty</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">typedefs</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>typedefs-and-c++</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>ctags</code>.
+<dt>‘<samp class="samp">typedefs-and-c++</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>typeset-mode</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">typeset-mode</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>uncompress</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">uncompress</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>unconditional</samp>’</dt>
-<dd><p>‘<samp>-u</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">unconditional</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>undefine</samp>’</dt>
-<dd><p>‘<samp>-U</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">undefine</samp>’</dt>
+<dd><p>‘<samp class="samp">-U</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>undefined-only</samp>’</dt>
-<dd><p>‘<samp>-u</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">undefined-only</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">update</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="code">cp</code>, <code class="code">ctags</code>, <code
class="code">mv</code>, <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>usage</samp>’</dt>
-<dd><p>Used in <code>gawk</code>; same as ‘<samp>--help</samp>’.
+<dt>‘<samp class="samp">usage</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>; same as ‘<samp
class="samp">--help</samp>’.
</p>
</dd>
-<dt>‘<samp>uuencode</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">uuencode</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>vanilla-operation</samp>’</dt>
-<dd><p>‘<samp>-V</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">vanilla-operation</samp>’</dt>
+<dd><p>‘<samp class="samp">-V</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>verbose</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">verify</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>version</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">version-control</samp>’</dt>
+<dd><p>‘<samp class="samp">-V</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>.
</p>
</dd>
-<dt>‘<samp>vgrind</samp>’</dt>
-<dd><p>‘<samp>-v</samp>’ in <code>ctags</code>.
+<dt>‘<samp class="samp">vgrind</samp>’</dt>
+<dd><p>‘<samp class="samp">-v</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>volume</samp>’</dt>
-<dd><p>‘<samp>-V</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">volume</samp>’</dt>
+<dd><p>‘<samp class="samp">-V</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>what-if</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">what-if</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>whole-size-limit</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">whole-size-limit</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>width</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>ls</code> and <code>ptx</code>.
+<dt>‘<samp class="samp">width</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">ls</code> and <code class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>word-regexp</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">word-regexp</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>writable</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">writable</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>zeros</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">zeros</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">gprof</code>.
</p></dd>
</dl>
<hr>
-<a name="OID-Allocations"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="OID-Allocations">
+<div class="nav-panel">
<p>
-Next: <a href="#Memory-Usage" accesskey="n" rel="next">Memory Usage</a>,
Previous: <a href="#Option-Table" accesskey="p" rel="prev">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>
+Next: <a href="#Memory-Usage" accesskey="n" rel="next">Memory Usage</a>,
Previous: <a href="#Option-Table" accesskey="p" rel="prev">Table of Long
Options</a>, Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program
Behavior for All Programs</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.11 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>
+<h3 class="section" id="OID-Allocations-1"><span>4.11 OID Allocations<a
class="copiable-link" href="#OID-Allocations-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-OID-allocations-for-GNU"></a>
+<a class="index-entry-id" id="index-SNMP"></a>
+<a class="index-entry-id" id="index-LDAP"></a>
+<a class="index-entry-id" id="index-X_002e509"></a>
<p>The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the
GNU Project (thanks to Sergey Poznyakoff). These are used for SNMP,
LDAP, X.509 certificates, and so on. The web site
-<a
href="https://www.alvestrand.no/objectid";>https://www.alvestrand.no/objectid</a>
has a (voluntary) listing of
+<a class="url"
href="https://www.alvestrand.no/objectid";>https://www.alvestrand.no/objectid</a>
has a (voluntary) listing of
many OID assignments.
</p>
<p>If you need a new slot for your GNU package, write
-<a href="mailto:maintainers@gnu.org";>maintainers@gnu.org</a>. Here is a list
of arcs currently
+<a class="email" href="mailto:maintainers@gnu.org";>maintainers@gnu.org</a>.
Here is a list of arcs currently
assigned:
</p>
<div class="example">
-<pre class="example">
+<pre class="example-preformatted">
1.3.6.1.4.1.11591 GNU
@@ -3082,21 +3023,21 @@
<hr>
-<a name="Memory-Usage"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Memory-Usage">
+<div class="nav-panel">
<p>
-Next: <a href="#File-Usage" accesskey="n" rel="next">File Usage</a>, Previous:
<a href="#OID-Allocations" accesskey="p" rel="prev">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>
+Next: <a href="#File-Usage" accesskey="n" rel="next">File Usage</a>, Previous:
<a href="#OID-Allocations" accesskey="p" rel="prev">OID Allocations</a>, Up: <a
href="#Program-Behavior" accesskey="u" rel="up">Program Behavior for All
Programs</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.12 Memory Usage</h3>
-<a name="index-memory-usage"></a>
+<h3 class="section" id="Memory-Usage-1"><span>4.12 Memory Usage<a
class="copiable-link" href="#Memory-Usage-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-memory-usage"></a>
<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>
-<p>However, for programs such as <code>cat</code> or <code>tail</code>, that
can
+<p>However, for programs such as <code class="code">cat</code> or <code
class="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
@@ -3105,94 +3046,83 @@
files that are bigger than will fit in memory all at once.
</p>
<p>If your program creates complicated data structures, just make them in
-memory and give a fatal error if <code>malloc</code> returns <code>NULL</code>.
+memory and give a fatal error if <code class="code">malloc</code> returns
<code class="code">NULL</code>.
</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
+<a class="index-entry-id" id="index-valgrind"></a>
+<a class="index-entry-id" id="index-memory-leak"></a>
+<p>Memory analysis tools such as <code class="command">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>
<hr>
-<a name="File-Usage"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="File-Usage">
+<div class="nav-panel">
<p>
-Previous: <a href="#Memory-Usage" accesskey="p" rel="prev">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>
+Previous: <a href="#Memory-Usage" accesskey="p" rel="prev">Memory Usage</a>,
Up: <a href="#Program-Behavior" accesskey="u" rel="up">Program Behavior for All
Programs</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.13 File Usage</h3>
-<a name="index-file-usage"></a>
+<h3 class="section" id="File-Usage-1"><span>4.13 File Usage<a
class="copiable-link" href="#File-Usage-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-file-usage"></a>
-<p>Programs should be prepared to operate when <samp>/usr</samp> and
<samp>/etc</samp>
+<p>Programs should be prepared to operate when <samp class="file">/usr</samp>
and <samp class="file">/etc</samp>
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>/usr</samp> or <samp>/etc</samp>.
+<samp class="file">/usr</samp> or <samp class="file">/etc</samp>.
</p>
-<p>There are two exceptions. <samp>/etc</samp> is used to store system
+<p>There are two exceptions. <samp class="file">/etc</samp> is used to store
system
configuration information; it is reasonable for a program to modify
-files in <samp>/etc</samp> when its job is to update the system configuration.
+files in <samp class="file">/etc</samp> 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>
<hr>
-<a name="Writing-C"></a>
-<div class="header">
+</div>
+</div>
+<div class="chapter-level-extent" id="Writing-C">
+<div class="nav-panel">
<p>
-Next: <a href="#Documentation" accesskey="n" rel="next">Documentation</a>,
Previous: <a href="#Program-Behavior" accesskey="p" rel="prev">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>
+Next: <a href="#Documentation" accesskey="n" rel="next">Documenting
Programs</a>, Previous: <a href="#Program-Behavior" accesskey="p"
rel="prev">Program Behavior for All Programs</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Coding Standards</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>
+<h2 class="chapter" id="Making-The-Best-Use-of-C"><span>5 Making The Best Use
of C<a class="copiable-link" href="#Making-The-Best-Use-of-C">
¶</a></span></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="mini-toc">
+<li><a href="#Formatting" accesskey="1">Formatting Your Source Code</a></li>
+<li><a href="#Comments" accesskey="2">Commenting Your Work</a></li>
+<li><a href="#Syntactic-Conventions" accesskey="3">Clean Use of C
Constructs</a></li>
+<li><a href="#Names" accesskey="4">Naming Variables, Functions, and
Files</a></li>
+<li><a href="#System-Portability" accesskey="5">Portability between System
Types</a></li>
+<li><a href="#CPU-Portability" accesskey="6">Portability between CPUs</a></li>
+<li><a href="#System-Functions" accesskey="7">Calling System Functions</a></li>
+<li><a href="#Internationalization" accesskey="8">Internationalization</a></li>
+<li><a href="#Character-Set" accesskey="9">Character Set</a></li>
+<li><a href="#Quote-Characters">Quote Characters</a></li>
+<li><a href="#Mmap">Mmap</a></li>
+</ul>
<hr>
-<a name="Formatting"></a>
-<div class="header">
+<div class="section-level-extent" id="Formatting">
+<div class="nav-panel">
<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>
+Next: <a href="#Comments" accesskey="n" rel="next">Commenting Your Work</a>,
Up: <a href="#Writing-C" accesskey="u" rel="up">Making The Best Use of 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>
+<h3 class="section" id="Formatting-Your-Source-Code"><span>5.1 Formatting Your
Source Code<a class="copiable-link" href="#Formatting-Your-Source-Code">
¶</a></span></h3>
+<a class="index-entry-id" id="index-formatting-source-code"></a>
-<a name="index-line-length"></a>
-<a name="index-length-of-source-lines"></a>
+<a class="index-entry-id" id="index-line-length"></a>
+<a class="index-entry-id" id="index-length-of-source-lines"></a>
<p>Please keep the length of source lines to 79 characters or less, for
maximum readability in the widest range of environments.
</p>
-<a name="index-open-brace"></a>
-<a name="index-braces_002c-in-C-source"></a>
-<a name="index-function-definitions_002c-formatting"></a>
+<a class="index-entry-id" id="index-open-brace"></a>
+<a class="index-entry-id" id="index-braces_002c-in-C-source"></a>
+<a class="index-entry-id" id="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
@@ -3200,7 +3130,7 @@
</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
+The open-brace that starts a <code class="code">struct</code> body can go in
column one
if you find it useful to treat that definition as a defun.
</p>
<p>It is also important for function definitions to start the name of the
@@ -3209,10 +3139,10 @@
using Standard C syntax, the format is this:
</p>
<div class="example">
-<pre class="example">static char *
+<pre class="example-preformatted">static char *
concat (char *s1, char *s2)
{
- …
+ ...
}
</pre></div>
@@ -3220,11 +3150,11 @@
this:
</p>
<div class="example">
-<pre class="example">static char *
+<pre class="example-preformatted">static char *
concat (s1, s2) /* Name starts in column one here */
char *s1, *s2;
{ /* Open brace in column one here */
- …
+ ...
}
</pre></div>
@@ -3232,32 +3162,32 @@
split it like this:
</p>
<div class="example">
-<pre class="example">int
+<pre class="example-preformatted">int
lots_of_args (int an_integer, long a_long, short a_short,
double a_double, float a_float)
-…
+...
</pre></div>
-<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
+<a class="index-entry-id" id="index-struct-types_002c-formatting"></a>
+<a class="index-entry-id" id="index-enum-types_002c-formatting"></a>
+<p>For <code class="code">struct</code> and <code class="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
+<pre class="example-preformatted">struct foo
{
int a, b;
}
-</pre><pre class="example"><span class="roman">or</span>
-</pre><pre class="example">struct foo { int a, b; }
+</pre><pre class="exdent"><span class="r">or</span>
+</pre><pre class="example-preformatted">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>
+C formatting style, which is also the default style of the <code
class="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
+<div class="example smallexample">
+<pre class="example-preformatted">-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>
@@ -3273,7 +3203,7 @@
<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))
+<pre class="example-preformatted">if (x < foo (y, z))
haha = bar[4] + 5;
else
{
@@ -3286,16 +3216,16 @@
}
</pre></div>
-<a name="index-spaces-before-open_002dparen"></a>
+<a class="index-entry-id" id="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"></a>
+<a class="index-entry-id" id="index-expressions_002c-splitting"></a>
<div class="example">
-<pre class="example">if (foo_this_is_long && bar > win (x, y, z)
+<pre class="example-preformatted">if (foo_this_is_long && bar > win
(x, y, z)
&& remaining_condition)
</pre></div>
@@ -3303,7 +3233,7 @@
level of indentation. For example, don’t write this:
</p>
<div class="example">
-<pre class="example">mode = (inmode[j] == VOIDmode
+<pre class="example-preformatted">mode = (inmode[j] == VOIDmode
|| GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])
? outmode[j] : inmode[j]);
</pre></div>
@@ -3311,7 +3241,7 @@
<p>Instead, use extra parentheses so that the indentation shows the nesting:
</p>
<div class="example">
-<pre class="example">mode = ((inmode[j] == VOIDmode
+<pre class="example-preformatted">mode = ((inmode[j] == VOIDmode
|| (GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])))
? outmode[j] : inmode[j]);
</pre></div>
@@ -3320,7 +3250,7 @@
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
+<pre class="example-preformatted">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></div>
@@ -3328,40 +3258,40 @@
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
+<pre class="example-preformatted">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></div>
<p>Format do-while statements like this:
</p>
<div class="example">
-<pre class="example">do
+<pre class="example-preformatted">do
{
a = foo (a);
}
while (a > 0);
</pre></div>
-<a name="index-formfeed"></a>
-<a name="index-control_002dL"></a>
+<a class="index-entry-id" id="index-formfeed"></a>
+<a class="index-entry-id" id="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>
-<a name="Comments"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Comments">
+<div class="nav-panel">
<p>
-Next: <a href="#Syntactic-Conventions" accesskey="n" rel="next">Syntactic
Conventions</a>, Previous: <a href="#Formatting" accesskey="p"
rel="prev">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>
+Next: <a href="#Syntactic-Conventions" accesskey="n" rel="next">Clean Use of C
Constructs</a>, Previous: <a href="#Formatting" accesskey="p"
rel="prev">Formatting Your Source Code</a>, Up: <a href="#Writing-C"
accesskey="u" rel="up">Making The Best Use of 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>
+<h3 class="section" id="Commenting-Your-Work"><span>5.2 Commenting Your Work<a
class="copiable-link" href="#Commenting-Your-Work"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-commenting"></a>
<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>’
+Example: ‘<samp class="samp">fmt - filter for simple filling of
text</samp>’. This comment
+should be at the top of the source file containing the ‘<samp
class="samp">main</samp>’
function of the program.
</p>
<p>Also, please write a brief comment at the start of each source file,
@@ -3380,7 +3310,7 @@
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 <code>char *</code> which is really the
+its use (such as an argument of type <code class="code">char *</code> 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
@@ -3410,89 +3340,89 @@
<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;
+<pre class="example-preformatted">/* Nonzero means truncate lines in the
display;
zero means continue them. */
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
+<a class="index-entry-id" id="index-conditionals_002c-comments-for"></a>
+<a class="index-entry-id" id="index-_0023endif_002c-commenting"></a>
+<p>Every ‘<samp class="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>#else</samp>’ should have a comment
describing the condition
-<em>and sense</em> of the code that follows. For example:
+state the condition of the conditional that is ending, <em
class="emph">including
+its sense</em>. ‘<samp class="samp">#else</samp>’ should have a
comment describing the condition
+<em class="emph">and sense</em> of the code that follows. For example:
</p>
<div class="example">
-<pre class="example">#ifdef foo
- …
+<div class="group"><pre class="example-preformatted">#ifdef foo
+ ...
#else /* not foo */
- …
+ ...
#endif /* not foo */
-</pre><pre class="example">#ifdef foo
- …
+</pre></div><div class="group"><pre class="example-preformatted">#ifdef foo
+ ...
#endif /* foo */
-</pre></div>
+</pre></div></div>
-<p>but, by contrast, write the comments this way for a
‘<samp>#ifndef</samp>’:
+<p>but, by contrast, write the comments this way for a ‘<samp
class="samp">#ifndef</samp>’:
</p>
<div class="example">
-<pre class="example">#ifndef foo
- …
+<div class="group"><pre class="example-preformatted">#ifndef foo
+ ...
#else /* foo */
- …
+ ...
#endif /* foo */
-</pre><pre class="example">#ifndef foo
- …
+</pre></div><div class="group"><pre class="example-preformatted">#ifndef foo
+ ...
#endif /* not foo */
-</pre></div>
+</pre></div></div>
<hr>
-<a name="Syntactic-Conventions"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Syntactic-Conventions">
+<div class="nav-panel">
<p>
-Next: <a href="#Names" accesskey="n" rel="next">Names</a>, Previous: <a
href="#Comments" accesskey="p" rel="prev">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>
+Next: <a href="#Names" accesskey="n" rel="next">Naming Variables, Functions,
and Files</a>, Previous: <a href="#Comments" accesskey="p"
rel="prev">Commenting Your Work</a>, Up: <a href="#Writing-C" accesskey="u"
rel="up">Making The Best Use of 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>
+<h3 class="section" id="Clean-Use-of-C-Constructs"><span>5.3 Clean Use of C
Constructs<a class="copiable-link" href="#Clean-Use-of-C-Constructs">
¶</a></span></h3>
+<a class="index-entry-id" id="index-syntactic-conventions"></a>
-<a name="index-implicit-int"></a>
-<a name="index-function-argument_002c-declaring"></a>
+<a class="index-entry-id" id="index-implicit-int"></a>
+<a class="index-entry-id" id="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>.
+declare functions to return <code class="code">int</code> rather than omitting
the
+<code class="code">int</code>.
</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
+<a class="index-entry-id" id="index-compiler-warnings"></a>
+<a class="index-entry-id" id="index-_002dWall-compiler-option"></a>
+<p>Some programmers like to use the GCC ‘<samp
class="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>-Wall</samp>’, because
it gives
+Other programmers prefer not to use ‘<samp
class="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"></a>
-<a name="index-lint"></a>
+<a class="index-entry-id" id="index-clang"></a>
+<a class="index-entry-id" id="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
+as <code class="command">lint</code>, <code class="command">clang</code>, and
GCC with extra warnings
+options such as <samp class="option">-Wconversion</samp> and <samp
class="option">-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 class="code">void</code> or calls to
do-nothing
functions merely to pacify a lint checker.
</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 class="code">extern</code>
declarations inside
functions.
</p>
-<a name="index-temporary-variables"></a>
+<a class="index-entry-id" id="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
+names like <code class="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
meaningful. This not only makes programs easier to understand, it also
@@ -3501,40 +3431,40 @@
all its uses. This makes the program even cleaner.
</p>
<p>Don’t use local variables or parameters that shadow global
identifiers.
-GCC’s ‘<samp>-Wshadow</samp>’ option can detect this problem.
+GCC’s ‘<samp class="samp">-Wshadow</samp>’ option can detect
this problem.
</p>
-<a name="index-multiple-variables-in-a-line"></a>
+<a class="index-entry-id" id="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:
</p>
<div class="example">
-<pre class="example">int foo,
+<div class="group"><pre class="example-preformatted">int foo,
bar;
-</pre></div>
+</pre></div></div>
<p>write either this:
</p>
<div class="example">
-<pre class="example">int foo, bar;
+<pre class="example-preformatted">int foo, bar;
</pre></div>
<p>or this:
</p>
<div class="example">
-<pre class="example">int foo;
+<pre class="example-preformatted">int foo;
int bar;
</pre></div>
<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>.
+<p>When you have an <code class="code">if</code>-<code
class="code">else</code> statement nested in another
+<code class="code">if</code> statement, always put braces around the <code
class="code">if</code>-<code class="code">else</code>.
Thus, never write like this:
</p>
<div class="example">
-<pre class="example">if (foo)
+<pre class="example-preformatted">if (foo)
if (bar)
win ();
else
@@ -3544,7 +3474,7 @@
<p>always like this:
</p>
<div class="example">
-<pre class="example">if (foo)
+<pre class="example-preformatted">if (foo)
{
if (bar)
win ();
@@ -3553,26 +3483,26 @@
}
</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>If you have an <code class="code">if</code> statement nested inside of an
<code class="code">else</code>
+statement, either write <code class="code">else if</code> on one line, like
this,
</p>
<div class="example">
-<pre class="example">if (foo)
- …
+<pre class="example-preformatted">if (foo)
+ ...
else if (bar)
- …
+ ...
</pre></div>
-<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:
+<p>with its <code class="code">then</code>-part indented like the preceding
<code class="code">then</code>-part,
+or write the nested <code class="code">if</code> within braces like this:
</p>
<div class="example">
-<pre class="example">if (foo)
- …
+<pre class="example-preformatted">if (foo)
+ ...
else
{
if (bar)
- …
+ ...
}
</pre></div>
@@ -3580,33 +3510,33 @@
same declaration. Instead, declare the structure tag separately
and then use it to declare the variables or typedefs.
</p>
-<p>Try to avoid assignments inside <code>if</code>-conditions (assignments
-inside <code>while</code>-conditions are ok). For example, don’t write
+<p>Try to avoid assignments inside <code class="code">if</code>-conditions
(assignments
+inside <code class="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)) == NULL)
+<pre class="example-preformatted">if ((foo = (char *) malloc (sizeof *foo)) ==
NULL)
fatal ("virtual memory exhausted");
</pre></div>
<p>instead, write this:
</p>
<div class="example">
-<pre class="example">foo = (char *) malloc (sizeof *foo);
+<pre class="example-preformatted">foo = (char *) malloc (sizeof *foo);
if (foo == NULL)
fatal ("virtual memory exhausted");
</pre></div>
<hr>
-<a name="Names"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Names">
+<div class="nav-panel">
<p>
-Next: <a href="#System-Portability" accesskey="n" rel="next">System
Portability</a>, Previous: <a href="#Syntactic-Conventions" accesskey="p"
rel="prev">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>
+Next: <a href="#System-Portability" accesskey="n" rel="next">Portability
between System Types</a>, Previous: <a href="#Syntactic-Conventions"
accesskey="p" rel="prev">Clean Use of C Constructs</a>, Up: <a
href="#Writing-C" accesskey="u" rel="up">Making The Best Use of 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>
+<h3 class="section"
id="Naming-Variables_002c-Functions_002c-and-Files"><span>5.4 Naming Variables,
Functions, and Files<a class="copiable-link"
href="#Naming-Variables_002c-Functions_002c-and-Files"> ¶</a></span></h3>
-<a name="index-names-of-variables_002c-functions_002c-and-files"></a>
+<a class="index-entry-id"
id="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
@@ -3622,11 +3552,11 @@
</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
+upper case for macros and <code class="code">enum</code> constants, and for
name-prefixes
that follow a uniform convention.
</p>
-<p>For example, you should use names like
<code>ignore_space_change_flag</code>;
-don’t use names like <code>iCantReadThis</code>.
+<p>For example, you should use names like <code
class="code">ignore_space_change_flag</code>;
+don’t use names like <code class="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
@@ -3634,56 +3564,71 @@
the option and its letter. For example,
</p>
<div class="example">
-<pre class="example">/* Ignore changes in horizontal whitespace (-b). */
+<div class="group"><pre class="example-preformatted">/* Ignore changes in
horizontal whitespace (-b). */
int ignore_space_change_flag;
-</pre></div>
+</pre></div></div>
<p>When you want to define names with constant integer values, use
-<code>enum</code> rather than ‘<samp>#define</samp>’. GDB knows
about enumeration
+<code class="code">enum</code> rather than ‘<samp
class="samp">#define</samp>’. GDB knows about enumeration
constants.
</p>
-<a name="index-file_002dname-limitations"></a>
-<a name="index-doschk"></a>
+<a class="index-entry-id" id="index-file_002dname-limitations"></a>
+<a class="index-entry-id" id="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.
+names. You can use the program <code class="code">doschk</code> to test for
this.
</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
+programs. <code class="code">doschk</code> also reports file names longer
than 14
characters.
</p>
<hr>
-<a name="System-Portability"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="System-Portability">
+<div class="nav-panel">
<p>
-Next: <a href="#CPU-Portability" accesskey="n" rel="next">CPU Portability</a>,
Previous: <a href="#Names" accesskey="p" rel="prev">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>
+Next: <a href="#CPU-Portability" accesskey="n" rel="next">Portability between
CPUs</a>, Previous: <a href="#Names" accesskey="p" rel="prev">Naming Variables,
Functions, and Files</a>, Up: <a href="#Writing-C" accesskey="u"
rel="up">Making The Best Use of 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>
+<h3 class="section" id="Portability-between-System-Types"><span>5.5
Portability between System Types<a class="copiable-link"
href="#Portability-between-System-Types"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-portability_002c-between-system-types"></a>
<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>
-<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 CPU. 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>
-<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
-be hard.
+<p>The primary purpose of GNU software is to run as part of the GNU
+operating system, compiled with GNU compilers, on various types of
+hardware. So the kinds of portability that are absolutely necessary
+are quite limited. It is important to support Linux-based GNU
+systems, since they are the form of GNU that people mainly use.
+</p>
+<p>Making a GNU program operate on operating systems other than the GNU
+system is not part of the core goal of developing a GNU package. You
+don’t ever have to do that. However, users will ask you to do that,
+and cooperating with those requests is useful—as long as you don’t
+let it dominate the project or impede the primary goal.
+</p>
+<p>It is good to support the other free or nearly free operating systems
+(for instance, *BSD). 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 be hard.
+</p>
+<p>For the most part it is good to port the program to more platforms,
+but you should not let take up so much of your time that it hinders
+you from improving the program in more central ways. If it starts to
+do that, please tell users that you don’t want to spend any more
+time on this—someone else must write that code, debug it, document
+it, etc., and then you can install it.
+</p>
+<p>You can reject porting patches for technical reasons too, as with any
+other patch that users submit. It is up to you.
</p>
-<a name="index-autoconf"></a>
+<a class="index-entry-id" id="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
@@ -3691,9 +3636,9 @@
written.
</p>
<p>Avoid using the format of semi-internal data bases (e.g., directories)
-when there is a higher-level alternative (<code>readdir</code>).
+when there is a higher-level alternative (<code class="code">readdir</code>).
</p>
-<a name="index-non_002dPOSIX-systems_002c-and-portability"></a>
+<a class="index-entry-id"
id="index-non_002dPOSIX-systems_002c-and-portability"></a>
<p>As for systems that are not like Unix, such as MS-DOS, 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
@@ -3701,21 +3646,21 @@
other incompatible systems.
</p>
<p>If you do support Windows, please do not abbreviate it as “win”.
-See <a href="#Trademarks">Trademarks</a>.
+See <a class="xref" href="#Trademarks">Trademarks</a>.
</p>
<p>Usually we write the name “Windows” in full, but when brevity is
very important (as in file names and some symbol names), we abbreviate
-it to “w”. In GNU Emacs, for instance, we use
‘<samp>w32</samp>’ in file
+it to “w”. In GNU Emacs, for instance, we use ‘<samp
class="samp">w32</samp>’ in file
names of Windows-specific files, but the macro for Windows
-conditionals is called <code>WINDOWSNT</code>. In principle there could
-also be ‘<samp>w64</samp>’.
+conditionals is called <code class="code">WINDOWSNT</code>. In principle
there could
+also be ‘<samp class="samp">w64</samp>’.
</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
+<code class="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 class="emph">use</em> these functions,
if you prefer
to make the program more portable to other systems.)
</p>
<p>But whether or not you use these GNU extensions, you should avoid
@@ -3723,31 +3668,31 @@
to move your code into other GNU programs.
</p>
<hr>
-<a name="CPU-Portability"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="CPU-Portability">
+<div class="nav-panel">
<p>
-Next: <a href="#System-Functions" accesskey="n" rel="next">System
Functions</a>, Previous: <a href="#System-Portability" accesskey="p"
rel="prev">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>
+Next: <a href="#System-Functions" accesskey="n" rel="next">Calling System
Functions</a>, Previous: <a href="#System-Portability" accesskey="p"
rel="prev">Portability between System Types</a>, Up: <a href="#Writing-C"
accesskey="u" rel="up">Making The Best Use of 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 CPUs</h3>
+<h3 class="section" id="Portability-between-CPUs"><span>5.6 Portability
between CPUs<a class="copiable-link" href="#Portability-between-CPUs">
¶</a></span></h3>
-<a name="index-data-types_002c-and-portability"></a>
-<a name="index-portability_002c-and-data-types"></a>
+<a class="index-entry-id" id="index-data-types_002c-and-portability"></a>
+<a class="index-entry-id" id="index-portability_002c-and-data-types"></a>
<p>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
-<code>int</code> will be less than 32 bits. We don’t support 16-bit
machines
+<code class="code">int</code> will be less than 32 bits. We don’t
support 16-bit machines
in GNU.
</p>
-<p>You need not cater to the possibility that <code>long</code> will be smaller
-than pointers and <code>size_t</code>. We know of one such platform: 64-bit
+<p>You need not cater to the possibility that <code class="code">long</code>
will be smaller
+than pointers and <code class="code">size_t</code>. We know of one such
platform: 64-bit
programs on Microsoft Windows. If you care about making your package
run on Windows using Mingw64, you would need to deal with 8-byte
-pointers and 4-byte <code>long</code>, which would break this code:
+pointers and 4-byte <code class="code">long</code>, which would break this
code:
</p>
<div class="example">
-<pre class="example">printf ("size = %lu\n", (unsigned long) sizeof
array);
+<pre class="example-preformatted">printf ("size = %lu\n", (unsigned
long) sizeof array);
printf ("diff = %ld\n", (long) (pointer2 - pointer1));
</pre></div>
@@ -3758,28 +3703,28 @@
on Windows, and you are not interested, you can respond with, “Switch
to GNU/Linux — your freedom depends on it.”
</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
+<p>Predefined file-size types like <code class="code">off_t</code> are an
exception: they are
+longer than <code class="code">long</code> on many platforms, so code like the
above won’t
+work with them. One way to print an <code class="code">off_t</code> value
portably is to
print its digits yourself, one by one.
</p>
-<p>Don’t assume that the address of an <code>int</code> object is also
the
+<p>Don’t assume that the address of an <code class="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:
</p>
<div class="example">
-<pre class="example">int c;
-…
+<pre class="example-preformatted">int c;
+...
while ((c = getchar ()) != EOF)
write (file_descriptor, &c, 1);
</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
+<p>Instead, use <code class="code">unsigned char</code> as follows. (The
<code class="code">unsigned</code>
+is for portability to unusual systems where <code class="code">char</code> is
signed and
where there is integer overflow checking.)
</p>
<div class="example">
-<pre class="example">int c;
+<pre class="example-preformatted">int c;
while ((c = getchar ()) != EOF)
{
unsigned char u = c;
@@ -3787,30 +3732,30 @@
}
</pre></div>
-<a name="index-casting-pointers-to-integers"></a>
+<a class="index-entry-id" id="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
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
+normal range of addresses you can get from <code class="code">malloc</code>
starts far away
from zero.
</p>
<hr>
-<a name="System-Functions"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="System-Functions">
+<div class="nav-panel">
<p>
-Next: <a href="#Internationalization" accesskey="n"
rel="next">Internationalization</a>, Previous: <a href="#CPU-Portability"
accesskey="p" rel="prev">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>
+Next: <a href="#Internationalization" accesskey="n"
rel="next">Internationalization</a>, Previous: <a href="#CPU-Portability"
accesskey="p" rel="prev">Portability between CPUs</a>, Up: <a href="#Writing-C"
accesskey="u" rel="up">Making The Best Use of 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>
+<h3 class="section" id="Calling-System-Functions"><span>5.7 Calling System
Functions<a class="copiable-link" href="#Calling-System-Functions">
¶</a></span></h3>
-<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>
+<a class="index-entry-id"
id="index-C-library-functions_002c-and-portability"></a>
+<a class="index-entry-id" id="index-POSIX-functions_002c-and-portability"></a>
+<a class="index-entry-id"
id="index-library-functions_002c-and-portability"></a>
+<a class="index-entry-id"
id="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,
@@ -3829,41 +3774,41 @@
<p>Despite the standards, nearly every library function has some sort of
portability issue on some system or another. Here are some examples:
</p>
-<dl compact="compact">
-<dt><code>open</code></dt>
-<dd><p>Names with trailing <code>/</code>’s are mishandled on many
platforms.
+<dl class="table">
+<dt><code class="code">open</code></dt>
+<dd><p>Names with trailing <code class="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
+<dt><code class="code">printf</code></dt>
+<dd><p><code class="code">long double</code> may be unimplemented; floating
values Infinity and
NaN are often mishandled; output for large precisions may be
incorrect.
</p>
</dd>
-<dt><code>readlink</code></dt>
-<dd><p>May return <code>int</code> instead of <code>ssize_t</code>.
+<dt><code class="code">readlink</code></dt>
+<dd><p>May return <code class="code">int</code> instead of <code
class="code">ssize_t</code>.
</p>
</dd>
-<dt><code>scanf</code></dt>
-<dd><p>On Windows, <code>errno</code> is not set on failure.
+<dt><code class="code">scanf</code></dt>
+<dd><p>On Windows, <code class="code">errno</code> is not set on failure.
</p></dd>
</dl>
-<a name="index-Gnulib"></a>
-<p><a href="https://www.gnu.org/software/gnulib/";>Gnulib</a> is a big help in
+<a class="index-entry-id" id="index-Gnulib"></a>
+<p><a class="uref" href="https://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"></a>
-<a name="index-error-messages_002c-in-Gnulib"></a>
-<a name="index-data-structures_002c-in-Gnulib"></a>
+<a class="index-entry-id" id="index-xmalloc_002c-in-Gnulib"></a>
+<a class="index-entry-id" id="index-error-messages_002c-in-Gnulib"></a>
+<a class="index-entry-id" id="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
+functions (<code class="code">xmalloc</code>, <code
class="code">xrealloc</code>), and output of error
messages.
</p>
<p>Gnulib integrates with GNU Autoconf and Automake to remove much of the
@@ -3872,48 +3817,48 @@
use the Gnulib code to supply the missing pieces.
</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
+portability: <a data-manual="gnulib"
href="https://www.gnu.org/software/gnulib/manual/gnulib.html#Top";>Introduction</a>
in <cite class="cite">Gnulib</cite> and
+see <a data-manual="autoconf"
href="https://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-C-and-C_002b_002b";>Portable
C and C++</a> in <cite class="cite">Autoconf</cite>. Please consult them
for many more details.
</p>
<hr>
-<a name="Internationalization"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Internationalization">
+<div class="nav-panel">
<p>
-Next: <a href="#Character-Set" accesskey="n" rel="next">Character Set</a>,
Previous: <a href="#System-Functions" accesskey="p" rel="prev">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>
+Next: <a href="#Character-Set" accesskey="n" rel="next">Character Set</a>,
Previous: <a href="#System-Functions" accesskey="p" rel="prev">Calling System
Functions</a>, Up: <a href="#Writing-C" accesskey="u" rel="up">Making The Best
Use of 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>
+<h3 class="section" id="Internationalization-1"><span>5.8
Internationalization<a class="copiable-link" href="#Internationalization-1">
¶</a></span></h3>
+<a class="index-entry-id" id="index-internationalization"></a>
-<a name="index-gettext"></a>
+<a class="index-entry-id" id="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>
-<p>Using GNU gettext involves putting a call to the <code>gettext</code> macro
+<p>Using GNU gettext involves putting a call to the <code
class="code">gettext</code> macro
around each string that might need translation—like this:
</p>
<div class="example">
-<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+<pre class="example-preformatted">printf (gettext ("Processing file
'%s'..."), file);
</pre></div>
-<p>This permits GNU gettext to replace the string <code>"Processing file
+<p>This permits GNU gettext to replace the string <code
class="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.
+<code class="code">gettext</code> when you add new strings that call for
translation.
</p>
-<p>Using GNU gettext in a package involves specifying a <em>text domain
+<p>Using GNU gettext in a package involves specifying a <em class="dfn">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>coreutils</samp>’ for the GNU
core utilities.
+package—for example, ‘<samp class="samp">coreutils</samp>’
for the GNU core utilities.
</p>
-<a name="index-message-text_002c-and-internationalization"></a>
+<a class="index-entry-id"
id="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
@@ -3923,14 +3868,14 @@
</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");
+<div class="example smallexample">
+<pre class="example-preformatted">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"),
+<div class="example smallexample">
+<pre class="example-preformatted">printf (gettext ("%s is full"),
capacity > 5000000 ? gettext ("disk") : gettext
("floppy disk"));
</pre></div>
@@ -3943,7 +3888,7 @@
<p>Complete sentences can be translated without problems:
</p>
<div class="example">
-<pre class="example">printf (capacity > 5000000 ? gettext ("disk is
full")
+<pre class="example-preformatted">printf (capacity > 5000000 ? gettext
("disk is full")
: gettext ("floppy disk is full"));
</pre></div>
@@ -3951,18 +3896,18 @@
code:
</p>
<div class="example">
-<pre class="example">printf ("# Implicit rule search has%s been
done.\n",
+<pre class="example-preformatted">printf ("# Implicit rule search has%s
been done.\n",
f->tried_implicit ? "" : " not");
</pre></div>
-<p>Adding <code>gettext</code> calls to this code cannot give correct results
for
+<p>Adding <code class="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
+<code class="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
+<pre class="example-preformatted">printf (f->tried_implicit
? "# Implicit rule search has been done.\n",
: "# Implicit rule search has not been done.\n");
</pre></div>
@@ -3970,7 +3915,7 @@
<p>Another example is this one:
</p>
<div class="example">
-<pre class="example">printf ("%d file%s processed", nfiles,
+<pre class="example-preformatted">printf ("%d file%s processed",
nfiles,
nfiles != 1 ? "s" : "");
</pre></div>
@@ -3978,7 +3923,7 @@
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,
+<pre class="example-preformatted">printf (gettext ("%d file%s
processed"), nfiles,
nfiles != 1 ? "s" : "");
</pre></div>
@@ -3987,33 +3932,33 @@
the two strings independently:
</p>
<div class="example">
-<pre class="example">printf ((nfiles != 1 ? gettext ("%d files
processed")
+<pre class="example-preformatted">printf ((nfiles != 1 ? gettext ("%d
files processed")
: gettext ("%d file processed")),
nfiles);
</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:
+and one for the rest. The GNU <code class="code">ngettext</code> function
solves this problem:
</p>
<div class="example">
-<pre class="example">printf (ngettext ("%d files processed",
"%d file processed", nfiles),
+<pre class="example-preformatted">printf (ngettext ("%d files
processed", "%d file processed", nfiles),
nfiles);
</pre></div>
<hr>
-<a name="Character-Set"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Character-Set">
+<div class="nav-panel">
<p>
-Next: <a href="#Quote-Characters" accesskey="n" rel="next">Quote
Characters</a>, Previous: <a href="#Internationalization" accesskey="p"
rel="prev">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>
+Next: <a href="#Quote-Characters" accesskey="n" rel="next">Quote
Characters</a>, Previous: <a href="#Internationalization" accesskey="p"
rel="prev">Internationalization</a>, Up: <a href="#Writing-C" accesskey="u"
rel="up">Making The Best Use of 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>
+<h3 class="section" id="Character-Set-1"><span>5.9 Character Set<a
class="copiable-link" href="#Character-Set-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-character-set"></a>
+<a class="index-entry-id" id="index-encodings"></a>
+<a class="index-entry-id" id="index-ASCII-characters"></a>
+<a class="index-entry-id" id="index-non_002dASCII-characters"></a>
<p>Sticking to the ASCII character set (plain text, 7-bit characters) is
preferred in GNU source code comments, text documents, and other
@@ -4022,7 +3967,7 @@
French Revolutionary calendar, it is OK if its literal strings contain
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>).
+names of contributors in change logs (see <a class="pxref"
href="#Change-Logs">Change Logs</a>).
</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
@@ -4030,45 +3975,45 @@
</p>
<hr>
-<a name="Quote-Characters"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Quote-Characters">
+<div class="nav-panel">
<p>
-Next: <a href="#Mmap" accesskey="n" rel="next">Mmap</a>, Previous: <a
href="#Character-Set" accesskey="p" rel="prev">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>
+Next: <a href="#Mmap" accesskey="n" rel="next">Mmap</a>, Previous: <a
href="#Character-Set" accesskey="p" rel="prev">Character Set</a>, Up: <a
href="#Writing-C" accesskey="u" rel="up">Making The Best Use of 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>
+<h3 class="section" id="Quote-Characters-1"><span>5.10 Quote Characters<a
class="copiable-link" href="#Quote-Characters-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-quote-characters"></a>
+<a class="index-entry-id" id="index-locale_002dspecific-quote-characters"></a>
+<a class="index-entry-id" id="index-left-quote"></a>
+<a class="index-entry-id" id="index-right-quote"></a>
+<a class="index-entry-id" id="index-opening-quote"></a>
+<a class="index-entry-id" id="index-single-quote"></a>
+<a class="index-entry-id" id="index-double-quote"></a>
+<a class="index-entry-id" id="index-grave-accent"></a>
<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>"</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.
+(‘<samp class="samp">"</samp>’) or 0x27 (‘<samp
class="samp">'</samp>’) for both opening and closing quotes.
+Although GNU programs traditionally used 0x60 (‘<samp
class="samp">`</samp>’) for opening
+and 0x27 (‘<samp class="samp">'</samp>’) for closing quotes,
nowadays quotes ‘<samp class="samp">`like
+this'</samp>’ are typically rendered asymmetrically, so quoting
‘<samp class="samp">"like
+this"</samp>’ or ‘<samp class="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:
</p>
<div class="example">
-<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+<pre class="example-preformatted">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
+<p>Here, a French translation might cause <code class="code">gettext</code> to
return the
+string <code class="code">"Traitement de fichier
‹ %s ›..."</code>, yielding quotes
more appropriate for a French locale.
</p>
<p>Sometimes a program may need to use opening and closing quotes
-directly. By convention, <code>gettext</code> translates the string
-‘<samp>"`"</samp>’ to the opening quote and the string
‘<samp>"'"</samp>’ to the
+directly. By convention, <code class="code">gettext</code> translates the
string
+‘<samp class="samp">"`"</samp>’ to the opening quote and
the string ‘<samp class="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.
@@ -4077,82 +4022,71 @@
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>--quoting-style</samp> of GNU <code>ls</code>.
+the option <samp class="option">--quoting-style</samp> of GNU <code
class="code">ls</code>.
</p>
<hr>
-<a name="Mmap"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Mmap">
+<div class="nav-panel">
<p>
-Previous: <a href="#Quote-Characters" accesskey="p" rel="prev">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>
+Previous: <a href="#Quote-Characters" accesskey="p" rel="prev">Quote
Characters</a>, Up: <a href="#Writing-C" accesskey="u" rel="up">Making The Best
Use of 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>
+<h3 class="section" id="Mmap-1"><span>5.11 Mmap<a class="copiable-link"
href="#Mmap-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-mmap"></a>
-<p>If you use <code>mmap</code> to read or write files, don’t assume it
either
+<p>If you use <code class="code">mmap</code> to read or write files,
don’t assume it either
works on all files or fails for all files. It may work on some files
and fail on others.
</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 proper way to use <code class="code">mmap</code> is to try it on the
specific file for
+which you want to use it—and if <code class="code">mmap</code>
doesn’t work, fall back on
+doing the job in another way using <code class="code">read</code> and <code
class="code">write</code>.
</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
+<code class="code">mmap</code>, but some do not. It is important to make
programs handle
all these kinds of files.
</p>
<hr>
-<a name="Documentation"></a>
-<div class="header">
+</div>
+</div>
+<div class="chapter-level-extent" id="Documentation">
+<div class="nav-panel">
<p>
-Next: <a href="#Managing-Releases" accesskey="n" rel="next">Managing
Releases</a>, Previous: <a href="#Writing-C" accesskey="p" rel="prev">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>
+Next: <a href="#Managing-Releases" accesskey="n" rel="next">The Release
Process</a>, Previous: <a href="#Writing-C" accesskey="p" rel="prev">Making The
Best Use of C</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU Coding
Standards</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>
+<h2 class="chapter" id="Documenting-Programs"><span>6 Documenting Programs<a
class="copiable-link" href="#Documenting-Programs"> ¶</a></span></h2>
+<a class="index-entry-id" id="index-documentation"></a>
<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.
</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.
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#GNU-Manuals" accesskey="1">GNU Manuals</a></li>
+<li><a href="#Doc-Strings-and-Manuals" accesskey="2">Doc Strings and
Manuals</a></li>
+<li><a href="#Manual-Structure-Details" accesskey="3">Manual Structure
Details</a></li>
+<li><a href="#License-for-Manuals" accesskey="4">License for Manuals</a></li>
+<li><a href="#Manual-Credits" accesskey="5">Manual Credits</a></li>
+<li><a href="#Printed-Manuals" accesskey="6">Printed Manuals</a></li>
+<li><a href="#NEWS-File" accesskey="7">The NEWS File</a></li>
+<li><a href="#Change-Logs" accesskey="8">Change Logs</a></li>
+<li><a href="#Man-Pages" accesskey="9">Man Pages</a></li>
+<li><a href="#Reading-other-Manuals">Reading other Manuals</a></li>
+</ul>
<hr>
-<a name="GNU-Manuals"></a>
-<div class="header">
+<div class="section-level-extent" id="GNU-Manuals">
+<div class="nav-panel">
<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>
+Next: <a href="#Doc-Strings-and-Manuals" accesskey="n" rel="next">Doc Strings
and Manuals</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documenting Programs</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>
+<h3 class="section" id="GNU-Manuals-1"><span>6.1 GNU Manuals<a
class="copiable-link" href="#GNU-Manuals-1"> ¶</a></span></h3>
<p>The preferred document format for the GNU system is the Texinfo
formatting language. Every GNU package should (ideally) have
@@ -4160,8 +4094,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 <code>info</code> or the
-Emacs Info subsystem (<kbd>C-h i</kbd>).
+hardcopy, or the on-line version available through <code
class="code">info</code> or the
+Emacs Info subsystem (<kbd class="kbd">C-h i</kbd>).
</p>
<p>Nowadays some other formats such as Docbook and Sgmltexi can be
converted automatically into Texinfo. It is ok to produce the Texinfo
@@ -4221,10 +4155,10 @@
implementation, rather than the structure that helps the user
understand.
</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
+<p>Instead, each manual should cover a coherent <em class="emph">topic</em>.
For example,
+instead of a manual for <code class="code">diff</code> and a manual for <code
class="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
+programs, as well as <code class="code">cmp</code>. By documenting these
programs
together, we can make the whole subject clearer.
</p>
<p>The manual which discusses a program should certainly document all of
@@ -4249,7 +4183,7 @@
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
+section into paragraphs. The watchword is, <em class="emph">at each point,
address
the most fundamental and important issue raised by the preceding text.</em>
</p>
<p>If necessary, add extra chapters at the beginning of the manual which
@@ -4262,9 +4196,9 @@
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="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>.
+entries, see <a data-manual="texinfo"
href="https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Index-Entries";>Making
Index Entries</a> in <cite class="cite">GNU
+Texinfo</cite>, and see <a data-manual="texinfo"
href="https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Indexing-Commands";>Defining
the Entries of an
+Index</a> in <cite class="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
@@ -4273,7 +4207,7 @@
different from what we use in GNU manuals.
</p>
<p>Please include an email address in the manual for where to report
-bugs <em>in the text of the manual</em>.
+bugs <em class="emph">in the text of the manual</em>.
</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
@@ -4283,30 +4217,30 @@
a computer program. Please use “invalid” for this, and reserve the
term “illegal” for activities prohibited by law.
</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
+<p>Please do not write ‘<samp class="samp">()</samp>’ after a
function name just to indicate
+it is a function. <code class="code">foo ()</code> is not a function, it is a
function
call with no arguments.
</p>
<p>Whenever possible, please stick to the active voice, avoiding the
passive, and use the present tense, not the future tense. For
-instance, write “The function <code>foo</code> returns a list containing
-<var>a</var> and <var>b</var>” rather than “A list containing
<var>a</var> and
-<var>b</var> will be returned.” One advantage of the active voice is it
+instance, write “The function <code class="code">foo</code> returns a
list containing
+<var class="var">a</var> and <var class="var">b</var>” rather than
“A list containing <var class="var">a</var> and
+<var class="var">b</var> will be returned.” One advantage of the active
voice is it
requires you to state the subject of the sentence; with the passive
voice, you might omit the subject, which leads to vagueness.
</p>
<p>It is proper to use the future tense when grammar demands it, as in,
-“If you type <kbd>x</kbd>, the computer will self-destruct in 10
+“If you type <kbd class="kbd">x</kbd>, the computer will self-destruct
in 10
seconds.”
</p>
<hr>
-<a name="Doc-Strings-and-Manuals"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Doc-Strings-and-Manuals">
+<div class="nav-panel">
<p>
-Next: <a href="#Manual-Structure-Details" accesskey="n" rel="next">Manual
Structure Details</a>, Previous: <a href="#GNU-Manuals" accesskey="p"
rel="prev">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>
+Next: <a href="#Manual-Structure-Details" accesskey="n" rel="next">Manual
Structure Details</a>, Previous: <a href="#GNU-Manuals" accesskey="p"
rel="prev">GNU Manuals</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documenting Programs</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>
+<h3 class="section" id="Doc-Strings-and-Manuals-1"><span>6.2 Doc Strings and
Manuals<a class="copiable-link" href="#Doc-Strings-and-Manuals-1">
¶</a></span></h3>
<p>Some programming systems, such as Emacs, provide a documentation string
for each function, command or variable. You may be tempted to write a
@@ -4333,14 +4267,14 @@
is to use them as a source of information for writing good text.
</p>
<hr>
-<a name="Manual-Structure-Details"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Manual-Structure-Details">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="#License-for-Manuals" accesskey="n" rel="next">License for
Manuals</a>, Previous: <a href="#Doc-Strings-and-Manuals" accesskey="p"
rel="prev">Doc Strings and Manuals</a>, Up: <a href="#Documentation"
accesskey="u" rel="up">Documenting Programs</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>
+<h3 class="section" id="Manual-Structure-Details-1"><span>6.3 Manual Structure
Details<a class="copiable-link" href="#Manual-Structure-Details-1">
¶</a></span></h3>
+<a class="index-entry-id" id="index-manual-structure"></a>
<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
@@ -4349,10 +4283,10 @@
number for the manual in both of these places.
</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
+‘<samp class="samp"><var class="var">program</var>
Invocation</samp>’ or ‘<samp class="samp">Invoking <var
class="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>@example</samp>’
+would look for in a man page). Start with an ‘<samp
class="samp">@example</samp>’
containing a template for all the options and arguments that the program
uses.
</p>
@@ -4360,7 +4294,7 @@
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>
-<p>The ‘<samp>--usage</samp>’ feature of the Info reader looks for
such a node
+<p>The ‘<samp class="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>
@@ -4368,14 +4302,14 @@
each program described in the manual.
</p>
<hr>
-<a name="License-for-Manuals"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="License-for-Manuals">
+<div class="nav-panel">
<p>
-Next: <a href="#Manual-Credits" accesskey="n" rel="next">Manual Credits</a>,
Previous: <a href="#Manual-Structure-Details" accesskey="p" rel="prev">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>
+Next: <a href="#Manual-Credits" accesskey="n" rel="next">Manual Credits</a>,
Previous: <a href="#Manual-Structure-Details" accesskey="p" rel="prev">Manual
Structure Details</a>, Up: <a href="#Documentation" accesskey="u"
rel="up">Documenting Programs</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>
+<h3 class="section" id="License-for-Manuals-1"><span>6.4 License for Manuals<a
class="copiable-link" href="#License-for-Manuals-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-license-for-manuals"></a>
<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
@@ -4383,7 +4317,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.
</p>
-<p>See <a
href="https://www.gnu.org/copyleft/fdl-howto.html";>https://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
+<p>See <a class="uref"
href="https://www.gnu.org/copyleft/fdl-howto.html";>https://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
of how to employ the GFDL.
</p>
<p>Note that it is not obligatory to include a copy of the GNU GPL or GNU
@@ -4393,14 +4327,14 @@
the program’s license, it is probably better not to include it.
</p>
<hr>
-<a name="Manual-Credits"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Manual-Credits">
+<div class="nav-panel">
<p>
-Next: <a href="#Printed-Manuals" accesskey="n" rel="next">Printed Manuals</a>,
Previous: <a href="#License-for-Manuals" accesskey="p" rel="prev">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>
+Next: <a href="#Printed-Manuals" accesskey="n" rel="next">Printed Manuals</a>,
Previous: <a href="#License-for-Manuals" accesskey="p" rel="prev">License for
Manuals</a>, Up: <a href="#Documentation" accesskey="u" rel="up">Documenting
Programs</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>
+<h3 class="section" id="Manual-Credits-1"><span>6.5 Manual Credits<a
class="copiable-link" href="#Manual-Credits-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-credits-for-manuals"></a>
<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
@@ -4408,54 +4342,54 @@
company as an author.
</p>
<hr>
-<a name="Printed-Manuals"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Printed-Manuals">
+<div class="nav-panel">
<p>
-Next: <a href="#NEWS-File" accesskey="n" rel="next">NEWS File</a>, Previous:
<a href="#Manual-Credits" accesskey="p" rel="prev">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>
+Next: <a href="#NEWS-File" accesskey="n" rel="next">The NEWS File</a>,
Previous: <a href="#Manual-Credits" accesskey="p" rel="prev">Manual
Credits</a>, Up: <a href="#Documentation" accesskey="u" rel="up">Documenting
Programs</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>
+<h3 class="section" id="Printed-Manuals-1"><span>6.6 Printed Manuals<a
class="copiable-link" href="#Printed-Manuals-1"> ¶</a></span></h3>
<p>The FSF publishes some GNU manuals in printed form. To encourage sales
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
-<a
href="https://www.gnu.org/order/order.html";>https://www.gnu.org/order/order.html</a>.
This should not be included
+<a class="url"
href="https://www.gnu.org/order/order.html";>https://www.gnu.org/order/order.html</a>.
This should not be included
in the printed manual, though, because there it is redundant.
</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>
<hr>
-<a name="NEWS-File"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="NEWS-File">
+<div class="nav-panel">
<p>
-Next: <a href="#Change-Logs" accesskey="n" rel="next">Change Logs</a>,
Previous: <a href="#Printed-Manuals" accesskey="p" rel="prev">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>
+Next: <a href="#Change-Logs" accesskey="n" rel="next">Change Logs</a>,
Previous: <a href="#Printed-Manuals" accesskey="p" rel="prev">Printed
Manuals</a>, Up: <a href="#Documentation" accesskey="u" rel="up">Documenting
Programs</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>
+<h3 class="section" id="The-NEWS-File"><span>6.7 The NEWS File<a
class="copiable-link" href="#The-NEWS-File"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-NEWS-file"></a>
<p>In addition to its manual, the package should have a file named
-<samp>NEWS</samp> which contains a list of user-visible changes worth
+<samp class="file">NEWS</samp> 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.
</p>
-<p>If the <samp>NEWS</samp> file gets very long, move some of the older items
-into a file named <samp>ONEWS</samp> and put a note at the end referring the
+<p>If the <samp class="file">NEWS</samp> file gets very long, move some of the
older items
+into a file named <samp class="file">ONEWS</samp> and put a note at the end
referring the
user to that file.
</p>
<hr>
-<a name="Change-Logs"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Change-Logs">
+<div class="nav-panel">
<p>
-Next: <a href="#Man-Pages" accesskey="n" rel="next">Man Pages</a>, Previous:
<a href="#NEWS-File" accesskey="p" rel="prev">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>
+Next: <a href="#Man-Pages" accesskey="n" rel="next">Man Pages</a>, Previous:
<a href="#NEWS-File" accesskey="p" rel="prev">The NEWS File</a>, Up: <a
href="#Documentation" accesskey="u" rel="up">Documenting Programs</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>
+<h3 class="section" id="Change-Logs-1"><span>6.8 Change Logs<a
class="copiable-link" href="#Change-Logs-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-change-logs"></a>
<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
@@ -4466,39 +4400,39 @@
history of how the conflicting concepts arose, who they came from, and
why the conflicting changes were made.
</p>
-<a name="index-software-forensics_002c-and-change-logs"></a>
+<a class="index-entry-id"
id="index-software-forensics_002c-and-change-logs"></a>
<p>Therefore, change logs should be detailed enough and accurate enough
-to provide the information commonly required for such <em>software
+to provide the information commonly required for such <em class="dfn">software
forensics</em>. Specifically, change logs should make finding answers to
the following questions easy:
</p>
-<ul>
-<li> What changes affected a particular source file?
+<ul class="itemize mark-bullet">
+<li>What changes affected a particular source file?
-</li><li> Was a particular source file renamed or moved, and if so, as part of
+</li><li>Was a particular source file renamed or moved, and if so, as part of
what change?
-</li><li> What changes affected a given function or macro or definition of a
+</li><li>What changes affected a given function or macro or definition of a
data structure?
-</li><li> Was a function (or a macro or the definition of a data structure)
+</li><li>Was a function (or a macro or the definition of a data structure)
renamed or moved from another file, and if so, as part of which
change?
-</li><li> What changes deleted a function (or macro or data structure)?
+</li><li>What changes deleted a function (or macro or data structure)?
-</li><li> What was the rationale for a given change, and what were its main
+</li><li>What was the rationale for a given change, and what were its main
ideas?
-</li><li> Is there any additional information regarding the change, and if so,
+</li><li>Is there any additional information regarding the change, and if so,
where can it be found?
</li></ul>
-<a name="index-VCS"></a>
-<a name="index-version-control-system_002c-for-keeping-change-logs"></a>
+<a class="index-entry-id" id="index-VCS"></a>
+<a class="index-entry-id"
id="index-version-control-system_002c-for-keeping-change-logs"></a>
<p>Historically, change logs were maintained on specially formatted
files. Nowadays, projects commonly keep their source files under a
-<em>version control system</em> (VCS), such as Git,
+<em class="dfn">version control system</em> (VCS), such as Git,
Subversion, or Mercurial. If the VCS repository is publicly
accessible, and changes are committed to it separately (one commit for
each logical changeset) and record the authors of each change, then
@@ -4515,62 +4449,56 @@
still consider providing them in the release tarballs, for the benefit
of users who’d like to review the change logs without accessing the
project’s VCS repository. Scripts exist that can produce
-<samp>ChangeLog</samp> files from the VCS logs; for example, the
-<samp>gitlog-to-changelog</samp> script, which is part of Gnulib, can do
-that for Git repositories. In Emacs, the command <kbd>C-x v a</kbd>
-(<code>vc-update-change-log</code>) does the job of incrementally updating a
-<samp>ChangeLog</samp> file from the VCS logs.
+<samp class="file">ChangeLog</samp> files from the VCS logs; for example, the
+<samp class="file">gitlog-to-changelog</samp> script, which is part of Gnulib,
can do
+that for Git repositories. In Emacs, the command <kbd class="kbd">C-x v
a</kbd>
+(<code class="code">vc-update-change-log</code>) does the job of incrementally
updating a
+<samp class="file">ChangeLog</samp> file from the VCS logs.
</p>
-<p>If separate change log files <em>are</em> maintained, they are normally
-called <samp>ChangeLog</samp>, and each such file covers an entire
+<p>If separate change log files <em class="emph">are</em> maintained, they are
normally
+called <samp class="file">ChangeLog</samp>, and each such file covers an entire
directory. Each directory can have its own change log file, or a
directory can use the change log of its parent directory—it’s up to
you.
</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="mini-toc">
+<li><a href="#Change-Log-Concepts" accesskey="1">Change Log Concepts and
Conventions</a></li>
+<li><a href="#Style-of-Change-Logs" accesskey="2">Style of Change Logs</a></li>
+<li><a href="#Simple-Changes" accesskey="3">Simple Changes</a></li>
+<li><a href="#Conditional-Changes" accesskey="4">Conditional Changes</a></li>
+<li><a href="#Indicating-the-Part-Changed" accesskey="5">Indicating the Part
Changed</a></li>
+</ul>
<hr>
-<a name="Change-Log-Concepts"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Change-Log-Concepts">
+<div class="nav-panel">
<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-and-Conventions"></a>
-<h4 class="subsection">6.8.1 Change Log Concepts and Conventions</h4>
+<h4 class="subsection" id="Change-Log-Concepts-and-Conventions"><span>6.8.1
Change Log Concepts and Conventions<a class="copiable-link"
href="#Change-Log-Concepts-and-Conventions"> ¶</a></span></h4>
-<a name="index-changeset_002c-in-a-change-log"></a>
-<a name="index-batch-of-changes_002c-in-a-change-log"></a>
+<a class="index-entry-id" id="index-changeset_002c-in-a-change-log"></a>
+<a class="index-entry-id" id="index-batch-of-changes_002c-in-a-change-log"></a>
<p>You can think of the change log as a conceptual “undo list”
which
states how earlier versions were different from the current version.
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. Each <em>entry</em> in
+explanation of how the earlier version differed. Each <em
class="dfn">entry</em> in
a change log describes either an individual change or the smallest
-batch of changes that belong together, also known as a <em>changeset</em>.
+batch of changes that belong together, also known as a <em
class="dfn">changeset</em>.
</p>
-<a name="index-title_002c-change-log-entry"></a>
-<a name="index-header-line_002c-change-log-entry"></a>
-<p>It is a good idea to start the change log entry with a <em>header
+<a class="index-entry-id" id="index-title_002c-change-log-entry"></a>
+<a class="index-entry-id" id="index-header-line_002c-change-log-entry"></a>
+<p>It is a good idea to start the change log entry with a <em
class="dfn">header
line</em>: a single line that is a complete sentence which summarizes the
changeset. If you keep the change log in a VCS, this
should be a requirement, as VCS commands that show the
-change log in abbreviated form, such as <kbd>git log --oneline</kbd>, treat
-the header line specially. (In a <samp>ChangeLog</samp> file, the header
+change log in abbreviated form, such as <kbd class="kbd">git log
--oneline</kbd>, treat
+the header line specially. (In a <samp class="file">ChangeLog</samp> file,
the header
line follows a line that says who was the author of the change and
when it was installed.)
</p>
-<a name="index-description_002c-change-log-entry"></a>
+<a class="index-entry-id" id="index-description_002c-change-log-entry"></a>
<p>Follow the change log entry’s header line with a description of the
overall change. This should be as long as needed to give a clear
description. Pay special attention to aspects of the changeset not
@@ -4586,7 +4514,7 @@
<p>The best place to explain how parts of the new code work with other code
is in comments in the code, not in the change log.
</p>
-<p>If you think that a change calls for explanation of <em>why</em> the
+<p>If you think that a change calls for explanation of <em
class="emph">why</em> the
change was needed—that is, what problem the old code had such that
it required this change—you’re probably right. Please put the
explanation in comments in the code, where people will see it whenever
@@ -4603,9 +4531,9 @@
<p>Following the free-text description of the change, it is a good idea
to give a list of names of the entities or definitions that you
changed, according to the files they are in, and what was changed in
-each one. See <a href="#Style-of-Change-Logs">Style of Change Logs</a>. If a
project uses a modern
+each one. See <a class="xref" href="#Style-of-Change-Logs">Style of Change
Logs</a>. If a project uses a modern
VCS to keep the change log information, as described in
-<a href="#Change-Logs">Change Logs</a>, explicitly listing the files and
functions that
+<a class="ref" href="#Change-Logs">Change Logs</a>, explicitly listing the
files and functions that
were changed is not strictly necessary, and in some cases (like
identical mechanical changes in many places) even tedious. It is up
to you to decide whether to allow your project’s developers to omit
@@ -4614,8 +4542,8 @@
However, while making this decision, please consider the following
benefits of providing the list of changed entities with each change:
</p>
-<ul>
-<li> Generation of useful <samp>ChangeLog</samp> files from VCS logs
+<ul class="itemize mark-bullet">
+<li>Generation of useful <samp class="file">ChangeLog</samp> files from VCS
logs
becomes more difficult if the change log entries don’t list the
modified functions/macros, because VCS commands cannot
reliably reproduce their names from the commit information alone. For
@@ -4625,24 +4553,24 @@
function defined before the one being modified), so using those diffs
to glean the names of the modified functions will produce inaccurate
results. You will need to use specialized scripts, such as gnulib’s
-<samp>vcs-to-changelog.py</samp>, mentioned below, to solve these
+<samp class="file">vcs-to-changelog.py</samp>, mentioned below, to solve these
difficulties, and make sure it supports the source languages used by
your project.
-</li><li> While modern VCS commands, such as Git’s <kbd>git log -L</kbd>
-and <kbd>git log -G</kbd>, provide powerful means for finding changes that
+</li><li>While modern VCS commands, such as Git’s <kbd class="kbd">git
log -L</kbd>
+and <kbd class="kbd">git log -G</kbd>, provide powerful means for finding
changes that
affected a certain function or macro or data structure (and thus might
-make <samp>ChangeLog</samp> files unnecessary if you have the repository
-available), they can sometimes fail. For example, <kbd>git log -L</kbd>
+make <samp class="file">ChangeLog</samp> files unnecessary if you have the
repository
+available), they can sometimes fail. For example, <kbd class="kbd">git log
-L</kbd>
doesn’t support syntax of some programming languages out of the box.
Mentioning the modified functions/macros explicitly allows finding the
related changes simply and reliably.
-</li><li> Some VCS commands have difficulties or limitations when
+</li><li>Some VCS commands have difficulties or limitations when
tracking changes across file moves or renames. Again, if the entities
are mentioned explicitly, those difficulties can be overcome.
-</li><li> Users that review changes using the generated <samp>ChangeLog</samp>
files
+</li><li>Users that review changes using the generated <samp
class="file">ChangeLog</samp> files
may not have the repository and the VCS commands available
to them. Naming the modified entities alleviates that problem.
</li></ul>
@@ -4652,38 +4580,38 @@
recommend to include them whenever possible and practical.
</p>
<p>It is also possible to generate the lists naming the modified entities
-by running a script. One such script is <samp>mklog.py</samp> (written in
-Python 3); it is used by the <code>GCC</code> project. Gnulib provides
-another variant of such a script, called <samp>vcs-to-changelog.py</samp>,
-part of the <code>vcs-to-changelog</code> module. Note that these scripts
+by running a script. One such script is <samp class="file">mklog.py</samp>
(written in
+Python 3); it is used by the <code class="code">GCC</code> project. Gnulib
provides
+another variant of such a script, called <samp
class="file">vcs-to-changelog.py</samp>,
+part of the <code class="code">vcs-to-changelog</code> module. Note that
these scripts
currently support fewer programming languages than the manual commands
-provided by Emacs (see <a href="#Style-of-Change-Logs">Style of Change
Logs</a>). Therefore, the
-above mentioned method of generating the <code>ChangeLog</code> file from
+provided by Emacs (see <a class="pxref" href="#Style-of-Change-Logs">Style of
Change Logs</a>). Therefore, the
+above mentioned method of generating the <code class="code">ChangeLog</code>
file from
the VCS commit history, for instance via the
-<code>gitlog-to-changelog</code> script, usually gives better
+<code class="code">gitlog-to-changelog</code> script, usually gives better
results—provided that the contributors stick to providing good
commit messages.
</p>
<hr>
-<a name="Style-of-Change-Logs"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Style-of-Change-Logs">
+<div class="nav-panel">
<p>
-Next: <a href="#Simple-Changes" accesskey="n" rel="next">Simple Changes</a>,
Previous: <a href="#Change-Log-Concepts" accesskey="p" rel="prev">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>
+Next: <a href="#Simple-Changes" accesskey="n" rel="next">Simple Changes</a>,
Previous: <a href="#Change-Log-Concepts" accesskey="p" rel="prev">Change Log
Concepts and Conventions</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>
+<h4 class="subsection" id="Style-of-Change-Logs-1"><span>6.8.2 Style of Change
Logs<a class="copiable-link" href="#Style-of-Change-Logs-1">
¶</a></span></h4>
+<a class="index-entry-id" id="index-change-logs_002c-style"></a>
<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.) Keep in mind that the line which shows the date of
the change and the author’s name and email address is needed only in a
-separate <samp>ChangeLog</samp> file, not when the change logs are kept in a
+separate <samp class="file">ChangeLog</samp> file, not when the change logs
are kept in a
VCS.
</p>
<div class="example">
-<pre class="example">2019-08-29 Noam Postavsky <npostavs@gmail.com>
+<pre class="example-preformatted">2019-08-29 Noam Postavsky
<npostavs@gmail.com>
Handle completely undecoded input in term (Bug#29918)
@@ -4720,9 +4648,9 @@
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.
+names by writing ‘<samp class="samp">* register.el
({insert,jump-to}-register)</samp>’;
+this is not a good idea, since searching for <code
class="code">jump-to-register</code> or
+<code class="code">insert-register</code> would not find that entry.
</p>
<p>Separate unrelated change log entries with blank lines. Don’t put
blank lines between individual changes of an entry. You can omit the
@@ -4730,18 +4658,18 @@
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>’. This makes highlighting in Emacs work better.
+‘<samp class="samp">)</samp>’, rather than ‘<samp
class="samp">,</samp>’, and opening the continuation with
+‘<samp class="samp">(</samp>’. This makes highlighting in Emacs
work better.
Here is an example:
</p>
<div class="example">
-<pre class="example">* src/keyboard.c (menu_bar_items, tool_bar_items)
+<pre class="example-preformatted">* src/keyboard.c (menu_bar_items,
tool_bar_items)
(Fexecute_extended_command): Deal with 'keymap' property.
</pre></div>
-<p>The easiest way to add an entry to <samp>ChangeLog</samp> is with the Emacs
-command <kbd>M-x add-change-log-entry</kbd>, or its variant <kbd>C-x 4 a</kbd>
-(<code>add-change-log-entry-other-window</code>). This automatically
+<p>The easiest way to add an entry to <samp class="file">ChangeLog</samp> is
with the Emacs
+command <kbd class="kbd">M-x add-change-log-entry</kbd>, or its variant <kbd
class="kbd">C-x 4 a</kbd>
+(<code class="code">add-change-log-entry-other-window</code>). This
automatically
collects the name of the changed file and the changed function or
variable, and formats a change log entry according to the conventions
described above, leaving it up to you to describe the changes you made
@@ -4752,7 +4680,7 @@
words, write this:
</p>
<div class="example">
-<pre class="example">2002-07-14 John Doe <jdoe@gnu.org>
+<pre class="example-preformatted">2002-07-14 John Doe <jdoe@gnu.org>
* sewing.c: Make it sew.
</pre></div>
@@ -4760,38 +4688,38 @@
<p>rather than this:
</p>
<div class="example">
-<pre class="example">2002-07-14 Usual Maintainer <usual@gnu.org>
+<pre class="example-preformatted">2002-07-14 Usual Maintainer
<usual@gnu.org>
* sewing.c: Make it sew. Patch by jdoe@gnu.org.
</pre></div>
<p>When committing someone else’s changes into a VCS, use the
VCS features to specify the author. For example, with Git,
-use <kbd>git commit --author=<var>author</var></kbd>.
+use <kbd class="kbd">git commit --author=<var class="var">author</var></kbd>.
</p>
<p>As for the date, that should be the date you applied the change.
(With a VCS, use the appropriate command-line switches,
-e.g., <kbd>git commit --date=<var>date</var></kbd>.)
+e.g., <kbd class="kbd">git commit --date=<var class="var">date</var></kbd>.)
</p>
<p>Modern VCS have commands to apply changes sent via email
-(e.g., Git has <kbd>git am</kbd>); in that case the author of the changeset
+(e.g., Git has <kbd class="kbd">git am</kbd>); in that case the author of the
changeset
and the date it was made will be automatically gleaned from the email
message and recorded in the repository. If the patches are prepared
-with suitable VCS commands, such as <kbd>git format-patch</kbd>,
+with suitable VCS commands, such as <kbd class="kbd">git format-patch</kbd>,
the email message body will also have the original author of the
changeset, so resending or forwarding the message will not interfere
with attributing the changes to their author. Thus, we recommend that
-you request your contributors to use commands such as <kbd>git
+you request your contributors to use commands such as <kbd class="kbd">git
format-patch</kbd> to prepare the patches.
</p>
<hr>
-<a name="Simple-Changes"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Simple-Changes">
+<div class="nav-panel">
<p>
Next: <a href="#Conditional-Changes" accesskey="n" rel="next">Conditional
Changes</a>, Previous: <a href="#Style-of-Change-Logs" accesskey="p"
rel="prev">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>
+<h4 class="subsection" id="Simple-Changes-1"><span>6.8.3 Simple Changes<a
class="copiable-link" href="#Simple-Changes-1"> ¶</a></span></h4>
<p>Certain simple kinds of changes don’t need much detail in the change
log.
@@ -4800,7 +4728,7 @@
own header line:
</p>
<div class="example">
-<pre class="example">2019-08-29 Eli Zaretskii <eliz@gnu.org>
+<pre class="example-preformatted">2019-08-29 Eli Zaretskii
<eliz@gnu.org>
* lisp/simple.el (kill-do-not-save-duplicates): Doc fix. (Bug#36827)
</pre></div>
@@ -4812,7 +4740,7 @@
being called, “All callers changed”—like this:
</p>
<div class="example">
-<pre class="example">* keyboard.c (Fcommand_execute): New arg SPECIAL.
+<pre class="example-preformatted">* keyboard.c (Fcommand_execute): New arg
SPECIAL.
All callers changed.
</pre></div>
@@ -4826,7 +4754,7 @@
repository:
</p>
<div class="example">
-<pre class="example">2019-01-07 Paul Eggert <eggert@cs.ucla.edu>
+<pre class="example-preformatted">2019-01-07 Paul Eggert
<eggert@cs.ucla.edu>
Update copyright year to 2019
@@ -4849,22 +4777,22 @@
manuals.
</p>
<hr>
-<a name="Conditional-Changes"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Conditional-Changes">
+<div class="nav-panel">
<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="prev">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>
+<h4 class="subsection" id="Conditional-Changes-1"><span>6.8.4 Conditional
Changes<a class="copiable-link" href="#Conditional-Changes-1">
¶</a></span></h4>
+<a class="index-entry-id"
id="index-conditional-changes_002c-and-change-logs"></a>
+<a class="index-entry-id" id="index-change-logs_002c-conditional-changes"></a>
<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
+compile-time <code class="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>Makefile.am</samp> files can contain
+interpreter; and Automake <samp class="file">Makefile.am</samp> files can
contain
variable definitions or target declarations that are only to be
considered if a configure-time Automake conditional is true.
</p>
@@ -4874,7 +4802,7 @@
in the change log the conditions for which a change applies.
</p>
<p>Our convention for indicating conditional changes is to use
-<em>square brackets around the name of the condition</em>.
+<em class="emph">square brackets around the name of the condition</em>.
</p>
<p>Conditional changes can happen in numerous scenarios and with many
variations, so here are some examples to help clarify. This first
@@ -4882,7 +4810,7 @@
conditional but do not have an associated function or entity name:
</p>
<div class="example">
-<pre class="example">* xterm.c [SOLARIS2]: Include <string.h>.
+<pre class="example-preformatted">* 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__,
@@ -4894,59 +4822,60 @@
self-evident.
</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:
+conditional: the C macro <code class="code">FRAME_WINDOW_P</code> is defined
(and used)
+only when the macro <code class="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 class="example-preformatted">* frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P):
Macro defined.
</pre></div>
-<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
class="code">init_display</code>,
whose definition as a whole is unconditional, but the changes
-themselves are contained in a ‘<samp>#ifdef HAVE_LIBNCURSES</samp>’
+themselves are contained in a ‘<samp class="samp">#ifdef
HAVE_LIBNCURSES</samp>’
conditional:
</p>
<div class="example">
-<pre class="example">* dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call
tgetent.
+<pre class="example-preformatted">* dispnew.c (init_display)
[HAVE_LIBNCURSES]: If X, call tgetent.
</pre></div>
<p>Finally, here is an entry for a change that takes effect only when
-a certain macro is <em>not</em> defined:
+a certain macro is <em class="emph">not</em> defined:
</p>
<div class="example">
-<pre class="example">* host.c (gethostname) [!HAVE_SOCKETS]: Replace with
winsock version.
+<pre class="example-preformatted">* host.c (gethostname) [!HAVE_SOCKETS]:
Replace with winsock version.
</pre></div>
<hr>
-<a name="Indicating-the-Part-Changed"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Indicating-the-Part-Changed">
+<div class="nav-panel">
<p>
Previous: <a href="#Conditional-Changes" accesskey="p" rel="prev">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>
+<h4 class="subsection" id="Indicating-the-Part-Changed-1"><span>6.8.5
Indicating the Part Changed<a class="copiable-link"
href="#Indicating-the-Part-Changed-1"> ¶</a></span></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:
+for a change in the part of the function <code
class="code">sh-while-getopts</code> that
+deals with <code class="code">sh</code> commands:
</p>
<div class="example">
-<pre class="example">* progmodes/sh-script.el (sh-while-getopts) <sh>:
Handle case that
+<pre class="example-preformatted">* progmodes/sh-script.el (sh-while-getopts)
<sh>: Handle case that
user-specified option string is empty.
</pre></div>
<hr>
-<a name="Man-Pages"></a>
-<div class="header">
+</div>
+</div>
+<div class="section-level-extent" id="Man-Pages">
+<div class="nav-panel">
<p>
-Next: <a href="#Reading-other-Manuals" accesskey="n" rel="next">Reading other
Manuals</a>, Previous: <a href="#Change-Logs" accesskey="p" rel="prev">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>
+Next: <a href="#Reading-other-Manuals" accesskey="n" rel="next">Reading other
Manuals</a>, Previous: <a href="#Change-Logs" accesskey="p" rel="prev">Change
Logs</a>, Up: <a href="#Documentation" accesskey="u" rel="up">Documenting
Programs</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>
+<h3 class="section" id="Man-Pages-1"><span>6.9 Man Pages<a
class="copiable-link" href="#Man-Pages-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-man-pages"></a>
<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.
@@ -4978,25 +4907,25 @@
</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="http://www.gnu.org/prep/maintain/maintain.html#License-Notices-for-Other-Files";>License
Notices for Other Files</a> in <cite>Information for GNU
+(see <a data-manual="maintain"
href="https://www.gnu.org/prep/maintain/maintain.html#License-Notices-for-Other-Files";>License
Notices for Other Files</a> in <cite class="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>).
+they can be considered true manuals, use the GFDL (see <a class="pxref"
href="#License-for-Manuals">License for Manuals</a>).
</p>
<p>Finally, the GNU help2man program
-(<a
href="https://www.gnu.org/software/help2man/";>https://www.gnu.org/software/help2man/</a>)
is one way to automate
-generation of a man page, in this case from <samp>--help</samp> output.
+(<a class="uref"
href="https://www.gnu.org/software/help2man/";>https://www.gnu.org/software/help2man/</a>)
is one way to automate
+generation of a man page, in this case from <samp class="option">--help</samp>
output.
This is sufficient in many cases.
</p>
<hr>
-<a name="Reading-other-Manuals"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Reading-other-Manuals">
+<div class="nav-panel">
<p>
-Previous: <a href="#Man-Pages" accesskey="p" rel="prev">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>
+Previous: <a href="#Man-Pages" accesskey="p" rel="prev">Man Pages</a>, Up: <a
href="#Documentation" accesskey="u" rel="up">Documenting Programs</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>
+<h3 class="section" id="Reading-other-Manuals-1"><span>6.10 Reading other
Manuals<a class="copiable-link" href="#Reading-other-Manuals-1">
¶</a></span></h3>
<p>There may be non-free books or documentation files that describe the
program you are documenting.
@@ -5011,14 +4940,15 @@
with the FSF about the individual case.
</p>
<hr>
-<a name="Managing-Releases"></a>
-<div class="header">
+</div>
+</div>
+<div class="chapter-level-extent" id="Managing-Releases">
+<div class="nav-panel">
<p>
-Next: <a href="#References" accesskey="n" rel="next">References</a>, Previous:
<a href="#Documentation" accesskey="p" rel="prev">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>
+Next: <a href="#References" accesskey="n" rel="next">References to Non-Free
Software and Documentation</a>, Previous: <a href="#Documentation"
accesskey="p" rel="prev">Documenting Programs</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Coding Standards</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>
+<h2 class="chapter" id="The-Release-Process"><span>7 The Release Process<a
class="copiable-link" href="#The-Release-Process"> ¶</a></span></h2>
+<a class="index-entry-id" id="index-releasing"></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
@@ -5028,191 +4958,187 @@
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="mini-toc">
+<li><a href="#Configuration" accesskey="1">How Configuration Should
Work</a></li>
+<li><a href="#Makefile-Conventions" accesskey="2">Makefile Conventions</a></li>
+<li><a href="#Releases" accesskey="3">Making Releases</a></li>
+</ul>
<hr>
-<a name="Configuration"></a>
-<div class="header">
+<div class="section-level-extent" id="Configuration">
+<div class="nav-panel">
<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>
+Next: <a href="#Makefile-Conventions" accesskey="n" rel="next">Makefile
Conventions</a>, Up: <a href="#Managing-Releases" accesskey="u" rel="up">The
Release Process</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>
+<h3 class="section" id="How-Configuration-Should-Work"><span>7.1 How
Configuration Should Work<a class="copiable-link"
href="#How-Configuration-Should-Work"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-program-configuration"></a>
-<a name="index-configure"></a>
+<a class="index-entry-id" id="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
+<code class="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
+The <code class="code">configure</code> script must record the configuration
options so
that they affect compilation.
</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="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>),
+<code class="code">configure</code> script in GNU packages. Many packages
implement it
+using GNU Autoconf (see <a data-manual="autoconf"
href="https://www.gnu.org/software/autoconf/manual/autoconf.html#Top";>Introduction</a>
in <cite class="cite">Autoconf</cite>)
+and/or GNU Automake (see <a data-manual="automake"
href="https://www.gnu.org/software/automake/manual/automake.html#Top";>Introduction</a>
in <cite class="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
+you like; for instance, by making <code class="code">configure</code> be a
wrapper around
a completely different configuration system.
</p>
-<p>Another way for the <code>configure</code> script to operate is to make a
-link from a standard name such as <samp>config.h</samp> to the proper
+<p>Another way for the <code class="code">configure</code> script to operate
is to make a
+link from a standard name such as <samp class="file">config.h</samp> 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>config.h</samp>. This is so that people won’t be able to build the
+the distribution should <em class="emph">not</em> contain a file named
+<samp class="file">config.h</samp>. This is so that people won’t be
able to build the
program without configuring it first.
</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>Makefile</samp>. Instead, it should include a file
<samp>Makefile.in</samp> which
+<p>Another thing that <code class="code">configure</code> can do is to edit
the Makefile. If
+you do this, the distribution should <em class="emph">not</em> contain a file
named
+<samp class="file">Makefile</samp>. Instead, it should include a file <samp
class="file">Makefile.in</samp> 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>
-<p>If <code>configure</code> does write the <samp>Makefile</samp>, then
<samp>Makefile</samp>
-should have a target named <samp>Makefile</samp> which causes
<code>configure</code>
+<p>If <code class="code">configure</code> does write the <samp
class="file">Makefile</samp>, then <samp class="file">Makefile</samp>
+should have a target named <samp class="file">Makefile</samp> which causes
<code class="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>Makefile</samp>.
+time. The files that <code class="code">configure</code> reads should be
listed as
+dependencies of <samp class="file">Makefile</samp>.
</p>
-<p>All the files which are output from the <code>configure</code> script should
+<p>All the files which are output from the <code class="code">configure</code>
script should
have comments at the beginning stating that they were generated
-automatically using <code>configure</code>. This is so that users won’t
think
+automatically using <code class="code">configure</code>. This is so that
users won’t think
of trying to edit them by hand.
</p>
-<p>The <code>configure</code> script should write a file named
<samp>config.status</samp>
+<p>The <code class="code">configure</code> script should write a file named
<samp class="file">config.status</samp>
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>
-<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
+<p>The <code class="code">configure</code> script should accept an option of
the form
+‘<samp class="samp">--srcdir=<var
class="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>
-<p>If the user does not specify ‘<samp>--srcdir</samp>’, then
<code>configure</code> should
-check both <samp>.</samp> and <samp>..</samp> to see if it can find the
sources. If
+<p>If the user does not specify ‘<samp
class="samp">--srcdir</samp>’, then <code class="code">configure</code>
should
+check both <samp class="file">.</samp> and <samp class="file">..</samp> 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>
-<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
+<p>Usually the easy way to support ‘<samp
class="samp">--srcdir</samp>’ is by editing a
+definition of <code class="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.
+possible, <code class="code">configure</code> can add to the Makefile a
variable named
+<code class="code">srcdir</code> whose value is precisely the specified
directory.
</p>
-<p>In addition, the ‘<samp>configure</samp>’ script should take
options
+<p>In addition, the ‘<samp class="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:
+(see <a class="pxref" href="#Directory-Variables">Variables for Installation
Directories</a>). Here is the list:
</p>
<div class="example">
-<pre class="example">--prefix --exec-prefix --bindir --sbindir --libexecdir
--sysconfdir
+<pre class="example-preformatted">--prefix --exec-prefix --bindir --sbindir
--libexecdir --sysconfdir
--sharedstatedir --localstatedir --runstatedir
--libdir --includedir --oldincludedir
--datarootdir --datadir --infodir --localedir --mandir --docdir
--htmldir --dvidir --pdfdir --psdir
</pre></div>
-<p>The <code>configure</code> script should also take an argument which
specifies the
+<p>The <code class="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:
</p>
<div class="example">
-<pre class="example"><var>cpu</var>-<var>company</var>-<var>system</var>
+<pre class="example-preformatted"><var class="var">cpu</var>-<var
class="var">company</var>-<var class="var">system</var>
</pre></div>
<p>For example, an Athlon-based GNU/Linux system might be
-‘<samp>i686-pc-linux-gnu</samp>’.
+‘<samp class="samp">i686-pc-linux-gnu</samp>’.
</p>
-<p>The <code>configure</code> script needs to be able to decode all plausible
+<p>The <code class="code">configure</code> script needs to be able to decode
all plausible
alternatives for how to describe a machine. Thus,
-‘<samp>athlon-pc-gnu/linux</samp>’ would be a valid alias. There
is a shell
+‘<samp class="samp">athlon-pc-gnu/linux</samp>’ would be a valid
alias. There is a shell
script called
-<a
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.sub";><samp>config.sub</samp></a>
that you can use as a subroutine to validate system
+<a class="uref"
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.sub";><samp
class="file">config.sub</samp></a> that you can use as a subroutine to validate
system
types and canonicalize aliases.
</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
+<p>The <code class="code">configure</code> script should also take the option
+<samp class="option">--build=<var class="var">buildtype</var></samp>, which
should be equivalent to a
+plain <var class="var">buildtype</var> argument. For example, ‘<samp
class="samp">configure
+--build=i686-pc-linux-gnu</samp>’ is equivalent to ‘<samp
class="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
+or argument, the <code class="code">configure</code> script should normally
guess it using
the shell script
-<a
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.guess";><samp>config.guess</samp></a>.
+<a class="uref"
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.guess";><samp
class="file">config.guess</samp></a>.
</p>
-<a name="index-optional-features_002c-configure_002dtime"></a>
+<a class="index-entry-id"
id="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:
</p>
-<dl compact="compact">
-<dt>‘<samp>--enable-<var>feature</var><span
class="roman">[</span>=<var>parameter</var><span
class="roman">]</span></samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">--enable-<var class="var">feature</var><span
class="r">[</span>=<var class="var">parameter</var><span
class="r">]</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>no</samp>’ should omit <var>feature</var>, if it is built
by default.
+facility called <var class="var">feature</var>. This allows users to choose
which
+optional features to include. Giving an optional <var
class="var">parameter</var> of
+‘<samp class="samp">no</samp>’ should omit <var
class="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
+<p>No ‘<samp class="samp">--enable</samp>’ option should <strong
class="strong">ever</strong> cause one feature to
+replace another. No ‘<samp class="samp">--enable</samp>’ option
should ever substitute one
useful behavior for another useful behavior. The only proper use for
-‘<samp>--enable</samp>’ is for questions of whether to build part
of the program
+‘<samp class="samp">--enable</samp>’ is for questions of whether
to build part of the program
or exclude it.
</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>.
+<dt>‘<samp class="samp">--with-<var
class="var">package</var></samp>’</dt>
+<dd><p>The package <var class="var">package</var> will be installed, so
configure this package
+to work with <var class="var">package</var>.
</p>
-<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>’,
+<p>Possible values of <var class="var">package</var> include
+‘<samp class="samp">gnu-as</samp>’ (or ‘<samp
class="samp">gas</samp>’), ‘<samp
class="samp">gnu-ld</samp>’, ‘<samp
class="samp">gnu-libc</samp>’,
+‘<samp class="samp">gdb</samp>’,
+‘<samp class="samp">x</samp>’,
and
-‘<samp>x-toolkit</samp>’.
+‘<samp class="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>’
+<p>Do not use a ‘<samp class="samp">--with</samp>’ option to
specify the file name to use to
+find certain files. That is outside the scope of what ‘<samp
class="samp">--with</samp>’
options are for.
</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
+<dt>‘<samp class="samp"><var class="var">variable</var>=<var
class="var">value</var></samp>’</dt>
+<dd><p>Set the value of the variable <var class="var">variable</var> to <var
class="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>configure
+build process. For example, the user could issue ‘<samp
class="samp">configure
CFLAGS=-g CXXFLAGS=-g</samp>’ to build with debugging information and
without
the default optimization.
</p>
-<p>Specifying variables as arguments to <code>configure</code>, like this:
+<p>Specifying variables as arguments to <code class="code">configure</code>,
like this:
</p><div class="example">
-<pre class="example">./configure CC=gcc
+<pre class="example-preformatted">./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 class="example-preformatted">CC=gcc ./configure
</pre></div>
<p>as it helps to recreate the same configuration later with
-<samp>config.status</samp>. However, both methods should be supported.
+<samp class="file">config.status</samp>. However, both methods should be
supported.
</p></dd>
</dl>
-<p>All <code>configure</code> scripts should accept all of the
“detail”
+<p>All <code class="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>--with-</samp>’ or
-‘<samp>--enable-</samp>’. This is so users will be able to
configure an
+should accept any option that starts with ‘<samp
class="samp">--with-</samp>’ or
+‘<samp class="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>
-<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
+<p>You will note that the categories ‘<samp
class="samp">--with-</samp>’ and ‘<samp
class="samp">--enable-</samp>’
+are narrow: they <strong class="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.
@@ -5221,150 +5147,141 @@
cross-compilation. In such a case, the host and target machines for the
program may be different.
</p>
-<p>The <code>configure</code> script should normally treat the specified type
of
+<p>The <code class="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>
<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
+type, use the configure option <samp class="option">--host=<var
class="var">hosttype</var></samp>, where
+<var class="var">hosttype</var> uses the same syntax as <var
class="var">buildtype</var>. The host type
normally defaults to the build type.
</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>--target=<var>targettype</var></samp>’. The syntax
for
-<var>targettype</var> is the same as for the host type. So the command would
+option ‘<samp class="samp">--target=<var
class="var">targettype</var></samp>’. The syntax for
+<var class="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 class="example-preformatted">./configure --host=<var
class="var">hosttype</var> --target=<var class="var">targettype</var>
</pre></div>
<p>The target type normally defaults to the host type.
Programs for which cross-operation is not meaningful need not accept the
-‘<samp>--target</samp>’ option, because configuring an entire
operating system for
+‘<samp class="samp">--target</samp>’ option, because configuring
an entire operating system for
cross-operation is not a meaningful operation.
</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
+your program is set up to do this, your <code class="code">configure</code>
script can simply
ignore most of its arguments.
</p>
<hr>
-<a name="Makefile-Conventions"></a>
-<div class="header">
+</div>
+<div class="section-level-extent" id="Makefile-Conventions">
+<div class="nav-panel">
<p>
-Next: <a href="#Releases" accesskey="n" rel="next">Releases</a>, Previous: <a
href="#Configuration" accesskey="p" rel="prev">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>
+Next: <a href="#Releases" accesskey="n" rel="next">Making Releases</a>,
Previous: <a href="#Configuration" accesskey="p" rel="prev">How Configuration
Should Work</a>, Up: <a href="#Managing-Releases" accesskey="u" rel="up">The
Release Process</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>
+<h3 class="section chapter-level-set-section"
id="Makefile-Conventions-1"><span>7.2 Makefile Conventions<a
class="copiable-link" href="#Makefile-Conventions-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-makefile_002c-conventions-for"></a>
+<a class="index-entry-id" id="index-conventions-for-makefiles"></a>
+<a class="index-entry-id" id="index-standards-for-makefiles"></a>
<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
-<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>.
+<small class="sc">POSIX</small> and <a data-manual="autoconf"
href="https://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Make";>Portable
Make Programming</a> in <cite class="cite">Autoconf</cite>.
</p>
-<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
‘<samp>install</samp>’
- rule: normal, pre-install and post-install.
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="#Makefile-Basics" accesskey="1">General Conventions for
Makefiles</a></li>
+<li><a href="#Utilities-in-Makefiles" accesskey="2">Utilities in
Makefiles</a></li>
+<li><a href="#Command-Variables" accesskey="3">Variables for Specifying
Commands</a></li>
+<li><a href="#DESTDIR" accesskey="4"><code class="code">DESTDIR</code>:
Support for Staged Installs</a></li>
+<li><a href="#Directory-Variables" accesskey="5">Variables for Installation
Directories</a></li>
+<li><a href="#Standard-Targets" accesskey="6">Standard Targets for
Users</a></li>
+<li><a href="#Install-Command-Categories" accesskey="7">Install Command
Categories</a></li>
+</ul>
<hr>
-<a name="Makefile-Basics"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Makefile-Basics">
+<div class="nav-panel">
<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>
+<h4 class="subsection section-level-set-subsection"
id="General-Conventions-for-Makefiles"><span>7.2.1 General Conventions for
Makefiles<a class="copiable-link" href="#General-Conventions-for-Makefiles">
¶</a></span></h4>
<p>Every Makefile should contain this line:
</p>
<div class="example">
-<pre class="example">SHELL = /bin/sh
+<pre class="example-preformatted">SHELL = /bin/sh
</pre></div>
-<p>to avoid trouble on systems where the <code>SHELL</code> variable might be
+<p>to avoid trouble on systems where the <code class="code">SHELL</code>
variable might be
inherited from the environment. (This is never a problem with GNU
-<code>make</code>.)
+<code class="code">make</code>.)
</p>
-<p>Different <code>make</code> programs have incompatible suffix lists and
+<p>Different <code class="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:
+<pre class="example-preformatted">.SUFFIXES:
.SUFFIXES: .c .o
</pre></div>
<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>
-<p>Don’t assume that <samp>.</samp> is in the path for command
execution. When
+<p>Don’t assume that <samp class="file">.</samp> 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>./</samp> if the program is built as
-part of the make or <samp>$(srcdir)/</samp> if the file is an unchanging part
+make, please make sure that it uses <samp class="file">./</samp> if the
program is built as
+part of the make or <samp class="file">$(srcdir)/</samp> if the file is an
unchanging part
of the source code. Without one of these prefixes, the current search
path is used.
</p>
-<p>The distinction between <samp>./</samp> (the <em>build directory</em>) and
-<samp>$(srcdir)/</samp> (the <em>source directory</em>) is important because
-users can build in a separate directory using the
‘<samp>--srcdir</samp>’ option
-to <samp>configure</samp>. A rule of the form:
+<p>The distinction between <samp class="file">./</samp> (the <em
class="dfn">build directory</em>) and
+<samp class="file">$(srcdir)/</samp> (the <em class="dfn">source
directory</em>) is important because
+users can build in a separate directory using the ‘<samp
class="samp">--srcdir</samp>’ option
+to <samp class="file">configure</samp>. A rule of the form:
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.1 : foo.man sedscript
+<div class="example smallexample">
+<pre class="example-preformatted">foo.1 : foo.man sedscript
sed -f sedscript foo.man > foo.1
</pre></div>
<p>will fail when the build directory is not the source directory, because
-<samp>foo.man</samp> and <samp>sedscript</samp> are in the source directory.
+<samp class="file">foo.man</samp> and <samp class="file">sedscript</samp> are
in the source directory.
</p>
-<p>When using GNU <code>make</code>, relying on
‘<samp>VPATH</samp>’ to find the source
+<p>When using GNU <code class="code">make</code>, relying on ‘<samp
class="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>$<</samp>’ will represent the
-source file wherever it is. (Many versions of <code>make</code> set
‘<samp>$<</samp>’
+since the <code class="code">make</code> automatic variable ‘<samp
class="samp">$<</samp>’ will represent the
+source file wherever it is. (Many versions of <code class="code">make</code>
set ‘<samp class="samp">$<</samp>’
only in implicit rules.) A Makefile target like
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.o : bar.c
+<div class="example smallexample">
+<pre class="example-preformatted">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c bar.c -o foo.o
</pre></div>
<p>should instead be written as
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.o : bar.c
+<div class="example smallexample">
+<pre class="example-preformatted">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c $< -o $@
</pre></div>
-<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
+<p>in order to allow ‘<samp class="samp">VPATH</samp>’ to work
correctly. When the target has
+multiple dependencies, using an explicit ‘<samp
class="samp">$(srcdir)</samp>’ is the easiest
way to make the rule work well. For example, the target above for
-<samp>foo.1</samp> is best written as:
+<samp class="file">foo.1</samp> is best written as:
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.1 : foo.man sedscript
+<div class="example smallexample">
+<pre class="example-preformatted">foo.1 : foo.man sedscript
sed -f $(srcdir)/sedscript $(srcdir)/foo.man > $@
</pre></div>
@@ -5381,68 +5298,68 @@
in any way.
</p>
<p>Try to make the build and installation targets, at least (and all their
-subtargets) work correctly with a parallel <code>make</code>.
+subtargets) work correctly with a parallel <code class="code">make</code>.
</p>
<hr>
-<a name="Utilities-in-Makefiles"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Utilities-in-Makefiles">
+<div class="nav-panel">
<p>
-Next: <a href="#Command-Variables" accesskey="n" rel="next">Command
Variables</a>, Previous: <a href="#Makefile-Basics" accesskey="p"
rel="prev">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>
+Next: <a href="#Command-Variables" accesskey="n" rel="next">Variables for
Specifying Commands</a>, Previous: <a href="#Makefile-Basics" accesskey="p"
rel="prev">General Conventions for 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="Utilities-in-Makefiles-1"></a>
-<h4 class="subsection">7.2.2 Utilities in Makefiles</h4>
+<h4 class="subsection section-level-set-subsection"
id="Utilities-in-Makefiles-1"><span>7.2.2 Utilities in Makefiles<a
class="copiable-link" href="#Utilities-in-Makefiles-1"> ¶</a></span></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 <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>.
+<code class="code">configure</code>) to run under <code class="code">sh</code>
(both the traditional Bourne
+shell and the <small class="sc">POSIX</small> shell), not <code
class="code">csh</code>. Don’t use any
+special features of <code class="code">ksh</code> or <code
class="code">bash</code>, or <small class="sc">POSIX</small> features
+not widely supported in traditional Bourne <code class="code">sh</code>.
</p>
-<p>The <code>configure</code> script and the Makefile rules for building and
+<p>The <code class="code">configure</code> script and the Makefile rules for
building and
installation should not use any utilities directly except these:
</p>
<div class="example">
-<pre class="example">awk cat cmp cp diff echo egrep expr false grep
install-info ln ls
+<pre class="example-preformatted">awk cat cmp cp diff echo expr false grep
install-info ln ls
mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true
</pre></div>
-<p>Compression programs such as <code>gzip</code> can be used in the
-<code>dist</code> rule.
+<p>Compression programs such as <code class="code">gzip</code> can be used in
the
+<code class="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
+<small class="sc">POSIX</small>-specified) options and features of these
programs. For
+example, don’t use ‘<samp class="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="http://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell";>Portable
Shell Programming</a> in <cite>Autoconf</cite>.
+<a data-manual="autoconf"
href="https://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell";>Portable
Shell Programming</a> in <cite class="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>
<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
+and related programs, but should do so via <code class="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
+<pre class="example-preformatted">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>Use the following <code class="code">make</code> variables to run those
programs:
</p>
<div class="example">
-<pre class="example">$(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD) $(LDCONFIG)
$(LEX)
+<pre class="example-preformatted">$(AR) $(BISON) $(CC) $(FLEX) $(INSTALL)
$(LD) $(LDCONFIG) $(LEX)
$(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
</pre></div>
-<p>When you use <code>ranlib</code> or <code>ldconfig</code>, you should make
sure
+<p>When you use <code class="code">ranlib</code> or <code
class="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>AC_PROG_RANLIB</samp>’ macro can
help with
+a problem. (The Autoconf ‘<samp
class="samp">AC_PROG_RANLIB</samp>’ macro can help with
this.)
</p>
<p>If you use symbolic links, you should implement a fallback for systems
@@ -5451,7 +5368,7 @@
<p>Additional utilities that can be used via Make variables are:
</p>
<div class="example">
-<pre class="example">chgrp chmod chown mknod
+<pre class="example-preformatted">chgrp chmod chown mknod
</pre></div>
<p>It is ok to use other utilities in Makefile portions (or scripts)
@@ -5459,159 +5376,159 @@
exist.
</p>
<hr>
-<a name="Command-Variables"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Command-Variables">
+<div class="nav-panel">
<p>
-Next: <a href="#DESTDIR" accesskey="n" rel="next">DESTDIR</a>, Previous: <a
href="#Utilities-in-Makefiles" accesskey="p" rel="prev">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>
+Next: <a href="#DESTDIR" accesskey="n" rel="next"><code
class="code">DESTDIR</code>: Support for Staged Installs</a>, Previous: <a
href="#Utilities-in-Makefiles" accesskey="p" rel="prev">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>
+<h4 class="subsection section-level-set-subsection"
id="Variables-for-Specifying-Commands"><span>7.2.3 Variables for Specifying
Commands<a class="copiable-link" href="#Variables-for-Specifying-Commands">
¶</a></span></h4>
<p>Makefiles should provide variables for overriding certain commands, options,
and so on.
</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>BISON = bison</samp>’, and refer to it
with
-<code>$(BISON)</code> whenever you need to use Bison.
+Thus, if you use Bison, have a variable named <code class="code">BISON</code>
whose default
+value is set with ‘<samp class="samp">BISON = bison</samp>’, and
refer to it with
+<code class="code">$(BISON)</code> whenever you need to use Bison.
</p>
-<p>File management utilities such as <code>ln</code>, <code>rm</code>,
<code>mv</code>, and
+<p>File management utilities such as <code class="code">ln</code>, <code
class="code">rm</code>, <code class="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>
<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
+used to supply options to the program. Append ‘<samp
class="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
+example, <code class="code">BISONFLAGS</code>. (The names <code
class="code">CFLAGS</code> for the C
+compiler, <code class="code">YFLAGS</code> for yacc, and <code
class="code">LFLAGS</code> for lex, are
exceptions to this rule, but we keep them because they are standard.)
-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>
-<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.
+Use <code class="code">CPPFLAGS</code> in any compilation command that runs the
+preprocessor, and use <code class="code">LDFLAGS</code> in any compilation
command that
+does linking as well as in any direct use of <code class="code">ld</code>.
+</p>
+<p>If there are C compiler options that <em class="emph">must</em> be used for
proper
+compilation of certain files, do not include them in <code
class="code">CFLAGS</code>.
+Users expect to be able to specify <code class="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
+independently of <code class="code">CFLAGS</code>, by writing them explicitly
in the
compilation commands or by defining an implicit rule, like this:
</p>
-<div class="smallexample">
-<pre class="smallexample">CFLAGS = -g
+<div class="example smallexample">
+<pre class="example-preformatted">CFLAGS = -g
ALL_CFLAGS = -I. $(CFLAGS)
.c.o:
$(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
</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
+<p>Do include the ‘<samp class="samp">-g</samp>’ option in <code
class="code">CFLAGS</code>, because that is not
+<em class="emph">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>-O</samp>’
-in the default value of <code>CFLAGS</code> as well.
+compiled with GCC by default, then you might as well include ‘<samp
class="samp">-O</samp>’
+in the default value of <code class="code">CFLAGS</code> as well.
</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
+<p>Put <code class="code">CFLAGS</code> last in the compilation command, after
other variables
+containing compiler options, so the user can use <code
class="code">CFLAGS</code> to
override the others.
</p>
-<p><code>CFLAGS</code> should be used in every invocation of the C compiler,
+<p><code class="code">CFLAGS</code> should be used in every invocation of the
C compiler,
both those which do compilation and those which do linking.
</p>
-<p>Every Makefile should define the variable <code>INSTALL</code>, which is the
+<p>Every Makefile should define the variable <code
class="code">INSTALL</code>, which is the
basic command for installing a file into the system.
</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
+<p>Every Makefile should also define the variables <code
class="code">INSTALL_PROGRAM</code>
+and <code class="code">INSTALL_DATA</code>. (The default for <code
class="code">INSTALL_PROGRAM</code> should
+be <code class="code">$(INSTALL)</code>; the default for <code
class="code">INSTALL_DATA</code> should be
+<code class="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
+<pre class="example-preformatted">$(INSTALL_PROGRAM) foo $(bindir)/foo
$(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
</pre></div>
-<p>However, it is preferable to support a <code>DESTDIR</code> prefix on the
+<p>However, it is preferable to support a <code class="code">DESTDIR</code>
prefix on the
target files, as explained in the next section.
</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 class="example-preformatted">$(INSTALL_PROGRAM) foo bar baz $(bindir)
</pre></div>
<hr>
-<a name="DESTDIR"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="DESTDIR">
+<div class="nav-panel">
<p>
-Next: <a href="#Directory-Variables" accesskey="n" rel="next">Directory
Variables</a>, Previous: <a href="#Command-Variables" accesskey="p"
rel="prev">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>
+Next: <a href="#Directory-Variables" accesskey="n" rel="next">Variables for
Installation Directories</a>, Previous: <a href="#Command-Variables"
accesskey="p" rel="prev">Variables for Specifying Commands</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>
+<h4 class="subsection section-level-set-subsection"
id="DESTDIR_003a-Support-for-Staged-Installs"><span>7.2.4 <code
class="code">DESTDIR</code>: Support for Staged Installs<a
class="copiable-link" href="#DESTDIR_003a-Support-for-Staged-Installs">
¶</a></span></h4>
-<a name="index-DESTDIR"></a>
-<a name="index-staged-installs"></a>
-<a name="index-installations_002c-staged"></a>
+<a class="index-entry-id" id="index-DESTDIR"></a>
+<a class="index-entry-id" id="index-staged-installs"></a>
+<a class="index-entry-id" id="index-installations_002c-staged"></a>
-<p><code>DESTDIR</code> is a variable prepended to each installed target file,
+<p><code class="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
+<pre class="example-preformatted">$(INSTALL_PROGRAM) foo
$(DESTDIR)$(bindir)/foo
$(INSTALL_DATA) libfoo.a $(DESTDIR)$(libdir)/libfoo.a
</pre></div>
-<p>The <code>DESTDIR</code> variable is specified by the user on the
<code>make</code>
+<p>The <code class="code">DESTDIR</code> variable is specified by the user on
the <code class="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 class="example-preformatted">make DESTDIR=/tmp/stage install
</pre></div>
-<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
+<p><code class="code">DESTDIR</code> should be supported only in the <code
class="code">install*</code> and
+<code class="code">uninstall*</code> targets, as those are the only targets
where it is
useful.
</p>
<p>If your installation step would normally install
-<samp>/usr/local/bin/foo</samp> and <samp>/usr/local/lib/libfoo.a</samp>, then
an
+<samp class="file">/usr/local/bin/foo</samp> and <samp
class="file">/usr/local/lib/libfoo.a</samp>, then an
installation invoked as in the example above would install
-<samp>/tmp/stage/usr/local/bin/foo</samp> and
-<samp>/tmp/stage/usr/local/lib/libfoo.a</samp> instead.
+<samp class="file">/tmp/stage/usr/local/bin/foo</samp> and
+<samp class="file">/tmp/stage/usr/local/lib/libfoo.a</samp> 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
+<p>Prepending the variable <code class="code">DESTDIR</code> to each target in
this way
+provides for <em class="dfn">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
+into a temporary location (<code class="code">DESTDIR</code>). However,
installed files
maintain their relative directory structure and any embedded file names
will not be modified.
</p>
-<p>You should not set the value of <code>DESTDIR</code> in your
<samp>Makefile</samp>
+<p>You should not set the value of <code class="code">DESTDIR</code> in your
<samp class="file">Makefile</samp>
at all; then the files are installed into their expected locations by
-default. Also, specifying <code>DESTDIR</code> should not change the
+default. Also, specifying <code class="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>
-<p><code>DESTDIR</code> support is commonly used in package creation. It is
+<p><code class="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
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
+<code class="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.
+<code class="code">DESTDIR</code>, though it is not an absolute requirement.
</p>
<hr>
-<a name="Directory-Variables"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Directory-Variables">
+<div class="nav-panel">
<p>
-Next: <a href="#Standard-Targets" accesskey="n" rel="next">Standard
Targets</a>, Previous: <a href="#DESTDIR" accesskey="p" rel="prev">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>
+Next: <a href="#Standard-Targets" accesskey="n" rel="next">Standard Targets
for Users</a>, Previous: <a href="#DESTDIR" accesskey="p" rel="prev"><code
class="code">DESTDIR</code>: Support for Staged Installs</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>
+<h4 class="subsection section-level-set-subsection"
id="Variables-for-Installation-Directories"><span>7.2.5 Variables for
Installation Directories<a class="copiable-link"
href="#Variables-for-Installation-Directories"> ¶</a></span></h4>
<p>Installation directories should always be named by variables, so it is
easy to install in a nonstandard place. The standard names for these
@@ -5621,15 +5538,15 @@
systems.
</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
+<code class="command">make</code> (e.g., <kbd class="kbd">make prefix=/usr
install</kbd>) or
+<code class="command">configure</code> (e.g., <kbd class="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"></a>
-<a name="index-installation-directories_002c-creating"></a>
+<a class="index-entry-id"
id="index-directories_002c-creating-installation"></a>
+<a class="index-entry-id"
id="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>
@@ -5638,80 +5555,75 @@
these two, and nothing should be directly installed into these two
directories.
</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
<samp>/usr/local</samp>.
+<dl class="table">
+<dt><a id="index-prefix"></a><span><code class="code">prefix</code><a
class="copiable-link" href="#index-prefix"> ¶</a></span></dt>
+<dd><p>A prefix used in constructing the default values of the variables listed
+below. The default value of <code class="code">prefix</code> should be <samp
class="file">/usr/local</samp>.
When building the complete GNU system, the prefix will be empty and
-<samp>/usr</samp> will be a symbolic link to <samp>/</samp>.
-(If you are using Autoconf, write it as ‘<samp>@prefix@</samp>’.)
+<samp class="file">/usr</samp> will be a symbolic link to <samp
class="file">/</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="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
+<p>Running ‘<samp class="samp">make install</samp>’ with a
different value of <code class="code">prefix</code> from
+the one used to build the program should <em class="emph">not</em> recompile
the
program.
</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>@exec_prefix@</samp>’.)
+<dt><a id="index-exec_005fprefix"></a><span><code
class="code">exec_prefix</code><a class="copiable-link"
href="#index-exec_005fprefix"> ¶</a></span></dt>
+<dd><p>A prefix used in constructing the default values of some of the
+variables listed below. The default value of <code
class="code">exec_prefix</code> should
+be <code class="code">$(prefix)</code>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@exec_prefix@</samp>’.)
</p>
-<p>Generally, <code>$(exec_prefix)</code> is used for directories that contain
+<p>Generally, <code class="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.
+while <code class="code">$(prefix)</code> is used directly for other
directories.
</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
+<p>Running ‘<samp class="samp">make install</samp>’ with a
different value of <code class="code">exec_prefix</code>
+from the one used to build the program should <em class="emph">not</em>
recompile the
program.
</p></dd>
</dl>
<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 <samp>/usr/local/bin</samp>, but write it as
-<samp>$(exec_prefix)/bin</samp>.
-(If you are using Autoconf, write it as ‘<samp>@bindir@</samp>’.)
+<dl class="table">
+<dt><a id="index-bindir"></a><span><code class="code">bindir</code><a
class="copiable-link" href="#index-bindir"> ¶</a></span></dt>
+<dd><p>The directory for installing executable programs that users can run.
+This should normally be <samp class="file">/usr/local/bin</samp>, but write it
as
+<samp class="file">$(exec_prefix)/bin</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="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
+<dt><a id="index-sbindir"></a><span><code class="code">sbindir</code><a
class="copiable-link" href="#index-sbindir"> ¶</a></span></dt>
+<dd><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>/usr/local/sbin</samp>, but write it as
-<samp>$(exec_prefix)/sbin</samp>.
-(If you are using Autoconf, write it as ‘<samp>@sbindir@</samp>’.)
+should normally be <samp class="file">/usr/local/sbin</samp>, but write it as
+<samp class="file">$(exec_prefix)/sbin</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="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
+<dt><a id="index-libexecdir"></a><span><code class="code">libexecdir</code><a
class="copiable-link" href="#index-libexecdir"> ¶</a></span></dt>
+<dd><p>The directory for installing executable programs to be run by other
programs rather than by users. This directory should normally be
-<samp>/usr/local/libexec</samp>, but write it as
<samp>$(exec_prefix)/libexec</samp>.
-(If you are using Autoconf, write it as
‘<samp>@libexecdir@</samp>’.)
+<samp class="file">/usr/local/libexec</samp>, but write it as <samp
class="file">$(exec_prefix)/libexec</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@libexecdir@</samp>’.)
</p>
-<p>The definition of ‘<samp>libexecdir</samp>’ is the same for all
packages, so
+<p>The definition of ‘<samp class="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>$(libexecdir)/<var>package-name</var>/</samp>,
+install their data under <samp class="file">$(libexecdir)/<var
class="var">package-name</var>/</samp>,
possibly within additional subdirectories thereof, such as
-<samp>$(libexecdir)/<var>package-name</var>/<var>machine</var>/<var>version</var></samp>.
+<samp class="file">$(libexecdir)/<var class="var">package-name</var>/<var
class="var">machine</var>/<var class="var">version</var></samp>.
</p></dd>
</dl>
<p>Data files used by the program during its execution are divided into
categories in two ways.
</p>
-<ul>
-<li> Some files are normally modified by programs; others are never normally
+<ul class="itemize mark-bullet">
+<li>Some files are normally modified by programs; others are never normally
modified (though users may edit some of these).
-</li><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.
@@ -5725,243 +5637,244 @@
<p>Here are the variables Makefiles should use to specify directories
to put these various kinds of files in:
</p>
-<dl compact="compact">
-<dt>‘<samp>datarootdir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">datarootdir</samp>’</dt>
<dd><p>The root of the directory tree for read-only architecture-independent
-data files. This should normally be <samp>/usr/local/share</samp>, but
-write it as <samp>$(prefix)/share</samp>. (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
+data files. This should normally be <samp
class="file">/usr/local/share</samp>, but
+write it as <samp class="file">$(prefix)/share</samp>. (If you are using
Autoconf, write
+it as ‘<samp class="samp">@datarootdir@</samp>’.) ‘<samp
class="samp">datadir</samp>’’s default value is
+based on this variable; so are ‘<samp
class="samp">infodir</samp>’, ‘<samp
class="samp">mandir</samp>’, and
others.
</p>
</dd>
-<dt>‘<samp>datadir</samp>’</dt>
+<dt>‘<samp class="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>datarootdir</samp>’, but we use the two
separate
+the same place as ‘<samp class="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.
</p>
-<p>This should normally be <samp>/usr/local/share</samp>, but write it as
-<samp>$(datarootdir)</samp>. (If you are using Autoconf, write it as
-‘<samp>@datadir@</samp>’.)
+<p>This should normally be <samp class="file">/usr/local/share</samp>, but
write it as
+<samp class="file">$(datarootdir)</samp>. (If you are using Autoconf, write
it as
+‘<samp class="samp">@datadir@</samp>’.)
</p>
-<p>The definition of ‘<samp>datadir</samp>’ is the same for all
packages, so you
+<p>The definition of ‘<samp class="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>$(datadir)/<var>package-name</var>/</samp>.
+install their data under <samp class="file">$(datadir)/<var
class="var">package-name</var>/</samp>.
</p>
</dd>
-<dt>‘<samp>sysconfdir</samp>’</dt>
+<dt>‘<samp class="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>/etc/passwd</samp>, and so forth belong
+and network configuration files, <samp class="file">/etc/passwd</samp>, and so
forth belong
here. All the files in this directory should be ordinary ASCII text
-files. This directory should normally be <samp>/usr/local/etc</samp>, but
-write it as <samp>$(prefix)/etc</samp>.
-(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 <samp>$(libexecdir)</samp> or <samp>$(sbindir)</samp>). 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>$(localstatedir)</samp>.
+files. This directory should normally be <samp
class="file">/usr/local/etc</samp>, but
+write it as <samp class="file">$(prefix)/etc</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@sysconfdir@</samp>’.)
+</p>
+<p>This directory is not the right place to install executables built by
+running ‘<samp class="samp">make</samp>’—they probably
belong in <samp class="file">$(libexecdir)</samp> or
+<samp class="file">$(sbindir)</samp>. Also do not install here files that
will be
+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 class="file">$(localstatedir)</samp>.
</p>
</dd>
-<dt>‘<samp>sharedstatedir</samp>’</dt>
+<dt>‘<samp class="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>/usr/local/com</samp>, but write it as <samp>$(prefix)/com</samp>.
-(If you are using Autoconf, write it as
‘<samp>@sharedstatedir@</samp>’.)
+<samp class="file">/usr/local/com</samp>, but write it as <samp
class="file">$(prefix)/com</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@sharedstatedir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>localstatedir</samp>’</dt>
+<dt>‘<samp class="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
operation; put such configuration information in separate files that go
-in <samp>$(datadir)</samp> or <samp>$(sysconfdir)</samp>.
<samp>$(localstatedir)</samp>
-should normally be <samp>/usr/local/var</samp>, but write it as
-<samp>$(prefix)/var</samp>.
-(If you are using Autoconf, write it as
‘<samp>@localstatedir@</samp>’.)
+in <samp class="file">$(datadir)</samp> or <samp
class="file">$(sysconfdir)</samp>. <samp class="file">$(localstatedir)</samp>
+should normally be <samp class="file">/usr/local/var</samp>, but write it as
+<samp class="file">$(prefix)/var</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@localstatedir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>runstatedir</samp>’</dt>
+<dt>‘<samp class="samp">runstatedir</samp>’</dt>
<dd><p>The directory for installing data files which the programs modify
while they run, that pertain to one specific machine, and which need
not persist longer than the execution of the program—which is
generally long-lived, for example, until the next reboot. PID files
for system daemons are a typical use. In addition, this directory
should not be cleaned except perhaps at reboot, while the general
-<samp>/tmp</samp> (<code>TMPDIR</code>) may be cleaned arbitrarily. This
should
-normally be <samp>/var/run</samp>, but write it as
-<samp>$(localstatedir)/run</samp>. Having it as a separate variable allows
-the use of <samp>/run</samp> if desired, for example. (If you are using
-Autoconf 2.70 or later, write it as ‘<samp>@runstatedir@</samp>’.)
+<samp class="file">/tmp</samp> (<code class="code">TMPDIR</code>) may be
cleaned arbitrarily. This should
+normally be <samp class="file">/var/run</samp>, but write it as
+<samp class="file">$(localstatedir)/run</samp>. Having it as a separate
variable allows
+the use of <samp class="file">/run</samp> if desired, for example. (If you
are using
+Autoconf 2.70 or later, write it as ‘<samp
class="samp">@runstatedir@</samp>’.)
</p></dd>
</dl>
<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>infodir</samp>’,
but not all
-need ‘<samp>libdir</samp>’ or ‘<samp>lispdir</samp>’.
+have Info files, so every program needs ‘<samp
class="samp">infodir</samp>’, but not all
+need ‘<samp class="samp">libdir</samp>’ or ‘<samp
class="samp">lispdir</samp>’.
</p>
-<dl compact="compact">
-<dt>‘<samp>includedir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="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 <samp>/usr/local/include</samp>, but write it as
-<samp>$(prefix)/include</samp>.
-(If you are using Autoconf, write it as
‘<samp>@includedir@</samp>’.)
+programs with the C ‘<samp class="samp">#include</samp>’
preprocessor directive. This
+should normally be <samp class="file">/usr/local/include</samp>, but write it
as
+<samp class="file">$(prefix)/include</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@includedir@</samp>’.)
</p>
<p>Most compilers other than GCC do not look for header files in directory
-<samp>/usr/local/include</samp>. So installing the header files this way is
+<samp class="file">/usr/local/include</samp>. 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>.
+header files in two places, one specified by <code
class="code">includedir</code> and one
+specified by <code class="code">oldincludedir</code>.
</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 <samp>/usr/include</samp>.
-(If you are using Autoconf, you can write it as
‘<samp>@oldincludedir@</samp>’.)
+<dt>‘<samp class="samp">oldincludedir</samp>’</dt>
+<dd><p>The directory for installing ‘<samp
class="samp">#include</samp>’ header files for use with
+compilers other than GCC. This should normally be <samp
class="file">/usr/include</samp>.
+(If you are using Autoconf, you can write it as ‘<samp
class="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
+<code class="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>
<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>foo.h</samp>, then it should install the header
-file in the <code>oldincludedir</code> directory if either (1) there is no
-<samp>foo.h</samp> there or (2) the <samp>foo.h</samp> that exists came from
the Foo
+provides a header file <samp class="file">foo.h</samp>, then it should install
the header
+file in the <code class="code">oldincludedir</code> directory if either (1)
there is no
+<samp class="file">foo.h</samp> there or (2) the <samp
class="file">foo.h</samp> that exists came from the Foo
package.
</p>
-<p>To tell whether <samp>foo.h</samp> came from the Foo package, put a magic
-string in the file—part of a comment—and <code>grep</code> for
that string.
+<p>To tell whether <samp class="file">foo.h</samp> came from the Foo package,
put a magic
+string in the file—part of a comment—and <code
class="code">grep</code> for that string.
</p>
</dd>
-<dt>‘<samp>docdir</samp>’</dt>
+<dt>‘<samp class="samp">docdir</samp>’</dt>
<dd><p>The directory for installing documentation files (other than Info) for
this package. By default, it should be
-<samp>/usr/local/share/doc/<var>yourpkg</var></samp>, but it should be written
as
-<samp>$(datarootdir)/doc/<var>yourpkg</var></samp>. (If you are using
Autoconf,
-write it as ‘<samp>@docdir@</samp>’.) The <var>yourpkg</var>
subdirectory, which
+<samp class="file">/usr/local/share/doc/<var class="var">yourpkg</var></samp>,
but it should be written as
+<samp class="file">$(datarootdir)/doc/<var class="var">yourpkg</var></samp>.
(If you are using Autoconf,
+write it as ‘<samp class="samp">@docdir@</samp>’.) The <var
class="var">yourpkg</var> subdirectory, which
may include a version number, prevents collisions among files with
-common names, such as <samp>README</samp>.
+common names, such as <samp class="file">README</samp>.
</p>
</dd>
-<dt>‘<samp>infodir</samp>’</dt>
+<dt>‘<samp class="samp">infodir</samp>’</dt>
<dd><p>The directory for installing the Info files for this package. By
-default, it should be <samp>/usr/local/share/info</samp>, but it should be
-written as <samp>$(datarootdir)/info</samp>. (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.
+default, it should be <samp class="file">/usr/local/share/info</samp>, but it
should be
+written as <samp class="file">$(datarootdir)/info</samp>. (If you are using
Autoconf,
+write it as ‘<samp class="samp">@infodir@</samp>’.) <code
class="code">infodir</code> is separate from
+<code class="code">docdir</code> for compatibility with existing practice.
</p>
</dd>
-<dt>‘<samp>htmldir</samp>’</dt>
-<dt>‘<samp>dvidir</samp>’</dt>
-<dt>‘<samp>pdfdir</samp>’</dt>
-<dt>‘<samp>psdir</samp>’</dt>
+<dt>‘<samp class="samp">htmldir</samp>’</dt>
+<dt>‘<samp class="samp">dvidir</samp>’</dt>
+<dt>‘<samp class="samp">pdfdir</samp>’</dt>
+<dt>‘<samp class="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>@htmldir@</samp>’,
-‘<samp>@dvidir@</samp>’, etc.) Packages which supply several
translations
+format. They should all be set to <code class="code">$(docdir)</code> by
default. (If
+you are using Autoconf, write them as ‘<samp
class="samp">@htmldir@</samp>’,
+‘<samp class="samp">@dvidir@</samp>’, etc.) Packages which supply
several translations
of their documentation should install them in
-‘<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>’.
+‘<samp class="samp">$(htmldir)/</samp>’<var class="var">ll</var>,
‘<samp class="samp">$(pdfdir)/</samp>’<var class="var">ll</var>,
etc. where
+<var class="var">ll</var> is a locale abbreviation such as ‘<samp
class="samp">en</samp>’ or ‘<samp class="samp">pt_BR</samp>’.
</p>
</dd>
-<dt>‘<samp>libdir</samp>’</dt>
+<dt>‘<samp class="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
<samp>$(libexecdir)</samp>
-instead. The value of <code>libdir</code> should normally be
-<samp>/usr/local/lib</samp>, but write it as <samp>$(exec_prefix)/lib</samp>.
-(If you are using Autoconf, write it as ‘<samp>@libdir@</samp>’.)
+install executables here, they probably ought to go in <samp
class="file">$(libexecdir)</samp>
+instead. The value of <code class="code">libdir</code> should normally be
+<samp class="file">/usr/local/lib</samp>, but write it as <samp
class="file">$(exec_prefix)/lib</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@libdir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>lispdir</samp>’</dt>
+<dt>‘<samp class="samp">lispdir</samp>’</dt>
<dd><p>The directory for installing any Emacs Lisp files in this package. By
-default, it should be <samp>/usr/local/share/emacs/site-lisp</samp>, but it
-should be written as <samp>$(datarootdir)/emacs/site-lisp</samp>.
+default, it should be <samp
class="file">/usr/local/share/emacs/site-lisp</samp>, but it
+should be written as <samp class="file">$(datarootdir)/emacs/site-lisp</samp>.
</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 <samp>configure.ac</samp> file:
+<p>If you are using Autoconf, write the default as ‘<samp
class="samp">@lispdir@</samp>’.
+In order to make ‘<samp class="samp">@lispdir@</samp>’ work, you
need the following lines
+in your <samp class="file">configure.ac</samp> file:
</p>
<div class="example">
-<pre class="example">lispdir='${datarootdir}/emacs/site-lisp'
+<pre class="example-preformatted">lispdir='${datarootdir}/emacs/site-lisp'
AC_SUBST(lispdir)
</pre></div>
</dd>
-<dt>‘<samp>localedir</samp>’</dt>
+<dt>‘<samp class="samp">localedir</samp>’</dt>
<dd><p>The directory for installing locale-specific message catalogs for this
-package. By default, it should be <samp>/usr/local/share/locale</samp>, but
-it should be written as <samp>$(datarootdir)/locale</samp>. (If you are
-using Autoconf, write it as ‘<samp>@localedir@</samp>’.) This
directory
+package. By default, it should be <samp
class="file">/usr/local/share/locale</samp>, but
+it should be written as <samp class="file">$(datarootdir)/locale</samp>. (If
you are
+using Autoconf, write it as ‘<samp
class="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:
</p>
-<dl compact="compact">
-<dt>‘<samp>mandir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">mandir</samp>’</dt>
<dd><p>The top-level directory for installing the man pages (if any) for this
-package. It will normally be <samp>/usr/local/share/man</samp>, but you
-should write it as <samp>$(datarootdir)/man</samp>. (If you are using
-Autoconf, write it as ‘<samp>@mandir@</samp>’.)
+package. It will normally be <samp class="file">/usr/local/share/man</samp>,
but you
+should write it as <samp class="file">$(datarootdir)/man</samp>. (If you are
using
+Autoconf, write it as ‘<samp class="samp">@mandir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>man1dir</samp>’</dt>
+<dt>‘<samp class="samp">man1dir</samp>’</dt>
<dd><p>The directory for installing section 1 man pages. Write it as
-<samp>$(mandir)/man1</samp>.
+<samp class="file">$(mandir)/man1</samp>.
</p></dd>
-<dt>‘<samp>man2dir</samp>’</dt>
+<dt>‘<samp class="samp">man2dir</samp>’</dt>
<dd><p>The directory for installing section 2 man pages. Write it as
-<samp>$(mandir)/man2</samp>
+<samp class="file">$(mandir)/man2</samp>
</p></dd>
-<dt>‘<samp>…</samp>’</dt>
+<dt>‘<samp class="samp">…</samp>’</dt>
<dd>
-<p><strong>Don’t make the primary documentation for any GNU software be a
+<p><strong class="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>
</p>
</dd>
-<dt>‘<samp>manext</samp>’</dt>
+<dt>‘<samp class="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>’.
+a period followed by the appropriate digit; it should normally be ‘<samp
class="samp">.1</samp>’.
</p>
</dd>
-<dt>‘<samp>man1ext</samp>’</dt>
+<dt>‘<samp class="samp">man1ext</samp>’</dt>
<dd><p>The file name extension for installed section 1 man pages.
</p></dd>
-<dt>‘<samp>man2ext</samp>’</dt>
+<dt>‘<samp class="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
+<dt>‘<samp class="samp">…</samp>’</dt>
+<dd><p>Use these names instead of ‘<samp
class="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:
</p>
-<dl compact="compact">
-<dt>‘<samp>srcdir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="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>srcdir = @srcdir@</samp>’.)
+variable is normally inserted by the <code class="code">configure</code> shell
script.
+(If you are using Autoconf, use ‘<samp class="samp">srcdir =
@srcdir@</samp>’.)
</p></dd>
</dl>
<p>For example:
</p>
-<div class="smallexample">
-<pre class="smallexample"># Common prefix for installation directories.
+<div class="example smallexample">
+<pre class="example-preformatted"># Common prefix for installation directories.
# NOTE: This directory must exist when you start the install.
prefix = /usr/local
datarootdir = $(prefix)/share
@@ -5978,7 +5891,7 @@
<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.
+should write the <code class="code">install</code> rule to create these
subdirectories.
</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
@@ -5997,31 +5910,31 @@
</p>
<hr>
-<a name="Standard-Targets"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Standard-Targets">
+<div class="nav-panel">
<p>
-Next: <a href="#Install-Command-Categories" accesskey="n" rel="next">Install
Command Categories</a>, Previous: <a href="#Directory-Variables" accesskey="p"
rel="prev">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>
+Next: <a href="#Install-Command-Categories" accesskey="n" rel="next">Install
Command Categories</a>, Previous: <a href="#Directory-Variables" accesskey="p"
rel="prev">Variables for Installation Directories</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>
+<h4 class="subsection section-level-set-subsection"
id="Standard-Targets-for-Users"><span>7.2.6 Standard Targets for Users<a
class="copiable-link" href="#Standard-Targets-for-Users"> ¶</a></span></h4>
<p>All GNU programs should have the following targets in their Makefiles:
</p>
-<dl compact="compact">
-<dt>‘<samp>all</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="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>
-<p>By default, the Make rules should compile and link with
‘<samp>-g</samp>’, so
+<p>By default, the Make rules should compile and link with ‘<samp
class="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.
</p>
</dd>
-<dt>‘<samp>install</samp>’</dt>
+<dt>‘<samp class="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
@@ -6031,36 +5944,36 @@
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.
+<code class="code">install-strip</code> target to do that.
</p>
-<p>If possible, write the <code>install</code> target rule so that it does not
+<p>If possible, write the <code class="code">install</code> target rule so
that it does not
modify anything in the directory where the program was built, provided
-‘<samp>make all</samp>’ has just been done. This is convenient
for building the
+‘<samp class="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>
<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
+specified as the values of the variables <code class="code">prefix</code> and
+<code class="code">exec_prefix</code>, as well as all subdirectories that are
needed.
+One way to do this is by means of an <code class="code">installdirs</code>
target
as described below.
</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
+<p>Use ‘<samp class="samp">-</samp>’ before any command for
installing a man page, so that
+<code class="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>
-<p>The way to install Info files is to copy them into <samp>$(infodir)</samp>
-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>dir</samp> file to add or update the
+<p>The way to install Info files is to copy them into <samp
class="file">$(infodir)</samp>
+with <code class="code">$(INSTALL_DATA)</code> (see <a class="pxref"
href="#Command-Variables">Variables for Specifying Commands</a>), and then run
+the <code class="code">install-info</code> program if it is present. <code
class="code">install-info</code>
+is a program that edits the Info <samp class="file">dir</samp> file to add or
update the
menu entry for the given Info file; it is part of the Texinfo package.
</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
+handle some additional situations, such as <code
class="code">install-info</code> not
being present.
</p>
-<div class="smallexample">
-<pre class="smallexample">do-install-info: foo.info installdirs
+<div class="example smallexample">
+<pre class="example-preformatted">do-install-info: foo.info installdirs
$(NORMAL_INSTALL)
# Prefer an info file in . to one in srcdir.
if test -f foo.info; then d=.; \
@@ -6080,61 +5993,61 @@
else true; fi
</pre></div>
-<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>When writing the <code class="code">install</code> target, you must
classify all the
+commands into three categories: normal ones, <em
class="dfn">pre-installation</em>
+commands and <em class="dfn">post-installation</em> commands. See <a
class="xref" 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>
+<dt>‘<samp class="samp">install-html</samp>’</dt>
+<dt>‘<samp class="samp">install-dvi</samp>’</dt>
+<dt>‘<samp class="samp">install-pdf</samp>’</dt>
+<dt>‘<samp class="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.
+must be installed by the <code class="code">install</code> target.
</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
+such as <code class="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 class="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>
-<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.
+<p>Please make these <code class="code">install-<var
class="var">format</var></code> targets invoke the
+commands for the <var class="var">format</var> target, for example, by making
+<var class="var">format</var> a dependency.
</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.
+<dt>‘<samp class="samp">uninstall</samp>’</dt>
+<dd><p>Delete all the installed files—the copies that the ‘<samp
class="samp">install</samp>’
+and ‘<samp class="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>
<p>The uninstallation commands are divided into three categories, just like
-the installation commands. See <a href="#Install-Command-Categories">Install
Command Categories</a>.
+the installation commands. See <a class="xref"
href="#Install-Command-Categories">Install Command Categories</a>.
</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
+<dt>‘<samp class="samp">install-strip</samp>’</dt>
+<dd><p>Like <code class="code">install</code>, but strip the executable files
while installing
+them. In simple cases, this target can use the <code
class="code">install</code> target in
a simple way:
</p>
-<div class="smallexample">
-<pre class="smallexample">install-strip:
+<div class="example smallexample">
+<pre class="example-preformatted">install-strip:
$(MAKE) INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' \
install
</pre></div>
<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>
+<code class="code">install-strip</code> target can’t just refer to the
<code class="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
+<p><code class="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>
@@ -6144,85 +6057,85 @@
executable elsewhere in case there is a bug.
</p>
</dd>
-<dt>‘<samp>clean</samp>’</dt>
+<dt>‘<samp class="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
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 ‘<samp>mkdir -p</samp>’, since they could have existed anyway.
+with ‘<samp class="samp">mkdir -p</samp>’, since they could have
existed anyway.
</p>
-<p>Delete <samp>.dvi</samp> files here if they are not part of the
distribution.
+<p>Delete <samp class="file">.dvi</samp> files here if they are not part of
the distribution.
</p>
</dd>
-<dt>‘<samp>distclean</samp>’</dt>
+<dt>‘<samp class="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>make distclean</samp>’ should leave only
the files
+any other files, ‘<samp class="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>mkdir -p</samp>’,
since they
+parent directories that were created with ‘<samp class="samp">mkdir
-p</samp>’, since they
could have existed anyway.
</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 <samp>libgcc.a</samp>, because recompiling it
+<dt>‘<samp class="samp">mostlyclean</samp>’</dt>
+<dd><p>Like ‘<samp class="samp">clean</samp>’, but may refrain
from deleting a few files that people
+normally don’t want to recompile. For example, the ‘<samp
class="samp">mostlyclean</samp>’
+target for GCC does not delete <samp class="file">libgcc.a</samp>, because
recompiling it
is rarely necessary and takes a lot of time.
</p>
</dd>
-<dt>‘<samp>maintainer-clean</samp>’</dt>
+<dt>‘<samp class="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
+This typically includes everything deleted by <code
class="code">distclean</code>, plus
more: C source files produced by Bison, tags tables, Info files, and
so on.
</p>
<p>The reason we say “almost everything” is that running the
command
-‘<samp>make maintainer-clean</samp>’ should not delete
<samp>configure</samp> even
-if <samp>configure</samp> 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 <samp>configure</samp> and then begin to
+‘<samp class="samp">make maintainer-clean</samp>’ should not
delete <samp class="file">configure</samp> even
+if <samp class="file">configure</samp> can be remade using a rule in the
Makefile. More
+generally, ‘<samp class="samp">make maintainer-clean</samp>’
should not delete anything
+that needs to exist in order to run <samp class="file">configure</samp> and
then begin to
build the program. Also, there is no need to delete parent
-directories that were created with ‘<samp>mkdir -p</samp>’, since
they could
+directories that were created with ‘<samp class="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
+<code class="code">maintainer-clean</code> should delete everything else that
can be
rebuilt.
</p>
-<p>The ‘<samp>maintainer-clean</samp>’ target is intended to be
used by a maintainer of
+<p>The ‘<samp class="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>make
maintainer-clean</samp>’ deletes.
+reconstruct some of the files that ‘<samp class="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>
<p>To help make users aware of this, the commands for the special
-<code>maintainer-clean</code> target should start with these two:
+<code class="code">maintainer-clean</code> target should start with these two:
</p>
-<div class="smallexample">
-<pre class="smallexample">@echo 'This command is intended for maintainers to
use; it'
+<div class="example smallexample">
+<pre class="example-preformatted">@echo 'This command is intended for
maintainers to use; it'
@echo 'deletes files that may need special tools to rebuild.'
</pre></div>
</dd>
-<dt>‘<samp>TAGS</samp>’</dt>
+<dt>‘<samp class="samp">TAGS</samp>’</dt>
<dd><p>Update a tags table for this program.
</p>
</dd>
-<dt>‘<samp>info</samp>’</dt>
+<dt>‘<samp class="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
+<div class="example smallexample">
+<pre class="example-preformatted">info: foo.info
foo.info: foo.texi chap1.texi chap2.texi
$(MAKEINFO) $(srcdir)/foo.texi
</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
+<p>You must define the variable <code class="code">MAKEINFO</code> in the
Makefile. It should
+run the <code class="code">makeinfo</code> program, which is part of the
Texinfo
distribution.
</p>
<p>Normally a GNU distribution comes with Info files, and that means the
@@ -6232,69 +6145,69 @@
because they will already be up to date.
</p>
</dd>
-<dt>‘<samp>dvi</samp>’</dt>
-<dt>‘<samp>html</samp>’</dt>
-<dt>‘<samp>pdf</samp>’</dt>
-<dt>‘<samp>ps</samp>’</dt>
+<dt>‘<samp class="samp">dvi</samp>’</dt>
+<dt>‘<samp class="samp">html</samp>’</dt>
+<dt>‘<samp class="samp">pdf</samp>’</dt>
+<dt>‘<samp class="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.
+of the <code class="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
+<div class="example smallexample">
+<pre class="example-preformatted">dvi: foo.dvi
foo.dvi: foo.texi chap1.texi chap2.texi
$(TEXI2DVI) $(srcdir)/foo.texi
</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
+<p>You must define the variable <code class="code">TEXI2DVI</code> in the
Makefile. It
+should run the program <code class="code">texi2dvi</code>, which is part of
the Texinfo
+distribution. (<code class="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
+write only the dependencies, and allow GNU <code class="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
+<div class="example smallexample">
+<pre class="example-preformatted">html: foo.html
foo.html: foo.texi chap1.texi chap2.texi
$(TEXI2HTML) $(srcdir)/foo.texi
</pre></div>
-<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>Again, you would define the variable <code class="code">TEXI2HTML</code> in
the Makefile;
+for example, it might run <code class="code">makeinfo --no-split --html</code>
+(<code class="command">makeinfo</code> is part of the Texinfo distribution).
</p>
</dd>
-<dt>‘<samp>dist</samp>’</dt>
+<dt>‘<samp class="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>
<p>For example, the distribution tar file of GCC version 1.40 unpacks into
-a subdirectory named <samp>gcc-1.40</samp>.
+a subdirectory named <samp class="file">gcc-1.40</samp>.
</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.
+named, use <code class="code">ln</code> or <code class="code">cp</code> to
install the proper files in it, and
+then <code class="code">tar</code> that subdirectory.
</p>
-<p>Compress the tar file with <code>gzip</code>. For example, the actual
-distribution file for GCC version 1.40 is called <samp>gcc-1.40.tar.gz</samp>.
+<p>Compress the tar file with <code class="code">gzip</code>. For example,
the actual
+distribution file for GCC version 1.40 is called <samp
class="file">gcc-1.40.tar.gz</samp>.
It is ok to support other free compression formats as well.
</p>
-<p>The <code>dist</code> target should explicitly depend on all non-source
files
+<p>The <code class="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>.
+See <a class="xref" href="#Releases">Making Releases</a>.
</p>
</dd>
-<dt>‘<samp>check</samp>’</dt>
+<dt>‘<samp class="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
@@ -6305,22 +6218,22 @@
<p>The following targets are suggested as conventional names, for programs
in which they are useful.
</p>
-<dl compact="compact">
-<dt><code>installcheck</code></dt>
+<dl class="table">
+<dt><code class="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>$(bindir)</samp> is in the search path.
+<samp class="file">$(bindir)</samp> 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
+<dt><code class="code">installdirs</code></dt>
+<dd><p>It’s useful to add a target named ‘<samp
class="samp">installdirs</samp>’ to create the
directories where files are installed, and their parent directories.
-There is a script called <samp>mkinstalldirs</samp> which is convenient for
+There is a script called <samp class="file">mkinstalldirs</samp> which is
convenient for
this; you can find it in the Gnulib package.
You can use a rule like this:
</p>
-<div class="smallexample">
-<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+<div class="example smallexample">
+<pre class="example-preformatted"># Make sure all installation directories
(e.g. $(bindir))
# actually exist by making them if necessary.
installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs $(bindir) $(datadir) \
@@ -6328,10 +6241,10 @@
$(mandir)
</pre></div>
-<p>or, if you wish to support <code>DESTDIR</code> (strongly encouraged),
+<p>or, if you wish to support <code class="env">DESTDIR</code> (strongly
encouraged),
</p>
-<div class="smallexample">
-<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+<div class="example smallexample">
+<pre class="example-preformatted"># Make sure all installation directories
(e.g. $(bindir))
# actually exist by making them if necessary.
installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs \
@@ -6346,19 +6259,19 @@
</dl>
<hr>
-<a name="Install-Command-Categories"></a>
-<div class="header">
+</div>
+<div class="subsection-level-extent" id="Install-Command-Categories">
+<div class="nav-panel">
<p>
-Previous: <a href="#Standard-Targets" accesskey="p" rel="prev">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>
+Previous: <a href="#Standard-Targets" accesskey="p" rel="prev">Standard
Targets for Users</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>
+<h4 class="subsection section-level-set-subsection"
id="Install-Command-Categories-1"><span>7.2.7 Install Command Categories<a
class="copiable-link" href="#Install-Command-Categories-1">
¶</a></span></h4>
-<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.
+<a class="index-entry-id" id="index-pre_002dinstallation-commands"></a>
+<a class="index-entry-id" id="index-post_002dinstallation-commands"></a>
+<p>When writing the <code class="code">install</code> target, you must
classify all the
+commands into three categories: normal ones, <em
class="dfn">pre-installation</em>
+commands and <em class="dfn">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
@@ -6372,7 +6285,7 @@
normal commands.
</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
+<code class="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
@@ -6381,8 +6294,8 @@
<p>Most programs don’t need any pre-installation commands, but we have
the
feature just in case it is needed.
</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
+<p>To classify the commands in the <code class="code">install</code> rule into
these three
+categories, insert <em class="dfn">category lines</em> among them. A category
line
specifies the category for the commands that follow.
</p>
<p>A category line consists of a tab and a reference to a special Make
@@ -6390,36 +6303,36 @@
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).
+<em class="emph">should not</em> define them in the makefile).
</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>
+<div class="example smallexample">
+<pre class="example-preformatted"> $(PRE_INSTALL) # <span
class="r">Pre-install commands follow.</span>
+ $(POST_INSTALL) # <span class="r">Post-install commands
follow.</span>
+ $(NORMAL_INSTALL) # <span class="r">Normal commands follow.</span>
</pre></div>
-<p>If you don’t use a category line at the beginning of the
<code>install</code>
+<p>If you don’t use a category line at the beginning of the <code
class="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
classified as normal.
</p>
-<p>These are the category lines for <code>uninstall</code>:
+<p>These are the category lines for <code class="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>
+<div class="example smallexample">
+<pre class="example-preformatted"> $(PRE_UNINSTALL) # <span
class="r">Pre-uninstall commands follow.</span>
+ $(POST_UNINSTALL) # <span class="r">Post-uninstall commands
follow.</span>
+ $(NORMAL_UNINSTALL) # <span class="r">Normal commands follow.</span>
</pre></div>
<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
+<p>If the <code class="code">install</code> or <code
class="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
+<em class="emph">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.
@@ -6428,14 +6341,14 @@
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
+<pre class="example-preformatted">[ basename bash cat chgrp chmod chown cmp cp
dd diff echo
+expand expr false 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>
-<a name="index-binary-packages"></a>
+<a class="index-entry-id" id="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
@@ -6445,74 +6358,75 @@
</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>-s</samp> option to
-<code>make</code> is needed to silence messages about entering
+extracting the pre-installation commands (the <samp class="option">-s</samp>
option to
+<code class="command">make</code> is needed to silence messages about entering
subdirectories):
</p>
-<div class="smallexample">
-<pre class="smallexample">make -s -n install -o all \
+<div class="example smallexample">
+<pre class="example-preformatted">make -s -n install -o all \
PRE_INSTALL=pre-install \
POST_INSTALL=post-install \
NORMAL_INSTALL=normal-install \
| gawk -f pre-install.awk
</pre></div>
-<p>where the file <samp>pre-install.awk</samp> could contain this:
+<p>where the file <samp class="file">pre-install.awk</samp> could contain this:
</p>
-<div class="smallexample">
-<pre class="smallexample">$0 ~ /^(normal-install|post-install)[ \t]*$/ {on = 0}
+<div class="example smallexample">
+<pre class="example-preformatted">$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">
+</div>
+</div>
+<div class="section-level-extent" id="Releases">
+<div class="nav-panel">
<p>
-Previous: <a href="#Makefile-Conventions" accesskey="p" rel="prev">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>
+Previous: <a href="#Makefile-Conventions" accesskey="p" rel="prev">Makefile
Conventions</a>, Up: <a href="#Managing-Releases" accesskey="u" rel="up">The
Release Process</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>
+<h3 class="section" id="Making-Releases"><span>7.3 Making Releases<a
class="copiable-link" href="#Making-Releases"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-packaging"></a>
-<a name="index-version-numbers_002c-for-releases"></a>
+<a class="index-entry-id" id="index-version-numbers_002c-for-releases"></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>
-<p>Package the distribution of <code>Foo version 69.96</code> up in a gzipped
tar
-file with the name <samp>foo-69.96.tar.gz</samp>. It should unpack into a
-subdirectory named <samp>foo-69.96</samp>.
+<p>Package the distribution of <code class="code">Foo version 69.96</code> up
in a gzipped tar
+file with the name <samp class="file">foo-69.96.tar.gz</samp>. It should
unpack into a
+subdirectory named <samp class="file">foo-69.96</samp>.
</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 <em>source
-files</em> and <em>non-source files</em>. Source files are written by humans
+part of the program in any way must be classified into <em class="dfn">source
+files</em> and <em class="dfn">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-README-file"></a>
-<p>The distribution should contain a file named <samp>README</samp> with a
+<a class="index-entry-id" id="index-README-file"></a>
+<p>The distribution should contain a file named <samp
class="file">README</samp> with a
general overview of the package:
</p>
-<ul>
-<li> the name of the package;
+<ul class="itemize mark-bullet">
+<li>the name of the package;
-</li><li> the version number of the package, or refer to where in the
+</li><li>the version number of the package, or refer to where in the
package the version can be found;
-</li><li> a general description of what the package does;
+</li><li>a general description of what the package does;
-</li><li> a reference to the file <samp>INSTALL</samp>, which
+</li><li>a reference to the file <samp class="file">INSTALL</samp>, which
should in turn contain an explanation of the installation procedure;
-</li><li> a brief explanation of any unusual top-level directories or
+</li><li>a brief explanation of any unusual top-level directories or
files, or other hints for readers to find their way around the source;
-</li><li> a reference to the file which contains the copying conditions.
-The GNU GPL, if used, should be in a file called <samp>COPYING</samp>. If
+</li><li>a reference to the file which contains the copying conditions.
+The GNU GPL, if used, should be in a file called <samp
class="file">COPYING</samp>. If
the GNU LGPL is used, it should be in a file called
-<samp>COPYING.LESSER</samp>.
+<samp class="file">COPYING.LESSER</samp>.
</li></ul>
<p>Naturally, all the source files must be in the distribution. It is
@@ -6521,20 +6435,20 @@
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, <code>flex</code>, TeX, and <code>makeinfo</code>; this helps avoid
+Bison, <code class="code">flex</code>, TeX, and <code
class="code">makeinfo</code>; this helps avoid
unnecessary dependencies between our distributions, so that users can
install whichever versions of whichever packages they like. Do not
induce new dependencies on other software lightly.
</p>
<p>Non-source files that might actually be modified by building and
-installing the program should <strong>never</strong> be included in the
+installing the program should <strong class="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>
<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>
+world-writable (octal mode 777), because ancient versions of <code
class="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.
@@ -6550,13 +6464,13 @@
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>foobarhacker.c</samp> and <samp>foobarhacker.o</samp> are not ambiguous;
they
-are truncated to <samp>foobarha.c</samp> and <samp>foobarha.o</samp>, which are
+<samp class="file">foobarhacker.c</samp> and <samp
class="file">foobarhacker.o</samp> are not ambiguous; they
+are truncated to <samp class="file">foobarha.c</samp> and <samp
class="file">foobarha.o</samp>, which are
distinct.
</p>
-<a name="index-texinfo_002etex_002c-in-a-distribution"></a>
-<p>Include in your distribution a copy of the <samp>texinfo.tex</samp> you used
-to test print any <samp>*.texinfo</samp> or <samp>*.texi</samp> files.
+<a class="index-entry-id"
id="index-texinfo_002etex_002c-in-a-distribution"></a>
+<p>Include in your distribution a copy of the <samp
class="file">texinfo.tex</samp> you used
+to test print any <samp class="file">*.texinfo</samp> or <samp
class="file">*.texi</samp> files.
</p>
<p>Likewise, if your program uses small GNU software packages like regex,
getopt, obstack, or termcap, include them in the distribution file.
@@ -6565,14 +6479,15 @@
other files to get.
</p>
<hr>
-<a name="References"></a>
-<div class="header">
+</div>
+</div>
+<div class="chapter-level-extent" id="References">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="#GNU-Free-Documentation-License" accesskey="n" rel="next">GNU
Free Documentation License</a>, Previous: <a href="#Managing-Releases"
accesskey="p" rel="prev">The Release Process</a>, Up: <a href="#Top"
accesskey="u" rel="up">GNU Coding Standards</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>
+<h2 class="chapter"
id="References-to-Non_002dFree-Software-and-Documentation"><span>8 References
to Non-Free Software and Documentation<a class="copiable-link"
href="#References-to-Non_002dFree-Software-and-Documentation">
¶</a></span></h2>
+<a class="index-entry-id" id="index-references-to-non_002dfree-material"></a>
<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
@@ -6583,15 +6498,15 @@
impression that their existence is legitimate.
</p>
<p>The GNU definition of free software is found on the GNU web site at
-<a
href="https://www.gnu.org/philosophy/free-sw.html";>https://www.gnu.org/philosophy/free-sw.html</a>,
and the definition
+<a class="url"
href="https://www.gnu.org/philosophy/free-sw.html";>https://www.gnu.org/philosophy/free-sw.html</a>,
and the definition
of free documentation is found at
-<a
href="https://www.gnu.org/philosophy/free-doc.html";>https://www.gnu.org/philosophy/free-doc.html</a>.
The terms “free”
+<a class="url"
href="https://www.gnu.org/philosophy/free-doc.html";>https://www.gnu.org/philosophy/free-doc.html</a>.
The terms “free”
and “non-free”, used in this document, refer to those definitions.
</p>
<p>A list of important licenses and whether they qualify as free is in
-<a
href="https://www.gnu.org/licenses/license-list.html";>https://www.gnu.org/licenses/license-list.html</a>.
If it is not
+<a class="url"
href="https://www.gnu.org/licenses/license-list.html";>https://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:licensing@gnu.org";>licensing@gnu.org</a>. We
will answer, and if the
+by writing to <a class="email"
href="mailto:licensing@gnu.org";>licensing@gnu.org</a>. We will answer, and if
the
license is an important one, we will add it to the list.
</p>
<p>When a non-free program or system is well known, you can mention it in
@@ -6628,7 +6543,7 @@
<p>Sometimes a program is free software in itself but depends on a
non-free platform in order to run. For instance, it used to be the
case that many Java programs depended on some non-free Java libraries.
-(See <a
href="https://www.gnu.org/philosophy/java-trap.html";>https://www.gnu.org/philosophy/java-trap.html</a>.)
+(See <a class="uref"
href="https://www.gnu.org/philosophy/java-trap.html";>https://www.gnu.org/philosophy/java-trap.html</a>.)
To recommend or promote such a program is to promote the other
programs it needs; therefore, judge mentions of the former as if they
were mentions of the latter. For this reason, we were careful about
@@ -6640,16 +6555,16 @@
on non-free software to run.
</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,
+typical example is <code class="command">mplayer</code>. It is free software
in itself,
and the free code can handle some kinds of files. However,
-<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>
+<code class="command">mplayer</code> recommends use of non-free codecs for
other kinds of
+files, and users that install <code class="command">mplayer</code> are very
likely to
+install those codecs along with it. To recommend <code
class="command">mplayer</code>
is, in effect, to promote use of the non-free codecs.
</p>
<p>Thus, you should not recommend programs that strongly encourage the
use of non-free software. This is why we do not list
-<code>mplayer</code> in the Free Software Directory.
+<code class="command">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
@@ -6676,33 +6591,33 @@
inherent in the nature of the web. Here’s how we treat that.
</p>
<p>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 page <var>p</var>
+non-free software packages; you should not refer to a page <var
class="var">p</var>
that links to AT&T’s site presenting it as a place to get some
-non-free program, because that part of the page <var>p</var> itself
+non-free program, because that part of the page <var class="var">p</var> itself
recommends and legitimizes the non-free program.
</p>
-<p>However, if <var>p</var> contains a link to AT&T’s web site for
some other
+<p>However, if <var class="var">p</var> contains a link to AT&T’s
web site for some other
purpose (such as long-distance telephone service), that is no reason
-you should not link to <var>p</var>.
+you should not link to <var class="var">p</var>.
</p>
<p>A web page recommends a program in an implicit but particularly strong
way if it requires users to run that program in order to use the page.
-Many pages contain Javascript code which they recommend in this way.
-This Javascript code may be free or nonfree, but nonfree is the usual
+Many pages contain JavaScript code which they recommend in this way.
+This JavaScript code may be free or non-free, but non-free is the usual
case.
</p>
<p>If the purpose for which you would refer to the page cannot be carried
-out without running nonfree Javascript code, then you should not refer
+out without running non-free JavaScript code, then you should not refer
to it. Thus, if the purpose of referring to the page is for people to
view a video, or subscribing to a mailing list, and the viewing or
-subscribing fail to work if the user’s browser blocks the nonfree
-Javascript code, then don’t refer to that page.
+subscribing fail to work if the user’s browser blocks the non-free
+JavaScript code, then don’t refer to that page.
</p>
-<p>The extreme case is that of web sites which depend on nonfree
-Javascript code even to <em>see</em> the contents of the pages. Any
-site hosted on ‘<code>wix.com</code>’ has this problem, and so do
some
+<p>The extreme case is that of web sites which depend on non-free
+JavaScript code even to <em class="emph">see</em> the contents of the pages.
Any
+site hosted on ‘<code class="indicateurl">wix.com</code>’ has this
problem, and so do some
other sites. Referring people to such pages to read their contents
-is, in effect, urging them to run those nonfree programs—so please
+is, in effect, urging them to run those non-free programs—so please
don’t refer to those pages. (Such pages also break the Web, so they
deserve condemnation for two reasons.)
</p>
@@ -6710,31 +6625,31 @@
or find another place to refer to that information.
</p>
<hr>
-<a name="GNU-Free-Documentation-License"></a>
-<div class="header">
+</div>
+<div class="appendix-level-extent" id="GNU-Free-Documentation-License">
+<div class="nav-panel">
<p>
-Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a
href="#References" accesskey="p" rel="prev">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>
+Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a
href="#References" accesskey="p" rel="prev">References to Non-Free Software and
Documentation</a>, Up: <a href="#Top" accesskey="u" rel="up">GNU Coding
Standards</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>
+<h2 class="appendix" id="GNU-Free-Documentation-License-1"><span>Appendix A
GNU Free Documentation License<a class="copiable-link"
href="#GNU-Free-Documentation-License-1"> ¶</a></span></h2>
-<a name="index-FDL_002c-GNU-Free-Documentation-License"></a>
-<div align="center">Version 1.3, 3 November 2008
+<a class="index-entry-id"
id="index-FDL_002c-GNU-Free-Documentation-License"></a>
+<div class="center">Version 1.3, 3 November 2008
</div>
<div class="display">
-<pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
-<a href="https://fsf.org/";>https://fsf.org/</a>
+<pre class="display-preformatted">Copyright © 2000, 2001, 2002, 2007,
2008 Free Software Foundation, Inc.
+<a class="uref" href="https://fsf.org/";>https://fsf.org/</a>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre></div>
-<ol start="0">
+<ol class="enumerate" start="0">
<li> PREAMBLE
<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
+functional and useful document <em class="dfn">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
@@ -6906,7 +6821,7 @@
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
</p>
-<ol type="A" start="1">
+<ol class="enumerate" type="A" start="1">
<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
@@ -7106,7 +7021,7 @@
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="https://www.gnu.org/licenses/";>https://www.gnu.org/licenses/</a>.
+<a class="uref"
href="https://www.gnu.org/licenses/";>https://www.gnu.org/licenses/</a>.
</p>
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
@@ -7152,31 +7067,30 @@
</p>
</li></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>
+<h3 class="heading"
id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"><span>ADDENDUM:
How to use this License for your documents<a class="copiable-link"
href="#ADDENDUM_003a-How-to-use-this-License-for-your-documents">
¶</a></span></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>.
+<div class="example smallexample">
+<div class="group"><pre class="example-preformatted"> Copyright (C) <var
class="var">year</var> <var class="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
or any later version published by the Free Software Foundation;
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></div>
+</pre></div></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></div>
+<div class="example smallexample">
+<div class="group"><pre class="example-preformatted"> with the Invariant
Sections being <var class="var">list their titles</var>, with
+ the Front-Cover Texts being <var class="var">list</var>, and with the
Back-Cover Texts
+ being <var class="var">list</var>.
+</pre></div></div>
<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
@@ -7189,351 +7103,354 @@
</p>
<hr>
-<a name="Index"></a>
-<div class="header">
+</div>
+<div class="unnumbered-level-extent" id="Index">
+<div class="nav-panel">
<p>
-Previous: <a href="#GNU-Free-Documentation-License" accesskey="p"
rel="prev">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>
+Previous: <a href="#GNU-Free-Documentation-License" accesskey="p"
rel="prev">GNU Free Documentation License</a>, Up: <a href="#Top" accesskey="u"
rel="up">GNU Coding Standards</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>
+<h2 class="unnumbered" id="Index-1"><span>Index<a class="copiable-link"
href="#Index-1"> ¶</a></span></h2>
+<div class="printindex cp-printindex">
+<table class="cp-letters-header-printindex"><tr><th>Jump to:
</th><td><a class="summary-letter-printindex"
href="#Index_cp_symbol-1"><b>-</b></a>
-<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-G"><b>G</b></a>
-<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
+<a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a>
-<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-W"><b>W</b></a>
-<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+<a class="summary-letter-printindex" 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">ANSI 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-batch-of-changes_002c-in-a-change-log">batch of changes, in a
change log</a>:</td><td> </td><td valign="top"><a
href="#Change-Log-Concepts">Change Log Concepts</a></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>bug-standards@gnu.org</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-compatibility">C
compatibility</a>:</td><td> </td><td valign="top"><a
href="#Compatibility">Compatibility</a></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-changeset_002c-in-a-change-log">changeset, in a change
log</a>:</td><td> </td><td valign="top"><a
href="#Change-Log-Concepts">Change Log Concepts</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
POSIX 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-description_002c-change-log-entry">description, change log
entry</a>:</td><td> </td><td valign="top"><a
href="#Change-Log-Concepts">Change Log Concepts</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>gnustandards-commit@gnu.org</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-GNUstep">GNUstep</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-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-H">H</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-header-line_002c-change-log-entry">header line, change log
entry</a>:</td><td> </td><td valign="top"><a
href="#Change-Log-Concepts">Change Log Concepts</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-length-of-source-lines">length
of source lines</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</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-line-length">line
length</a>:</td><td> </td><td valign="top"><a
href="#Formatting">Formatting</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"><samp>NEWS</samp>
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-POSIX 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">POSIX
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"><samp>README</samp>
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-software-forensics_002c-and-change-logs">software forensics, and
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-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"><samp>texinfo.tex</samp>,
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-title_002c-change-log-entry">title, change log
entry</a>:</td><td> </td><td valign="top"><a
href="#Change-Log-Concepts">Change Log Concepts</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></td><td valign="top"><a
href="#index-VCS">VCS</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-version-control-system_002c-for-keeping-change-logs">version
control system, for keeping 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-version-numbers_002c-for-releases">version numbers, for
releases</a>:</td><td> </td><td valign="top"><a
href="#Releases">Releases</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 class="cp-entries-printindex" border="0">
+<tr><td></td><th class="entries-header-printindex">Index Entry</th><th
class="sections-header-printindex">Section</th></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_symbol-1">-</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-_002d_002dhelp-output">‘<samp
class="samp">--help</samp>’ output</a></td><td
class="printindex-index-section"><a
href="#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-_002d_002dversion-output">‘<samp
class="samp">--version</samp>’ output</a></td><td
class="printindex-index-section"><a
href="#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-_002dWall-compiler-option">‘<samp
class="samp">-Wall</samp>’ compiler option</a></td><td
class="printindex-index-section"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_symbol-2">#</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-_0023endif_002c-commenting"><code class="code">#endif</code>,
commenting</a></td><td class="printindex-index-section"><a
href="#Comments">Comments</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-A">A</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-accepting-contributions">accepting contributions</a></td><td
class="printindex-index-section"><a
href="#Contributions">Contributions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-address-for-bug-reports">address for bug reports</a></td><td
class="printindex-index-section"><a
href="#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-ANSI-C-standard">ANSI C standard</a></td><td
class="printindex-index-section"><a href="#Standard-C">Standard C</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-arbitrary-limits-on-data">arbitrary limits on data</a></td><td
class="printindex-index-section"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-ASCII-characters">ASCII characters</a></td><td
class="printindex-index-section"><a href="#Character-Set">Character
Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-autoconf"><code>autoconf</code></a></td><td
class="printindex-index-section"><a href="#System-Portability">System
Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-avoiding-proprietary-code">avoiding proprietary code</a></td><td
class="printindex-index-section"><a href="#Reading-Non_002dFree-Code">Reading
Non-Free Code</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-B">B</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-batch-of-changes_002c-in-a-change-log">batch of changes, in a
change log</a></td><td class="printindex-index-section"><a
href="#Change-Log-Concepts">Change Log Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-behavior_002c-dependent-on-program_0027s-name">behavior, dependent
on program’s name</a></td><td class="printindex-index-section"><a
href="#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-binary-packages">binary packages</a></td><td
class="printindex-index-section"><a href="#Install-Command-Categories">Install
Command Categories</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-bindir"><code>bindir</code></a></td><td
class="printindex-index-section"><a href="#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-braces_002c-in-C-source">braces, in C source</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-bug-reports">bug reports</a></td><td
class="printindex-index-section"><a
href="#g_t_002d_002dhelp">--help</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-bug_002dstandards_0040gnu_002eorg-email-address"><code
class="code">bug-standards@gnu.org</code> email address</a></td><td
class="printindex-index-section"><a href="#Preface">Preface</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-C">C</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-C-compatibility">C compatibility</a></td><td
class="printindex-index-section"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-C-library-functions_002c-and-portability">C library functions, and
portability</a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-canonical-name-of-a-program">canonical name of a
program</a></td><td class="printindex-index-section"><a
href="#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-casting-pointers-to-integers">casting pointers to
integers</a></td><td class="printindex-index-section"><a
href="#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-CGI-programs_002c-standard-options-for">CGI programs, standard
options for</a></td><td class="printindex-index-section"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-change-logs">change logs</a></td><td
class="printindex-index-section"><a href="#Change-Logs">Change
Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-change-logs_002c-conditional-changes">change logs, conditional
changes</a></td><td class="printindex-index-section"><a
href="#Conditional-Changes">Conditional Changes</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-change-logs_002c-style">change logs, style</a></td><td
class="printindex-index-section"><a href="#Style-of-Change-Logs">Style of
Change Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-changeset_002c-in-a-change-log">changeset, in a change
log</a></td><td class="printindex-index-section"><a
href="#Change-Log-Concepts">Change Log Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-character-set">character set</a></td><td
class="printindex-index-section"><a href="#Character-Set">Character
Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-clang"><code>clang</code></a></td><td
class="printindex-index-section"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-command_002dline-arguments_002c-decoding">command-line arguments,
decoding</a></td><td class="printindex-index-section"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-command_002dline-interface">command-line interface</a></td><td
class="printindex-index-section"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-commenting">commenting</a></td><td
class="printindex-index-section"><a href="#Comments">Comments</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-compatibility-with-C-and-POSIX-standards">compatibility with C and
POSIX standards</a></td><td class="printindex-index-section"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-compiler-warnings">compiler warnings</a></td><td
class="printindex-index-section"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-conditional-changes_002c-and-change-logs">conditional changes, and
change logs</a></td><td class="printindex-index-section"><a
href="#Conditional-Changes">Conditional Changes</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-conditionals_002c-comments-for">conditionals, comments
for</a></td><td class="printindex-index-section"><a
href="#Comments">Comments</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-configure"><code>configure</code></a></td><td
class="printindex-index-section"><a
href="#Configuration">Configuration</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-control_002dL">control-L</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-conventions-for-makefiles">conventions for makefiles</a></td><td
class="printindex-index-section"><a href="#Makefile-Conventions">Makefile
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-CORBA">CORBA</a></td><td class="printindex-index-section"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-credits-for-manuals">credits for manuals</a></td><td
class="printindex-index-section"><a href="#Manual-Credits">Manual
Credits</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-D">D</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-D_002dbus">D-bus</a></td><td class="printindex-index-section"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-data-structures_002c-in-Gnulib"><code>data structures, in
Gnulib</code></a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-data-types_002c-and-portability">data types, and
portability</a></td><td class="printindex-index-section"><a
href="#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-description_002c-change-log-entry">description, change log
entry</a></td><td class="printindex-index-section"><a
href="#Change-Log-Concepts">Change Log Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-DESTDIR"><code>DESTDIR</code></a></td><td
class="printindex-index-section"><a href="#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-directories_002c-creating-installation">directories, creating
installation</a></td><td class="printindex-index-section"><a
href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-documentation">documentation</a></td><td
class="printindex-index-section"><a
href="#Documentation">Documentation</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-doschk"><code>doschk</code></a></td><td
class="printindex-index-section"><a href="#Names">Names</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-double-quote">double quote</a></td><td
class="printindex-index-section"><a href="#Quote-Characters">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-downloading-this-manual">downloading this manual</a></td><td
class="printindex-index-section"><a href="#Preface">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-dynamic-plug_002dins">dynamic plug-ins</a></td><td
class="printindex-index-section"><a
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-E">E</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-encodings">encodings</a></td><td
class="printindex-index-section"><a href="#Character-Set">Character
Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-enum-types_002c-formatting"><code class="code">enum</code> types,
formatting</a></td><td class="printindex-index-section"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-error-messages">error messages</a></td><td
class="printindex-index-section"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-error-messages_002c-formatting">error messages,
formatting</a></td><td class="printindex-index-section"><a
href="#Errors">Errors</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-error-messages_002c-in-Gnulib"><code>error messages, in
Gnulib</code></a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-exec_005fprefix"><code>exec_prefix</code></a></td><td
class="printindex-index-section"><a href="#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-expressions_002c-splitting">expressions, splitting</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-F">F</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-FDL_002c-GNU-Free-Documentation-License">FDL, GNU Free
Documentation License</a></td><td class="printindex-index-section"><a
href="#GNU-Free-Documentation-License">GNU Free Documentation
License</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-file-usage">file usage</a></td><td
class="printindex-index-section"><a href="#File-Usage">File Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-file_002dname-limitations">file-name limitations</a></td><td
class="printindex-index-section"><a href="#Names">Names</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-formatting-error-messages">formatting error messages</a></td><td
class="printindex-index-section"><a href="#Errors">Errors</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-formatting-source-code">formatting source code</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-formfeed">formfeed</a></td><td class="printindex-index-section"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-function-argument_002c-declaring">function argument,
declaring</a></td><td class="printindex-index-section"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-function-definitions_002c-formatting">function definitions,
formatting</a></td><td class="printindex-index-section"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-function-prototypes">function prototypes</a></td><td
class="printindex-index-section"><a href="#Standard-C">Standard C</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-G">G</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-getopt"><code>getopt</code></a></td><td
class="printindex-index-section"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-gettext"><code>gettext</code></a></td><td
class="printindex-index-section"><a
href="#Internationalization">Internationalization</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-GNOME">GNOME</a></td><td class="printindex-index-section"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-GNOME-and-Guile">GNOME and Guile</a></td><td
class="printindex-index-section"><a href="#Source-Language">Source
Language</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-Gnulib">Gnulib</a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-gnustandards-project-repository">gnustandards project
repository</a></td><td class="printindex-index-section"><a
href="#Preface">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"><code
class="code">gnustandards-commit@gnu.org</code> mailing list</a></td><td
class="printindex-index-section"><a href="#Preface">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-GNUstep">GNUstep</a></td><td class="printindex-index-section"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-graphical-user-interface">graphical user interface</a></td><td
class="printindex-index-section"><a href="#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-grave-accent">grave accent</a></td><td
class="printindex-index-section"><a href="#Quote-Characters">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-GTK_002b">GTK+</a></td><td class="printindex-index-section"><a
href="#Graphical-Interfaces">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-Guile">Guile</a></td><td class="printindex-index-section"><a
href="#Source-Language">Source Language</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-H">H</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-header-line_002c-change-log-entry">header line, change log
entry</a></td><td class="printindex-index-section"><a
href="#Change-Log-Concepts">Change Log Concepts</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-I">I</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-implicit-int">implicit <code class="code">int</code></a></td><td
class="printindex-index-section"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-impossible-conditions">impossible conditions</a></td><td
class="printindex-index-section"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-installation-directories_002c-creating">installation directories,
creating</a></td><td class="printindex-index-section"><a
href="#Directory-Variables">Directory Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-installations_002c-staged">installations, staged</a></td><td
class="printindex-index-section"><a href="#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-interface-styles">interface styles</a></td><td
class="printindex-index-section"><a href="#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-internationalization">internationalization</a></td><td
class="printindex-index-section"><a
href="#Internationalization">Internationalization</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-K">K</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-keyboard-interface">keyboard interface</a></td><td
class="printindex-index-section"><a href="#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-L">L</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-LDAP">LDAP</a></td><td class="printindex-index-section"><a
href="#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-left-quote">left quote</a></td><td
class="printindex-index-section"><a href="#Quote-Characters">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-legal-aspects">legal aspects</a></td><td
class="printindex-index-section"><a href="#Legal-Issues">Legal
Issues</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-legal-papers">legal papers</a></td><td
class="printindex-index-section"><a
href="#Contributions">Contributions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-length-of-source-lines">length of source lines</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-libexecdir"><code>libexecdir</code></a></td><td
class="printindex-index-section"><a href="#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-libiconv"><code>libiconv</code></a></td><td
class="printindex-index-section"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-libraries">libraries</a></td><td
class="printindex-index-section"><a href="#Libraries">Libraries</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-library-functions_002c-and-portability">library functions, and
portability</a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-library-interface">library interface</a></td><td
class="printindex-index-section"><a href="#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-license-for-manuals">license for manuals</a></td><td
class="printindex-index-section"><a href="#License-for-Manuals">License for
Manuals</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-line-length">line length</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-lint"><code>lint</code></a></td><td
class="printindex-index-section"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-locale_002dspecific-quote-characters">locale-specific quote
characters</a></td><td class="printindex-index-section"><a
href="#Quote-Characters">Quote Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-long-option-names">long option names</a></td><td
class="printindex-index-section"><a href="#Option-Table">Option
Table</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-long_002dnamed-options">long-named options</a></td><td
class="printindex-index-section"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-M">M</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-makefile_002c-conventions-for">makefile, conventions
for</a></td><td class="printindex-index-section"><a
href="#Makefile-Conventions">Makefile Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-malloc-return-value"><code class="code">malloc</code> return
value</a></td><td class="printindex-index-section"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a href="#index-man-pages">man
pages</a></td><td class="printindex-index-section"><a href="#Man-Pages">Man
Pages</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-manual-structure">manual structure</a></td><td
class="printindex-index-section"><a href="#Manual-Structure-Details">Manual
Structure Details</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-memory-allocation-failure">memory allocation failure</a></td><td
class="printindex-index-section"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-memory-leak">memory leak</a></td><td
class="printindex-index-section"><a href="#Memory-Usage">Memory
Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-memory-usage">memory usage</a></td><td
class="printindex-index-section"><a href="#Memory-Usage">Memory
Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-message-text_002c-and-internationalization">message text, and
internationalization</a></td><td class="printindex-index-section"><a
href="#Internationalization">Internationalization</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-mmap"><code>mmap</code></a></td><td
class="printindex-index-section"><a href="#Mmap">Mmap</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-multiple-variables-in-a-line">multiple variables in a
line</a></td><td class="printindex-index-section"><a
href="#Syntactic-Conventions">Syntactic Conventions</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-N">N</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-names-of-variables_002c-functions_002c-and-files">names of
variables, functions, and files</a></td><td class="printindex-index-section"><a
href="#Names">Names</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-NEWS-file"><samp class="file">NEWS</samp> file</a></td><td
class="printindex-index-section"><a href="#NEWS-File">NEWS File</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-non_002dASCII-characters">non-ASCII characters</a></td><td
class="printindex-index-section"><a href="#Character-Set">Character
Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-non_002dPOSIX-systems_002c-and-portability">non-POSIX systems, and
portability</a></td><td class="printindex-index-section"><a
href="#System-Portability">System Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-non_002dstandard-extensions">non-standard extensions</a></td><td
class="printindex-index-section"><a href="#Using-Extensions">Using
Extensions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-NUL-characters"><code class="code">NUL</code>
characters</a></td><td class="printindex-index-section"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-O">O</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-OID-allocations-for-GNU">OID allocations for GNU</a></td><td
class="printindex-index-section"><a href="#OID-Allocations">OID
Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-open-brace">open brace</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-opening-quote">opening quote</a></td><td
class="printindex-index-section"><a href="#Quote-Characters">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-optional-features_002c-configure_002dtime">optional features,
configure-time</a></td><td class="printindex-index-section"><a
href="#Configuration">Configuration</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-options-for-compatibility">options for compatibility</a></td><td
class="printindex-index-section"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-options_002c-standard-command_002dline">options, standard
command-line</a></td><td class="printindex-index-section"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-output-device-and-program_0027s-behavior">output device and
program’s behavior</a></td><td class="printindex-index-section"><a
href="#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-P">P</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-packaging">packaging</a></td><td
class="printindex-index-section"><a href="#Releases">Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-PATH_005fINFO_002c-specifying-standard-options-as">PATH_INFO,
specifying standard options as</a></td><td class="printindex-index-section"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-plug_002dins">plug-ins</a></td><td
class="printindex-index-section"><a
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-plugin_005fis_005fGPL_005fcompatible"><code>plugin_is_GPL_compatible</code></a></td><td
class="printindex-index-section"><a
href="#Dynamic-Plug_002dIn-Interfaces">Dynamic Plug-In Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-portability_002c-and-data-types">portability, and data
types</a></td><td class="printindex-index-section"><a
href="#CPU-Portability">CPU Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-portability_002c-and-library-functions">portability, and library
functions</a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-portability_002c-between-system-types">portability, between system
types</a></td><td class="printindex-index-section"><a
href="#System-Portability">System Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-POSIX-compatibility">POSIX compatibility</a></td><td
class="printindex-index-section"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-POSIX-functions_002c-and-portability">POSIX functions, and
portability</a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-POSIXLY_005fCORRECT_002c-environment-variable"><code
class="code">POSIXLY_CORRECT</code>, environment variable</a></td><td
class="printindex-index-section"><a
href="#Compatibility">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-post_002dinstallation-commands">post-installation
commands</a></td><td class="printindex-index-section"><a
href="#Install-Command-Categories">Install Command Categories</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-pre_002dinstallation-commands">pre-installation
commands</a></td><td class="printindex-index-section"><a
href="#Install-Command-Categories">Install Command Categories</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-prefix"><code>prefix</code></a></td><td
class="printindex-index-section"><a href="#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-program-configuration">program configuration</a></td><td
class="printindex-index-section"><a
href="#Configuration">Configuration</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-program-design">program design</a></td><td
class="printindex-index-section"><a href="#Design-Advice">Design
Advice</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-program-name-and-its-behavior">program name and its
behavior</a></td><td class="printindex-index-section"><a
href="#User-Interfaces">User Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-program_0027s-canonical-name">program’s canonical
name</a></td><td class="printindex-index-section"><a
href="#g_t_002d_002dversion">--version</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-programming-languages">programming languages</a></td><td
class="printindex-index-section"><a href="#Source-Language">Source
Language</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-proprietary-programs">proprietary programs</a></td><td
class="printindex-index-section"><a href="#Reading-Non_002dFree-Code">Reading
Non-Free Code</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-Q">Q</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-quote-characters">quote characters</a></td><td
class="printindex-index-section"><a href="#Quote-Characters">Quote
Characters</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-R">R</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-README-file"><samp class="file">README</samp> file</a></td><td
class="printindex-index-section"><a href="#Releases">Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-references-to-non_002dfree-material">references to non-free
material</a></td><td class="printindex-index-section"><a
href="#References">References</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-releasing">releasing</a></td><td
class="printindex-index-section"><a href="#Managing-Releases">Managing
Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-right-quote">right quote</a></td><td
class="printindex-index-section"><a href="#Quote-Characters">Quote
Characters</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-S">S</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-Savannah-repository-for-gnustandards">Savannah repository for
gnustandards</a></td><td class="printindex-index-section"><a
href="#Preface">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-sbindir"><code>sbindir</code></a></td><td
class="printindex-index-section"><a href="#Directory-Variables">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-signal-handling">signal handling</a></td><td
class="printindex-index-section"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-single-quote">single quote</a></td><td
class="printindex-index-section"><a href="#Quote-Characters">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-SNMP">SNMP</a></td><td class="printindex-index-section"><a
href="#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-software-forensics_002c-and-change-logs">software forensics, and
change logs</a></td><td class="printindex-index-section"><a
href="#Change-Logs">Change Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-spaces-before-open_002dparen">spaces before open-paren</a></td><td
class="printindex-index-section"><a href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-staged-installs">staged installs</a></td><td
class="printindex-index-section"><a href="#DESTDIR">DESTDIR</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-standard-command_002dline-options">standard command-line
options</a></td><td class="printindex-index-section"><a
href="#Command_002dLine-Interfaces">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-standards-for-makefiles">standards for makefiles</a></td><td
class="printindex-index-section"><a href="#Makefile-Conventions">Makefile
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-struct-types_002c-formatting"><code class="code">struct</code>
types, formatting</a></td><td class="printindex-index-section"><a
href="#Formatting">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-syntactic-conventions">syntactic conventions</a></td><td
class="printindex-index-section"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-T">T</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-table-of-long-options">table of long options</a></td><td
class="printindex-index-section"><a href="#Option-Table">Option
Table</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-temporary-files">temporary files</a></td><td
class="printindex-index-section"><a href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-temporary-variables">temporary variables</a></td><td
class="printindex-index-section"><a href="#Syntactic-Conventions">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-texinfo_002etex_002c-in-a-distribution"><samp
class="file">texinfo.tex</samp>, in a distribution</a></td><td
class="printindex-index-section"><a href="#Releases">Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-title_002c-change-log-entry">title, change log entry</a></td><td
class="printindex-index-section"><a href="#Change-Log-Concepts">Change Log
Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-TMPDIR-environment-variable"><code class="code">TMPDIR</code>
environment variable</a></td><td class="printindex-index-section"><a
href="#Semantics">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-trademarks">trademarks</a></td><td
class="printindex-index-section"><a href="#Trademarks">Trademarks</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-U">U</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-user-interface-styles">user interface styles</a></td><td
class="printindex-index-section"><a href="#Graphical-Interfaces">Graphical
Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-V">V</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-valgrind"><code>valgrind</code></a></td><td
class="printindex-index-section"><a href="#Memory-Usage">Memory
Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-VCS">VCS</a></td><td class="printindex-index-section"><a
href="#Change-Logs">Change Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-version-control-system_002c-for-keeping-change-logs">version
control system, for keeping change logs</a></td><td
class="printindex-index-section"><a href="#Change-Logs">Change
Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-version-numbers_002c-for-releases">version numbers, for
releases</a></td><td class="printindex-index-section"><a
href="#Releases">Releases</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-W">W</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-where-to-obtain-standards_002etexi">where to obtain <code
class="code">standards.texi</code></a></td><td
class="printindex-index-section"><a href="#Preface">Preface</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-X">X</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-X_002e509">X.509</a></td><td class="printindex-index-section"><a
href="#OID-Allocations">OID Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="#index-xmalloc_002c-in-Gnulib"><code>xmalloc, in
Gnulib</code></a></td><td class="printindex-index-section"><a
href="#System-Functions">System Functions</a></td></tr>
+<tr><td colspan="3"><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>
+<table class="cp-letters-footer-printindex"><tr><th>Jump to:
</th><td><a class="summary-letter-printindex"
href="#Index_cp_symbol-1"><b>-</b></a>
-<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-G"><b>G</b></a>
-<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
+<a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a>
-<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-W"><b>W</b></a>
-<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+<a class="summary-letter-printindex" href="#Index_cp_letter-X"><b>X</b></a>
</td></tr></table>
+</div>
-<hr>
+</div>
+</div>
Index: standards.html.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.html.gz,v
retrieving revision 1.98
retrieving revision 1.99
diff -u -b -r1.98 -r1.99
Binary files /var/tmp/cvsTXhwqG and /var/tmp/cvs48Oq9X differ
Index: standards.html_node.tar.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.html_node.tar.gz,v
retrieving revision 1.98
retrieving revision 1.99
diff -u -b -r1.98 -r1.99
Binary files /var/tmp/cvshiM5IJ and /var/tmp/cvsszKVt1 differ
Index: standards.info.tar.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.info.tar.gz,v
retrieving revision 1.97
retrieving revision 1.98
diff -u -b -r1.97 -r1.98
Binary files /var/tmp/cvsGvsV7I and /var/tmp/cvsHjg1T0 differ
Index: standards.pdf
===================================================================
RCS file: /web/www/www/prep/standards/standards.pdf,v
retrieving revision 1.97
retrieving revision 1.98
diff -u -b -r1.97 -r1.98
Binary files /var/tmp/cvs1ScMyI and /var/tmp/cvspjwyn0 differ
Index: standards.texi.tar.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.texi.tar.gz,v
retrieving revision 1.97
retrieving revision 1.98
diff -u -b -r1.97 -r1.98
Binary files /var/tmp/cvsaOpBrM and /var/tmp/cvsB2G6h4 differ
Index: standards.txt
===================================================================
RCS file: /web/www/www/prep/standards/standards.txt,v
retrieving revision 1.95
retrieving revision 1.96
diff -u -b -r1.95 -r1.96
--- standards.txt 8 Jul 2021 18:18:42 -0000 1.95
+++ standards.txt 29 May 2024 18:09:30 -0000 1.96
@@ -19,8 +19,8 @@
4.6 Finding the Program's Executable and Associated Files
4.7 Standards for Graphical Interfaces
4.8 Standards for Command Line Interfaces
- 4.8.1 '--version'
- 4.8.2 '--help'
+ 4.8.1 â--versionâ
+ 4.8.2 â--helpâ
4.9 Standards for Dynamic Plug-in Interfaces
4.10 Table of Long Options
4.11 OID Allocations
@@ -60,7 +60,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
@@ -68,12 +68,13 @@
8 References to Non-Free Software and Documentation
Appendix A GNU Free Documentation License
Index
+
GNU Coding Standards
********************
-The GNU coding standards, last updated July 1, 2021.
+The GNU coding standards, last updated May 26, 2024.
- Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
+ Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012,
2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free Software Foundation,
Inc.
@@ -107,7 +108,7 @@
Contents: (maintain)Top.).
If you want to receive diffs for every change to these GNU documents,
-join the mailing list 'gnustandards-commit@gnu.org', via the web
+join the mailing list âgnustandards-commit@gnu.orgâ, via the web
interface at
<https://lists.gnu.org/mailman/listinfo/gnustandards-commit>. Archives
are also available there.
@@ -137,8 +138,8 @@
coding standards for a trivial program.
<https://www.gnu.org/software/hello/hello.html>.
- This release of the GNU Coding Standards was last updated July 1,
-2021.
+ This release of the GNU Coding Standards was last updated May 26,
+2024.
2 Keeping Free Software Free
****************************
@@ -299,22 +300,22 @@
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
+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
+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.
@@ -332,8 +333,8 @@
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
@@ -392,18 +393,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
@@ -420,7 +421,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.
@@ -442,15 +443,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
@@ -491,15 +492,15 @@
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
+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').
+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
@@ -523,27 +524,27 @@
range of encodings.
Check every system call for an error return, unless you know you wish
-to ignore errors. Include the system error text (from 'strerror', or
+to ignore errors. Include the system error text (from â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
-'NULL'. 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
+ Check every call to âmallocâ or âreallocâ to see if it returned
+âNULLâ. 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.
- 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
@@ -555,18 +556,18 @@
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
+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.
@@ -583,9 +584,9 @@
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 you make temporary files, check the âTMPDIRâ environment variable;
if that variable is defined, use the specified directory instead of
-'/tmp'.
+â/tmpâ.
In addition, be aware that there is a possible security problem when
creating temporary files in world-writable directories. In C, you can
@@ -593,11 +594,11 @@
fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600);
-or by using the 'mkstemps' function from Gnulib (*note
+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
+ 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::).
@@ -606,7 +607,7 @@
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.
@@ -621,7 +622,7 @@
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
+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.
@@ -641,14 +642,13 @@
SOURCEFILE:LINENO:COLUMN: MESSAGE
SOURCEFILE:LINENO.COLUMN: MESSAGE
-
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
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
@@ -700,7 +700,7 @@
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. Thus, if you
-make 'foo' a link to 'ls', the program should behave the same regardless
+make âfooâ a link to âlsâ, the program should behave the same
regardless
of which of those names is used to invoke it.
Instead, use a run time option or a compilation switch or both to
@@ -727,15 +727,15 @@
binary data. Sending such output to a terminal is useless and can cause
trouble. If such a program normally sends its output to stdout, it
should detect, in these cases, when the output is a terminal and give an
-error message instead. The '-f' option should override this exception,
+error message instead. The â-fâ option should override this exception,
thus permitting the output to go to the terminal.
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 Finding the Program's Executable and Associated Files
@@ -746,24 +746,24 @@
either source files or files constructed by building, that it uses at
run time.
- The way to find them starts with looking at 'argv[0]'.
+ The way to find them starts with looking at âargv[0]â.
If that string contains a slash, it is by convention the file name of
the executable and its directory part is the directory that contained
the executable. This is the case when the program was not found through
-'PATH', which normally means it was built but not installed, and run
-from the build directory. The program can use the 'argv[0]' file name
+âPATHâ, which normally means it was built but not installed, and run
+from the build directory. The program can use the âargv[0]â file name
to relaunch itself, and can look in its directory part for associated
files. If that file name is not absolute, then it is relative to the
working directory in which the program started.
- If 'argv[0]' does not contain a slash, it is a command name whose
-executable was found via 'PATH'. The program should search for that
-name in the directories in 'PATH', interpreting '.' as the working
+ If âargv[0]â does not contain a slash, it is a command name whose
+executable was found via âPATHâ. The program should search for that
+name in the directories in âPATHâ, interpreting â.â as the working
directory that was current when the program started.
If this procedure finds the executable, we call the directory it was
-found in the "invocation directory". The program should check for the
+found in the âinvocation directoryâ. The program should check for the
presence in that directory of the associated files it needs.
If the program's executable is normally built in a subdirectory of
@@ -779,28 +779,28 @@
If this procedure doesn't come up with an invocation directory that
is valid--normally the case for an installed program that was found via
-'PATH'--the program should look for the associated files in the
+âPATHâ--the program should look for the associated files in the
directories where the program's makefile installs them. *Note Directory
Variables::.
- Providing valid information in 'argv[0]' is a convention, not
+ Providing valid information in âargv[0]â is a convention, not
guaranteed. Well-behaved programs that launch other programs, such as
shells, follow the convention; your code should follow it too, when
launching other programs. But it is always possible to launch the
-program and give a nonsensical value in 'argv[0]'.
+program and give a nonsensical value in âargv[0]â.
Therefore, any program that needs to know the location of its
executable, or that of of other associated files, should offer the user
environment variables to specify those locations explicitly.
- *Don't give special privilege, such as with the 'setuid' bit, to
+ *Don't give special privilege, such as with the âsetuidâ bit, to
programs that will search heuristically for associated files or for
their own executables when invoked that way.* Limit that privilege to
programs that find associated files in hard-coded installed locations
-such as under '/usr' and '/etc'.
+such as under â/usrâ and â/etcâ.
*Note (bash)Bourne Shell Variables::, for more information about
-'PATH'.
+âPATHâ.
4.7 Standards for Graphical Interfaces
======================================
@@ -833,40 +833,40 @@
=========================================
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
+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.8.1 '--version'
+4.8.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
@@ -879,9 +879,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:
@@ -908,9 +908,9 @@
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
-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
+of the 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.
It is ok to finish the output with a list of the major authors of the
@@ -937,7 +937,7 @@
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);
@@ -948,13 +948,13 @@
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. In
+Any abbreviation can be followed by âvVERSION[+]â, meaning that
+particular version, or later versions with the â+â, as shown above. In
the case of a GNU license, _always_ indicate the permitted versions in
this way.
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
@@ -1014,17 +1014,17 @@
More information about these licenses and many more are on the GNU
licensing web pages, <https://www.gnu.org/licenses/license-list.html>.
-4.8.2 '--help'
+4.8.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.
- 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 'https://www.gnu.org/software/PKG'), and the general page for
+(normally âhttps://www.gnu.org/software/PKGâ), and the general page for
help using GNU programs. The format should be like this:
Report bugs to: MAILING-ADDRESS
@@ -1050,7 +1050,7 @@
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
+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.).
@@ -1074,1084 +1074,1084 @@
please send <bug-standards@gnu.org> 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 choose 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.
-'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.11 OID Allocations
====================
@@ -2221,7 +2221,7 @@
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
@@ -2230,9 +2230,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 'NULL'.
+in memory and give a fatal error if âmallocâ returns âNULLâ.
- 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.
@@ -2240,15 +2240,15 @@
4.13 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.
@@ -2272,7 +2272,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
@@ -2304,7 +2304,7 @@
double a_double, float a_float)
...
- For 'struct' and 'enum' types, likewise put the braces in column one,
+ For âstructâ and âenumâ types, likewise put the braces in column
one,
unless the whole contents fits on one line:
struct foo
@@ -2315,7 +2315,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
@@ -2396,8 +2396,8 @@
========================
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
+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,
@@ -2416,7 +2416,7 @@
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
@@ -2449,10 +2449,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
@@ -2464,7 +2464,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
...
@@ -2480,31 +2480,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.
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
@@ -2513,7 +2513,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
@@ -2534,8 +2534,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)
@@ -2554,16 +2554,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)
...
@@ -2577,8 +2577,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)) == NULL)
fatal ("virtual memory exhausted");
@@ -2607,11 +2607,11 @@
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
@@ -2622,17 +2622,17 @@
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
@@ -2642,18 +2642,33 @@
versions. For a GNU program, this kind of portability is desirable, but
not paramount.
- 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 CPU. 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.
-
- 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
-be hard.
+ The primary purpose of GNU software is to run as part of the GNU
+operating system, compiled with GNU compilers, on various types of
+hardware. So the kinds of portability that are absolutely necessary are
+quite limited. It is important to support Linux-based GNU systems,
+since they are the form of GNU that people mainly use.
+
+ Making a GNU program operate on operating systems other than the GNU
+system is not part of the core goal of developing a GNU package. You
+don't ever have to do that. However, users will ask you to do that, and
+cooperating with those requests is useful--as long as you don't let it
+dominate the project or impede the primary goal.
+
+ It is good to support the other free or nearly free operating systems
+(for instance, *BSD). 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 be hard.
+
+ For the most part it is good to port the program to more platforms,
+but you should not let take up so much of your time that it hinders you
+from improving the program in more central ways. If it starts to do
+that, please tell users that you don't want to spend any more time on
+this--someone else must write that code, debug it, document it, etc.,
+and then you can install it.
+
+ You can reject porting patches for technical reasons too, as with any
+other patch that users submit. It is up to you.
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
@@ -2662,7 +2677,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 MS-DOS, Windows, VMS,
MVS, and older Macintosh systems, supporting them is often a lot of
@@ -2675,11 +2690,11 @@
Usually we write the name "Windows" in full, but when brevity is very
important (as in file names and some symbol names), we abbreviate it to
-"w". In GNU Emacs, for instance, we use 'w32' in file names of
+"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'. In principle there could also be 'w64'.
+âWINDOWSNTâ. In principle there could also be âw64â.
- It is a good idea to define the "feature test macro" '_GNU_SOURCE'
+ 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
@@ -2697,14 +2712,14 @@
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
+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.
- You need not cater to the possibility that 'long' will be smaller
-than pointers and 'size_t'. We know of one such platform: 64-bit
+ You need not cater to the possibility that âlongâ will be smaller
+than pointers and âsize_tâ. We know of one such platform: 64-bit
programs on Microsoft Windows. If you care about making your package
run on Windows using Mingw64, you would need to deal with 8-byte
-pointers and 4-byte 'long', which would break this code:
+pointers and 4-byte âlongâ, which would break this code:
printf ("size = %lu\n", (unsigned long) sizeof array);
printf ("diff = %ld\n", (long) (pointer2 - pointer1));
@@ -2716,12 +2731,12 @@
program run on Windows, and you are not interested, you can respond
with, "Switch to GNU/Linux -- your freedom depends on 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:
@@ -2730,8 +2745,8 @@
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
+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;
@@ -2747,7 +2762,7 @@
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
+normal range of addresses you can get from âmallocâ starts far away from
zero.
5.7 Calling System Functions
@@ -2770,19 +2785,19 @@
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 (https://www.gnu.org/software/gnulib/) is a big help in this
regard. Gnulib provides implementations of standard interfaces on many
@@ -2794,7 +2809,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
@@ -2815,22 +2830,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
-'%s'..."' with a translated version.
+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
+ 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
@@ -2865,9 +2880,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
@@ -2895,7 +2910,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),
@@ -2909,7 +2924,7 @@
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
+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 (*note Change Logs::).
@@ -2921,11 +2936,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
@@ -2933,13 +2948,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.
@@ -2947,22 +2962,22 @@
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
=========
-If you use 'mmap' to read or write files, don't assume it either works
+If you use âmmapâ to read or write files, don't assume it 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
+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.
@@ -2983,8 +2998,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
@@ -3046,9 +3061,9 @@
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
+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
+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
@@ -3106,20 +3121,20 @@
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
+ 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.
Whenever possible, please stick to the active voice, avoiding the
passive, and use the present tense, not the future tense. For instance,
-write "The function 'foo' returns a list containing A and B" rather than
+write "The function âfooâ returns a list containing A and B" rather than
"A list containing A and B will be returned." One advantage of the
active voice is it requires you to state the subject of the sentence;
with the passive voice, you might omit the subject, which leads to
vagueness.
It is proper to use the future tense when grammar demands it, as in,
-"If you type 'x', the computer will self-destruct in 10 seconds."
+"If you type âxâ, the computer will self-destruct in 10 seconds."
6.2 Doc Strings and Manuals
===========================
@@ -3158,17 +3173,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 '@example' 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.
@@ -3218,15 +3233,15 @@
6.7 The NEWS File
=================
-In addition to its manual, the package should have a file named 'NEWS'
+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
@@ -3242,33 +3257,33 @@
why the conflicting changes were made.
Therefore, change logs should be detailed enough and accurate enough
-to provide the information commonly required for such "software
-forensics". Specifically, change logs should make finding answers to
+to provide the information commonly required for such âsoftware
+forensicsâ. Specifically, change logs should make finding answers to
the following questions easy:
- * What changes affected a particular source file?
+ ⢠What changes affected a particular source file?
- * Was a particular source file renamed or moved, and if so, as part
+ ⢠Was a particular source file renamed or moved, and if so, as part
of what change?
- * What changes affected a given function or macro or definition of a
+ ⢠What changes affected a given function or macro or definition of a
data structure?
- * Was a function (or a macro or the definition of a data structure)
+ ⢠Was a function (or a macro or the definition of a data structure)
renamed or moved from another file, and if so, as part of which
change?
- * What changes deleted a function (or macro or data structure)?
+ ⢠What changes deleted a function (or macro or data structure)?
- * What was the rationale for a given change, and what were its main
+ ⢠What was the rationale for a given change, and what were its main
ideas?
- * Is there any additional information regarding the change, and if
+ ⢠Is there any additional information regarding the change, and if
so, where can it be found?
Historically, change logs were maintained on specially formatted
files. Nowadays, projects commonly keep their source files under a
-"version control system" (VCS), such as Git, Subversion, or Mercurial.
+âversion control systemâ (VCS), such as Git, Subversion, or Mercurial.
If the VCS repository is publicly accessible, and changes are committed
to it separately (one commit for each logical changeset) and record the
authors of each change, then the information recorded by the VCS can be
@@ -3282,14 +3297,14 @@
If you decide not to maintain separate change log files, you should
still consider providing them in the release tarballs, for the benefit
of users who'd like to review the change logs without accessing the
-project's VCS repository. Scripts exist that can produce 'ChangeLog'
-files from the VCS logs; for example, the 'gitlog-to-changelog' script,
+project's VCS repository. Scripts exist that can produce âChangeLogâ
+files from the VCS logs; for example, the âgitlog-to-changelogâ script,
which is part of Gnulib, can do that for Git repositories. In Emacs,
-the command 'C-x v a' ('vc-update-change-log') does the job of
-incrementally updating a 'ChangeLog' file from the VCS logs.
+the command âC-x v aâ (âvc-update-change-logâ) does the job of
+incrementally updating a âChangeLogâ file from the VCS logs.
If separate change log files _are_ maintained, they are normally
-called 'ChangeLog', and each such file covers an entire directory. Each
+called âChangeLogâ, and each such file covers an entire directory. Each
directory can have its own change log file, or a directory can use the
change log of its parent directory--it's up to you.
@@ -3300,16 +3315,16 @@
how earlier versions were different from the current version. 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. Each "entry" in a change log
+of how the earlier version differed. Each âentryâ in a change log
describes either an individual change or the smallest batch of changes
-that belong together, also known as a "changeset".
+that belong together, also known as a âchangesetâ.
- It is a good idea to start the change log entry with a "header line":
+ It is a good idea to start the change log entry with a âheader lineâ:
a single line that is a complete sentence which summarizes the
changeset. If you keep the change log in a VCS, this should be a
requirement, as VCS commands that show the change log in abbreviated
-form, such as 'git log --oneline', treat the header line specially. (In
-a 'ChangeLog' file, the header line follows a line that says who was the
+form, such as âgit log --onelineâ, treat the header line specially. (In
+a âChangeLogâ file, the header line follows a line that says who was the
author of the change and when it was installed.)
Follow the change log entry's header line with a description of the
@@ -3354,7 +3369,7 @@
please consider the following benefits of providing the list of changed
entities with each change:
- * Generation of useful 'ChangeLog' files from VCS logs becomes more
+ ⢠Generation of useful âChangeLogâ files from VCS logs becomes more
difficult if the change log entries don't list the modified
functions/macros, because VCS commands cannot reliably reproduce
their names from the commit information alone. For example, when
@@ -3364,24 +3379,24 @@
before the one being modified), so using those diffs to glean the
names of the modified functions will produce inaccurate results.
You will need to use specialized scripts, such as gnulib's
- 'vcs-to-changelog.py', mentioned below, to solve these
+ âvcs-to-changelog.pyâ, mentioned below, to solve these
difficulties, and make sure it supports the source languages used
by your project.
- * While modern VCS commands, such as Git's 'git log -L' and 'git log
- -G', provide powerful means for finding changes that affected a
+ ⢠While modern VCS commands, such as Git's âgit log -Lâ and âgit log
+ -Gâ, provide powerful means for finding changes that affected a
certain function or macro or data structure (and thus might make
- 'ChangeLog' files unnecessary if you have the repository
- available), they can sometimes fail. For example, 'git log -L'
+ âChangeLogâ files unnecessary if you have the repository
+ available), they can sometimes fail. For example, âgit log -Lâ
doesn't support syntax of some programming languages out of the
box. Mentioning the modified functions/macros explicitly allows
finding the related changes simply and reliably.
- * Some VCS commands have difficulties or limitations when tracking
+ ⢠Some VCS commands have difficulties or limitations when tracking
changes across file moves or renames. Again, if the entities are
mentioned explicitly, those difficulties can be overcome.
- * Users that review changes using the generated 'ChangeLog' files may
+ ⢠Users that review changes using the generated âChangeLogâ files may
not have the repository and the VCS commands available to them.
Naming the modified entities alleviates that problem.
@@ -3390,14 +3405,14 @@
recommend to include them whenever possible and practical.
It is also possible to generate the lists naming the modified
-entities by running a script. One such script is 'mklog.py' (written in
-Python 3); it is used by the 'GCC' project. Gnulib provides another
-variant of such a script, called 'vcs-to-changelog.py', part of the
-'vcs-to-changelog' module. Note that these scripts currently support
+entities by running a script. One such script is âmklog.pyâ (written in
+Python 3); it is used by the âGCCâ project. Gnulib provides another
+variant of such a script, called âvcs-to-changelog.pyâ, part of the
+âvcs-to-changelogâ module. Note that these scripts currently support
fewer programming languages than the manual commands provided by Emacs
(*note Style of Change Logs::). Therefore, the above mentioned method
-of generating the 'ChangeLog' file from the VCS commit history, for
-instance via the 'gitlog-to-changelog' script, usually gives better
+of generating the âChangeLogâ file from the VCS commit history, for
+instance via the âgitlog-to-changelogâ script, usually gives better
results--provided that the contributors stick to providing good commit
messages.
@@ -3409,7 +3424,7 @@
followed by descriptions of specific changes. (These examples are drawn
from Emacs.) Keep in mind that the line which shows the date of the
change and the author's name and email address is needed only in a
-separate 'ChangeLog' file, not when the change logs are kept in a VCS.
+separate âChangeLogâ file, not when the change logs are kept in a VCS.
2019-08-29 Noam Postavsky <npostavs@gmail.com>
@@ -3446,9 +3461,9 @@
it; if you abbreviate the name, 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. Don't put
blank lines between individual changes of an entry. You can omit the
@@ -3456,15 +3471,15 @@
same file.
Break long lists of function names by closing continued lines with
-')', rather than ',', and opening the continuation with '('. This makes
+â)â, rather than â,â, and opening the continuation with â(â. This
makes
highlighting in Emacs work better. Here is an example:
* src/keyboard.c (menu_bar_items, tool_bar_items)
(Fexecute_extended_command): Deal with 'keymap' property.
- The easiest way to add an entry to 'ChangeLog' is with the Emacs
-command 'M-x add-change-log-entry', or its variant 'C-x 4 a'
-('add-change-log-entry-other-window'). This automatically collects the
+ The easiest way to add an entry to âChangeLogâ is with the Emacs
+command âM-x add-change-log-entryâ, or its variant âC-x 4 aâ
+(âadd-change-log-entry-other-windowâ). This automatically collects the
name of the changed file and the changed function or variable, and
formats a change log entry according to the conventions described above,
leaving it up to you to describe the changes you made to that function
@@ -3485,22 +3500,22 @@
* sewing.c: Make it sew. Patch by jdoe@gnu.org.
When committing someone else's changes into a VCS, use the VCS
-features to specify the author. For example, with Git, use 'git commit
---author=AUTHOR'.
+features to specify the author. For example, with Git, use âgit commit
+--author=AUTHORâ.
As for the date, that should be the date you applied the change.
-(With a VCS, use the appropriate command-line switches, e.g., 'git
-commit --date=DATE'.)
+(With a VCS, use the appropriate command-line switches, e.g., âgit
+commit --date=DATEâ.)
Modern VCS have commands to apply changes sent via email (e.g., Git
-has 'git am'); in that case the author of the changeset and the date it
+has âgit amâ); in that case the author of the changeset and the date it
was made will be automatically gleaned from the email message and
recorded in the repository. If the patches are prepared with suitable
-VCS commands, such as 'git format-patch', the email message body will
+VCS commands, such as âgit format-patchâ, the email message body will
also have the original author of the changeset, so resending or
forwarding the message will not interfere with attributing the changes
to their author. Thus, we recommend that you request your contributors
-to use commands such as 'git format-patch' to prepare the patches.
+to use commands such as âgit format-patchâ to prepare the patches.
6.8.3 Simple Changes
--------------------
@@ -3558,9 +3573,9 @@
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
+â#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.
@@ -3588,14 +3603,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
+ 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:
+contained in a â#ifdef HAVE_LIBNCURSESâ conditional:
* dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call tgetent.
@@ -3609,8 +3624,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.
@@ -3656,7 +3671,7 @@
Finally, the GNU help2man program
(<https://www.gnu.org/software/help2man/>) is one way to automate
-generation of a man page, in this case from '--help' output. This is
+generation of a man page, in this case from â--helpâ output. This is
sufficient in many cases.
6.10 Reading other Manuals
@@ -3688,65 +3703,65 @@
7.1 How Configuration Should Work
=================================
-Each GNU distribution should come with a shell script named 'configure'.
+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
+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
+ 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
+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
+ 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'.
+â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 stating 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
+ 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
+ In addition, the âconfigureâ script should take options corresponding
to most of the standard directory variables (*note Directory
Variables::). Here is the list:
@@ -3756,79 +3771,79 @@
--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â
(https://git.savannah.gnu.org/cgit/config.git/plain/config.sub) 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â
(https://git.savannah.gnu.org/cgit/config.git/plain/config.guess).
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'
+ 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'
+â--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
- CXXFLAGS=-g' to build with debugging information and without the
+ 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
+ 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
+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
@@ -3838,29 +3853,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
@@ -3878,11 +3893,11 @@
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
+ 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:
@@ -3893,27 +3908,27 @@
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
+ 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
+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
+ 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
+ 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
+â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
@@ -3924,9 +3939,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
@@ -3945,27 +3960,27 @@
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
+ awk cat cmp cp diff echo 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
--p', convenient as it may be, because a few systems don't support it at
+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:
(autoconf)Portable Shell.
@@ -3974,23 +3989,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
+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
+ 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.)
+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.
@@ -4010,28 +4025,28 @@
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
+ 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,
+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
+âCFLAGSâ, by writing them explicitly in the compilation commands or by
defining an implicit rule, like this:
CFLAGS = -g
@@ -4039,33 +4054,33 @@
.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
-644'.) Then it should use those variables as the commands for actual
+ 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:
$(INSTALL_PROGRAM) foo $(bindir)/foo
$(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
- However, it is preferable to support a 'DESTDIR' prefix on the target
+ 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
@@ -4073,48 +4088,48 @@
$(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
+ 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.
+ 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
+ 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
+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
+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
+strongly recommend GNU packages support âDESTDIRâ, though it is not an
absolute requirement.
7.2.5 Variables for Installation Directories
@@ -4126,9 +4141,9 @@
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
---prefix=/usr'). GNU packages should not try to guess which value
+ 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
packages behave identically, allowing the installer to achieve any
@@ -4142,66 +4157,66 @@
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 '@prefix@'.)
+ 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
- '@exec_prefix@'.)
+ 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
+ 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
- '@bindir@'.)
+ 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 '@sbindir@'.)
+ 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 '@libexecdir@'.)
+ â/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
+ 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
+ install their data under â$(libexecdir)/PACKAGE-NAME/â, possibly
within additional subdirectories thereof, such as
- '$(libexecdir)/PACKAGE-NAME/MACHINE/VERSION'.
+ â$(libexecdir)/PACKAGE-NAME/MACHINE/VERSIONâ.
Data files used by the program during its execution are divided into
categories in two ways.
- * Some files are normally modified by programs; others are never
+ ⢠Some files are normally modified by programs; others are never
normally modified (though users may edit some of these).
- * Some files are architecture-independent and can be shared by all
+ ⢠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.
@@ -4214,205 +4229,206 @@
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 '@datarootdir@'.) 'datadir''s default
- value is based on this variable; so are 'infodir', 'mandir', and
+ â/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
- '@datadir@'.)
+ 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
+ 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@'.)
+ â/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
- 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)'.
+ This directory is not the right place to install executables built
+ by running âmakeâ--they probably belong in â$(libexecdir)â or
+ â$(sbindir)â. Also do not install here files that will be 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)â.
-'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 '@sharedstatedir@'.)
+ â/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
- '@localstatedir@'.)
+ 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@â.)
-'runstatedir'
+ârunstatedirâ
The directory for installing data files which the programs modify
while they run, that pertain to one specific machine, and which
need not persist longer than the execution of the program--which is
generally long-lived, for example, until the next reboot. PID
files for system daemons are a typical use. In addition, this
directory should not be cleaned except perhaps at reboot, while the
- general '/tmp' ('TMPDIR') may be cleaned arbitrarily. This should
- normally be '/var/run', but write it as '$(localstatedir)/run'.
- Having it as a separate variable allows the use of '/run' if
+ general â/tmpâ (âTMPDIRâ) may be cleaned arbitrarily. This should
+ normally be â/var/runâ, but write it as â$(localstatedir)/runâ.
+ Having it as a separate variable allows the use of â/runâ if
desired, for example. (If you are using Autoconf 2.70 or later,
- write it as '@runstatedir@'.)
+ write it as â@runstatedir@â.)
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'.
+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
- '@includedir@'.)
+ 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'.
+ â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@'.)
+â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;
+ â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 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 '@docdir@'.) 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 '@infodir@'.) '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 '@htmldir@', '@dvidir@', etc.)
+ 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'.
+ 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 '@libdir@'.)
+ â$(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 '@lispdir@'. In
- order to make '@lispdir@' work, you need the following lines in
- your 'configure.ac' 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.acâ 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 '@localedir@'.) This directory usually
+ 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 '@mandir@'.)
+ 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
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
+â...â
+ 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:
@@ -4432,7 +4448,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
@@ -4454,19 +4470,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
@@ -4476,33 +4492,33 @@
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
+ handle some additional situations, such as âinstall-infoâ not being
present.
do-install-info: foo.info installdirs
@@ -4524,36 +4540,36 @@
"$(DESTDIR)$(infodir)/foo.info"; \
else true; fi
- 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
+ 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.
+ 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
+ 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
+ â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.
@@ -4562,9 +4578,9 @@
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:
@@ -4572,10 +4588,10 @@
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.
@@ -4584,67 +4600,67 @@
install a stripped executable for actual execution while saving the
unstripped executable elsewhere in case there is a bug.
-'clean'
+â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
+ 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
+ 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'
+âinfoâ
Generate any Info files needed. The best way to write the rules is
as follows:
@@ -4653,8 +4669,8 @@
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
@@ -4663,14 +4679,14 @@
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:
@@ -4680,11 +4696,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:
@@ -4694,32 +4710,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
@@ -4728,15 +4744,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:
@@ -4747,7 +4763,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.
@@ -4763,9 +4779,9 @@
7.2.7 Install Command Categories
--------------------------------
-When writing the 'install' target, you must classify all the commands
-into three categories: normal ones, "pre-installation" commands and
-"post-installation" commands.
+When writing the âinstallâ target, you must classify all the commands
+into three categories: normal ones, âpre-installationâ commands and
+âpost-installationâ commands.
Normal commands move files into their proper places, and set their
modes. They may not alter any files except the ones that come entirely
@@ -4780,7 +4796,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
@@ -4789,8 +4805,8 @@
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
-categories, insert "category lines" among them. A category line
+ 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.
A category line consists of a tab and a reference to a special Make
@@ -4807,12 +4823,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.
@@ -4821,7 +4837,7 @@
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
+ 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
@@ -4832,7 +4848,7 @@
programs except for these:
[ basename bash cat chgrp chmod chown cmp cp dd diff echo
- egrep expand expr false fgrep find getopt grep gunzip gzip
+ expand expr false 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
@@ -4846,7 +4862,7 @@
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 \
@@ -4855,7 +4871,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}
@@ -4868,44 +4884,44 @@
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" and "non-source files". Source files are written by humans and
+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' with a general
+ The distribution should contain a file named âREADMEâ with a general
overview of the package:
- * the name of the package;
+ ⢠the name of the package;
- * the version number of the package, or refer to where in the package
+ ⢠the version number of the package, or refer to where in the package
the version can be found;
- * a general description of what the package does;
+ ⢠a general description of what the package does;
- * a reference to the file 'INSTALL', which should in turn contain an
+ ⢠a reference to the file âINSTALLâ, which should in turn contain an
explanation of the installation procedure;
- * a brief explanation of any unusual top-level directories or files,
+ ⢠a brief explanation of any unusual top-level directories or files,
or other hints for readers to find their way around the source;
- * a reference 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'.
+ ⢠a reference 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â.
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, 'flex',
-TeX, and 'makeinfo'; this helps avoid unnecessary dependencies between
+include non-source files produced by Autoconf, Automake, Bison, âflexâ,
+TeX, and âmakeinfoâ; this helps avoid unnecessary dependencies between
our distributions, so that users can install whichever versions of
whichever packages they like. Do not induce new dependencies on other
software lightly.
@@ -4919,7 +4935,7 @@
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
+â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.
@@ -4932,12 +4948,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
@@ -5012,15 +5028,15 @@
depend on non-free 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
+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
+â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
@@ -5058,22 +5074,22 @@
A web page recommends a program in an implicit but particularly
strong way if it requires users to run that program in order to use the
-page. Many pages contain Javascript code which they recommend in this
-way. This Javascript code may be free or nonfree, but nonfree is the
+page. Many pages contain JavaScript code which they recommend in this
+way. This JavaScript code may be free or non-free, but non-free is the
usual case.
If the purpose for which you would refer to the page cannot be
-carried out without running nonfree Javascript code, then you should not
-refer to it. Thus, if the purpose of referring to the page is for
+carried out without running non-free JavaScript code, then you should
+not refer to it. Thus, if the purpose of referring to the page is for
people to view a video, or subscribing to a mailing list, and the
viewing or subscribing fail to work if the user's browser blocks the
-nonfree Javascript code, then don't refer to that page.
+non-free JavaScript code, then don't refer to that page.
- The extreme case is that of web sites which depend on nonfree
-Javascript code even to _see_ the contents of the pages. Any site
-hosted on 'wix.com' has this problem, and so do some other sites.
+ The extreme case is that of web sites which depend on non-free
+JavaScript code even to _see_ the contents of the pages. Any site
+hosted on âwix.comâ has this problem, and so do some other sites.
Referring people to such pages to read their contents is, in effect,
-urging them to run those nonfree programs--so please don't refer to
+urging them to run those non-free programs--so please don't refer to
those pages. (Such pages also break the Web, so they deserve
condemnation for two reasons.)
@@ -5085,7 +5101,7 @@
Version 1.3, 3 November 2008
- Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+ Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
<https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
@@ -5094,7 +5110,7 @@
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other
- functional and useful document "free" in the sense of freedom: to
+ functional and useful document âfreeâ 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
@@ -5564,241 +5580,241 @@
* Menu:
-* #endif, commenting: Comments. (line 2451)
* --help output: --help. (line 1019)
* --version output: --version. (line 868)
* -Wall compiler option: Syntactic Conventions.
(line 2484)
-* accepting contributions: Contributions. (line 185)
+* #endif, commenting: Comments. (line 2451)
+* accepting contributions: Contributions. (line 186)
* address for bug reports: --help. (line 1024)
-* ANSI C standard: Standard C. (line 355)
-* arbitrary limits on data: Semantics. (line 514)
-* ASCII characters: Character Set. (line 2906)
-* autoconf: System Portability. (line 2657)
+* ANSI C standard: Standard C. (line 356)
+* arbitrary limits on data: Semantics. (line 515)
+* ASCII characters: Character Set. (line 2921)
+* autoconf: System Portability. (line 2672)
* avoiding proprietary code: Reading Non-Free Code.
- (line 151)
+ (line 152)
* batch of changes, in a change log: Change Log Concepts.
- (line 3298)
+ (line 3313)
* behavior, dependent on program's name: User Interfaces. (line 699)
* binary packages: Install Command Categories.
- (line 4839)
+ (line 4855)
* bindir: Directory Variables.
- (line 4173)
+ (line 4188)
* braces, in C source: Formatting. (line 2267)
* bug reports: --help. (line 1024)
-* bug-standards@gnu.org email address: Preface. (line 114)
-* C compatibility: Compatibility. (line 292)
-* C library functions, and portability: System Functions. (line 2755)
+* bug-standards@gnu.org email address: Preface. (line 115)
+* C compatibility: Compatibility. (line 293)
+* C library functions, and portability: System Functions. (line 2770)
* canonical name of a program: --version. (line 874)
-* casting pointers to integers: CPU Portability. (line 2743)
+* casting pointers to integers: CPU Portability. (line 2758)
* CGI programs, standard options for: Command-Line Interfaces.
(line 859)
-* change logs: Change Logs. (line 3234)
+* change logs: Change Logs. (line 3249)
* change logs, conditional changes: Conditional Changes.
- (line 3558)
+ (line 3573)
* change logs, style: Style of Change Logs.
- (line 3406)
+ (line 3421)
* changeset, in a change log: Change Log Concepts.
- (line 3298)
-* character set: Character Set. (line 2906)
+ (line 3313)
+* character set: Character Set. (line 2921)
* clang: Syntactic Conventions.
(line 2491)
-* command-line arguments, decoding: Semantics. (line 545)
+* command-line arguments, decoding: Semantics. (line 546)
* command-line interface: Command-Line Interfaces.
(line 834)
* commenting: Comments. (line 2397)
-* compatibility with C and POSIX standards: Compatibility. (line 292)
+* compatibility with C and POSIX standards: Compatibility. (line 293)
* compiler warnings: Syntactic Conventions.
(line 2484)
* conditional changes, and change logs: Conditional Changes.
- (line 3558)
+ (line 3573)
* conditionals, comments for: Comments. (line 2451)
-* configure: Configuration. (line 3690)
+* configure: Configuration. (line 3705)
* control-L: Formatting. (line 2389)
* conventions for makefiles: Makefile Conventions.
- (line 3868)
+ (line 3883)
* CORBA: Graphical Interfaces.
(line 818)
-* credits for manuals: Manual Credits. (line 3199)
+* credits for manuals: Manual Credits. (line 3214)
* D-bus: Graphical Interfaces.
(line 818)
-* data structures, in Gnulib: System Functions. (line 2793)
-* data types, and portability: CPU Portability. (line 2696)
+* data structures, in Gnulib: System Functions. (line 2808)
+* data types, and portability: CPU Portability. (line 2711)
* description, change log entry: Change Log Concepts.
- (line 3314)
-* DESTDIR: DESTDIR. (line 4078)
+ (line 3329)
+* DESTDIR: DESTDIR. (line 4093)
* directories, creating installation: Directory Variables.
- (line 4136)
-* documentation: Documentation. (line 2971)
+ (line 4151)
+* documentation: Documentation. (line 2986)
* doschk: Names. (line 2626)
-* double quote: Quote Characters. (line 2922)
-* downloading this manual: Preface. (line 98)
+* double quote: Quote Characters. (line 2937)
+* downloading this manual: Preface. (line 99)
* dynamic plug-ins: Dynamic Plug-In Interfaces.
(line 1038)
-* encodings: Character Set. (line 2906)
+* encodings: Character Set. (line 2921)
* enum types, formatting: Formatting. (line 2306)
-* error messages: Semantics. (line 524)
-* error messages, formatting: Errors. (line 634)
-* error messages, in Gnulib: System Functions. (line 2793)
+* error messages: Semantics. (line 525)
+* error messages, formatting: Errors. (line 635)
+* error messages, in Gnulib: System Functions. (line 2808)
* exec_prefix: Directory Variables.
- (line 4155)
+ (line 4170)
* expressions, splitting: Formatting. (line 2352)
* FDL, GNU Free Documentation License: GNU Free Documentation License.
- (line 5085)
+ (line 5101)
* file usage: File Usage. (line 2242)
* file-name limitations: Names. (line 2626)
-* formatting error messages: Errors. (line 634)
+* formatting error messages: Errors. (line 635)
* formatting source code: Formatting. (line 2264)
* formfeed: Formatting. (line 2389)
* function argument, declaring: Syntactic Conventions.
(line 2480)
* function definitions, formatting: Formatting. (line 2267)
-* function prototypes: Standard C. (line 371)
+* function prototypes: Standard C. (line 372)
* getopt: Command-Line Interfaces.
(line 834)
* gettext: Internationalization.
- (line 2811)
+ (line 2826)
* GNOME: Graphical Interfaces.
(line 818)
-* GNOME and Guile: Source Language. (line 281)
-* Gnulib: System Functions. (line 2786)
-* gnustandards project repository: Preface. (line 114)
-* gnustandards-commit@gnu.org mailing list: Preface. (line 108)
+* GNOME and Guile: Source Language. (line 282)
+* Gnulib: System Functions. (line 2801)
+* gnustandards project repository: Preface. (line 115)
+* gnustandards-commit@gnu.org mailing list: Preface. (line 109)
* GNUstep: Graphical Interfaces.
(line 807)
* graphical user interface: Graphical Interfaces.
(line 807)
-* grave accent: Quote Characters. (line 2922)
+* grave accent: Quote Characters. (line 2937)
* GTK+: Graphical Interfaces.
(line 807)
-* Guile: Source Language. (line 281)
+* Guile: Source Language. (line 282)
* header line, change log entry: Change Log Concepts.
- (line 3306)
+ (line 3321)
* implicit int: Syntactic Conventions.
(line 2480)
-* impossible conditions: Semantics. (line 571)
+* impossible conditions: Semantics. (line 572)
* installation directories, creating: Directory Variables.
- (line 4136)
-* installations, staged: DESTDIR. (line 4078)
+ (line 4151)
+* installations, staged: DESTDIR. (line 4093)
* interface styles: Graphical Interfaces.
(line 807)
* internationalization: Internationalization.
- (line 2811)
+ (line 2826)
* keyboard interface: Graphical Interfaces.
(line 818)
* LDAP: OID Allocations. (line 2158)
-* left quote: Quote Characters. (line 2922)
-* legal aspects: Legal Issues. (line 145)
-* legal papers: Contributions. (line 185)
+* left quote: Quote Characters. (line 2937)
+* legal aspects: Legal Issues. (line 146)
+* legal papers: Contributions. (line 186)
* length of source lines: Formatting. (line 2264)
* libexecdir: Directory Variables.
- (line 4186)
-* libiconv: Semantics. (line 519)
-* libraries: Libraries. (line 606)
-* library functions, and portability: System Functions. (line 2755)
+ (line 4201)
+* libiconv: Semantics. (line 520)
+* libraries: Libraries. (line 607)
+* library functions, and portability: System Functions. (line 2770)
* library interface: Graphical Interfaces.
(line 818)
* license for manuals: License for Manuals.
- (line 3180)
+ (line 3195)
* line length: Formatting. (line 2264)
* lint: Syntactic Conventions.
(line 2491)
-* locale-specific quote characters: Quote Characters. (line 2922)
+* locale-specific quote characters: Quote Characters. (line 2937)
* long option names: Option Table. (line 1070)
* long-named options: Command-Line Interfaces.
(line 840)
* makefile, conventions for: Makefile Conventions.
- (line 3868)
-* malloc return value: Semantics. (line 530)
-* man pages: Man Pages. (line 3620)
+ (line 3883)
+* malloc return value: Semantics. (line 531)
+* man pages: Man Pages. (line 3635)
* manual structure: Manual Structure Details.
- (line 3153)
-* memory allocation failure: Semantics. (line 530)
+ (line 3168)
+* memory allocation failure: Semantics. (line 531)
* memory leak: Memory Usage. (line 2234)
* memory usage: Memory Usage. (line 2217)
* message text, and internationalization: Internationalization.
- (line 2834)
-* mmap: Mmap. (line 2954)
+ (line 2849)
+* mmap: Mmap. (line 2969)
* multiple variables in a line: Syntactic Conventions.
(line 2517)
* names of variables, functions, and files: Names. (line 2594)
-* NEWS file: NEWS File. (line 3220)
-* non-ASCII characters: Character Set. (line 2906)
-* non-POSIX systems, and portability: System Portability. (line 2666)
-* non-standard extensions: Using Extensions. (line 324)
-* NUL characters: Semantics. (line 519)
+* NEWS file: NEWS File. (line 3235)
+* non-ASCII characters: Character Set. (line 2921)
+* non-POSIX systems, and portability: System Portability. (line 2681)
+* non-standard extensions: Using Extensions. (line 325)
+* NUL characters: Semantics. (line 520)
* OID allocations for GNU: OID Allocations. (line 2158)
* open brace: Formatting. (line 2267)
-* opening quote: Quote Characters. (line 2922)
-* optional features, configure-time: Configuration. (line 3782)
-* options for compatibility: Compatibility. (line 300)
+* opening quote: Quote Characters. (line 2937)
+* optional features, configure-time: Configuration. (line 3797)
+* options for compatibility: Compatibility. (line 301)
* options, standard command-line: Command-Line Interfaces.
(line 859)
* output device and program's behavior: User Interfaces. (line 710)
-* packaging: Releases. (line 4866)
+* packaging: Releases. (line 4882)
* PATH_INFO, specifying standard options as: Command-Line Interfaces.
(line 859)
* plug-ins: Dynamic Plug-In Interfaces.
(line 1038)
* plugin_is_GPL_compatible: Dynamic Plug-In Interfaces.
(line 1049)
-* portability, and data types: CPU Portability. (line 2696)
-* portability, and library functions: System Functions. (line 2755)
+* portability, and data types: CPU Portability. (line 2711)
+* portability, and library functions: System Functions. (line 2770)
* portability, between system types: System Portability. (line 2640)
-* POSIX compatibility: Compatibility. (line 292)
-* POSIX functions, and portability: System Functions. (line 2755)
-* POSIXLY_CORRECT, environment variable: Compatibility. (line 307)
+* POSIX compatibility: Compatibility. (line 293)
+* POSIX functions, and portability: System Functions. (line 2770)
+* POSIXLY_CORRECT, environment variable: Compatibility. (line 308)
* post-installation commands: Install Command Categories.
- (line 4765)
+ (line 4781)
* pre-installation commands: Install Command Categories.
- (line 4765)
+ (line 4781)
* prefix: Directory Variables.
- (line 4145)
-* program configuration: Configuration. (line 3690)
-* program design: Design Advice. (line 257)
+ (line 4160)
+* program configuration: Configuration. (line 3705)
+* program design: Design Advice. (line 258)
* program name and its behavior: User Interfaces. (line 699)
* program's canonical name: --version. (line 874)
-* programming languages: Source Language. (line 263)
+* programming languages: Source Language. (line 264)
* proprietary programs: Reading Non-Free Code.
- (line 151)
-* quote characters: Quote Characters. (line 2922)
-* README file: Releases. (line 4881)
-* references to non-free material: References. (line 4950)
-* releasing: Managing Releases. (line 3679)
-* right quote: Quote Characters. (line 2922)
-* Savannah repository for gnustandards: Preface. (line 114)
+ (line 152)
+* quote characters: Quote Characters. (line 2937)
+* README file: Releases. (line 4897)
+* references to non-free material: References. (line 4966)
+* releasing: Managing Releases. (line 3694)
+* right quote: Quote Characters. (line 2937)
+* Savannah repository for gnustandards: Preface. (line 115)
* sbindir: Directory Variables.
- (line 4179)
-* signal handling: Semantics. (line 560)
-* single quote: Quote Characters. (line 2922)
+ (line 4194)
+* signal handling: Semantics. (line 561)
+* single quote: Quote Characters. (line 2937)
* SNMP: OID Allocations. (line 2158)
-* software forensics, and change logs: Change Logs. (line 3243)
+* software forensics, and change logs: Change Logs. (line 3258)
* spaces before open-paren: Formatting. (line 2346)
-* staged installs: DESTDIR. (line 4078)
+* staged installs: DESTDIR. (line 4093)
* standard command-line options: Command-Line Interfaces.
(line 859)
* standards for makefiles: Makefile Conventions.
- (line 3868)
+ (line 3883)
* struct types, formatting: Formatting. (line 2306)
* syntactic conventions: Syntactic Conventions.
(line 2480)
* table of long options: Option Table. (line 1070)
-* temporary files: Semantics. (line 585)
+* temporary files: Semantics. (line 586)
* temporary variables: Syntactic Conventions.
(line 2505)
-* texinfo.tex, in a distribution: Releases. (line 4938)
+* texinfo.tex, in a distribution: Releases. (line 4954)
* title, change log entry: Change Log Concepts.
- (line 3306)
-* TMPDIR environment variable: Semantics. (line 585)
-* trademarks: Trademarks. (line 229)
+ (line 3321)
+* TMPDIR environment variable: Semantics. (line 586)
+* trademarks: Trademarks. (line 230)
* user interface styles: Graphical Interfaces.
(line 807)
* valgrind: Memory Usage. (line 2234)
-* VCS: Change Logs. (line 3268)
+* VCS: Change Logs. (line 3283)
* version control system, for keeping change logs: Change Logs.
- (line 3268)
-* version numbers, for releases: Releases. (line 4866)
-* where to obtain standards.texi: Preface. (line 98)
+ (line 3283)
+* version numbers, for releases: Releases. (line 4882)
+* where to obtain standards.texi: Preface. (line 99)
* X.509: OID Allocations. (line 2158)
-* xmalloc, in Gnulib: System Functions. (line 2793)
+* xmalloc, in Gnulib: System Functions. (line 2808)
Index: standards.txt.gz
===================================================================
RCS file: /web/www/www/prep/standards/standards.txt.gz,v
retrieving revision 1.97
retrieving revision 1.98
diff -u -b -r1.97 -r1.98
Binary files /var/tmp/cvspVfKEN and /var/tmp/cvsX8JuC5 differ
Index: html_node/CPU-Portability.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/CPU-Portability.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/CPU-Portability.html 8 Jul 2021 18:18:42 -0000 1.84
+++ html_node/CPU-Portability.html 29 May 2024 18:09:30 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>CPU Portability (GNU Coding Standards)</title>
<meta name="description" content="CPU Portability (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="System Portability">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="System-Functions.html" rel="next" title="System Functions">
+<link href="System-Portability.html" rel="prev" title="System Portability">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,32 +44,31 @@
</head>
<body lang="en">
-<a name="CPU-Portability"></a>
-<div class="header">
+<div class="section-level-extent" id="CPU-Portability">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="System-Functions.html" accesskey="n" rel="next">Calling System
Functions</a>, Previous: <a href="System-Portability.html" accesskey="p"
rel="prev">Portability between System Types</a>, Up: <a href="Writing-C.html"
accesskey="u" rel="up">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Portability-between-CPUs"></a>
-<h3 class="section">5.6 Portability between CPUs</h3>
+<h3 class="section" id="Portability-between-CPUs"><span>5.6 Portability
between CPUs<a class="copiable-link" href="#Portability-between-CPUs">
¶</a></span></h3>
-<a name="index-data-types_002c-and-portability"></a>
-<a name="index-portability_002c-and-data-types"></a>
+<a class="index-entry-id" id="index-data-types_002c-and-portability"></a>
+<a class="index-entry-id" id="index-portability_002c-and-data-types"></a>
<p>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
-<code>int</code> will be less than 32 bits. We don’t support 16-bit
machines
+<code class="code">int</code> will be less than 32 bits. We don’t
support 16-bit machines
in GNU.
</p>
-<p>You need not cater to the possibility that <code>long</code> will be smaller
-than pointers and <code>size_t</code>. We know of one such platform: 64-bit
+<p>You need not cater to the possibility that <code class="code">long</code>
will be smaller
+than pointers and <code class="code">size_t</code>. We know of one such
platform: 64-bit
programs on Microsoft Windows. If you care about making your package
run on Windows using Mingw64, you would need to deal with 8-byte
-pointers and 4-byte <code>long</code>, which would break this code:
+pointers and 4-byte <code class="code">long</code>, which would break this
code:
</p>
<div class="example">
-<pre class="example">printf ("size = %lu\n", (unsigned long) sizeof
array);
+<pre class="example-preformatted">printf ("size = %lu\n", (unsigned
long) sizeof array);
printf ("diff = %ld\n", (long) (pointer2 - pointer1));
</pre></div>
@@ -98,28 +79,28 @@
on Windows, and you are not interested, you can respond with, “Switch
to GNU/Linux — your freedom depends on it.”
</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
+<p>Predefined file-size types like <code class="code">off_t</code> are an
exception: they are
+longer than <code class="code">long</code> on many platforms, so code like the
above won’t
+work with them. One way to print an <code class="code">off_t</code> value
portably is to
print its digits yourself, one by one.
</p>
-<p>Don’t assume that the address of an <code>int</code> object is also
the
+<p>Don’t assume that the address of an <code class="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:
</p>
<div class="example">
-<pre class="example">int c;
-…
+<pre class="example-preformatted">int c;
+...
while ((c = getchar ()) != EOF)
write (file_descriptor, &c, 1);
</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
+<p>Instead, use <code class="code">unsigned char</code> as follows. (The
<code class="code">unsigned</code>
+is for portability to unusual systems where <code class="code">char</code> is
signed and
where there is integer overflow checking.)
</p>
<div class="example">
-<pre class="example">int c;
+<pre class="example-preformatted">int c;
while ((c = getchar ()) != EOF)
{
unsigned char u = c;
@@ -127,21 +108,22 @@
}
</pre></div>
-<a name="index-casting-pointers-to-integers"></a>
+<a class="index-entry-id" id="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
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
+normal range of addresses you can get from <code class="code">malloc</code>
starts far away
from zero.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="System-Functions.html">Calling System Functions</a>, Previous:
<a href="System-Portability.html">Portability between System Types</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Change-Log-Concepts.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Change-Log-Concepts.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Change-Log-Concepts.html 8 Jul 2021 18:18:42 -0000 1.84
+++ html_node/Change-Log-Concepts.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Change Log Concepts (GNU Coding Standards)</title>
<meta name="description" content="Change Log Concepts (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Change Logs">
+<link href="Change-Logs.html" rel="up" title="Change Logs">
+<link href="Style-of-Change-Logs.html" rel="next" title="Style of Change Logs">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,37 +44,36 @@
</head>
<body lang="en">
-<a name="Change-Log-Concepts"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Change-Log-Concepts">
+<div class="nav-panel">
<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>
+Next: <a href="Style-of-Change-Logs.html" accesskey="n" rel="next">Style of
Change Logs</a>, Up: <a href="Change-Logs.html" 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" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Change-Log-Concepts-and-Conventions"></a>
-<h4 class="subsection">6.8.1 Change Log Concepts and Conventions</h4>
+<h4 class="subsection" id="Change-Log-Concepts-and-Conventions"><span>6.8.1
Change Log Concepts and Conventions<a class="copiable-link"
href="#Change-Log-Concepts-and-Conventions"> ¶</a></span></h4>
-<a name="index-changeset_002c-in-a-change-log"></a>
-<a name="index-batch-of-changes_002c-in-a-change-log"></a>
+<a class="index-entry-id" id="index-changeset_002c-in-a-change-log"></a>
+<a class="index-entry-id" id="index-batch-of-changes_002c-in-a-change-log"></a>
<p>You can think of the change log as a conceptual “undo list”
which
states how earlier versions were different from the current version.
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. Each <em>entry</em> in
+explanation of how the earlier version differed. Each <em
class="dfn">entry</em> in
a change log describes either an individual change or the smallest
-batch of changes that belong together, also known as a <em>changeset</em>.
+batch of changes that belong together, also known as a <em
class="dfn">changeset</em>.
</p>
-<a name="index-title_002c-change-log-entry"></a>
-<a name="index-header-line_002c-change-log-entry"></a>
-<p>It is a good idea to start the change log entry with a <em>header
+<a class="index-entry-id" id="index-title_002c-change-log-entry"></a>
+<a class="index-entry-id" id="index-header-line_002c-change-log-entry"></a>
+<p>It is a good idea to start the change log entry with a <em
class="dfn">header
line</em>: a single line that is a complete sentence which summarizes the
changeset. If you keep the change log in a VCS, this
should be a requirement, as VCS commands that show the
-change log in abbreviated form, such as <kbd>git log --oneline</kbd>, treat
-the header line specially. (In a <samp>ChangeLog</samp> file, the header
+change log in abbreviated form, such as <kbd class="kbd">git log
--oneline</kbd>, treat
+the header line specially. (In a <samp class="file">ChangeLog</samp> file,
the header
line follows a line that says who was the author of the change and
when it was installed.)
</p>
-<a name="index-description_002c-change-log-entry"></a>
+<a class="index-entry-id" id="index-description_002c-change-log-entry"></a>
<p>Follow the change log entry’s header line with a description of the
overall change. This should be as long as needed to give a clear
description. Pay special attention to aspects of the changeset not
@@ -108,7 +89,7 @@
<p>The best place to explain how parts of the new code work with other code
is in comments in the code, not in the change log.
</p>
-<p>If you think that a change calls for explanation of <em>why</em> the
+<p>If you think that a change calls for explanation of <em
class="emph">why</em> the
change was needed—that is, what problem the old code had such that
it required this change—you’re probably right. Please put the
explanation in comments in the code, where people will see it whenever
@@ -125,9 +106,9 @@
<p>Following the free-text description of the change, it is a good idea
to give a list of names of the entities or definitions that you
changed, according to the files they are in, and what was changed in
-each one. See <a href="Style-of-Change-Logs.html#Style-of-Change-Logs">Style
of Change Logs</a>. If a project uses a modern
+each one. See <a class="xref" href="Style-of-Change-Logs.html">Style of
Change Logs</a>. If a project uses a modern
VCS to keep the change log information, as described in
-<a href="Change-Logs.html#Change-Logs">Change Logs</a>, explicitly listing the
files and functions that
+<a class="ref" href="Change-Logs.html">Change Logs</a>, explicitly listing the
files and functions that
were changed is not strictly necessary, and in some cases (like
identical mechanical changes in many places) even tedious. It is up
to you to decide whether to allow your project’s developers to omit
@@ -136,8 +117,8 @@
However, while making this decision, please consider the following
benefits of providing the list of changed entities with each change:
</p>
-<ul>
-<li> Generation of useful <samp>ChangeLog</samp> files from VCS logs
+<ul class="itemize mark-bullet">
+<li>Generation of useful <samp class="file">ChangeLog</samp> files from VCS
logs
becomes more difficult if the change log entries don’t list the
modified functions/macros, because VCS commands cannot
reliably reproduce their names from the commit information alone. For
@@ -147,24 +128,24 @@
function defined before the one being modified), so using those diffs
to glean the names of the modified functions will produce inaccurate
results. You will need to use specialized scripts, such as gnulib’s
-<samp>vcs-to-changelog.py</samp>, mentioned below, to solve these
+<samp class="file">vcs-to-changelog.py</samp>, mentioned below, to solve these
difficulties, and make sure it supports the source languages used by
your project.
-</li><li> While modern VCS commands, such as Git’s <kbd>git log -L</kbd>
-and <kbd>git log -G</kbd>, provide powerful means for finding changes that
+</li><li>While modern VCS commands, such as Git’s <kbd class="kbd">git
log -L</kbd>
+and <kbd class="kbd">git log -G</kbd>, provide powerful means for finding
changes that
affected a certain function or macro or data structure (and thus might
-make <samp>ChangeLog</samp> files unnecessary if you have the repository
-available), they can sometimes fail. For example, <kbd>git log -L</kbd>
+make <samp class="file">ChangeLog</samp> files unnecessary if you have the
repository
+available), they can sometimes fail. For example, <kbd class="kbd">git log
-L</kbd>
doesn’t support syntax of some programming languages out of the box.
Mentioning the modified functions/macros explicitly allows finding the
related changes simply and reliably.
-</li><li> Some VCS commands have difficulties or limitations when
+</li><li>Some VCS commands have difficulties or limitations when
tracking changes across file moves or renames. Again, if the entities
are mentioned explicitly, those difficulties can be overcome.
-</li><li> Users that review changes using the generated <samp>ChangeLog</samp>
files
+</li><li>Users that review changes using the generated <samp
class="file">ChangeLog</samp> files
may not have the repository and the VCS commands available
to them. Naming the modified entities alleviates that problem.
</li></ul>
@@ -174,22 +155,23 @@
recommend to include them whenever possible and practical.
</p>
<p>It is also possible to generate the lists naming the modified entities
-by running a script. One such script is <samp>mklog.py</samp> (written in
-Python 3); it is used by the <code>GCC</code> project. Gnulib provides
-another variant of such a script, called <samp>vcs-to-changelog.py</samp>,
-part of the <code>vcs-to-changelog</code> module. Note that these scripts
+by running a script. One such script is <samp class="file">mklog.py</samp>
(written in
+Python 3); it is used by the <code class="code">GCC</code> project. Gnulib
provides
+another variant of such a script, called <samp
class="file">vcs-to-changelog.py</samp>,
+part of the <code class="code">vcs-to-changelog</code> module. Note that
these scripts
currently support fewer programming languages than the manual commands
-provided by Emacs (see <a
href="Style-of-Change-Logs.html#Style-of-Change-Logs">Style of Change
Logs</a>). Therefore, the
-above mentioned method of generating the <code>ChangeLog</code> file from
+provided by Emacs (see <a class="pxref" href="Style-of-Change-Logs.html">Style
of Change Logs</a>). Therefore, the
+above mentioned method of generating the <code class="code">ChangeLog</code>
file from
the VCS commit history, for instance via the
-<code>gitlog-to-changelog</code> script, usually gives better
+<code class="code">gitlog-to-changelog</code> script, usually gives better
results—provided that the contributors stick to providing good
commit messages.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="Style-of-Change-Logs.html">Style of Change Logs</a>, Up: <a
href="Change-Logs.html">Change Logs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Change-Logs.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Change-Logs.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Change-Logs.html 8 Jul 2021 18:18:42 -0000 1.84
+++ html_node/Change-Logs.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Change Logs (GNU Coding Standards)</title>
<meta name="description" content="Change Logs (GNU Coding Standards)">
@@ -23,37 +23,20 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="NEWS File">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Man-Pages.html" rel="next" title="Man Pages">
+<link href="NEWS-File.html" rel="prev" title="NEWS File">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +45,14 @@
</head>
<body lang="en">
-<a name="Change-Logs"></a>
-<div class="header">
+<div class="section-level-extent" id="Change-Logs">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Man-Pages.html" accesskey="n" rel="next">Man Pages</a>,
Previous: <a href="NEWS-File.html" accesskey="p" rel="prev">The NEWS File</a>,
Up: <a href="Documentation.html" accesskey="u" rel="up">Documenting
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Change-Logs-1"><span>6.8 Change Logs<a
class="copiable-link" href="#Change-Logs-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-change-logs"></a>
<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
@@ -81,39 +63,39 @@
history of how the conflicting concepts arose, who they came from, and
why the conflicting changes were made.
</p>
-<a name="index-software-forensics_002c-and-change-logs"></a>
+<a class="index-entry-id"
id="index-software-forensics_002c-and-change-logs"></a>
<p>Therefore, change logs should be detailed enough and accurate enough
-to provide the information commonly required for such <em>software
+to provide the information commonly required for such <em class="dfn">software
forensics</em>. Specifically, change logs should make finding answers to
the following questions easy:
</p>
-<ul>
-<li> What changes affected a particular source file?
+<ul class="itemize mark-bullet">
+<li>What changes affected a particular source file?
-</li><li> Was a particular source file renamed or moved, and if so, as part of
+</li><li>Was a particular source file renamed or moved, and if so, as part of
what change?
-</li><li> What changes affected a given function or macro or definition of a
+</li><li>What changes affected a given function or macro or definition of a
data structure?
-</li><li> Was a function (or a macro or the definition of a data structure)
+</li><li>Was a function (or a macro or the definition of a data structure)
renamed or moved from another file, and if so, as part of which
change?
-</li><li> What changes deleted a function (or macro or data structure)?
+</li><li>What changes deleted a function (or macro or data structure)?
-</li><li> What was the rationale for a given change, and what were its main
+</li><li>What was the rationale for a given change, and what were its main
ideas?
-</li><li> Is there any additional information regarding the change, and if so,
+</li><li>Is there any additional information regarding the change, and if so,
where can it be found?
</li></ul>
-<a name="index-VCS"></a>
-<a name="index-version-control-system_002c-for-keeping-change-logs"></a>
+<a class="index-entry-id" id="index-VCS"></a>
+<a class="index-entry-id"
id="index-version-control-system_002c-for-keeping-change-logs"></a>
<p>Historically, change logs were maintained on specially formatted
files. Nowadays, projects commonly keep their source files under a
-<em>version control system</em> (VCS), such as Git,
+<em class="dfn">version control system</em> (VCS), such as Git,
Subversion, or Mercurial. If the VCS repository is publicly
accessible, and changes are committed to it separately (one commit for
each logical changeset) and record the authors of each change, then
@@ -130,35 +112,31 @@
still consider providing them in the release tarballs, for the benefit
of users who’d like to review the change logs without accessing the
project’s VCS repository. Scripts exist that can produce
-<samp>ChangeLog</samp> files from the VCS logs; for example, the
-<samp>gitlog-to-changelog</samp> script, which is part of Gnulib, can do
-that for Git repositories. In Emacs, the command <kbd>C-x v a</kbd>
-(<code>vc-update-change-log</code>) does the job of incrementally updating a
-<samp>ChangeLog</samp> file from the VCS logs.
+<samp class="file">ChangeLog</samp> files from the VCS logs; for example, the
+<samp class="file">gitlog-to-changelog</samp> script, which is part of Gnulib,
can do
+that for Git repositories. In Emacs, the command <kbd class="kbd">C-x v
a</kbd>
+(<code class="code">vc-update-change-log</code>) does the job of incrementally
updating a
+<samp class="file">ChangeLog</samp> file from the VCS logs.
</p>
-<p>If separate change log files <em>are</em> maintained, they are normally
-called <samp>ChangeLog</samp>, and each such file covers an entire
+<p>If separate change log files <em class="emph">are</em> maintained, they are
normally
+called <samp class="file">ChangeLog</samp>, and each such file covers an entire
directory. Each directory can have its own change log file, or a
directory can use the change log of its parent directory—it’s up to
you.
</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="mini-toc">
+<li><a href="Change-Log-Concepts.html" accesskey="1">Change Log Concepts and
Conventions</a></li>
+<li><a href="Style-of-Change-Logs.html" accesskey="2">Style of Change
Logs</a></li>
+<li><a href="Simple-Changes.html" accesskey="3">Simple Changes</a></li>
+<li><a href="Conditional-Changes.html" accesskey="4">Conditional
Changes</a></li>
+<li><a href="Indicating-the-Part-Changed.html" accesskey="5">Indicating the
Part Changed</a></li>
+</ul>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Man-Pages.html">Man Pages</a>, Previous: <a
href="NEWS-File.html">The NEWS File</a>, Up: <a
href="Documentation.html">Documenting Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Character-Set.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Character-Set.html,v
retrieving revision 1.76
retrieving revision 1.77
diff -u -b -r1.76 -r1.77
--- html_node/Character-Set.html 8 Jul 2021 18:18:42 -0000 1.76
+++ html_node/Character-Set.html 29 May 2024 18:09:31 -0000 1.77
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Character Set (GNU Coding Standards)</title>
<meta name="description" content="Character Set (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Internationalization">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Quote-Characters.html" rel="next" title="Quote Characters">
+<link href="Internationalization.html" rel="prev" title="Internationalization">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,18 +43,17 @@
</head>
<body lang="en">
-<a name="Character-Set"></a>
-<div class="header">
+<div class="section-level-extent" id="Character-Set">
+<div class="nav-panel">
<p>
-Next: <a href="Quote-Characters.html#Quote-Characters" accesskey="n"
rel="next">Quote Characters</a>, Previous: <a
href="Internationalization.html#Internationalization" accesskey="p"
rel="prev">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>
+Next: <a href="Quote-Characters.html" accesskey="n" rel="next">Quote
Characters</a>, Previous: <a href="Internationalization.html" accesskey="p"
rel="prev">Internationalization</a>, Up: <a href="Writing-C.html" accesskey="u"
rel="up">Making The Best Use of C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="Character-Set-1"><span>5.9 Character Set<a
class="copiable-link" href="#Character-Set-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-character-set"></a>
+<a class="index-entry-id" id="index-encodings"></a>
+<a class="index-entry-id" id="index-ASCII-characters"></a>
+<a class="index-entry-id" id="index-non_002dASCII-characters"></a>
<p>Sticking to the ASCII character set (plain text, 7-bit characters) is
preferred in GNU source code comments, text documents, and other
@@ -82,13 +62,14 @@
French Revolutionary calendar, it is OK if its literal strings contain
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>).
+names of contributors in change logs (see <a class="pxref"
href="Change-Logs.html">Change Logs</a>).
</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>
Index: html_node/Command-Variables.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Command-Variables.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Command-Variables.html 8 Jul 2021 18:18:42 -0000 1.84
+++ html_node/Command-Variables.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Command Variables (GNU Coding Standards)</title>
<meta name="description" content="Command Variables (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Utilities in Makefiles">
+<link href="Makefile-Conventions.html" rel="up" title="Makefile Conventions">
+<link href="DESTDIR.html" rel="next" title="DESTDIR">
+<link href="Utilities-in-Makefiles.html" rel="prev" title="Utilities in
Makefiles">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,94 +44,94 @@
</head>
<body lang="en">
-<a name="Command-Variables"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Command-Variables">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="DESTDIR.html" accesskey="n" rel="next"><code
class="code">DESTDIR</code>: Support for Staged Installs</a>, Previous: <a
href="Utilities-in-Makefiles.html" accesskey="p" rel="prev">Utilities in
Makefiles</a>, Up: <a href="Makefile-Conventions.html" 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"
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>
+<h4 class="subsection section-level-set-subsection"
id="Variables-for-Specifying-Commands"><span>7.2.3 Variables for Specifying
Commands<a class="copiable-link" href="#Variables-for-Specifying-Commands">
¶</a></span></h4>
<p>Makefiles should provide variables for overriding certain commands, options,
and so on.
</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>BISON = bison</samp>’, and refer to it
with
-<code>$(BISON)</code> whenever you need to use Bison.
+Thus, if you use Bison, have a variable named <code class="code">BISON</code>
whose default
+value is set with ‘<samp class="samp">BISON = bison</samp>’, and
refer to it with
+<code class="code">$(BISON)</code> whenever you need to use Bison.
</p>
-<p>File management utilities such as <code>ln</code>, <code>rm</code>,
<code>mv</code>, and
+<p>File management utilities such as <code class="code">ln</code>, <code
class="code">rm</code>, <code class="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>
<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
+used to supply options to the program. Append ‘<samp
class="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
+example, <code class="code">BISONFLAGS</code>. (The names <code
class="code">CFLAGS</code> for the C
+compiler, <code class="code">YFLAGS</code> for yacc, and <code
class="code">LFLAGS</code> for lex, are
exceptions to this rule, but we keep them because they are standard.)
-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>
-<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.
+Use <code class="code">CPPFLAGS</code> in any compilation command that runs the
+preprocessor, and use <code class="code">LDFLAGS</code> in any compilation
command that
+does linking as well as in any direct use of <code class="code">ld</code>.
+</p>
+<p>If there are C compiler options that <em class="emph">must</em> be used for
proper
+compilation of certain files, do not include them in <code
class="code">CFLAGS</code>.
+Users expect to be able to specify <code class="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
+independently of <code class="code">CFLAGS</code>, by writing them explicitly
in the
compilation commands or by defining an implicit rule, like this:
</p>
-<div class="smallexample">
-<pre class="smallexample">CFLAGS = -g
+<div class="example smallexample">
+<pre class="example-preformatted">CFLAGS = -g
ALL_CFLAGS = -I. $(CFLAGS)
.c.o:
$(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
</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
+<p>Do include the ‘<samp class="samp">-g</samp>’ option in <code
class="code">CFLAGS</code>, because that is not
+<em class="emph">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>-O</samp>’
-in the default value of <code>CFLAGS</code> as well.
+compiled with GCC by default, then you might as well include ‘<samp
class="samp">-O</samp>’
+in the default value of <code class="code">CFLAGS</code> as well.
</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
+<p>Put <code class="code">CFLAGS</code> last in the compilation command, after
other variables
+containing compiler options, so the user can use <code
class="code">CFLAGS</code> to
override the others.
</p>
-<p><code>CFLAGS</code> should be used in every invocation of the C compiler,
+<p><code class="code">CFLAGS</code> should be used in every invocation of the
C compiler,
both those which do compilation and those which do linking.
</p>
-<p>Every Makefile should define the variable <code>INSTALL</code>, which is the
+<p>Every Makefile should define the variable <code
class="code">INSTALL</code>, which is the
basic command for installing a file into the system.
</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
+<p>Every Makefile should also define the variables <code
class="code">INSTALL_PROGRAM</code>
+and <code class="code">INSTALL_DATA</code>. (The default for <code
class="code">INSTALL_PROGRAM</code> should
+be <code class="code">$(INSTALL)</code>; the default for <code
class="code">INSTALL_DATA</code> should be
+<code class="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
+<pre class="example-preformatted">$(INSTALL_PROGRAM) foo $(bindir)/foo
$(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
</pre></div>
-<p>However, it is preferable to support a <code>DESTDIR</code> prefix on the
+<p>However, it is preferable to support a <code class="code">DESTDIR</code>
prefix on the
target files, as explained in the next section.
</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 class="example-preformatted">$(INSTALL_PROGRAM) foo bar baz $(bindir)
</pre></div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="DESTDIR.html"><code class="code">DESTDIR</code>: Support for
Staged Installs</a>, Previous: <a href="Utilities-in-Makefiles.html">Utilities
in Makefiles</a>, Up: <a href="Makefile-Conventions.html">Makefile
Conventions</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Command_002dLine-Interfaces.html
===================================================================
RCS file:
/web/www/www/prep/standards/html_node/Command_002dLine-Interfaces.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Command_002dLine-Interfaces.html 8 Jul 2021 18:18:42 -0000
1.84
+++ html_node/Command_002dLine-Interfaces.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Command-Line Interfaces (GNU Coding Standards)</title>
<meta name="description" content="Command-Line Interfaces (GNU Coding
Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Graphical Interfaces">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Dynamic-Plug_002dIn-Interfaces.html" rel="next" title="Dynamic
Plug-In Interfaces">
+<link href="Graphical-Interfaces.html" rel="prev" title="Graphical Interfaces">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,66 +43,64 @@
</head>
<body lang="en">
-<a name="Command_002dLine-Interfaces"></a>
-<div class="header">
+<div class="section-level-extent" id="Command_002dLine-Interfaces">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Dynamic-Plug_002dIn-Interfaces.html" accesskey="n"
rel="next">Standards for Dynamic Plug-in Interfaces</a>, Previous: <a
href="Graphical-Interfaces.html" accesskey="p" rel="prev">Standards for
Graphical Interfaces</a>, Up: <a href="Program-Behavior.html" accesskey="u"
rel="up">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Standards-for-Command-Line-Interfaces"></a>
-<h3 class="section">4.8 Standards for Command Line Interfaces</h3>
-<a name="index-command_002dline-interface"></a>
+<h3 class="section" id="Standards-for-Command-Line-Interfaces"><span>4.8
Standards for Command Line Interfaces<a class="copiable-link"
href="#Standards-for-Command-Line-Interfaces"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-command_002dline-interface"></a>
-<a name="index-getopt"></a>
+<a class="index-entry-id" id="index-getopt"></a>
<p>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
-<code>getopt</code> to parse them. Note that the GNU version of
<code>getopt</code>
+<code class="code">getopt</code> to parse them. Note that the GNU version of
<code class="code">getopt</code>
will normally permit options anywhere among the arguments unless the
-special argument ‘<samp>--</samp>’ is used. This is not what POSIX
+special argument ‘<samp class="samp">--</samp>’ is used. This is
not what POSIX
specifies; it is a GNU extension.
</p>
-<a name="index-long_002dnamed-options"></a>
+<a class="index-entry-id" id="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>.
+<code class="code">getopt_long</code>.
</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>--verbose</samp>’. To achieve this
uniformity, look at
+spelled precisely ‘<samp class="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>).
+for your program (see <a class="pxref" href="Option-Table.html">Table of Long
Options</a>).
</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>-o</samp>’ or
‘<samp>--output</samp>’). Even if you allow an output
+(preferably ‘<samp class="samp">-o</samp>’ or ‘<samp
class="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"></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 ‘<code>http://example.org/p.cgi/--help</code>’ in a
browser should
-output the same information as invoking ‘<samp>p.cgi
--help</samp>’ from the
+<a class="index-entry-id" id="index-standard-command_002dline-options"></a>
+<a class="index-entry-id"
id="index-options_002c-standard-command_002dline"></a>
+<a class="index-entry-id"
id="index-CGI-programs_002c-standard-options-for"></a>
+<a class="index-entry-id"
id="index-PATH_005fINFO_002c-specifying-standard-options-as"></a>
+<p>All programs should support two standard options: ‘<samp
class="samp">--version</samp>’
+and ‘<samp class="samp">--help</samp>’. CGI programs should
accept these as command-line
+options, and also if given as the <code class="env">PATH_INFO</code>; for
instance,
+visiting ‘<code
class="indicateurl">http://example.org/p.cgi/--help</code>’ in a browser
should
+output the same information as invoking ‘<samp class="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>
+<ul class="mini-toc">
+<li><a href="_002d_002dversion.html" accesskey="1"><samp
class="option">--version</samp></a></li>
+<li><a href="_002d_002dhelp.html" accesskey="2"><samp
class="option">--help</samp></a></li>
+</ul>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Dynamic-Plug_002dIn-Interfaces.html">Standards for Dynamic
Plug-in Interfaces</a>, Previous: <a href="Graphical-Interfaces.html">Standards
for Graphical Interfaces</a>, Up: <a href="Program-Behavior.html">Program
Behavior for All Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
Index: html_node/Comments.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Comments.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Comments.html 8 Jul 2021 18:18:42 -0000 1.84
+++ html_node/Comments.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Comments (GNU Coding Standards)</title>
<meta name="description" content="Comments (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Formatting">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Syntactic-Conventions.html" rel="next" title="Syntactic
Conventions">
+<link href="Formatting.html" rel="prev" title="Formatting">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,19 +44,18 @@
</head>
<body lang="en">
-<a name="Comments"></a>
-<div class="header">
+<div class="section-level-extent" id="Comments">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Syntactic-Conventions.html" accesskey="n" rel="next">Clean Use
of C Constructs</a>, Previous: <a href="Formatting.html" accesskey="p"
rel="prev">Formatting Your Source Code</a>, Up: <a href="Writing-C.html"
accesskey="u" rel="up">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Commenting-Your-Work"><span>5.2 Commenting Your Work<a
class="copiable-link" href="#Commenting-Your-Work"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-commenting"></a>
<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>’
+Example: ‘<samp class="samp">fmt - filter for simple filling of
text</samp>’. This comment
+should be at the top of the source file containing the ‘<samp
class="samp">main</samp>’
function of the program.
</p>
<p>Also, please write a brief comment at the start of each source file,
@@ -93,7 +74,7 @@
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 <code>char *</code> which is really the
+its use (such as an argument of type <code class="code">char *</code> 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
@@ -123,47 +104,48 @@
<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;
+<pre class="example-preformatted">/* Nonzero means truncate lines in the
display;
zero means continue them. */
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
+<a class="index-entry-id" id="index-conditionals_002c-comments-for"></a>
+<a class="index-entry-id" id="index-_0023endif_002c-commenting"></a>
+<p>Every ‘<samp class="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>#else</samp>’ should have a comment
describing the condition
-<em>and sense</em> of the code that follows. For example:
+state the condition of the conditional that is ending, <em
class="emph">including
+its sense</em>. ‘<samp class="samp">#else</samp>’ should have a
comment describing the condition
+<em class="emph">and sense</em> of the code that follows. For example:
</p>
<div class="example">
-<pre class="example">#ifdef foo
- …
+<div class="group"><pre class="example-preformatted">#ifdef foo
+ ...
#else /* not foo */
- …
+ ...
#endif /* not foo */
-</pre><pre class="example">#ifdef foo
- …
+</pre></div><div class="group"><pre class="example-preformatted">#ifdef foo
+ ...
#endif /* foo */
-</pre></div>
+</pre></div></div>
-<p>but, by contrast, write the comments this way for a
‘<samp>#ifndef</samp>’:
+<p>but, by contrast, write the comments this way for a ‘<samp
class="samp">#ifndef</samp>’:
</p>
<div class="example">
-<pre class="example">#ifndef foo
- …
+<div class="group"><pre class="example-preformatted">#ifndef foo
+ ...
#else /* foo */
- …
+ ...
#endif /* foo */
-</pre><pre class="example">#ifndef foo
- …
+</pre></div><div class="group"><pre class="example-preformatted">#ifndef foo
+ ...
#endif /* not foo */
-</pre></div>
+</pre></div></div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Syntactic-Conventions.html">Clean Use of C Constructs</a>,
Previous: <a href="Formatting.html">Formatting Your Source Code</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Compatibility.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Compatibility.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Compatibility.html 8 Jul 2021 18:18:42 -0000 1.84
+++ html_node/Compatibility.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Compatibility (GNU Coding Standards)</title>
<meta name="description" content="Compatibility (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Source
Language">
+<link href="Design-Advice.html" rel="up" title="Design Advice">
+<link href="Using-Extensions.html" rel="next" title="Using Extensions">
+<link href="Source-Language.html" rel="prev" title="Source Language">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,17 +43,16 @@
</head>
<body lang="en">
-<a name="Compatibility"></a>
-<div class="header">
+<div class="section-level-extent" id="Compatibility">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Using-Extensions.html" accesskey="n" rel="next">Using
Non-standard Features</a>, Previous: <a href="Source-Language.html"
accesskey="p" rel="prev">Which Languages to Use</a>, Up: <a
href="Design-Advice.html" accesskey="u" rel="up">General Program Design</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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-C-compatibility"></a>
-<a name="index-POSIX-compatibility"></a>
+<h3 class="section" id="Compatibility-with-Other-Implementations"><span>3.2
Compatibility with Other Implementations<a class="copiable-link"
href="#Compatibility-with-Other-Implementations"> ¶</a></span></h3>
+<a class="index-entry-id"
id="index-compatibility-with-C-and-POSIX-standards"></a>
+<a class="index-entry-id" id="index-C-compatibility"></a>
+<a class="index-entry-id" id="index-POSIX-compatibility"></a>
<p>With occasional exceptions, utility programs and libraries for GNU
should be upward compatible with those in Berkeley Unix, and upward
@@ -83,29 +63,35 @@
<p>When these standards conflict, it is useful to offer compatibility
modes for each of them.
</p>
-<a name="index-options-for-compatibility"></a>
+<a class="index-entry-id" id="index-options-for-compatibility"></a>
<p>Standard C and POSIX 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.
+free to make the extensions anyway, and include a ‘<samp
class="samp">--ansi</samp>’,
+‘<samp class="samp">--posix</samp>’, or ‘<samp
class="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-POSIXLY_005fCORRECT_002c-environment-variable"></a>
+<a class="index-entry-id"
id="index-POSIXLY_005fCORRECT_002c-environment-variable"></a>
<p>Many GNU programs suppress extensions that conflict with POSIX if the
-environment variable <code>POSIXLY_CORRECT</code> is defined (even if it is
+environment variable <code class="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>
<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.)
+<code class="code">vi</code> is replaced with Emacs.) But it is nice to offer
a compatible
+feature as well. (There is a free <code class="code">vi</code> clone, so we
offer it.)
</p>
<p>Additional useful features are welcome regardless of whether
there is any precedent for them.
</p>
+</div>
+<hr>
+<div class="nav-panel">
+<p>
+Next: <a href="Using-Extensions.html">Using Non-standard Features</a>,
Previous: <a href="Source-Language.html">Which Languages to Use</a>, Up: <a
href="Design-Advice.html">General Program Design</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
+</div>
Index: html_node/Conditional-Changes.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Conditional-Changes.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Conditional-Changes.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Conditional-Changes.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Conditional Changes (GNU Coding Standards)</title>
<meta name="description" content="Conditional Changes (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Simple
Changes">
+<link href="Change-Logs.html" rel="up" title="Change Logs">
+<link href="Indicating-the-Part-Changed.html" rel="next" title="Indicating the
Part Changed">
+<link href="Simple-Changes.html" rel="prev" title="Simple Changes">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,23 +44,22 @@
</head>
<body lang="en">
-<a name="Conditional-Changes"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Conditional-Changes">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Indicating-the-Part-Changed.html" accesskey="n"
rel="next">Indicating the Part Changed</a>, Previous: <a
href="Simple-Changes.html" accesskey="p" rel="prev">Simple Changes</a>, Up: <a
href="Change-Logs.html" 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" 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>
+<h4 class="subsection" id="Conditional-Changes-1"><span>6.8.4 Conditional
Changes<a class="copiable-link" href="#Conditional-Changes-1">
¶</a></span></h4>
+<a class="index-entry-id"
id="index-conditional-changes_002c-and-change-logs"></a>
+<a class="index-entry-id" id="index-change-logs_002c-conditional-changes"></a>
<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
+compile-time <code class="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>Makefile.am</samp> files can contain
+interpreter; and Automake <samp class="file">Makefile.am</samp> files can
contain
variable definitions or target declarations that are only to be
considered if a configure-time Automake conditional is true.
</p>
@@ -88,7 +69,7 @@
in the change log the conditions for which a change applies.
</p>
<p>Our convention for indicating conditional changes is to use
-<em>square brackets around the name of the condition</em>.
+<em class="emph">square brackets around the name of the condition</em>.
</p>
<p>Conditional changes can happen in numerous scenarios and with many
variations, so here are some examples to help clarify. This first
@@ -96,7 +77,7 @@
conditional but do not have an associated function or entity name:
</p>
<div class="example">
-<pre class="example">* xterm.c [SOLARIS2]: Include <string.h>.
+<pre class="example-preformatted">* 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__,
@@ -108,34 +89,35 @@
self-evident.
</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:
+conditional: the C macro <code class="code">FRAME_WINDOW_P</code> is defined
(and used)
+only when the macro <code class="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 class="example-preformatted">* frame.h [HAVE_X_WINDOWS] (FRAME_WINDOW_P):
Macro defined.
</pre></div>
-<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
class="code">init_display</code>,
whose definition as a whole is unconditional, but the changes
-themselves are contained in a ‘<samp>#ifdef HAVE_LIBNCURSES</samp>’
+themselves are contained in a ‘<samp class="samp">#ifdef
HAVE_LIBNCURSES</samp>’
conditional:
</p>
<div class="example">
-<pre class="example">* dispnew.c (init_display) [HAVE_LIBNCURSES]: If X, call
tgetent.
+<pre class="example-preformatted">* dispnew.c (init_display)
[HAVE_LIBNCURSES]: If X, call tgetent.
</pre></div>
<p>Finally, here is an entry for a change that takes effect only when
-a certain macro is <em>not</em> defined:
+a certain macro is <em class="emph">not</em> defined:
</p>
<div class="example">
-<pre class="example">* host.c (gethostname) [!HAVE_SOCKETS]: Replace with
winsock version.
+<pre class="example-preformatted">* host.c (gethostname) [!HAVE_SOCKETS]:
Replace with winsock version.
</pre></div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Indicating-the-Part-Changed.html">Indicating the Part
Changed</a>, Previous: <a href="Simple-Changes.html">Simple Changes</a>, Up: <a
href="Change-Logs.html">Change Logs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Conditional-Compilation.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Conditional-Compilation.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Conditional-Compilation.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Conditional-Compilation.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Conditional Compilation (GNU Coding Standards)</title>
<meta name="description" content="Conditional Compilation (GNU Coding
Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Standard C">
+<link href="Design-Advice.html" rel="up" title="Design Advice">
+<link href="Standard-C.html" rel="prev" title="Standard C">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,24 +43,23 @@
</head>
<body lang="en">
-<a name="Conditional-Compilation"></a>
-<div class="header">
+<div class="section-level-extent" id="Conditional-Compilation">
+<div class="nav-panel">
<p>
-Previous: <a href="Standard-C.html#Standard-C" accesskey="p"
rel="prev">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>
+Previous: <a href="Standard-C.html" accesskey="p" rel="prev">Standard C and
Pre-Standard C</a>, Up: <a href="Design-Advice.html" accesskey="u"
rel="up">General Program Design</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Conditional-Compilation-1"></a>
-<h3 class="section">3.5 Conditional Compilation</h3>
+<h3 class="section" id="Conditional-Compilation-1"><span>3.5 Conditional
Compilation<a class="copiable-link" href="#Conditional-Compilation-1">
¶</a></span></h3>
<p>When supporting configuration options already known when building your
-program we prefer using <code>if (... )</code> over conditional compilation,
+program we prefer using <code class="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>
<p>For example, please write
</p>
-<div class="smallexample">
-<pre class="smallexample"> if (HAS_FOO)
+<div class="example smallexample">
+<pre class="example-preformatted"> if (HAS_FOO)
...
else
...
@@ -87,8 +67,8 @@
<p>instead of:
</p>
-<div class="smallexample">
-<pre class="smallexample"> #ifdef HAS_FOO
+<div class="example smallexample">
+<pre class="example-preformatted"> #ifdef HAS_FOO
...
#else
...
@@ -98,25 +78,26 @@
<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.
+<code class="code">HAS_FOO</code> is defined as either 0 or 1.
</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>
-<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
+<p>In the case of function-like macros like <code
class="code">REVERSIBLE_CC_MODE</code> in
+GCC which cannot be simply used in <code class="code">if (...)</code>
statements, there is
an easy workaround. Simply introduce another macro
-<code>HAS_REVERSIBLE_CC_MODE</code> as in the following example:
+<code class="code">HAS_REVERSIBLE_CC_MODE</code> as in the following example:
</p>
-<div class="smallexample">
-<pre class="smallexample"> #ifdef REVERSIBLE_CC_MODE
+<div class="example smallexample">
+<pre class="example-preformatted"> #ifdef REVERSIBLE_CC_MODE
#define HAS_REVERSIBLE_CC_MODE 1
#else
#define HAS_REVERSIBLE_CC_MODE 0
#endif
</pre></div>
+</div>
Index: html_node/Configuration.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Configuration.html,v
retrieving revision 1.86
retrieving revision 1.87
diff -u -b -r1.86 -r1.87
--- html_node/Configuration.html 8 Jul 2021 18:18:43 -0000 1.86
+++ html_node/Configuration.html 29 May 2024 18:09:31 -0000 1.87
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Configuration (GNU Coding Standards)</title>
<meta name="description" content="Configuration (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Managing Releases">
+<link href="Managing-Releases.html" rel="up" title="Managing Releases">
+<link href="Makefile-Conventions.html" rel="next" title="Makefile Conventions">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span.r {font-family: initial; font-weight: normal; font-style: normal}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,182 +44,181 @@
</head>
<body lang="en">
-<a name="Configuration"></a>
-<div class="header">
+<div class="section-level-extent" id="Configuration">
+<div class="nav-panel">
<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>
+Next: <a href="Makefile-Conventions.html" accesskey="n" rel="next">Makefile
Conventions</a>, Up: <a href="Managing-Releases.html" accesskey="u"
rel="up">The Release Process</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="How-Configuration-Should-Work"><span>7.1 How
Configuration Should Work<a class="copiable-link"
href="#How-Configuration-Should-Work"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-program-configuration"></a>
-<a name="index-configure"></a>
+<a class="index-entry-id" id="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
+<code class="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
+The <code class="code">configure</code> script must record the configuration
options so
that they affect compilation.
</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="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>),
+<code class="code">configure</code> script in GNU packages. Many packages
implement it
+using GNU Autoconf (see <a data-manual="autoconf"
href="https://www.gnu.org/software/autoconf/manual/html_node/index.html#Top";>Introduction</a>
in <cite class="cite">Autoconf</cite>)
+and/or GNU Automake (see <a data-manual="automake"
href="https://www.gnu.org/software/automake/manual/html_node/index.html#Top";>Introduction</a>
in <cite class="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
+you like; for instance, by making <code class="code">configure</code> be a
wrapper around
a completely different configuration system.
</p>
-<p>Another way for the <code>configure</code> script to operate is to make a
-link from a standard name such as <samp>config.h</samp> to the proper
+<p>Another way for the <code class="code">configure</code> script to operate
is to make a
+link from a standard name such as <samp class="file">config.h</samp> 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>config.h</samp>. This is so that people won’t be able to build the
+the distribution should <em class="emph">not</em> contain a file named
+<samp class="file">config.h</samp>. This is so that people won’t be
able to build the
program without configuring it first.
</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>Makefile</samp>. Instead, it should include a file
<samp>Makefile.in</samp> which
+<p>Another thing that <code class="code">configure</code> can do is to edit
the Makefile. If
+you do this, the distribution should <em class="emph">not</em> contain a file
named
+<samp class="file">Makefile</samp>. Instead, it should include a file <samp
class="file">Makefile.in</samp> 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>
-<p>If <code>configure</code> does write the <samp>Makefile</samp>, then
<samp>Makefile</samp>
-should have a target named <samp>Makefile</samp> which causes
<code>configure</code>
+<p>If <code class="code">configure</code> does write the <samp
class="file">Makefile</samp>, then <samp class="file">Makefile</samp>
+should have a target named <samp class="file">Makefile</samp> which causes
<code class="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>Makefile</samp>.
+time. The files that <code class="code">configure</code> reads should be
listed as
+dependencies of <samp class="file">Makefile</samp>.
</p>
-<p>All the files which are output from the <code>configure</code> script should
+<p>All the files which are output from the <code class="code">configure</code>
script should
have comments at the beginning stating that they were generated
-automatically using <code>configure</code>. This is so that users won’t
think
+automatically using <code class="code">configure</code>. This is so that
users won’t think
of trying to edit them by hand.
</p>
-<p>The <code>configure</code> script should write a file named
<samp>config.status</samp>
+<p>The <code class="code">configure</code> script should write a file named
<samp class="file">config.status</samp>
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>
-<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
+<p>The <code class="code">configure</code> script should accept an option of
the form
+‘<samp class="samp">--srcdir=<var
class="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>
-<p>If the user does not specify ‘<samp>--srcdir</samp>’, then
<code>configure</code> should
-check both <samp>.</samp> and <samp>..</samp> to see if it can find the
sources. If
+<p>If the user does not specify ‘<samp
class="samp">--srcdir</samp>’, then <code class="code">configure</code>
should
+check both <samp class="file">.</samp> and <samp class="file">..</samp> 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>
-<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
+<p>Usually the easy way to support ‘<samp
class="samp">--srcdir</samp>’ is by editing a
+definition of <code class="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.
+possible, <code class="code">configure</code> can add to the Makefile a
variable named
+<code class="code">srcdir</code> whose value is precisely the specified
directory.
</p>
-<p>In addition, the ‘<samp>configure</samp>’ script should take
options
+<p>In addition, the ‘<samp class="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:
+(see <a class="pxref" href="Directory-Variables.html">Variables for
Installation Directories</a>). Here is the list:
</p>
<div class="example">
-<pre class="example">--prefix --exec-prefix --bindir --sbindir --libexecdir
--sysconfdir
+<pre class="example-preformatted">--prefix --exec-prefix --bindir --sbindir
--libexecdir --sysconfdir
--sharedstatedir --localstatedir --runstatedir
--libdir --includedir --oldincludedir
--datarootdir --datadir --infodir --localedir --mandir --docdir
--htmldir --dvidir --pdfdir --psdir
</pre></div>
-<p>The <code>configure</code> script should also take an argument which
specifies the
+<p>The <code class="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:
</p>
<div class="example">
-<pre class="example"><var>cpu</var>-<var>company</var>-<var>system</var>
+<pre class="example-preformatted"><var class="var">cpu</var>-<var
class="var">company</var>-<var class="var">system</var>
</pre></div>
<p>For example, an Athlon-based GNU/Linux system might be
-‘<samp>i686-pc-linux-gnu</samp>’.
+‘<samp class="samp">i686-pc-linux-gnu</samp>’.
</p>
-<p>The <code>configure</code> script needs to be able to decode all plausible
+<p>The <code class="code">configure</code> script needs to be able to decode
all plausible
alternatives for how to describe a machine. Thus,
-‘<samp>athlon-pc-gnu/linux</samp>’ would be a valid alias. There
is a shell
+‘<samp class="samp">athlon-pc-gnu/linux</samp>’ would be a valid
alias. There is a shell
script called
-<a
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.sub";><samp>config.sub</samp></a>
that you can use as a subroutine to validate system
+<a class="uref"
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.sub";><samp
class="file">config.sub</samp></a> that you can use as a subroutine to validate
system
types and canonicalize aliases.
</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
+<p>The <code class="code">configure</code> script should also take the option
+<samp class="option">--build=<var class="var">buildtype</var></samp>, which
should be equivalent to a
+plain <var class="var">buildtype</var> argument. For example, ‘<samp
class="samp">configure
+--build=i686-pc-linux-gnu</samp>’ is equivalent to ‘<samp
class="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
+or argument, the <code class="code">configure</code> script should normally
guess it using
the shell script
-<a
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.guess";><samp>config.guess</samp></a>.
+<a class="uref"
href="https://git.savannah.gnu.org/cgit/config.git/plain/config.guess";><samp
class="file">config.guess</samp></a>.
</p>
-<a name="index-optional-features_002c-configure_002dtime"></a>
+<a class="index-entry-id"
id="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:
</p>
-<dl compact="compact">
-<dt>‘<samp>--enable-<var>feature</var><span
class="roman">[</span>=<var>parameter</var><span
class="roman">]</span></samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">--enable-<var class="var">feature</var><span
class="r">[</span>=<var class="var">parameter</var><span
class="r">]</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>no</samp>’ should omit <var>feature</var>, if it is built
by default.
+facility called <var class="var">feature</var>. This allows users to choose
which
+optional features to include. Giving an optional <var
class="var">parameter</var> of
+‘<samp class="samp">no</samp>’ should omit <var
class="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
+<p>No ‘<samp class="samp">--enable</samp>’ option should <strong
class="strong">ever</strong> cause one feature to
+replace another. No ‘<samp class="samp">--enable</samp>’ option
should ever substitute one
useful behavior for another useful behavior. The only proper use for
-‘<samp>--enable</samp>’ is for questions of whether to build part
of the program
+‘<samp class="samp">--enable</samp>’ is for questions of whether
to build part of the program
or exclude it.
</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>.
+<dt>‘<samp class="samp">--with-<var
class="var">package</var></samp>’</dt>
+<dd><p>The package <var class="var">package</var> will be installed, so
configure this package
+to work with <var class="var">package</var>.
</p>
-<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>’,
+<p>Possible values of <var class="var">package</var> include
+‘<samp class="samp">gnu-as</samp>’ (or ‘<samp
class="samp">gas</samp>’), ‘<samp
class="samp">gnu-ld</samp>’, ‘<samp
class="samp">gnu-libc</samp>’,
+‘<samp class="samp">gdb</samp>’,
+‘<samp class="samp">x</samp>’,
and
-‘<samp>x-toolkit</samp>’.
+‘<samp class="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>’
+<p>Do not use a ‘<samp class="samp">--with</samp>’ option to
specify the file name to use to
+find certain files. That is outside the scope of what ‘<samp
class="samp">--with</samp>’
options are for.
</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
+<dt>‘<samp class="samp"><var class="var">variable</var>=<var
class="var">value</var></samp>’</dt>
+<dd><p>Set the value of the variable <var class="var">variable</var> to <var
class="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>configure
+build process. For example, the user could issue ‘<samp
class="samp">configure
CFLAGS=-g CXXFLAGS=-g</samp>’ to build with debugging information and
without
the default optimization.
</p>
-<p>Specifying variables as arguments to <code>configure</code>, like this:
+<p>Specifying variables as arguments to <code class="code">configure</code>,
like this:
</p><div class="example">
-<pre class="example">./configure CC=gcc
+<pre class="example-preformatted">./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 class="example-preformatted">CC=gcc ./configure
</pre></div>
<p>as it helps to recreate the same configuration later with
-<samp>config.status</samp>. However, both methods should be supported.
+<samp class="file">config.status</samp>. However, both methods should be
supported.
</p></dd>
</dl>
-<p>All <code>configure</code> scripts should accept all of the
“detail”
+<p>All <code class="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>--with-</samp>’ or
-‘<samp>--enable-</samp>’. This is so users will be able to
configure an
+should accept any option that starts with ‘<samp
class="samp">--with-</samp>’ or
+‘<samp class="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>
-<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
+<p>You will note that the categories ‘<samp
class="samp">--with-</samp>’ and ‘<samp
class="samp">--enable-</samp>’
+are narrow: they <strong class="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.
@@ -246,39 +227,40 @@
cross-compilation. In such a case, the host and target machines for the
program may be different.
</p>
-<p>The <code>configure</code> script should normally treat the specified type
of
+<p>The <code class="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>
<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
+type, use the configure option <samp class="option">--host=<var
class="var">hosttype</var></samp>, where
+<var class="var">hosttype</var> uses the same syntax as <var
class="var">buildtype</var>. The host type
normally defaults to the build type.
</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>--target=<var>targettype</var></samp>’. The syntax
for
-<var>targettype</var> is the same as for the host type. So the command would
+option ‘<samp class="samp">--target=<var
class="var">targettype</var></samp>’. The syntax for
+<var class="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 class="example-preformatted">./configure --host=<var
class="var">hosttype</var> --target=<var class="var">targettype</var>
</pre></div>
<p>The target type normally defaults to the host type.
Programs for which cross-operation is not meaningful need not accept the
-‘<samp>--target</samp>’ option, because configuring an entire
operating system for
+‘<samp class="samp">--target</samp>’ option, because configuring
an entire operating system for
cross-operation is not a meaningful operation.
</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
+your program is set up to do this, your <code class="code">configure</code>
script can simply
ignore most of its arguments.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="Makefile-Conventions.html">Makefile Conventions</a>, Up: <a
href="Managing-Releases.html">The Release Process</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Contributions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Contributions.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Contributions.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Contributions.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Contributions (GNU Coding Standards)</title>
<meta name="description" content="Contributions (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Reading Non-Free Code">
+<link href="Legal-Issues.html" rel="up" title="Legal Issues">
+<link href="Trademarks.html" rel="next" title="Trademarks">
+<link href="Reading-Non_002dFree-Code.html" rel="prev" title="Reading Non-Free
Code">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,21 +43,20 @@
</head>
<body lang="en">
-<a name="Contributions"></a>
-<div class="header">
+<div class="section-level-extent" id="Contributions">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Trademarks.html" accesskey="n" rel="next">Trademarks</a>,
Previous: <a href="Reading-Non_002dFree-Code.html" accesskey="p"
rel="prev">Referring to Proprietary Programs</a>, Up: <a
href="Legal-Issues.html" accesskey="u" rel="up">Keeping Free Software Free</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Accepting-Contributions"><span>2.2 Accepting
Contributions<a class="copiable-link" href="#Accepting-Contributions">
¶</a></span></h3>
+<a class="index-entry-id" id="index-legal-papers"></a>
+<a class="index-entry-id" id="index-accepting-contributions"></a>
<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
+sign papers initially. <em class="emph">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.
@@ -112,13 +92,14 @@
</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="http://www.gnu.org/prep/maintain/html_node/Legal-Matters.html#Legal-Matters";>Legal
Matters</a> in <cite>Information for GNU Maintainers</cite>.
+or not), please take a look: see <a data-manual="maintain"
href="https://www.gnu.org/prep/maintain/html_node/Legal-Matters.html#Legal-Matters";>Legal
Matters</a> in <cite class="cite">Information for GNU Maintainers</cite>.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Trademarks.html">Trademarks</a>, Previous: <a
href="Reading-Non_002dFree-Code.html">Referring to Proprietary Programs</a>,
Up: <a href="Legal-Issues.html">Keeping Free Software Free</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/DESTDIR.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/DESTDIR.html,v
retrieving revision 1.73
retrieving revision 1.74
diff -u -b -r1.73 -r1.74
--- html_node/DESTDIR.html 8 Jul 2021 18:18:43 -0000 1.73
+++ html_node/DESTDIR.html 29 May 2024 18:09:31 -0000 1.74
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>DESTDIR (GNU Coding Standards)</title>
<meta name="description" content="DESTDIR (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Command Variables">
+<link href="Makefile-Conventions.html" rel="up" title="Makefile Conventions">
+<link href="Directory-Variables.html" rel="next" title="Directory Variables">
+<link href="Command-Variables.html" rel="prev" title="Command Variables">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,72 +44,72 @@
</head>
<body lang="en">
-<a name="DESTDIR"></a>
-<div class="header">
+<div class="subsection-level-extent" id="DESTDIR">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Directory-Variables.html" accesskey="n" rel="next">Variables
for Installation Directories</a>, Previous: <a href="Command-Variables.html"
accesskey="p" rel="prev">Variables for Specifying Commands</a>, Up: <a
href="Makefile-Conventions.html" 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" 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>
+<h4 class="subsection section-level-set-subsection"
id="DESTDIR_003a-Support-for-Staged-Installs"><span>7.2.4 <code
class="code">DESTDIR</code>: Support for Staged Installs<a
class="copiable-link" href="#DESTDIR_003a-Support-for-Staged-Installs">
¶</a></span></h4>
-<a name="index-DESTDIR"></a>
-<a name="index-staged-installs"></a>
-<a name="index-installations_002c-staged"></a>
+<a class="index-entry-id" id="index-DESTDIR"></a>
+<a class="index-entry-id" id="index-staged-installs"></a>
+<a class="index-entry-id" id="index-installations_002c-staged"></a>
-<p><code>DESTDIR</code> is a variable prepended to each installed target file,
+<p><code class="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
+<pre class="example-preformatted">$(INSTALL_PROGRAM) foo
$(DESTDIR)$(bindir)/foo
$(INSTALL_DATA) libfoo.a $(DESTDIR)$(libdir)/libfoo.a
</pre></div>
-<p>The <code>DESTDIR</code> variable is specified by the user on the
<code>make</code>
+<p>The <code class="code">DESTDIR</code> variable is specified by the user on
the <code class="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 class="example-preformatted">make DESTDIR=/tmp/stage install
</pre></div>
-<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
+<p><code class="code">DESTDIR</code> should be supported only in the <code
class="code">install*</code> and
+<code class="code">uninstall*</code> targets, as those are the only targets
where it is
useful.
</p>
<p>If your installation step would normally install
-<samp>/usr/local/bin/foo</samp> and <samp>/usr/local/lib/libfoo.a</samp>, then
an
+<samp class="file">/usr/local/bin/foo</samp> and <samp
class="file">/usr/local/lib/libfoo.a</samp>, then an
installation invoked as in the example above would install
-<samp>/tmp/stage/usr/local/bin/foo</samp> and
-<samp>/tmp/stage/usr/local/lib/libfoo.a</samp> instead.
+<samp class="file">/tmp/stage/usr/local/bin/foo</samp> and
+<samp class="file">/tmp/stage/usr/local/lib/libfoo.a</samp> 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
+<p>Prepending the variable <code class="code">DESTDIR</code> to each target in
this way
+provides for <em class="dfn">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
+into a temporary location (<code class="code">DESTDIR</code>). However,
installed files
maintain their relative directory structure and any embedded file names
will not be modified.
</p>
-<p>You should not set the value of <code>DESTDIR</code> in your
<samp>Makefile</samp>
+<p>You should not set the value of <code class="code">DESTDIR</code> in your
<samp class="file">Makefile</samp>
at all; then the files are installed into their expected locations by
-default. Also, specifying <code>DESTDIR</code> should not change the
+default. Also, specifying <code class="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>
-<p><code>DESTDIR</code> support is commonly used in package creation. It is
+<p><code class="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
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
+<code class="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.
+<code class="code">DESTDIR</code>, though it is not an absolute requirement.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Directory-Variables.html">Variables for Installation
Directories</a>, Previous: <a href="Command-Variables.html">Variables for
Specifying Commands</a>, Up: <a href="Makefile-Conventions.html">Makefile
Conventions</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Design-Advice.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Design-Advice.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Design-Advice.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Design-Advice.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Design Advice (GNU Coding Standards)</title>
<meta name="description" content="Design Advice (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Trademarks">
+<link href="index.html" rel="up" title="Top">
+<link href="Program-Behavior.html" rel="next" title="Program Behavior">
+<link href="Legal-Issues.html" rel="prev" title="Legal Issues">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,34 +43,29 @@
</head>
<body lang="en">
-<a name="Design-Advice"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Design-Advice">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Program-Behavior.html" accesskey="n" rel="next">Program
Behavior for All Programs</a>, Previous: <a href="Legal-Issues.html"
accesskey="p" rel="prev">Keeping Free Software Free</a>, Up: <a
href="index.html" accesskey="u" rel="up">GNU Coding Standards</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter" id="General-Program-Design"><span>3 General Program
Design<a class="copiable-link" href="#General-Program-Design">
¶</a></span></h2>
+<a class="index-entry-id" id="index-program-design"></a>
<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>
+<ul class="mini-toc">
+<li><a href="Source-Language.html" accesskey="1">Which Languages to
Use</a></li>
+<li><a href="Compatibility.html" accesskey="2">Compatibility with Other
Implementations</a></li>
+<li><a href="Using-Extensions.html" accesskey="3">Using Non-standard
Features</a></li>
+<li><a href="Standard-C.html" accesskey="4">Standard C and Pre-Standard
C</a></li>
+<li><a href="Conditional-Compilation.html" accesskey="5">Conditional
Compilation</a></li>
+</ul>
+</div>
Index: html_node/Directory-Variables.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Directory-Variables.html,v
retrieving revision 1.89
retrieving revision 1.90
diff -u -b -r1.89 -r1.90
--- html_node/Directory-Variables.html 8 Jul 2021 18:18:43 -0000 1.89
+++ html_node/Directory-Variables.html 29 May 2024 18:09:31 -0000 1.90
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Directory Variables (GNU Coding Standards)</title>
<meta name="description" content="Directory Variables (GNU Coding Standards)">
@@ -23,37 +23,21 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="DESTDIR">
+<link href="Makefile-Conventions.html" rel="up" title="Makefile Conventions">
+<link href="Standard-Targets.html" rel="next" title="Standard Targets">
+<link href="DESTDIR.html" rel="prev" title="DESTDIR">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,14 +46,13 @@
</head>
<body lang="en">
-<a name="Directory-Variables"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Directory-Variables">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Standard-Targets.html" accesskey="n" rel="next">Standard
Targets for Users</a>, Previous: <a href="DESTDIR.html" accesskey="p"
rel="prev"><code class="code">DESTDIR</code>: Support for Staged Installs</a>,
Up: <a href="Makefile-Conventions.html" 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" 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>
+<h4 class="subsection section-level-set-subsection"
id="Variables-for-Installation-Directories"><span>7.2.5 Variables for
Installation Directories<a class="copiable-link"
href="#Variables-for-Installation-Directories"> ¶</a></span></h4>
<p>Installation directories should always be named by variables, so it is
easy to install in a nonstandard place. The standard names for these
@@ -79,15 +62,15 @@
systems.
</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
+<code class="command">make</code> (e.g., <kbd class="kbd">make prefix=/usr
install</kbd>) or
+<code class="command">configure</code> (e.g., <kbd class="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"></a>
-<a name="index-installation-directories_002c-creating"></a>
+<a class="index-entry-id"
id="index-directories_002c-creating-installation"></a>
+<a class="index-entry-id"
id="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>
@@ -96,80 +79,75 @@
these two, and nothing should be directly installed into these two
directories.
</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
<samp>/usr/local</samp>.
+<dl class="table">
+<dt><a id="index-prefix"></a><span><code class="code">prefix</code><a
class="copiable-link" href="#index-prefix"> ¶</a></span></dt>
+<dd><p>A prefix used in constructing the default values of the variables listed
+below. The default value of <code class="code">prefix</code> should be <samp
class="file">/usr/local</samp>.
When building the complete GNU system, the prefix will be empty and
-<samp>/usr</samp> will be a symbolic link to <samp>/</samp>.
-(If you are using Autoconf, write it as ‘<samp>@prefix@</samp>’.)
+<samp class="file">/usr</samp> will be a symbolic link to <samp
class="file">/</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="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
+<p>Running ‘<samp class="samp">make install</samp>’ with a
different value of <code class="code">prefix</code> from
+the one used to build the program should <em class="emph">not</em> recompile
the
program.
</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>@exec_prefix@</samp>’.)
+<dt><a id="index-exec_005fprefix"></a><span><code
class="code">exec_prefix</code><a class="copiable-link"
href="#index-exec_005fprefix"> ¶</a></span></dt>
+<dd><p>A prefix used in constructing the default values of some of the
+variables listed below. The default value of <code
class="code">exec_prefix</code> should
+be <code class="code">$(prefix)</code>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@exec_prefix@</samp>’.)
</p>
-<p>Generally, <code>$(exec_prefix)</code> is used for directories that contain
+<p>Generally, <code class="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.
+while <code class="code">$(prefix)</code> is used directly for other
directories.
</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
+<p>Running ‘<samp class="samp">make install</samp>’ with a
different value of <code class="code">exec_prefix</code>
+from the one used to build the program should <em class="emph">not</em>
recompile the
program.
</p></dd>
</dl>
<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 <samp>/usr/local/bin</samp>, but write it as
-<samp>$(exec_prefix)/bin</samp>.
-(If you are using Autoconf, write it as ‘<samp>@bindir@</samp>’.)
+<dl class="table">
+<dt><a id="index-bindir"></a><span><code class="code">bindir</code><a
class="copiable-link" href="#index-bindir"> ¶</a></span></dt>
+<dd><p>The directory for installing executable programs that users can run.
+This should normally be <samp class="file">/usr/local/bin</samp>, but write it
as
+<samp class="file">$(exec_prefix)/bin</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="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
+<dt><a id="index-sbindir"></a><span><code class="code">sbindir</code><a
class="copiable-link" href="#index-sbindir"> ¶</a></span></dt>
+<dd><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>/usr/local/sbin</samp>, but write it as
-<samp>$(exec_prefix)/sbin</samp>.
-(If you are using Autoconf, write it as ‘<samp>@sbindir@</samp>’.)
+should normally be <samp class="file">/usr/local/sbin</samp>, but write it as
+<samp class="file">$(exec_prefix)/sbin</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="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
+<dt><a id="index-libexecdir"></a><span><code class="code">libexecdir</code><a
class="copiable-link" href="#index-libexecdir"> ¶</a></span></dt>
+<dd><p>The directory for installing executable programs to be run by other
programs rather than by users. This directory should normally be
-<samp>/usr/local/libexec</samp>, but write it as
<samp>$(exec_prefix)/libexec</samp>.
-(If you are using Autoconf, write it as
‘<samp>@libexecdir@</samp>’.)
+<samp class="file">/usr/local/libexec</samp>, but write it as <samp
class="file">$(exec_prefix)/libexec</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@libexecdir@</samp>’.)
</p>
-<p>The definition of ‘<samp>libexecdir</samp>’ is the same for all
packages, so
+<p>The definition of ‘<samp class="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>$(libexecdir)/<var>package-name</var>/</samp>,
+install their data under <samp class="file">$(libexecdir)/<var
class="var">package-name</var>/</samp>,
possibly within additional subdirectories thereof, such as
-<samp>$(libexecdir)/<var>package-name</var>/<var>machine</var>/<var>version</var></samp>.
+<samp class="file">$(libexecdir)/<var class="var">package-name</var>/<var
class="var">machine</var>/<var class="var">version</var></samp>.
</p></dd>
</dl>
<p>Data files used by the program during its execution are divided into
categories in two ways.
</p>
-<ul>
-<li> Some files are normally modified by programs; others are never normally
+<ul class="itemize mark-bullet">
+<li>Some files are normally modified by programs; others are never normally
modified (though users may edit some of these).
-</li><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.
@@ -183,243 +161,244 @@
<p>Here are the variables Makefiles should use to specify directories
to put these various kinds of files in:
</p>
-<dl compact="compact">
-<dt>‘<samp>datarootdir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">datarootdir</samp>’</dt>
<dd><p>The root of the directory tree for read-only architecture-independent
-data files. This should normally be <samp>/usr/local/share</samp>, but
-write it as <samp>$(prefix)/share</samp>. (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
+data files. This should normally be <samp
class="file">/usr/local/share</samp>, but
+write it as <samp class="file">$(prefix)/share</samp>. (If you are using
Autoconf, write
+it as ‘<samp class="samp">@datarootdir@</samp>’.) ‘<samp
class="samp">datadir</samp>’’s default value is
+based on this variable; so are ‘<samp
class="samp">infodir</samp>’, ‘<samp
class="samp">mandir</samp>’, and
others.
</p>
</dd>
-<dt>‘<samp>datadir</samp>’</dt>
+<dt>‘<samp class="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>datarootdir</samp>’, but we use the two
separate
+the same place as ‘<samp class="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.
</p>
-<p>This should normally be <samp>/usr/local/share</samp>, but write it as
-<samp>$(datarootdir)</samp>. (If you are using Autoconf, write it as
-‘<samp>@datadir@</samp>’.)
+<p>This should normally be <samp class="file">/usr/local/share</samp>, but
write it as
+<samp class="file">$(datarootdir)</samp>. (If you are using Autoconf, write
it as
+‘<samp class="samp">@datadir@</samp>’.)
</p>
-<p>The definition of ‘<samp>datadir</samp>’ is the same for all
packages, so you
+<p>The definition of ‘<samp class="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>$(datadir)/<var>package-name</var>/</samp>.
+install their data under <samp class="file">$(datadir)/<var
class="var">package-name</var>/</samp>.
</p>
</dd>
-<dt>‘<samp>sysconfdir</samp>’</dt>
+<dt>‘<samp class="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>/etc/passwd</samp>, and so forth belong
+and network configuration files, <samp class="file">/etc/passwd</samp>, and so
forth belong
here. All the files in this directory should be ordinary ASCII text
-files. This directory should normally be <samp>/usr/local/etc</samp>, but
-write it as <samp>$(prefix)/etc</samp>.
-(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 <samp>$(libexecdir)</samp> or <samp>$(sbindir)</samp>). 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>$(localstatedir)</samp>.
+files. This directory should normally be <samp
class="file">/usr/local/etc</samp>, but
+write it as <samp class="file">$(prefix)/etc</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@sysconfdir@</samp>’.)
+</p>
+<p>This directory is not the right place to install executables built by
+running ‘<samp class="samp">make</samp>’—they probably
belong in <samp class="file">$(libexecdir)</samp> or
+<samp class="file">$(sbindir)</samp>. Also do not install here files that
will be
+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 class="file">$(localstatedir)</samp>.
</p>
</dd>
-<dt>‘<samp>sharedstatedir</samp>’</dt>
+<dt>‘<samp class="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>/usr/local/com</samp>, but write it as <samp>$(prefix)/com</samp>.
-(If you are using Autoconf, write it as
‘<samp>@sharedstatedir@</samp>’.)
+<samp class="file">/usr/local/com</samp>, but write it as <samp
class="file">$(prefix)/com</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@sharedstatedir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>localstatedir</samp>’</dt>
+<dt>‘<samp class="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
operation; put such configuration information in separate files that go
-in <samp>$(datadir)</samp> or <samp>$(sysconfdir)</samp>.
<samp>$(localstatedir)</samp>
-should normally be <samp>/usr/local/var</samp>, but write it as
-<samp>$(prefix)/var</samp>.
-(If you are using Autoconf, write it as
‘<samp>@localstatedir@</samp>’.)
+in <samp class="file">$(datadir)</samp> or <samp
class="file">$(sysconfdir)</samp>. <samp class="file">$(localstatedir)</samp>
+should normally be <samp class="file">/usr/local/var</samp>, but write it as
+<samp class="file">$(prefix)/var</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@localstatedir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>runstatedir</samp>’</dt>
+<dt>‘<samp class="samp">runstatedir</samp>’</dt>
<dd><p>The directory for installing data files which the programs modify
while they run, that pertain to one specific machine, and which need
not persist longer than the execution of the program—which is
generally long-lived, for example, until the next reboot. PID files
for system daemons are a typical use. In addition, this directory
should not be cleaned except perhaps at reboot, while the general
-<samp>/tmp</samp> (<code>TMPDIR</code>) may be cleaned arbitrarily. This
should
-normally be <samp>/var/run</samp>, but write it as
-<samp>$(localstatedir)/run</samp>. Having it as a separate variable allows
-the use of <samp>/run</samp> if desired, for example. (If you are using
-Autoconf 2.70 or later, write it as ‘<samp>@runstatedir@</samp>’.)
+<samp class="file">/tmp</samp> (<code class="code">TMPDIR</code>) may be
cleaned arbitrarily. This should
+normally be <samp class="file">/var/run</samp>, but write it as
+<samp class="file">$(localstatedir)/run</samp>. Having it as a separate
variable allows
+the use of <samp class="file">/run</samp> if desired, for example. (If you
are using
+Autoconf 2.70 or later, write it as ‘<samp
class="samp">@runstatedir@</samp>’.)
</p></dd>
</dl>
<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>infodir</samp>’,
but not all
-need ‘<samp>libdir</samp>’ or ‘<samp>lispdir</samp>’.
+have Info files, so every program needs ‘<samp
class="samp">infodir</samp>’, but not all
+need ‘<samp class="samp">libdir</samp>’ or ‘<samp
class="samp">lispdir</samp>’.
</p>
-<dl compact="compact">
-<dt>‘<samp>includedir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="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 <samp>/usr/local/include</samp>, but write it as
-<samp>$(prefix)/include</samp>.
-(If you are using Autoconf, write it as
‘<samp>@includedir@</samp>’.)
+programs with the C ‘<samp class="samp">#include</samp>’
preprocessor directive. This
+should normally be <samp class="file">/usr/local/include</samp>, but write it
as
+<samp class="file">$(prefix)/include</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@includedir@</samp>’.)
</p>
<p>Most compilers other than GCC do not look for header files in directory
-<samp>/usr/local/include</samp>. So installing the header files this way is
+<samp class="file">/usr/local/include</samp>. 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>.
+header files in two places, one specified by <code
class="code">includedir</code> and one
+specified by <code class="code">oldincludedir</code>.
</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 <samp>/usr/include</samp>.
-(If you are using Autoconf, you can write it as
‘<samp>@oldincludedir@</samp>’.)
+<dt>‘<samp class="samp">oldincludedir</samp>’</dt>
+<dd><p>The directory for installing ‘<samp
class="samp">#include</samp>’ header files for use with
+compilers other than GCC. This should normally be <samp
class="file">/usr/include</samp>.
+(If you are using Autoconf, you can write it as ‘<samp
class="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
+<code class="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>
<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>foo.h</samp>, then it should install the header
-file in the <code>oldincludedir</code> directory if either (1) there is no
-<samp>foo.h</samp> there or (2) the <samp>foo.h</samp> that exists came from
the Foo
+provides a header file <samp class="file">foo.h</samp>, then it should install
the header
+file in the <code class="code">oldincludedir</code> directory if either (1)
there is no
+<samp class="file">foo.h</samp> there or (2) the <samp
class="file">foo.h</samp> that exists came from the Foo
package.
</p>
-<p>To tell whether <samp>foo.h</samp> came from the Foo package, put a magic
-string in the file—part of a comment—and <code>grep</code> for
that string.
+<p>To tell whether <samp class="file">foo.h</samp> came from the Foo package,
put a magic
+string in the file—part of a comment—and <code
class="code">grep</code> for that string.
</p>
</dd>
-<dt>‘<samp>docdir</samp>’</dt>
+<dt>‘<samp class="samp">docdir</samp>’</dt>
<dd><p>The directory for installing documentation files (other than Info) for
this package. By default, it should be
-<samp>/usr/local/share/doc/<var>yourpkg</var></samp>, but it should be written
as
-<samp>$(datarootdir)/doc/<var>yourpkg</var></samp>. (If you are using
Autoconf,
-write it as ‘<samp>@docdir@</samp>’.) The <var>yourpkg</var>
subdirectory, which
+<samp class="file">/usr/local/share/doc/<var class="var">yourpkg</var></samp>,
but it should be written as
+<samp class="file">$(datarootdir)/doc/<var class="var">yourpkg</var></samp>.
(If you are using Autoconf,
+write it as ‘<samp class="samp">@docdir@</samp>’.) The <var
class="var">yourpkg</var> subdirectory, which
may include a version number, prevents collisions among files with
-common names, such as <samp>README</samp>.
+common names, such as <samp class="file">README</samp>.
</p>
</dd>
-<dt>‘<samp>infodir</samp>’</dt>
+<dt>‘<samp class="samp">infodir</samp>’</dt>
<dd><p>The directory for installing the Info files for this package. By
-default, it should be <samp>/usr/local/share/info</samp>, but it should be
-written as <samp>$(datarootdir)/info</samp>. (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.
+default, it should be <samp class="file">/usr/local/share/info</samp>, but it
should be
+written as <samp class="file">$(datarootdir)/info</samp>. (If you are using
Autoconf,
+write it as ‘<samp class="samp">@infodir@</samp>’.) <code
class="code">infodir</code> is separate from
+<code class="code">docdir</code> for compatibility with existing practice.
</p>
</dd>
-<dt>‘<samp>htmldir</samp>’</dt>
-<dt>‘<samp>dvidir</samp>’</dt>
-<dt>‘<samp>pdfdir</samp>’</dt>
-<dt>‘<samp>psdir</samp>’</dt>
+<dt>‘<samp class="samp">htmldir</samp>’</dt>
+<dt>‘<samp class="samp">dvidir</samp>’</dt>
+<dt>‘<samp class="samp">pdfdir</samp>’</dt>
+<dt>‘<samp class="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>@htmldir@</samp>’,
-‘<samp>@dvidir@</samp>’, etc.) Packages which supply several
translations
+format. They should all be set to <code class="code">$(docdir)</code> by
default. (If
+you are using Autoconf, write them as ‘<samp
class="samp">@htmldir@</samp>’,
+‘<samp class="samp">@dvidir@</samp>’, etc.) Packages which supply
several translations
of their documentation should install them in
-‘<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>’.
+‘<samp class="samp">$(htmldir)/</samp>’<var class="var">ll</var>,
‘<samp class="samp">$(pdfdir)/</samp>’<var class="var">ll</var>,
etc. where
+<var class="var">ll</var> is a locale abbreviation such as ‘<samp
class="samp">en</samp>’ or ‘<samp class="samp">pt_BR</samp>’.
</p>
</dd>
-<dt>‘<samp>libdir</samp>’</dt>
+<dt>‘<samp class="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
<samp>$(libexecdir)</samp>
-instead. The value of <code>libdir</code> should normally be
-<samp>/usr/local/lib</samp>, but write it as <samp>$(exec_prefix)/lib</samp>.
-(If you are using Autoconf, write it as ‘<samp>@libdir@</samp>’.)
+install executables here, they probably ought to go in <samp
class="file">$(libexecdir)</samp>
+instead. The value of <code class="code">libdir</code> should normally be
+<samp class="file">/usr/local/lib</samp>, but write it as <samp
class="file">$(exec_prefix)/lib</samp>.
+(If you are using Autoconf, write it as ‘<samp
class="samp">@libdir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>lispdir</samp>’</dt>
+<dt>‘<samp class="samp">lispdir</samp>’</dt>
<dd><p>The directory for installing any Emacs Lisp files in this package. By
-default, it should be <samp>/usr/local/share/emacs/site-lisp</samp>, but it
-should be written as <samp>$(datarootdir)/emacs/site-lisp</samp>.
+default, it should be <samp
class="file">/usr/local/share/emacs/site-lisp</samp>, but it
+should be written as <samp class="file">$(datarootdir)/emacs/site-lisp</samp>.
</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 <samp>configure.ac</samp> file:
+<p>If you are using Autoconf, write the default as ‘<samp
class="samp">@lispdir@</samp>’.
+In order to make ‘<samp class="samp">@lispdir@</samp>’ work, you
need the following lines
+in your <samp class="file">configure.ac</samp> file:
</p>
<div class="example">
-<pre class="example">lispdir='${datarootdir}/emacs/site-lisp'
+<pre class="example-preformatted">lispdir='${datarootdir}/emacs/site-lisp'
AC_SUBST(lispdir)
</pre></div>
</dd>
-<dt>‘<samp>localedir</samp>’</dt>
+<dt>‘<samp class="samp">localedir</samp>’</dt>
<dd><p>The directory for installing locale-specific message catalogs for this
-package. By default, it should be <samp>/usr/local/share/locale</samp>, but
-it should be written as <samp>$(datarootdir)/locale</samp>. (If you are
-using Autoconf, write it as ‘<samp>@localedir@</samp>’.) This
directory
+package. By default, it should be <samp
class="file">/usr/local/share/locale</samp>, but
+it should be written as <samp class="file">$(datarootdir)/locale</samp>. (If
you are
+using Autoconf, write it as ‘<samp
class="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:
</p>
-<dl compact="compact">
-<dt>‘<samp>mandir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="samp">mandir</samp>’</dt>
<dd><p>The top-level directory for installing the man pages (if any) for this
-package. It will normally be <samp>/usr/local/share/man</samp>, but you
-should write it as <samp>$(datarootdir)/man</samp>. (If you are using
-Autoconf, write it as ‘<samp>@mandir@</samp>’.)
+package. It will normally be <samp class="file">/usr/local/share/man</samp>,
but you
+should write it as <samp class="file">$(datarootdir)/man</samp>. (If you are
using
+Autoconf, write it as ‘<samp class="samp">@mandir@</samp>’.)
</p>
</dd>
-<dt>‘<samp>man1dir</samp>’</dt>
+<dt>‘<samp class="samp">man1dir</samp>’</dt>
<dd><p>The directory for installing section 1 man pages. Write it as
-<samp>$(mandir)/man1</samp>.
+<samp class="file">$(mandir)/man1</samp>.
</p></dd>
-<dt>‘<samp>man2dir</samp>’</dt>
+<dt>‘<samp class="samp">man2dir</samp>’</dt>
<dd><p>The directory for installing section 2 man pages. Write it as
-<samp>$(mandir)/man2</samp>
+<samp class="file">$(mandir)/man2</samp>
</p></dd>
-<dt>‘<samp>…</samp>’</dt>
+<dt>‘<samp class="samp">…</samp>’</dt>
<dd>
-<p><strong>Don’t make the primary documentation for any GNU software be a
+<p><strong class="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>
</p>
</dd>
-<dt>‘<samp>manext</samp>’</dt>
+<dt>‘<samp class="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>’.
+a period followed by the appropriate digit; it should normally be ‘<samp
class="samp">.1</samp>’.
</p>
</dd>
-<dt>‘<samp>man1ext</samp>’</dt>
+<dt>‘<samp class="samp">man1ext</samp>’</dt>
<dd><p>The file name extension for installed section 1 man pages.
</p></dd>
-<dt>‘<samp>man2ext</samp>’</dt>
+<dt>‘<samp class="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
+<dt>‘<samp class="samp">…</samp>’</dt>
+<dd><p>Use these names instead of ‘<samp
class="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:
</p>
-<dl compact="compact">
-<dt>‘<samp>srcdir</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="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>srcdir = @srcdir@</samp>’.)
+variable is normally inserted by the <code class="code">configure</code> shell
script.
+(If you are using Autoconf, use ‘<samp class="samp">srcdir =
@srcdir@</samp>’.)
</p></dd>
</dl>
<p>For example:
</p>
-<div class="smallexample">
-<pre class="smallexample"># Common prefix for installation directories.
+<div class="example smallexample">
+<pre class="example-preformatted"># Common prefix for installation directories.
# NOTE: This directory must exist when you start the install.
prefix = /usr/local
datarootdir = $(prefix)/share
@@ -436,7 +415,7 @@
<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.
+should write the <code class="code">install</code> rule to create these
subdirectories.
</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
@@ -454,10 +433,11 @@
supports them.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Standard-Targets.html">Standard Targets for Users</a>,
Previous: <a href="DESTDIR.html"><code class="code">DESTDIR</code>: Support for
Staged Installs</a>, Up: <a href="Makefile-Conventions.html">Makefile
Conventions</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: 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.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Doc-Strings-and-Manuals.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Doc-Strings-and-Manuals.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Doc Strings and Manuals (GNU Coding Standards)</title>
<meta name="description" content="Doc Strings and Manuals (GNU Coding
Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="GNU Manuals">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Manual-Structure-Details.html" rel="next" title="Manual Structure
Details">
+<link href="GNU-Manuals.html" rel="prev" title="GNU Manuals">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,14 +43,13 @@
</head>
<body lang="en">
-<a name="Doc-Strings-and-Manuals"></a>
-<div class="header">
+<div class="section-level-extent" id="Doc-Strings-and-Manuals">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Manual-Structure-Details.html" accesskey="n" rel="next">Manual
Structure Details</a>, Previous: <a href="GNU-Manuals.html" accesskey="p"
rel="prev">GNU Manuals</a>, Up: <a href="Documentation.html" accesskey="u"
rel="up">Documenting Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="Doc-Strings-and-Manuals-1"><span>6.2 Doc Strings and
Manuals<a class="copiable-link" href="#Doc-Strings-and-Manuals-1">
¶</a></span></h3>
<p>Some programming systems, such as Emacs, provide a documentation string
for each function, command or variable. You may be tempted to write a
@@ -95,6 +75,7 @@
<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>
+</div>
Index: html_node/Documentation.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Documentation.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Documentation.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Documentation.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Documentation (GNU Coding Standards)</title>
<meta name="description" content="Documentation (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Mmap">
+<link href="index.html" rel="up" title="Top">
+<link href="Managing-Releases.html" rel="next" title="Managing Releases">
+<link href="Writing-C.html" rel="prev" title="Writing C">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,45 +43,34 @@
</head>
<body lang="en">
-<a name="Documentation"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Documentation">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Managing-Releases.html" accesskey="n" rel="next">The Release
Process</a>, Previous: <a href="Writing-C.html" accesskey="p" rel="prev">Making
The Best Use of C</a>, Up: <a href="index.html" accesskey="u" rel="up">GNU
Coding Standards</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter" id="Documenting-Programs"><span>6 Documenting Programs<a
class="copiable-link" href="#Documenting-Programs"> ¶</a></span></h2>
+<a class="index-entry-id" id="index-documentation"></a>
<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.
</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.
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="GNU-Manuals.html" accesskey="1">GNU Manuals</a></li>
+<li><a href="Doc-Strings-and-Manuals.html" accesskey="2">Doc Strings and
Manuals</a></li>
+<li><a href="Manual-Structure-Details.html" accesskey="3">Manual Structure
Details</a></li>
+<li><a href="License-for-Manuals.html" accesskey="4">License for
Manuals</a></li>
+<li><a href="Manual-Credits.html" accesskey="5">Manual Credits</a></li>
+<li><a href="Printed-Manuals.html" accesskey="6">Printed Manuals</a></li>
+<li><a href="NEWS-File.html" accesskey="7">The NEWS File</a></li>
+<li><a href="Change-Logs.html" accesskey="8">Change Logs</a></li>
+<li><a href="Man-Pages.html" accesskey="9">Man Pages</a></li>
+<li><a href="Reading-other-Manuals.html">Reading other Manuals</a></li>
+</ul>
+</div>
Index: 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.43
retrieving revision 1.44
diff -u -b -r1.43 -r1.44
--- html_node/Dynamic-Plug_002dIn-Interfaces.html 8 Jul 2021 18:18:43
-0000 1.43
+++ html_node/Dynamic-Plug_002dIn-Interfaces.html 29 May 2024 18:09:31
-0000 1.44
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Dynamic Plug-In Interfaces (GNU Coding Standards)</title>
<meta name="description" content="Dynamic Plug-In Interfaces (GNU Coding
Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="--help">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Option-Table.html" rel="next" title="Option Table">
+<link href="Command_002dLine-Interfaces.html" rel="prev" title="Command-Line
Interfaces">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,16 +43,15 @@
</head>
<body lang="en">
-<a name="Dynamic-Plug_002dIn-Interfaces"></a>
-<div class="header">
+<div class="section-level-extent" id="Dynamic-Plug_002dIn-Interfaces">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Option-Table.html" accesskey="n" rel="next">Table of Long
Options</a>, Previous: <a href="Command_002dLine-Interfaces.html" accesskey="p"
rel="prev">Standards for Command Line Interfaces</a>, Up: <a
href="Program-Behavior.html" accesskey="u" rel="up">Program Behavior for All
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Standards-for-Dynamic-Plug_002din-Interfaces"></a>
-<h3 class="section">4.9 Standards for Dynamic Plug-in Interfaces</h3>
-<a name="index-plug_002dins"></a>
-<a name="index-dynamic-plug_002dins"></a>
+<h3 class="section"
id="Standards-for-Dynamic-Plug_002din-Interfaces"><span>4.9 Standards for
Dynamic Plug-in Interfaces<a class="copiable-link"
href="#Standards-for-Dynamic-Plug_002din-Interfaces"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-plug_002dins"></a>
+<a class="index-entry-id" id="index-dynamic-plug_002dins"></a>
<p>Another aspect of keeping free programs free is encouraging
development of free plug-ins, and discouraging development of
@@ -85,13 +65,13 @@
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"></a>
+<a class="index-entry-id" id="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="http://gcc.gnu.org/onlinedocs/gccint/Plugins.html#Plugins";>Plugins</a> in
<cite>GCC Internals</cite>).
+<code class="code">plugin_is_GPL_compatible</code>, thus asserting that the
plug-in is
+released under a GPL-compatible license (see <a data-manual="gccint"
href="https://gcc.gnu.org/onlinedocs/gccint/Plugins.html#Plugins";>Plugins</a>
in <cite class="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,
@@ -105,10 +85,11 @@
the plug-in developer understood that the license had this requirement.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Option-Table.html">Table of Long Options</a>, Previous: <a
href="Command_002dLine-Interfaces.html">Standards for Command Line
Interfaces</a>, Up: <a href="Program-Behavior.html">Program Behavior for All
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Errors.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Errors.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Errors.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Errors.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Errors (GNU Coding Standards)</title>
<meta name="description" content="Errors (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Libraries">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="User-Interfaces.html" rel="next" title="User Interfaces">
+<link href="Libraries.html" rel="prev" title="Libraries">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,28 +44,27 @@
</head>
<body lang="en">
-<a name="Errors"></a>
-<div class="header">
+<div class="section-level-extent" id="Errors">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="User-Interfaces.html" accesskey="n" rel="next">Standards for
Interfaces Generally</a>, Previous: <a href="Libraries.html" accesskey="p"
rel="prev">Library Behavior</a>, Up: <a href="Program-Behavior.html"
accesskey="u" rel="up">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Formatting-Error-Messages"><span>4.4 Formatting Error
Messages<a class="copiable-link" href="#Formatting-Error-Messages">
¶</a></span></h3>
+<a class="index-entry-id" id="index-formatting-error-messages"></a>
+<a class="index-entry-id" id="index-error-messages_002c-formatting"></a>
<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 class="example-preformatted"><var class="var">sourcefile</var>:<var
class="var">lineno</var>: <var class="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-preformatted"><var class="var">sourcefile</var>:<var
class="var">lineno</var>:<var class="var">column</var>: <var
class="var">message</var>
+<var class="var">sourcefile</var>:<var class="var">lineno</var>.<var
class="var">column</var>: <var class="var">message</var>
</pre></div>
@@ -94,7 +75,7 @@
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
-<code>wcwidth</code> functions.
+<code class="code">wcwidth</code> functions.
</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
@@ -102,27 +83,27 @@
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 class="example-preformatted"><var class="var">sourcefile</var>:<var
class="var">line1</var>.<var class="var">column1</var>-<var
class="var">line2</var>.<var class="var">column2</var>: <var
class="var">message</var>
+<var class="var">sourcefile</var>:<var class="var">line1</var>.<var
class="var">column1</var>-<var class="var">column2</var>: <var
class="var">message</var>
+<var class="var">sourcefile</var>:<var class="var">line1</var>-<var
class="var">line2</var>: <var class="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 class="example-preformatted"><var class="var">file1</var>:<var
class="var">line1</var>.<var class="var">column1</var>-<var
class="var">file2</var>:<var class="var">line2</var>.<var
class="var">column2</var>: <var class="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 class="example-preformatted"><var class="var">program</var>:<var
class="var">sourcefile</var>:<var class="var">lineno</var>: <var
class="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 class="example-preformatted"><var class="var">program</var>: <var
class="var">message</var>
</pre></div>
<p>when there is no relevant source file.
@@ -130,7 +111,7 @@
<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 class="example-preformatted"><var class="var">program</var>:<var
class="var">sourcefile</var>:<var class="var">lineno</var>:<var
class="var">column</var>: <var class="var">message</var>
</pre></div>
<p>In an interactive program (one that is reading commands from a
@@ -140,7 +121,7 @@
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>
-<p>The string <var>message</var> should not begin with a capital letter when
+<p>The string <var class="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.
@@ -149,10 +130,11 @@
usage messages, should start with a capital letter. But they should not
end with a period.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="User-Interfaces.html">Standards for Interfaces Generally</a>,
Previous: <a href="Libraries.html">Library Behavior</a>, Up: <a
href="Program-Behavior.html">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/File-Usage.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/File-Usage.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/File-Usage.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/File-Usage.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>File Usage (GNU Coding Standards)</title>
<meta name="description" content="File Usage (GNU Coding Standards)">
@@ -23,37 +23,17 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Memory Usage">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Memory-Usage.html" rel="prev" title="Memory Usage">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,29 +42,29 @@
</head>
<body lang="en">
-<a name="File-Usage"></a>
-<div class="header">
+<div class="section-level-extent" id="File-Usage">
+<div class="nav-panel">
<p>
-Previous: <a href="Memory-Usage.html#Memory-Usage" accesskey="p"
rel="prev">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>
+Previous: <a href="Memory-Usage.html" accesskey="p" rel="prev">Memory
Usage</a>, Up: <a href="Program-Behavior.html" accesskey="u" rel="up">Program
Behavior for All Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="File-Usage-1"></a>
-<h3 class="section">4.13 File Usage</h3>
-<a name="index-file-usage"></a>
+<h3 class="section" id="File-Usage-1"><span>4.13 File Usage<a
class="copiable-link" href="#File-Usage-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-file-usage"></a>
-<p>Programs should be prepared to operate when <samp>/usr</samp> and
<samp>/etc</samp>
+<p>Programs should be prepared to operate when <samp class="file">/usr</samp>
and <samp class="file">/etc</samp>
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>/usr</samp> or <samp>/etc</samp>.
+<samp class="file">/usr</samp> or <samp class="file">/etc</samp>.
</p>
-<p>There are two exceptions. <samp>/etc</samp> is used to store system
+<p>There are two exceptions. <samp class="file">/etc</samp> is used to store
system
configuration information; it is reasonable for a program to modify
-files in <samp>/etc</samp> when its job is to update the system configuration.
+files in <samp class="file">/etc</samp> 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>
+</div>
Index: html_node/Finding-Program-Files.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Finding-Program-Files.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- html_node/Finding-Program-Files.html 8 Jul 2021 18:18:43 -0000
1.4
+++ html_node/Finding-Program-Files.html 29 May 2024 18:09:31 -0000
1.5
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Finding Program Files (GNU Coding Standards)</title>
<meta name="description" content="Finding Program Files (GNU Coding
Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="User-Interfaces.html#User-Interfaces" rel="prev" title="User
Interfaces">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Graphical-Interfaces.html" rel="next" title="Graphical Interfaces">
+<link href="User-Interfaces.html" rel="prev" title="User Interfaces">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,39 +43,38 @@
</head>
<body lang="en">
-<a name="Finding-Program-Files"></a>
-<div class="header">
+<div class="section-level-extent" id="Finding-Program-Files">
+<div class="nav-panel">
<p>
-Next: <a href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="n"
rel="next">Graphical Interfaces</a>, Previous: <a
href="User-Interfaces.html#User-Interfaces" accesskey="p" rel="prev">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>
+Next: <a href="Graphical-Interfaces.html" accesskey="n" rel="next">Standards
for Graphical Interfaces</a>, Previous: <a href="User-Interfaces.html"
accesskey="p" rel="prev">Standards for Interfaces Generally</a>, Up: <a
href="Program-Behavior.html" accesskey="u" rel="up">Program Behavior for All
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Finding-the-Program_0027s-Executable-and-Associated-Files"></a>
-<h3 class="section">4.6 Finding the Program’s Executable and Associated
Files</h3>
+<h3 class="section"
id="Finding-the-Program_0027s-Executable-and-Associated-Files"><span>4.6
Finding the Program’s Executable and Associated Files<a
class="copiable-link"
href="#Finding-the-Program_0027s-Executable-and-Associated-Files">
¶</a></span></h3>
<p>A program may need to find the executable file it was started with, so
as to relaunch the same program. It may need to find associated
files, either source files or files constructed by building, that
it uses at run time.
</p>
-<p>The way to find them starts with looking at <code>argv[0]</code>.
+<p>The way to find them starts with looking at <code
class="code">argv[0]</code>.
</p>
<p>If that string contains a slash, it is by convention the file name of
the executable and its directory part is the directory that contained
the executable. This is the case when the program was not found
-through <code>PATH</code>, which normally means it was built but not
+through <code class="env">PATH</code>, which normally means it was built but
not
installed, and run from the build directory. The program can use the
-<code>argv[0]</code> file name to relaunch itself, and can look in its
+<code class="code">argv[0]</code> file name to relaunch itself, and can look
in its
directory part for associated files. If that file name is not
absolute, then it is relative to the working directory in which the
program started.
</p>
-<p>If <code>argv[0]</code> does not contain a slash, it is a command name whose
-executable was found via <code>PATH</code>. The program should search for
-that name in the directories in <code>PATH</code>, interpreting <samp>.</samp>
as
+<p>If <code class="code">argv[0]</code> does not contain a slash, it is a
command name whose
+executable was found via <code class="env">PATH</code>. The program should
search for
+that name in the directories in <code class="env">PATH</code>, interpreting
<samp class="file">.</samp> as
the working directory that was current when the program started.
</p>
<p>If this procedure finds the executable, we call the directory it was
-found in the <em>invocation directory</em>. The program should check
+found in the <em class="dfn">invocation directory</em>. The program should
check
for the presence in that directory of the associated files it needs.
</p>
<p>If the program’s executable is normally built in a subdirectory of the
@@ -109,34 +89,35 @@
</p>
<p>If this procedure doesn’t come up with an invocation directory that is
valid—normally the case for an installed program that was found via
-<code>PATH</code>—the program should look for the associated files in the
+<code class="env">PATH</code>—the program should look for the associated
files in the
directories where the program’s makefile installs them.
-See <a href="Directory-Variables.html#Directory-Variables">Directory
Variables</a>.
+See <a class="xref" href="Directory-Variables.html">Variables for Installation
Directories</a>.
</p>
-<p>Providing valid information in <code>argv[0]</code> is a convention, not
+<p>Providing valid information in <code class="code">argv[0]</code> is a
convention, not
guaranteed. Well-behaved programs that launch other programs, such as
shells, follow the convention; your code should follow it too, when
launching other programs. But it is always possible to launch the
-program and give a nonsensical value in <code>argv[0]</code>.
+program and give a nonsensical value in <code class="code">argv[0]</code>.
</p>
<p>Therefore, any program that needs to know the location of its
executable, or that of of other associated files, should offer the
user environment variables to specify those locations explicitly.
</p>
-<p><strong>Don’t give special privilege, such as with the
<code>setuid</code>
+<p><strong class="strong">Don’t give special privilege, such as with the
<code class="code">setuid</code>
bit, to programs that will search heuristically for associated files
or for their own executables when invoked that way.</strong> Limit that
privilege to programs that find associated files in hard-coded
-installed locations such as under <samp>/usr</samp> and <samp>/etc</samp>.
+installed locations such as under <samp class="file">/usr</samp> and <samp
class="file">/etc</samp>.
</p>
-<p>See <a
href="http://www.gnu.org/software/bash/manual/html_node/Bourne-Shell-Variables.html#Bourne-Shell-Variables";>Bourne
Shell Variables</a> in <cite>Bash Reference Manual</cite>,
-for more information about <code>PATH</code>.
+<p>See <a data-manual="bash"
href="https://www.gnu.org/software/bash/manual/html_node/Bourne-Shell-Variables.html#Bourne-Shell-Variables";>Bourne
Shell Variables</a> in <cite class="cite">Bash Reference Manual</cite>,
+for more information about <code class="env">PATH</code>.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Next: <a href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="n"
rel="next">Graphical Interfaces</a>, Previous: <a
href="User-Interfaces.html#User-Interfaces" accesskey="p" rel="prev">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>
+Next: <a href="Graphical-Interfaces.html">Standards for Graphical
Interfaces</a>, Previous: <a href="User-Interfaces.html">Standards for
Interfaces Generally</a>, Up: <a href="Program-Behavior.html">Program Behavior
for All Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Formatting.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Formatting.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Formatting.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Formatting.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Formatting (GNU Coding Standards)</title>
<meta name="description" content="Formatting (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Writing C">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Comments.html" rel="next" title="Comments">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span.r {font-family: initial; font-weight: normal; font-style: normal}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,24 +44,23 @@
</head>
<body lang="en">
-<a name="Formatting"></a>
-<div class="header">
+<div class="section-level-extent" id="Formatting">
+<div class="nav-panel">
<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>
+Next: <a href="Comments.html" accesskey="n" rel="next">Commenting Your
Work</a>, Up: <a href="Writing-C.html" accesskey="u" rel="up">Making The Best
Use of C</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Formatting-Your-Source-Code"><span>5.1 Formatting Your
Source Code<a class="copiable-link" href="#Formatting-Your-Source-Code">
¶</a></span></h3>
+<a class="index-entry-id" id="index-formatting-source-code"></a>
-<a name="index-line-length"></a>
-<a name="index-length-of-source-lines"></a>
+<a class="index-entry-id" id="index-line-length"></a>
+<a class="index-entry-id" id="index-length-of-source-lines"></a>
<p>Please keep the length of source lines to 79 characters or less, for
maximum readability in the widest range of environments.
</p>
-<a name="index-open-brace"></a>
-<a name="index-braces_002c-in-C-source"></a>
-<a name="index-function-definitions_002c-formatting"></a>
+<a class="index-entry-id" id="index-open-brace"></a>
+<a class="index-entry-id" id="index-braces_002c-in-C-source"></a>
+<a class="index-entry-id" id="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
@@ -87,7 +68,7 @@
</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
+The open-brace that starts a <code class="code">struct</code> body can go in
column one
if you find it useful to treat that definition as a defun.
</p>
<p>It is also important for function definitions to start the name of the
@@ -96,10 +77,10 @@
using Standard C syntax, the format is this:
</p>
<div class="example">
-<pre class="example">static char *
+<pre class="example-preformatted">static char *
concat (char *s1, char *s2)
{
- …
+ ...
}
</pre></div>
@@ -107,11 +88,11 @@
this:
</p>
<div class="example">
-<pre class="example">static char *
+<pre class="example-preformatted">static char *
concat (s1, s2) /* Name starts in column one here */
char *s1, *s2;
{ /* Open brace in column one here */
- …
+ ...
}
</pre></div>
@@ -119,32 +100,32 @@
split it like this:
</p>
<div class="example">
-<pre class="example">int
+<pre class="example-preformatted">int
lots_of_args (int an_integer, long a_long, short a_short,
double a_double, float a_float)
-…
+...
</pre></div>
-<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
+<a class="index-entry-id" id="index-struct-types_002c-formatting"></a>
+<a class="index-entry-id" id="index-enum-types_002c-formatting"></a>
+<p>For <code class="code">struct</code> and <code class="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
+<pre class="example-preformatted">struct foo
{
int a, b;
}
-</pre><pre class="example"><span class="roman">or</span>
-</pre><pre class="example">struct foo { int a, b; }
+</pre><pre class="exdent"><span class="r">or</span>
+</pre><pre class="example-preformatted">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>
+C formatting style, which is also the default style of the <code
class="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
+<div class="example smallexample">
+<pre class="example-preformatted">-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>
@@ -160,7 +141,7 @@
<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))
+<pre class="example-preformatted">if (x < foo (y, z))
haha = bar[4] + 5;
else
{
@@ -173,16 +154,16 @@
}
</pre></div>
-<a name="index-spaces-before-open_002dparen"></a>
+<a class="index-entry-id" id="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"></a>
+<a class="index-entry-id" id="index-expressions_002c-splitting"></a>
<div class="example">
-<pre class="example">if (foo_this_is_long && bar > win (x, y, z)
+<pre class="example-preformatted">if (foo_this_is_long && bar > win
(x, y, z)
&& remaining_condition)
</pre></div>
@@ -190,7 +171,7 @@
level of indentation. For example, don’t write this:
</p>
<div class="example">
-<pre class="example">mode = (inmode[j] == VOIDmode
+<pre class="example-preformatted">mode = (inmode[j] == VOIDmode
|| GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])
? outmode[j] : inmode[j]);
</pre></div>
@@ -198,7 +179,7 @@
<p>Instead, use extra parentheses so that the indentation shows the nesting:
</p>
<div class="example">
-<pre class="example">mode = ((inmode[j] == VOIDmode
+<pre class="example-preformatted">mode = ((inmode[j] == VOIDmode
|| (GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])))
? outmode[j] : inmode[j]);
</pre></div>
@@ -207,7 +188,7 @@
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
+<pre class="example-preformatted">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></div>
@@ -215,31 +196,32 @@
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
+<pre class="example-preformatted">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></div>
<p>Format do-while statements like this:
</p>
<div class="example">
-<pre class="example">do
+<pre class="example-preformatted">do
{
a = foo (a);
}
while (a > 0);
</pre></div>
-<a name="index-formfeed"></a>
-<a name="index-control_002dL"></a>
+<a class="index-entry-id" id="index-formfeed"></a>
+<a class="index-entry-id" id="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>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="Comments.html">Commenting Your Work</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: 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.86
retrieving revision 1.87
diff -u -b -r1.86 -r1.87
--- html_node/GNU-Free-Documentation-License.html 8 Jul 2021 18:18:43
-0000 1.86
+++ html_node/GNU-Free-Documentation-License.html 29 May 2024 18:09:31
-0000 1.87
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>GNU Free Documentation License (GNU Coding Standards)</title>
<meta name="description" content="GNU Free Documentation License (GNU Coding
Standards)">
@@ -23,37 +23,22 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="References">
+<link href="index.html" rel="up" title="Top">
+<link href="Index.html" rel="next" title="Index">
+<link href="References.html" rel="prev" title="References">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+div.center {text-align:center}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+pre.display-preformatted {font-family: inherit}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,32 +47,31 @@
</head>
<body lang="en">
-<a name="GNU-Free-Documentation-License"></a>
-<div class="header">
+<div class="appendix-level-extent" id="GNU-Free-Documentation-License">
+<div class="nav-panel">
<p>
-Next: <a href="Index.html#Index" accesskey="n" rel="next">Index</a>, Previous:
<a href="References.html#References" accesskey="p" rel="prev">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>
+Next: <a href="Index.html" accesskey="n" rel="next">Index</a>, Previous: <a
href="References.html" accesskey="p" rel="prev">References to Non-Free Software
and Documentation</a>, Up: <a href="index.html" accesskey="u" rel="up">GNU
Coding Standards</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="appendix" id="GNU-Free-Documentation-License-1"><span>Appendix A
GNU Free Documentation License<a class="copiable-link"
href="#GNU-Free-Documentation-License-1"> ¶</a></span></h2>
-<a name="index-FDL_002c-GNU-Free-Documentation-License"></a>
-<div align="center">Version 1.3, 3 November 2008
+<a class="index-entry-id"
id="index-FDL_002c-GNU-Free-Documentation-License"></a>
+<div class="center">Version 1.3, 3 November 2008
</div>
<div class="display">
-<pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free
Software Foundation, Inc.
-<a href="https://fsf.org/";>https://fsf.org/</a>
+<pre class="display-preformatted">Copyright © 2000, 2001, 2002, 2007,
2008 Free Software Foundation, Inc.
+<a class="uref" href="https://fsf.org/";>https://fsf.org/</a>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre></div>
-<ol start="0">
+<ol class="enumerate" start="0">
<li> PREAMBLE
<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
+functional and useful document <em class="dfn">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
@@ -259,7 +243,7 @@
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
</p>
-<ol type="A" start="1">
+<ol class="enumerate" type="A" start="1">
<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
@@ -459,7 +443,7 @@
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="https://www.gnu.org/licenses/";>https://www.gnu.org/licenses/</a>.
+<a class="uref"
href="https://www.gnu.org/licenses/";>https://www.gnu.org/licenses/</a>.
</p>
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
@@ -505,31 +489,30 @@
</p>
</li></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>
+<h3 class="heading"
id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"><span>ADDENDUM:
How to use this License for your documents<a class="copiable-link"
href="#ADDENDUM_003a-How-to-use-this-License-for-your-documents">
¶</a></span></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>.
+<div class="example smallexample">
+<div class="group"><pre class="example-preformatted"> Copyright (C) <var
class="var">year</var> <var class="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
or any later version published by the Free Software Foundation;
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></div>
+</pre></div></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></div>
+<div class="example smallexample">
+<div class="group"><pre class="example-preformatted"> with the Invariant
Sections being <var class="var">list their titles</var>, with
+ the Front-Cover Texts being <var class="var">list</var>, and with the
Back-Cover Texts
+ being <var class="var">list</var>.
+</pre></div></div>
<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
@@ -541,10 +524,11 @@
to permit their use in free software.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Next: <a href="Index.html#Index" accesskey="n" rel="next">Index</a>, Previous:
<a href="References.html#References" accesskey="p" rel="prev">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>
+Next: <a href="Index.html">Index</a>, Previous: <a
href="References.html">References to Non-Free Software and Documentation</a>,
Up: <a href="index.html">GNU Coding Standards</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/GNU-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/GNU-Manuals.html,v
retrieving revision 1.85
retrieving revision 1.86
diff -u -b -r1.85 -r1.86
--- html_node/GNU-Manuals.html 8 Jul 2021 18:18:43 -0000 1.85
+++ html_node/GNU-Manuals.html 29 May 2024 18:09:31 -0000 1.86
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>GNU Manuals (GNU Coding Standards)</title>
<meta name="description" content="GNU Manuals (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Documentation">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Doc-Strings-and-Manuals.html" rel="next" title="Doc Strings and
Manuals">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,14 +43,13 @@
</head>
<body lang="en">
-<a name="GNU-Manuals"></a>
-<div class="header">
+<div class="section-level-extent" id="GNU-Manuals">
+<div class="nav-panel">
<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>
+Next: <a href="Doc-Strings-and-Manuals.html" accesskey="n" rel="next">Doc
Strings and Manuals</a>, Up: <a href="Documentation.html" accesskey="u"
rel="up">Documenting Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="GNU-Manuals-1"></a>
-<h3 class="section">6.1 GNU Manuals</h3>
+<h3 class="section" id="GNU-Manuals-1"><span>6.1 GNU Manuals<a
class="copiable-link" href="#GNU-Manuals-1"> ¶</a></span></h3>
<p>The preferred document format for the GNU system is the Texinfo
formatting language. Every GNU package should (ideally) have
@@ -77,8 +57,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 <code>info</code> or the
-Emacs Info subsystem (<kbd>C-h i</kbd>).
+hardcopy, or the on-line version available through <code
class="code">info</code> or the
+Emacs Info subsystem (<kbd class="kbd">C-h i</kbd>).
</p>
<p>Nowadays some other formats such as Docbook and Sgmltexi can be
converted automatically into Texinfo. It is ok to produce the Texinfo
@@ -138,10 +118,10 @@
implementation, rather than the structure that helps the user
understand.
</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
+<p>Instead, each manual should cover a coherent <em class="emph">topic</em>.
For example,
+instead of a manual for <code class="code">diff</code> and a manual for <code
class="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
+programs, as well as <code class="code">cmp</code>. By documenting these
programs
together, we can make the whole subject clearer.
</p>
<p>The manual which discusses a program should certainly document all of
@@ -166,7 +146,7 @@
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
+section into paragraphs. The watchword is, <em class="emph">at each point,
address
the most fundamental and important issue raised by the preceding text.</em>
</p>
<p>If necessary, add extra chapters at the beginning of the manual which
@@ -179,9 +159,9 @@
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="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>.
+entries, see <a data-manual="texinfo"
href="https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Index-Entries.html#Index-Entries";>Making
Index Entries</a> in <cite class="cite">GNU
+Texinfo</cite>, and see <a data-manual="texinfo"
href="https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Indexing-Commands.html#Indexing-Commands";>Defining
the Entries of an
+Index</a> in <cite class="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
@@ -190,7 +170,7 @@
different from what we use in GNU manuals.
</p>
<p>Please include an email address in the manual for where to report
-bugs <em>in the text of the manual</em>.
+bugs <em class="emph">in the text of the manual</em>.
</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
@@ -200,26 +180,27 @@
a computer program. Please use “invalid” for this, and reserve the
term “illegal” for activities prohibited by law.
</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
+<p>Please do not write ‘<samp class="samp">()</samp>’ after a
function name just to indicate
+it is a function. <code class="code">foo ()</code> is not a function, it is a
function
call with no arguments.
</p>
<p>Whenever possible, please stick to the active voice, avoiding the
passive, and use the present tense, not the future tense. For
-instance, write “The function <code>foo</code> returns a list containing
-<var>a</var> and <var>b</var>” rather than “A list containing
<var>a</var> and
-<var>b</var> will be returned.” One advantage of the active voice is it
+instance, write “The function <code class="code">foo</code> returns a
list containing
+<var class="var">a</var> and <var class="var">b</var>” rather than
“A list containing <var class="var">a</var> and
+<var class="var">b</var> will be returned.” One advantage of the active
voice is it
requires you to state the subject of the sentence; with the passive
voice, you might omit the subject, which leads to vagueness.
</p>
<p>It is proper to use the future tense when grammar demands it, as in,
-“If you type <kbd>x</kbd>, the computer will self-destruct in 10
+“If you type <kbd class="kbd">x</kbd>, the computer will self-destruct
in 10
seconds.”
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="Doc-Strings-and-Manuals.html">Doc Strings and Manuals</a>, Up:
<a href="Documentation.html">Documenting Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Graphical-Interfaces.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Graphical-Interfaces.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Graphical-Interfaces.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Graphical-Interfaces.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Graphical Interfaces (GNU Coding Standards)</title>
<meta name="description" content="Graphical Interfaces (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="Finding-Program-Files.html#Finding-Program-Files" rel="prev"
title="Finding Program Files">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Command_002dLine-Interfaces.html" rel="next" title="Command-Line
Interfaces">
+<link href="Finding-Program-Files.html" rel="prev" title="Finding Program
Files">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,20 +43,19 @@
</head>
<body lang="en">
-<a name="Graphical-Interfaces"></a>
-<div class="header">
+<div class="section-level-extent" id="Graphical-Interfaces">
+<div class="nav-panel">
<p>
-Next: <a href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces"
accesskey="n" rel="next">Command-Line Interfaces</a>, Previous: <a
href="Finding-Program-Files.html#Finding-Program-Files" accesskey="p"
rel="prev">Finding Program Files</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>
+Next: <a href="Command_002dLine-Interfaces.html" accesskey="n"
rel="next">Standards for Command Line Interfaces</a>, Previous: <a
href="Finding-Program-Files.html" accesskey="p" rel="prev">Finding the
Program’s Executable and Associated Files</a>, Up: <a
href="Program-Behavior.html" accesskey="u" rel="up">Program Behavior for All
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Standards-for-Graphical-Interfaces"></a>
-<h3 class="section">4.7 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>
+<h3 class="section" id="Standards-for-Graphical-Interfaces"><span>4.7
Standards for Graphical Interfaces<a class="copiable-link"
href="#Standards-for-Graphical-Interfaces"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-graphical-user-interface"></a>
+<a class="index-entry-id" id="index-interface-styles"></a>
+<a class="index-entry-id" id="index-user-interface-styles"></a>
-<a name="index-GTK_002b"></a>
-<a name="index-GNUstep"></a>
+<a class="index-entry-id" id="index-GTK_002b"></a>
+<a class="index-entry-id" id="index-GNUstep"></a>
<p>When you write a program that provides a graphical user interface,
please make it work with the X Window System, using the GTK+ toolkit
or the GNUstep toolkit, unless the functionality specifically requires
@@ -87,11 +67,11 @@
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"></a>
-<a name="index-GNOME"></a>
-<a name="index-D_002dbus"></a>
-<a name="index-keyboard-interface"></a>
-<a name="index-library-interface"></a>
+<a class="index-entry-id" id="index-CORBA"></a>
+<a class="index-entry-id" id="index-GNOME"></a>
+<a class="index-entry-id" id="index-D_002dbus"></a>
+<a class="index-entry-id" id="index-keyboard-interface"></a>
+<a class="index-entry-id" id="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
@@ -102,9 +82,10 @@
</p>
<p>Please make your program interoperate with access technology such as
screen readers (see
-<a
href="https://www.gnu.org/accessibility/accessibility.html";>https://www.gnu.org/accessibility/accessibility.html</a>).
This should
+<a class="url"
href="https://www.gnu.org/accessibility/accessibility.html";>https://www.gnu.org/accessibility/accessibility.html</a>).
This should
be automatic if you use GTK+.
</p>
+</div>
Index: html_node/Index.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Index.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Index.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Index.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Index (GNU Coding Standards)</title>
<meta name="description" content="Index (GNU Coding Standards)">
@@ -23,36 +23,22 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" 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="prev" title="GNU Free Documentation License">
+<link href="index.html" rel="up" title="Top">
+<link href="GNU-Free-Documentation-License.html" rel="prev" title="GNU Free
Documentation License">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+a.summary-letter-printindex {text-decoration: none}
+span:hover a.copiable-link {visibility: visible}
+td.printindex-index-entry {vertical-align: top}
+td.printindex-index-section {vertical-align: top; padding-left: 1em}
+th.entries-header-printindex {text-align:left}
+th.sections-header-printindex {text-align:left; padding-left: 1em}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -61,355 +47,357 @@
</head>
<body lang="en">
-<a name="Index"></a>
-<div class="header">
+<div class="unnumbered-level-extent" id="Index">
+<div class="nav-panel">
<p>
-Previous: <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
accesskey="p" rel="prev">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>
+Previous: <a href="GNU-Free-Documentation-License.html" accesskey="p"
rel="prev">GNU Free Documentation License</a>, Up: <a href="index.html"
accesskey="u" rel="up">GNU Coding Standards</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>
+<h2 class="unnumbered" id="Index-1"><span>Index<a class="copiable-link"
href="#Index-1"> ¶</a></span></h2>
+<div class="printindex cp-printindex">
+<table class="cp-letters-header-printindex"><tr><th>Jump to:
</th><td><a class="summary-letter-printindex"
href="#Index_cp_symbol-1"><b>-</b></a>
-<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-G"><b>G</b></a>
-<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
+<a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a>
-<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-W"><b>W</b></a>
-<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+<a class="summary-letter-printindex" 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">ANSI 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="Change-Log-Concepts.html#index-batch-of-changes_002c-in-a-change-log">batch
of changes, in a change log</a>:</td><td> </td><td valign="top"><a
href="Change-Log-Concepts.html#Change-Log-Concepts">Change Log
Concepts</a></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>bug-standards@gnu.org</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="Compatibility.html#index-C-compatibility">C
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-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="Change-Log-Concepts.html#index-changeset_002c-in-a-change-log">changeset,
in a change log</a>:</td><td> </td><td valign="top"><a
href="Change-Log-Concepts.html#Change-Log-Concepts">Change Log
Concepts</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 POSIX 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="Change-Log-Concepts.html#index-description_002c-change-log-entry">description,
change log entry</a>:</td><td> </td><td valign="top"><a
href="Change-Log-Concepts.html#Change-Log-Concepts">Change Log
Concepts</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>gnustandards-commit@gnu.org</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-GNUstep">GNUstep</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="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-H">H</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="Change-Log-Concepts.html#index-header-line_002c-change-log-entry">header
line, change log entry</a>:</td><td> </td><td valign="top"><a
href="Change-Log-Concepts.html#Change-Log-Concepts">Change Log
Concepts</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="Formatting.html#index-length-of-source-lines">length of source
lines</a>:</td><td> </td><td valign="top"><a
href="Formatting.html#Formatting">Formatting</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="Formatting.html#index-line-length">line
length</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-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"><samp>NEWS</samp>
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-POSIX
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">POSIX
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"><samp>README</samp>
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="Change-Logs.html#index-software-forensics_002c-and-change-logs">software
forensics, and 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="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"><samp>texinfo.tex</samp>,
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="Change-Log-Concepts.html#index-title_002c-change-log-entry">title, change
log entry</a>:</td><td> </td><td valign="top"><a
href="Change-Log-Concepts.html#Change-Log-Concepts">Change Log
Concepts</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></td><td valign="top"><a
href="Change-Logs.html#index-VCS">VCS</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="Change-Logs.html#index-version-control-system_002c-for-keeping-change-logs">version
control system, for keeping 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="Releases.html#index-version-numbers_002c-for-releases">version numbers,
for releases</a>:</td><td> </td><td valign="top"><a
href="Releases.html#Releases">Releases</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 class="cp-entries-printindex" border="0">
+<tr><td></td><th class="entries-header-printindex">Index Entry</th><th
class="sections-header-printindex">Section</th></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_symbol-1">-</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="_002d_002dhelp.html#index-_002d_002dhelp-output">‘<samp
class="samp">--help</samp>’ output</a></td><td
class="printindex-index-section"><a
href="_002d_002dhelp.html">--help</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="_002d_002dversion.html#index-_002d_002dversion-output">‘<samp
class="samp">--version</samp>’ output</a></td><td
class="printindex-index-section"><a
href="_002d_002dversion.html">--version</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-_002dWall-compiler-option">‘<samp
class="samp">-Wall</samp>’ compiler option</a></td><td
class="printindex-index-section"><a href="Syntactic-Conventions.html">Syntactic
Conventions</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_symbol-2">#</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Comments.html#index-_0023endif_002c-commenting"><code
class="code">#endif</code>, commenting</a></td><td
class="printindex-index-section"><a href="Comments.html">Comments</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-A">A</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Contributions.html#index-accepting-contributions">accepting
contributions</a></td><td class="printindex-index-section"><a
href="Contributions.html">Contributions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="_002d_002dhelp.html#index-address-for-bug-reports">address for bug
reports</a></td><td class="printindex-index-section"><a
href="_002d_002dhelp.html">--help</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Standard-C.html#index-ANSI-C-standard">ANSI C standard</a></td><td
class="printindex-index-section"><a href="Standard-C.html">Standard
C</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-arbitrary-limits-on-data">arbitrary limits on
data</a></td><td class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Character-Set.html#index-ASCII-characters">ASCII characters</a></td><td
class="printindex-index-section"><a href="Character-Set.html">Character
Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Portability.html#index-autoconf"><code>autoconf</code></a></td><td
class="printindex-index-section"><a href="System-Portability.html">System
Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Reading-Non_002dFree-Code.html#index-avoiding-proprietary-code">avoiding
proprietary code</a></td><td class="printindex-index-section"><a
href="Reading-Non_002dFree-Code.html">Reading Non-Free Code</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-B">B</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Log-Concepts.html#index-batch-of-changes_002c-in-a-change-log">batch
of changes, in a change log</a></td><td class="printindex-index-section"><a
href="Change-Log-Concepts.html">Change Log Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="User-Interfaces.html#index-behavior_002c-dependent-on-program_0027s-name">behavior,
dependent on program’s name</a></td><td
class="printindex-index-section"><a href="User-Interfaces.html">User
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Install-Command-Categories.html#index-binary-packages">binary
packages</a></td><td class="printindex-index-section"><a
href="Install-Command-Categories.html">Install Command Categories</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Directory-Variables.html#index-bindir"><code>bindir</code></a></td><td
class="printindex-index-section"><a href="Directory-Variables.html">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-braces_002c-in-C-source">braces, in C
source</a></td><td class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="_002d_002dhelp.html#index-bug-reports">bug reports</a></td><td
class="printindex-index-section"><a
href="_002d_002dhelp.html">--help</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Preface.html#index-bug_002dstandards_0040gnu_002eorg-email-address"><code
class="code">bug-standards@gnu.org</code> email address</a></td><td
class="printindex-index-section"><a href="Preface.html">Preface</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-C">C</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Compatibility.html#index-C-compatibility">C compatibility</a></td><td
class="printindex-index-section"><a
href="Compatibility.html">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-C-library-functions_002c-and-portability">C
library functions, and portability</a></td><td
class="printindex-index-section"><a href="System-Functions.html">System
Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="_002d_002dversion.html#index-canonical-name-of-a-program">canonical name
of a program</a></td><td class="printindex-index-section"><a
href="_002d_002dversion.html">--version</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="CPU-Portability.html#index-casting-pointers-to-integers">casting pointers
to integers</a></td><td class="printindex-index-section"><a
href="CPU-Portability.html">CPU Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Command_002dLine-Interfaces.html#index-CGI-programs_002c-standard-options-for">CGI
programs, standard options for</a></td><td class="printindex-index-section"><a
href="Command_002dLine-Interfaces.html">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Logs.html#index-change-logs">change logs</a></td><td
class="printindex-index-section"><a href="Change-Logs.html">Change
Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Conditional-Changes.html#index-change-logs_002c-conditional-changes">change
logs, conditional changes</a></td><td class="printindex-index-section"><a
href="Conditional-Changes.html">Conditional Changes</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Style-of-Change-Logs.html#index-change-logs_002c-style">change logs,
style</a></td><td class="printindex-index-section"><a
href="Style-of-Change-Logs.html">Style of Change Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Log-Concepts.html#index-changeset_002c-in-a-change-log">changeset,
in a change log</a></td><td class="printindex-index-section"><a
href="Change-Log-Concepts.html">Change Log Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Character-Set.html#index-character-set">character set</a></td><td
class="printindex-index-section"><a href="Character-Set.html">Character
Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-clang"><code>clang</code></a></td><td
class="printindex-index-section"><a href="Syntactic-Conventions.html">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-command_002dline-arguments_002c-decoding">command-line
arguments, decoding</a></td><td class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Command_002dLine-Interfaces.html#index-command_002dline-interface">command-line
interface</a></td><td class="printindex-index-section"><a
href="Command_002dLine-Interfaces.html">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Comments.html#index-commenting">commenting</a></td><td
class="printindex-index-section"><a href="Comments.html">Comments</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Compatibility.html#index-compatibility-with-C-and-POSIX-standards">compatibility
with C and POSIX standards</a></td><td class="printindex-index-section"><a
href="Compatibility.html">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-compiler-warnings">compiler
warnings</a></td><td class="printindex-index-section"><a
href="Syntactic-Conventions.html">Syntactic Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Conditional-Changes.html#index-conditional-changes_002c-and-change-logs">conditional
changes, and change logs</a></td><td class="printindex-index-section"><a
href="Conditional-Changes.html">Conditional Changes</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Comments.html#index-conditionals_002c-comments-for">conditionals,
comments for</a></td><td class="printindex-index-section"><a
href="Comments.html">Comments</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Configuration.html#index-configure"><code>configure</code></a></td><td
class="printindex-index-section"><a
href="Configuration.html">Configuration</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-control_002dL">control-L</a></td><td
class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Makefile-Conventions.html#index-conventions-for-makefiles">conventions
for makefiles</a></td><td class="printindex-index-section"><a
href="Makefile-Conventions.html">Makefile Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-CORBA">CORBA</a></td><td
class="printindex-index-section"><a href="Graphical-Interfaces.html">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Manual-Credits.html#index-credits-for-manuals">credits for
manuals</a></td><td class="printindex-index-section"><a
href="Manual-Credits.html">Manual Credits</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-D">D</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-D_002dbus">D-bus</a></td><td
class="printindex-index-section"><a href="Graphical-Interfaces.html">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-data-structures_002c-in-Gnulib"><code>data
structures, in Gnulib</code></a></td><td class="printindex-index-section"><a
href="System-Functions.html">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="CPU-Portability.html#index-data-types_002c-and-portability">data types,
and portability</a></td><td class="printindex-index-section"><a
href="CPU-Portability.html">CPU Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Log-Concepts.html#index-description_002c-change-log-entry">description,
change log entry</a></td><td class="printindex-index-section"><a
href="Change-Log-Concepts.html">Change Log Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="DESTDIR.html#index-DESTDIR"><code>DESTDIR</code></a></td><td
class="printindex-index-section"><a href="DESTDIR.html">DESTDIR</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Directory-Variables.html#index-directories_002c-creating-installation">directories,
creating installation</a></td><td class="printindex-index-section"><a
href="Directory-Variables.html">Directory Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Documentation.html#index-documentation">documentation</a></td><td
class="printindex-index-section"><a
href="Documentation.html">Documentation</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Names.html#index-doschk"><code>doschk</code></a></td><td
class="printindex-index-section"><a href="Names.html">Names</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-double-quote">double quote</a></td><td
class="printindex-index-section"><a href="Quote-Characters.html">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Preface.html#index-downloading-this-manual">downloading this
manual</a></td><td class="printindex-index-section"><a
href="Preface.html">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-dynamic-plug_002dins">dynamic
plug-ins</a></td><td class="printindex-index-section"><a
href="Dynamic-Plug_002dIn-Interfaces.html">Dynamic Plug-In
Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-E">E</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Character-Set.html#index-encodings">encodings</a></td><td
class="printindex-index-section"><a href="Character-Set.html">Character
Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-enum-types_002c-formatting"><code
class="code">enum</code> types, formatting</a></td><td
class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-error-messages">error messages</a></td><td
class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Errors.html#index-error-messages_002c-formatting">error messages,
formatting</a></td><td class="printindex-index-section"><a
href="Errors.html">Errors</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-error-messages_002c-in-Gnulib"><code>error
messages, in Gnulib</code></a></td><td class="printindex-index-section"><a
href="System-Functions.html">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Directory-Variables.html#index-exec_005fprefix"><code>exec_prefix</code></a></td><td
class="printindex-index-section"><a href="Directory-Variables.html">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-expressions_002c-splitting">expressions,
splitting</a></td><td class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-F">F</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="GNU-Free-Documentation-License.html#index-FDL_002c-GNU-Free-Documentation-License">FDL,
GNU Free Documentation License</a></td><td class="printindex-index-section"><a
href="GNU-Free-Documentation-License.html">GNU Free Documentation
License</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="File-Usage.html#index-file-usage">file usage</a></td><td
class="printindex-index-section"><a href="File-Usage.html">File
Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Names.html#index-file_002dname-limitations">file-name
limitations</a></td><td class="printindex-index-section"><a
href="Names.html">Names</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Errors.html#index-formatting-error-messages">formatting error
messages</a></td><td class="printindex-index-section"><a
href="Errors.html">Errors</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-formatting-source-code">formatting source
code</a></td><td class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-formfeed">formfeed</a></td><td
class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-function-argument_002c-declaring">function
argument, declaring</a></td><td class="printindex-index-section"><a
href="Syntactic-Conventions.html">Syntactic Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-function-definitions_002c-formatting">function
definitions, formatting</a></td><td class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Standard-C.html#index-function-prototypes">function
prototypes</a></td><td class="printindex-index-section"><a
href="Standard-C.html">Standard C</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-G">G</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Command_002dLine-Interfaces.html#index-getopt"><code>getopt</code></a></td><td
class="printindex-index-section"><a
href="Command_002dLine-Interfaces.html">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Internationalization.html#index-gettext"><code>gettext</code></a></td><td
class="printindex-index-section"><a
href="Internationalization.html">Internationalization</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-GNOME">GNOME</a></td><td
class="printindex-index-section"><a href="Graphical-Interfaces.html">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Source-Language.html#index-GNOME-and-Guile">GNOME and Guile</a></td><td
class="printindex-index-section"><a href="Source-Language.html">Source
Language</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-Gnulib">Gnulib</a></td><td
class="printindex-index-section"><a href="System-Functions.html">System
Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Preface.html#index-gnustandards-project-repository">gnustandards project
repository</a></td><td class="printindex-index-section"><a
href="Preface.html">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Preface.html#index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"><code
class="code">gnustandards-commit@gnu.org</code> mailing list</a></td><td
class="printindex-index-section"><a href="Preface.html">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-GNUstep">GNUstep</a></td><td
class="printindex-index-section"><a href="Graphical-Interfaces.html">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-graphical-user-interface">graphical user
interface</a></td><td class="printindex-index-section"><a
href="Graphical-Interfaces.html">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-grave-accent">grave accent</a></td><td
class="printindex-index-section"><a href="Quote-Characters.html">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-GTK_002b">GTK+</a></td><td
class="printindex-index-section"><a href="Graphical-Interfaces.html">Graphical
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Source-Language.html#index-Guile">Guile</a></td><td
class="printindex-index-section"><a href="Source-Language.html">Source
Language</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-H">H</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Log-Concepts.html#index-header-line_002c-change-log-entry">header
line, change log entry</a></td><td class="printindex-index-section"><a
href="Change-Log-Concepts.html">Change Log Concepts</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-I">I</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-implicit-int">implicit <code
class="code">int</code></a></td><td class="printindex-index-section"><a
href="Syntactic-Conventions.html">Syntactic Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-impossible-conditions">impossible
conditions</a></td><td class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Directory-Variables.html#index-installation-directories_002c-creating">installation
directories, creating</a></td><td class="printindex-index-section"><a
href="Directory-Variables.html">Directory Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="DESTDIR.html#index-installations_002c-staged">installations,
staged</a></td><td class="printindex-index-section"><a
href="DESTDIR.html">DESTDIR</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-interface-styles">interface
styles</a></td><td class="printindex-index-section"><a
href="Graphical-Interfaces.html">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Internationalization.html#index-internationalization">internationalization</a></td><td
class="printindex-index-section"><a
href="Internationalization.html">Internationalization</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-K">K</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-keyboard-interface">keyboard
interface</a></td><td class="printindex-index-section"><a
href="Graphical-Interfaces.html">Graphical Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-L">L</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="OID-Allocations.html#index-LDAP">LDAP</a></td><td
class="printindex-index-section"><a href="OID-Allocations.html">OID
Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-left-quote">left quote</a></td><td
class="printindex-index-section"><a href="Quote-Characters.html">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Legal-Issues.html#index-legal-aspects">legal aspects</a></td><td
class="printindex-index-section"><a href="Legal-Issues.html">Legal
Issues</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Contributions.html#index-legal-papers">legal papers</a></td><td
class="printindex-index-section"><a
href="Contributions.html">Contributions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-length-of-source-lines">length of source
lines</a></td><td class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Directory-Variables.html#index-libexecdir"><code>libexecdir</code></a></td><td
class="printindex-index-section"><a href="Directory-Variables.html">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-libiconv"><code>libiconv</code></a></td><td
class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Libraries.html#index-libraries">libraries</a></td><td
class="printindex-index-section"><a
href="Libraries.html">Libraries</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-library-functions_002c-and-portability">library
functions, and portability</a></td><td class="printindex-index-section"><a
href="System-Functions.html">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-library-interface">library
interface</a></td><td class="printindex-index-section"><a
href="Graphical-Interfaces.html">Graphical Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="License-for-Manuals.html#index-license-for-manuals">license for
manuals</a></td><td class="printindex-index-section"><a
href="License-for-Manuals.html">License for Manuals</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-line-length">line length</a></td><td
class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-lint"><code>lint</code></a></td><td
class="printindex-index-section"><a href="Syntactic-Conventions.html">Syntactic
Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-locale_002dspecific-quote-characters">locale-specific
quote characters</a></td><td class="printindex-index-section"><a
href="Quote-Characters.html">Quote Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Option-Table.html#index-long-option-names">long option names</a></td><td
class="printindex-index-section"><a href="Option-Table.html">Option
Table</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Command_002dLine-Interfaces.html#index-long_002dnamed-options">long-named
options</a></td><td class="printindex-index-section"><a
href="Command_002dLine-Interfaces.html">Command-Line Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-M">M</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Makefile-Conventions.html#index-makefile_002c-conventions-for">makefile,
conventions for</a></td><td class="printindex-index-section"><a
href="Makefile-Conventions.html">Makefile Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-malloc-return-value"><code
class="code">malloc</code> return value</a></td><td
class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Man-Pages.html#index-man-pages">man pages</a></td><td
class="printindex-index-section"><a href="Man-Pages.html">Man
Pages</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Manual-Structure-Details.html#index-manual-structure">manual
structure</a></td><td class="printindex-index-section"><a
href="Manual-Structure-Details.html">Manual Structure Details</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-memory-allocation-failure">memory allocation
failure</a></td><td class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Memory-Usage.html#index-memory-leak">memory leak</a></td><td
class="printindex-index-section"><a href="Memory-Usage.html">Memory
Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Memory-Usage.html#index-memory-usage">memory usage</a></td><td
class="printindex-index-section"><a href="Memory-Usage.html">Memory
Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Internationalization.html#index-message-text_002c-and-internationalization">message
text, and internationalization</a></td><td class="printindex-index-section"><a
href="Internationalization.html">Internationalization</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Mmap.html#index-mmap"><code>mmap</code></a></td><td
class="printindex-index-section"><a href="Mmap.html">Mmap</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-multiple-variables-in-a-line">multiple
variables in a line</a></td><td class="printindex-index-section"><a
href="Syntactic-Conventions.html">Syntactic Conventions</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-N">N</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Names.html#index-names-of-variables_002c-functions_002c-and-files">names
of variables, functions, and files</a></td><td
class="printindex-index-section"><a href="Names.html">Names</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="NEWS-File.html#index-NEWS-file"><samp class="file">NEWS</samp>
file</a></td><td class="printindex-index-section"><a href="NEWS-File.html">NEWS
File</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Character-Set.html#index-non_002dASCII-characters">non-ASCII
characters</a></td><td class="printindex-index-section"><a
href="Character-Set.html">Character Set</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Portability.html#index-non_002dPOSIX-systems_002c-and-portability">non-POSIX
systems, and portability</a></td><td class="printindex-index-section"><a
href="System-Portability.html">System Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Using-Extensions.html#index-non_002dstandard-extensions">non-standard
extensions</a></td><td class="printindex-index-section"><a
href="Using-Extensions.html">Using Extensions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-NUL-characters"><code class="code">NUL</code>
characters</a></td><td class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-O">O</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="OID-Allocations.html#index-OID-allocations-for-GNU">OID allocations for
GNU</a></td><td class="printindex-index-section"><a
href="OID-Allocations.html">OID Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-open-brace">open brace</a></td><td
class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-opening-quote">opening quote</a></td><td
class="printindex-index-section"><a href="Quote-Characters.html">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Configuration.html#index-optional-features_002c-configure_002dtime">optional
features, configure-time</a></td><td class="printindex-index-section"><a
href="Configuration.html">Configuration</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Compatibility.html#index-options-for-compatibility">options for
compatibility</a></td><td class="printindex-index-section"><a
href="Compatibility.html">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Command_002dLine-Interfaces.html#index-options_002c-standard-command_002dline">options,
standard command-line</a></td><td class="printindex-index-section"><a
href="Command_002dLine-Interfaces.html">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="User-Interfaces.html#index-output-device-and-program_0027s-behavior">output
device and program’s behavior</a></td><td
class="printindex-index-section"><a href="User-Interfaces.html">User
Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-P">P</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Releases.html#index-packaging">packaging</a></td><td
class="printindex-index-section"><a href="Releases.html">Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Command_002dLine-Interfaces.html#index-PATH_005fINFO_002c-specifying-standard-options-as">PATH_INFO,
specifying standard options as</a></td><td class="printindex-index-section"><a
href="Command_002dLine-Interfaces.html">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-plug_002dins">plug-ins</a></td><td
class="printindex-index-section"><a
href="Dynamic-Plug_002dIn-Interfaces.html">Dynamic Plug-In
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Dynamic-Plug_002dIn-Interfaces.html#index-plugin_005fis_005fGPL_005fcompatible"><code>plugin_is_GPL_compatible</code></a></td><td
class="printindex-index-section"><a
href="Dynamic-Plug_002dIn-Interfaces.html">Dynamic Plug-In
Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="CPU-Portability.html#index-portability_002c-and-data-types">portability,
and data types</a></td><td class="printindex-index-section"><a
href="CPU-Portability.html">CPU Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-portability_002c-and-library-functions">portability,
and library functions</a></td><td class="printindex-index-section"><a
href="System-Functions.html">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Portability.html#index-portability_002c-between-system-types">portability,
between system types</a></td><td class="printindex-index-section"><a
href="System-Portability.html">System Portability</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Compatibility.html#index-POSIX-compatibility">POSIX
compatibility</a></td><td class="printindex-index-section"><a
href="Compatibility.html">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-POSIX-functions_002c-and-portability">POSIX
functions, and portability</a></td><td class="printindex-index-section"><a
href="System-Functions.html">System Functions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Compatibility.html#index-POSIXLY_005fCORRECT_002c-environment-variable"><code
class="code">POSIXLY_CORRECT</code>, environment variable</a></td><td
class="printindex-index-section"><a
href="Compatibility.html">Compatibility</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Install-Command-Categories.html#index-post_002dinstallation-commands">post-installation
commands</a></td><td class="printindex-index-section"><a
href="Install-Command-Categories.html">Install Command Categories</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Install-Command-Categories.html#index-pre_002dinstallation-commands">pre-installation
commands</a></td><td class="printindex-index-section"><a
href="Install-Command-Categories.html">Install Command Categories</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Directory-Variables.html#index-prefix"><code>prefix</code></a></td><td
class="printindex-index-section"><a href="Directory-Variables.html">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Configuration.html#index-program-configuration">program
configuration</a></td><td class="printindex-index-section"><a
href="Configuration.html">Configuration</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Design-Advice.html#index-program-design">program design</a></td><td
class="printindex-index-section"><a href="Design-Advice.html">Design
Advice</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="User-Interfaces.html#index-program-name-and-its-behavior">program name
and its behavior</a></td><td class="printindex-index-section"><a
href="User-Interfaces.html">User Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="_002d_002dversion.html#index-program_0027s-canonical-name">program’s
canonical name</a></td><td class="printindex-index-section"><a
href="_002d_002dversion.html">--version</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Source-Language.html#index-programming-languages">programming
languages</a></td><td class="printindex-index-section"><a
href="Source-Language.html">Source Language</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Reading-Non_002dFree-Code.html#index-proprietary-programs">proprietary
programs</a></td><td class="printindex-index-section"><a
href="Reading-Non_002dFree-Code.html">Reading Non-Free Code</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-Q">Q</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-quote-characters">quote
characters</a></td><td class="printindex-index-section"><a
href="Quote-Characters.html">Quote Characters</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-R">R</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Releases.html#index-README-file"><samp class="file">README</samp>
file</a></td><td class="printindex-index-section"><a
href="Releases.html">Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="References.html#index-references-to-non_002dfree-material">references to
non-free material</a></td><td class="printindex-index-section"><a
href="References.html">References</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Managing-Releases.html#index-releasing">releasing</a></td><td
class="printindex-index-section"><a href="Managing-Releases.html">Managing
Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-right-quote">right quote</a></td><td
class="printindex-index-section"><a href="Quote-Characters.html">Quote
Characters</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-S">S</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Preface.html#index-Savannah-repository-for-gnustandards">Savannah
repository for gnustandards</a></td><td class="printindex-index-section"><a
href="Preface.html">Preface</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Directory-Variables.html#index-sbindir"><code>sbindir</code></a></td><td
class="printindex-index-section"><a href="Directory-Variables.html">Directory
Variables</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-signal-handling">signal handling</a></td><td
class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Quote-Characters.html#index-single-quote">single quote</a></td><td
class="printindex-index-section"><a href="Quote-Characters.html">Quote
Characters</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="OID-Allocations.html#index-SNMP">SNMP</a></td><td
class="printindex-index-section"><a href="OID-Allocations.html">OID
Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Logs.html#index-software-forensics_002c-and-change-logs">software
forensics, and change logs</a></td><td class="printindex-index-section"><a
href="Change-Logs.html">Change Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-spaces-before-open_002dparen">spaces before
open-paren</a></td><td class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="DESTDIR.html#index-staged-installs">staged installs</a></td><td
class="printindex-index-section"><a href="DESTDIR.html">DESTDIR</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Command_002dLine-Interfaces.html#index-standard-command_002dline-options">standard
command-line options</a></td><td class="printindex-index-section"><a
href="Command_002dLine-Interfaces.html">Command-Line Interfaces</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Makefile-Conventions.html#index-standards-for-makefiles">standards for
makefiles</a></td><td class="printindex-index-section"><a
href="Makefile-Conventions.html">Makefile Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Formatting.html#index-struct-types_002c-formatting"><code
class="code">struct</code> types, formatting</a></td><td
class="printindex-index-section"><a
href="Formatting.html">Formatting</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-syntactic-conventions">syntactic
conventions</a></td><td class="printindex-index-section"><a
href="Syntactic-Conventions.html">Syntactic Conventions</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-T">T</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Option-Table.html#index-table-of-long-options">table of long
options</a></td><td class="printindex-index-section"><a
href="Option-Table.html">Option Table</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-temporary-files">temporary files</a></td><td
class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Syntactic-Conventions.html#index-temporary-variables">temporary
variables</a></td><td class="printindex-index-section"><a
href="Syntactic-Conventions.html">Syntactic Conventions</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Releases.html#index-texinfo_002etex_002c-in-a-distribution"><samp
class="file">texinfo.tex</samp>, in a distribution</a></td><td
class="printindex-index-section"><a href="Releases.html">Releases</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Log-Concepts.html#index-title_002c-change-log-entry">title, change
log entry</a></td><td class="printindex-index-section"><a
href="Change-Log-Concepts.html">Change Log Concepts</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Semantics.html#index-TMPDIR-environment-variable"><code
class="code">TMPDIR</code> environment variable</a></td><td
class="printindex-index-section"><a
href="Semantics.html">Semantics</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Trademarks.html#index-trademarks">trademarks</a></td><td
class="printindex-index-section"><a
href="Trademarks.html">Trademarks</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-U">U</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Graphical-Interfaces.html#index-user-interface-styles">user interface
styles</a></td><td class="printindex-index-section"><a
href="Graphical-Interfaces.html">Graphical Interfaces</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-V">V</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Memory-Usage.html#index-valgrind"><code>valgrind</code></a></td><td
class="printindex-index-section"><a href="Memory-Usage.html">Memory
Usage</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Logs.html#index-VCS">VCS</a></td><td
class="printindex-index-section"><a href="Change-Logs.html">Change
Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Change-Logs.html#index-version-control-system_002c-for-keeping-change-logs">version
control system, for keeping change logs</a></td><td
class="printindex-index-section"><a href="Change-Logs.html">Change
Logs</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Releases.html#index-version-numbers_002c-for-releases">version numbers,
for releases</a></td><td class="printindex-index-section"><a
href="Releases.html">Releases</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-W">W</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="Preface.html#index-where-to-obtain-standards_002etexi">where to obtain
<code class="code">standards.texi</code></a></td><td
class="printindex-index-section"><a href="Preface.html">Preface</a></td></tr>
+<tr><td colspan="3"><hr></td></tr>
+<tr><th id="Index_cp_letter-X">X</th></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="OID-Allocations.html#index-X_002e509">X.509</a></td><td
class="printindex-index-section"><a href="OID-Allocations.html">OID
Allocations</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a
href="System-Functions.html#index-xmalloc_002c-in-Gnulib"><code>xmalloc, in
Gnulib</code></a></td><td class="printindex-index-section"><a
href="System-Functions.html">System Functions</a></td></tr>
+<tr><td colspan="3"><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>
+<table class="cp-letters-footer-printindex"><tr><th>Jump to:
</th><td><a class="summary-letter-printindex"
href="#Index_cp_symbol-1"><b>-</b></a>
-<a class="summary-letter" href="#Index_cp_symbol-2"><b>-</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-G"><b>G</b></a>
-<a class="summary-letter" href="#Index_cp_letter-H"><b>H</b></a>
+<a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a>
-<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
+<a class="summary-letter-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" 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-printindex" href="#Index_cp_letter-W"><b>W</b></a>
-<a class="summary-letter" href="#Index_cp_letter-X"><b>X</b></a>
+<a class="summary-letter-printindex" href="#Index_cp_letter-X"><b>X</b></a>
</td></tr></table>
+</div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Previous: <a
href="GNU-Free-Documentation-License.html#GNU-Free-Documentation-License"
accesskey="p" rel="prev">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>
+Previous: <a href="GNU-Free-Documentation-License.html">GNU Free Documentation
License</a>, Up: <a href="index.html">GNU Coding Standards</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>
Index: 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.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Indicating-the-Part-Changed.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Indicating-the-Part-Changed.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Indicating the Part Changed (GNU Coding Standards)</title>
<meta name="description" content="Indicating the Part Changed (GNU Coding
Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Conditional Changes">
+<link href="Change-Logs.html" rel="up" title="Change Logs">
+<link href="Conditional-Changes.html" rel="prev" title="Conditional Changes">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,26 +43,26 @@
</head>
<body lang="en">
-<a name="Indicating-the-Part-Changed"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Indicating-the-Part-Changed">
+<div class="nav-panel">
<p>
-Previous: <a href="Conditional-Changes.html#Conditional-Changes" accesskey="p"
rel="prev">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>
+Previous: <a href="Conditional-Changes.html" accesskey="p"
rel="prev">Conditional Changes</a>, Up: <a href="Change-Logs.html"
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" 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>
+<h4 class="subsection" id="Indicating-the-Part-Changed-1"><span>6.8.5
Indicating the Part Changed<a class="copiable-link"
href="#Indicating-the-Part-Changed-1"> ¶</a></span></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:
+for a change in the part of the function <code
class="code">sh-while-getopts</code> that
+deals with <code class="code">sh</code> commands:
</p>
<div class="example">
-<pre class="example">* progmodes/sh-script.el (sh-while-getopts) <sh>:
Handle case that
+<pre class="example-preformatted">* progmodes/sh-script.el (sh-while-getopts)
<sh>: Handle case that
user-specified option string is empty.
</pre></div>
+</div>
Index: html_node/Install-Command-Categories.html
===================================================================
RCS file:
/web/www/www/prep/standards/html_node/Install-Command-Categories.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Install-Command-Categories.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Install-Command-Categories.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Install Command Categories (GNU Coding Standards)</title>
<meta name="description" content="Install Command Categories (GNU Coding
Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Standard
Targets">
+<link href="Makefile-Conventions.html" rel="up" title="Makefile Conventions">
+<link href="Standard-Targets.html" rel="prev" title="Standard Targets">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span.r {font-family: initial; font-weight: normal; font-style: normal}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,20 +44,19 @@
</head>
<body lang="en">
-<a name="Install-Command-Categories"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Install-Command-Categories">
+<div class="nav-panel">
<p>
-Previous: <a href="Standard-Targets.html#Standard-Targets" accesskey="p"
rel="prev">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>
+Previous: <a href="Standard-Targets.html" accesskey="p" rel="prev">Standard
Targets for Users</a>, Up: <a href="Makefile-Conventions.html" 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"
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>
+<h4 class="subsection section-level-set-subsection"
id="Install-Command-Categories-1"><span>7.2.7 Install Command Categories<a
class="copiable-link" href="#Install-Command-Categories-1">
¶</a></span></h4>
-<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.
+<a class="index-entry-id" id="index-pre_002dinstallation-commands"></a>
+<a class="index-entry-id" id="index-post_002dinstallation-commands"></a>
+<p>When writing the <code class="code">install</code> target, you must
classify all the
+commands into three categories: normal ones, <em
class="dfn">pre-installation</em>
+commands and <em class="dfn">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
@@ -89,7 +70,7 @@
normal commands.
</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
+<code class="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
@@ -98,8 +79,8 @@
<p>Most programs don’t need any pre-installation commands, but we have
the
feature just in case it is needed.
</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
+<p>To classify the commands in the <code class="code">install</code> rule into
these three
+categories, insert <em class="dfn">category lines</em> among them. A category
line
specifies the category for the commands that follow.
</p>
<p>A category line consists of a tab and a reference to a special Make
@@ -107,36 +88,36 @@
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).
+<em class="emph">should not</em> define them in the makefile).
</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>
+<div class="example smallexample">
+<pre class="example-preformatted"> $(PRE_INSTALL) # <span
class="r">Pre-install commands follow.</span>
+ $(POST_INSTALL) # <span class="r">Post-install commands
follow.</span>
+ $(NORMAL_INSTALL) # <span class="r">Normal commands follow.</span>
</pre></div>
-<p>If you don’t use a category line at the beginning of the
<code>install</code>
+<p>If you don’t use a category line at the beginning of the <code
class="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
classified as normal.
</p>
-<p>These are the category lines for <code>uninstall</code>:
+<p>These are the category lines for <code class="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>
+<div class="example smallexample">
+<pre class="example-preformatted"> $(PRE_UNINSTALL) # <span
class="r">Pre-uninstall commands follow.</span>
+ $(POST_UNINSTALL) # <span class="r">Post-uninstall commands
follow.</span>
+ $(NORMAL_UNINSTALL) # <span class="r">Normal commands follow.</span>
</pre></div>
<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
+<p>If the <code class="code">install</code> or <code
class="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
+<em class="emph">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.
@@ -145,14 +126,14 @@
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
+<pre class="example-preformatted">[ basename bash cat chgrp chmod chown cmp cp
dd diff echo
+expand expr false 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>
-<a name="index-binary-packages"></a>
+<a class="index-entry-id" id="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
@@ -162,30 +143,31 @@
</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>-s</samp> option to
-<code>make</code> is needed to silence messages about entering
+extracting the pre-installation commands (the <samp class="option">-s</samp>
option to
+<code class="command">make</code> is needed to silence messages about entering
subdirectories):
</p>
-<div class="smallexample">
-<pre class="smallexample">make -s -n install -o all \
+<div class="example smallexample">
+<pre class="example-preformatted">make -s -n install -o all \
PRE_INSTALL=pre-install \
POST_INSTALL=post-install \
NORMAL_INSTALL=normal-install \
| gawk -f pre-install.awk
</pre></div>
-<p>where the file <samp>pre-install.awk</samp> could contain this:
+<p>where the file <samp class="file">pre-install.awk</samp> could contain this:
</p>
-<div class="smallexample">
-<pre class="smallexample">$0 ~ /^(normal-install|post-install)[ \t]*$/ {on = 0}
+<div class="example smallexample">
+<pre class="example-preformatted">$0 ~ /^(normal-install|post-install)[ \t]*$/
{on = 0}
on {print $0}
$0 ~ /^pre-install[ \t]*$/ {on = 1}
</pre></div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Previous: <a href="Standard-Targets.html#Standard-Targets" accesskey="p"
rel="prev">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>
+Previous: <a href="Standard-Targets.html">Standard Targets for Users</a>, Up:
<a href="Makefile-Conventions.html">Makefile Conventions</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Internationalization.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Internationalization.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Internationalization.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Internationalization.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Internationalization (GNU Coding Standards)</title>
<meta name="description" content="Internationalization (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="System
Functions">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Character-Set.html" rel="next" title="Character Set">
+<link href="System-Functions.html" rel="prev" title="System Functions">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,43 +44,42 @@
</head>
<body lang="en">
-<a name="Internationalization"></a>
-<div class="header">
+<div class="section-level-extent" id="Internationalization">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Character-Set.html" accesskey="n" rel="next">Character Set</a>,
Previous: <a href="System-Functions.html" accesskey="p" rel="prev">Calling
System Functions</a>, Up: <a href="Writing-C.html" accesskey="u"
rel="up">Making The Best Use of C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="Internationalization-1"><span>5.8
Internationalization<a class="copiable-link" href="#Internationalization-1">
¶</a></span></h3>
+<a class="index-entry-id" id="index-internationalization"></a>
-<a name="index-gettext"></a>
+<a class="index-entry-id" id="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>
-<p>Using GNU gettext involves putting a call to the <code>gettext</code> macro
+<p>Using GNU gettext involves putting a call to the <code
class="code">gettext</code> macro
around each string that might need translation—like this:
</p>
<div class="example">
-<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+<pre class="example-preformatted">printf (gettext ("Processing file
'%s'..."), file);
</pre></div>
-<p>This permits GNU gettext to replace the string <code>"Processing file
+<p>This permits GNU gettext to replace the string <code
class="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.
+<code class="code">gettext</code> when you add new strings that call for
translation.
</p>
-<p>Using GNU gettext in a package involves specifying a <em>text domain
+<p>Using GNU gettext in a package involves specifying a <em class="dfn">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>coreutils</samp>’ for the GNU
core utilities.
+package—for example, ‘<samp class="samp">coreutils</samp>’
for the GNU core utilities.
</p>
-<a name="index-message-text_002c-and-internationalization"></a>
+<a class="index-entry-id"
id="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
@@ -108,14 +89,14 @@
</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");
+<div class="example smallexample">
+<pre class="example-preformatted">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"),
+<div class="example smallexample">
+<pre class="example-preformatted">printf (gettext ("%s is full"),
capacity > 5000000 ? gettext ("disk") : gettext
("floppy disk"));
</pre></div>
@@ -128,7 +109,7 @@
<p>Complete sentences can be translated without problems:
</p>
<div class="example">
-<pre class="example">printf (capacity > 5000000 ? gettext ("disk is
full")
+<pre class="example-preformatted">printf (capacity > 5000000 ? gettext
("disk is full")
: gettext ("floppy disk is full"));
</pre></div>
@@ -136,18 +117,18 @@
code:
</p>
<div class="example">
-<pre class="example">printf ("# Implicit rule search has%s been
done.\n",
+<pre class="example-preformatted">printf ("# Implicit rule search has%s
been done.\n",
f->tried_implicit ? "" : " not");
</pre></div>
-<p>Adding <code>gettext</code> calls to this code cannot give correct results
for
+<p>Adding <code class="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
+<code class="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
+<pre class="example-preformatted">printf (f->tried_implicit
? "# Implicit rule search has been done.\n",
: "# Implicit rule search has not been done.\n");
</pre></div>
@@ -155,7 +136,7 @@
<p>Another example is this one:
</p>
<div class="example">
-<pre class="example">printf ("%d file%s processed", nfiles,
+<pre class="example-preformatted">printf ("%d file%s processed",
nfiles,
nfiles != 1 ? "s" : "");
</pre></div>
@@ -163,7 +144,7 @@
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,
+<pre class="example-preformatted">printf (gettext ("%d file%s
processed"), nfiles,
nfiles != 1 ? "s" : "");
</pre></div>
@@ -172,25 +153,26 @@
the two strings independently:
</p>
<div class="example">
-<pre class="example">printf ((nfiles != 1 ? gettext ("%d files
processed")
+<pre class="example-preformatted">printf ((nfiles != 1 ? gettext ("%d
files processed")
: gettext ("%d file processed")),
nfiles);
</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:
+and one for the rest. The GNU <code class="code">ngettext</code> function
solves this problem:
</p>
<div class="example">
-<pre class="example">printf (ngettext ("%d files processed",
"%d file processed", nfiles),
+<pre class="example-preformatted">printf (ngettext ("%d files
processed", "%d file processed", nfiles),
nfiles);
</pre></div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Character-Set.html">Character Set</a>, Previous: <a
href="System-Functions.html">Calling System Functions</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Legal-Issues.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Legal-Issues.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Legal-Issues.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Legal-Issues.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Legal Issues (GNU Coding Standards)</title>
<meta name="description" content="Legal Issues (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Preface">
+<link href="index.html" rel="up" title="Top">
+<link href="Design-Advice.html" rel="next" title="Design Advice">
+<link href="Preface.html" rel="prev" title="Preface">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,28 +43,25 @@
</head>
<body lang="en">
-<a name="Legal-Issues"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Legal-Issues">
+<div class="nav-panel">
<p>
-Next: <a href="Design-Advice.html#Design-Advice" accesskey="n"
rel="next">Design Advice</a>, Previous: <a href="Preface.html#Preface"
accesskey="p" rel="prev">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>
+Next: <a href="Design-Advice.html" accesskey="n" rel="next">General Program
Design</a>, Previous: <a href="Preface.html" accesskey="p" rel="prev">About the
GNU Coding Standards</a>, Up: <a href="index.html" accesskey="u" rel="up">GNU
Coding Standards</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter" id="Keeping-Free-Software-Free"><span>2 Keeping Free
Software Free<a class="copiable-link" href="#Keeping-Free-Software-Free">
¶</a></span></h2>
+<a class="index-entry-id" id="index-legal-aspects"></a>
<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="mini-toc">
+<li><a href="Reading-Non_002dFree-Code.html" accesskey="1">Referring to
Proprietary Programs</a></li>
+<li><a href="Contributions.html" accesskey="2">Accepting Contributions</a></li>
+<li><a href="Trademarks.html" accesskey="3">Trademarks</a></li>
+</ul>
+</div>
Index: html_node/Libraries.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Libraries.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Libraries.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Libraries.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Libraries (GNU Coding Standards)</title>
<meta name="description" content="Libraries (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Semantics">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Errors.html" rel="next" title="Errors">
+<link href="Semantics.html" rel="prev" title="Semantics">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,19 +43,18 @@
</head>
<body lang="en">
-<a name="Libraries"></a>
-<div class="header">
+<div class="section-level-extent" id="Libraries">
+<div class="nav-panel">
<p>
-Next: <a href="Errors.html#Errors" accesskey="n" rel="next">Errors</a>,
Previous: <a href="Semantics.html#Semantics" accesskey="p"
rel="prev">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>
+Next: <a href="Errors.html" accesskey="n" rel="next">Formatting Error
Messages</a>, Previous: <a href="Semantics.html" accesskey="p"
rel="prev">Writing Robust Programs</a>, Up: <a href="Program-Behavior.html"
accesskey="u" rel="up">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Library-Behavior"><span>4.3 Library Behavior<a
class="copiable-link" href="#Library-Behavior"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-libraries"></a>
<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.
+that of <code class="code">malloc</code> itself.
</p>
<p>Here are certain name conventions for libraries, to avoid name
conflicts.
@@ -90,7 +70,7 @@
other; then they can both go in the same file.
</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
+should have names beginning with ‘<samp class="samp">_</samp>’.
The ‘<samp class="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.
@@ -98,6 +78,7 @@
<p>Static functions and variables can be used as you like and need not
fit any naming convention.
</p>
+</div>
Index: html_node/License-for-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/License-for-Manuals.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/License-for-Manuals.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/License-for-Manuals.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>License for Manuals (GNU Coding Standards)</title>
<meta name="description" content="License for Manuals (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Manual Structure Details">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Manual-Credits.html" rel="next" title="Manual Credits">
+<link href="Manual-Structure-Details.html" rel="prev" title="Manual Structure
Details">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +43,14 @@
</head>
<body lang="en">
-<a name="License-for-Manuals"></a>
-<div class="header">
+<div class="section-level-extent" id="License-for-Manuals">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Manual-Credits.html" accesskey="n" rel="next">Manual
Credits</a>, Previous: <a href="Manual-Structure-Details.html" accesskey="p"
rel="prev">Manual Structure Details</a>, Up: <a href="Documentation.html"
accesskey="u" rel="up">Documenting Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="License-for-Manuals-1"><span>6.4 License for Manuals<a
class="copiable-link" href="#License-for-Manuals-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-license-for-manuals"></a>
<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
@@ -78,7 +58,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.
</p>
-<p>See <a
href="https://www.gnu.org/copyleft/fdl-howto.html";>https://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
+<p>See <a class="uref"
href="https://www.gnu.org/copyleft/fdl-howto.html";>https://www.gnu.org/copyleft/fdl-howto.html</a>
for more explanation
of how to employ the GFDL.
</p>
<p>Note that it is not obligatory to include a copy of the GNU GPL or GNU
@@ -87,6 +67,7 @@
short manual, whose size would be increased considerably by including
the program’s license, it is probably better not to include it.
</p>
+</div>
Index: html_node/Makefile-Basics.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Makefile-Basics.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Makefile-Basics.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Makefile-Basics.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Makefile Basics (GNU Coding Standards)</title>
<meta name="description" content="Makefile Basics (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Makefile Conventions">
+<link href="Makefile-Conventions.html" rel="up" title="Makefile Conventions">
+<link href="Utilities-in-Makefiles.html" rel="next" title="Utilities in
Makefiles">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,83 +43,82 @@
</head>
<body lang="en">
-<a name="Makefile-Basics"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Makefile-Basics">
+<div class="nav-panel">
<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>
+Next: <a href="Utilities-in-Makefiles.html" accesskey="n" rel="next">Utilities
in Makefiles</a>, Up: <a href="Makefile-Conventions.html" 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"
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>
+<h4 class="subsection section-level-set-subsection"
id="General-Conventions-for-Makefiles"><span>7.2.1 General Conventions for
Makefiles<a class="copiable-link" href="#General-Conventions-for-Makefiles">
¶</a></span></h4>
<p>Every Makefile should contain this line:
</p>
<div class="example">
-<pre class="example">SHELL = /bin/sh
+<pre class="example-preformatted">SHELL = /bin/sh
</pre></div>
-<p>to avoid trouble on systems where the <code>SHELL</code> variable might be
+<p>to avoid trouble on systems where the <code class="code">SHELL</code>
variable might be
inherited from the environment. (This is never a problem with GNU
-<code>make</code>.)
+<code class="code">make</code>.)
</p>
-<p>Different <code>make</code> programs have incompatible suffix lists and
+<p>Different <code class="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:
+<pre class="example-preformatted">.SUFFIXES:
.SUFFIXES: .c .o
</pre></div>
<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>
-<p>Don’t assume that <samp>.</samp> is in the path for command
execution. When
+<p>Don’t assume that <samp class="file">.</samp> 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>./</samp> if the program is built as
-part of the make or <samp>$(srcdir)/</samp> if the file is an unchanging part
+make, please make sure that it uses <samp class="file">./</samp> if the
program is built as
+part of the make or <samp class="file">$(srcdir)/</samp> if the file is an
unchanging part
of the source code. Without one of these prefixes, the current search
path is used.
</p>
-<p>The distinction between <samp>./</samp> (the <em>build directory</em>) and
-<samp>$(srcdir)/</samp> (the <em>source directory</em>) is important because
-users can build in a separate directory using the
‘<samp>--srcdir</samp>’ option
-to <samp>configure</samp>. A rule of the form:
+<p>The distinction between <samp class="file">./</samp> (the <em
class="dfn">build directory</em>) and
+<samp class="file">$(srcdir)/</samp> (the <em class="dfn">source
directory</em>) is important because
+users can build in a separate directory using the ‘<samp
class="samp">--srcdir</samp>’ option
+to <samp class="file">configure</samp>. A rule of the form:
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.1 : foo.man sedscript
+<div class="example smallexample">
+<pre class="example-preformatted">foo.1 : foo.man sedscript
sed -f sedscript foo.man > foo.1
</pre></div>
<p>will fail when the build directory is not the source directory, because
-<samp>foo.man</samp> and <samp>sedscript</samp> are in the source directory.
+<samp class="file">foo.man</samp> and <samp class="file">sedscript</samp> are
in the source directory.
</p>
-<p>When using GNU <code>make</code>, relying on
‘<samp>VPATH</samp>’ to find the source
+<p>When using GNU <code class="code">make</code>, relying on ‘<samp
class="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>$<</samp>’ will represent the
-source file wherever it is. (Many versions of <code>make</code> set
‘<samp>$<</samp>’
+since the <code class="code">make</code> automatic variable ‘<samp
class="samp">$<</samp>’ will represent the
+source file wherever it is. (Many versions of <code class="code">make</code>
set ‘<samp class="samp">$<</samp>’
only in implicit rules.) A Makefile target like
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.o : bar.c
+<div class="example smallexample">
+<pre class="example-preformatted">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c bar.c -o foo.o
</pre></div>
<p>should instead be written as
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.o : bar.c
+<div class="example smallexample">
+<pre class="example-preformatted">foo.o : bar.c
$(CC) -I. -I$(srcdir) $(CFLAGS) -c $< -o $@
</pre></div>
-<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
+<p>in order to allow ‘<samp class="samp">VPATH</samp>’ to work
correctly. When the target has
+multiple dependencies, using an explicit ‘<samp
class="samp">$(srcdir)</samp>’ is the easiest
way to make the rule work well. For example, the target above for
-<samp>foo.1</samp> is best written as:
+<samp class="file">foo.1</samp> is best written as:
</p>
-<div class="smallexample">
-<pre class="smallexample">foo.1 : foo.man sedscript
+<div class="example smallexample">
+<pre class="example-preformatted">foo.1 : foo.man sedscript
sed -f $(srcdir)/sedscript $(srcdir)/foo.man > $@
</pre></div>
@@ -155,12 +135,13 @@
in any way.
</p>
<p>Try to make the build and installation targets, at least (and all their
-subtargets) work correctly with a parallel <code>make</code>.
+subtargets) work correctly with a parallel <code class="code">make</code>.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="Utilities-in-Makefiles.html">Utilities in Makefiles</a>, Up: <a
href="Makefile-Conventions.html">Makefile Conventions</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Makefile-Conventions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Makefile-Conventions.html,v
retrieving revision 1.89
retrieving revision 1.90
diff -u -b -r1.89 -r1.90
--- html_node/Makefile-Conventions.html 8 Jul 2021 18:18:43 -0000 1.89
+++ html_node/Makefile-Conventions.html 29 May 2024 18:09:31 -0000 1.90
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Makefile Conventions (GNU Coding Standards)</title>
<meta name="description" content="Makefile Conventions (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Configuration">
+<link href="Managing-Releases.html" rel="up" title="Managing Releases">
+<link href="Releases.html" rel="next" title="Releases">
+<link href="Configuration.html" rel="prev" title="Configuration">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,44 +43,36 @@
</head>
<body lang="en">
-<a name="Makefile-Conventions"></a>
-<div class="header">
+<div class="section-level-extent" id="Makefile-Conventions">
+<div class="nav-panel">
<p>
-Next: <a href="Releases.html#Releases" accesskey="n" rel="next">Releases</a>,
Previous: <a href="Configuration.html#Configuration" accesskey="p"
rel="prev">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>
+Next: <a href="Releases.html" accesskey="n" rel="next">Making Releases</a>,
Previous: <a href="Configuration.html" accesskey="p" rel="prev">How
Configuration Should Work</a>, Up: <a href="Managing-Releases.html"
accesskey="u" rel="up">The Release Process</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section chapter-level-set-section"
id="Makefile-Conventions-1"><span>7.2 Makefile Conventions<a
class="copiable-link" href="#Makefile-Conventions-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-makefile_002c-conventions-for"></a>
+<a class="index-entry-id" id="index-conventions-for-makefiles"></a>
+<a class="index-entry-id" id="index-standards-for-makefiles"></a>
<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
-<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>.
+<small class="sc">POSIX</small> and <a data-manual="autoconf"
href="https://www.gnu.org/software/autoconf/manual/html_node/Portable-Make.html#Portable-Make";>Portable
Make Programming</a> in <cite class="cite">Autoconf</cite>.
</p>
-<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
‘<samp>install</samp>’
- rule: normal, pre-install and post-install.
-</td></tr>
-</table>
+<ul class="mini-toc">
+<li><a href="Makefile-Basics.html" accesskey="1">General Conventions for
Makefiles</a></li>
+<li><a href="Utilities-in-Makefiles.html" accesskey="2">Utilities in
Makefiles</a></li>
+<li><a href="Command-Variables.html" accesskey="3">Variables for Specifying
Commands</a></li>
+<li><a href="DESTDIR.html" accesskey="4"><code class="code">DESTDIR</code>:
Support for Staged Installs</a></li>
+<li><a href="Directory-Variables.html" accesskey="5">Variables for
Installation Directories</a></li>
+<li><a href="Standard-Targets.html" accesskey="6">Standard Targets for
Users</a></li>
+<li><a href="Install-Command-Categories.html" accesskey="7">Install Command
Categories</a></li>
+</ul>
+</div>
Index: html_node/Man-Pages.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Man-Pages.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Man-Pages.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Man-Pages.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Man Pages (GNU Coding Standards)</title>
<meta name="description" content="Man Pages (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Indicating the Part Changed">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Reading-other-Manuals.html" rel="next" title="Reading other
Manuals">
+<link href="Change-Logs.html" rel="prev" title="Change Logs">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +43,14 @@
</head>
<body lang="en">
-<a name="Man-Pages"></a>
-<div class="header">
+<div class="section-level-extent" id="Man-Pages">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Reading-other-Manuals.html" accesskey="n" rel="next">Reading
other Manuals</a>, Previous: <a href="Change-Logs.html" accesskey="p"
rel="prev">Change Logs</a>, Up: <a href="Documentation.html" accesskey="u"
rel="up">Documenting Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="Man-Pages-1"><span>6.9 Man Pages<a
class="copiable-link" href="#Man-Pages-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-man-pages"></a>
<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.
@@ -102,21 +82,22 @@
</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="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
+(see <a data-manual="maintain"
href="https://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 class="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>).
+they can be considered true manuals, use the GFDL (see <a class="pxref"
href="License-for-Manuals.html">License for Manuals</a>).
</p>
<p>Finally, the GNU help2man program
-(<a
href="https://www.gnu.org/software/help2man/";>https://www.gnu.org/software/help2man/</a>)
is one way to automate
-generation of a man page, in this case from <samp>--help</samp> output.
+(<a class="uref"
href="https://www.gnu.org/software/help2man/";>https://www.gnu.org/software/help2man/</a>)
is one way to automate
+generation of a man page, in this case from <samp class="option">--help</samp>
output.
This is sufficient in many cases.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Reading-other-Manuals.html">Reading other Manuals</a>,
Previous: <a href="Change-Logs.html">Change Logs</a>, Up: <a
href="Documentation.html">Documenting Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Managing-Releases.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Managing-Releases.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Managing-Releases.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Managing-Releases.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Managing Releases (GNU Coding Standards)</title>
<meta name="description" content="Managing Releases (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Reading other Manuals">
+<link href="index.html" rel="up" title="Top">
+<link href="References.html" rel="next" title="References">
+<link href="Documentation.html" rel="prev" title="Documentation">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +43,14 @@
</head>
<body lang="en">
-<a name="Managing-Releases"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Managing-Releases">
+<div class="nav-panel">
<p>
-Next: <a href="References.html#References" accesskey="n"
rel="next">References</a>, Previous: <a href="Documentation.html#Documentation"
accesskey="p" rel="prev">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>
+Next: <a href="References.html" accesskey="n" rel="next">References to
Non-Free Software and Documentation</a>, Previous: <a href="Documentation.html"
accesskey="p" rel="prev">Documenting Programs</a>, Up: <a href="index.html"
accesskey="u" rel="up">GNU Coding Standards</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter" id="The-Release-Process"><span>7 The Release Process<a
class="copiable-link" href="#The-Release-Process"> ¶</a></span></h2>
+<a class="index-entry-id" id="index-releasing"></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
@@ -80,15 +60,13 @@
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="mini-toc">
+<li><a href="Configuration.html" accesskey="1">How Configuration Should
Work</a></li>
+<li><a href="Makefile-Conventions.html" accesskey="2">Makefile
Conventions</a></li>
+<li><a href="Releases.html" accesskey="3">Making Releases</a></li>
+</ul>
+</div>
Index: html_node/Manual-Credits.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Manual-Credits.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Manual-Credits.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Manual-Credits.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Manual Credits (GNU Coding Standards)</title>
<meta name="description" content="Manual Credits (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="License for Manuals">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Printed-Manuals.html" rel="next" title="Printed Manuals">
+<link href="License-for-Manuals.html" rel="prev" title="License for Manuals">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,21 +43,21 @@
</head>
<body lang="en">
-<a name="Manual-Credits"></a>
-<div class="header">
+<div class="section-level-extent" id="Manual-Credits">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Printed-Manuals.html" accesskey="n" rel="next">Printed
Manuals</a>, Previous: <a href="License-for-Manuals.html" accesskey="p"
rel="prev">License for Manuals</a>, Up: <a href="Documentation.html"
accesskey="u" rel="up">Documenting Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Manual-Credits-1"><span>6.5 Manual Credits<a
class="copiable-link" href="#Manual-Credits-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-credits-for-manuals"></a>
<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>
+</div>
Index: html_node/Manual-Structure-Details.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Manual-Structure-Details.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Manual-Structure-Details.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Manual-Structure-Details.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Manual Structure Details (GNU Coding Standards)</title>
<meta name="description" content="Manual Structure Details (GNU Coding
Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Doc Strings and Manuals">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="License-for-Manuals.html" rel="next" title="License for Manuals">
+<link href="Doc-Strings-and-Manuals.html" rel="prev" title="Doc Strings and
Manuals">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +43,14 @@
</head>
<body lang="en">
-<a name="Manual-Structure-Details"></a>
-<div class="header">
+<div class="section-level-extent" id="Manual-Structure-Details">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="License-for-Manuals.html" accesskey="n" rel="next">License for
Manuals</a>, Previous: <a href="Doc-Strings-and-Manuals.html" accesskey="p"
rel="prev">Doc Strings and Manuals</a>, Up: <a href="Documentation.html"
accesskey="u" rel="up">Documenting Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Manual-Structure-Details-1"><span>6.3 Manual Structure
Details<a class="copiable-link" href="#Manual-Structure-Details-1">
¶</a></span></h3>
+<a class="index-entry-id" id="index-manual-structure"></a>
<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
@@ -79,10 +59,10 @@
number for the manual in both of these places.
</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
+‘<samp class="samp"><var class="var">program</var>
Invocation</samp>’ or ‘<samp class="samp">Invoking <var
class="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>@example</samp>’
+would look for in a man page). Start with an ‘<samp
class="samp">@example</samp>’
containing a template for all the options and arguments that the program
uses.
</p>
@@ -90,13 +70,14 @@
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>
-<p>The ‘<samp>--usage</samp>’ feature of the Info reader looks for
such a node
+<p>The ‘<samp class="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>
<p>If one manual describes several programs, it should have such a node for
each program described in the manual.
</p>
+</div>
Index: html_node/Memory-Usage.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Memory-Usage.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Memory-Usage.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Memory-Usage.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Memory Usage (GNU Coding Standards)</title>
<meta name="description" content="Memory Usage (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="OID
Allocations">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="File-Usage.html" rel="next" title="File Usage">
+<link href="OID-Allocations.html" rel="prev" title="OID Allocations">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,22 +43,21 @@
</head>
<body lang="en">
-<a name="Memory-Usage"></a>
-<div class="header">
+<div class="section-level-extent" id="Memory-Usage">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="File-Usage.html" accesskey="n" rel="next">File Usage</a>,
Previous: <a href="OID-Allocations.html" accesskey="p" rel="prev">OID
Allocations</a>, Up: <a href="Program-Behavior.html" accesskey="u"
rel="up">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Memory-Usage-1"></a>
-<h3 class="section">4.12 Memory Usage</h3>
-<a name="index-memory-usage"></a>
+<h3 class="section" id="Memory-Usage-1"><span>4.12 Memory Usage<a
class="copiable-link" href="#Memory-Usage-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-memory-usage"></a>
<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>
-<p>However, for programs such as <code>cat</code> or <code>tail</code>, that
can
+<p>However, for programs such as <code class="code">cat</code> or <code
class="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
@@ -86,16 +66,17 @@
files that are bigger than will fit in memory all at once.
</p>
<p>If your program creates complicated data structures, just make them in
-memory and give a fatal error if <code>malloc</code> returns <code>NULL</code>.
+memory and give a fatal error if <code class="code">malloc</code> returns
<code class="code">NULL</code>.
</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
+<a class="index-entry-id" id="index-valgrind"></a>
+<a class="index-entry-id" id="index-memory-leak"></a>
+<p>Memory analysis tools such as <code class="command">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>
Index: html_node/Mmap.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Mmap.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Mmap.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Mmap.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Mmap (GNU Coding Standards)</title>
<meta name="description" content="Mmap (GNU Coding Standards)">
@@ -23,37 +23,17 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Quote
Characters">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Quote-Characters.html" rel="prev" title="Quote Characters">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,31 +42,31 @@
</head>
<body lang="en">
-<a name="Mmap"></a>
-<div class="header">
+<div class="section-level-extent" id="Mmap">
+<div class="nav-panel">
<p>
-Previous: <a href="Quote-Characters.html#Quote-Characters" accesskey="p"
rel="prev">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>
+Previous: <a href="Quote-Characters.html" accesskey="p" rel="prev">Quote
Characters</a>, Up: <a href="Writing-C.html" accesskey="u" rel="up">Making The
Best Use of C</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Mmap-1"><span>5.11 Mmap<a class="copiable-link"
href="#Mmap-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-mmap"></a>
-<p>If you use <code>mmap</code> to read or write files, don’t assume it
either
+<p>If you use <code class="code">mmap</code> to read or write files,
don’t assume it either
works on all files or fails for all files. It may work on some files
and fail on others.
</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 proper way to use <code class="code">mmap</code> is to try it on the
specific file for
+which you want to use it—and if <code class="code">mmap</code>
doesn’t work, fall back on
+doing the job in another way using <code class="code">read</code> and <code
class="code">write</code>.
</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
+<code class="code">mmap</code>, but some do not. It is important to make
programs handle
all these kinds of files.
</p>
+</div>
Index: html_node/NEWS-File.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/NEWS-File.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/NEWS-File.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/NEWS-File.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>NEWS File (GNU Coding Standards)</title>
<meta name="description" content="NEWS File (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Printed
Manuals">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Change-Logs.html" rel="next" title="Change Logs">
+<link href="Printed-Manuals.html" rel="prev" title="Printed Manuals">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,27 +43,27 @@
</head>
<body lang="en">
-<a name="NEWS-File"></a>
-<div class="header">
+<div class="section-level-extent" id="NEWS-File">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Change-Logs.html" accesskey="n" rel="next">Change Logs</a>,
Previous: <a href="Printed-Manuals.html" accesskey="p" rel="prev">Printed
Manuals</a>, Up: <a href="Documentation.html" accesskey="u"
rel="up">Documenting Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="The-NEWS-File"><span>6.7 The NEWS File<a
class="copiable-link" href="#The-NEWS-File"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-NEWS-file"></a>
<p>In addition to its manual, the package should have a file named
-<samp>NEWS</samp> which contains a list of user-visible changes worth
+<samp class="file">NEWS</samp> 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.
</p>
-<p>If the <samp>NEWS</samp> file gets very long, move some of the older items
-into a file named <samp>ONEWS</samp> and put a note at the end referring the
+<p>If the <samp class="file">NEWS</samp> file gets very long, move some of the
older items
+into a file named <samp class="file">ONEWS</samp> and put a note at the end
referring the
user to that file.
</p>
+</div>
Index: html_node/Names.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Names.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Names.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Names.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Names (GNU Coding Standards)</title>
<meta name="description" content="Names (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Syntactic Conventions">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="System-Portability.html" rel="next" title="System Portability">
+<link href="Syntactic-Conventions.html" rel="prev" title="Syntactic
Conventions">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,16 +44,15 @@
</head>
<body lang="en">
-<a name="Names"></a>
-<div class="header">
+<div class="section-level-extent" id="Names">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="System-Portability.html" accesskey="n" rel="next">Portability
between System Types</a>, Previous: <a href="Syntactic-Conventions.html"
accesskey="p" rel="prev">Clean Use of C Constructs</a>, Up: <a
href="Writing-C.html" accesskey="u" rel="up">Making The Best Use of C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section"
id="Naming-Variables_002c-Functions_002c-and-Files"><span>5.4 Naming Variables,
Functions, and Files<a class="copiable-link"
href="#Naming-Variables_002c-Functions_002c-and-Files"> ¶</a></span></h3>
-<a name="index-names-of-variables_002c-functions_002c-and-files"></a>
+<a class="index-entry-id"
id="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
@@ -87,11 +68,11 @@
</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
+upper case for macros and <code class="code">enum</code> constants, and for
name-prefixes
that follow a uniform convention.
</p>
-<p>For example, you should use names like
<code>ignore_space_change_flag</code>;
-don’t use names like <code>iCantReadThis</code>.
+<p>For example, you should use names like <code
class="code">ignore_space_change_flag</code>;
+don’t use names like <code class="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
@@ -99,32 +80,33 @@
the option and its letter. For example,
</p>
<div class="example">
-<pre class="example">/* Ignore changes in horizontal whitespace (-b). */
+<div class="group"><pre class="example-preformatted">/* Ignore changes in
horizontal whitespace (-b). */
int ignore_space_change_flag;
-</pre></div>
+</pre></div></div>
<p>When you want to define names with constant integer values, use
-<code>enum</code> rather than ‘<samp>#define</samp>’. GDB knows
about enumeration
+<code class="code">enum</code> rather than ‘<samp
class="samp">#define</samp>’. GDB knows about enumeration
constants.
</p>
-<a name="index-file_002dname-limitations"></a>
-<a name="index-doschk"></a>
+<a class="index-entry-id" id="index-file_002dname-limitations"></a>
+<a class="index-entry-id" id="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.
+names. You can use the program <code class="code">doschk</code> to test for
this.
</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
+programs. <code class="code">doschk</code> also reports file names longer
than 14
characters.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="System-Portability.html">Portability between System Types</a>,
Previous: <a href="Syntactic-Conventions.html">Clean Use of C Constructs</a>,
Up: <a href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Non_002dGNU-Standards.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Non_002dGNU-Standards.html,v
retrieving revision 1.74
retrieving revision 1.75
diff -u -b -r1.74 -r1.75
--- html_node/Non_002dGNU-Standards.html 8 Jul 2021 18:18:43 -0000
1.74
+++ html_node/Non_002dGNU-Standards.html 29 May 2024 18:09:31 -0000
1.75
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Non-GNU Standards (GNU Coding Standards)</title>
<meta name="description" content="Non-GNU Standards (GNU Coding Standards)">
@@ -23,37 +23,17 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Program
Behavior">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Semantics.html" rel="next" title="Semantics">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,14 +42,13 @@
</head>
<body lang="en">
-<a name="Non_002dGNU-Standards"></a>
-<div class="header">
+<div class="section-level-extent" id="Non_002dGNU-Standards">
+<div class="nav-panel">
<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>
+Next: <a href="Semantics.html" accesskey="n" rel="next">Writing Robust
Programs</a>, Up: <a href="Program-Behavior.html" accesskey="u"
rel="up">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Non_002dGNU-Standards-1"><span>4.1 Non-GNU Standards<a
class="copiable-link" href="#Non_002dGNU-Standards-1"> ¶</a></span></h3>
<p>The GNU Project regards standards published by other organizations as
suggestions, not orders. We consider those standards, but we do not
@@ -93,16 +72,16 @@
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>--pedantic</samp>’, which was implemented
only so that
+you must specify ‘<samp class="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>
-<p>POSIX.2 specifies that ‘<samp>df</samp>’ and
‘<samp>du</samp>’ must output sizes by
+<p>POSIX.2 specifies that ‘<samp class="samp">df</samp>’ and
‘<samp class="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>POSIXLY_CORRECT</samp>’ (which was originally going to be
named
-‘<samp>POSIX_ME_HARDER</samp>’).
+‘<samp class="samp">POSIXLY_CORRECT</samp>’ (which was originally
going to be named
+‘<samp class="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
@@ -113,10 +92,11 @@
merely because a standard says it is “forbidden” or
“deprecated”.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="Semantics.html">Writing Robust Programs</a>, Up: <a
href="Program-Behavior.html">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/OID-Allocations.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/OID-Allocations.html,v
retrieving revision 1.59
retrieving revision 1.60
diff -u -b -r1.59 -r1.60
--- html_node/OID-Allocations.html 8 Jul 2021 18:18:43 -0000 1.59
+++ html_node/OID-Allocations.html 29 May 2024 18:09:31 -0000 1.60
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>OID Allocations (GNU Coding Standards)</title>
<meta name="description" content="OID Allocations (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Option Table">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Memory-Usage.html" rel="next" title="Memory Usage">
+<link href="Option-Table.html" rel="prev" title="Option Table">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,31 +44,30 @@
</head>
<body lang="en">
-<a name="OID-Allocations"></a>
-<div class="header">
+<div class="section-level-extent" id="OID-Allocations">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Memory-Usage.html" accesskey="n" rel="next">Memory Usage</a>,
Previous: <a href="Option-Table.html" accesskey="p" rel="prev">Table of Long
Options</a>, Up: <a href="Program-Behavior.html" accesskey="u" rel="up">Program
Behavior for All Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="OID-Allocations-1"></a>
-<h3 class="section">4.11 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>
+<h3 class="section" id="OID-Allocations-1"><span>4.11 OID Allocations<a
class="copiable-link" href="#OID-Allocations-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-OID-allocations-for-GNU"></a>
+<a class="index-entry-id" id="index-SNMP"></a>
+<a class="index-entry-id" id="index-LDAP"></a>
+<a class="index-entry-id" id="index-X_002e509"></a>
<p>The OID (object identifier) 1.3.6.1.4.1.11591 has been assigned to the
GNU Project (thanks to Sergey Poznyakoff). These are used for SNMP,
LDAP, X.509 certificates, and so on. The web site
-<a
href="https://www.alvestrand.no/objectid";>https://www.alvestrand.no/objectid</a>
has a (voluntary) listing of
+<a class="url"
href="https://www.alvestrand.no/objectid";>https://www.alvestrand.no/objectid</a>
has a (voluntary) listing of
many OID assignments.
</p>
<p>If you need a new slot for your GNU package, write
-<a href="mailto:maintainers@gnu.org";>maintainers@gnu.org</a>. Here is a list
of arcs currently
+<a class="email" href="mailto:maintainers@gnu.org";>maintainers@gnu.org</a>.
Here is a list of arcs currently
assigned:
</p>
<div class="example">
-<pre class="example">
+<pre class="example-preformatted">
1.3.6.1.4.1.11591 GNU
@@ -136,6 +117,7 @@
</pre></div>
+</div>
Index: html_node/Option-Table.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Option-Table.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Option-Table.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Option-Table.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Option Table (GNU Coding Standards)</title>
<meta name="description" content="Option Table (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Dynamic Plug-In Interfaces">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="OID-Allocations.html" rel="next" title="OID Allocations">
+<link href="Dynamic-Plug_002dIn-Interfaces.html" rel="prev" title="Dynamic
Plug-In Interfaces">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,1485 +43,1485 @@
</head>
<body lang="en">
-<a name="Option-Table"></a>
-<div class="header">
+<div class="section-level-extent" id="Option-Table">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="OID-Allocations.html" accesskey="n" rel="next">OID
Allocations</a>, Previous: <a href="Dynamic-Plug_002dIn-Interfaces.html"
accesskey="p" rel="prev">Standards for Dynamic Plug-in Interfaces</a>, Up: <a
href="Program-Behavior.html" accesskey="u" rel="up">Program Behavior for All
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Table-of-Long-Options"></a>
-<h3 class="section">4.10 Table of Long Options</h3>
-<a name="index-long-option-names"></a>
-<a name="index-table-of-long-options"></a>
+<h3 class="section" id="Table-of-Long-Options"><span>4.10 Table of Long
Options<a class="copiable-link" href="#Table-of-Long-Options">
¶</a></span></h3>
+<a class="index-entry-id" id="index-long-option-names"></a>
+<a class="index-entry-id" id="index-table-of-long-options"></a>
<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:bug-standards@gnu.org";>bug-standards@gnu.org</a> a
list of them, with their
+please send <a class="email"
href="mailto:bug-standards@gnu.org";>bug-standards@gnu.org</a> a list of them,
with their
meanings, so we can update the table.
</p>
-<dl compact="compact">
-<dt>‘<samp>after-date</samp>’</dt>
-<dd><p>‘<samp>-N</samp>’ in <code>tar</code>.
+<dl class="table">
+<dt>‘<samp class="samp">after-date</samp>’</dt>
+<dd><p>‘<samp class="samp">-N</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">all</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">du</code>, <code class="code">ls</code>, <code
class="code">nm</code>, <code class="code">stty</code>, <code
class="code">uname</code>,
+and <code class="code">unexpand</code>.
</p>
</dd>
-<dt>‘<samp>all-text</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">all-text</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>almost-all</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">almost-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">append</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">etags</code>, <code class="code">tee</code>, <code
class="code">time</code>;
+‘<samp class="samp">-r</samp>’ in <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>archive</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>cp</code>.
+<dt>‘<samp class="samp">archive</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">cp</code>.
</p>
</dd>
-<dt>‘<samp>archive-name</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">archive-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>arglength</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">arglength</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>ascii</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ascii</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>assign</samp>’</dt>
-<dd><p>‘<samp>-v</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">assign</samp>’</dt>
+<dd><p>‘<samp class="samp">-v</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>assume-new</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">assume-new</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>assume-old</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">assume-old</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>auto-check</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">auto-check</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>auto-pager</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">auto-pager</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>auto-reference</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">auto-reference</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>avoid-wraps</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">avoid-wraps</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>background</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">backward-search</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>basename</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">basename</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>batch</samp>’</dt>
+<dt>‘<samp class="samp">batch</samp>’</dt>
<dd><p>Used in GDB.
</p>
</dd>
-<dt>‘<samp>baud</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">before</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">tac</code>.
</p>
</dd>
-<dt>‘<samp>binary</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>cpio</code> and
<code>diff</code>.
+<dt>‘<samp class="samp">binary</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">cpio</code> and <code class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>bits-per-code</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">bits-per-code</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>block-size</samp>’</dt>
-<dd><p>Used in <code>cpio</code> and <code>tar</code>.
+<dt>‘<samp class="samp">block-size</samp>’</dt>
+<dd><p>Used in <code class="code">cpio</code> and <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>blocks</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>head</code> and
<code>tail</code>.
+<dt>‘<samp class="samp">blocks</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">head</code> and <code class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>break-file</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">break-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>brief</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">bytes</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">head</code>, <code class="code">split</code>, and <code
class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>c<tt>++</tt></samp>’</dt>
-<dd><p>‘<samp>-C</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">c<code class="t">++</code></samp>’</dt>
+<dd><p>‘<samp class="samp">-C</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>catenate</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">catenate</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>cd</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">changes</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">chgrp</code> and <code class="code">chown</code>.
</p>
</dd>
-<dt>‘<samp>classify</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">classify</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>colons</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">colons</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>command</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>su</code>;
-‘<samp>-x</samp>’ in GDB.
+<dt>‘<samp class="samp">command</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">su</code>;
+‘<samp class="samp">-x</samp>’ in GDB.
</p>
</dd>
-<dt>‘<samp>compare</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">compare</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>compat</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">compat</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>compress</samp>’</dt>
-<dd><p>‘<samp>-Z</samp>’ in <code>tar</code> and <code>shar</code>.
+<dt>‘<samp class="samp">compress</samp>’</dt>
+<dd><p>‘<samp class="samp">-Z</samp>’ in <code
class="code">tar</code> and <code class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>concatenate</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">concatenate</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>confirmation</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">confirmation</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>context</samp>’</dt>
-<dd><p>Used in <code>diff</code>.
+<dt>‘<samp class="samp">context</samp>’</dt>
+<dd><p>Used in <code class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>copyleft</samp>’</dt>
-<dd><p>‘<samp>-W copyleft</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">copyleft</samp>’</dt>
+<dd><p>‘<samp class="samp">-W copyleft</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">copyright</samp>’</dt>
+<dd><p>‘<samp class="samp">-C</samp>’ in <code
class="code">ptx</code>, <code class="code">recode</code>, and <code
class="code">wdiff</code>;
+‘<samp class="samp">-W copyright</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>core</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">count</samp>’</dt>
+<dd><p>‘<samp class="samp">-q</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>count-links</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">count-links</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>create</samp>’</dt>
-<dd><p>Used in <code>tar</code> and <code>cpio</code>.
+<dt>‘<samp class="samp">create</samp>’</dt>
+<dd><p>Used in <code class="code">tar</code> and <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>cut-mark</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">cut-mark</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>cxref</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>ctags</code>.
+<dt>‘<samp class="samp">cxref</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>date</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>touch</code>.
+<dt>‘<samp class="samp">date</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="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.
+<dt>‘<samp class="samp">debug</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">make</code> and <code class="code">m4</code>;
+‘<samp class="samp">-t</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>define</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">define</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>defines</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in Bison and <code>ctags</code>.
+<dt>‘<samp class="samp">defines</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in Bison and <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>delete</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">delete</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">dereference</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">chgrp</code>, <code class="code">chown</code>, <code
class="code">cpio</code>, <code class="code">du</code>,
+<code class="code">ls</code>, and <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>dereference-args</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">dereference-args</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>device</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">diacritics</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>dictionary-order</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>look</code>.
+<dt>‘<samp class="samp">dictionary-order</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">look</code>.
</p>
</dd>
-<dt>‘<samp>diff</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">diff</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>digits</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">digits</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="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
+<dt>‘<samp class="samp">directory</samp>’</dt>
+<dd><p>Specify the directory to use, in various programs. In <code
class="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
+<code class="code">rm</code> and <code class="code">ln</code>, it means to not
treat links to directories
specially.
</p>
</dd>
-<dt>‘<samp>discard-all</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">discard-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>discard-locals</samp>’</dt>
-<dd><p>‘<samp>-X</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">discard-locals</samp>’</dt>
+<dd><p>‘<samp class="samp">-X</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>dry-run</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">dry-run</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>ed</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ed</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>elide-empty-files</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">elide-empty-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>end-delete</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">end-delete</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>end-insert</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">end-insert</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>entire-new-file</samp>’</dt>
-<dd><p>‘<samp>-N</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">entire-new-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-N</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>environment-overrides</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">environment-overrides</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>eof</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">eof</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>epoch</samp>’</dt>
+<dt>‘<samp class="samp">epoch</samp>’</dt>
<dd><p>Used in GDB.
</p>
</dd>
-<dt>‘<samp>error-limit</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">error-limit</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>error-output</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">error-output</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>escape</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">escape</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>exclude-from</samp>’</dt>
-<dd><p>‘<samp>-X</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">exclude-from</samp>’</dt>
+<dd><p>‘<samp class="samp">-X</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>exec</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">exit</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>exit-0</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>unshar</code>.
+<dt>‘<samp class="samp">exit-0</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">unshar</code>.
</p>
</dd>
-<dt>‘<samp>expand-tabs</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">expand-tabs</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>expression</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>sed</code>.
+<dt>‘<samp class="samp">expression</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">sed</code>.
</p>
</dd>
-<dt>‘<samp>extern-only</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">extern-only</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">extract</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">cpio</code>;
+‘<samp class="samp">-x</samp>’ in <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>faces</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>finger</code>.
+<dt>‘<samp class="samp">faces</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">finger</code>.
</p>
</dd>
-<dt>‘<samp>fast</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>su</code>.
+<dt>‘<samp class="samp">fast</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>fatal-warnings</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">fatal-warnings</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">file</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">gawk</code>, <code class="code">info</code>, <code
class="code">make</code>, <code class="code">mt</code>,
+<code class="code">sed</code>, and <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>field-separator</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">field-separator</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>file-prefix</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in Bison.
+<dt>‘<samp class="samp">file-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>file-type</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">file-type</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>files-from</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">files-from</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>fill-column</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">fill-column</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>flag-truncation</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">flag-truncation</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>fixed-output-files</samp>’</dt>
-<dd><p>‘<samp>-y</samp>’ in Bison.
+<dt>‘<samp class="samp">fixed-output-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-y</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>follow</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>tail</code>.
+<dt>‘<samp class="samp">follow</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>footnote-style</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">footnote-style</samp>’</dt>
+<dd><p>Used in <code class="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>.
+<dt>‘<samp class="samp">force</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>, and <code class="code">rm</code>.
</p>
</dd>
-<dt>‘<samp>force-prefix</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">force-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>foreground</samp>’</dt>
+<dt>‘<samp class="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.
</p>
</dd>
-<dt>‘<samp>format</samp>’</dt>
-<dd><p>Used in <code>ls</code>, <code>time</code>, and <code>ptx</code>.
+<dt>‘<samp class="samp">format</samp>’</dt>
+<dd><p>Used in <code class="code">ls</code>, <code class="code">time</code>,
and <code class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>freeze-state</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">freeze-state</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>fullname</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">gap-size</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>get</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">get</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>graphic</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>ul</code>.
+<dt>‘<samp class="samp">graphic</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">ul</code>.
</p>
</dd>
-<dt>‘<samp>graphics</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">graphics</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>group</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>install</code>.
+<dt>‘<samp class="samp">group</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">install</code>.
</p>
</dd>
-<dt>‘<samp>gzip</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>tar</code> and <code>shar</code>.
+<dt>‘<samp class="samp">gzip</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">tar</code> and <code class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>hashsize</samp>’</dt>
-<dd><p>‘<samp>-H</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">hashsize</samp>’</dt>
+<dd><p>‘<samp class="samp">-H</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>header</samp>’</dt>
-<dd><p>‘<samp>-h</samp>’ in <code>objdump</code> and
<code>recode</code>
+<dt>‘<samp class="samp">header</samp>’</dt>
+<dd><p>‘<samp class="samp">-h</samp>’ in <code
class="code">objdump</code> and <code class="code">recode</code>
</p>
</dd>
-<dt>‘<samp>heading</samp>’</dt>
-<dd><p>‘<samp>-H</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">heading</samp>’</dt>
+<dd><p>‘<samp class="samp">-H</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>help</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">here-delimiter</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>hide-control-chars</samp>’</dt>
-<dd><p>‘<samp>-q</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">hide-control-chars</samp>’</dt>
+<dd><p>‘<samp class="samp">-q</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>html</samp>’</dt>
-<dd><p>In <code>makeinfo</code>, output HTML.
+<dt>‘<samp class="samp">html</samp>’</dt>
+<dd><p>In <code class="code">makeinfo</code>, output HTML.
</p>
</dd>
-<dt>‘<samp>idle</samp>’</dt>
-<dd><p>‘<samp>-u</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">idle</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>ifdef</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ifdef</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">ignore</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">ls</code>;
+‘<samp class="samp">-x</samp>’ in <code class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>ignore-all-space</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-all-space</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-backups</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">ignore-backups</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>ignore-blank-lines</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-blank-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">ignore-case</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">look</code> and <code class="code">ptx</code>;
+‘<samp class="samp">-i</samp>’ in <code class="code">diff</code>
and <code class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-errors</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">ignore-errors</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>ignore-file</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">ignore-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>ignore-indentation</samp>’</dt>
-<dd><p>‘<samp>-I</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">ignore-indentation</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>ignore-init-file</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in Oleo.
+<dt>‘<samp class="samp">ignore-init-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in Oleo.
</p>
</dd>
-<dt>‘<samp>ignore-interrupts</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>tee</code>.
+<dt>‘<samp class="samp">ignore-interrupts</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">tee</code>.
</p>
</dd>
-<dt>‘<samp>ignore-matching-lines</samp>’</dt>
-<dd><p>‘<samp>-I</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-matching-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-space-change</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">ignore-space-change</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>ignore-zeros</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">ignore-zeros</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">include</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">etags</code>;
+‘<samp class="samp">-I</samp>’ in <code class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>include-dir</samp>’</dt>
-<dd><p>‘<samp>-I</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">include-dir</samp>’</dt>
+<dd><p>‘<samp class="samp">-I</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>incremental</samp>’</dt>
-<dd><p>‘<samp>-G</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">incremental</samp>’</dt>
+<dd><p>‘<samp class="samp">-G</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>info</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’, ‘<samp>-l</samp>’, and
‘<samp>-m</samp>’ in Finger.
+<dt>‘<samp class="samp">info</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’, ‘<samp
class="samp">-l</samp>’, and ‘<samp class="samp">-m</samp>’
in Finger.
</p>
</dd>
-<dt>‘<samp>init-file</samp>’</dt>
+<dt>‘<samp class="samp">init-file</samp>’</dt>
<dd><p>In some programs, specify the name of the file to read as the
user’s
init file.
</p>
</dd>
-<dt>‘<samp>initial</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>expand</code>.
+<dt>‘<samp class="samp">initial</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">expand</code>.
</p>
</dd>
-<dt>‘<samp>initial-tab</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">initial-tab</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>inode</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">inode</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">interactive</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>, <code class="code">rm</code>;
+‘<samp class="samp">-e</samp>’ in <code class="code">m4</code>;
+‘<samp class="samp">-p</samp>’ in <code class="code">xargs</code>;
+‘<samp class="samp">-w</samp>’ in <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>intermix-type</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">intermix-type</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>iso-8601</samp>’</dt>
-<dd><p>Used in <code>date</code>
+<dt>‘<samp class="samp">iso-8601</samp>’</dt>
+<dd><p>Used in <code class="code">date</code>
</p>
</dd>
-<dt>‘<samp>jobs</samp>’</dt>
-<dd><p>‘<samp>-j</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">jobs</samp>’</dt>
+<dd><p>‘<samp class="samp">-j</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>just-print</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">just-print</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>keep-going</samp>’</dt>
-<dd><p>‘<samp>-k</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">keep-going</samp>’</dt>
+<dd><p>‘<samp class="samp">-k</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>keep-files</samp>’</dt>
-<dd><p>‘<samp>-k</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">keep-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-k</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>kilobytes</samp>’</dt>
-<dd><p>‘<samp>-k</samp>’ in <code>du</code> and <code>ls</code>.
+<dt>‘<samp class="samp">kilobytes</samp>’</dt>
+<dd><p>‘<samp class="samp">-k</samp>’ in <code
class="code">du</code> and <code class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>language</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">language</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>less-mode</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">less-mode</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>level-for-gzip</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">level-for-gzip</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>line-bytes</samp>’</dt>
-<dd><p>‘<samp>-C</samp>’ in <code>split</code>.
+<dt>‘<samp class="samp">line-bytes</samp>’</dt>
+<dd><p>‘<samp class="samp">-C</samp>’ in <code
class="code">split</code>.
</p>
</dd>
-<dt>‘<samp>lines</samp>’</dt>
-<dd><p>Used in <code>split</code>, <code>head</code>, and <code>tail</code>.
+<dt>‘<samp class="samp">lines</samp>’</dt>
+<dd><p>Used in <code class="code">split</code>, <code
class="code">head</code>, and <code class="code">tail</code>.
</p>
</dd>
-<dt>‘<samp>link</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">link</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>lint</samp>’</dt>
-<dt>‘<samp>lint-old</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">lint</samp>’</dt>
+<dt>‘<samp class="samp">lint-old</samp>’</dt>
+<dd><p>Used in <code class="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>.
+<dt>‘<samp class="samp">list</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">cpio</code>;
+‘<samp class="samp">-l</samp>’ in <code class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>list</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">list</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>literal</samp>’</dt>
-<dd><p>‘<samp>-N</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">literal</samp>’</dt>
+<dd><p>‘<samp class="samp">-N</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>load-average</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">load-average</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>login</samp>’</dt>
-<dd><p>Used in <code>su</code>.
+<dt>‘<samp class="samp">login</samp>’</dt>
+<dd><p>Used in <code class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>machine</samp>’</dt>
-<dd><p>Used in <code>uname</code>.
+<dt>‘<samp class="samp">machine</samp>’</dt>
+<dd><p>Used in <code class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>macro-name</samp>’</dt>
-<dd><p>‘<samp>-M</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">macro-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-M</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>mail</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>hello</code> and
<code>uname</code>.
+<dt>‘<samp class="samp">mail</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">hello</code> and <code class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>make-directories</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">make-directories</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>makefile</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">makefile</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>mapped</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">max-args</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>max-chars</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">max-chars</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>max-lines</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">max-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>max-load</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">max-load</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>max-procs</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">max-procs</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>mesg</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">mesg</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>message</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">message</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>minimal</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">minimal</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>mixed-uuencode</samp>’</dt>
-<dd><p>‘<samp>-M</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">mixed-uuencode</samp>’</dt>
+<dd><p>‘<samp class="samp">-M</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">mode</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">install</code>, <code class="code">mkdir</code>, and <code
class="code">mkfifo</code>.
</p>
</dd>
-<dt>‘<samp>modification-time</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">modification-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>multi-volume</samp>’</dt>
-<dd><p>‘<samp>-M</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">multi-volume</samp>’</dt>
+<dd><p>‘<samp class="samp">-M</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>name-prefix</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in Bison.
+<dt>‘<samp class="samp">name-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>nesting-limit</samp>’</dt>
-<dd><p>‘<samp>-L</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">nesting-limit</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>net-headers</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">net-headers</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>new-file</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">new-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>no-builtin-rules</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">no-builtin-rules</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>no-character-count</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-character-count</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-check-existing</samp>’</dt>
-<dd><p>‘<samp>-x</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-check-existing</samp>’</dt>
+<dd><p>‘<samp class="samp">-x</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-common</samp>’</dt>
-<dd><p>‘<samp>-3</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">no-common</samp>’</dt>
+<dd><p>‘<samp class="samp">-3</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>no-create</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>touch</code>.
+<dt>‘<samp class="samp">no-create</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">touch</code>.
</p>
</dd>
-<dt>‘<samp>no-defines</samp>’</dt>
-<dd><p>‘<samp>-D</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">no-defines</samp>’</dt>
+<dd><p>‘<samp class="samp">-D</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>no-deleted</samp>’</dt>
-<dd><p>‘<samp>-1</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">no-deleted</samp>’</dt>
+<dd><p>‘<samp class="samp">-1</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>no-dereference</samp>’</dt>
-<dd><p>‘<samp>-d</samp>’ in <code>cp</code>.
+<dt>‘<samp class="samp">no-dereference</samp>’</dt>
+<dd><p>‘<samp class="samp">-d</samp>’ in <code
class="code">cp</code>.
</p>
</dd>
-<dt>‘<samp>no-inserted</samp>’</dt>
-<dd><p>‘<samp>-2</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">no-inserted</samp>’</dt>
+<dd><p>‘<samp class="samp">-2</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>no-keep-going</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">no-keep-going</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>no-lines</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in Bison.
+<dt>‘<samp class="samp">no-lines</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in Bison.
</p>
</dd>
-<dt>‘<samp>no-piping</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-piping</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-prof</samp>’</dt>
-<dd><p>‘<samp>-e</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">no-prof</samp>’</dt>
+<dd><p>‘<samp class="samp">-e</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>no-regex</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>etags</code>.
+<dt>‘<samp class="samp">no-regex</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>no-sort</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">no-sort</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>no-splash</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">no-split</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>no-static</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">no-static</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>no-time</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">no-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>no-timestamp</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">no-timestamp</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>no-validate</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">no-validate</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>no-wait</samp>’</dt>
-<dd><p>Used in <code>emacsclient</code>.
+<dt>‘<samp class="samp">no-wait</samp>’</dt>
+<dd><p>Used in <code class="code">emacsclient</code>.
</p>
</dd>
-<dt>‘<samp>no-warn</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">node</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">info</code>.
</p>
</dd>
-<dt>‘<samp>nodename</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>uname</code>.
+<dt>‘<samp class="samp">nodename</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>nonmatching</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">nonmatching</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>nstuff</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>objdump</code>.
+<dt>‘<samp class="samp">nstuff</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">objdump</code>.
</p>
</dd>
-<dt>‘<samp>null</samp>’</dt>
-<dd><p>‘<samp>-0</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">null</samp>’</dt>
+<dd><p>‘<samp class="samp">-0</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>number</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">number</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>number-nonblank</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">number-nonblank</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>numeric-sort</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">numeric-sort</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">numeric-uid-gid</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">cpio</code> and <code class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>nx</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">old-archive</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>old-file</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">old-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">one-file-system</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">tar</code>, <code class="code">cp</code>, and <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>only-file</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">only-file</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>only-prof</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">only-prof</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>only-time</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">only-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">options</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">getopt</code>, <code class="code">fdlist</code>, <code
class="code">fdmount</code>,
+<code class="code">fdmountd</code>, and <code class="code">fdumount</code>.
</p>
</dd>
-<dt>‘<samp>output</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">output-prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>override</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>rm</code>.
+<dt>‘<samp class="samp">override</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">rm</code>.
</p>
</dd>
-<dt>‘<samp>overwrite</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>unshar</code>.
+<dt>‘<samp class="samp">overwrite</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">unshar</code>.
</p>
</dd>
-<dt>‘<samp>owner</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>install</code>.
+<dt>‘<samp class="samp">owner</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">install</code>.
</p>
</dd>
-<dt>‘<samp>paginate</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">paginate</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>paragraph-indent</samp>’</dt>
-<dd><p>Used in <code>makeinfo</code>.
+<dt>‘<samp class="samp">paragraph-indent</samp>’</dt>
+<dd><p>Used in <code class="code">makeinfo</code>.
</p>
</dd>
-<dt>‘<samp>parents</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>mkdir</code> and
<code>rmdir</code>.
+<dt>‘<samp class="samp">parents</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">mkdir</code> and <code class="code">rmdir</code>.
</p>
</dd>
-<dt>‘<samp>pass-all</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>ul</code>.
+<dt>‘<samp class="samp">pass-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">ul</code>.
</p>
</dd>
-<dt>‘<samp>pass-through</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">pass-through</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>port</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>finger</code>.
+<dt>‘<samp class="samp">port</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">finger</code>.
</p>
</dd>
-<dt>‘<samp>portability</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>cpio</code> and <code>tar</code>.
+<dt>‘<samp class="samp">portability</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="code">cpio</code> and <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>posix</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">posix</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>prefix-builtins</samp>’</dt>
-<dd><p>‘<samp>-P</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">prefix-builtins</samp>’</dt>
+<dd><p>‘<samp class="samp">-P</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>prefix</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">prefix</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>preserve</samp>’</dt>
-<dd><p>Used in <code>tar</code> and <code>cp</code>.
+<dt>‘<samp class="samp">preserve</samp>’</dt>
+<dd><p>Used in <code class="code">tar</code> and <code class="code">cp</code>.
</p>
</dd>
-<dt>‘<samp>preserve-environment</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>su</code>.
+<dt>‘<samp class="samp">preserve-environment</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>preserve-modification-time</samp>’</dt>
-<dd><p>‘<samp>-m</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">preserve-modification-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-m</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>preserve-order</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">preserve-order</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>preserve-permissions</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">preserve-permissions</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>print</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">print</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>print-chars</samp>’</dt>
-<dd><p>‘<samp>-L</samp>’ in <code>cmp</code>.
+<dt>‘<samp class="samp">print-chars</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">cmp</code>.
</p>
</dd>
-<dt>‘<samp>print-data-base</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">print-data-base</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>print-directory</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">print-directory</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>print-file-name</samp>’</dt>
-<dd><p>‘<samp>-o</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">print-file-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-o</samp>’ in <code
class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>print-symdefs</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">print-symdefs</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>printer</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">printer</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>prompt</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>ed</code>.
+<dt>‘<samp class="samp">prompt</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">ed</code>.
</p>
</dd>
-<dt>‘<samp>proxy</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">query-user</samp>’</dt>
+<dd><p>‘<samp class="samp">-X</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>question</samp>’</dt>
-<dd><p>‘<samp>-q</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">question</samp>’</dt>
+<dd><p>‘<samp class="samp">-q</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>quiet</samp>’</dt>
+<dt>‘<samp class="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
+program accepting ‘<samp class="samp">--quiet</samp>’ should
accept ‘<samp class="samp">--silent</samp>’ as a
synonym.
</p>
</dd>
-<dt>‘<samp>quiet-unshar</samp>’</dt>
-<dd><p>‘<samp>-Q</samp>’ in <code>shar</code>
+<dt>‘<samp class="samp">quiet-unshar</samp>’</dt>
+<dd><p>‘<samp class="samp">-Q</samp>’ in <code
class="code">shar</code>
</p>
</dd>
-<dt>‘<samp>quote-name</samp>’</dt>
-<dd><p>‘<samp>-Q</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">quote-name</samp>’</dt>
+<dd><p>‘<samp class="samp">-Q</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>rcs</samp>’</dt>
-<dd><p>‘<samp>-n</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">rcs</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>re-interval</samp>’</dt>
-<dd><p>Used in <code>gawk</code>.
+<dt>‘<samp class="samp">re-interval</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>read-full-blocks</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">read-full-blocks</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>readnow</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">recon</samp>’</dt>
+<dd><p>‘<samp class="samp">-n</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>record-number</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">record-number</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">recursive</samp>’</dt>
+<dd><p>Used in <code class="code">chgrp</code>, <code
class="code">chown</code>, <code class="code">cp</code>, <code
class="code">ls</code>, <code class="code">diff</code>,
+and <code class="code">rm</code>.
</p>
</dd>
-<dt>‘<samp>reference</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>touch</code>.
+<dt>‘<samp class="samp">reference</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">touch</code>.
</p>
</dd>
-<dt>‘<samp>references</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">references</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>regex</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>tac</code> and
<code>etags</code>.
+<dt>‘<samp class="samp">regex</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">tac</code> and <code class="code">etags</code>.
</p>
</dd>
-<dt>‘<samp>release</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>uname</code>.
+<dt>‘<samp class="samp">release</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>reload-state</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">reload-state</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>relocation</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>objdump</code>.
+<dt>‘<samp class="samp">relocation</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">objdump</code>.
</p>
</dd>
-<dt>‘<samp>rename</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">rename</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>replace</samp>’</dt>
-<dd><p>‘<samp>-i</samp>’ in <code>xargs</code>.
+<dt>‘<samp class="samp">replace</samp>’</dt>
+<dd><p>‘<samp class="samp">-i</samp>’ in <code
class="code">xargs</code>.
</p>
</dd>
-<dt>‘<samp>report-identical-files</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">report-identical-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>reset-access-time</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">reset-access-time</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>reverse</samp>’</dt>
-<dd><p>‘<samp>-r</samp>’ in <code>ls</code> and <code>nm</code>.
+<dt>‘<samp class="samp">reverse</samp>’</dt>
+<dd><p>‘<samp class="samp">-r</samp>’ in <code
class="code">ls</code> and <code class="code">nm</code>.
</p>
</dd>
-<dt>‘<samp>reversed-ed</samp>’</dt>
-<dd><p>‘<samp>-f</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">reversed-ed</samp>’</dt>
+<dd><p>‘<samp class="samp">-f</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>right-side-defs</samp>’</dt>
-<dd><p>‘<samp>-R</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">right-side-defs</samp>’</dt>
+<dd><p>‘<samp class="samp">-R</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>same-order</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">same-order</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>same-permissions</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">same-permissions</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>save</samp>’</dt>
-<dd><p>‘<samp>-g</samp>’ in <code>stty</code>.
+<dt>‘<samp class="samp">save</samp>’</dt>
+<dd><p>‘<samp class="samp">-g</samp>’ in <code
class="code">stty</code>.
</p>
</dd>
-<dt>‘<samp>se</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">sentence-regexp</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>separate-dirs</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">separate-dirs</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>separator</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>tac</code>.
+<dt>‘<samp class="samp">separator</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="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.
+<dt>‘<samp class="samp">sequence</samp>’</dt>
+<dd><p>Used by <code class="code">recode</code> to choose files or pipes for
sequencing passes.
</p>
</dd>
-<dt>‘<samp>shell</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>su</code>.
+<dt>‘<samp class="samp">shell</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">su</code>.
</p>
</dd>
-<dt>‘<samp>show-all</samp>’</dt>
-<dd><p>‘<samp>-A</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">show-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-A</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>show-c-function</samp>’</dt>
-<dd><p>‘<samp>-p</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">show-c-function</samp>’</dt>
+<dd><p>‘<samp class="samp">-p</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>show-ends</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">show-ends</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>show-function-line</samp>’</dt>
-<dd><p>‘<samp>-F</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">show-function-line</samp>’</dt>
+<dd><p>‘<samp class="samp">-F</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>show-tabs</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">show-tabs</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>silent</samp>’</dt>
+<dt>‘<samp class="samp">silent</samp>’</dt>
<dd><p>Used in many programs to inhibit the usual output.
Every program accepting
-‘<samp>--silent</samp>’ should accept
‘<samp>--quiet</samp>’ as a synonym.
+‘<samp class="samp">--silent</samp>’ should accept ‘<samp
class="samp">--quiet</samp>’ as a synonym.
</p>
</dd>
-<dt>‘<samp>size</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">size</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>socket</samp>’</dt>
+<dt>‘<samp class="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.
</p>
</dd>
-<dt>‘<samp>sort</samp>’</dt>
-<dd><p>Used in <code>ls</code>.
+<dt>‘<samp class="samp">sort</samp>’</dt>
+<dd><p>Used in <code class="code">ls</code>.
</p>
</dd>
-<dt>‘<samp>source</samp>’</dt>
-<dd><p>‘<samp>-W source</samp>’ in <code>gawk</code>.
+<dt>‘<samp class="samp">source</samp>’</dt>
+<dd><p>‘<samp class="samp">-W source</samp>’ in <code
class="code">gawk</code>.
</p>
</dd>
-<dt>‘<samp>sparse</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">sparse</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>speed-large-files</samp>’</dt>
-<dd><p>‘<samp>-H</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">speed-large-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-H</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>split-at</samp>’</dt>
-<dd><p>‘<samp>-E</samp>’ in <code>unshar</code>.
+<dt>‘<samp class="samp">split-at</samp>’</dt>
+<dd><p>‘<samp class="samp">-E</samp>’ in <code
class="code">unshar</code>.
</p>
</dd>
-<dt>‘<samp>split-size-limit</samp>’</dt>
-<dd><p>‘<samp>-L</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">split-size-limit</samp>’</dt>
+<dd><p>‘<samp class="samp">-L</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>squeeze-blank</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>cat</code>.
+<dt>‘<samp class="samp">squeeze-blank</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">cat</code>.
</p>
</dd>
-<dt>‘<samp>start-delete</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">start-delete</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>start-insert</samp>’</dt>
-<dd><p>‘<samp>-y</samp>’ in <code>wdiff</code>.
+<dt>‘<samp class="samp">start-insert</samp>’</dt>
+<dd><p>‘<samp class="samp">-y</samp>’ in <code
class="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
+<dt>‘<samp class="samp">starting-file</samp>’</dt>
+<dd><p>Used in <code class="code">tar</code> and <code
class="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>.
+<dt>‘<samp class="samp">statistics</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>stdin-file-list</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">stdin-file-list</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>stop</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">stop</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>strict</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>recode</code>.
+<dt>‘<samp class="samp">strict</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>strip</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>install</code>.
+<dt>‘<samp class="samp">strip</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">install</code>.
</p>
</dd>
-<dt>‘<samp>strip-all</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">strip-all</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>strip-debug</samp>’</dt>
-<dd><p>‘<samp>-S</samp>’ in <code>strip</code>.
+<dt>‘<samp class="samp">strip-debug</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">strip</code>.
</p>
</dd>
-<dt>‘<samp>submitter</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">submitter</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">suffix</samp>’</dt>
+<dd><p>‘<samp class="samp">-S</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>.
</p>
</dd>
-<dt>‘<samp>suffix-format</samp>’</dt>
-<dd><p>‘<samp>-b</samp>’ in <code>csplit</code>.
+<dt>‘<samp class="samp">suffix-format</samp>’</dt>
+<dd><p>‘<samp class="samp">-b</samp>’ in <code
class="code">csplit</code>.
</p>
</dd>
-<dt>‘<samp>sum</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">sum</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">gprof</code>.
</p>
</dd>
-<dt>‘<samp>summarize</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">summarize</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">du</code>.
</p>
</dd>
-<dt>‘<samp>symbolic</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>ln</code>.
+<dt>‘<samp class="samp">symbolic</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">ln</code>.
</p>
</dd>
-<dt>‘<samp>symbols</samp>’</dt>
-<dd><p>Used in GDB and <code>objdump</code>.
+<dt>‘<samp class="samp">symbols</samp>’</dt>
+<dd><p>Used in GDB and <code class="code">objdump</code>.
</p>
</dd>
-<dt>‘<samp>synclines</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">synclines</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>sysname</samp>’</dt>
-<dd><p>‘<samp>-s</samp>’ in <code>uname</code>.
+<dt>‘<samp class="samp">sysname</samp>’</dt>
+<dd><p>‘<samp class="samp">-s</samp>’ in <code
class="code">uname</code>.
</p>
</dd>
-<dt>‘<samp>tabs</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>expand</code> and
<code>unexpand</code>.
+<dt>‘<samp class="samp">tabs</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">expand</code> and <code class="code">unexpand</code>.
</p>
</dd>
-<dt>‘<samp>tabsize</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>ls</code>.
+<dt>‘<samp class="samp">tabsize</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">terminal</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">tput</code> and <code class="code">ul</code>.
+‘<samp class="samp">-t</samp>’ in <code class="code">wdiff</code>.
</p>
</dd>
-<dt>‘<samp>text</samp>’</dt>
-<dd><p>‘<samp>-a</samp>’ in <code>diff</code>.
+<dt>‘<samp class="samp">text</samp>’</dt>
+<dd><p>‘<samp class="samp">-a</samp>’ in <code
class="code">diff</code>.
</p>
</dd>
-<dt>‘<samp>text-files</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">text-files</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>time</samp>’</dt>
-<dd><p>Used in <code>ls</code> and <code>touch</code>.
+<dt>‘<samp class="samp">time</samp>’</dt>
+<dd><p>Used in <code class="code">ls</code> and <code
class="code">touch</code>.
</p>
</dd>
-<dt>‘<samp>timeout</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">to-stdout</samp>’</dt>
+<dd><p>‘<samp class="samp">-O</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>total</samp>’</dt>
-<dd><p>‘<samp>-c</samp>’ in <code>du</code>.
+<dt>‘<samp class="samp">total</samp>’</dt>
+<dd><p>‘<samp class="samp">-c</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">touch</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">make</code>, <code class="code">ranlib</code>, and <code
class="code">recode</code>.
</p>
</dd>
-<dt>‘<samp>trace</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">trace</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">traditional</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">hello</code>;
+‘<samp class="samp">-W traditional</samp>’ in <code
class="code">gawk</code>;
+‘<samp class="samp">-G</samp>’ in <code class="code">ed</code>,
<code class="code">m4</code>, and <code class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>tty</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">typedefs</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>typedefs-and-c++</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>ctags</code>.
+<dt>‘<samp class="samp">typedefs-and-c++</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>typeset-mode</samp>’</dt>
-<dd><p>‘<samp>-t</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">typeset-mode</samp>’</dt>
+<dd><p>‘<samp class="samp">-t</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>uncompress</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">uncompress</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>unconditional</samp>’</dt>
-<dd><p>‘<samp>-u</samp>’ in <code>cpio</code>.
+<dt>‘<samp class="samp">unconditional</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="code">cpio</code>.
</p>
</dd>
-<dt>‘<samp>undefine</samp>’</dt>
-<dd><p>‘<samp>-U</samp>’ in <code>m4</code>.
+<dt>‘<samp class="samp">undefine</samp>’</dt>
+<dd><p>‘<samp class="samp">-U</samp>’ in <code
class="code">m4</code>.
</p>
</dd>
-<dt>‘<samp>undefined-only</samp>’</dt>
-<dd><p>‘<samp>-u</samp>’ in <code>nm</code>.
+<dt>‘<samp class="samp">undefined-only</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="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>.
+<dt>‘<samp class="samp">update</samp>’</dt>
+<dd><p>‘<samp class="samp">-u</samp>’ in <code
class="code">cp</code>, <code class="code">ctags</code>, <code
class="code">mv</code>, <code class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>usage</samp>’</dt>
-<dd><p>Used in <code>gawk</code>; same as ‘<samp>--help</samp>’.
+<dt>‘<samp class="samp">usage</samp>’</dt>
+<dd><p>Used in <code class="code">gawk</code>; same as ‘<samp
class="samp">--help</samp>’.
</p>
</dd>
-<dt>‘<samp>uuencode</samp>’</dt>
-<dd><p>‘<samp>-B</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">uuencode</samp>’</dt>
+<dd><p>‘<samp class="samp">-B</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>vanilla-operation</samp>’</dt>
-<dd><p>‘<samp>-V</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">vanilla-operation</samp>’</dt>
+<dd><p>‘<samp class="samp">-V</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>verbose</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">verify</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>version</samp>’</dt>
+<dt>‘<samp class="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>.
+<dt>‘<samp class="samp">version-control</samp>’</dt>
+<dd><p>‘<samp class="samp">-V</samp>’ in <code
class="code">cp</code>, <code class="code">ln</code>, <code
class="code">mv</code>.
</p>
</dd>
-<dt>‘<samp>vgrind</samp>’</dt>
-<dd><p>‘<samp>-v</samp>’ in <code>ctags</code>.
+<dt>‘<samp class="samp">vgrind</samp>’</dt>
+<dd><p>‘<samp class="samp">-v</samp>’ in <code
class="code">ctags</code>.
</p>
</dd>
-<dt>‘<samp>volume</samp>’</dt>
-<dd><p>‘<samp>-V</samp>’ in <code>tar</code>.
+<dt>‘<samp class="samp">volume</samp>’</dt>
+<dd><p>‘<samp class="samp">-V</samp>’ in <code
class="code">tar</code>.
</p>
</dd>
-<dt>‘<samp>what-if</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>make</code>.
+<dt>‘<samp class="samp">what-if</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">make</code>.
</p>
</dd>
-<dt>‘<samp>whole-size-limit</samp>’</dt>
-<dd><p>‘<samp>-l</samp>’ in <code>shar</code>.
+<dt>‘<samp class="samp">whole-size-limit</samp>’</dt>
+<dd><p>‘<samp class="samp">-l</samp>’ in <code
class="code">shar</code>.
</p>
</dd>
-<dt>‘<samp>width</samp>’</dt>
-<dd><p>‘<samp>-w</samp>’ in <code>ls</code> and <code>ptx</code>.
+<dt>‘<samp class="samp">width</samp>’</dt>
+<dd><p>‘<samp class="samp">-w</samp>’ in <code
class="code">ls</code> and <code class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>word-regexp</samp>’</dt>
-<dd><p>‘<samp>-W</samp>’ in <code>ptx</code>.
+<dt>‘<samp class="samp">word-regexp</samp>’</dt>
+<dd><p>‘<samp class="samp">-W</samp>’ in <code
class="code">ptx</code>.
</p>
</dd>
-<dt>‘<samp>writable</samp>’</dt>
-<dd><p>‘<samp>-T</samp>’ in <code>who</code>.
+<dt>‘<samp class="samp">writable</samp>’</dt>
+<dd><p>‘<samp class="samp">-T</samp>’ in <code
class="code">who</code>.
</p>
</dd>
-<dt>‘<samp>zeros</samp>’</dt>
-<dd><p>‘<samp>-z</samp>’ in <code>gprof</code>.
+<dt>‘<samp class="samp">zeros</samp>’</dt>
+<dd><p>‘<samp class="samp">-z</samp>’ in <code
class="code">gprof</code>.
</p></dd>
</dl>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="OID-Allocations.html">OID Allocations</a>, Previous: <a
href="Dynamic-Plug_002dIn-Interfaces.html">Standards for Dynamic Plug-in
Interfaces</a>, Up: <a href="Program-Behavior.html">Program Behavior for All
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Preface.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Preface.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Preface.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Preface.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Preface (GNU Coding Standards)</title>
<meta name="description" content="Preface (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Top">
+<link href="index.html" rel="up" title="Top">
+<link href="Legal-Issues.html" rel="next" title="Legal Issues">
+<link href="index.html" rel="prev" title="Top">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,14 +43,13 @@
</head>
<body lang="en">
-<a name="Preface"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Preface">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Legal-Issues.html" accesskey="n" rel="next">Keeping Free
Software Free</a>, Previous: <a href="index.html" accesskey="p" rel="prev">GNU
Coding Standards</a>, Up: <a href="index.html" accesskey="u" rel="up">GNU
Coding Standards</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter" id="About-the-GNU-Coding-Standards"><span>1 About the GNU
Coding Standards<a class="copiable-link"
href="#About-the-GNU-Coding-Standards"> ¶</a></span></h2>
<p>The GNU Coding Standards were written by Richard Stallman and other GNU
Project volunteers. Their purpose is to make the GNU system clean,
@@ -79,37 +59,37 @@
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-standards_002etexi"></a>
-<a name="index-downloading-this-manual"></a>
+<a class="index-entry-id" id="index-where-to-obtain-standards_002etexi"></a>
+<a class="index-entry-id" id="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="https://www.gnu.org/prep/standards/";>https://www.gnu.org/prep/standards/</a>.
+text, and more, at: <a class="uref"
href="https://www.gnu.org/prep/standards/";>https://www.gnu.org/prep/standards/</a>.
</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="http://www.gnu.org/prep/maintain/html_node/index.html#Top";>Contents</a>
in <cite>Information for Maintainers of GNU
+(see <a data-manual="maintain"
href="https://www.gnu.org/prep/maintain/html_node/index.html#Top";>Contents</a>
in <cite class="cite">Information for Maintainers of GNU
Software</cite>).
</p>
-<a name="index-gnustandards_002dcommit_0040gnu_002eorg-mailing-list"></a>
+<a class="index-entry-id"
id="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>gnustandards-commit@gnu.org</code>, via the web
+join the mailing list <code class="code">gnustandards-commit@gnu.org</code>,
via the web
interface at
-<a
href="https://lists.gnu.org/mailman/listinfo/gnustandards-commit";>https://lists.gnu.org/mailman/listinfo/gnustandards-commit</a>.
+<a class="url"
href="https://lists.gnu.org/mailman/listinfo/gnustandards-commit";>https://lists.gnu.org/mailman/listinfo/gnustandards-commit</a>.
Archives are also available there.
</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>
+<a class="index-entry-id"
id="index-bug_002dstandards_0040gnu_002eorg-email-address"></a>
+<a class="index-entry-id" id="index-Savannah-repository-for-gnustandards"></a>
+<a class="index-entry-id" id="index-gnustandards-project-repository"></a>
<p>Please send corrections or suggestions for this document to
-<a href="mailto:bug-standards@gnu.org";>bug-standards@gnu.org</a>. If you make
a suggestion, please
+<a class="email"
href="mailto:bug-standards@gnu.org";>bug-standards@gnu.org</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
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="https://savannah.gnu.org/projects/gnustandards";>https://savannah.gnu.org/projects/gnustandards</a>.
+at <a class="url"
href="https://savannah.gnu.org/projects/gnustandards";>https://savannah.gnu.org/projects/gnustandards</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.
@@ -125,16 +105,17 @@
</p>
<p>The GNU Hello program serves as an example of how to follow the GNU
coding standards for a trivial program.
-<a
href="https://www.gnu.org/software/hello/hello.html";>https://www.gnu.org/software/hello/hello.html</a>.
+<a class="uref"
href="https://www.gnu.org/software/hello/hello.html";>https://www.gnu.org/software/hello/hello.html</a>.
</p>
<p>This release of the GNU Coding Standards was last updated
-July 1, 2021.
+May 26, 2024.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Legal-Issues.html">Keeping Free Software Free</a>, Previous: <a
href="index.html">GNU Coding Standards</a>, Up: <a href="index.html">GNU Coding
Standards</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Printed-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Printed-Manuals.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Printed-Manuals.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Printed-Manuals.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Printed Manuals (GNU Coding Standards)</title>
<meta name="description" content="Printed Manuals (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Manual
Credits">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="NEWS-File.html" rel="next" title="NEWS File">
+<link href="Manual-Credits.html" rel="prev" title="Manual Credits">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,25 +43,25 @@
</head>
<body lang="en">
-<a name="Printed-Manuals"></a>
-<div class="header">
+<div class="section-level-extent" id="Printed-Manuals">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="NEWS-File.html" accesskey="n" rel="next">The NEWS File</a>,
Previous: <a href="Manual-Credits.html" accesskey="p" rel="prev">Manual
Credits</a>, Up: <a href="Documentation.html" accesskey="u"
rel="up">Documenting Programs</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Printed-Manuals-1"></a>
-<h3 class="section">6.6 Printed Manuals</h3>
+<h3 class="section" id="Printed-Manuals-1"><span>6.6 Printed Manuals<a
class="copiable-link" href="#Printed-Manuals-1"> ¶</a></span></h3>
<p>The FSF publishes some GNU manuals in printed form. To encourage sales
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
-<a
href="https://www.gnu.org/order/order.html";>https://www.gnu.org/order/order.html</a>.
This should not be included
+<a class="url"
href="https://www.gnu.org/order/order.html";>https://www.gnu.org/order/order.html</a>.
This should not be included
in the printed manual, though, because there it is redundant.
</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>
+</div>
Index: html_node/Program-Behavior.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Program-Behavior.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Program-Behavior.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Program-Behavior.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Program Behavior (GNU Coding Standards)</title>
<meta name="description" content="Program Behavior (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Conditional Compilation">
+<link href="index.html" rel="up" title="Top">
+<link href="Writing-C.html" rel="next" title="Writing C">
+<link href="Design-Advice.html" rel="prev" title="Design Advice">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,50 +43,35 @@
</head>
<body lang="en">
-<a name="Program-Behavior"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Program-Behavior">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Writing-C.html" accesskey="n" rel="next">Making The Best Use of
C</a>, Previous: <a href="Design-Advice.html" accesskey="p" rel="prev">General
Program Design</a>, Up: <a href="index.html" accesskey="u" rel="up">GNU Coding
Standards</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter" id="Program-Behavior-for-All-Programs"><span>4 Program
Behavior for All Programs<a class="copiable-link"
href="#Program-Behavior-for-All-Programs"> ¶</a></span></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="Finding-Program-Files.html#Finding-Program-Files" accesskey="6">Finding
Program Files</a>:</td><td> </td><td align="left" valign="top">How
to find the program’s executable
- and other files that go with it.
-</td></tr>
-<tr><td align="left" valign="top">• <a
href="Graphical-Interfaces.html#Graphical-Interfaces" accesskey="7">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="8">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="9">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">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="mini-toc">
+<li><a href="Non_002dGNU-Standards.html" accesskey="1">Non-GNU
Standards</a></li>
+<li><a href="Semantics.html" accesskey="2">Writing Robust Programs</a></li>
+<li><a href="Libraries.html" accesskey="3">Library Behavior</a></li>
+<li><a href="Errors.html" accesskey="4">Formatting Error Messages</a></li>
+<li><a href="User-Interfaces.html" accesskey="5">Standards for Interfaces
Generally</a></li>
+<li><a href="Finding-Program-Files.html" accesskey="6">Finding the
Program’s Executable and Associated Files</a></li>
+<li><a href="Graphical-Interfaces.html" accesskey="7">Standards for Graphical
Interfaces</a></li>
+<li><a href="Command_002dLine-Interfaces.html" accesskey="8">Standards for
Command Line Interfaces</a></li>
+<li><a href="Dynamic-Plug_002dIn-Interfaces.html" accesskey="9">Standards for
Dynamic Plug-in Interfaces</a></li>
+<li><a href="Option-Table.html">Table of Long Options</a></li>
+<li><a href="OID-Allocations.html">OID Allocations</a></li>
+<li><a href="Memory-Usage.html">Memory Usage</a></li>
+<li><a href="File-Usage.html">File Usage</a></li>
+</ul>
+</div>
Index: html_node/Quote-Characters.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Quote-Characters.html,v
retrieving revision 1.76
retrieving revision 1.77
diff -u -b -r1.76 -r1.77
--- html_node/Quote-Characters.html 8 Jul 2021 18:18:43 -0000 1.76
+++ html_node/Quote-Characters.html 29 May 2024 18:09:31 -0000 1.77
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Quote Characters (GNU Coding Standards)</title>
<meta name="description" content="Quote Characters (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Character Set">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Mmap.html" rel="next" title="Mmap">
+<link href="Character-Set.html" rel="prev" title="Character Set">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,46 +44,45 @@
</head>
<body lang="en">
-<a name="Quote-Characters"></a>
-<div class="header">
+<div class="section-level-extent" id="Quote-Characters">
+<div class="nav-panel">
<p>
-Next: <a href="Mmap.html#Mmap" accesskey="n" rel="next">Mmap</a>, Previous: <a
href="Character-Set.html#Character-Set" accesskey="p" rel="prev">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>
+Next: <a href="Mmap.html" accesskey="n" rel="next">Mmap</a>, Previous: <a
href="Character-Set.html" accesskey="p" rel="prev">Character Set</a>, Up: <a
href="Writing-C.html" accesskey="u" rel="up">Making The Best Use of C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Quote-Characters-1"><span>5.10 Quote Characters<a
class="copiable-link" href="#Quote-Characters-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-quote-characters"></a>
+<a class="index-entry-id" id="index-locale_002dspecific-quote-characters"></a>
+<a class="index-entry-id" id="index-left-quote"></a>
+<a class="index-entry-id" id="index-right-quote"></a>
+<a class="index-entry-id" id="index-opening-quote"></a>
+<a class="index-entry-id" id="index-single-quote"></a>
+<a class="index-entry-id" id="index-double-quote"></a>
+<a class="index-entry-id" id="index-grave-accent"></a>
<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>"</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.
+(‘<samp class="samp">"</samp>’) or 0x27 (‘<samp
class="samp">'</samp>’) for both opening and closing quotes.
+Although GNU programs traditionally used 0x60 (‘<samp
class="samp">`</samp>’) for opening
+and 0x27 (‘<samp class="samp">'</samp>’) for closing quotes,
nowadays quotes ‘<samp class="samp">`like
+this'</samp>’ are typically rendered asymmetrically, so quoting
‘<samp class="samp">"like
+this"</samp>’ or ‘<samp class="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:
</p>
<div class="example">
-<pre class="example">printf (gettext ("Processing file '%s'..."),
file);
+<pre class="example-preformatted">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
+<p>Here, a French translation might cause <code class="code">gettext</code> to
return the
+string <code class="code">"Traitement de fichier
‹ %s ›..."</code>, yielding quotes
more appropriate for a French locale.
</p>
<p>Sometimes a program may need to use opening and closing quotes
-directly. By convention, <code>gettext</code> translates the string
-‘<samp>"`"</samp>’ to the opening quote and the string
‘<samp>"'"</samp>’ to the
+directly. By convention, <code class="code">gettext</code> translates the
string
+‘<samp class="samp">"`"</samp>’ to the opening quote and
the string ‘<samp class="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.
@@ -110,10 +91,16 @@
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>--quoting-style</samp> of GNU <code>ls</code>.
+the option <samp class="option">--quoting-style</samp> of GNU <code
class="code">ls</code>.
</p>
+</div>
+<hr>
+<div class="nav-panel">
+<p>
+Next: <a href="Mmap.html">Mmap</a>, Previous: <a
href="Character-Set.html">Character Set</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
+</div>
Index: 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.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Reading-Non_002dFree-Code.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Reading-Non_002dFree-Code.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Reading Non-Free Code (GNU Coding Standards)</title>
<meta name="description" content="Reading Non-Free Code (GNU Coding
Standards)">
@@ -23,37 +23,17 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Legal Issues">
+<link href="Legal-Issues.html" rel="up" title="Legal Issues">
+<link href="Contributions.html" rel="next" title="Contributions">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,16 +42,15 @@
</head>
<body lang="en">
-<a name="Reading-Non_002dFree-Code"></a>
-<div class="header">
+<div class="section-level-extent" id="Reading-Non_002dFree-Code">
+<div class="nav-panel">
<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>
+Next: <a href="Contributions.html" accesskey="n" rel="next">Accepting
Contributions</a>, Up: <a href="Legal-Issues.html" accesskey="u"
rel="up">Keeping Free Software Free</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Referring-to-Proprietary-Programs"><span>2.1 Referring
to Proprietary Programs<a class="copiable-link"
href="#Referring-to-Proprietary-Programs"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-proprietary-programs"></a>
+<a class="index-entry-id" id="index-avoiding-proprietary-code"></a>
<p>Don’t in any circumstances refer to Unix source code for or during
your work on GNU! (Or to any other proprietary programs.)
@@ -104,10 +83,11 @@
to free memory, or use a new GNU facility such as obstacks.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="Contributions.html">Accepting Contributions</a>, Up: <a
href="Legal-Issues.html">Keeping Free Software Free</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Reading-other-Manuals.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Reading-other-Manuals.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Reading-other-Manuals.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Reading-other-Manuals.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Reading other Manuals (GNU Coding Standards)</title>
<meta name="description" content="Reading other Manuals (GNU Coding
Standards)">
@@ -23,37 +23,17 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Man Pages">
+<link href="Documentation.html" rel="up" title="Documentation">
+<link href="Man-Pages.html" rel="prev" title="Man Pages">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,14 +42,13 @@
</head>
<body lang="en">
-<a name="Reading-other-Manuals"></a>
-<div class="header">
+<div class="section-level-extent" id="Reading-other-Manuals">
+<div class="nav-panel">
<p>
-Previous: <a href="Man-Pages.html#Man-Pages" accesskey="p" rel="prev">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>
+Previous: <a href="Man-Pages.html" accesskey="p" rel="prev">Man Pages</a>, Up:
<a href="Documentation.html" accesskey="u" rel="up">Documenting Programs</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Reading-other-Manuals-1"><span>6.10 Reading other
Manuals<a class="copiable-link" href="#Reading-other-Manuals-1">
¶</a></span></h3>
<p>There may be non-free books or documentation files that describe the
program you are documenting.
@@ -83,6 +62,7 @@
documentation. Copying from free documentation may be ok; please check
with the FSF about the individual case.
</p>
+</div>
Index: html_node/References.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/References.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/References.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/References.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>References (GNU Coding Standards)</title>
<meta name="description" content="References (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Releases">
+<link href="index.html" rel="up" title="Top">
+<link href="GNU-Free-Documentation-License.html" rel="next" title="GNU Free
Documentation License">
+<link href="Managing-Releases.html" rel="prev" title="Managing Releases">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +43,14 @@
</head>
<body lang="en">
-<a name="References"></a>
-<div class="header">
+<div class="chapter-level-extent" id="References">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="GNU-Free-Documentation-License.html" accesskey="n"
rel="next">GNU Free Documentation License</a>, Previous: <a
href="Managing-Releases.html" accesskey="p" rel="prev">The Release Process</a>,
Up: <a href="index.html" accesskey="u" rel="up">GNU Coding Standards</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter"
id="References-to-Non_002dFree-Software-and-Documentation"><span>8 References
to Non-Free Software and Documentation<a class="copiable-link"
href="#References-to-Non_002dFree-Software-and-Documentation">
¶</a></span></h2>
+<a class="index-entry-id" id="index-references-to-non_002dfree-material"></a>
<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
@@ -81,15 +61,15 @@
impression that their existence is legitimate.
</p>
<p>The GNU definition of free software is found on the GNU web site at
-<a
href="https://www.gnu.org/philosophy/free-sw.html";>https://www.gnu.org/philosophy/free-sw.html</a>,
and the definition
+<a class="url"
href="https://www.gnu.org/philosophy/free-sw.html";>https://www.gnu.org/philosophy/free-sw.html</a>,
and the definition
of free documentation is found at
-<a
href="https://www.gnu.org/philosophy/free-doc.html";>https://www.gnu.org/philosophy/free-doc.html</a>.
The terms “free”
+<a class="url"
href="https://www.gnu.org/philosophy/free-doc.html";>https://www.gnu.org/philosophy/free-doc.html</a>.
The terms “free”
and “non-free”, used in this document, refer to those definitions.
</p>
<p>A list of important licenses and whether they qualify as free is in
-<a
href="https://www.gnu.org/licenses/license-list.html";>https://www.gnu.org/licenses/license-list.html</a>.
If it is not
+<a class="url"
href="https://www.gnu.org/licenses/license-list.html";>https://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:licensing@gnu.org";>licensing@gnu.org</a>. We
will answer, and if the
+by writing to <a class="email"
href="mailto:licensing@gnu.org";>licensing@gnu.org</a>. We will answer, and if
the
license is an important one, we will add it to the list.
</p>
<p>When a non-free program or system is well known, you can mention it in
@@ -126,7 +106,7 @@
<p>Sometimes a program is free software in itself but depends on a
non-free platform in order to run. For instance, it used to be the
case that many Java programs depended on some non-free Java libraries.
-(See <a
href="https://www.gnu.org/philosophy/java-trap.html";>https://www.gnu.org/philosophy/java-trap.html</a>.)
+(See <a class="uref"
href="https://www.gnu.org/philosophy/java-trap.html";>https://www.gnu.org/philosophy/java-trap.html</a>.)
To recommend or promote such a program is to promote the other
programs it needs; therefore, judge mentions of the former as if they
were mentions of the latter. For this reason, we were careful about
@@ -138,16 +118,16 @@
on non-free software to run.
</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,
+typical example is <code class="command">mplayer</code>. It is free software
in itself,
and the free code can handle some kinds of files. However,
-<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>
+<code class="command">mplayer</code> recommends use of non-free codecs for
other kinds of
+files, and users that install <code class="command">mplayer</code> are very
likely to
+install those codecs along with it. To recommend <code
class="command">mplayer</code>
is, in effect, to promote use of the non-free codecs.
</p>
<p>Thus, you should not recommend programs that strongly encourage the
use of non-free software. This is why we do not list
-<code>mplayer</code> in the Free Software Directory.
+<code class="command">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
@@ -174,43 +154,44 @@
inherent in the nature of the web. Here’s how we treat that.
</p>
<p>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 page <var>p</var>
+non-free software packages; you should not refer to a page <var
class="var">p</var>
that links to AT&T’s site presenting it as a place to get some
-non-free program, because that part of the page <var>p</var> itself
+non-free program, because that part of the page <var class="var">p</var> itself
recommends and legitimizes the non-free program.
</p>
-<p>However, if <var>p</var> contains a link to AT&T’s web site for
some other
+<p>However, if <var class="var">p</var> contains a link to AT&T’s
web site for some other
purpose (such as long-distance telephone service), that is no reason
-you should not link to <var>p</var>.
+you should not link to <var class="var">p</var>.
</p>
<p>A web page recommends a program in an implicit but particularly strong
way if it requires users to run that program in order to use the page.
-Many pages contain Javascript code which they recommend in this way.
-This Javascript code may be free or nonfree, but nonfree is the usual
+Many pages contain JavaScript code which they recommend in this way.
+This JavaScript code may be free or non-free, but non-free is the usual
case.
</p>
<p>If the purpose for which you would refer to the page cannot be carried
-out without running nonfree Javascript code, then you should not refer
+out without running non-free JavaScript code, then you should not refer
to it. Thus, if the purpose of referring to the page is for people to
view a video, or subscribing to a mailing list, and the viewing or
-subscribing fail to work if the user’s browser blocks the nonfree
-Javascript code, then don’t refer to that page.
+subscribing fail to work if the user’s browser blocks the non-free
+JavaScript code, then don’t refer to that page.
</p>
-<p>The extreme case is that of web sites which depend on nonfree
-Javascript code even to <em>see</em> the contents of the pages. Any
-site hosted on ‘<code>wix.com</code>’ has this problem, and so do
some
+<p>The extreme case is that of web sites which depend on non-free
+JavaScript code even to <em class="emph">see</em> the contents of the pages.
Any
+site hosted on ‘<code class="indicateurl">wix.com</code>’ has this
problem, and so do some
other sites. Referring people to such pages to read their contents
-is, in effect, urging them to run those nonfree programs—so please
+is, in effect, urging them to run those non-free programs—so please
don’t refer to those pages. (Such pages also break the Web, so they
deserve condemnation for two reasons.)
</p>
<p>Instead, please quote excerpts from the page to make your point,
or find another place to refer to that information.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="GNU-Free-Documentation-License.html">GNU Free Documentation
License</a>, Previous: <a href="Managing-Releases.html">The Release
Process</a>, Up: <a href="index.html">GNU Coding Standards</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Releases.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Releases.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Releases.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Releases.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Releases (GNU Coding Standards)</title>
<meta name="description" content="Releases (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Install Command Categories">
+<link href="Managing-Releases.html" rel="up" title="Managing Releases">
+<link href="Makefile-Conventions.html" rel="prev" title="Makefile Conventions">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
+ul.mark-bullet {list-style-type: disc}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,54 +43,53 @@
</head>
<body lang="en">
-<a name="Releases"></a>
-<div class="header">
+<div class="section-level-extent" id="Releases">
+<div class="nav-panel">
<p>
-Previous: <a href="Makefile-Conventions.html#Makefile-Conventions"
accesskey="p" rel="prev">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>
+Previous: <a href="Makefile-Conventions.html" accesskey="p"
rel="prev">Makefile Conventions</a>, Up: <a href="Managing-Releases.html"
accesskey="u" rel="up">The Release Process</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Making-Releases"><span>7.3 Making Releases<a
class="copiable-link" href="#Making-Releases"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-packaging"></a>
-<a name="index-version-numbers_002c-for-releases"></a>
+<a class="index-entry-id" id="index-version-numbers_002c-for-releases"></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>
-<p>Package the distribution of <code>Foo version 69.96</code> up in a gzipped
tar
-file with the name <samp>foo-69.96.tar.gz</samp>. It should unpack into a
-subdirectory named <samp>foo-69.96</samp>.
+<p>Package the distribution of <code class="code">Foo version 69.96</code> up
in a gzipped tar
+file with the name <samp class="file">foo-69.96.tar.gz</samp>. It should
unpack into a
+subdirectory named <samp class="file">foo-69.96</samp>.
</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 <em>source
-files</em> and <em>non-source files</em>. Source files are written by humans
+part of the program in any way must be classified into <em class="dfn">source
+files</em> and <em class="dfn">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-README-file"></a>
-<p>The distribution should contain a file named <samp>README</samp> with a
+<a class="index-entry-id" id="index-README-file"></a>
+<p>The distribution should contain a file named <samp
class="file">README</samp> with a
general overview of the package:
</p>
-<ul>
-<li> the name of the package;
+<ul class="itemize mark-bullet">
+<li>the name of the package;
-</li><li> the version number of the package, or refer to where in the
+</li><li>the version number of the package, or refer to where in the
package the version can be found;
-</li><li> a general description of what the package does;
+</li><li>a general description of what the package does;
-</li><li> a reference to the file <samp>INSTALL</samp>, which
+</li><li>a reference to the file <samp class="file">INSTALL</samp>, which
should in turn contain an explanation of the installation procedure;
-</li><li> a brief explanation of any unusual top-level directories or
+</li><li>a brief explanation of any unusual top-level directories or
files, or other hints for readers to find their way around the source;
-</li><li> a reference to the file which contains the copying conditions.
-The GNU GPL, if used, should be in a file called <samp>COPYING</samp>. If
+</li><li>a reference to the file which contains the copying conditions.
+The GNU GPL, if used, should be in a file called <samp
class="file">COPYING</samp>. If
the GNU LGPL is used, it should be in a file called
-<samp>COPYING.LESSER</samp>.
+<samp class="file">COPYING.LESSER</samp>.
</li></ul>
<p>Naturally, all the source files must be in the distribution. It is
@@ -118,20 +98,20 @@
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, <code>flex</code>, TeX, and <code>makeinfo</code>; this helps avoid
+Bison, <code class="code">flex</code>, TeX, and <code
class="code">makeinfo</code>; this helps avoid
unnecessary dependencies between our distributions, so that users can
install whichever versions of whichever packages they like. Do not
induce new dependencies on other software lightly.
</p>
<p>Non-source files that might actually be modified by building and
-installing the program should <strong>never</strong> be included in the
+installing the program should <strong class="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>
<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>
+world-writable (octal mode 777), because ancient versions of <code
class="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.
@@ -147,13 +127,13 @@
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>foobarhacker.c</samp> and <samp>foobarhacker.o</samp> are not ambiguous;
they
-are truncated to <samp>foobarha.c</samp> and <samp>foobarha.o</samp>, which are
+<samp class="file">foobarhacker.c</samp> and <samp
class="file">foobarhacker.o</samp> are not ambiguous; they
+are truncated to <samp class="file">foobarha.c</samp> and <samp
class="file">foobarha.o</samp>, which are
distinct.
</p>
-<a name="index-texinfo_002etex_002c-in-a-distribution"></a>
-<p>Include in your distribution a copy of the <samp>texinfo.tex</samp> you used
-to test print any <samp>*.texinfo</samp> or <samp>*.texi</samp> files.
+<a class="index-entry-id"
id="index-texinfo_002etex_002c-in-a-distribution"></a>
+<p>Include in your distribution a copy of the <samp
class="file">texinfo.tex</samp> you used
+to test print any <samp class="file">*.texinfo</samp> or <samp
class="file">*.texi</samp> files.
</p>
<p>Likewise, if your program uses small GNU software packages like regex,
getopt, obstack, or termcap, include them in the distribution file.
@@ -161,10 +141,11 @@
the expense of possible inconvenience to a user who doesn’t know what
other files to get.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Previous: <a href="Makefile-Conventions.html#Makefile-Conventions"
accesskey="p" rel="prev">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>
+Previous: <a href="Makefile-Conventions.html">Makefile Conventions</a>, Up: <a
href="Managing-Releases.html">The Release Process</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Semantics.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Semantics.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Semantics.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Semantics.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Semantics (GNU Coding Standards)</title>
<meta name="description" content="Semantics (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Non-GNU Standards">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Libraries.html" rel="next" title="Libraries">
+<link href="Non_002dGNU-Standards.html" rel="prev" title="Non-GNU Standards">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,55 +44,54 @@
</head>
<body lang="en">
-<a name="Semantics"></a>
-<div class="header">
+<div class="section-level-extent" id="Semantics">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Libraries.html" accesskey="n" rel="next">Library Behavior</a>,
Previous: <a href="Non_002dGNU-Standards.html" accesskey="p" rel="prev">Non-GNU
Standards</a>, Up: <a href="Program-Behavior.html" accesskey="u"
rel="up">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Writing-Robust-Programs"></a>
-<h3 class="section">4.2 Writing Robust Programs</h3>
+<h3 class="section" id="Writing-Robust-Programs"><span>4.2 Writing Robust
Programs<a class="copiable-link" href="#Writing-Robust-Programs">
¶</a></span></h3>
-<a name="index-arbitrary-limits-on-data"></a>
-<p>Avoid arbitrary limits on the length or number of <em>any</em> data
+<a class="index-entry-id" id="index-arbitrary-limits-on-data"></a>
+<p>Avoid arbitrary limits on the length or number of <em class="emph">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-NUL-characters"></a>
-<a name="index-libiconv"></a>
+<a class="index-entry-id" id="index-NUL-characters"></a>
+<a class="index-entry-id" id="index-libiconv"></a>
<p>Utilities reading files should not drop NUL characters, or any other
nonprinting characters. Programs should work properly with multibyte
character encodings, such as UTF-8. You can use libiconv to deal with
a range of encodings.
</p>
-<a name="index-error-messages"></a>
+<a class="index-entry-id" id="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>strerror</code>, or equivalent) in <em>every</em> error message
+<code class="code">strerror</code>, or equivalent) in <em
class="emph">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-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 <code>NULL</code>. Check <code>realloc</code> even if you are making
the
+<a class="index-entry-id" id="index-malloc-return-value"></a>
+<a class="index-entry-id" id="index-memory-allocation-failure"></a>
+<p>Check every call to <code class="code">malloc</code> or <code
class="code">realloc</code> to see if it
+returned <code class="code">NULL</code>. Check <code
class="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.
+<code class="code">realloc</code> may get a different block if you ask for
less space.
</p>
-<p>You must expect <code>free</code> to alter the contents of the block that
was
+<p>You must expect <code class="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>.
+calling <code class="code">free</code>.
</p>
-<p>If <code>malloc</code> fails in a noninteractive program, make that a fatal
+<p>If <code class="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"></a>
-<p>Use <code>getopt_long</code> to decode arguments, unless the argument syntax
+<a class="index-entry-id"
id="index-command_002dline-arguments_002c-decoding"></a>
+<p>Use <code class="code">getopt_long</code> to decode arguments, unless the
argument syntax
makes this unreasonable.
</p>
<p>When static storage is to be written in during program execution, use
@@ -122,22 +103,22 @@
<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.
+in a directory, use <code class="code">readdir</code> or some other high-level
interface.
These are supported compatibly by GNU.
</p>
-<a name="index-signal-handling"></a>
+<a class="index-entry-id" id="index-signal-handling"></a>
<p>The preferred signal handling facilities are the BSD variant of
-<code>signal</code>, and the POSIX <code>sigaction</code> function; the
-alternative USG <code>signal</code> interface is an inferior design.
+<code class="code">signal</code>, and the POSIX <code
class="code">sigaction</code> function; the
+alternative USG <code class="code">signal</code> interface is an inferior
design.
</p>
<p>Nowadays, using the POSIX signal functions may be the easiest way
-to make a program portable. If you use <code>signal</code>, then on GNU/Linux
+to make a program portable. If you use <code class="code">signal</code>, then
on GNU/Linux
systems running GNU libc version 1, you should include
-<samp>bsd/signal.h</samp> instead of <samp>signal.h</samp>, so as to get BSD
+<samp class="file">bsd/signal.h</samp> instead of <samp
class="file">signal.h</samp>, 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.
+<code class="code">signal</code> has only the USG behavior, or give up on them.
</p>
-<a name="index-impossible-conditions"></a>
+<a class="index-entry-id" id="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
@@ -147,38 +128,39 @@
elsewhere.
</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
+<em class="emph">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"></a>
-<a name="index-TMPDIR-environment-variable"></a>
-<p>If you make temporary files, check the <code>TMPDIR</code> environment
+<a class="index-entry-id" id="index-temporary-files"></a>
+<a class="index-entry-id" id="index-TMPDIR-environment-variable"></a>
+<p>If you make temporary files, check the <code class="code">TMPDIR</code>
environment
variable; if that variable is defined, use the specified directory
-instead of <samp>/tmp</samp>.
+instead of <samp class="file">/tmp</samp>.
</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:
</p>
<div class="example">
-<pre class="example">fd = open (filename, O_WRONLY | O_CREAT | O_EXCL, 0600);
+<pre class="example-preformatted">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>or by using the <code class="code">mkstemps</code> function from Gnulib
+(see <a data-manual="gnulib"
href="https://www.gnu.org/software/gnulib/manual/html_node/mkstemps.html#mkstemps";>mkstemps</a>
in <cite class="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
+<p>In bash, use <code class="code">set -C</code> (long name <code
class="code">noclobber</code>) to avoid this
+problem. In addition, the <code class="code">mktemp</code> utility is a more
general
solution for creating temporary files from shell scripts
-(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>).
+(see <a data-manual="coreutils"
href="https://www.gnu.org/software/coreutils/manual/html_node/mktemp-invocation.html#mktemp-invocation";>mktemp
invocation</a> in <cite class="cite">GNU Coreutils</cite>).
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Libraries.html">Library Behavior</a>, Previous: <a
href="Non_002dGNU-Standards.html">Non-GNU Standards</a>, Up: <a
href="Program-Behavior.html">Program Behavior for All Programs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Simple-Changes.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Simple-Changes.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Simple-Changes.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Simple-Changes.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Simple Changes (GNU Coding Standards)</title>
<meta name="description" content="Simple Changes (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Style of Change Logs">
+<link href="Change-Logs.html" rel="up" title="Change Logs">
+<link href="Conditional-Changes.html" rel="next" title="Conditional Changes">
+<link href="Style-of-Change-Logs.html" rel="prev" title="Style of Change Logs">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,14 +44,13 @@
</head>
<body lang="en">
-<a name="Simple-Changes"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Simple-Changes">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Conditional-Changes.html" accesskey="n" rel="next">Conditional
Changes</a>, Previous: <a href="Style-of-Change-Logs.html" accesskey="p"
rel="prev">Style of Change Logs</a>, Up: <a href="Change-Logs.html"
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" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Simple-Changes-1"></a>
-<h4 class="subsection">6.8.3 Simple Changes</h4>
+<h4 class="subsection" id="Simple-Changes-1"><span>6.8.3 Simple Changes<a
class="copiable-link" href="#Simple-Changes-1"> ¶</a></span></h4>
<p>Certain simple kinds of changes don’t need much detail in the change
log.
@@ -78,7 +59,7 @@
own header line:
</p>
<div class="example">
-<pre class="example">2019-08-29 Eli Zaretskii <eliz@gnu.org>
+<pre class="example-preformatted">2019-08-29 Eli Zaretskii
<eliz@gnu.org>
* lisp/simple.el (kill-do-not-save-duplicates): Doc fix. (Bug#36827)
</pre></div>
@@ -90,7 +71,7 @@
being called, “All callers changed”—like this:
</p>
<div class="example">
-<pre class="example">* keyboard.c (Fcommand_execute): New arg SPECIAL.
+<pre class="example-preformatted">* keyboard.c (Fcommand_execute): New arg
SPECIAL.
All callers changed.
</pre></div>
@@ -104,7 +85,7 @@
repository:
</p>
<div class="example">
-<pre class="example">2019-01-07 Paul Eggert <eggert@cs.ucla.edu>
+<pre class="example-preformatted">2019-01-07 Paul Eggert
<eggert@cs.ucla.edu>
Update copyright year to 2019
@@ -126,10 +107,11 @@
recommend to keep change logs for Texinfo sources of your project’s
manuals.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-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="prev">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>
+Next: <a href="Conditional-Changes.html">Conditional Changes</a>, Previous: <a
href="Style-of-Change-Logs.html">Style of Change Logs</a>, Up: <a
href="Change-Logs.html">Change Logs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Source-Language.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Source-Language.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Source-Language.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Source-Language.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Source Language (GNU Coding Standards)</title>
<meta name="description" content="Source Language (GNU Coding Standards)">
@@ -23,37 +23,17 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Design Advice">
+<link href="Design-Advice.html" rel="up" title="Design Advice">
+<link href="Compatibility.html" rel="next" title="Compatibility">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +42,14 @@
</head>
<body lang="en">
-<a name="Source-Language"></a>
-<div class="header">
+<div class="section-level-extent" id="Source-Language">
+<div class="nav-panel">
<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>
+Next: <a href="Compatibility.html" accesskey="n" rel="next">Compatibility with
Other Implementations</a>, Up: <a href="Design-Advice.html" accesskey="u"
rel="up">General Program Design</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="Which-Languages-to-Use"><span>3.1 Which Languages to
Use<a class="copiable-link" href="#Which-Languages-to-Use">
¶</a></span></h3>
+<a class="index-entry-id" id="index-programming-languages"></a>
<p>When you want to use a language that gets compiled and runs at high
speed, the best language to use is C. C++ is ok too, but please don’t
@@ -82,18 +61,18 @@
particular role in the GNU System: it is the preferred language to
extend programs written in C/C++, and also a fine language for a wide
range of applications. The more GNU components use Guile and Scheme,
-the more users are able to extend and combine them (see <a
href="http://www.gnu.org/software/guile/manual/html_node/The-Emacs-Thesis.html#The-Emacs-Thesis";>The
Emacs
-Thesis</a> in <cite>GNU Guile Reference Manual</cite>).
+the more users are able to extend and combine them (see <a data-manual="guile"
href="https://www.gnu.org/software/guile/manual/html_node/The-Emacs-Thesis.html#The-Emacs-Thesis";>The
Emacs
+Thesis</a> in <cite class="cite">GNU Guile Reference Manual</cite>).
</p>
<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"></a>
-<a name="index-GNOME-and-Guile"></a>
+<a class="index-entry-id" id="index-Guile"></a>
+<a class="index-entry-id" id="index-GNOME-and-Guile"></a>
<p>The standard extensibility interpreter for GNU software is Guile
-(<a
href="https://www.gnu.org/software/guile/";>https://www.gnu.org/software/guile/</a>),
which implements the
+(<a class="uref"
href="https://www.gnu.org/software/guile/";>https://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
@@ -102,6 +81,7 @@
GNU system.
</p>
+</div>
Index: html_node/Standard-C.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Standard-C.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Standard-C.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Standard-C.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Standard C (GNU Coding Standards)</title>
<meta name="description" content="Standard C (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Using
Extensions">
+<link href="Design-Advice.html" rel="up" title="Design Advice">
+<link href="Conditional-Compilation.html" rel="next" title="Conditional
Compilation">
+<link href="Using-Extensions.html" rel="prev" title="Using Extensions">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +44,14 @@
</head>
<body lang="en">
-<a name="Standard-C"></a>
-<div class="header">
+<div class="section-level-extent" id="Standard-C">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Conditional-Compilation.html" accesskey="n"
rel="next">Conditional Compilation</a>, Previous: <a
href="Using-Extensions.html" accesskey="p" rel="prev">Using Non-standard
Features</a>, Up: <a href="Design-Advice.html" accesskey="u" rel="up">General
Program Design</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Standard-C-and-Pre_002dStandard-C"><span>3.4 Standard
C and Pre-Standard C<a class="copiable-link"
href="#Standard-C-and-Pre_002dStandard-C"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-ANSI-C-standard"></a>
<p>1989 Standard C is widespread enough now that it is ok to use its
features in programs. There is one exception: do not ever use the
@@ -89,29 +70,29 @@
<p>However, it is easy to support pre-standard compilers in most programs,
so if you know how to do that, feel free.
</p>
-<a name="index-function-prototypes"></a>
+<a class="index-entry-id" id="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
+<pre class="example-preformatted">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
+<pre class="example-preformatted">int
foo (x, y)
int x, y;
-…
+...
</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 class="example-preformatted">int foo (int, int);
</pre></div>
<p>You need such a declaration anyway, in a header file, to get the benefit
@@ -119,25 +100,25 @@
you have the declaration, you normally lose nothing by writing the
function definition in the pre-standard style.
</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>This technique does not work for integer types narrower than <code
class="code">int</code>.
+If you think of an argument as being of a type narrower than <code
class="code">int</code>,
+declare it as <code class="code">int</code> instead.
</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,
-because <code>dev_t</code> is wider than <code>int</code> on some machines.
There
+<code class="code">dev_t</code>, you run into trouble, because <code
class="code">dev_t</code> is shorter than
+<code class="code">int</code> on some machines; but you cannot use <code
class="code">int</code> instead,
+because <code class="code">dev_t</code> is wider than <code
class="code">int</code> 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 <code>dev_t</code> using Autoconf and choose
+argument is to check the width of <code class="code">dev_t</code> using
Autoconf and choose
the argument type accordingly. This may not be worth the trouble.
</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.
*/
+<pre class="example-preformatted">/* Declare the prototype for a general
external function. */
#if defined (__STDC__) || defined (WINDOWSNT)
#define P_(proto) proto
#else
@@ -145,10 +126,11 @@
#endif
</pre></div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Conditional-Compilation.html">Conditional Compilation</a>,
Previous: <a href="Using-Extensions.html">Using Non-standard Features</a>, Up:
<a href="Design-Advice.html">General Program Design</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Standard-Targets.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Standard-Targets.html,v
retrieving revision 1.87
retrieving revision 1.88
diff -u -b -r1.87 -r1.88
--- html_node/Standard-Targets.html 8 Jul 2021 18:18:43 -0000 1.87
+++ html_node/Standard-Targets.html 29 May 2024 18:09:31 -0000 1.88
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Standard Targets (GNU Coding Standards)</title>
<meta name="description" content="Standard Targets (GNU Coding Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Directory Variables">
+<link href="Makefile-Conventions.html" rel="up" title="Makefile Conventions">
+<link href="Install-Command-Categories.html" rel="next" title="Install Command
Categories">
+<link href="Directory-Variables.html" rel="prev" title="Directory Variables">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,32 +44,31 @@
</head>
<body lang="en">
-<a name="Standard-Targets"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Standard-Targets">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Install-Command-Categories.html" accesskey="n"
rel="next">Install Command Categories</a>, Previous: <a
href="Directory-Variables.html" accesskey="p" rel="prev">Variables for
Installation Directories</a>, Up: <a href="Makefile-Conventions.html"
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" 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>
+<h4 class="subsection section-level-set-subsection"
id="Standard-Targets-for-Users"><span>7.2.6 Standard Targets for Users<a
class="copiable-link" href="#Standard-Targets-for-Users"> ¶</a></span></h4>
<p>All GNU programs should have the following targets in their Makefiles:
</p>
-<dl compact="compact">
-<dt>‘<samp>all</samp>’</dt>
+<dl class="table">
+<dt>‘<samp class="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>
-<p>By default, the Make rules should compile and link with
‘<samp>-g</samp>’, so
+<p>By default, the Make rules should compile and link with ‘<samp
class="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.
</p>
</dd>
-<dt>‘<samp>install</samp>’</dt>
+<dt>‘<samp class="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
@@ -97,36 +78,36 @@
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.
+<code class="code">install-strip</code> target to do that.
</p>
-<p>If possible, write the <code>install</code> target rule so that it does not
+<p>If possible, write the <code class="code">install</code> target rule so
that it does not
modify anything in the directory where the program was built, provided
-‘<samp>make all</samp>’ has just been done. This is convenient
for building the
+‘<samp class="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>
<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
+specified as the values of the variables <code class="code">prefix</code> and
+<code class="code">exec_prefix</code>, as well as all subdirectories that are
needed.
+One way to do this is by means of an <code class="code">installdirs</code>
target
as described below.
</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
+<p>Use ‘<samp class="samp">-</samp>’ before any command for
installing a man page, so that
+<code class="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>
-<p>The way to install Info files is to copy them into <samp>$(infodir)</samp>
-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>dir</samp> file to add or update the
+<p>The way to install Info files is to copy them into <samp
class="file">$(infodir)</samp>
+with <code class="code">$(INSTALL_DATA)</code> (see <a class="pxref"
href="Command-Variables.html">Variables for Specifying Commands</a>), and then
run
+the <code class="code">install-info</code> program if it is present. <code
class="code">install-info</code>
+is a program that edits the Info <samp class="file">dir</samp> file to add or
update the
menu entry for the given Info file; it is part of the Texinfo package.
</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
+handle some additional situations, such as <code
class="code">install-info</code> not
being present.
</p>
-<div class="smallexample">
-<pre class="smallexample">do-install-info: foo.info installdirs
+<div class="example smallexample">
+<pre class="example-preformatted">do-install-info: foo.info installdirs
$(NORMAL_INSTALL)
# Prefer an info file in . to one in srcdir.
if test -f foo.info; then d=.; \
@@ -146,61 +127,61 @@
else true; fi
</pre></div>
-<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>When writing the <code class="code">install</code> target, you must
classify all the
+commands into three categories: normal ones, <em
class="dfn">pre-installation</em>
+commands and <em class="dfn">post-installation</em> commands. See <a
class="xref" href="Install-Command-Categories.html">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>
+<dt>‘<samp class="samp">install-html</samp>’</dt>
+<dt>‘<samp class="samp">install-dvi</samp>’</dt>
+<dt>‘<samp class="samp">install-pdf</samp>’</dt>
+<dt>‘<samp class="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.
+must be installed by the <code class="code">install</code> target.
</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
+such as <code class="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 class="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>
-<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.
+<p>Please make these <code class="code">install-<var
class="var">format</var></code> targets invoke the
+commands for the <var class="var">format</var> target, for example, by making
+<var class="var">format</var> a dependency.
</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.
+<dt>‘<samp class="samp">uninstall</samp>’</dt>
+<dd><p>Delete all the installed files—the copies that the ‘<samp
class="samp">install</samp>’
+and ‘<samp class="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>
<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>.
+the installation commands. See <a class="xref"
href="Install-Command-Categories.html">Install Command Categories</a>.
</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
+<dt>‘<samp class="samp">install-strip</samp>’</dt>
+<dd><p>Like <code class="code">install</code>, but strip the executable files
while installing
+them. In simple cases, this target can use the <code
class="code">install</code> target in
a simple way:
</p>
-<div class="smallexample">
-<pre class="smallexample">install-strip:
+<div class="example smallexample">
+<pre class="example-preformatted">install-strip:
$(MAKE) INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' \
install
</pre></div>
<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>
+<code class="code">install-strip</code> target can’t just refer to the
<code class="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
+<p><code class="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>
@@ -210,85 +191,85 @@
executable elsewhere in case there is a bug.
</p>
</dd>
-<dt>‘<samp>clean</samp>’</dt>
+<dt>‘<samp class="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
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 ‘<samp>mkdir -p</samp>’, since they could have existed anyway.
+with ‘<samp class="samp">mkdir -p</samp>’, since they could have
existed anyway.
</p>
-<p>Delete <samp>.dvi</samp> files here if they are not part of the
distribution.
+<p>Delete <samp class="file">.dvi</samp> files here if they are not part of
the distribution.
</p>
</dd>
-<dt>‘<samp>distclean</samp>’</dt>
+<dt>‘<samp class="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>make distclean</samp>’ should leave only
the files
+any other files, ‘<samp class="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>mkdir -p</samp>’,
since they
+parent directories that were created with ‘<samp class="samp">mkdir
-p</samp>’, since they
could have existed anyway.
</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 <samp>libgcc.a</samp>, because recompiling it
+<dt>‘<samp class="samp">mostlyclean</samp>’</dt>
+<dd><p>Like ‘<samp class="samp">clean</samp>’, but may refrain
from deleting a few files that people
+normally don’t want to recompile. For example, the ‘<samp
class="samp">mostlyclean</samp>’
+target for GCC does not delete <samp class="file">libgcc.a</samp>, because
recompiling it
is rarely necessary and takes a lot of time.
</p>
</dd>
-<dt>‘<samp>maintainer-clean</samp>’</dt>
+<dt>‘<samp class="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
+This typically includes everything deleted by <code
class="code">distclean</code>, plus
more: C source files produced by Bison, tags tables, Info files, and
so on.
</p>
<p>The reason we say “almost everything” is that running the
command
-‘<samp>make maintainer-clean</samp>’ should not delete
<samp>configure</samp> even
-if <samp>configure</samp> 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 <samp>configure</samp> and then begin to
+‘<samp class="samp">make maintainer-clean</samp>’ should not
delete <samp class="file">configure</samp> even
+if <samp class="file">configure</samp> can be remade using a rule in the
Makefile. More
+generally, ‘<samp class="samp">make maintainer-clean</samp>’
should not delete anything
+that needs to exist in order to run <samp class="file">configure</samp> and
then begin to
build the program. Also, there is no need to delete parent
-directories that were created with ‘<samp>mkdir -p</samp>’, since
they could
+directories that were created with ‘<samp class="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
+<code class="code">maintainer-clean</code> should delete everything else that
can be
rebuilt.
</p>
-<p>The ‘<samp>maintainer-clean</samp>’ target is intended to be
used by a maintainer of
+<p>The ‘<samp class="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>make
maintainer-clean</samp>’ deletes.
+reconstruct some of the files that ‘<samp class="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>
<p>To help make users aware of this, the commands for the special
-<code>maintainer-clean</code> target should start with these two:
+<code class="code">maintainer-clean</code> target should start with these two:
</p>
-<div class="smallexample">
-<pre class="smallexample">@echo 'This command is intended for maintainers to
use; it'
+<div class="example smallexample">
+<pre class="example-preformatted">@echo 'This command is intended for
maintainers to use; it'
@echo 'deletes files that may need special tools to rebuild.'
</pre></div>
</dd>
-<dt>‘<samp>TAGS</samp>’</dt>
+<dt>‘<samp class="samp">TAGS</samp>’</dt>
<dd><p>Update a tags table for this program.
</p>
</dd>
-<dt>‘<samp>info</samp>’</dt>
+<dt>‘<samp class="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
+<div class="example smallexample">
+<pre class="example-preformatted">info: foo.info
foo.info: foo.texi chap1.texi chap2.texi
$(MAKEINFO) $(srcdir)/foo.texi
</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
+<p>You must define the variable <code class="code">MAKEINFO</code> in the
Makefile. It should
+run the <code class="code">makeinfo</code> program, which is part of the
Texinfo
distribution.
</p>
<p>Normally a GNU distribution comes with Info files, and that means the
@@ -298,69 +279,69 @@
because they will already be up to date.
</p>
</dd>
-<dt>‘<samp>dvi</samp>’</dt>
-<dt>‘<samp>html</samp>’</dt>
-<dt>‘<samp>pdf</samp>’</dt>
-<dt>‘<samp>ps</samp>’</dt>
+<dt>‘<samp class="samp">dvi</samp>’</dt>
+<dt>‘<samp class="samp">html</samp>’</dt>
+<dt>‘<samp class="samp">pdf</samp>’</dt>
+<dt>‘<samp class="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.
+of the <code class="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
+<div class="example smallexample">
+<pre class="example-preformatted">dvi: foo.dvi
foo.dvi: foo.texi chap1.texi chap2.texi
$(TEXI2DVI) $(srcdir)/foo.texi
</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
+<p>You must define the variable <code class="code">TEXI2DVI</code> in the
Makefile. It
+should run the program <code class="code">texi2dvi</code>, which is part of
the Texinfo
+distribution. (<code class="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
+write only the dependencies, and allow GNU <code class="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
+<div class="example smallexample">
+<pre class="example-preformatted">html: foo.html
foo.html: foo.texi chap1.texi chap2.texi
$(TEXI2HTML) $(srcdir)/foo.texi
</pre></div>
-<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>Again, you would define the variable <code class="code">TEXI2HTML</code> in
the Makefile;
+for example, it might run <code class="code">makeinfo --no-split --html</code>
+(<code class="command">makeinfo</code> is part of the Texinfo distribution).
</p>
</dd>
-<dt>‘<samp>dist</samp>’</dt>
+<dt>‘<samp class="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>
<p>For example, the distribution tar file of GCC version 1.40 unpacks into
-a subdirectory named <samp>gcc-1.40</samp>.
+a subdirectory named <samp class="file">gcc-1.40</samp>.
</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.
+named, use <code class="code">ln</code> or <code class="code">cp</code> to
install the proper files in it, and
+then <code class="code">tar</code> that subdirectory.
</p>
-<p>Compress the tar file with <code>gzip</code>. For example, the actual
-distribution file for GCC version 1.40 is called <samp>gcc-1.40.tar.gz</samp>.
+<p>Compress the tar file with <code class="code">gzip</code>. For example,
the actual
+distribution file for GCC version 1.40 is called <samp
class="file">gcc-1.40.tar.gz</samp>.
It is ok to support other free compression formats as well.
</p>
-<p>The <code>dist</code> target should explicitly depend on all non-source
files
+<p>The <code class="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>.
+See <a class="xref" href="Releases.html">Making Releases</a>.
</p>
</dd>
-<dt>‘<samp>check</samp>’</dt>
+<dt>‘<samp class="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
@@ -371,22 +352,22 @@
<p>The following targets are suggested as conventional names, for programs
in which they are useful.
</p>
-<dl compact="compact">
-<dt><code>installcheck</code></dt>
+<dl class="table">
+<dt><code class="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>$(bindir)</samp> is in the search path.
+<samp class="file">$(bindir)</samp> 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
+<dt><code class="code">installdirs</code></dt>
+<dd><p>It’s useful to add a target named ‘<samp
class="samp">installdirs</samp>’ to create the
directories where files are installed, and their parent directories.
-There is a script called <samp>mkinstalldirs</samp> which is convenient for
+There is a script called <samp class="file">mkinstalldirs</samp> which is
convenient for
this; you can find it in the Gnulib package.
You can use a rule like this:
</p>
-<div class="smallexample">
-<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+<div class="example smallexample">
+<pre class="example-preformatted"># Make sure all installation directories
(e.g. $(bindir))
# actually exist by making them if necessary.
installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs $(bindir) $(datadir) \
@@ -394,10 +375,10 @@
$(mandir)
</pre></div>
-<p>or, if you wish to support <code>DESTDIR</code> (strongly encouraged),
+<p>or, if you wish to support <code class="env">DESTDIR</code> (strongly
encouraged),
</p>
-<div class="smallexample">
-<pre class="smallexample"># Make sure all installation directories (e.g.
$(bindir))
+<div class="example smallexample">
+<pre class="example-preformatted"># Make sure all installation directories
(e.g. $(bindir))
# actually exist by making them if necessary.
installdirs: mkinstalldirs
$(srcdir)/mkinstalldirs \
@@ -411,10 +392,11 @@
</p></dd>
</dl>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Install-Command-Categories.html">Install Command
Categories</a>, Previous: <a href="Directory-Variables.html">Variables for
Installation Directories</a>, Up: <a href="Makefile-Conventions.html">Makefile
Conventions</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: 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.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Style-of-Change-Logs.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Style-of-Change-Logs.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Style of Change Logs (GNU Coding Standards)</title>
<meta name="description" content="Style of Change Logs (GNU Coding Standards)">
@@ -23,37 +23,20 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="Change Log Concepts">
+<link href="Change-Logs.html" rel="up" title="Change Logs">
+<link href="Simple-Changes.html" rel="next" title="Simple Changes">
+<link href="Change-Log-Concepts.html" rel="prev" title="Change Log Concepts">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+kbd.kbd {font-style: oblique}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,26 +45,25 @@
</head>
<body lang="en">
-<a name="Style-of-Change-Logs"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Style-of-Change-Logs">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Simple-Changes.html" accesskey="n" rel="next">Simple
Changes</a>, Previous: <a href="Change-Log-Concepts.html" accesskey="p"
rel="prev">Change Log Concepts and Conventions</a>, Up: <a
href="Change-Logs.html" 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" 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>
+<h4 class="subsection" id="Style-of-Change-Logs-1"><span>6.8.2 Style of Change
Logs<a class="copiable-link" href="#Style-of-Change-Logs-1">
¶</a></span></h4>
+<a class="index-entry-id" id="index-change-logs_002c-style"></a>
<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.) Keep in mind that the line which shows the date of
the change and the author’s name and email address is needed only in a
-separate <samp>ChangeLog</samp> file, not when the change logs are kept in a
+separate <samp class="file">ChangeLog</samp> file, not when the change logs
are kept in a
VCS.
</p>
<div class="example">
-<pre class="example">2019-08-29 Noam Postavsky <npostavs@gmail.com>
+<pre class="example-preformatted">2019-08-29 Noam Postavsky
<npostavs@gmail.com>
Handle completely undecoded input in term (Bug#29918)
@@ -118,9 +100,9 @@
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.
+names by writing ‘<samp class="samp">* register.el
({insert,jump-to}-register)</samp>’;
+this is not a good idea, since searching for <code
class="code">jump-to-register</code> or
+<code class="code">insert-register</code> would not find that entry.
</p>
<p>Separate unrelated change log entries with blank lines. Don’t put
blank lines between individual changes of an entry. You can omit the
@@ -128,18 +110,18 @@
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>’. This makes highlighting in Emacs work better.
+‘<samp class="samp">)</samp>’, rather than ‘<samp
class="samp">,</samp>’, and opening the continuation with
+‘<samp class="samp">(</samp>’. This makes highlighting in Emacs
work better.
Here is an example:
</p>
<div class="example">
-<pre class="example">* src/keyboard.c (menu_bar_items, tool_bar_items)
+<pre class="example-preformatted">* src/keyboard.c (menu_bar_items,
tool_bar_items)
(Fexecute_extended_command): Deal with 'keymap' property.
</pre></div>
-<p>The easiest way to add an entry to <samp>ChangeLog</samp> is with the Emacs
-command <kbd>M-x add-change-log-entry</kbd>, or its variant <kbd>C-x 4 a</kbd>
-(<code>add-change-log-entry-other-window</code>). This automatically
+<p>The easiest way to add an entry to <samp class="file">ChangeLog</samp> is
with the Emacs
+command <kbd class="kbd">M-x add-change-log-entry</kbd>, or its variant <kbd
class="kbd">C-x 4 a</kbd>
+(<code class="code">add-change-log-entry-other-window</code>). This
automatically
collects the name of the changed file and the changed function or
variable, and formats a change log entry according to the conventions
described above, leaving it up to you to describe the changes you made
@@ -150,7 +132,7 @@
words, write this:
</p>
<div class="example">
-<pre class="example">2002-07-14 John Doe <jdoe@gnu.org>
+<pre class="example-preformatted">2002-07-14 John Doe <jdoe@gnu.org>
* sewing.c: Make it sew.
</pre></div>
@@ -158,34 +140,35 @@
<p>rather than this:
</p>
<div class="example">
-<pre class="example">2002-07-14 Usual Maintainer <usual@gnu.org>
+<pre class="example-preformatted">2002-07-14 Usual Maintainer
<usual@gnu.org>
* sewing.c: Make it sew. Patch by jdoe@gnu.org.
</pre></div>
<p>When committing someone else’s changes into a VCS, use the
VCS features to specify the author. For example, with Git,
-use <kbd>git commit --author=<var>author</var></kbd>.
+use <kbd class="kbd">git commit --author=<var class="var">author</var></kbd>.
</p>
<p>As for the date, that should be the date you applied the change.
(With a VCS, use the appropriate command-line switches,
-e.g., <kbd>git commit --date=<var>date</var></kbd>.)
+e.g., <kbd class="kbd">git commit --date=<var class="var">date</var></kbd>.)
</p>
<p>Modern VCS have commands to apply changes sent via email
-(e.g., Git has <kbd>git am</kbd>); in that case the author of the changeset
+(e.g., Git has <kbd class="kbd">git am</kbd>); in that case the author of the
changeset
and the date it was made will be automatically gleaned from the email
message and recorded in the repository. If the patches are prepared
-with suitable VCS commands, such as <kbd>git format-patch</kbd>,
+with suitable VCS commands, such as <kbd class="kbd">git format-patch</kbd>,
the email message body will also have the original author of the
changeset, so resending or forwarding the message will not interfere
with attributing the changes to their author. Thus, we recommend that
-you request your contributors to use commands such as <kbd>git
+you request your contributors to use commands such as <kbd class="kbd">git
format-patch</kbd> to prepare the patches.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Simple-Changes.html">Simple Changes</a>, Previous: <a
href="Change-Log-Concepts.html">Change Log Concepts and Conventions</a>, Up: <a
href="Change-Logs.html">Change Logs</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Syntactic-Conventions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Syntactic-Conventions.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Syntactic-Conventions.html 8 Jul 2021 18:18:43 -0000
1.84
+++ html_node/Syntactic-Conventions.html 29 May 2024 18:09:31 -0000
1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Syntactic Conventions (GNU Coding Standards)</title>
<meta name="description" content="Syntactic Conventions (GNU Coding
Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Comments">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Names.html" rel="next" title="Names">
+<link href="Comments.html" rel="prev" title="Comments">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,52 +44,51 @@
</head>
<body lang="en">
-<a name="Syntactic-Conventions"></a>
-<div class="header">
+<div class="section-level-extent" id="Syntactic-Conventions">
+<div class="nav-panel">
<p>
-Next: <a href="Names.html#Names" accesskey="n" rel="next">Names</a>, Previous:
<a href="Comments.html#Comments" accesskey="p" rel="prev">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>
+Next: <a href="Names.html" accesskey="n" rel="next">Naming Variables,
Functions, and Files</a>, Previous: <a href="Comments.html" accesskey="p"
rel="prev">Commenting Your Work</a>, Up: <a href="Writing-C.html" accesskey="u"
rel="up">Making The Best Use of C</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
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>
+<h3 class="section" id="Clean-Use-of-C-Constructs"><span>5.3 Clean Use of C
Constructs<a class="copiable-link" href="#Clean-Use-of-C-Constructs">
¶</a></span></h3>
+<a class="index-entry-id" id="index-syntactic-conventions"></a>
-<a name="index-implicit-int"></a>
-<a name="index-function-argument_002c-declaring"></a>
+<a class="index-entry-id" id="index-implicit-int"></a>
+<a class="index-entry-id" id="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>.
+declare functions to return <code class="code">int</code> rather than omitting
the
+<code class="code">int</code>.
</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
+<a class="index-entry-id" id="index-compiler-warnings"></a>
+<a class="index-entry-id" id="index-_002dWall-compiler-option"></a>
+<p>Some programmers like to use the GCC ‘<samp
class="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>-Wall</samp>’, because
it gives
+Other programmers prefer not to use ‘<samp
class="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"></a>
-<a name="index-lint"></a>
+<a class="index-entry-id" id="index-clang"></a>
+<a class="index-entry-id" id="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
+as <code class="command">lint</code>, <code class="command">clang</code>, and
GCC with extra warnings
+options such as <samp class="option">-Wconversion</samp> and <samp
class="option">-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 class="code">void</code> or calls to
do-nothing
functions merely to pacify a lint checker.
</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 class="code">extern</code>
declarations inside
functions.
</p>
-<a name="index-temporary-variables"></a>
+<a class="index-entry-id" id="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
+names like <code class="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
meaningful. This not only makes programs easier to understand, it also
@@ -116,40 +97,40 @@
all its uses. This makes the program even cleaner.
</p>
<p>Don’t use local variables or parameters that shadow global
identifiers.
-GCC’s ‘<samp>-Wshadow</samp>’ option can detect this problem.
+GCC’s ‘<samp class="samp">-Wshadow</samp>’ option can detect
this problem.
</p>
-<a name="index-multiple-variables-in-a-line"></a>
+<a class="index-entry-id" id="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:
</p>
<div class="example">
-<pre class="example">int foo,
+<div class="group"><pre class="example-preformatted">int foo,
bar;
-</pre></div>
+</pre></div></div>
<p>write either this:
</p>
<div class="example">
-<pre class="example">int foo, bar;
+<pre class="example-preformatted">int foo, bar;
</pre></div>
<p>or this:
</p>
<div class="example">
-<pre class="example">int foo;
+<pre class="example-preformatted">int foo;
int bar;
</pre></div>
<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>.
+<p>When you have an <code class="code">if</code>-<code
class="code">else</code> statement nested in another
+<code class="code">if</code> statement, always put braces around the <code
class="code">if</code>-<code class="code">else</code>.
Thus, never write like this:
</p>
<div class="example">
-<pre class="example">if (foo)
+<pre class="example-preformatted">if (foo)
if (bar)
win ();
else
@@ -159,7 +140,7 @@
<p>always like this:
</p>
<div class="example">
-<pre class="example">if (foo)
+<pre class="example-preformatted">if (foo)
{
if (bar)
win ();
@@ -168,26 +149,26 @@
}
</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>If you have an <code class="code">if</code> statement nested inside of an
<code class="code">else</code>
+statement, either write <code class="code">else if</code> on one line, like
this,
</p>
<div class="example">
-<pre class="example">if (foo)
- …
+<pre class="example-preformatted">if (foo)
+ ...
else if (bar)
- …
+ ...
</pre></div>
-<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:
+<p>with its <code class="code">then</code>-part indented like the preceding
<code class="code">then</code>-part,
+or write the nested <code class="code">if</code> within braces like this:
</p>
<div class="example">
-<pre class="example">if (foo)
- …
+<pre class="example-preformatted">if (foo)
+ ...
else
{
if (bar)
- …
+ ...
}
</pre></div>
@@ -195,27 +176,28 @@
same declaration. Instead, declare the structure tag separately
and then use it to declare the variables or typedefs.
</p>
-<p>Try to avoid assignments inside <code>if</code>-conditions (assignments
-inside <code>while</code>-conditions are ok). For example, don’t write
+<p>Try to avoid assignments inside <code class="code">if</code>-conditions
(assignments
+inside <code class="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)) == NULL)
+<pre class="example-preformatted">if ((foo = (char *) malloc (sizeof *foo)) ==
NULL)
fatal ("virtual memory exhausted");
</pre></div>
<p>instead, write this:
</p>
<div class="example">
-<pre class="example">foo = (char *) malloc (sizeof *foo);
+<pre class="example-preformatted">foo = (char *) malloc (sizeof *foo);
if (foo == NULL)
fatal ("virtual memory exhausted");
</pre></div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Next: <a href="Names.html#Names" accesskey="n" rel="next">Names</a>, Previous:
<a href="Comments.html#Comments" accesskey="p" rel="prev">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>
+Next: <a href="Names.html">Naming Variables, Functions, and Files</a>,
Previous: <a href="Comments.html">Commenting Your Work</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/System-Functions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/System-Functions.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/System-Functions.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/System-Functions.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>System Functions (GNU Coding Standards)</title>
<meta name="description" content="System Functions (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="CPU
Portability">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="Internationalization.html" rel="next" title="Internationalization">
+<link href="CPU-Portability.html" rel="prev" title="CPU Portability">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,19 +43,18 @@
</head>
<body lang="en">
-<a name="System-Functions"></a>
-<div class="header">
+<div class="section-level-extent" id="System-Functions">
+<div class="nav-panel">
<p>
-Next: <a href="Internationalization.html#Internationalization" accesskey="n"
rel="next">Internationalization</a>, Previous: <a
href="CPU-Portability.html#CPU-Portability" accesskey="p" rel="prev">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>
+Next: <a href="Internationalization.html" accesskey="n"
rel="next">Internationalization</a>, Previous: <a href="CPU-Portability.html"
accesskey="p" rel="prev">Portability between CPUs</a>, Up: <a
href="Writing-C.html" accesskey="u" rel="up">Making The Best Use of C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="Calling-System-Functions"></a>
-<h3 class="section">5.7 Calling System Functions</h3>
+<h3 class="section" id="Calling-System-Functions"><span>5.7 Calling System
Functions<a class="copiable-link" href="#Calling-System-Functions">
¶</a></span></h3>
-<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>
+<a class="index-entry-id"
id="index-C-library-functions_002c-and-portability"></a>
+<a class="index-entry-id" id="index-POSIX-functions_002c-and-portability"></a>
+<a class="index-entry-id"
id="index-library-functions_002c-and-portability"></a>
+<a class="index-entry-id"
id="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,
@@ -93,41 +73,41 @@
<p>Despite the standards, nearly every library function has some sort of
portability issue on some system or another. Here are some examples:
</p>
-<dl compact="compact">
-<dt><code>open</code></dt>
-<dd><p>Names with trailing <code>/</code>’s are mishandled on many
platforms.
+<dl class="table">
+<dt><code class="code">open</code></dt>
+<dd><p>Names with trailing <code class="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
+<dt><code class="code">printf</code></dt>
+<dd><p><code class="code">long double</code> may be unimplemented; floating
values Infinity and
NaN are often mishandled; output for large precisions may be
incorrect.
</p>
</dd>
-<dt><code>readlink</code></dt>
-<dd><p>May return <code>int</code> instead of <code>ssize_t</code>.
+<dt><code class="code">readlink</code></dt>
+<dd><p>May return <code class="code">int</code> instead of <code
class="code">ssize_t</code>.
</p>
</dd>
-<dt><code>scanf</code></dt>
-<dd><p>On Windows, <code>errno</code> is not set on failure.
+<dt><code class="code">scanf</code></dt>
+<dd><p>On Windows, <code class="code">errno</code> is not set on failure.
</p></dd>
</dl>
-<a name="index-Gnulib"></a>
-<p><a href="https://www.gnu.org/software/gnulib/";>Gnulib</a> is a big help in
+<a class="index-entry-id" id="index-Gnulib"></a>
+<p><a class="uref" href="https://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"></a>
-<a name="index-error-messages_002c-in-Gnulib"></a>
-<a name="index-data-structures_002c-in-Gnulib"></a>
+<a class="index-entry-id" id="index-xmalloc_002c-in-Gnulib"></a>
+<a class="index-entry-id" id="index-error-messages_002c-in-Gnulib"></a>
+<a class="index-entry-id" id="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
+functions (<code class="code">xmalloc</code>, <code
class="code">xrealloc</code>), and output of error
messages.
</p>
<p>Gnulib integrates with GNU Autoconf and Automake to remove much of the
@@ -136,15 +116,16 @@
use the Gnulib code to supply the missing pieces.
</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
+portability: <a data-manual="gnulib"
href="https://www.gnu.org/software/gnulib/manual/html_node/index.html#Top";>Introduction</a>
in <cite class="cite">Gnulib</cite> and
+see <a data-manual="autoconf"
href="https://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 class="cite">Autoconf</cite>. Please consult them
for many more details.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Next: <a href="Internationalization.html#Internationalization" accesskey="n"
rel="next">Internationalization</a>, Previous: <a
href="CPU-Portability.html#CPU-Portability" accesskey="p" rel="prev">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>
+Next: <a href="Internationalization.html">Internationalization</a>, Previous:
<a href="CPU-Portability.html">Portability between CPUs</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/System-Portability.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/System-Portability.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/System-Portability.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/System-Portability.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>System Portability (GNU Coding Standards)</title>
<meta name="description" content="System Portability (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Names">
+<link href="Writing-C.html" rel="up" title="Writing C">
+<link href="CPU-Portability.html" rel="next" title="CPU Portability">
+<link href="Names.html" rel="prev" title="Names">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,34 +43,48 @@
</head>
<body lang="en">
-<a name="System-Portability"></a>
-<div class="header">
+<div class="section-level-extent" id="System-Portability">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="CPU-Portability.html" accesskey="n" rel="next">Portability
between CPUs</a>, Previous: <a href="Names.html" accesskey="p"
rel="prev">Naming Variables, Functions, and Files</a>, Up: <a
href="Writing-C.html" accesskey="u" rel="up">Making The Best Use of C</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Portability-between-System-Types"><span>5.5
Portability between System Types<a class="copiable-link"
href="#Portability-between-System-Types"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-portability_002c-between-system-types"></a>
<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>
-<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 CPU. 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>
-<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
-be hard.
+<p>The primary purpose of GNU software is to run as part of the GNU
+operating system, compiled with GNU compilers, on various types of
+hardware. So the kinds of portability that are absolutely necessary
+are quite limited. It is important to support Linux-based GNU
+systems, since they are the form of GNU that people mainly use.
+</p>
+<p>Making a GNU program operate on operating systems other than the GNU
+system is not part of the core goal of developing a GNU package. You
+don’t ever have to do that. However, users will ask you to do that,
+and cooperating with those requests is useful—as long as you don’t
+let it dominate the project or impede the primary goal.
+</p>
+<p>It is good to support the other free or nearly free operating systems
+(for instance, *BSD). 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 be hard.
+</p>
+<p>For the most part it is good to port the program to more platforms,
+but you should not let take up so much of your time that it hinders
+you from improving the program in more central ways. If it starts to
+do that, please tell users that you don’t want to spend any more
+time on this—someone else must write that code, debug it, document
+it, etc., and then you can install it.
+</p>
+<p>You can reject porting patches for technical reasons too, as with any
+other patch that users submit. It is up to you.
</p>
-<a name="index-autoconf"></a>
+<a class="index-entry-id" id="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
@@ -97,9 +92,9 @@
written.
</p>
<p>Avoid using the format of semi-internal data bases (e.g., directories)
-when there is a higher-level alternative (<code>readdir</code>).
+when there is a higher-level alternative (<code class="code">readdir</code>).
</p>
-<a name="index-non_002dPOSIX-systems_002c-and-portability"></a>
+<a class="index-entry-id"
id="index-non_002dPOSIX-systems_002c-and-portability"></a>
<p>As for systems that are not like Unix, such as MS-DOS, 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
@@ -107,31 +102,32 @@
other incompatible systems.
</p>
<p>If you do support Windows, please do not abbreviate it as “win”.
-See <a href="Trademarks.html#Trademarks">Trademarks</a>.
+See <a class="xref" href="Trademarks.html">Trademarks</a>.
</p>
<p>Usually we write the name “Windows” in full, but when brevity is
very important (as in file names and some symbol names), we abbreviate
-it to “w”. In GNU Emacs, for instance, we use
‘<samp>w32</samp>’ in file
+it to “w”. In GNU Emacs, for instance, we use ‘<samp
class="samp">w32</samp>’ in file
names of Windows-specific files, but the macro for Windows
-conditionals is called <code>WINDOWSNT</code>. In principle there could
-also be ‘<samp>w64</samp>’.
+conditionals is called <code class="code">WINDOWSNT</code>. In principle
there could
+also be ‘<samp class="samp">w64</samp>’.
</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
+<code class="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 class="emph">use</em> these functions,
if you prefer
to make the program more portable to other systems.)
</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>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="CPU-Portability.html">Portability between CPUs</a>, Previous:
<a href="Names.html">Naming Variables, Functions, and Files</a>, Up: <a
href="Writing-C.html">Making The Best Use of C</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Trademarks.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Trademarks.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Trademarks.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Trademarks.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Trademarks (GNU Coding Standards)</title>
<meta name="description" content="Trademarks (GNU Coding Standards)">
@@ -23,37 +23,17 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Contributions">
+<link href="Legal-Issues.html" rel="up" title="Legal Issues">
+<link href="Contributions.html" rel="prev" title="Contributions">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +42,14 @@
</head>
<body lang="en">
-<a name="Trademarks"></a>
-<div class="header">
+<div class="section-level-extent" id="Trademarks">
+<div class="nav-panel">
<p>
-Previous: <a href="Contributions.html#Contributions" accesskey="p"
rel="prev">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>
+Previous: <a href="Contributions.html" accesskey="p" rel="prev">Accepting
Contributions</a>, Up: <a href="Legal-Issues.html" accesskey="u"
rel="up">Keeping Free Software Free</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Trademarks-1"><span>2.3 Trademarks<a
class="copiable-link" href="#Trademarks-1"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-trademarks"></a>
<p>Please do not include any trademark acknowledgments in GNU software
packages or documentation.
@@ -95,8 +74,9 @@
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 so in
GNU packages. Please write “Windows” in full, or abbreviate it to
-“w.” See <a
href="System-Portability.html#System-Portability">System Portability</a>.
+“w.” See <a class="xref"
href="System-Portability.html">Portability between System Types</a>.
</p>
+</div>
Index: html_node/User-Interfaces.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/User-Interfaces.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/User-Interfaces.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/User-Interfaces.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>User Interfaces (GNU Coding Standards)</title>
<meta name="description" content="User Interfaces (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="Finding-Program-Files.html#Finding-Program-Files" rel="next"
title="Finding Program Files">
-<link href="Errors.html#Errors" rel="prev" title="Errors">
+<link href="Program-Behavior.html" rel="up" title="Program Behavior">
+<link href="Finding-Program-Files.html" rel="next" title="Finding Program
Files">
+<link href="Errors.html" rel="prev" title="Errors">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,21 +43,20 @@
</head>
<body lang="en">
-<a name="User-Interfaces"></a>
-<div class="header">
+<div class="section-level-extent" id="User-Interfaces">
+<div class="nav-panel">
<p>
-Next: <a href="Finding-Program-Files.html#Finding-Program-Files" accesskey="n"
rel="next">Finding Program Files</a>, Previous: <a href="Errors.html#Errors"
accesskey="p" rel="prev">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>
+Next: <a href="Finding-Program-Files.html" accesskey="n" rel="next">Finding
the Program’s Executable and Associated Files</a>, Previous: <a
href="Errors.html" accesskey="p" rel="prev">Formatting Error Messages</a>, Up:
<a href="Program-Behavior.html" accesskey="u" rel="up">Program Behavior for All
Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Standards-for-Interfaces-Generally"><span>4.5
Standards for Interfaces Generally<a class="copiable-link"
href="#Standards-for-Interfaces-Generally"> ¶</a></span></h3>
-<a name="index-program-name-and-its-behavior"></a>
-<a name="index-behavior_002c-dependent-on-program_0027s-name"></a>
+<a class="index-entry-id" id="index-program-name-and-its-behavior"></a>
+<a class="index-entry-id"
id="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. Thus, if you
-make <samp>foo</samp> a link to <samp>ls</samp>, the program should behave the
+make <samp class="file">foo</samp> a link to <samp class="file">ls</samp>, the
program should behave the
same regardless of which of those names is used to invoke it.
</p>
<p>Instead, use a run time option or a compilation switch or both to
@@ -84,7 +64,7 @@
of the program, with different default behaviors, and install them
under two different names.
</p>
-<a name="index-output-device-and-program_0027s-behavior"></a>
+<a class="index-entry-id"
id="index-output-device-and-program_0027s-behavior"></a>
<p>Likewise, please don’t make the behavior of a command-line program
depend on the type of output device it gets as standard output or
standard input. Device independence is an important principle of the
@@ -104,21 +84,22 @@
binary data. Sending such output to a terminal is useless and can
cause trouble. If such a program normally sends its output to stdout,
it should detect, in these cases, when the output is a terminal and
-give an error message instead. The <code>-f</code> option should override
+give an error message instead. The <code class="code">-f</code> option should
override
this exception, thus permitting the output to go to the terminal.
</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
+device. It would be disastrous if <code class="code">ls</code> or <code
class="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
+output device type. For example, we provide a <code class="code">dir</code>
program much
+like <code class="code">ls</code> except that its default output format is
always
multi-column format.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Next: <a href="Finding-Program-Files.html#Finding-Program-Files" accesskey="n"
rel="next">Finding Program Files</a>, Previous: <a href="Errors.html#Errors"
accesskey="p" rel="prev">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>
+Next: <a href="Finding-Program-Files.html">Finding the Program’s
Executable and Associated Files</a>, Previous: <a href="Errors.html">Formatting
Error Messages</a>, Up: <a href="Program-Behavior.html">Program Behavior for
All Programs</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Using-Extensions.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Using-Extensions.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Using-Extensions.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Using-Extensions.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Using Extensions (GNU Coding Standards)</title>
<meta name="description" content="Using Extensions (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Compatibility">
+<link href="Design-Advice.html" rel="up" title="Design Advice">
+<link href="Standard-C.html" rel="next" title="Standard C">
+<link href="Compatibility.html" rel="prev" title="Compatibility">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,15 +43,14 @@
</head>
<body lang="en">
-<a name="Using-Extensions"></a>
-<div class="header">
+<div class="section-level-extent" id="Using-Extensions">
+<div class="nav-panel">
<p>
-Next: <a href="Standard-C.html#Standard-C" accesskey="n" rel="next">Standard
C</a>, Previous: <a href="Compatibility.html#Compatibility" accesskey="p"
rel="prev">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>
+Next: <a href="Standard-C.html" accesskey="n" rel="next">Standard C and
Pre-Standard C</a>, Previous: <a href="Compatibility.html" accesskey="p"
rel="prev">Compatibility with Other Implementations</a>, Up: <a
href="Design-Advice.html" accesskey="u" rel="up">General Program Design</a>
[<a href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h3 class="section" id="Using-Non_002dstandard-Features"><span>3.3 Using
Non-standard Features<a class="copiable-link"
href="#Using-Non_002dstandard-Features"> ¶</a></span></h3>
+<a class="index-entry-id" id="index-non_002dstandard-extensions"></a>
<p>Many GNU facilities that already exist support a number of convenient
extensions over the comparable Unix facilities. Whether to use these
@@ -82,8 +62,8 @@
program to work on fewer kinds of machines.
</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
+For example, you can define functions with a “keyword” <code
class="code">INLINE</code>
+and define that as a macro to expand into either <code
class="code">inline</code> or
nothing, depending on the compiler.
</p>
<p>In general, perhaps it is best not to use the extensions if you can
@@ -100,6 +80,7 @@
compiler, then no one can compile them without having them installed
already. That would be extremely troublesome in certain cases.
</p>
+</div>
Index: html_node/Utilities-in-Makefiles.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Utilities-in-Makefiles.html,v
retrieving revision 1.86
retrieving revision 1.87
diff -u -b -r1.86 -r1.87
--- html_node/Utilities-in-Makefiles.html 8 Jul 2021 18:18:43 -0000
1.86
+++ html_node/Utilities-in-Makefiles.html 29 May 2024 18:09:31 -0000
1.87
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Utilities in Makefiles (GNU Coding Standards)</title>
<meta name="description" content="Utilities in Makefiles (GNU Coding
Standards)">
@@ -23,37 +23,19 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Makefile
Basics">
+<link href="Makefile-Conventions.html" rel="up" title="Makefile Conventions">
+<link href="Command-Variables.html" rel="next" title="Command Variables">
+<link href="Makefile-Basics.html" rel="prev" title="Makefile Basics">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,66 +44,65 @@
</head>
<body lang="en">
-<a name="Utilities-in-Makefiles"></a>
-<div class="header">
+<div class="subsection-level-extent" id="Utilities-in-Makefiles">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Command-Variables.html" accesskey="n" rel="next">Variables for
Specifying Commands</a>, Previous: <a href="Makefile-Basics.html" accesskey="p"
rel="prev">General Conventions for Makefiles</a>, Up: <a
href="Makefile-Conventions.html" 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" 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>
+<h4 class="subsection section-level-set-subsection"
id="Utilities-in-Makefiles-1"><span>7.2.2 Utilities in Makefiles<a
class="copiable-link" href="#Utilities-in-Makefiles-1"> ¶</a></span></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 <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>.
+<code class="code">configure</code>) to run under <code class="code">sh</code>
(both the traditional Bourne
+shell and the <small class="sc">POSIX</small> shell), not <code
class="code">csh</code>. Don’t use any
+special features of <code class="code">ksh</code> or <code
class="code">bash</code>, or <small class="sc">POSIX</small> features
+not widely supported in traditional Bourne <code class="code">sh</code>.
</p>
-<p>The <code>configure</code> script and the Makefile rules for building and
+<p>The <code class="code">configure</code> script and the Makefile rules for
building and
installation should not use any utilities directly except these:
</p>
<div class="example">
-<pre class="example">awk cat cmp cp diff echo egrep expr false grep
install-info ln ls
+<pre class="example-preformatted">awk cat cmp cp diff echo expr false grep
install-info ln ls
mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true
</pre></div>
-<p>Compression programs such as <code>gzip</code> can be used in the
-<code>dist</code> rule.
+<p>Compression programs such as <code class="code">gzip</code> can be used in
the
+<code class="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
+<small class="sc">POSIX</small>-specified) options and features of these
programs. For
+example, don’t use ‘<samp class="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="http://www.gnu.org/software/autoconf/manual/html_node/Portable-Shell.html#Portable-Shell";>Portable
Shell Programming</a> in <cite>Autoconf</cite>.
+<a data-manual="autoconf"
href="https://www.gnu.org/software/autoconf/manual/html_node/Portable-Shell.html#Portable-Shell";>Portable
Shell Programming</a> in <cite class="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>
<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
+and related programs, but should do so via <code class="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
+<pre class="example-preformatted">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>Use the following <code class="code">make</code> variables to run those
programs:
</p>
<div class="example">
-<pre class="example">$(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD) $(LDCONFIG)
$(LEX)
+<pre class="example-preformatted">$(AR) $(BISON) $(CC) $(FLEX) $(INSTALL)
$(LD) $(LDCONFIG) $(LEX)
$(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
</pre></div>
-<p>When you use <code>ranlib</code> or <code>ldconfig</code>, you should make
sure
+<p>When you use <code class="code">ranlib</code> or <code
class="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>AC_PROG_RANLIB</samp>’ macro can
help with
+a problem. (The Autoconf ‘<samp
class="samp">AC_PROG_RANLIB</samp>’ macro can help with
this.)
</p>
<p>If you use symbolic links, you should implement a fallback for systems
@@ -130,17 +111,18 @@
<p>Additional utilities that can be used via Make variables are:
</p>
<div class="example">
-<pre class="example">chgrp chmod chown mknod
+<pre class="example-preformatted">chgrp chmod chown mknod
</pre></div>
<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>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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="prev">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>
+Next: <a href="Command-Variables.html">Variables for Specifying Commands</a>,
Previous: <a href="Makefile-Basics.html">General Conventions for Makefiles</a>,
Up: <a href="Makefile-Conventions.html">Makefile Conventions</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/Writing-C.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/Writing-C.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/Writing-C.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/Writing-C.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Writing C (GNU Coding Standards)</title>
<meta name="description" content="Writing C (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="File Usage">
+<link href="index.html" rel="up" title="Top">
+<link href="Documentation.html" rel="next" title="Documentation">
+<link href="Program-Behavior.html" rel="prev" title="Program Behavior">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,43 +43,32 @@
</head>
<body lang="en">
-<a name="Writing-C"></a>
-<div class="header">
+<div class="chapter-level-extent" id="Writing-C">
+<div class="nav-panel">
<p>
-Next: <a href="Documentation.html#Documentation" accesskey="n"
rel="next">Documentation</a>, Previous: <a
href="Program-Behavior.html#Program-Behavior" accesskey="p" rel="prev">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>
+Next: <a href="Documentation.html" accesskey="n" rel="next">Documenting
Programs</a>, Previous: <a href="Program-Behavior.html" accesskey="p"
rel="prev">Program Behavior for All Programs</a>, Up: <a href="index.html"
accesskey="u" rel="up">GNU Coding Standards</a> [<a
href="index.html#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" 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>
+<h2 class="chapter" id="Making-The-Best-Use-of-C"><span>5 Making The Best Use
of C<a class="copiable-link" href="#Making-The-Best-Use-of-C">
¶</a></span></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="mini-toc">
+<li><a href="Formatting.html" accesskey="1">Formatting Your Source
Code</a></li>
+<li><a href="Comments.html" accesskey="2">Commenting Your Work</a></li>
+<li><a href="Syntactic-Conventions.html" accesskey="3">Clean Use of C
Constructs</a></li>
+<li><a href="Names.html" accesskey="4">Naming Variables, Functions, and
Files</a></li>
+<li><a href="System-Portability.html" accesskey="5">Portability between System
Types</a></li>
+<li><a href="CPU-Portability.html" accesskey="6">Portability between
CPUs</a></li>
+<li><a href="System-Functions.html" accesskey="7">Calling System
Functions</a></li>
+<li><a href="Internationalization.html"
accesskey="8">Internationalization</a></li>
+<li><a href="Character-Set.html" accesskey="9">Character Set</a></li>
+<li><a href="Quote-Characters.html">Quote Characters</a></li>
+<li><a href="Mmap.html">Mmap</a></li>
+</ul>
+</div>
Index: html_node/_002d_002dhelp.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/_002d_002dhelp.html,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -b -r1.68 -r1.69
--- html_node/_002d_002dhelp.html 8 Jul 2021 18:18:43 -0000 1.68
+++ html_node/_002d_002dhelp.html 29 May 2024 18:09:31 -0000 1.69
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>--help (GNU Coding Standards)</title>
<meta name="description" content="--help (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev"
title="--version">
+<link href="Command_002dLine-Interfaces.html" rel="up" title="Command-Line
Interfaces">
+<link href="_002d_002dversion.html" rel="prev" title="--version">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,38 +43,38 @@
</head>
<body lang="en">
-<a name="g_t_002d_002dhelp"></a>
-<div class="header">
+<div class="subsection-level-extent" id="g_t_002d_002dhelp">
+<div class="nav-panel">
<p>
-Previous: <a href="_002d_002dversion.html#g_t_002d_002dversion" accesskey="p"
rel="prev">--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>
+Previous: <a href="_002d_002dversion.html" accesskey="p" rel="prev"><samp
class="option">--version</samp></a>, Up: <a
href="Command_002dLine-Interfaces.html" accesskey="u" rel="up">Standards for
Command Line Interfaces</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="g_t_002d_002dhelp-1"></a>
-<h4 class="subsection">4.8.2 <samp>--help</samp></h4>
+<h4 class="subsection" id="g_t_002d_002dhelp-1"><span>4.8.2 <samp
class="option">--help</samp><a class="copiable-link"
href="#g_t_002d_002dhelp-1"> ¶</a></span></h4>
-<a name="index-_002d_002dhelp-output"></a>
+<a class="index-entry-id" id="index-_002d_002dhelp-output"></a>
-<p>The standard <code>--help</code> option should output brief documentation
+<p>The standard <code class="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"></a>
-<a name="index-bug-reports"></a>
-<p>Near the end of the ‘<samp>--help</samp>’ option’s
output, please place lines
+<a class="index-entry-id" id="index-address-for-bug-reports"></a>
+<a class="index-entry-id" id="index-bug-reports"></a>
+<p>Near the end of the ‘<samp class="samp">--help</samp>’
option’s output, please place lines
giving the email address for bug reports, the package’s home page
-(normally
‘<code>https://www.gnu.org/software/<var>pkg</var></code>’), and the
+(normally ‘<code class="indicateurl">https://www.gnu.org/software/<var
class="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: <https://www.gnu.org/software/<var>pkg</var>/>
+<pre class="example-preformatted">Report bugs to: <var
class="var">mailing-address</var>
+<var class="var">pkg</var> home page: <https://www.gnu.org/software/<var
class="var">pkg</var>/>
General help using GNU software: <https://www.gnu.org/gethelp/>
</pre></div>
<p>It is ok to mention other appropriate mailing lists and web pages.
</p>
+</div>
Index: html_node/_002d_002dversion.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/_002d_002dversion.html,v
retrieving revision 1.69
retrieving revision 1.70
diff -u -b -r1.69 -r1.70
--- html_node/_002d_002dversion.html 8 Jul 2021 18:18:43 -0000 1.69
+++ html_node/_002d_002dversion.html 29 May 2024 18:09:31 -0000 1.70
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>--version (GNU Coding Standards)</title>
<meta name="description" content="--version (GNU Coding Standards)">
@@ -23,37 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<link href="index.html#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
+<link href="index.html" rel="start" title="Top">
+<link href="Index.html" 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="prev" title="Command-Line Interfaces">
+<link href="Command_002dLine-Interfaces.html" rel="up" title="Command-Line
Interfaces">
+<link href="_002d_002dhelp.html" rel="next" title="--help">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-blockquote.smallquotation {font-size: smaller}
-div.display {margin-left: 3.2em}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -62,50 +43,49 @@
</head>
<body lang="en">
-<a name="g_t_002d_002dversion"></a>
-<div class="header">
+<div class="subsection-level-extent" id="g_t_002d_002dversion">
+<div class="nav-panel">
<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>
+Next: <a href="_002d_002dhelp.html" accesskey="n" rel="next"><samp
class="option">--help</samp></a>, Up: <a
href="Command_002dLine-Interfaces.html" accesskey="u" rel="up">Standards for
Command Line Interfaces</a> [<a href="index.html#SEC_Contents"
title="Table of contents" rel="contents">Contents</a>][<a href="Index.html"
title="Index" rel="index">Index</a>]</p>
</div>
<hr>
-<a name="g_t_002d_002dversion-1"></a>
-<h4 class="subsection">4.8.1 <samp>--version</samp></h4>
+<h4 class="subsection" id="g_t_002d_002dversion-1"><span>4.8.1 <samp
class="option">--version</samp><a class="copiable-link"
href="#g_t_002d_002dversion-1"> ¶</a></span></h4>
-<a name="index-_002d_002dversion-output"></a>
+<a class="index-entry-id" id="index-_002d_002dversion-output"></a>
-<p>The standard <code>--version</code> option should direct the program to
+<p>The standard <code class="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"></a>
-<a name="index-program_0027s-canonical-name"></a>
+<a class="index-entry-id" id="index-canonical-name-of-a-program"></a>
+<a class="index-entry-id" id="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 class="example-preformatted">GNU Emacs 19.30
</pre></div>
-<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
+<p>The program’s name should be a constant string; <em
class="emph">don’t</em> compute it
+from <code class="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>.
+out the precise file name where a command is found in <code
class="code">PATH</code>.
</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 class="example-preformatted">emacsserver (GNU Emacs) 19.30
</pre></div>
<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>
-<p>If you <em>need</em> to mention the version numbers of libraries which
+<p>If you <em class="emph">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
@@ -121,7 +101,7 @@
each on a separate line.
</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
+the 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.
@@ -131,8 +111,8 @@
</p>
<p>Here’s an example of output that follows these rules:
</p>
-<div class="smallexample">
-<pre class="smallexample">GNU hello 2.3
+<div class="example smallexample">
+<pre class="example-preformatted">GNU hello 2.3
Copyright (C) 2007 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later
<https://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
@@ -148,11 +128,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;
-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>.)
+see <a data-manual="maintain"
href="https://www.gnu.org/prep/maintain/html_node/Copyright-Notices.html#Copyright-Notices";>Copyright
Notices</a> in <cite class="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 notices (see <a class="pxref"
href="Internationalization.html">Internationalization</a>). If the
translation’s
+character set supports it, the ‘<samp class="samp">(C)</samp>’
should be replaced with the
copyright symbol, as follows:
</p>
<p>©
@@ -163,22 +143,22 @@
have legal significance.
</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. In the case of a GNU license, <em>always</em> indicate the permitted
+Any abbreviation can be followed by ‘<samp class="samp">v<var
class="var">version</var>[+]</samp>’, meaning
+that particular version, or later versions with the ‘<samp
class="samp">+</samp>’, as shown
+above. In the case of a GNU license, <em class="emph">always</em> indicate
the permitted
versions in this way.
</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
+‘<samp class="samp">/</samp>’ for a separator; the version number
can follow the license
abbreviation as usual, as in the examples below.
</p>
-<dl compact="compact">
+<dl class="table">
<dt>GPL</dt>
-<dd><p>GNU General Public License, <a
href="https://www.gnu.org/licenses/gpl.html";>https://www.gnu.org/licenses/gpl.html</a>.
+<dd><p>GNU General Public License, <a class="url"
href="https://www.gnu.org/licenses/gpl.html";>https://www.gnu.org/licenses/gpl.html</a>.
</p>
</dd>
<dt>LGPL</dt>
-<dd><p>GNU Lesser General Public License, <a
href="https://www.gnu.org/licenses/lgpl.html";>https://www.gnu.org/licenses/lgpl.html</a>.
+<dd><p>GNU Lesser General Public License, <a class="url"
href="https://www.gnu.org/licenses/lgpl.html";>https://www.gnu.org/licenses/lgpl.html</a>.
</p>
</dd>
<dt>GPL/Ada</dt>
@@ -187,66 +167,67 @@
</dd>
<dt>Apache</dt>
<dd><p>The Apache Software Foundation license,
-<a
href="https://directory.fsf.org/wiki/License:Apache2.0";>https://directory.fsf.org/wiki/License:Apache2.0</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:Apache2.0";>https://directory.fsf.org/wiki/License:Apache2.0</a>.
</p>
</dd>
<dt>Artistic</dt>
<dd><p>The Artistic license used for Perl,
-<a
href="https://directory.fsf.org/wiki/License:ArtisticLicense2.0";>https://directory.fsf.org/wiki/License:ArtisticLicense2.0</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:ArtisticLicense2.0";>https://directory.fsf.org/wiki/License:ArtisticLicense2.0</a>.
</p>
</dd>
<dt>Expat</dt>
-<dd><p>The Expat license, <a
href="https://directory.fsf.org/wiki/License:Expat";>https://directory.fsf.org/wiki/License:Expat</a>.
+<dd><p>The Expat license, <a class="url"
href="https://directory.fsf.org/wiki/License:Expat";>https://directory.fsf.org/wiki/License:Expat</a>.
</p>
</dd>
<dt>MPL</dt>
-<dd><p>The Mozilla Public License, <a
href="https://directory.fsf.org/wiki/License:MPLv2.0";>https://directory.fsf.org/wiki/License:MPLv2.0</a>.
+<dd><p>The Mozilla Public License, <a class="url"
href="https://directory.fsf.org/wiki/License:MPLv2.0";>https://directory.fsf.org/wiki/License:MPLv2.0</a>.
</p>
</dd>
<dt>OBSD</dt>
<dd><p>The original (4-clause) BSD license, incompatible with the GNU GPL,<br>
-<a
href="https://directory.fsf.org/wiki/License:BSD_4Clause";>https://directory.fsf.org/wiki/License:BSD_4Clause</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:BSD_4Clause";>https://directory.fsf.org/wiki/License:BSD_4Clause</a>.
</p>
</dd>
<dt>PHP</dt>
-<dd><p>The license used for PHP, <a
href="https://directory.fsf.org/wiki/License:PHPv3.01";>https://directory.fsf.org/wiki/License:PHPv3.01</a>.
+<dd><p>The license used for PHP, <a class="url"
href="https://directory.fsf.org/wiki/License:PHPv3.01";>https://directory.fsf.org/wiki/License:PHPv3.01</a>.
</p>
</dd>
<dt>public domain</dt>
<dd><p>The non-license that is being in the public domain,<br>
-<a
href="https://www.gnu.org/licenses/license-list.html#PublicDomain";>https://www.gnu.org/licenses/license-list.html#PublicDomain</a>.
+<a class="url"
href="https://www.gnu.org/licenses/license-list.html#PublicDomain";>https://www.gnu.org/licenses/license-list.html#PublicDomain</a>.
</p>
</dd>
<dt>Python</dt>
<dd><p>The license for Python,
-<a
href="https://directory.fsf.org/wiki/License:Python2.0.1";>https://directory.fsf.org/wiki/License:Python2.0.1</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:Python2.0.1";>https://directory.fsf.org/wiki/License:Python2.0.1</a>.
</p>
</dd>
<dt>RBSD</dt>
<dd><p>The revised (3-clause) BSD, compatible with the GNU GPL,<br>
-<a
href="https://directory.fsf.org/wiki/License:BSD_3Clause";>https://directory.fsf.org/wiki/License:BSD_3Clause</a>.
+<a class="url"
href="https://directory.fsf.org/wiki/License:BSD_3Clause";>https://directory.fsf.org/wiki/License:BSD_3Clause</a>.
</p>
</dd>
<dt>X11</dt>
<dd><p>The simple non-copyleft license used for most versions of the X Window
-System, <a
href="https://directory.fsf.org/wiki/License:X11";>https://directory.fsf.org/wiki/License:X11</a>.
+System, <a class="url"
href="https://directory.fsf.org/wiki/License:X11";>https://directory.fsf.org/wiki/License:X11</a>.
</p>
</dd>
<dt>Zlib</dt>
-<dd><p>The license for Zlib, <a
href="https://directory.fsf.org/wiki/License:Zlib";>https://directory.fsf.org/wiki/License:Zlib</a>.
+<dd><p>The license for Zlib, <a class="url"
href="https://directory.fsf.org/wiki/License:Zlib";>https://directory.fsf.org/wiki/License:Zlib</a>.
</p>
</dd>
</dl>
<p>More information about these licenses and many more are on the GNU
licensing web pages,
-<a
href="https://www.gnu.org/licenses/license-list.html";>https://www.gnu.org/licenses/license-list.html</a>.
+<a class="url"
href="https://www.gnu.org/licenses/license-list.html";>https://www.gnu.org/licenses/license-list.html</a>.
</p>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<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>
+Next: <a href="_002d_002dhelp.html"><samp class="option">--help</samp></a>,
Up: <a href="Command_002dLine-Interfaces.html">Standards for Command Line
Interfaces</a> [<a href="index.html#SEC_Contents" title="Table of
contents" rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
Index: html_node/index.html
===================================================================
RCS file: /web/www/www/prep/standards/html_node/index.html,v
retrieving revision 1.84
retrieving revision 1.85
diff -u -b -r1.84 -r1.85
--- html_node/index.html 8 Jul 2021 18:18:43 -0000 1.84
+++ html_node/index.html 29 May 2024 18:09:31 -0000 1.85
@@ -1,8 +1,11 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!DOCTYPE html>
<html>
-<!-- The GNU coding standards, last updated July 1, 2021.
+<!-- Created by GNU Texinfo 7.1dev, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<!-- The GNU coding standards, last updated May 26, 2024.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Free
Software Foundation, Inc.
@@ -13,9 +16,6 @@
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". -->
-<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Top (GNU Coding Standards)</title>
<meta name="description" content="Top (GNU Coding Standards)">
@@ -23,36 +23,18 @@
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+
<link href="#Top" rel="start" title="Top">
-<link href="Index.html#Index" rel="index" title="Index">
+<link href="Index.html" rel="index" title="Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="/manual" rel="up" title="(dir)">
-<link href="Preface.html#Preface" rel="next" title="Preface">
+<link href="Preface.html" rel="next" title="Preface">
<style type="text/css">
<!--
-a.summary-letter {text-decoration: none}
-blockquote.indentedblock {margin-right: 0em}
-blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
-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}
-kbd {font-style: oblique}
-pre.display {font-family: inherit}
-pre.format {font-family: inherit}
-pre.menu-comment {font-family: serif}
-pre.menu-preformatted {font-family: serif}
-pre.smalldisplay {font-family: inherit; font-size: smaller}
-pre.smallexample {font-size: smaller}
-pre.smallformat {font-family: inherit; font-size: smaller}
-pre.smalllisp {font-size: smaller}
-span.nolinebreak {white-space: nowrap}
-span.roman {font-family: initial; font-weight: normal}
-span.sansserif {font-family: sans-serif; font-weight: normal}
-ul.no-bullet {list-style: none}
+a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
+span:hover a.copiable-link {visibility: visible}
+ul.toc-numbered-mark {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="/software/gnulib/manual.css">
@@ -61,7 +43,6 @@
</head>
<body lang="en">
-<h1 class="settitle" align="center">GNU Coding Standards</h1>
@@ -69,113 +50,16 @@
-<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.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-Finding-the-Program_0027s-Executable-and-Associated-Files"
href="Finding-Program-Files.html#Finding-Program-Files">4.6 Finding the
Program’s Executable and Associated Files</a></li>
- <li><a name="toc-Standards-for-Graphical-Interfaces"
href="Graphical-Interfaces.html#Graphical-Interfaces">4.7 Standards for
Graphical Interfaces</a></li>
- <li><a name="toc-Standards-for-Command-Line-Interfaces"
href="Command_002dLine-Interfaces.html#Command_002dLine-Interfaces">4.8
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.8.1
<samp>--version</samp></a></li>
- <li><a name="toc-_002d_002dhelp-1"
href="_002d_002dhelp.html#g_t_002d_002dhelp">4.8.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.9
Standards for Dynamic Plug-in Interfaces</a></li>
- <li><a name="toc-Table-of-Long-Options"
href="Option-Table.html#Option-Table">4.10 Table of Long Options</a></li>
- <li><a name="toc-OID-Allocations-1"
href="OID-Allocations.html#OID-Allocations">4.11 OID Allocations</a></li>
- <li><a name="toc-Memory-Usage-1"
href="Memory-Usage.html#Memory-Usage">4.12 Memory Usage</a></li>
- <li><a name="toc-File-Usage-1" href="File-Usage.html#File-Usage">4.13 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
CPUs</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-and-Conventions"
href="Change-Log-Concepts.html#Change-Log-Concepts">6.8.1 Change Log Concepts
and Conventions</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>
-
-<a name="Top"></a>
-<div class="header">
+<div class="top-level-extent" id="Top">
+<div class="nav-panel">
<p>
-Next: <a href="Preface.html#Preface" accesskey="n" rel="next">Preface</a>, Up:
<a href="/manual" 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>
+Next: <a href="Preface.html" accesskey="n" rel="next">About the GNU Coding
Standards</a>, Up: <a href="/manual" accesskey="u" rel="up">(dir)</a>
[<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
<hr>
-<a name="GNU-Coding-Standards"></a>
-<h1 class="top">GNU Coding Standards</h1>
+<h1 class="top" id="GNU-Coding-Standards"><span>GNU Coding Standards<a
class="copiable-link" href="#GNU-Coding-Standards"> ¶</a></span></h1>
-<p>The GNU coding standards, last updated July 1, 2021.
+<p>The GNU coding standards, last updated May 26, 2024.
</p>
<p>Copyright © 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
@@ -190,35 +74,107 @@
“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">
+<div class="region-contents" id="SEC_Contents">
+<h2 class="contents-heading">Table of Contents</h2>
-</pre></th></tr></table>
+<div class="contents">
+<ul class="toc-numbered-mark">
+ <li><a id="toc-About-the-GNU-Coding-Standards" href="Preface.html">1 About
the GNU Coding Standards</a></li>
+ <li><a id="toc-Keeping-Free-Software-Free" href="Legal-Issues.html">2
Keeping Free Software Free</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Referring-to-Proprietary-Programs"
href="Reading-Non_002dFree-Code.html">2.1 Referring to Proprietary
Programs</a></li>
+ <li><a id="toc-Accepting-Contributions" href="Contributions.html">2.2
Accepting Contributions</a></li>
+ <li><a id="toc-Trademarks" href="Trademarks.html">2.3 Trademarks</a></li>
+ </ul></li>
+ <li><a id="toc-General-Program-Design" href="Design-Advice.html">3 General
Program Design</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Which-Languages-to-Use" href="Source-Language.html">3.1
Which Languages to Use</a></li>
+ <li><a id="toc-Compatibility-with-Other-Implementations"
href="Compatibility.html">3.2 Compatibility with Other Implementations</a></li>
+ <li><a id="toc-Using-Non_002dstandard-Features"
href="Using-Extensions.html">3.3 Using Non-standard Features</a></li>
+ <li><a id="toc-Standard-C-and-Pre_002dStandard-C"
href="Standard-C.html">3.4 Standard C and Pre-Standard C</a></li>
+ <li><a id="toc-Conditional-Compilation"
href="Conditional-Compilation.html">3.5 Conditional Compilation</a></li>
+ </ul></li>
+ <li><a id="toc-Program-Behavior-for-All-Programs"
href="Program-Behavior.html">4 Program Behavior for All Programs</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Non_002dGNU-Standards"
href="Non_002dGNU-Standards.html">4.1 Non-GNU Standards</a></li>
+ <li><a id="toc-Writing-Robust-Programs" href="Semantics.html">4.2 Writing
Robust Programs</a></li>
+ <li><a id="toc-Library-Behavior" href="Libraries.html">4.3 Library
Behavior</a></li>
+ <li><a id="toc-Formatting-Error-Messages" href="Errors.html">4.4
Formatting Error Messages</a></li>
+ <li><a id="toc-Standards-for-Interfaces-Generally"
href="User-Interfaces.html">4.5 Standards for Interfaces Generally</a></li>
+ <li><a id="toc-Finding-the-Program_0027s-Executable-and-Associated-Files"
href="Finding-Program-Files.html">4.6 Finding the Program’s Executable
and Associated Files</a></li>
+ <li><a id="toc-Standards-for-Graphical-Interfaces"
href="Graphical-Interfaces.html">4.7 Standards for Graphical Interfaces</a></li>
+ <li><a id="toc-Standards-for-Command-Line-Interfaces"
href="Command_002dLine-Interfaces.html">4.8 Standards for Command Line
Interfaces</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-_002d_002dversion" href="_002d_002dversion.html">4.8.1
<samp class="option">--version</samp></a></li>
+ <li><a id="toc-_002d_002dhelp" href="_002d_002dhelp.html">4.8.2 <samp
class="option">--help</samp></a></li>
+ </ul></li>
+ <li><a id="toc-Standards-for-Dynamic-Plug_002din-Interfaces"
href="Dynamic-Plug_002dIn-Interfaces.html">4.9 Standards for Dynamic Plug-in
Interfaces</a></li>
+ <li><a id="toc-Table-of-Long-Options" href="Option-Table.html">4.10 Table
of Long Options</a></li>
+ <li><a id="toc-OID-Allocations" href="OID-Allocations.html">4.11 OID
Allocations</a></li>
+ <li><a id="toc-Memory-Usage" href="Memory-Usage.html">4.12 Memory
Usage</a></li>
+ <li><a id="toc-File-Usage" href="File-Usage.html">4.13 File Usage</a></li>
+ </ul></li>
+ <li><a id="toc-Making-The-Best-Use-of-C" href="Writing-C.html">5 Making The
Best Use of C</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Formatting-Your-Source-Code" href="Formatting.html">5.1
Formatting Your Source Code</a></li>
+ <li><a id="toc-Commenting-Your-Work" href="Comments.html">5.2 Commenting
Your Work</a></li>
+ <li><a id="toc-Clean-Use-of-C-Constructs"
href="Syntactic-Conventions.html">5.3 Clean Use of C Constructs</a></li>
+ <li><a id="toc-Naming-Variables_002c-Functions_002c-and-Files"
href="Names.html">5.4 Naming Variables, Functions, and Files</a></li>
+ <li><a id="toc-Portability-between-System-Types"
href="System-Portability.html">5.5 Portability between System Types</a></li>
+ <li><a id="toc-Portability-between-CPUs" href="CPU-Portability.html">5.6
Portability between CPUs</a></li>
+ <li><a id="toc-Calling-System-Functions" href="System-Functions.html">5.7
Calling System Functions</a></li>
+ <li><a id="toc-Internationalization" href="Internationalization.html">5.8
Internationalization</a></li>
+ <li><a id="toc-Character-Set" href="Character-Set.html">5.9 Character
Set</a></li>
+ <li><a id="toc-Quote-Characters" href="Quote-Characters.html">5.10 Quote
Characters</a></li>
+ <li><a id="toc-Mmap" href="Mmap.html">5.11 Mmap</a></li>
+ </ul></li>
+ <li><a id="toc-Documenting-Programs" href="Documentation.html">6 Documenting
Programs</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-GNU-Manuals" href="GNU-Manuals.html">6.1 GNU
Manuals</a></li>
+ <li><a id="toc-Doc-Strings-and-Manuals"
href="Doc-Strings-and-Manuals.html">6.2 Doc Strings and Manuals</a></li>
+ <li><a id="toc-Manual-Structure-Details"
href="Manual-Structure-Details.html">6.3 Manual Structure Details</a></li>
+ <li><a id="toc-License-for-Manuals" href="License-for-Manuals.html">6.4
License for Manuals</a></li>
+ <li><a id="toc-Manual-Credits" href="Manual-Credits.html">6.5 Manual
Credits</a></li>
+ <li><a id="toc-Printed-Manuals" href="Printed-Manuals.html">6.6 Printed
Manuals</a></li>
+ <li><a id="toc-The-NEWS-File" href="NEWS-File.html">6.7 The NEWS
File</a></li>
+ <li><a id="toc-Change-Logs" href="Change-Logs.html">6.8 Change Logs</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-Change-Log-Concepts-and-Conventions"
href="Change-Log-Concepts.html">6.8.1 Change Log Concepts and
Conventions</a></li>
+ <li><a id="toc-Style-of-Change-Logs"
href="Style-of-Change-Logs.html">6.8.2 Style of Change Logs</a></li>
+ <li><a id="toc-Simple-Changes" href="Simple-Changes.html">6.8.3 Simple
Changes</a></li>
+ <li><a id="toc-Conditional-Changes"
href="Conditional-Changes.html">6.8.4 Conditional Changes</a></li>
+ <li><a id="toc-Indicating-the-Part-Changed"
href="Indicating-the-Part-Changed.html">6.8.5 Indicating the Part
Changed</a></li>
+ </ul></li>
+ <li><a id="toc-Man-Pages" href="Man-Pages.html">6.9 Man Pages</a></li>
+ <li><a id="toc-Reading-other-Manuals"
href="Reading-other-Manuals.html">6.10 Reading other Manuals</a></li>
+ </ul></li>
+ <li><a id="toc-The-Release-Process" href="Managing-Releases.html">7 The
Release Process</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-How-Configuration-Should-Work"
href="Configuration.html">7.1 How Configuration Should Work</a></li>
+ <li><a id="toc-Makefile-Conventions" href="Makefile-Conventions.html">7.2
Makefile Conventions</a>
+ <ul class="toc-numbered-mark">
+ <li><a id="toc-General-Conventions-for-Makefiles"
href="Makefile-Basics.html">7.2.1 General Conventions for Makefiles</a></li>
+ <li><a id="toc-Utilities-in-Makefiles"
href="Utilities-in-Makefiles.html">7.2.2 Utilities in Makefiles</a></li>
+ <li><a id="toc-Variables-for-Specifying-Commands"
href="Command-Variables.html">7.2.3 Variables for Specifying Commands</a></li>
+ <li><a id="toc-DESTDIR_003a-Support-for-Staged-Installs"
href="DESTDIR.html">7.2.4 <code class="code">DESTDIR</code>: Support for Staged
Installs</a></li>
+ <li><a id="toc-Variables-for-Installation-Directories"
href="Directory-Variables.html">7.2.5 Variables for Installation
Directories</a></li>
+ <li><a id="toc-Standard-Targets-for-Users"
href="Standard-Targets.html">7.2.6 Standard Targets for Users</a></li>
+ <li><a id="toc-Install-Command-Categories"
href="Install-Command-Categories.html">7.2.7 Install Command Categories</a></li>
+ </ul></li>
+ <li><a id="toc-Making-Releases" href="Releases.html">7.3 Making
Releases</a></li>
+ </ul></li>
+ <li><a id="toc-References-to-Non_002dFree-Software-and-Documentation"
href="References.html">8 References to Non-Free Software and
Documentation</a></li>
+ <li><a id="toc-GNU-Free-Documentation-License"
href="GNU-Free-Documentation-License.html">Appendix A GNU Free Documentation
License</a></li>
+ <li><a id="toc-Index" href="Index.html" rel="index">Index</a></li>
+</ul>
+</div>
+</div>
+</div>
<hr>
-<div class="header">
+<div class="nav-panel">
<p>
-Next: <a href="Preface.html#Preface" accesskey="n" rel="next">Preface</a>, Up:
<a href="/manual" 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>
+Next: <a href="Preface.html" accesskey="n" rel="next">About the GNU Coding
Standards</a> [<a href="#SEC_Contents" title="Table of contents"
rel="contents">Contents</a>][<a href="Index.html" title="Index"
rel="index">Index</a>]</p>
</div>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- www/prep/standards index.html standards.dvi.gz ...,
Alfred M. Szmidt <=