summary refs log tree commit diff
path: root/nixos/modules/services/misc/synergy.nix
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2013-10-31 13:18:00 +0100
committerEelco Dolstra <eelco.dolstra@logicblox.com>2013-10-31 13:18:00 +0100
commit456d8ec52b640ff67c88d04c89ea59836953b38f (patch)
tree45e81dbd960c843b64445d2b6504414833ccfbf6 /nixos/modules/services/misc/synergy.nix
parent86443f4efde456ae3d3f82b26aa36d073f36f8e2 (diff)
downloadnixpkgs-456d8ec52b640ff67c88d04c89ea59836953b38f.tar
nixpkgs-456d8ec52b640ff67c88d04c89ea59836953b38f.tar.gz
nixpkgs-456d8ec52b640ff67c88d04c89ea59836953b38f.tar.bz2
nixpkgs-456d8ec52b640ff67c88d04c89ea59836953b38f.tar.lz
nixpkgs-456d8ec52b640ff67c88d04c89ea59836953b38f.tar.xz
nixpkgs-456d8ec52b640ff67c88d04c89ea59836953b38f.tar.zst
nixpkgs-456d8ec52b640ff67c88d04c89ea59836953b38f.zip
Clean up Synergy option descriptions a bit
Diffstat (limited to 'nixos/modules/services/misc/synergy.nix')
-rw-r--r--nixos/modules/services/misc/synergy.nix34
1 files changed, 16 insertions, 18 deletions
diff --git a/nixos/modules/services/misc/synergy.nix b/nixos/modules/services/misc/synergy.nix
index 91c0acb0bc2..63e7c7667e5 100644
--- a/nixos/modules/services/misc/synergy.nix
+++ b/nixos/modules/services/misc/synergy.nix
@@ -22,58 +22,56 @@ in
         enable = mkOption {
           default = false;
           description = "
-            Whether to enable the synergy client (receive keyboard and mouse events from a synergy server)
+            Whether to enable the Synergy client (receive keyboard and mouse events from a Synergy server).
           ";
         };
         screenName = mkOption {
           default = "";
-          description = "
-            use screen-name instead the hostname to identify
+          description = ''
+            Use the given name instead of the hostname to identify
             ourselves to the server.
-            ";
+          '';
         };
         serverAddress = mkOption {
-          description = "
+          description = ''
             The server address is of the form: [hostname][:port].  The
             hostname must be the address or hostname of the server.  The
             port overrides the default port, 24800.
-          ";
+          '';
         };
         autoStart = mkOption {
           default = true;
           type = types.bool;
-          description = "Whether synergy-client should be started automatically.";
+          description = "Whether the Synergy client should be started automatically.";
         };
       };
 
       server = {
         enable = mkOption {
           default = false;
-          description = "
-            Whether to enable the synergy server (send keyboard and mouse events)
-          ";
+          description = ''
+            Whether to enable the Synergy server (send keyboard and mouse events).
+          '';
         };
         configFile = mkOption {
           default = "/etc/synergy-server.conf";
-          description = "
-            The synergy server configuration file. open upstart-jobs/synergy.nix to see an example
-          ";
+          description = "The Synergy server configuration file.";
         };
         screenName = mkOption {
           default = "";
-          description = "
-            use screen-name instead the hostname to identify
+          description = ''
+            Use the given name instead of the hostname to identify
             this screen in the configuration.
-            ";
+          '';
         };
         address = mkOption {
           default = "";
-          description = "listen for clients on the given address";
+          description = "Address on which to listen for clients.";
         };
         autoStart = mkOption {
           default = true;
           type = types.bool;
-          description = "Whether synergy-server should be started automatically.";
+          description = "Whether the Synergy server should be started automatically.";
         };
       };
     };