Docs: Legacy setup instructions for native Windows Emacs.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Sat, 30 Jan 2021 23:52:32 +0200
changeset 1716 7724648509b6
parent 1715 b4821d6701e5
child 1717 3c60aeba5004
Docs: Legacy setup instructions for native Windows Emacs.
INSTALL.rst
README.md
--- a/INSTALL.rst	Sat Jan 30 23:37:26 2021 +0200
+++ b/INSTALL.rst	Sat Jan 30 23:52:32 2021 +0200
@@ -1,51 +1,3 @@
-.. -*- coding: utf-8 -*-
-
-=======================================
- 'dot-emacs' installation instruction.
-=======================================
-.. contents::
-
-Written by Oleksandr Gavenko <gavenkoa@gmail.com>
-
-You can do anything with this file without any warranty.
-
-Setup on Windows
-===
-
-Choose separate ``HOME`` directory like ``c:\home`` and set this environment
-variable in ``System => Advanced System Settings => Environment Variables``.
-
-After setting ``HOME`` environment variable Emacs expands ``~`` path element to
-that directory allowing quicker access to your file (especially with ``ido``).
-
-If ``INFOPATH`` is not set it automatically extended with additional directory
-``~/usr/share/info``. With ``cygwin-mount.el`` Cygwin info pages become
-available in native Emacs too!
-
-.. note::
-
-   Example of ``INFOPATH`` which works with Cygwin and native Emacs::
-
-     INFOPATH=/cygdrive/d/home/usr/share/info:/usr/share/info:/usr/local/share/info:
-
-   Latest ``:`` sign instructs Cygwin built-in info viewer to include system
-   paths and native Emacs to include its own info pages regardless installation
-   directory.
-
-``MANPATH`` automatically expanded with additional directory
-``~/usr/share/man`` if ``cygwin-mount.el`` is installed. Trailing ``:``
-correctly treated in native Emacs with ``cygwin-mount.el``.
-
-.. note::
-
-   To use ``woman`` on Windows set MANPATH like this (note that path in
-   Cygwin/MinGW style so you need use cygwin-mount.el)::
-
-  MANPATH=:/cygdrive/d/home/usr/share/man:/usr/share/man:/usr/local/share/man
-
-.. note:: Default man search paths is listened in ``/usr/share/misc/man.conf``.
-
-.. note:: You can customise ``woman-manpath`` variable.
 
 GTD (org-mode)
 ===
--- a/README.md	Sat Jan 30 23:37:26 2021 +0200
+++ b/README.md	Sat Jan 30 23:52:32 2021 +0200
@@ -38,4 +38,31 @@
 :   For storing connection settings, passwords and enabling modes added to
     load-path in `~/.emacs.d/.emacs-pre`. Will not be overridden on install.
 
+## Org mode conventions
 
+TODO
+
+## Legacy setup instructions for native Windows Emacs
+
+Define env var `HOME` like `c:\home`. Emacs will expand path element `~` to that
+directory and some modes provide shortcuts for quick navigation to that
+directory.
+
+### cygwin-mount.el
+
+`cygwin-mount.el` teaches Windows Emacs to understand Cygwin paths.
+
+In particular setting `INFOPATH` & `MANPATH` using Cygwin's convention allows to
+read info and man pages from Windows Emacs!
+
+Example of `INFOPATH` which works both in Cygwin and native Emacs:
+
+    INFOPATH=/cygdrive/c/home/usr/share/info:/usr/share/info:/usr/local/share/info:
+
+Final sign `:` instructs Cygwin's built-in info viewer to include system paths
+and native Emacs to include its own info pages.
+
+Emacs's `woman.el` and Cygwin's `man` both understand following:
+
+    MANPATH=:/cygdrive/c/home/usr/share/man:/usr/share/man:/usr/local/share/man
+