From c2ad027dcf8631f8788681c1cde4d39e45545322 Mon Sep 17 00:00:00 2001 From: Daniel Weschke Date: Sat, 5 Dec 2020 00:37:25 +0100 Subject: [PATCH] add readme --- README.md | 347 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.org | 79 ++++++++++++ 2 files changed, 426 insertions(+) create mode 100644 README.md create mode 100644 README.org diff --git a/README.md b/README.md new file mode 100644 index 00000000..7c8685f8 --- /dev/null +++ b/README.md @@ -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. + + + + +# 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 + + + + +++ ++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1: General
M->end-of-buffer 
M-<beginning-of-buffer 
C-x hmark-whole-buffermark the whole buffer
C-x TABindent-rigidlyindent selected region
C-x RET fset-buffer-file-coding-systeme. g. set to utf-8
 decode-coding-regione. g. decode to utf-8 (郭富城Aaron Kwok)
 diff-buffer-with-fileshow a diff between buffer and file
C-h vcounsel-describe-variablehelp text of variable
C-h fcounsel-describe-funtionhelp text of function
+ + + + +++ ++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2: Org
C-c |org-table-create-or-convert-from-regionconvert seperator 1. TAB, 2. comma, 3. space
C-u C-c |org-table-create-or-convert-from-regionconvert using comma (CSV) seperator
C-u C-u C-c |org-table-create-or-convert-from-regionconvert using TAB
C-u N C-c |org-table-create-or-convert-from-regionconvert using N spaces
C-u REGEX C-c |org-table-create-or-convert-from-regionconvert using regex to match seperator
C-c C-x \\org-toggle-pretty-entriese. g. displays ± as ±
   
Org table  
S-rightorg-shiftrightmove a single cell right
S-leftorg-shiftleftmove a single cell left
C-c SPCorg-table-blank-fieldclear cell
   
Org src block  
C-c C-v torg-babel-tanglecreate a file with the content of the block, use in header: :tangle filename
+ + + + +++ ++ ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3: Custom and changed keys
C-rquery-replace-regexpreplace text. (former isearch-backward)
C-x C-bibufferlist buffers (former list-buffers)
C-x |toggle-window-splittoggle horizontal/vertical 2 window split
M-upmove-line-upmove current line up
M-downmove-line-downmove current line down
mouse-6 scroll right
mouse-7 scroll left
mouse-8previous-buffer 
mouse-9next-buffer 
f5 in org export to html
f6 in org export to LaTeX
+ + + + +# Packages + +- **rainbow-mode.el:** + 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 [Interlocking](https://www.emacswiki.org/info-ref?find=Interlocking) in the [EmacsManual](https://www.emacswiki.org/emacs/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. + diff --git a/README.org b/README.org new file mode 100644 index 00000000..85ed109a --- /dev/null +++ b/README.org @@ -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. +