summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJimmy Aguilar Mena <spacibba@aol.com>2019-04-02 22:52:41 +0200
committerJimmy Aguilar Mena <spacibba@aol.com>2019-05-03 23:34:29 +0200
commit9afef8b2833b0b1021b08acca2168aa47ed7aad2 (patch)
tree6f26911309cad24982e10134a0e08dc5b825dc9a
parentdd9a96f75740b027a04047e2c5a28fda04eb00ce (diff)
downloademacs-9afef8b2833b0b1021b08acca2168aa47ed7aad2.tar.gz
Added fill-column-indicator manual documentation
*etc/NEWS: reduced the comments about fill-column-indicator *doc/emacs/display.texi: Added documentation for fill-column-indicator in this section in the manual
-rw-r--r--doc/emacs/display.texi45
-rw-r--r--etc/NEWS12
2 files changed, 47 insertions, 10 deletions
diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index f464a3a59f0..62a4b62cfca 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -1141,6 +1141,51 @@ right-to-left paragraphs.
@node Displaying Boundaries
@section Displaying Boundaries
+@cindex mode, fill-column-indicator
+@findex display-fill-column-indicator-mode
+@findex global-display-fill-column-indicator-mode
+ Emacs can add an indicator to display a fill column position. The
+fill column indicator is a useful functionality specially in
+prog-mode to indicate the position of an specific column.
+
+ You can set the buffer-local variables @code{display-fill-column-indicator}
+and @code{display-fill-column-indicator-character} to activate the
+indicator and controls how the indicator looks.
+
+Alternatively you can type @kbd{M-x display-fill-column-indicator-mode} or
+@kbd{M-x global-display-fill-column-indicator-mode} which enables the indicator
+locally and globally respectively and also chooses the character to
+use if none is set. It is possible to use the first one to activate the
+indicator in a hook or the second one to enable it globally.
+
+There are 2 new buffer local variables and 1 face to customize this
+mode:
+
+@table @code
+@item display-fill-column-indicator-column
+@vindex display-fill-column-indicator-column
+Is the column number where the indicator should be set. It can take
+positive numerical values for the column or the special value t which
+means that the variable 'fill-column' will be used.
+
+Any other value disables the indicator. The default value is t.
+
+@item display-fill-column-indicator-char
+@vindex display-fill-column-indicator-char
+Is the character used for the indicator. This character can be any
+valid char including unicode ones if the actual font supports them.
+
+When the mode is enabled throw the functions
+@code{display-fill-column-indicator-mode} or
+@code{global-display-fill-column-indicator-mode}, the initialization
+functions check if this variable is non-nil, otherwise the
+initialization tries to set it to U+2502 or '|'.
+
+@item fill-column-face
+Is the face used to display the indicator it inherits its default
+values from shadow and the default face.
+@end table
+
@vindex indicate-buffer-boundaries
On graphical displays, Emacs can indicate the buffer boundaries in
the fringes. If you enable this feature, the first line and the last
diff --git a/etc/NEWS b/etc/NEWS
index e2eed9b4192..444c059f05e 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -343,21 +343,13 @@ Emacs configured with Cairo drawing and linked with cairo >= 1.16.0.
---
** Emacs now optionally displays a fill column indicator.
-The fill column indicator is a usefull functionality specially in
-prog-mode to indicate the position of a specific column. This is
-similar to what 'fill-column-indicator' package provides, but much
-faster and compatible with show-trailing-whitespace.
+This is similar to what 'fill-column-indicator' package provides, but
+much faster and compatible with show-trailing-whitespace.
Customize the buffer-local variables 'display-fill-column-indicator'
and 'display-fill-column-indicator-character' to activate the
indicator.
-Alternatively you can use the modes
-'display-fill-column-indicator-mode' or the global
-'global-display-fill-column-indicator-mode' which enables it locally
-and globally respectively and also chooses the character to use if no
-one is set.
-
The indicators is not displayed at all in minibuffer windows and
in tooltips, as it is not useful there.