emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Emacs manual: correct @code to @kbd


From: Aaron S. Hawley
Subject: Emacs manual: correct @code to @kbd
Date: Mon, 8 Jun 2009 14:58:52 -0400

I found a dozen places in the Emacs manual where the markup should be
@kbd and not @code.

Here's a patch.

cvs diff: Diffing doc/emacs
Index: doc/emacs/basic.texi
2009-06-08  Aaron S. Hawley  <address@hidden>

        * basic.texi (Continuation Lines): Use @kbd for keys instead of @code.

        * building.texi (GDB-UI Layout): Use @kbd for keys instead of @code.

        * custom.texi (Init Rebinding): Use @kbd for keys instead of @code.

        * dired.texi (Misc Dired Features): Use @kbd for keys instead of @code.

        * fortran-xtra.texi (Fortran Columns): Use @kbd for keys instead of
        @code.

        * maintaining.texi (Merging): Use @kbd for keys instead of @code.

        * misc.texi (Document View): Use @kbd for keys instead of @code.
        (Conversion): Use @kbd for keys instead of @code.

        * mule.texi (Input Methods): Use @kbd for keys instead of @code.
        (Unibyte Mode): Use @kbd for keys instead of @code.

        * programs.texi (Motion in C): Use @kbd for keys instead of @code.

        * sending.texi (Mail Headers): Use @kbd for keys instead of @code.
        (Mail Methods): Use @kbd for keys instead of @code.

        * windows.texi (Window Convenience): Use @kbd for keys instead of
        @code.
        (Window Convenience): Use @kbd for keys instead of @code.
Index: basic.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/basic.texi,v
retrieving revision 1.15
diff -u -r1.15 basic.texi
--- doc/emacs/basic.texi        6 May 2009 03:55:13 -0000       1.15
+++ doc/emacs/basic.texi        8 Jun 2009 18:45:54 -0000
@@ -490,8 +490,8 @@
 @dfn{word wrapping}: instead of wrapping long lines exactly at the
 right window edge, Emacs wraps them at the word boundaries (i.e.,
 space or tab characters) nearest to the right window edge.  Visual
-Line mode also redefines editing commands such as @code{C-a},
address@hidden, and @code{C-k} to operate on screen lines rather than
+Line mode also redefines editing commands such as @kbd{C-a},
address@hidden, and @kbd{C-k} to operate on screen lines rather than
 logical lines.  @xref{Visual Line Mode}.

 @node Position Info
Index: doc/emacs/building.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/building.texi,v
retrieving revision 1.21
diff -u -r1.21 building.texi
--- doc/emacs/building.texi     4 Jun 2009 03:07:17 -0000       1.21
+++ doc/emacs/building.texi     8 Jun 2009 18:49:57 -0000
@@ -904,8 +904,8 @@
   You may also specify additional GDB-related buffers to display,
 either in the same frame or a different one.  Select the buffers you
 want with the @samp{GUD->GDB-windows} and @samp{GUD->GDB-Frames}
