Man pages: Difference between revisions

From NixOS Wiki
imported>Garbas
mNo edit summary
imported>Ncfavier
add man-pages-posix as part of the Linux man-pages project
Line 21: Line 21:


<syntaxhighlight>
<syntaxhighlight>
environment.systemPackages = [ pkgs.manpages ];
environment.systemPackages = [ pkgs.man-pages pkgs.man-pages-posix ];
</syntaxhighlight>
</syntaxhighlight>



Revision as of 22:39, 11 June 2021

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. There is also NixOS options website

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.man-pages pkgs.man-pages-posix ];

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.