[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
20/23: doc: Reorganize "Emacs Interface" node.
From: |
Alex Kost |
Subject: |
20/23: doc: Reorganize "Emacs Interface" node. |
Date: |
Sun, 30 Aug 2015 15:28:16 +0000 |
alezost pushed a commit to branch master
in repository guix.
commit c554de892901e1375d55fa953855a01c32154189
Author: Alex Kost <address@hidden>
Date: Thu Aug 13 20:16:29 2015 +0300
doc: Reorganize "Emacs Interface" node.
* doc/guix.texi (Package Management): Move "Emacs Interface" node to ...
(Top): ...here, since it is not just about package management.
* doc/emacs.texi: Shift all nodes one level up (@section -> @chapter, etc.).
Rename "Emacs Usage" node into "Emacs Package Management". Move "Emacs
Configuration" node here.
---
doc/emacs.texi | 58 ++++++++++++++++++++++++++++---------------------------
doc/guix.texi | 20 ++++++++++++------
2 files changed, 43 insertions(+), 35 deletions(-)
diff --git a/doc/emacs.texi b/doc/emacs.texi
index 180037a..5fa15d7 100644
--- a/doc/emacs.texi
+++ b/doc/emacs.texi
@@ -1,29 +1,21 @@
@node Emacs Interface
address@hidden Emacs Interface
address@hidden Emacs Interface
@cindex Emacs
-GNU Guix comes with a visual user interface for address@hidden, known
-as ``guix.el''. It can be used for routine package management tasks,
-pretty much like the @command{guix package} command (@pxref{Invoking
-guix package}). Specifically, ``guix.el'' makes it easy to:
-
address@hidden
address@hidden browse and display packages and generations;
address@hidden search, install, upgrade and remove packages;
address@hidden display packages from previous generations;
address@hidden do some other useful things.
address@hidden itemize
+GNU Guix comes with several useful modules (known as ``guix.el'') for
address@hidden which are intended to make an Emacs user interaction with
+Guix convenient and fun.
@menu
* Initial Setup: Emacs Initial Setup. Preparing @file{~/.emacs}.
-* Usage: Emacs Usage. Using the interface.
-* Configuration: Emacs Configuration. Configuring the interface.
+* Package Management: Emacs Package Management. Managing packages and
generations.
* Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}}
file names.
* Completions: Emacs Completions. Completing @command{guix} shell
command.
@end menu
+
@node Emacs Initial Setup
address@hidden Initial Setup
address@hidden Initial Setup
On the Guix System Distribution (@pxref{GNU Distribution}), ``guix.el''
is ready to use, provided Guix is installed system-wide, which is the
@@ -105,22 +97,32 @@ emacs, The GNU Emacs Manual}).
You can activate Emacs packages installed in your profile whenever you
want using @address@hidden
address@hidden Emacs Usage
address@hidden Usage
+
address@hidden Emacs Package Management
address@hidden Package Management
Once ``guix.el'' has been successfully configured, you should be able to
-use commands for displaying packages and generations. This information
-can be displayed in a ``list'' or ``info'' buffer.
+use a visual interface for routine package management tasks, pretty much
+like the @command{guix package} command (@pxref{Invoking guix package}).
+Specifically, it makes it easy to:
+
address@hidden
address@hidden browse and display packages and generations;
address@hidden search, install, upgrade and remove packages;
address@hidden display packages from previous generations;
address@hidden do some other useful things.
address@hidden itemize
@menu
* Commands: Emacs Commands. @kbd{M-x address@hidden
* General information: Emacs General info. Common for both interfaces.
* ``List'' buffer: Emacs List buffer. List-like interface.
* ``Info'' buffer: Emacs Info buffer. Help-like interface.
+* Configuration: Emacs Configuration. Configuring the interface.
@end menu
@node Emacs Commands
address@hidden Commands
address@hidden Commands
All commands for displaying packages and generations use the current
profile, which can be changed with
@@ -191,7 +193,7 @@ Once @command{guix pull} has succeeded, the Guix REPL is
restared. This
allows you to keep using the Emacs interface with the updated Guix.
@node Emacs General info
address@hidden General information
address@hidden General information
The following keys are available for both ``list'' and ``info'' types of
buffers:
@@ -235,7 +237,7 @@ was restarted, you may want to revert ``list'' buffer (by
pressing
@kbd{g}).
@node Emacs List buffer
address@hidden ``List'' buffer
address@hidden ``List'' buffer
An interface of a ``list'' buffer is similar to the interface provided
by ``package.el'' (@pxref{Package Menu,,, emacs, The GNU Emacs Manual}).
@@ -310,7 +312,7 @@ with another marked generation.
@end table
@node Emacs Info buffer
address@hidden ``Info'' buffer
address@hidden ``Info'' buffer
The interface of an ``info'' buffer is similar to the interface of
@code{help-mode} (@pxref{Help Mode,,, emacs, The GNU Emacs Manual}).
@@ -485,11 +487,11 @@ Various settings for ``info'' buffers.
@node Emacs Prettify
address@hidden Guix Prettify Mode
address@hidden Guix Prettify Mode
-Along with ``guix.el'', address@hidden comes with ``guix-prettify.el''.
-It provides a minor mode for abbreviating store file names by replacing
-hash sequences of symbols with address@hidden'':
address@hidden also comes with ``guix-prettify.el''. It provides a minor
+mode for abbreviating store file names by replacing hash sequences of
+symbols with address@hidden'':
@example
/gnu/store/72f54nfp6g1hz873w8z3gfcah0h4nl9p-foo-0.1
@@ -526,7 +528,7 @@ mode hooks (@pxref{Hooks,,, emacs, The GNU Emacs Manual}),
for example:
@node Emacs Completions
address@hidden Shell Completions
address@hidden Shell Completions
Another feature that becomes available after configuring Emacs interface
(@pxref{Emacs Initial Setup}) is completing of @command{guix}
diff --git a/doc/guix.texi b/doc/guix.texi
index 5a9ebc9..cb5bbab 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -70,6 +70,7 @@ package management tool written for the GNU system.
* Introduction:: What is Guix about?
* Installation:: Installing Guix.
* Package Management:: Package installation, upgrade, etc.
+* Emacs Interface:: Using Guix from Emacs.
* Programming Interface:: Using Guix in Scheme.
* Utilities:: Package management commands.
* GNU Distribution:: Software for your friendly GNU system.
@@ -101,13 +102,19 @@ Package Management
* Features:: How Guix will make your life brighter.
* Invoking guix package:: Package installation, removal, etc.
-* Emacs Interface:: Package management from Emacs.
* Substitutes:: Downloading pre-built binaries.
* Packages with Multiple Outputs:: Single source package, multiple outputs.
* Invoking guix gc:: Running the garbage collector.
* Invoking guix pull:: Fetching the latest Guix and distribution.
* Invoking guix archive:: Exporting and importing store files.
+Emacs Interface
+
+* Initial Setup: Emacs Initial Setup. Preparing @file{~/.emacs}.
+* Package Management: Emacs Package Management. Managing packages and
generations.
+* Prettify Mode: Emacs Prettify. Abbreviating @file{/gnu/store/@dots{}}
file names.
+* Completions: Emacs Completions. Completing @command{guix} shell
command.
+
Programming Interface
* Defining Packages:: Defining new packages.
@@ -964,14 +971,13 @@ features.
This chapter describes the main features of Guix, as well as the package
management tools it provides. Two user interfaces are provided for
-routine package management tasks: a command-line interface
-(@pxref{Invoking guix package, @code{guix package}}), and a visual user
-interface in Emacs (@pxref{Emacs Interface}).
+routine package management tasks: A command-line interface described below
+(@pxref{Invoking guix package, @code{guix package}}), as well as a visual user
+interface in Emacs described in a subsequent chapter (@pxref{Emacs Interface}).
@menu
* Features:: How Guix will make your life brighter.
* Invoking guix package:: Package installation, removal, etc.
-* Emacs Interface:: Package management from Emacs.
* Substitutes:: Downloading pre-built binaries.
* Packages with Multiple Outputs:: Single source package, multiple outputs.
* Invoking guix gc:: Running the garbage collector.
@@ -1455,8 +1461,6 @@ Finally, since @command{guix package} may actually start
build
processes, it supports all the common build options that @command{guix
build} supports (@pxref{Invoking guix build, common build options}).
address@hidden emacs.texi
-
@node Substitutes
@section Substitutes
@@ -1898,6 +1902,8 @@ automatically builds them. The build process may be
controlled with the
same options that can be passed to the @command{guix build} command
(@pxref{Invoking guix build, common build options}).
address@hidden
*********************************************************************
address@hidden emacs.texi
@c *********************************************************************
@node Programming Interface
- 10/23: emacs: Add 'guix-lint-checker-names'., (continued)
- 10/23: emacs: Add 'guix-lint-checker-names'., Alex Kost, 2015/08/30
- 17/23: ui: Add 'run-guix'., Alex Kost, 2015/08/30
- 11/23: guix graph: Export node types and <node-type> accessors., Alex Kost, 2015/08/30
- 12/23: emacs: Add 'guix-graph-type-names'., Alex Kost, 2015/08/30
- 18/23: emacs: Add code to run guix command in REPL., Alex Kost, 2015/08/30
- 15/23: emacs: Add minibuffer readers., Alex Kost, 2015/08/30
- 19/23: emacs: Add code to run guix command in shell., Alex Kost, 2015/08/30
- 13/23: emacs: Add 'guix-package-names'., Alex Kost, 2015/08/30
- 14/23: emacs: Add help variables., Alex Kost, 2015/08/30
- 21/23: emacs: Add "guix-popup.el"., Alex Kost, 2015/08/30
- 20/23: doc: Reorganize "Emacs Interface" node.,
Alex Kost <=
- 23/23: emacs: Use prompt for packages instead popup for edit action., Alex Kost, 2015/08/30
- 16/23: emacs: Add and use alist accessors., Alex Kost, 2015/08/30
- 22/23: emacs: Add popup interface for guix commands., Alex Kost, 2015/08/30