visiting an outline.
When this is set you can disable allout widgets in select files
-by setting `allout-widgets-mode-inhibit'
+by setting `allout-widgets-mode-inhibit'.
Instead of setting `allout-widgets-auto-activation' you can
explicitly invoke `allout-widgets-mode' in allout buffers where
)
;;;_ > allout-current-decorated-p ()
(defun allout-current-decorated-p ()
- "True if the current item is not decorated"
+ "True if the current item is not decorated."
(save-excursion
(if (allout-back-to-current-heading)
(if (> allout-recent-depth 0)
(ssh "ssh" "22")
(sftp "sftp" "115")
(smtp "smtp" "25"))
- "List of authentication protocols and their names"
+ "List of authentication protocols and their names."
:version "23.2" ;; No Gnus
:type '(repeat :tag "Authentication Protocols"
If such a timer is active, cancel it. Start a new timer if
Global Auto-Revert Mode is active or if Auto-Revert Mode is active
in some buffer. Restarting the timer ensures that Auto-Revert Mode
-will use an up-to-date value of `auto-revert-interval'"
+will use an up-to-date value of `auto-revert-interval'."
(interactive)
(if (timerp auto-revert-timer)
(cancel-timer auto-revert-timer))
;;;###autoload (put 'battery-mode-line-string 'risky-local-variable t)
(defcustom battery-mode-line-limit 100
- "Percentage of full battery load below which display battery status"
+ "Percentage of full battery load below which display battery status."
:version "24.1"
:type 'integer
:group 'battery)
(defun math-map-binop (binop args1 args2)
- "Apply BINOP to the elements of the lists ARGS1 and ARGS2"
+ "Apply BINOP to the elements of the lists ARGS1 and ARGS2."
(if args1
(cons
(funcall binop (car args1) (car args2))
"Find the dates in YEAR on which daylight saving time starts and ends.
Returns a list (YEAR START END), where START and END are
expressions that when evaluated return the start and end dates,
-respectively. This function first attempts to use pre-calculated
+respectively. This function first attempts to use pre-calculated
data from `calendar-dst-transition-cache', otherwise it calls
`calendar-dst-find-data' (and adds the results to the cache).
If dates in YEAR cannot be handled by `encode-time' (e.g.,
(defun calendar-mayan-long-count-to-absolute (c)
"Compute the absolute date corresponding to the Mayan Long Count C.
-Long count is a list (baktun katun tun uinal kin)"
+Long count is a list (baktun katun tun uinal kin)."
(+ (* (nth 0 c) 144000) ; baktun
(* (nth 1 c) 7200) ; katun
(* (nth 2 c) 360) ; tun
(setq calendar-date-echo-text \\='(format \"ISO date: %s\"
(calendar-iso-date-string
(list month day year))))
+
Changing this variable without using customize has no effect on
pre-existing calendar windows."
:group 'calendar
(defun calendar-generate-month (month year indent)
"Produce a calendar for MONTH, YEAR on the Gregorian calendar.
-The calendar is inserted at the top of the buffer in which point is currently
-located, but indented INDENT spaces. The indentation is done from the first
-character on the line and does not disturb the first INDENT characters on the
-line."
+The calendar is inserted at the top of the buffer in which point is
+currently located, but indented INDENT spaces. The indentation is
+done from the first character on the line and does not disturb the
+first INDENT characters on the line."
(let ((blank-days ; at start of month
(mod
(- (calendar-day-of-week (list month 1 year))
(defun calendar-string-spread (strings char length)
"Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
-The effect is like `mapconcat' but the separating pieces are as balanced as
-possible. Each item of STRINGS is evaluated before concatenation so it can
-actually be an expression that evaluates to a string. If LENGTH is too short,
-the STRINGS are just concatenated and the result truncated."
+The effect is like `mapconcat' but the separating pieces are as
+balanced as possible. Each item of STRINGS is evaluated before
+concatenation so it can actually be an expression that evaluates
+to a string. If LENGTH is too short, the STRINGS are just
+concatenated and the result truncated."
;; The algorithm is based on equation (3.25) on page 85 of Concrete
;; Mathematics by Ronald L. Graham, Donald E. Knuth, and Oren Patashnik,
;; Addison-Wesley, Reading, MA, 1989.
(defun calendar-cursor-to-date (&optional error event)
"Return a list (month day year) of current cursor position.
-If cursor is not on a specific date, signals an error if optional parameter
-ERROR is non-nil, otherwise just returns nil.
+If cursor is not on a specific date, signals an error if optional
+parameter ERROR is non-nil, otherwise just returns nil.
If EVENT is non-nil, it's an event indicating the buffer position to
use instead of point."
(with-current-buffer
(defun calendar-read (prompt acceptable &optional initial-contents)
"Return an object read from the minibuffer.
-Prompt with the string PROMPT and use the function ACCEPTABLE to decide if
-entered item is acceptable. If non-nil, optional third arg INITIAL-CONTENTS
-is a string to insert in the minibuffer before reading."
+Prompt with the string PROMPT and use the function ACCEPTABLE to decide
+if entered item is acceptable. If non-nil, optional third arg
+INITIAL-CONTENTS is a string to insert in the minibuffer before reading."
(let ((value (read-minibuffer prompt initial-contents)))
(while (not (funcall acceptable value))
(setq value (read-minibuffer prompt initial-contents)))
(defun calendar-read-date (&optional noday)
"Prompt for Gregorian date. Return a list (month day year).
If optional NODAY is t, does not ask for day, but just returns
-\(month 1 year); if NODAY is any other non-nil value the value returned is
-\(month year)"
+\(month 1 year); if NODAY is any other non-nil value the value
+returned is (month year)."
(let* ((year (calendar-read
"Year (>0): "
(lambda (x) (> x 0))
(defun calendar-mark-visible-date (date &optional mark)
"Mark DATE in the calendar window with MARK.
-MARK is a single-character string, a list of face attributes/values, or a face.
-MARK defaults to `diary-entry-marker'."
+MARK is a single-character string, a list of face attributes/values,
+or a face. MARK defaults to `diary-entry-marker'."
(if (calendar-date-is-valid-p date)
(with-current-buffer calendar-buffer
(save-excursion
"Return the absolute date of the DAYNAME on or before absolute DATE.
DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
-Note: Applying this function to d+6 gives us the DAYNAME on or after an
-absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to
-absolute date d, applying it to d-1 gives the DAYNAME previous to absolute
-date d, and applying it to d+7 gives the DAYNAME following absolute date d."
+Note: Applying this function to d+6 gives us the DAYNAME on or after
+an absolute day d. Similarly, applying it to d+3 gives the DAYNAME
+nearest to absolute date d, applying it to d-1 gives the DAYNAME
+previous to absolute date d, and applying it to d+7 gives the DAYNAME
+following absolute date d."
(- date (% (- date dayname) 7)))
(defun calendar-nth-named-absday (n dayname month year &optional day)
(cons mark entry)))))
(defun diary-ordinal-suffix (n)
- "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
+ "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)"
(if (or (memq (% n 100) '(11 12 13))
(< 3 (% n 10)))
"th"
ROOTDIR is the root directory of a given autoconf controlled project.
PROGRAM is the program to be configured.
TESTFILE is the file used with AC_INIT.
-configure the initial configure script using `autoconf-new-automake-string'"
+Configure the initial configure script using `autoconf-new-automake-string'."
(interactive "DRoot Dir: \nsProgram: \nsTest File: ")
(require 'ede/srecode)
(if (bufferp rootdir)
(looking-at (concat "\\(A[CM]_" macro "\\|" macro "\\)"))))
(defun autoconf-find-last-macro (macro &optional ignore-bol)
- "Move to the last occurrence of MACRO in FILE, and return that point.
+ "Move to the last occurrence of MACRO, and return that point.
The last macro is usually the one in which we would like to insert more
items such as CHECK_HEADERS."
(let ((op (point)) (atbol (if ignore-bol "" "^")))
nil)))
(defun autoconf-parameter-strip (param)
- "Strip the parameter PARAM of whitespace and miscellaneous characters."
+ "Strip the parameter PARAM of whitespace and miscellaneous characters."
;; force greedy match for \n.
(when (string-match "\\`\n*\\s-*\\[?\\s-*" param)
(setq param (substring param (match-end 0))))
(defclass ede-target-with-config-build ()
()
"Class to mix into a project with configuration for builds.
-This class brings in method overloads for for building.")
+This class brings in method overloads for building.")
(cl-defmethod project-compile-project ((proj ede-project-with-config-build) &optional command)
"Compile the entire current project PROJ.
(defun ede-linux--detect-architecture (dir)
"Try to auto-detect the architecture as configured in DIR.
-DIR is Linux' build directory. If it cannot be auto-detected,
+DIR is Linux' build directory. If it cannot be auto-detected,
returns `project-linux-architecture-default'."
(let ((archs-dir (expand-file-name "arch" dir))
(archs (ede-linux--get-archs dir))
(defun ede-linux--get-architecture (dir bdir)
"Try to auto-detect the architecture as configured in BDIR.
-Uses `ede-linux--detect-architecture' for the auto-detection. If
-the result is `ask', let the user choose from architectures found
-in DIR."
+Uses `ede-linux--detect-architecture' for the auto-detection.
+If the result is `ask', let the user choose from architectures
+found in DIR."
(let ((arch (ede-linux--detect-architecture bdir)))
(cl-case arch
(ask
(cl-defmethod semantic-collector-calculate-cache
((obj semantic-collector-buffer-deep))
"Calculate the completion cache for OBJ.
-Uses `semantic-flatten-tags-table'"
+Uses `semantic-flatten-tags-table'."
(oset obj cache
;; Must create it in SEMANTICDB find format.
;; ( ( DBTABLE TAG TAG ... ) ... )
:documentation "List of tags this displayer is showing.")
(last-prefix :type string
:protection :protected
- :documentation "Prefix associated with slot `table'")
+ :documentation "Prefix associated with slot `table'.")
)
"Abstract displayer baseclass.
Manages the display of some number of tags.
(defun semantic-displayer-point-position ()
"Return the location of POINT as positioned on the selected frame.
-Return a cons cell (X . Y)"
+Return a cons cell (X . Y)."
(let* ((frame (selected-frame))
(toolbarleft
(if (eq (cdr (assoc 'tool-bar-position default-frame-alist)) 'left)
When adding new elements, try to use symbols also returned by the parser.
The form of an entry in this list is of the form:
( SYMBOL . FACE )
-where SYMBOL is a tag type symbol used with semantic. FACE
+where SYMBOL is a tag type symbol used with semantic, and FACE
is a symbol representing a face.
Faces used are generated in `font-lock' for consistency, and will not
be used unless font lock is a feature.")
(concat file ": " proto))))
(define-overloadable-function semantic-format-tag-short-doc (tag &optional parent color)
- "Display a short form of TAG's documentation. (Comments, or docstring.)
+ "Display a short form of TAG's documentation. (Comments, or docstring.)
Optional argument PARENT is the parent type if TAG is a detail.
Optional argument COLOR means highlight the prototype with font-lock colors.")
(defun semantic-find-file-noselect (file &optional nowarn rawfile wildcards)
"Call `find-file-noselect' with various features turned off.
Use this when referencing a file that will be soon deleted.
-FILE, NOWARN, RAWFILE, and WILDCARDS are passed into `find-file-noselect'"
+FILE, NOWARN, RAWFILE, and WILDCARDS are passed into `find-file-noselect'."
;; Hack -
;; Check if we are in set-auto-mode, and if so, warn about this.
(when (boundp 'keep-mode-if-same)
(defcustom semantic-idle-scheduler-work-idle-time 60
"Time in seconds of idle before scheduling big work.
-This time should be long enough that once any big work is started, it is
-unlikely the user would be ready to type again right away."
+This time should be long enough that once any big work is started,
+it is unlikely the user would be ready to type again right away."
:group 'semantic
:type 'number
:set (lambda (sym val)
#'semantic-idle-breadcrumbs--display-in-header-line
"Function to display the tag under point in idle time.
This function should take a list of Semantic tags as its only
-argument. The tags are sorted according to their nesting order,
-starting with the outermost tag. The function should call
+argument. The tags are sorted according to their nesting order,
+starting with the outermost tag. The function should call
`semantic-idle-breadcrumbs-format-tag-list-function' to convert
the tag list into a string."
:group 'semantic
#'semantic-idle-breadcrumbs--format-linear
"Function to format the list of tags containing point.
This function should take a list of Semantic tags and an optional
-maximum length of the produced string as its arguments. The
-maximum length is a hint and can be ignored. When the maximum
-length is omitted, an unconstrained string should be
-produced. The tags are sorted according to their nesting order,
-starting with the outermost tag. Single tags should be formatted
-using `semantic-idle-breadcrumbs-format-tag-function' unless
-special formatting is required."
+maximum length of the produced string as its arguments. The
+maximum length is a hint and can be ignored. When the maximum
+length is omitted, an unconstrained string should be produced.
+The tags are sorted according to their nesting order, starting
+with the outermost tag. Single tags should be formatted using
+`semantic-idle-breadcrumbs-format-tag-function' unless special
+formatting is required."
:group 'semantic
:type '(choice
(const :tag "Format tags as list, innermost last"
(defsubst semantic-lex-map-types (fun &optional property)
"Call function FUN on every lexical type.
If optional PROPERTY is non-nil, call FUN only on every type symbol
-which as a PROPERTY value. FUN receives a type symbol as argument."
+which has a PROPERTY value. FUN receives a type symbol as argument."
(semantic-lex-map-symbols
fun semantic-lex-types-obarray property))
If two analyzers can match the same text, it is important to order the
analyzers so that the one you want to match first occurs first. For
example, it is good to put a number analyzer in front of a symbol
-analyzer which might mistake a number for as a symbol."
+analyzer which might mistake a number for a symbol."
`(defun ,name (start end &optional depth length)
,(concat doc "\nSee `semantic-lex' for more information.")
;; Make sure the state of block parsing starts over.
(defmacro define-lex-block-type-analyzer (name doc syntax matches)
"Define a block type analyzer NAME with DOC string.
-SYNTAX is the regexp that matches block delimiters, typically the
+SYNTAX is the regexp that matches block delimiters, typically the
open (`\\\\s(') and close (`\\\\s)') parenthesis syntax classes.
MATCHES is a pair (OPEN-SPECS . CLOSE-SPECS) that defines blocks.
(defun senator-search-default-tag-filter (tag)
"Default function that filters searched tags.
-Ignore tags of classes in `senator-search-ignore-tag-classes'"
+Ignore tags of classes in `senator-search-ignore-tag-classes'."
(not (memq (semantic-tag-class tag)
senator-search-ignore-tag-classes)))
Subclasses should be named `semantic-symref-tool-NAME', where
NAME is the name of the tool used in the configuration variable
-`semantic-symref-tool'"
+`semantic-symref-tool'."
:abstract t)
(cl-defmethod semantic-symref-get-result ((tool semantic-symref-tool-baseclass))
:type list
:documentation
"The list of tags with hits in them.
-Use the `semantic-symref-hit-tags' method to get this list.")
+Use the `semantic-symref-hit-tags' method to get this list.")
)
"The results from a symbol reference search.")
SEARCHTXT is the text that is being searched for.
Used to narrow the in-buffer search.
SEARCHTYPE is the type of search (such as 'symbol or 'tagname).
-If there is no database, of if the searchtype is wrong, return nil."
+If there is no database, or if the searchtype is wrong, return nil."
;; Allowed search types for this mechanism:
;; tagname, tagregexp, tagcompletions
(if (not (memq searchtype '(tagname tagregexp tagcompletions)))
NAME is the name of this variable.
TYPE is a string or semantic tag representing the type of this variable.
Optional DEFAULT-VALUE is a string representing the default value of this
-variable. ATTRIBUTES is a list of additional attributes belonging to this
-tag."
+variable.
+ATTRIBUTES is a list of additional attributes belonging to this tag."
(apply 'semantic-tag name 'variable
:type type
:default-value default-value
(defsubst semantic-tag-new-include (name system-flag &rest attributes)
"Create a semantic tag of class `include'.
NAME is the name of this include.
-SYSTEM-FLAG represents that we were able to identify this include as belonging
-to the system, as opposed to belonging to the local project.
+SYSTEM-FLAG represents that we were able to identify this include as
+belonging to the system, as opposed to belonging to the local project.
ATTRIBUTES is a list of additional attributes belonging to this tag."
(apply 'semantic-tag name 'include
:system-flag system-flag
(defsubst semantic-tag-new-package (name detail &rest attributes)
"Create a semantic tag of class `package'.
NAME is the name of this package.
-DETAIL is extra information about this package, such as a location where
-it can be found.
+DETAIL is extra information about this package, such as a location
+where it can be found.
ATTRIBUTES is a list of additional attributes belonging to this tag."
(apply 'semantic-tag name 'package
:detail detail
(defsubst semantic-tag-set-faux (tag)
"Set TAG to be a new FAUX tag.
FAUX tags represent constructs not found in the source code.
-You can identify a faux tag with `semantic-tag-faux-p'"
+You can identify a faux tag with `semantic-tag-faux-p'."
(semantic--tag-put-property tag :faux-flag t))
(defsubst semantic-tag-set-name (tag name)
;; it. This prevents saving of massive amounts of proxy data.
(defun semantic-create-tag-proxy (function data)
"Create a tag proxy symbol.
-FUNCTION will be used to resolve the proxy. It should take 3
+FUNCTION will be used to resolve the proxy. It should take
two arguments, DATA and TAG. TAG is a proxy tag that needs
-to be resolved, and DATA is the DATA passed into this function.
+to be resolved, and DATA is the data passed into this function.
DATA is data to help resolve the proxy. DATA can be an EIEIO object,
such that FUNCTION is a method.
FUNCTION should return a list of tags, preferably one tag."
"Return the parent of the function that TAG describes.
That is the value of the `:parent' attribute.
A function has a parent if it is a method of a class, and if the
-function does not appear in body of its parent class."
+function does not appear in the body of its parent class."
(semantic-tag-named-parent tag))
(defsubst semantic-tag-function-destructor-p (tag)
Children are any sub-tags which contain overlays.
Default behavior is to get `semantic-tag-components' in addition
-to the components of an anonymous types (if applicable.)
+to the components of an anonymous type (if applicable.)
Note for language authors:
If a mode defines a language tag that has tags in it with overlays
"List expansion candidates for the :using-namespaces argument.
A dictionary entry of the named PREFIX_NAMESPACE with the value
NAMESPACE:: is created for each namespace unless the current
-buffer contains a using NAMESPACE; statement "
+buffer contains a using NAMESPACE; statement."
:group 'srecode-cpp
:type '(repeat string))
;;;###autoload
(defun srecode-semantic-handle-:c (dict)
- "Add macros into the dictionary DICT based on the current c file.
+ "Add macros into the dictionary DICT based on the current C file.
Adds the following:
FILENAME_SYMBOL - filename converted into a C compat symbol.
HEADER - Shown section if in a header file."
(define-mode-local-override srecode-semantic-apply-tag-to-dict
c-mode (tag-wrapper dict)
"Apply C and C++ specific features from TAG-WRAPPER into DICT.
-Calls `srecode-semantic-apply-tag-to-dict-default' first. Adds
+Calls `srecode-semantic-apply-tag-to-dict-default' first. Adds
special behavior for tag of classes include, using and function.
This function cannot be split into C and C++ specific variants, as
;;
(defun srecode-create-dictionary (&optional buffer-or-parent)
- "Create a dictionary for BUFFER.
+ "Create a dictionary for BUFFER-OR-PARENT.
If BUFFER-OR-PARENT is not specified, assume a buffer, and
use the current buffer.
If BUFFER-OR-PARENT is another dictionary, then remember the
entries &optional state)
"Add ENTRIES to DICT.
-ENTRIES is a list of even length of dictionary entries to
-add. ENTRIES looks like this:
+ENTRIES is a list of even length of dictionary entries to add.
+ENTRIES looks like this:
(NAME_1 VALUE_1 NAME_2 VALUE_2 ...)
* Otherwise, a compound variable is created for VALUE_N.
The optional argument STATE has to non-nil when compound values
-are inserted. An error is signaled if ENTRIES contains compound
+are inserted. An error is signaled if ENTRIES contains compound
values but STATE is nil."
(while entries
(let ((name (nth 0 entries))
name &optional non-recursive)
"Return information about DICT's value for NAME.
DICT is a dictionary, and NAME is a string that is treated as the
-name of an entry in the dictionary. If such an entry exists, its
-value is returned. Otherwise, nil is returned. Normally, the
+name of an entry in the dictionary. If such an entry exists, its
+value is returned. Otherwise, nil is returned. Normally, the
lookup is recursive in the sense that the parent of DICT is
searched for NAME if it is not found in DICT. This recursive
lookup can be disabled by the optional argument NON-RECURSIVE.
"Create a dictionary with entries according to TAGS.
TAGS should be in the format produced by the template file
-grammar. That is
+grammar. That is
TAGS = (ENTRY_1 ENTRY_2 ...)
ENTRY_N = (NAME ENTRY_N_1 ENTRY_N_2 ...) | TAG
-where TAG is a semantic tag of class 'variable. The (NAME ... )
+where TAG is a semantic tag of class 'variable. The (NAME ... )
form creates a child dictionary which is stored under the name
-NAME. The TAG form creates a value entry or section dictionary
+NAME. The TAG form creates a value entry or section dictionary
entry whose name is the name of the tag.
STATE is the current compiler state."
(defun scheme-compile-region (start end)
"Compile the current region in the inferior Scheme process.
-\(A BEGIN is wrapped around the region: (BEGIN <region>))"
+\(A BEGIN is wrapped around the region: (BEGIN <region>).)"
(interactive "r")
(comint-send-string (scheme-proc) (format scheme-compile-exp-command
(format "(begin %s)"
(list (/ (* Y x) y) Y (/ (* Y (- 1 x y)) y))))
(defun color-lab-to-lch (L a b)
- "Convert CIE L*a*b* to L*C*h*"
+ "Convert CIE L*a*b* to L*C*h*."
(list L (sqrt (+ (* a a) (* b b))) (atan b a)))
(defun color-lch-to-lab (L C h)
- "Convert CIE L*a*b* to L*C*h*"
+ "Convert CIE L*a*b* to L*C*h*."
(list L (* C (cos h)) (* C (sin h))))
(defun color-cie-de2000 (color1 color2 &optional kL kC kH)
(defcustom doc-view-image-width 850
"Default image width.
Has only an effect if `doc-view-scale-internally' is non-nil and support for
-scaling is compiled into emacs."
+scaling is compiled into Emacs."
:version "24.1"
:type 'number)
(error "Cannot determine the document type"))))))
(defun doc-view-set-up-single-converter ()
- "Find the right single-page converter for the current document type"
+ "Find the right single-page converter for the current document type."
(pcase-let ((`(,conv-function ,type ,extension)
(pcase doc-view-doc-type
('djvu (list #'doc-view-djvu->tiff-converter-ddjvu 'tiff "tif"))
"Change font and/or font settings for frames on display DISPLAY-OR-FRAME.
If DISPLAY-OR-FRAME is a frame, the display is the one for that frame.
-If SET-FONT is non-nil, change the font for frames. Otherwise re-apply the
-current form for the frame (i.e. hinting or somesuch changed)."
+If SET-FONT is non-nil, change the font for frames. Otherwise re-apply
+the current form for the frame (i.e. hinting or somesuch changed)."
(let ((new-font (and (fboundp 'font-get-system-font)
(font-get-system-font)))
(frame-list (frames-on-display-list display-or-frame)))
(defun dynamic-setting-handle-config-changed-event (event)
"Handle config-changed-event on the display in EVENT.
Changes can be
- The monospace font. If `font-use-system-font' is nil, the font
- is not changed.
+ The monospace font. If `font-use-system-font' is nil,
+ the font is not changed.
The normal font.
Xft parameters, like DPI and hinting.
The Gtk+ theme name.
Pairs of delimiters in this list are a fallback in case they have
no syntax relevant to `electric-pair-mode' in the syntax table
-defined in `electric-pair-text-syntax-table'"
+defined in `electric-pair-text-syntax-table'."
:version "24.4"
:group 'electricity
:type '(repeat (cons character character)))
#'electric-pair--skip-whitespace
"Function to use to skip whitespace forward.
Before attempting a skip, if `electric-pair-skip-whitespace' is
-non-nil, this function is called. It move point to a new buffer
+non-nil, this function is called. It move point to a new buffer
position, presumably skipping only whitespace in between.")
(defun electric-pair--skip-whitespace ()
(defvar electric-pair-string-bound-function 'point-max
"Next buffer position where strings are syntactically unexpected.
Value is a function called with no arguments and returning a
-buffer position. Major modes should set this variable
+buffer position. Major modes should set this variable
buffer-locally if they experience slowness with
`electric-pair-mode' when pairing quotes.")
(defun avl-tree--del-balance (node branch dir)
"Rebalance a tree after deleting a node.
-The deletion was done from the left (DIR=0) or right (DIR=1) sub-tree of the
-left (BRANCH=0) or right (BRANCH=1) child of NODE.
+The deletion was done from the left (DIR=0) or right (DIR=1) sub-tree
+of the left (BRANCH=0) or right (BRANCH=1) child of NODE.
Return t if the height of the tree has shrunk."
;; (or is it vice-versa for BRANCH?)
(let ((br (avl-tree--node-branch node branch))
Matching uses the comparison function previously specified in
`avl-tree-create' when TREE was created.
-If there is no such element in the tree, nil is
-returned. Optional argument NILFLAG specifies a value to return
-instead of nil in this case. This allows non-existent elements to
-be distinguished from a null element. (See also
-`avl-tree-member-p', which does this for you.)"
+If there is no such element in the tree, nil is returned.
+Optional argument NILFLAG specifies a value to return instead of nil
+in this case. This allows non-existent elements to be distinguished
+from a null element. (See also `avl-tree-member-p', which does this
+for you.)"
(let ((node (avl-tree--root tree))
(compare-function (avl-tree--cmpfun tree)))
(catch 'found
(defun avl-tree-mapcar (fun tree &optional reverse)
- "Apply FUNCTION to all elements in AVL tree TREE,
+ "Apply function FUN to all elements in AVL tree TREE,
and make a list of the results.
-The FUNCTION is applied and the list constructed in ascending
+The function is applied and the list constructed in ascending
order, or descending order if REVERSE is non-nil.
-Note that if you don't care about the order in which FUNCTION is
+Note that if you don't care about the order in which FUN is
applied, just that the resulting list is in the correct order,
then
"Return an AVL tree iterator object.
Calling `iter-next' on this object will retrieve the next element
-from TREE. If REVERSE is non-nil, elements are returned in
+from TREE. If REVERSE is non-nil, elements are returned in
reverse order.
Note that any modification to TREE *immediately* invalidates all
"Non-nil means collect call-graph information when compiling.
This records which functions were called and from where.
If the value is t, compilation displays the call graph when it finishes.
-If the value is neither t nor nil, compilation asks you whether to display
-the graph.
+If the value is neither t nor nil, compilation asks you whether to
+display the graph.
-The call tree only lists functions called, not macros used. Those functions
-which the byte-code interpreter knows about directly (eq, cons, etc.) are
-not reported.
+The call tree only lists functions called, not macros used. Those
+functions which the byte-code interpreter knows about directly (eq,
+cons, etc.) are not reported.
-The call tree also lists those functions which are not known to be called
-\(that is, to which no calls have been compiled). Functions which can be
-invoked interactively are excluded from this list."
+The call tree also lists those functions which are not known to be
+called (that is, to which no calls have been compiled). Functions
+which can be invoked interactively are excluded from this list."
:type '(choice (const :tag "Yes" t) (const :tag "No" nil)
(other :tag "Ask" lambda)))
"Non-nil means attempt auto-fixing of doc strings.
If this value is the symbol `query', then the user is queried before
any change is made. If the value is `automatic', then all changes are
-made without asking unless the change is very-complex. If the value
+made without asking unless the change is very complex. If the value
is `semiautomatic' or any other value, then simple fixes are made
without asking, and complex changes are made by asking the user first.
The value `never' is the same as nil, never ask or change anything."
system. Possible values are:
nil - Don't spell-check during basic style checks.
- defun - Spell-check when style checking a single defun
- buffer - Spell-check when style checking the whole buffer
+ defun - Spell-check when style checking a single defun.
+ buffer - Spell-check when style checking the whole buffer.
interactive - Spell-check during any interactive check.
- t - Always spell-check"
+ t - Always spell-check."
:type '(choice (const nil)
(const defun)
(const buffer)
(defun checkdoc-ispell ()
"Check the style and spelling of everything interactively.
Calls `checkdoc' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc'"
+Prefix argument is the same as for `checkdoc'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc)))
(defun checkdoc-ispell-current-buffer ()
"Check the style and spelling of the current buffer.
Calls `checkdoc-current-buffer' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-current-buffer'"
+Prefix argument is the same as for `checkdoc-current-buffer'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-current-buffer)))
(defun checkdoc-ispell-interactive ()
"Check the style and spelling of the current buffer interactively.
Calls `checkdoc-interactive' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-interactive'"
+Prefix argument is the same as for `checkdoc-interactive'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-interactive)))
(defun checkdoc-ispell-message-interactive ()
"Check the style and spelling of message text interactively.
Calls `checkdoc-message-interactive' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-message-interactive'"
+Prefix argument is the same as for `checkdoc-message-interactive'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-message-interactive
(defun checkdoc-ispell-message-text ()
"Check the style and spelling of message text interactively.
Calls `checkdoc-message-text' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-message-text'"
+Prefix argument is the same as for `checkdoc-message-text'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-message-text)))
(defun checkdoc-ispell-start ()
"Check the style and spelling of the current buffer.
Calls `checkdoc-start' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-start'"
+Prefix argument is the same as for `checkdoc-start'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-start)))
(defun checkdoc-ispell-continue ()
"Check the style and spelling of the current buffer after point.
Calls `checkdoc-continue' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-continue'"
+Prefix argument is the same as for `checkdoc-continue'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-continue)))
(defun checkdoc-ispell-comments ()
"Check the style and spelling of the current buffer's comments.
Calls `checkdoc-comments' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-comments'"
+Prefix argument is the same as for `checkdoc-comments'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-comments)))
(defun checkdoc-ispell-defun ()
"Check the style and spelling of the current defun with Ispell.
Calls `checkdoc-defun' with spell-checking turned on.
-Prefix argument is the same as for `checkdoc-defun'"
+Prefix argument is the same as for `checkdoc-defun'."
(interactive)
(let ((checkdoc-spellcheck-documentation-flag t))
(call-interactively #'checkdoc-defun)))
;;; Commentary:
-;; This implements the most of CLOS's multiple-dispatch generic functions.
+;; This implements most of CLOS's multiple-dispatch generic functions.
;; To use it you need either (require 'cl-generic) or (require 'cl-lib).
;; The main entry points are: `cl-defgeneric' and `cl-defmethod'.
;;; Add support for describe-function
(defun cl--generic-search-method (met-name)
- "For `find-function-regexp-alist'. Searches for a cl-defmethod.
+ "For `find-function-regexp-alist'. Searches for a cl-defmethod.
MET-NAME is as returned by `cl--generic-load-hist-format'."
(let ((base-re (concat "(\\(?:cl-\\)?defmethod[ \t]+"
(regexp-quote (format "%s" (car met-name)))
(cl-defmethod eieio-read-customization-group ((obj eieio-default-superclass))
"Do a completing read on the name of a customization group in OBJ.
-Return the symbol for the group, or nil"
+Return the symbol for the group, or nil."
(let ((g (eieio--class-option (eieio--object-class obj)
:custom-groups)))
(if (= (length g) 1)
With ARG, do it that many times. Negative arg -N means move
backward across N balanced expressions. This command assumes
point is not in a string or comment. Calls
-`forward-sexp-function' to do the work, if that is non-nil. If
-unable to move over a sexp, signal `scan-error' with three
+`forward-sexp-function' to do the work, if that is non-nil.
+If unable to move over a sexp, signal `scan-error' with three
arguments: a message, the start of the obstacle (usually a
parenthesis or list marker of some kind), and end of the
obstacle."
defined by the current language mode. With ARG, do this that
many times. A negative argument means move backward but still to
a less deep spot. If ESCAPE-STRINGS is non-nil (as it is
-interactively), move out of enclosing strings as well. If
+interactively), move out of enclosing strings as well. If
NO-SYNTAX-CROSSING is non-nil (as it is interactively), prefer to
break out of any enclosing string instead of moving to the start
of a list broken across multiple strings. On error, location of
(buffer-substring-no-properties (point-min) (point-max)))))))
(defun package--archive-contents-from-file ()
- "Parse the archive-contents at `package-archive-upload-base'"
+ "Parse the archive-contents at `package-archive-upload-base'."
(let ((file (expand-file-name "archive-contents"
package-archive-upload-base)))
(if (not (file-exists-p file))
`summary' Short description of the package, typically taken from
the first line of the file.
-`reqs' Requirements of the package. A list of (PACKAGE
+`reqs' Requirements of the package. A list of (PACKAGE
VERSION-LIST) naming the dependent package and the minimum
required version.
-`kind' The distribution format of the package. Currently, it is
+`kind' The distribution format of the package. Currently, it is
either `single' or `tar'.
`archive' The name of the archive (as a string) whence this
auto-name))
(defun package--make-autoloads-and-stuff (pkg-desc pkg-dir)
- "Generate autoloads, description file, etc.. for PKG-DESC installed at PKG-DIR."
+ "Generate autoloads, description file, etc., for PKG-DESC installed at PKG-DIR."
(package-generate-autoloads (package-desc-name pkg-desc) pkg-dir)
(let ((desc-file (expand-file-name (package--description-file pkg-dir)
pkg-dir)))
omitted from the package menu. To toggle this, type \\[package-menu-toggle-hiding].
Values can be interactively added to this list by typing
-\\[package-menu-hide-package] on a package"
+\\[package-menu-hide-package] on a package."
:version "25.1"
:type '(repeat (regexp :tag "Hide packages with name matching")))
(error nil)))))
(defun ses-exercise-startup ()
- "Prepare for coverage tests"
+ "Prepare for coverage tests."
;;Clean up from any previous runs
(condition-case nil (kill-buffer "ses-example.ses") (error nil))
(condition-case nil (kill-buffer "ses-test.ses") (error nil))
(defface testcover-nohits
'((t (:background "DeepPink2")))
- "Face for forms that had no hits during coverage test"
+ "Face for forms that had no hits during coverage test."
:group 'testcover)
(defface testcover-1value
'((t (:background "Wheat2")))
- "Face for forms that always produced the same value during coverage test"
+ "Face for forms that always produced the same value during coverage test."
:group 'testcover)
(defun epg-receive-keys (context keys)
"Add keys from server.
-KEYS is a list of key IDs"
+KEYS is a list of key IDs."
(unwind-protect
(progn
(epg-start-receive-keys context keys)
(defun epg-start-edit-key (context key edit-callback handback)
"Initiate an edit operation on KEY.
-EDIT-CALLBACK is called from process filter and takes 3
+EDIT-CALLBACK is called from process filter and takes four
arguments: the context, a status, an argument string, and the
handback argument.
"Non-nil when we're currently processing a message.
When ERC receives a private message, it sets up a new buffer for
-this query. These in turn, though, do start flyspell. This
+this query. These in turn, though, do start flyspell. This
involves starting an external process, in which case Emacs will
wait - and when it waits, it does accept other stuff from, say,
network exceptions. So, if someone sends you two messages
"The maximum length of a single message.
If a message exceeds this size, it is broken into multiple ones.
-IRC allows for lines up to 512 bytes. Two of them are CR LF.
+IRC allows for lines up to 512 bytes. Two of them are CR LF.
And a typical message looks like this:
:nicky!uhuser@host212223.dialin.fnordisp.net PRIVMSG #lazybastards :Hello!
This is either a coding system, a cons, a function, or nil.
If a cons, the encoding system for outgoing text is in the car
-and the decoding system for incoming text is in the cdr. The most
-interesting use for this is to put `undecided' in the cdr. This
+and the decoding system for incoming text is in the cdr. The most
+interesting use for this is to put `undecided' in the cdr. This
means that `erc-coding-system-precedence' will be consulted, and the
first match there will be used.
(defun erc-server-send (string &optional forcep target)
"Send STRING to the current server.
If FORCEP is non-nil, no flood protection is done - the string is
-sent directly. This might cause the messages to arrive in a wrong
+sent directly. This might cause the messages to arrive in a wrong
order.
If TARGET is specified, look up encoding information for that
"Send LINE to the server as a privmsg or a notice.
MESSAGE-COMMAND should be either \"PRIVMSG\" or \"NOTICE\".
If the target is \",\", the last person you've got a message from will
-be used. If the target is \".\", the last person you've sent a message
+be used. If the target is \".\", the last person you've sent a message
to will be used."
(cond
((string-match "^\\s-*\\(\\S-+\\) ?\\(.*\\)" line)
"Face used for highlighting buttons in ERC buffers.
A button is a piece of text that you can activate by pressing
-`RET' or `mouse-2' above it. See also `erc-button-keymap'."
+`RET' or `mouse-2' above it. See also `erc-button-keymap'."
:type 'face
:group 'erc-faces)
current server.
BUTTON is the number of the regexp grouping actually matching the
- button, This is ignored if REGEXP is \\='nicknames.
+ button. This is ignored if REGEXP is \\='nicknames.
FORM is a lisp expression which must eval to true for the button to
- be added,
+ be added.
CALLBACK is the function to call when the user push this button.
CALLBACK can also be a symbol. Its variable value will be used
t)))
(defun erc-browse-emacswiki (thing)
- "Browse to thing in the emacs-wiki."
+ "Browse to THING in the emacs-wiki."
(browse-url (concat erc-emacswiki-url thing)))
(defun erc-browse-emacswiki-lisp (thing)
(require 'erc)
(defgroup erc-ezbounce nil
- "Interface to the EZBounce IRC bouncer (a virtual IRC server)"
+ "Interface to the EZBounce IRC bouncer (a virtual IRC server)."
:group 'erc)
(defcustom erc-ezb-regexp "^ezbounce!srv$"
;;;###autoload
(defun erc-ezb-get-login (server port)
"Return an appropriate EZBounce login for SERVER and PORT.
-Look up entries in `erc-ezb-login-alist'. If the username or password
+Look up entries in `erc-ezb-login-alist'. If the username or password
in the alist is nil, prompt for the appropriate values."
(let ((login (cdr (assoc (cons server port) erc-ezb-login-alist))))
(when login
(defcustom erc-fill-variable-maximum-indentation 17
"If we indent a line after a long nick, don't indent more then this
-characters. Set to nil to disable."
+characters. Set to nil to disable."
:group 'erc-fill
:type 'integer)
"Return the logfile to use for BUFFER.
If BUFFER is nil, the value of `current-buffer' is used.
This is determined by `erc-generate-log-file-name-function'.
-The result is converted to lowercase, as IRC is case-insensitive"
+The result is converted to lowercase, as IRC is case-insensitive."
(unless buffer (setq buffer (current-buffer)))
(with-current-buffer buffer
(let ((target (or (buffer-name buffer) (erc-default-target)))
(defcustom erc-log-match-format "%t<%n:%c> %m"
"Format for matched Messages.
-This variable specifies how messages in the corresponding log buffers will
-be formatted. The various format specs are:
+This variable specifies how messages in the corresponding log buffers
+will be formatted. The various format specs are:
%t Timestamp (uses `erc-timestamp-format' if non-nil or \"[%Y-%m-%d %H:%M] \")
%n Nickname of sender
"Hook run when text matches a given match-type.
Functions in this hook are passed as arguments:
\(match-type nick!user@host message) where MATCH-TYPE is a symbol of:
-current-nick, keyword, pal, dangerous-host, fool"
+current-nick, keyword, pal, dangerous-host, fool."
:options '(erc-log-matches erc-hide-fools erc-beep-on-match)
:group 'erc-match
:type 'hook)
(require 'erc)
(defgroup erc-netsplit nil
- "Netsplit detection tries to automatically figure when a
-netsplit happens, and filters the QUIT messages. It also keeps
-track of netsplits, so that it can filter the JOIN messages on a netjoin too."
+ "Netsplit detection tries to automatically figure when a netsplit
+happens, and filters the QUIT messages. It also keeps track of
+netsplits, so that it can filter the JOIN messages on a netjoin too."
:group 'erc)
;;;###autoload(autoload 'erc-netsplit-mode "erc-netsplit")
:type 'boolean)
(defcustom erc-netsplit-debug nil
- "If non-nil, debug messages will be shown in the
-sever buffer."
+ "If non-nil, debug messages will be shown in the sever buffer."
:group 'erc-netsplit
:type 'boolean)
("ZiRC: Random server" ZiRC "irc.zirc.org" ((6660 6669)))
("ZUHnet: Random server" ZUHnet "irc.zuh.net" 6667)
("Zurna: Random server" Zurna "irc.zurna.net" 6667))
- "Alist of irc servers. (NAME NET HOST PORTS) where
+ "Alist of irc servers.
+Each server is a list (NAME NET HOST PORTS) where
NAME is a name for that server,
-NET is a symbol indicating to which network from `erc-networks-alist' this
- server corresponds,
+NET is a symbol indicating to which network from `erc-networks-alist'
+ this server corresponds,
HOST is the servers hostname and
PORTS is either a number, a list of numbers, or a list of port ranges."
:group 'erc-networks
(ZiRC "zirc.org")
(ZUHnet "zuh.net")
(Zurna "zurna.net"))
- "Alist of IRC networks. (NET MATCHER) where
+ "Alist of IRC networks.
+Each network is a list (NET MATCHER) where
NET is a symbol naming that IRC network and
-MATCHER is used to find a corresponding network to a server while connected to
- it. If it is regexp, it's used to match against `erc-server-announced-name'.
- It can also be a function (predicate). Then it is executed with the
- server buffer as current-buffer."
+MATCHER is used to find a corresponding network to a server while
+ connected to it. If it is regexp, it's used to match against
+ `erc-server-announced-name'. It can also be a function (predicate).
+ Then it is executed with the server buffer as current-buffer."
:group 'erc-networks
:type '(repeat
(list :tag "Network"
(erc-with-server-buffer erc-network))
(defun erc-current-network ()
- "Deprecated. Use `erc-network' instead. Return the name of this server's
-network as a symbol."
+ "Deprecated. Use `erc-network' instead.
+Return the name of this server's network as a symbol."
(erc-with-server-buffer
(intern (downcase (symbol-name erc-network)))))
(defvar erc-input-ring-index nil
"Position in the input ring for erc.
If nil, the input line is blank and the user is conceptually after
-the most recently added item in the ring. If an integer, the input
+the most recently added item in the ring. If an integer, the input
line is non-blank and displays the item from the ring indexed by this
variable.")
(make-variable-buffer-local 'erc-input-ring-index)
;;; Customization:
(defgroup erc-speedbar nil
- "Integration of ERC in the Speedbar"
+ "Integration of ERC in the Speedbar."
:group 'erc)
(defcustom erc-speedbar-sort-users-type 'activity
indent))))
(defun erc-speedbar-update-channel (buffer)
- "Update the speedbar information about a ERC buffer. The update
-is only done when the channel is actually expanded already."
+ "Update the speedbar information about a ERC buffer.
+The update is only done when the channel is actually expanded already."
;; This is only a rude hack and doesn't care about multiserver usage
;; yet, consider this a brain storming, better ideas?
(with-current-buffer speedbar-buffer
"Insert timestamp only if its value changed since last insertion.
If `erc-insert-timestamp-function' is `erc-insert-timestamp-left', a
string of spaces which is the same size as the timestamp is added to
-the beginning of the line in its place. If you use
+the beginning of the line in its place. If you use
`erc-insert-timestamp-right', nothing gets inserted in place of the
timestamp."
:group 'erc-stamp
(defcustom erc-track-position-in-mode-line 'before-modes
"Where to show modified channel information in the mode-line.
-Setting this variable only has effects in GNU Emacs versions above 21.3.
+Setting this variable only has effect in GNU Emacs versions above 21.3.
Choices are:
`before-modes' - add to the beginning of `mode-line-modes',
(defun erc-track-remove-from-mode-line ()
- "Remove `erc-track-modified-channels' from the mode-line"
+ "Remove `erc-track-modified-channels' from the mode-line."
(when (boundp 'mode-line-modes)
(setq mode-line-modes
(remove '(t erc-modified-channels-object) mode-line-modes)))
(defun erc-modified-channels-update (&rest _args)
"This function updates the information in `erc-modified-channels-alist'
according to buffer visibility. It calls
-`erc-modified-channels-display' at the end. This should usually be
+`erc-modified-channels-display' at the end. This should usually be
called via `window-configuration-change-hook'.
ARGS are ignored."
(interactive)
(defvar erc-track-last-non-erc-buffer nil
"Stores the name of the last buffer you were in before activating
-`erc-track-switch-buffers'")
+`erc-track-switch-buffers'.")
(defun erc-track-sort-by-activest ()
"Sort erc-modified-channels-alist by activity.
count))
(defun erc-track-sort-by-importance ()
- "Sort erc-modified-channels-alist by importance.
+ "Sort `erc-modified-channels-alist' by importance.
That means the position of the face in `erc-track-faces-priority-list'."
(setq erc-modified-channels-alist
(sort erc-modified-channels-alist
(defun erc-track-get-active-buffer (arg)
"Return the buffer name of ARG in `erc-modified-channels-alist'.
-Negative arguments index in the opposite direction. This direction is
-relative to `erc-track-switch-direction'"
+Negative arguments index in the opposite direction. This direction
+is relative to `erc-track-switch-direction'."
(let ((dir erc-track-switch-direction)
offset)
(when (< arg 0)
an erc-server-user struct, and CHANNEL-DATA is either nil or an
erc-channel-user struct.
-See also: `erc-sort-channel-users-by-activity'"
+See also: `erc-sort-channel-users-by-activity'."
(let (users)
(if (hash-table-p erc-channel-users)
(maphash (lambda (_nick cdata)
`erc-echo-notice-in-active-buffer',
`erc-echo-notice-in-user-buffers',
`erc-echo-notice-in-user-and-target-buffers',
-`erc-echo-notice-in-first-user-buffer'"
+`erc-echo-notice-in-first-user-buffer'."
:group 'erc-hooks
:type 'hook
:options '(erc-echo-notice-in-default-buffer
`erc-echo-notice-in-active-buffer',
`erc-echo-notice-in-user-buffers',
`erc-echo-notice-in-user-and-target-buffers',
-`erc-echo-notice-in-first-user-buffer'"
+`erc-echo-notice-in-first-user-buffer'."
:group 'erc-hooks
:type 'hook
:options '(erc-echo-notice-in-default-buffer
Specifically in relation to NICK (user@host) information. Returns REASON
unmodified if nothing can be removed.
E.g. \"Read error to Nick [user@some.host]: 110\" would be shortened to
-\"Read error: 110\". The same applies for \"Ping Timeout\"."
+\"Read error: 110\". The same applies for \"Ping Timeout\"."
(setq nick (regexp-quote nick)
login (regexp-quote login)
host (regexp-quote host))
(defun erc-format-@nick (&optional user _channel-data)
"Format the nickname of USER showing if USER has a voice, is an
-operator, half-op, admin or owner. Owners have \"~\", admins have
+operator, half-op, admin or owner. Owners have \"~\", admins have
\"&\", operators have \"@\" and users with voice have \"+\" as a
prefix. Use CHANNEL-DATA to determine op and voice status. See
also `erc-format-nick-function'."
(defun ffap-latex-mode (name)
"`ffap' function suitable for latex buffers.
-This uses the program kpsewhich if available. In this case, the
+This uses the program kpsewhich if available. In this case, the
variable `ffap-latex-guess-rules' is used for building a filename
out of NAME."
(cond ((file-exists-p name)
"If file SIZE larger than `large-file-warning-threshold', allow user to abort.
OP-TYPE specifies the file operation being performed (for message
to user). If OFFER-RAW is true, give user the additional option
-to open the file literally. If the user chooses this option,
-`abort-if-file-too-large' returns the symbol `raw'. Otherwise, it
-returns nil or exits non-locally."
+to open the file literally. If the user chooses this option,
+`abort-if-file-too-large' returns the symbol `raw'. Otherwise,
+it returns nil or exits non-locally."
(let ((choice (and large-file-warning-threshold size
(> size large-file-warning-threshold)
;; No point in warning if we can't read it.
NODE is assumed to be a cons cell where the car is either a
string or a symbol representing a mode name.
-If it is a mode then the the depth of the mode (ie, how many
-parents that mode has) will be returned.
+If it is a mode then the depth of the mode (ie, how many parents
+that mode has) will be returned.
If it is a string then the length of the string plus 1000 will be
returned.
whose modification time does not match that of the buffer.
This function only handles buffers that are visiting files.
-Non-file buffers need a custom function"
+Non-file buffers need a custom function."
(and buffer-file-name
(file-readable-p buffer-file-name)
(not (buffer-modified-p (current-buffer)))
(defcustom filesets-tree-max-level 3
"Maximum scan depth for directory trees.
A :tree fileset is defined by a base directory the contents of which
-will be recursively added to the menu. `filesets-tree-max-level' tells up
-to which level the directory structure should be scanned/listed,
+will be recursively added to the menu. `filesets-tree-max-level' tells
+up to which level the directory structure should be scanned/listed,
i.e. how deep the menu should be. Try something like
(\"HOME -- only one level\"
`filesets-data' is a list of (NAME-AS-STRING . DEFINITION), DEFINITION
being an association list with the fields:
-:files FILE-1 .. FILE-N ... a list of files belonging to a fileset
+:files FILE-1 .. FILE-N ... a list of files belonging to a fileset.
:ingroup FILE-NAME ... an inclusion group's base file.
-:tree ROOT-DIR PATTERN ... a base directory and a file pattern
+:tree ROOT-DIR PATTERN ... a base directory and a file pattern.
:pattern DIR PATTERN ... a base directory and a regexp matching
files in that directory. Usually,
:filter-dirs-flag BOOLEAN ... is only used in conjunction with :tree.
:tree-max-level INTEGER ... recurse into directories this many levels
-\(see `filesets-tree-max-level' for a full explanation)
+\(see `filesets-tree-max-level' for a full explanation).
:dormant-flag BOOLEAN ... non-nil means don't show this item in the
menu; dormant filesets can still be manipulated via commands available
from the minibuffer -- e.g. `filesets-open', `filesets-close', or
-`filesets-run-cmd'
+`filesets-run-cmd'.
-:dormant-p FUNCTION ... a function returning :dormant-flag
+:dormant-p FUNCTION ... a function returning :dormant-flag.
:open FUNCTION ... the function used to open file belonging to this
-fileset. The function takes a file name as argument
+fileset. The function takes a file name as argument.
:save FUNCTION ... the function used to save file belonging to this
fileset; it takes no arguments, but works on the current buffer.
In conjunction with the :tree tag, :save is void. :open refers to the
function used for opening files in a directory, not for opening the
-directory. For browsing directories, `filesets-browse-dir-function' is used.
+directory. For browsing directories, `filesets-browse-dir-function'
+is used.
Before using :ingroup, make sure that the file type is already
defined in `filesets-ingroup-patterns'."
"Filesets: manual editing of user data required!
Filesets has detected that you were using an older version before,
-which requires some manual updating. Type `y' for editing the startup
+which requires some manual updating. Type `y' for editing the startup
file now.
-The layout of `filesets-data' has changed. Please delete your cache file
+The layout of `filesets-data' has changed. Please delete your cache file
and edit your startup file as shown below:
1. `filesets-data': Edit all :pattern filesets in your startup file and
(defun gnus-agent-flush-cache ()
"Flush the agent's index files such that the group no longer
appears to have any local content. The actual content, the
-article files, is then deleted using gnus-agent-expire-group. The
-gnus-agent-regenerate-group method provides an undo mechanism by
-reconstructing the index files from the article files."
+article files, is then deleted using gnus-agent-expire-group.
+The gnus-agent-regenerate-group method provides an undo mechanism
+by reconstructing the index files from the article files."
(interactive)
(save-excursion
(let ((file-name-coding-system nnmail-pathname-coding-system))
;; gnus-article-encrypt-protocol-alist.
(defcustom gnus-article-encrypt-protocol "PGP"
"The protocol used for encrypt articles.
-It is a string, such as \"PGP\". If nil, ask user."
+It is a string, such as \"PGP\". If nil, ask user."
:version "22.1"
:type 'string
:group 'mime-security)
Strings like this can be either a message ID or a mail address. If it is one
of the symbols `mid' or `mail', Gnus will always assume that the string is a
message ID or a mail address, respectively. If this variable is set to the
-symbol `ask', always query the user what do do. If it is a function, this
+symbol `ask', always query the user what to do. If it is a function, this
function will be called with the string as its only argument. The function
must return `mid', `mail', `invalid' or `ask'."
:version "22.1"
unread and ticked articles.
`Other'
- Display the articles that satisfy the S-expression. The S-expression
+ Display the articles that satisfy the S-expression. The S-expression
should be in an array form.")
(comment (string :tag "Comment") "\
FUNCTION is the function to be called. TIME is the number of
`gnus-demon-timestep's between each call.
-If nil, never call. If t, call each `gnus-demon-timestep'.
+If nil, never call. If t, call each `gnus-demon-timestep'.
If IDLE is t, only call each time Emacs has been idle for TIME.
If IDLE is a number, only call when Emacs has been idle more than
(defun gnus-demon-run-callback (func &optional idle time special)
"Run FUNC if Emacs has been idle for longer than IDLE seconds.
If not, and a TIME is given, restart a new idle timer, so FUNC
-can be called at the next opportunity. Such a special idle run is
-marked with SPECIAL."
+can be called at the next opportunity. Such a special idle run
+is marked with SPECIAL."
(unless gnus-inhibit-demon
(cl-block run-callback
(when (eq idle t)
(defun gnus-dired-print (&optional file-name print-to)
"In dired, print FILE-NAME according to the mailcap file.
-If there is no print command, print in a PostScript image. If the
-optional argument PRINT-TO is nil, send the image to the printer. If
-PRINT-TO is a string, save the PostScript image in a file with that
-name. If PRINT-TO is a number, prompt the user for the name of the
-file to save in."
+If there is no print command, print in a PostScript image. If the
+optional argument PRINT-TO is nil, send the image to the printer.
+If PRINT-TO is a string, save the PostScript image in a file with
+that name. If PRINT-TO is a number, prompt the user for the name
+of the file to save in."
(interactive (list
(file-name-sans-versions (dired-get-filename) t)
(ps-print-preprint current-prefix-arg)))
"Parse RFC5545 iCalendar in buffer BUF and return an event object.
Return a gnus-icalendar-event object representing the first event
-contained in the invitation. Return nil for calendars without an event entry.
+contained in the invitation. Return nil for calendars without an
+event entry.
ATTENDEE-NAME-OR-EMAIL is a list of strings that will be matched
-against the event's attendee names and emails. Invitation rsvp
+against the event's attendee names and emails. Invitation rsvp
status will be retrieved from the first matching attendee record."
(let ((ical (with-current-buffer (icalendar--get-unfolded-buffer (get-buffer buf))
(goto-char (point-min))
(defsubst gnus-range-normalize (range)
"Normalize RANGE.
-If RANGE is a single range, return (RANGE). Otherwise, return RANGE."
+If RANGE is a single range, return (RANGE). Otherwise, return RANGE."
(if (listp (cdr-safe range)) range (list range)))
(defun gnus-last-element (list)
(defun gnus-pad-form (el pad-width)
"Return a form that pads EL to PAD-WIDTH accounting for multi-column
-characters correctly. This is because `format' may pad to columns or to
-characters when given a pad value."
+characters correctly. This is because `format' may pad to columns
+or to characters when given a pad value."
(let ((pad (abs pad-width))
(side (< 0 pad-width)))
(if (symbolp el)
'((((class color) (background light)) (:foreground "PaleTurquoise" :bold t))
(((class color) (background dark)) (:foreground "PaleTurquoise" :bold t))
(t (:bold t)))
- "Face used for displaying AGENTIZED servers"
+ "Face used for displaying AGENTIZED servers."
:group 'gnus-server-visual)
(defface gnus-server-cloud
'((((class color) (background light)) (:foreground "ForestGreen" :bold t))
(((class color) (background dark)) (:foreground "PaleGreen" :bold t))
(t (:bold t)))
- "Face used for displaying Cloud-synced servers"
+ "Face used for displaying Cloud-synced servers."
:group 'gnus-server-visual)
(defface gnus-server-cloud-host
'((((class color) (background light)) (:foreground "Green3" :bold t))
(((class color) (background dark)) (:foreground "Green1" :bold t))
(t (:bold t)))
- "Face used for displaying OPENED servers"
+ "Face used for displaying OPENED servers."
:group 'gnus-server-visual)
(defface gnus-server-closed
(((class color) (background dark))
(:foreground "LightBlue" :italic t))
(t (:italic t)))
- "Face used for displaying CLOSED servers"
+ "Face used for displaying CLOSED servers."
:group 'gnus-server-visual)
(defface gnus-server-denied
'((((class color) (background light)) (:foreground "Red" :bold t))
(((class color) (background dark)) (:foreground "Pink" :bold t))
(t (:inverse-video t :bold t)))
- "Face used for displaying DENIED servers"
+ "Face used for displaying DENIED servers."
:group 'gnus-server-visual)
(defface gnus-server-offline
'((((class color) (background light)) (:foreground "Orange" :bold t))
(((class color) (background dark)) (:foreground "Yellow" :bold t))
(t (:inverse-video t :bold t)))
- "Face used for displaying OFFLINE servers"
+ "Face used for displaying OFFLINE servers."
:group 'gnus-server-visual)
(defvar gnus-server-font-lock-keywords
(sexp :menu-tag "other" t)))
(defcustom gnus-refer-thread-use-nnir nil
- "Use nnir to search an entire server when referring threads. A
-nil value will only search for thread-related articles in the
+ "Use nnir to search an entire server when referring threads.
+A nil value will only search for thread-related articles in the
current group."
:version "24.1"
:group 'gnus-thread
(defcustom gnus-refer-thread-limit-to-thread nil
"If non-nil referring a thread will limit the summary buffer to
-articles in the thread. A nil value will add the thread articles
+articles in the thread. A nil value will add the thread articles
to the summary buffer."
:version "25.1"
:group 'gnus-thread
(defun gnus-summary-limit-include-thread (id &optional thread-only)
"Display all hidden articles belonging to thread ID.
When called interactively, ID is the Message-ID of the current
-article. If thread-only is non-nil limit the summary buffer to
+article. If thread-only is non-nil limit the summary buffer to
these articles."
(interactive (list (mail-header-id (gnus-summary-article-header))))
(let ((articles (gnus-articles-in-thread
result))
(defun gnus-summary-refer-thread (&optional limit)
- "Fetch all articles in the current thread. For backends that
-know how to search for threads (currently only 'nnimap) a
-non-numeric prefix arg will use nnir to search the entire
+ "Fetch all articles in the current thread. For backends
+that know how to search for threads (currently only 'nnimap)
+a non-numeric prefix arg will use nnir to search the entire
server; without a prefix arg only the current group is
-searched. If the variable `gnus-refer-thread-use-nnir' is
-non-nil the prefix arg has the reverse meaning. If no
+searched. If the variable `gnus-refer-thread-use-nnir' is
+non-nil the prefix arg has the reverse meaning. If no
backend-specific 'request-thread function is available fetch
-LIMIT (the numerical prefix) old headers. If LIMIT is
+LIMIT (the numerical prefix) old headers. If LIMIT is
non-numeric or nil fetch the number specified by the
`gnus-refer-thread-limit' variable."
(interactive "P")
BACKWARD is non-nil. If BACKWARD is `all', do all articles.
If UNREAD is non-nil, only unread articles will
be taken into consideration. If NOT-CASE-FOLD, case won't be folded
-in the comparisons. If NOT-MATCHING, return a list of all articles that
-not match REGEXP on HEADER."
+in the comparisons. If NOT-MATCHING, return a list of all articles
+that not match REGEXP on HEADER."
(let ((case-fold-search (not not-case-fold))
articles func)
(if (consp header)
(defun gnus-rescale-image (image size)
"Rescale IMAGE to SIZE if possible.
-SIZE is in format (WIDTH . HEIGHT). Return a new image.
+SIZE is in format (WIDTH . HEIGHT). Return a new image.
Sizes are in pixels."
(if (not (fboundp 'imagemagick-types))
image
%O Download mark (character).
%* If present, indicates desired cursor position
(instead of after first colon).
-%u User defined specifier. The next character in the
- format string should be a letter. Gnus will call the
+%u User defined specifier. The next character in the
+ format string should be a letter. Gnus will call the
function gnus-user-format-function-X, where X is the
- letter following %u. The function will be passed the
- current header as argument. The function should
+ letter following %u. The function will be passed the
+ current header as argument. The function should
return a string, which will be inserted into the
summary just like information from any other summary
specifier.
-&user-date; Age sensitive date format. Various date format is
+&user-date; Age sensitive date format. Various date format is
defined in `gnus-user-date-format-alist'.
;;;###autoload
(defun gnus-no-server (&optional arg slave)
"Read network news.
-If ARG is a positive number, Gnus will use that as the startup
-level. If ARG is nil, Gnus will be started at level 2. If ARG is
-non-nil and not a positive number, Gnus will prompt the user for the
-name of an NNTP server to use.
+If ARG is a positive number, Gnus will use that as the startup level.
+If ARG is nil, Gnus will be started at level 2. If ARG is non-nil
+and not a positive number, Gnus will prompt the user for the name of
+an NNTP server to use.
As opposed to `gnus', this command will not connect to the local
server."
(interactive "P")
:type 'boolean)
(defcustom mail-source-incoming-file-prefix "Incoming"
- "Prefix for file name for storing incoming mail"
+ "Prefix for file name for storing incoming mail."
:group 'mail-source
:type 'string)
If `above', reply above quoted text.
If `below', reply below quoted text.
-Note: Many newsgroups frown upon nontraditional reply styles. You
-probably want to set this variable only for specific groups,
+Note: Many newsgroups frown upon nontraditional reply styles.
+You probably want to set this variable only for specific groups,
e.g. using `gnus-posting-styles':
(eval (set (make-local-variable \\='message-cite-reply-position) \\='above))"
(message-yank-cited-prefix "")
(message-yank-empty-prefix "")
(message-citation-line-format "\n\n-----------------------\nOn %a, %b %d %Y, %N wrote:\n"))
- "Message citation style used by MS Outlook. Use with message-cite-style.")
+ "Message citation style used by MS Outlook. Use with `message-cite-style'.")
(defconst message-cite-style-thunderbird
'((message-cite-function 'message-cite-original)
(message-yank-cited-prefix ">")
(message-yank-empty-prefix ">")
(message-citation-line-format "On %D %R %p, %N wrote:"))
- "Message citation style used by Mozilla Thunderbird. Use with message-cite-style.")
+ "Message citation style used by Mozilla Thunderbird. Use with `message-cite-style'.")
(defconst message-cite-style-gmail
'((message-cite-function 'message-cite-original)
(message-yank-cited-prefix " ")
(message-yank-empty-prefix " ")
(message-citation-line-format "On %e %B %Y %R, %f wrote:\n"))
- "Message citation style used by Gmail. Use with message-cite-style.")
+ "Message citation style used by Gmail. Use with `message-cite-style'.")
(defcustom message-distribution-function nil
"Function called to return a Distribution header."
one.
However, some mail readers (MUA's) can't read split messages, i.e.,
-mails in message/partially format. Answer `n', and the message will be
-sent in one piece.
+mails in message/partially format. Answer `n', and the message
+will be sent in one piece.
The size limit is controlled by `message-send-mail-partially-limit'.
If you always want Gnus to send messages in one piece, set
"Show the external-body part of HANDLE.
This function replaces the buffer of HANDLE with a buffer contains
the entire message.
-If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing."
+If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing."
(unless (mm-handle-cache handle)
(mm-extern-cache-contents handle))
(unless no-display
"Show the partial part of HANDLE.
This function replaces the buffer of HANDLE with a buffer contains
the entire message.
-If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing."
+If NO-DISPLAY is nil, display it. Otherwise, do nothing after replacing."
(let ((id (cdr (assq 'id (cdr (mm-handle-type handle)))))
phandles
(b (point)) (n 1) total
(defun mml-secure-message-sign (&optional method)
"Add MML tags to sign the entire message.
-Use METHOD if given. Else use `mml-secure-method' or
+Use METHOD if given. Else use `mml-secure-method' or
`mml-default-sign-method'."
(interactive)
(mml-secure-message
(defun mml-secure-message-sign-encrypt (&optional method)
"Add MML tag to sign and encrypt the entire message.
-Use METHOD if given. Else use `mml-secure-method' or
+Use METHOD if given. Else use `mml-secure-method' or
`mml-default-sign-method'."
(interactive)
(mml-secure-message
(defun mml-secure-message-encrypt (&optional method)
"Add MML tag to encrypt the entire message.
-Use METHOD if given. Else use `mml-secure-method' or
+Use METHOD if given. Else use `mml-secure-method' or
`mml-default-sign-method'."
(interactive)
(mml-secure-message
(autoload 'epa-select-keys "epa")
(defun mml2015-epg-key-image (key-id)
- "Return the image of a key, if any"
+ "Return the image of a key, if any."
(with-temp-buffer
(set-buffer-multibyte nil)
(let* ((coding-system-for-write 'binary)
(autoload 'gnus-rescale-image "gnus-util")
(defun mml2015-epg-key-image-to-string (key-id)
- "Return a string with the image of a key, if any"
+ "Return a string with the image of a key, if any."
(let ((key-image (mml2015-epg-key-image key-id)))
(if (not key-image)
""
Entries look like (3 . day) which means something like \"Please
Hortense, would you be so kind as to remind me of my appointments 3 days
-before the date, thank you very much. Anda, hmmm... by the way, are you
+before the date, thank you very much. Anda, hmmm... by the way, are you
doing anything special tonight ?\".
The units of measure are 'minute 'hour 'day 'week 'month and 'year (no,
(defvoo nndiary-get-new-mail nil
"Whether nndiary gets new mail and split it.
Contrary to traditional mail back ends, this variable can be set to t
-even if your primary mail back end also retrieves mail. In such a case,
+even if your primary mail back end also retrieves mail. In such a case,
NDiary uses its own mail-sources and split-methods.")
(defvoo nndiary-nov-is-evil nil
(defvar nnheader-directory-files-is-safe (not (eq system-type 'windows-nt))
"If non-nil, Gnus believes `directory-files' is safe.
It has been reported numerous times that `directory-files' fails with
-an alarming frequency on NFS mounted file systems. If it is nil,
+an alarming frequency on NFS mounted file systems. If it is nil,
`nnheader-directory-files-safe' is used.")
(defun nnheader-directory-files-safe (&rest args)
"Internal: stores search result.")
(defvar nnir-search-history ()
- "Internal: the history for querying search options in nnir")
+ "Internal: the history for querying search options in nnir.")
(defconst nnir-tmp-buffer " *nnir*"
"Internal: temporary buffer.")
(defvar nnir-imap-search-other "HEADER %S"
"The IMAP search item to use for anything other than
- `nnir-imap-search-arguments'. By default this is the name of an
- email header field")
+`nnir-imap-search-arguments'. By default this is the name of an
+email header field.")
(defvar nnir-imap-search-argument-history ()
"The history for querying search options in nnir")
;; Data type article list.
(defmacro nnir-artlist-length (artlist)
- "Returns number of articles in artlist."
+ "Return number of articles in artlist."
`(length ,artlist))
(defmacro nnir-artlist-article (artlist n)
- "Returns from ARTLIST the Nth artitem (counting starting at 1)."
+ "Return from ARTLIST the Nth artitem (counting starting at 1)."
`(when (> ,n 0)
(elt ,artlist (1- ,n))))
(defmacro nnir-artitem-group (artitem)
- "Returns the group from the ARTITEM."
+ "Return the group from the ARTITEM."
`(elt ,artitem 0))
(defmacro nnir-artitem-number (artitem)
- "Returns the number from the ARTITEM."
+ "Return the number from the ARTITEM."
`(elt ,artitem 1))
(defmacro nnir-artitem-rsv (artitem)
- "Returns the Retrieval Status Value (RSV, score) from the ARTITEM."
+ "Return the Retrieval Status Value (RSV, score) from the ARTITEM."
`(elt ,artitem 2))
(defmacro nnir-article-group (article)
- "Returns the group for ARTICLE"
+ "Return the group for ARTICLE."
`(nnir-artitem-group (nnir-artlist-article nnir-artlist ,article)))
(defmacro nnir-article-number (article)
- "Returns the number for ARTICLE"
+ "Return the number for ARTICLE."
`(nnir-artitem-number (nnir-artlist-article nnir-artlist ,article)))
(defmacro nnir-article-rsv (article)
- "Returns the rsv for ARTICLE"
+ "Return the rsv for ARTICLE."
`(nnir-artitem-rsv (nnir-artlist-article nnir-artlist ,article)))
(defsubst nnir-article-ids (article)
- "Returns the pair `(nnir id . real id)' of ARTICLE"
+ "Return the pair `(nnir id . real id)' of ARTICLE."
(cons article (nnir-article-number article)))
(defmacro nnir-categorize (sequence keyfunc &optional valuefunc)
- "Sorts a sequence into categories and returns a list of the form
+ "Sort a sequence into categories and returns a list of the form
`((key1 (element11 element12)) (key2 (element21 element22))'.
The category key for a member of the sequence is obtained
as `(keyfunc member)' and the corresponding element is just
-`member'. If `valuefunc' is non-nil, the element of the list
+`member'. If `valuefunc' is non-nil, the element of the list
is `(valuefunc member)'."
`(unless (null ,sequence)
(let (value)
(defcustom nnir-retrieve-headers-override-function nil
"If non-nil, a function that accepts an article list and group
and populates the `nntp-server-buffer' with the retrieved
-headers. Must return either 'nov or 'headers indicating the
+headers. Must return either 'nov or 'headers indicating the
retrieved header format.
If this variable is nil, or if the provided function returns nil for a search
:group 'nnir)
(defcustom nnir-imap-default-search-key "whole message"
- "The default IMAP search key for an nnir search. Must be one of
- the keys in `nnir-imap-search-arguments'. To use raw imap queries
+ "The default IMAP search key for an nnir search. Must be one of
+ the keys in `nnir-imap-search-arguments'. To use raw imap queries
by default set this to \"imap\"."
:version "24.1"
:type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
(defcustom nnir-hyrex-additional-switches '()
"A list of strings, to be given as additional arguments for nnir-search.
-Note that this should be a list. I.e., do NOT use the following:
+Note that this should be a list. I.e., do NOT use the following:
(setq nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong !
Instead, use this:
(setq nnir-hyrex-additional-switches \\='(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))"
buffer search all groups belonging to the server on the current
line; if called from the *Group* buffer search any marked groups,
or the group on the current line, or all the groups under the
-current topic. Calling with a prefix-arg prompts for additional
-search-engine specific constraints. A non-nil `specs' arg must be
+current topic. Calling with a prefix-arg prompts for additional
+search-engine specific constraints. A non-nil `specs' arg must be
an alist with `nnir-query-spec' and `nnir-group-spec' keys, and
skips all prompting."
(interactive "P")
;; Namazu interface
(defun nnir-run-namazu (query server &optional _group)
- "Run given query against Namazu. Returns a vector of (group name, file name)
-pairs (also vectors, actually).
+ "Run given query against Namazu.
+Returns a vector of (group name, file name) pairs (also vectors,
+actually).
Tested with Namazu 2.0.6 on a GNU/Linux system."
;; (when group
(and group (string-match "^nnir" group))))
(defun nnir-read-parms (nnir-search-engine)
- "Reads additional search parameters according to `nnir-engines'."
+ "Read additional search parameters according to `nnir-engines'."
(let ((parmspec (nth 2 (assoc nnir-search-engine nnir-engines))))
(mapcar #'nnir-read-parm parmspec)))
(defun nnir-read-parm (parmspec)
- "Reads a single search parameter.
+ "Read a single search parameter.
`parmspec' is a cons cell, the car is a symbol, the cdr is a prompt."
(let ((sym (car parmspec))
(prompt (cdr parmspec)))
nnir-method-default-engines))))
(defun nnir-read-server-parm (key server &optional not-global)
- "Returns the parameter value corresponding to `key' for
-`server'. If no server-specific value is found consult the global
+ "Return the parameter value corresponding to `key' for `server'.
+If no server-specific value is found consult the global
environment unless `not-global' is non-nil."
(let ((method (gnus-server-to-method server)))
(cond ((and method (assq key (cddr method)))
(defun nnir-search-thread (header)
"Make an nnir group based on the thread containing the article
-header. The current server will be searched. If the registry is
+header. The current server will be searched. If the registry is
installed, the server that the registry reports the current
article came from is also searched."
(let* ((query
its maildir mail folders (e.g. the Dovecot IMAP server or mutt).")
(defvoo nnmairix-default-group nil
- "Default search group. This is the group which is used for all
+ "Default search group. This is the group which is used for all
temporary searches, e.g. nnmairix-search.")
;;; === Internal variables
(defun nnmairix-propagate-marks (&optional server)
"Propagate marks from nnmairix group to original articles.
Unless SERVER is explicitly specified, will use the last opened
-nnmairix server. Only marks from current session will be set."
+nnmairix server. Only marks from current session will be set."
(interactive)
(if server
(nnmairix-open-server server)
(defcustom smime-keys nil
"Map mail addresses to a file containing Certificate (and private key).
-The file is assumed to be in PEM format. You can also associate additional
+The file is assumed to be in PEM format. You can also associate additional
certificates to be sent with every message to each address."
:type '(repeat (list (string :tag "Mail address")
(file :tag "File name")
For this to work the CRL must be up-to-date and since they are
normally updated quite often (i.e., several times a day) you
-probably need some tool to keep them up-to-date. Unfortunately
+probably need some tool to keep them up-to-date. Unfortunately
Gnus cannot do this for you.
The CRL should either be appended (in PEM format) to your
(defun smime-verify-buffer (&optional buffer)
"Verify integrity of S/MIME message in BUFFER.
-Uses current buffer if BUFFER is nil. Returns non-nil on success.
+Uses current buffer if BUFFER is nil. Returns non-nil on success.
Any details (stdout and stderr) are left in the buffer specified by
`smime-details-buffer'."
(interactive)
(defun smime-noverify-buffer (&optional buffer)
"Verify integrity of S/MIME message in BUFFER.
Does NOT verify validity of certificate (only message integrity).
-Uses current buffer if BUFFER is nil. Returns non-nil on success.
+Uses current buffer if BUFFER is nil. Returns non-nil on success.
Any details (stdout and stderr) are left in the buffer specified by
`smime-details-buffer'."
(interactive)
;;;###autoload
(defun spam-report-url-ping-mm-url (host report)
- "Ping a host through HTTP, addressing a specific GET resource. Use
-the external program specified in `mm-url-program' to connect to
-server."
+ "Ping a host through HTTP, addressing a specific GET resource.
+Use the external program specified in `mm-url-program' to connect
+to server."
(with-temp-buffer
(let ((url (format "http://%s%s" host report)))
(mm-url-insert url t))))
(defcustom spam-spamassassin-positive-spam-flag-header "YES"
"The regex on `spam-spamassassin-spam-flag-header' for positive spam
-identification"
+identification."
:type 'string
:group 'spam-spamassassin)
(defcustom spam-spamassassin-spam-status-header "X-Spam-Status"
- "The header inserted by SpamAssassin, giving extended scoring information"
+ "The header inserted by SpamAssassin, giving extended scoring information."
:type 'string
:group 'spam-spamassassin)
:group 'spam-spamassassin)
(defcustom spam-sa-learn-rebuild t
- "Whether sa-learn should rebuild the database every time it is called
+ "Whether sa-learn should rebuild the database every time it is called.
Enable this if you want sa-learn to rebuild the database automatically. Doing
this will slightly increase the running time of the spam registration process.
If you choose not to do this, you will have to run \"sa-learn --rebuild\" in
nil))
(defun spam-classifications ()
- "Return list of valid classifications"
+ "Return list of valid classifications."
'(spam ham))
(defun spam-classification-valid-p (classification)
(require 'spam-stat)
(defun spam-check-stat ()
- "Check the spam-stat backend for the classification of this message"
+ "Check the spam-stat backend for the classification of this message."
(let ((spam-stat-split-fancy-spam-group spam-split-group) ; override
(spam-stat-buffer (buffer-name)) ; stat the current buffer
category return)
;; return something sensible if the score can't be determined
(defun spam-spamassassin-score (&optional recheck)
- "Get the SpamAssassin score"
+ "Get the SpamAssassin score."
(interactive "P")
(save-window-excursion
(gnus-summary-show-article t)
(delq nil (mapcar 'symbol-name minor-mode-list)))
(defun describe-minor-mode-from-symbol (symbol)
- "Display documentation of a minor mode given as a symbol, SYMBOL"
+ "Display documentation of a minor mode given as a symbol, SYMBOL."
(interactive (list (intern (completing-read
"Minor mode symbol: "
(describe-minor-mode-completion-table-for-symbol)))))
(defcustom hippie-expand-ignore-buffers '("^ \\*.*\\*$" dired-mode)
"A list specifying which buffers not to search (if not current).
Can contain both regexps matching buffer names (as strings) and major modes
-\(as atoms)"
+\(as atoms)."
:type '(repeat (choice regexp (symbol :tag "Major Mode")))
:group 'hippie-expand)
keep-overlays : More of a bell (or possibly whistle) than an
optimization - If on, preserve overlay highlighting
(cf ediff or goo-font-lock) as well as basic faces.\n
- body-text-only : Emit only body-text. In concrete terms,
+ body-text-only : Emit only body-text. In concrete terms,
1. Suppress calls to `hfy-page-header' and
`hfy-page-footer'
2. Pretend that `div-wrapper' option above is
(defun hfy-face-resolve-face (fn)
"For FN return a face specification.
-FN may be either a face or a face specification. If the latter,
+FN may be either a face or a face specification. If the latter,
then the specification is returned unchanged."
(cond
((facep fn)
(defun hfy-begin-span (style text-block text-id text-begins-block-p)
"Default handler to begin a span of text.
-Insert \"<span class=\"STYLE\" ...>\". See
-`hfy-begin-span-handler' for more information."
+Insert \"<span class=\"STYLE\" ...>\".
+See `hfy-begin-span-handler' for more information."
(when text-begins-block-p
(insert
(format "<span onclick=\"toggle_invis('%s');\">…</span>" text-block)))
(defvar ibuffer-auto-buffers-changed nil)
(defun ibuffer-update-saved-filters-format (filters)
- "Transforms alist from old to new `ibuffer-saved-filters' format.
+ "Transform alist from old to new `ibuffer-saved-filters' format.
Specifically, converts old-format alist with values of the
form (STRING (FILTER-SPECS...)) to alist with values of the
form (STRING FILTER-SPECS...), where each filter spec should be a
-cons cell with a symbol in the car. Any elements in the latter
+cons cell with a symbol in the car. Any elements in the latter
form are kept as is.
Returns (OLD-FORMAT-DETECTED . UPDATED-SAVED-FILTERS-LIST)."
Each element should look like (\"NAME\" . FILTER-LIST), where
FILTER-LIST has the same structure as the variable
-`ibuffer-filtering-qualifiers', which see. The filters defined
+`ibuffer-filtering-qualifiers', which see. The filters defined
here are joined with an implicit logical `and' and associated
-with NAME. The combined specification can be used by name in
+with NAME. The combined specification can be used by name in
other filter specifications via the `saved' qualifier (again, see
`ibuffer-filtering-qualifiers'). They can also be switched to by
name (see the functions `ibuffer-switch-to-saved-filters' and
-`ibuffer-save-filters'). The variable `ibuffer-save-with-custom'
-affects how this information is saved for future sessions. This
+`ibuffer-save-filters'). The variable `ibuffer-save-with-custom'
+affects how this information is saved for future sessions. This
variable can be set directly from lisp code."
:version "26.1"
:type '(alist :key-type (string :tag "Filter name")
(customize-save-variable 'ibuffer-saved-filters
ibuffer-saved-filters)
(message "Saved updated ibuffer-saved-filters."))))
- ". See below for
+ ". See below for
an explanation and alternative ways to save the repaired value.
Explanation: For the list variable `ibuffer-saved-filters',
elements of the form (STRING (FILTER-SPECS...)) are deprecated
and should instead have the form (STRING FILTER-SPECS...), where
-each filter spec is a cons cell with a symbol in the car. See
-`ibuffer-saved-filters' for details. The repaired value fixes
+each filter spec is a cons cell with a symbol in the car. See
+`ibuffer-saved-filters' for details. The repaired value fixes
this format without changing the meaning of the saved filters.
Alternative ways to save the repaired value:
"A list specifying the filters currently acting on the buffer list.
If this list is nil, then no filters are currently in
-effect. Otherwise, each element of this list specifies a single
+effect. Otherwise, each element of this list specifies a single
filter, and all of the specified filters in the list are applied
successively to the buffer list.
-- (saved . \"NAME\")
Represents the filter saved under the string NAME
- in the alist `ibuffer-saved-filters'. It is an
+ in the alist `ibuffer-saved-filters'. It is an
error to name a filter that has not been saved.
This variable is local to each ibuffer buffer.")
:group 'ibuffer)
(defun ibuffer-repair-saved-filters ()
- "Updates `ibuffer-saved-filters' to its new-style format, if needed.
+ "Update `ibuffer-saved-filters' to its new-style format, if needed.
If this list has any elements of the old-style format, a
deprecation warning is raised, with a button allowing persistent
-update. Any updated filters retain their meaning in the new
-format. See `ibuffer-update-saved-filters-format' and
+update. Any updated filters retain their meaning in the new
+format. See `ibuffer-update-saved-filters-format' and
`ibuffer-saved-filters' for details of the old and new formats."
(interactive)
(when (and (boundp 'ibuffer-saved-filters) ibuffer-saved-filters)
;;;###autoload (autoload 'ibuffer-do-eval "ibuf-ext")
(define-ibuffer-op eval (form)
"Evaluate FORM in each of the buffers.
-Does not display the buffer during evaluation. See
-`ibuffer-do-view-and-eval' for that."
+Does not display the buffer during evaluation.
+See `ibuffer-do-view-and-eval' for that."
(:interactive
(list
(read-from-minibuffer
filters))))
(defun ibuffer-unary-operand (filter)
- "Extracts operand from a unary compound FILTER specification.
+ "Extract operand from a unary compound FILTER specification.
FILTER should be a cons cell of either form (f . d) or (f d),
-where operand d is itself a cons cell, or nil. Returns d."
+where operand d is itself a cons cell, or nil. Returns d."
(let* ((tail (cdr filter))
(maybe-q (car-safe tail)))
(if (consp maybe-q) maybe-q tail)))
"Limit current view to buffers with filename extension matching QUALIFIER.
The separator character (typically `.') is not part of the
-pattern. For example, for a buffer associated with file
+pattern. For example, for a buffer associated with file
'/a/b/c.d', this matches against 'd'."
(:description "filename extension"
:reader (read-from-minibuffer
"Limit current view to buffers with directory matching QUALIFIER.
For a buffer associated with file '/a/b/c.d', this matches
-against '/a/b'. For a buffer not associated with a file, this
+against '/a/b'. For a buffer not associated with a file, this
matches against the value of `default-directory' in that buffer."
(:description "directory name"
:reader (read-from-minibuffer "Filter by directory name (regex): "))
"Arguments for `image-dired-cmd-pngcrush-program'.
Available format specifiers are the same as in
`image-dired-cmd-create-thumbnail-options', with %q for a
-temporary file name (typically generated by pnqnq)"
+temporary file name (typically generated by pnqnq)."
:version "26.1"
:type '(repeat (string :tag "Argument"))
:group 'image-dired)
If the current buffer is displaying an image file as an image,
call `image-mode-as-text' to switch to text or hex display.
-Otherwise, display the image by calling `image-mode'"
+Otherwise, display the image by calling `image-mode'."
(interactive)
(if (image-get-display-property)
(image-mode-as-text)
t)
(defun ccl-compile-read-multibyte-character (cmd)
- "Compile read-multibyte-character"
+ "Compile read-multibyte-character."
(if (/= (length cmd) 3)
(error "CCL: Invalid number of arguments: %s" cmd))
(let ((RRR (nth 1 cmd))
nil)
(defun ccl-compile-write-multibyte-character (cmd)
- "Compile write-multibyte-character"
+ "Compile write-multibyte-character."
(if (/= (length cmd) 3)
(error "CCL: Invalid number of arguments: %s" cmd))
(let ((RRR (nth 1 cmd))
(defconst kkc-lookup-cache-tag 'kkc-lookup-cache-2)
(defun kkc-save-init-file ()
- "Save initial setup code for KKC to a file specified by `kkc-init-file-name'"
+ "Save initial setup code for KKC to a file specified by `kkc-init-file-name'."
(if (and kkc-init-file-flag
(not (eq kkc-init-file-flag t)))
(let ((coding-system-for-write 'iso-2022-7bit)
"Set up Latin-1/ASCII display for the arguments character SETS.
See option `latin1-display' for the method. The members of the list
must be in `latin1-display-sets'. With no arguments, reset the
-display for all of `latin1-display-sets'. See also
+display for all of `latin1-display-sets'. See also
`latin1-display-setup'."
(if sets
(progn
136 141 171 184 196 151 230 144 253))
)
"The constant `ogonek-name-encoding-alist' is a list of (NAME.LIST) pairs.
-Each LIST contains codes for 18 Polish diacritic characters. The codes
-are given in the following order:
+Each LIST contains codes for 18 Polish diacritic characters.
+The codes are given in the following order:
Aogonek Cacute Eogonek Lslash Nacute Oacute Sacute Zacute Zdotaccent
aogonek cacute eogonek lslash nacute oacute sacute zacute zdotaccent.")
" THE INTERACTIVE FUNCTIONS PROVIDED BY THE LIBRARY `ogonek'.
If you read this text then you are either looking at the library's
-source text or you have called the `ogonek-how' command. In the
+source text or you have called the `ogonek-how' command. In the
latter case you may remove this text using `\\[kill-buffer]'.
The library provides functions for changing the encoding of Polish
1. `ogonek-recode-region' and `ogonek-recode-buffer' to change
between one-character encodings, such as `iso-8859-2', `mazovia',
- plain `ascii' or `TeX'. As the names suggest you may recode
+ plain `ascii' or `TeX'. As the names suggest you may recode
either the entire current buffer or just a marked region
- in it. You may use the functions interactively as commands.
+ in it. You may use the functions interactively as commands.
Once you call a command you will be asked about the code
currently used in your text and the target encoding, the one
- you want to get. The following example shows a non-interactive
- use of the functions in a program. This also illustrates what
+ you want to get. The following example shows a non-interactive
+ use of the functions in a program. This also illustrates what
type of parameters the functions expect to be called with:
(ogonek-recode-region
(ogonek-prefixify-buffer prefix-char to-code-name)
The TAB character used in interactive mode makes `emacs'
- display the list of encodings recognized by the library. The list
+ display the list of encodings recognized by the library. The list
is stored in the constant `ogonek-name-encoding-alist'.
The `ogonek' functions refer to five variables in which the suggested
- answers to dialogue questions are stored. The variables and their
+ answers to dialogue questions are stored. The variables and their
default values are:
ogonek-from-encoding iso8859-2
(autoload \\='ogonek-deprefixify-region \"ogonek\")
The most frequent function calls can be abbreviated and assigned to
- keyboard keys. Here are a few practical examples:
+ keyboard keys. Here are a few practical examples:
(defun deprefixify-iso8859-2-region (start end)
(interactive \"*r\")
(defun ogonek-lookup-encoding (encoding)
"Pick up an association for ENCODING in `ogonek-name-encoding-alist'.
Before returning a result test whether the string ENCODING is in
-the list `ogonek-name-encoding-alist'"
+the list `ogonek-name-encoding-alist'."
(let ((code-list (assoc encoding ogonek-name-encoding-alist)))
(if (null code-list)
(error "! Name `%s' not known in `ogonek-name-encoding-alist'"
(defun ogonek-deprefixify-region (start end prefix-char to-encoding)
"In a region, replace PREFIX pairs with their corresponding TO-encodings.
PREFIX-CHAR followed by a Polish character from the `ogonek-prefix-code'
-list is replaced with the corresponding TO-encoded character. A doubled
-PREFIX-CHAR gets replaced with a single one. A combination of PREFIX-CHAR
+list is replaced with the corresponding TO-encoded character. A doubled
+PREFIX-CHAR gets replaced with a single one. A combination of PREFIX-CHAR
followed by a non-Polish character, that is one not listed in the
`ogonek-prefix-code' constant, is left unchanged."
(interactive (progn (barf-if-buffer-read-only)
"Predicate to filter hits of Isearch and replace commands.
Isearch hits that don't satisfy the predicate will be skipped.
The value should be a function of two arguments; it will be
-called with the the positions of the start and the end of the
-text matched by Isearch and replace commands. If this function
+called with the positions of the start and the end of the text
+matched by Isearch and replace commands. If this function
returns nil, Isearch and replace commands will continue searching
without stopping at resp. replacing this match.
"Text properties that are added to the isearch prompt.")
(defun isearch--momentary-message (string)
- "Print STRING at the end of the isearch prompt for 1 second"
+ "Print STRING at the end of the isearch prompt for 1 second."
(let ((message-log-max nil))
(message "%s%s%s"
(isearch-message-prefix nil isearch-nonincremental)
;;; API mandatory
(cl-defgeneric jsonrpc-connection-send (conn &key id method params result error)
"Send a JSONRPC message to connection CONN.
-ID, METHOD, PARAMS, RESULT and ERROR. ")
+ID, METHOD, PARAMS, RESULT and ERROR.")
;;; API optional
(cl-defgeneric jsonrpc-shutdown (conn)
:documentation "Process object wrapped by the this connection.")
(-expected-bytes
:accessor jsonrpc--expected-bytes
- :documentation "How many bytes declared by server")
+ :documentation "How many bytes declared by server.")
(-on-shutdown
:accessor jsonrpc--on-shutdown
:initform #'ignore
(cl-defmethod jsonrpc-shutdown ((conn jsonrpc-process-connection)
&optional cleanup)
"Wait for JSONRPC connection CONN to shutdown.
-With optional CLEANUP, kill any associated buffers. "
+With optional CLEANUP, kill any associated buffers."
(unwind-protect
(cl-loop
with proc = (jsonrpc--process conn) for i from 0
while (not (process-get proc 'jsonrpc-sentinel-cleanup-started))
unless (zerop i) do
- (jsonrpc--warn "Sentinel for %s still hasn't run, deleting it!" proc)
+ (jsonrpc--warn "Sentinel for %s still hasn't run, deleting it!" proc)
do
(delete-process proc)
(accept-process-output nil 0.1))
(deferred nil))
"Does actual work for `jsonrpc-async-request'.
-Return a list (ID TIMER). ID is the new request's ID, or nil if
-the request was deferred. TIMER is a timer object set (or nil, if
+Return a list (ID TIMER). ID is the new request's ID, or nil if
+the request was deferred. TIMER is a timer object set (or nil, if
TIMEOUT is nil)."
(pcase-let* ((buf (current-buffer)) (point (point))
(`(,_ ,timer ,old-id)
;;;###autoload
(defun tibetan-char-p (ch)
"Check if char CH is Tibetan character.
-Returns non-nil if CH is Tibetan. Otherwise, returns nil."
+Returns non-nil if CH is Tibetan. Otherwise, returns nil."
(memq (char-charset ch) '(tibetan tibetan-1-column)))
;;; Functions for Tibetan <-> Tibetan-transcription.
This variable is used by the default date generating function,
feedmail-default-date-generator. If nil, the default, the
last-modified timestamp of the queue file is used to create the
-message Date: header; if there is no queue file, the current time is
-used. If you are using VM, it might be supplying this header for
-you. To suppress VM's version
+message Date: header; if there is no queue file, the current time
+is used. If you are using VM, it might be supplying this header
+for you. To suppress VM's version
(setq vm-mail-header-insert-date nil)"
:group 'feedmail-queue
When this hook runs, the current buffer is already the appropriate
buffer. It has already had all the header prepping from the standard
package. The next step after running the hook will be to save the
-message via Fcc: processing. The hook might be interested in these:
+message via Fcc: processing. The hook might be interested in these:
\(1) `feedmail-prepped-text-buffer' contains the header and body of the
message, ready to go; (2) `feedmail-address-list' contains a list
of simplified recipients of addresses which are to be given to the
"User's last opportunity to modify the message before Fcc action.
It has already had all the header prepping from the standard package.
The next step after running the hook will be to save the message via
-Fcc: processing. The hook might be interested in these: (1)
+Fcc: processing. The hook might be interested in these: (1)
`feedmail-prepped-text-buffer' contains the header and body of the
message, ready to go; (2) `feedmail-address-list' contains a list of
simplified recipients of addressees to whom the message was sent (3)
)))
(defun feedmail-send-it-immediately-wrapper ()
- "Wrapper to catch skip-me-i"
+ "Wrapper to catch skip-me-i."
(if (eq 'skip-me-i (catch 'skip-me-i (feedmail-send-it-immediately)))
(error "FQM: Sending...abandoned!")))
(sit-for feedmail-queue-chatty-sit-for))))
(defun feedmail-find-eoh (&optional noerror)
- "Internal; finds the end of message header fields, returns mark just before it"
+ "Internal; finds the end of message header fields, returns mark just before it."
;; all this funny business with line endings is to account for CRLF
;; weirdness that I don't think I'll ever figure out
(feedmail-say-debug ">in-> feedmail-find-eoh %s" noerror)
(or (nth 1 val) (nth 0 val) addr)))
(defun hashcash-generate-payment (str val)
- "Generate a hashcash payment by finding a VAL-bit collison on STR."
+ "Generate a hashcash payment by finding a VAL-bit collision on STR."
(if (and (> val 0)
hashcash-program)
(with-current-buffer (get-buffer-create " *hashcash*")
(error "No `hashcash' binary found")))
(defun hashcash-generate-payment-async (str val callback)
- "Generate a hashcash payment by finding a VAL-bit collison on STR.
+ "Generate a hashcash payment by finding a VAL-bit collision on STR.
Return immediately. Call CALLBACK with process and result when ready."
(if (and (> val 0)
hashcash-program)
;;;###autoload
(defun hashcash-insert-payment (arg)
- "Insert X-Payment and X-Hashcash headers with a payment for ARG"
+ "Insert X-Payment and X-Hashcash headers with a payment for ARG."
(interactive "sPay to: ")
(unless (hashcash-already-paid-p arg)
(let ((pay (hashcash-generate-payment (hashcash-payment-to arg)
;;;###autoload
(defun hashcash-verify-payment (token &optional resource amount)
- "Verify a hashcash payment"
+ "Verify a hashcash payment."
(let* ((split (split-string token ":"))
(key (if (< (hashcash-version token) 1.2)
(nth 1 split)
(throw 'scan x))))))))))
(defvar rmail-movemail-variant-in-use nil
- "The movemail variant currently in use. Known variants are:
+ "The movemail variant currently in use. Known variants are:
`emacs' Means any implementation, compatible with the native Emacs one.
This is the default;
(defun rmail-get-attr-value (attr state)
"Return the character value for ATTR.
ATTR is a (numeric) index, an offset into the mbox attribute
-header value. STATE is one of nil, t, or a character value."
+header value. STATE is one of nil, t, or a character value."
(cond
((numberp state) state)
((not state) ?-)
;; Default to preferring HTML parts, but only if we have a renderer
(if rmail-mime-render-html-function t nil)
"If non-nil, default to showing HTML part rather than text part
-when both are available"
+when both are available."
:group 'rmail
:version "25.1"
:type 'boolean)
`raw' forces raw mode, any other non-nil value forces decoded mode.
If `rmail-enable-mime' is nil, this creates a temporary \"*RMAIL*\"
-buffer holding a decoded copy of the message. Inline content-types are
-handled according to `rmail-mime-media-type-handlers-alist'.
+buffer holding a decoded copy of the message. Inline content-types
+are handled according to `rmail-mime-media-type-handlers-alist'.
By default, this displays text and multipart messages, and offers to
download attachments as specified by `rmail-mime-attachment-dirs-alist'.
The arguments ARG and STATE have no effect in this case."
(defun rmail-summary-show-message (where)
"Show current mail message.
-Position it according to WHERE which can be BEG or END"
+Position it according to WHERE which can be BEG or END."
(if (and (one-window-p) (not pop-up-frames))
;; If there is just one window, put the summary on the top.
(let ((buffer rmail-buffer))
(defun sc-raw-mode-toggle ()
"Toggle, in one fell swoop, two important SC variables:
-`sc-fixup-whitespace-p' and `sc-auto-fill-region-p'"
+`sc-fixup-whitespace-p' and `sc-auto-fill-region-p'."
(interactive)
(setq sc-fixup-whitespace-p (not sc-fixup-whitespace-p)
sc-auto-fill-region-p (not sc-auto-fill-region-p))
(man man-args)))
(defmacro Man-start-calling (&rest body)
- "Start the man command in `body' after setting up the environment"
+ "Start the man command in `body' after setting up the environment."
`(let ((process-environment (copy-sequence process-environment))
;; The following is so Awk script gets \n intact
;; But don't prevent decoding of the outside.
;;;###mh-autoload
(defmacro mh-do-at-event-location (event &rest body)
"Switch to the location of EVENT and execute BODY.
-After BODY has been executed return to original window. The
-modification flag of the buffer in the event window is
+After BODY has been executed return to original window.
+The modification flag of the buffer in the event window is
preserved."
(declare (debug t))
(let ((event-window (make-symbol "event-window"))
"Iterate over region.
VAR is bound to the message on the current line as we loop
-starting from BEGIN till END. In each step BODY is executed.
+starting from BEGIN till END. In each step BODY is executed.
If VAR is nil then the loop is executed without any binding."
(declare (debug (symbolp body)))
VAR is bound to each message in turn in a loop over RANGE, which
can be a message number, a list of message numbers, a sequence, a
region in a cons cell, or a MH range (something like last:20) in
-a string. In each iteration, BODY is executed.
+a string. In each iteration, BODY is executed.
The parameter RANGE is usually created with
`mh-interactive-range' in order to provide a uniform interface to
"/usr/lib/mh/MailAliases" "/usr/share/mailutils/mh/MailAliases"
"/etc/passwd")
"A list of system files which are a source of aliases.
-If these files are modified, they are automatically reread. This list
+If these files are modified, they are automatically reread. This list
need include only system aliases and the passwd file, since personal
alias files listed in your \"Aliasfile:\" MH profile component are
-automatically included. You can update the alias list manually using
+automatically included. You can update the alias list manually using
\\[mh-alias-reload]."
:type '(repeat file)
:group 'mh-alias)
Since aliases are updated frequently, MH-E reloads aliases
automatically whenever an alias lookup occurs if an alias source has
-changed. Sources include files listed in your \"Aliasfile:\" profile
+changed. Sources include files listed in your \"Aliasfile:\" profile
component and your password file if option `mh-alias-local-users' is
-turned on. However, you can reload your aliases manually by calling
+turned on. However, you can reload your aliases manually by calling
this command directly.
This function runs `mh-alias-reloaded-hook' after the aliases have
(defun mh-alias-ali (alias &optional user)
"Return ali expansion for ALIAS.
ALIAS must be a string for a single alias.
-If USER is t, then assume ALIAS is an address and call ali -user. ali
-returns the string unchanged if not defined. The same is done here."
+If USER is t, then assume ALIAS is an address and call ali -user.
+ali returns the string unchanged if not defined. The same is
+done here."
(condition-case err
(save-excursion
(let ((user-arg (if user "-user" "-nouser")))
(defun mh-alias-canonicalize-suggestion (string)
"Process STRING to replace spaces by periods.
-First all spaces and commas are replaced by periods. Then every run of
-consecutive periods are replaced with a single period. Finally the
+First all spaces and commas are replaced by periods. Then every run
+of consecutive periods are replaced with a single period. Finally the
string is converted to lower case."
(with-temp-buffer
(insert string)
candidate.
If the alias exists already, you will have the choice of
-inserting the new alias before or after the old alias. In the
+inserting the new alias before or after the old alias. In the
former case, this alias will be used when sending mail to this
-alias. In the latter case, the alias serves as an additional
+alias. In the latter case, the alias serves as an additional
folder name hint when filing messages."
(if (not file)
(setq file (mh-alias-insert-file alias)))
(defun mh-alias-add-alias (alias address)
"Add ALIAS for ADDRESS in personal alias file.
-This function prompts you for an alias and address. If the alias
+This function prompts you for an alias and address. If the alias
exists already, you will have the choice of inserting the new
-alias before or after the old alias. In the former case, this
-alias will be used when sending mail to this alias. In the latter
+alias before or after the old alias. In the former case, this
+alias will be used when sending mail to this alias. In the latter
case, the alias serves as an additional folder name hint when
filing messages."
(interactive "P\nP")
If this command is called a second consecutive time with the same
CLICK position, kill the region (or delete it
-if `mouse-drag-copy-region' is non-nil)"
+if `mouse-drag-copy-region' is non-nil)."
(interactive "e")
(mouse-minibuffer-check click)
(let* ((posn (event-start click))
(defun browse-url-default-macosx-browser (url &optional _new-window)
"Invoke the macOS system's default Web browser.
-The optional NEW-WINDOW argument is not used"
+The optional NEW-WINDOW argument is not used."
(interactive (browse-url-interactive-arg "URL: "))
(start-process (concat "open " url) nil "open" url))
(defun eudc-set (var val)
"Set the most local (server, protocol or default) binding of VAR to VAL.
-The current binding of VAR is also set to VAL"
+The current binding of VAR is also set to VAL."
(cond
((not (eq 'unbound (eudc-variable-server-value var)))
(eudc-server-set var val))
(defun eudc-variable-protocol-value (var &optional protocol)
"Return the value of VAR local to PROTOCOL.
Return `unbound' if VAR has no value local to PROTOCOL.
-PROTOCOL defaults to `eudc-protocol'"
+PROTOCOL defaults to `eudc-protocol'."
(let* ((eudc-locals (get var 'eudc-locals))
protocol-locals)
(if (not (and (boundp var)
(defun eudc-variable-server-value (var &optional server)
"Return the value of VAR local to SERVER.
Return `unbound' if VAR has no value local to SERVER.
-SERVER defaults to `eudc-server'"
+SERVER defaults to `eudc-server'."
(let* ((eudc-locals (get var 'eudc-locals))
server-locals)
(if (not (and (boundp var)
"Set the value of VAR according to its locals.
If the VAR has a server- or protocol-local value corresponding
to the current `eudc-server' and `eudc-protocol' then it is set
-accordingly. Otherwise it is set to its EUDC default binding"
+accordingly. Otherwise it is set to its EUDC default binding."
(let (val)
(cond
((not (eq 'unbound (setq val (eudc-variable-server-value var))))
If REPLACE is non-nil, then this expansion replaces the name in the buffer.
`eudc-expansion-overwrites-query' being non-nil inverts the meaning of REPLACE.
Multiple servers can be tried with the same query until one finds a match,
-see `eudc-inline-expansion-servers'"
+see `eudc-inline-expansion-servers'."
(interactive)
(cond
((eq eudc-inline-expansion-servers 'current-server)
(defun eudc-bbdb-format-record-as-result (record)
"Format the BBDB RECORD as a EUDC query result record.
-The record is filtered according to `eudc-bbdb-current-return-attributes'"
+The record is filtered according to `eudc-bbdb-current-return-attributes'."
(require 'bbdb)
(let ((attrs (or eudc-bbdb-current-return-attributes
'(firstname lastname aka company phones addresses net notes)))
(defun eudc-ldap-get-field-list (_dummy &optional objectclass)
"Return a list of valid attribute names for the current server.
OBJECTCLASS is the LDAP object class for which the valid
-attribute names are returned. Default to `person'"
+attribute names are returned. Default to `person'."
(interactive)
(or eudc-server
(call-interactively 'eudc-set-server))
(defun pop3-list (process &optional msg)
"If MSG is nil, return an alist of (MESSAGE-ID . SIZE) pairs.
-Otherwise, return the size of the message-id MSG"
+Otherwise, return the size of the message-id MSG."
(pop3-send-command process (if msg
(format "LIST %d" msg)
"LIST"))
"Store ELEMENT in NS.
Multiple elements with the same name can be stored in a
namespace. When retrieving the element you can specify a
-discriminant predicate to `soap-namespace-get'"
+discriminant predicate to `soap-namespace-get'."
(let ((name (soap-element-name element)))
(push element (gethash name (soap-namespace-elements ns)))))
(defun soap-xs-parse-sequence (node)
"Parse a sequence definition from XML NODE.
-Returns a `soap-xs-complex-type'"
+Returns a `soap-xs-complex-type'."
(cl-assert (memq (soap-l2wk (xml-node-name node))
'(xsd:sequence xsd:choice xsd:all))
nil
(defun soap-parse-envelope (node operation wsdl)
"Parse the SOAP envelope in NODE and return the response.
OPERATION is the WSDL operation for which we expect the response,
-WSDL is used to decode the NODE"
+WSDL is used to decode the NODE."
(soap-with-local-xmlns node
(cl-assert (eq (soap-l2wk (xml-node-name node)) 'soap:Envelope)
nil
(defun soap-inspect-xs-complex-type (type)
"Insert information about TYPE in the current buffer.
-TYPE is a `soap-xs-complex-type'"
+TYPE is a `soap-xs-complex-type'."
(insert "Complex type: " (soap-element-fq-name type))
(insert "\nKind: ")
(cl-case (soap-xs-complex-type-indicator type)
(< (car numbers1) (car numbers2))))
(defun rng-xsd-date-to-days (year month day)
- "Return a unique day number where Jan 1 1 AD is day 1"
+ "Return a unique day number where Jan 1 1 AD is day 1."
(if (> year 0) ; AD
(+ (rng-xsd-days-in-years (- year 1))
(rng-xsd-day-number-in-year year month day))
(defun org-babel-prep-session:C (_session _params)
"This function does nothing as C is a compiled language with no
-support for sessions"
+support for sessions."
(error "C is a compiled language -- no support for sessions"))
(defun org-babel-load-session:C (_session _body _params)
"This function does nothing as C is a compiled language with no
-support for sessions"
+support for sessions."
(error "C is a compiled language -- no support for sessions"))
;; helper functions
(defun org-babel-execute:J (body params)
"Execute a block of J code BODY.
PARAMS are given by org-babel.
-This function is called by `org-babel-execute-src-block'"
+This function is called by `org-babel-execute-src-block'."
(message "executing J source code block")
(let* ((processed-params (org-babel-process-params params))
(sessionp (cdr (assq :session params)))
(defun org-babel-prep-session:asymptote (_session _params)
"Return an error if the :session header argument is set.
-Asymptote does not support sessions"
+Asymptote does not support sessions."
(error "Asymptote does not support sessions"))
(defun org-babel-variable-assignments:asymptote (params)
body)
(defun org-babel-execute:awk (body params)
- "Execute a block of Awk code with org-babel. This function is
-called by `org-babel-execute-src-block'"
+ "Execute a block of Awk code with org-babel.
+This function is called by `org-babel-execute-src-block'."
(message "executing Awk source code block")
(let* ((result-params (cdr (assq :result-params params)))
(cmd-line (cdr (assq :cmd-line params)))
name is removed, since in that case the process will be executing
remotely. The file name is then processed by `expand-file-name'.
Unless second argument NO-QUOTE-P is non-nil, the file name is
-additionally processed by `shell-quote-argument'"
+additionally processed by `shell-quote-argument'."
(let ((f (org-babel-local-file-name (expand-file-name name))))
(if no-quote-p f (shell-quote-argument f))))
;; Use ebnf-eps-buffer to produce an encapsulated postscript file.
;;
(defun org-babel-execute:ebnf (body params)
- "Execute a block of Ebnf code with org-babel. This function is
-called by `org-babel-execute-src-block'"
+ "Execute a block of Ebnf code with org-babel.
+This function is called by `org-babel-execute-src-block'."
(save-excursion
(let* ((dest-file (cdr (assq :file params)))
(dest-dir (file-name-directory dest-file))
(defun org-babel-execute:forth (body params)
"Execute a block of Forth code with org-babel.
-This function is called by `org-babel-execute-src-block'"
+This function is called by `org-babel-execute-src-block'."
(if (string= "none" (cdr (assq :session params)))
(error "Non-session evaluation not supported for Forth code blocks")
(let ((all-results (org-babel-forth-session-execute body params)))
executable.")
(defun org-babel-execute:fortran (body params)
- "This function should only be called by `org-babel-execute:fortran'"
+ "This function should only be called by `org-babel-execute:fortran'."
(let* ((tmp-src-file (org-babel-temp-file "fortran-src-" ".F90"))
(tmp-bin-file (org-babel-temp-file "fortran-bin-" org-babel-exeext))
(cmdline (cdr (assq :cmdline params)))
(defun org-babel-prep-session:fortran (_session _params)
"This function does nothing as fortran is a compiled language with no
-support for sessions"
+support for sessions."
(error "Fortran is a compiled languages -- no support for sessions"))
(defun org-babel-load-session:fortran (_session _body _params)
"This function does nothing as fortran is a compiled language with no
-support for sessions"
+support for sessions."
(error "Fortran is a compiled languages -- no support for sessions"))
;; helper functions
:type 'string)
(defun org-babel-execute:groovy (body params)
- "Execute a block of Groovy code with org-babel. This function is
-called by `org-babel-execute-src-block'"
+ "Execute a block of Groovy code with org-babel.
+This function is called by `org-babel-execute-src-block'."
(message "executing Groovy source code block")
(let* ((processed-params (org-babel-process-params params))
(session (org-babel-groovy-initiate-session (nth 0 processed-params)))
"Name of the command to use for executing Io code.")
(defun org-babel-execute:io (body params)
- "Execute a block of Io code with org-babel. This function is
-called by `org-babel-execute-src-block'"
+ "Execute a block of Io code with org-babel.
+This function is called by `org-babel-execute-src-block'."
(message "executing Io source code block")
(let* ((processed-params (org-babel-process-params params))
(session (org-babel-io-initiate-session (nth 0 processed-params)))
(defun org-babel-execute:js (body params)
"Execute a block of Javascript code with org-babel.
-This function is called by `org-babel-execute-src-block'"
+This function is called by `org-babel-execute-src-block'."
(let* ((org-babel-js-cmd (or (cdr (assq :cmd params)) org-babel-js-cmd))
(result-type (cdr (assq :result-type params)))
(full-body (org-babel-expand-body:generic
(defvar org-babel-default-header-args:lilypond '()
"Default header arguments for lilypond code blocks.
NOTE: The arguments are determined at lilypond compile time.
-See (org-babel-lilypond-set-header-args)")
+See `org-babel-lilypond-set-header-args'.")
(defvar org-babel-lilypond-compile-post-tangle t
"Following the org-babel-tangle (C-c C-v t) command,
org-babel-lilypond-compile-post-tangle determines whether ob-lilypond should
automatically attempt to compile the resultant tangled file.
If the value is nil, no automated compilation takes place.
-Default value is t")
+Default value is t.")
(defvar org-babel-lilypond-display-pdf-post-tangle t
"Following a successful LilyPond compilation
org-babel-lilypond-display-pdf-post-tangle determines whether to automate the
drawing / redrawing of the resultant pdf. If the value is nil,
-the pdf is not automatically redrawn. Default value is t")
+the pdf is not automatically redrawn. Default value is t.")
(defvar org-babel-lilypond-play-midi-post-tangle t
"Following a successful LilyPond compilation
(defun org-babel-lilypond-tangle ()
"ob-lilypond specific tangle, attempts to invoke
=ly-execute-tangled-ly= if tangle is successful. Also passes
-specific arguments to =org-babel-tangle="
+specific arguments to =org-babel-tangle=."
(interactive)
(if (org-babel-tangle nil "yes" "lilypond")
(org-babel-lilypond-execute-tangled-ly) nil))
(defun org-babel-lilypond-execute-tangled-ly ()
"Compile result of block tangle with lilypond.
-If error in compilation, attempt to mark the error in lilypond org file"
+If error in compilation, attempt to mark the error in lilypond org file."
(when org-babel-lilypond-compile-post-tangle
(let ((org-babel-lilypond-tangled-file (org-babel-lilypond-switch-extension
(buffer-file-name) ".lilypond"))
(org-babel-lilypond-attempt-to-play-midi org-babel-lilypond-temp-file)))))
(defun org-babel-lilypond-compile-lilyfile (file-name &optional test)
- "Compile lilypond file and check for compile errors
-FILE-NAME is full path to lilypond (.ly) file"
+ "Compile lilypond file and check for compile errors.
+FILE-NAME is full path to lilypond (.ly) file."
(message "Compiling LilyPond...")
(let ((arg-1 org-babel-lilypond-ly-command) ;program
(arg-2 nil) ;infile
containing the output message from the compilation.
FILE-NAME is full path to lilypond file.
If TEST is t just return nil if no error found, and pass
-nil as file-name since it is unused in this context"
+nil as file-name since it is unused in this context."
(let ((is-error (search-forward "error:" nil t)))
(if test
is-error
(defun org-babel-lilypond-process-compile-error (file-name)
"Process the compilation error that has occurred.
-FILE-NAME is full path to lilypond file"
+FILE-NAME is full path to lilypond file."
(let ((line-num (org-babel-lilypond-parse-line-num)))
(let ((error-lines (org-babel-lilypond-parse-error-line file-name line-num)))
(org-babel-lilypond-mark-error-line file-name error-lines)
(defun org-babel-lilypond-mark-error-line (file-name line)
"Mark the erroneous lines in the lilypond org buffer.
FILE-NAME is full path to lilypond file.
-LINE is the erroneous line"
+LINE is the erroneous line."
(switch-to-buffer-other-window
(concat (file-name-nondirectory
(org-babel-lilypond-switch-extension file-name ".org"))))
(and (numberp num) num)))))
(defun org-babel-lilypond-parse-error-line (file-name lineNo)
- "Extract the erroneous line from the tangled .ly file
+ "Extract the erroneous line from the tangled .ly file.
FILE-NAME is full path to lilypond file.
-LINENO is the number of the erroneous line"
+LINENO is the number of the erroneous line."
(with-temp-buffer
(insert-file-contents (org-babel-lilypond-switch-extension file-name ".ly")
nil nil nil t)
nil)))
(defun org-babel-lilypond-attempt-to-open-pdf (file-name &optional test)
- "Attempt to display the generated pdf file
-FILE-NAME is full path to lilypond file
-If TEST is non-nil, the shell command is returned and is not run"
+ "Attempt to display the generated pdf file.
+FILE-NAME is full path to lilypond file.
+If TEST is non-nil, the shell command is returned and is not run."
(when org-babel-lilypond-display-pdf-post-tangle
(let ((pdf-file (org-babel-lilypond-switch-extension file-name ".pdf")))
(if (file-exists-p pdf-file)
(message "No pdf file generated so can't display!")))))
(defun org-babel-lilypond-attempt-to-play-midi (file-name &optional test)
- "Attempt to play the generated MIDI file
-FILE-NAME is full path to lilypond file
-If TEST is non-nil, the shell command is returned and is not run"
+ "Attempt to play the generated MIDI file.
+FILE-NAME is full path to lilypond file.
+If TEST is non-nil, the shell command is returned and is not run."
(when org-babel-lilypond-play-midi-post-tangle
(let ((midi-file (org-babel-lilypond-switch-extension file-name ".midi")))
(if (file-exists-p midi-file)
(if org-babel-lilypond-arrange-mode "ENABLED." "DISABLED."))))
(defun org-babel-lilypond-switch-extension (file-name ext)
- "Utility command to swap current FILE-NAME extension with EXT"
+ "Utility command to swap current FILE-NAME extension with EXT."
(concat (file-name-sans-extension
file-name) ext))
(defun org-babel-lilypond-get-header-args (mode)
- "Default arguments to use when evaluating a lilypond
-source block. These depend upon whether we are in arrange
-mode i.e. ARRANGE-MODE is t"
+ "Default arguments to use when evaluating a lilypond source block.
+These depend upon whether we are in Arrange mode i.e. MODE is t."
(cond (mode
'((:tangle . "yes")
(:noweb . "yes")
(defun org-babel-lilypond-set-header-args (mode)
"Set org-babel-default-header-args:lilypond
-dependent on ORG-BABEL-LILYPOND-ARRANGE-MODE"
+dependent on ORG-BABEL-LILYPOND-ARRANGE-MODE."
(setq org-babel-default-header-args:lilypond
(org-babel-lilypond-get-header-args mode)))
(defun org-babel-prep-session:lua (session params)
"Prepare SESSION according to the header arguments in PARAMS.
-VARS contains resolved variable references"
+VARS contains resolved variable references."
(let* ((session (org-babel-lua-initiate-session session))
(var-lines
(org-babel-variable-assignments:lua params)))
body)))
(defun org-babel-execute:picolisp (body params)
- "Execute a block of Picolisp code with org-babel. This function is
- called by `org-babel-execute-src-block'"
+ "Execute a block of Picolisp code with org-babel.
+This function is called by `org-babel-execute-src-block'."
(message "executing Picolisp source code block")
(let* (
;; Name of the session or "none".
(defun org-babel-prep-session:processing (_session _params)
"Return an error if the :session header argument is set.
-Processing does not support sessions"
+Processing does not support sessions."
(error "Processing does not support sessions"))
(defun org-babel-variable-assignments:processing (params)
(defun org-babel-prep-session:python (session params)
"Prepare SESSION according to the header arguments in PARAMS.
-VARS contains resolved variable references"
+VARS contains resolved variable references."
(let* ((session (org-babel-python-initiate-session session))
(var-lines
(org-babel-variable-assignments:python params)))
(let ((eoe-string (format "puts \"%s\"" org-babel-ruby-eoe-indicator)))
;; Force the session to be ready before the actual session
;; code is run. There is some problem in comint that will
- ;; sometimes show the prompt after the the input has already
+ ;; sometimes show the prompt after the input has already
;; been inserted and that throws off the extraction of the
;; result for Babel.
(org-babel-comint-with-output
(name)))
(defmacro org-babel-scheme-capture-current-message (&rest body)
- "Capture current message in both interactive and noninteractive mode"
+ "Capture current message in both interactive and noninteractive mode."
`(if noninteractive
(let ((original-message (symbol-function 'message))
(current-message nil))
(current-message))))
(defun org-babel-scheme-execute-with-geiser (code output impl repl)
- "Execute code in specified REPL. If the REPL doesn't exist, create it
-using the given scheme implementation.
+ "Execute code in specified REPL.
+If the REPL doesn't exist, create it using the given scheme
+implementation.
-Returns the output of executing the code if the output parameter
+Returns the output of executing the code if the OUTPUT parameter
is true; otherwise returns the last value."
(let ((result nil))
(with-temp-buffer
(defun org-babel-execute:scheme (body params)
"Execute a block of Scheme code with org-babel.
-This function is called by `org-babel-execute-src-block'"
+This function is called by `org-babel-execute-src-block'."
(let* ((source-buffer (current-buffer))
(source-buffer-name (replace-regexp-in-string ;; zap surrounding *
"^ ?\\*\\([^*]+\\)\\*" "\\1"
(defun org-babel-execute:shen (body params)
"Execute a block of Shen code with org-babel.
-This function is called by `org-babel-execute-src-block'"
+This function is called by `org-babel-execute-src-block'."
(require 'inf-shen)
(let* ((result-params (cdr (assq :result-params params)))
(full-body (org-babel-expand-body:shen body params)))
"List of types searched for when creating the daily/weekly agenda.
This variable is a list of symbols that controls the types of
items that appear in the daily/weekly agenda. Allowed symbols in this
-list are are
+list are
:timestamp List items containing a date stamp or date range matching
the selected date. This includes sexp entries in angular
(defcustom org-agenda-move-date-from-past-immediately-to-today t
"Non-nil means jump to today when moving a past date forward in time.
-When using S-right in the agenda to move a a date forward, and the date
+When using S-right in the agenda to move a date forward, and the date
stamp currently points to the past, the first key press will move it
-to today. WHen nil, just move one day forward even if the date stays
+to today. When nil, just move one day forward even if the date stays
in the past."
:group 'org-agenda-daily/weekly
:version "24.1"
times that have a grid line.
The fourth item is a string placed after the grid times. This
-will align with agenda items"
+will align with agenda items."
:group 'org-agenda-time-grid
:type
'(list
if an entry should be listed before another entry. The following
symbols are recognized:
-time-up Put entries with time-of-day indications first, early first
-time-down Put entries with time-of-day indications first, late first
-timestamp-up Sort by any timestamp, early first
-timestamp-down Sort by any timestamp, late first
-scheduled-up Sort by scheduled timestamp, early first
-scheduled-down Sort by scheduled timestamp, late first
-deadline-up Sort by deadline timestamp, early first
-deadline-down Sort by deadline timestamp, late first
-ts-up Sort by active timestamp, early first
-ts-down Sort by active timestamp, late first
-tsia-up Sort by inactive timestamp, early first
-tsia-down Sort by inactive timestamp, late first
+time-up Put entries with time-of-day indications first, early first.
+time-down Put entries with time-of-day indications first, late first.
+timestamp-up Sort by any timestamp, early first.
+timestamp-down Sort by any timestamp, late first.
+scheduled-up Sort by scheduled timestamp, early first.
+scheduled-down Sort by scheduled timestamp, late first.
+deadline-up Sort by deadline timestamp, early first.
+deadline-down Sort by deadline timestamp, late first.
+ts-up Sort by active timestamp, early first.
+ts-down Sort by active timestamp, late first.
+tsia-up Sort by inactive timestamp, early first.
+tsia-down Sort by inactive timestamp, late first.
category-keep Keep the default order of categories, corresponding to the
sequence in `org-agenda-files'.
category-up Sort alphabetically by category, A-Z.
effort-down Sort numerically by estimated effort, high effort first.
user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
-habit-up Put entries that are habits first
-habit-down Put entries that are habits last
-alpha-up Sort headlines alphabetically
-alpha-down Sort headlines alphabetically, reversed
+habit-up Put entries that are habits first.
+habit-down Put entries that are habits last.
+alpha-up Sort headlines alphabetically.
+alpha-down Sort headlines alphabetically, reversed.
The different possibilities will be tried in sequence, and testing stops
if one comparison returns a \"not-equal\". For example, the default
"Filter lines in the agenda buffer that have a specific category.
The category is that of the current line.
Without prefix argument, keep only the lines of that category.
-With a prefix argument, exclude the lines of that category.
-"
+With a prefix argument, exclude the lines of that category."
(interactive "P")
(if (and org-agenda-filtered-by-category
org-agenda-category-filter)
(defun org-agenda-forward-block (&optional backward)
"Move forward by one agenda block.
-When optional argument BACKWARD is set, go backward"
+When optional argument BACKWARD is set, go backward."
(interactive)
(cond ((not (derived-mode-p 'org-agenda-mode))
(user-error
(error "Unknown %S operator" operator)))))
(defun org-columns--overlay-text (value fmt width property original)
- "Return text "
+ "Return text."
(format fmt
(let ((v (org-columns-add-ellipses value width)))
(pcase property
:group 'org-faces)
(defface org-verbatim '((t (:inherit shadow)))
- "Face for fixed-with text like code snippets"
+ "Face for fixed-with text like code snippets."
:group 'org-faces
:version "22.1")
(defcustom org-cycle-level-faces t
"Non-nil means level styles cycle after level `org-n-level-faces'.
Then so level org-n-level-faces+1 is styled like level 1.
-If nil, then all levels >=org-n-level-faces are styled like
-level org-n-level-faces"
+If nil, then all levels >= org-n-level-faces are styled like
+level org-n-level-faces."
:group 'org-appearance
:group 'org-faces
:version "24.1"
expected indentation when wrapping line.
When optional argument HEADING is non-nil, assume line is at
-a heading. Moreover, if is is `inlinetask', the first star will
+a heading. Moreover, if it is `inlinetask', the first star will
have `org-warning' face."
(let* ((line (aref (pcase heading
(`nil org-indent--text-line-prefixes)
(defvar org-inlinetask-min-level) ; defined in org-inlinetask.el
(defun org-get-limited-outline-regexp ()
"Return outline-regexp with limited number of levels.
-The number of levels is controlled by `org-inlinetask-min-level'"
+The number of levels is controlled by `org-inlinetask-min-level'."
(cond ((not (derived-mode-p 'org-mode))
outline-regexp)
((not (featurep 'org-inlinetask))
the variable `org-agenda-files'.
org-agenda-text-search-extra-files
Include the files given in the variable
- `org-agenda-text-search-extra-files'"
+ `org-agenda-text-search-extra-files'."
:group 'org-mobile
:type '(list :greedy t
(option (const :tag "org-agenda-files" org-agenda-files))
When nil, fast selection is never used.
When the symbol `prefix', it will be used when `org-todo' is called
-with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
+with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
in an Org buffer, and
`\\[universal-argument] t' in an agenda buffer.
(defcustom org-extend-today-until 0
"The hour when your day really ends. Must be an integer.
This has influence for the following applications:
-- When switching the agenda to \"today\". It it is still earlier than
+- When switching the agenda to \"today\". If it is still earlier than
the time given here, the day recognized as TODAY is actually yesterday.
- When a date is read from the user and it is still before the time given
here, the current date and time will be assumed to be yesterday, 23:59.
for valid values of a property.
Note for programmers:
-When querying an entry with `org-entry-get', you can control if inheritance
+When querying an entry with `org-entry-get', you can control if inheritance
should be used. By default, `org-entry-get' looks only at the local
properties. You can request inheritance by setting the inherit argument
to t (to force inheritance) or to `selective' (to respect the setting
'org-stats stats)))))))
(defun org-refresh-effort-properties ()
- "Refresh effort properties"
+ "Refresh effort properties."
(org-refresh-properties
org-effort-property
'((effort . identity)
This command can be called in any mode to follow an external link
or a time-stamp that has Org mode syntax. Its behavior is
undefined when called on internal links (e.g., fuzzy links).
-Raise an error when there is nothing to follow. "
+Raise an error when there is nothing to follow."
(interactive)
(cond ((org-in-regexp org-any-link-re)
(org-open-link-from-string (match-string-no-properties 0)))
Note that toggling the tag with tags commands will not change the property
and therefore not influence behavior!
-This can be t, meaning the tag ORDERED should be used, It can also be a
+This can be t, meaning the tag ORDERED should be used. It can also be a
string to select a different tag for this task."
:group 'org-todo
:type '(choice
Depending on context, this does one of the following:
- switch a timestamp at point one day into the future
-- on a headline, switch to the next TODO keyword.
+- on a headline, switch to the next TODO keyword
- on an item, switch entire list to the next bullet type
- on a property line, switch to the next allowed value
- on a clocktable definition line, move time block into the future"
(defcustom org-html-checkbox-type 'ascii
"The type of checkboxes to use for HTML export.
-See `org-html-checkbox-types' for for the values used for each
+See `org-html-checkbox-types' for the values used for each
option."
:group 'org-export-html
:version "24.4"
(let ((attr (org-export-read-attribute :attr_latex table)))
(when (plist-get attr :rmlines)
;; When the "rmlines" attribute is provided, remove all hlines
- ;; but the the one separating heading from the table body.
+ ;; but the one separating heading from the table body.
(let ((n 0) (pos 0))
(while (and (< (length output) pos)
(setq pos (string-match "^\\\\hline\n?" output pos)))
;; Src blocks
(defcustom org-man-source-highlight nil
- "Use GNU source highlight to embellish source blocks "
+ "Use GNU source highlight to embellish source blocks."
:group 'org-export-man
:version "24.4"
:package-version '(Org . "8.0")
(defun org-man-verse-block (_verse-block contents _info)
"Transcode a VERSE-BLOCK element from Org to Man.
-CONTENTS is verse block contents. INFO is a plist holding
+CONTENTS is verse block contents. INFO is a plist holding
contextual information."
(format ".RS\n.ft I\n%s\n.ft\n.RE" contents))
(defun org-publish-sitemap-default (title list)
"Default site map, as a string.
-TITLE is the the title of the site map. LIST is an internal
+TITLE is the title of the site map. LIST is an internal
representation for the files to include, as returned by
`org-list-to-lisp'. PROJECT is the current project."
(concat "#+TITLE: " title "\n\n"
If there are no such entries, return nil.
ALIST defaults to `outline-heading-alist'.
Similar to (car (rassoc LEVEL ALIST)).
-If there are several different entries with same new level, choose
-the one with the smallest distance to the association of HEAD in the alist.
+If there are several different entries with same new level, choose the
+one with the smallest distance to the association of HEAD in the alist.
This makes it possible for promotion to work in modes with several
-independent sets of headings (numbered, unnumbered, appendix...)"
+independent sets of headings (numbered, unnumbered, appendix...)."
(unless alist (setq alist outline-heading-alist))
(let ((l (rassoc level alist))
ll h hl l2 l2l)
(defun c-maybe-re-mark-raw-string ()
;; When this function is called, point is immediately after a " which opens
- ;; a string. If this " is the characteristic " of of a raw string
+ ;; a string. If this " is the characteristic " of a raw string
;; opener, apply the pertinent `syntax-table' text properties to the
;; entire raw string (when properly terminated) or just the delimiter
;; (otherwise). In either of these cases, return t, otherwise return nil.
(dcl-back-to-indentation-1 (point))
(dcl-back-to-indentation-1)))
(defun dcl-back-to-indentation-1 (&optional limit)
- "Helper function for dcl-back-to-indentation"
+ "Helper function for `dcl-back-to-indentation'."
;; "Indentation points" that we will travel to
;; $ l: ! comment
to cur-indent+extra-indent.
See also documentation for dcl-calc-command-indent-function.
-The indent-type classification could probably be expanded upon.
-"
+The indent-type classification could probably be expanded upon."
()
(save-excursion
(beginning-of-line)
;;;-------------------------------------------------------------------------
(defun dcl-indent-to (col &optional minimum)
- "Like indent-to, but only indents if indentation would change"
+ "Like `indent-to', but only indents if indentation would change."
(interactive)
(let (cur-indent collapsed indent)
(save-excursion
detected in this region. DATA is any object that the caller
wishes to attach to the created diagnostic for later retrieval.
-OVERLAY-PROPERTIES is an an alist of properties attached to the
+OVERLAY-PROPERTIES is an alist of properties attached to the
created diagnostic, overriding the default properties and any
properties of `flymake-overlay-control' of the diagnostic's
type."
(cl-defun flymake--overlays (&key beg end filter compare key)
"Get flymake-related overlays.
If BEG is non-nil and END is nil, consider only `overlays-at'
-BEG. Otherwise consider `overlays-in' the region comprised by BEG
+BEG. Otherwise consider `overlays-in' the region comprised by BEG
and END, defaulting to the whole buffer. Remove all that do not
verify FILTER, a function, and sort them by COMPARE (using KEY)."
(save-restriction
`flymake-start' with a prefix argument.
If the function returns, Flymake considers the backend to be
-\"running\". If it has not done so already, the backend is
+\"running\". If it has not done so already, the backend is
expected to call the function REPORT-FN with a single argument
REPORT-ACTION also followed by an optional list of keyword-value
pairs in the form (:REPORT-KEY VALUE :REPORT-KEY2 VALUE2...).
A backend may call REPORT-FN repeatedly in this manner, but
only until Flymake considers that the most recently requested
buffer check is now obsolete because, say, buffer contents have
- changed in the meantime. The backend is only given notice of
- this via a renewed call to the backend function. Thus, to
+ changed in the meantime. The backend is only given notice of
+ this via a renewed call to the backend function. Thus, to
prevent making obsolete reports and wasting resources, backend
functions should first cancel any ongoing processing from
previous calls.
(defvar flymake-diagnostic-types-alist '() "")
(make-obsolete-variable
'flymake-diagnostic-types-alist
- "Set properties on the diagnostic symbols instead. See Info
+ "Set properties on the diagnostic symbols instead. See Info
Node `(Flymake)Flymake error types'"
"27.1")
(defvar-local flymake--backend-state nil
"Buffer-local hash table of a Flymake backend's state.
The keys to this hash table are functions as found in
-`flymake-diagnostic-functions'. The values are structures
+`flymake-diagnostic-functions'. The values are structures
of the type `flymake--backend-state', with these slots:
`running', a symbol to keep track of a backend's replies via its
-REPORT-FN argument. A backend is running if this key is
-present. If nil, Flymake isn't expecting any replies from the
+REPORT-FN argument. A backend is running if this key is
+present. If nil, Flymake isn't expecting any replies from the
backend.
`diags', a (possibly empty) list of recent diagnostic objects
,@body)))
(defun flymake-is-running ()
- "Tell if Flymake has running backends in this buffer"
+ "Tell if Flymake has running backends in this buffer."
(flymake-running-backends))
;; FIXME: clone of `isearch-intesects-p'! Make this an util.
(defun flymake--collect (fn &optional message-prefix)
"Collect Flymake backends matching FN.
-If MESSAGE-PREFIX, echo a message using that prefix"
+If MESSAGE-PREFIX, echo a message using that prefix."
(unless flymake--backend-state
(user-error "Flymake is not initialized"))
(let (retval)
Some backends may take longer than others to respond or complete,
and some may decide to disable themselves if they are not
-suitable for the current buffer. The commands
+suitable for the current buffer. The commands
`flymake-running-backends', `flymake-disabled-backends' and
`flymake-reporting-backends' summarize the situation, as does the
special *Flymake log* buffer." :group 'flymake :lighter
"Associative list of threads provided by \"-thread-info\" MI command.
Keys are thread numbers (in strings) and values are structures as
-returned from -thread-info by `gdb-json-partial-output'. Updated in
+returned from -thread-info by `gdb-json-partial-output'. Updated in
`gdb-thread-list-handler-custom'.")
(defvar gdb-running-threads-count nil
valid signal handlers.")
(defgroup gdb nil
- "GDB graphical interface"
+ "GDB graphical interface."
:group 'tools
:link '(info-link "(emacs)GDB Graphical Interface")
:version "23.2")
(defgroup gdb-non-stop nil
- "GDB non-stop debugging settings"
+ "GDB non-stop debugging settings."
:group 'gdb
:version "23.2")
(defgroup gdb-buffers nil
- "GDB buffers"
+ "GDB buffers."
:group 'gdb
:version "23.2")
"`gud-call' wrapper which adds --thread/--all options between
CMD1 and CMD2. NOALL is the same as in `gdb-gud-context-command'.
-NOARG must be t when this macro is used outside `gud-def'"
+NOARG must be t when this macro is used outside `gud-def'."
`(gud-call
(concat (gdb-gud-context-command ,cmd1 ,noall) " " ,cmd2)
,(when (not noarg) 'arg)))
responses.
If FIX-LIST is non-nil, \"FIX-LIST={..}\" is replaced with
-\"FIX-LIST=[..]\" prior to parsing. This is used to fix broken
+\"FIX-LIST=[..]\" prior to parsing. This is used to fix broken
-break-info output when it contains breakpoint script field
incompatible with GDB/MI output syntax.
(defcustom grep-error-screen-columns nil
"If non-nil, column numbers in grep hits are screen columns.
-See `compilation-error-screen-columns'"
+See `compilation-error-screen-columns'."
:type '(choice (const :tag "Default" nil)
integer)
:version "22.1"
"Returns the previous expr, point is set to beginning of that expr.
The expr is represented as a cons cell, where the car specifies the point in
the current buffer that marks the beginning of the expr and the cdr specifies
-the character after the end of the expr"
+the character after the end of the expr."
(let ((begin) (end))
(gud-backward-sexp)
(setq begin (point))
"Indentation of Perl statements with respect to containing block."
:type 'integer)
-;; Is is not unusual to put both things like perl-indent-level and
+;; It is not unusual to put both things like perl-indent-level and
;; cperl-indent-level in the local variable section of a file. If only
;; one of perl-mode and cperl-mode is in use, a warning will be issued
;; about the variable. Autoload these here, so that no warning is
When Ghostscript encounters an error it displays an error message
-with a file position. Clicking mouse-2 on this number will bring
+with a file position. Clicking mouse-2 on this number will bring
point to the corresponding spot in the PostScript window, if input
to the interpreter was sent from that window.
Typing \\<ps-run-mode-map>\\[ps-run-goto-error] when the cursor is at the number has the same effect."
"To what column should text on current line be indented?
Indentation is increased if the last token on the current line
-defines the beginning of a group. These tokens are: { [ <<"
+defines the beginning of a group. These tokens are: { [ <<"
(save-excursion
(beginning-of-line)
(if (looking-at "[ \t]*\\(}\\|\\]\\|>>\\)")
(defun ps-run-goto-error ()
"Jump to buffer position read as integer at point.
-Use line numbers if `ps-run-error-line-numbers' is not nil"
+Use line numbers if `ps-run-error-line-numbers' is not nil."
(interactive)
(let ((p (point)))
(unless (looking-at "[0-9]")
(defvar-local python-eldoc-get-doc t
"Non-nil means eldoc should fetch the documentation
- automatically. Set to nil by `python-eldoc-function' if
+ automatically. Set to nil by `python-eldoc-function' if
`python-eldoc-function-timeout-permanent' is non-nil and
`python-eldoc-function' times out.")
(defcustom python-eldoc-function-timeout-permanent t
"Non-nil means that when `python-eldoc-function' times out
-`python-eldoc-get-doc' will be set to nil"
+`python-eldoc-get-doc' will be set to nil."
:group 'python
:type 'boolean
:version "25.1")
longer return the documentation at the point automatically.
Set `python-eldoc-get-doc' to t to reenable eldoc documentation
-fetching"
+fetching."
(when python-eldoc-get-doc
(with-timeout (python-eldoc-function-timeout
(if python-eldoc-function-timeout-permanent
(defun shadow-make-group (regexp sites)
"Make a description of a file group---
actually a list of regexp Tramp file names---from REGEXP (name of file to
-be shadowed), and list of SITES"
+be shadowed), and list of SITES."
(if sites
(cons (shadow-make-fullname
(shadow-parse-name (shadow-site-primary (car sites))) nil regexp)
(defcustom speedbar-obj-do-check t
"Non-nil check all files in speedbar to see if they have an object file.
Any file checked out is marked with `speedbar-obj-indicator', and the
-marking is based on `speedbar-obj-alist'"
+marking is based on `speedbar-obj-alist'."
:group 'speedbar-vc
:type 'boolean)
;;*---------------------------------------------------------------------*/
(defun flyspell-auto-correct-previous-hook ()
"Hook to track successive calls to `flyspell-auto-correct-previous-word'.
-Sets `flyspell-auto-correct-previous-pos' to nil"
+Sets `flyspell-auto-correct-previous-pos' to nil."
(interactive)
(remove-hook 'pre-command-hook (function flyspell-auto-correct-previous-hook) t)
(unless (eq this-command (function flyspell-auto-correct-previous-word))
;;;###autoload
(defun reftex-bib-or-thebib ()
"Test if BibTeX or \\begin{thebibliography} should be used for the citation.
-Find the bof of the current file"
+Find the bof of the current file."
(let* ((docstruct (symbol-value reftex-docstruct-symbol))
(rest (or (member (list 'bof (buffer-file-name)) docstruct)
docstruct))
(interactive)
(reftex-index-visit-location 'hide))
(defun reftex-index-goto-entry ()
- "Go to document location in other window. *Index* window stays."
+ "Go to document location in other window. *Index* window stays."
(interactive)
(reftex-index-visit-location t))
(defun reftex-index-mouse-goto-line-and-hide (ev)
(reftex-index-change-entry new (format "Removed prefix: %s" prefix))))
(defun reftex-index-kill ()
- "FIXME: Not yet implemented"
+ "FIXME: Not yet implemented."
(interactive)
(error "This function is currently not implemented"))
(defun reftex-index-undo ()
- "FIXME: Not yet implemented"
+ "FIXME: Not yet implemented."
(interactive)
(error "This function is currently not implemented"))
(defun reftex-context-substring (&optional to-end)
"Return up to 150 chars from point.
-When point is just after a { or [, limit string to matching parenthesis"
+When point is just after a { or [, limit string to matching parenthesis."
(cond
(to-end
;; Environment - find next \end
(buffer-file-name)))))
(cond
((null master)
- (error "Need a filename for this buffer, please save it first"))
+ (error "Need a filename for this buffer, please save it first"))
((or (file-exists-p (concat master ".tex"))
(reftex-get-buffer-visiting (concat master ".tex")))
;; Ahh, an extra .tex was missing...
"Return the next best `rst-Hdr' upward from HDR.
Consider existing hierarchy HIER and preferred headers. PREV may
be a previous `rst-Hdr' which may be taken into account. If DOWN
-return the next best `rst-Hdr' downward instead. Return nil in
+return the next best `rst-Hdr' downward instead. Return nil if
HIER is nil."
(let* ((normalized-hier (if down
hier
;; testcover: ok.
"Display a table of contents for current buffer.
Displays all section titles found in the current buffer in a
-hierarchical list. The resulting buffer can be navigated, and
+hierarchical list. The resulting buffer can be navigated, and
selecting a section title moves the cursor to that section."
(interactive)
(rst-reset-section-caches)
(defun rst-uncomment-region (beg end &optional _arg)
"Uncomment the current region.
-Region is from BEG to END. _ARG is ignored"
+Region is from BEG to END. _ARG is ignored."
(save-excursion
(goto-char beg)
(rst-forward-line-strict 0)
(defun rst-font-lock-extend-region-internal (beg end)
"Check the region BEG / END for being in the middle of a multi-line construct.
-Return nil if not or a cons with new values for BEG / END"
+Return nil if not or a cons with new values for BEG / END."
(let ((nbeg (rst-font-lock-extend-region-extend beg -1))
(nend (rst-font-lock-extend-region-extend end 1)))
(if (or nbeg nend)
(put 'thumbs-mode 'mode-class 'special)
(define-derived-mode thumbs-mode
fundamental-mode "thumbs"
- "Preview images in a thumbnails buffer"
+ "Preview images in a thumbnails buffer."
(setq buffer-read-only t))
(defvar thumbs-view-image-mode-map
"Restore ARGth diff from `ediff-killed-diffs-alist'.
ARG is a prefix argument. If ARG is nil, restore the current-difference.
If the second optional argument, a character, is given, use it to
-determine the target buffer instead of (ediff-last-command-char)"
+determine the target buffer instead of `ediff-last-command-char'."
(interactive "P")
(ediff-barf-if-not-control-buffer)
(if (numberp arg)
(defvar cvs-cvsroot nil
"Specifies where the (current) cvs master repository is.
Overrides the environment variable $CVSROOT by sending \" -d dir\" to
-all CVS commands. This switch is useful if you have multiple CVS
-repositories. It can be set interactively with \\[cvs-change-cvsroot.]
+all CVS commands. This switch is useful if you have multiple CVS
+repositories. It can be set interactively with \\[cvs-change-cvsroot.]
There is no need to set this if $CVSROOT is set to a correct value.")
(defcustom cvs-auto-remove-handled nil
"If non-nil, tagging can only be applied to directories.
Tagging should generally be applied a directory at a time, but sometimes it is
useful to be able to tag a single file. The normal way to do that is to use
-`cvs-mode-force-command' so as to temporarily override the restrictions,"
+`cvs-mode-force-command' so as to temporarily override the restrictions."
:group 'pcl-cvs
:type '(boolean))
:file-sources (nreverse vc-hg--hgignore-filenames))))
(defun vc-hg--ignore-patterns-valid-p (hgip)
- "Return whether the cached ignore patterns in HGIP are still valid"
+ "Return whether the cached ignore patterns in HGIP are still valid."
(let ((valid t)
(file-sources (vc-hg--ignore-patterns-file-sources hgip)))
(while (and file-sources valid)
widget))
(defun widget-field-value-set (widget value)
- "Set an editable text field WIDGET to VALUE"
+ "Set an editable text field WIDGET to VALUE."
(let ((from (widget-field-start widget))
(to (widget-field-text-end widget))
(buffer (widget-field-buffer widget)))
"History of input to `widget-string-prompt-value'.")
(define-widget 'string 'editable-field
- "A string"
+ "A string."
:tag "String"
:format "%{%t%}: %v"
:complete-function 'ispell-complete-word
(selection-symbol target-type &optional time-stamp terminal))
(defun x-dnd-version-from-flags (flags)
- "Return the version byte from the 32 bit FLAGS in an XDndEnter message"
+ "Return the version byte from the 32 bit FLAGS in an XDndEnter message."
(if (consp flags) ;; Long as cons
(ash (car flags) -8)
(ash flags -24))) ;; Ordinary number
(defun x-dnd-more-than-3-from-flags (flags)
- "Return the nmore-than3 bit from the 32 bit FLAGS in an XDndEnter message"
+ "Return the nmore-than3 bit from the 32 bit FLAGS in an XDndEnter message."
(if (consp flags)
(logand (cdr flags) 1)
(logand flags 1)))
projects / emacs.git / commitdiff