]> git.eshelyaron.com Git - emacs.git/commitdiff
Documentation for the use-package macro
authorPhillip Lord <phillip.lord@russet.org.uk>
Thu, 17 Jan 2013 21:57:39 +0000 (21:57 +0000)
committerPhillip Lord <phillip.lord@russet.org.uk>
Thu, 17 Jan 2013 21:57:39 +0000 (21:57 +0000)
lisp/use-package/use-package.el

index 3dce341e9da490c1670754f9318b3f15c70b3a5c..63223a3a26ab4a67f0757bc036345681c1f82b06 100644 (file)
 
 
 (defmacro use-package (name &rest args)
+"Use a package with configuration options.
+
+For full documentation. please see commentary. 
+
+  (use-package package-name
+     :keyword option)
+:init Code to run when `use-package' form evals.
+:bind Perform key bindings, and define autoload for bound
+      commands.
+:commands Define autoloads for given commands.
+:mode Form to be added to `auto-mode-alist'.
+:interpreter Form to be added to `auto-interpreter-alist'.
+:defer Defer loading of package -- automatic
+       if :commands, :bind, :mode or :interpreter are used.
+:config Runs if and when package loads.
+:if Conditional loading.
+:disabled Ignore everything.
+:defines Define vars to silence byte-compiler.
+:load-path Add to `load-path' before loading.
+:diminish Support for diminish package (if it's installed).
+"
   (let* ((commands (plist-get args :commands))
          (pre-init-body (plist-get args :pre-init))
          (init-body (plist-get args :init))