/usr/share/doc/ne/html/Syntax-Highlighting.html is in ne-doc 2.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | <html lang="en">
<head>
<title>Syntax Highlighting - ne's manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="ne's manual">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Reference.html#Reference" title="Reference">
<link rel="prev" href="The-Requester.html#The-Requester" title="The Requester">
<link rel="next" href="Menus.html#Menus" title="Menus">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Syntax-Highlighting"></a>
<p>
Next: <a rel="next" accesskey="n" href="Menus.html#Menus">Menus</a>,
Previous: <a rel="previous" accesskey="p" href="The-Requester.html#The-Requester">The Requester</a>,
Up: <a rel="up" accesskey="u" href="Reference.html#Reference">Reference</a>
<hr>
</div>
<h3 class="section">3.6 Syntax Highlighting</h3>
<p><a name="index-Syntax-Highlighting-71"></a>
Syntax highlighting is particularly useful for programming language
text or other types of documents which have a strictly defined syntax.
Colors indicate different syntactic categories of text according to
the syntax definition in use.
<p>Syntax definitions are stored in separate files. <code>ne</code> comes with a
suite of syntax definitions for many popular programming languages.
When you load a file, <code>ne</code> selects the appropriate syntax
definition as determined by the filename extension in much the same way
autoprefs are loaded. It also contains a built-in table of common
filename extensions that share the same syntax definitions. For
example, both ‘<samp><span class="samp">cbl</span></samp>’, and ‘<samp><span class="samp">cob</span></samp>’ files use the ‘<samp><span class="samp">cobol</span></samp>’
definition. See the <a href="Syntax.html#Syntax">Syntax</a> command for the complete list of
built-in extension mappings.
<p>If there is no matching syntax definition for the filename extension,
or if the buffer you are editing has no filename yet, or you just want
to try a different syntax definition, you can load and use the
syntax definition of your choice with the <code>Syntax</code> command. It
takes the syntax name as a parameter. For example, the name “<code>c</code>”
works for C syntax files with extensions ‘<samp><span class="samp">.c</span></samp>’, ‘<samp><span class="samp">.h</span></samp>’,
‘<samp><span class="samp">c++</span></samp>’, etc. <code>ne</code> searches for the specified syntax definition
file in the ‘<samp><span class="samp">syntax</span></samp>’ subdirectory of your <samp><span class="file">~/.ne</span></samp> directory
first. If not found there, <code>ne</code> then looks in the ‘<samp><span class="samp">syntax</span></samp>’
subdirectory of <code>ne</code>'s global directory for the syntax definition
file. See <a href="Arguments.html#Arguments">Arguments</a>.
<p>With no parameter, the <code>Syntax</code> command prompts you for a syntax
to load, the offered default being the currently loaded syntax if there is one.
<p>One syntax definition you may find useful for any type of text file is
called simply ‘<samp><span class="samp">tabs</span></samp>’. It highlights the <span class="sc">tab</span>s in your text so
you can distinguish them from regular spaces.
<p>You can create your own syntax definitions and store them in your
<samp><span class="file">~/.ne/syntax</span></samp> directory (actually, modifying the colors of an
existing definition is much easier; see <a href="Hints-and-Tricks.html#Hints-and-Tricks">Hints and Tricks</a>). A complete
explanation of syntax specifications is beyond the scope of this document,
but the existing definition files should prove to be useful examples. In
particular, the <samp><span class="file">syntax/c.jsf</span></samp> file contains some particularly
helpful comments. Syntax definition files have a ‘<samp><span class="samp">.jsf</span></samp>’ extension. Do
not include that extension when using the <code>Syntax</code> command.
<p>Syntax highlighting does incur a slight penalty in memory used per line of
text, and it also consumes some CPU resources. For small to medium sized
files you'll probably never notice. But for extremely large files—on
the order of the size of your system's RAM—the difference could be
significant. If you invoke <code>ne</code> with the <code>--no-syntax</code>
parameter, <code>ne</code> will disable the syntax highlighting mechanism
entirely, freeing up the memory and CPU otherwise consumed. (Note that
if you are that tight on memory, you may need to disable the undo
buffer as well. See <a href="DoUndo.html#DoUndo">DoUndo</a>.)
<p><code>ne</code> uses code from another editor—the GPL-licensed
<code>joe</code>—for its syntax highlighting capabilities. Because of this fact, the
syntax definition files are identical, even to the ‘<samp><span class="samp">.jsf</span></samp>’
extension, which is an acronym for “Joe's Syntax File”. It's possible
that if both <code>joe</code> and <code>ne</code> are installed on your system that
they share the same syntax file directory.
</body></html>
|