Function: whitespace-toggle-options

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

Signature

(whitespace-toggle-options ARG)

Documentation

Toggle local whitespace-mode(var)/whitespace-mode(fun) options.

If local whitespace-mode is off, toggle the option given by ARG and turn on local whitespace-mode.

If local whitespace-mode is on, toggle the option given by ARG and restart local whitespace-mode.

Interactively, it reads one of the following chars:

  CHAR MEANING
  (VIA FACES)
   f toggle face visualization
   t toggle TAB visualization
   s toggle SPACE and HARD SPACE visualization
   r toggle trailing blanks visualization
   l toggle "long lines" visualization
   L toggle "long lines" tail visualization
   n toggle NEWLINE visualization
   e toggle empty line at bob and/or eob visualization
   C-i toggle indentation SPACEs visualization (via indent-tabs-mode)
   I toggle indentation SPACEs visualization
   i toggle indentation TABs visualization
   C-t toggle big indentation visualization
   C-a toggle SPACEs after TAB visualization (via indent-tabs-mode)
   A toggle SPACEs after TAB: SPACEs visualization
   a toggle SPACEs after TAB: TABs visualization
   C-b toggle SPACEs before TAB visualization (via indent-tabs-mode)
   B toggle SPACEs before TAB: SPACEs visualization
   b toggle SPACEs before TAB: TABs visualization

  (VIA DISPLAY TABLE)
   T toggle TAB visualization
   S toggle SPACEs before TAB visualization
   N toggle NEWLINE visualization

   x restore whitespace-style value
   ? display brief help

Non-interactively, ARG should be a symbol or a list of symbols. The valid symbols are:

   face toggle face visualization
   tabs toggle TAB visualization
   spaces toggle SPACE and HARD SPACE visualization
   trailing toggle trailing blanks visualization
   lines toggle "long lines" visualization
   lines-tail toggle "long lines" tail visualization
   newline toggle NEWLINE visualization
   empty toggle empty line at bob and/or eob visualization
   indentation toggle indentation SPACEs visualization
   indentation::tab toggle indentation SPACEs visualization
   indentation::space toggle indentation TABs visualization
   big-indent toggle big indentation visualization
   space-after-tab toggle SPACEs after TAB visualization
   space-after-tab::tab toggle SPACEs after TAB: SPACEs visualization
   space-after-tab::space toggle SPACEs after TAB: TABs visualization
   space-before-tab toggle SPACEs before TAB visualization
   space-before-tab::tab toggle SPACEs before TAB: SPACEs visualization
   space-before-tab::space toggle SPACEs before TAB: TABs visualization

   tab-mark toggle TAB visualization
   space-mark toggle SPACEs before TAB visualization
   newline-mark toggle NEWLINE visualization

   whitespace-style restore whitespace-style value

See whitespace-style and indent-tabs-mode(var)/indent-tabs-mode(fun) for documentation.

View in manual

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/whitespace.el.gz
;;;###autoload
(defun whitespace-toggle-options (arg)
  "Toggle local `whitespace-mode' options.

If local whitespace-mode is off, toggle the option given by ARG
and turn on local whitespace-mode.

If local whitespace-mode is on, toggle the option given by ARG
and restart local whitespace-mode.

Interactively, it reads one of the following chars:

  CHAR	MEANING
  (VIA FACES)
   f	toggle face visualization
   t	toggle TAB visualization
   s	toggle SPACE and HARD SPACE visualization
   r	toggle trailing blanks visualization
   l	toggle \"long lines\" visualization
   L	toggle \"long lines\" tail visualization
   n	toggle NEWLINE visualization
   e	toggle empty line at bob and/or eob visualization
   C-i	toggle indentation SPACEs visualization (via `indent-tabs-mode')
   I	toggle indentation SPACEs visualization
   i	toggle indentation TABs visualization
   C-t	toggle big indentation visualization
   C-a	toggle SPACEs after TAB visualization (via `indent-tabs-mode')
   A	toggle SPACEs after TAB: SPACEs visualization
   a	toggle SPACEs after TAB: TABs visualization
   C-b	toggle SPACEs before TAB visualization (via `indent-tabs-mode')
   B	toggle SPACEs before TAB: SPACEs visualization
   b	toggle SPACEs before TAB: TABs visualization

  (VIA DISPLAY TABLE)
   T	toggle TAB visualization
   S	toggle SPACEs before TAB visualization
   N	toggle NEWLINE visualization

   x	restore `whitespace-style' value
   ?	display brief help

Non-interactively, ARG should be a symbol or a list of symbols.
The valid symbols are:

   face			toggle face visualization
   tabs			toggle TAB visualization
   spaces		toggle SPACE and HARD SPACE visualization
   trailing		toggle trailing blanks visualization
   lines		toggle \"long lines\" visualization
   lines-tail		toggle \"long lines\" tail visualization
   newline		toggle NEWLINE visualization
   empty		toggle empty line at bob and/or eob visualization
   indentation		toggle indentation SPACEs visualization
   indentation::tab	toggle indentation SPACEs visualization
   indentation::space	toggle indentation TABs visualization
   big-indent		toggle big indentation visualization
   space-after-tab		toggle SPACEs after TAB visualization
   space-after-tab::tab		toggle SPACEs after TAB: SPACEs visualization
   space-after-tab::space	toggle SPACEs after TAB: TABs visualization
   space-before-tab		toggle SPACEs before TAB visualization
   space-before-tab::tab	toggle SPACEs before TAB: SPACEs visualization
   space-before-tab::space	toggle SPACEs before TAB: TABs visualization

   tab-mark		toggle TAB visualization
   space-mark		toggle SPACEs before TAB visualization
   newline-mark		toggle NEWLINE visualization

   whitespace-style	restore `whitespace-style' value

See `whitespace-style' and `indent-tabs-mode' for documentation."
  (interactive (whitespace-interactive-char t))
  (let ((whitespace-style
	 (whitespace-toggle-list t arg whitespace-active-style)))
    (whitespace-mode 0)
    (whitespace-mode 1)))