mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* Manual updates.

Browse source
This commit is contained in:
Eelco Dolstra 2005-04-10 20:54:21 +00:00
parent c9c58dba55
commit 82d771f6e6
10 changed files with 741 additions and 714 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
NEWS
View file

@ -159,6 +159,8 @@ Nix 0.8 has the following improvements:
* `fetchurl' allows SHA-1 and SHA-256 in addition to MD5. Just * `fetchurl' allows SHA-1 and SHA-256 in addition to MD5. Just
specify the attribute `sha1' or `sha256' instead of `md5'. specify the attribute `sha1' or `sha256' instead of `md5'.
* Manual updates.
Version 0.7 (January 12, 2005) Version 0.7 (January 12, 2005)

23
doc/manual/glossary.xml
View file

@ -134,6 +134,29 @@
</glossentry> </glossentry>
<glossentry id="gloss-user-env"><glossterm>user environment</glossterm>
<glossdef><para>An automatically generated store object that
consists of a set of symlinks to “active” applications, i.e., other
store paths. These are generated automatically by <link
linkend="sec-nix-env"><command>nix-env</command></link>. See <xref
linkend="sec-profiles" />.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-profile"><glossterm>profile</glossterm>
<glossdef><para>A symlink to the current <link
linkend="gloss-user-env">user environment</link> of a user, e.g.,
<filename>/nix/var/nix/profiles/default</filename>.</para></glossdef>
</glossentry>
</glosslist> </glosslist>

2
doc/manual/manual.xml
View file

@ -36,7 +36,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common.xml" /> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="env-common.xml" /> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="env-common.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="conf-file.xml" /> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="conf-file.xml" />
<sect1> <sect1 id="sec-nix-env">
<title>nix-env</title> <title>nix-env</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-env.xml" /> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nix-env.xml" />
</sect1> </sect1>

2
doc/manual/nix-build.xml
View file

@ -8,6 +8,8 @@
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>nix-build</command> <command>nix-build</command>
<arg><option>--add-drv-link</option></arg>
<arg><option>--no-link</option></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg> <arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>

1366
doc/manual/nix-env.xml
View file

File diff suppressed because it is too large Load diff

9
doc/manual/nix-store.xml
View file

