diff options
Diffstat (limited to 'doc/groff.html.node/ms-Naming-Conventions.html')
| -rw-r--r-- | doc/groff.html.node/ms-Naming-Conventions.html | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/doc/groff.html.node/ms-Naming-Conventions.html b/doc/groff.html.node/ms-Naming-Conventions.html new file mode 100644 index 0000000..db31955 --- /dev/null +++ b/doc/groff.html.node/ms-Naming-Conventions.html @@ -0,0 +1,89 @@ +<!DOCTYPE html> +<html> +<!-- Created by GNU Texinfo 7.0.3, https://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<!-- This manual documents GNU troff version 1.23.0. + +Copyright © 1994-2023 Free Software Foundation, Inc. + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A +copy of the license is included in the section entitled "GNU Free +Documentation License". --> +<title>ms Naming Conventions (The GNU Troff Manual)</title> + +<meta name="description" content="ms Naming Conventions (The GNU Troff Manual)"> +<meta name="keywords" content="ms Naming Conventions (The GNU Troff Manual)"> +<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="index.html" rel="start" title="Top"> +<link href="Request-Index.html" rel="index" title="Request Index"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="ms.html" rel="up" title="ms"> +<link href="ms-Legacy-Features.html" rel="prev" title="ms Legacy Features"> +<style type="text/css"> +<!-- +ul.mark-bullet {list-style-type: disc} +--> +</style> + + +</head> + +<body lang="en"> +<div class="subsection-level-extent" id="ms-Naming-Conventions"> +<div class="nav-panel"> +<p> +Previous: <a href="ms-Legacy-Features.html" accesskey="p" rel="prev">Legacy Features</a>, Up: <a href="ms.html" accesskey="u" rel="up"><samp class="file">ms</samp></a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Request-Index.html" title="Index" rel="index">Index</a>]</p> +</div> +<hr> +<h4 class="subsection" id="Naming-Conventions">4.6.9 Naming Conventions</h4> +<a class="index-entry-id" id="index-ms-macros_002c-naming-conventions"></a> +<a class="index-entry-id" id="index-naming-conventions_002c-ms-macros"></a> + +<p>The following conventions are used for names of macros, strings, and +registers. External names available to documents that use the +<code class="code">groff</code> <samp class="file">ms</samp> macros contain only uppercase letters and digits. +</p> +<p>Internally, the macros are divided into modules. Conventions for +identifier names are as follows. +</p> +<ul class="itemize mark-bullet"> +<li>Names used only within one module are of the form +<var class="var">module</var><code class="code">*</code><var class="var">name</var>. + +</li><li>Names used outside the module in which they are defined are of the form +<var class="var">module</var><code class="code">@</code><var class="var">name</var>. + +</li><li>Names associated with a particular environment are of the form +<var class="var">environment</var><code class="code">:</code><var class="var">name</var>; these are used only within the +<code class="code">par</code> module. + +</li><li><var class="var">name</var> does not have a module prefix. + +</li><li>Constructed names used to implement arrays are of the form +<var class="var">array</var><code class="code">!</code><var class="var">index</var>. +</li></ul> + +<p>Thus the <code class="code">groff</code> <samp class="file">ms</samp> macros reserve the following names. +</p> +<ul class="itemize mark-bullet"> +<li>Names containing the characters <code class="code">*</code>, <code class="code">@</code>, and <code class="code">:</code>. + +</li><li>Names containing only uppercase letters and digits. +</li></ul> + + + +</div> + + + +</body> +</html> |