diff options
author | mpp <mpp@FreeBSD.org> | 1999-12-08 22:15:09 +0000 |
---|---|---|
committer | mpp <mpp@FreeBSD.org> | 1999-12-08 22:15:09 +0000 |
commit | 417fa30de618234ab56569f76161137a2931e717 (patch) | |
tree | 8cf9cf1d078d78c8daae308ec5e2f165d7d30361 /share | |
parent | ef74d85fe0f8cf85be2d016f121c79e90ffcafa8 (diff) | |
download | FreeBSD-src-417fa30de618234ab56569f76161137a2931e717.zip FreeBSD-src-417fa30de618234ab56569f76161137a2931e717.tar.gz |
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
Diffstat (limited to 'share')
-rw-r--r-- | share/examples/mdoc/example.1 | 24 | ||||
-rw-r--r-- | share/examples/mdoc/example.3 | 64 | ||||
-rw-r--r-- | share/examples/mdoc/example.4 | 12 | ||||
-rw-r--r-- | share/misc/mdoc.template | 4 |
4 files changed, 60 insertions, 44 deletions
diff --git a/share/examples/mdoc/example.1 b/share/examples/mdoc/example.1 index 4ee3c92..53ba9cf 100644 --- a/share/examples/mdoc/example.1 +++ b/share/examples/mdoc/example.1 @@ -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 diff --git a/share/examples/mdoc/example.3 b/share/examples/mdoc/example.3 index 8d3f7c5..b2dc556 100644 --- a/share/examples/mdoc/example.3 +++ b/share/examples/mdoc/example.3 @@ -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 diff --git a/share/examples/mdoc/example.4 b/share/examples/mdoc/example.4 index e320863..45be914 100644 --- a/share/examples/mdoc/example.4 +++ b/share/examples/mdoc/example.4 @@ -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 diff --git a/share/misc/mdoc.template b/share/misc/mdoc.template index 287a2c7..c85db15 100644 --- a/share/misc/mdoc.template +++ b/share/misc/mdoc.template @@ -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 |