mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-26 23:54:01 +00:00
2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
104 lines
3.1 KiB
Nix
104 lines
3.1 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.services.emacs;
|
|
|
|
editorScript = pkgs.writeScriptBin "emacseditor" ''
|
|
#!${pkgs.runtimeShell}
|
|
if [ -z "$1" ]; then
|
|
exec ${cfg.package}/bin/emacsclient --create-frame --alternate-editor ${cfg.package}/bin/emacs
|
|
else
|
|
exec ${cfg.package}/bin/emacsclient --alternate-editor ${cfg.package}/bin/emacs "$@"
|
|
fi
|
|
'';
|
|
|
|
desktopApplicationFile = pkgs.writeTextFile {
|
|
name = "emacsclient.desktop";
|
|
destination = "/share/applications/emacsclient.desktop";
|
|
text = ''
|
|
[Desktop Entry]
|
|
Name=Emacsclient
|
|
GenericName=Text Editor
|
|
Comment=Edit text
|
|
MimeType=text/english;text/plain;text/x-makefile;text/x-c++hdr;text/x-c++src;text/x-chdr;text/x-csrc;text/x-java;text/x-moc;text/x-pascal;text/x-tcl;text/x-tex;application/x-shellscript;text/x-c;text/x-c++;
|
|
Exec=emacseditor %F
|
|
Icon=emacs
|
|
Type=Application
|
|
Terminal=false
|
|
Categories=Development;TextEditor;
|
|
StartupWMClass=Emacs
|
|
Keywords=Text;Editor;
|
|
'';
|
|
};
|
|
|
|
in
|
|
{
|
|
|
|
options.services.emacs = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Whether to enable a user service for the Emacs daemon. Use <literal>emacsclient</literal> to connect to the
|
|
daemon. If <literal>true</literal>, <varname>services.emacs.install</varname> is
|
|
considered <literal>true</literal>, whatever its value.
|
|
'';
|
|
};
|
|
|
|
install = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Whether to install a user service for the Emacs daemon. Once
|
|
the service is started, use emacsclient to connect to the
|
|
daemon.
|
|
|
|
The service must be manually started for each user with
|
|
"systemctl --user start emacs" or globally through
|
|
<varname>services.emacs.enable</varname>.
|
|
'';
|
|
};
|
|
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.emacs;
|
|
defaultText = literalExpression "pkgs.emacs";
|
|
description = lib.mdDoc ''
|
|
emacs derivation to use.
|
|
'';
|
|
};
|
|
|
|
defaultEditor = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
When enabled, configures emacsclient to be the default editor
|
|
using the EDITOR environment variable.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = mkIf (cfg.enable || cfg.install) {
|
|
systemd.user.services.emacs = {
|
|
description = "Emacs: the extensible, self-documenting text editor";
|
|
|
|
serviceConfig = {
|
|
Type = "forking";
|
|
ExecStart = "${pkgs.bash}/bin/bash -c 'source ${config.system.build.setEnvironment}; exec ${cfg.package}/bin/emacs --daemon'";
|
|
ExecStop = "${cfg.package}/bin/emacsclient --eval (kill-emacs)";
|
|
Restart = "always";
|
|
};
|
|
} // optionalAttrs cfg.enable { wantedBy = [ "default.target" ]; };
|
|
|
|
environment.systemPackages = [ cfg.package editorScript desktopApplicationFile ];
|
|
|
|
environment.variables.EDITOR = mkIf cfg.defaultEditor (mkOverride 900 "${editorScript}/bin/emacseditor");
|
|
};
|
|
|
|
meta.doc = ./emacs.xml;
|
|
}
|