: [[image:iciclesimage]] || *Previous:* '''[[Icicles]]''' || IciclesIndex || *Next:* [[Icicles - Screenshots]] || ---- == Icicles Libraries == "'''Icicles'''" refers to a set of libraries that enhance [[minibuffer]] input, providing [[Icicles - Cycling Completions|cycling]] among completion candidates and more powerful [[completion]]. It is composed of the following '''''required''''' libraries: [:Required] === Required === * '''[[icicles.el]]''' -- main library * [[icicles-chg.el]] -- change logs (no code) * [[icicles-cmd1.el]] -- top-level [[command]]s, part 1 * [[icicles-cmd2.el]] -- top-level commands, part 2 * [[icicles-doc1.el]] -- first part of the doc (##Commentary##, no code) * [[icicles-doc2.el]] -- second part of the doc (##Commentary##, no code) * [[icicles-face.el]] -- [[face]]s (customizable) * [[icicles-fn.el]] -- non-interactive functions * [[icicles-mac.el]] -- macros * [[icicles-mcmd.el]] -- minibuffer commands * [[icicles-mode.el]] -- ''Icicle'' mode definition * [[icicles-opt.el]] -- [[user option]]s (customizable [[variable]]s) * [[icicles-var.el]] -- internal variables When you load (e.g. `load-library' or `require') the driver library, '''[[icicles.el]]''', the others are all loaded automatically, except for ##icicles-chg.el##, ##icicles-doc1.el## and ##icicles-doc2.el##, which need not be loaded (they contain only a change log and documentation, as comments). [:Optional] === Optional, But Recommended === The following libraries are recommended but '''''optional''''' (loaded by [[icicles.el]] if in your `load-path', otherwise ignored). They are enhanced by '''Icicles''', or '''Icicles''' is enhanced by them, or both. ||[[apropos-fn+var.el]] ||Apropos enhancements for functions and [[variable]]s. || ||[[bookmark+.el]] etc.||Many bookmark enhancements. See '''[[Bookmark+]]''' and [[Icicles - Bookmark Enhancements]].|| ||[[col-highlight.el]] ||Required by ##crosshairs.el## (Emacs 22+). See HighlightCurrentColumn.|| ||[[crosshairs.el]] ||Highlight target positions -- see CrosshairHighlighting.|| ||[[doremi.el]], [[doremi-frm.el]] ||Incremental changes -- see [[Icicles - Completions Display]], [[Icicles - Completion Methods and Styles#SwankCompletion|Icicles - Fuzzy Symbol Completion]], and [[option]] [[Icicles - Customization and General Tips#icicle-max-candidates|icicle-max-candidates]].|| ||[[frame-cmds.el]] ||[[FrameModes#frame-cmds.el|Frame and window commands]].|| ||[[fuzzy-match.el]] ||See [[Icicles - Completion Methods and Styles]].|| ||[[hexrgb.el]] ||Color manipulation. I strongly recommend that you include this library.|| ||[[hl-line+.el]] ||Required by ##crosshairs.el## (Emacs 22+). See HighlightCurrentLine.|| ||[[icomplete+.el]] ||See [[Icicles - Icompletion]] and '''[[IcompleteMode#IcompleteModePlus|Icomplete+]]'''.|| ||[[info+.el]] ||See [[Icicles - Info Enhancements]] and '''[[Info+]]'''.|| ||[[lacarte.el]] ||Keyboard access to the [[menu bar]] menus -- see '''LaCarte'''. Used with '''Icicles''', you can type a substring or a [[regexp]] that matches any part of a [[menu bar]] menu tree, and you can cycle among [[completion]] candidates to easily navigate menus and choose a menu item.|| ||[[mb-depth+.el]] ||MinibufferDepthIndicator, for recursive [[minibuffer]]s (Emacs 22 and later).|| ||[[pp+.el]] ||Pretty-printing for `##M-:##'. See '''[[EvaluatingExpressions#PpPlus|Pp+]]'''.|| ||[[synonyms.el]] ||A hypertext thesaurus. See '''[[Synonyms]]'''.|| ||[[thingatpt+.el]] ||Better defaults when using commands; better possibilities for `##M-.##'. See '''[[ThingAtPoint+]]''' and [[Icicles - Inserting Text from Cursor]].|| ||[[vline.el]] ||Required by ##crosshairs.el## (Emacs 22+). See VlineMode.|| Be aware that some of these libraries in turn require other libraries. For example, library ##frame-cmds.el## requires library [[frame-fns.el]] Depending on your platform, if you use '''Icicles''' in a text terminal (that is, without a window system/manager), then you might need to change some of the key bindings, if some of the default bindings are not available to you. If on your platform, for example, Emacs in a text terminal does not recognize a key such as `S-TAB' (as something different from `TAB'), then you will want to change that key binding. To customize '''Icicles''' key bindings, see [[Icicles - Customizing Key Bindings]]. You might also want to customize some of the '''Icicles''' faces, since a text terminal is sometimes limited in the colors it can handle. [:byte-compile] It is of course best to byte-compile all of the libraries (except ##icicles-chg.el##, ##icicles-doc1.el##, and ##icicles-doc2.el##). You will likely get some byte-compiler warning messages. These are probably benign -- ignore them. '''Icicles''' is designed to work with multiple versions of Emacs, and that fact provokes compiler warnings. If you get byte-compiler errors (not warnings), then please report a bug, using `M-x icicle-send-bug-report'. === Updating === Whenever you update '''Icicles''' (i.e., download new versions of '''Icicle''' source files), I recommend that you do the following: # Delete all existing byte-compiled '''Icicles''' files (##icicles*.elc##). # Load '''Icicles''' (`load-library' or `require'). # Byte-compile the source files. In particular, always load ##icicles-mac.el## (''not'' ##icicles-mac.el####c##) before you byte-compile new versions of the files, in case there have been any changes to Lisp macros (in ##icicles-mac.el##). After startup, you can turn ''Icicle'' mode on or off at any time interactively, using command '''`icy-mode'''' (aka `icicle-mode' -- prefix `icy' is unique to this command, so it is easier to complete). '''Note:''' If you turn on ''Icicle'' mode in your [[init file]], it's generally best to do so as late as possible -- after you or any libraries that you load do any key binding. This is because '''Icicles''' uses the current global key bindings to determine which keys to bind for minibuffer completion and cycling. To pick up the latest bindings at any time, you can of course enter ''Icicle'' mode interactively using command `icy-mode' (if necessary, exit, then re-enter). '''Note:''' '''Icicles''' redefines some functions when you are in ''Icicle'' mode (it restores them when you leave ''Icicle'' mode). It generally does not use `defadvice' to alter the functions; it redefines them instead. Because of this, there can be incompatibilities with other libraries that also change the same functions (using `defadvice' or otherwise). An example is ViperMode. If you load Viper before '''Icicles''', then you will run into problems with function `read-file-name' because it is tweaked by both Viper and Icicles. If you load '''Icicles''' before Viper, you should not encounter this problem (but you might encounter other problems: both '''Icicles''' and Viper try to control the minibuffer). == Checking What Has Changed == Here's one way to check which '''Icicles''' libraries have changed recently: '''[https://www.emacswiki.org/emacs?action=rc;match=%5Cicicles.*.el?$;days=28;all=1;showedit=1 Latest Icicles Changes]''' [:BulkIciclesDownload] == Downloading Icicles Libraries == [new:DrewAdams:2017-10-14 22:52 UTC] '''NOTE:''' '''Icicles''', as well as my other libraries that are on %%EmacsWiki%%, used to be obtainable also from [[MELPA]]. You may still find some of them there, but they are likely ''not up-to-date''. As of 2017-10, [[MELPA]] has decided to no longer accept Lisp libraries from %%EmacsWiki%%. This includes my libraries, even though these libraries are read-only (administrator lock on the wiki pages). Too bad. This means that you must download '''Icicles''' and my other libraries only from Emacs Wiki. Sorry about that. I upload '''Icicles''' files only to the wiki. [new] '''1.''' '''Download Files Individually''' You can download the '''Icicles''' files individually from ElispArea, by clicking the link for each and then right-clicking its `Download' link, and choosing `Save As' in your browser. You will need to do that on ''each'' file page. '''2.''' '''Bulk Download From Within Emacs''' Two alternative methods: * Use library [[icicles-install.el]]. See the simple instructions in the file header, and read the docstring for [[user option]] `icicle-files-to-download-list', defined there. This method is based on the [[ELPA]] initialization code. It uses [[UrlPackage]], if available; otherwise it uses `wget'. Thanks to AnupamSengupta for this. * Use library [[auto-install.el]]. Set it up like this: ##(setq auto-install-save-confirm nil)##. Do `M-x auto-install-batch', then enter `icicles'. -- Thanks to AndyStewart for this. '''3.''' '''Bulk Download Using a Shell Script Outside Emacs:''' (UNIX, GNU/Linux) Use `wget': [[get-icicles.sh]]. Thanks to LeWang for that. Thanks to MishaGorodnitzky for tweaking it to get around an EmacsWiki limit on how many files you can download per second. '''4'''. '''Bulk Download Using a Python script''': [[icicles_dler.py]]. Runs under python2.5.2. Thanks to DarrenYin. (The script is still "somewhat sketchy". -- DarrenYin) This downloads only Icicles files, not any of its dependencies or recommended libraries. '''5.''' '''Bulk Download Using `wget' Directly''' * Required libraries: wget https://www.emacswiki.org/emacs/download/icicles{,-chg,-cmd1,-cmd2,-doc1,-doc2,-face,-fn,-mac,-mcmd,-mode,-opt,-var}.el July 26th 2019, Error 400 - bad request * Optional libraries: wget https://www.emacswiki.org/emacs/download/{apropos-fn%2bvar,bookmark%2b,col-highlight,crosshairs,doremi,doremi-frm,frame-cmds,fuzzy-match,hexrgb,hl-line%2b,icomplete%2b,info%2b,lacarte,mb-depth%2b,pp%2b,synonyms,thingatpt%2b,vline}.el -- JoniDiMontago [new:DrewAdams:2009-04-17 07:54 UTC Updated by BoruchBaum 2018-04-03] '''Note:''' The remaining methods perform downloads from the GitHubMirror, and so have in common two disadvantages: 1) They download only the Icicles files themselves, not any of their dependencies or recommended related libraries. Those related libraries are also available on the GitHubMirror, but in ''separate'' git repositories; 2) They might not always have the absolute most up-to-date version because the GitHubMirror is updated only periodically (e.g. once a week). (Note too that repository names on GitHub cannot contain a plus character (`##+##'). So, for example, '''[[Bookmark+]]''' files are available from repository https://github.com/emacsmirror/bookmark-plus, not ##https://github.com/emacsmirror/bookmark+##.) [new] '''6.''' '''Manual Download Using `git'''' The GitHubMirror contains a git repository that includes the '''[[https://github.com/emacsmirror/icicles Icicles files]]''' (https://github.com/emacsmirror/icicles), as well as other repositories. Note that if you do not need the entire git history of each '''Icicles''' file, you can clone a subset using the options --depth=1 --branch=master [:ZipFileDownload] '''7.''' '''Manual GitHub Download Using a Zip File''' You can download an automatically generated zip file of '''Icicles''' files from the '''[[https://github.com/emacsmirror/icicles Icicles repository]]''' on the GitHubMirror. '''8.''' '''Download and update all the libraries using a `bash' script written by the creator of the '''[[https://www.youtube.com/channel/UCEqYjPJdmEcUVfHmQwJVM9A Emacs Elements]] Channel''' Watch the '''[[https://youtu.be/UEa8boIqKcg Video]]''' and get the '''[[https://github.com/emacs-elements/public_elements/blob/main/drew-adams-packages.sh Script]]'''. ---- || *Previous:* '''[[Icicles]]''' || IciclesIndex || *Next:* [[Icicles - Screenshots]] || DrewsElispLibraries referenced here: Lisp:lacarte.el, Lisp:icicles.el, Lisp:icicles-chg.el, Lisp:icicles-cmd1.el, Lisp:icicles-cmd2.el, Lisp:icicles-face.el, Lisp:icicles-fn.el, Lisp:icicles-mac.el, Lisp:icicles-mode.el, Lisp:icicles-opt.el, Lisp:icicles-var.el, Lisp:icomplete+.el ---- CategoryCommands CategoryCompletion CategoryRegexp