-sub-menus.  If the menu-bar is unavailable, type @code{M-x
address@hidden or @code{M-x
+sub-menus.  If the menu-bar is unavailable, type @kbd{M-x
address@hidden or @kbd{M-x
 address@hidden respectively, where
 @var{buffertype} is the relevant buffer type, such as
 @samp{breakpoints}.  Most of these buffers are read-only, and typing
Index: doc/emacs/custom.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/custom.texi,v
retrieving revision 1.22
diff -u -r1.22 custom.texi
--- doc/emacs/custom.texi       4 Jun 2009 03:13:28 -0000       1.22
+++ doc/emacs/custom.texi       8 Jun 2009 18:49:57 -0000
@@ -1706,7 +1706,7 @@
 @end example

   When the key sequence includes function keys or mouse button events,
-or address@hidden characters such as @code{C-=} or @code{H-a},
+or address@hidden characters such as @kbd{C-=} or @kbd{H-a},
 you must use a vector to specify the key sequence.  Each element in
 the vector stands for an input event; the elements are separated by
 spaces and surrounded by a pair of square brackets.  If an element is
Index: doc/emacs/dired.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/dired.texi,v
retrieving revision 1.11
diff -u -r1.11 dired.texi
--- doc/emacs/dired.texi        8 Jan 2009 05:28:48 -0000       1.11
+++ doc/emacs/dired.texi        8 Jun 2009 18:49:57 -0000
@@ -1349,7 +1349,7 @@
 each pair of like-named files, and if the expression's value is
 address@hidden, those files are considered ``different.''

-  For instance, the sequence @code{M-x dired-compare-directories
+  For instance, the sequence @kbd{M-x dired-compare-directories
 @key{RET} (> mtime1 mtime2) @key{RET}} marks files newer in this
 directory than in the other, and marks files older in the other
 directory than in this one.  It also marks files with no counterpart,
Index: doc/emacs/fortran-xtra.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/fortran-xtra.texi,v
retrieving revision 1.7
diff -u -r1.7 fortran-xtra.texi
--- doc/emacs/fortran-xtra.texi 8 Jan 2009 05:28:49 -0000       1.7
+++ doc/emacs/fortran-xtra.texi 8 Jun 2009 18:49:57 -0000
@@ -550,7 +550,7 @@
 @kindex C-u C-c C-w @r{(Fortran mode)}
 @findex fortran-window-create
   You can also split the window horizontally and continue editing with
-the split in place.  To do this, use @kbd{C-u C-c C-w} (@code{M-x
+the split in place.  To do this, use @kbd{C-u C-c C-w} (@kbd{M-x
 fortran-window-create}).  By editing in this window you can
 immediately see when you make a line too wide to be correct Fortran.

Index: doc/emacs/maintaining.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/maintaining.texi,v
retrieving revision 1.20
diff -u -r1.20 maintaining.texi
--- doc/emacs/maintaining.texi  26 Apr 2009 19:01:24 -0000      1.20
+++ doc/emacs/maintaining.texi  8 Jun 2009 18:49:58 -0000
@@ -1307,7 +1307,7 @@

 @cindex vc-resolve-conflicts
   Then you can resolve the conflicts by editing the file manually.  Or
-you can type @code{M-x vc-resolve-conflicts} after visiting the file.
+you can type @kbd{M-x vc-resolve-conflicts} after visiting the file.
 This starts an Ediff session, as described above.  Don't forget to
 check in the merged version afterwards.

Index: doc/emacs/misc.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/misc.texi,v
retrieving revision 1.22
diff -u -r1.22 misc.texi
--- doc/emacs/misc.texi 12 May 2009 04:16:56 -0000      1.22
+++ doc/emacs/misc.texi 8 Jun 2009 18:49:58 -0000
@@ -49,8 +49,8 @@
 @kbd{C-c C-c} (@code{doc-view-toggle-display}) toggles between DocView
 and the file text.

-  You can explicitly toggle DocView mode with the command @code{M-x
-doc-view-mode}, and DocView minor mode with the command @code{M-x
+  You can explicitly toggle DocView mode with the command @kbd{M-x
+doc-view-mode}, and DocView minor mode with the command @kbd{M-x
 doc-view-minor-mode}.

   When DocView mode starts, it displays a welcome screen and begins
@@ -165,7 +165,7 @@
 For efficiency, DocView caches the images produced by @command{gs}.
 The name of this directory is given by the variable
 @code{doc-view-cache-directory}.  You can clear the cache directory by
-typing @code{M-x doc-view-clear-cache}.
+typing @kbd{M-x doc-view-clear-cache}.

 @findex doc-view-kill-proc
 @findex doc-view-kill-proc-and-buffer
Index: doc/emacs/mule.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/mule.texi,v
retrieving revision 1.15
diff -u -r1.15 mule.texi
--- doc/emacs/mule.texi 16 May 2009 14:33:16 -0000      1.15
+++ doc/emacs/mule.texi 8 Jun 2009 18:49:58 -0000
@@ -491,7 +491,7 @@

     Type @kbd{C-f} and @kbd{C-b} to move forward and backward among
 the alternatives in the current row.  As you do this, Emacs highlights
-the current alternative with a special color; type @address@hidden
+the current alternative with a special color; type @kbd{C-SPC}
 to select the current alternative and use it as input.  The
 alternatives in the row are also numbered; the number appears before
 the alternative.  Typing a digit @var{n} selects the @var{n}th
@@ -1585,7 +1585,7 @@

 On a graphical display, you should not need to do anything special to use
 these keys; they should simply work.  On a text-only terminal, you
-should use the command @code{M-x set-keyboard-coding-system} or the
+should use the command @kbd{M-x set-keyboard-coding-system} or the
 variable @code{keyboard-coding-system} to specify which coding system
 your keyboard uses (@pxref{Terminal Coding}).  Enabling this feature
 will probably require you to use @kbd{ESC} to type Meta characters;
Index: doc/emacs/programs.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/programs.texi,v
retrieving revision 1.9
diff -u -r1.9 programs.texi
--- doc/emacs/programs.texi     8 Jan 2009 05:28:51 -0000       1.9
+++ doc/emacs/programs.texi     8 Jun 2009 18:49:58 -0000
@@ -1461,7 +1461,7 @@
 enclosing braces.  (By contrast, @code{beginning-of-defun} and
 @code{end-of-defun} search for braces in column zero.)  If you are
 editing code where the opening brace of a function isn't placed in
-column zero, you may wish to bind @code{C-M-a} and @code{C-M-e} to
+column zero, you may wish to bind @kbd{C-M-a} and @kbd{C-M-e} to
 these commands.  @xref{Moving by Defuns}.

 @item C-c C-u
Index: doc/emacs/sending.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/sending.texi,v
retrieving revision 1.6
diff -u -r1.6 sending.texi
--- doc/emacs/sending.texi      15 Mar 2009 22:57:59 -0000      1.6
+++ doc/emacs/sending.texi      8 Jun 2009 18:49:58 -0000
@@ -287,7 +287,7 @@
 @vindex mail-default-headers
   You can direct Emacs to insert certain default headers into the
 outgoing message by setting the variable @code{mail-default-headers}
-to a string.  Then @code{C-x m} inserts this string into the message
+to a string.  Then @kbd{C-x m} inserts this string into the message
 headers.  If the default header fields are not appropriate for a
 particular message, edit them as necessary before sending the message.

@@ -787,7 +787,7 @@
 MH-E and Message mode, not documented in this manual.
 @xref{Top,,MH-E,mh-e, The Emacs Interface to MH}.  @xref{Top,,Message,message,
 Message Manual}.  You can choose any of them as your preferred method.
-The commands @code{C-x m}, @code{C-x 4 m} and @code{C-x 5 m} use
+The commands @kbd{C-x m}, @kbd{C-x 4 m} and @kbd{C-x 5 m} use
 whichever agent you have specified, as do various other Emacs commands
 and facilities that send mail.

Index: doc/emacs/windows.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/windows.texi,v
retrieving revision 1.6
diff -u -r1.6 windows.texi
--- doc/emacs/windows.texi      8 Jan 2009 05:28:53 -0000       1.6
+++ doc/emacs/windows.texi      8 Jun 2009 18:49:59 -0000
@@ -369,7 +369,7 @@
 partitioned into windows), so that you can ``undo'' them.  To undo,
 use @kbd{C-c left} (@code{winner-undo}).  If you change your mind
 while undoing, you can redo the changes you had undone using @kbd{C-c
-right} (@code{M-x winner-redo}).  Another way to enable Winner mode is
+right} (@kbd{M-x winner-redo}).  Another way to enable Winner mode is
 by customizing the variable @code{winner-mode}.

 @cindex Windmove package


-- 
In general, we reserve the right to have a poor
memory--the computer, however, is supposed to
remember!  Poor computer.  -- Guy Lewis Steele Jr.

Attachment: emacs-doc_kbd-fixes.diff
Description: Binary data


reply via email to

[Prev in Thread] Current Thread [Next in Thread]