Make share/examples/mdoc and share/misc/mdoc.template internally
consistent, and consistent with mdoc(7) and mdoc.samples(7). PR: doc/15352, doc/15353
This commit is contained in:
parent
65c9393d40
commit
ed0bfbe5c7
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=54340
@ -29,7 +29,7 @@
|
||||
.\"
|
||||
.\" Note: The date here should be updated whenever a non-trivial
|
||||
.\" change is made to the manual page.
|
||||
.Dd January 8, 1997
|
||||
.Dd December 8, 1999
|
||||
.Dt EXAMPLE 1
|
||||
.\" Note: Only specify the operating system when the command
|
||||
.\" is FreeBSD specific, otherwise use the .Os macro with no
|
||||
@ -94,6 +94,19 @@ of the
|
||||
command:
|
||||
.Pp
|
||||
.Dl % example -abc -d xyzzy /dev/null
|
||||
.Sh DIAGNOSTICS
|
||||
Exit status is 0 on success, and 1 if the command
|
||||
fails for one of the following reasons
|
||||
.Bl -diag
|
||||
.It example error message
|
||||
An example of an error message.
|
||||
.It another example error message.
|
||||
Self explanatory.
|
||||
.El
|
||||
.Sh COMPATIBILITY
|
||||
The
|
||||
.Nm
|
||||
command has no known compatibility issues.
|
||||
.Sh SEE ALSO
|
||||
.Xr example 3 ,
|
||||
.Xr example 4 ,
|
||||
@ -121,15 +134,6 @@ If the command conforms to some standard, such as
|
||||
or
|
||||
.St -ansiC ,
|
||||
it should be noted here.
|
||||
.Sh DIAGNOSTICS
|
||||
Exit status is 0 on success, and 1 if the command
|
||||
fails for one of the following reasons
|
||||
.Bl -diag
|
||||
.It example error message
|
||||
An example of an error message.
|
||||
.It another example error message.
|
||||
Self explanatory.
|
||||
.El
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
|
@ -29,7 +29,7 @@
|
||||
.\"
|
||||
.\" Note: The date here should be updated whenever a non-trivial
|
||||
.\" change is made to the manual page.
|
||||
.Dd January 8, 1997
|
||||
.Dd December 8, 1999
|
||||
.Dt EXAMPLE 3
|
||||
.\" Note: Only specify the operating system when the command
|
||||
.\" is FreeBSD specific, otherwise use the .Os macro with no
|
||||
@ -74,6 +74,10 @@ as follows:
|
||||
#define EXAMPLE_ONE 1
|
||||
#define EXAMPLE_TWO 2
|
||||
.Ed
|
||||
.Sh IMPLEMENTATION NOTES
|
||||
The
|
||||
.Fn example
|
||||
function is not actually implemented.
|
||||
.Sh RETURN VALUES
|
||||
.Rv -std example
|
||||
.Sh ENVIRONMENT
|
||||
@ -89,35 +93,12 @@ Example of a file in the
|
||||
.Sx FILES
|
||||
section.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr example 1 ,
|
||||
.Xr example 4 ,
|
||||
.Xr mdoc 7 ,
|
||||
.Xr mdoc.samples 7
|
||||
.Rs
|
||||
.%A A. B. Author
|
||||
.%T Example RFC Title
|
||||
.%O RFC0000
|
||||
.Re
|
||||
.Rs
|
||||
.%A A. B. Author
|
||||
.%B Example Book Title
|
||||
.%O ISBN-0-000-00000-0
|
||||
.Re
|
||||
.Rs
|
||||
.%A A. B. Author
|
||||
.%D January 1997
|
||||
.%J Example Journal Name
|
||||
.%T Example Article Title
|
||||
.Re
|
||||
.Sh STANDARDS
|
||||
If the command conforms to some standard, such as
|
||||
.St -p1003.2
|
||||
or
|
||||
.St -ansiC ,
|
||||
it should be noted here.
|
||||
.Sh DIAGNOSTICS
|
||||
None.
|
||||
.Sh COMPATIBILITY
|
||||
The
|
||||
.Fn example
|
||||
function has no known compatibility issues.
|
||||
.Sh ERRORS
|
||||
.\" Delete any errno's that are not returned by your
|
||||
.\" function or system call and then tailor the
|
||||
@ -288,6 +269,33 @@ Authentication error.
|
||||
.It Bq Er ENEEDAUTH
|
||||
Need authenticator.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr example 1 ,
|
||||
.Xr example 4 ,
|
||||
.Xr mdoc 7 ,
|
||||
.Xr mdoc.samples 7
|
||||
.Rs
|
||||
.%A A. B. Author
|
||||
.%T Example RFC Title
|
||||
.%O RFC0000
|
||||
.Re
|
||||
.Rs
|
||||
.%A A. B. Author
|
||||
.%B Example Book Title
|
||||
.%O ISBN-0-000-00000-0
|
||||
.Re
|
||||
.Rs
|
||||
.%A A. B. Author
|
||||
.%D January 1997
|
||||
.%J Example Journal Name
|
||||
.%T Example Article Title
|
||||
.Re
|
||||
.Sh STANDARDS
|
||||
If the command conforms to some standard, such as
|
||||
.St -p1003.2
|
||||
or
|
||||
.St -ansiC ,
|
||||
it should be noted here.
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
|
@ -29,7 +29,7 @@
|
||||
.\"
|
||||
.\" Note: The date here should be updated whenever a non-trivial
|
||||
.\" change is made to the manual page.
|
||||
.Dd January 8, 1997
|
||||
.Dd December 8, 1999
|
||||
.Dt EXAMPLE 4 i386
|
||||
.\" Note: Only specify the operating system when the command
|
||||
.\" is FreeBSD specific, otherwise use the .Os macro with no
|
||||
@ -64,11 +64,6 @@ Example of a file in the
|
||||
.Sx FILES
|
||||
section.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr example 1 ,
|
||||
.Xr example 3 ,
|
||||
.Xr mdoc 7 ,
|
||||
.Xr mdoc.samples 7
|
||||
.Sh DIAGNOSTICS
|
||||
.Bl -diag
|
||||
.It example%d: example diagnostic message.
|
||||
@ -76,6 +71,11 @@ An example of a diagnostic message.
|
||||
.It example%d: another example diagnostic message.
|
||||
Self explanatory.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr example 1 ,
|
||||
.Xr example 3 ,
|
||||
.Xr mdoc 7 ,
|
||||
.Xr mdoc.samples 7
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm
|
||||
|
@ -1,3 +1,5 @@
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.\" The following requests are required for all man pages.
|
||||
.Dd DATE
|
||||
.Os
|
||||
@ -8,6 +10,7 @@
|
||||
.Sh SYNOPSIS
|
||||
.Sh DESCRIPTION
|
||||
.\" The following requests should be uncommented and used where appropriate.
|
||||
.\" .Sh IMPLEMENTATION NOTES
|
||||
.\" This next request is for sections 2 and 3 function return values only.
|
||||
.\" .Sh RETURN VALUES
|
||||
.\" This next request is for sections 1, 6, 7 & 8 only
|
||||
@ -17,6 +20,7 @@
|
||||
.\" This next request is for sections 1, 6, 7 & 8 only
|
||||
.\" (command return values (to shell) and fprintf/stderr type diagnostics)
|
||||
.\" .Sh DIAGNOSTICS
|
||||
.\" .Sh COMPATIBILITY
|
||||
.\" The next request is for sections 2 and 3 error and signal handling only.
|
||||
.\" .Sh ERRORS
|
||||
.\" .Sh SEE ALSO
|
||||
|
Loading…
Reference in New Issue
Block a user