consult-autoloads.el (17116B)
1 ;;; consult-autoloads.el --- automatically extracted autoloads (do not edit) -*- lexical-binding: t -*- 2 ;; Generated by the `loaddefs-generate' function. 3 4 ;; This file is part of GNU Emacs. 5 6 ;;; Code: 7 8 (add-to-list 'load-path (or (and load-file-name (file-name-directory load-file-name)) (car load-path))) 9 10 11 12 ;;; Generated autoloads from consult.el 13 14 (autoload 'consult-completion-in-region "consult" "\ 15 Use minibuffer completion as the UI for `completion-at-point'. 16 17 The function is called with 4 arguments: START END COLLECTION PREDICATE. 18 The arguments and expected return value are as specified for 19 `completion-in-region'. Use as a value for `completion-in-region-function'. 20 21 The function can be configured via `consult-customize'. 22 23 (consult-customize consult-completion-in-region 24 :completion-styles (basic) 25 :cycle-threshold 3) 26 27 These configuration options are supported: 28 29 * :cycle-threshold - Cycling threshold (def: `completion-cycle-threshold') 30 * :completion-styles - Use completion styles (def: `completion-styles') 31 * :require-match - Require matches when completing (def: nil) 32 * :prompt - The prompt string shown in the minibuffer 33 34 (fn START END COLLECTION &optional PREDICATE)") 35 (autoload 'consult-outline "consult" "\ 36 Jump to an outline heading, obtained by matching against `outline-regexp'. 37 38 This command supports narrowing to a heading level and candidate preview. 39 The symbol at point is added to the future history." t) 40 (autoload 'consult-mark "consult" "\ 41 Jump to a marker in MARKERS list (defaults to buffer-local `mark-ring'). 42 43 The command supports preview of the currently selected marker position. 44 The symbol at point is added to the future history. 45 46 (fn &optional MARKERS)" t) 47 (autoload 'consult-global-mark "consult" "\ 48 Jump to a marker in MARKERS list (defaults to `global-mark-ring'). 49 50 The command supports preview of the currently selected marker position. 51 The symbol at point is added to the future history. 52 53 (fn &optional MARKERS)" t) 54 (autoload 'consult-line "consult" "\ 55 Search for a matching line. 56 57 Depending on the setting `consult-point-placement' the command 58 jumps to the beginning or the end of the first match on the line 59 or the line beginning. The default candidate is the non-empty 60 line next to point. This command obeys narrowing. Optional 61 INITIAL input can be provided. The search starting point is 62 changed if the START prefix argument is set. The symbol at point 63 and the last `isearch-string' is added to the future history. 64 65 (fn &optional INITIAL START)" t) 66 (autoload 'consult-line-multi "consult" "\ 67 Search for a matching line in multiple buffers. 68 69 By default search across all project buffers. If the prefix 70 argument QUERY is non-nil, all buffers are searched. Optional 71 INITIAL input can be provided. The symbol at point and the last 72 `isearch-string' is added to the future history.In order to 73 search a subset of buffers, QUERY can be set to a plist according 74 to `consult--buffer-query'. 75 76 (fn QUERY &optional INITIAL)" t) 77 (autoload 'consult-keep-lines "consult" "\ 78 Select a subset of the lines in the current buffer with live preview. 79 80 The selected lines are kept and the other lines are deleted. When called 81 interactively, the lines selected are those that match the minibuffer input. In 82 order to match the inverse of the input, prefix the input with `! '. When 83 called from Elisp, the filtering is performed by a FILTER function. This 84 command obeys narrowing. 85 86 FILTER is the filter function. 87 INITIAL is the initial input. 88 89 (fn &optional FILTER INITIAL)" t) 90 (autoload 'consult-focus-lines "consult" "\ 91 Hide or show lines using overlays. 92 93 The selected lines are shown and the other lines hidden. When called 94 interactively, the lines selected are those that match the minibuffer input. In 95 order to match the inverse of the input, prefix the input with `! '. With 96 optional prefix argument SHOW reveal the hidden lines. Alternatively the 97 command can be restarted to reveal the lines. When called from Elisp, the 98 filtering is performed by a FILTER function. This command obeys narrowing. 99 100 FILTER is the filter function. 101 INITIAL is the initial input. 102 103 (fn &optional SHOW FILTER INITIAL)" t) 104 (autoload 'consult-goto-line "consult" "\ 105 Read line number and jump to the line with preview. 106 107 Jump directly if a line number is given as prefix ARG. The command respects 108 narrowing and the settings `consult-goto-line-numbers' and 109 `consult-line-numbers-widen'. 110 111 (fn &optional ARG)" t) 112 (autoload 'consult-recent-file "consult" "\ 113 Find recent file using `completing-read'." t) 114 (autoload 'consult-mode-command "consult" "\ 115 Run a command from any of the given MODES. 116 117 If no MODES are specified, use currently active major and minor modes. 118 119 (fn &rest MODES)" t) 120 (autoload 'consult-yank-from-kill-ring "consult" "\ 121 Select STRING from the kill ring and insert it. 122 With prefix ARG, put point at beginning, and mark at end, like `yank' does. 123 124 This command behaves like `yank-from-kill-ring' in Emacs 28, which also offers 125 a `completing-read' interface to the `kill-ring'. Additionally the Consult 126 version supports preview of the selected string. 127 128 (fn STRING &optional ARG)" t) 129 (autoload 'consult-yank-pop "consult" "\ 130 If there is a recent yank act like `yank-pop'. 131 132 Otherwise select string from the kill ring and insert it. 133 See `yank-pop' for the meaning of ARG. 134 135 This command behaves like `yank-pop' in Emacs 28, which also offers a 136 `completing-read' interface to the `kill-ring'. Additionally the Consult 137 version supports preview of the selected string. 138 139 (fn &optional ARG)" t) 140 (autoload 'consult-yank-replace "consult" "\ 141 Select STRING from the kill ring. 142 143 If there was no recent yank, insert the string. 144 Otherwise replace the just-yanked string with the selected string. 145 146 There exists no equivalent of this command in Emacs 28. 147 148 (fn STRING)" t) 149 (autoload 'consult-bookmark "consult" "\ 150 If bookmark NAME exists, open it, otherwise create a new bookmark with NAME. 151 152 The command supports preview of file bookmarks and narrowing. See the 153 variable `consult-bookmark-narrow' for the narrowing configuration. 154 155 (fn NAME)" t) 156 (autoload 'consult-complex-command "consult" "\ 157 Select and evaluate command from the command history. 158 159 This command can act as a drop-in replacement for `repeat-complex-command'." t) 160 (autoload 'consult-history "consult" "\ 161 Insert string from HISTORY of current buffer. 162 In order to select from a specific HISTORY, pass the history 163 variable as argument. INDEX is the name of the index variable to 164 update, if any. BOL is the function which jumps to the beginning 165 of the prompt. See also `cape-history' from the Cape package. 166 167 (fn &optional HISTORY INDEX BOL)" t) 168 (autoload 'consult-isearch-history "consult" "\ 169 Read a search string with completion from the Isearch history. 170 171 This replaces the current search string if Isearch is active, and 172 starts a new Isearch session otherwise." t) 173 (autoload 'consult-minor-mode-menu "consult" "\ 174 Enable or disable minor mode. 175 176 This is an alternative to `minor-mode-menu-from-indicator'." t) 177 (autoload 'consult-theme "consult" "\ 178 Disable current themes and enable THEME from `consult-themes'. 179 180 The command supports previewing the currently selected theme. 181 182 (fn THEME)" t) 183 (autoload 'consult-buffer "consult" "\ 184 Enhanced `switch-to-buffer' command with support for virtual buffers. 185 186 The command supports recent files, bookmarks, views and project files as 187 virtual buffers. Buffers are previewed. Narrowing to buffers (b), files (f), 188 bookmarks (m) and project files (p) is supported via the corresponding 189 keys. In order to determine the project-specific files and buffers, the 190 `consult-project-function' is used. The virtual buffer SOURCES 191 default to `consult-buffer-sources'. See `consult--multi' for the 192 configuration of the virtual buffer sources. 193 194 (fn &optional SOURCES)" t) 195 (autoload 'consult-project-buffer "consult" "\ 196 Enhanced `project-switch-to-buffer' command with support for virtual buffers. 197 The command may prompt you for a project directory if it is invoked from 198 outside a project. See `consult-buffer' for more details." t) 199 (autoload 'consult-buffer-other-window "consult" "\ 200 Variant of `consult-buffer' which opens in other window." t) 201 (autoload 'consult-buffer-other-frame "consult" "\ 202 Variant of `consult-buffer' which opens in other frame." t) 203 (autoload 'consult-grep "consult" "\ 204 Search with `grep' for files in DIR where the content matches a regexp. 205 206 The initial input is given by the INITIAL argument. DIR can be 207 nil, a directory string or a list of file/directory paths. If 208 `consult-grep' is called interactively with a prefix argument, 209 the user can specify the directories or files to search in. 210 Multiple directories must be separated by comma in the 211 minibuffer, since they are read via `completing-read-multiple'. 212 By default the project directory is used if 213 `consult-project-function' is defined and returns non-nil. 214 Otherwise the `default-directory' is searched. 215 216 The input string is split, the first part of the string (grep 217 input) is passed to the asynchronous grep process and the second 218 part of the string is passed to the completion-style filtering. 219 220 The input string is split at a punctuation character, which is 221 given as the first character of the input string. The format is 222 similar to Perl-style regular expressions, e.g., /regexp/. 223 Furthermore command line options can be passed to grep, specified 224 behind --. The overall prompt input has the form 225 `#async-input -- grep-opts#filter-string'. 226 227 Note that the grep input string is transformed from Emacs regular 228 expressions to Posix regular expressions. Always enter Emacs 229 regular expressions at the prompt. `consult-grep' behaves like 230 builtin Emacs search commands, e.g., Isearch, which take Emacs 231 regular expressions. Furthermore the asynchronous input split 232 into words, each word must match separately and in any order. 233 See `consult--regexp-compiler' for the inner workings. In order 234 to disable transformations of the grep input, adjust 235 `consult--regexp-compiler' accordingly. 236 237 Here we give a few example inputs: 238 239 #alpha beta : Search for alpha and beta in any order. 240 #alpha.*beta : Search for alpha before beta. 241 #\\(alpha\\|beta\\) : Search for alpha or beta (Note Emacs syntax!) 242 #word -- -C3 : Search for word, include 3 lines as context 243 #first#second : Search for first, quick filter for second. 244 245 The symbol at point is added to the future history. 246 247 (fn &optional DIR INITIAL)" t) 248 (autoload 'consult-git-grep "consult" "\ 249 Search with `git grep' for files in DIR with INITIAL input. 250 See `consult-grep' for details. 251 252 (fn &optional DIR INITIAL)" t) 253 (autoload 'consult-ripgrep "consult" "\ 254 Search with `rg' for files in DIR with INITIAL input. 255 See `consult-grep' for details. 256 257 (fn &optional DIR INITIAL)" t) 258 (autoload 'consult-find "consult" "\ 259 Search for files in DIR matching input regexp given INITIAL input. 260 See `consult-grep' for details regarding the asynchronous search 261 and the arguments. 262 263 (fn &optional DIR INITIAL)" t) 264 (autoload 'consult-locate "consult" "\ 265 Search with `locate' for files which match input given INITIAL input. 266 267 The input is treated literally such that locate can take advantage of 268 the locate database index. Regular expressions would often force a slow 269 linear search through the entire database. The locate process is started 270 asynchronously, similar to `consult-grep'. See `consult-grep' for more 271 details regarding the asynchronous search. 272 273 (fn &optional INITIAL)" t) 274 (autoload 'consult-man "consult" "\ 275 Search for man page given INITIAL input. 276 277 The input string is not preprocessed and passed literally to the 278 underlying man commands. The man process is started asynchronously, 279 similar to `consult-grep'. See `consult-grep' for more details regarding 280 the asynchronous search. 281 282 (fn &optional INITIAL)" t) 283 (register-definition-prefixes "consult" '("consult-")) 284 285 286 ;;; Generated autoloads from consult-compile.el 287 288 (autoload 'consult-compile-error "consult-compile" "\ 289 Jump to a compilation error in the current buffer. 290 291 This command collects entries from compilation buffers and grep 292 buffers related to the current buffer. The command supports 293 preview of the currently selected error." t) 294 (register-definition-prefixes "consult-compile" '("consult-compile--")) 295 296 297 ;;; Generated autoloads from consult-flymake.el 298 299 (autoload 'consult-flymake "consult-flymake" "\ 300 Jump to Flymake diagnostic. 301 When PROJECT is non-nil then prompt with diagnostics from all 302 buffers in the current project instead of just the current buffer. 303 304 (fn &optional PROJECT)" t) 305 (register-definition-prefixes "consult-flymake" '("consult-flymake--")) 306 307 308 ;;; Generated autoloads from consult-imenu.el 309 310 (autoload 'consult-imenu "consult-imenu" "\ 311 Select item from flattened `imenu' using `completing-read' with preview. 312 313 The command supports preview and narrowing. See the variable 314 `consult-imenu-config', which configures the narrowing. 315 The symbol at point is added to the future history. 316 317 See also `consult-imenu-multi'." t) 318 (autoload 'consult-imenu-multi "consult-imenu" "\ 319 Select item from the imenus of all buffers from the same project. 320 321 In order to determine the buffers belonging to the same project, the 322 `consult-project-function' is used. Only the buffers with the 323 same major mode as the current buffer are used. See also 324 `consult-imenu' for more details. In order to search a subset of buffers, 325 QUERY can be set to a plist according to `consult--buffer-query'. 326 327 (fn &optional QUERY)" t) 328 (register-definition-prefixes "consult-imenu" '("consult-imenu-")) 329 330 331 ;;; Generated autoloads from consult-info.el 332 333 (autoload 'consult-info "consult-info" "\ 334 Full text search through info MANUALS. 335 336 (fn &rest MANUALS)" t) 337 (register-definition-prefixes "consult-info" '("consult-info--")) 338 339 340 ;;; Generated autoloads from consult-kmacro.el 341 342 (autoload 'consult-kmacro "consult-kmacro" "\ 343 Run a chosen keyboard macro. 344 345 With prefix ARG, run the macro that many times. 346 Macros containing mouse clicks are omitted. 347 348 (fn ARG)" t) 349 (register-definition-prefixes "consult-kmacro" '("consult-kmacro--")) 350 351 352 ;;; Generated autoloads from consult-org.el 353 354 (autoload 'consult-org-heading "consult-org" "\ 355 Jump to an Org heading. 356 357 MATCH and SCOPE are as in `org-map-entries' and determine which 358 entries are offered. By default, all entries of the current 359 buffer are offered. 360 361 (fn &optional MATCH SCOPE)" t) 362 (autoload 'consult-org-agenda "consult-org" "\ 363 Jump to an Org agenda heading. 364 365 By default, all agenda entries are offered. MATCH is as in 366 `org-map-entries' and can used to refine this. 367 368 (fn &optional MATCH)" t) 369 (register-definition-prefixes "consult-org" '("consult-org--")) 370 371 372 ;;; Generated autoloads from consult-register.el 373 374 (autoload 'consult-register-window "consult-register" "\ 375 Enhanced drop-in replacement for `register-preview'. 376 377 BUFFER is the window buffer. 378 SHOW-EMPTY must be t if the window should be shown for an empty register list. 379 380 (fn BUFFER &optional SHOW-EMPTY)") 381 (autoload 'consult-register-format "consult-register" "\ 382 Enhanced preview of register REG. 383 This function can be used as `register-preview-function'. 384 If COMPLETION is non-nil format the register for completion. 385 386 (fn REG &optional COMPLETION)") 387 (autoload 'consult-register "consult-register" "\ 388 Load register and either jump to location or insert the stored text. 389 390 This command is useful to search the register contents. For quick access 391 to registers it is still recommended to use the register functions 392 `consult-register-load' and `consult-register-store' or the built-in 393 built-in register access functions. The command supports narrowing, see 394 `consult-register--narrow'. Marker positions are previewed. See 395 `jump-to-register' and `insert-register' for the meaning of prefix ARG. 396 397 (fn &optional ARG)" t) 398 (autoload 'consult-register-load "consult-register" "\ 399 Do what I mean with a REG. 400 401 For a window configuration, restore it. For a number or text, insert it. 402 For a location, jump to it. See `jump-to-register' and `insert-register' 403 for the meaning of prefix ARG. 404 405 (fn REG &optional ARG)" t) 406 (autoload 'consult-register-store "consult-register" "\ 407 Store register dependent on current context, showing an action menu. 408 409 With an active region, store/append/prepend the contents, optionally 410 deleting the region when a prefix ARG is given. With a numeric prefix 411 ARG, store or add the number. Otherwise store point, frameset, window or 412 kmacro. 413 414 (fn ARG)" t) 415 (register-definition-prefixes "consult-register" '("consult-register-")) 416 417 418 ;;; Generated autoloads from consult-xref.el 419 420 (autoload 'consult-xref "consult-xref" "\ 421 Show xrefs with preview in the minibuffer. 422 423 This function can be used for `xref-show-xrefs-function'. 424 See `xref-show-xrefs-function' for the description of the 425 FETCHER and ALIST arguments. 426 427 (fn FETCHER &optional ALIST)") 428 (register-definition-prefixes "consult-xref" '("consult-xref--")) 429 430 ;;; End of scraped data 431 432 (provide 'consult-autoloads) 433 434 ;; Local Variables: 435 ;; version-control: never 436 ;; no-byte-compile: t 437 ;; no-update-autoloads: t 438 ;; no-native-compile: t 439 ;; coding: utf-8-emacs-unix 440 ;; End: 441 442 ;;; consult-autoloads.el ends here