aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJimmy Aguilar Mena2019-04-02 22:52:41 +0200
committerJimmy Aguilar Mena2019-05-05 16:27:37 +0200
commitc7ff15c6eb8412020ff527d847abdd4004dba0c4 (patch)
treeaee6f8f664d107852798512edf27dfa957f1bf53 /doc
parentc34f00b58cfb23dbd19b349cb2f24056ff8149ad (diff)
downloademacs-c7ff15c6eb8412020ff527d847abdd4004dba0c4.tar.gz
emacs-c7ff15c6eb8412020ff527d847abdd4004dba0c4.zip
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
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/display.texi45
1 files changed, 45 insertions, 0 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.
1141@node Displaying Boundaries 1141@node Displaying Boundaries
1142@section Displaying Boundaries 1142@section Displaying Boundaries
1143 1143
1144@cindex mode, fill-column-indicator
1145@findex display-fill-column-indicator-mode
1146@findex global-display-fill-column-indicator-mode
1147 Emacs can add an indicator to display a fill column position. The
1148fill column indicator is a useful functionality specially in
1149prog-mode to indicate the position of an specific column.
1150
1151 You can set the buffer-local variables @code{display-fill-column-indicator}
1152and @code{display-fill-column-indicator-character} to activate the
1153indicator and controls how the indicator looks.
1154
1155Alternatively you can type @kbd{M-x display-fill-column-indicator-mode} or
1156@kbd{M-x global-display-fill-column-indicator-mode} which enables the indicator
1157locally and globally respectively and also chooses the character to
1158use if none is set. It is possible to use the first one to activate the
1159indicator in a hook or the second one to enable it globally.
1160
1161There are 2 new buffer local variables and 1 face to customize this
1162mode:
1163
1164@table @code
1165@item display-fill-column-indicator-column
1166@vindex display-fill-column-indicator-column
1167Is the column number where the indicator should be set. It can take
1168positive numerical values for the column or the special value t which
1169means that the variable 'fill-column' will be used.
1170
1171Any other value disables the indicator. The default value is t.
1172
1173@item display-fill-column-indicator-char
1174@vindex display-fill-column-indicator-char
1175Is the character used for the indicator. This character can be any
1176valid char including unicode ones if the actual font supports them.
1177
1178When the mode is enabled throw the functions
1179@code{display-fill-column-indicator-mode} or
1180@code{global-display-fill-column-indicator-mode}, the initialization
1181functions check if this variable is non-nil, otherwise the
1182initialization tries to set it to U+2502 or '|'.
1183
1184@item fill-column-face
1185Is the face used to display the indicator it inherits its default
1186values from shadow and the default face.
1187@end table
1188
1144@vindex indicate-buffer-boundaries 1189@vindex indicate-buffer-boundaries
1145 On graphical displays, Emacs can indicate the buffer boundaries in 1190 On graphical displays, Emacs can indicate the buffer boundaries in
1146the fringes. If you enable this feature, the first line and the last 1191the fringes. If you enable this feature, the first line and the last