Man pages - Revision history

imported>9glenda: Add documentation for Mandoc

2023-11-30T21:40:34Z

Add documentation for Mandoc

← Older revision		Revision as of 21:40, 30 November 2023
Line 33:		Line 33:

	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]].

imported>Wackbyte: syntax highlighting

2022-03-02T02:34:47Z

syntax highlighting

← Older revision		Revision as of 02:34, 2 March 2022
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>

imported>Ncfavier: link to the apropos page

2021-06-11T22:51:44Z

link to the apropos page

← Older revision		Revision as of 22:51, 11 June 2021
Line 33:		Line 33:

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

			=== Apropos ===

			See [[Apropos]].

imported>Ncfavier: add man-pages-posix as part of the Linux man-pages project

2021-06-11T22:39:35Z

add man-pages-posix as part of the Linux man-pages project

← Older revision		Revision as of 22:39, 11 June 2021
Line 21:		Line 21:

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

imported>Garbas at 21:43, 24 September 2020

2020-09-24T21:43:16Z

← Older revision		Revision as of 21:43, 24 September 2020
Line 12:		Line 12:

	This is a lightweight alternative to the “Configuration Options” page in <code>nixos-help</code>.		This is a lightweight alternative to the “Configuration Options” page in <code>nixos-help</code>.
	There is also [https://nixos.org~~/nixos~~/options~~.html#~~ NixOS options] website		There is also [https://search.nixos.org/options NixOS options] website

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

imported>Extends: Adding nixos website concerning available options

2020-08-15T09:42:30Z

Adding nixos website concerning available options

← Older revision		Revision as of 09:42, 15 August 2020
Line 12:		Line 12:

	This is a lightweight alternative to the “Configuration Options” page in <code>nixos-help</code>.		This is a lightweight alternative to the “Configuration Options” page in <code>nixos-help</code>.
			There is also [https://nixos.org/nixos/options.html# NixOS options] website

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

imported>Profpatsch: man configuration.nix

2019-02-06T10:39:18Z

man configuration.nix

← Older revision		Revision as of 10:39, 6 February 2019
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 ==

imported>Profpatsch: init man page, how to enable development man pages

2019-02-06T10:30:53Z

init man page, how to enable development man pages

New page

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

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: 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:

<syntaxhighlight>
environment.systemPackages = [ pkgs.manpages ];
</syntaxhighlight>

To try it out: <code>man 3 scanf</code>.

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

<syntaxhighlight>
documentation.dev.enable = true;
</syntaxhighlight>

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