Man pages: Difference between revisions
imported>Ncfavier link to the apropos page |
imported>9glenda Add documentation for Mandoc |
||
| (One intermediate revision by one other user not shown) | |||
| Line 7: | Line 7: | ||
The NixOS option system creates a manpage with all options and their documentation. | The NixOS option system creates a manpage with all options and their documentation. | ||
<syntaxhighlight> | <syntaxhighlight lang="console"> | ||
man 5 configuration.nix | $ man 5 configuration.nix | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 20: | Line 20: | ||
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: | 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: | ||
<syntaxhighlight> | <syntaxhighlight lang="nix"> | ||
environment.systemPackages = [ pkgs.man-pages pkgs.man-pages-posix ]; | environment.systemPackages = [ pkgs.man-pages pkgs.man-pages-posix ]; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 28: | Line 28: | ||
Libraries and development utilities might provide additional documentation and manpages. You can add those to your system like this: | Libraries and development utilities might provide additional documentation and manpages. You can add those to your system like this: | ||
<syntaxhighlight> | <syntaxhighlight lang="nix"> | ||
documentation.dev.enable = true; | documentation.dev.enable = true; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
See also: the other options in the `documentation` namespace. | See also: the other options in the `documentation` namespace. | ||
== Mandoc as the default man page viewer == | |||
Mandoc is a set of tools designed for working with mdoc(7), the preferred roff macro language for BSD manual pages, as well as man(7), the historical roff macro language used in UNIX manuals. It can be used as an alternative to man-db. | |||
To use mandoc as the default man page viewer add following code to your config: | |||
<syntaxhighlight lang="nix"> | |||
documentation.man = { | |||
# In order to enable to mandoc man-db has to be disabled. | |||
man-db.enable = false; | |||
mandoc.enable = true; | |||
}; | |||
</syntaxhighlight> | |||
See also: the [https://mandoc.bsd.lv/ Mandoc website]. | |||
=== Apropos === | === Apropos === | ||
See [[Apropos]]. | See [[Apropos]]. | ||