Commit graph

143 commits

Author SHA1 Message Date
Eelco Dolstra 5932de5c1a svn path=/nixos/trunk/; revision=28430 2011-08-09 14:08:24 +00:00
Ludovic Courtès 610839eb29 doc: Attempt to placate Docbook.
svn path=/nixos/trunk/; revision=27476
2011-06-15 14:46:06 +00:00
Ludovic Courtès 7fe48226c0 doc: Add more details on `lib/testing.nix'.
svn path=/nixos/trunk/; revision=27474
2011-06-15 14:12:45 +00:00
Nicolas Pierron 729d19536c Manual (user configuration): Fix minor typo.
svn path=/nixos/trunk/; revision=27071
2011-05-01 10:24:41 +00:00
Nicolas Pierron 1c69051ba8 Manual: Clarify NixOS modules.
svn path=/nixos/trunk/; revision=27070
2011-05-01 10:24:37 +00:00
Nicolas Pierron 4aa86107fd Remove references to other kind of VCS from the manual.
svn path=/nixos/trunk/; revision=27069
2011-05-01 10:24:28 +00:00
Shea Levy 2ddda472c4 Put vim on the live cd in place of nvi
svn path=/nixos/trunk/; revision=26679
2011-04-04 13:45:16 +00:00
Shea Levy 817cc79cb5 The live cd contains vi, not vim
svn path=/nixos/trunk/; revision=26654
2011-04-01 12:22:57 +00:00
Ludovic Courtès b7a8b26d09 doc: Fix the manual.
svn path=/nixos/trunk/; revision=26220
2011-03-09 10:38:18 +00:00
Ludovic Courtès 7cb3958e4b doc: Use a <footnote>, not a <note>.
svn path=/nixos/trunk/; revision=26214
2011-03-08 21:54:18 +00:00
Ludovic Courtès 36cf4ba40b doc: Escape `&'.
svn path=/nixos/trunk/; revision=26213
2011-03-08 21:31:00 +00:00
Ludovic Courtès d028ec95d0 doc: Escape `>'.
svn path=/nixos/trunk/; revision=26212
2011-03-08 21:14:21 +00:00
Ludovic Courtès 79a322f050 doc: Add a section on VM testing, mostly copied from the wiki.
svn path=/nixos/trunk/; revision=26211
2011-03-08 20:55:43 +00:00
Michael Raskin 75d4861077 Fix Nixpkgs link; typo noticed by Shea Levy
svn path=/nixos/trunk/; revision=26181
2011-03-07 07:55:53 +00:00
Sander van der Burg 96b769c979 Removed the backdoor, because it does not work anymore and it has also become obsolete (Disnix uses something else now)
svn path=/nixos/trunk/; revision=25601
2011-01-17 16:15:59 +00:00
Ludovic Courtès 41fcad19fb manual: Recommend `-O dir_index'.
svn path=/nixos/trunk/; revision=25580
2011-01-15 21:51:56 +00:00
Sander van der Burg 11d2cd78e0 - deployment.targetHost is now used for connecting to remote hosts instead of deployment.hostname. This makes more sense.
- fixed error in the manual (nixos-deploy-network => nixos-build-vms)


svn path=/nixos/trunk/; revision=25031
2010-12-07 20:13:50 +00:00
Sander van der Burg 9df8293d63 Wrote manual pages for the nixos-deploy-network and nixos-build-vms commands
svn path=/nixos/trunk/; revision=25030
2010-12-07 16:33:18 +00:00
Nicolas Pierron b6f2fde0e0 man nixos-option: Fix typos.
svn path=/nixos/trunk/; revision=23940
2010-09-26 13:46:44 +00:00
Nicolas Pierron 0a9b2f6e44 Add a man page for nixos-option.
svn path=/nixos/trunk/; revision=23938
2010-09-26 08:43:59 +00:00
Nicolas Pierron 26417566c4 Re-word installation, and use "nixos-option --install" to generate a
template for configuration.nix which uses the result of
nixos-hardware-scan.

