選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

man-nixos-option.xml 3.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. <refentry xmlns="http://docbook.org/ns/docbook"
  2. xmlns:xlink="http://www.w3.org/1999/xlink"
  3. xmlns:xi="http://www.w3.org/2001/XInclude">
  4. <refmeta>
  5. <refentrytitle><command>nixos-option</command>
  6. </refentrytitle><manvolnum>8</manvolnum>
  7. <refmiscinfo class="source">NixOS</refmiscinfo>
  8. <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
  9. </refmeta>
  10. <refnamediv>
  11. <refname><command>nixos-option</command></refname>
  12. <refpurpose>inspect a NixOS configuration</refpurpose>
  13. </refnamediv>
  14. <refsynopsisdiv>
  15. <cmdsynopsis>
  16. <command>nixos-option</command>
  17. <arg>
  18. <option>-I</option> <replaceable>path</replaceable>
  19. </arg>
  20. <arg>
  21. <option>--verbose</option>
  22. </arg>
  23. <arg>
  24. <option>--xml</option>
  25. </arg>
  26. <arg choice="plain">
  27. <replaceable>option.name</replaceable>
  28. </arg>
  29. </cmdsynopsis>
  30. </refsynopsisdiv>
  31. <refsection>
  32. <title>Description</title>
  33. <para>
  34. This command evaluates the configuration specified in
  35. <filename>/etc/nixos/configuration.nix</filename> and returns the properties
  36. of the option name given as argument.
  37. </para>
  38. <para>
  39. When the option name is not an option, the command prints the list of
  40. attributes contained in the attribute set.
  41. </para>
  42. </refsection>
  43. <refsection>
  44. <title>Options</title>
  45. <para>
  46. This command accepts the following options:
  47. </para>
  48. <variablelist>
  49. <varlistentry>
  50. <term>
  51. <option>-I</option> <replaceable>path</replaceable>
  52. </term>
  53. <listitem>
  54. <para>
  55. This option is passed to the underlying
  56. <command>nix-instantiate</command> invocation.
  57. </para>
  58. </listitem>
  59. </varlistentry>
  60. <varlistentry>
  61. <term>
  62. <option>--verbose</option>
  63. </term>
  64. <listitem>
  65. <para>
  66. This option enables verbose mode, which currently is just the Bash
  67. <command>set</command> <option>-x</option> debug mode.
  68. </para>
  69. </listitem>
  70. </varlistentry>
  71. <varlistentry>
  72. <term>
  73. <option>--xml</option>
  74. </term>
  75. <listitem>
  76. <para>
  77. This option causes the output to be rendered as XML.
  78. </para>
  79. </listitem>
  80. </varlistentry>
  81. </variablelist>
  82. </refsection>
  83. <refsection>
  84. <title>Environment</title>
  85. <variablelist>
  86. <varlistentry>
  87. <term>
  88. <envar>NIXOS_CONFIG</envar>
  89. </term>
  90. <listitem>
  91. <para>
  92. Path to the main NixOS configuration module. Defaults to
  93. <filename>/etc/nixos/configuration.nix</filename>.
  94. </para>
  95. </listitem>
  96. </varlistentry>
  97. </variablelist>
  98. </refsection>
  99. <refsection>
  100. <title>Examples</title>
  101. <para>
  102. Investigate option values:
  103. <screen><prompt>$ </prompt>nixos-option boot.loader
  104. This attribute set contains:
  105. generationsDir
  106. grub
  107. initScript
  108. <prompt>$ </prompt>nixos-option boot.loader.grub.enable
  109. Value:
  110. true
  111. Default:
  112. true
  113. Description:
  114. Whether to enable the GNU GRUB boot loader.
  115. Declared by:
  116. "/nix/var/nix/profiles/per-user/root/channels/nixos/nixpkgs/nixos/modules/system/boot/loader/grub/grub.nix"
  117. Defined by:
  118. "/nix/var/nix/profiles/per-user/root/channels/nixos/nixpkgs/nixos/modules/system/boot/loader/grub/grub.nix"
  119. </screen>
  120. </para>
  121. </refsection>
  122. <refsection>
  123. <title>Bugs</title>
  124. <para>
  125. The author listed in the following section is wrong. If there is any other
  126. bug, please report to Nicolas Pierron.
  127. </para>
  128. </refsection>
  129. </refentry>