Variable: recentf-auto-cleanup

recentf-auto-cleanup is a customizable variable defined in recentf.el.gz.

Value

mode

Documentation

Define when to automatically cleanup the recent list.

That is, remove duplicates, non-kept, and excluded files.

The following values can be set:

- mode
    Cleanup when turning the mode on (default).
- never
    Never cleanup the list automatically.
- A number
    Cleanup each time Emacs has been idle that number of seconds.
- A time string
    Cleanup at specified time string daily, for example at "11:00pm".

If a time string is provided and it is already past the specified time for the current day, the first cleanup happens immediately as for mode.

Setting this variable directly does not take effect; use M-x customize (customize).

See also the command recentf-cleanup, that can be used to manually cleanup the list.

Probably introduced at or before Emacs version 22.1.

Source Code

;; Defined in /usr/src/emacs/lisp/recentf.el.gz
(defcustom recentf-auto-cleanup 'mode
  "Define when to automatically cleanup the recent list.
That is, remove duplicates, non-kept, and excluded files.

The following values can be set:

- `mode'
    Cleanup when turning the mode on (default).
- `never'
    Never cleanup the list automatically.
- A number
    Cleanup each time Emacs has been idle that number of seconds.
- A time string
    Cleanup at specified time string daily, for example at \"11:00pm\".

If a time string is provided and it is already past the specified time
for the current day, the first cleanup happens immediately as for `mode'.

Setting this variable directly does not take effect;
use \\[customize].

See also the command `recentf-cleanup', that can be used to manually
cleanup the list."
  :group 'recentf
  :type '(radio (const  :tag "When mode enabled"
                        :value mode)
                (const  :tag "Never"
                        :value never)
                (number :tag "When idle after (seconds)"
                        :value 300)
                (string :tag "At time"
                        :value "11:00pm"))
  :set (lambda (variable value)
         (set-default variable value)
         (when (featurep 'recentf)
           ;; Unavailable until recentf has been loaded.
           (recentf-auto-cleanup))))