WikEmacs - User contributions [en]

Ido

2012-04-28T16:30:55Z

Monotux:

{{Package
|name=Ido
|author = Kim F. Storm
|description=Interactive Do [[MiniBuffer]] Enhancement
|source=http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/ido.el
|maintainer=[[FSF]]
|in_emacs=yes
|Development status=active
}}

'''Ido''' - Interactively do things is a very convenient way to find files and switch buffers.

== Basic setup ==

<source lang="lisp">
(ido-mode)
(ido-everywhere 1)
</source>

== Helpful keybindings ==

; {{Keys|C-s}}
: Move to next ido suggestion.

; {{Keys|C-r}}
: Move to previous ido suggestion.

; {{Keys|C-f}}
: Temporarily revert to the default find-file behavior. Handy if [[ido]] won't behave as you'd like.

== Common Customization ==

=== Enable Fuzzy Matching ===

<syntaxhighlight lang="lisp">
(setq ido-enable-flex-matching t)
</syntaxhighlight>

=== Ignore Case ===

{{Snippet|(setq ido-case-fold t)}}

=== Virtual Buffers ===

If [[Recentf]] is enabled, you can use {{CommandKeys|C-x b|ido-switch-buffer}} to visit recently closed files by enabling virtual buffers:
{{Snippet|(setq ido-use-virtual-buffers t)}}

=== Prevent Auto-Merge ===

Ido's default behavior when there is no matching file in the current directory is to look in recent working directories. If you prefer to limit {{CommandKeys|C-x C-f|ido-find-file}} to the current directory you can disable this ''auto-merge'' behavior:
{{Snippet|(setq ido-auto-merge-work-directories-length -1) ;; disable auto-merge}}

You can still look in other working directories explicitly with {{Keys|M-s|ido-merge-work-directories}}.

=== Directory Caching on Windows ===

On [[Windows]] operating systems it can be unreliable to cache directory listings: the directory may not appear to be modified even though files have been added or removed. Ido caches directory listings by default, which may cause confusion on Windows. You can disable caching:

<syntaxhighlight lang="lisp">
(when (equal system-type 'windows-nt)
(setq ido-max-dir-file-cache 0)) ; caching unreliable
</syntaxhighlight>

=== Specifying sort-order ===
If you'd like to tweak the default file sorting, like making [[Org]]-files appear first, tell [[ido]] which files to give a higher sort priority:
<syntaxhighlight lang="lisp">
(setq ido-file-extensions-order '(".org" ".txt" ".py" ".emacs" ".xml" ".el"
".ini" ".cfg" ".conf"))
</syntaxhighlight>

== See Also ==

[[Helm]]

== External Links ==

