diff options
| author | Humm <hummsmith42@gmail.com> | 2022-01-02 01:54:26 +0000 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2022-01-02 10:25:07 +0100 |
| commit | b16de454afc736a87c0386390c4cc91ba3cc8f29 (patch) | |
| tree | e8243bc8f0100c2f0e56f4f18cf1911085a06598 | |
| parent | 5061ecc8b3831ad38f8000a6c0c6edad190bf904 (diff) | |
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).
| -rw-r--r-- | scdoc.1.scd | 10 | ||||
| -rw-r--r-- | scdoc.5.scd | 10 |
2 files changed, 10 insertions, 10 deletions
diff --git a/scdoc.1.scd b/scdoc.1.scd index 74c38d2..1ea099f 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 - generate *man*(7) manual pages # 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 837a844..06cc212 100644 --- a/scdoc.5.scd +++ b/scdoc.5.scd @@ -1,4 +1,4 @@ -scdoc(5) +SCDOC(5) # NAME @@ -12,10 +12,10 @@ Input files must use the UTF-8 encoding. 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 |