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