consult-autoloads.el (17417B)
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', which also offers a 118 `completing-read' interface to the `kill-ring'. Additionally the 119 Consult 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', which also offers a 129 `completing-read' interface to the `kill-ring'. Additionally the 130 Consult 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 (fn STRING)" t) 140 (autoload 'consult-bookmark "consult" "\ 141 If bookmark NAME exists, open it, otherwise create a new bookmark with NAME. 142 143 The command supports preview of file bookmarks and narrowing. See the 144 variable `consult-bookmark-narrow' for the narrowing configuration. 145 146 (fn NAME)" t) 147 (autoload 'consult-complex-command "consult" "\ 148 Select and evaluate command from the command history. 149 150 This command can act as a drop-in replacement for `repeat-complex-command'." t) 151 (autoload 'consult-history "consult" "\ 152 Insert string from HISTORY of current buffer. 153 In order to select from a specific HISTORY, pass the history 154 variable as argument. INDEX is the name of the index variable to 155 update, if any. BOL is the function which jumps to the beginning 156 of the prompt. See also `cape-history' from the Cape package. 157 158 (fn &optional HISTORY INDEX BOL)" t) 159 (autoload 'consult-isearch-history "consult" "\ 160 Read a search string with completion from the Isearch history. 161 162 This replaces the current search string if Isearch is active, and 163 starts a new Isearch session otherwise." t) 164 (autoload 'consult-minor-mode-menu "consult" "\ 165 Enable or disable minor mode. 166 167 This is an alternative to `minor-mode-menu-from-indicator'." t) 168 (autoload 'consult-theme "consult" "\ 169 Disable current themes and enable THEME from `consult-themes'. 170 171 The command supports previewing the currently selected theme. 172 173 (fn THEME)" t) 174 (autoload 'consult-buffer "consult" "\ 175 Enhanced `switch-to-buffer' command with support for virtual buffers. 176 177 The command supports recent files, bookmarks, views and project files as 178 virtual buffers. Buffers are previewed. Narrowing to buffers (b), files (f), 179 bookmarks (m) and project files (p) is supported via the corresponding 180 keys. In order to determine the project-specific files and buffers, the 181 `consult-project-function' is used. The virtual buffer SOURCES 182 default to `consult-buffer-sources'. See `consult--multi' for the 183 configuration of the virtual buffer sources. 184 185 (fn &optional SOURCES)" t) 186 (autoload 'consult-project-buffer "consult" "\ 187 Enhanced `project-switch-to-buffer' command with support for virtual buffers. 188 The command may prompt you for a project directory if it is invoked from 189 outside a project. See `consult-buffer' for more details." t) 190 (autoload 'consult-buffer-other-window "consult" "\ 191 Variant of `consult-buffer', switching to a buffer in another window." t) 192 (autoload 'consult-buffer-other-frame "consult" "\ 193 Variant of `consult-buffer', switching to a buffer in another frame." t) 194 (autoload 'consult-buffer-other-tab "consult" "\ 195 Variant of `consult-buffer', switching to a buffer in another tab." t) 196 (autoload 'consult-grep "consult" "\ 197 Search with `grep' for files in DIR where the content matches a regexp. 198 199 The initial input is given by the INITIAL argument. DIR can be nil, a 200 directory string or a list of file/directory paths. If `consult-grep' 201 is called interactively with a prefix argument, the user can specify the 202 directories or files to search in. Multiple directories or files must 203 be separated by comma in the minibuffer, since they are read via 204 `completing-read-multiple'. By default the project directory is used if 205 `consult-project-function' is defined and returns non-nil. Otherwise 206 the `default-directory' is searched. If the command is invoked with a 207 double prefix argument (twice `C-u') the user is asked for a project, if 208 not yet inside a project, or the current project is searched. 209 210 The input string is split, the first part of the string (grep input) is 211 passed to the asynchronous grep process and the second part of the 212 string is passed to the completion-style filtering. 213 214 The input string is split at a punctuation character, which is given as 215 the first character of the input string. The format is similar to 216 Perl-style regular expressions, e.g., /regexp/. Furthermore command 217 line options can be passed to grep, specified behind --. The overall 218 prompt input has the form `#async-input -- grep-opts#filter-string'. 219 220 Note that the grep input string is transformed from Emacs regular 221 expressions to Posix regular expressions. Always enter Emacs regular 222 expressions at the prompt. `consult-grep' behaves like builtin Emacs 223 search commands, e.g., Isearch, which take Emacs regular expressions. 224 Furthermore the asynchronous input split into words, each word must 225 match separately and in any order. See `consult--regexp-compiler' for 226 the inner workings. In order to disable transformations of the grep 227 input, adjust `consult--regexp-compiler' accordingly. 228 229 Here we give a few example inputs: 230 231 #alpha beta : Search for alpha and beta in any order. 232 #alpha.*beta : Search for alpha before beta. 233 #\\(alpha\\|beta\\) : Search for alpha or beta (Note Emacs syntax!) 234 #word -- -C3 : Search for word, include 3 lines as context 235 #first#second : Search for first, quick filter for second. 236 237 The symbol at point is added to the future history. 238 239 (fn &optional DIR INITIAL)" t) 240 (autoload 'consult-git-grep "consult" "\ 241 Search with `git grep' for files in DIR with INITIAL input. 242 See `consult-grep' for details. 243 244 (fn &optional DIR INITIAL)" t) 245 (autoload 'consult-ripgrep "consult" "\ 246 Search with `rg' for files in DIR with INITIAL input. 247 See `consult-grep' for details. 248 249 (fn &optional DIR INITIAL)" t) 250 (autoload 'consult-find "consult" "\ 251 Search for files with `find' in DIR. 252 The file names must match the input regexp. INITIAL is the 253 initial minibuffer input. See `consult-grep' for details 254 regarding the asynchronous search and the arguments. 255 256 (fn &optional DIR INITIAL)" t) 257 (autoload 'consult-fd "consult" "\ 258 Search for files with `fd' in DIR. 259 The file names must match the input regexp. INITIAL is the 260 initial minibuffer input. See `consult-grep' for details 261 regarding the asynchronous search 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