README.md
author Oleksandr Gavenko <gavenkoa@gmail.com>
Mon, 25 Dec 2023 20:15:49 +0200
changeset 1772 d97be992a1f9
parent 1717 3c60aeba5004
permissions -rw-r--r--
Introduced Org state FAILED.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
     1
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
     2
# Oleksandr Gavenko's Emacs initialization script
749
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
     3
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
     4
## Installation
12
fb11a9de5ab3 Добавил коментарии по инсталляции файлов настроек.
Oleksander Gavenko <gavenko_a@3g.ua>
parents:
diff changeset
     5
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
     6
To install:
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
     7
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
     8
    make install
42
04fd7747bc49 Update copyright notice.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 13
diff changeset
     9
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    10
To download external packages:
1687
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    11
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    12
    make install-packages
1687
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    13
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    14
## Config files structure
1687
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    15
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    16
I use `~/.emacs.d/init.d` as main entry point for customization. That file load
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    17
another files in such order:
1687
3f69332472cb Added Make target to preinstall packages from ELPA.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1237
diff changeset
    18
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    19
`~/.emacs.d/.emacs-autogen`
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    20
:   Hold environment info discovered during installing. Automatically generated.
46
773ac573338d Update content.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 42
diff changeset
    21
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    22
`~/.emacs.d/.emacs-pre`
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    23
:   For manually written customization (usually for updating load-path) which
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    24
    can affect on `.emacs-my`. Will not be overridden on install.
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    25
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    26
`~/.emacs.d/my/loaddefs.el`
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    27
:   Definition for my modes autoload functions. Automatically generated.
46
773ac573338d Update content.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 42
diff changeset
    28
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    29
`~/.emacs.d/.emacs-custom`
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    30
:   For storing customization's by Emacs itself. Some settings from this file can
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    31
    effect on loaded Elisp files from .emacs-my. Will not be overridden on
1237
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    32
    install.
1715
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    33
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    34
`~/.emacs.d/.emacs-my`
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    35
:   Here main customization's is placed.
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    36
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    37
`~/.emacs.d/.emacs-post`
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    38
:   For storing connection settings, passwords and enabling modes added to
b4821d6701e5 Converted README to Markdown format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1687
diff changeset
    39
    load-path in `~/.emacs.d/.emacs-pre`. Will not be overridden on install.
749
a8d71dd0fbd5 Convert documentation files to RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 386
diff changeset
    40
1716
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    41
## Org mode conventions
1237
a194c21bc9d2 Update docs for new file hierarchy.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 749
diff changeset
    42
1717
3c60aeba5004 Moved definition of root for Org mode files to defs file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1716
diff changeset
    43
`my-org-dir` controls location of Org root directory.
1716
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    44
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    45
## Legacy setup instructions for native Windows Emacs
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    46
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    47
Define env var `HOME` like `c:\home`. Emacs will expand path element `~` to that
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    48
directory and some modes provide shortcuts for quick navigation to that
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    49
directory.
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    50
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    51
### cygwin-mount.el
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    52
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    53
`cygwin-mount.el` teaches Windows Emacs to understand Cygwin paths.
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    54
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    55
In particular setting `INFOPATH` & `MANPATH` using Cygwin's convention allows to
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    56
read info and man pages from Windows Emacs!
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    57
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    58
Example of `INFOPATH` which works both in Cygwin and native Emacs:
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    59
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    60
    INFOPATH=/cygdrive/c/home/usr/share/info:/usr/share/info:/usr/local/share/info:
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    61
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    62
Final sign `:` instructs Cygwin's built-in info viewer to include system paths
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    63
and native Emacs to include its own info pages.
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    64
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    65
Emacs's `woman.el` and Cygwin's `man` both understand following:
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    66
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    67
    MANPATH=:/cygdrive/c/home/usr/share/man:/usr/share/man:/usr/local/share/man
7724648509b6 Docs: Legacy setup instructions for native Windows Emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1715
diff changeset
    68