From b16de454afc736a87c0386390c4cc91ba3cc8f29 Mon Sep 17 00:00:00 2001 From: Humm Date: Sun, 02 Jan 2022 01:54:26 +0000 Subject: [PATCH] scdoc(1), scdoc(5): follow conventions more closely The man page title must be all caps. Always traditionally and usually today, man page references using -man set the name in italic type: See .IR man (1). --- scdoc.1.scd | 10 +++++----- scdoc.5.scd | 10 +++++----- diff --git a/scdoc.1.scd b/scdoc.1.scd index 74c38d2ab5afb627c1269e08f3f5261077762863..1ea099fd67ad9588d35a103fb3b5f32f596d4cb3 100644 --- a/scdoc.1.scd +++ b/scdoc.1.scd @@ -1,8 +1,8 @@ -scdoc(1) +SCDOC(1) # NAME -scdoc - generate *man*(7) manual pages +scdoc - generate _man_(7) manual pages # SYNOPSIS @@ -10,12 +10,12 @@ *scdoc* < _input_ # DESCRIPTION -The scdoc utility reads *scdoc*(5) syntax from the standard input and writes -*man*(7) style roff to the standard output. +The scdoc utility reads _scdoc_(5) syntax from the standard input and writes +_man_(7) style roff to the standard output. # SEE ALSO -*scdoc*(5) +_scdoc_(5) # AUTHORS diff --git a/scdoc.5.scd b/scdoc.5.scd index 837a844851fbd367a35cd4bf491228325a06e104..06cc212df3c7c84e3544b6cb727029615ed00f56 100644 --- a/scdoc.5.scd +++ b/scdoc.5.scd @@ -1,4 +1,4 @@ -scdoc(5) +SCDOC(5) # NAME @@ -12,10 +12,10 @@ ## 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 -you're writing for (see *man*(1) for information on manual sections). +_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 positioned at those locations in the generated man page, and *must* be @@ -204,7 +204,7 @@ By convention, all scdoc documents should be hard wrapped at 80 columns. # SEE ALSO -*scdoc*(1) +_scdoc_(1) # AUTHORS -- 2.48.1