From 74b8daa6e0e5152e9c49a64972dd26fd145b0698 Mon Sep 17 00:00:00 2001 From: Simon Branch Date: Fri, 31 Dec 2021 18:00:21 -0800 Subject: [PATCH] scdoc.5: fix formatting in the preamble In a manpage, bold indicates literal text which should be entered verbatim by the user. That makes no sense for the preamble: the user should change "name" to the name of their manpage. --- scdoc.5.scd | 4 ++-- diff --git a/scdoc.5.scd b/scdoc.5.scd index 84e456bb7b21eec7b0cf679851ff52f579762b99..837a844851fbd367a35cd4bf491228325a06e104 100644 --- a/scdoc.5.scd +++ b/scdoc.5.scd @@ -12,9 +12,9 @@ ## Preamble Each scdoc file must begin with the following preamble: - *name*(_section_) ["left\_footer" ["center\_header"]] + _name_(_section_) ["left\_footer" ["center\_header"]] -*name* is the name of the man page you are writing, and _section_ is the section +_name_ is the name of the man page you are writing, and _section_ is the section you're writing for (see *man*(1) for information on manual sections). _left\_footer_ and _center\_header_ are optional arguments which set the text -- 2.48.1