svn path=/nixos/trunk/; revision=23926
2010-09-25 22:30:02 +00:00
Nicolas Pierron 93029d3c4f Update installation instructions.
svn path=/nixos/trunk/; revision=23925
2010-09-25 22:29:58 +00:00
Nicolas Pierron 757a0002a2 Simplify the installation instruction for building a CD.
svn path=/nixos/trunk/; revision=23924
2010-09-25 22:29:54 +00:00
Eelco Dolstra c1295661c4 * Added a command `nixos-rebuild build-vm-with-bootloader'. This is
like `build-vm', but boots using the regular boot loader (i.e. GRUB
  1 or 2) rather than booting directly from the kernel/initrd.  Thus
  it allows testing of GRUB.

svn path=/nixos/trunk/; revision=23747
2010-09-13 12:34:58 +00:00
Eelco Dolstra 2ec105cc85 * Separate building of the NixOS manual and manpages. Usually we only
need the manpages, and the manual takes much longer to build.

svn path=/nixos/trunk/; revision=23112
2010-08-11 12:28:53 +00:00
Yury G. Kudryashov e3afda0a88 Don't use deprecated config options
svn path=/nixos/trunk/; revision=20979
2010-04-08 09:19:10 +00:00
Lluís Batlle i Rossell 093b51a562 Removing references to linux kernel 'vmlinuz', and making them point to 'bzImage'.
That should match with a related change in nixpkgs.


svn path=/nixos/trunk/; revision=20095
2010-02-18 11:35:39 +00:00
Eelco Dolstra deb4f88c2c * Let the GRUB menu builder detect whether /boot is on a different
partition from /.  If so, copy the kernels and initrds to /boot and
  use paths relative to /boot in the GRUB configuration file.  This
  makes the boot.loader.grub.bootDevice option obsolete.  (Is there a
  way to mark obsolete options?)  It also makes it unnecessary to set
  boot.loader.grub.copyKernels, although that option is still
  available since it can speed up GRUB if the Nix store is very
  large.

svn path=/nixos/trunk/; revision=18998
2009-12-16 18:57:02 +00:00
Eelco Dolstra a612fd0d5e * Obsoleted boot.initrd.extraKernelModules (use
boot.initrd.kernelModules instead).

svn path=/nixos/trunk/; revision=18969
2009-12-15 14:05:01 +00:00
Eelco Dolstra e0d69c92a8 * Added a manpage for nixos-rebuild.
svn path=/nixos/trunk/; revision=18855
2009-12-09 15:05:13 +00:00
Eelco Dolstra ad17a6dce3 * Changes related to the xorg-7.5 merge.
svn path=/nixos/trunk/; revision=18126
2009-11-04 22:44:40 +00:00
Nicolas Pierron f656741395 Manual: Update nixos-checkout comments.
svn path=/nixos/trunk/; revision=17955
2009-10-26 09:50:33 +00:00
Nicolas Pierron 56d6afaa8a When nixos is used inside a /nix/store, the store path is replace by
/etc/nixos/nixos which is the default location of nixos.

svn path=/nixos/trunk/; revision=17681
2009-10-06 19:07:09 +00:00
Nicolas Pierron 11025f3462 Fix typo from the previous commit.
svn path=/nixos/trunk/; revision=17674
2009-10-06 09:58:11 +00:00
Nicolas Pierron 2fe37ffe21 Remove /nix/store/<hash> prefixes from the manual.
svn path=/nixos/trunk/; revision=17673
2009-10-06 09:53:19 +00:00
Eelco Dolstra 824e94cf0a * Fix hyperlink generation, but now in XSLT instead of sed.
svn path=/nixos/trunk/; revision=17660
2009-10-05 23:47:50 +00:00
Eelco Dolstra 6b3b22537e * Generate valid DocBook. <emphasis> isn't allowed in a <filename>.
* For manpage generation, work around a bug in the DocBook XSL
  stylesheet by using a <simplelist> instead of a <itemizedlist>
  (which is arguably better anyway).  The indentation of an
  <itemizedlist> lasts beyond the end of that element under certain
  circumstances, it seems.