[http://www.masteringemacs.org/articles/2010/10/10/introduction-to-ido-mode/ Introduction to Ido Mode]

[[Category:Completion]]
[[Category:Built-in Package]]
[[Category:MiniBuffer]]
[[Category:Convenience]]
[[Category:Minor Mode]]
[[Category:Buffer Navigation]]
[[Category:Popular Package]]

Package.el

2012-04-12T14:07:29Z

Monotux: Snippet requires cl which wasn't loaded

{{Package
|name=package.el
|description=Package Manager
|author=Tom Tromey
|maintainer=[[FSF]]
|source=http://repo.or.cz/w/emacs.git/blob_plain/HEAD:/lisp/emacs-lisp/package.el
|in_emacs=yes
|Development status=active
}}

package.el is the built-in package manager in Emacs 24.

== Install package.el on Emacs 23 ==
<tt>package.el</tt> is bundled with Emacs 24, but it’s not bound to Emacs 23. Before it became part of Emacs it was an external package, known as ELPA (I guess that stood for Emacs Lisp Package Manager or something similar). So even if you’re an Emacs 23 user you can copy the latest version of <tt>package.el</tt> from [http://repo.or.cz/w/emacs.git/blob_plain/1a0a666f941c99882093d7bd08ced15033bc3f0c:/lisp/emacs-lisp/package.el here] and enjoy it.

== Configuration ==
Put the following snippet of code near the beginning of your Emacs config, since you’ll definitely want packages installed via <tt>package.el</tt> to be initalized ''before'' you start tweaking them.
<source lang="lisp">
(require 'package)
(package-initialize)
</source>

== How it works ==
What <tt>package.el</tt> basically does is that it connects to a list of package repositories, retrieves the list of the packages there, presents it to you in a interactive fashion and lets you install the packages you like (of course you can also remove the once you don’t like). <tt>package.el</tt> understands the dependencies between packages and if one package requires others to run they will be installed automatically (which is really neat).

The magic starts with the command {{Command|package-list-packages}}. At this point you should see something in the lines of this.

You can navigate the list of packages, mark the ones you want to install with the “i” key or the ones you want removed with the “d” key and when you’re done you can press the “x” key to execute the scheduled actions.

Initially <tt>package.el</tt> didn’t provide the option to update a package, but that should be fixed in recent Emacs builds. According to this [http://lists.gnu.org/archive/html/emacs-devel/2011-09/msg00371.html thread] you can even update all of the installed packages by using the “U” key in the packages list view (I guess that a small “u” would update only one package). Unfortunately my build is lacking those capabilities so I cannot comment of their usability.

== How to add additional repository ==
You’d probably notice that your list of available packages is not particularly long. That’s because the official Emacs 24 package repository has a strict licensing (and source code) requirements to include a package there. Luckily there are a number of community-maintained <tt>package.el</tt> repos around with much more relaxed requirements. Probably the most popular of them is [http://marmalade-repo.org/ Marmalade], created by [http://nex-3.com/ Nathan Weizenbaum] of Sass and Haml fame. You can include it in your <tt>package-archives</tt> list like this:

<pre class="cl">(add-to-list 'package-archives
'("marmalade" . "http://marmalade-repo.org/packages/") t)</pre>
Marmalade provides a web based UI for package upload and search (both quite buggy unfortunately) and the ability to share the maintenance of a package between several people, who’ll be able to upload new version of the package. There’s also a Emacs Lisp Marmalade tool, that allows you to submit packages directly from Emacs.

== How to use it with a custom build ==
Using the <tt>package.el</tt> UI is ok if you’re a casual Emacs user, but what if you have a custom Emacs configuration, stored under version control, that you’d like to instantly deploy on any OS/machine (like Emacs Prelude). Here in play comes <tt>package.el</tt>’s programmer interface. In [https://github.com/bbatsov/emacs-prelude Emacs Prelude] I use the following code to install a list of required packages automatically on Emacs startup (if necessary):

<pre class="cl">;; Comment out if you've already loaded this package...
(require 'cl)

(defvar prelude-packages
'(ack-and-a-half auctex clojure-mode coffee-mode deft expand-region
gist groovy-mode haml-mode haskell-mode inf-ruby
magit magithub markdown-mode paredit projectile python
sass-mode rainbow-mode scss-mode solarized-theme
volatile-highlights yaml-mode yari zenburn-theme)
"A list of packages to ensure are installed at launch.")

(defun prelude-packages-installed-p ()
(loop for p in prelude-packages
when (not (package-installed-p p)) do (return nil)
finally (return t)))

(unless (prelude-packages-installed-p)
;; check for new packages (package versions)
(message "%s" "Emacs Prelude is now refreshing its package database...")
(package-refresh-contents)
(message "%s" " done.")
;; install the missing packages
(dolist (p prelude-packages)
(when (not (package-installed-p p))
(package-install p))))

(provide 'prelude-packages)
;;; prelude-packages.el ends here</pre>
This code check if all of the packages in the list are installed and if any of them are not installed if refreshes the local package database (in the case a required package for recently added to the remote repo) and installs them.

== How to publish it to Marmalade ==
To be able to publish a package to Marmalade (or another repo) it should comform a standardized structure. A single-file package might look like this:

<pre>
;;; sass-mode.el --- Sass major mode

;; Copyright 2007-2010 Nathan Weizenbaum

;; Author: Nathan Weizenbaum <nex342@gmail.com>
;; URL: http://github.com/nex3/sass-mode
;; Version: 3.0.20
;; Package-Requires: ((haml-mode "3.0.20"))

;; Code goes here

;;; sass-mode.el ends here
</pre>

A multi-file package should have an additional file named
`<name>-pkg.el` that should look like this:

<pre>
(define-package "sass-mode" "3.0.20"
"Sass major mode"
'((haml-mode "3.0.20")))

</pre>

== package.el Repositories ==

* [[ELPA]]
* [[MELPA]]
* [[Marmalade]]

== External links ==

* [http://batsov.com/articles/2012/02/19/package-management-in-emacs-the-good-the-bad-and-the-ugly/ Package Management in Emacs]

[[Category:Package Manager]]

Bookmarks

2012-03-31T15:55:35Z

Monotux: Minor typo fix + how to set another bookmarks-file manually.

{{Package
|name=recentf
|description=helps opening a file that is recently visited
|source=http://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/bookmarks.el
|maintainer=[[FSF]]
|in_emacs=yes
|Development status=active
}}

Bookmarks are somewhat like registers in that they record positions you can jump to. Unlike registers, they have long names, and they persist automatically from one Emacs session to the next. The prototypical use of bookmarks is to record “where you were reading” in various files.

== Command about Bookmarks ==

*C-x r m <RET> Set the bookmark for the visited file, at point.
*C-x r m bookmark <RET> Set the bookmark named bookmark at point (bookmark-set).
*C-x r b bookmark <RET> Jump to the bookmark named bookmark (bookmark-jump).
*C-x r l List all bookmarks (list-bookmarks).
*M-x bookmark-save Save all the current bookmark values in the default bookmark file.

== Changing the default bookmarks-file ==
By default, bookmarks are saved to the file <tt>~/.emacs.bmk</tt>, outside of your <tt>~/.emacs.d</tt> directory. To change this to another file, set the variable <tt>bookmark-default-file</tt> to what you like:
<syntaxhighlight lang="lisp">
(setq bookmark-default-file "~/.emacs.d/bookmarks")
</syntaxhighlight>

[[Category:Utilities]] [[Category:Bookmarks]]
[[Category:Native Package]] [[ Category:File Navigation]]