Commit cedf175b authored by Eli Zaretskii's avatar Eli Zaretskii
Browse files

(Highlight Interactively): Include global-hi-lock-mode. Add miscellaneous

details and elaborations.
parent 71060bdd
...@@ -389,35 +389,48 @@ group @samp{jit-lock}. @xref{Specific Customization}. ...@@ -389,35 +389,48 @@ group @samp{jit-lock}. @xref{Specific Customization}.
@cindex highlighting by matching @cindex highlighting by matching
@cindex interactive highlighting @cindex interactive highlighting
It is sometimes useful to highlight the strings that match a certain It is sometimes useful to temporarily highlight text that
regular expression. For example, you might wish to see all the matches a certain regular expression. For example, you might wish to
references to a certain variable in a program source file, or highlight see all the references to a certain variable in a program source file,
certain parts in a voluminous output of some program, or make certain highlight certain parts in a voluminous output of some program, or
cliches stand out in an article. make certain names stand out in an article.
@findex hi-lock-mode @findex hi-lock-mode
Use the @kbd{M-x hi-lock-mode} command to turn on a minor mode that Use the @kbd{M-x hi-lock-mode} command to turn on a minor mode that
allows you to specify regular expressions of the text to be allows you to interactively add and remove regular expressions
highlighted. Hi-lock mode works like Font Lock (@pxref{Font Lock}), specifying text to be highlighted. Hi Lock mode works like Font Lock
except that it lets you specify explicitly what parts of text to mode (@pxref{Font Lock}), except that it lets you easily add and
highlight. You control Hi-lock mode with these commands: remove regular expressions while you are editing a buffer. To enable
Hi Lock mode for all buffers use @kbd{M-x global-hi-lock-mode} or
place @code{(global-hi-lock-mode 1)} in your @file{.emacs} file.
You control Hi Lock mode with these commands:
@table @kbd @table @kbd
@item C-x w h @var{regexp} @key{RET} @var{face} @key{RET} @item C-x w h @var{regexp} @key{RET} @var{face} @key{RET}
@kindex C-x w h @kindex C-x w h
@findex highlight-regexp @findex highlight-regexp
Highlight text that matches Highlight text that matches @var{regexp} using face @var{face}
@var{regexp} using face @var{face} (@code{highlight-regexp}). (@code{highlight-regexp}). By using this command more than once, you
By using this command more than once, you can highlight various can highlight various parts of the text in different ways. The
parts of the text in different ways. highlighting will remain as long as the buffer is loaded. For
example, to highlight all occurrences of the word ``whim'' using the
default face (a yellow background) @kbd{C-x w h whim @key{RET}
@key{RET}}. Any face can be used for highlighting, Hi Lock provides
several of its own and these are pre-loaded into a history list. While
being prompted for a face use @kbd{C-p} and @kbd{C-n} to cycle through
them.
@item C-x w r @var{regexp} @key{RET} @item C-x w r @var{regexp} @key{RET}
@kindex C-x w r @kindex C-x w r
@findex unhighlight-regexp @findex unhighlight-regexp
Unhighlight @var{regexp} (@code{unhighlight-regexp}). You must enter Unhighlight @var{regexp} (@code{unhighlight-regexp}).
one of the regular expressions currently specified for highlighting. When activated from the menu select the expression to unhighlight from
(You can use completion, or choose from a menu, to enter one of them a list. When activated from the keyboard the most recently added
conveniently.) expression will be shown. Use @kbd{C-p} to show the next older
expression and @kbd{C-n} to select the next newer expression. When
the expression to unhighlight appears press @kbd{@key{RET}} to unhighlight
it. The expression can also be typed and completion is available.
@item C-x w l @var{regexp} @key{RET} @var{face} @key{RET} @item C-x w l @var{regexp} @key{RET} @var{face} @key{RET}
@kindex C-x w l @kindex C-x w l
...@@ -436,7 +449,7 @@ program. This key binding runs the ...@@ -436,7 +449,7 @@ program. This key binding runs the
@code{hi-lock-write-interactive-patterns} command. @code{hi-lock-write-interactive-patterns} command.
These patterns will be read the next time you visit the file while These patterns will be read the next time you visit the file while
Hi-lock mode is enabled, or whenever you use the @kbd{M-x Hi Lock mode is enabled, or whenever you use the @kbd{M-x
hi-lock-find-patterns} command. hi-lock-find-patterns} command.
@item C-x w i @item C-x w i
...@@ -444,8 +457,14 @@ hi-lock-find-patterns} command. ...@@ -444,8 +457,14 @@ hi-lock-find-patterns} command.
@findex hi-lock-find-patterns @findex hi-lock-find-patterns
@vindex hi-lock-exclude-modes @vindex hi-lock-exclude-modes
Re-read regexp/face pairs in the current buffer Re-read regexp/face pairs in the current buffer
(@code{hi-lock-write-interactive-patterns}). The list of pairs is (@code{hi-lock-write-interactive-patterns}). Users familiar with Font
found no matter where in the buffer it may be. Lock keywords might interactively enter patterns
(@code{highlight-regexp}), write them into the file
(@code{hi-lock-write-interactive-patterns}), edit them, perhaps
including different faces for different parenthesized parts of the
match, and finally use this command
(@code{hi-lock-write-interactive-patterns}) to have Hi Lock highlight
them.
This command does nothing if the major mode is a member of the list This command does nothing if the major mode is a member of the list
@code{hi-lock-exclude-modes}. @code{hi-lock-exclude-modes}.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment