Emacs - Revision history

DHCP: fix formatting and consistency

2026-06-01T13:21:02Z

fix formatting and consistency

DHCP: fix formatting

2026-05-20T22:52:44Z

fix formatting

← Older revision		Revision as of 22:52, 20 May 2026
Line 20:		Line 20:

	To temporarily use Emacs in a shell environment without modifying your system configuration, you can run:		To temporarily use Emacs in a shell environment without modifying your system configuration, you can run:
	~~{{Commands\|~~		<syntaxhighlight lang=console>
	<~~nowiki~~>
	$ nix-shell -p emacs		$ nix-shell -p emacs
	</~~nowiki~~>		</syntaxhighlight>
	}}
	This makes the Emacs editor available in your current shell. You can then launch Emacs by typing <code>emacs</code>.		This makes the Emacs editor available in your current shell. You can then launch Emacs by typing <code>emacs</code>.

Line 149:		Line 148:
	You may then reference it twice:		You may then reference it twice:

	{{file\|/etc/nixos/configuration.nix\|nix\|~~<nowiki>~~		{{file\|/etc/nixos/configuration.nix\|nix\|3=
	## if you want it per-user instead of system-wide use 'users.users.<name>.packages = with pkgs; [' instead		## if you want it per-user instead of system-wide use 'users.users.<name>.packages = with pkgs; [' instead
	environment.systemPackages = with pkgs; [		environment.systemPackages = with pkgs; [
Line 160:		Line 159:
	package = pkgs.myEmacs;		package = pkgs.myEmacs;
	};		};
	~~</nowiki>~~}}		}}

	Using this approach, there is no need to keep two lists of emacsPackages in sync.		Using this approach, there is no need to keep two lists of emacsPackages in sync.
Line 309:		Line 308:

	They are located at <code>pkgs/applications/editors/emacs/elisp-packages/manual-packages/</code> [https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/editors/emacs/elisp-packages/manual-packages] and a new pkg must be added under <code>pkgs/applications/editors/elisp-packages/manual-packages.nix</code> [https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/emacs/elisp-packages/manual-packages.nix]. Once the nixpkg is ready, it can be tested using the following command. This inserts the nixpkg into the load-path of Emacs.		They are located at <code>pkgs/applications/editors/emacs/elisp-packages/manual-packages/</code> [https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/editors/emacs/elisp-packages/manual-packages] and a new pkg must be added under <code>pkgs/applications/editors/elisp-packages/manual-packages.nix</code> [https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/emacs/elisp-packages/manual-packages.nix]. Once the nixpkg is ready, it can be tested using the following command. This inserts the nixpkg into the load-path of Emacs.
	~~{{Commands\|~~		<syntaxhighlight lang=console>
	<~~nowiki~~>
	$ nix-shell -I nixpkgs=<path_to_nixpkgs_copy> -p "(emacsPackagesFor pkgs.emacs28).emacsWithPackages (epkgs: [ epkgs.<package> ])"		$ nix-shell -I nixpkgs=<path_to_nixpkgs_copy> -p "(emacsPackagesFor pkgs.emacs28).emacsWithPackages (epkgs: [ epkgs.<package> ])"
	</~~nowiki~~>		</syntaxhighlight>
	}}		}}

Jthulhu: Added a workaround for a bug that hasn't been fixed upstream yet, when using xwidgets and pgtk.

2026-04-23T13:46:14Z

Added a workaround for a bug that hasn't been fixed upstream yet, when using xwidgets and pgtk.

@@ Line 387: / Line 387: @@
+}
 </syntaxhighlight>
 == Troubleshooting ==

Pigs: /* Configuration */ provide a clearer list of possible ways to configure emacs

2026-01-09T23:24:42Z

Configuration: provide a clearer list of possible ways to configure emacs

← Older revision		Revision as of 23:24, 9 January 2026
Line 51:		Line 51:

	== Configuration ==		== Configuration ==
	~~{{Note\|Currently, configuring Emacs is possible by using Home Manager. A workaround for a global configuration is highlighted in the advanced section.}}~~

	==== ~~Basic~~ ====		==== NixOS System Configuration ====
	<~~syntaxhighlight lang="nix"~~>
	~~programs~~.emacs = {		System wide configuration of Emacs is limited to only the [https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html Emacs daemon]. To enable Emacs daemon user services system-wide and set as default editor:

			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			services.emacs = {
	enable = true;		enable = true;
	defaultEditor = true;		defaultEditor = true;
	};		};
	</~~syntaxhighlight~~>		</nowiki>
			}}

			Use <code>emacsclient</code> to connect to the daemon. For a full list of module configuration options, see {{nixos:option\|services.emacs}}.

			==== Home Manager ====

	~~==== Advanced ====~~		[[Home Manager]] provides a larger set of user-specific configuration options for Emacs.
	<~~syntaxhighlight lang="~~nix">
	~~# Global Configuration~~		A minimal configuration that installs Emacs alongside <code>nix-mode</code> and <code>nixfmt</code> packages:
	~~# Emacs is running as a daemon here, accesible via the "emacsclient" command~~
	~~services.emacs = {~~
	~~enable = true;~~
	~~package = pkgs.emacs;~~
	};

	~~# Home Configuration~~		{{file\|home.nix\|nix\|<nowiki>
	programs.emacs = {		programs.emacs = {
	enable = true;		enable = true;
	package = pkgs.emacs; # replace with pkgs.emacs-gtk if desired		package = pkgs.emacs; # replace with pkgs.emacs-gtk if desired
			extraPackages = epkgs: [
			epkgs.nix-mode
			epkgs.nixfmt
			];
	extraConfig = ''		extraConfig = ''
	(setq standard-indent 2)		(setq standard-indent 2)
	'';		'';
	};		};
	</~~syntaxhighlight~~>		</nowiki>
			}}

			{{note\| An alternative option to setting the config inside a Nix string, you can load the config file by <code>extraConfig <nowiki>=</nowiki> builtins.readFile ./emacs_config.el</code>.}}

			To search for Emacs plugins within the package set, see {{nixos:package\|emacsPackages.*}}. A full list of Home Manager configuration module options can be found [https://home-manager-options.extranix.com/?query=programs.emacs here].

			Home Manager also provides a configuration module for enabling the Emacs daemon:

			{{file\|home.nix\|nix\|<nowiki>
			# Emacs is running as a daemon here, accesible via the "emacsclient" command
			services.emacs = {
			enable = true;
			defaultEditor = true;
			};
			</nowiki>
			}}

			See [https://home-manager-options.extranix.com/?query=services.emacs the module options] for <code>services.emacs</code> configurations options.

	== Tips and Tricks ==		== Tips and Tricks ==

Pigs: /* System setup */ make it clear the distinction between installing system wide vs home manager

2026-01-09T22:31:25Z

System setup: make it clear the distinction between installing system wide vs home manager

← Older revision		Revision as of 22:31, 9 January 2026
Line 30:		Line 30:

	To install Emacs system-wide, making it available to all users, add the following to your configuration:		To install Emacs system-wide, making it available to all users, add the following to your configuration:
	~~<syntaxhighlight lang="nix">~~
	~~# Example for~~ /etc/nixos/configuration.nix		{{file\|/etc/nixos/configuration.nix\|nix\|
			<nowiki>
	environment.systemPackages = [		environment.systemPackages = [
	pkgs.emacs		pkgs.emacs
	];		];
			</nowiki>
			}}

	~~# User-~~specific ~~installation (in ~/.config/nixpkgs/~~home.nix)		Alternatively, Emacs can be installed specific to a user via [[Home Manager]]:

			{{file\|home.nix\|nix\|<nowiki>
	home.packages = [		home.packages = [
	pkgs.emacs		pkgs.emacs
	];		];
	</~~syntaxhighlight~~>		</nowiki>
			}}

	After rebuilding your system with <code>nixos-rebuild switch</code> or <code>home-manager switch</code>, Emacs will be installed and accessible.		After rebuilding your system with <code>nixos-rebuild switch</code> or <code>home-manager switch</code>, Emacs will be installed and accessible.

Pigs: /* Advanced */ defaultEditor is only an option for services.emacs, not programs.emacs

2026-01-09T19:51:22Z

Advanced: defaultEditor is only an option for services.emacs, not programs.emacs

← Older revision		Revision as of 19:51, 9 January 2026
Line 67:		Line 67:
	enable = true;		enable = true;
	package = pkgs.emacs; # replace with pkgs.emacs-gtk if desired		package = pkgs.emacs; # replace with pkgs.emacs-gtk if desired
	~~defaultEditor = true;~~
	extraConfig = ''		extraConfig = ''
	(setq standard-indent 2)		(setq standard-indent 2)

Arnecc at 21:01, 12 December 2025

2025-12-12T21:01:47Z

← Older revision		Revision as of 21:01, 12 December 2025
Line 104:		Line 104:

	</syntaxhighlight>Note that if the expression <code>(emacsPackagesFor emacs-pgtk)</code> is present, <code>emacs-pgtk</code> need not be listed separately in the list <code>environment.systemPackages</code>. Indeed, if one does that, <code>nixos-rebuild</code> will warn about link collisions when the configuration is rebuilt.		</syntaxhighlight>Note that if the expression <code>(emacsPackagesFor emacs-pgtk)</code> is present, <code>emacs-pgtk</code> need not be listed separately in the list <code>environment.systemPackages</code>. Indeed, if one does that, <code>nixos-rebuild</code> will warn about link collisions when the configuration is rebuilt.

			====== Alternative way of installation to ensuring consistent package management for emacs and emacsclient ======
			If you plan to use the same packages for both emacs and emacsclient, you can define a custom emacs like this:
			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			nixpkgs.config.packageOverrides = pkgs: rec {
			myEmacs = pkgs.emacs.pkgs.withPackages (epkgs: with epkgs; [
			org
			nixmode
			... # list all your desired emacsPackages here
			]);
			};
			</nowiki>}}

			You may then reference it twice:

			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			## if you want it per-user instead of system-wide use 'users.users.<name>.packages = with pkgs; [' instead
			environment.systemPackages = with pkgs; [
			myEmacs
			];

			## enabling emacsclient and making all the packages available
			services.emacs = {
			enable = true;
			package = pkgs.myEmacs;
			};
			</nowiki>}}

			Using this approach, there is no need to keep two lists of emacsPackages in sync.

	==== Tree-sitter ====		==== Tree-sitter ====

Jjramsey: Warn about double-listing emacs-pgtk.

2025-07-10T23:54:25Z

Warn about double-listing emacs-pgtk.

← Older revision		Revision as of 23:54, 10 July 2025
Line 103:		Line 103:


	</syntaxhighlight>		</syntaxhighlight>Note that if the expression <code>(emacsPackagesFor emacs-pgtk)</code> is present, <code>emacs-pgtk</code> need not be listed separately in the list <code>environment.systemPackages</code>. Indeed, if one does that, <code>nixos-rebuild</code> will warn about link collisions when the configuration is rebuilt.

	==== Tree-sitter ====		==== Tree-sitter ====

Jjramsey: emacsPgtkNativeComp no longer works; emacs-pgtk does.

2025-07-10T23:47:55Z

emacsPgtkNativeComp no longer works; emacs-pgtk does.

← Older revision		Revision as of 23:47, 10 July 2025
Line 78:		Line 78:
	==== Installing Packages ====		==== Installing Packages ====
	{{Note\|Emacs, much like NixOS can rebuild and re-fetch all of its packages based on its initialization file alone, if one chooses to use an extension called "use-package". Such a configuration file can be version controlled and used in all compatible operating systems.}}		{{Note\|Emacs, much like NixOS can rebuild and re-fetch all of its packages based on its initialization file alone, if one chooses to use an extension called "use-package". Such a configuration file can be version controlled and used in all compatible operating systems.}}
	One can mix and match whether Emacs packages are installed by Nix or Emacs. This can be particularly useful for Emacs packages that need to be built, such as vterm. One way to install Emacs packages through Nix is by the following, replacing {{ic\|~~emacsPgtkNativeComp~~}} with the variant in use:<syntaxhighlight lang="nix">		One can mix and match whether Emacs packages are installed by Nix or Emacs. This can be particularly useful for Emacs packages that need to be built, such as vterm. One way to install Emacs packages through Nix is by the following, replacing {{ic\|emacs-pgtk}} with the variant in use:<syntaxhighlight lang="nix">
	environment.systemPackages = with pkgs;		environment.systemPackages = with pkgs;
	[ ...		[ ...
	((emacsPackagesFor ~~emacsPgtkNativeComp~~).emacsWithPackages (		((emacsPackagesFor emacs-pgtk).emacsWithPackages (
	epkgs: [ epkgs.vterm ]		epkgs: [ epkgs.vterm ]
	))		))
Line 89:		Line 89:
	# To make the packages available to emacsclient, one can do the following:		# To make the packages available to emacsclient, one can do the following:
	services.emacs.package = with pkgs; (		services.emacs.package = with pkgs; (
	(emacsPackagesFor ~~emacsPgtkNativeComp~~).emacsWithPackages (		(emacsPackagesFor emacs-pgtk).emacsWithPackages (
	epkgs: [ epkgs.vterm ]		epkgs: [ epkgs.vterm ]
	)		)
Line 205:		Line 205:
	environment.systemPackages = with pkgs;		environment.systemPackages = with pkgs;
	[ ...		[ ...
	((emacsPackagesFor ~~emacsPgtkNativeComp~~).emacsWithPackages (epkgs: [		((emacsPackagesFor emacs-pgtk).emacsWithPackages (epkgs: [
	epkgs.vterm		epkgs.vterm
	(callPackage ./lambda-line.nix {		(callPackage ./lambda-line.nix {

DoggoBit at 15:07, 9 June 2025

2025-06-09T15:07:53Z

← Older revision		Revision as of 15:07, 9 June 2025
Line 1:		Line 1:
	{{application infobox		{{application infobox
	\|~~title~~=GNU Emacs		\|name=GNU Emacs
	\|image=EmacsIcon.svg		\|image=EmacsIcon.svg
	\|type=Text Editor		\|type=Text Editor