aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2015-03-14 19:30:36 +0200
committerEli Zaretskii2015-03-14 19:30:36 +0200
commit2fdec80c2cebf486bc708c5a59b0cd52def5285b (patch)
tree84f26672d9ef19abc45fbf03301080ad646cdd34
parentcc1132158206626d9cab7b98ca68e8ca43dddc8c (diff)
downloademacs-2fdec80c2cebf486bc708c5a59b0cd52def5285b.tar.gz
emacs-2fdec80c2cebf486bc708c5a59b0cd52def5285b.zip
Improve indexing in Emacs manual (Bug#20105)
doc/emacs/basic.texi (Moving Point): Improve indexing for HOME and END. doc/emacs/cmdargs.texi (General Variables): Improve indexing for environment variables. doc/emacs/msdog.texi (Windows HOME): doc/emacs/msdog-xtra.texi (MS-DOS File Names): Remove markup from HOME in the index entries.
-rw-r--r--doc/emacs/ChangeLog11
-rw-r--r--doc/emacs/basic.texi4
-rw-r--r--doc/emacs/cmdargs.texi49
-rw-r--r--doc/emacs/msdog-xtra.texi2
-rw-r--r--doc/emacs/msdog.texi2
5 files changed, 61 insertions, 7 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index 7d8fcf4cb6d..b9c16c969e3 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,14 @@
12015-03-14 Eli Zaretskii <eliz@gnu.org>
2
3 * basic.texi (Moving Point): Improve indexing for HOME and END.
4
5 * cmdargs.texi (General Variables): Improve indexing for
6 environment variables.
7
8 * msdog.texi (Windows HOME):
9 * msdog-xtra.texi (MS-DOS File Names): Remove markup from HOME in
10 the index entries. (Bug#20105)
11
12015-01-31 Eli Zaretskii <eliz@gnu.org> 122015-01-31 Eli Zaretskii <eliz@gnu.org>
2 13
3 * msdog.texi (Windows Files): Document characters invalid in 14 * msdog.texi (Windows Files): Document characters invalid in
diff --git a/doc/emacs/basic.texi b/doc/emacs/basic.texi
index 2594608e947..be45856a6dd 100644
--- a/doc/emacs/basic.texi
+++ b/doc/emacs/basic.texi
@@ -206,14 +206,14 @@ preserves position within the line, like @kbd{C-n}.
206@item C-a 206@item C-a
207@itemx @key{Home} 207@itemx @key{Home}
208@kindex C-a 208@kindex C-a
209@kindex HOME 209@kindex HOME key
210@findex move-beginning-of-line 210@findex move-beginning-of-line
211Move to the beginning of the line (@code{move-beginning-of-line}). 211Move to the beginning of the line (@code{move-beginning-of-line}).
212 212
213@item C-e 213@item C-e
214@itemx @key{End} 214@itemx @key{End}
215@kindex C-e 215@kindex C-e
216@kindex END 216@kindex END key
217@findex move-end-of-line 217@findex move-end-of-line
218Move to the end of the line (@code{move-end-of-line}). 218Move to the end of the line (@code{move-end-of-line}).
219 219
diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi
index 42c8e33d5c7..071cd68f906 100644
--- a/doc/emacs/cmdargs.texi
+++ b/doc/emacs/cmdargs.texi
@@ -442,22 +442,31 @@ special meanings in Emacs. Most of these variables are also used by
442some other programs. Emacs does not require any of these environment 442some other programs. Emacs does not require any of these environment
443variables to be set, but it uses their values if they are set. 443variables to be set, but it uses their values if they are set.
444 444
445@vtable @env 445@c This used to be @vtable, but that enters the variables alone into
446@c the Variable Index, which in some cases, like ``HOME'', might be
447@c confused with keys by that name, and other cases, like ``NAME'',
448@c might be confused with general-purpose phrases.
449@table @env
446@item CDPATH 450@item CDPATH
451@vindex CDPATH, environment variable
447Used by the @code{cd} command to search for the directory you specify, 452Used by the @code{cd} command to search for the directory you specify,
448when you specify a relative directory name. 453when you specify a relative directory name.
449@item DBUS_SESSION_BUS_ADDRESS 454@item DBUS_SESSION_BUS_ADDRESS
455@vindex DBUS_SESSION_BUS_ADDRESS, environment variable
450Used by D-Bus when Emacs is compiled with it. Usually, there is no 456Used by D-Bus when Emacs is compiled with it. Usually, there is no
451need to change it. Setting it to a dummy address, like 457need to change it. Setting it to a dummy address, like
452@samp{unix:path=/dev/null}, suppresses connections to the D-Bus session 458@samp{unix:path=/dev/null}, suppresses connections to the D-Bus session
453bus as well as autolaunching the D-Bus session bus if not running yet. 459bus as well as autolaunching the D-Bus session bus if not running yet.
454@item EMACSDATA 460@item EMACSDATA
461@vindex EMACSDATA, environment variable
455Directory for the architecture-independent files that come with Emacs. 462Directory for the architecture-independent files that come with Emacs.
456This is used to initialize the variable @code{data-directory}. 463This is used to initialize the variable @code{data-directory}.
457@item EMACSDOC 464@item EMACSDOC
465#vindex EMACSDOC, environment variable
458Directory for the documentation string file, which is used to 466Directory for the documentation string file, which is used to
459initialize the Lisp variable @code{doc-directory}. 467initialize the Lisp variable @code{doc-directory}.
460@item EMACSLOADPATH 468@item EMACSLOADPATH
469#vindex EMACSLOADPATH, environment variable
461A colon-separated list of directories@footnote{Here and below, 470A colon-separated list of directories@footnote{Here and below,
462whenever we say ``colon-separated list of directories'', it pertains 471whenever we say ``colon-separated list of directories'', it pertains
463to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the 472to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the
@@ -471,23 +480,28 @@ the default @code{load-path}. To specify an empty element in the
471middle of the list, use 2 colons in a row, as in 480middle of the list, use 2 colons in a row, as in
472@samp{EMACSLOADPATH="/tmp::/foo"}. 481@samp{EMACSLOADPATH="/tmp::/foo"}.
473@item EMACSPATH 482@item EMACSPATH
483@vindex EMACSPATH, environment variable
474A colon-separated list of directories to search for executable files. 484A colon-separated list of directories to search for executable files.
475If set, Emacs uses this in addition to @env{PATH} (see below) when 485If set, Emacs uses this in addition to @env{PATH} (see below) when
476initializing the variable @code{exec-path} (@pxref{Shell}). 486initializing the variable @code{exec-path} (@pxref{Shell}).
477@item EMAIL 487@item EMAIL
488@vindex EMAIL, environment variable
478@vindex user-mail-address@r{, initialization} 489@vindex user-mail-address@r{, initialization}
479Your email address; used to initialize the Lisp variable 490Your email address; used to initialize the Lisp variable
480@code{user-mail-address}, which the Emacs mail interface puts into the 491@code{user-mail-address}, which the Emacs mail interface puts into the
481@samp{From} header of outgoing messages (@pxref{Mail Headers}). 492@samp{From} header of outgoing messages (@pxref{Mail Headers}).
482@item ESHELL 493@item ESHELL
494@vindex ESHELL, environment variable
483Used for shell-mode to override the @env{SHELL} environment variable 495Used for shell-mode to override the @env{SHELL} environment variable
484(@pxref{Interactive Shell}). 496(@pxref{Interactive Shell}).
485@item HISTFILE 497@item HISTFILE
498@vindex HISTFILE, environment variable
486The name of the file that shell commands are saved in between logins. 499The name of the file that shell commands are saved in between logins.
487This variable defaults to @file{~/.bash_history} if you use Bash, to 500This variable defaults to @file{~/.bash_history} if you use Bash, to
488@file{~/.sh_history} if you use ksh, and to @file{~/.history} 501@file{~/.sh_history} if you use ksh, and to @file{~/.history}
489otherwise. 502otherwise.
490@item HOME 503@item HOME
504@vindex HOME, environment variable
491The location of your files in the directory tree; used for 505The location of your files in the directory tree; used for
492expansion of file names starting with a tilde (@file{~}). On MS-DOS, 506expansion of file names starting with a tilde (@file{~}). On MS-DOS,
493it defaults to the directory from which Emacs was started, with 507it defaults to the directory from which Emacs was started, with
@@ -499,6 +513,7 @@ where @var{username} is your user name), though for backwards
499compatibility @file{C:/} will be used instead if a @file{.emacs} file 513compatibility @file{C:/} will be used instead if a @file{.emacs} file
500is found there. 514is found there.
501@item HOSTNAME 515@item HOSTNAME
516@vindex HOSTNAME, environment variable
502The name of the machine that Emacs is running on. 517The name of the machine that Emacs is running on.
503@c complete.el is obsolete since 24.1. 518@c complete.el is obsolete since 24.1.
504@ignore 519@ignore
@@ -507,15 +522,24 @@ A colon-separated list of directories. Used by the @code{complete} package
507to search for files. 522to search for files.
508@end ignore 523@end ignore
509@item INFOPATH 524@item INFOPATH
525@vindex INFOPATH, environment variable
510A colon-separated list of directories in which to search for Info files. 526A colon-separated list of directories in which to search for Info files.
511@item LC_ALL 527@item LC_ALL
528@vindex LC_ALL, environment variable
512@itemx LC_COLLATE 529@itemx LC_COLLATE
530@vindex LC_COLLATE, environment variable
513@itemx LC_CTYPE 531@itemx LC_CTYPE
532@vindex LC_CTYPE, environment variable
514@itemx LC_MESSAGES 533@itemx LC_MESSAGES
534@vindex LC_MESSAGES, environment variable
515@itemx LC_MONETARY 535@itemx LC_MONETARY
536@vindex LC_MONETARY, environment variable
516@itemx LC_NUMERIC 537@itemx LC_NUMERIC
538@vindex LC_NUMERIC, environment variable
517@itemx LC_TIME 539@itemx LC_TIME
540@vindex LC_TIME, environment variable
518@itemx LANG 541@itemx LANG
542@vindex LANG, environment variable
519The user's preferred locale. The locale has six categories, specified 543The user's preferred locale. The locale has six categories, specified
520by the environment variables @env{LC_COLLATE} for sorting, 544by the environment variables @env{LC_COLLATE} for sorting,
521@env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system 545@env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system
@@ -537,73 +561,92 @@ matched against entries in @code{locale-language-names},
537@code{locale-preferred-coding-systems}, to select a default language 561@code{locale-preferred-coding-systems}, to select a default language
538environment and coding system. @xref{Language Environments}. 562environment and coding system. @xref{Language Environments}.
539@item LOGNAME 563@item LOGNAME
564@vindex LOGNAME, environment variable
540The user's login name. See also @env{USER}. 565The user's login name. See also @env{USER}.
541@item MAIL 566@item MAIL
567@vindex MAIL, environment variable
542The name of your system mail inbox. 568The name of your system mail inbox.
543@ifnottex 569@ifnottex
544@item MH 570@item MH
571@vindex MH, environment variable
545Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs 572Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs
546Interface to MH}. 573Interface to MH}.
547@end ifnottex 574@end ifnottex
548@item NAME 575@item NAME
576@vindex NAME, environment variable
549Your real-world name. This is used to initialize the variable 577Your real-world name. This is used to initialize the variable
550@code{user-full-name} (@pxref{Mail Headers}). 578@code{user-full-name} (@pxref{Mail Headers}).
551@item NNTPSERVER 579@item NNTPSERVER
580@vindex NNTPSERVER, environment variable
552The name of the news server. Used by the mh and Gnus packages. 581The name of the news server. Used by the mh and Gnus packages.
553@item ORGANIZATION 582@item ORGANIZATION
583@vindex ORGANIZATION, environment variable
554The name of the organization to which you belong. Used for setting the 584The name of the organization to which you belong. Used for setting the
555`Organization:' header in your posts from the Gnus package. 585`Organization:' header in your posts from the Gnus package.
556@item PATH 586@item PATH
587@vindex PATH, environment variable
557A colon-separated list of directories containing executable files. 588A colon-separated list of directories containing executable files.
558This is used to initialize the variable @code{exec-path} 589This is used to initialize the variable @code{exec-path}
559(@pxref{Shell}). 590(@pxref{Shell}).
560@item PWD 591@item PWD
592@vindex PWD, environment variable
561If set, this should be the default directory when Emacs was started. 593If set, this should be the default directory when Emacs was started.
562@item REPLYTO 594@item REPLYTO
595@vindex REPLYTO, environment variable
563If set, this specifies an initial value for the variable 596If set, this specifies an initial value for the variable
564@code{mail-default-reply-to} (@pxref{Mail Headers}). 597@code{mail-default-reply-to} (@pxref{Mail Headers}).
565@item SAVEDIR 598@item SAVEDIR
599@vindex SAVEDIR, environment variable
566The name of a directory in which news articles are saved by default. 600The name of a directory in which news articles are saved by default.
567Used by the Gnus package. 601Used by the Gnus package.
568@item SHELL 602@item SHELL
603@vindex SHELL, environment variable
569The name of an interpreter used to parse and execute programs run from 604The name of an interpreter used to parse and execute programs run from
570inside Emacs. 605inside Emacs.
571@item SMTPSERVER 606@item SMTPSERVER
607@vindex SMTPSERVER, environment variable
572The name of the outgoing mail server. This is used to initialize the 608The name of the outgoing mail server. This is used to initialize the
573variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}). 609variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}).
574@cindex background mode, on @command{xterm} 610@cindex background mode, on @command{xterm}
575@item TERM 611@item TERM
612@vindex TERM, environment variable
576The type of the terminal that Emacs is using. This variable must be 613The type of the terminal that Emacs is using. This variable must be
577set unless Emacs is run in batch mode. On MS-DOS, it defaults to 614set unless Emacs is run in batch mode. On MS-DOS, it defaults to
578@samp{internal}, which specifies a built-in terminal emulation that 615@samp{internal}, which specifies a built-in terminal emulation that
579handles the machine's own display. 616handles the machine's own display.
580@item TERMCAP 617@item TERMCAP
618@vindex TERMCAP, environment variable
581The name of the termcap library file describing how to program the 619The name of the termcap library file describing how to program the
582terminal specified by @env{TERM}. This defaults to 620terminal specified by @env{TERM}. This defaults to
583@file{/etc/termcap}. 621@file{/etc/termcap}.
584@item TMPDIR 622@item TMPDIR
623@vindex TMPDIR, environment variable
585@itemx TMP 624@itemx TMP
625@vindex TMP, environment variable
586@itemx TEMP 626@itemx TEMP
627@vindex TEMP, environment variable
587These environment variables are used to initialize the variable 628These environment variables are used to initialize the variable
588@code{temporary-file-directory}, which specifies a directory in which 629@code{temporary-file-directory}, which specifies a directory in which
589to put temporary files (@pxref{Backup}). Emacs tries to use 630to put temporary files (@pxref{Backup}). Emacs tries to use
590@env{TMPDIR} first. If that is unset, Emacs normally falls back on 631@env{TMPDIR} first. If that is unset, Emacs normally falls back on
591@file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on 632@file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on
592@env{TMP}, then @env{TEMP}, and finally @file{c:/temp}. 633@env{TMP}, then @env{TEMP}, and finally @file{c:/temp}.
593
594@item TZ 634@item TZ
635@vindex TZ, environment variable
595This specifies the current time zone and possibly also daylight 636This specifies the current time zone and possibly also daylight
596saving time information. On MS-DOS, if @env{TZ} is not set in the 637saving time information. On MS-DOS, if @env{TZ} is not set in the
597environment when Emacs starts, Emacs defines a default value as 638environment when Emacs starts, Emacs defines a default value as
598appropriate for the country code returned by DOS@. On MS-Windows, Emacs 639appropriate for the country code returned by DOS@. On MS-Windows, Emacs
599does not use @env{TZ} at all. 640does not use @env{TZ} at all.
600@item USER 641@item USER
642@vindex USER, environment variable
601The user's login name. See also @env{LOGNAME}. On MS-DOS, this 643The user's login name. See also @env{LOGNAME}. On MS-DOS, this
602defaults to @samp{root}. 644defaults to @samp{root}.
603@item VERSION_CONTROL 645@item VERSION_CONTROL
646@vindex VERSION_CONTROL, environment variable
604Used to initialize the @code{version-control} variable (@pxref{Backup 647Used to initialize the @code{version-control} variable (@pxref{Backup
605Names}). 648Names}).
606@end vtable 649@end table
607 650
608@node Misc Variables 651@node Misc Variables
609@appendixsubsec Miscellaneous Variables 652@appendixsubsec Miscellaneous Variables
diff --git a/doc/emacs/msdog-xtra.texi b/doc/emacs/msdog-xtra.texi
index 1033aeb700b..304039e6bf2 100644
--- a/doc/emacs/msdog-xtra.texi
+++ b/doc/emacs/msdog-xtra.texi
@@ -352,7 +352,7 @@ long file name support, set the environment variable @env{LFN} to
352DOS programs to access long file names, so Emacs built for MS-DOS will 352DOS programs to access long file names, so Emacs built for MS-DOS will
353only see their short 8+3 aliases. 353only see their short 8+3 aliases.
354 354
355@cindex @env{HOME} directory under MS-DOS 355@cindex HOME directory under MS-DOS
356 MS-DOS has no notion of home directory, so Emacs on MS-DOS pretends 356 MS-DOS has no notion of home directory, so Emacs on MS-DOS pretends
357that the directory where it is installed is the value of the @env{HOME} 357that the directory where it is installed is the value of the @env{HOME}
358environment variable. That is, if your Emacs binary, 358environment variable. That is, if your Emacs binary,
diff --git a/doc/emacs/msdog.texi b/doc/emacs/msdog.texi
index 0245fed208c..a17d87543d9 100644
--- a/doc/emacs/msdog.texi
+++ b/doc/emacs/msdog.texi
@@ -425,7 +425,7 @@ names, which might cause misalignment of columns in Dired display.
425 425
426@node Windows HOME 426@node Windows HOME
427@section HOME and Startup Directories on MS-Windows 427@section HOME and Startup Directories on MS-Windows
428@cindex @code{HOME} directory on MS-Windows 428@cindex HOME directory on MS-Windows
429 429
430 The Windows equivalent of @code{HOME} is the @dfn{user-specific 430 The Windows equivalent of @code{HOME} is the @dfn{user-specific
431application data directory}. The actual location depends on the 431application data directory}. The actual location depends on the