daniel/emacs
1
2
Fork 0
Code Issues 7 Pull Requests Projects Releases Wiki Activity

add readme

Browse Source
This commit is contained in:
Daniel Weschke
2020-12-05 00:37:25 +01:00
commit c2ad027dcf
2 changed files with 426 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

347
README.md Normal file
View File

@@ -0,0 +1,347 @@
# Table of Contents
1. [Requirements](#org5dac277)
2. [Key bindings and functions](#org8820a76)
3. [Packages](#org0b929de)
4. [Information](#org2b905fc)
5. [Errors](#org79be759)
1. [failed execution of bibtex2html](#org48a4eb7)
This is an ongoing evolution of Emacs configuration files, inspired by
a bunch of online resources.
<a id="org5dac277"></a>
# Requirements
- external packages
- aspell/hunspell (flyspell-buffer)
- biber (for org-mode latex-mode)
- bibtex2html (for org-mode)
- ledger (for ledger-mode)
- languagetool (for langtool)
- python-pylint (for python-mode)
- for EAF emacs-application-framework
yay -S python-pyqt5 python-pyqt5-sip python-pyqtwebengine python-qrcode python-feedparser python-dbus python-pyinotify python-markdown nodejs aria2 libreoffice python-pymupdf python-grip filebrowser-bin
- copy/merge the texmf directory into your home directory
- copy all files of this directory into your ~/.config/emacs directory
- for Emacs version < 27 create symbolic link to the init file
- `ln -s ~/.config/emacs/init ~/.emacs` (or `~/.emacs.el`,
`~/.emacs.d/init.el`)
<a id="org8820a76"></a>
# Key bindings and functions
<table>
<caption class="t-above"><span class="table-number">Table 1:</span> General</caption>
<colgroup>
<col class="org-left">
<col class="org-left">
<col class="org-left">
</colgroup>
<tbody>
<tr>
<td class="org-left">M-></td>
<td class="org-left">end-of-buffer</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">M-<</td>
<td class="org-left">beginning-of-buffer</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">C-x h</td>
<td class="org-left">mark-whole-buffer</td>
<td class="org-left">mark the whole buffer</td>
</tr>
<tr>
<td class="org-left">C-x TAB</td>
<td class="org-left">indent-rigidly</td>
<td class="org-left">indent selected region</td>
</tr>
<tr>
<td class="org-left">C-x RET f</td>
<td class="org-left">set-buffer-file-coding-system</td>
<td class="org-left">e. g. set to utf-8</td>
</tr>
<tr>
<td class="org-left">&#xa0;</td>
<td class="org-left">decode-coding-region</td>
<td class="org-left">e. g. decode to utf-8 (郭富城Aaron Kwok)</td>
</tr>
<tr>
<td class="org-left">&#xa0;</td>
<td class="org-left">diff-buffer-with-file</td>
<td class="org-left">show a diff between buffer and file</td>
</tr>
<tr>
<td class="org-left">C-h v</td>
<td class="org-left">counsel-describe-variable</td>
<td class="org-left">help text of variable</td>
</tr>
<tr>
<td class="org-left">C-h f</td>
<td class="org-left">counsel-describe-funtion</td>
<td class="org-left">help text of function</td>
</tr>
</tbody>
</table>
<table>
<caption class="t-above"><span class="table-number">Table 2:</span> Org</caption>
<colgroup>
<col class="org-left">
<col class="org-left">
<col class="org-left">
</colgroup>
<tbody>
<tr>
<td class="org-left">C-c &vert;</td>
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert seperator 1. TAB, 2. comma, 3. space</td>
</tr>
<tr>
<td class="org-left">C-u C-c &vert;</td>
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert using comma (CSV) seperator</td>
</tr>
<tr>
<td class="org-left">C-u C-u C-c &vert;</td>
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert using TAB</td>
</tr>
<tr>
<td class="org-left">C-u N C-c &vert;</td>
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert using N spaces</td>
</tr>
<tr>
<td class="org-left">C-u REGEX C-c &vert;</td>
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert using regex to match seperator</td>
</tr>
<tr>
<td class="org-left">C-c C-x \\</td>
<td class="org-left">org-toggle-pretty-entries</td>
<td class="org-left">e. g. displays &plusmn; as ±</td>
</tr>
<tr>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">Org table</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">S-right</td>
<td class="org-left">org-shiftright</td>
<td class="org-left">move a single cell right</td>
</tr>
<tr>
<td class="org-left">S-left</td>
<td class="org-left">org-shiftleft</td>
<td class="org-left">move a single cell left</td>
</tr>
<tr>
<td class="org-left">C-c SPC</td>
<td class="org-left">org-table-blank-field</td>
<td class="org-left">clear cell</td>
</tr>
<tr>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">Org src block</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">C-c C-v t</td>
<td class="org-left">org-babel-tangle</td>
<td class="org-left">create a file with the content of the block, use in header: :tangle filename</td>
</tr>
</tbody>
</table>
<table>
<caption class="t-above"><span class="table-number">Table 3:</span> Custom and changed keys</caption>
<colgroup>
<col class="org-left">
<col class="org-left">
<col class="org-left">
</colgroup>
<tbody>
<tr>
<td class="org-left">C-r</td>
<td class="org-left">query-replace-regexp</td>
<td class="org-left">replace text. (former isearch-backward)</td>
</tr>
<tr>
<td class="org-left">C-x C-b</td>
<td class="org-left">ibuffer</td>
<td class="org-left">list buffers (former list-buffers)</td>
</tr>
<tr>
<td class="org-left">C-x &vert;</td>
<td class="org-left">toggle-window-split</td>
<td class="org-left">toggle horizontal/vertical 2 window split</td>
</tr>
<tr>
<td class="org-left">M-up</td>
<td class="org-left">move-line-up</td>
<td class="org-left">move current line up</td>
</tr>
<tr>
<td class="org-left">M-down</td>
<td class="org-left">move-line-down</td>
<td class="org-left">move current line down</td>
</tr>
<tr>
<td class="org-left">mouse-6</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">scroll right</td>
</tr>
<tr>
<td class="org-left">mouse-7</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">scroll left</td>
</tr>
<tr>
<td class="org-left">mouse-8</td>
<td class="org-left">previous-buffer</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">mouse-9</td>
<td class="org-left">next-buffer</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">f5</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">in org export to html</td>
</tr>
<tr>
<td class="org-left">f6</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">in org export to LaTeX</td>
</tr>
</tbody>
</table>
<a id="org0b929de"></a>
# Packages
- **rainbow-mode.el:** <https://elpa.gnu.org/packages/rainbow-mode.html>
rainbow-mode is a minor mode for Emacs which displays strings representing
colors with the color they represent as background.
<a id="org2b905fc"></a>
# Information
Interlock symlinks and auto-save files.
Be aware that symbolic links of the form “.#\*” are not auto-save files
but interlocks to prevent the simultaneous editing of the same
file. See [Interlocking](https://www.emacswiki.org/info-ref?find=Interlocking) in the [EmacsManual](https://www.emacswiki.org/emacs/EmacsManual) for details.
<a id="org79be759"></a>
# Errors
<a id="org48a4eb7"></a>
## failed execution of bibtex2html
see bib2htmlxxxxxx.blg for errors, e.g.
- I couldn&rsquo;t open style file acmu.bst
copy/merge the texmf directory into your home directory.

79
README.org Normal file
View File

@@ -0,0 +1,79 @@
#+TITLE: Emacs Configuration
This is an ongoing evolution of Emacs configuration files, inspired by
a bunch of online resources.
* Requirements
- external packages
- aspell/hunspell (flyspell-buffer)
- biber (for org-mode latex-mode)
- bibtex2html (for org-mode)
- ledger (for ledger-mode)
- languagetool (for langtool)
- python-pylint (for python-mode)
- for EAF emacs-application-framework
yay -S python-pyqt5 python-pyqt5-sip python-pyqtwebengine python-qrcode python-feedparser python-dbus python-pyinotify python-markdown nodejs aria2 libreoffice python-pymupdf python-grip filebrowser-bin
- copy/merge the texmf directory into your home directory
- copy all files of this directory into your ~/.config/emacs directory
- for Emacs version < 27 create symbolic link to the init file
- =ln -s ~/.config/emacs/init ~/.emacs= (or =~/.emacs.el=,
=~/.emacs.d/init.el=)
* Key bindings and functions
#+caption: General
| M-> | end-of-buffer | |
| M-< | beginning-of-buffer | |
| C-x h | mark-whole-buffer | mark the whole buffer |
| C-x TAB | indent-rigidly | indent selected region |
| C-x RET f | set-buffer-file-coding-system | e. g. set to utf-8 |
| | decode-coding-region | e. g. decode to utf-8 (郭富城Aaron Kwok) |
| | diff-buffer-with-file | show a diff between buffer and file |
| C-h v | counsel-describe-variable | help text of variable |
| C-h f | counsel-describe-funtion | help text of function |
#+caption: Org
| C-c \vert | org-table-create-or-convert-from-region | convert seperator 1. TAB, 2. comma, 3. space |
| C-u C-c \vert | org-table-create-or-convert-from-region | convert using comma (CSV) seperator |
| C-u C-u C-c \vert | org-table-create-or-convert-from-region | convert using TAB |
| C-u N C-c \vert | org-table-create-or-convert-from-region | convert using N spaces |
| C-u REGEX C-c \vert | org-table-create-or-convert-from-region | convert using regex to match seperator |
| C-c C-x \ | org-toggle-pretty-entries | e. g. displays \pm as ± |
| | | |
| Org table | | |
| S-right | org-shiftright | move a single cell right |
| S-left | org-shiftleft | move a single cell left |
| C-c SPC | org-table-blank-field | clear cell |
| | | |
| Org src block | | |
| C-c C-v t | org-babel-tangle | create a file with the content of the block, use in header: :tangle filename |
#+caption: Custom and changed keys
| C-r | query-replace-regexp | replace text. (former isearch-backward) |
| C-x C-b | ibuffer | list buffers (former list-buffers) |
| C-x \vert | toggle-window-split | toggle horizontal/vertical 2 window split |
| M-up | move-line-up | move current line up |
| M-down | move-line-down | move current line down |
| mouse-6 | | scroll right |
| mouse-7 | | scroll left |
| mouse-8 | previous-buffer | |
| mouse-9 | next-buffer | |
| f5 | | in org export to html |
| f6 | | in org export to LaTeX |
* Packages
- rainbow-mode.el :: https://elpa.gnu.org/packages/rainbow-mode.html
rainbow-mode is a minor mode for Emacs which displays strings representing
colors with the color they represent as background.
* Information
Interlock symlinks and auto-save files.
Be aware that symbolic links of the form “.#*” are not auto-save files
but interlocks to prevent the simultaneous editing of the same
file. See [[https://www.emacswiki.org/info-ref?find=Interlocking][Interlocking]] in the [[https://www.emacswiki.org/emacs/EmacsManual][EmacsManual]] for details.
* Errors
** failed execution of bibtex2html
see bib2htmlxxxxxx.blg for errors, e.g.
- I couldn't open style file acmu.bst
copy/merge the texmf directory into your home directory.