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