Commit graph

2693 commits

Author SHA1 Message Date
Eli Zaretskii
136e931189 Improve documentation of "C-u C-x ="
* doc/emacs/mule.texi (International Chars): Mention the
composition information displayed by "C-u C-x =".  (Bug#42256)
2020-07-09 20:38:38 +03:00
Basil L. Contovounesios
c37de84845 Fix typos and markup in fill column indicator docs
* doc/emacs/display.texi (Displaying Boundaries): Fix typos and
Texinfo markup.
2020-06-22 14:57:24 +01:00
Basil L. Contovounesios
229995ba2c Fix some Texinfo markup
* doc/misc/gnus-faq.texi (FAQ 3-11):
* doc/emacs/frames.texi (Tab Bars): Consistently use @var with
lower-case metasyntactic variables and @minus instead of a dash.
(Text-Only Mouse):
* doc/emacs/files.texi (Auto Revert):
* doc/emacs/misc.texi (emacsclient Options)
(Embedded WebKit Widgets):
* doc/lispref/control.texi (pcase Macro):
* doc/lispref/debugging.texi (Backtraces):
* doc/lispref/files.texi (Truenames):
* doc/lispref/frames.texi (Management Parameters):
* doc/lispref/os.texi (Time Calculations):
* doc/lispref/text.texi (Parsing JSON):
* doc/misc/efaq-w32.texi (Other versions of Emacs, Debugging)
(Swap Caps NT, Printing, Bash, Developing with Emacs):
* doc/misc/efaq.texi (New in Emacs 25):
* doc/misc/emacs-gnutls.texi (Help For Users):
* doc/misc/message.texi (Using S/MIME, Passphrase caching):
* test/manual/etags/tex-src/gzip.texi (Overview): Use @. when a
sentence in the middle of a paragraph ends with an upper-case letter
as per "(texinfo) Ending a Sentence".
2020-06-17 13:07:51 +01:00
Basil L. Contovounesios
01e86b9fdf Fix recentf typo in Emacs manual
* doc/emacs/files.texi (File Conveniences): Fix misspelling of
recentf-list.
2020-06-17 01:10:20 +01:00
João Távora
44c0e074f7 * doc/emacs/buffers.texi (Icomplete): Mention icomplete-minibuffer-setup-hook. 2020-06-01 01:29:50 +01:00
Eli Zaretskii
1a6d59eeba Improve the documentation of setting up fontsets
* doc/lispref/display.texi (Fontsets): Improve the accuracy of a
cross-reference to "Character Properties".

* doc/emacs/mule.texi (Fontsets, Modifying Fontsets): Improve the
documentation of fontsets and how to modify them.
2020-05-23 15:14:27 +03:00
Eli Zaretskii
13b6dfd4f7 * doc/emacs/killing.texi (Rectangles): Improve indexing. 2020-05-23 10:33:35 +03:00
Eli Zaretskii
b4937f64cd Improve documentation of manually installing Lisp packages
* doc/emacs/building.texi (Lisp Libraries): Describe how to
manually load packages in the init file.  Mention the 'site-lisp'
subdirectory of the default 'load-path'.

* doc/emacs/package.texi (Packages): Describe manual installation
of ELisp packages.  Suggested by Jean-Christophe Helary
<jean.christophe.helary@traduction-libre.org>.
2020-05-16 11:54:37 +03:00
Paul Eggert
632aa9d57a Go back to “Bahá’í”
* doc/emacs/calendar.texi (Holidays): Revert previous change, as
bahai.org spells it “Bahá’í” (with U+2019 RIGHT SINGLE QUOTATION
MARK) and that’s good enough for us.
2020-05-10 09:14:17 -07:00
Eli Zaretskii
7081c1d66f Fix typos in the Emacs user manual
* doc/emacs/calendar.texi (Holidays): Fix usage of non-ASCII
accents.
* doc/emacs/custom.texi (Init Rebinding): Fix a cross-reference.
* doc/emacs/dired.texi (Operating on Files): Make the
cross-reference to "VC Delete/Rename" be to a different manual in
the printed version.  (Bug#41100)
2020-05-08 14:21:35 +03:00
Eli Zaretskii
76516465bf * doc/emacs/modes.texi (Major Modes): Fix quoting. (Bug#41110) 2020-05-06 17:13:55 +03:00
Eli Zaretskii
7be160d800 Improve "Help Summary" section in user manual
* doc/emacs/help.texi (Help Summary): Add cross-references to
sections with details of each Help command.
2020-05-05 17:47:33 +03:00
Eli Zaretskii
ed25282b82 Document effect of 'search-upper-case' on replacement commands
* doc/emacs/search.texi (Replacement and Lax Matches): Document
the role of 'search-upper-case' in replacement commands.
(Lax Search): Document the value 'not-yanks' of
'search-upper-case' where the variable itself is documented.

* lisp/replace.el (query-replace-regexp, query-replace): Mention
'search-upper-case' and its effect in doc strings.  (Bug#40940)
2020-05-02 10:54:01 +03:00
Stefan Kangas
0278741676 Fix typo in custom.texi
* doc/emacs/custom.texi (Variables): Fix typo.  Pointed out by
ej32u@protonmail.com.  (Bug#40890)
2020-04-27 17:09:11 +02:00
Juri Linkov
f0e1bf56f0 Fix bugs in tab-bar and tab-line and mention remaining features in manual.
* doc/emacs/frames.texi (Tab Bars): Mention tab-bar-new-tab-to,
tab-bar-close-last-tab-choice, tab-bar-close-tab-select, tab-undo,
tab-select, tab-bar-history-mode.

* doc/emacs/windows.texi (Tab Line): Mention tab-line-tabs-function.

* lisp/tab-bar.el (tab-bar-select-tab-modifiers): Mention
tab-bar-tab-hints in docstring.
(tab-bar-tab-hints): Mention tab-bar-select-tab-modifiers
in docstring.
(tab-bar-select-tab): Mention tab-bar-select-tab-modifiers
in docstring.
(tab-bar-switch-to-tab): Expand the docstring.
(tab-bar-new-tab-to): Fix bug in handling 'left' value.
(tab-bar-close-tab): Fix bug in handling 'left' value.
(tab-bar-undo-close-tab): Use funcall tab-bar-tabs-function
instead of direct call to tab-bar-tabs.
(tab-bar-history-back, tab-bar-history-forward): Add docstrings.
(tab-bar-history-mode): Expand docstring.

* lisp/tab-line.el (tab-line-format): Fix bug for handling window
switching that should set face 'tab-line-tab-current'.
2020-04-27 01:28:36 +03:00
Juri Linkov
ba6104d1e8 Change doc-view-mode-map prefix key 's' to 'c'.
* doc/emacs/misc.texi (DocView Slicing): Change prefix key 's' to 'c'.

* lisp/doc-view.el (doc-view-mode-map): Change prefix key 's' to 'c'.

* lisp/image-mode.el (image-mode-map): Add image-transform-set-scale to menu.

* doc/emacs/files.texi (Image Mode): Describe commands
image-transform-fit-both, image-transform-set-scale, image-transform-reset.

* etc/NEWS: Rearrange image sections.

https://lists.gnu.org/archive/html/emacs-devel/2020-04/msg01315.html
2020-04-23 02:14:42 +03:00
Eli Zaretskii
fc55f65305 Minor improvements in documentation of the last change
* etc/NEWS:
* doc/emacs/files.texi (Image Mode): Minor copyedits of last change.
2020-04-21 16:50:13 +03:00
Juri Linkov
a64da75961 Add image-auto-resize defcustoms to image-mode.el
* lisp/image-mode.el (image-auto-resize)
(image-auto-resize-on-window-resize): New defcustoms.
(image-mode-map): Bind "sb" to image-transform-fit-both.
(image-mode): Set image-transform-resize to image-auto-resize initially.
(image-mode--setup-mode): Add hook on image-auto-resize-on-window-resize.
(image-toggle-display-image): Check if image-transform-resize is t.
(image-transform-properties): Check image-transform-resize for nil and t.
(image-transform-fit-both): New command.
(image-transform-reset): Reset image-transform-resize to image-auto-resize.

* doc/emacs/files.texi (Image Mode): Mention image-auto-resize and
image-auto-resize-on-window-resize.

https://lists.gnu.org/archive/html/emacs-devel/2020-04/msg01160.html
2020-04-21 02:42:16 +03:00
Juri Linkov
692ad40539 Improve the documentation of tab-bar and tab-line
* doc/emacs/frames.texi (Tab Bars): Add xref to "Tab Line".
Document more commands.

* doc/emacs/windows.texi (Windows):
* doc/emacs/emacs.texi (Top): Add "Tab Line" menu.

* doc/emacs/windows.texi (Window Convenience):
Move tab-line documentation to new node "Tab Line".
(Tab Line): New node.

* doc/emacs/glossary.texi (Glossary):
* doc/emacs/modes.texi (Minor Modes):
* doc/emacs/display.texi (Standard Faces): Add xref to "Tab Line".
2020-04-21 02:23:35 +03:00
Juri Linkov
9261a219ec * doc/emacs/windows.texi (Window Convenience): Decribe more windmove features.
* doc/emacs/windows.texi (Window Convenience): Add descriptions of
windmove-display-default-keybindings,
windmove-delete-default-keybindings,
windmove-swap-states-in-direction.

* etc/NEWS: Regroup to move some parts closer to related sections.
2020-04-20 01:57:32 +03:00
Juri Linkov
4df8a61117 Add new node "Image Mode" to Emacs Manual.
* doc/emacs/dired.texi (Image-Dired): Add xref to "Image Mode".

* doc/emacs/emacs.texi (Top): Add new node "Image Mode" to menu.

* doc/emacs/files.texi (Files): Add new node "Image Mode" to menu.
(File Conveniences): Split part of node to new node "Image Mode".

* doc/emacs/frames.texi (Mouse Commands): Add xref to "Image Mode".

* doc/emacs/misc.texi (Embedded WebKit Widgets): Rename xref from
"File Conveniences" to "Image Mode".
2020-04-19 02:43:06 +03:00
Štěpán Němec
d7d5ee6c57 ; Fix a typo in cmdargs.texi (bug#40701) 2020-04-18 23:28:40 +02:00
Štěpán Němec
067b070598 ; Fix some typos and doc issues (bug#40695) 2020-04-18 17:10:02 +02:00
Eli Zaretskii
175c61c18b Fix "C-u M-!" when 'shell-command-dont-erase-buffer' is non-nil
* lisp/simple.el (shell-command-dont-erase-buffer): Clarify the
effect of the various values in the doc string.
(shell-command-save-pos-or-erase, shell-command): Don't move or
push point if the output will go to the current buffer.
(Bug#40690)
(shell-command): Mention 'shell-command-dont-erase-buffer' in the
doc string.

* test/lisp/simple-tests.el
(with-shell-command-dont-erase-buffer): Don't is shell quoting
'like this', as it doesn't work on MS-Windows; quote "like this"
instead.
(simple-tests-shell-command-dont-erase-buffer): Adapt the test to
the new modus operandi.

* doc/emacs/misc.texi (Single Shell): Document the effect of the
various values of 'shell-command-dont-erase-buffer'.

* etc/NEWS: Expand and reword the entry regarding changes in
'shell-command-dont-erase-buffer'.
2020-04-18 12:01:26 +03:00
Eli Zaretskii
63e8d0ea87 Fix last changes describing mail commands
* doc/emacs/sending.texi (Sending Mail): Fix the description of
the behavior of 'C-x m' without prefix argument.  (Bug#40561)
2020-04-12 21:47:52 +03:00
Eli Zaretskii
3f9310b0fe Fix and improve documentation of mail-related features
* lisp/simple.el (compose-mail): Clarify the effect of the
CONTINUE argument.
* lisp/mail/sendmail.el (mail-from-style): Update the RFC value in
the obsolescence warning text.

* doc/emacs/sending.texi (Sending Mail): Fix the description of
the behavior of 'C-x m' wrt prefix argument.
(Mail Headers): Remove the description of 'mail-from-style'.

* etc/NEWS: Mention that 'mail-from-style' is obsolete.

(Bug#40561)
2020-04-12 11:31:29 +03:00
Alan Mackenzie
cf57663f2a Mention jit-lock deferred as an alternative to fast-but-imprecise-scrolling
* doc/emacs/display.texi (Scrolling): Add a paragraph on using jit-lock
deferred fontification as a way of obviating Emacs hanging after
auto-repeated scrolling.
2020-04-11 21:04:50 +00:00
Eli Zaretskii
561e9fb91b Improve documentation of project.el commands
* lisp/progmodes/project.el (project-find-regexp): Require 'grep'
to be able to call 'grep-read-files'.
(project-search, project-query-replace-regexp): Doc fixes.

* doc/emacs/maintaining.texi (Projects): New section.
* doc/emacs/emacs.texi (Top): Add "Projects" to the detailed menu.
2020-03-21 13:26:19 +02:00
Eli Zaretskii
b468b3d1ff Fix a recent documentation change
* doc/emacs/frames.texi (Mouse Commands): More detailed
description of how tilting the mouse-wheel works.

* lisp/mwheel.el (mouse-wheel-tilt-scroll)
(mouse-wheel-flip-direction): Fix the wording of doc strings.
(Bug#39979)
2020-03-13 12:24:25 +02:00
İ. Göktuğ Kayaalp
ef5744a988 Improve docs for horizontal scrolling with mouse and touchpad (Bug#39979)
* lisp/mwheel.el (mouse-wheel-tilt-scroll,
mouse-wheel-flip-direction): Improve docstrings.
* doc/emacs/frames.texi (Mouse Commands): Mention touchpads.
2020-03-11 19:48:47 -04:00
Alan Third
72f87f8873 NS port documentation updates
* doc/emacs/macos.texi (Mac / GNUstep Customization): Document some
more of the ns- variables and remove incorrect font back-end
information.
* etc/NEWS: Update the documentation status of macOS news entries.
2020-03-07 14:41:47 +00:00
Noam Postavsky
60418a1ab2 Explain how to unset mode bindings (Bug#39802)
* doc/emacs/custom.texi (Init Rebinding): Explain that passing nil to
define-key will unbind keys, and extend the example accordingly.
2020-03-03 22:04:48 -05:00
Juri Linkov
592b1cfee9 Improve documentation of next-error-highlight-no-select (bug#38778)
* doc/emacs/building.texi (Compilation Mode):
Mention next-error-highlight-no-select.

* lisp/simple.el (next-error-highlight): Add reference to
next-error-highlight-no-select.
(next-error-highlight-no-select): Add reference to
next-error-highlight.
2020-03-04 01:48:03 +02:00
Eli Zaretskii
d373647e8f ; * doc/emacs/mini.texi (Yes or No Prompts): Fix last change. 2020-03-03 18:23:40 +02:00
Juri Linkov
1ca6d15656 * doc/emacs/mini.texi (Yes or No Prompts): 'y-or-n-p' now uses the minibuffer. 2020-03-03 00:33:30 +02:00
Eli Zaretskii
2e39fc83bb * doc/emacs/sending.texi (Mail Sending): Fix index entries. 2020-02-21 11:03:08 +02:00
Allen Li
b410f902d5 Document 'message-send-mail-function' in the Emacs manual
Most of the manual here addresses Message mode, yet talks about
'send-mail-function' which is used for Mail mode.
Fixing this completely requires more involved work, but for now at
least document the difference here.

* doc/emacs/sending.texi (Mail Sending): Mention
'message-send-mail-function'.  (Bug#39639)
2020-02-21 11:01:25 +02:00
Allen Li
ac0546612d Fix reference to 'message-send-and-exit' in Emacs manual
Most of the manual here addresses Message mode, and C-c C-c directly
above cites the Message mode command, not the Mail mode command.

* doc/emacs/sending.texi (Mail Sending): Fix reference.  (Bug#39639)
2020-02-21 10:58:46 +02:00
Alan Mackenzie
530067463b Correct "different than" to "different from" where appropriate
(doc/emacs/screen.texi)
(doc/lispintro/emacs-lisp-intro.texi)
(doc/misc/calc.texi)
(doc/misc/gnus.texi)
(doc/misc/sc.texi)
(lisp/align.el)
(lisp/allout-widgets.el)
(lisp/allout.el)
(lisp/emacs-lisp/gv.el)
(lisp/font-lock.el)
(lisp/gnus/mm-util.el)
(lisp/mail/feedmail.el)
(lisp/mail/sendmail.el)
(lisp/mail/supercite.el)
(lisp/org/org-attach.el)
(lisp/progmodes/cc-langs.el)
(lisp/progmodes/idlw-shell.el)
(lisp/ps-print.el)
(lisp/simple.el)
(src/cmds.c)
(src/editfns.c)
(src/frame.h)
(src/regex-emacs.c)
(src/xfaces.c): Replace "different than" by "different from".
2020-02-09 14:33:14 +00:00
Eli Zaretskii
56b8768b32 More accurate documentation of 'package-menu-hide-package'
* doc/emacs/package.texi (Package Menu): Improve the description
of the 'H' command.

* lisp/emacs-lisp/package.el (package-menu-mode-menu): More
accurate wording of the help-echo string.
(package-menu-hide-package): Make the doc string more accurate.
(Bug#39436)
2020-02-08 11:38:52 +02:00
Stephen Gildea
d10be6bf28 Example goto-addr hook: MH-E already uses goto-address
* lisp/net/goto-addr.el, doc/emacs/misc.texi: Do not use MH-E as the
example of how to add a hook to goto-address, because MH-E calls
goto-address internally.
2020-02-01 09:06:34 -08:00
Eli Zaretskii
a0336029db * doc/emacs/files.texi (Auto Save Files): Improve indexing (bug#39259). 2020-01-24 10:19:19 +02:00
Eli Zaretskii
57fb8b10c1 Fix inaccurate wording in the Emacs manual
* doc/emacs/custom.texi (Modifier Keys):
* doc/emacs/basic.texi (Inserting Text): Fix minor inaccuracies in
describing the 'Alt' modifier.  (Bug#39254)
2020-01-24 10:12:45 +02:00
Stefan Kangas
d15f2d4cbc Prefer saying "Info manual" to "info page" in docs
Pointed out by Eli Zaretskii in:
https://debbugs.gnu.org/cgi/bugreport.cgi?bug=39215#14
* doc/emacs/Makefile.in:
* doc/lispintro/Makefile.in:
* doc/lispref/Makefile.in:
* doc/misc/Makefile.in:
* lisp/dired-x.el (top-level):
* lisp/gnus/gnus-sum.el (gnus-summary-mode):
* lisp/progmodes/cperl-mode.el (cperl-info-page): Doc fix; prefer
saying "Info manual" over "info page".
2020-01-23 02:36:04 +01:00
Juri Linkov
7dd065fc7b Small fixes in documentation.
* doc/emacs/dired.texi (Operating on Files): Fix name of dired-vc-rename-file.

* doc/emacs/fixit.texi (Undo): Update new values of undo limits
doubled in bug#31104.
2020-01-21 00:50:15 +02:00
Tino Calancha
2eb0b7835d Fix shell-command-dont-erase-buffer feature
* lisp/simple.el (shell-command-dont-erase-buffer):
The default, nil, is backward compatible, i.e. it erases the buffer
only if the output buffer is not the current one; the new value 'erase
always erases the output buffer.
Update docstring.

(shell-command-save-pos-or-erase):
Add optional arg output-to-current-buffer.
Rename it so that it's not internal.  All callers updated.

(shell-command-set-point-after-cmd): Rename it so that it's not internal.
All callers updated.
Adjust it to cover a side case.

(shell-command): Adjust logic to match the specification (Bug#39067).
Enable the feature when the output buffer is the current one.

(shell-command-on-region): Little tweak to follow
`shell-command-dont-erase-buffer' specification.

* test/lisp/simple-tests.el (with-shell-command-dont-erase-buffer):
Add helper macro.
(simple-tests-shell-command-39067)
(simple-tests-shell-command-dont-erase-buffer): Add tests.

* doc/emacs/misc.texi (Single Shell): Update manual.

* etc/NEWS (Single shell commands): Announce the change.
2020-01-19 11:13:02 +01:00
Paul Eggert
2391d3f45d ; spelling fixes 2020-01-17 14:24:15 -08:00
Robert Pluim
5da372e17e ; Minor edit in anti.texi 2020-01-17 09:35:48 +01:00
Robert Pluim
8d091f7fc2 ; Fix recent markup change
* doc/emacs/custom.texi (Find Init): Fix variable markup.
2020-01-17 08:53:29 +01:00
Stefan Kangas
778923afe5 Document feature requests in the Emacs manual
* doc/emacs/trouble.texi (Contributing): Document how to send feature
requests.  (Bug20697)
2020-01-16 21:35:07 +01:00