1 .. -*- coding: utf-8 -*-

     2 

     3 =======================================

     4  'dot-emacs' installation instruction.

     5 =======================================

     6 .. contents::

     7 

     8 Written by Oleksandr Gavenko <gavenkoa@gmail.com>

     9 

    10 You can do anything with this file without any warranty.

    11 

    12 Setup on Windows

    13 ===

    14 

    15 Choose separate ``HOME`` directory like ``c:\home`` and set this environment

    16 variable in ``System => Advanced System Settings => Environment Variables``.

    17 

    18 After setting ``HOME`` environment variable Emacs expands ``~`` path element to

    19 that directory allowing quicker access to your file (especially with ``ido``).

    20 

    21 If ``INFOPATH`` is not set it automatically extended with additional directory

    22 ``~/usr/share/info``. With ``cygwin-mount.el`` Cygwin info pages become

    23 available in native Emacs too!

    24 

    25 .. note::

    26 

    27    Example of ``INFOPATH`` which works with Cygwin and native Emacs::

    28 

    29      INFOPATH=/cygdrive/d/home/usr/share/info:/usr/share/info:/usr/local/share/info:

    30 

    31    Latest ``:`` sign instructs Cygwin built-in info viewer to include system

    32    paths and native Emacs to include its own info pages regardless installation

    33    directory.

    34 

    35 ``MANPATH`` automatically expanded with additional directory

    36 ``~/usr/share/man`` if ``cygwin-mount.el`` is installed. Trailing ``:``

    37 correctly treated in native Emacs with ``cygwin-mount.el``.

    38 

    39 .. note::

    40 

    41    To use ``woman`` on Windows set MANPATH like this (note that path in

    42    Cygwin/MinGW style so you need use cygwin-mount.el)::

    43 

    44   MANPATH=:/cygdrive/d/home/usr/share/man:/usr/share/man:/usr/local/share/man

    45 

    46 .. note:: Default man search paths is listened in ``/usr/share/misc/man.conf``.

    47 

    48 .. note:: You can customise ``woman-manpath`` variable.