EmacsInit

for backup my emacs init file

Traditional Chinese README

Indexes

• Files
• To Use Emacs Init File
  • For Linux and Mac
  • For Windows
• Install
  • Settings
  • Using Install Script
  • Using Makefile
• Getting Start
• KeyBindings
  • Normale State
• Packages

Files

• .emacs : settings for emacs
• install.sh : install script for .emacs
• makefile : makefile for .emacs
• settings : setting file for install/uninstall

To Use Emacs Init File

open the emacs and type C-h r, it will show the emacs manual

then type g Init File and press Enter, it will show the help file about where to put emacs init file

I will talk about where I place my emacs init file below as an example

For Linux and Mac

I place the ".emacs" at "$HOME/"

For Windows

I place the ".emacs" at "${env:APPDATA}\.emacs.d\" ( or "%APPDATA%\.emacs.d\" in CMD ) with name "init.el"

this is the default directory of emacs init file

Install

Settings

• the directory path targetDir

  this is the installed directory of .emacs

• the target file name initTargetName

  this is the installed file name of .emacs

• the source file name initSourceName

  this is the file name in the repo, this is used for the purpose of updating emacs init file

Using Install Script

the script is written in bash script, so any shell support bash script can be used

to use the script

• first chmod u+x install.sh to make the script executable
• modify the variables in settings if neccessary
• type ./install.sh to install .emacs file

Using Makefile

makefile is written for those who want to use make to finish the task

it is also used to ease the update of source file from me

currently, the makefile support the following options

• default : update the source file

  this is make with no option

• install : install .emacs

  actually this option use the install script, so make sure the install script is executable

• uninstall : uninstall .emacs

to change the path and file name of .emacs, just modify the variables in settings

Getting Start

for using the emacs init file first time, you need to decide whether you want to use the packages or not

if you don't want to use packages, just delete the corresponding lines in the emacs init file

if you want to use the packages, just install the emacs init file and open emacs.

it will automatically install the packages if you use emacs for the first time.

if the download of package does not happen and an error occurs.

type <M-x> package-refresh-contents in emacs, and <M-x> load <the-path-of-emacs-init-file>.

this should solve the problem.

then just have fun with the init file.

Key Bindings

all keybindings in evil insert state except <ESC>, <C-z> are unbound, since I don't use insert mode key bindings in vim, and I prefer using emacs keybinding in insert state.

• C-c a : open the org agenda dispatcher
• C-c c : open the org capture menu

Normal State

• ' ' ( space ) : page down
• '\d' ( backspace ) : page up
• \r : toggle relative line number ( only in emacs version >= 26 )

Packages

• evil : Extensable VI Layer
• org : the org mode package
• htmlize : for exporting html in org mode