From: Ted Zlatanov <tzz@lifelogs.com>
Subject: emacs doc changes (was: emacs-Xtra)
Date: Wed, 19 Apr 2006 12:34:29 -0400 [thread overview]
Message-ID: <4n7j5l5xt6.fsf_-_@asimov.bwh.harvard.edu> (raw)
In-Reply-To: E1FW48B-0007qb-Nb@fencepost.gnu.org
[-- Attachment #1: Type: text/plain, Size: 65 bytes --]
Attached is patch #1, covering emacs.texi and screen.texi.
Ted
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: emacs+screen.texi.patch --]
[-- Type: text/x-patch, Size: 20872 bytes --]
? emacs+screen.texi.patch
Index: emacs.texi
===================================================================
RCS file: /sources/emacs/emacs/man/emacs.texi,v
retrieving revision 1.126
diff -r1.126 emacs.texi
92,94c92,94
< If you never before used the Info documentation system, type @kbd{h},
< and Emacs will take you to a programmed instruction sequence for the
< Info commands.
---
> To learn more about the Info documentation system, type @kbd{h}, and
> Emacs will take you to a programmed instruction sequence for the Info
> commands.
870,872c870,872
< editor. The reader is not expected to be a programmer; simple
< customizations do not require programming skill. The user who is not
< interested in customizing can ignore the scattered customization hints.
---
> editor. Simple Emacs customizations do not require you to be a
> programmer. If you are not interested in customizing, you can ignore
> the scattered customization hints.
875,880c875,879
< primer. For complete beginners, it is a good idea to start with the
< on-line, learn-by-doing tutorial, before reading the manual. To run the
< tutorial, start Emacs and type @kbd{C-h t}. This way you can learn
< Emacs by using Emacs on a specially designed file which describes
< commands, tells you when to try them, and then explains the results you
< see.
---
> primer. You should start with the on-line, learn-by-doing tutorial,
> before reading the manual if you are just starting to use Emacs. To
> run the tutorial, start Emacs and type @kbd{C-h t}. The tutorial
> describes commands, tells you when to try them, and explains the
> results.
886,888c885,887
< should practice the commands there. The next few chapters describe
< fundamental techniques and concepts that are used constantly. You need
< to understand them thoroughly, experimenting with them if necessary.
---
> should practice the commands shown there. The next few chapters
> describe fundamental techniques and concepts that are used constantly.
> You need to understand them thoroughly and experiment with them.
891,893c890,892
< useful for all kinds of editing. Chapter 20 and following chapters
< describe features that you may or may not want to use; read those
< chapters when you need them.
---
> useful for many kinds of editing. Chapter 20 and following chapters
> describe optional yet useful features; read those chapters when you
> need them.
896c895
< properly. It explains how to cope with some common problems
---
> properly. It explains how to cope with many common problems
900,902c899,901
< To find the documentation on a particular command, look in the index.
< Keys (character commands) and command names have separate indexes. There
< is also a glossary, with a cross reference for each term.
---
> To find out more about a particular command, look in the index.
> Keys (character commands) and command names have separate indexes.
> There is also a glossary, with a cross reference for each term.
905,908c904,907
< The Info file is for on-line perusal with the Info program, which will
< be the principal way of viewing documentation on-line in the GNU system.
< Both the Info file and the Info program itself are distributed along
< with GNU Emacs. The Info file and the printed book contain
---
> The Info file is for on-line perusal with the Info program, which is
> the principal way to access documentation on-line in the GNU system.
> Both the Emacs Info file and the Info program itself are distributed
> along with GNU Emacs. The Info file and the printed book contain
910c909
< files, which are also distributed along with GNU Emacs.
---
> files, which are also distributed with GNU Emacs.
1065,1066c1064,1065
< We say that Emacs is a @dfn{display} editor because normally the text
< being edited is visible on the screen and is updated automatically as you
---
> Emacs is a @dfn{display} editor because normally the text being
> edited is visible on the screen and is updated automatically as you
1069c1068
< We call it a @dfn{real-time} editor because the display is updated very
---
> It is a @dfn{real-time} editor because the display is updated very
1074,1079c1073,1078
< We call Emacs advanced because it provides facilities that go beyond
< simple insertion and deletion: controlling subprocesses; automatic
< indentation of programs; viewing two or more files at once; editing
< formatted text; and dealing in terms of characters, words, lines,
< sentences, paragraphs, and pages, as well as expressions and comments in
< several different programming languages.
---
> Emacs is advanced because it provides much more than simple
> insertion and deletion. It can control subprocesses, indent programs
> automatically, show two or more files at once, and edit formatted
> text. Emacs can operate in terms of characters, words, lines,
> sentences, paragraphs, and pages, as well as expressions and comments
> in several different programming languages.
1086,1106c1085,1106
< @dfn{Customizable} means that you can change the definitions of Emacs
< commands in little ways. For example, if you use a programming language in
< which comments start with @samp{<**} and end with @samp{**>}, you can tell
< the Emacs comment manipulation commands to use those strings
< (@pxref{Comments}). Another sort of customization is rearrangement of the
< command set. For example, if you prefer the four basic cursor motion
< commands (up, down, left and right) on keys in a diamond pattern on the
< keyboard, you can rebind the keys that way. @xref{Customization}.
<
< @dfn{Extensible} means that you can go beyond simple customization and
< write entirely new commands, programs in the Lisp language to be run by
< Emacs's own Lisp interpreter. Emacs is an ``on-line extensible''
< system, which means that it is divided into many functions that call
< each other, any of which can be redefined in the middle of an editing
< session. Almost any part of Emacs can be replaced without making a
< separate copy of all of Emacs. Most of the editing commands of Emacs
< are written in Lisp; the few exceptions could have been written
< in Lisp but are written in C for efficiency. Although only a programmer
< can write an extension, anybody can use it afterward. @xref{Top,
< Emacs Lisp Intro, Preface, eintr, An Introduction to Programming in
< Emacs Lisp}, if you want to learn Emacs Lisp programming.
---
> @dfn{Customizable} means that you can affect or redefine Emacs
> commands in little ways. For example, if you use a programming
> language in which comments start with @samp{<**} and end with
> @samp{**>}, you can tell the Emacs comment manipulation commands to
> use those strings (@pxref{Comments}). Another sort of customization
> is rearrangement of the command set. For example, you can rebind the
> basic cursor motion commands (up, down, left and right) to any keys on
> the keyboard that you find comfortable. @xref{Customization}.
>
> @dfn{Extensible} means that you can go beyond simple customization
> and write entirely new commands -- programs in the Lisp language to be
> run by Emacs's own Lisp interpreter. Emacs is an ``on-line
> extensible'' system, which means that it is divided into many
> functions that call each other, any of which can be redefined in the
> middle of an editing session. Almost any part of Emacs can be
> replaced without making a separate copy of all of Emacs. Most of the
> editing commands of Emacs are written in Lisp; the few exceptions
> could have been written in Lisp but use C instead for efficiency.
> Although only a programmer can write an extension, anybody can use it
> afterwards. @xref{Top, Emacs Lisp Intro, Preface, eintr, An
> Introduction to Programming in Emacs Lisp}, if you want to learn Emacs
> Lisp programming.
1109,1113c1109,1113
< and convenient handling of mouse buttons. But Emacs provides many of
< the benefits of a graphical display even on a text-only terminal. For
< instance, it can highlight parts of a file, display and edit several
< files at once, move text between files, and edit files while running
< shell commands.
---
> and convenient handling of mouse buttons. In addition, Emacs provides
> many of the benefits of a graphical display even on a text-only
> terminal. For instance, it can highlight parts of a file, display and
> edit several files at once, move text between files, and edit files
> while running shell commands.
Index: screen.texi
===================================================================
RCS file: /sources/emacs/emacs/man/screen.texi,v
retrieving revision 1.26
diff -r1.26 screen.texi
27,28c27,28
< prompts appear and where you enter information when Emacs asks for it.
< See following sections for more information about these special lines.
---
> prompts appear and you enter information when Emacs asks for it. See
> following sections for more information about these special lines.
39,40c39,40
< (such as a hollow box). On text terminals, which have just one
< cursor, that cursor always appears in the selected window.
---
> (such as a hollow box). On text terminals, the cursor always appears
> in the selected window.
43,47c43,47
< window (though mouse commands generally operate on whatever window you
< click them in, whether selected or not). The text in other windows is
< mostly visible for reference, unless/until you select them. If you
< use multiple frames on a graphical display, then giving the input
< focus to a particular frame selects a window in that frame.
---
> window (mouse commands generally operate on whatever window you click
> them in, whether selected or not). The text in unselected windows is
> mostly visible for reference. If you use multiple frames on a
> graphical display, then giving the input focus to a particular frame
> selects a window in that frame.
50,52c50,52
< is going on in that window. It appears in different color and/or a
< ``3D'' box, if the terminal supports that; its contents normally begin
< with @w{@samp{--:-- @ *scratch*}} when Emacs starts. The mode line
---
> is going on in that window. It appears in different color or a ``3D''
> box if the terminal supports either; its contents normally begin with
> @w{@samp{--:-- @ *scratch*}} when Emacs starts. The mode line
92,93c92,93
< window, each window has its own position for point in that buffer, and
< (when possible) its own cursor.
---
> window, each window has its own point in that buffer, and (when
> possible) its own cursor.
95,101c95,100
< A text-only terminal has just one cursor, so Emacs puts it
< in the selected window. The other windows do not show a cursor, even
< though they do have a location of point. When Emacs updates the
< screen on a text-only terminal, it has to put the cursor temporarily
< at the place the output goes. This doesn't mean point is there,
< though. Once display updating finishes, Emacs puts the cursor where
< point is.
---
> A text-only terminal has just one cursor in the selected window.
> The other windows do not show a cursor, even though they do have a
> location of point. When Emacs updates the screen on a text-only
> terminal, it has to put the cursor temporarily at the place the output
> goes. This doesn't mean point is there, though. Once display
> updating finishes, Emacs puts the cursor where point is.
168,179c167,179
< The size of @samp{*Messages*} is limited to a certain number of lines.
< The variable @code{message-log-max} specifies how many lines. Once the
< buffer has that many lines, each line added at the end deletes one line
< from the beginning. @xref{Variables}, for how to set variables such as
< @code{message-log-max}.
<
< The echo area is also used to display the @dfn{minibuffer}, a window that
< is used for reading arguments to commands, such as the name of a file to be
< edited. When the minibuffer is in use, the echo area begins with a prompt
< string that usually ends with a colon; also, the cursor appears in that line
< because it is the selected window. You can always get out of the
< minibuffer by typing @kbd{C-g}. @xref{Minibuffer}.
---
> The size of @samp{*Messages*} is limited to a certain number of
> lines. The variable @code{message-log-max} specifies how many lines.
> Once the buffer has that many lines, new lines at the end remove lines
> from the beginning to keep the size constant. @xref{Variables}, for
> how to set variables such as @code{message-log-max}.
>
> The echo area is also used to display the @dfn{minibuffer}, a window
> where you can input arguments to commands, such as the name of a file
> to be edited. When the minibuffer is in use, the echo area begins
> with a prompt string that usually ends with a colon; also, the cursor
> appears in that line because it is the selected window. You can
> always get out of the minibuffer by typing @kbd{C-g}.
> @xref{Minibuffer}.
194,195c194,195
< window has a slightly different appearance than those of other
< windows; see @ref{Optional Mode Line}, for more about this.
---
> window is slightly different from the others; see @ref{Optional Mode
> Line}, for more information.
204,207c204,207
< This gives information about the buffer being displayed in the window: the
< buffer's name, what major and minor modes are in use, whether the buffer's
< text has been changed, and how far down the buffer you are currently
< looking.
---
> This is information about the window and the buffer it displays: the
> buffer's name, what major and minor modes are in use, whether the
> buffer's text has been changed, and how far down the buffer you are
> currently looking.
214,215c214,215
< @var{fr} appears only on text-only terminals, to show the selected
< frame name. @xref{Frames}. The initial frame's name is @samp{F1}.
---
> @var{fr} appears only on text-only terminals as the selected frame
> name. @xref{Frames}. The initial frame's name is @samp{F1}.
217,218c217,218
< @var{buf} is the name of the window's @dfn{buffer}. In most cases
< this is the same as the name of a file you are editing. @xref{Buffers}.
---
> @var{buf} is the name of the window's @dfn{buffer}. Usually this is
> the same as the name of a file you are editing. @xref{Buffers}.
220,223c220,223
< The buffer displayed in the selected window (the window that the
< cursor is in) is the @dfn{current buffer}--the one that editing takes
< place in. When we speak of what some command does to ``the buffer,''
< we mean it does those things to the current buffer.
---
> The buffer displayed in the selected window (the window with the
> cursor) is the @dfn{current buffer}, where editing happens. When a
> command's effect applies to ``the buffer,'' we mean it does those
> things to the current buffer.
235,238c235,238
< This is present when Line Number mode is enabled (which it normally is).
< You can optionally display the current column number too, by turning on
< Column Number mode (which is not enabled by default because it is
< somewhat slower). @xref{Optional Mode Line}.
---
> This is present when Line Number mode is enabled (it normally is).
> You can display the current column number too, by turning on Column
> Number mode. It is not enabled by default because it is somewhat
> slower. @xref{Optional Mode Line}.
241,245c241,245
< buffer. At any time, each buffer is in one and only one of the possible
< major modes. The major modes available include Fundamental mode (the
< least specialized), Text mode, Lisp mode, C mode, Texinfo mode, and many
< others. @xref{Major Modes}, for details of how the modes differ and how
< to select one.@refill
---
> buffer. A buffer can only be in one major mode at a time. The major
> modes available include Fundamental mode (the least specialized), Text
> mode, Lisp mode, C mode, Texinfo mode, and many others. @xref{Major
> Modes}, for details of how the modes differ and how to select
> one.@refill
256,258c256,259
< @xref{Minor Modes}, for more information. @samp{Narrow} means that
< the buffer being displayed has editing restricted to only a portion of
< its text. (This is not really a minor mode, but is like one.)
---
> @xref{Minor Modes}, for more information.
>
> @samp{Narrow} means that the buffer being displayed has editing
> restricted to only a portion of its text. This is like a minor mode.
262,263c263,264
< In addition, if Emacs is currently inside a recursive editing level,
< square brackets (@samp{[@dots{}]}) appear around the parentheses that
---
> In addition, if Emacs is inside a recursive editing level, square
> brackets (@samp{[@dots{}]}) appear around the parentheses that
291,306c292,306
< The colon after @var{cs} can change to another string in certain
< circumstances. Emacs uses newline characters to separate lines in the buffer.
< Some files use different conventions for separating lines: either
< carriage-return linefeed (the MS-DOS convention) or just carriage-return
< (the Macintosh convention). If the buffer's file uses carriage-return
< linefeed, the colon changes to either a backslash (@samp{\}) or
< @samp{(DOS)}, depending on the operating system. If the file uses just
< carriage-return, the colon indicator changes to either a forward slash
< (@samp{/}) or @samp{(Mac)}. On some systems, Emacs displays
< @samp{(Unix)} instead of the colon even for files that use newline to
< separate lines.
<
< @xref{Optional Mode Line}, for features that add other handy
< information to the mode line, such as the size of the buffer, the
< current column number of point, and whether new mail for you has
< arrived.
---
> The colon after @var{cs} can change to another string sometimes.
> Emacs uses newline characters to separate lines in the buffer. Some
> files use different conventions for separating lines: either
> carriage-return linefeed (the MS-DOS convention) or just
> carriage-return (the Macintosh convention). If the buffer's file uses
> carriage-return linefeed, the colon changes to either a backslash
> (@samp{\}) or @samp{(DOS)}, depending on the operating system. If the
> file uses just carriage-return, the colon indicator changes to either
> a forward slash (@samp{/}) or @samp{(Mac)}. On some systems, Emacs
> displays @samp{(Unix)} instead of the colon even for files that use
> newline to separate lines.
>
> @xref{Optional Mode Line}, to add other handy information to the
> mode line, such as the size of the buffer, the current column number
> of point, and whether new mail for you has arrived.
309,310c309,310
< various parts of it, Emacs displays help text to say what a click in
< that place will do. @xref{Mode Line Mouse}.
---
> various parts of it, you'll see help text to say what a click in that
> place will do. @xref{Mode Line Mouse}.
317,318c317,318
< can use to perform certain common operations. There's no need to list
< them here, as you can more easily see for yourself.
---
> can use to perform common operations. There's no need to list them
> here, as you can more easily see them yourself.
324,327c324,327
< from the menu bar. An arrow pointing right, after the menu item,
< indicates that the item leads to a subsidiary menu; @samp{...} at the
< end means that the command will read arguments (further input from
< you) before it actually does anything.
---
> from the menu bar. When a menu item has an arrow pointing right, it
> leads to a subsidiary menu; @samp{...} at the end means that the
> command invoked will read arguments (further input from you) before it
> actually does anything.
335,344c335,343
< @code{tmm-menubar}). This command enters a mode in which you can select
< a menu item from the keyboard. A provisional choice appears in the echo
< area. You can use the up and down arrow keys to move through the
< menu to different choices. When you have found the choice you want,
< type @key{RET} to select it.
<
< Each menu item also has an assigned letter or digit which designates
< that item; it is usually the initial of some word in the item's name.
< This letter or digit is separated from the item name by @samp{=>}. You
< can type the item's letter or digit to select the item.
---
> @code{tmm-menubar}). This lets you select a menu item from the
> keyboard. A provisional choice appears in the echo area. You can use
> the up and down arrow keys to move through the menu to different
> items, and then you can type @key{RET} to select the item..
>
> You'll see that each menu item in the text-only menubar also has an
> assigned letter or digit which designates that item; it is usually the
> initial of some word in the item's name. You can type the item's
> letter or digit to select it.
347,348c346
< well; if so, the menu lists one equivalent key binding in parentheses
< after the item itself.
---
> well; one binding will be in parentheses after the item itself.
[-- Attachment #3: Type: text/plain, Size: 142 bytes --]
_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel
next prev parent reply other threads:[~2006-04-19 16:34 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-04-12 21:41 emacs-Xtra Nick Roberts
2006-04-13 3:20 ` emacs-Xtra Richard Stallman
2006-04-13 4:14 ` emacs-Xtra Nick Roberts
2006-04-13 7:10 ` emacs-Xtra Nic
2006-04-13 9:02 ` emacs-Xtra Eli Zaretskii
2006-04-14 4:18 ` emacs-Xtra Richard Stallman
2006-04-14 22:21 ` emacs-Xtra Nic
2006-04-15 17:33 ` emacs-Xtra Richard Stallman
2006-04-13 18:40 ` emacs-Xtra Ted Zlatanov
2006-04-14 7:43 ` emacs-Xtra Eli Zaretskii
2006-04-14 13:39 ` emacs-Xtra Ted Zlatanov
2006-04-14 14:40 ` emacs-Xtra Eli Zaretskii
2006-04-14 16:05 ` emacs-Xtra Ted Zlatanov
2006-04-14 16:54 ` emacs-Xtra Eli Zaretskii
2006-04-15 17:32 ` emacs-Xtra Richard Stallman
2006-04-15 18:09 ` emacs-Xtra David Kastrup
2006-04-18 15:03 ` emacs-Xtra Ted Zlatanov
2006-04-19 4:17 ` emacs-Xtra Richard Stallman
2006-04-19 16:34 ` Ted Zlatanov [this message]
2006-04-19 17:38 ` emacs doc changes Ted Zlatanov
2006-04-19 17:51 ` emacs doc changes (was: emacs-Xtra) Eli Zaretskii
2006-04-19 17:57 ` emacs doc changes David Kastrup
2006-04-19 18:01 ` Ted Zlatanov
2006-04-19 18:15 ` David Kastrup
2006-04-19 18:34 ` Giorgos Keramidas
2006-04-19 20:44 ` Stefan Monnier
2006-04-20 9:50 ` Eli Zaretskii
2006-04-20 9:58 ` David Kastrup
2006-04-20 10:13 ` Eli Zaretskii
2006-04-20 19:38 ` Richard Stallman
2006-04-20 21:09 ` Stefan Monnier
2006-04-27 14:42 ` Richard Stallman
2006-04-30 15:29 ` Stefan Monnier
2006-05-01 4:19 ` Richard Stallman
2006-05-01 12:39 ` Stefan Monnier
2006-05-02 2:05 ` Richard Stallman
2006-05-11 23:06 ` Aaron S. Hawley
2006-04-20 10:25 ` Eli Zaretskii
2006-04-20 1:14 ` Richard Stallman
2006-04-20 13:43 ` Jay Belanger
2006-04-20 9:15 ` Eli Zaretskii
2006-04-20 9:21 ` David Kastrup
2006-04-19 17:58 ` Ted Zlatanov
2006-04-25 16:48 ` Richard Stallman
2006-04-15 17:32 ` emacs-Xtra Richard Stallman
2006-04-14 16:15 ` emacs-Xtra Richard Stallman
2006-04-14 4:18 ` emacs-Xtra Richard Stallman
2006-04-13 8:28 ` emacs-Xtra Eli Zaretskii
2006-04-13 18:40 ` emacs-Xtra Glenn Morris
2006-04-14 7:35 ` emacs-Xtra Eli Zaretskii
2006-04-14 4:18 ` emacs-Xtra Richard Stallman
2006-04-14 8:16 ` emacs-Xtra Eli Zaretskii
2006-04-21 11:43 ` emacs-Xtra Eli Zaretskii
2006-04-21 21:05 ` emacs-Xtra Richard Stallman
2006-04-14 4:18 ` emacs-Xtra Richard Stallman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4n7j5l5xt6.fsf_-_@asimov.bwh.harvard.edu \
--to=tzz@lifelogs.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.