* Disable the man.endnotes.are.numbered option to prevent endnotes to
  be generated for each xlink:href in the Declarations/Definitions
  lists (which we don't want anyway, I guess).  This causes libxslt to
  get stuck in an infinite (?) loop.

svn path=/nixos/trunk/; revision=17659
2009-10-05 23:15:06 +00:00
Eelco Dolstra 4452096f3e * Validate the manual against the DocBook 5 RelaxNG schema.
svn path=/nixos/trunk/; revision=17643
2009-10-05 13:17:45 +00:00
Nicolas Pierron 32c3793e62 Add "defined by" and "declared by" for each option. These are list of files
which link to either the remote source or the local file location.

svn path=/nixos/trunk/; revision=17255
2009-09-18 15:10:37 +00:00
Nicolas Pierron cb85c4ed3e Add display of declaration and definition locations.
svn path=/nixos/trunk/; revision=17254
2009-09-18 15:10:32 +00:00
Nicolas Pierron 10e9705a86 Replace optionDeclarations by options which is directly computed by
moduleMerge.

svn path=/nixos/trunk/; revision=17166
2009-09-15 14:09:18 +00:00
Eelco Dolstra b56fecc83a * env -> envar.
svn path=/nixos/trunk/; revision=17106
2009-09-14 06:56:00 +00:00
Nicolas Pierron a07e90d6f3 Update the documentation:
* Change the module syntax of the example to follow Eelco's suggestions.

* Add a section "Building your own NixOS CD", which explain how to replace
configuration.nix by the configuration file of a live CD/DVD.

* Fix "Testing the installer" and "Testing the initrd" to fit the location
of derivations.

svn path=/nixos/trunk/; revision=17105
2009-09-13 22:13:19 +00:00
Eelco Dolstra f1035de47c * For the generation of manual / manpages, don't evaluate the option
declarations again (because we already have them).  This cuts
  evaluation time from 7.2s to 4.9s.

svn path=/nixos/trunk/; revision=16798
2009-08-21 09:08:55 +00:00
Eelco Dolstra f076849acd * Escape strings.
svn path=/nixos/branches/modular-nixos/; revision=16374
2009-07-15 13:40:30 +00:00
Eelco Dolstra da996583ee * Include the NixOS manpages in the system environment. Actually
there is only one currently: configuration.nix(5), which contains a
  list of all the options.

svn path=/nixos/branches/modular-nixos/; revision=16360
2009-07-14 16:27:46 +00:00
Eelco Dolstra 896a9f0508 * Generate a manual page for configuration.nix containing all the
options.

svn path=/nixos/branches/modular-nixos/; revision=16358
2009-07-14 15:47:03 +00:00
Eelco Dolstra a27f3942ef * Callouts require the docbook_xsl images.
svn path=/nixos/branches/modular-nixos/; revision=16354
2009-07-14 13:31:32 +00:00
Eelco Dolstra d06556e274 * Get rid of the `experimental' flag.
svn path=/nixos/branches/modular-nixos/; revision=16010
2009-06-19 14:27:43 +00:00
Eelco Dolstra 86509aa159 * Output the manual as XHTML. This also sets the charset correctly.
svn path=/nixos/branches/modular-nixos/; revision=15881
2009-06-05 17:16:42 +00:00
Eelco Dolstra f4b5a21d59 * Fix building the manual.
svn path=/nixos/branches/modular-nixos/; revision=15877
2009-06-05 15:04:58 +00:00
Nicolas Pierron 3f1dd56e9e * Synced with trunk @ 14801
svn path=/nixos/branches/modular-nixos/; revision=14953
2009-04-08 14:01:16 +00:00
Nicolas Pierron 9ba1f01479 * Synced with trunk @ 14413
svn path=/nixos/branches/modular-nixos/; revision=14951
2009-04-08 13:50:32 +00:00
Eelco Dolstra b470feb916 * nixpkgsPath -> nixpkgs.
svn path=/nixos/trunk/; revision=14702
2009-03-25 15:47:29 +00:00
Eelco Dolstra 8d3ee677d5 svn path=/nixos/trunk/; revision=14411 2009-03-06 13:53:19 +00:00
Nicolas Pierron 22f49c3cd2 * Add a small script to ensure that all configurations in doc/config-examples can be evaluated.
* Fix doc/config-examples/svn-server.nix to use the experimental apache configuration.

svn path=/nixos/branches/fix-style/; revision=14200
2009-02-22 23:34:03 +00:00
Nicolas Pierron b1eabe2b1b An upstart job to display manual
svn path=/nixos/branches/fix-style/; revision=14158
2009-02-22 16:06:42 +00:00
Nicolas Pierron fc6d48ef63 Allowing direct package use in manual expression
svn path=/nixos/branches/fix-style/; revision=14157
2009-02-22 16:06:32 +00:00
Nicolas Pierron 1c1c1e0b15 Add a section to help user to extend NixOS.
svn path=/nixos/branches/fix-style/; revision=13861
2009-01-25 15:49:27 +00:00
Michael Raskin 0a1f41c742 An upstart job to display manual
svn path=/nixos/trunk/; revision=13728
2009-01-08 23:30:23 +00:00
Michael Raskin aa393f816c Allowing direct package use in manual expression
svn path=/nixos/trunk/; revision=13724
2009-01-08 21:50:27 +00:00
Nicolas Pierron 7aa27dfee2 Merge branches 'fix-style' and 'master' into fix-style
svn path=/nixos/branches/fix-style/; revision=13688
2009-01-02 19:41:39 +00:00
Eelco Dolstra 2897911915 * Hydra release expression for building NixOS.
svn path=/nixos/trunk/; revision=13651
2008-12-17 13:25:23 +00:00
Nicolas Pierron 892d12bccf - Move some system configuration to options:
* system.nssModules
  * system.modulesTree
  * system.sbin.modprobe
  * system.sbin.mount
  * nix.envVars

- Remove Arguments that can be accessed either by "config" or "pkgs".

- Use the new scheme for upstart-jobs/default.nix.
This is now a configuration file which is imported by system/options.nix.

- Jobs can now include upstart-job/default.nix:
  * upstrat-jobs/cron.nix
  * upstart-jobs/dhclient.nix

=> No Nixos file refers to upstart-jobs/default.nix except if one of its options is require to define an extra job. (e.g.: cron, dhclient)

svn path=/nixos/branches/fix-style/; revision=13327
2008-11-18 18:00:09 +00:00
Eelco Dolstra 8c2fd764e2 * Move the configuration examples to doc/.
svn path=/nixos/trunk/; revision=12723
2008-08-26 13:01:16 +00:00
Eelco Dolstra 3116621c46 * Document testing the initrd.
svn path=/nixos/trunk/; revision=12721
2008-08-26 12:48:27 +00:00
Eelco Dolstra a662f1c473 * Fix building the manual.
svn path=/nixos/trunk/; revision=12556
2008-08-08 19:25:31 +00:00
Eelco Dolstra ebb43a3f67 * Make the location of Nixpkgs a function argument (defaulting
to ../../nixpkgs).  This makes the "pkgs" symlink under the 
  nixos checkout unnecessary.

svn path=/nixos/trunk/; revision=11989
2008-06-05 15:33:17 +00:00
Eelco Dolstra cc7f3c7aaa * URL updates.
svn path=/nixos/trunk/; revision=11801
2008-05-09 15:08:43 +00:00
Eelco Dolstra 0efc29afa4 * Manual updates.
svn path=/nixos/trunk/; revision=10560
2008-02-08 22:43:59 +00:00
Eelco Dolstra e9a7f80681 * Build the Nix manual in a Nix expression instead of a Makefile so
that it becomes easier to include it on the CD.

svn path=/nixos/trunk/; revision=10070
2008-01-04 14:24:42 +00:00
Eelco Dolstra 1089c1f7fa * Fix the manual.
svn path=/nixos/trunk/; revision=9769
2007-11-21 14:39:52 +00:00
Wouter den Breejen 94854926fb Made the docs to install compiz fusion a little bit more clear. All credits go to Michael raskin.
svn path=/nixos/trunk/; revision=9698
2007-11-15 18:31:31 +00:00
Michael Raskin edf5ce8d75 Fixed docbook build for NixOS
svn path=/nixos/trunk/; revision=9628
2007-11-11 10:46:26 +00:00
Michael Raskin 2f49250b8d Now nearly builds docbook section on options; skips names however.
svn path=/nixos/trunk/; revision=9627
2007-11-11 09:30:01 +00:00
Michael Raskin 8a887b6a94 Added Pidgin-LaTeX configuration section after pidgin-latex update; fixed the build process
svn path=/nixos/trunk/; revision=9625
2007-11-11 09:10:56 +00:00
Michael Raskin 5459a5c007 Added user configuration chapter - currently about Compiz.
svn path=/nixos/trunk/; revision=9589
2007-11-05 21:17:16 +00:00
Eelco Dolstra 17cc5ecc47 * Add OpenSSH and pciutils to the boot environment.
svn path=/nixos/trunk/; revision=7918
2007-02-19 22:33:44 +00:00
Eelco Dolstra 56f813a0fe * Readme is obsolete now.
svn path=/nixos/trunk/; revision=7870
2007-02-06 21:38:59 +00:00
Eelco Dolstra 5aed111620 * More manual.
svn path=/nixos/trunk/; revision=7869
2007-02-06 21:25:36 +00:00
Eelco Dolstra 9759134665 * Manual.
svn path=/nixos/trunk/; revision=7868
2007-02-06 21:14:02 +00:00
Eelco Dolstra 4b7e9b5401 * Instructions on testing the installer without having to make an ISO
/ burn a CD, namely by making a loopback target file system.
* Installer: continue if the MANIFEST on the CD is missing (useful if
  we're not actually installing from a CD).

svn path=/nixos/trunk/; revision=7843
2007-02-05 15:12:47 +00:00
Eelco Dolstra 668c146e33 * Doh! Make sure that we put *only* splash_helper in the initrd and
not all of splashutils, otherwise we get Glibc in the initrd.

svn path=/nixos/trunk/; revision=7771
2007-01-23 13:44:41 +00:00
Eelco Dolstra a7d81141be * Prettyprint the option defaults and examples.
svn path=/nixos/trunk/; revision=7768
2007-01-23 11:39:02 +00:00
Eelco Dolstra e3c5b9e752 svn path=/nixos/trunk/; revision=7767 2007-01-23 11:18:23 +00:00
Eelco Dolstra d674ec1223 * Add a top-level book.
* Copy the stylesheet from the Nix manual.  We should really put this
  somewhere central.

svn path=/nixos/trunk/; revision=7766
2007-01-23 11:11:58 +00:00
Eelco Dolstra 8e0f2fd7c6 * Properly render DocBook in option descriptions.
svn path=/nixos/trunk/; revision=7765
2007-01-23 11:06:31 +00:00
Eelco Dolstra 3034daabb7 * Generate DocBook documentation on the available options from the Nix
expression.

svn path=/nixos/trunk/; revision=7764
2007-01-23 10:52:51 +00:00
Eelco Dolstra 0817c307dc * Moving stuff around.
svn path=/nixos/trunk/; revision=7155
2006-11-27 19:49:05 +00:00
Armijn Hemel 4a8b316cf6 * show installation instructions at install time
* update manual to reflect new method better

svn path=/nixu/trunk/; revision=6285
2006-08-27 22:31:35 +00:00
Armijn Hemel f7c69397b7 update howto to reflect new changes
svn path=/nixu/trunk/; revision=6274
2006-08-27 15:34:24 +00:00
Armijn Hemel af9eb8537e move the existing documentation to the docs directory
svn path=/nixu/trunk/; revision=5007
2006-03-08 19:15:14 +00:00
Armijn Hemel a05f476c39 add a doc directory, with some documentation in it
svn path=/nixu/trunk/; revision=5006
2006-03-08 19:14:12 +00:00