Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
other:emacs_doc [2023/09/06 10:44] – [Example configuration file] Added note about "M-;" jypeter | other:emacs_doc [2024/02/15 15:09] – [Example configuration file] Improved jypeter |
---|
==== Windows installation ==== | ==== Windows installation ==== |
| |
=== emacs for Windows === | |
| |
This is the //light and easy// option! | === emacs binaries for Windows === |
| |
* Use [[other:win10apps#installing_applications_with_winget|winget]] to install ''emacs'' for Windows: | <note warning>When installing emacs, you will need an account that can get **//elevated// (i.e. //administrator//) permissions** |
* Just type the folllowing, in a windows ''cmd'', ''PowerShell'' or ''Terminal'' **with //elevated// (i.e. //administrator//) permissions**:\\ ''%%winget install --id GNU.Emacs%%'' | |
* Note: if the automated installation with ''winget'' does not work, download the Windows installer from the most recent ''windows/gnu-XX'' directory of a [[https://ftpmirror.gnu.org/emacs/|gnu ftp mirror]] | \\ On a computer configured at LSCE, use your ''[[https://wiki.lsce.ipsl.fr/pmip3/doku.php/other:win10config#the_available_accounts|.\admin]]'' account</note> |
| |
| * Use ''winget'' to install ''emacs'' for Windows (optional [[other:win10apps#installing_applications_with_winget|winget]] details, for people who want to learn more): |
| * Just type the folllowing, in a windows ''cmd'', ''PowerShell'' or ''Terminal'' |
| * ''%%winget install --id GNU.Emacs%%'' |
| * if your Windows terminal does not have //elevated// (i.e. //administrator//) permissions, a pop-up window will open and ask for confirmation |
| * IF the automated installation with ''winget'' does not work, download the most recent Windows installer from a gnu //ftp// mirror |
| * Go to [[https://ftpmirror.gnu.org/emacs/|gnu emacs ftp mirror]] |
| * Go to the most recent ''windows/emacs-XX/'' folder (e.g. ''windows/emacs-29/'') |
| * Download the most recent ''emacs-XX.YY-installer.exe'' file (e.g. ''emacs-29.1_2-installer.exe'') and execute it |
| |
| * If everything went well, you should have a new ''Start''=>''Emacs-XX'' menu that you can use to start ''emacs'' |
| * If that's not the case, ask JYP and remind him to finish this section FIXME |
| |
* You can work with the default ''emacs'' settings, but it is highly recommended to start with a nice existing emacs configuration file (if available) | * You can work with the default ''emacs'' settings, but it is highly recommended to start with a nice existing emacs configuration file (if available) |
* [[other:emacs_doc#example_configuration_file|Example configuration file]] | * [[other:emacs_doc#example_configuration_file|Example configuration file]] |
| |
* **If** you need to **work with remote files**, ''emacs'' can automatically transfer files from your computer and remote servers, if configured properly\\ <wrap hi>**Extremely** useful</wrap> | === Recommended EXTRA binaries for Windows === |
| |
| * **If** you need to **work with remote files**, ''emacs'' can automatically transfer files between your local computer and remote servers, if configured properly\\ <wrap hi>**Extremely** useful</wrap> |
* [[https://wiki.lsce.ipsl.fr/pmip3/doku.php/other:putty_conf|Install PuTTY]], and configure a PuTTY //profile// for the desired //host **and** user// combination, so that emacs can use the [[https://the.earth.li/~sgtatham/putty/0.78/htmldoc/Chapter7.html#plink|PuTTY plink]] command to connect to remote servers (and transfer files) | * [[https://wiki.lsce.ipsl.fr/pmip3/doku.php/other:putty_conf|Install PuTTY]], and configure a PuTTY //profile// for the desired //host **and** user// combination, so that emacs can use the [[https://the.earth.li/~sgtatham/putty/0.78/htmldoc/Chapter7.html#plink|PuTTY plink]] command to connect to remote servers (and transfer files) |
* Do not use //space// characters in the predefined PuTTY profile name! | * **Do not use //space// characters in the predefined PuTTY profile name**! |
* ''mylogin_server'' (e.g. ''jyp_ssh1'') is OK | * ''mylogin_server'' (e.g. ''me_ssh1'') is OK |
* but ''mylogin server'' will **not** work | * but ''mylogin server'' will **not** work |
* Use the [[https://www.gnu.org/software/tramp/#Inline-methods|plinkx]] //method// when opening a remote file with emacs: ''/plinkx:mylogin_server:/path/to/file'' | * Use the [[https://www.gnu.org/software/tramp/#Inline-methods|plinkx]] //method// when opening a remote file with emacs: ''/plinkx:mylogin_server:/path/to/file'' |
* Use **exactly** the same profile name as an existing PuTTY profile! | * Use **exactly the same profile name** as an existing PuTTY profile! |
* More details in FIXME | * More details in FIXME |
| |
* The ''2.8.7-1'' Win32 binaries are dated //May 2004//, but **work perfectly fine**! | * The ''2.8.7-1'' Win32 binaries are dated //May 2004//, but **work perfectly fine**! |
| |
* Extra Windows specific information (optional, read only if you need it): [[https://www.gnu.org/software/emacs/manual/html_mono/efaq-w32.html|GNU Emacs FAQ for MS Windows]] | === emacs for Windows technical notes === |
| |
=== emacs for Linux, inside WSL === | <note tip>These notes are only here for finding them easily, but **you probably don't need them**.\\ Just follow exactly the windows related instructions on this page!</note> |
| |
This is the //overkill// option... Useful only if you really need WSL! But you should also install the [[#emacs_for_windows|emacs Windows version]]! | * [[https://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Microsoft-Windows|Emacs and Microsoft Windows/MS-DOS]] (//Appendix H// of the //The Emacs Editor manual//) |
| |
* Install [[other:win10wsl|Windows Subsystem for Linux]] | * [[https://www.gnu.org/software/emacs/manual/html_mono/efaq-w32.html|GNU Emacs FAQ for MS Windows]] |
* Install emacs for Linux (check [[#linux_installation|Linux installation]] above) | |
| * Extra Windows specific information (optional, read only if you need it): [[https://www.gnu.org/software/emacs/manual/html_mono/efaq-w32.html|GNU Emacs FAQ for MS Windows]] |
| |
===== Launching emacs ===== | ===== Launching emacs ===== |
==== Windows launch ==== | ==== Windows launch ==== |
| |
* ''Start'' => ''E'' => ''Emacs'' | * ''Start'' => ''E'' => ''Emacs-XX.Y'' => ''Emacs'' |
| |
==== Mac launch ==== | ==== Mac launch ==== |
==== Example configuration file ==== | ==== Example configuration file ==== |
| |
* Recommended {{ :other:emacs_jyp_2023-08-11.txt |emacs configuration file}} | * Recommended {{ :other:emacs_jyp_2023-09-12.txt |emacs configuration file}} |
* Download this ''emacs_jyp_yyyy-mm-dd.txt'' file to the [[other:emacs_doc#location_of_the_configuration_file|appropriate configuration directory (for your system)]] | * Download this ''emacs_jyp_yyyy-mm-dd.txt'' file to the [[other:emacs_doc#location_of_the_configuration_file|appropriate configuration directory (for your system)]] |
* Rename the file to ''.emacs'' | * Rename the file to ''.emacs'' |
* Edit the file (with ''emacs'' or another editor) and search //Microsoft// to (un)comment MS Windows specific sections of the configuration file | * Edit the file (with ''emacs'' or another editor) and search //Microsoft// to (un)comment MS Windows specific sections of the configuration file |
* (re)start ''emacs'' to take this configuration file into account | * (re)start ''emacs'' to take this configuration file into account |
| * If ''emacs'' displays the following error message, just create the ''server'' directory (''c:/Users/your_login/AppData/Roaming/.emacs.d/server'') by hand and restart ''emacs''\\ <code>Warning (initialization): An error occurred while loading ‘c:/Users/your_login/AppData/Roaming/.emacs’: |
| |
* Keyboard shortcuts defined by the example configuration file | File is missing: Opening output file, No such file or directory, c:/Users/your_login/AppData/Roaming/.emacs.d/server/server</code> |
| |
| * **Keyboard shortcuts** defined by the example configuration file |
* ''C-x C-g'': go to a specific line | * ''C-x C-g'': go to a specific line |
* ''Shift Left_Arrow'' and ''Shift Right_Arrow'': go to the beginning/end of a line\\ Same behavior as ''C-a'' and ''C-e'', and the ''Home'' and ''End'' keyboard keys | * ''Shift Left_Arrow'' and ''Shift Right_Arrow'': go to the beginning/end of a line\\ Same behavior as ''C-a'' and ''C-e'', and the ''Home'' and ''End'' keyboard keys |
* [[https://www.gnu.org/software/emacs/manual/html_node/emacs/|The Emacs Editor]] (the official manual) | * [[https://www.gnu.org/software/emacs/manual/html_node/emacs/|The Emacs Editor]] (the official manual) |
* Other official related [[https://www.gnu.org/software/emacs/manual/|GNU Emacs Manuals]] | * Other official related [[https://www.gnu.org/software/emacs/manual/|GNU Emacs Manuals]] |
| |
| * [[https://github.com/rougier#emacs-hacking|Emacs hacking]] by Nicolas Rougier |
| |
===== Updating emacs ===== | ===== Updating emacs ===== |