Man pages: Difference between revisions

From NixOS Wiki
imported>Profpatsch
init man page, how to enable development man pages
 
imported>Profpatsch
man configuration.nix
Line 2: Line 2:


See the [https://wiki.archlinux.org/index.php/Man_page Archwiki] and [https://en.wikipedia.org/wiki/Man_page Wikipedia] entries for more information.
See the [https://wiki.archlinux.org/index.php/Man_page Archwiki] and [https://en.wikipedia.org/wiki/Man_page Wikipedia] entries for more information.
== NixOS: Display configuration options ==
The NixOS option system creates a manpage with all options and their documentation.
<syntaxhighlight>
man 5 configuration.nix
</syntaxhighlight>
This is a lightweight alternative to the “Configuration Options” page in <code>nixos-help</code>.


== NixOS: Some man pages are missing ==
== NixOS: Some man pages are missing ==

Revision as of 10:39, 6 February 2019

Man pages are a form of documentation available on Unix-like systems.

See the Archwiki and Wikipedia entries for more information.

NixOS: Display configuration options

The NixOS option system creates a manpage with all options and their documentation.

man 5 configuration.nix

This is a lightweight alternative to the “Configuration Options” page in nixos-help.

NixOS: Some man pages are missing

Development man pages

The “Linux man-pages project” provides a set of documentation of the Linux programming API, mostly section `3`. You can access them by adding them to your system packages:

environment.systemPackages = [ pkgs.manpages ];

To try it out: man 3 scanf.

Libraries and development utilities might provide additional documentation and manpages. You can add those to your system like this:

documentation.dev.enable = true;

See also: the other options in the `documentation` namespace.