@ -330,7 +330,8 @@ query is applied to the target of the symlink.</para>
<variablelist> <variablelist>
<varlistentry><term><option>--use-output</option> / <option>-u</option></term> <varlistentry><term><option>--use-output</option></term>
<term><option>-u</option></term>
<listitem><para>For each argument to the query that is a store <listitem><para>For each argument to the query that is a store
derivation, apply the query to the output path of the derivation derivation, apply the query to the output path of the derivation
@ -338,7 +339,8 @@ query is applied to the target of the symlink.</para>
</varlistentry> </varlistentry>
<varlistentry><term><option>--force-realise</option> / <option>-f</option></term> <varlistentry><term><option>--force-realise</option></term>
<term><option>-f</option></term>
<listitem><para>Realise each argument to the query first (see <listitem><para>Realise each argument to the query first (see
<link linkend="rsec-nix-store-realise"><command>nix-store <link linkend="rsec-nix-store-realise"><command>nix-store
@ -365,7 +367,8 @@ query is applied to the target of the symlink.</para>
</varlistentry> </varlistentry>
<varlistentry><term><option>--requisites</option> / <option>-R</option></term> <varlistentry><term><option>--requisites</option></term>
<term><option>-R</option></term>
<listitem><para>Prints out the <link <listitem><para>Prints out the <link
linkend="gloss-closure">closure</link> of the store path linkend="gloss-closure">closure</link> of the store path

15
doc/manual/opt-common.xml
View file

@ -19,7 +19,8 @@
</varlistentry> </varlistentry>
<varlistentry><term><option>--verbose</option> / <option>-v</option></term> <varlistentry><term><option>--verbose</option></term>
<term><option>-v</option></term>
<listitem> <listitem>
@ -72,7 +73,8 @@
</varlistentry> </varlistentry>
<varlistentry><term><option>--no-build-output</option> / <option>-Q</option></term> <varlistentry><term><option>--no-build-output</option></term>
<term><option>-Q</option></term>
<listitem><para>By default, output written by builders to standard <listitem><para>By default, output written by builders to standard
output and standard error is echoed to the Nix command's standard output and standard error is echoed to the Nix command's standard
@ -84,7 +86,8 @@
</varlistentry> </varlistentry>
<varlistentry id="opt-max-jobs"><term><option>--max-jobs</option> / <option>-j</option></term> <varlistentry id="opt-max-jobs"><term><option>--max-jobs</option></term>
<term><option>-j</option></term>
<listitem><para>Sets the maximum number of build jobs that Nix will <listitem><para>Sets the maximum number of build jobs that Nix will
perform in parallel to the specified number. The default is 1. A perform in parallel to the specified number. The default is 1. A
@ -93,7 +96,8 @@
</varlistentry> </varlistentry>
<varlistentry><term><option>--keep-going</option> / <option>-k</option></term> <varlistentry><term><option>--keep-going</option></term>
<term><option>-k</option></term>
<listitem><para>Keep going in case of failed builds, to the <listitem><para>Keep going in case of failed builds, to the
greatest extent possible. That is, if building an input of some greatest extent possible. That is, if building an input of some
@ -105,7 +109,8 @@
</varlistentry> </varlistentry>
<varlistentry><term><option>--keep-failed</option> / <option>-K</option></term> <varlistentry><term><option>--keep-failed</option></term>
<term><option>-K</option></term>
<listitem><para>Specifies that in case of a build failure, the <listitem><para>Specifies that in case of a build failure, the
temporary directory (usually in <filename>/tmp</filename>) in which temporary directory (usually in <filename>/tmp</filename>) in which

32
doc/manual/package-management.xml
View file

@ -2,23 +2,23 @@
<para>This chapter discusses how to do package management with Nix, <para>This chapter discusses how to do package management with Nix,
i.e., how to obtain, install, upgrade, and erase components. This is i.e., how to obtain, install, upgrade, and erase components. This is
the <quote>user’s</quote> perspective of the Nix system — people the “user’s” perspective of the Nix system — people
who want to <emphasis>create</emphasis> components should consult who want to <emphasis>create</emphasis> components should consult
<xref linkend='chap-writing-nix-expressions' />.</para> <xref linkend='chap-writing-nix-expressions' />.</para>
<sect1><title>Basic package management</title> <sect1><title>Basic package management</title>
<para>The main command for package management is <para>The main command for package management is <link
<command>nix-env</command>. You can use it to install, upgrade, and linkend="sec-nix-env"><command>nix-env</command></link>. You can use
erase components, and to query what components are installed or are it to install, upgrade, and erase components, and to query what
available for installation.</para> components are installed or are available for installation.</para>
<para>In Nix, different users can have different <quote>views</quote> <para>In Nix, different users can have different “views”
on the set of installed applications. That is, there might be lots of on the set of installed applications. That is, there might be lots of
applications present on the system (possibly in many different applications present on the system (possibly in many different
versions), but users can have a specific selection of those active — versions), but users can have a specific selection of those active —
where <quote>active</quote> just means that it appears in a directory where “active” just means that it appears in a directory
in the user’s <envar>PATH</envar>. Such a view on the set of in the user’s <envar>PATH</envar>. Such a view on the set of
installed applications is called a <emphasis>user installed applications is called a <emphasis>user
environment</emphasis>, which is just a directory tree consisting of environment</emphasis>, which is just a directory tree consisting of
@ -31,11 +31,9 @@ Nix expressions called the Nix Package collection that contains
components ranging from basic development stuff such as GCC and Glibc, components ranging from basic development stuff such as GCC and Glibc,
to end-user applications like Mozilla Firefox. (Nix is however not to end-user applications like Mozilla Firefox. (Nix is however not
tied to the Nix Package collection; you could write your own Nix tied to the Nix Package collection; you could write your own Nix
expression based on it, or completely new ones.) You can download the expressions based on it, or completely new ones.) You can download
latest version from <ulink the latest version from <ulink
url='http://catamaran.labs.cs.uu.nl/dist/nix' />. You probably want url='http://catamaran.labs.cs.uu.nl/dist/nix' />.</para>
the latest unstable release; currently the stable releases tend to lag
behind quite a bit.</para>
<para>Assuming that you have downloaded and unpacked a release of Nix <para>Assuming that you have downloaded and unpacked a release of Nix
Packages, you can view the set of available components in the release: Packages, you can view the set of available components in the release:
@ -127,7 +125,7 @@ release of Nix Packages, you can do:
$ nix-env -f nixpkgs-<replaceable>version</replaceable> -u subversion</screen> $ nix-env -f nixpkgs-<replaceable>version</replaceable> -u subversion</screen>
This will <emphasis>only</emphasis> upgrade Subversion if there is a This will <emphasis>only</emphasis> upgrade Subversion if there is a
<quote>newer</quote> version in the new set of Nix expressions, as “newer” version in the new set of Nix expressions, as
defined by some pretty arbitrary rules regarding ordering of version defined by some pretty arbitrary rules regarding ordering of version
numbers (which generally do what you’d expect of them). To just numbers (which generally do what you’d expect of them). To just
unconditionally replace Subversion with whatever version is in the Nix unconditionally replace Subversion with whatever version is in the Nix
@ -175,7 +173,7 @@ set.</para></footnote></para>
</sect1> </sect1>
<sect1><title>Profiles</title> <sect1 id="sec-profiles"><title>Profiles</title>
<para>Profiles and user environments are Nix’s mechanism for <para>Profiles and user environments are Nix’s mechanism for
implementing the ability to allow differens users to have different implementing the ability to allow differens users to have different
@ -336,7 +334,7 @@ This will <emphasis>not</emphasis> change the
(<option>-u</option>) and uninstall (<option>-e</option>) never (<option>-u</option>) and uninstall (<option>-e</option>) never
actually delete components from the system. All they do (as shown actually delete components from the system. All they do (as shown
above) is to create a new user environment that no longer contains above) is to create a new user environment that no longer contains
symlinks to the <quote>deleted</quote> components.</para> symlinks to the “deleted” components.</para>
<para>Of course, since disk space is not infinite, unused components <para>Of course, since disk space is not infinite, unused components
should be removed at some point. You can do this by running the Nix should be removed at some point. You can do this by running the Nix
@ -423,7 +421,7 @@ linkend="sec-nix-channel"><command>nix-channel</command></link> you
can automatically stay up to date with whatever is available at that can automatically stay up to date with whatever is available at that
URL.</para> URL.</para>
<para>You can <quote>subscribe</quote> to a channel using <para>You can “subscribe” to a channel using
<command>nix-channel --add</command>, e.g., <command>nix-channel --add</command>, e.g.,
<screen> <screen>
@ -436,7 +434,7 @@ of the Nix Packages collection. (Instead of
stability, but right now is just outdated.) Subscribing really just stability, but right now is just outdated.) Subscribing really just
means that the URL is added to the file means that the URL is added to the file
<filename>~/.nix-channels</filename>. Right now there is no command <filename>~/.nix-channels</filename>. Right now there is no command
to <quote>unsubscribe</quote>; you should just edit that file manually to “unsubscribe”; you should just edit that file manually
and delete the offending URL.</para> and delete the offending URL.</para>
<para>To obtain the latest Nix expressions available in a channel, do <para>To obtain the latest Nix expressions available in a channel, do

2
doc/manual/style.css
View file

@ -102,6 +102,8 @@ pre.screen
.note,.warning .note,.warning
{ {
margin-top: 1em;
margin-bottom: 1em;
border: 1px solid #6185a0; border: 1px solid #6185a0;
padding: 0px 1em; padding: 0px 1em;
background: #fffff5; background: #fffff5;

2
doc/manual/writing-nix-expressions.xml
View file

@ -818,7 +818,7 @@ set.</para>
</simplesect> </simplesect>
<simplesect><title>Functions</title> <simplesect id="ss-functions"><title>Functions</title>
<para>Functions have the following form: <para>Functions have the following form: