nix-super/doc/manual
Eelco Dolstra 6d6c68c0d2 * Added a new kind of multi-line string literal delimited by two
single quotes.  Example (from NixOS):

    job = ''
      start on network-interfaces

      start script

        rm -f /var/run/opengl-driver
        ${if videoDriver == "nvidia"        
          then "ln -sf ${nvidiaDrivers} /var/run/opengl-driver"
          else if cfg.driSupport
          then "ln -sf ${mesa} /var/run/opengl-driver"
          else ""
        }

        rm -f /var/log/slim.log

      end script
    '';

  This style has two big advantages:

  - \, ' and " aren't special, only '' and ${.  So you get a lot less
    escaping in shell scripts / configuration files in Nixpkgs/NixOS.
    The delimiter '' is rare in scripts (and can usually be written as
    "").  ${ is also fairly rare.

    Other delimiters such as <<...>>, {{...}} and <|...|> were also
    considered but this one appears to have the fewest drawbacks
    (thanks Martin).

  - Indentation is intelligently stripped so that multi-line strings
    can follow the nesting structure of the containing Nix
    expression.  E.g. in the example above 6 spaces are stripped from
    the start of each line.  This prevents unnecessary indentation in
    generated files (which sometimes even breaks things).

  See tests/lang/eval-okay-ind-string.nix for some examples.
2007-11-30 16:48:45 +00:00
..
figures * Update the user environments figure to show multiple profiles and 2005-03-16 14:40:48 +00:00
bugs.xml * Troubleshooting information on fixing a b0rked Berkeley DB database. 2006-11-30 11:24:10 +00:00
build-farm.xml * Convert to DocBook 5. 2006-08-21 16:05:11 +00:00
builtins.xml * New primop `readFile' to get the contents of a file as a string. 2007-11-21 13:49:59 +00:00
conf-file.xml 2007-10-29 22:16:36 +00:00
env-common.xml * Documented multi-user Nix. 2007-10-31 18:01:56 +00:00
glossary.xml * Convert to DocBook 5. 2006-08-21 16:05:11 +00:00
installation.xml * Documented multi-user Nix. 2007-10-31 18:01:56 +00:00
introduction.xml * Improved introduction (actually copied mostly from the homepage). 2007-10-23 16:34:04 +00:00
Makefile.am * A rule to make a PDF version of the manual. 2007-11-01 14:42:44 +00:00
manual.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-build.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-channel.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-collect-garbage.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-copy-closure.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-env.xml * Documented multi-user Nix. 2007-10-31 18:01:56 +00:00
nix-hash.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-install-package.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-instantiate.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-lang-ref.xml * chapter -> appendix. 2004-11-02 08:25:29 +00:00
nix-pack-closure.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-prefetch-url.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-pull.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-push.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-store.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
nix-unpack-closure.xml * Manpage for nix-copy-closure. 2007-09-19 14:01:41 +00:00
opt-common-syn.xml 2007-10-29 22:16:36 +00:00
opt-common.xml 2007-10-29 22:16:36 +00:00
opt-inst-syn.xml * Documented multi-user Nix. 2007-10-31 18:01:56 +00:00
package-management.xml * Typo reported by Arie Middelkoop. 2006-10-26 23:06:47 +00:00
quick-start.xml * Manual. 2006-09-29 11:03:16 +00:00
quote-literals.xsl * Translate Unicode quote characters to ASCII equivalents when 2006-10-06 09:03:39 +00:00
release-notes.xml * Added a new kind of multi-line string literal delimited by two 2007-11-30 16:48:45 +00:00
schemas.xml * Document setuid Nix installs. 2004-10-31 17:08:48 +00:00
style.css 2007-10-24 13:54:06 +00:00
troubleshooting.xml * Troubleshooting entry about running out of locks. 2007-11-29 14:15:33 +00:00
writing-nix-expressions.xml * Documented some of the more obscure derivation attributes (including 2007-11-01 13:28:33 +00:00