From 516a9816a39b0b378e3bb5eef34f5af75d6683cb Mon Sep 17 00:00:00 2001 From: Michael Lohmann Date: Mon, 6 Feb 2023 00:37:38 +0100 Subject: [PATCH] nixos/manual/manpages: add description on previewing manpage files (#214833) nixos/manual/manpages: add description on previewing manpage files I was a bit lost with the new manpage format and it took me some time to find the corresponding pull request by @pennae with a very helpful comment of @alyssais that mentioned this: https://github.com/NixOS/nixpkgs/pull/213256#issuecomment-1407713215 As @pennae noted, the file path is only a fallback if it cannot be resolved in the man database Co-authored-by: pennae <82953136+pennae@users.noreply.github.com> --- nixos/doc/manual/manpages/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/nixos/doc/manual/manpages/README.md b/nixos/doc/manual/manpages/README.md index ed2682e5332d..9923f4823922 100644 --- a/nixos/doc/manual/manpages/README.md +++ b/nixos/doc/manual/manpages/README.md @@ -4,6 +4,8 @@ This is the collection of NixOS manpages, excluding `configuration.nix(5)`. Man pages are written in [`mdoc(7)` format](https://mandoc.bsd.lv/man/mdoc.7.html) and should be portable between mandoc and groff for rendering (though minor differences may occur, mandoc and groff seem to have slightly different spacing rules.) +For previewing edited files, you can just run `man -l path/to/file.8` and you will see it rendered. + Being written in `mdoc` these manpages use semantic markup. This file provides a guideline on where to apply which of the semantic elements of `mdoc`. ### Command lines and arguments