Function: whitespace-newline-mode

whitespace-newline-mode is an autoloaded, interactive and byte-compiled function defined in whitespace.el.gz.

Signature

(whitespace-newline-mode &optional ARG)

Documentation

Toggle newline visualization (Whitespace Newline mode).

This is a minor mode. If called interactively, toggle the Whitespace-Newline mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate whitespace-newline-mode(var)/whitespace-newline-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

Use whitespace-newline-mode(var)/whitespace-newline-mode(fun) only for NEWLINE visualization exclusively. For other visualizations, including NEWLINE visualization together with (HARD) SPACEs and/or TABs, please, use whitespace-mode(var)/whitespace-mode(fun).

See also whitespace-newline and whitespace-display-mappings.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/whitespace.el.gz
;;;###autoload
(define-minor-mode whitespace-newline-mode
  "Toggle newline visualization (Whitespace Newline mode).

Use `whitespace-newline-mode' only for NEWLINE visualization
exclusively.  For other visualizations, including NEWLINE
visualization together with (HARD) SPACEs and/or TABs, please,
use `whitespace-mode'.

See also `whitespace-newline' and `whitespace-display-mappings'."
  :lighter    " nl"
  :init-value nil
  :global     nil
  :group      'whitespace
  (let ((whitespace-style '(face newline-mark newline)))
    (whitespace-mode (if whitespace-newline-mode
			 1 -1)))
  ;; sync states (running a batch job)
  (setq whitespace-newline-mode whitespace-mode))