From 30b31a8f6190dad40ca972b445420e10f47a9afc Mon Sep 17 00:00:00 2001 From: Eelco Dolstra Date: Thu, 8 Jan 2004 16:56:40 +0000 Subject: [PATCH] * Start of nix-env reference. * Some CSS tweaks. --- doc/manual/Makefile.am | 4 +- doc/manual/manual.xml | 5 ++ doc/manual/nix-env.xml | 166 +++++++++++++++++++++++++++++++++++++++ doc/manual/nix-store.xml | 24 +++--- doc/manual/style.css | 32 ++++++-- 5 files changed, 215 insertions(+), 16 deletions(-) create mode 100644 doc/manual/nix-env.xml diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am index a0fa19406a..f0344ef649 100644 --- a/doc/manual/Makefile.am +++ b/doc/manual/Makefile.am @@ -7,7 +7,7 @@ XSLTPROC = $(ENV) $(xsltproc) $(xmlflags) --catalogs \ --param html.stylesheet \'style.css\' SOURCES = manual.xml introduction.xml installation.xml overview.xml \ - nix-store.xml nix-instantiate.xml \ + nix-env.xml nix-store.xml nix-instantiate.xml \ troubleshooting.xml bugs.xml opt-verbose.xml \ style.css images @@ -18,7 +18,7 @@ manual.is-valid: $(SOURCES) version.xml version.xml: echo -n $(VERSION) > version.xml -man1_MANS = nix-store.1 nix-instantiate.1 +man1_MANS = nix-env.1 nix-store.1 nix-instantiate.1 man $(MANS): $(SOURCES) manual.is-valid $(XSLTPROC) $(docbookxsl)/manpages/docbook.xsl manual.xml diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml index 1df0d1fc91..e95b0fc91d 100644 --- a/doc/manual/manual.xml +++ b/doc/manual/manual.xml @@ -7,6 +7,7 @@ + @@ -36,6 +37,10 @@ Command Reference + + nix-env + &nix-env; + nix-store &nix-store; diff --git a/doc/manual/nix-env.xml b/doc/manual/nix-env.xml new file mode 100644 index 0000000000..d8b50bf3cd --- /dev/null +++ b/doc/manual/nix-env.xml @@ -0,0 +1,166 @@ + + + nix-env + manipulate or query Nix user environments + + + + + nix-env + + + + + + + + + + + + + + path + + operation + options + arguments + + + + + Description + + + The command nix-env is used to manipulate Nix + user environments. User environments are sets of software + components available to a user at some point in time. In other + words, they are a synthesised view of the programs available in + the Nix store. There may be many user environments: different + users can have different environments, and individual users can + switch between different environments. + + + + + + nix-env takes exactly one + operation flag which indicates the + subcommand to be performed. These are documented below. + + + + + + + + + + Common options + + + This section lists the options that are common to all + operations. These options are allowed for every subcommand, + though they may not always have an effect. + + + + + &opt-verbose; + + + + + + Specifies the Nix expression used by the + , , + and operations to + obtain derivations. The default is + ~/.nix-defexpr. + + + + + + + + + + + + + + Files + + + + + ~/.nix-defexpr + + + The default Nix expression used by the + , , + and operations to + obtain derivations. It is generally a symbolic link to + some other location set using the + operation. The + option may be used to override + this default. + + + + + + ~/.nix-userenv + + + A symbolic link to the user's current user environment. + By default, it points to + prefix/var/nix/links/current. + The PATH environment variable should + include ~/.nix-userenv for the use + environments to be visible to the user. + + + + + + + + + + + + + + Operation <option>--install</option> + + + Synopsis + + nix-env + + + + + + + + Description + + + + + + + + + + diff --git a/doc/manual/nix-store.xml b/doc/manual/nix-store.xml index 36abf7af36..cbd38cd238 100644 --- a/doc/manual/nix-store.xml +++ b/doc/manual/nix-store.xml @@ -11,7 +11,7 @@ - + @@ -32,18 +32,21 @@ nix-store takes exactly one - operation flag which indicated the - subcommand to be performed. These are individually - documented below. + operation flag which indicates the + subcommand to be performed. These are documented below. + + + + Common options - This section lists the options that are common to all Nix + This section lists the options that are common to all operations. These options are allowed for every subcommand, though they may not always have an effect. @@ -68,6 +71,9 @@ + + + Environment variables @@ -221,10 +227,10 @@ Description - The operation displays various bits of - information about store expressions or store paths. The queries - are described in . At most one query - can be specified. The default query is . + The operation displays various bits + of information about store expressions or store paths. The + queries are described below. At most one query can be + specified. The default query is . diff --git a/doc/manual/style.css b/doc/manual/style.css index a7d8809f0b..3ff9edbd40 100644 --- a/doc/manual/style.css +++ b/doc/manual/style.css @@ -20,19 +20,41 @@ h1,h2,h3 text-align: left; } -h1 +h1 /* title */ { - font-size: 185%; + font-size: 200%; } -h2 +h2 /* chapters, appendices, subtitle */ +{ + font-size: 180%; +} + +/* Extra space between chapters, appendices. */ +div.chapter > div.titlepage h2, div.appendix > div.titlepage h2 +{ + margin-top: 1.5em; +/* border-top: solid #005aa0; */ +} + +div.sect1 h2 /* sections */ { font-size: 150%; } -h3 +div.refnamediv h2, div.refsynopsisdiv h2, div.refsection h2 /* refentry parts */ { - font-size: 120%; + font-size: 125%; +} + +div.refsection h3 +{ + font-size: 110%; +} + +h3 /* subsections */ +{ + font-size: 125%; }