about summary refs log tree commit diff
path: root/doc/manual/opt-common.xml
blob: 6c8db2a72757e326386e846d6557b33231027afa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<varlistentry>
  <term><option>--help</option></term>
  <listitem>
    <para>
      Prints out a summary of the command syntax and exits.
    </para>
  </listitem>
</varlistentry>


<varlistentry>
  <term><option>--version</option></term>
  <listitem>
    <para>
      Prints out the Nix version number on standard output and exits.
    </para>
  </listitem>
</varlistentry>


<varlistentry>
  <term><option>--verbose</option> / <option>-v</option></term>
  <listitem>
    <para>
      Increases the level of verbosity of diagnostic messages printed
      on standard error.  For each Nix operation, the information
      printed on standard output is well-defined; any diagnostic
      information is printed on standard error, never on standard
      output.
    </para>

    <para>
      This option may be specified repeatedly.  Currently, the
      following verbosity levels exist:
    </para>

    <variablelist>
      <varlistentry>
        <term>0</term>
        <listitem>
          <para>
            <quote>Errors only</quote>: only print messages explaining
            why the Nix invocation failed.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>1</term>
        <listitem>
          <para>
            <quote>Informational</quote>: print
            <emphasis>useful</emphasis> messages about what Nix is
            doing.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>2</term>
        <listitem>
          <para>
            <quote>Talkative</quote>: print more informational messages.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>3</term>
        <listitem>
          <para>
            <quote>Chatty</quote>: print even more informational messages.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>4</term>
        <listitem>
          <para>
            <quote>Debug</quote>: print debug information:
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>5</term>
        <listitem>
          <para>
            <quote>Vomit</quote>: print vast amounts of debug
            information.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>

  </listitem>
</varlistentry>


<varlistentry>
  <term><option>--build-output</option> / <option>-B</option></term>
  <listitem>
    <para>
      Causes the output written by build actions to standard output
      and standard error to be echoed to standard error, regardless of
      verbosity level.  By default, it is only echoed at a verbosity
      level of at least 4 (<quote>Debug</quote>), and is suppressed at
      lower levels.  Note that it is always written to a log file in
      <filename><replaceable>prefix</replaceable>/nix/var/log/nix</filename>.
    </para>
  </listitem>
</varlistentry>


<varlistentry>
  <term><option>--keep-failed</option> / <option>-K</option></term>
  <listitem>
    <para>
      Specifies that in case of a build failure, the temporary
      directory (usually in <filename>/tmp</filename>) in which the
      build takes place should not be deleted.  The path of the build
      directory is printed as an informational message.
    </para>
  </listitem>
</varlistentry>