Nix 2.28.2
Nix, the purely functional package manager; unstable internal interfaces
 
Loading...
Searching...
No Matches
man-pages.hh File Reference
#include <filesystem>
#include <string>

Go to the source code of this file.

Functions

std::filesystem::path nix::getNixManDir ()
 Get path to the nix manual dir.
 
void nix::showManPage (const std::string &name)
 

Function Documentation

◆ getNixManDir()

std::filesystem::path nix::getNixManDir ( )

Get path to the nix manual dir.

Nix relies on the man pages being available at a NIX_MAN_DIR for displaying help messaged for legacy cli.

NIX_MAN_DIR is a compile-time parameter, so man pages are unlikely to work for cases when the nix executable is installed out-of-store or as a static binary.

◆ showManPage()

void nix::showManPage ( const std::string & name)

Show the manual page for the specified program.

Parameters
nameName of the man item.