Re: rec-mode.info file

[Antoine Kalmbach]

Charles Millar <millarc@verizon.net> writes:

> Is there some code that has to added to the new rec-mode repo so that the new
> info file is accessed by the info command?
>

Unfortunately, distributing rec-mode solely via ELPA means that the info
manual will not be installed in your system info directory, which is
where the info command usually looks for info files.

Instead, you can use the Emacs Info reader. ELPA packages that come with
Info manuals will be automatically be accessible upon installation.

So, once rec-mode installs successfully from ELPA, you will be able to
use Emacs' info reader by invoking `C-h i RET m RET rec-mode'.  I also
added a link to the package commentary section, so doing `C-h P RET
rec-mode' will take you to the package description which has a link to
the relevant info section.

But, Emacs' package manager does not install the info file into your
system info directory, instead, it puts them into
`~/.emacs.d/elpa/rec-mode-VERSION/rec-mode.info'.  This means it won't
be available for the command line info reader.  If you prefer that over
Emacs' Info reader, then you can do one of the following:

  1. Make an alias that calls info with `-d 
<path-to-directory-of-rec-mode.info>'

  2. Symlink rec-mode.info from ~/.emacs.d/elpa/... to 
/usr/local/share/info/rec-mode.info

  3. Manually clone the repository and symlink that file

Or any combination of the three.  But the problem with symlinks is that
the symlink is no longer valid as the installation path changes whenever
rec-mode's VERSION changes.

Alternatively, you can wait until your operating system's package
manager has rec-mode, if it packages Emacs packages (Debian does, I
think).  Those should install the info file.  But this can be a long
wait, and may not be the way you install Emacs packages.

As a result, I would recommend, once rec-mode installs from ELPA, to use
the Emacs Info reader.  If you must use info, then all you need to
ensure is info can access rec-mode.info that is installed outside your
system info directory.

-- 
Antoine Kalmbach