summary refs log tree commit diff
path: root/nixos/doc/manual/man-nixos-version.xml
blob: db7440977c9b98e8680fb0b292abde1c3953b459 (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
<refentry xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude">

<refmeta>
  <refentrytitle><command>nixos-version</command></refentrytitle>
  <manvolnum>8</manvolnum>
  <refmiscinfo class="source">NixOS</refmiscinfo>
</refmeta>

<refnamediv>
  <refname><command>nixos-version</command></refname>
  <refpurpose>show the version of nixpkgs NixOS was built from</refpurpose>
</refnamediv>

<refsynopsisdiv>
  <cmdsynopsis>
    <command>nixos-version</command>
    <arg><option>--hash</option></arg>
    <arg><option>--revision</option></arg>
  </cmdsynopsis>
</refsynopsisdiv>

<refsection><title>Description</title>

<para>This command describes the version of nixpkgs used to build
NixOS.</para>

<para>By default the output includes:</para>

<itemizedlist>
  <listitem><para>The NixOS release</para></listitem>
  <listitem><para>Number of commits since the release</para></listitem>
  <listitem><para>Git SHA of the released commit</para></listitem>
  <listitem><para>Codename of the NixOS release</para></listitem>
</itemizedlist>
</refsection>

<refsection><title>Example</title>

<para>Here is an example output, and corresponding information:
<screen>$ nixos-version
16.03.1011.6317da4 (Emu)
</screen>
</para>

<informaltable>
  <tgroup cols="2">
    <thead>
      <row>
        <entry>Attribute</entry>
        <entry>Value</entry>
      </row>
    </thead>
    <tbody>
      <row>
        <entry>NixOS Release</entry>
        <entry><literal>16.03</literal></entry>
      </row>
      <row>
        <entry>Commit Count</entry>
        <entry><literal>1011</literal></entry>
      </row>
      <row>
        <entry>Commit SHA</entry>
        <entry><literal>6317da4</literal></entry>
      </row>
      <row>
        <entry>Release Codename</entry>
        <entry><literal>Emu</literal></entry>
      </row>
    </tbody>
  </tgroup>
</informaltable>
<para>
</para>


</refsection>


<refsection><title>Options</title>

<para>This command accepts the following options:</para>

<variablelist>

  <varlistentry>
    <term><option>--hash</option></term>
    <term><option>--revision</option></term>
    <listitem>
      <para>The output will be the full hash of the git commit
<screen>$ nixos-version --hash
6317da40006f6bc2480c6781999c52d88dde2acf
</screen>
      </para>
    </listitem>
  </varlistentry>
</variablelist>

</refsection>
</refentry>