From c07ba7c8560250d1b184698e6453b6d5ca11846f Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Tue, 2 Oct 2018 15:59:59 -0400 Subject: nixpkgs docs: Reformat --- doc/package-notes.xml | 74 ++++++++++++++++++++++++++++++++------------------- 1 file changed, 46 insertions(+), 28 deletions(-) (limited to 'doc/package-notes.xml') diff --git a/doc/package-notes.xml b/doc/package-notes.xml index d8f55ef0a856..5a13d18aa595 100644 --- a/doc/package-notes.xml +++ b/doc/package-notes.xml @@ -671,8 +671,9 @@ overrides = self: super: rec { plugins = with availablePlugins; [ python perl ]; } } - If the configure function returns an attrset without the plugins - attribute, availablePlugins will be used automatically. + If the configure function returns an attrset without the + plugins attribute, availablePlugins + will be used automatically. @@ -706,9 +707,11 @@ overrides = self: super: rec { }; } + - WeeChat allows to set defaults on startup using the --run-command. - The configure method can be used to pass commands to the program: + WeeChat allows to set defaults on startup using the + --run-command. The configure method + can be used to pass commands to the program: weechat.override { configure = { availablePlugins, ... }: { init = '' @@ -717,12 +720,14 @@ overrides = self: super: rec { ''; }; } - Further values can be added to the list of commands when running - weechat --run-command "your-commands". + Further values can be added to the list of commands when running + weechat --run-command "your-commands". + - Additionally it's possible to specify scripts to be loaded when starting weechat. - These will be loaded before the commands from init: + Additionally it's possible to specify scripts to be loaded when starting + weechat. These will be loaded before the commands from + init: weechat.override { configure = { availablePlugins, ... }: { scripts = with pkgs.weechatScripts; [ @@ -734,11 +739,13 @@ overrides = self: super: rec { }; } + - In nixpkgs there's a subpackage which contains derivations for - WeeChat scripts. Such derivations expect a passthru.scripts attribute - which contains a list of all scripts inside the store path. Furthermore all scripts - have to live in $out/share. An exemplary derivation looks like this: + In nixpkgs there's a subpackage which contains + derivations for WeeChat scripts. Such derivations expect a + passthru.scripts attribute which contains a list of all + scripts inside the store path. Furthermore all scripts have to live in + $out/share. An exemplary derivation looks like this: { stdenv, fetchurl }: stdenv.mkDerivation { @@ -817,20 +824,26 @@ citrix_receiver.override {
ibus-engines.typing-booster - This package is an ibus-based completion method to speed up typing. + + This package is an ibus-based completion method to speed up typing. +
Activating the engine - IBus needs to be configured accordingly to activate typing-booster. The configuration - depends on the desktop manager in use. For detailed instructions, please refer to the - upstream docs. + IBus needs to be configured accordingly to activate + typing-booster. The configuration depends on the desktop + manager in use. For detailed instructions, please refer to the + upstream + docs. + - On NixOS you need to explicitly enable ibus with given engines - before customizing your desktop to use typing-booster. This can be achieved - using the ibus module: + On NixOS you need to explicitly enable ibus with given + engines before customizing your desktop to use + typing-booster. This can be achieved using the + ibus module: { pkgs, ... }: { i18n.inputMethod = { enabled = "ibus"; @@ -844,17 +857,20 @@ citrix_receiver.override { Using custom hunspell dictionaries - The IBus engine is based on hunspell to support completion in many languages. - By default the dictionaries de-de, en-us, es-es, - it-it, sv-se and sv-fi - are in use. To add another dictionary, the package can be overridden like this: + The IBus engine is based on hunspell to support + completion in many languages. By default the dictionaries + de-de, en-us, + es-es, it-it, + sv-se and sv-fi are in use. To add + another dictionary, the package can be overridden like this: ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; } + - Note: each language passed to langs must be an attribute name in - pkgs.hunspellDicts. + Note: each language passed to langs must be an + attribute name in pkgs.hunspellDicts.
@@ -862,10 +878,12 @@ citrix_receiver.override { Built-in emoji picker - The ibus-engines.typing-booster package contains a program - named emoji-picker. To display all emojis correctly, - a special font such as noto-fonts-emoji is needed: + The ibus-engines.typing-booster package contains a + program named emoji-picker. To display all emojis + correctly, a special font such as noto-fonts-emoji is + needed: + On NixOS it can be installed using the following expression: { pkgs, ... }: { -- cgit v1.2.3