nixpkgs/system/options.nix

{pkgs, config, ...}:

let
  inherit (pkgs.lib) mkOption mergeOneOption;
in

{

  time = {

    timeZone = mkOption {
      default = "CET";
      example = "America/New_York";
      description = "The time zone used when displaying times and dates.";
    };

  };

  
  boot = {

    isLiveCD = mkOption {
      default = false;
      description = "
        If set to true, the root device will be mounted read-only and
        a ramdisk will be mounted on top of it using unionfs to
        provide a writable root.  This is used for the NixOS
        Live-CD/DVD.
      ";
    };

    resumeDevice = mkOption {
      default = "";
      example = "0:0";
      description = "
        Device for manual resume attempt during boot. Looks like 
        major:minor. ls -l /dev/SWAP_PARTION shows them.
      ";
    };

    hardwareScan = mkOption {
      default = true;
      description = "
        Whether to try to load kernel modules for all detected hardware.
        Usually this does a good job of providing you with the modules
        you need, but sometimes it can crash the system or cause other
        nasty effects.  If the hardware scan is turned on, it can be
        disabled at boot time by adding the <literal>safemode</literal>
        parameter to the kernel command line.
      ";
    };

    initrd = {

      allowMissing = mkOption {
        default = false;
        description = ''
          Allow some initrd components to be missing. Useful for
          custom kernel that are changed too often to track needed
          kernelModules.
        '';
      };

      lvm = mkOption {
        default = true;
        description = "
          Whether to include lvm in the initial ramdisk. You should use this option
          if your ROOT device is on lvm volume.
        ";
      };

      enableSplashScreen = mkOption {
        default = true;
        description = "
          Whether to show a nice splash screen while booting.
        ";
      };

    };
    
    copyKernels = mkOption {
      default = false;
      description = "
        Whether the Grub menu builder should copy kernels and initial
        ramdisks to /boot.  This is necessary when /nix is on a
        different file system than /boot.
      ";
    };

    localCommands = mkOption {
      default = "";
      example = "text=anything; echo You can put $text here.";
      description = "
        Shell commands to be executed just before Upstart is started.
      ";
    };

    extraTTYs = mkOption {
      default = [];
      example = [8 9];
      description = "
        Tty (virtual console) devices, in addition to the consoles on
        which mingetty and syslogd run, that must be initialised.
        Only useful if you have some program that you want to run on
        some fixed console.  For example, the NixOS installation CD
        opens the manual in a web browser on console 7, so it sets
        <option>boot.extraTTYs</option> to <literal>[7]</literal>.
      ";
    };

  };

  system = {
    # NSS modules.  Hacky!
    nssModules = mkOption {
      internal = true;
      default = [];
      description = "
        Search path for NSS (Name Service Switch) modules.  This allows
        several DNS resolution methods to be specified via
        <filename>/etc/nsswitch.conf</filename>.
      ";
      merge = pkgs.lib.mergeListOption;
      apply = list:
        let
          list2 =
             list
          ++ pkgs.lib.optional config.users.ldap.enable pkgs.nss_ldap;
        in {
          list = list2;
          path = pkgs.lib.makeLibraryPath list2;
        };
    };

    modulesTree = mkOption {
      internal = true;
      default = [];
      description = "
        Tree of kernel modules.  This includes the kernel, plus modules
        built outside of the kernel.  Combine these into a single tree of
        symlinks because modprobe only supports one directory.
      ";
      merge = pkgs.lib.mergeListOption;

      # Convert the list of path to only one path.
      apply = pkgs.aggregateModules;
    };

    sbin = {
      modprobe = mkOption {
        # should be moved in module-init-tools
        internal = true;
        default = pkgs.substituteAll {
          dir = "sbin";
          src = ./modprobe;
          isExecutable = true;
          inherit (pkgs) module_init_tools;
          inherit (config.system) modulesTree;
        };
        description = ''
          Wrapper around modprobe that sets the path to the modules
          tree.
        '';
      };

      # !!! The mount option should not stay in /system/option.nix
      mount = mkOption {
        internal = true;
        default = pkgs.utillinuxng.override {
          buildMountOnly = true;
          mountHelpers = pkgs.buildEnv {
            name = "mount-helpers";
            paths = [
              pkgs.ntfs3g
              pkgs.mount_cifs
              pkgs.nfsUtils
            ];
            pathsToLink = "/sbin";
          } + "/sbin";
        };
        description = "
          A patched `mount' command that looks in a directory in the Nix
          store instead of in /sbin for mount helpers (like mount.ntfs-3g or
          mount.cifs).
        ";
      };
    };
  };


  networking = {

    hostName = mkOption {
      default = "nixos";
      description = "
        The name of the machine.  Leave it empty if you want to obtain
        it from a DHCP server (if using DHCP).
      ";
    };

    nativeIPv6 = mkOption {
      default = false;
      description = "
        Whether to use IPv6 even though gw6c is not used. For example, 
        for Postfix.
      ";
    };

    extraHosts = mkOption {
      default = "";
      example = "192.168.0.1 lanlocalhost";
      description = ''
        Additional entries to be appended to <filename>/etc/hosts</filename>.
      '';
    };

    defaultGateway = mkOption {
      default = "";
      example = "131.211.84.1";
      description = "
        The default gateway.  It can be left empty if it is auto-detected through DHCP.
      ";
    };

    nameservers = mkOption {
      default = [];
      example = ["130.161.158.4" "130.161.33.17"];
      description = "
        The list of nameservers.  It can be left empty if it is auto-detected through DHCP.
      ";
    };

    domain = mkOption {
      default = "";
      example = "home";
      description = "
        The domain.  It can be left empty if it is auto-detected through DHCP.
      ";
    };

    localCommands = mkOption {
      default = "";
      example = "text=anything; echo You can put $text here.";
      description = "
        Shell commands to be executed at the end of the
        <literal>network-interfaces</literal> Upstart job.  Note that if
        you are using DHCP to obtain the network configuration,
        interfaces may not be fully configured yet.
      ";
    };

    defaultMailServer = {

      directDelivery = mkOption {
        default = false;
        example = true;
        description = "
          Use the trivial Mail Transfer Agent (MTA)
          <command>ssmtp</command> package to allow programs to send
          e-mail.  If you don't want to run a ``real'' MTA like
          <command>sendmail</command> or <command>postfix</command> on
          your machine, set this option to <literal>true</literal>, and
          set the option
          <option>networking.defaultMailServer.hostName</option> to the
          host name of your preferred mail server.
        ";
      };

      hostName = mkOption {
        example = "mail.example.org";
        description = "
          The host name of the default mail server to use to deliver
          e-mail.
        ";
      };

      domain = mkOption {
        default = "";
        example = "example.org";
        description = "
          The domain from which mail will appear to be sent.
        ";
      };

      useTLS = mkOption {
        default = false;
        example = true;
        description = "
          Whether TLS should be used to connect to the default mail
          server.
        ";
      };

      useSTARTTLS = mkOption {
        default = false;
        example = true;
        description = "
          Whether the STARTTLS should be used to connect to the default
          mail server.  (This is needed for TLS-capable mail servers
          running on the default SMTP port 25.)
        ";
      };

    };

  };


  fileSystems = mkOption {
    default = null;
    example = [
      { mountPoint = "/";
        device = "/dev/hda1";
      }
      { mountPoint = "/data";
        device = "/dev/hda2";
        fsType = "ext3";
        options = "data=journal";
      }
      { mountPoint = "/bigdisk";
        label = "bigdisk";
      }
    ];
    description = "
      The file systems to be mounted.  It must include an entry for
      the root directory (<literal>mountPoint = \"/\"</literal>).  Each
      entry in the list is an attribute set with the following fields:
      <literal>mountPoint</literal>, <literal>device</literal>,
      <literal>fsType</literal> (a file system type recognised by
      <command>mount</command>; defaults to
      <literal>\"auto\"</literal>), and <literal>options</literal>
      (the mount options passed to <command>mount</command> using the
      <option>-o</option> flag; defaults to <literal>\"defaults\"</literal>).

      Instead of specifying <literal>device</literal>, you can also
      specify a volume label (<literal>label</literal>) for file
      systems that support it, such as ext2/ext3 (see <command>mke2fs
      -L</command>).

      <literal>autocreate</literal> forces <literal>mountPoint</literal> to be created with 
      <command>mkdir -p</command> .
    ";
  };


  swapDevices = mkOption {
    default = [];
    example = [
      { device = "/dev/hda7"; }
      { device = "/var/swapfile"; }
      { label = "bigswap"; }
    ];
    description = "
      The swap devices and swap files.  These must have been
      initialised using <command>mkswap</command>.  Each element
      should be an attribute set specifying either the path of the
      swap device or file (<literal>device</literal>) or the label
      of the swap device (<literal>label</literal>, see
      <command>mkswap -L</command>).  Using a label is
      recommended.
    ";
  };

  nesting = {
    children = mkOption {
      default = [];
      description = "
        Additional configurations to build.
      ";
    };
  };

  
  passthru = mkOption {
    default = {};
    description = "
      Additional parameters. Ignored. When you want to be sure that 
      /etc/nixos/nixos -A config.passthru.* is that same thing the 
      system rebuild will use.
    ";
  };

  require = [
    #../modules/hardware/network/intel-3945abg.nix
    ../etc/default.nix
    ../modules/config/fonts.nix
    ../modules/config/i18n.nix
    ../modules/config/system-path.nix
    ../modules/config/unix-odbc-drivers.nix
    ../modules/config/users-groups.nix
    ../modules/installer/grub/grub.nix
    ../modules/security/setuid-wrappers.nix
    ../modules/security/sudo.nix
    ../modules/services/audio/alsa.nix
    ../modules/services/audio/pulseaudio.nix
    ../modules/services/databases/mysql.nix
    ../modules/services/databases/postgresql.nix
    ../modules/services/hardware/acpid.nix
    ../modules/services/hardware/hal.nix
    ../modules/services/hardware/udev.nix
    ../modules/services/logging/klogd.nix
    ../modules/services/logging/syslogd.nix
    ../modules/services/mail/dovecot.nix
    ../modules/services/mail/postfix.nix
    ../modules/services/misc/autofs.nix
    ../modules/services/misc/disnix.nix
    ../modules/services/misc/nix-daemon.nix
    ../modules/services/misc/nixos-manual.nix
    ../modules/services/misc/rogue.nix
    ../modules/services/misc/synergy.nix
    ../modules/services/monitoring/nagios/default.nix
    ../modules/services/monitoring/zabbix-agent.nix
    ../modules/services/monitoring/zabbix-server.nix
    ../modules/services/network-filesystems/nfs-kernel.nix
    ../modules/services/network-filesystems/samba.nix # TODO: doesn't start here (?)
    ../modules/services/networking/avahi-daemon.nix
    ../modules/services/networking/bind.nix
    ../modules/services/networking/bitlbee.nix
    ../modules/services/networking/dhclient.nix
    ../modules/services/networking/dhcpd.nix
    ../modules/services/networking/ejabberd.nix # untested, dosen't compile on x86_64-linux
    ../modules/services/networking/gnunet.nix
    ../modules/services/networking/gw6c.nix
    ../modules/services/networking/ifplugd.nix
    ../modules/services/networking/ircd-hybrid.nix # TODO: doesn't compile on x86_64-linux, can't test
    ../modules/services/networking/ntpd.nix
    ../modules/services/networking/openfire.nix
    ../modules/services/networking/openvpn.nix
    ../modules/services/networking/portmap.nix
    ../modules/services/networking/ssh/lshd.nix # GNU lshd SSH2 deamon (TODO: does neither start nor generate seed file ?)
    ../modules/services/networking/ssh/sshd.nix
    ../modules/services/networking/vsftpd.nix
    ../modules/services/printing/cupsd.nix
    ../modules/services/scheduling/atd.nix
    ../modules/services/scheduling/cron.nix
    ../modules/services/scheduling/fcron.nix
    ../modules/services/system/consolekit.nix
    ../modules/services/system/dbus.nix
    ../modules/services/system/nscd.nix
    ../modules/services/ttys/gpm.nix
    ../modules/services/ttys/mingetty.nix
    ../modules/services/web-servers/apache-httpd
    ../modules/services/web-servers/jboss.nix
    ../modules/services/web-servers/tomcat.nix # untested, too lazy to get that jdk
    ../modules/services/x11/xfs.nix
    ../modules/services/x11/xserver/default.nix
    ../modules/system/activation/activation-script.nix
    ../modules/system/boot/kernel.nix
    ../modules/system/boot/stage-1.nix
    ../modules/system/boot/stage-2.nix
    ../modules/system/upstart-events/ctrl-alt-delete.nix
    ../modules/system/upstart-events/halt.nix
    ../modules/system/upstart-events/maintenance-shell.nix
    ../system/assertion.nix
    ../system/nixos-environment.nix
    ../system/nixos-installer.nix
    ../system/system-options.nix
    ../upstart-jobs/cron/locate.nix
    ../upstart-jobs/default.nix
    ../upstart-jobs/filesystems.nix
    ../upstart-jobs/guest-users.nix
    ../upstart-jobs/kbd.nix
    ../upstart-jobs/ldap
    ../upstart-jobs/lvm.nix
    ../upstart-jobs/network-interfaces.nix
    ../upstart-jobs/pcmcia.nix
    ../upstart-jobs/swap.nix
    ../upstart-jobs/swraid.nix
    ../upstart-jobs/tty-backgrounds.nix
  ];
}