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